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