xref: /openbsd-src/usr.bin/ssh/match.c (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /* $OpenBSD: match.c,v 1.27 2008/06/10 23:06:19 djm Exp $ */
2 /*
3  * Author: Tatu Ylonen <ylo@cs.hut.fi>
4  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5  *                    All rights reserved
6  * Simple pattern matching, with '*' and '?' as wildcards.
7  *
8  * As far as I am concerned, the code I have written for this software
9  * can be used freely for any purpose.  Any derived versions of this
10  * software must be clearly marked as such, and if the derived work is
11  * incompatible with the protocol description in the RFC file, it must be
12  * called by a name other than "ssh" or "Secure Shell".
13  */
14 /*
15  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions
19  * are met:
20  * 1. Redistributions of source code must retain the above copyright
21  *    notice, this list of conditions and the following disclaimer.
22  * 2. Redistributions in binary form must reproduce the above copyright
23  *    notice, this list of conditions and the following disclaimer in the
24  *    documentation and/or other materials provided with the distribution.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #include <sys/types.h>
39 
40 #include <ctype.h>
41 #include <string.h>
42 
43 #include "xmalloc.h"
44 #include "match.h"
45 
46 /*
47  * Returns true if the given string matches the pattern (which may contain ?
48  * and * as wildcards), and zero if it does not match.
49  */
50 
51 int
52 match_pattern(const char *s, const char *pattern)
53 {
54 	for (;;) {
55 		/* If at end of pattern, accept if also at end of string. */
56 		if (!*pattern)
57 			return !*s;
58 
59 		if (*pattern == '*') {
60 			/* Skip the asterisk. */
61 			pattern++;
62 
63 			/* If at end of pattern, accept immediately. */
64 			if (!*pattern)
65 				return 1;
66 
67 			/* If next character in pattern is known, optimize. */
68 			if (*pattern != '?' && *pattern != '*') {
69 				/*
70 				 * Look instances of the next character in
71 				 * pattern, and try to match starting from
72 				 * those.
73 				 */
74 				for (; *s; s++)
75 					if (*s == *pattern &&
76 					    match_pattern(s + 1, pattern + 1))
77 						return 1;
78 				/* Failed. */
79 				return 0;
80 			}
81 			/*
82 			 * Move ahead one character at a time and try to
83 			 * match at each position.
84 			 */
85 			for (; *s; s++)
86 				if (match_pattern(s, pattern))
87 					return 1;
88 			/* Failed. */
89 			return 0;
90 		}
91 		/*
92 		 * There must be at least one more character in the string.
93 		 * If we are at the end, fail.
94 		 */
95 		if (!*s)
96 			return 0;
97 
98 		/* Check if the next character of the string is acceptable. */
99 		if (*pattern != '?' && *pattern != *s)
100 			return 0;
101 
102 		/* Move to the next character, both in string and in pattern. */
103 		s++;
104 		pattern++;
105 	}
106 	/* NOTREACHED */
107 }
108 
109 /*
110  * Tries to match the string against the
111  * comma-separated sequence of subpatterns (each possibly preceded by ! to
112  * indicate negation).  Returns -1 if negation matches, 1 if there is
113  * a positive match, 0 if there is no match at all.
114  */
115 
116 int
117 match_pattern_list(const char *string, const char *pattern, u_int len,
118     int dolower)
119 {
120 	char sub[1024];
121 	int negated;
122 	int got_positive;
123 	u_int i, subi;
124 
125 	got_positive = 0;
126 	for (i = 0; i < len;) {
127 		/* Check if the subpattern is negated. */
128 		if (pattern[i] == '!') {
129 			negated = 1;
130 			i++;
131 		} else
132 			negated = 0;
133 
134 		/*
135 		 * Extract the subpattern up to a comma or end.  Convert the
136 		 * subpattern to lowercase.
137 		 */
138 		for (subi = 0;
139 		    i < len && subi < sizeof(sub) - 1 && pattern[i] != ',';
140 		    subi++, i++)
141 			sub[subi] = dolower && isupper(pattern[i]) ?
142 			    (char)tolower(pattern[i]) : pattern[i];
143 		/* If subpattern too long, return failure (no match). */
144 		if (subi >= sizeof(sub) - 1)
145 			return 0;
146 
147 		/* If the subpattern was terminated by a comma, skip the comma. */
148 		if (i < len && pattern[i] == ',')
149 			i++;
150 
151 		/* Null-terminate the subpattern. */
152 		sub[subi] = '\0';
153 
154 		/* Try to match the subpattern against the string. */
155 		if (match_pattern(string, sub)) {
156 			if (negated)
157 				return -1;		/* Negative */
158 			else
159 				got_positive = 1;	/* Positive */
160 		}
161 	}
162 
163 	/*
164 	 * Return success if got a positive match.  If there was a negative
165 	 * match, we have already returned -1 and never get here.
166 	 */
167 	return got_positive;
168 }
169 
170 /*
171  * Tries to match the host name (which must be in all lowercase) against the
172  * comma-separated sequence of subpatterns (each possibly preceded by ! to
173  * indicate negation).  Returns -1 if negation matches, 1 if there is
174  * a positive match, 0 if there is no match at all.
175  */
176 int
177 match_hostname(const char *host, const char *pattern, u_int len)
178 {
179 	return match_pattern_list(host, pattern, len, 1);
180 }
181 
182 /*
183  * returns 0 if we get a negative match for the hostname or the ip
184  * or if we get no match at all.  returns -1 on error, or 1 on
185  * successful match.
186  */
187 int
188 match_host_and_ip(const char *host, const char *ipaddr,
189     const char *patterns)
190 {
191 	int mhost, mip;
192 
193 	/* error in ipaddr match */
194 	if ((mip = addr_match_list(ipaddr, patterns)) == -2)
195 		return -1;
196 	else if (mip == -1) /* negative ip address match */
197 		return 0;
198 
199 	/* negative hostname match */
200 	if ((mhost = match_hostname(host, patterns, strlen(patterns))) == -1)
201 		return 0;
202 	/* no match at all */
203 	if (mhost == 0 && mip == 0)
204 		return 0;
205 	return 1;
206 }
207 
208 /*
209  * match user, user@host_or_ip, user@host_or_ip_list against pattern
210  */
211 int
212 match_user(const char *user, const char *host, const char *ipaddr,
213     const char *pattern)
214 {
215 	char *p, *pat;
216 	int ret;
217 
218 	if ((p = strchr(pattern,'@')) == NULL)
219 		return match_pattern(user, pattern);
220 
221 	pat = xstrdup(pattern);
222 	p = strchr(pat, '@');
223 	*p++ = '\0';
224 
225 	if ((ret = match_pattern(user, pat)) == 1)
226 		ret = match_host_and_ip(host, ipaddr, p);
227 	xfree(pat);
228 
229 	return ret;
230 }
231 
232 /*
233  * Returns first item from client-list that is also supported by server-list,
234  * caller must xfree() returned string.
235  */
236 #define	MAX_PROP	40
237 #define	SEP	","
238 char *
239 match_list(const char *client, const char *server, u_int *next)
240 {
241 	char *sproposals[MAX_PROP];
242 	char *c, *s, *p, *ret, *cp, *sp;
243 	int i, j, nproposals;
244 
245 	c = cp = xstrdup(client);
246 	s = sp = xstrdup(server);
247 
248 	for ((p = strsep(&sp, SEP)), i=0; p && *p != '\0';
249 	    (p = strsep(&sp, SEP)), i++) {
250 		if (i < MAX_PROP)
251 			sproposals[i] = p;
252 		else
253 			break;
254 	}
255 	nproposals = i;
256 
257 	for ((p = strsep(&cp, SEP)), i=0; p && *p != '\0';
258 	    (p = strsep(&cp, SEP)), i++) {
259 		for (j = 0; j < nproposals; j++) {
260 			if (strcmp(p, sproposals[j]) == 0) {
261 				ret = xstrdup(p);
262 				if (next != NULL)
263 					*next = (cp == NULL) ?
264 					    strlen(c) : (u_int)(cp - c);
265 				xfree(c);
266 				xfree(s);
267 				return ret;
268 			}
269 		}
270 	}
271 	if (next != NULL)
272 		*next = strlen(c);
273 	xfree(c);
274 	xfree(s);
275 	return NULL;
276 }
277