identity

Documentation

Overview

Package identity encapsulates the node identity.

Index

• Constants
• Variables
• func TLSCertPaths(dataDir string) (string, string)
• func TLSSentryClientCertPaths(dataDir string) (string, string)
• type Identity
  • func Load(dataDir string, signerFactory signature.SignerFactory) (*Identity, error)
  • func LoadOrGenerate(dataDir string, signerFactory signature.SignerFactory) (*Identity, error)
  • func WithTLSCertificate(cert *tls.Certificate) *Identity

Constants

const (
	// NodeKeyPubFilename is the filename of the PEM encoded node public key.
	NodeKeyPubFilename = "identity_pub.pem"

	// P2PKeyPubFilename is the filename of the PEM encoded p2p public key.
	P2PKeyPubFilename = "p2p_pub.pem"

	// ConsensusKeyPubFilename is the filename of the PEM encoded consensus
	// public key.
	ConsensusKeyPubFilename = "consensus_pub.pem"

	// VRFKeyPubFilename is the filename of the PEM encoded node VRF public key.
	VRFKeyPubFilename = "vrf_pub.pem"

	// CommonName is the CommonName to use when generating TLS certificates.
	CommonName = "oasis-node"
)

Variables

var RequiredSignerRoles = []signature.SignerRole{
	signature.SignerNode,
	signature.SignerP2P,
	signature.SignerConsensus,
	signature.SignerVRF,
}

RequiredSignerRoles is the required signer roles needed to load or provision a node identity.

Functions

func TLSCertPaths

func TLSCertPaths(dataDir string) (string, string)

TLSCertPaths returns the TLS private key and certificate paths relative to the passed data directory.

func TLSSentryClientCertPaths

func TLSSentryClientCertPaths(dataDir string) (string, string)

TLSSentryClientCertPaths returns the sentry client TLS private key and certificate paths relative to the passed data directory.

Types

type Identity

type Identity struct {
	// NodeSigner is a node identity key signer.
	NodeSigner signature.Signer
	// P2PSigner is a node P2P link key signer.
	P2PSigner signature.Signer
	// ConsensusSigner is a node consensus key signer.
	ConsensusSigner signature.Signer
	// VRFSigner is a node VRF key signer.
	VRFSigner signature.Signer

	// TLSSentryClientCertificate is the client certificate used for
	// connecting to the sentry node's control connection.  It is never rotated.
	TLSSentryClientCertificate *tls.Certificate

	// TLSSigner is a node TLS certificate signer.
	TLSSigner signature.Signer
	// TLSCertificate is a certificate that can be used for TLS.
	TLSCertificate *tls.Certificate
}

Identity is a node identity.

func Load

func Load(dataDir string, signerFactory signature.SignerFactory) (*Identity, error)

Load loads an identity.

func LoadOrGenerate

func LoadOrGenerate(dataDir string, signerFactory signature.SignerFactory) (*Identity, error)

LoadOrGenerate loads or generates an identity.

func WithTLSCertificate

func WithTLSCertificate(cert *tls.Certificate) *Identity

WithTLSCertificate creates a new identity with the specified TLS certificate, but otherwise leaves it blank.