softhsm2-util: support import certificate

The softhsm2-util already support importing keys, why not also import
certificates?

Useful for test scripts that require both keys and certificates.

Add --import-type <type> parameter, depreciate the --aes parameter.

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>

Author: alonbl

src/bin/util/softhsm2-util-botan.cpp

@@ -47,6 +47,9 @@
 #include <botan/bigint.h>
 #include <botan/der_enc.h>
 #include <botan/oids.h>
+#include <botan/der_enc.h>
+#include <botan/x509cert.h>
+#include <botan/x509_dn.h>
 
 // Init Botan
 void crypto_init()
@@ -209,6 +212,64 @@ int crypto_import_key_pair
 	return result;
 }
 
+int crypto_import_certificate
+(
+	CK_SESSION_HANDLE hSession,
+	char* filePath,
+	char* label,
+	char* objID,
+	size_t objIDLen
+)
+{
+	auto _vector_ptr = [](std::vector<uint8_t> &v) {
+		return v.size() == 0 ? NULL : &v.front();
+	};
+
+	Botan::X509_Certificate cert(filePath);
+	std::vector<uint8_t> blob;
+	std::vector<uint8_t> subject;
+	std::vector<uint8_t> issuer;
+	std::vector<uint8_t> serial;
+
+	Botan::DER_Encoder blob_encoder(blob);
+	Botan::DER_Encoder subject_encoder(subject);
+	Botan::DER_Encoder issuer_encoder(issuer);
+	Botan::DER_Encoder serial_encoder(serial);
+
+	cert.encode_into(blob_encoder);
+	cert.subject_dn().encode_into(subject_encoder);
+	cert.issuer_dn().encode_into(issuer_encoder);
+	serial_encoder.encode(Botan::BigInt::decode(cert.serial_number()));
+
+	CK_OBJECT_CLASS certClass = CKO_CERTIFICATE;
+	CK_CERTIFICATE_TYPE certType = CKC_X_509;
+	CK_BBOOL ckFalse = CK_FALSE, ckTrue = CK_TRUE;
+	CK_ATTRIBUTE certTemplate[] = {
+		{ CKA_CLASS,            &certClass,          	sizeof(certClass) },
+		{ CKA_CERTIFICATE_TYPE, &certType,           	sizeof(certType) },
+		{ CKA_LABEL,            label,               	strlen(label) },
+		{ CKA_ID,               objID,               	objIDLen },
+		{ CKA_TOKEN,            &ckTrue,            	sizeof(ckTrue) },
+		{ CKA_PRIVATE,		&ckFalse,		sizeof(ckFalse) },
+		{ CKA_VALUE,            _vector_ptr(blob),    	(CK_ULONG)blob.size() },
+		{ CKA_SUBJECT,          _vector_ptr(subject), 	(CK_ULONG)subject.size() },
+		{ CKA_ISSUER,           _vector_ptr(issuer),  	(CK_ULONG)issuer.size() },
+		{ CKA_SERIAL_NUMBER,    _vector_ptr(serial),  	(CK_ULONG)serial.size() }
+	};
+
+	CK_OBJECT_HANDLE hCert;
+	CK_RV rv = p11->C_CreateObject(hSession, certTemplate, 10, &hCert);
+	if (rv != CKR_OK)
+	{
+		fprintf(stderr, "ERROR: Could not save the certificate in the token.\n");
+		return 1;
+	}
+
+	printf("The certificate has been imported.\n");
+
+	return 0;
+}
+
 // Read the key from file
 Botan::Private_Key* crypto_read_file(char* filePath, char* filePIN)
 {

src/bin/util/softhsm2-util-ossl.cpp

@@ -218,6 +218,151 @@ int crypto_import_key_pair
 	return result;
 }
 
