chrome.proxy

ब्यौरा

अनुमतियां

प्रॉक्सी सेटिंग एपीआई का इस्तेमाल करने के लिए, आपको एक्सटेंशन मेनिफ़ेस्ट में "प्रॉक्सी" अनुमति के बारे में एलान करना होगा. उदाहरण के लिए:

{
  "name": "My extension",
  ...
  "permissions": [
    "proxy"
  ],
  ...
}

सिद्धांत और इस्तेमाल

प्रॉक्सी सेटिंग को proxy.ProxyConfig ऑब्जेक्ट में तय किया जाता है. Chrome की प्रॉक्सी सेटिंग के आधार पर, सेटिंग में proxy.ProxyRules या proxy.PacScript शामिल हो सकते हैं.

प्रॉक्सी मोड

प्रॉक्सी कॉन्फ़िगरेशन ऑब्जेक्ट का mode एट्रिब्यूट, प्रॉक्सी के इस्तेमाल के आधार पर Chrome के काम करने का तरीका तय करता है. इसमें नीचे दी गई वैल्यू हो सकती हैं:

direct

direct मोड में, सभी कनेक्शन सीधे तौर पर बन जाते हैं और इसमें कोई प्रॉक्सी शामिल नहीं होता. इस मोड की मदद से, ProxyConfig ऑब्जेक्ट में कोई और पैरामीटर नहीं जोड़ा जा सकता.

auto_detect

auto_detect मोड में, प्रॉक्सी कॉन्फ़िगरेशन को पीएसी स्क्रिप्ट से तय किया जाता है. इस स्क्रिप्ट को http://wpad/wpad.dat पर डाउनलोड किया जा सकता है. यह मोड, ProxyConfig ऑब्जेक्ट में किसी और पैरामीटर को जोड़ने की अनुमति नहीं देता.

pac_script

pac_script मोड में, प्रॉक्सी कॉन्फ़िगरेशन को पीएसी स्क्रिप्ट से तय किया जाता है. इसे proxy.PacScript ऑब्जेक्ट में दिए गए यूआरएल से लिया जाता है या proxy.PacScript ऑब्जेक्ट में बताए गए data एलिमेंट से लिया जाता है. इसके अलावा, यह मोड ProxyConfig ऑब्जेक्ट में किसी और पैरामीटर की अनुमति नहीं देता.

fixed_servers

fixed_servers मोड में, प्रॉक्सी कॉन्फ़िगरेशन को proxy.ProxyRules ऑब्जेक्ट में कॉपी किया जाता है. इसकी बनावट के बारे में प्रॉक्सी नियमों में बताया गया है. इसके अलावा, fixed_servers मोड, ProxyConfig ऑब्जेक्ट में किसी और पैरामीटर की अनुमति नहीं देता.

system

system मोड में प्रॉक्सी कॉन्फ़िगरेशन को ऑपरेटिंग सिस्टम से लिया जाता है. यह मोड, ProxyConfig ऑब्जेक्ट में कोई और पैरामीटर नहीं जोड़ने की अनुमति देता है. ध्यान दें कि system मोड, कोई प्रॉक्सी कॉन्फ़िगरेशन नहीं सेट करने से अलग है. बाद वाले मामले में, Chrome सिस्टम सेटिंग पर वापस तभी वापस आता है, जब कोई कमांड-लाइन विकल्प प्रॉक्सी कॉन्फ़िगरेशन को प्रभावित नहीं करता.

प्रॉक्सी के नियम

proxy.ProxyRules ऑब्जेक्ट में, singleProxy एट्रिब्यूट या proxyForHttp, proxyForHttps, proxyForFtp, और fallbackProxy का सबसेट हो सकता है.

पहले मामले में, एचटीटीपी, एचटीटीपीएस, और एफ़टीपी ट्रैफ़िक को तय किए गए प्रॉक्सी सर्वर के ज़रिए प्रॉक्सी किया जाता है. अन्य ट्रैफ़िक को सीधे तौर पर भेजा जाता है. बाद वाले मामले में, व्यवहार थोड़ा और आसान होता है: अगर किसी प्रॉक्सी सर्वर को एचटीटीपी, एचटीटीपीएस या एफ़टीपी प्रोटोकॉल के लिए कॉन्फ़िगर किया जाता है, तो उससे जुड़े ट्रैफ़िक को तय किए गए सर्वर से प्रॉक्सी किया जाता है. अगर ऐसा कोई प्रॉक्सी सर्वर नहीं दिया गया है या ट्रैफ़िक, एचटीटीपी, एचटीटीपीएस या एफ़टीपी से अलग किसी दूसरे प्रोटोकॉल का इस्तेमाल करता है, तो fallbackProxy का इस्तेमाल किया जाता है. अगर कोई fallbackProxy तय नहीं किया गया है, तो ट्रैफ़िक को सीधे किसी प्रॉक्सी सर्वर के बिना भेजा जाता है.

प्रॉक्सी सर्वर ऑब्जेक्ट

proxy.ProxyServer ऑब्जेक्ट में प्रॉक्सी सर्वर कॉन्फ़िगर किया जाता है. प्रॉक्सी सर्वर से कनेक्ट करने के लिए, scheme एट्रिब्यूट में बताए गए प्रोटोकॉल का इस्तेमाल किया जाता है. प्रॉक्सी सर्वर को host एट्रिब्यूट की मदद से तय किया जाता है. अगर scheme के बारे में नहीं बताया गया है, तो प्रॉक्सी कनेक्शन डिफ़ॉल्ट रूप से http हो जाता है.

