Merge "Prevent unload of modules which implement an Optional API."
[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  * Uses the OpenSSL library, available at
26  *      http://www.openssl.org/
27  */
28
29 /*** MODULEINFO
30         <depend>openssl</depend>
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 #include "asterisk/paths.h"     /* use ast_config_AST_KEY_DIR */
37 #include <openssl/ssl.h>
38 #include <openssl/err.h>
39 #include <openssl/aes.h>
40 #include <dirent.h>
41
42 #include "asterisk/module.h"
43 #include "asterisk/md5.h"
44 #include "asterisk/cli.h"
45 #include "asterisk/io.h"
46 #include "asterisk/lock.h"
47 #include "asterisk/utils.h"
48
49 #define AST_API_MODULE
50 #include "asterisk/crypto.h"
51
52 /*
53  * Asterisk uses RSA keys with SHA-1 message digests for its
54  * digital signatures.  The choice of RSA is due to its higher
55  * throughput on verification, and the choice of SHA-1 based
56  * on the recently discovered collisions in MD5's compression
57  * algorithm and recommendations of avoiding MD5 in new schemes
58  * from various industry experts.
59  *
60  * We use OpenSSL to provide our crypto routines, although we never
61  * actually use full-up SSL
62  *
63  */
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         AST_RWLIST_ENTRY(ast_key) list;
85 };
86
87 static AST_RWLIST_HEAD_STATIC(keys, ast_key);
88
89 /*!
90  * \brief setting of priv key
91  * \param buf
92  * \param size
93  * \param rwflag
94  * \param userdata
95  * \return length of string,-1 on failure
96 */
97 static int pw_cb(char *buf, int size, int rwflag, void *userdata)
98 {
99         struct ast_key *key = (struct ast_key *)userdata;
100         char prompt[256];
101         int tmp;
102         int res;
103
104         if (key->infd < 0) {
105                 /* Note that we were at least called */
106                 key->infd = -2;
107                 return -1;
108         }
109
110         snprintf(prompt, sizeof(prompt), ">>>> passcode for %s key '%s': ",
111                  key->ktype == AST_KEY_PRIVATE ? "PRIVATE" : "PUBLIC", key->name);
112         if (write(key->outfd, prompt, strlen(prompt)) < 0) {
113                 ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
114                 key->infd = -2;
115                 return -1;
116         }
117         tmp = ast_hide_password(key->infd);
118         memset(buf, 0, size);
119         res = read(key->infd, buf, size);
120         if (res == -1) {
121                 ast_log(LOG_WARNING, "read() failed: %s\n", strerror(errno));
122         }
123         ast_restore_tty(key->infd, tmp);
124         if (buf[strlen(buf) -1] == '\n') {
125                 buf[strlen(buf) - 1] = '\0';
126         }
127         return strlen(buf);
128 }
129
130 /*!
131  * \brief return the ast_key structure for name
132  * \see ast_key_get
133 */
134 struct ast_key * AST_OPTIONAL_API_NAME(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         }
145         AST_RWLIST_UNLOCK(&keys);
146
147         return key;
148 }
149
150 /*!
151  * \brief load RSA key from file
152  * \param dir directory string
153  * \param fname name of file
154  * \param ifd incoming file descriptor
155  * \param ofd outgoing file descriptor
156  * \param not2
157  * \retval key on success.
158  * \retval NULL on failure.
159 */
160 static struct ast_key *try_load_key(const char *dir, const char *fname, int ifd, int ofd, int *not2)
161 {
162         int ktype = 0, found = 0;
163         char *c = NULL, ffname[256];
164         unsigned char digest[16];
165         FILE *f;
166         struct MD5Context md5;
167         struct ast_key *key;
168         static int notice = 0;
169
170         /* Make sure its name is a public or private key */
171         if ((c = strstr(fname, ".pub")) && !strcmp(c, ".pub")) {
172                 ktype = AST_KEY_PUBLIC;
173         } else if ((c = strstr(fname, ".key")) && !strcmp(c, ".key")) {
174                 ktype = AST_KEY_PRIVATE;
175         } else {
176                 return NULL;
177         }
178
179         /* Get actual filename */
180         snprintf(ffname, sizeof(ffname), "%s/%s", dir, fname);
181
182         /* Open file */
183         if (!(f = fopen(ffname, "r"))) {
184                 ast_log(LOG_WARNING, "Unable to open key file %s: %s\n", ffname, strerror(errno));
185                 return NULL;
186         }
187
188         MD5Init(&md5);
189         while (!feof(f)) {
190                 /* Calculate a "whatever" quality md5sum of the key */
191                 char buf[256] = "";
192                 if (!fgets(buf, sizeof(buf), f)) {
193                         continue;
194                 }
195                 if (!feof(f)) {
196                         MD5Update(&md5, (unsigned char *) buf, strlen(buf));
197                 }
198         }
199         MD5Final(digest, &md5);
200
201         /* Look for an existing key */
202         AST_RWLIST_TRAVERSE(&keys, key, list) {
203                 if (!strcasecmp(key->fn, ffname)) {
204                         break;
205                 }
206         }
207
208         if (key) {
209                 /* If the MD5 sum is the same, and it isn't awaiting a passcode
210                    then this is far enough */
211                 if (!memcmp(digest, key->digest, 16) &&
212                     !(key->ktype & KEY_NEEDS_PASSCODE)) {
213                         fclose(f);
214                         key->delme = 0;
215                         return NULL;
216                 } else {
217                         /* Preserve keytype */
218                         ktype = key->ktype;
219                         /* Recycle the same structure */
220                         found++;
221                 }
222         }
223
224         /* Make fname just be the normal name now */
225         *c = '\0';
226         if (!key) {
227                 if (!(key = ast_calloc(1, sizeof(*key)))) {
228                         fclose(f);
229                         return NULL;
230                 }
231         }
232         /* First the filename */
233         ast_copy_string(key->fn, ffname, sizeof(key->fn));
234         /* Then the name */
235         ast_copy_string(key->name, fname, sizeof(key->name));
236         key->ktype = ktype;
237         /* Yes, assume we're going to be deleted */
238         key->delme = 1;
239         /* Keep the key type */
240         memcpy(key->digest, digest, 16);
241         /* Can I/O takes the FD we're given */
242         key->infd = ifd;
243         key->outfd = ofd;
244         /* Reset the file back to the beginning */
245         rewind(f);
246         /* Now load the key with the right method */
247         if (ktype == AST_KEY_PUBLIC) {
248                 key->rsa = PEM_read_RSA_PUBKEY(f, NULL, pw_cb, key);
249         } else {
250                 key->rsa = PEM_read_RSAPrivateKey(f, NULL, pw_cb, key);
251         }
252         fclose(f);
253         if (key->rsa) {
254                 if (RSA_size(key->rsa) == 128) {
255                         /* Key loaded okay */
256                         key->ktype &= ~KEY_NEEDS_PASSCODE;
257                         ast_verb(3, "Loaded %s key '%s'\n", key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
258                         ast_debug(1, "Key '%s' loaded OK\n", key->name);
259                         key->delme = 0;
260                 } else {
261                         ast_log(LOG_NOTICE, "Key '%s' is not expected size.\n", key->name);
262                 }
263         } else if (key->infd != -2) {
264                 ast_log(LOG_WARNING, "Key load %s '%s' failed\n",key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
265                 if (ofd > -1) {
266                         ERR_print_errors_fp(stderr);
267                 } else {
268                         ERR_print_errors_fp(stderr);
269                 }
270         } else {
271                 ast_log(LOG_NOTICE, "Key '%s' needs passcode.\n", key->name);
272                 key->ktype |= KEY_NEEDS_PASSCODE;
273                 if (!notice) {
274                         if (!ast_opt_init_keys) {
275                                 ast_log(LOG_NOTICE, "Add the '-i' flag to the asterisk command line if you want to automatically initialize passcodes at launch.\n");
276                         }
277                         notice++;
278                 }
279                 /* Keep it anyway */
280                 key->delme = 0;
281                 /* Print final notice about "keys init" 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
290         return key;
291 }
292
293 /*!
294  * \brief signs outgoing message with public key
295  * \see ast_sign_bin
296 */
297 int AST_OPTIONAL_API_NAME(ast_sign_bin)(struct ast_key *key, const char *msg, int msglen, unsigned char *dsig)
298 {
299         unsigned char digest[20];
300         unsigned int siglen = 128;
301         int res;
302
303         if (key->ktype != AST_KEY_PRIVATE) {
304                 ast_log(LOG_WARNING, "Cannot sign with a public key\n");
305                 return -1;
306         }
307
308         /* Calculate digest of message */
309         SHA1((unsigned char *)msg, msglen, digest);
310
311         /* Verify signature */
312         if (!(res = RSA_sign(NID_sha1, digest, sizeof(digest), dsig, &siglen, key->rsa))) {
313                 ast_log(LOG_WARNING, "RSA Signature (key %s) failed\n", key->name);
314                 return -1;
315         }
316
317         if (siglen != 128) {
318                 ast_log(LOG_WARNING, "Unexpected signature length %d, expecting %d\n", (int)siglen, (int)128);
319                 return -1;
320         }
321
322         return 0;
323 }
324
325 /*!
326  * \brief decrypt a message
327  * \see ast_decrypt_bin
328 */
329 int AST_OPTIONAL_API_NAME(ast_decrypt_bin)(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
330 {
331         int res, pos = 0;
332
333         if (key->ktype != AST_KEY_PRIVATE) {
334                 ast_log(LOG_WARNING, "Cannot decrypt with a public key\n");
335                 return -1;
336         }
337
338         if (srclen % 128) {
339                 ast_log(LOG_NOTICE, "Tried to decrypt something not a multiple of 128 bytes\n");
340                 return -1;
341         }
342
343         while (srclen) {
344                 /* Process chunks 128 bytes at a time */
345                 if ((res = RSA_private_decrypt(128, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING)) < 0) {
346                         return -1;
347                 }
348                 pos += res;
349                 src += 128;
350                 srclen -= 128;
351                 dst += res;
352         }
353
354         return pos;
355 }
356
357 /*!
358  * \brief encrypt a message
359  * \see ast_encrypt_bin
360 */
361 int AST_OPTIONAL_API_NAME(ast_encrypt_bin)(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
362 {
363         int res, bytes, pos = 0;
364
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                 }
375                 /* Process chunks 128-41 bytes at a time */
376                 if ((res = RSA_public_encrypt(bytes, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING)) != 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 /*!
389  * \brief wrapper for __ast_sign_bin then base64 encode it
390  * \see ast_sign
391 */
392 int AST_OPTIONAL_API_NAME(ast_sign)(struct ast_key *key, char *msg, char *sig)
393 {
394         unsigned char dsig[128];
395         int siglen = sizeof(dsig), res;
396
397         if (!(res = ast_sign_bin(key, msg, strlen(msg), dsig))) {
398                 /* Success -- encode (256 bytes max as documented) */
399                 ast_base64encode(sig, dsig, siglen, 256);
400         }
401
402         return res;
403 }
404
405 /*!
406  * \brief check signature of a message
407  * \see ast_check_signature_bin
408 */
409 int AST_OPTIONAL_API_NAME(ast_check_signature_bin)(struct ast_key *key, const char *msg, int msglen, const unsigned char *dsig)
410 {
411         unsigned char digest[20];
412         int res;
413
414         if (key->ktype != AST_KEY_PUBLIC) {
415                 /* Okay, so of course you really *can* but for our purposes
416                    we're going to say you can't */
417                 ast_log(LOG_WARNING, "Cannot check message signature with a private key\n");
418                 return -1;
419         }
420
421         /* Calculate digest of message */
422         SHA1((unsigned char *)msg, msglen, digest);
423
424         /* Verify signature */
425         if (!(res = RSA_verify(NID_sha1, digest, sizeof(digest), (unsigned char *)dsig, 128, key->rsa))) {
426                 ast_debug(1, "Key failed verification: %s\n", key->name);
427                 return -1;
428         }
429
430         /* Pass */
431         return 0;
432 }
433
434 /*!
435  * \brief base64 decode then sent to __ast_check_signature_bin
436  * \see ast_check_signature
437 */
438 int AST_OPTIONAL_API_NAME(ast_check_signature)(struct ast_key *key, const char *msg, const char *sig)
439 {
440         unsigned char dsig[128];
441         int res;
442
443         /* Decode signature */
444         if ((res = ast_base64decode(dsig, sig, sizeof(dsig))) != sizeof(dsig)) {
445                 ast_log(LOG_WARNING, "Signature improper length (expect %d, got %d)\n", (int)sizeof(dsig), (int)res);
446                 return -1;
447         }
448
449         res = ast_check_signature_bin(key, msg, strlen(msg), dsig);
450
451         return res;
452 }
453
454 int AST_OPTIONAL_API_NAME(ast_crypto_loaded)(void)
455 {
456         return 1;
457 }
458
459 int AST_OPTIONAL_API_NAME(ast_aes_set_encrypt_key)(const unsigned char *key, ast_aes_encrypt_key *ctx)
460 {
461         return AES_set_encrypt_key(key, 128, ctx);
462 }
463
464 int AST_OPTIONAL_API_NAME(ast_aes_set_decrypt_key)(const unsigned char *key, ast_aes_decrypt_key *ctx)
465 {
466         return AES_set_decrypt_key(key, 128, ctx);
467 }
468
469 void AST_OPTIONAL_API_NAME(ast_aes_encrypt)(const unsigned char *in, unsigned char *out, const ast_aes_encrypt_key *ctx)
470 {
471         return AES_encrypt(in, out, ctx);
472 }
473
474 void AST_OPTIONAL_API_NAME(ast_aes_decrypt)(const unsigned char *in, unsigned char *out, const ast_aes_decrypt_key *ctx)
475 {
476         return AES_decrypt(in, out, ctx);
477 }
478
479 /*!
480  * \brief refresh RSA keys from file
481  * \param ifd file descriptor
482  * \param ofd file descriptor
483  * \return void
484 */
485 static void crypto_load(int ifd, int ofd)
486 {
487         struct ast_key *key;
488         DIR *dir = NULL;
489         struct dirent *ent;
490         int note = 0;
491
492         AST_RWLIST_WRLOCK(&keys);
493
494         /* Mark all keys for deletion */
495         AST_RWLIST_TRAVERSE(&keys, key, list) {
496                 key->delme = 1;
497         }
498
499         /* Load new keys */
500         if ((dir = opendir(ast_config_AST_KEY_DIR))) {
501                 while ((ent = readdir(dir))) {
502                         try_load_key(ast_config_AST_KEY_DIR, ent->d_name, ifd, ofd, &note);
503                 }
504                 closedir(dir);
505         } else {
506                 ast_log(LOG_WARNING, "Unable to open key directory '%s'\n", ast_config_AST_KEY_DIR);
507         }
508
509         if (note) {
510                 ast_log(LOG_NOTICE, "Please run the command 'keys init' to enter the passcodes for the keys\n");
511         }
512
513         /* Delete any keys that are no longer present */
514         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&keys, key, list) {
515                 if (key->delme) {
516                         ast_debug(1, "Deleting key %s type %d\n", key->name, key->ktype);
517                         AST_RWLIST_REMOVE_CURRENT(list);
518                         if (key->rsa) {
519                                 RSA_free(key->rsa);
520                         }
521                         ast_free(key);
522                 }
523         }
524         AST_RWLIST_TRAVERSE_SAFE_END;
525
526         AST_RWLIST_UNLOCK(&keys);
527 }
528
529 static void md52sum(char *sum, unsigned char *md5)
530 {
531         int x;
532         for (x = 0; x < 16; x++) {
533                 sum += sprintf(sum, "%02hhx", *(md5++));
534         }
535 }
536
537 /*!
538  * \brief show the list of RSA keys
539  * \param e CLI command
540  * \param cmd
541  * \param a list of CLI arguments
542  * \return CLI_SUCCESS
543 */
544 static char *handle_cli_keys_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
545 {
546 #define FORMAT "%-18s %-8s %-16s %-33s\n"
547
548         struct ast_key *key;
549         char sum[16 * 2 + 1];
550         int count_keys = 0;
551
552         switch (cmd) {
553         case CLI_INIT:
554                 e->command = "keys show";
555                 e->usage =
556                         "Usage: keys show\n"
557                         "       Displays information about RSA keys known by Asterisk\n";
558                 return NULL;
559         case CLI_GENERATE:
560                 return NULL;
561         }
562
563         ast_cli(a->fd, FORMAT, "Key Name", "Type", "Status", "Sum");
564         ast_cli(a->fd, FORMAT, "------------------", "--------", "----------------", "--------------------------------");
565
566         AST_RWLIST_RDLOCK(&keys);
567         AST_RWLIST_TRAVERSE(&keys, key, list) {
568                 md52sum(sum, key->digest);
569                 ast_cli(a->fd, FORMAT, key->name,
570                         (key->ktype & 0xf) == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE",
571                         key->ktype & KEY_NEEDS_PASSCODE ? "[Needs Passcode]" : "[Loaded]", sum);
572                 count_keys++;
573         }
574         AST_RWLIST_UNLOCK(&keys);
575
576         ast_cli(a->fd, "\n%d known RSA keys.\n", count_keys);
577
578         return CLI_SUCCESS;
579
580 #undef FORMAT
581 }
582
583 /*!
584  * \brief initialize all RSA keys
585  * \param e CLI command
586  * \param cmd
587  * \param a list of CLI arguments
588  * \return CLI_SUCCESS
589 */
590 static char *handle_cli_keys_init(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
591 {
592         struct ast_key *key;
593         int ign;
594         char *kn, tmp[256] = "";
595
596         switch (cmd) {
597         case CLI_INIT:
598                 e->command = "keys init";
599                 e->usage =
600                         "Usage: keys init\n"
601                         "       Initializes private keys (by reading in pass code from\n"
602                         "       the user)\n";
603                 return NULL;
604         case CLI_GENERATE:
605                 return NULL;
606         }
607
608         if (a->argc != 2) {
609                 return CLI_SHOWUSAGE;
610         }
611
612         AST_RWLIST_WRLOCK(&keys);
613         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&keys, key, list) {
614                 /* Reload keys that need pass codes now */
615                 if (key->ktype & KEY_NEEDS_PASSCODE) {
616                         kn = key->fn + strlen(ast_config_AST_KEY_DIR) + 1;
617                         ast_copy_string(tmp, kn, sizeof(tmp));
618                         try_load_key(ast_config_AST_KEY_DIR, tmp, a->fd, a->fd, &ign);
619                 }
620         }
621         AST_RWLIST_TRAVERSE_SAFE_END
622         AST_RWLIST_UNLOCK(&keys);
623
624         return CLI_SUCCESS;
625 }
626
627 static struct ast_cli_entry cli_crypto[] = {
628         AST_CLI_DEFINE(handle_cli_keys_show, "Displays RSA key information"),
629         AST_CLI_DEFINE(handle_cli_keys_init, "Initialize RSA key passcodes")
630 };
631
632 /*! \brief initialise the res_crypto module */
633 static int crypto_init(void)
634 {
635         ast_cli_register_multiple(cli_crypto, ARRAY_LEN(cli_crypto));
636         return 0;
637 }
638
639 static int reload(void)
640 {
641         crypto_load(-1, -1);
642         return 0;
643 }
644
645 static int load_module(void)
646 {
647         crypto_init();
648         if (ast_opt_init_keys) {
649                 crypto_load(STDIN_FILENO, STDOUT_FILENO);
650         } else {
651                 crypto_load(-1, -1);
652         }
653
654         /* This prevents dlclose from ever running, but allows CLI cleanup at shutdown. */
655         ast_module_shutdown_ref(ast_module_info->self);
656         return AST_MODULE_LOAD_SUCCESS;
657 }
658
659 static int unload_module(void)
660 {
661         ast_cli_unregister_multiple(cli_crypto, ARRAY_LEN(cli_crypto));
662
663         return 0;
664 }
665
666 /* needs usecount semantics defined */
667 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Cryptographic Digital Signatures",
668         .support_level = AST_MODULE_SUPPORT_CORE,
669         .load = load_module,
670         .unload = unload_module,
671         .reload = reload,
672         .load_pri = AST_MODPRI_CHANNEL_DEPEND, /*!< Since we don't have a config file, we could move up to REALTIME_DEPEND, if necessary */
673 );