Proxy Auto-Configuration (PAC) Datei

Syntax

function FindProxyForURL(url, host) {
  // …
}

Parameter

url

Die URL, auf die zugegriffen wird. Die Pfad- und Query-Komponenten von https:// URLs werden entfernt. In Chrome (Versionen 52 bis 73) können Sie dies deaktivieren, indem Sie PacHttpsUrlStrippingEnabled in der Richtlinie auf false setzen oder mit dem --unsafe-pac-url Kommandozeilen-Flag starten (in Chrome 74 funktioniert nur das Flag, und ab 75 gibt es keine Möglichkeit, das Entfernen von Pfaden zu deaktivieren; ab Chrome 81 gilt das Entfernen von Pfaden nicht für HTTP-URLs, es besteht jedoch Interesse daran, dieses Verhalten an HTTPS anzupassen); in Firefox ist die Einstellung network.proxy.autoconfig_url.include_path.

host

Der aus der URL extrahierte Hostname. Dies dient nur der Bequemlichkeit; es ist die gleiche Zeichenfolge wie zwischen :// und dem ersten : oder / danach. Die Portnummer ist in diesem Parameter nicht enthalten. Sie kann bei Bedarf aus der URL extrahiert werden.

Beschreibung

Gibt eine Zeichenfolge zurück, die die Konfiguration beschreibt. Das Format dieser Zeichenfolge ist im Abschnitt Rückgabewertformat unten definiert.

Rückgabewertformat

• Die JavaScript-Funktion gibt eine einzelne Zeichenfolge zurück.
• Wenn die Zeichenfolge null ist, sollten keine Proxies verwendet werden.
• Die Zeichenfolge kann eine beliebige Anzahl der folgenden Bausteine enthalten, die durch ein Semikolon getrennt sind:

DIRECT

Verbindungen sollten direkt hergestellt werden, ohne Proxies

PROXY host:port

Der angegebene Proxy sollte verwendet werden

SOCKS host:port

Der angegebene SOCKS-Server sollte verwendet werden

Neuere Versionen von Firefox unterstützten ebenfalls:

HTTP host:port

Der angegebene Proxy sollte verwendet werden

HTTPS host:port

Der angegebene HTTPS-Proxy sollte verwendet werden

SOCKS4 host:port, SOCKS5 host:port

Der angegebene SOCKS-Server (mit der angegebenen SOCKS-Version) sollte verwendet werden

Wenn es mehrere durch Semikolon getrennte Einstellungen gibt, wird die linkeste Einstellung verwendet, bis Firefox die Verbindung zum Proxy nicht herstellen kann. In diesem Fall wird der nächste Wert verwendet usw.

Der Browser versucht automatisch, einen zuvor nicht reagierenden Proxy nach 30 Minuten erneut zu verwenden. Zusätzliche Versuche werden mit einem Abstand von einer Stunde fortgesetzt, wobei immer 30 Minuten zur verstrichenen Zeit zwischen den Versuchen hinzugefügt werden.

Sollten alle Proxies ausfallen und es keine DIRECT-Option geben, fragt der Browser, ob die Proxies vorübergehend ignoriert und direkte Verbindungen versucht werden sollen. Nach 20 Minuten fragt der Browser, ob die Proxies erneut versucht werden sollen, und fragt nach weiteren 40 Minuten erneut. Die Anfragen werden fortgesetzt, wobei immer 20 Minuten zur verstrichenen Zeit zwischen den Abfragen hinzugefügt werden.

Beispiele

PROXY w3proxy.netscape.com:8080; PROXY mozilla.netscape.com:8081

Primärer Proxy ist w3proxy:8080; wenn dieser ausfällt, wird mozilla:8081 verwendet, bis der primäre Proxy wieder funktioniert.

PROXY w3proxy.netscape.com:8080; PROXY mozilla.netscape.com:8081; DIRECT

Wie oben, aber wenn beide Proxies ausfallen, werden automatisch direkte Verbindungen hergestellt. (Im ersten Beispiel oben bittet Netscape um eine Bestätigung des Benutzers für direkte Verbindungen; in diesem Fall ist keine Benutzerintervention erforderlich.)

