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