awssigner

Documentation

Overview

Package awssigner contains a new signer that uses aws-kms as an hsm

Index

• func NewKmsSigner(ctx context.Context, awsRegion, awsAccessKey, awsSecretAccessKey, keyID string) (_ signer.Signer, err error)
• type PubKeyData
• type Signer
  • func (signingHandler *Signer) Address() common.Address
  • func (signingHandler *Signer) Equals(o libp2p.Key) bool
  • func (signingHandler *Signer) GetPublic() libp2p.PubKey
  • func (signingHandler *Signer) GetTransactor(ctx context.Context, chainID *big.Int) (*bind.TransactOpts, error)
  • func (signingHandler *Signer) PrivKey() libp2p.PrivKey
  • func (signingHandler *Signer) Raw() ([]byte, error)
  • func (signingHandler *Signer) Sign(bytes []byte) ([]byte, error)
  • func (signingHandler *Signer) SignMessage(ctx context.Context, message []byte, hash bool) (signer.Signature, error)
  • func (signingHandler *Signer) Type() pb.KeyType
  • func (signingHandler *Signer) UnsafeMakePublicKeyData(ctx context.Context) (*PubKeyData, error)
  • func (signingHandler *Signer) UnsafeSetKeyID(keyID string)
  • func (signingHandler *Signer) UnsafeSetPubKeyData(pubKeyData *PubKeyData)
• type UnsafeSigner
  • func MakeUnsafeSigner(client *kms.Client) UnsafeSigner

Functions

func NewKmsSigner

func NewKmsSigner(ctx context.Context, awsRegion, awsAccessKey, awsSecretAccessKey, keyID string) (_ signer.Signer, err error)

NewKmsSigner creates a kms handler.

Types

type PubKeyData

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

PubKeyData is the public key data.

type Signer

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

Signer is an aws signer.

func (*Signer) Address

func (signingHandler *Signer) Address() common.Address

Address gets the address of the signing group.

func (*Signer) Equals

func (signingHandler *Signer) Equals(o libp2p.Key) bool

Equals assumes we're using *libp2p.Secp256k1PublicKey type for o.

func (*Signer) GetPublic

func (signingHandler *Signer) GetPublic() libp2p.PubKey

GetPublic gets the libp2p public key.

func (*Signer) GetTransactor

func (signingHandler *Signer) GetTransactor(ctx context.Context, chainID *big.Int) (*bind.TransactOpts, error)

GetTransactor creates a kms transactor.

func (*Signer) PrivKey

func (signingHandler *Signer) PrivKey() libp2p.PrivKey

PrivKey returns the private key bytes.

func (*Signer) Raw

func (signingHandler *Signer) Raw() ([]byte, error)

Raw returns the raw bytes of the public key.

func (*Signer) Sign

func (signingHandler *Signer) Sign(bytes []byte) ([]byte, error)

Sign signs the bytes.

func (*Signer) SignMessage

func (signingHandler *Signer) SignMessage(ctx context.Context, message []byte, hash bool) (signer.Signature, error)

SignMessage signs a hashed message.

func (*Signer) Type

func (signingHandler *Signer) Type() pb.KeyType

Type returns the key type.

func (*Signer) UnsafeMakePublicKeyData

func (signingHandler *Signer) UnsafeMakePublicKeyData(ctx context.Context) (*PubKeyData, error)

UnsafeMakePublicKeyData creates the public key data.

func (*Signer) UnsafeSetKeyID

func (signingHandler *Signer) UnsafeSetKeyID(keyID string)

UnsafeSetKeyID sets the key id.

func (*Signer) UnsafeSetPubKeyData

func (signingHandler *Signer) UnsafeSetPubKeyData(pubKeyData *PubKeyData)

UnsafeSetPubKeyData sets the public key data.

type UnsafeSigner

type UnsafeSigner interface {
	signer.Signer
	// UnsafeSetKeyID sets the key id.
	UnsafeSetKeyID(keyID string)
	// UnsafeSetPubKeyData sets the public key data.
	UnsafeSetPubKeyData(pubKeyData *PubKeyData)
	// UnsafeMakePublicKeyData creates the public key data.
	UnsafeMakePublicKeyData(ctx context.Context) (*PubKeyData, error)
}

UnsafeSigner is an unsafe signer.

func MakeUnsafeSigner

func MakeUnsafeSigner(client *kms.Client) UnsafeSigner

MakeUnsafeSigner creates a new unsafe signer.

/ this is only to be used for testing. It should not be used in production code under any circumstances.