Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add more pkcs11 tests #426

Closed
wants to merge 2 commits into from
Closed

Add more pkcs11 tests #426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2e7ce9
Add more PKCS11 tests
prateek-y Sep 22, 2021
518ef59
Address PR feedback
prateek-y Sep 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions PKCS11.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ and set the following environment variables:

```
TEST_PKCS11_LIB = <path-to-shared-lib>
TEST_PKCS11_TOKEN_LABEL = <token-label>
TEST_PKCS11_PIN = <pin-for-logging-into-token>
TEST_PKCS11_PKEY_LABEL = <private-key-label>
TEST_PKCS11_CERT_FILE = <path-to-PEM-encoded-certificate>
TEST_PKCS11_CA_FILE = <path-to-PEM-encoded-CA-file-needed-to-trust-certificate>
TEST_PKCS11_TOKEN_DIR = <path-to-softhsm-token-dir>
```
TEST_PKCS11_LIB is used by the tests to peform pkcs11 operations.

TEST_PKCS11_TOKEN_DIR is used by the tests to clear the softhsm tokens before a test begins. This is achieved by cleaning the token directory <b>NOTE: Any tokens created outside the tests will be cleaned up along with all the objects/keys on it as part of the tests.</b>


## The suggested way to set up your machine
1) Install [SoftHSM2](https://www.opendnssec.org/softhsm/) via brew / apt / apt-get / yum:
Expand All @@ -31,7 +31,14 @@ TEST_PKCS11_CA_FILE = <path-to-PEM-encoded-CA-file-needed-to-trust-certificate>
directories.tokendir = /usr/local/var/lib/softhsm/tokens/
```

2) Create token and private key.
2) Set env vars like so:
```
TEST_PKCS11_LIB = <path to libsofthsm2.so>
TEST_PKCS11_TOKEN_DIR = /usr/local/var/lib/softhsm/tokens/
```


3) [Example to import your keys, Not used by tests] Create token and private key

You can use any values for the labels, pin, key, cert, CA etc.
Here are copy-paste friendly commands for using files available in this repo.
Expand All @@ -44,13 +51,5 @@ TEST_PKCS11_CA_FILE = <path-to-PEM-encoded-CA-file-needed-to-trust-certificate>
```
> softhsm2-util --import tests/resources/unittests.p8 --slot <slot-with-token> --label my-test-key --id BEEFCAFE --pin 0000
```
<b>WARN: All tokens created outside the tests would be cleaned up as part of the tests, Use a separate token directory for running the tests if you would like to keep your tokens intact.</b>

3) Set env vars like so:
```
TEST_PKCS11_LIB = <path to libsofthsm2.so>
TEST_PKCS11_TOKEN_LABEL = my-test-token
TEST_PKCS11_PIN = 0000
TEST_PKCS11_PKEY_LABEL = my-test-key
TEST_PKCS11_CERT_FILE = <path to aws-c-io>/tests/resources/unittests.crt
TEST_PKCS11_CA_FILE = <path to aws-c-io>/tests/resources/unittests.crt
```
13 changes: 13 additions & 0 deletions include/aws/io/private/pkcs11_private.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@
#include <aws/io/io.h>

struct aws_pkcs11_lib;

/* These defines must exist before the official PKCS#11 headers are included */
#define CK_PTR *
#define NULL_PTR 0
#define CK_DEFINE_FUNCTION(returnType, name) returnType name
#define CK_DECLARE_FUNCTION(returnType, name) returnType name
#define CK_DECLARE_FUNCTION_POINTER(returnType, name) returnType(CK_PTR name)
#define CK_CALLBACK_FUNCTION(returnType, name) returnType(CK_PTR name)

/* Support older PKCS#11 versions, even if we're using newer headers.
* The PKCS#11 API is designed to be forward compatible. */
#include <aws/io/private/pkcs11/v2.40/pkcs11.h>

struct aws_string;

/**
Expand Down
19 changes: 7 additions & 12 deletions source/pkcs11.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,6 @@

#include <inttypes.h>

/* These defines must exist before the official PKCS#11 headers are included */
#define CK_PTR *
#define NULL_PTR 0
#define CK_DEFINE_FUNCTION(returnType, name) returnType name
#define CK_DECLARE_FUNCTION(returnType, name) returnType name
#define CK_DECLARE_FUNCTION_POINTER(returnType, name) returnType(CK_PTR name)
#define CK_CALLBACK_FUNCTION(returnType, name) returnType(CK_PTR name)

/* Support older PKCS#11 versions, even if we're using newer headers.
* The PKCS#11 API is designed to be forward compatible. */
#include <aws/io/private/pkcs11/v2.40/pkcs11.h>
#define AWS_SUPPORTED_CRYPTOKI_VERSION_MAJOR 2
#define AWS_MIN_SUPPORTED_CRYPTOKI_VERSION_MINOR 20

Expand Down Expand Up @@ -428,6 +417,12 @@ void aws_pkcs11_lib_release(struct aws_pkcs11_lib *pkcs11_lib) {
}
}

CK_FUNCTION_LIST_PTR aws_pkcs11_get_function_list(struct aws_pkcs11_lib *pkcs11_lib) {
if (pkcs11_lib) {
return pkcs11_lib->function_list;
}
}

/**
* Find the slot that meets all criteria:
* - has a token
Expand Down Expand Up @@ -665,7 +660,7 @@ int aws_pkcs11_lib_find_private_key(
bool must_finalize_search = false;

/* set up search attributes */
CK_OBJECT_CLASS key_class = CKO_PRIVATE_KEY;
CK_OBJECT_CLASS key_class = CKO_SECRET_KEY;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the difference between CKO_PRIVATE_KEY and CKO_SECRET_KEY?
is a PRIVATE_KEY also qualify as a SECRET_KEY?

The tests were passing when I created the private key via:
softhsm2 --import tests/resources/unittests.p8
and searched for a CKO_PRIVATE_KEY

does CKO_SECRET_KEY also work when searching for keys created via the --import command?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed offline, its basically the symmetric key which does not have a public key/cert associated with it. I will revert back to asymmetric key.

CK_ULONG num_attributes = 1;
CK_ATTRIBUTE attributes[2] = {
{
Expand Down
3 changes: 3 additions & 0 deletions tests/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,9 @@ if (ENABLE_PKCS11_TESTS)
add_test_case(pkcs11_lib_initialize)
add_test_case(pkcs11_lib_omit_initialize)
add_test_case(pkcs11_find_private_key)
add_test_case(pkcs11_find_slot)
add_test_case(pkcs11_session_tests)
add_test_case(pkcs11_login_tests)
endif()

set(TEST_BINARY_NAME ${PROJECT_NAME}-tests)
Expand Down
Loading