अगर किसी proxy.ProxyServer ऑब्जेक्ट में कोई port तय नहीं किया गया है, तो पोर्ट को स्कीम से लिया जाता है. डिफ़ॉल्ट पोर्ट हैं:

बायपास लिस्ट

अलग-अलग सर्वर को bypassList के साथ प्रॉक्सी से बाहर रखा जा सकता है. इस सूची में ये एंट्री हो सकती हैं:

[SCHEME://]HOST_PATTERN[:PORT]

उन सभी होस्टनेम से मैच करें जो HOST_PATTERN पैटर्न से मिलते-जुलते हैं. लीडिंग "." को "*." माना जाता है.

उदाहरण: "foobar.com", "*foobar.com", "*.foobar.com", "*foobar.com:99", "https://x.*.y.com:99".

पैटर्न	मैच करती स्ट्रिंग	मिलान नहीं होता है
".foobar.com"	"www.foobar.com"	"foobar.com"
"*.foobar.com"	"www.foobar.com"	"foobar.com"
"foobar.com"	"foobar.com"	"www.foobar.com"
"*foobar.com"	"foobar.com", "www.foobar.com", "foofoobar.com"

[SCHEME://]IP_LITERAL[:PORT]

उन यूआरएल को मैच करें जो आईपी पते की लिटरल वैल्यू हैं. सैद्धान्तिक तौर पर, यह पहले मामले से मिलता-जुलता है. हालांकि, आईपी लिटरल तौर पर कैननिकल होने की जांच करने के लिए, खास मामलों में भी ऐसा किया जाता है. उदाहरण के लिए, "[0:0:0::1]" पर मैच करना, "[::1]" से मैच करने के जैसा ही है, क्योंकि आईपीवी6 में कैननिकल होने की प्रक्रिया अंदरूनी तौर पर पूरी होती है.

उदाहरण: 127.0.1, [0:0::1], [::1]:80, https://[::1]:443

IP_LITERAL/PREFIX_LENGTH_IN_BITS

दी गई रेंज में, ऐसे किसी भी यूआरएल का मिलान करें जिसमें आईपी लिटरल (IP_LITERAL) मौजूद हो. आईपी रेंज (PREFIX_LENGTH_IN_BITS) की जानकारी, सीआईडीआर नोटेशन का इस्तेमाल करके दी जाती है.

दी गई रेंज के अंदर, ऐसे किसी भी यूआरएल का मिलान करें जिसमें आईपी लिटरल वैल्यू हो. आईपी रेंज को सीआईडीआर नोटेशन का इस्तेमाल करके दिखाया जाता है. उदाहरण: "192.168.1.1/16", "fefe:13::abc/33"

<local>

लिटरल स्ट्रिंग <local>, आसान होस्टनेम से मैच करती है. सामान्य होस्टनेम वह होता है जिसमें कोई बिंदु नहीं होता है और यह आईपी लिटरल नहीं होता है. उदाहरण के लिए example और localhost सामान्य होस्टनेम हैं, जबकि example.com, example., और [::1] नहीं.

उदाहरण: "<local>"

उदाहरण

नीचे दिया गया कोड, सभी सर्वर पर एचटीटीपी कनेक्शन के लिए SOCKS 5 प्रॉक्सी सेट करता है. हालांकि, यह foobar.com है. साथ ही, अन्य सभी प्रोटोकॉल के लिए, डायरेक्ट कनेक्शन का इस्तेमाल किया जाता है. सेटिंग सामान्य और गुप्त विंडो पर लागू होती हैं, क्योंकि गुप्त विंडो सामान्य विंडो से सेटिंग इनहेरिट करती हैं. Types API दस्तावेज़ भी देखें.

var config = {
  mode: "fixed_servers",
  rules: {
    proxyForHttp: {
      scheme: "socks5",
      host: "1.2.3.4"
    },
    bypassList: ["foobar.com"]
  }
};
chrome.proxy.settings.set(
  {value: config, scope: 'regular'},
  function() {}
);

यह कोड, कस्टम पीएसी स्क्रिप्ट सेट करता है.

var config = {
  mode: "pac_script",
  pacScript: {
    data: "function FindProxyForURL(url, host) {\n" +
          "  if (host == 'foobar.com')\n" +
          "    return 'PROXY blackhole:80';\n" +
          "  return 'DIRECT';\n" +
          "}"
  }
};
chrome.proxy.settings.set(
  {value: config, scope: 'regular'},
  function() {}
);

अगला स्निपेट, मौजूदा असरदार प्रॉक्सी सेटिंग के बारे में क्वेरी करता है. असरदार प्रॉक्सी सेटिंग को किसी दूसरे एक्सटेंशन या किसी नीति से तय किया जा सकता है. ज़्यादा जानकारी के लिए, Types API का दस्तावेज़ देखें.

chrome.proxy.settings.get(
  {'incognito': false},
  function(config) {
    console.log(JSON.stringify(config));
  }
);

ध्यान दें कि set() को पास किया गया value ऑब्जेक्ट, get() के कॉलबैक फ़ंक्शन को पास किए गए value ऑब्जेक्ट के जैसा नहीं है. बाद वाले वाले एलिमेंट में rules.proxyForHttp.port एलिमेंट शामिल होगा.

chrome.proxy.onProxyError.addListener(
  callback: function,
)