pkcs11hsm

Documentation

Overview

Package pkcs11hsm adds support for PKCS11 compatible HSMs by satisfying the DigitalSignatureManager interface.

Index

• type ByTime
  • func (a ByTime) Addresses() []address.Address
  • func (a ByTime) Len() int
  • func (a ByTime) Less(i, j int) bool
  • func (a ByTime) Swap(i, j int)
• type Curve
• type PKCS11HSMConfiguration
• type PKCS11HSMConnectionDetails
• type PKCS11HSMSignatureManager
  • func ProvidePKCS11HSMSignatureManager(options PKCS11HSMSignatureManagerOptions) (*PKCS11HSMSignatureManager, error)
  • func (s *PKCS11HSMSignatureManager) Close(_ context.Context, _ signaturemanager.CloseInput) (*signaturemanager.CloseOutput, error)
  • func (s *PKCS11HSMSignatureManager) GenerateKey(_ context.Context, input signaturemanager.GenerateKeyInput) (*signaturemanager.GenerateKeyOutput, error)
  • func (s *PKCS11HSMSignatureManager) IsAlive(_ context.Context, input signaturemanager.IsAliveInput) (*signaturemanager.IsAliveOutput, error)
  • func (s *PKCS11HSMSignatureManager) ListKeys(_ context.Context, input signaturemanager.ListKeysInput) (*signaturemanager.ListKeysOutput, error)
  • func (s *PKCS11HSMSignatureManager) Open(_ context.Context, _ signaturemanager.OpenInput) (*signaturemanager.OpenOutput, error)
  • func (s *PKCS11HSMSignatureManager) RemoveKey(_ context.Context, input signaturemanager.RemoveKeyInput) (*signaturemanager.RemoveKeyOutput, error)
  • func (s *PKCS11HSMSignatureManager) Sign(ctx context.Context, input signaturemanager.SignInput) (*signaturemanager.SignOutput, error)
• type PKCS11HSMSignatureManagerOptions

Types

type ByTime

type ByTime []addressTime

ByTime defines a type to be used when sorting accounts by time.

func (ByTime) Addresses

func (a ByTime) Addresses() []address.Address

Addresses is implementing the required element interface to be used by sort.Sort.

func (ByTime) Len

func (a ByTime) Len() int

Len is implementing the required element interface to be used by sort.Sort.

func (ByTime) Less

func (a ByTime) Less(i, j int) bool

Less is implementing the required element interface to be used by sort.Sort.

func (ByTime) Swap

func (a ByTime) Swap(i, j int)

Swap is implementing the required element interface to be used by sort.Sort.

type Curve

type Curve string

const (
	CurveDefault   Curve = "secp256k1"
	CurveSecp256k1 Curve = "secp256k1"
)

type PKCS11HSMConfiguration

type PKCS11HSMConfiguration struct {
	Curve Curve
}

PKCS11HSMConfiguration configuration to connect to a softHSM instance.

type PKCS11HSMConnectionDetails

type PKCS11HSMConnectionDetails struct {
	// Configuration configuration to connect to a softHSM instance.
	Configuration PKCS11HSMConfiguration
}

PKCS11HSMConnectionDetails configuration to connect to a specific slot in a softHSM instance.

type PKCS11HSMSignatureManager

type PKCS11HSMSignatureManager struct {
	// contains filtered or unexported fields
}

PKCS11HSMSignatureManager implements the DigitalSignatureManager interface.

func ProvidePKCS11HSMSignatureManager

func ProvidePKCS11HSMSignatureManager(options PKCS11HSMSignatureManagerOptions) (*PKCS11HSMSignatureManager, error)

ProvidePKCS11HSMSignatureManager creates a new instance of PKCS11HSMSignatureManager using the provided options, returning an error if it fails.

func (*PKCS11HSMSignatureManager) Close

func (s *PKCS11HSMSignatureManager) Close(_ context.Context, _ signaturemanager.CloseInput) (*signaturemanager.CloseOutput, error)

func (*PKCS11HSMSignatureManager) GenerateKey

func (s *PKCS11HSMSignatureManager) GenerateKey(_ context.Context, input signaturemanager.GenerateKeyInput) (*signaturemanager.GenerateKeyOutput, error)

func (*PKCS11HSMSignatureManager) IsAlive

func (s *PKCS11HSMSignatureManager) IsAlive(_ context.Context, input signaturemanager.IsAliveInput) (*signaturemanager.IsAliveOutput, error)

func (*PKCS11HSMSignatureManager) ListKeys

func (s *PKCS11HSMSignatureManager) ListKeys(_ context.Context, input signaturemanager.ListKeysInput) (*signaturemanager.ListKeysOutput, error)

func (*PKCS11HSMSignatureManager) Open

func (s *PKCS11HSMSignatureManager) Open(_ context.Context, _ signaturemanager.OpenInput) (*signaturemanager.OpenOutput, error)

func (*PKCS11HSMSignatureManager) RemoveKey

func (s *PKCS11HSMSignatureManager) RemoveKey(_ context.Context, input signaturemanager.RemoveKeyInput) (*signaturemanager.RemoveKeyOutput, error)

func (*PKCS11HSMSignatureManager) Sign

func (s *PKCS11HSMSignatureManager) Sign(ctx context.Context, input signaturemanager.SignInput) (*signaturemanager.SignOutput, error)

type PKCS11HSMSignatureManagerOptions

type PKCS11HSMSignatureManagerOptions struct {
	PkcsContext *pkcs11.Ctx
}

PKCS11HSMSignatureManagerOptions defines options to create a new instance of PKCS11HSMSignatureManager.