Extract common logic in OpenSSL-specific code
[tinc] / src / utils.c
1 /*
2     utils.c -- gathering of some stupid small functions
3     Copyright (C) 1999-2005 Ivo Timmermans
4                   2000-2013 Guus Sliepen <guus@tinc-vpn.org>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License along
17     with this program; if not, write to the Free Software Foundation, Inc.,
18     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #include "logger.h"
22 #include "system.h"
23 #include "utils.h"
24 #include "xalloc.h"
25
26 static const char hexadecimals[] = "0123456789ABCDEF";
27 static const char base64_original[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
28 static const char base64_urlsafe[] =  "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
29 static const char base64_decode[256] = {
30         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
31                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
32                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, 62, -1, 63,
33                 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1,
34                 -1,  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14,
35                 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, 63,
36                 -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
37                 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, -1, -1, -1, -1, -1,
38                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
39                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
40                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
41                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
42                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
43                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
44                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
45                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
46         };
47
48 static uint8_t charhex2bin(char c) {
49         uint8_t cu = (uint8_t) c;
50
51         if(isdigit(cu)) {
52                 return cu - '0';
53         } else {
54                 return toupper(cu) - 'A' + 10;
55         }
56 }
57
58 size_t hex2bin(const char *src, void *vdst, size_t length) {
59         uint8_t *dst = vdst;
60         size_t i;
61
62         for(i = 0; i < length && isxdigit((uint8_t) src[i * 2]) && isxdigit((uint8_t) src[i * 2 + 1]); i++) {
63                 dst[i] = charhex2bin(src[i * 2]) * 16 + charhex2bin(src[i * 2 + 1]);
64         }
65
66         return i;
67 }
68
69 size_t bin2hex(const void *vsrc, char *dst, size_t length) {
70         const char *src = vsrc;
71
72         for(size_t i = length; i > 0;) {
73                 --i;
74                 dst[i * 2 + 1] = hexadecimals[(unsigned char) src[i] & 15];
75                 dst[i * 2] = hexadecimals[(unsigned char) src[i] >> 4];
76         }
77
78         dst[length * 2] = 0;
79         return length * 2;
80 }
81
82 size_t b64decode_tinc(const char *src, void *dst, size_t length) {
83         size_t i;
84         uint32_t triplet = 0;
85         unsigned char *udst = (unsigned char *)dst;
86
87         for(i = 0; i < length && src[i]; i++) {
88                 triplet |= base64_decode[src[i] & 0xff] << (6 * (i & 3));
89
90                 if((i & 3) == 3) {
91                         if(triplet & 0xff000000U) {
92                                 return 0;
93                         }
94
95                         udst[0] = triplet & 0xff;
96                         triplet >>= 8;
97                         udst[1] = triplet & 0xff;
98                         triplet >>= 8;
99                         udst[2] = triplet;
100                         triplet = 0;
101                         udst += 3;
102                 }
103         }
104
105         if(triplet & 0xff000000U) {
106                 return 0;
107         }
108
109         if((i & 3) == 3) {
110                 udst[0] = triplet & 0xff;
111                 triplet >>= 8;
112                 udst[1] = triplet & 0xff;
113                 return i / 4 * 3 + 2;
114         } else if((i & 3) == 2) {
115                 udst[0] = triplet & 0xff;
116                 return i / 4 * 3 + 1;
117         } else {
118                 return i / 4 * 3;
119         }
120 }
121
122 static size_t b64encode_tinc_internal(const void *src, char *dst, size_t length, const char *alphabet) {
123         uint32_t triplet;
124         const unsigned char *usrc = (unsigned char *)src;
125         size_t si = length / 3 * 3;
126         size_t di = length / 3 * 4;
127
128         switch(length % 3) {
129         case 2:
130                 triplet = usrc[si] | usrc[si + 1] << 8;
131                 dst[di] = alphabet[triplet & 63];
132                 triplet >>= 6;
133                 dst[di + 1] = alphabet[triplet & 63];
134                 triplet >>= 6;
135                 dst[di + 2] = alphabet[triplet];
136                 dst[di + 3] = 0;
137                 length = di + 3;
138                 break;
139
140         case 1:
141                 triplet = usrc[si];
142                 dst[di] = alphabet[triplet & 63];
143                 triplet >>= 6;
144                 dst[di + 1] = alphabet[triplet];
145                 dst[di + 2] = 0;
146                 length = di + 2;
147                 break;
148
149         default:
150                 dst[di] = 0;
151                 length = di;
152                 break;
153         }
154
155         while(si > 0) {
156                 di -= 4;
157                 si -= 3;
158                 triplet = usrc[si] | usrc[si + 1] << 8 | usrc[si + 2] << 16;
159                 dst[di] = alphabet[triplet & 63];
160                 triplet >>= 6;
161                 dst[di + 1] = alphabet[triplet & 63];
162                 triplet >>= 6;
163                 dst[di + 2] = alphabet[triplet & 63];
164                 triplet >>= 6;
165                 dst[di + 3] = alphabet[triplet];
166         }
167
168         return length;
169 }
170
171 size_t b64encode_tinc(const void *src, char *dst, size_t length) {
172         return b64encode_tinc_internal(src, dst, length, base64_original);
173 }
174
175 size_t b64encode_tinc_urlsafe(const void *src, char *dst, size_t length) {
176         return b64encode_tinc_internal(src, dst, length, base64_urlsafe);
177 }
178
179 #ifdef HAVE_MINGW
180 const char *winerror(int err) {
181         static char buf[1024], *ptr;
182
183         ptr = buf + snprintf(buf, sizeof(buf), "(%d) ", err);
184
185         if(!FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
186                           NULL, err, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), ptr, sizeof(buf) - (ptr - buf), NULL)) {
187                 strncpy(buf, "(unable to format errormessage)", sizeof(buf));
188         };
189
190         if((ptr = strchr(buf, '\r'))) {
191                 *ptr = '\0';
192         }
193
194         return buf;
195 }
196 #endif
197
198 bool check_id(const char *id) {
199         if(!id || !*id) {
200                 return false;
201         }
202
203         for(; *id; id++)
204                 if(!isalnum((uint8_t) *id) && *id != '_') {
205                         return false;
206                 }
207
208         return true;
209 }
210
211 bool check_netname(const char *netname, bool strict) {
212         if(!netname || !*netname || *netname == '.') {
213                 return false;
214         }
215
216         for(const char *c = netname; *c; c++) {
217                 if(iscntrl((uint8_t) *c)) {
218                         return false;
219                 }
220
221                 if(*c == '/' || *c == '\\') {
222                         return false;
223                 }
224
225                 if(strict && strchr(" $%<>:`\"|?*", *c)) {
226                         return false;
227                 }
228         }
229
230         return true;
231 }
232
233 /* Windows doesn't define HOST_NAME_MAX. */
234 #ifndef HOST_NAME_MAX
235 #define HOST_NAME_MAX 255
236 #endif
237
238 char *replace_name(const char *name) {
239         char *ret_name;
240
241         if(name[0] == '$') {
242                 char *envname = getenv(name + 1);
243                 char hostname[HOST_NAME_MAX + 1];
244
245                 if(!envname) {
246                         if(strcmp(name + 1, "HOST")) {
247                                 logger(DEBUG_ALWAYS, LOG_ERR, "Invalid Name: environment variable %s does not exist\n", name + 1);
248                                 return NULL;
249                         }
250
251                         if(gethostname(hostname, sizeof(hostname)) || !*hostname) {
252                                 logger(DEBUG_ALWAYS, LOG_ERR, "Could not get hostname: %s\n", sockstrerror(sockerrno));
253                                 return NULL;
254                         }
255
256                         hostname[HOST_NAME_MAX] = 0;
257                         envname = hostname;
258                 }
259
260                 ret_name = xstrdup(envname);
261
262                 for(char *c = ret_name; *c; c++)
263                         if(!isalnum((uint8_t) *c)) {
264                                 *c = '_';
265                         }
266         } else {
267                 ret_name = xstrdup(name);
268         }
269
270         if(!check_id(ret_name)) {
271                 logger(DEBUG_ALWAYS, LOG_ERR, "Invalid name for myself!");
272                 free(ret_name);
273                 return NULL;
274         }
275
276         return ret_name;
277 }
278
279 /* Open a file with the desired permissions, minus the umask.
280    Also, if we want to create an executable file, we call fchmod()
281    to set the executable bits. */
282
283 FILE *fopenmask(const char *filename, const char *mode, mode_t perms) {
284         mode_t mask = umask(0);
285         perms &= ~mask;
286         umask(~perms & 0777);
287         FILE *f = fopen(filename, mode);
288
289         if(!f) {
290                 fprintf(stderr, "Could not open %s: %s\n", filename, strerror(errno));
291                 return NULL;
292         }
293
294 #ifdef HAVE_FCHMOD
295
296         if(perms & 0444) {
297                 fchmod(fileno(f), perms);
298         }
299
300 #endif
301         umask(mask);
302         return f;
303 }
304