1 const char urlmatch_rcs[] = "$Id: urlmatch.c,v 1.10.2.1 2002/06/06 19:06:44 jongfoster Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa//current/Attic/urlmatch.c,v $
6 * Purpose : Declares functions to match URLs against URL
9 * Copyright : Written by and Copyright (C) 2001 the SourceForge
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
35 * $Log: urlmatch.c,v $
36 * Revision 1.10.2.1 2002/06/06 19:06:44 jongfoster
37 * Adding support for proprietary Microsoft WebDAV extensions
39 * Revision 1.10 2002/05/12 21:40:37 jongfoster
40 * - Removing some unused code
42 * Revision 1.9 2002/04/04 00:36:36 gliptak
43 * always use pcre for matching
45 * Revision 1.8 2002/04/03 23:32:47 jongfoster
46 * Fixing memory leak on error
48 * Revision 1.7 2002/03/26 22:29:55 swa
49 * we have a new homepage!
51 * Revision 1.6 2002/03/24 13:25:43 swa
52 * name change related issues
54 * Revision 1.5 2002/03/13 00:27:05 jongfoster
57 * Revision 1.4 2002/03/07 03:46:17 oes
58 * Fixed compiler warnings
60 * Revision 1.3 2002/03/03 14:51:11 oes
61 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
63 * Revision 1.2 2002/01/21 00:14:09 jongfoster
64 * Correcting comment style
65 * Fixing an uninitialized memory bug in create_url_spec()
67 * Revision 1.1 2002/01/17 20:53:46 jongfoster
68 * Moving all our URL and URL pattern parsing code to the same file - it
69 * was scattered around in filters.c, loaders.c and parsers.c.
71 * Providing a single, simple url_match(pattern,url) function - rather than
72 * the 3-line match routine which was repeated all over the place.
74 * Renaming free_url to free_url_spec, since it frees a struct url_spec.
76 * Providing parse_http_url() so that URLs can be parsed without faking a
77 * HTTP request line for parse_http_request() or repeating the parsing
78 * code (both of which were techniques that were actually in use).
80 * Standardizing that struct http_request is used to represent a URL, and
81 * struct url_spec is used to represent a URL pattern. (Before, URLs were
82 * represented as seperate variables and a partially-filled-in url_spec).
85 *********************************************************************/
92 #include <sys/types.h>
100 #if !defined(_WIN32) && !defined(__OS2__)
105 #include "urlmatch.h"
107 #include "miscutil.h"
110 const char urlmatch_h_rcs[] = URLMATCH_H_VERSION;
113 /*********************************************************************
115 * Function : free_http_request
117 * Description : Freez a http_request structure
120 * 1 : http = points to a http_request structure to free
124 *********************************************************************/
125 void free_http_request(struct http_request *http)
134 freez(http->hostport);
137 freez(http->host_ip_addr_str);
138 freez(http->dbuffer);
144 /*********************************************************************
146 * Function : parse_http_url
148 * Description : Parse out the host and port from the URL. Find the
149 * hostname & path, port (if ':'), and/or password (if '@')
152 * 1 : url = URL (or is it URI?) to break down
153 * 2 : http = pointer to the http structure to hold elements.
154 * Will be zeroed before use. Note that this
155 * function sets the http->gpc and http->ver
157 * 3 : csp = Current client state (buffers, headers, etc...)
159 * Returns : JB_ERR_OK on success
160 * JB_ERR_MEMORY on out of memory
161 * JB_ERR_PARSE on malformed command/URL
162 * or >100 domains deep.
164 *********************************************************************/
165 jb_err parse_http_url(const char * url,
166 struct http_request *http,
167 struct client_state *csp)
170 * Zero out the results structure
172 memset(http, '\0', sizeof(*http));
176 * Save our initial URL
178 http->url = strdup(url);
179 if (http->url == NULL)
181 return JB_ERR_MEMORY;
186 * Check for * URI. If found, we're done.
188 if (*http->url == '*')
190 http->path = strdup("*");
191 http->hostport = strdup("");
197 * Split URL into protocol,hostport,path.
207 return JB_ERR_MEMORY;
210 /* Find the start of the URL in our scratch space */
212 if (strncmpic(url_noproto, "http://", 7) == 0)
217 else if (strncmpic(url_noproto, "https://", 8) == 0)
227 url_path = strchr(url_noproto, '/');
228 if (url_path != NULL)
233 * NOTE: The following line ignores the path for HTTPS URLS.
234 * This means that you get consistent behaviour if you type a
235 * https URL in and it's parsed by the function. (When the
236 * URL is actually retrieved, SSL hides the path part).
238 http->path = strdup(http->ssl ? "/" : url_path);
240 http->hostport = strdup(url_noproto);
245 * Repair broken HTTP requests that don't contain a path,
246 * or CONNECT requests
248 http->path = strdup("/");
249 http->hostport = strdup(url_noproto);
254 if ( (http->path == NULL)
255 || (http->hostport == NULL))
258 free_http_request(http);
259 return JB_ERR_MEMORY;
265 * Split hostport into user/password (ignored), host, port.
272 buf = strdup(http->hostport);
275 free_http_request(http);
276 return JB_ERR_MEMORY;
279 /* check if url contains username and/or password */
280 host = strchr(buf, '@');
283 /* Contains username/password, skip it and the @ sign. */
288 /* No username or password. */
292 /* check if url contains port */
293 port = strchr(host, ':');
297 /* Terminate hostname and point to start of port string */
299 http->port = atoi(port);
303 /* No port specified. */
304 http->port = (http->ssl ? 143 : 80);
307 http->host = strdup(host);
311 if (http->host == NULL)
313 free_http_request(http);
314 return JB_ERR_MEMORY;
319 * Split domain name so we can compare it against wildcards
323 char *vec[BUFFER_SIZE];
327 http->dbuffer = strdup(http->host);
328 if (NULL == http->dbuffer)
330 free_http_request(http);
331 return JB_ERR_MEMORY;
334 /* map to lower case */
335 for (p = http->dbuffer; *p ; p++)
337 *p = tolower((int)(unsigned char)*p);
340 /* split the domain name into components */
341 http->dcount = ssplit(http->dbuffer, ".", vec, SZ(vec), 1, 1);
343 if (http->dcount <= 0)
346 * Error: More than SZ(vec) components in domain
347 * or: no components in domain
349 free_http_request(http);
353 /* save a copy of the pointers in dvec */
354 size = http->dcount * sizeof(*http->dvec);
356 http->dvec = (char **)malloc(size);
357 if (NULL == http->dvec)
359 free_http_request(http);
360 return JB_ERR_MEMORY;
363 memcpy(http->dvec, vec, size);
371 /*********************************************************************
373 * Function : parse_http_request
375 * Description : Parse out the host and port from the URL. Find the
376 * hostname & path, port (if ':'), and/or password (if '@')
379 * 1 : req = HTTP request line to break down
380 * 2 : http = pointer to the http structure to hold elements
381 * 3 : csp = Current client state (buffers, headers, etc...)
383 * Returns : JB_ERR_OK on success
384 * JB_ERR_MEMORY on out of memory
385 * JB_ERR_CGI_PARAMS on malformed command/URL
386 * or >100 domains deep.
388 *********************************************************************/
389 jb_err parse_http_request(const char *req,
390 struct http_request *http,
391 struct client_state *csp)
399 memset(http, '\0', sizeof(*http));
404 return JB_ERR_MEMORY;
407 n = ssplit(buf, " \r\n", v, SZ(v), 1, 1);
414 /* this could be a CONNECT request */
415 if (strcmpic(v[0], "connect") == 0)
420 /* or it could be any other basic HTTP request type */
421 else if ((0 == strcmpic(v[0], "get"))
422 || (0 == strcmpic(v[0], "head"))
423 || (0 == strcmpic(v[0], "post"))
424 || (0 == strcmpic(v[0], "put"))
425 || (0 == strcmpic(v[0], "delete"))
426 || (0 == strcmpic(v[0], "options"))
427 || (0 == strcmpic(v[0], "trace"))
429 /* or a webDAV extension (RFC2518) */
430 || (0 == strcmpic(v[0], "propfind"))
431 || (0 == strcmpic(v[0], "proppatch"))
432 || (0 == strcmpic(v[0], "move"))
433 || (0 == strcmpic(v[0], "copy"))
434 || (0 == strcmpic(v[0], "mkcol"))
435 || (0 == strcmpic(v[0], "lock"))
436 || (0 == strcmpic(v[0], "unlock"))
438 /* Or a Microsoft webDAV extension for Exchange 2000. See: */
439 /* http://lists.w3.org/Archives/Public/w3c-dist-auth/2002JanMar/0001.html */
440 /* http://msdn.microsoft.com/library/en-us/wss/wss/_webdav_methods.asp */
441 || (0 == strcmpic(v[0], "bcopy"))
442 || (0 == strcmpic(v[0], "bmove"))
443 || (0 == strcmpic(v[0], "bdelete"))
444 || (0 == strcmpic(v[0], "bpropfind"))
445 || (0 == strcmpic(v[0], "bproppatch"))
447 /* Or another Microsoft webDAV extension for Exchange 2000. See: */
448 /* http://systems.cs.colorado.edu/grunwald/MobileComputing/Papers/draft-cohen-gena-p-base-00.txt */
449 /* http://lists.w3.org/Archives/Public/w3c-dist-auth/2002JanMar/0001.html */
450 /* http://msdn.microsoft.com/library/en-us/wss/wss/_webdav_methods.asp */
451 || (0 == strcmpic(v[0], "subscribe"))
452 || (0 == strcmpic(v[0], "unsubscribe"))
453 || (0 == strcmpic(v[0], "notify"))
454 || (0 == strcmpic(v[0], "poll"))
462 /* Unknown HTTP method */
467 err = parse_http_url(v[1], http, csp);
475 * Copy the details into the structure
477 http->ssl = is_connect;
478 http->cmd = strdup(req);
479 http->gpc = strdup(v[0]);
480 http->ver = strdup(v[2]);
482 if ( (http->cmd == NULL)
483 || (http->gpc == NULL)
484 || (http->ver == NULL) )
487 free_http_request(http);
488 return JB_ERR_MEMORY;
495 /*********************************************************************
497 * Function : simple_domaincmp
499 * Description : Domain-wise Compare fqdn's. The comparison is
500 * both left- and right-anchored. The individual
501 * domain names are compared with simplematch().
502 * This is only used by domain_match.
505 * 1 : pv = array of patterns to compare
506 * 2 : fv = array of domain components to compare
507 * 3 : len = length of the arrays (both arrays are the
508 * same length - if they weren't, it couldn't
509 * possibly be a match).
511 * Returns : 0 => domains are equivalent, else no match.
513 *********************************************************************/
514 static int simple_domaincmp(char **pv, char **fv, int len)
518 for (n = 0; n < len; n++)
520 if (simplematch(pv[n], fv[n]))
531 /*********************************************************************
533 * Function : domain_match
535 * Description : Domain-wise Compare fqdn's. Governed by the bimap in
536 * pattern->unachored, the comparison is un-, left-,
537 * right-anchored, or both.
538 * The individual domain names are compared with
542 * 1 : pattern = a domain that may contain a '*' as a wildcard.
543 * 2 : fqdn = domain name against which the patterns are compared.
545 * Returns : 0 => domains are equivalent, else no match.
547 *********************************************************************/
548 static int domain_match(const struct url_spec *pattern, const struct http_request *fqdn)
550 char **pv, **fv; /* vectors */
552 int unanchored = pattern->unanchored & (ANCHOR_RIGHT | ANCHOR_LEFT);
554 plen = pattern->dcount;
559 /* fqdn is too short to match this pattern */
566 if (unanchored == ANCHOR_LEFT)
571 * Convert this into a fully anchored pattern with
572 * the fqdn and pattern the same length
574 fv += (flen - plen); /* flen - plen >= 0 due to check above */
575 return simple_domaincmp(pv, fv, plen);
577 else if (unanchored == 0)
579 /* Fully anchored, check length */
584 return simple_domaincmp(pv, fv, plen);
586 else if (unanchored == ANCHOR_RIGHT)
588 /* Left anchored, ignore all extra in fqdn */
589 return simple_domaincmp(pv, fv, plen);
595 int maxn = flen - plen;
596 for (n = 0; n <= maxn; n++)
598 if (!simple_domaincmp(pv, fv, plen))
603 * Doesn't match from start of fqdn
604 * Try skipping first part of fqdn
614 /*********************************************************************
616 * Function : create_url_spec
618 * Description : Creates a "url_spec" structure from a string.
619 * When finished, free with unload_url().
622 * 1 : url = Target url_spec to be filled in. Will be
624 * 2 : buf = Source pattern, null terminated. NOTE: The
625 * contents of this buffer are destroyed by this
626 * function. If this function succeeds, the
627 * buffer is copied to url->spec. If this
628 * function fails, the contents of the buffer
631 * Returns : JB_ERR_OK - Success
632 * JB_ERR_MEMORY - Out of memory
633 * JB_ERR_PARSE - Cannot parse regex (Detailed message
634 * written to system log)
636 *********************************************************************/
637 jb_err create_url_spec(struct url_spec * url, const char * buf)
645 memset(url, '\0', sizeof(*url));
647 /* save a copy of the orignal specification */
648 if ((url->spec = strdup(buf)) == NULL)
650 return JB_ERR_MEMORY;
653 if ((p = strchr(buf, '/')) != NULL)
655 if (NULL == (url->path = strdup(p)))
658 return JB_ERR_MEMORY;
660 url->pathlen = strlen(url->path);
671 char rebuf[BUFFER_SIZE];
673 if (NULL == (url->preg = zalloc(sizeof(*url->preg))))
677 return JB_ERR_MEMORY;
680 sprintf(rebuf, "^(%s)", url->path);
682 errcode = regcomp(url->preg, rebuf,
683 (REG_EXTENDED|REG_NOSUB|REG_ICASE));
686 size_t errlen = regerror(errcode,
687 url->preg, rebuf, sizeof(rebuf));
689 if (errlen > (sizeof(rebuf) - (size_t)1))
691 errlen = sizeof(rebuf) - (size_t)1;
693 rebuf[errlen] = '\0';
695 log_error(LOG_LEVEL_ERROR, "error compiling %s: %s",
706 if ((p = strchr(buf, ':')) == NULL)
721 /* Parse domain part */
722 if (buf[strlen(buf) - 1] == '.')
724 url->unanchored |= ANCHOR_RIGHT;
728 url->unanchored |= ANCHOR_LEFT;
731 /* split domain into components */
733 url->dbuffer = strdup(buf);
734 if (NULL == url->dbuffer)
740 return JB_ERR_MEMORY;
743 /* map to lower case */
744 for (p = url->dbuffer; *p ; p++)
746 *p = tolower((int)(unsigned char)*p);
749 /* split the domain name into components */
750 url->dcount = ssplit(url->dbuffer, ".", v, SZ(v), 1, 1);
760 return JB_ERR_MEMORY;
762 else if (url->dcount != 0)
765 /* save a copy of the pointers in dvec */
766 size = url->dcount * sizeof(*url->dvec);
768 url->dvec = (char **)malloc(size);
769 if (NULL == url->dvec)
777 return JB_ERR_MEMORY;
780 memcpy(url->dvec, v, size);
789 /*********************************************************************
791 * Function : free_url_spec
793 * Description : Called from the "unloaders". Freez the url
794 * structure elements.
797 * 1 : url = pointer to a url_spec structure.
801 *********************************************************************/
802 void free_url_spec(struct url_spec *url)
804 if (url == NULL) return;
818 /*********************************************************************
820 * Function : url_match
822 * Description : Compare a URL against a URL pattern.
825 * 1 : pattern = a URL pattern
826 * 2 : url = URL to match
828 * Returns : 0 iff the URL matches the pattern, else nonzero.
830 *********************************************************************/
831 int url_match(const struct url_spec *pattern,
832 const struct http_request *url)
834 return ((pattern->port == 0) || (pattern->port == url->port))
835 && ((pattern->dbuffer == NULL) || (domain_match(pattern, url) == 0))
836 && ((pattern->path == NULL) ||
837 (regexec(pattern->preg, url->path, 0, NULL, 0) == 0)