Fix up the AGI doc dump CLI command and update the AGI commands tex file to not
[asterisk/asterisk.git] / res / res_crypto.c
old mode 100755 (executable)
new mode 100644 (file)
index 205a8c5..73a54ba
@@ -1,29 +1,40 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Provide Cryptographic Signature capability
- * 
- * Copyright (C) 1999, Mark Spencer
+ * Copyright (C) 1999 - 2006, Digium, Inc.
  *
- * Mark Spencer <markster@linux-support.net>
+ * Mark Spencer <markster@digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
  *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Provide Cryptographic Signature capability
+ *
+ * \author Mark Spencer <markster@digium.com> 
+ *
+ * \extref Uses the OpenSSL library, available at
+ *     http://www.openssl.org/
  */
 
+/*** MODULEINFO
+       <depend>ssl</depend>
+ ***/
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include <sys/types.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>
 #include <openssl/ssl.h>
 #include <openssl/err.h>
 #include <stdio.h>
 #include <errno.h>
 #include <unistd.h>
 #include <fcntl.h>
-#include "../asterisk.h"
-#include "../astconf.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"
 
 /*
  * Asterisk uses RSA keys with SHA-1 message digests for its
@@ -115,7 +137,7 @@ static int pw_cb(char *buf, int size, int rwflag, void *userdata)
        return -1;
 }
 
-struct ast_key *ast_key_get(char *kname, int ktype)
+static struct ast_key *__ast_key_get(const char *kname, int ktype)
 {
        struct ast_key *key;
        ast_mutex_lock(&keylock);
@@ -135,7 +157,7 @@ static struct ast_key *try_load_key (char *dir, char *fname, int ifd, int ofd, i
        int ktype = 0;
        char *c = NULL;
        char ffname[256];
-       char digest[16];
+       unsigned char digest[16];
        FILE *f;
        struct MD5Context md5;
        struct ast_key *key;
@@ -174,9 +196,10 @@ static struct ast_key *try_load_key (char *dir, char *fname, int ifd, int ofd, i
        while(!feof(f)) {
                /* Calculate a "whatever" quality md5sum of the key */
                char buf[256];
+               memset(buf, 0, 256);
                fgets(buf, sizeof(buf), f);
                if (!feof(f)) {
-                       MD5Update(&md5, buf, strlen(buf));
+                       MD5Update(&md5, (unsigned char *) buf, strlen(buf));
                }
        }
        MD5Final(digest, &md5);
