1 const char urlmatch_rcs[] = "$Id: urlmatch.c,v 1.9 2002/04/04 00:36:36 gliptak Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/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.9 2002/04/04 00:36:36 gliptak
37 * always use pcre for matching
39 * Revision 1.8 2002/04/03 23:32:47 jongfoster
40 * Fixing memory leak on error
42 * Revision 1.7 2002/03/26 22:29:55 swa
43 * we have a new homepage!
45 * Revision 1.6 2002/03/24 13:25:43 swa
46 * name change related issues
48 * Revision 1.5 2002/03/13 00:27:05 jongfoster
51 * Revision 1.4 2002/03/07 03:46:17 oes
52 * Fixed compiler warnings
54 * Revision 1.3 2002/03/03 14:51:11 oes
55 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
57 * Revision 1.2 2002/01/21 00:14:09 jongfoster
58 * Correcting comment style
59 * Fixing an uninitialized memory bug in create_url_spec()
61 * Revision 1.1 2002/01/17 20:53:46 jongfoster
62 * Moving all our URL and URL pattern parsing code to the same file - it
63 * was scattered around in filters.c, loaders.c and parsers.c.
65 * Providing a single, simple url_match(pattern,url) function - rather than
66 * the 3-line match routine which was repeated all over the place.
68 * Renaming free_url to free_url_spec, since it frees a struct url_spec.
70 * Providing parse_http_url() so that URLs can be parsed without faking a
71 * HTTP request line for parse_http_request() or repeating the parsing
72 * code (both of which were techniques that were actually in use).
74 * Standardizing that struct http_request is used to represent a URL, and
75 * struct url_spec is used to represent a URL pattern. (Before, URLs were
76 * represented as seperate variables and a partially-filled-in url_spec).
79 *********************************************************************/
86 #include <sys/types.h>
94 #if !defined(_WIN32) && !defined(__OS2__)
101 #include "miscutil.h"
104 const char urlmatch_h_rcs[] = URLMATCH_H_VERSION;
107 /*********************************************************************
109 * Function : free_http_request
111 * Description : Freez a http_request structure
114 * 1 : http = points to a http_request structure to free
118 *********************************************************************/
119 void free_http_request(struct http_request *http)
128 freez(http->hostport);
131 freez(http->host_ip_addr_str);
132 freez(http->dbuffer);
138 /*********************************************************************
140 * Function : parse_http_url
142 * Description : Parse out the host and port from the URL. Find the
143 * hostname & path, port (if ':'), and/or password (if '@')
146 * 1 : url = URL (or is it URI?) to break down
147 * 2 : http = pointer to the http structure to hold elements.
148 * Will be zeroed before use. Note that this
149 * function sets the http->gpc and http->ver
151 * 3 : csp = Current client state (buffers, headers, etc...)
153 * Returns : JB_ERR_OK on success
154 * JB_ERR_MEMORY on out of memory
155 * JB_ERR_CGI_PARAMS on malformed command/URL
156 * or >100 domains deep.
158 *********************************************************************/
159 jb_err parse_http_url(const char * url,
160 struct http_request *http,
161 struct client_state *csp)
164 * Zero out the results structure
166 memset(http, '\0', sizeof(*http));
170 * Save our initial URL
172 http->url = strdup(url);
173 if (http->url == NULL)
175 return JB_ERR_MEMORY;
180 * Split URL into protocol,hostport,path.
190 return JB_ERR_MEMORY;
193 /* Find the start of the URL in our scratch space */
195 if (strncmpic(url_noproto, "http://", 7) == 0)
200 else if (strncmpic(url_noproto, "https://", 8) == 0)
210 url_path = strchr(url_noproto, '/');
211 if (url_path != NULL)
216 * NOTE: The following line ignores the path for HTTPS URLS.
217 * This means that you get consistent behaviour if you type a
218 * https URL in and it's parsed by the function. (When the
219 * URL is actually retrieved, SSL hides the path part).
221 http->path = strdup(http->ssl ? "/" : url_path);
223 http->hostport = strdup(url_noproto);
228 * Repair broken HTTP requests that don't contain a path,
229 * or CONNECT requests
231 http->path = strdup("/");
232 http->hostport = strdup(url_noproto);
237 if ( (http->path == NULL)
238 || (http->hostport == NULL))
241 free_http_request(http);
242 return JB_ERR_MEMORY;
248 * Split hostport into user/password (ignored), host, port.
255 buf = strdup(http->hostport);
258 free_http_request(http);
259 return JB_ERR_MEMORY;
262 /* check if url contains username and/or password */
263 host = strchr(buf, '@');
266 /* Contains username/password, skip it and the @ sign. */
271 /* No username or password. */
275 /* check if url contains port */
276 port = strchr(host, ':');
280 /* Terminate hostname and point to start of port string */
282 http->port = atoi(port);
286 /* No port specified. */
287 http->port = (http->ssl ? 143 : 80);
290 http->host = strdup(host);
294 if (http->host == NULL)
296 free_http_request(http);
297 return JB_ERR_MEMORY;
303 * Split domain name so we can compare it against wildcards
306 char *vec[BUFFER_SIZE];
310 http->dbuffer = strdup(http->host);
311 if (NULL == http->dbuffer)
313 free_http_request(http);
314 return JB_ERR_MEMORY;
317 /* map to lower case */
318 for (p = http->dbuffer; *p ; p++)
320 *p = tolower((int)(unsigned char)*p);
323 /* split the domain name into components */
324 http->dcount = ssplit(http->dbuffer, ".", vec, SZ(vec), 1, 1);
326 if (http->dcount <= 0)
329 * Error: More than SZ(vec) components in domain
330 * or: no components in domain
332 free_http_request(http);
336 /* save a copy of the pointers in dvec */
337 size = http->dcount * sizeof(*http->dvec);
339 http->dvec = (char **)malloc(size);
340 if (NULL == http->dvec)
342 free_http_request(http);
343 return JB_ERR_MEMORY;
346 memcpy(http->dvec, vec, size);
354 /*********************************************************************
356 * Function : parse_http_request
358 * Description : Parse out the host and port from the URL. Find the
359 * hostname & path, port (if ':'), and/or password (if '@')
362 * 1 : req = HTTP request line to break down
363 * 2 : http = pointer to the http structure to hold elements
364 * 3 : csp = Current client state (buffers, headers, etc...)
366 * Returns : JB_ERR_OK on success
367 * JB_ERR_MEMORY on out of memory
368 * JB_ERR_CGI_PARAMS on malformed command/URL
369 * or >100 domains deep.
371 *********************************************************************/
372 jb_err parse_http_request(const char *req,
373 struct http_request *http,
374 struct client_state *csp)
382 memset(http, '\0', sizeof(*http));
387 return JB_ERR_MEMORY;
390 n = ssplit(buf, " \r\n", v, SZ(v), 1, 1);
397 /* this could be a CONNECT request */
398 if (strcmpic(v[0], "connect") == 0)
403 /* or it could be any other basic HTTP request type */
404 else if ((0 == strcmpic(v[0], "get"))
405 || (0 == strcmpic(v[0], "head"))
406 || (0 == strcmpic(v[0], "post"))
407 || (0 == strcmpic(v[0], "put"))
408 || (0 == strcmpic(v[0], "delete"))
410 /* or a webDAV extension (RFC2518) */
411 || (0 == strcmpic(v[0], "propfind"))
412 || (0 == strcmpic(v[0], "proppatch"))
413 || (0 == strcmpic(v[0], "move"))
414 || (0 == strcmpic(v[0], "copy"))
415 || (0 == strcmpic(v[0], "mkcol"))
416 || (0 == strcmpic(v[0], "lock"))
417 || (0 == strcmpic(v[0], "unlock"))
425 /* Unknown HTTP method */
430 err = parse_http_url(v[1], http, csp);
438 * Copy the details into the structure
440 http->ssl = is_connect;
441 http->cmd = strdup(req);
442 http->gpc = strdup(v[0]);
443 http->ver = strdup(v[2]);
445 if ( (http->cmd == NULL)
446 || (http->gpc == NULL)
447 || (http->ver == NULL) )
450 free_http_request(http);
451 return JB_ERR_MEMORY;
458 /*********************************************************************
460 * Function : simple_domaincmp
462 * Description : Domain-wise Compare fqdn's. The comparison is
463 * both left- and right-anchored. The individual
464 * domain names are compared with simplematch().
465 * This is only used by domain_match.
468 * 1 : pv = array of patterns to compare
469 * 2 : fv = array of domain components to compare
470 * 3 : len = length of the arrays (both arrays are the
471 * same length - if they weren't, it couldn't
472 * possibly be a match).
474 * Returns : 0 => domains are equivalent, else no match.
476 *********************************************************************/
477 static int simple_domaincmp(char **pv, char **fv, int len)
481 for (n = 0; n < len; n++)
483 if (simplematch(pv[n], fv[n]))
494 /*********************************************************************
496 * Function : domain_match
498 * Description : Domain-wise Compare fqdn's. Governed by the bimap in
499 * pattern->unachored, the comparison is un-, left-,
500 * right-anchored, or both.
501 * The individual domain names are compared with
505 * 1 : pattern = a domain that may contain a '*' as a wildcard.
506 * 2 : fqdn = domain name against which the patterns are compared.
508 * Returns : 0 => domains are equivalent, else no match.
510 *********************************************************************/
511 static int domain_match(const struct url_spec *pattern, const struct http_request *fqdn)
513 char **pv, **fv; /* vectors */
515 int unanchored = pattern->unanchored & (ANCHOR_RIGHT | ANCHOR_LEFT);
517 plen = pattern->dcount;
522 /* fqdn is too short to match this pattern */
529 if (unanchored == ANCHOR_LEFT)
534 * Convert this into a fully anchored pattern with
535 * the fqdn and pattern the same length
537 fv += (flen - plen); /* flen - plen >= 0 due to check above */
538 return simple_domaincmp(pv, fv, plen);
540 else if (unanchored == 0)
542 /* Fully anchored, check length */
547 return simple_domaincmp(pv, fv, plen);
549 else if (unanchored == ANCHOR_RIGHT)
551 /* Left anchored, ignore all extra in fqdn */
552 return simple_domaincmp(pv, fv, plen);
558 int maxn = flen - plen;
559 for (n = 0; n <= maxn; n++)
561 if (!simple_domaincmp(pv, fv, plen))
566 * Doesn't match from start of fqdn
567 * Try skipping first part of fqdn
577 /*********************************************************************
579 * Function : create_url_spec
581 * Description : Creates a "url_spec" structure from a string.
582 * When finished, free with unload_url().
585 * 1 : url = Target url_spec to be filled in. Will be
587 * 2 : buf = Source pattern, null terminated. NOTE: The
588 * contents of this buffer are destroyed by this
589 * function. If this function succeeds, the
590 * buffer is copied to url->spec. If this
591 * function fails, the contents of the buffer
594 * Returns : JB_ERR_OK - Success
595 * JB_ERR_MEMORY - Out of memory
596 * JB_ERR_PARSE - Cannot parse regex (Detailed message
597 * written to system log)
599 *********************************************************************/
600 jb_err create_url_spec(struct url_spec * url, const char * buf)
608 memset(url, '\0', sizeof(*url));
610 /* save a copy of the orignal specification */
611 if ((url->spec = strdup(buf)) == NULL)
613 return JB_ERR_MEMORY;
616 if ((p = strchr(buf, '/')) != NULL)
618 if (NULL == (url->path = strdup(p)))
621 return JB_ERR_MEMORY;
623 url->pathlen = strlen(url->path);
634 char rebuf[BUFFER_SIZE];
636 if (NULL == (url->preg = zalloc(sizeof(*url->preg))))
640 return JB_ERR_MEMORY;
643 sprintf(rebuf, "^(%s)", url->path);
645 errcode = regcomp(url->preg, rebuf,
646 (REG_EXTENDED|REG_NOSUB|REG_ICASE));
649 size_t errlen = regerror(errcode,
650 url->preg, rebuf, sizeof(rebuf));
652 if (errlen > (sizeof(rebuf) - (size_t)1))
654 errlen = sizeof(rebuf) - (size_t)1;
656 rebuf[errlen] = '\0';
658 log_error(LOG_LEVEL_ERROR, "error compiling %s: %s",
669 if ((p = strchr(buf, ':')) == NULL)
684 /* Parse domain part */
685 if (buf[strlen(buf) - 1] == '.')
687 url->unanchored |= ANCHOR_RIGHT;
691 url->unanchored |= ANCHOR_LEFT;
694 /* split domain into components */
696 url->dbuffer = strdup(buf);
697 if (NULL == url->dbuffer)
703 return JB_ERR_MEMORY;
706 /* map to lower case */
707 for (p = url->dbuffer; *p ; p++)
709 *p = tolower((int)(unsigned char)*p);
712 /* split the domain name into components */
713 url->dcount = ssplit(url->dbuffer, ".", v, SZ(v), 1, 1);
723 return JB_ERR_MEMORY;
725 else if (url->dcount != 0)
728 /* save a copy of the pointers in dvec */
729 size = url->dcount * sizeof(*url->dvec);
731 url->dvec = (char **)malloc(size);
732 if (NULL == url->dvec)
740 return JB_ERR_MEMORY;
743 memcpy(url->dvec, v, size);
752 /*********************************************************************
754 * Function : free_url_spec
756 * Description : Called from the "unloaders". Freez the url
757 * structure elements.
760 * 1 : url = pointer to a url_spec structure.
764 *********************************************************************/
765 void free_url_spec(struct url_spec *url)
767 if (url == NULL) return;
781 /*********************************************************************
783 * Function : url_match
785 * Description : Compare a URL against a URL pattern.
788 * 1 : pattern = a URL pattern
789 * 2 : url = URL to match
791 * Returns : 0 iff the URL matches the pattern, else nonzero.
793 *********************************************************************/
794 int url_match(const struct url_spec *pattern,
795 const struct http_request *url)
797 return ((pattern->port == 0) || (pattern->port == url->port))
798 && ((pattern->dbuffer == NULL) || (domain_match(pattern, url) == 0))
799 && ((pattern->path == NULL) ||
800 (regexec(pattern->preg, url->path, 0, NULL, 0) == 0)