Proxy Auto-Configuration (PAC) file

A Proxy Auto-Configuration (PAC) file is a JavaScript function that determines whether web browser requests (HTTP, HTTPS, and FTP) go directly to the destination or are forwarded to a web proxy server. The JavaScript function contained in the PAC file defines the function:

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

ret = FindProxyForURL(url, host);

Syntax

function FindProxyForURL(url, host)

Parameters

url

The full URL being accessed.

host

The hostname extracted from the URL. This is only for convenience; it is the same string as between :// and the first : or / after that. The port number is not included in this parameter. It can be extracted from the URL when necessary.

Description

Returns a string describing the configuration. The format of this string is defined in return value format below.

Return value format

• The JavaScript function returns a single string
• If the string is null, no proxies should be used
• The string can contain any number of the following building blocks, separated by a semicolon:

DIRECT

Connections should be made directly, without any proxies

PROXYhost:port

The specified proxy should be used

SOCKShost:port

The specified SOCKS server should be used

Recent versions of Ffirefox support as well:

HTTP host:port

The specified proxy should be used

HTTPS host:port

The specified HTTPS proxy  should be used

SOCKS4 host:port

SOCKS5 host:port

The specified SOCKS server (with the specified SOCK version) should be used

If there are multiple semicolon-separated settings, the left-most setting will be used, until Firefox fails to establish the connection to the proxy. In that case, the next value will be used, etc.

The browser will automatically retry a previously unresponsive proxy after 30 minutes. Additional attempts will continue beginning at one hour, always adding 30 minutes to the elapsed time between attempts.

If all proxies are down, and there was no DIRECT option specified, the browser will ask if proxies should be temporarily ignored, and direct connections attempted. After 20 minutes, the browser will ask if proxies should be retried, asking again after an additional 40 minutes. Queries will continue, always adding 20 minutes to the elapsed time between queries.

Examples

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

Primary proxy is w3proxy:8080; if that goes down start using mozilla:8081 until the primary proxy comes up again.

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

Same as above, but if both proxies go down, automatically start making direct connections. (In the first example above, Netscape will ask user confirmation about making direct connections; in this case, there is no user intervention.)

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

Use SOCKS if the primary proxy goes down.

The auto-config file should be saved to a file with a .pac filename extension:

proxy.pac

And the MIME type set to:

application/x-ns-proxy-autoconfig

Next, you should configure your server to map the .pac filename extension to the MIME type.

Predefined functions and environment

These functions can be used in building the PAC file:

• Hostname based conditions
  • isPlainHostName()
  • dnsDomainIs()
  • localHostOrDomainIs()
  • isResolvable()
  • isInNet()
• Related utility functions
  • dnsResolve()
  • convert_addr()
  • myIpAddress()
  • dnsDomainLevels()
• URL/hostname based conditions
  • shExpMatch()
• Time based conditions
  • weekdayRange()
  • dateRange()
  • timeRange()
• There is one associative array already defined (because a JavaScript currently cannot define them on its own):
  • ProxyConfig.bindings

isPlainHostName()

Syntax

isPlainHostName(host)

Parameters

host

The hostname from the URL (excluding port number).

Description

True if and only if there is no domain name in the hostname (no dots).

Examples

function FindProxyForURL(url, host) {
  if (!isPlainHostName(host))
    return host;
}

//returns "www.mozilla.org"

function FindProxyForURL(url, host) {
  if (isPlainHostName("www"))
    return "isPlainHostName is true";
  return "isPlainHostName is false";
}

//returns "true"

dnsDomainIs()

Syntax

dnsDomainIs(host, domain)

Parameters

host

Is the hostname from the URL.

domain

Is the domain name to test the hostname against.

Description

Returns true if and only if the domain of hostname matches.

Examples

function FindProxyForURL(url, host) {
  if (dnsDomainIs("www.mozilla.org", ".mozilla.org"))
    return "dnsDomainIs is true";
  return "dnsDomainIs is false";
}

//returns "true"

function FindProxyForURL(url, host) {
  if (dnsDomainIs("www", ".mozilla.org"))
    return "dnsDomainIs is true";
  return "dnsDomainIs is false";
}

//returns "false"

