]> git.ipfire.org Git - thirdparty/strongswan.git/commitdiff
Implemented private key on top of a PKCS#11 token
authorMartin Willi <martin@revosec.ch>
Thu, 15 Jul 2010 15:54:26 +0000 (17:54 +0200)
committerMartin Willi <martin@revosec.ch>
Wed, 4 Aug 2010 07:26:20 +0000 (09:26 +0200)
src/libstrongswan/plugins/pkcs11/Makefile.am
src/libstrongswan/plugins/pkcs11/pkcs11_plugin.c
src/libstrongswan/plugins/pkcs11/pkcs11_private_key.c [new file with mode: 0644]
src/libstrongswan/plugins/pkcs11/pkcs11_private_key.h [new file with mode: 0644]

index cfd8f02d9180a59e3b18e0a4779755cd6666f053..44f5d085e630ff6c5f76ff79bfad8b6f63439adb 100644 (file)
@@ -14,6 +14,7 @@ libstrongswan_pkcs11_la_SOURCES = \
        pkcs11_plugin.h pkcs11_plugin.c pkcs11.h \
        pkcs11_library.h pkcs11_library.c \
        pkcs11_creds.h pkcs11_creds.c \
+       pkcs11_private_key.h pkcs11_private_key.c \
        pkcs11_manager.h pkcs11_manager.c
 
 libstrongswan_pkcs11_la_LDFLAGS = -module -avoid-version
index 6befacd6b73cd5f3ea3b4d2be3956597108569eb..e083af548c40d4aae9a14d2915ffe10005b591f1 100644 (file)
@@ -22,6 +22,7 @@
 
 #include "pkcs11_manager.h"
 #include "pkcs11_creds.h"
+#include "pkcs11_private_key.h"
 
 typedef struct private_pkcs11_plugin_t private_pkcs11_plugin_t;
 