PROXY w3proxy.netscape.com:8080; SOCKS socks:1080

Verwenden Sie SOCKS, wenn der primäre Proxy ausfällt.

Die Autokonfigurationsdatei sollte unter einem Dateinamen mit der Endung .pac gespeichert werden: proxy.pac.

Und der MIME-Typ sollte auf application/x-ns-proxy-autoconfig gesetzt werden.

Als nächstes sollten Sie Ihren Server so konfigurieren, dass die .pac-Dateierweiterung dem MIME-Typ zugeordnet wird.

Vorgegebene Funktionen und Umgebung

Diese Funktionen können beim Erstellen der PAC-Datei verwendet werden:

• Bedingte Hostname-Funktionen

  • isPlainHostName()
  • dnsDomainIs()
  • localHostOrDomainIs()
  • isResolvable()
  • isInNet()

• Zugehörige Hilfsfunktionen

  • dnsResolve()
  • convert_addr()
  • myIpAddress()
  • dnsDomainLevels()

• Bedingte URL/Hostname-Funktionen

  • shExpMatch()

• Zeitbasierte Funktionen

  • weekdayRange()
  • dateRange()
  • timeRange()

• Logging-Hilfsfunktion

  • alert()

• Es gab ein bereits definiertes assoziatives Array (Objekt), da der JavaScript-Code damals nicht in der Lage war, es selbst zu definieren:

  • ProxyConfig.bindings Veraltet

isPlainHostName()

Syntax

isPlainHostName(host)

Parameter

host

Der Hostname aus der URL (ohne Portnummer).

Beschreibung

Gibt true zurück, wenn und nur wenn es keinen Domainnamen im Hostnamen gibt (keine Punkte).

Beispiele

isPlainHostName("www.mozilla.org"); // false
isPlainHostName("www"); // true

dnsDomainIs()

Syntax

dnsDomainIs(host, domain)

Parameter

host

Ist der Hostname aus der URL.

domain

Ist der Domainname zum Prüfen des Hostnamens.

Beschreibung

Gibt true zurück, wenn und nur wenn die Domain des Hostnamens übereinstimmt.

Beispiele

dnsDomainIs("www.mozilla.org", ".mozilla.org") // true
dnsDomainIs("www", ".mozilla.org") // false

localHostOrDomainIs()

Syntax

localHostOrDomainIs(host, hostDom)

Parameter

host

Der Hostname aus der URL.

hostDom

Vollständig qualifizierter Hostname zum Abgleichen.

Beschreibung

Ist true, wenn der Hostname genau mit dem angegebenen Hostnamen übereinstimmt oder wenn es keinen Domainnamen-Teil im Hostnamen gibt, aber der nicht qualifizierte Hostname übereinstimmt.

Beispiele

localHostOrDomainIs("www.mozilla.org", "www.mozilla.org") // true (exact match)
localHostOrDomainIs("www", "www.mozilla.org") // true (hostname match, domain not specified)
localHostOrDomainIs("www.google.com", "www.mozilla.org") // false (domain name mismatch)
localHostOrDomainIs("home.mozilla.org", "www.mozilla.org") // false (hostname mismatch)

isResolvable()

Syntax

isResolvable(host)

Parameter

host

ist der Hostname aus der URL.

Versucht, den Hostnamen aufzulösen. Gibt true zurück, wenn es gelingt.

Beispiele

isResolvable("www.mozilla.org") // true

isInNet()

Syntax

isInNet(host, pattern, mask)

Parameter

host

ein DNS-Hostname oder eine IP-Adresse. Wenn ein Hostname übergeben wird, wird er von dieser Funktion in eine IP-Adresse aufgelöst.

pattern

ein IP-Adressenmuster im Punkt-getrennten Format.

mask

Maske für das IP-Adressenmuster, die informiert, welche Teile der IP-Adresse mit dem Muster übereinstimmen sollen. 0 bedeutet ignorieren, 255 bedeutet übereinstimmen.

Gibt true zurück, wenn und nur wenn die IP-Adresse des Hosts mit dem angegebenen IP-Adressenmuster übereinstimmt.

