client

Documentation

Overview

Package client is a cross-platform client for the signer binary (a.k.a."EnterpriseCertSigner").

The signer binary is OS-specific, but exposes a standard set of APIs for the client to use.

Index

• Variables
• type Connection
  • func (c *Connection) Close() error
• type Key
  • func Cred(configFilePath string) (*Key, error)
  • func (k *Key) CertificateChain() [][]byte
  • func (k *Key) Close() error
  • func (k *Key) Public() crypto.PublicKey
  • func (k *Key) Sign(_ io.Reader, digest []byte, opts crypto.SignerOpts) (signed []byte, err error)
• type SignArgs

Variables

var ErrCredUnavailable = errors.New("Cred is unavailable")

ErrCredUnavailable is a sentinel error that indicates ECP Cred is unavailable, possibly due to missing config or missing binary path.

Types

type Connection

type Connection struct {
	io.ReadCloser
	io.WriteCloser
}

A Connection wraps a pair of unidirectional streams as an io.ReadWriteCloser.

func (*Connection) Close

func (c *Connection) Close() error

Close closes c's underlying ReadCloser and WriteCloser.

type Key

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

Key implements credential.Credential by holding the executed signer subprocess.

func Cred

func Cred(configFilePath string) (*Key, error)

Cred spawns a signer subprocess that listens on stdin/stdout to perform certificate related operations, including signing messages with the private key.

The signer binary path is read from the specified configFilePath, if provided. Otherwise, use the default config file path.

The config file also specifies which certificate the signer should use.

func (*Key) CertificateChain

func (k *Key) CertificateChain() [][]byte

CertificateChain returns the credential as a raw X509 cert chain. This contains the public key.

func (*Key) Close

func (k *Key) Close() error

Close closes the RPC connection and kills the signer subprocess. Call this to free up resources when the Key object is no longer needed.

func (*Key) Public

func (k *Key) Public() crypto.PublicKey

Public returns the public key for this Key.

func (*Key) Sign

func (k *Key) Sign(_ io.Reader, digest []byte, opts crypto.SignerOpts) (signed []byte, err error)

Sign signs a message digest, using the specified signer options.

type SignArgs

type SignArgs struct {
	Digest []byte            // The content to sign.
	Opts   crypto.SignerOpts // Options for signing, such as Hash identifier.
}

SignArgs contains arguments to a crypto Signer.Sign method.