+int crypto_import_certificate
+(
+	CK_SESSION_HANDLE hSession,
+	char* filePath,
+	char* label,
+	char* objID,
+	size_t objIDLen
+)
+{
+	BIO* in = NULL;
+	X509* x509 = NULL;
+	CK_BYTE_PTR blob = NULL;
+	CK_BYTE_PTR subject = NULL;
+	CK_BYTE_PTR issuer = NULL;
+	CK_BYTE_PTR serial = NULL;
+	CK_BYTE_PTR p;
+	int blobSize;
+	int subjectSize;
+	int issuerSize;
+	int serialSize;
+	int ret = 1;
+
+	if (!(in = BIO_new_file(filePath, "rb")))
+	{
+		fprintf(stderr, "ERROR: Could open the PKCS#8 file: %s\n", filePath);
+		goto cleanup;
+	}
+
+	if ((x509 = PEM_read_bio_X509(in, NULL, NULL, NULL)) == NULL)
+	{
+		fprintf(stderr, "ERROR: Could not read the certificate file: %s\n", filePath);
+		goto cleanup;
+	}
+
+	blobSize = i2d_X509(x509, NULL);
+	subjectSize = i2d_X509_NAME(X509_get_subject_name(x509), NULL);
+	issuerSize = i2d_X509_NAME(X509_get_issuer_name(x509), NULL);
+	serialSize = i2d_ASN1_INTEGER(X509_get_serialNumber(x509), NULL);
+
+	if
+	(
+		blobSize < 0 ||
+		subjectSize < 0 ||
+		issuerSize < 0 ||
+		serialSize < 0
+	)
+	{
+		fprintf(stderr, "ERROR: Could not convert certificate to DER.\n");
+		goto cleanup;
+	}
+
+	if (blobSize > 0)
+	{
+		if ((blob = (CK_BYTE_PTR)malloc(blobSize)) == NULL)
+		{
+			fprintf(stderr, "ERROR: Could not allocate memory.\n");
+			goto cleanup;
+		}
+		p = blob;
+		blobSize = i2d_X509(x509, &p);
+	}
+	if (subjectSize > 0) {
+		if ((subject = (CK_BYTE_PTR)malloc(subjectSize)) == NULL)
+		{
+			fprintf(stderr, "ERROR: Could not allocate memory.\n");
+			goto cleanup;
+		}
+		p = subject;
+		subjectSize = i2d_X509_NAME(X509_get_subject_name(x509), &p);
+	}
+	if (issuerSize > 0)
+	{
+		if ((issuer = (CK_BYTE_PTR)malloc(issuerSize)) == NULL)
+		{
+			fprintf(stderr, "ERROR: Could not allocate memory.\n");
+			goto cleanup;
+		}
+		p = issuer;
+		issuerSize = i2d_X509_NAME(X509_get_issuer_name(x509), &p);
+	}
+	if (serialSize > 0)
+	{
+		if ((serial = (CK_BYTE_PTR)malloc(serialSize)) == NULL)
+		{
+			fprintf(stderr, "ERROR: Could not allocate memory.\n");
+			goto cleanup;
+		}
+		p = serial;
+		serialSize = i2d_ASN1_INTEGER(X509_get_serialNumber(x509), &p);
+	}
+
+	if
+	(
+		blobSize < 0 ||
+		subjectSize < 0 ||
+		issuerSize < 0 ||
+		serialSize < 0
+	)
+	{
+		fprintf(stderr, "ERROR: Could not convert certificate to DER.\n");
+		goto cleanup;
+	}
+
+	{
+		CK_OBJECT_CLASS certClass = CKO_CERTIFICATE;
+		CK_CERTIFICATE_TYPE certType = CKC_X_509;
+		CK_BBOOL ckFalse = CK_FALSE, ckTrue = CK_TRUE;
+		CK_ATTRIBUTE certTemplate[] = {
+			{ CKA_CLASS,            &certClass,   sizeof(certClass) },
+			{ CKA_CERTIFICATE_TYPE, &certType,    sizeof(certType) },
+			{ CKA_LABEL,            label,        strlen(label) },
+			{ CKA_ID,               objID,        objIDLen },
+			{ CKA_TOKEN,            &ckTrue,      sizeof(ckTrue) },
+			{ CKA_PRIVATE,          &ckFalse,     sizeof(ckFalse) },
+			{ CKA_VALUE,            blob,         (CK_ULONG)blobSize },
+			{ CKA_SUBJECT,          subject,      (CK_ULONG)subjectSize },
+			{ CKA_ISSUER,           issuer,       (CK_ULONG)issuerSize },
+			{ CKA_SERIAL_NUMBER,    serial,       (CK_ULONG)serialSize }
+		};
+
+		CK_OBJECT_HANDLE hCert;
+		CK_RV rv = p11->C_CreateObject(hSession, certTemplate, 10, &hCert);
+		if (rv != CKR_OK)
+		{
+			fprintf(stderr, "ERROR: Could not save the certificate in the token.\n");
+			goto cleanup;
+		}
+	}
+
+	printf("The certificate has been imported.\n");
+
+	ret = 0;
+
+cleanup:
+
+	free(blob);
+	free(subject);
+	free(issuer);
+	free(serial);
+	X509_free(x509);
+	BIO_free(in);
+
+	return ret;
+}
+
 // Read the key from file
 EVP_PKEY* crypto_read_file(char* filePath, char* filePIN)
 {

src/bin/util/softhsm2-util.1

@@ -20,27 +20,23 @@ softhsm2-util \- support tool for libsofthsm2
 .PP
 .B softhsm2-util \-\-import
 .I path
+.RB [ \-\-import-type
+.IR type ]
+\\
+.ti +0.7i
 .RB [ \-\-file-pin
 .IR PIN ]
 .B \-\-token
 .I label
+.RB [ \-\-pin
+.I PIN]
+.B [\-\-no\-public\-key]
 \\
 .ti +0.7i
-.RB [ \-\-pin
-.I PIN
-.B \-\-no\-public\-key]
 .B \-\-label
 .I text
 .B \-\-id
 .I hex
-.PP
-.B softhsm2-util \-\-import
-.I path
-.B \-\-aes
-.B \-\-token
-.I label
-\\
-.ti +0.7i
 .RB [ \-\-pin
 .I PIN]
 .B \-\-label
@@ -125,11 +121,11 @@ Any content in token will be erased.
 Show the help information.
 .TP
 .B \-\-import \fIpath\fR
-Import a key pair from the given
+Import an object from the given
 .IR path .
-The file must be in PKCS#8-format.
 .br
 Use with
+.BR \-\-import-type,
 .BR \-\-slot
 or
 .BR \-\-token
@@ -141,10 +137,6 @@ or
 .BR \-\-label ,
 and
 .BR \-\-id .
-.br
-Can also be used with
-.BR \-\-aes
-to use file as is and import it as AES.
 .TP
 .B \-\-init-token
 Initialize the token at a given slot, token label or token serial.
@@ -183,8 +175,20 @@ print the default PKCS#11 library.
 Show the version info.
 .SH OPTIONS
 .TP
+.B \-\-import-type \fItype\fR
+Import object type, \fItype\fR may be one of:
+.RS
+.IP keypair\ [default]
+The file must be in PKCS#8 PEM format.
+.IP aes
+The file must be in binary format.
+.IP cert
+The file must be in X509 PEM format.
+.RE
+.TP
 .B \-\-aes
 Used to tell import to use file as is and import it as AES.
+Deprecated, use \fI--import-type aes\fR instead.
 .TP
 .B \-\-file-pin \fIPIN\fR
 The

src/bin/util/softhsm2-util.cpp

@@ -101,10 +101,17 @@ void usage()
 	printf("                    WARNING: Any content in token will be erased.\n");
 	printf("  -h                Shows this help screen.\n");
 	printf("  --help            Shows this help screen.\n");
-	printf("  --import <path>   Import a key pair from the given path.\n");
-	printf("                    The file must be in PKCS#8-format.\n");
-	printf("                    Use with --slot or --token or --serial, --file-pin,\n");
-	printf("                    --label, --id, --no-public-key, and --pin.\n");
+	printf("  --import <path>   Import an object from the given path.\n");
+	printf("                    Use with --import-type, --slot or --token or --serial,\n");
+	printf("                    --file-pin, --label, --id, --no-public-key, and --pin.\n");
+	printf("  --import-type <type>\n");
+	printf("                    Import object type, type may be one of:\n");
+	printf("                        keypair [default]\n");
+	printf("                            The file must be in PKCS#8 PEM format.\n");
+	printf("                        aes\n");
+	printf("                            The file must be in binary format.\n");
+	printf("                        cert\n");
+	printf("                            The file must be in X509 PEM format.\n");
 	printf("  --init-token      Initialize the token at a given slot.\n");
 	printf("                    Use with --slot or --token or --serial or --free,\n");
 	printf("                    --label, --so-pin, and --pin.\n");
@@ -118,6 +125,7 @@ void usage()
 	printf("  --version         Show version info.\n");
 	printf("Options:\n");
 	printf("  --aes             Used to tell import to use file as is and import it as AES.\n");
+	printf("                    Deprecated, use '--import-type aes'.\n");
 	printf("  --file-pin <PIN>  Supply a PIN if the file is encrypted.\n");
 	printf("  --force           Used to override a warning.\n");
 	printf("  --free            Use the first free/uninitialized token.\n");
@@ -134,6 +142,13 @@ void usage()
 	printf("  --token <label>   Will use the token with a matching token label.\n");
 }
 
