Merge "res_pjsip/res_pjsip_callerid: NULL check on caller id name string"
[asterisk/asterisk.git] / res / res_crypto.c
index 65c5b76..8f97ce9 100644 (file)
  *
  * \brief Provide Cryptographic Signature capability
  *
- * \author Mark Spencer <markster@digium.com> 
+ * \author Mark Spencer <markster@digium.com>
  *
- * \extref Uses the OpenSSL library, available at
+ * Uses the OpenSSL library, available at
  *     http://www.openssl.org/
  */
 
 /*** MODULEINFO
-       <depend>ssl</depend>
+       <depend>openssl</depend>
+       <support_level>core</support_level>
  ***/
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
-#include <sys/types.h>
+#include "asterisk/paths.h"    /* use ast_config_AST_KEY_DIR */
 #include <openssl/ssl.h>
 #include <openssl/err.h>
-#include <stdio.h>
+#include <openssl/aes.h>
 #include <dirent.h>
-#include <string.h>
-#include <errno.h>
-#include <unistd.h>
-#include <fcntl.h>
-
-#include "asterisk/file.h"
-#include "asterisk/channel.h"
-#include "asterisk/logger.h"
-#include "asterisk/say.h"
+
 #include "asterisk/module.h"
-#include "asterisk/options.h"
-#include "asterisk/crypto.h"
 #include "asterisk/md5.h"
 #include "asterisk/cli.h"
 #include "asterisk/io.h"
 #include "asterisk/lock.h"
 #include "asterisk/utils.h"
 
+#define AST_API_MODULE
+#include "asterisk/crypto.h"
+
 /*
  * Asterisk uses RSA keys with SHA-1 message digests for its
  * digital signatures.  The choice of RSA is due to its higher
  * throughput on verification, and the choice of SHA-1 based
- * on the recently discovered collisions in MD5's compression 
+ * on the recently discovered collisions in MD5's compression
  * algorithm and recommendations of avoiding MD5 in new schemes
  * from various industry experts.
  *
@@ -106,24 +98,32 @@ static int pw_cb(char *buf, int size, int rwflag, void *userdata)
 {
        struct ast_key *key = (struct ast_key *)userdata;
        char prompt[256];
-       int res, tmp;
+       int tmp;
+       int res;
 
        if (key->infd < 0) {
                /* Note that we were at least called */
                key->infd = -2;
                return -1;
        }
-       
+
        snprintf(prompt, sizeof(prompt), ">>>> passcode for %s key '%s': ",
                 key->ktype == AST_KEY_PRIVATE ? "PRIVATE" : "PUBLIC", key->name);
-       write(key->outfd, prompt, strlen(prompt));
-       memset(buf, 0, sizeof(buf));
+       if (write(key->outfd, prompt, strlen(prompt)) < 0) {
+               ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
+               key->infd = -2;
+               return -1;
+       }
        tmp = ast_hide_password(key->infd);
        memset(buf, 0, size);
        res = read(key->infd, buf, size);
+       if (res == -1) {
+               ast_log(LOG_WARNING, "read() failed: %s\n", strerror(errno));
+       }
        ast_restore_tty(key->infd, tmp);
-       if (buf[strlen(buf) -1] == '\n')
+       if (buf[strlen(buf) -1] == '\n') {
                buf[strlen(buf) - 1] = '\0';
+       }
        return strlen(buf);
 }
 
@@ -131,15 +131,16 @@ static int pw_cb(char *buf, int size, int rwflag, void *userdata)
  * \brief return the ast_key structure for name
  * \see ast_key_get
 */
-static struct ast_key *__ast_key_get(const char *kname, int ktype)
+struct ast_key * AST_OPTIONAL_API_NAME(ast_key_get)(const char *kname, int ktype)
 {
        struct ast_key *key;
 
        AST_RWLIST_RDLOCK(&keys);
        AST_RWLIST_TRAVERSE(&keys, key, list) {
                if (!strcmp(kname, key->name) &&
-                   (ktype == key->ktype))
+                   (ktype == key->ktype)) {
                        break;
+               }
        }
        AST_RWLIST_UNLOCK(&keys);
 