@@ -103,6 +104,8 @@ METHOD(plugin_t, destroy, void,
 {
        pkcs11_creds_t *creds;
 
+       lib->creds->remove_builder(lib->creds,
+                                                       (builder_function_t)pkcs11_private_key_connect);
        while (this->creds->remove_last(this->creds, (void**)&creds) == SUCCESS)
        {
                lib->credmgr->remove_set(lib->credmgr, &creds->set);
@@ -129,5 +132,8 @@ plugin_t *pkcs11_plugin_create()
 
        this->manager = pkcs11_manager_create((void*)token_event_cb, this);
 
+       lib->creds->add_builder(lib->creds, CRED_PRIVATE_KEY, KEY_ANY,
+                                                       (builder_function_t)pkcs11_private_key_connect);
+
        return &this->public.plugin;
 }
diff --git a/src/libstrongswan/plugins/pkcs11/pkcs11_private_key.c b/src/libstrongswan/plugins/pkcs11/pkcs11_private_key.c
new file mode 100644 (file)
index 0000000..576e2af
--- /dev/null
@@ -0,0 +1,369 @@
+/*
+ * Copyright (C) 2010 Martin Willi
+ * Copyright (C) 2010 revosec AG
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * for more details.
+ */
+
+#include "pkcs11_private_key.h"
+
+#include "pkcs11_library.h"
+#include "pkcs11_manager.h"
+
+#include <debug.h>
+#include <threading/mutex.h>
+
+typedef struct private_pkcs11_private_key_t private_pkcs11_private_key_t;
+
+/**
+ * Private data of an pkcs11_private_key_t object.
+ */
+struct private_pkcs11_private_key_t {
+
+       /**
+        * Public pkcs11_private_key_t interface.
+        */
+       pkcs11_private_key_t public;
+
+       /**
+        * PKCS#11 module
+        */
+       pkcs11_library_t *lib;
+
+       /**
+        * Token session
+        */
+       CK_SESSION_HANDLE session;
+
+       /**
+        * Mutex to lock session
+        */
+       mutex_t *mutex;
+
+       /**
+        * Key object on the token
+        */
+       CK_OBJECT_HANDLE object;
+
+       /**
+        * Associated public key
+        */
+       public_key_t *pubkey;
+
+       /**
+        * References to this key
+        */
+       refcount_t ref;
+};
+
+METHOD(private_key_t, get_type, key_type_t,
+       private_pkcs11_private_key_t *this)
+{
+       return this->pubkey->get_type(this->pubkey);
+}
+
+METHOD(private_key_t, get_keysize, size_t,
+       private_pkcs11_private_key_t *this)
+{
+       return this->pubkey->get_keysize(this->pubkey);
+}
+
+/**
+ * Get the Cryptoki mechanism for a signature scheme
+ */
+static CK_MECHANISM_PTR scheme_to_mechanism(signature_scheme_t scheme)
+{
+       static struct {
+               signature_scheme_t scheme;
+               CK_MECHANISM mechanism;
+       } mappings[] = {
+               {SIGN_RSA_EMSA_PKCS1_NULL,              {CKM_RSA_PKCS,                          NULL, 0}},
+               {SIGN_RSA_EMSA_PKCS1_SHA1,              {CKM_SHA1_RSA_PKCS,                     NULL, 0}},
+               {SIGN_RSA_EMSA_PKCS1_SHA256,    {CKM_SHA256_RSA_PKCS,           NULL, 0}},
+               {SIGN_RSA_EMSA_PKCS1_SHA384,    {CKM_SHA384_RSA_PKCS,           NULL, 0}},
+               {SIGN_RSA_EMSA_PKCS1_SHA512,    {CKM_SHA512_RSA_PKCS,           NULL, 0}},
+               {SIGN_RSA_EMSA_PKCS1_MD5,               {CKM_MD5_RSA_PKCS,                      NULL, 0}},
+       };
+       int i;
+
+       for (i = 0; i < countof(mappings); i++)
+       {
+               if (mappings[i].scheme == scheme)
+               {
+                       return &mappings[i].mechanism;
+               }
+       }
+       return NULL;
+}
+
+METHOD(private_key_t, sign, bool,
+       private_pkcs11_private_key_t *this, signature_scheme_t scheme,
+       chunk_t data, chunk_t *signature)
+{
+       CK_MECHANISM_PTR mechanism;
+       CK_BYTE_PTR buf;
+       CK_ULONG len;
+       CK_RV rv;
+
+       mechanism = scheme_to_mechanism(scheme);
+       if (!mechanism)
+       {
+               DBG1(DBG_LIB, "signature scheme %N not supported",
+                        signature_scheme_names, scheme);
+               return FALSE;
+       }
+       this->mutex->lock(this->mutex);
+       rv = this->lib->f->C_SignInit(this->session, mechanism, this->object);
+       if (rv != CKR_OK)
+       {
+               this->mutex->unlock(this->mutex);
+               DBG1(DBG_LIB, "C_SignInit() failed: %N", ck_rv_names, rv);
+               return FALSE;
+       }
+       buf = malloc(get_keysize(this));
+       rv = this->lib->f->C_Sign(this->session, data.ptr, data.len, buf, &len);
+       this->mutex->unlock(this->mutex);
+       if (rv != CKR_OK)
+       {
+               DBG1(DBG_LIB, "C_Sign() failed: %N", ck_rv_names, rv);
+               free(buf);
+               return FALSE;
+       }
+       *signature = chunk_create(buf, len);
+       return TRUE;
+}
+
+METHOD(private_key_t, decrypt, bool,
+       private_pkcs11_private_key_t *this, chunk_t crypto, chunk_t *plain)
+{
+       return FALSE;
+}
+
+METHOD(private_key_t, get_public_key, public_key_t*,
+       private_pkcs11_private_key_t *this)
+{
+       return this->pubkey->get_ref(this->pubkey);
+}
+
+METHOD(private_key_t, get_fingerprint, bool,
+       private_pkcs11_private_key_t *this, cred_encoding_type_t type,
+       chunk_t *fingerprint)
+{
+       return this->pubkey->get_fingerprint(this->pubkey, type, fingerprint);
+}
+
+METHOD(private_key_t, get_encoding, bool,
+       private_pkcs11_private_key_t *this, cred_encoding_type_t type,
+       chunk_t *encoding)
+{
+       return FALSE;
+}
+
+METHOD(private_key_t, get_ref, private_key_t*,
+       private_pkcs11_private_key_t *this)
+{
+       ref_get(&this->ref);
+       return &this->public.key;
+}
+
+METHOD(private_key_t, destroy, void,
+       private_pkcs11_private_key_t *this)
+{
+       if (ref_put(&this->ref))
+       {
+               if (this->pubkey)
+               {
+                       this->pubkey->destroy(this->pubkey);
+               }
+               this->mutex->destroy(this->mutex);
+               this->lib->f->C_CloseSession(this->session);
+               free(this);
+       }
+}
+
+/**
+ * Find the PKCS#11 library by its friendly name
+ */
+static pkcs11_library_t* find_lib(char *module)
+{
+       pkcs11_manager_t *manager;
+       enumerator_t *enumerator;
+       pkcs11_library_t *p11, *found = NULL;
+       CK_SLOT_ID slot;
+
+       manager = pkcs11_manager_get();
+       if (!manager)
+       {
+               return NULL;
+       }
+       enumerator = manager->create_token_enumerator(manager);
+       while (enumerator->enumerate(enumerator, &p11, &slot))
+       {
+               if (streq(module, p11->get_name(p11)))
+               {
+                       found = p11;
+                       break;
+               }
+       }
+       enumerator->destroy(enumerator);
+       return found;
+}
+
+/**
+ * Find the key on the token
+ */
+static bool find_key(private_pkcs11_private_key_t *this, chunk_t keyid)
+{
+       CK_OBJECT_CLASS class = CKO_PRIVATE_KEY;
+       CK_ATTRIBUTE tmpl[] = {
+               {CKA_CLASS, &class, sizeof(class)},
+               {CKA_ID, keyid.ptr, keyid.len},
+       };
+       CK_OBJECT_HANDLE object;
+       CK_KEY_TYPE type;
+       CK_ATTRIBUTE attr[] = {
+               {CKA_KEY_TYPE, &type, sizeof(type)},
+               {CKA_MODULUS, NULL, 0},
+               {CKA_PUBLIC_EXPONENT, NULL, 0},
+       };
+       enumerator_t *enumerator;
+       chunk_t modulus, pubexp;
+
+       enumerator = this->lib->create_object_enumerator(this->lib,
+                                               this->session, tmpl, countof(tmpl), attr, countof(attr));
+       if (enumerator->enumerate(enumerator, &object))
+       {
+               switch (type)
+               {
+                       case CKK_RSA:
+                               if (attr[0].ulValueLen == -1 || attr[1].ulValueLen == -1)
+                               {
+                                       DBG1(DBG_CFG, "reading modulus/exponent from PKCS#1 failed");
+                                       break;
+                               }
+                               modulus = chunk_create(attr[1].pValue, attr[1].ulValueLen);
+                               pubexp = chunk_create(attr[2].pValue, attr[2].ulValueLen);
+                               this->pubkey = lib->creds->create(lib->creds, CRED_PUBLIC_KEY,
+                                                                       KEY_RSA, BUILD_RSA_MODULUS, modulus,
+                                                                       BUILD_RSA_PUB_EXP, pubexp, BUILD_END);
+                               if (!this->pubkey)
+                               {
+                                       DBG1(DBG_CFG, "extracting public key from PKCS#11 RSA "
+                                                "private key failed");
+                               }
+                               this->object = object;
+                               break;
+                       default:
+                               DBG1(DBG_CFG, "PKCS#11 key type %d not supported", type);
+                               break;
+               }
+       }
+       enumerator->destroy(enumerator);
+       return this->pubkey != NULL;
+}
+
+/**
+ * See header.
+ */
+pkcs11_private_key_t *pkcs11_private_key_connect(key_type_t type, va_list args)
+{
+       private_pkcs11_private_key_t *this;
+       char *keyid = NULL, *pin = NULL, *module = NULL;
+       int slot = -1;
+       CK_RV rv;
+       chunk_t chunk;
+
+       while (TRUE)
+       {
+               switch (va_arg(args, builder_part_t))
+               {
+                       case BUILD_PKCS11_KEYID:
+                               keyid = va_arg(args, char*);
+                               continue;
+                       case BUILD_PKCS11_PIN:
+                               pin = va_arg(args, char*);
+                               continue;
+                       case BUILD_PKCS11_SLOT:
+                               slot = va_arg(args, int);
+                               continue;
+                       case BUILD_PKCS11_MODULE:
+                               module = va_arg(args, char*);
+                               continue;
+                       case BUILD_END:
+                               break;
+                       default:
+                               return NULL;
+               }
+               break;
+       }
+       if (!keyid || !pin || !module || slot == -1)
+       {       /* we currently require all parameters, TODO: search for pubkeys */
+               return NULL;
+       }
+
+       INIT(this,
+               .public.key = {
+                       .get_type = _get_type,
+                       .sign = _sign,
+                       .decrypt = _decrypt,
+                       .get_keysize = _get_keysize,
+                       .get_public_key = _get_public_key,
+                       .equals = private_key_equals,
+                       .belongs_to = private_key_belongs_to,
+                       .get_fingerprint = _get_fingerprint,
+                       .has_fingerprint = private_key_has_fingerprint,
+                       .get_encoding = _get_encoding,
+                       .get_ref = _get_ref,
+                       .destroy = _destroy,
+               },
+               .ref = 1,
+       );
+
+       this->lib = find_lib(module);
+       if (!this->lib)
+       {
+               DBG1(DBG_CFG, "PKCS#11 module '%s' not found", module);
+               free(this);
+               return NULL;
+       }
+
+       rv = this->lib->f->C_OpenSession(slot, CKF_SERIAL_SESSION,
+                                                                        NULL, NULL, &this->session);
+       if (rv != CKR_OK)
+       {
+               DBG1(DBG_CFG, "opening private key session on '%s':%d failed: %N",
+                        module, slot, ck_rv_names, rv);
+               free(this);
+               return NULL;
+       }
+
+       this->mutex = mutex_create(MUTEX_TYPE_DEFAULT);
+
+       rv = this->lib->f->C_Login(this->session, CKU_USER, pin, strlen(pin));
+       if (rv != CKR_OK)
+       {
+               DBG1(DBG_CFG, "login to '%s':%d failed: %N",
+                        module, slot, ck_rv_names, rv);
+               destroy(this);
+               return NULL;
+       }
+
+       chunk = chunk_from_hex(chunk_create(keyid, strlen(keyid)), NULL);
+       if (!find_key(this, chunk))
+       {
+               free(chunk.ptr);
+               destroy(this);
+               return NULL;
+       }
+       free(chunk.ptr);
+
+       return &this->public;
+}
diff --git a/src/libstrongswan/plugins/pkcs11/pkcs11_private_key.h b/src/libstrongswan/plugins/pkcs11/pkcs11_private_key.h
new file mode 100644 (file)
index 0000000..86b04b7
--- /dev/null
@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2010 Martin Willi
+ * Copyright (C) 2010 revosec AG
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * for more details.
+ */
+
+/**
+ * @defgroup pkcs11_private_key pkcs11_private_key
+ * @{ @ingroup pkcs11
+ */
+
+#ifndef PKCS11_PRIVATE_KEY_H_
+#define PKCS11_PRIVATE_KEY_H_
+
+typedef struct pkcs11_private_key_t pkcs11_private_key_t;
+
+#include <credentials/builder.h>
+#include <credentials/keys/private_key.h>
+
+/**
+ * Private Key implementation on top of PKCS#11.
+ */
+struct pkcs11_private_key_t {
+
+       /**
+        * Implements private_key_t interface.
+        */
+       private_key_t key;
+};
+
+/**
+ * Open a private key on a PKCS#11 device.
+ *
+ * Accepts the BUILD_SMARTCARD_KEYID and the BUILD_SMARTCARD_PIN arguments.
+ *
+ * @param type         type of the key
+ * @param args         builder_part_t argument list
+ * @return                     loaded key, NULL on failure
+ */
+pkcs11_private_key_t *pkcs11_private_key_connect(key_type_t type, va_list args);
+
+#endif /** PKCS11_PRIVATE_KEY_H_ @}*/