Das Muster- und die Maskenspezifikation erfolgt auf die gleiche Weise wie bei der SOCKS-Konfiguration.

Beispiele

function FindProxyForURL(url, host) {
  alert(isInNet(host, "192.0.2.172", "255.255.255.255"));
  // "PAC-alert: true"
}

dnsResolve()

dnsResolve(host)

Parameter

host

Hostname zum Auflösen.

Löst den angegebenen DNS-Hostname in eine IP-Adresse auf und gibt ihn im Punkt-getrennten Format als Zeichenfolge zurück.

Beispiel

dnsResolve("www.mozilla.org"); // returns the string "104.16.41.2"

convert_addr()

Syntax

convert_addr(ipaddr)

Parameter

ipaddr

Jede punktierte Adresse wie eine IP-Adresse oder Maske.

Verkettet die vier Punkt-getrennten Bytes zu einem 4-Byte-Wort und konvertiert es in dezimal.

Beispiel

convert_addr("192.0.2.172"); // returns the decimal number 1745889538

myIpAddress()

Syntax

myIpAddress()

Parameter

(Keine)

Rückgabewert

Gibt die Server-IP-Adresse des Computers zurück, auf dem Firefox ausgeführt wird, als Zeichenfolge im Punkt-getrennten Integerformat. Um hilfreicher zu sein, wird es mehrere Alternativen ausprobieren, bevor es auf die Loopback-Adresse (wie 127.0.0.1) zurückgreift.

Beispiel

myIpAddress()

dnsDomainLevels()

Syntax

dnsDomainLevels(host)

Parameter

host

ist der Hostname aus der URL.

Gibt die Anzahl (Integer) der DNS-Domain-Level (Anzahl der Punkte) im Hostnamen zurück.

Beispiele

dnsDomainLevels("www") // 0
dnsDomainLevels("mozilla.org") // 1
dnsDomainLevels("www.mozilla.org"); // 2

shExpMatch()

Syntax

shExpMatch(str, shExp)

Parameter

str

ist eine beliebige Zeichenfolge zum Vergleich (z. B. die URL oder der Hostname).

shExp

ist ein Shell-Ausdruck zum Vergleich.

Gibt true zurück, wenn die Zeichenfolge dem angegebenen Shell-Glob-Ausdruck entspricht.

Die Unterstützung für die spezielle Glob-Ausdruckssyntax variiert je nach Browser: * (übereinstimmen mit einer beliebigen Anzahl von Zeichen) und ? (übereinstimmen mit einem Zeichen) werden immer unterstützt, während [Zeichen] und [^Zeichen] zusätzlich von einigen Implementierungen (einschließlich Firefox) unterstützt werden.

Beispiele

shExpMatch("http://home.netscape.com/people/ari/index.html", "*/ari/*"); // returns true
shExpMatch("http://home.netscape.com/people/montulli/index.html", "*/ari/*"); // returns false

weekdayRange()

Syntax

weekdayRange(wd1, wd2)
weekdayRange(wd1, wd2, gmt)

Parameter

wd1 und wd2

Einer der geordneten Wochentag-Zeichenfolgen: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"

gmt

Ist entweder die Zeichenfolge "GMT" oder wird weggelassen.

Nur der erste Parameter ist obligatorisch. Entweder der zweite, der dritte oder beide können weggelassen werden.

Wenn nur ein Parameter vorhanden ist, gibt die Funktion einen true Wert am Wochentag zurück, den der Parameter darstellt. Wenn die Zeichenkette "GMT" als zweiter Parameter angegeben wird, werden Zeiten in GMT genommen. Andernfalls wird die lokale Zeitzone angenommen.

Wenn sowohl wd1 als auch wd2 definiert sind, ist die Bedingung true, wenn der aktuelle Wochentag zwischen diesen beiden geordneten Wochentagen liegt. Grenzen sind inklusiv, aber die Grenzen sind geordnet. Wenn der "GMT"-Parameter angegeben ist, werden Zeiten in GMT genommen. Andernfalls wird die lokale Zeitzone verwendet.