@@ -156,7 +157,7 @@ static struct ast_key *__ast_key_get(const char *kname, int ktype)
  * \retval key on success.
  * \retval NULL on failure.
 */
-static struct ast_key *try_load_key(char *dir, char *fname, int ifd, int ofd, int *not2)
+static struct ast_key *try_load_key(const char *dir, const char *fname, int ifd, int ofd, int *not2)
 {
        int ktype = 0, found = 0;
        char *c = NULL, ffname[256];
@@ -167,12 +168,13 @@ static struct ast_key *try_load_key(char *dir, char *fname, int ifd, int ofd, in
        static int notice = 0;
 
        /* Make sure its name is a public or private key */
-       if ((c = strstr(fname, ".pub")) && !strcmp(c, ".pub"))
+       if ((c = strstr(fname, ".pub")) && !strcmp(c, ".pub")) {
                ktype = AST_KEY_PUBLIC;
-       else if ((c = strstr(fname, ".key")) && !strcmp(c, ".key"))
+       } else if ((c = strstr(fname, ".key")) && !strcmp(c, ".key")) {
                ktype = AST_KEY_PRIVATE;
-       else
+       } else {
                return NULL;
+       }
 
        /* Get actual filename */
        snprintf(ffname, sizeof(ffname), "%s/%s", dir, fname);
@@ -184,23 +186,27 @@ static struct ast_key *try_load_key(char *dir, char *fname, int ifd, int ofd, in
        }
 
        MD5Init(&md5);
-       while(!feof(f)) {
+       while (!feof(f)) {
                /* Calculate a "whatever" quality md5sum of the key */
                char buf[256] = "";
-               fgets(buf, sizeof(buf), f);
-               if (!feof(f))
+               if (!fgets(buf, sizeof(buf), f)) {
+                       continue;
+               }
+               if (!feof(f)) {
                        MD5Update(&md5, (unsigned char *) buf, strlen(buf));
+               }
        }
        MD5Final(digest, &md5);
 
        /* Look for an existing key */
        AST_RWLIST_TRAVERSE(&keys, key, list) {
-               if (!strcasecmp(key->fn, ffname))
+               if (!strcasecmp(key->fn, ffname)) {
                        break;
+               }
        }
 
        if (key) {
-               /* If the MD5 sum is the same, and it isn't awaiting a passcode 
+               /* If the MD5 sum is the same, and it isn't awaiting a passcode
                   then this is far enough */
                if (!memcmp(digest, key->digest, 16) &&
                    !(key->ktype & KEY_NEEDS_PASSCODE)) {
@@ -238,10 +244,11 @@ static struct ast_key *try_load_key(char *dir, char *fname, int ifd, int ofd, in
        /* Reset the file back to the beginning */
        rewind(f);
        /* Now load the key with the right method */
-       if (ktype == AST_KEY_PUBLIC)
+       if (ktype == AST_KEY_PUBLIC) {
                key->rsa = PEM_read_RSA_PUBKEY(f, NULL, pw_cb, key);
-       else
+       } else {
                key->rsa = PEM_read_RSAPrivateKey(f, NULL, pw_cb, key);
+       }
        fclose(f);
        if (key->rsa) {
                if (RSA_size(key->rsa) == 128) {
@@ -250,31 +257,35 @@ static struct ast_key *try_load_key(char *dir, char *fname, int ifd, int ofd, in
                        ast_verb(3, "Loaded %s key '%s'\n", key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
                        ast_debug(1, "Key '%s' loaded OK\n", key->name);
                        key->delme = 0;
-               } else
+               } else {
                        ast_log(LOG_NOTICE, "Key '%s' is not expected size.\n", key->name);
+               }
        } else if (key->infd != -2) {
                ast_log(LOG_WARNING, "Key load %s '%s' failed\n",key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
-               if (ofd > -1)
+               if (ofd > -1) {
                        ERR_print_errors_fp(stderr);
-               else
+               } else {
                        ERR_print_errors_fp(stderr);
+               }
        } else {
                ast_log(LOG_NOTICE, "Key '%s' needs passcode.\n", key->name);
                key->ktype |= KEY_NEEDS_PASSCODE;
                if (!notice) {
-                       if (!ast_opt_init_keys) 
+                       if (!ast_opt_init_keys) {
                                ast_log(LOG_NOTICE, "Add the '-i' flag to the asterisk command line if you want to automatically initialize passcodes at launch.\n");
+                       }
                        notice++;
                }
                /* Keep it anyway */
                key->delme = 0;
-               /* Print final notice about "init keys" when done */
+               /* Print final notice about "keys init" when done */
                *not2 = 1;
        }
 
        /* If this is a new key add it to the list */
-       if (!found)
+       if (!found) {
                AST_RWLIST_INSERT_TAIL(&keys, key, list);
+       }
 
        return key;
 }
@@ -283,7 +294,7 @@ static struct ast_key *try_load_key(char *dir, char *fname, int ifd, int ofd, in
  * \brief signs outgoing message with public key
  * \see ast_sign_bin
 */
-static int __ast_sign_bin(struct ast_key *key, const char *msg, int msglen, unsigned char *dsig)
+int AST_OPTIONAL_API_NAME(ast_sign_bin)(struct ast_key *key, const char *msg, int msglen, unsigned char *dsig)
 {
        unsigned char digest[20];
        unsigned int siglen = 128;
@@ -309,14 +320,13 @@ static int __ast_sign_bin(struct ast_key *key, const char *msg, int msglen, unsi
        }
 
        return 0;
-       
 }
 
 /*!
  * \brief decrypt a message
  * \see ast_decrypt_bin
 */
-static int __ast_decrypt_bin(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
+int AST_OPTIONAL_API_NAME(ast_decrypt_bin)(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
 {
        int res, pos = 0;
 
@@ -330,10 +340,11 @@ static int __ast_decrypt_bin(unsigned char *dst, const unsigned char *src, int s
                return -1;
        }
 
-       while(srclen) {
+       while (srclen) {
                /* Process chunks 128 bytes at a time */
-               if ((res = RSA_private_decrypt(128, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING)) < 0)
+               if ((res = RSA_private_decrypt(128, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING)) < 0) {
                        return -1;
+               }
                pos += res;
                src += 128;
                srclen -= 128;
@@ -347,7 +358,7 @@ static int __ast_decrypt_bin(unsigned char *dst, const unsigned char *src, int s
  * \brief encrypt a message
  * \see ast_encrypt_bin
 */
-static int __ast_encrypt_bin(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
+int AST_OPTIONAL_API_NAME(ast_encrypt_bin)(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
 {
        int res, bytes, pos = 0;
 
@@ -355,11 +366,12 @@ static int __ast_encrypt_bin(unsigned char *dst, const unsigned char *src, int s
                ast_log(LOG_WARNING, "Cannot encrypt with a private key\n");
                return -1;
        }
-       
-       while(srclen) {
+
+       while (srclen) {
                bytes = srclen;
-               if (bytes > 128 - 41)
+               if (bytes > 128 - 41) {
                        bytes = 128 - 41;
+               }
                /* Process chunks 128-41 bytes at a time */
                if ((res = RSA_public_encrypt(bytes, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING)) != 128) {
                        ast_log(LOG_NOTICE, "How odd, encrypted size is %d\n", res);
@@ -377,14 +389,15 @@ static int __ast_encrypt_bin(unsigned char *dst, const unsigned char *src, int s
  * \brief wrapper for __ast_sign_bin then base64 encode it
  * \see ast_sign
 */
-static int __ast_sign(struct ast_key *key, char *msg, char *sig)
+int AST_OPTIONAL_API_NAME(ast_sign)(struct ast_key *key, char *msg, char *sig)
 {
        unsigned char dsig[128];
        int siglen = sizeof(dsig), res;
 
-       if (!(res = ast_sign_bin(key, msg, strlen(msg), dsig)))
+       if (!(res = ast_sign_bin(key, msg, strlen(msg), dsig))) {
                /* Success -- encode (256 bytes max as documented) */
                ast_base64encode(sig, dsig, siglen, 256);
+       }
 
        return res;
 }
@@ -393,7 +406,7 @@ static int __ast_sign(struct ast_key *key, char *msg, char *sig)
  * \brief check signature of a message
  * \see ast_check_signature_bin
 */
-static int __ast_check_signature_bin(struct ast_key *key, const char *msg, int msglen, const unsigned char *dsig)
+int AST_OPTIONAL_API_NAME(ast_check_signature_bin)(struct ast_key *key, const char *msg, int msglen, const unsigned char *dsig)
 {
        unsigned char digest[20];
        int res;
@@ -422,7 +435,7 @@ static int __ast_check_signature_bin(struct ast_key *key, const char *msg, int m
  * \brief base64 decode then sent to __ast_check_signature_bin
  * \see ast_check_signature
 */
-static int __ast_check_signature(struct ast_key *key, const char *msg, const char *sig)
+int AST_OPTIONAL_API_NAME(ast_check_signature)(struct ast_key *key, const char *msg, const char *sig)
 {
        unsigned char dsig[128];
        int res;
@@ -438,6 +451,31 @@ static int __ast_check_signature(struct ast_key *key, const char *msg, const cha
        return res;
 }
 
+int AST_OPTIONAL_API_NAME(ast_crypto_loaded)(void)
+{
+       return 1;
+}
+
+int AST_OPTIONAL_API_NAME(ast_aes_set_encrypt_key)(const unsigned char *key, ast_aes_encrypt_key *ctx)
+{
+       return AES_set_encrypt_key(key, 128, ctx);
+}
+
+int AST_OPTIONAL_API_NAME(ast_aes_set_decrypt_key)(const unsigned char *key, ast_aes_decrypt_key *ctx)
+{
+       return AES_set_decrypt_key(key, 128, ctx);
+}
+
+void AST_OPTIONAL_API_NAME(ast_aes_encrypt)(const unsigned char *in, unsigned char *out, const ast_aes_encrypt_key *ctx)
+{
+       return AES_encrypt(in, out, ctx);
+}
+
+void AST_OPTIONAL_API_NAME(ast_aes_decrypt)(const unsigned char *in, unsigned char *out, const ast_aes_decrypt_key *ctx)
+{
+       return AES_decrypt(in, out, ctx);
+}
+
 /*!
  * \brief refresh RSA keys from file
  * \param ifd file descriptor
@@ -459,28 +497,31 @@ static void crypto_load(int ifd, int ofd)
        }
 
        /* Load new keys */
-       if ((dir = opendir((char *)ast_config_AST_KEY_DIR))) {
-               while((ent = readdir(dir))) {
-                       try_load_key((char *)ast_config_AST_KEY_DIR, ent->d_name, ifd, ofd, &note);
+       if ((dir = opendir(ast_config_AST_KEY_DIR))) {
+               while ((ent = readdir(dir))) {
+                       try_load_key(ast_config_AST_KEY_DIR, ent->d_name, ifd, ofd, &note);
                }
                closedir(dir);
-       } else
-               ast_log(LOG_WARNING, "Unable to open key directory '%s'\n", (char *)ast_config_AST_KEY_DIR);
+       } else {
+               ast_log(LOG_WARNING, "Unable to open key directory '%s'\n", ast_config_AST_KEY_DIR);
+       }
 
-       if (note)
-               ast_log(LOG_NOTICE, "Please run the command 'init keys' to enter the passcodes for the keys\n");
+       if (note) {
+               ast_log(LOG_NOTICE, "Please run the command 'keys init' to enter the passcodes for the keys\n");
+       }
 
        /* Delete any keys that are no longer present */
        AST_RWLIST_TRAVERSE_SAFE_BEGIN(&keys, key, list) {
                if (key->delme) {
                        ast_debug(1, "Deleting key %s type %d\n", key->name, key->ktype);
-                       AST_RWLIST_REMOVE_CURRENT(&keys, list);
-                       if (key->rsa)
+                       AST_RWLIST_REMOVE_CURRENT(list);
+                       if (key->rsa) {
                                RSA_free(key->rsa);
+                       }
                        ast_free(key);
                }
        }
-       AST_RWLIST_TRAVERSE_SAFE_END
+       AST_RWLIST_TRAVERSE_SAFE_END;
 
        AST_RWLIST_UNLOCK(&keys);
 }
@@ -488,101 +529,110 @@ static void crypto_load(int ifd, int ofd)
 static void md52sum(char *sum, unsigned char *md5)
 {
        int x;
-       for (x = 0; x < 16; x++) 
-               sum += sprintf(sum, "%02x", *(md5++));
+       for (x = 0; x < 16; x++) {
+               sum += sprintf(sum, "%02hhx", *(md5++));
+       }
 }
 
-/*! 
- * \brief show the list of RSA keys 
- * \param fd file descriptor
- * \param argc no of arguements
- * \param argv list of arguements
- * \return RESULT_SUCCESS
+/*!
+ * \brief show the list of RSA keys
+ * \param e CLI command
+ * \param cmd
+ * \param a list of CLI arguments
+ * \return CLI_SUCCESS
 */
-static int show_keys(int fd, int argc, char *argv[])
+static char *handle_cli_keys_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
+#define FORMAT "%-18s %-8s %-16s %-33s\n"
+
        struct ast_key *key;
        char sum[16 * 2 + 1];
        int count_keys = 0;
 
-       ast_cli(fd, "%-18s %-8s %-16s %-33s\n", "Key Name", "Type", "Status", "Sum");
+       switch (cmd) {
+       case CLI_INIT:
+               e->command = "keys show";
+               e->usage =
+                       "Usage: keys show\n"
+                       "       Displays information about RSA keys known by Asterisk\n";
+               return NULL;
+       case CLI_GENERATE:
+               return NULL;
+       }
+
+       ast_cli(a->fd, FORMAT, "Key Name", "Type", "Status", "Sum");
+       ast_cli(a->fd, FORMAT, "------------------", "--------", "----------------", "--------------------------------");
 
        AST_RWLIST_RDLOCK(&keys);
        AST_RWLIST_TRAVERSE(&keys, key, list) {
                md52sum(sum, key->digest);
-               ast_cli(fd, "%-18s %-8s %-16s %-33s\n", key->name, 
+               ast_cli(a->fd, FORMAT, key->name,
                        (key->ktype & 0xf) == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE",
                        key->ktype & KEY_NEEDS_PASSCODE ? "[Needs Passcode]" : "[Loaded]", sum);
                count_keys++;
        }
        AST_RWLIST_UNLOCK(&keys);
 
-       ast_cli(fd, "%d known RSA keys.\n", count_keys);
+       ast_cli(a->fd, "\n%d known RSA keys.\n", count_keys);
+
+       return CLI_SUCCESS;
 
-       return RESULT_SUCCESS;
+#undef FORMAT
 }
 
-/*! 
- * \brief initialize all RSA keys  
- * \param fd file descriptor
- * \param argc no of arguements
- * \param argv list of arguements
- * \return RESULT_SUCCESS
+/*!
+ * \brief initialize all RSA keys
+ * \param e CLI command
+ * \param cmd
+ * \param a list of CLI arguments
+ * \return CLI_SUCCESS
 */
-static int init_keys(int fd, int argc, char *argv[])
+static char *handle_cli_keys_init(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
        struct ast_key *key;
        int ign;
        char *kn, tmp[256] = "";
 
+       switch (cmd) {
+       case CLI_INIT:
+               e->command = "keys init";
+               e->usage =
+                       "Usage: keys init\n"
+                       "       Initializes private keys (by reading in pass code from\n"
+                       "       the user)\n";
+               return NULL;
+       case CLI_GENERATE:
+               return NULL;
+       }
+
+       if (a->argc != 2) {
+               return CLI_SHOWUSAGE;
+       }
+
        AST_RWLIST_WRLOCK(&keys);
        AST_RWLIST_TRAVERSE_SAFE_BEGIN(&keys, key, list) {
                /* Reload keys that need pass codes now */
                if (key->ktype & KEY_NEEDS_PASSCODE) {
                        kn = key->fn + strlen(ast_config_AST_KEY_DIR) + 1;
                        ast_copy_string(tmp, kn, sizeof(tmp));
-                       try_load_key((char *)ast_config_AST_KEY_DIR, tmp, fd, fd, &ign);
+                       try_load_key(ast_config_AST_KEY_DIR, tmp, a->fd, a->fd, &ign);
                }
        }
        AST_RWLIST_TRAVERSE_SAFE_END
        AST_RWLIST_UNLOCK(&keys);
 
-       return RESULT_SUCCESS;
+       return CLI_SUCCESS;
 }
 
-static const char show_key_usage[] =
-"Usage: keys show\n"
-"       Displays information about RSA keys known by Asterisk\n";
-
-static const char init_keys_usage[] =
-"Usage: keys init\n"
-"       Initializes private keys (by reading in pass code from the user)\n";
-
 static struct ast_cli_entry cli_crypto[] = {
-       { { "keys", "show", NULL },
-       show_keys, "Displays RSA key information",
-       show_key_usage },
-
-       { { "keys", "init", NULL },
-       init_keys, "Initialize RSA key passcodes",
-       init_keys_usage },
+       AST_CLI_DEFINE(handle_cli_keys_show, "Displays RSA key information"),
+       AST_CLI_DEFINE(handle_cli_keys_init, "Initialize RSA key passcodes")
 };
 
 /*! \brief initialise the res_crypto module */
 static int crypto_init(void)
 {
-       SSL_library_init();
-       ERR_load_crypto_strings();
-       ast_cli_register_multiple(cli_crypto, sizeof(cli_crypto) / sizeof(struct ast_cli_entry));
-
-       /* Install ourselves into stubs */
-       ast_key_get = __ast_key_get;
-       ast_check_signature = __ast_check_signature;
-       ast_check_signature_bin = __ast_check_signature_bin;
-       ast_sign = __ast_sign;
-       ast_sign_bin = __ast_sign_bin;
-       ast_encrypt_bin = __ast_encrypt_bin;
-       ast_decrypt_bin = __ast_decrypt_bin;
+       ast_cli_register_multiple(cli_crypto, ARRAY_LEN(cli_crypto));
        return 0;
 }
 
@@ -595,22 +645,29 @@ static int reload(void)
 static int load_module(void)
 {
        crypto_init();
-       if (ast_opt_init_keys)
+       if (ast_opt_init_keys) {
                crypto_load(STDIN_FILENO, STDOUT_FILENO);
-       else
+       } else {
                crypto_load(-1, -1);
-       return 0;
+       }
+
+       /* This prevents dlclose from ever running, but allows CLI cleanup at shutdown. */
+       ast_module_shutdown_ref(ast_module_info->self);
+       return AST_MODULE_LOAD_SUCCESS;
 }
 
 static int unload_module(void)
 {
-       /* Can't unload this once we're loaded */
-       return -1;
+       ast_cli_unregister_multiple(cli_crypto, ARRAY_LEN(cli_crypto));
+
+       return 0;
 }
 
 /* needs usecount semantics defined */
-AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Cryptographic Digital Signatures",
-               .load = load_module,
-               .unload = unload_module,
-               .reload = reload
-       );
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Cryptographic Digital Signatures",
+       .support_level = AST_MODULE_SUPPORT_CORE,
+       .load = load_module,
+       .unload = unload_module,
+       .reload = reload,
+       .load_pri = AST_MODPRI_CHANNEL_DEPEND, /*!< Since we don't have a config file, we could move up to REALTIME_DEPEND, if necessary */
+);