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