├── README.md ├── INSTALL ├── pactester ├── pac_utils.js └── COPYING /README.md: -------------------------------------------------------------------------------- 1 | **I have stopped maintaining this version of pactester. Please use the version that comes with [pacparser](http://github.com/pacparser/pacparser). -Manu Garg** 2 | 3 | Pactester 4 | ========= 5 | 6 | Pactester is a tool to test Proxy Auto Configuration (PAC) files. PAC files are 7 | used by browsers to determine the "right" proxy for a URL. Since the PAC file 8 | evaluation mechanism is generated inside the browser and cannot be accessed 9 | from outside, the only way to tell which proxy your browser will use for a 10 | specific URL is manual inspection of the PAC file. But manual inspectiondoesn't really scale very well. Pactester resolves this problem. It makes use 11 | of JavaScript interpreter and netscape/mozilla APIs to evaluate the PAC files 12 | and automates the whole process. 13 | 14 | Pactester reads a PAC file, evaluates it in a JavaScript context and uses this 15 | PAC file's logic to determine the proxy for a specific URL. 16 | 17 | Usage: ./pactester <-p pacfile> <-u url> [-h host] [-c client_ip] 18 | ./pactester <-p pacfile> <-f urlslist> [-c client_ip] 19 | 20 | Options: 21 | -p pacfile: PAC file to test 22 | -u url: URL to test 23 | -h host: Host part of the URL 24 | -c client_ip: client IP address (defaults to IP address of the machine on which script is running) 25 | -f urlslist: a file containing list of URLs to be tested. 26 | 27 | Example: 28 | ./pactester -p wpad.dat -u http://www.google.com 29 | ./pactester -p wpad.dat -u http://www.google.com -c 192.168.1.105 30 | ./pactester -p wpad.dat -f url_list 31 | 32 | * How It Works? 33 | --------------- 34 | 35 | It evaluates the PAC file in a Javascript context. To do that it uses the 36 | JavaScript::SpiderMonkey perl module, which is a perl interface to Mozilla's 37 | C implementation of Javascript- Spidermonkey. 38 | 39 | PAC files use certain JavaScript functions. These functions have been defined 40 | in pac_utils.js file included with this tool (This file was generated using 41 | another file from Mozilla source code). Also, since JavaScript has no DNS 42 | resolving capability which is required by the "dnsResolve" and "myIpAddress" 43 | functions in the PAC files, these functions have been defined in perl and then 44 | exported to a JavaScript context. 45 | 46 | * Install 47 | --------- 48 | 49 | Please see 'INSTALL' in the root directory of the package. 50 | 51 | * How to use it? 52 | ---------------- 53 | 54 | Pactester can be used to determine the proxy for a single URL or a list of URLs. 55 | 56 | To determine the proxy for a single URL: 57 | ./pactester -p www.pac -u http://www.example.com 58 | 59 | For a list of URLs : 60 | ./pactester -p www.pac -f urllist 61 | where urllist is a file containing the list of URLs separated by newline. 62 | 63 | * Extending command line web clients: 64 | ------------------------------------ 65 | 66 | Pactester can be also be used to extend command line web clients like curl and 67 | perl-libwww library. 68 | 69 | To use it with curl: Right now, curl doesn't have the functionality to 70 | evaluate PAC files to find out proxy for a given URL. However, based on 71 | pactester, you can write a wrapper perl script around curl. This perl script 72 | will first find out the proxy for the URL, the way that pactester finds out, 73 | and then it will call curl with the option '-x "proxy server as returned by 74 | pactester method"'. 75 | 76 | Similarly, this method can be used inside perl-libwww web clients too. 77 | 78 | 79 | * Platforms 80 | --------- 81 | 82 | Pactester has been tested to work on Linux and Intel Macs. 83 | 84 | Author: Manu Garg 85 | Copyright (C) 2007 Google Inc. 86 | -------------------------------------------------------------------------------- /INSTALL: -------------------------------------------------------------------------------- 1 | Pactester consists of a perl script 'pactester' and a set of JavaScript 2 | functions defined in 'pac_utils.js'. Pactester doesn't really require any 3 | installation as such. You can just download it, extract it and start using it 4 | if you have all the dependencies installed on your system, which is usually not 5 | the case ;-). 6 | 7 | Dependencies: 'pactester' uses 'JavaSript::SpiderMonkey' perl module for 8 | JavaScript evaluation. JavaScript::SpiderMonkey in turn requires 'Spidermonkey' 9 | (Mozilla's implementation of JavaScript in C) and 'Log::Log4perl' module. 10 | However, to ease the installation process, pactester tarball comes with the 11 | source code of all 3 softwares. You can find them in 'build' dir inside the 12 | package. 13 | 14 | Automated Installation Using install.sh: 15 | ======================================= 16 | Starting with version 1.0.3, pactester comes with a cool install script. To use 17 | the script go to 'build' directory inside the package and run: 18 | ./install.sh [install_path] 19 | 20 | 'install_path' is the location where you want to install pactester. If you don't 21 | specify the install path, perl modules will be installed in the standard 22 | location (you'll need root access for that of course) and script will be left 23 | in the package directory. 24 | 25 | For example, running 'sudo ./install.sh' on my system, installs perl modules in 26 | /usr/local/{lib,share}/perl/5.8.8/. 27 | 28 | Sometimes it can be very desirable to install pactester in a non-standard 29 | location, for example if you don't have root access or you want to install it 30 | in your home directory to avoid cluttering the system. Well, it's very simple. 31 | Just run install.sh as: 32 | ./install.sh $HOME/tools/ 33 | 34 | This will install perl modules in $HOME/tools/{lib,share}/perl/. and pactester 35 | in $HOME/tools. Install script takes care of updating the library search path 36 | in 'pactester', so after installation, you can run pactester simply as: 37 | $HOME/tools/pactester 38 | 39 | 40 | Manual Installation: 41 | =================== 42 | 43 | Of course, if you don't like a script doing some "magic" on your system, you 44 | can choose to install pactester manually. 45 | 46 | Install Spidermonkey 47 | -------------------- 48 | 49 | * Go to build directory and untar Spidermonkey tarball: 50 | manugarg@hobbiton:~/pactester/build$ cd build 51 | manugarg@hobbiton:~/pactester/build$ tar xzfv js-1.5.tar.gz 52 | 53 | * Build js and install libjs.so 54 | manugarg@hobbiton:~/pactester/build$ cd js/src 55 | manugarg@hobbiton:~/pactester/build$ make -f Makefile.ref 56 | manugarg@hobbiton:~/pactester/build$ sudo cp Linux_All_DBG.OBJ/libjs.so /usr/lib 57 | (If you don't want to copy it to /usr/lib, copy it to some other directory and 58 | point your environment variable LD_LIBRARY_PATH there.) 59 | 60 | Install Log::Log4perl 61 | --------------------- 62 | (needed only if you don't have it already) 63 | 64 | * Extract Log-Log4perl tarball: 65 | manugarg@hobbiton:~/pactester/build$ tar xzvf Log-Log4perl-1.08.tar.gz 66 | 67 | * Build and install Log::Log4perl like any other perl module: 68 | manugarg@hobbiton:~/pactester/build$ cd Log-Log4perl-1.08 69 | manugarg@hobbiton:~/pactester/build$ perl Makefile.PL 70 | manugarg@hobbiton:~/pactester/build$ make 71 | manugarg@hobbiton:~/pactester/build$ sudo make install 72 | 73 | Install JavaScript::SpiderMonkey 74 | -------------------------------- 75 | * Extract JavaScript-SpiderMonkey tarball: 76 | manugarg@hobbiton:~/pactester/build$ tar xzfv JavaScript-SpiderMonkey-0.17.tar.gz 77 | 78 | * Make sure that JavaScript-SpiderMonkey and js are at same directory level 79 | manugarg@hobbiton:~/pactester/build$ ls . 80 | JavaScript-SpiderMonkey-0.17 81 | JavaScript-SpiderMonkey-0.17.tar.gz 82 | js 83 | js-1.5.tar.gz 84 | 85 | * Now build and install JavaScript-SpiderMonkey like any other perl module: 86 | manugarg@hobbiton:~/pactester/build$ cd JavaScript-SpiderMonkey-0.17 87 | manugarg@hobbiton:~/pactester/build$ perl Makefile.PL 88 | manugarg@hobbiton:~/pactester/build$ make 89 | manugarg@hobbiton:~/pactester/build$ sudo make install 90 | 91 | -- and you're good to go! Have fun. 92 | 93 | Manu Garg, http://www.manugarg.com, 2006 94 | -------------------------------------------------------------------------------- /pactester: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl -w 2 | 3 | # Copyright (C) 2006 Google Inc. 4 | # Author: Manu Garg 5 | # 6 | # pactester is a tool to test proxy auto-configuration (PAC) files. Please read 7 | # README file included with this package for more information about this tool. 8 | # 9 | # pactester is free software; you can redistribute it and/or 10 | # modify it under the terms of the GNU Lesser General Public 11 | # License as published by the Free Software Foundation; either 12 | # version 2.1 of the License, or (at your option) any later version. 13 | 14 | # pactester is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 | # Lesser General Public License for more details. 18 | 19 | # You should have received a copy of the GNU Lesser General Public 20 | # License along with this library; if not, write to the Free Software 21 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA 22 | 23 | use strict; 24 | 25 | use FindBin; 26 | use Getopt::Std; 27 | use Socket; 28 | use Sys::Hostname; 29 | 30 | #use lib qw(INCPATH) 31 | use JavaScript::SpiderMonkey; 32 | 33 | my %options=(); 34 | getopt("puhcf",\%options); 35 | 36 | my $mypac_file = $options{p} if defined $options{p}; 37 | my $url = $options{u} if defined $options{u}; 38 | my $host = $options{h} if defined $options{h}; 39 | my $client_ip = $options{c} if defined $options{c}; 40 | my $urls_list = $options{f} if defined $options{f}; 41 | 42 | sub printusage{ 43 | print < <-u url> [-h host] [-c client_ip] 46 | ./pactester <-p pacfile> <-f urlslist> [-c client_ip] 47 | 48 | Options: 49 | -p pacfile: PAC file to test 50 | -u url: URL to test 51 | -h host: Host part of the URL 52 | -c client_ip: client IP address (defaults to IP address of the machine on which script is running) 53 | -f urlslist: a file containing list of URLs to be tested. 54 | EOF 55 | } 56 | 57 | # Check for right number of options 58 | if (not defined $mypac_file or (not defined $url and not defined $urls_list)) { 59 | print "Wrong number of arguments!\n"; 60 | printusage(); 61 | exit(1); 62 | } 63 | 64 | # Don't process $urls_list and $url at the same time 65 | if (defined $urls_list and defined $url) { 66 | print "Wrong number of arguments!\n"; 67 | printusage(); 68 | exit(1); 69 | } 70 | 71 | # Validate IP address 72 | if (defined $client_ip) { 73 | my @octets = split(/\./, $client_ip); 74 | if ($client_ip !~ /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/ or 75 | $octets[0] > 255 or $octets[1] > 255 or 76 | $octets[2] > 255 or $octets[3] > 255) { 77 | print "Invalid IP address: $client_ip!\n"; 78 | printusage(); 79 | exit(1); 80 | } 81 | } 82 | 83 | # Define DNS resolve needed by pac files 84 | sub dns_res($) { 85 | my $hostname = shift; 86 | my $addr = gethostbyname($hostname); 87 | if ($addr) { return inet_ntoa($addr); } 88 | else { return 'null'; } 89 | } 90 | 91 | # Define a function to get my IP address 92 | sub my_ip() { 93 | if (defined $client_ip) { return $client_ip; } 94 | my $ip = dns_res(Sys::Hostname::hostname); 95 | if ($ip eq 'null') { return '127.0.0.1'; } 96 | return $ip; 97 | } 98 | 99 | # Find proxy for a url and a host 100 | sub findproxy($$$) { 101 | my ($j, $url, $host) = @_; 102 | $j->property_by_path("pac.url",$url); 103 | $j->property_by_path("pac.host",$host); 104 | $j->property_by_path("pac.proxy"); 105 | my $rc = $j->eval(q! 106 | pac.proxy=FindProxyForURL(pac.url,pac.host); 107 | !); 108 | if ($rc != 1) {print $@; return 0;} 109 | return 1; 110 | } 111 | 112 | # pac utils path. this file contains the js function used in pac files. 113 | my $pac_utils_path .= "$FindBin::Bin/pac_utils.js"; 114 | 115 | # Read javascript files to evaluate 116 | my $oldifs = $/; 117 | undef $/; 118 | open(FILE,$pac_utils_path) || die "Could not open pac_utils.js\n"; 119 | my $nspac = ; 120 | close(FILE); 121 | open(FILE,$mypac_file) || die "Could not open your pac file: $mypac_file\n"; 122 | my $mypac = ; 123 | close(FILE); 124 | $/ = $oldifs; 125 | 126 | # Create and initialize JavaScript context 127 | my $js_context = JavaScript::SpiderMonkey->new(); 128 | $js_context->init(); # Initialize Runtime/Context 129 | 130 | # Export perl functions to JavaScript context. 131 | $js_context->function_set("dnsResolve", sub {dns_res shift}); 132 | $js_context->function_set("myIpAddress", sub {my_ip}); 133 | 134 | # Evaluate pac_utils.js and PAC file 135 | my $rc = $js_context->eval($nspac); 136 | $rc = $js_context->eval($mypac); 137 | if ($rc != 1) { 138 | print $@; 139 | die "Could not evaluate your pac file\n" 140 | } 141 | 142 | # Single URL mode 143 | if (defined $url){ 144 | $url =~ /.*\:\/\/([^\/:]+)/ || die "URL: $url is not valid\n"; 145 | if (not defined $host) { $host = $2; } 146 | if (findproxy($js_context, $url, $host)){ 147 | print $js_context->property_get("pac.proxy")."\n"; 148 | } else { 149 | print "Could not find proxy for url: $url"; 150 | } 151 | } 152 | 153 | # Batch processing mode 154 | if (defined $urls_list) { 155 | open(FILE, $urls_list); 156 | my @urllist = ; 157 | foreach (@urllist) { 158 | chomp; 159 | my $url = $_; 160 | # Extract host from URL 161 | if (not $url =~ /.*\:\/\/([^\/:]+).*/) { 162 | print "URL: '$url' is not valid\n"; 163 | next; 164 | } 165 | my $host = $1; 166 | if (findproxy($js_context, $url, $host)){ 167 | print $url."|".$js_context->property_get("pac.proxy")."\n"; 168 | } else { 169 | print "Could not find proxy for url: $url"; 170 | } 171 | } 172 | } 173 | -------------------------------------------------------------------------------- /pac_utils.js: -------------------------------------------------------------------------------- 1 | /* This file is an adaption of netwerk/base/src/nsProxyAutoConfig.js file in 2 | * mozilla source code. 3 | * 4 | * **** BEGIN LICENSE BLOCK **** 5 | * Version: LGPL 2.1 6 | 7 | * This file is a free software; you can redistribute it and/or 8 | * modify it under the terms of the GNU Lesser General Public 9 | * License as published by the Free Software Foundation; either 10 | * version 2.1 of the License, or (at your option) any later version. 11 | 12 | * This file is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 | * Lesser General Public License for more details. 16 | 17 | * You should have received a copy of the GNU Lesser General Public 18 | * License along with this library; if not, write to the Free Software 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 20 | * USA 21 | * **** END LICENSE BLOCK **** 22 | * 23 | * Original Contributors: 24 | * Akhil Arora 25 | * Tomi Leppikangas 26 | * Darin Fisher 27 | * Gagan Saksena 04/24/00 28 | * 29 | * Adapted for pactester by: 30 | * Manu Garg 01/10/2007 31 | */ 32 | 33 | function dnsDomainIs(host, domain) { 34 | return (host.length >= domain.length && 35 | host.substring(host.length - domain.length) == domain); 36 | } 37 | function dnsDomainLevels(host) { 38 | return host.split('.').length-1; 39 | } 40 | function convert_addr(ipchars) { 41 | var bytes = ipchars.split('.'); 42 | var result = ((bytes[0] & 0xff) << 24) | 43 | ((bytes[1] & 0xff) << 16) | 44 | ((bytes[2] & 0xff) << 8) | 45 | (bytes[3] & 0xff); 46 | return result; 47 | } 48 | function isInNet(ipaddr, pattern, maskstr) { 49 | var test = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/(ipaddr); 50 | if (test == null) { 51 | ipaddr = dnsResolve(ipaddr); 52 | if (ipaddr == 'null') 53 | return false; 54 | } else if (test[1] > 255 || test[2] > 255 || 55 | test[3] > 255 || test[4] > 255) { 56 | return false; // not an IP address 57 | } 58 | var host = convert_addr(ipaddr); 59 | var pat = convert_addr(pattern); 60 | var mask = convert_addr(maskstr); 61 | return ((host & mask) == (pat & mask)); 62 | 63 | } 64 | function isPlainHostName(host) { 65 | return (host.search('\\.') == -1); 66 | } 67 | function isResolvable(host) { 68 | var ip = dnsResolve(host); 69 | return (ip != 'null'); 70 | } 71 | function localHostOrDomainIs(host, hostdom) { 72 | return (host == hostdom) || 73 | (hostdom.lastIndexOf(host + '.', 0) == 0); 74 | } 75 | function shExpMatch(url, pattern) { 76 | pattern = pattern.replace(/\./g, '\\.'); 77 | pattern = pattern.replace(/\*/g, '.*'); 78 | pattern = pattern.replace(/\?/g, '.'); 79 | var newRe = new RegExp('^'+pattern+'$'); 80 | return newRe.test(url); 81 | } 82 | var wdays = new Array('SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT'); 83 | var monthes = new Array('JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL', 'AUG', 'SEP', 'OCT', 'NOV', 'DEC'); 84 | function weekdayRange() { 85 | function getDay(weekday) { 86 | for (var i = 0; i < 6; i++) { 87 | if (weekday == wdays[i]) 88 | return i; 89 | } 90 | return -1; 91 | } 92 | var date = new Date(); 93 | var argc = arguments.length; 94 | var wday; 95 | if (argc < 1) 96 | return false; 97 | if (arguments[argc - 1] == 'GMT') { 98 | argc--; 99 | wday = date.getUTCDay(); 100 | } else { 101 | wday = date.getDay(); 102 | } 103 | var wd1 = getDay(arguments[0]); 104 | var wd2 = (argc == 2) ? getDay(arguments[1]) : wd1; 105 | return (wd1 == -1 || wd2 == -1) ? false 106 | : (wd1 <= wday && wday <= wd2); 107 | } 108 | function dateRange() { 109 | function getMonth(name) { 110 | for (var i = 0; i < 6; i++) { 111 | if (name == monthes[i]) 112 | return i; 113 | } 114 | return -1; 115 | } 116 | var date = new Date(); 117 | var argc = arguments.length; 118 | if (argc < 1) { 119 | return false; 120 | } 121 | var isGMT = (arguments[argc - 1] == 'GMT'); 122 | 123 | if (isGMT) { 124 | argc--; 125 | } 126 | // function will work even without explict handling of this case 127 | if (argc == 1) { 128 | var tmp = parseInt(arguments[0]); 129 | if (isNaN(tmp)) { 130 | return ((isGMT ? date.getUTCMonth() : date.getMonth()) == 131 | getMonth(arguments[0])); 132 | } else if (tmp < 32) { 133 | return ((isGMT ? date.getUTCDate() : date.getDate()) == tmp); 134 | } else { 135 | return ((isGMT ? date.getUTCFullYear() : date.getFullYear()) == 136 | tmp); 137 | } 138 | } 139 | var year = date.getFullYear(); 140 | var date1, date2; 141 | date1 = new Date(year, 0, 1, 0, 0, 0); 142 | date2 = new Date(year, 11, 31, 23, 59, 59); 143 | var adjustMonth = false; 144 | for (var i = 0; i < (argc >> 1); i++) { 145 | var tmp = parseInt(arguments[i]); 146 | if (isNaN(tmp)) { 147 | var mon = getMonth(arguments[i]); 148 | date1.setMonth(mon); 149 | } else if (tmp < 32) { 150 | adjustMonth = (argc <= 2); 151 | date1.setDate(tmp); 152 | } else { 153 | date1.setFullYear(tmp); 154 | } 155 | } 156 | for (var i = (argc >> 1); i < argc; i++) { 157 | var tmp = parseInt(arguments[i]); 158 | if (isNaN(tmp)) { 159 | var mon = getMonth(arguments[i]); 160 | date2.setMonth(mon); 161 | } else if (tmp < 32) { 162 | date2.setDate(tmp); 163 | } else { 164 | date2.setFullYear(tmp); 165 | } 166 | } 167 | if (adjustMonth) { 168 | date1.setMonth(date.getMonth()); 169 | date2.setMonth(date.getMonth()); 170 | } 171 | if (isGMT) { 172 | var tmp = date; 173 | tmp.setFullYear(date.getUTCFullYear()); 174 | tmp.setMonth(date.getUTCMonth()); 175 | tmp.setDate(date.getUTCDate()); 176 | tmp.setHours(date.getUTCHours()); 177 | tmp.setMinutes(date.getUTCMinutes()); 178 | tmp.setSeconds(date.getUTCSeconds()); 179 | date = tmp; 180 | } 181 | return ((date1 <= date) && (date <= date2)); 182 | } 183 | function timeRange() { 184 | var argc = arguments.length; 185 | var date = new Date(); 186 | var isGMT= false; 187 | 188 | if (argc < 1) { 189 | return false; 190 | } 191 | if (arguments[argc - 1] == 'GMT') { 192 | isGMT = true; 193 | argc--; 194 | } 195 | 196 | var hour = isGMT ? date.getUTCHours() : date.getHours(); 197 | var date1, date2; 198 | date1 = new Date(); 199 | date2 = new Date(); 200 | 201 | if (argc == 1) { 202 | return (hour == arguments[0]); 203 | } else if (argc == 2) { 204 | return ((arguments[0] <= hour) && (hour <= arguments[1])); 205 | } else { 206 | switch (argc) { 207 | case 6: 208 | date1.setSeconds(arguments[2]); 209 | date2.setSeconds(arguments[5]); 210 | case 4: 211 | var middle = argc >> 1; 212 | date1.setHours(arguments[0]); 213 | date1.setMinutes(arguments[1]); 214 | date2.setHours(arguments[middle]); 215 | date2.setMinutes(arguments[middle + 1]); 216 | if (middle == 2) { 217 | date2.setSeconds(59); 218 | } 219 | break; 220 | default: 221 | throw 'timeRange: bad number of arguments' 222 | } 223 | } 224 | 225 | if (isGMT) { 226 | date.setFullYear(date.getUTCFullYear()); 227 | date.setMonth(date.getUTCMonth()); 228 | date.setDate(date.getUTCDate()); 229 | date.setHours(date.getUTCHours()); 230 | date.setMinutes(date.getUTCMinutes()); 231 | date.setSeconds(date.getUTCSeconds()); 232 | } 233 | return ((date1 <= date) && (date <= date2)); 234 | } 235 | 236 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 489 | 490 | Also add information on how to contact you by electronic and paper mail. 491 | 492 | You should also get your employer (if you work as a programmer) or your 493 | school, if any, to sign a "copyright disclaimer" for the library, if 494 | necessary. Here is a sample; alter the names: 495 | 496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker. 498 | 499 | , 1 April 1990 500 | Ty Coon, President of Vice 501 | 502 | That's all there is to it! 503 | 504 | 505 | --------------------------------------------------------------------------------