@@ -199,13 +222,10 @@ static struct ast_key *try_load_key (char *dir, char *fname, int ifd, int ofd, i
        /* Make fname just be the normal name now */
        *c = '\0';
        if (!key) {
-               key = (struct ast_key *)malloc(sizeof(struct ast_key));
-               if (!key) {
-                       ast_log(LOG_WARNING, "Out of memory\n");
+               if (!(key = ast_calloc(1, sizeof(*key)))) {
                        fclose(f);
                        return NULL;
                }
-               memset(key, 0, sizeof(struct ast_key));
        }
        /* At this point we have a key structure (old or new).  Time to
           fill it with what we know */
@@ -213,9 +233,9 @@ static struct ast_key *try_load_key (char *dir, char *fname, int ifd, int ofd, i
        if (found)
                ast_mutex_lock(&keylock);
        /* First the filename */
-       strncpy(key->fn, ffname, sizeof(key->fn) - 1);
+       ast_copy_string(key->fn, ffname, sizeof(key->fn));
        /* Then the name */
-       strncpy(key->name, fname, sizeof(key->name) - 1);
+       ast_copy_string(key->name, fname, sizeof(key->name));
        key->ktype = ktype;
        /* Yes, assume we're going to be deleted */
        key->delme = 1;
@@ -233,13 +253,15 @@ static struct ast_key *try_load_key (char *dir, char *fname, int ifd, int ofd, i
                key->rsa = PEM_read_RSAPrivateKey(f, NULL, pw_cb, key);
        fclose(f);
        if (key->rsa) {
-               /* Key loaded okay */
-               key->ktype &= ~KEY_NEEDS_PASSCODE;
-               if (option_verbose > 2)
-                       ast_verbose(VERBOSE_PREFIX_3 "Loaded %s key '%s'\n", key->ktype == AST_KEY_PUBLIC ? "PUBLIC" : "PRIVATE", key->name);
-               if (option_debug)
-                       ast_log(LOG_DEBUG, "Key '%s' loaded OK\n", key->name);
-               key->delme = 0;
+               if (RSA_size(key->rsa) == 128) {
+                       /* Key loaded okay */
+                       key->ktype &= ~KEY_NEEDS_PASSCODE;
+                       if (option_verbose > 2)
+                               ast_verbose(VERBOSE_PREFIX_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
+                       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) {
@@ -250,7 +272,7 @@ static struct ast_key *try_load_key (char *dir, char *fname, int ifd, int ofd, i
                ast_log(LOG_NOTICE, "Key '%s' needs passcode.\n", key->name);
                key->ktype |= KEY_NEEDS_PASSCODE;
                if (!notice) {
-                       if (!option_initcrypto) 
+                       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++;
                }
@@ -296,14 +318,14 @@ static char *binary(int y, int len)
 
 #endif
 
-int ast_sign_bin(struct ast_key *key, char *msg, int msglen, unsigned char *dsig)
+static int __ast_sign_bin(struct ast_key *key, const char *msg, int msglen, unsigned char *dsig)
 {
        unsigned char digest[20];
-       int siglen = sizeof(dsig);
+       unsigned int siglen = 128;
        int res;
 
        if (key->ktype != AST_KEY_PRIVATE) {
-               ast_log(LOG_WARNING, "Cannot sign with a private key\n");
+               ast_log(LOG_WARNING, "Cannot sign with a public key\n");
                return -1;
        }
 
@@ -318,8 +340,8 @@ int ast_sign_bin(struct ast_key *key, char *msg, int msglen, unsigned char *dsig
                return -1;
        }
 
-       if (siglen != sizeof(dsig)) {
-               ast_log(LOG_WARNING, "Unexpected signature length %d, expecting %d\n", (int)siglen, (int)sizeof(dsig));
+       if (siglen != 128) {
+               ast_log(LOG_WARNING, "Unexpected signature length %d, expecting %d\n", (int)siglen, (int)128);
                return -1;
        }
 
@@ -327,7 +349,61 @@ int ast_sign_bin(struct ast_key *key, char *msg, int msglen, unsigned char *dsig
        
 }
 
-int ast_sign(struct ast_key *key, char *msg, char *sig)
+static int __ast_decrypt_bin(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
+{
+       int res;
+       int pos = 0;
+       if (key->ktype != AST_KEY_PRIVATE) {
+               ast_log(LOG_WARNING, "Cannot decrypt with a public key\n");
+               return -1;
+       }
+
+       if (srclen % 128) {
+               ast_log(LOG_NOTICE, "Tried to decrypt something not a multiple of 128 bytes\n");
+               return -1;
+       }
+       while(srclen) {
+               /* Process chunks 128 bytes at a time */
+               res = RSA_private_decrypt(128, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING);
+               if (res < 0)
+                       return -1;
+               pos += res;
+               src += 128;
+               srclen -= 128;
+               dst += res;
+       }
+       return pos;
+}
+
+static int __ast_encrypt_bin(unsigned char *dst, const unsigned char *src, int srclen, struct ast_key *key)
+{
+       int res;
+       int bytes;
+       int pos = 0;
+       if (key->ktype != AST_KEY_PUBLIC) {
+               ast_log(LOG_WARNING, "Cannot encrypt with a private key\n");
+               return -1;
+       }
+       
+       while(srclen) {
+               bytes = srclen;
+               if (bytes > 128 - 41)
+                       bytes = 128 - 41;
+               /* Process chunks 128-41 bytes at a time */
+               res = RSA_public_encrypt(bytes, src, dst, key->rsa, RSA_PKCS1_OAEP_PADDING);
+               if (res != 128) {
+                       ast_log(LOG_NOTICE, "How odd, encrypted size is %d\n", res);
+                       return -1;
+               }
+               src += bytes;
+               srclen -= bytes;
+               pos += res;
+               dst += res;
+       }
+       return pos;
+}
+
+static int __ast_sign(struct ast_key *key, char *msg, char *sig)
 {
        unsigned char dsig[128];
        int siglen = sizeof(dsig);
@@ -340,7 +416,7 @@ int ast_sign(struct ast_key *key, char *msg, char *sig)
        
 }
 
-int ast_check_signature_bin(struct ast_key *key, char *msg, int msglen, unsigned char *dsig)
+static int __ast_check_signature_bin(struct ast_key *key, const char *msg, int msglen, const unsigned char *dsig)
 {
        unsigned char digest[20];
        int res;
@@ -356,17 +432,17 @@ int ast_check_signature_bin(struct ast_key *key, char *msg, int msglen, unsigned
        SHA1((unsigned char *)msg, msglen, digest);
 
        /* Verify signature */
-       res = RSA_verify(NID_sha1, digest, sizeof(digest), dsig, sizeof(dsig), key->rsa);
+       res = RSA_verify(NID_sha1, digest, sizeof(digest), (unsigned char *)dsig, 128, key->rsa);
        
        if (!res) {
-               ast_log(LOG_DEBUG, "Key failed verification\n");
+               ast_debug(1, "Key failed verification: %s\n", key->name);
                return -1;
        }
        /* Pass */
        return 0;
 }
 
-int ast_check_signature(struct ast_key *key, char *msg, char *sig)
+static int __ast_check_signature(struct ast_key *key, const char *msg, const char *sig)
 {
        unsigned char dsig[128];
        int res;
@@ -384,7 +460,7 @@ int ast_check_signature(struct ast_key *key, char *msg, char *sig)
 static void crypto_load(int ifd, int ofd)
 {
        struct ast_key *key, *nkey, *last;
-       DIR *dir;
+       DIR *dir = NULL;
        struct dirent *ent;
        int note = 0;
        /* Mark all keys for deletion */
@@ -413,7 +489,7 @@ static void crypto_load(int ifd, int ofd)
        while(key) {
                nkey = key->next;
                if (key->delme) {
-                       ast_log(LOG_DEBUG, "Deleting key %s type %d\n", key->name, key->ktype);
+                       ast_debug(1, "Deleting key %s type %d\n", key->name, key->ktype);
                        /* Do the delete */
                        if (last)
                                last->next = nkey;
@@ -440,6 +516,7 @@ static int show_keys(int fd, int argc, char *argv[])
 {
        struct ast_key *key;
        char sum[16 * 2 + 1];
+       int count_keys = 0;
 
        ast_mutex_lock(&keylock);
        key = keys;
@@ -451,8 +528,10 @@ static int show_keys(int fd, int argc, char *argv[])
                        key->ktype & KEY_NEEDS_PASSCODE ? "[Needs Passcode]" : "[Loaded]", sum);
                                
                key = key->next;
+               count_keys++;
        }
        ast_mutex_unlock(&keylock);
+       ast_cli(fd, "%d known RSA keys.\n", count_keys);
        return RESULT_SUCCESS;
 }
 
@@ -468,7 +547,7 @@ static int init_keys(int fd, int argc, char *argv[])
                /* Reload keys that need pass codes now */
                if (key->ktype & KEY_NEEDS_PASSCODE) {
                        kn = key->fn + strlen(ast_config_AST_KEY_DIR) + 1;
-                       strncpy(tmp, kn, sizeof(tmp) - 1);
+                       ast_copy_string(tmp, kn, sizeof(tmp));
                        try_load_key((char *)ast_config_AST_KEY_DIR, tmp, fd, fd, &ign);
                }
                key = key->next;
@@ -476,63 +555,66 @@ static int init_keys(int fd, int argc, char *argv[])
        return RESULT_SUCCESS;
 }
 
-static char show_key_usage[] =
-"Usage: show keys\n"
+static const char show_key_usage[] =
+"Usage: keys show\n"
 "       Displays information about RSA keys known by Asterisk\n";
 
-static char init_keys_usage[] =
-"Usage: init keys\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_show_keys = 
-{ { "show", "keys", NULL }, show_keys, "Displays RSA key information", show_key_usage };
+static struct ast_cli_entry cli_crypto[] = {
+       { { "keys", "show", NULL },
+       show_keys, "Displays RSA key information",
+       show_key_usage },
 
-static struct ast_cli_entry cli_init_keys = 
-{ { "init", "keys", NULL }, init_keys, "Initialize RSA key passcodes", init_keys_usage };
+       { { "keys", "init", NULL },
+       init_keys, "Initialize RSA key passcodes",
+       init_keys_usage },
+};
 
 static int crypto_init(void)
 {
        SSL_library_init();
        ERR_load_crypto_strings();
-       ast_cli_register(&cli_show_keys);
-       ast_cli_register(&cli_init_keys);
+       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;
        return 0;
 }
 
-int reload(void)
+static int reload(void)
 {
        crypto_load(-1, -1);
        return 0;
 }
 
-int load_module(void)
+static int load_module(void)
 {
        crypto_init();
-       if (option_initcrypto)
+       if (ast_opt_init_keys)
                crypto_load(STDIN_FILENO, STDOUT_FILENO);
        else
                crypto_load(-1, -1);
        return 0;
 }
 
-int unload_module(void)
+static int unload_module(void)
 {
        /* Can't unload this once we're loaded */
        return -1;
 }
 
-char *description(void)
-{
-       return "Cryptographic Digital Signatures";
-}
-
-int usecount(void)
-{
-       /* We should never be unloaded */
-       return 1;
-}
-
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
+/* needs usecount semantics defined */
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Cryptographic Digital Signatures",
+               .load = load_module,
+               .unload = unload_module,
+               .reload = reload
+       );