Move new mailbox.c source file to common/.
[gnupg.git] / common / mbox-util.c
1 /* mbox-util.c - Mail address helper functions
2  * Copyright (C) 1998-2010 Free Software Foundation, Inc.
3  * Copyright (C) 1998-2015 Werner Koch
4  *
5  * This file is part of GnuPG.
6  *
7  * This file is free software; you can redistribute it and/or modify
8  * it under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * This file is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, see <http://www.gnu.org/licenses/>.
29  */
30
31 #include <config.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <unistd.h>
36 #include <errno.h>
37
38 #include "util.h"
39 #include "mbox-util.h"
40
41
42 static int
43 string_count_chr (const char *string, int c)
44 {
45   int count;
46
47   for (count=0; *string; string++ )
48     if ( *string == c )
49       count++;
50   return count;
51 }
52
53
54 static int
55 string_has_ctrl_or_space (const char *string)
56 {
57   for (; *string; string++ )
58     if (!(*string & 0x80) && *string <= 0x20)
59       return 1;
60   return 0;
61 }
62
63
64 /* Return true if STRING has two consecutive '.' after an '@'
65    sign.  */
66 static int
67 has_dotdot_after_at (const char *string)
68 {
69   string = strchr (string, '@');
70   if (!string)
71     return 0; /* No at-sign.  */
72   string++;
73   return !!strstr (string, "..");
74 }
75
76
77 /* Check whether the string has characters not valid in an RFC-822
78    address.  To cope with OpenPGP we ignore non-ascii characters
79    so that for example umlauts are legal in an email address.  An
80    OpenPGP user ID must be utf-8 encoded but there is no strict
81    requirement for RFC-822.  Thus to avoid IDNA encoding we put the
82    address verbatim as utf-8 into the user ID under the assumption
83    that mail programs handle IDNA at a lower level and take OpenPGP
84    user IDs as utf-8.  Note that we can't do an utf-8 encoding
85    checking here because in keygen.c this function is called with the
86    native encoding and native to utf-8 encoding is only done  later.  */
87 int
88 has_invalid_email_chars (const char *s)
89 {
90   int at_seen=0;
91   const char *valid_chars=
92     "01234567890_-.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
93
94   for ( ; *s; s++ )
95     {
96       if ( (*s & 0x80) )
97         continue; /* We only care about ASCII.  */
98       if ( *s == '@' )
99         at_seen=1;
100       else if ( !at_seen && !(strchr (valid_chars, *s)
101                               || strchr ("!#$%&'*+/=?^`{|}~", *s)))
102         return 1;
103       else if ( at_seen && !strchr( valid_chars, *s ) )
104         return 1;
105     }
106   return 0;
107 }
108
109
110 /* Check whether NAME represents a valid mailbox according to
111    RFC822. Returns true if so. */
112 int
113 is_valid_mailbox (const char *name)
114 {
115   return !( !name
116             || !*name
117             || has_invalid_email_chars (name)
118             || string_count_chr (name,'@') != 1
119             || *name == '@'
120             || name[strlen(name)-1] == '@'
121             || name[strlen(name)-1] == '.'
122             || strstr (name, "..") );
123 }
124
125
126 /* Return the mailbox (local-part@domain) form a standard user id.
127    Caller must free the result.  Returns NULL if no valid mailbox was
128    found (or we are out of memory). */
129 char *
130 mailbox_from_userid (const char *userid)
131 {
132   const char *s, *s_end;
133   size_t len;
134   char *result = NULL;
135
136   s = strchr (userid, '<');
137   if (s)
138     {
139       /* Seems to be a standard user id.  */
140       s++;
141       s_end = strchr (s, '>');
142       if (s_end && s_end > s)
143         {
144           len = s_end - s;
145           result = xtrymalloc (len + 1);
146           if (!result)
147             return NULL; /* Ooops - out of core.  */
148           strncpy (result, s, len);
149           result[len] = 0;
150           /* Apply some basic checks on the address.  We do not use
151              is_valid_mailbox because those checks are too strict.  */
152           if (string_count_chr (result, '@') != 1  /* Need exactly one '@.  */
153               || *result == '@'           /* local-part missing.  */
154               || result[len-1] == '@'     /* domain missing.  */
155               || result[len-1] == '.'     /* ends with a dot.  */
156               || string_has_ctrl_or_space (result)
157               || has_dotdot_after_at (result))
158             {
159               xfree (result);
160               result = NULL;
161               errno = EINVAL;
162             }
163         }
164       else
165         errno = EINVAL;
166     }
167   else if (is_valid_mailbox (userid))
168     {
169       /* The entire user id is a mailbox.  Return that one.  Note that
170          this fallback method has some restrictions on the valid
171          syntax of the mailbox.  However, those who want weird
172          addresses should know about it and use the regular <...>
173          syntax.  */
174       result = xtrystrdup (userid);
175     }
176   else
177     errno = EINVAL;
178
179   return result;
180 }
181
182
183 /* Check whether UID is a valid standard user id of the form
184      "Heinrich Heine <heinrichh@duesseldorf.de>"
185    and return true if this is the case. */
186 int
187 is_valid_user_id (const char *uid)
188 {
189   if (!uid || !*uid)
190     return 0;
191
192   return 1;
193 }