db

Documentation

Index

• Variables
• type AuthDB
  • func New(c *Config) (AuthDB, error)
• type Config
• type DB
  • func (db *DB) IsRevoked(sn string) (bool, error)
  • func (db *DB) Revoke(rci *RevokedCertificateInfo) error
  • func (db *DB) Shutdown() error
  • func (db *DB) StoreCertificate(crt *x509.Certificate) error
  • func (db *DB) UseToken(id, tok string) (bool, error)
• type RevokedCertificateInfo
• type SimpleDB
  • func (s *SimpleDB) IsRevoked(sn string) (bool, error)
  • func (s *SimpleDB) Revoke(rci *RevokedCertificateInfo) error
  • func (s *SimpleDB) Shutdown() error
  • func (s *SimpleDB) StoreCertificate(crt *x509.Certificate) error
  • func (s *SimpleDB) UseToken(id, tok string) (bool, error)

Variables

var ErrAlreadyExists = errors.New("already exists")

ErrAlreadyExists can be returned if the DB attempts to set a key that has been previously set.

var ErrNotImplemented = errors.Errorf("not implemented")

ErrNotImplemented is an error returned when an operation is Not Implemented.

Types

type AuthDB

type AuthDB interface {
	IsRevoked(sn string) (bool, error)
	Revoke(rci *RevokedCertificateInfo) error
	StoreCertificate(crt *x509.Certificate) error
	UseToken(id, tok string) (bool, error)
	Shutdown() error
}

AuthDB is an interface over an Authority DB client that implements a nosql.DB interface.

func New

func New(c *Config) (AuthDB, error)

New returns a new database client that implements the AuthDB interface.

type Config

type Config struct {
	Type       string `json:"type"`
	DataSource string `json:"dataSource"`
	ValueDir   string `json:"valueDir,omitempty"`
	Database   string `json:"database,omitempty"`
}

Config represents the JSON attributes used for configuring a step-ca DB.

type DB

type DB struct {
	nosql.DB
	// contains filtered or unexported fields
}

DB is a wrapper over the nosql.DB interface.

func (*DB) IsRevoked

func (db *DB) IsRevoked(sn string) (bool, error)

IsRevoked returns whether or not a certificate with the given identifier has been revoked. In the case of an X509 Certificate the `id` should be the Serial Number of the Certificate.

func (*DB) Revoke

func (db *DB) Revoke(rci *RevokedCertificateInfo) error

Revoke adds a certificate to the revocation table.

func (*DB) Shutdown

func (db *DB) Shutdown() error

Shutdown sends a shutdown message to the database.

func (*DB) StoreCertificate

func (db *DB) StoreCertificate(crt *x509.Certificate) error

StoreCertificate stores a certificate PEM.

func (*DB) UseToken

func (db *DB) UseToken(id, tok string) (bool, error)

UseToken returns true if we were able to successfully store the token for for the first time, false otherwise.

type RevokedCertificateInfo

type RevokedCertificateInfo struct {
	Serial        string
	ProvisionerID string
	ReasonCode    int
	Reason        string
	RevokedAt     time.Time
	TokenID       string
	MTLS          bool
}

RevokedCertificateInfo contains information regarding the certificate revocation action.

type SimpleDB

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

SimpleDB is a barebones implementation of the DB interface. It is NOT an in memory implementation of the DB, but rather the bare minimum of functionality that the CA requires to operate securely.

func (*SimpleDB) IsRevoked

func (s *SimpleDB) IsRevoked(sn string) (bool, error)

IsRevoked noop

func (*SimpleDB) Revoke

func (s *SimpleDB) Revoke(rci *RevokedCertificateInfo) error

Revoke returns a "NotImplemented" error.

func (*SimpleDB) Shutdown

func (s *SimpleDB) Shutdown() error

Shutdown returns nil

func (*SimpleDB) StoreCertificate

func (s *SimpleDB) StoreCertificate(crt *x509.Certificate) error

StoreCertificate returns a "NotImplemented" error.

func (*SimpleDB) UseToken

func (s *SimpleDB) UseToken(id, tok string) (bool, error)

UseToken returns a "NotImplemented" error.