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