Version 0.3.0 from FTP
[asterisk/asterisk.git] / res / res_crypto.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Provide Cryptographic Signature capability
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #include <asterisk/file.h>
15 #include <asterisk/channel.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/say.h>
18 #include <asterisk/module.h>
19 #include <asterisk/options.h>
20 #include <asterisk/crypto.h>
21 #include <asterisk/md5.h>
22 #include <asterisk/cli.h>
23 #include <asterisk/io.h>
24 #include <openssl/ssl.h>
25 #include <openssl/err.h>
26 #include <stdio.h>
27 #include <pthread.h>
28 #include <dirent.h>
29 #include <string.h>
30 #include <errno.h>
31 #include <unistd.h>
32 #include <fcntl.h>
33 #include "../asterisk.h"
34 #include "../astconf.h"
35
36 /*
37  * Asterisk uses RSA keys with SHA-1 message digests for its
38  * digital signatures.  The choice of RSA is due to its higher
39  * throughput on verification, and the choice of SHA-1 based
40  * on the recently discovered collisions in MD5's compression 
41  * algorithm and recommendations of avoiding MD5 in new schemes
42  * from various industry experts.
43  *
44  * We use OpenSSL to provide our crypto routines, although we never
45  * actually use full-up SSL
46  *
47  */
48
49 /*
50  * XXX This module is not very thread-safe.  It is for everyday stuff
51  *     like reading keys and stuff, but there are all kinds of weird
52  *     races with people running reload and key init at the same time
53  *     for example
54  *
55  * XXXX
56  */
57
58 static char base64[64];
59 static char b2a[256];
60
61 static pthread_mutex_t keylock = AST_MUTEX_INITIALIZER;
62
63 #define KEY_NEEDS_PASSCODE (1 << 16)
64
65 struct ast_key {
66         /* Name of entity */
67         char name[80];
68         /* File name */
69         char fn[256];
70         /* Key type (AST_KEY_PUB or AST_KEY_PRIV, along with flags from above) */
71         int ktype;
72         /* RSA structure (if successfully loaded) */
73         RSA *rsa;
74         /* Whether we should be deleted */
75         int delme;
76         /* FD for input (or -1 if no input allowed, or -2 if we needed input) */
77         int infd;
78         /* FD for output */
79         int outfd;
80         /* Last MD5 Digest */
81         unsigned char digest[16];
82         struct ast_key *next;
83 };
84
85 static struct ast_key *keys = NULL;
86
87
88 #if 0
89 static int fdprint(int fd, char *s)
90 {
91         return write(fd, s, strlen(s) + 1);
92 }
93 #endif
94 static int pw_cb(char *buf, int size, int rwflag, void *userdata)
95 {
96         struct ast_key *key = (struct ast_key *)userdata;
97         char prompt[256];
98         int res;
99         int tmp;
100         if (key->infd > -1) {
101                 snprintf(prompt, sizeof(prompt), ">>>> passcode for %s key '%s': ",
102                          key->ktype == AST_KEY_PRIVATE ? "PRIVATE" : "PUBLIC", key->name);
103                 write(key->outfd, prompt, strlen(prompt));
104                 memset(buf, 0, sizeof(buf));
105                 tmp = ast_hide_password(key->infd);
106                 memset(buf, 0, size);
107                 res = read(key->infd, buf, size);
108                 ast_restore_tty(key->infd, tmp);
109                 if (buf[strlen(buf) -1] == '\n')
110                         buf[strlen(buf) - 1] = '\0';
111                 return strlen(buf);
112         } else {
113                 /* Note that we were at least called */
114                 key->infd = -2;
115         }
116         return -1;
117 }
118
119 struct ast_key *ast_key_get(char *kname, int ktype)
120 {
121         struct ast_key *key;
122         ast_pthread_mutex_lock(&keylock);
123         key = keys;
124         while(key) {
125                 if (!strcmp(kname, key->name) &&
126                     (ktype == key->ktype))
127                         break;
128                 key = key->next;
129         }
130         ast_pthread_mutex_unlock(&keylock);
131         return key;
132 }
133
134 static struct ast_key *try_load_key (char *dir, char *fname, int ifd, int ofd, int *not2)
135 {
136         int ktype = 0;
137         char *c = NULL;
138         char ffname[256];
139         char digest[16];
140         FILE *f;
141         struct MD5Context md5;
142         struct ast_key *key;
143         static int notice = 0;
144         int found = 0;
145
146         /* Make sure its name is a public or private key */
147
148         if ((c = strstr(fname, ".pub")) && !strcmp(c, ".pub")) {
149                 ktype = AST_KEY_PUBLIC;
150         } else if ((c = strstr(fname, ".key")) && !strcmp(c, ".key")) {
151                 ktype = AST_KEY_PRIVATE;
152         } else
153                 return NULL;
154
155         /* Get actual filename */
156         snprintf(ffname, sizeof(ffname), "%s/%s", dir, fname);
157
158         ast_pthread_mutex_lock(&keylock);
159         key = keys;
160         while(key) {
161                 /* Look for an existing version already */
162                 if (!strcasecmp(key->fn, ffname)) 
163                         break;
164                 key = key->next;
165         }
166         ast_pthread_mutex_unlock(&keylock);
167
168         /* Open file */
169         f = fopen(ffname, "r");
170         if (!f) {
171                 ast_log(LOG_WARNING, "Unable to open key file %s: %s\n", ffname, strerror(errno));
172                 return NULL;
173         }
174         MD5Init(&md5);
175         while(!feof(f)) {
176                 /* Calculate a "whatever" quality md5sum of the key */
177                 char buf[256];
178                 fgets(buf, sizeof(buf), f);
179                 if (!feof(f)) {
180                         MD5Update(&md5, buf, strlen(buf));
181                 }
182         }
183         MD5Final(digest, &md5);
184         if (key) {
185                 /* If the MD5 sum is the same, and it isn't awaiting a passcode 
186                    then this is far enough */
187                 if (!memcmp(digest, key->digest, 16) &&
188                     !(key->ktype & KEY_NEEDS_PASSCODE)) {
189                         fclose(f);
190                         key->delme = 0;
191                         return NULL;
192                 } else {
193                         /* Preserve keytype */
194                         ktype = key->ktype;
195                         /* Recycle the same structure */
196                         found++;
197                 }
198         }
199
200         /* Make fname just be the normal name now */
201         *c = '\0';
202         if (!key) {
203                 key = (struct ast_key *)malloc(sizeof(struct ast_key));
204                 if (!key) {
205                         ast_log(LOG_WARNING, "Out of memory\n");
206                         fclose(f);
207                         return NULL;
208                 }
209                 memset(key, 0, sizeof(struct ast_key));
210         }
211         /* At this point we have a key structure (old or new).  Time to
212            fill it with what we know */
213         /* Gotta lock if this one already exists */
214         if (found)
215                 ast_pthread_mutex_lock(&keylock);
216         /* First the filename */
217         strncpy(key->fn, ffname, sizeof(key->fn));
218         /* Then the name */
219         strncpy(key->name, fname, sizeof(key->name));
220         key->ktype = ktype;
221         /* Yes, assume we're going to be deleted */
222         key->delme = 1;
223         /* Keep the key type */
224         memcpy(key->digest, digest, 16);
225         /* Can I/O takes the FD we're given */
226         key->infd = ifd;
227         key->outfd = ofd;
228         /* Reset the file back to the beginning */
229         rewind(f);
230         /* Now load the key with the right method */
231         if (ktype == AST_KEY_PUBLIC)
232                 key->rsa = PEM_read_RSA_PUBKEY(f, NULL, pw_cb, key);
233         else
234                 key->rsa = PEM_read_RSAPrivateKey(f, NULL, pw_cb, key);
235         fclose(f);
236         if (key->rsa) {
237                 /* Key loaded okay */
238                 key->ktype &= ~KEY_NEEDS_PASSCODE;
239                 if (option_verbose > 2)
240                         ast_verbose(VERBOSE_PREFIX_3 "Loaded %s key '%s'\n", key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
241                 if (option_debug)
242                         ast_log(LOG_DEBUG, "Key '%s' loaded OK\n", key->name);
243                 key->delme = 0;
244         } else if (key->infd != -2) {
245                 ast_log(LOG_WARNING, "Key load %s '%s' failed\n",key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
246                 if (ofd > -1) {
247                         ERR_print_errors_fp(stderr);
248                 } else
249                         ERR_print_errors_fp(stderr);
250         } else {
251                 ast_log(LOG_NOTICE, "Key '%s' needs passcode.\n", key->name);
252                 key->ktype |= KEY_NEEDS_PASSCODE;
253                 if (!notice) {
254                         if (!option_initcrypto) 
255                                 ast_log(LOG_NOTICE, "Add the '-i' flag to the asterisk command line if you want to automatically initialize passcodes at launch.\n");
256                         notice++;
257                 }
258                 /* Keep it anyway */
259                 key->delme = 0;
260                 /* Print final notice about "init keys" when done */
261                 *not2 = 1;
262         }
263         if (found)
264                 ast_pthread_mutex_unlock(&keylock);
265         if (!found) {
266                 ast_pthread_mutex_lock(&keylock);
267                 key->next = keys;
268                 keys = key;
269                 ast_pthread_mutex_unlock(&keylock);
270         }
271         return key;
272 }
273
274 #if 0
275
276 static void dump(unsigned char *src, int len)
277 {
278         int x; 
279         for (x=0;x<len;x++)
280                 printf("%02x", *(src++));
281         printf("\n");
282 }
283
284 static char *binary(int y, int len)
285 {
286         static char res[80];
287         int x;
288         memset(res, 0, sizeof(res));
289         for (x=0;x<len;x++) {
290                 if (y & (1 << x))
291                         res[(len - x - 1)] = '1';
292                 else
293                         res[(len - x - 1)] = '0';
294         }
295         return res;
296 }
297
298 #endif
299
300 static int base64decode(unsigned char *dst, char *src, int max)
301 {
302         int cnt = 0;
303         unsigned int byte = 0;
304         unsigned int bits = 0;
305         int incnt = 0;
306 #if 0
307         unsigned char *odst = dst;
308 #endif
309         while(*src && (cnt < max)) {
310                 /* Shift in 6 bits of input */
311                 byte <<= 6;
312                 byte |= (b2a[(int)(*src)]) & 0x3f;
313                 bits += 6;
314 #if 0
315                 printf("Add: %c %s\n", *src, binary(b2a[(int)(*src)] & 0x3f, 6));
316 #endif
317                 src++;
318                 incnt++;
319                 /* If we have at least 8 bits left over, take that character 
320                    off the top */
321                 if (bits >= 8)  {
322                         bits -= 8;
323                         *dst = (byte >> bits) & 0xff;
324 #if 0
325                         printf("Remove: %02x %s\n", *dst, binary(*dst, 8));
326 #endif
327                         dst++;
328                         cnt++;
329                 }
330         }
331 #if 0
332         dump(odst, cnt);
333 #endif
334         /* Dont worry about left over bits, they're extra anyway */
335         return cnt;
336 }
337
338 static int base64encode(char *dst, unsigned char *src, int srclen, int max)
339 {
340         int cnt = 0;
341         unsigned int byte = 0;
342         int bits = 0;
343         int index;
344         int cntin = 0;
345 #if 0
346         char *odst = dst;
347         dump(src, srclen);
348 #endif
349         /* Reserve one bit for end */
350         max--;
351         while((cntin < srclen) && (cnt < max)) {
352                 byte <<= 8;
353 #if 0
354                 printf("Add: %02x %s\n", *src, binary(*src, 8));
355 #endif
356                 byte |= *(src++);
357                 bits += 8;
358                 cntin++;
359                 while((bits >= 6) && (cnt < max)) {
360                         bits -= 6;
361                         /* We want only the top */
362                         index = (byte >> bits) & 0x3f;
363                         *dst = base64[index];
364 #if 0
365                         printf("Remove: %c %s\n", *dst, binary(index, 6));
366 #endif
367                         dst++;
368                         cnt++;
369                 }
370         }
371         if (bits && (cnt < max)) {
372                 /* Add one last character for the remaining bits, 
373                    padding the rest with 0 */
374                 byte <<= (6 - bits);
375                 index = (byte) & 0x3f;
376                 *(dst++) = base64[index];
377                 cnt++;
378         }
379         *dst = '\0';
380         return cnt;
381 }
382
383 int ast_sign(struct ast_key *key, char *msg, char *sig)
384 {
385         unsigned char digest[20];
386         unsigned char dsig[128];
387         int siglen = sizeof(dsig);
388         int res;
389
390         if (key->ktype != AST_KEY_PRIVATE) {
391                 ast_log(LOG_WARNING, "Cannot sign with a private key\n");
392                 return -1;
393         }
394
395         /* Calculate digest of message */
396         SHA1((unsigned char *)msg, strlen(msg), digest);
397
398         /* Verify signature */
399         res = RSA_sign(NID_sha1, digest, sizeof(digest), dsig, &siglen, key->rsa);
400         
401         if (!res) {
402                 ast_log(LOG_WARNING, "RSA Signature (key %s) failed\n", key->name);
403                 return -1;
404         }
405
406         if (siglen != sizeof(dsig)) {
407                 ast_log(LOG_WARNING, "Unexpected signature length %d, expecting %d\n", siglen, sizeof(dsig));
408                 return -1;
409         }
410
411         /* Success -- encode (256 bytes max as documented) */
412         base64encode(sig, dsig, siglen, 256);
413         return 0;
414         
415 }
416
417 int ast_check_signature(struct ast_key *key, char *msg, char *sig)
418 {
419         unsigned char digest[20];
420         unsigned char dsig[128];
421         int res;
422
423         if (key->ktype != AST_KEY_PUBLIC) {
424                 /* Okay, so of course you really *can* but for our purposes
425                    we're going to say you can't */
426                 ast_log(LOG_WARNING, "Cannot check message signature with a private key\n");
427                 return -1;
428         }
429
430         /* Decode signature */
431         res = base64decode(dsig, sig, sizeof(dsig));
432         if (res != sizeof(dsig)) {
433                 ast_log(LOG_WARNING, "Signature improper length (expect %d, got %d)\n", sizeof(dsig), res);
434                 return -1;
435         }
436
437         /* Calculate digest of message */
438         SHA1((unsigned char *)msg, strlen(msg), digest);
439
440         /* Verify signature */
441         res = RSA_verify(NID_sha1, digest, sizeof(digest), dsig, sizeof(dsig), key->rsa);
442         
443         if (!res) {
444                 ast_log(LOG_DEBUG, "Key failed verification\n");
445                 return -1;
446         }
447         /* Pass */
448         return 0;
449 }
450
451 static void crypto_load(int ifd, int ofd)
452 {
453         struct ast_key *key, *nkey, *last;
454         DIR *dir;
455         struct dirent *ent;
456         int note = 0;
457         /* Mark all keys for deletion */
458         ast_pthread_mutex_lock(&keylock);
459         key = keys;
460         while(key) {
461                 key->delme = 1;
462                 key = key->next;
463         }
464         ast_pthread_mutex_unlock(&keylock);
465         /* Load new keys */
466         dir = opendir((char *)ast_config_AST_KEY_DIR);
467         if (dir) {
468                 while((ent = readdir(dir))) {
469                         try_load_key((char *)ast_config_AST_KEY_DIR, ent->d_name, ifd, ofd, &note);
470                 }
471                 closedir(dir);
472         } else
473                 ast_log(LOG_WARNING, "Unable to open key directory '%s'\n", (char *)ast_config_AST_KEY_DIR);
474         if (note) {
475                 ast_log(LOG_NOTICE, "Please run the command 'init keys' to enter the passcodes for the keys\n");
476         }
477         ast_pthread_mutex_lock(&keylock);
478         key = keys;
479         last = NULL;
480         while(key) {
481                 nkey = key->next;
482                 if (key->delme) {
483                         ast_log(LOG_DEBUG, "Deleting key %s type %d\n", key->name, key->ktype);
484                         /* Do the delete */
485                         if (last)
486                                 last->next = nkey;
487                         else
488                                 keys = nkey;
489                         if (key->rsa)
490                                 RSA_free(key->rsa);
491                         free(key);
492                 } else 
493                         last = key;
494                 key = nkey;
495         }
496         ast_pthread_mutex_unlock(&keylock);
497 }
498
499 static void md52sum(char *sum, unsigned char *md5)
500 {
501         int x;
502         for (x=0;x<16;x++) 
503                 sum += sprintf(sum, "%02x", *(md5++));
504 }
505
506 static int show_keys(int fd, int argc, char *argv[])
507 {
508         struct ast_key *key;
509         char sum[16 * 2 + 1];
510
511         ast_pthread_mutex_lock(&keylock);
512         key = keys;
513         ast_cli(fd, "%-18s %-8s %-16s %-33s\n", "Key Name", "Type", "Status", "Sum");
514         while(key) {
515                 md52sum(sum, key->digest);
516                 ast_cli(fd, "%-18s %-8s %-16s %-33s\n", key->name, 
517                         (key->ktype & 0xf) == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE",
518                         key->ktype & KEY_NEEDS_PASSCODE ? "[Needs Passcode]" : "[Loaded]", sum);
519                                 
520                 key = key->next;
521         }
522         ast_pthread_mutex_unlock(&keylock);
523         return RESULT_SUCCESS;
524 }
525
526 static int init_keys(int fd, int argc, char *argv[])
527 {
528         struct ast_key *key;
529         int ign;
530         char *kn;
531         char tmp[256];
532
533         key = keys;
534         while(key) {
535                 /* Reload keys that need pass codes now */
536                 if (key->ktype & KEY_NEEDS_PASSCODE) {
537                         kn = key->fn + strlen(ast_config_AST_KEY_DIR) + 1;
538                         strncpy(tmp, kn, sizeof(tmp));
539                         try_load_key((char *)ast_config_AST_KEY_DIR, tmp, fd, fd, &ign);
540                 }
541                 key = key->next;
542         }
543         return RESULT_SUCCESS;
544 }
545
546 static char show_key_usage[] =
547 "Usage: show keys\n"
548 "       Displays information about RSA keys known by Asterisk\n";
549
550 static char init_keys_usage[] =
551 "Usage: init keys\n"
552 "       Initializes private keys (by reading in pass code from the user)\n";
553
554 static struct ast_cli_entry cli_show_keys = 
555 { { "show", "keys", NULL }, show_keys, "Displays RSA key information", show_key_usage };
556
557 static struct ast_cli_entry cli_init_keys = 
558 { { "init", "keys", NULL }, init_keys, "Initialize RSA key passcodes", init_keys_usage };
559
560 static void base64_init(void)
561 {
562         int x;
563         memset(b2a, -1, sizeof(b2a));
564         /* Initialize base-64 Conversion table */
565         for (x=0;x<26;x++) {
566                 /* A-Z */
567                 base64[x] = 'A' + x;
568                 b2a['A' + x] = x;
569                 /* a-z */
570                 base64[x + 26] = 'a' + x;
571                 b2a['a' + x] = x + 26;
572                 /* 0-9 */
573                 if (x < 10) {
574                         base64[x + 52] = '0' + x;
575                         b2a['0' + x] = x + 52;
576                 }
577         }
578         base64[62] = '+';
579         base64[63] = '/';
580         b2a[(int)'+'] = 62;
581         b2a[(int)'/'] = 63;
582 #if 0
583         for (x=0;x<64;x++) {
584                 if (b2a[(int)base64[x]] != x) {
585                         fprintf(stderr, "!!! %d failed\n", x);
586                 } else
587                         fprintf(stderr, "--- %d passed\n", x);
588         }
589 #endif
590 }
591
592 static int crypto_init(void)
593 {
594         base64_init();
595         SSL_library_init();
596         ERR_load_crypto_strings();
597         ast_cli_register(&cli_show_keys);
598         ast_cli_register(&cli_init_keys);
599         return 0;
600 }
601
602 int reload(void)
603 {
604         crypto_load(-1, -1);
605         return 0;
606 }
607
608 int load_module(void)
609 {
610         crypto_init();
611         if (option_initcrypto)
612                 crypto_load(STDIN_FILENO, STDOUT_FILENO);
613         else
614                 crypto_load(-1, -1);
615         return 0;
616 }
617
618 int unload_module(void)
619 {
620         /* Can't unload this once we're loaded */
621         return -1;
622 }
623
624 char *description(void)
625 {
626         return "Cryptographic Digital Signatures";
627 }
628
629 int usecount(void)
630 {
631         /* We should never be unloaded */
632         return 1;
633 }
634
635 char *key()
636 {
637         return ASTERISK_GPL_KEY;
638 }