pki

Documentation

Index

• Constants
• Variables
• func Backend(conf *logical.BackendConfig) *backend
• func CBDelete(b *backend, s logical.Storage, path string) (*logical.Response, error)
• func CBList(b *backend, s logical.Storage, path string) (*logical.Response, error)
• func CBPatch(b *backend, s logical.Storage, path string, data map[string]interface{}) (*logical.Response, error)
• func CBRead(b *backend, s logical.Storage, path string) (*logical.Response, error)
• func CBReq(b *backend, s logical.Storage, operation logical.Operation, path string, ...) (*logical.Response, error)
• func CBWrite(b *backend, s logical.Storage, path string, data map[string]interface{}) (*logical.Response, error)
• func CreateBackendWithStorage(t testing.TB) (*backend, logical.Storage)
• func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)
• func NewIssuerUsageFromNames(names []string) (issuerUsage, error)
• type IfModifiedSinceHelper
• type NameKey
  • func (n NameKey) String() string
• type UUIDKey
  • func (u UUIDKey) String() string

Constants

const (
	IssuerRefNotFound = issuerID("not-found")
	KeyRefNotFound    = keyID("not-found")
)

const (
	ReadOnlyUsage    issuerUsage = iota
	IssuanceUsage    issuerUsage = 1 << iota
	CRLSigningUsage  issuerUsage = 1 << iota
	OCSPSigningUsage issuerUsage = 1 << iota

	// When adding a new usage in the future, we'll need to create a usage
	// mask field on the IssuerEntry and handle migrations to a newer mask,
	// inferring a value for the new bits.
	AllIssuerUsages = ReadOnlyUsage | IssuanceUsage | CRLSigningUsage | OCSPSigningUsage
)

const SecretCertsType = "pki"

SecretCertsType is the name used to identify this type

Variables

var (
	OcspUnauthorizedResponse = &logical.Response{
		Data: map[string]interface{}{
			logical.HTTPContentType: ocspResponseContentType,
			logical.HTTPStatusCode:  http.StatusUnauthorized,
			logical.HTTPRawBody:     ocsp.UnauthorizedErrorResponse,
		},
	}
	OcspMalformedResponse = &logical.Response{
		Data: map[string]interface{}{
			logical.HTTPContentType: ocspResponseContentType,
			logical.HTTPStatusCode:  http.StatusBadRequest,
			logical.HTTPRawBody:     ocsp.MalformedRequestErrorResponse,
		},
	}
	OcspInternalErrorResponse = &logical.Response{
		Data: map[string]interface{}{
			logical.HTTPContentType: ocspResponseContentType,
			logical.HTTPStatusCode:  http.StatusInternalServerError,
			logical.HTTPRawBody:     ocsp.InternalErrorErrorResponse,
		},
	}

	ErrMissingOcspUsage = errors.New("issuer entry did not have the OCSPSigning usage")
	ErrIssuerHasNoKey   = errors.New("issuer has no key")
	ErrUnknownIssuer    = errors.New("unknown issuer")
)

These response variables should not be mutated, instead treat them as constants

Functions

func Backend

func Backend(conf *logical.BackendConfig) *backend

Backend returns a new Backend framework struct

func CBDelete

func CBDelete(b *backend, s logical.Storage, path string) (*logical.Response, error)

func CBList

func CBList(b *backend, s logical.Storage, path string) (*logical.Response, error)

func CBPatch

func CBPatch(b *backend, s logical.Storage, path string, data map[string]interface{}) (*logical.Response, error)

func CBRead

func CBRead(b *backend, s logical.Storage, path string) (*logical.Response, error)

func CBReq

func CBReq(b *backend, s logical.Storage, operation logical.Operation, path string, data map[string]interface{}) (*logical.Response, error)

Direct storage backend helpers (b, s := createBackendWithStorage(t)) which are mostly compatible with client.Logical() operations. The main difference is that the JSON round-tripping hasn't occurred, so values are as the backend returns them (e.g., []string instead of []interface{}).

func CBWrite

func CBWrite(b *backend, s logical.Storage, path string, data map[string]interface{}) (*logical.Response, error)

func CreateBackendWithStorage

func CreateBackendWithStorage(t testing.TB) (*backend, logical.Storage)

Setup helpers

func Factory

func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Factory creates a new backend implementing the logical.Backend interface

func NewIssuerUsageFromNames

func NewIssuerUsageFromNames(names []string) (issuerUsage, error)

Types

type IfModifiedSinceHelper

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

type NameKey

type NameKey string

func (NameKey) String

func (n NameKey) String() string

type UUIDKey

type UUIDKey string

func (UUIDKey) String

func (u UUIDKey) String() string