The aws-greengrass-pkcs11-provider from njlaw

aws-greengrass-pkcs11-provider's Introduction

AWS Greengrass PKCS11 Provider

The AWS Greengrass PKCS11 Provider enables the ability to interact with Trusted Platform Module (TPM) storing IoT thing's private key and certificate to connect to AWS IoT and other AWS services. This PKCS11 provider is meant to run with Greengrass Nucleus as a plugin.

Parameters

This PKCS11 Provider takes the following parameters:

Required

name: A unique string identifier for the configuration.
library: Absolute path to PKCS11 library on the device.
slot: Slot ID of the slot which holds the key. Not to be confused with slot index or slot label.
userPin: User pin needed to access the slot.

Start Greengrass with PKCS11 provider plugin

Setup

Thing private key and certificate need to be imported to the TPM on the device.
config.yaml containing the following additional config:

Sample configuration to bootstrap Greengrass nucleus with the PKCS11 plugin

aws.greengrass.crypto.Pkcs11Provider:
    configuration:
      name: sample_name
      library: /absolute/path/to/library
      slot: 12345
      userPin: abc123

Command to start Greengrass:

sudo -E java -Droot="<root>" -Dlog.store=FILE \
  -jar ./GreengrassCore/lib/Greengrass.jar \
  --aws-region <region> \
  --init-config config.yaml \
  --component-default-user ggc_user:ggc_group \
  --setup-system-service true
  --trusted-plugin <path_to_plugin>/aws.greengrass.crypto.Pkcs11Provider.jar

Get PKCS11 provider plugin through deployment

Setup

Thing private key and certificate need to be imported to the TPM on the device.

Create a deployment and merge the parameters as shown below:

{
  "targetArn": "<arn_of_target>",
  "components": {
    "aws.greengrass.crypto.Pkcs11Provider": {
      "componentVersion": "1.0.0",
      "configurationUpdate": {
        "merge": "{\"name\":\"sample_name\",\"library\":\"/absolute/path/to/library\",\"slot\":12345,\"userPin\":\"abc123\"}"
      }
    }
  }