pkcs11

Documentation

Overview

Copyright IBM Corp. 2016 All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func FindPKCS11Lib() (lib, pin, label string)
• func New(opts PKCS11Opts, keyStore bccsp.KeyStore) (bccsp.BCCSP, error)
• type DummyKeystoreOpts
• type FileKeystoreOpts
• type PKCS11Opts

Functions

func FindPKCS11Lib

func FindPKCS11Lib() (lib, pin, label string)

FindPKCS11Lib IS ONLY USED FOR TESTING This is a convenience function. Useful to self-configure, for tests where usual configuration is not available

func New

func New(opts PKCS11Opts, keyStore bccsp.KeyStore) (bccsp.BCCSP, error)

New WithParams returns a new instance of the software-based BCCSP set at the passed security level, hash family and KeyStore.

Types

type DummyKeystoreOpts

type DummyKeystoreOpts struct{}

DummyKeystoreOpts is placeholder for testing purposes

type FileKeystoreOpts

type FileKeystoreOpts struct {
	KeyStorePath string `mapstructure:"keystore" json:"keystore" yaml:"KeyStore"`
}

FileKeystoreOpts currently only ECDSA operations go to PKCS11, need a keystore still Pluggable Keystores, could add JKS, P12, etc..

type PKCS11Opts

type PKCS11Opts struct {
	// Default algorithms when not specified (Deprecated?)
	SecLevel   int    `mapstructure:"security" json:"security"`
	HashFamily string `mapstructure:"hash" json:"hash"`

	// Keystore options
	Ephemeral     bool               `mapstructure:"tempkeys,omitempty" json:"tempkeys,omitempty"`
	FileKeystore  *FileKeystoreOpts  `mapstructure:"filekeystore,omitempty" json:"filekeystore,omitempty"`
	DummyKeystore *DummyKeystoreOpts `mapstructure:"dummykeystore,omitempty" json:"dummykeystore,omitempty"`

	// PKCS11 options
	Library    string `mapstructure:"library" json:"library"`
	Label      string `mapstructure:"label" json:"label"`
	Pin        string `mapstructure:"pin" json:"pin"`
	SoftVerify bool   `mapstructure:"softwareverify,omitempty" json:"softwareverify,omitempty"`
	Immutable  bool   `mapstructure:"immutable,omitempty" json:"immutable,omitempty"`
	AltId      string `mapstructure:"altid" json:"altid"`
}

PKCS11Opts contains options for the P11Factory