chrome.proxy

Opis

Uprawnienia

Plik manifestu

Aby korzystać z interfejsu API ustawień serwera proxy, musisz zadeklarować uprawnienie „proxy” w pliku manifestu rozszerzenia. Na przykład:

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

Obiekty i właściwości

Ustawienia serwera proxy są zdefiniowane w obiekcie proxy.ProxyConfig. W zależności od ustawień serwera proxy w Chrome, ustawienia mogą zawierać proxy.ProxyRules lub proxy.PacScript.

Tryby serwera proxy

Atrybut mode obiektu ProxyConfig określa ogólne zachowanie Chrome w odniesieniu do korzystania z serwera proxy. Może przyjmować te wartości:

direct

W trybie direct wszystkie połączenia są tworzone bezpośrednio, bez udziału serwera proxy. Ten tryb nie dopuszcza żadnych dodatkowych parametrów w obiekcie ProxyConfig.

auto_detect

W trybie auto_detect konfiguracja serwera proxy jest określana przez skrypt PAC, który można pobrać pod adresem http://wpad/wpad.dat. Ten tryb nie dopuszcza żadnych dodatkowych parametrów w obiekcie ProxyConfig.

pac_script

W trybie pac_script konfiguracja serwera proxy jest określana przez skrypt PAC, który jest pobierany z adresu URL określonego w obiekcie proxy.PacScript lub dosłownie pobierany z elementu data określonego w obiekcie proxy.PacScript. Poza tym ten tryb nie dopuszcza żadnych dodatkowych parametrów w obiekcie ProxyConfig.

fixed_servers

W trybie fixed_servers konfiguracja serwera proxy jest zakodowana w obiekcie proxy.ProxyRules. Jego struktura jest opisana w sekcji Reguły serwera proxy. Poza tym tryb fixed_servers nie dopuszcza żadnych dodatkowych parametrów w obiekcie ProxyConfig.

system

W trybie system konfiguracja serwera proxy jest pobierana z systemu operacyjnego. Ten tryb nie dopuszcza żadnych dodatkowych parametrów w obiekcie ProxyConfig. Pamiętaj, że tryb system różni się od ustawienia konfiguracji serwera proxy. W tym drugim przypadku Chrome wraca do ustawień systemowych tylko wtedy, gdy żadne opcje wiersza poleceń nie wpływają na konfigurację serwera proxy.

Reguły serwera proxy

Obiekt proxy.ProxyRules może zawierać atrybut singleProxy lub podzbiór atrybutów proxyForHttp, proxyForHttps, proxyForFtp, i fallbackProxy.

W pierwszym przypadku ruch HTTP, HTTPS i FTP jest przekierowywany przez określony serwer proxy. Inny ruch jest wysyłany bezpośrednio. W drugim przypadku zachowanie jest nieco bardziej subtelne: jeśli serwer proxy jest skonfigurowany dla protokołu HTTP, HTTPS lub FTP, odpowiedni ruch jest przekierowywany przez określony serwer. Jeśli taki serwer proxy nie jest określony lub ruch używa innego protokołu niż HTTP, HTTPS lub FTP, używany jest fallbackProxy. Jeśli nie określono fallbackProxy, ruch jest wysyłany bezpośrednio bez serwera proxy.

Obiekty serwera proxy

Serwer proxy jest konfigurowany w obiekcie proxy.ProxyServer. Połączenie z serwerem proxy (zdefiniowanym przez atrybut host) używa protokołu zdefiniowanego w atrybucie scheme. Jeśli nie określono scheme, połączenie z serwerem proxy domyślnie używa protokołu http.

Jeśli w obiekcie proxy.ProxyServer nie zdefiniowano port, port jest wyprowadzany ze schematu. Domyślne porty:

Lista pomijanych

Poszczególne serwery można wykluczyć z przekierowywania za pomocą bypassList. Ta lista może zawierać te wpisy:

[SCHEME://]HOST_PATTERN[:PORT]

Dopasuj wszystkie nazwy hostów, które pasują do wzorca HOST_PATTERN. Początkowy znak "." jest interpretowany jako "*.".

Przykłady: "foobar.com", "*foobar.com", "*.foobar.com", "*foobar.com:99", "https://x.*.y.com:99".

Wzór	Dopasowania	Nie pasuje
".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]

Dopasuj adresy URL, które są literałami adresów IP. Koncepcyjnie jest to podobne do pierwszego przypadku, ale z wyjątkami dotyczącymi kanonizacji literałów IP. Na przykład dopasowanie do „[0:0:0::1]” jest takie samo jak dopasowanie do „[::1]”, ponieważ kanonizacja IPv6 jest wykonywana wewnętrznie.

Przykłady: 127.0.1, [0:0::1], [::1]:80, https://[::1]:443

IP_LITERAL/PREFIX_LENGTH_IN_BITS

Dopasuj dowolny adres URL zawierający literał IP (IP_LITERAL) w danym zakresie. Zakres adresów IP (PREFIX_LENGTH_IN_BITS) jest określany za pomocą notacji CIDR.

Dopasuj dowolny adres URL zawierający literał IP w danym zakresie. Zakres adresów IP jest określany za pomocą notacji CIDR. Przykłady: "192.168.1.1/16", "fefe:13::abc/33"

<local>

Literał <local> pasuje do prostych nazw hostów. Prosta nazwa hosta to nazwa, która nie zawiera kropek i nie jest literałem IP. Na przykład example i localhost to proste nazwy hostów, a example.com, example. i [::1] nie.

Przykład: "<local>"

Przykłady

Poniższy kod ustawia serwer proxy SOCKS 5 dla połączeń HTTP ze wszystkimi serwerami z wyjątkiem foobar.com i używa połączeń bezpośrednich dla wszystkich innych protokołów. Ustawienia dotyczą zwykłych i incognito okien, ponieważ okna incognito dziedziczą ustawienia ze zwykłych okien. Zapoznaj się też z dokumentacją interfejsu 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() {}
);

Poniższy kod ustawia niestandardowy skrypt PAC.

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() {}
);

Następny fragment kodu wysyła zapytanie o aktualnie obowiązujące ustawienia serwera proxy. Obowiązujące ustawienia serwera proxy mogą być określone przez inne rozszerzenie lub przez zasadę. Szczegółowe informacje znajdziesz w dokumentacji interfejsu Types API.

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

Pamiętaj, że obiekt value przekazywany do set() nie jest identyczny z obiektem value przekazywanym do funkcji wywołania zwrotnego get(). Ten drugi będzie zawierać element rules.proxyForHttp.port.

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