Beispiele

weekdayRange("MON", "FRI") // returns true Monday through Friday (local timezone)
weekdayRange("MON", "FRI", "GMT") // returns true Monday through Friday (GMT timezone)
weekdayRange("SAT") // returns true on Saturdays local time
weekdayRange("SAT", "GMT") // returns true on Saturdays GMT time
weekdayRange("FRI", "MON") // returns true Friday and Monday only (note, the order does matter!)

dateRange()

Syntax

dateRange(dayOrMonthOrYear)
dateRange(dayOrMonthOrYear, gmt)  // ambiguity is resolved by assuming year is greater than 31
dateRange(day1, day2)
dateRange(day1, day2, gmt)
dateRange(month1, month2)
dateRange(month1, month2, gmt)
dateRange(year1, year2)
dateRange(year1, year2, gmt)
dateRange(day1, month1, day2, month2)
dateRange(day1, month1, day2, month2, gmt)
dateRange(month1, year1, month2, year2)
dateRange(month1, year1, month2, year2, gmt)
dateRange(day1, month1, year1, day2, month2, year2)
dateRange(day1, month1, year1, day2, month2, year2, gmt)

Parameter

day

Ist der geordnete Tag im Monat zwischen 1 und 31 (als Integer).

month

Ist eine der geordneten Monats-Zeichenfolgen: "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC".

year

Ist die geordnete Ganzzahl des Jahres. Zum Beispiel 2016 (nicht 16).

gmt

Ist entweder die Zeichenkette "GMT", die den Zeitvergleich in der GMT-Zeitzone vornimmt, oder wird weggelassen. Wird keine Angabe gemacht, werden die Zeiten in der lokalen Zeitzone angenommen.

Wenn nur ein einzelner Wert angegeben wird (aus jeder Kategorie: Tag, Monat, Jahr), gibt die Funktion einen true Wert nur an Tagen zurück, die dieser Angabe entsprechen. Wenn beide Werte angegeben sind, ist das Ergebnis true zwischen diesen Zeiten, einschließlich der Grenzen, aber die Grenzen sind geordnet.

Beispiele

dateRange(1) // returns true on the first day of each month, local timezone
dateRange(1, "GMT") // returns true on the first day of each month, GMT timezone
dateRange(1, 15) // returns true on the first half of each month
dateRange(24, "DEC");// returns true on 24th of December each year
dateRange("JAN", "MAR"); // returns true on the first quarter of the year

dateRange(1, "JUN", 15, "AUG");
// returns true from June 1st until August 15th, each year
// (including June 1st and August 15th)

dateRange(1, "JUN", 1995, 15, "AUG", 1995);
// returns true from June 1st, 1995, until August 15th, same year

dateRange("OCT", 1995, "MAR", 1996);
// returns true from October 1995 until March 1996
// (including the entire month of October 1995 and March 1996)

dateRange(1995);
// returns true during the entire year of 1995

dateRange(1995, 1997);
// returns true from beginning of year 1995 until the end of year 1997

timeRange()

Syntax

// The full range of expansions is analogous to dateRange.
timeRange(hour1, min1, sec1, hour2, min2, sec2)
timeRange(hour1, min1, sec1, hour2, min2, sec2, gmt)

Parameter

hour

Ist die Stunde von 0 bis 23. (0 ist Mitternacht, 23 ist 23 Uhr.)

min

Minuten von 0 bis 59.

sec

Sekunden von 0 bis 59.

gmt

Entweder die Zeichenkette "GMT" für GMT-Zeitzone oder nicht angegeben, für lokale Zeitzone.

Wenn nur ein einzelner Wert angegeben wird (aus jeder Kategorie: Stunde, Minute, Sekunde), gibt die Funktion einen true Wert nur zu den Zeiten zurück, die dieser Angabe entsprechen. Wenn beide Werte angegeben sind, ist das Ergebnis true zwischen diesen Zeiten, einschließlich der Grenzen, aber die Grenzen sind geordnet.

Beispiele

