identity

Documentation

Index

• type Certificate
  • func NewCertificate(cert *ftlv1.Certificate) (Certificate, error)
  • func (c Certificate) String() string
• type CertificateData
  • func (c CertificateData) String() string
• type CertifiedSignedData
  • func (c CertifiedSignedData) String() string
  • func (c CertifiedSignedData) Verify(caVerifier Verifier) (Identity, []byte, error)
• type Controller
  • func NewController() Controller
  • func (c Controller) String() string
• type Identity
  • func Parse(s string) (Identity, error)
• type KeyPair
  • func GenerateKeyPair() (KeyPair, error)
  • func NewKeyPair(handle keyset.Handle) KeyPair
  • func (t KeyPair) Handle() keyset.Handle
  • func (t KeyPair) Public() (PublicKey, error)
  • func (t KeyPair) Signer() (Signer, error)
  • func (t KeyPair) Verifier() (Verifier, error)
• type PublicKey
  • func NewPublicKey(b []byte) PublicKey
  • func (pk PublicKey) Decode(ctx *kong.DecodeContext) error
• type Runner
  • func NewRunner(key model.RunnerKey, module string) Runner
  • func (r Runner) String() string
• type SignedData
  • func NewSignedData(verifier Verifier, data, signature []byte) (SignedData, error)
• type Signer
  • func (k Signer) Public() (PublicKey, error)
  • func (k Signer) Sign(data []byte) (SignedData, error)
• type Store
  • func NewStoreNewKeys(identity Identity) (*Store, error)
  • func (s *Store) CertifiedSign(data []byte) (CertifiedSignedData, error)
  • func (s *Store) NewGetCertificateRequest() (v1.GetCertificationRequest, error)
  • func (s *Store) SetCertificate(cert Certificate, controllerVerifier Verifier) error
  • func (s *Store) SignCertificateRequest(req *v1.GetCertificationRequest) (Certificate, error)
• type Verifier
  • func NewVerifier(publicKey PublicKey) (Verifier, error)
  • func (k Verifier) Verify(signedData SignedData) ([]byte, error)

Types

type Certificate

type Certificate struct {
	SignedData
}

func NewCertificate

func NewCertificate(cert *ftlv1.Certificate) (Certificate, error)

func (Certificate) String

func (c Certificate) String() string

type CertificateData

type CertificateData struct {
	ID            Identity
	NodePublicKey PublicKey
}

func (CertificateData) String

func (c CertificateData) String() string

type CertifiedSignedData

type CertifiedSignedData struct {
	Certificate Certificate
	SignedData  SignedData
}

CertifiedSignedData is sent by a node and proves identity based on a certificate.

func (CertifiedSignedData) String

func (c CertifiedSignedData) String() string

func (CertifiedSignedData) Verify

func (c CertifiedSignedData) Verify(caVerifier Verifier) (Identity, []byte, error)

Verify against the CA and then the node certificate. Only return the data if both are valid.

type Controller

type Controller struct{}

func NewController

func NewController() Controller

func (Controller) String

func (c Controller) String() string

type Identity

type Identity interface {
	String() string
}

func Parse

func Parse(s string) (Identity, error)

type KeyPair

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

func GenerateKeyPair

func GenerateKeyPair() (KeyPair, error)

GenerateKeyPair creates a new key pair using Tink's ED25519 key template

func NewKeyPair

func NewKeyPair(handle keyset.Handle) KeyPair

func (KeyPair) Handle

func (t KeyPair) Handle() keyset.Handle

func (KeyPair) Public

func (t KeyPair) Public() (PublicKey, error)

func (KeyPair) Signer

func (t KeyPair) Signer() (Signer, error)

func (KeyPair) Verifier

func (t KeyPair) Verifier() (Verifier, error)

type PublicKey

type PublicKey struct {
	Bytes []byte
}

func NewPublicKey

func NewPublicKey(b []byte) PublicKey

func (PublicKey) Decode

func (pk PublicKey) Decode(ctx *kong.DecodeContext) error

type Runner

type Runner struct {
	Key    model.RunnerKey
	Module string
}

Runner identity TODO: Maybe use KeyType[T any, TP keyPayloadConstraint[T]]?

func NewRunner

func NewRunner(key model.RunnerKey, module string) Runner

func (Runner) String

func (r Runner) String() string

type SignedData

type SignedData struct {
	Signature []byte
	// contains filtered or unexported fields
}

func NewSignedData

func NewSignedData(verifier Verifier, data, signature []byte) (SignedData, error)

NewSignedData ensures that the data is signed correctly.

type Signer

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

func (Signer) Public

func (k Signer) Public() (PublicKey, error)

func (Signer) Sign

func (k Signer) Sign(data []byte) (SignedData, error)

type Store

type Store struct {
	Identity           Identity
	KeyPair            KeyPair
	Signer             Signer
	Certificate        optional.Option[Certificate]
	ControllerVerifier optional.Option[Verifier]
}

Store is held by a node and contains the node's identity, key pair, signer, and certificate.

func NewStoreNewKeys

func NewStoreNewKeys(identity Identity) (*Store, error)

func (*Store) CertifiedSign

func (s *Store) CertifiedSign(data []byte) (CertifiedSignedData, error)

func (*Store) NewGetCertificateRequest

func (s *Store) NewGetCertificateRequest() (v1.GetCertificationRequest, error)

func (*Store) SetCertificate

func (s *Store) SetCertificate(cert Certificate, controllerVerifier Verifier) error

func (*Store) SignCertificateRequest

func (s *Store) SignCertificateRequest(req *v1.GetCertificationRequest) (Certificate, error)

type Verifier

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

func NewVerifier

func NewVerifier(publicKey PublicKey) (Verifier, error)

func (Verifier) Verify

func (k Verifier) Verify(signedData SignedData) ([]byte, error)