Descrizione
Utilizza l'API chrome.proxy per gestire le impostazioni del proxy di Chrome. Questa API si basa sul prototipo ChromeSetting dell'API di tipo per ottenere e impostare la configurazione del proxy.
Autorizzazioni
proxyPer utilizzare l'API delle impostazioni del proxy, devi dichiarare l'autorizzazione "proxy" nel manifest dell'estensione. Ad esempio:
{
"name": "My extension",
...
"permissions": [
"proxy"
],
...
}
Concetti e utilizzo
Le impostazioni del proxy sono definite in un oggetto proxy.ProxyConfig. A seconda delle impostazioni del proxy di Chrome,
le impostazioni potrebbero contenere proxy.ProxyRules o un proxy.PacScript.
Modalità proxy
L'attributo mode di un oggetto ProxyConfig determina il comportamento generale di Chrome in relazione all'utilizzo del proxy. Può assumere i seguenti valori:
direct- In modalità
directtutte le connessioni vengono create direttamente, senza l'intervento di alcun proxy. Questa modalità non consente altri parametri nell'oggettoProxyConfig. auto_detect- In modalità
auto_detect, la configurazione del proxy è determinata da uno script PAC che può essere scaricato all'indirizzo http://wpad/wpad.dat. Questa modalità non consente altri parametri nell'oggettoProxyConfig. pac_script- In modalità
pac_script, la configurazione del proxy è determinata da uno script PAC recuperato dall'URL specificato nell'oggettoproxy.PacScripto preso letteralmente dall'elementodataspecificato nell'oggettoproxy.PacScript. Inoltre, questa modalità non consente altri parametri nell'oggettoProxyConfig. fixed_servers- In modalità
fixed_servers, la configurazione del proxy è codificata in un oggettoproxy.ProxyRules. La sua struttura è descritta in Regole proxy. Inoltre, la modalitàfixed_serversnon consente altri parametri nell'oggettoProxyConfig. system- In modalità
system, la configurazione del proxy viene presa dal sistema operativo. Questa modalità non consente altri parametri nell'oggettoProxyConfig. Tieni presente che la modalitàsystemè diversa dall'impostazione di nessuna configurazione del proxy. In quest'ultimo caso, Chrome torna alle impostazioni di sistema solo se nessuna opzione della riga di comando influisce sulla configurazione del proxy.
Regole del proxy
L'oggetto proxy.ProxyRules può contenere un attributo singleProxy o un sottoinsieme di proxyForHttp, proxyForHttps, proxyForFtp e fallbackProxy.
Nel primo caso, il traffico HTTP, HTTPS e FTP viene instradato tramite il server proxy specificato. L'altro traffico viene inviato direttamente. In quest'ultimo caso, il comportamento è leggermente più sottile: se un server proxy è configurato per il protocollo HTTP, HTTPS o FTP, il rispettivo traffico viene instradato tramite il server specificato. Se non viene specificato un server proxy di questo tipo o se il traffico utilizza un protocollo diverso da HTTP, HTTPS o FTP, viene utilizzato fallbackProxy. Se non viene specificato fallbackProxy, il traffico viene inviato direttamente senza un server proxy.
Oggetti del server proxy
Un server proxy è configurato in un oggetto proxy.ProxyServer. La connessione al server proxy (definita dall'attributo host) utilizza il protocollo definito nell'attributo scheme. Se non viene specificato scheme, la connessione proxy viene impostata su http.
Se non è definito alcun port in un oggetto proxy.ProxyServer, la porta viene derivata dallo schema.
Le porte predefinite sono:
| Scheme | Porta |
|---|---|
| http | 80 |
| https | 443 |
| socks4 | 1080 |
| socks5 | 1080 |
Lista di bypass
I singoli server possono essere esclusi dal proxy con bypassList. Questo elenco potrebbe contenere
le seguenti voci:
[SCHEME://]HOST_PATTERN[:PORT]Trova tutti i nomi host che corrispondono al pattern
HOST_PATTERN. Un"."iniziale viene interpretato come un"*.".Esempi:
"foobar.com", "*foobar.com", "*.foobar.com", "*foobar.com:99", "https://x.*.y.com:99".Pattern Corrisponde a Non corrisponde a ".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"e"foofoobar.com"[SCHEME://]IP_LITERAL[:PORT]Trova gli URL che sono valori letterali di indirizzi IP. Concettualmente, questo è simile al primo caso, ma con casi speciali per gestire la canonicalizzazione letterale degli IP. Ad esempio, la corrispondenza con "[0:0:0::1]" è uguale alla corrispondenza con "[::1]" perché la canonicalizzazione IPv6 viene eseguita internamente.
Esempi:
127.0.1,[0:0::1],[::1]:80,https://[::1]:443IP_LITERAL/PREFIX_LENGTH_IN_BITSTrova qualsiasi URL contenente un valore letterale IP (
IP_LITERAL) compreso nell'intervallo specificato. L'intervallo IP (PREFIX_LENGTH_IN_BITS) è specificato utilizzando la notazione CIDR.Trova qualsiasi URL contenente un valore letterale IP compreso nell'intervallo specificato. L'intervallo IP viene specificato utilizzando la notazione CIDR. Esempi:
"192.168.1.1/16", "fefe:13::abc/33"<local>La stringa letterale
<local>corrisponde a nomi host semplici. Un nome host semplice non contiene punti e non è un valore letterale IP. Ad esempio,exampleelocalhostsono nomi host semplici, mentreexample.com,example.e[::1]non lo sono.Esempio:
"<local>"
Esempi
Il seguente codice imposta un proxy SOCKS 5 per le connessioni HTTP a tutti i server tranne foobar.com e utilizza connessioni dirette per tutti gli altri protocolli. Le impostazioni si applicano alle finestre normali e in incognito, poiché le finestre in incognito ereditano le impostazioni dalle finestre normali. Consulta anche la documentazione dell'API Types.
var config = {
mode: "fixed_servers",
rules: {
proxyForHttp: {
scheme: "socks5",
host: "1.2.3.4"
},
bypassList: ["foobar.com"]
}
};
browser.proxy.settings.set(
{value: config, scope: 'regular'},
function() {}
);
Il seguente codice imposta uno script PAC personalizzato.
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" +
"}"
}
};
browser.proxy.settings.set(
{value: config, scope: 'regular'},
function() {}
);
Lo snippet successivo esegue una query sulle impostazioni del proxy attualmente in vigore. Le impostazioni del proxy effettive possono essere determinate da un'altra estensione o da una policy. Per maggiori dettagli, consulta la documentazione dell'API Types.
browser.proxy.settings.get(
{'incognito': false},
function(config) {
console.log(JSON.stringify(config));
}
);
Tieni presente che l'oggetto value passato a set() non è identico all'oggetto value passato alla funzione di callback di get(). Quest'ultimo conterrà un elemento rules.proxyForHttp.port.
Tipi
Mode
Enum
"direct"
"auto_detect"
"pac_script"
"fixed_servers"
"system"
PacScript
Un oggetto contenente informazioni sulla configurazione automatica del proxy. Deve essere compilato un solo campo.
Proprietà
-
dati
stringa facoltativa
Uno script PAC.
-
obbligatorio
boolean facoltativo
Se impostato su true, uno script PAC non valido impedirà allo stack di rete di tornare alle connessioni dirette. Il valore predefinito è false.
-
url
stringa facoltativa
URL del file PAC da utilizzare.
ProxyConfig
Un oggetto che incapsula una configurazione proxy completa.
Proprietà
-
modalità
"direct" = Non utilizzare mai un proxy "auto_detect" = Rileva automaticamente le impostazioni del proxy "pac_script" = Utilizza lo script PAC specificato "fixed_servers" = Specifica manualmente i server proxy "system" = Utilizza le impostazioni del proxy di sistema
-
pacScript
PacScript facoltativo
Lo script di configurazione automatica del proxy (PAC) per questa configurazione. Utilizza questa opzione per la modalità "pac_script".
-
regole
ProxyRules facoltativo
Le regole del proxy che descrivono questa configurazione. Utilizza questa opzione per la modalità "fixed_servers".
ProxyRules
Un oggetto che incapsula l'insieme di regole del proxy per tutti i protocolli. Utilizza "singleProxy" o (un sottoinsieme di) "proxyForHttp", "proxyForHttps", "proxyForFtp" e "fallbackProxy".
Proprietà
-
bypassList
string[] facoltativo
Elenco di server a cui connettersi senza un server proxy.
-
fallbackProxy
ProxyServer facoltativo
Il server proxy da utilizzare per tutto il resto o se uno dei proxyFor… specifici non è specificato.
-
proxyForFtp
ProxyServer facoltativo
Il server proxy da utilizzare per le richieste FTP.
-
proxyForHttp
ProxyServer facoltativo
Il server proxy da utilizzare per le richieste HTTP.
-
proxyForHttps
ProxyServer facoltativo
Il server proxy da utilizzare per le richieste HTTPS.
-
singleProxy
ProxyServer facoltativo
Il server proxy da utilizzare per tutte le richieste per URL (ovvero http, https e ftp).
ProxyServer
Un oggetto che incapsula la specifica di un singolo server proxy.
Proprietà
-
host
stringa
Il nome host o l'indirizzo IP del server proxy. I nomi host devono essere in ASCII (nel formato Punycode). IDNA non è ancora supportato.
-
porta
number optional
La porta del server proxy. Per impostazione predefinita, viene utilizzata una porta che dipende dallo schema.
-
schema
Schema facoltativo
Lo schema (protocollo) del server proxy stesso. Il valore predefinito è "http".
Scheme
Enum
"http"
"https"
"quic"
"socks4"
"socks5"
Proprietà
settings
Impostazioni del proxy da utilizzare. Il valore di questa impostazione è un oggetto ProxyConfig.
Eventi
onProxyError
browser.proxy.onProxyError.addListener(
callback: function,
)
Invia notifiche sugli errori del proxy.
Parametri
-
callback
funzione
Il parametro
callbackha il seguente aspetto:(details: object) => void
-
dettagli
oggetto
-
dettagli
stringa
Dettagli aggiuntivi sull'errore, ad esempio un errore di runtime JavaScript.
-
errore
stringa
La descrizione dell'errore.
-
fatal
booleano
Se true, l'errore era irreversibile e la transazione di rete è stata interrotta. In caso contrario, viene utilizzata una connessione diretta.
-
-