timeRange(12); // returns true from noon to 1pm
timeRange(12, 13) // returns true from noon to 1pm
timeRange(12, "GMT") // returns true from noon to 1pm, in the GMT timezone
timeRange(9, 17) // returns true from 9am to 5pm
timeRange(8, 30, 17, 0) // returns true from 8:30am to 5:00pm
timeRange(0, 0, 0, 0, 0, 30) // returns true between midnight and 30 seconds past midnight

alert()

Syntax

alert(message)

Parameter

message

Die Zeichenfolge zum Loggen

Protokolliert die Nachricht in der Browserkonsole.

Beispiele

alert(`${host} = ${dnsResolve(host)}`) // logs the host name and its IP address
alert("Error: shouldn't reach this clause.") // log a message

Beispiel 1

Proxy für alles außer lokalen Hosts verwenden

Alle Hosts, die nicht vollständig qualifiziert sind oder sich im lokalen Netzwerk befinden, werden direkt verbunden. Alles andere wird durch w3proxy.mozilla.org:8080 geleitet. Wenn der Proxy ausfällt, werden die Verbindungen automatisch direkt:

function FindProxyForURL(url, host) {
  if (isPlainHostName(host) || dnsDomainIs(host, ".mozilla.org")) {
    return "DIRECT";
  }
  return "PROXY w3proxy.mozilla.org:8080; DIRECT";
}

Beispiel 2

Wie oben, aber Proxy für lokale Server verwenden, die außerhalb der Firewall sind

Wenn es Hosts gibt (wie den Hauptwebserver), die zur lokalen Domain gehören, aber außerhalb der Firewall liegen und nur über den Proxyserver erreichbar sind, können diese Ausnahmen mit der Funktion localHostOrDomainIs() behandelt werden:

function FindProxyForURL(url, host) {
  if (
    (isPlainHostName(host) || dnsDomainIs(host, ".mozilla.org")) &&
    !localHostOrDomainIs(host, "www.mozilla.org") &&
    !localHostOrDomainIs(host, "merchant.mozilla.org")
  ) {
    return "DIRECT";
  }
  return "PROXY w3proxy.mozilla.org:8080; DIRECT";
}

Das obige Beispiel wird den Proxy für alles verwenden, außer für lokale Hosts in der mozilla.org-Domain, mit der weiteren Ausnahme, dass die Hosts www.mozilla.org und merchant.mozilla.org durch den Proxy geleitet werden.

Beispiel 3

Proxy nur verwenden, wenn Host nicht aufgelöst werden kann

Dieses Beispiel funktioniert in einer Umgebung, in der der interne DNS-Server so eingerichtet ist, dass er nur interne Hostnamen auflösen kann und das Ziel darin besteht, einen Proxy nur für nicht auflösbare Hosts zu verwenden:

function FindProxyForURL(url, host) {
  if (isResolvable(host)) {
    return "DIRECT";
  }
  return "PROXY proxy.example.com:8080";
}

Das oben genannte erfordert die Konsultation des DNS jedes Mal; es kann intelligent mit anderen Regeln gruppiert werden, so dass das DNS nur konsultiert wird, wenn andere Regeln kein Ergebnis liefern:

function FindProxyForURL(url, host) {
  if (
    isPlainHostName(host) ||
    dnsDomainIs(host, ".example.com") ||
    isResolvable(host)
  ) {
    return "DIRECT";
  }
  return "PROXY proxy.example.com:8080";
}

Beispiel 4

Subnetzbasierte Entscheidungen

In diesem Beispiel werden alle Hosts in einem bestimmten Subnetz direkt verbunden, andere über den Proxy:

function FindProxyForURL(url, host) {
  if (isInNet(host, "192.0.2.172", "255.255.0.0")) {
    return "DIRECT";
  }
  return "PROXY proxy.example.com:8080";
}

Auch hier kann die Nutzung des DNS-Servers durch Hinzufügen redundanter Regeln am Anfang minimiert werden:

function FindProxyForURL(url, host) {
  if (
    isPlainHostName(host) ||
    dnsDomainIs(host, ".example.com") ||
    isInNet(host, "192.0.2.0", "255.255.0.0")
  ) {
    return "DIRECT";
  }
  return "PROXY proxy.example.com:8080";
}

