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