function FindProxyForURL(url, host) {
  if (dnsDomainIs("www.mozilla.org", ".mozilla.org"))
    return "dnsDomainIs is true";
  return "dnsDomainIs is false";
}

//returns "false"

localHostOrDomainIs()

Syntax

localHostOrDomainIs(host, hostdom)

Parameters

host

The hostname from the URL.

hostdom

Fully qualified hostname to match against.

Description

Is true if the hostname matches exactly the specified hostname, or if there is no domain name part in the hostname, but the unqualified hostname matches.

Examples

function FindProxyForURL(url, host) {
  if (localHostOrDomainIs("www.mozilla.org", "www.mozilla.org"))
    return "localHostOrDomainIs is true (exact match)";
  return "localHostOrDomainIs is false";
}

//returns "localHostOrDomainIs is true (exact match)"

function FindProxyForURL(url, host) {
  if (localHostOrDomainIs("www", "www.mozilla.org"))
    return "localHostOrDomainIs is true (hostname match, domain not specified))";
  return "localHostOrDomainIs is false";
}

//returns "localHostOrDomainIs is true (hostname match, domain not specified))"

function FindProxyForURL(url, host) {
  if (localHostOrDomainIs("www.google.com", "www.mozilla.org"))
    return "localHostOrDomainIs is true";
  return "localHostOrDomainIs is false (domain name mismatch)";
} 

// returns "localHostOrDomainIs is false (domain name mismatch)"

function FindProxyForURL(url, host) {
  if (localHostOrDomainIs("home.mozilla.org", "www.mozilla.org"))
    return "localHostOrDomainIs is true";
  return "localHostOrDomainIs is false (domain name mismatch)"; 
}

// returns "localHostOrDomainIs is false (hostname mismatch)"

isResolvable()

Syntax

isResolvable(host)

Parameters

host

is the hostname from the URL.

Tries to resolve the hostname. Returns true if succeeds.

Examples:

function FindProxyForURL(url, host) {
  if (isResolvable("www.mozilla.org"))
    return "isResolvable is true";
  return "isResolvable is false";
}

// returns "isResolvable is true"

isInNet()

Syntax

isInNet(host, pattern, mask)

Parameters

host

a DNS hostname, or IP address. If a hostname is passed, it will be resolved into an IP address by this function.

pattern

an IP address pattern in the dot-separated format.

mask

mask for the IP address pattern informing which parts of the IP address should be matched against. 0 means ignore, 255 means match.

True if and only if the IP address of the host matches the specified IP address pattern.

Pattern and mask specification is done the same way as for SOCKS configuration.

Examples:

function FindProxyForURL(url, host) {
// put in the address returned by dnsResolve (see next example)
  if (isInNet(host, "63.245.213.24", "255.255.255.255"))
    return "isInNet is true";
  return "isInNet is false";
}

// returns "isInNet is true"

dnsResolve()

dnsResolve(host)

Parameters

host

hostname to resolve.

Resolves the given DNS hostname into an IP address, and returns it in the dot-separated format as a string.

Example

function FindProxyForURL(url, host) {
  return dnsResolve("www.mozilla.org");
} 

//returns the string "104.16.41.2"

convert_addr()

Syntax

convert_addr(ipaddr)

Parameters

ipaddr

Any dotted address such as an IP address or mask.

Concatenates the four dot-separated bytes into one 4-byte word and converts it to decimal.

Example

function FindProxyForURL(url, host) {
  return convert_addr("104.16.41.2");
} 

//returns the decimal number 1745889538

myIpAddress()

Syntax

myIpAddress()

Parameters

(none)

Returns the server IP address of the machine Firefox is running on, as a string in the dot-separated integer format.

Example

function FindProxyForURL(url, host) {
  return myIpAddress();
} 

//returns the string "127.0.1.1" if you were running Firefox on that localhost

dnsDomainLevels()

Syntax

dnsDomainLevels(host)

Parameters

host

is the hostname from the URL.

Returns the number (integer) of DNS domain levels (number of dots) in the hostname.

Examples:

function FindProxyForURL(url, host) {
  return dnsDomainLevels("www");
}

//returns 0

function FindProxyForURL(url, host) {
  return dnsDomainLevels("mozilla.org");
}