Beispiel 5

Lastverteilung/Routing basierend auf URL-Mustern

Dieses Beispiel ist raffinierter. Es gibt vier (4) Proxyserver; einer von ihnen ist ein heiße Stand-by für alle anderen, so dass, wenn einer der anderen ausfällt, der vierte ihn übernimmt. Darüber hinaus teilen sich die drei verbleibenden Proxyserver die Last basierend auf URL-Mustern, was ihr Caching effektiver macht (es gibt nur eine Kopie eines Dokuments auf den drei Servern - im Gegensatz zu einer Kopie auf jedem von ihnen). Die Last wird wie folgt verteilt:

Alle lokalen Zugriffe sollten direkt erfolgen. Alle Proxyserver laufen auf Port 8080 (sie müssen das nicht, Sie können einfach Ihren Port ändern, aber denken Sie daran, Ihre Konfigurationen auf beiden Seiten anzupassen). Beachten Sie, wie Zeichenfolgen mit dem + Operator in JavaScript verknüpft werden können.

function FindProxyForURL(url, host) {
  if (isPlainHostName(host) || dnsDomainIs(host, ".example.com")) {
    return "DIRECT";
  } else if (shExpMatch(host, "*.com")) {
    return "PROXY proxy1.example.com:8080; PROXY proxy4.example.com:8080";
  } else if (shExpMatch(host, "*.edu")) {
    return "PROXY proxy2.example.com:8080; PROXY proxy4.example.com:8080";
  }
  return "PROXY proxy3.example.com:8080; PROXY proxy4.example.com:8080";
}

Beispiel 6

Proxy für ein bestimmtes Protokoll festlegen

Die meisten der Standard-JavaScript-Funktionen sind in der FindProxyForURL() Funktion verfügbar. Zum Beispiel kann die Funktion startsWith() verwendet werden, um unterschiedliche Proxies basierend auf dem Protokoll festzulegen:

function FindProxyForURL(url, host) {
  if (url.startsWith("http:")) {
    return "PROXY http-proxy.example.com:8080";
  } else if (url.startsWith("ftp:")) {
    return "PROXY ftp-proxy.example.com:8080";
  } else if (url.startsWith("gopher:")) {
    return "PROXY gopher-proxy.example.com:8080";
  } else if (url.startsWith("https:") || url.startsWith("snews:")) {
    return "PROXY security-proxy.example.com:8080";
  }
  return "DIRECT";
}

Zum Beispiel:

if (shExpMatch(url, "http:*")) {
  return "PROXY http-proxy.example.com:8080";
}

Geschichte und Implementierung

Die Proxy-Auto-Konfiguration wurde in den späten 1990er Jahren gleichzeitig mit der Einführung von JavaScript in Netscape Navigator 2.0 eingeführt. Die Open-Source-Freigabe von Netscape führte letztendlich zu Firefox selbst.

Die "ursprünglichste" Implementierung von PAC und ihren JavaScript-Bibliotheken ist daher nsProxyAutoConfig.js, die in frühen Versionen von Firefox zu finden ist. Diese Utilities finden sich in vielen anderen Open-Source-Systemen einschließlich Chromium. Firefox integrierte später die Datei in ProxyAutoConfig.cpp als C++-Zeichenfolgenliteral. Um diese in eine eigene Datei zu extrahieren, reicht es aus, das Stück in JavaScript mit einem console.log Befehl zu kopieren, um es auszugeben.

Microsoft hat im Allgemeinen seine eigene Implementierung gemacht. Es gab einige Probleme mit ihren Bibliotheken, aber die meisten sind inzwischen behoben. Sie haben einige neue "Ex"-suffigierte Funktionen um die Adressverarbeitungsteile herum definiert, um IPv6 zu unterstützen. Die Funktion wird von Chromium unterstützt, aber noch nicht von Firefox (bugzilla #558253).

Siehe auch

• Proxy-Server
• MIME-Typen (IANA Media-Typen)
• Automatische Proxy-HTTP-Server-Konfiguration in Webbrowsern