update copyright headers for 2005
[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 - 2005, 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                 memset(buf, 0, 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_mutex_lock(&keylock);
216         /* First the filename */
217         strncpy(key->fn, ffname, sizeof(key->fn) - 1);
218         /* Then the name */
219         strncpy(key->name, fname, sizeof(key->name) - 1);
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                 if (RSA_size(key->rsa) == 128) {
238                         /* Key loaded okay */
239                         key->ktype &= ~KEY_NEEDS_PASSCODE;
240                         if (option_verbose > 2)
241                                 ast_verbose(VERBOSE_PREFIX_3 "Loaded %s key '%s'\n", key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
242                         if (option_debug)
243                                 ast_log(LOG_DEBUG, "Key '%s' loaded OK\n", key->name);
244                         key->delme = 0;
245                 } else
246                         ast_log(LOG_NOTICE, "Key '%s' is not expected size.\n", key->name);
247         } else if (key->infd != -2) {
248                 ast_log(LOG_WARNING, "Key load %s '%s' failed\n",key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
249                 if (ofd > -1) {
250                         ERR_print_errors_fp(stderr);
251                 } else
252                         ERR_print_errors_fp(stderr);
253         } else {
254                 ast_log(LOG_NOTICE, "Key '%s' needs passcode.\n", key->name);
255                 key->ktype |= KEY_NEEDS_PASSCODE;
256                 if (!notice) {
257                         if (!option_initcrypto) 
258                                 ast_log(LOG_NOTICE, "Add the '-i' flag to the asterisk command line if you want to automatically initialize passcodes at launch.\n");
259                         notice++;
260                 }
261                 /* Keep it anyway */
262                 key->delme = 0;
263                 /* Print final notice about "init keys" when done */
264                 *not2 = 1;
265         }
266         if (found)
267                 ast_mutex_unlock(&keylock);
268         if (!found) {
269                 ast_mutex_lock(&keylock);
270                 key->next = keys;
271                 keys = key;
272                 ast_mutex_unlock(&keylock);
273         }
274         return key;
275 }
276
277 #if 0
278
279 static void dump(unsigned char *src, int len)
280 {
281         int x; 
282         for (x=0;x<len;x++)
283                 printf("%02x", *(src++));
284         printf("\n");
285 }
286
287 static char *binary(int y, int len)
288 {
289         static char res[80];
290         int x;
291         memset(res, 0, sizeof(res));
292         for (x=0;x<len;x++) {
293                 if (y & (1 << x))
294                         res[(len - x - 1)] = '1';
295                 else
296                         res[(len - x - 1)] = '0';
297         }
298         return res;
299 }
300
301 #endif
302
303 int ast_sign_bin(struct ast_key *key, char *msg, int msglen, unsigned char *dsig)
304 {
305         unsigned char digest[20];
306         int siglen = 128;
307         int res;
308
309         if (key->ktype != AST_KEY_PRIVATE) {
310                 ast_log(LOG_WARNING, "Cannot sign with a public key\n");
311                 return -1;
312         }
313
314         /* Calculate digest of message */
315         SHA1((unsigned char *)msg, msglen, digest);
316
317         /* Verify signature */
318         res = RSA_sign(NID_sha1, digest, sizeof(digest), dsig, &siglen, key->rsa);
319         
320         if (!res) {
321                 ast_log(LOG_WARNING, "RSA Signature (key %s) failed\n", key->name);
322                 return -1;
323         }
324
325         if (siglen != 128) {
326                 ast_log(LOG_WARNING, "Unexpected signature length %d, expecting %d\n", (int)siglen, (int)128);
327                 return -1;
328         }
329
330         return 0;
331         
332 }
333
334 extern int ast_decrypt_bin(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
335 {
336         int res;
337         int pos = 0;
338         if (key->ktype != AST_KEY_PRIVATE) {
339                 ast_log(LOG_WARNING, "Cannot decrypt with a public key\n");
340                 return -1;
341         }
342
343         if (srclen % 128) {
344                 ast_log(LOG_NOTICE, "Tried to decrypt something not a multiple of 128 bytes\n");
345                 return -1;
346         }
347         while(srclen) {
348                 /* Process chunks 128 bytes at a time */
349                 res = RSA_private_decrypt(128, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING);
350                 if (res < 0)
351                         return -1;
352                 pos += res;
353                 src += 128;
354                 srclen -= 128;
355                 dst += res;
356         }
357         return pos;
358 }
359
360 extern int ast_encrypt_bin(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
361 {
362         int res;
363         int bytes;
364         int pos = 0;
365         if (key->ktype != AST_KEY_PUBLIC) {
366                 ast_log(LOG_WARNING, "Cannot encrypt with a private key\n");
367                 return -1;
368         }
369         
370         while(srclen) {
371                 bytes = srclen;
372                 if (bytes > 128 - 41)
373                         bytes = 128 - 41;
374                 /* Process chunks 128-41 bytes at a time */
375                 res = RSA_public_encrypt(bytes, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING);
376                 if (res != 128) {
377                         ast_log(LOG_NOTICE, "How odd, encrypted size is %d\n", res);
378                         return -1;
379                 }
380                 src += bytes;
381                 srclen -= bytes;
382                 pos += res;
383                 dst += res;
384         }
385         return pos;
386 }
387
388 int ast_sign(struct ast_key *key, char *msg, char *sig)
389 {
390         unsigned char dsig[128];
391         int siglen = sizeof(dsig);
392         int res;
393         res = ast_sign_bin(key, msg, strlen(msg), dsig);
394         if (!res)
395                 /* Success -- encode (256 bytes max as documented) */
396                 ast_base64encode(sig, dsig, siglen, 256);
397         return res;
398         
399 }
400
401 int ast_check_signature_bin(struct ast_key *key, char *msg, int msglen, unsigned char *dsig)
402 {
403         unsigned char digest[20];
404         int res;
405
406         if (key->ktype != AST_KEY_PUBLIC) {
407                 /* Okay, so of course you really *can* but for our purposes
408                    we're going to say you can't */
409                 ast_log(LOG_WARNING, "Cannot check message signature with a private key\n");
410                 return -1;
411         }
412
413         /* Calculate digest of message */
414         SHA1((unsigned char *)msg, msglen, digest);
415
416         /* Verify signature */
417         res = RSA_verify(NID_sha1, digest, sizeof(digest), dsig, 128, key->rsa);
418         
419         if (!res) {
420                 ast_log(LOG_DEBUG, "Key failed verification: %s\n", key->name);
421                 return -1;
422         }
423         /* Pass */
424         return 0;
425 }
426
427 int ast_check_signature(struct ast_key *key, char *msg, char *sig)
428 {
429         unsigned char dsig[128];
430         int res;
431
432         /* Decode signature */
433         res = ast_base64decode(dsig, sig, sizeof(dsig));
434         if (res != sizeof(dsig)) {
435                 ast_log(LOG_WARNING, "Signature improper length (expect %d, got %d)\n", (int)sizeof(dsig), (int)res);
436                 return -1;
437         }
438         res = ast_check_signature_bin(key, msg, strlen(msg), dsig);
439         return res;
440 }
441
442 static void crypto_load(int ifd, int ofd)
443 {
444         struct ast_key *key, *nkey, *last;
445         DIR *dir = NULL;
446         struct dirent *ent;
447         int note = 0;
448         /* Mark all keys for deletion */
449         ast_mutex_lock(&keylock);
450         key = keys;
451         while(key) {
452                 key->delme = 1;
453                 key = key->next;
454         }
455         ast_mutex_unlock(&keylock);
456         /* Load new keys */
457         dir = opendir((char *)ast_config_AST_KEY_DIR);
458         if (dir) {
459                 while((ent = readdir(dir))) {
460                         try_load_key((char *)ast_config_AST_KEY_DIR, ent->d_name, ifd, ofd, &note);
461                 }
462                 closedir(dir);
463         } else
464                 ast_log(LOG_WARNING, "Unable to open key directory '%s'\n", (char *)ast_config_AST_KEY_DIR);
465         if (note) {
466                 ast_log(LOG_NOTICE, "Please run the command 'init keys' to enter the passcodes for the keys\n");
467         }
468         ast_mutex_lock(&keylock);
469         key = keys;
470         last = NULL;
471         while(key) {
472                 nkey = key->next;
473                 if (key->delme) {
474                         ast_log(LOG_DEBUG, "Deleting key %s type %d\n", key->name, key->ktype);
475                         /* Do the delete */
476                         if (last)
477                                 last->next = nkey;
478                         else
479                                 keys = nkey;
480                         if (key->rsa)
481                                 RSA_free(key->rsa);
482                         free(key);
483                 } else 
484                         last = key;
485                 key = nkey;
486         }
487         ast_mutex_unlock(&keylock);
488 }
489
490 static void md52sum(char *sum, unsigned char *md5)
491 {
492         int x;
493         for (x=0;x<16;x++) 
494                 sum += sprintf(sum, "%02x", *(md5++));
495 }
496
497 static int show_keys(int fd, int argc, char *argv[])
498 {
499         struct ast_key *key;
500         char sum[16 * 2 + 1];
501
502         ast_mutex_lock(&keylock);
503         key = keys;
504         ast_cli(fd, "%-18s %-8s %-16s %-33s\n", "Key Name", "Type", "Status", "Sum");
505         while(key) {
506                 md52sum(sum, key->digest);
507                 ast_cli(fd, "%-18s %-8s %-16s %-33s\n", key->name, 
508                         (key->ktype & 0xf) == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE",
509                         key->ktype & KEY_NEEDS_PASSCODE ? "[Needs Passcode]" : "[Loaded]", sum);
510                                 
511                 key = key->next;
512         }
513         ast_mutex_unlock(&keylock);
514         return RESULT_SUCCESS;
515 }
516
517 static int init_keys(int fd, int argc, char *argv[])
518 {
519         struct ast_key *key;
520         int ign;
521         char *kn;
522         char tmp[256] = "";
523
524         key = keys;
525         while(key) {
526                 /* Reload keys that need pass codes now */
527                 if (key->ktype & KEY_NEEDS_PASSCODE) {
528                         kn = key->fn + strlen(ast_config_AST_KEY_DIR) + 1;
529                         strncpy(tmp, kn, sizeof(tmp) - 1);
530                         try_load_key((char *)ast_config_AST_KEY_DIR, tmp, fd, fd, &ign);
531                 }
532                 key = key->next;
533         }
534         return RESULT_SUCCESS;
535 }
536
537 static char show_key_usage[] =
538 "Usage: show keys\n"
539 "       Displays information about RSA keys known by Asterisk\n";
540
541 static char init_keys_usage[] =
542 "Usage: init keys\n"
543 "       Initializes private keys (by reading in pass code from the user)\n";
544
545 static struct ast_cli_entry cli_show_keys = 
546 { { "show", "keys", NULL }, show_keys, "Displays RSA key information", show_key_usage };
547
548 static struct ast_cli_entry cli_init_keys = 
549 { { "init", "keys", NULL }, init_keys, "Initialize RSA key passcodes", init_keys_usage };
550
551 static int crypto_init(void)
552 {
553         SSL_library_init();
554         ERR_load_crypto_strings();
555         ast_cli_register(&cli_show_keys);
556         ast_cli_register(&cli_init_keys);
557         return 0;
558 }
559
560 int reload(void)
561 {
562         crypto_load(-1, -1);
563         return 0;
564 }
565
566 int load_module(void)
567 {
568         crypto_init();
569         if (option_initcrypto)
570                 crypto_load(STDIN_FILENO, STDOUT_FILENO);
571         else
572                 crypto_load(-1, -1);
573         return 0;
574 }
575
576 int unload_module(void)
577 {
578         /* Can't unload this once we're loaded */
579         return -1;
580 }
581
582 char *description(void)
583 {
584         return "Cryptographic Digital Signatures";
585 }
586
587 int usecount(void)
588 {
589         /* We should never be unloaded */
590         return 1;
591 }
592
593 char *key()
594 {
595         return ASTERISK_GPL_KEY;
596 }