+// Enumeration of import types
+enum {
+	IMPORT_TYPE_KEYPAIR,
+	IMPORT_TYPE_AES,
+	IMPORT_TYPE_CERT
+};
+
 // Enumeration of the long options
 enum {
 	OPT_DELETE_TOKEN = 0x100,
@@ -143,6 +158,7 @@ enum {
 	OPT_HELP,
 	OPT_ID,
 	OPT_IMPORT,
+	OPT_IMPORT_TYPE,
 	OPT_INIT_TOKEN,
 	OPT_LABEL,
 	OPT_MODULE,
@@ -167,6 +183,7 @@ static const struct option long_options[] = {
 	{ "help",            0, NULL, OPT_HELP },
 	{ "id",              1, NULL, OPT_ID },
 	{ "import",          1, NULL, OPT_IMPORT },
+	{ "import-type",     1, NULL, OPT_IMPORT_TYPE },
 	{ "init-token",      0, NULL, OPT_INIT_TOKEN },
 	{ "label",           1, NULL, OPT_LABEL },
 	{ "module",          1, NULL, OPT_MODULE },
@@ -205,7 +222,7 @@ int main(int argc, char* argv[])
 	int forceExec = 0;
 	bool freeToken = false;
 	int noPublicKey = 0;
-	bool importAES = false;
+	int importType = IMPORT_TYPE_KEYPAIR;
 
 	int doInitToken = 0;
 	int doShowSlots = 0;
@@ -251,8 +268,20 @@ int main(int argc, char* argv[])
 				inPath = optarg;
 				needP11 = true;
 				break;
+			case OPT_IMPORT_TYPE:
+				if (!strcmp(optarg, "keypair"))
+					importType = IMPORT_TYPE_KEYPAIR;
+				else if (!strcmp(optarg, "aes"))
+					importType = IMPORT_TYPE_AES;
+				else if (!strcmp(optarg, "cert"))
+					importType = IMPORT_TYPE_CERT;
+				else
+				{
+					fprintf(stderr, "ERROR: Invalid import type '%s'\n", optarg);
+				}
+				break;
 			case OPT_AES:
-				importAES = true;
+				importType = IMPORT_TYPE_AES;
 				break;
 			case OPT_DELETE_TOKEN:
 				doDeleteToken = 1;
@@ -370,8 +399,22 @@ int main(int argc, char* argv[])
 		rv = findSlot(slot, serial, token, slotID);
 		if (!rv)
 		{
-			rv = importAES ? importSecretKey(inPath, slotID, userPIN, label, objectID)
-					: importKeyPair(inPath, filePIN, slotID, userPIN, label, objectID, forceExec, noPublicKey);
+			switch(importType)
+			{
+				case IMPORT_TYPE_KEYPAIR:
+					rv = importKeyPair(inPath, filePIN, slotID, userPIN, label, objectID, forceExec, noPublicKey);
+					break;
+				case IMPORT_TYPE_AES:
+					rv = importSecretKey(inPath, slotID, userPIN, label, objectID);
+					break;
+				case IMPORT_TYPE_CERT:
+					rv = importCertificate(inPath, slotID, userPIN, label, objectID, forceExec);
+					break;
+				default:
+					fprintf(stderr, "Invalid importType %d.\n", importType);
+					rv = 1;
+					break;
+			}
 		}
 	}
 
@@ -1117,7 +1160,7 @@ int importKeyPair
 		return 1;
 	}
 
-	CK_OBJECT_HANDLE oHandle = searchObject(hSession, objID, objIDLen);
+	CK_OBJECT_HANDLE oHandle = searchObject(hSession, CKO_PRIVATE_KEY, objID, objIDLen);
 	if (oHandle != CK_INVALID_HANDLE && forceExec == 0)
 	{
 		free(objID);
@@ -1205,6 +1248,98 @@ int importSecretKey(char* filePath, CK_SLOT_ID slotID, char* userPIN, char* labe
 	return result;
 }
 
+// Import a certificate from given path
+int importCertificate
+(
+	char* filePath,
+	CK_SLOT_ID slotID,
+	char* userPIN,
+	char* label,
+	char* objectID,
+	int forceExec
+)
+{
+	char user_pin_copy[MAX_PIN_LEN+1] = {0};
+
+	if (label == NULL)
+	{
+		fprintf(stderr, "ERROR: A label for the object must be supplied. "
+				"Use --label <text>\n");
+		return 1;
+	}
+
+	if (objectID == NULL)
+	{
+		fprintf(stderr, "ERROR: An ID for the object must be supplied. "
+				"Use --id <hex>\n");
+		return 1;
+	}
+
+	size_t objIDLen = 0;
+	char* objID = hexStrToBin(objectID, strlen(objectID), &objIDLen);
+	if (objID == NULL)
+	{
+		fprintf(stderr, "Please edit --id <hex> to correct error.\n");
+		return 1;
+	}
+
+	CK_SESSION_HANDLE hSession;
+	CK_RV rv = p11->C_OpenSession(slotID, CKF_SERIAL_SESSION | CKF_RW_SESSION,
+					NULL_PTR, NULL_PTR, &hSession);
+	if (rv != CKR_OK)
+	{
+		if (rv == CKR_SLOT_ID_INVALID)
+		{
+			fprintf(stderr, "ERROR: The given slot does not exist.\n");
+		}
+		else
+		{
+			fprintf(stderr, "ERROR: Could not open a session on the given slot.\n");
+		}
+		free(objID);
+		return 1;
+	}
+
+	// Get the password
+	if (getPW(userPIN, user_pin_copy, CKU_USER) != 0)
+	{
+		fprintf(stderr, "ERROR: Could not get user PIN\n");
+		free(objID);
+		return 1;
+	}
+
+	rv = p11->C_Login(hSession, CKU_USER, (CK_UTF8CHAR_PTR)user_pin_copy, strlen(user_pin_copy));
+	if (rv != CKR_OK)
+	{
+		if (rv == CKR_PIN_INCORRECT) {
+			fprintf(stderr, "ERROR: The given user PIN does not match the one in the token.\n");
+		}
+		else
+		{
+			fprintf(stderr, "ERROR: Could not log in on the token.\n");
+		}
+		free(objID);
+		return 1;
+	}
+
+	CK_OBJECT_HANDLE oHandle = searchObject(hSession, CKO_CERTIFICATE, objID, objIDLen);
+	if (oHandle != CK_INVALID_HANDLE && forceExec == 0)
+	{
+		free(objID);
+		fprintf(stderr, "ERROR: The ID is already assigned to another object. "
+				"Use --force to override this message.\n");
+		return 1;
+	}
+
+	crypto_init();
+	int result = crypto_import_certificate(hSession, filePath, label, objID, objIDLen);
+	crypto_final();
+
+	free(objID);
+
+	return result;
+}
+
 // Convert a char array of hexadecimal characters into a binary representation
 char* hexStrToBin(char* objectID, int idLength, size_t* newLen)
 {
@@ -1291,14 +1426,13 @@ int hexdigit_to_int(char ch)
 }
 
 // Search for an object
-CK_OBJECT_HANDLE searchObject(CK_SESSION_HANDLE hSession, char* objID, size_t objIDLen)
+CK_OBJECT_HANDLE searchObject(CK_SESSION_HANDLE hSession, CK_OBJECT_CLASS oClass, char* objID, size_t objIDLen)
 {
 	if (objID == NULL)
 	{
 		return CK_INVALID_HANDLE;
 	}
 
-	CK_OBJECT_CLASS oClass = CKO_PRIVATE_KEY;
 	CK_OBJECT_HANDLE hObject = CK_INVALID_HANDLE;
 	CK_ULONG objectCount = 0;
 

src/bin/util/softhsm2-util.h

@@ -49,8 +49,10 @@ bool rm(std::string path);
 int showSlots();
 int importKeyPair(char* filePath, char* filePIN, CK_SLOT_ID slotID, char* userPIN, char* objectLabel, char* objectID, int forceExec, int noPublicKey);
 int importSecretKey(char* filePath, CK_SLOT_ID slotID, char* userPIN, char* label, char* objectID);
+int importCertificate(char* filePath, CK_SLOT_ID slotID, char* userPIN, char* objectLabel, char* objectID, int forceExec);
 int crypto_import_key_pair(CK_SESSION_HANDLE hSession, char* filePath, char* filePIN, char* label, char* objID, size_t objIDLen, int noPublicKey);
 int crypto_import_aes_key(CK_SESSION_HANDLE hSession, char* filePath, char* label, char* objID, size_t objIDLen);
+int crypto_import_certificate(CK_SESSION_HANDLE hSession, char* filePath, char* label, char* objID, size_t objIDLen);
 
 // Support functions
 
@@ -72,6 +74,6 @@ static void* moduleHandle;
 extern CK_FUNCTION_LIST_PTR p11;
 
 /// PKCS#11 support
-CK_OBJECT_HANDLE searchObject(CK_SESSION_HANDLE hSession, char* objID, size_t objIDLen);
+CK_OBJECT_HANDLE searchObject(CK_SESSION_HANDLE hSession, CK_OBJECT_CLASS oClass, char* objID, size_t objIDLen);
 
 #endif // !_SOFTHSM_V2_SOFTHSM2_UTIL_H