Reworked the posix and w32 exechelpers.
[gnupg.git] / common / userids.c
1 /* userids.c - Utility functions for user ids.
2  * Copyright (C) 2001, 2003, 2004, 2006,
3  *               2009 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG 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
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 /* This file implements a few utility functions useful when working
22    with canonical encrypted S-expresions (i.e. not the S-exprssion
23    objects from libgcrypt).  */
24
25 #include <config.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29
30 #include "util.h"
31 #include "userids.h"
32
33
34 /* Parse the user-id NAME and build a search description for it.
35  * Returns 0 on succdess or an error code.  DESC may be NULL to merely
36  * check the validity of a user-id.
37  *
38  * Some used rules:
39  * - If the username starts with 8,9,16 or 17 hex-digits (the first one
40  *   must be in the range 0..9), this is considered a keyid; depending
41  *   on the length a short or complete one.
42  * - If the username starts with 32,33,40 or 41 hex-digits (the first one
43  *   must be in the range 0..9), this is considered a fingerprint.
44  * - If the username starts with a left angle, we assume it is a complete
45  *   email address and look only at this part.
46  * - If the username starts with a colon we assume it is a unified 
47  *   key specfification. 
48  * - If the username starts with a '.', we assume it is the ending
49  *   part of an email address
50  * - If the username starts with an '@', we assume it is a part of an
51  *   email address
52  * - If the userid start with an '=' an exact compare is done.
53  * - If the userid starts with a '*' a case insensitive substring search is
54  *   done (This is the default).
55  * - If the userid starts with a '+' we will compare individual words
56  *   and a match requires that all the words are in the userid.
57  *   Words are delimited by white space or "()<>[]{}.@-+_,;/&!"
58  *   (note that you can't search for these characters). Compare
59  *   is not case sensitive.
60  * - If the userid starts with a '&' a 40 hex digits keygrip is expected.
61  */
62
63 gpg_error_t
64 classify_user_id (const char *name, KEYDB_SEARCH_DESC *desc)
65 {
66   const char *s;
67   int hexprefix = 0;
68   int hexlength;
69   int mode = 0;   
70   KEYDB_SEARCH_DESC dummy_desc;
71
72   if (!desc)
73     desc = &dummy_desc;
74     
75   /* Clear the structure so that the mode field is set to zero unless
76      we set it to the correct value right at the end of this
77      function. */
78   memset (desc, 0, sizeof *desc);
79
80   /* Skip leading spaces.  */
81   for(s = name; *s && spacep (s); s++ )
82     ;
83
84   switch (*s) 
85     {
86     case 0:  /* Empty string is an error.  */
87       return gpg_error (GPG_ERR_INV_USER_ID);
88
89     case '.': /* An email address, compare from end.  Note that this
90                  has not yet been implemented in the search code.  */
91       mode = KEYDB_SEARCH_MODE_MAILEND;
92       s++;
93       desc->u.name = s;
94       break;
95
96     case '<': /* An email address.  */
97       mode = KEYDB_SEARCH_MODE_MAIL;
98       s++;
99       desc->u.name = s;
100       break;
101
102     case '@':  /* Part of an email address.  */
103       mode = KEYDB_SEARCH_MODE_MAILSUB;
104       s++;
105       desc->u.name = s;
106       break;
107
108     case '=':  /* Exact compare.  */
109       mode = KEYDB_SEARCH_MODE_EXACT;
110       s++;
111       desc->u.name = s;
112       break;
113
114     case '*':  /* Case insensitive substring search.  */
115       mode = KEYDB_SEARCH_MODE_SUBSTR;
116       s++;
117       desc->u.name = s;
118       break;
119
120     case '+':  /* Compare individual words.  Note that this has not
121                   yet been implemented in the search code.  */
122       mode = KEYDB_SEARCH_MODE_WORDS;
123       s++;
124       desc->u.name = s;
125       break;
126
127     case '/': /* Subject's DN.  */
128       s++;
129       if (!*s || spacep (s)) /* No DN or prefixed with a space.  */
130         return gpg_error (GPG_ERR_INV_USER_ID);
131       desc->u.name = s;
132       mode = KEYDB_SEARCH_MODE_SUBJECT;
133       break;
134
135     case '#': /* S/N with optional issuer id or just issuer id.  */
136       { 
137         const char *si;
138         
139         s++;
140         if ( *s == '/')
141           { /* "#/" indicates an issuer's DN.  */
142             s++;
143             if (!*s || spacep (s)) /* No DN or prefixed with a space.  */
144               return gpg_error (GPG_ERR_INV_USER_ID); 
145             desc->u.name = s;
146             mode = KEYDB_SEARCH_MODE_ISSUER;
147           }
148         else 
149           { /* Serialnumber + optional issuer ID.  */
150             for (si=s; *si && *si != '/'; si++)
151               {
152                  /* Check for an invalid digit in the serial number. */
153                 if (!strchr("01234567890abcdefABCDEF", *si))
154                   return gpg_error (GPG_ERR_INV_USER_ID);
155               }
156             desc->sn = (const unsigned char*)s;
157             desc->snlen = -1;
158             if (!*si)
159               mode = KEYDB_SEARCH_MODE_SN;
160             else
161               {
162                 s = si+1;
163                 if (!*s || spacep (s))  /* No DN or prefixed with a space.  */
164                   return gpg_error (GPG_ERR_INV_USER_ID);
165                 desc->u.name = s;
166                 mode = KEYDB_SEARCH_MODE_ISSUER_SN;
167               }
168           }
169       }
170       break;
171
172     case ':': /* Unified fingerprint. */
173       {  
174         const char *se, *si;
175         int i;
176         
177         se = strchr (++s,':');
178         if (!se)
179           return gpg_error (GPG_ERR_INV_USER_ID);
180         for (i=0,si=s; si < se; si++, i++ )
181           {
182             if (!strchr("01234567890abcdefABCDEF", *si))
183               return gpg_error (GPG_ERR_INV_USER_ID); /* Invalid digit.  */
184           }
185         if (i != 32 && i != 40)
186           return gpg_error (GPG_ERR_INV_USER_ID); /* Invalid length of fpr.  */
187         for (i=0,si=s; si < se; i++, si +=2) 
188           desc->u.fpr[i] = hextobyte(si);
189         for (; i < 20; i++)
190           desc->u.fpr[i]= 0;
191         s = se + 1;
192         mode = KEYDB_SEARCH_MODE_FPR;
193       } 
194       break;
195
196     case '&': /* Keygrip*/
197       {  
198         if (hex2bin (s+1, desc->u.grip, 20) < 0)
199           return gpg_error (GPG_ERR_INV_USER_ID); /* Invalid. */
200         mode = KEYDB_SEARCH_MODE_KEYGRIP;
201       } 
202       break;
203
204     default:
205       if (s[0] == '0' && s[1] == 'x')
206         {
207           hexprefix = 1;
208           s += 2;
209         }
210
211       hexlength = strspn(s, "0123456789abcdefABCDEF");
212       if (hexlength >= 8 && s[hexlength] =='!')
213         {
214           desc->exact = 1;
215           hexlength++; /* Just for the following check.  */
216         }
217       
218       /* Check if a hexadecimal number is terminated by EOS or blank.  */
219       if (hexlength && s[hexlength] && !spacep (s+hexlength)) 
220         {
221           if (hexprefix) /* A "0x" prefix without a correct
222                             termination is an error.  */
223             return gpg_error (GPG_ERR_INV_USER_ID); 
224           /* The first characters looked like a hex number, but the
225              entire string is not.  */
226           hexlength = 0;  
227         }
228       
229       if (desc->exact)
230         hexlength--; /* Remove the bang.  */
231
232       if (hexlength == 8
233           || (!hexprefix && hexlength == 9 && *s == '0'))
234         { 
235           /* Short keyid.  */
236           if (hexlength == 9)
237             s++; 
238           desc->u.kid[1] = strtoul( s, NULL, 16 );
239           mode = KEYDB_SEARCH_MODE_SHORT_KID;
240         }
241       else if (hexlength == 16
242                || (!hexprefix && hexlength == 17 && *s == '0'))
243         { 
244           /* Long keyid.  */
245           char buf[9];
246           if (hexlength == 17)
247             s++;
248           mem2str (buf, s, 9);
249           desc->u.kid[0] = strtoul (buf, NULL, 16);
250           desc->u.kid[1] = strtoul (s+8, NULL, 16);
251           mode = KEYDB_SEARCH_MODE_LONG_KID;
252         }
253       else if (hexlength == 32
254                || (!hexprefix && hexlength == 33 && *s == '0'))
255         { 
256           /* MD5 fingerprint.  */
257           int i;
258           if (hexlength == 33)
259             s++;
260           memset (desc->u.fpr+16, 0, 4); 
261           for (i=0; i < 16; i++, s+=2) 
262             {
263               int c = hextobyte(s);
264               if (c == -1)
265                 return gpg_error (GPG_ERR_INV_USER_ID);
266               desc->u.fpr[i] = c;
267             }
268           mode = KEYDB_SEARCH_MODE_FPR16;
269         }
270       else if (hexlength == 40
271                || (!hexprefix && hexlength == 41 && *s == '0'))
272         { 
273           /* SHA1/RMD160 fingerprint.  */
274           int i;
275           if (hexlength == 41)
276             s++;
277           for (i=0; i < 20; i++, s+=2) 
278             {
279               int c = hextobyte(s);
280               if (c == -1)
281                 return gpg_error (GPG_ERR_INV_USER_ID);
282               desc->u.fpr[i] = c;
283             }
284           mode = KEYDB_SEARCH_MODE_FPR20;
285         }
286       else if (!hexprefix)
287         { 
288           /* The fingerprint in an X.509 listing is often delimited by
289              colons, so we try to single this case out. */
290           mode = 0;
291           hexlength = strspn (s, ":0123456789abcdefABCDEF");
292           if (hexlength == 59 && (!s[hexlength] || spacep (s+hexlength))) 
293             {
294               int i;
295
296               for (i=0; i < 20; i++, s += 3) 
297                 {
298                   int c = hextobyte(s);
299                   if (c == -1 || (i < 19 && s[2] != ':'))
300                     break;
301                   desc->u.fpr[i] = c;
302                 }
303               if (i == 20)
304                 mode = KEYDB_SEARCH_MODE_FPR20;
305             }
306           if (!mode) /* Default to substring search.  */
307             { 
308               desc->exact = 0;
309               desc->u.name = s;
310               mode = KEYDB_SEARCH_MODE_SUBSTR; 
311             }
312         }
313       else
314         { 
315           /* Hex number with a prefix but with a wrong length.  */
316           return gpg_error (GPG_ERR_INV_USER_ID);
317         }
318     }
319   
320   desc->mode = mode;
321   return 0;
322 }