//returns 1

function FindProxyForURL(url, host) {
  return dnsDomainLevels("www.mozilla.org");
}

//returns 2

shExpMatch()

Syntax

shExpMatch(str, shexp)

Parameters

str

is any string to compare (e.g. the URL, or the hostname).

shexp

is a shell expression to compare against.

Returns true if the string matches the specified shell expression.

Currently, the patterns are shell expressions, not regular expressions.

Examples

function FindProxyForURL(url, host) {
  return shExpMatch("https://home.netscape.com/people/ari/index.html", "*/ari/*");
}

//returns true

function FindProxyForURL(url, host) {
  return shExpMatch("https://home.netscape.com/people/montulli/index.html", "*/ari/*");
}

//returns false

weekdayRange()

Syntax

weekdayRange(wd1, wd2, gmt)

Parameters

wd1 and wd2

One of the ordered weekday strings:

"SUN"|"MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"

gmt

Is either the string "GMT" or is left out.

Only the first parameter is mandatory. Either the second, the third, or both may be left out.

If only one parameter is present, the function returns a value of true on the weekday that the parameter represents. If the string "GMT" is specified as a second parameter, times are taken to be in GMT. Otherwise, they are assumed to be in the local timezone.

If both wd1 and wd1 are defined, the condition is true if the current weekday is in between those two ordered weekdays. Bounds are inclusive, but the bounds are ordered. If the "GMT" parameter is specified, times are taken to be in GMT. Otherwise, the local timezone is used.

Examples

function FindProxyForURL(url, host) {
  return weekdayRange("MON", "FRI");
}

//returns true Monday through Friday (local timezone)

function FindProxyForURL(url, host) {
  return weekdayRange("MON", "FRI", "GMT");
}

//returns true Monday through Friday (GMT timezone)

function FindProxyForURL(url, host) {
  return weekdayRange("SAT");
}

//returns true true on Saturdays local time

function FindProxyForURL(url, host) {
  return weekdayRange("SAT", "GMT");
}

//returns true on Saturdays GMT time

function FindProxyForURL(url, host) {
  return weekdayRange("FRI", "MON");
}

//returns true Friday and Monday only (note, order does matter!)

dateRange()

Syntax

dateRange(<day1>, <month1>, <year1>, <day2>, <month2>, <year2>, <gmt>)

Parameters

day

Is the ordered day of the month between 1 and 31 (as an integer).

1|2|3|4|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31

month

Is one of the ordered month strings below.

"JAN"|"FEB"|"MAR"|"APR"|"MAY"|"JUN"|"JUL"|"AUG"|"SEP"|"OCT"|"NOV"|"DEC"

year

Is the ordered full year integer number. For example, 2016 (not 16).

gmt

Is either the string "GMT", which makes time comparison occur in GMT timezone, or is left out. If left unspecified, times are taken to be in the local timezone.

If only a single value is specified (from each category: day, month, year), the function returns a true value only on days that match that specification. If both values are specified, the result is true between those times, including bounds, but the bounds are ordered.

Examples

function FindProxyForURL(url, host) {
  return dateRange(1);
}

//returns true on the first day of each month, local timezone

function FindProxyForURL(url, host) {
  return dateRange(1, "GMT")
}

//returns true on the first day of each month, GMT timezone

function FindProxyForURL(url, host) {
  return dateRange(1, 15);
}

//returns true on the first half of each month

function FindProxyForURL(url, host) {
  return dateRange(24, "DEC");
}

//returns true on 24th of December each year

function FindProxyForURL(url, host) {
  return dateRange("JAN", "MAR");
}

//returns true on the first quarter of the year

function FindProxyForURL(url, host) {
  return dateRange(1, "JUN", 15, "AUG");
}

//returns true from June 1st until August 15th, each year (including June 1st and August 15th)

function FindProxyForURL(url, host) {
  return dateRange(1, "JUN", 1995, 15, "AUG", 1995);
}

//returns true from June 1st, 1995, until August 15th, same year

function FindProxyForURL(url, host) {
  return dateRange("OCT", 1995, "MAR", 1996);
}

//returns true from October 1995 until March 1996 (including the entire month of October 1995 and March 1996)

function FindProxyForURL(url, host) {
  return dateRange(1995);
}

//returns true during the entire year of 1995

function FindProxyForURL(url, host) {
  return dateRange(1995, 1997);
}

//returns true from beginning of year 1995 until the end of year 1997

timeRange()

Syntax

timeRange(<hour1>, <min1>, <sec1>, <hour2>, <min2>, <sec2>, <gmt>)

Parameters

hour

Is the hour from 0 to 23. (0 is midnight, 23 is 11 pm.)

min

Minutes from 0 to 59.

sec

Seconds from 0 to 59.

gmt

Either the string "GMT" for GMT timezone, or not specified, for local timezone.

If only a single value is specified (from each category: hour, minute, second), the function returns a true value only at times that match that specification. If both values are specified, the result is true between those times, including bounds, but the bounds are ordered.

Examples

function FindProxyForURL(url, host) {
  return timerange(12);
}

//returns true from noon to 1pm

function FindProxyForURL(url, host) {
  return timerange(12, 13);
}

//returns true from noon to 1pm

function FindProxyForURL(url, host) {
  return timerange(12, "GMT");
}

//true from noon to 1pm, in GMT timezone

function FindProxyForURL(url, host) {
  return timerange(9, 17);
}

//returns true from 9am to 5pm

function FindProxyForURL(url, host) {
  return timerange(8, 30, 17, 00);
}

//returns true from 8:30am to 5:00pm

function FindProxyForURL(url, host) {
  return timerange(0, 0, 0, 0, 0, 30);
}

//returns true between midnight and 30 seconds past midnight

Example 1

Use proxy for everything except local hosts

All hosts which aren't fully qualified, or the ones that are in local domain, will be connected to directly. Everything else will go through w3proxy:8080. If the proxy goes down, connections become direct automatically:

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

Example 2

As above, but use proxy for local servers which are outside the firewall

If there are hosts (such as the main Web server) that belong to the local domain but are outside the firewall and are only reachable through the proxy server, those exceptions can be handled using the localHostOrDomainIs() function:

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

The above example will use the proxy for everything except local hosts in the mozilla.org domain, with the further exception that hosts www.mozilla.org and merchant.mozilla.org will go through the proxy.

Example 3

Use proxy only if cannot resolve host

This example will work in an environment where the internal DNS server is set up so that it can only resolve internal host names, and the goal is to use a proxy only for hosts that aren't resolvable:

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

The above requires consulting the DNS every time; it can be grouped intelligently with other rules so that DNS is consulted only if other rules do not yield a result:

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

Example 4

Subnet based decisions

In this example all of the hosts in a given subnet are connected-to directly, others are connected through the proxy:

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

Again, use of the DNS server in the above can be minimized by adding redundant rules in the beginning:

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

Example 5

Load balancing/routing based on URL patterns

This example is more sophisticated. There are four (4) proxy servers; one of them is a hot stand-by for all of the other ones, so if any of the remaining three goes down the fourth one will take over. Furthermore, the three remaining proxy servers share the load based on URL patterns, which makes their caching more effective (there is only one copy of any document on the three servers -- as opposed to one copy on each of them). The load is distributed like this:

All local accesses are desired to be direct. All proxy servers run on the port 8080 (they don't need to). Note how strings can be concatenated with the + operator in JavaScript.

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

Example 6

Setting a proxy for a specific protocol

Most of the standard JavaScript functionality is available for use in the FindProxyForURL() function. As an example, to set different proxies based on the protocol the substring() function can be used:

function FindProxyForURL(url, host) {
  if (url.substring(0, 5) == "http:") {
    return "PROXY http-proxy.mydomain.com:8080";
  }
  else if (url.substring(0, 4) == "ftp:") {
    return "PROXY ftp-proxy.mydomain.com:8080";
  }
  else if (url.substring(0, 7) == "gopher:") {
    return "PROXY gopher-proxy.mydomain.com:8080";
  }
  else if (url.substring(0, 6) == "https:" ||
           url.substring(0, 6) == "snews:") {
    return "PROXY security-proxy.mydomain.com:8080";
  } else {
    return "DIRECT";
  }
}

For example:

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