scepserver

Documentation

Index

• func DecodeSCEPResponse(ctx context.Context, r *http.Response) (interface{}, error)
• func EncodeSCEPRequest(ctx context.Context, r *http.Request, request interface{}) error
• func EndpointLoggingMiddleware(logger log.Logger) endpoint.Middleware
• func MakeHTTPHandler(e *Endpoints, svc Service, logger kitlog.Logger) http.Handler
• func MakeSCEPEndpoint(svc Service) endpoint.Endpoint
• type Endpoints
  • func MakeClientEndpoints(instance string) (*Endpoints, error)
  • func MakeServerEndpoints(svc Service) *Endpoints
  • func (e *Endpoints) GetCACaps(ctx context.Context) ([]byte, error)
  • func (e *Endpoints) GetCACert(ctx context.Context) ([]byte, int, error)
  • func (e *Endpoints) GetNextCACert(ctx context.Context) ([]byte, error)
  • func (e *Endpoints) PKIOperation(ctx context.Context, msg []byte) ([]byte, error)
  • func (e *Endpoints) Supports(cap string) bool
• type SCEPRequest
• type SCEPResponse
• type Service
  • func NewLoggingService(logger log.Logger, s Service) Service
  • func NewService(depot depot.Depot, opts ...ServiceOption) (Service, error)
• type ServiceOption
  • func AllowRenewal(duration int) ServiceOption
  • func CAKeyPassword(pw []byte) ServiceOption
  • func ChallengePassword(pw string) ServiceOption
  • func ClientValidity(duration int) ServiceOption
  • func WithCSRVerifier(csrVerifier csrverifier.CSRVerifier) ServiceOption
  • func WithDynamicChallenges(cache challenge.Store) ServiceOption
  • func WithLogger(logger log.Logger) ServiceOption

Functions

func DecodeSCEPResponse

func DecodeSCEPResponse(ctx context.Context, r *http.Response) (interface{}, error)

DecodeSCEPResponse decodes a SCEP response

func EncodeSCEPRequest

func EncodeSCEPRequest(ctx context.Context, r *http.Request, request interface{}) error

EncodeSCEPRequest encodes a SCEP HTTP Request. Used by the client.

func EndpointLoggingMiddleware

func EndpointLoggingMiddleware(logger log.Logger) endpoint.Middleware

EndpointLoggingMiddleware returns an endpoint middleware that logs the duration of each invocation, and the resulting error, if any.

func MakeHTTPHandler

func MakeHTTPHandler(e *Endpoints, svc Service, logger kitlog.Logger) http.Handler

func MakeSCEPEndpoint

func MakeSCEPEndpoint(svc Service) endpoint.Endpoint

Types

type Endpoints

type Endpoints struct {
	GetEndpoint  endpoint.Endpoint
	PostEndpoint endpoint.Endpoint
	// contains filtered or unexported fields
}

func MakeClientEndpoints

func MakeClientEndpoints(instance string) (*Endpoints, error)

MakeClientEndpoints returns an Endpoints struct where each endpoint invokes the corresponding method on the remote instance, via a transport/http.Client. Useful in a SCEP client.

func MakeServerEndpoints

func MakeServerEndpoints(svc Service) *Endpoints

func (*Endpoints) GetCACaps

func (e *Endpoints) GetCACaps(ctx context.Context) ([]byte, error)

func (*Endpoints) GetCACert

func (e *Endpoints) GetCACert(ctx context.Context) ([]byte, int, error)

func (*Endpoints) GetNextCACert

func (e *Endpoints) GetNextCACert(ctx context.Context) ([]byte, error)

func (*Endpoints) PKIOperation

func (e *Endpoints) PKIOperation(ctx context.Context, msg []byte) ([]byte, error)

func (*Endpoints) Supports

func (e *Endpoints) Supports(cap string) bool

type SCEPRequest

type SCEPRequest struct {
	Operation string
	Message   []byte
}

SCEPRequest is a SCEP server request.

type SCEPResponse

type SCEPResponse struct {
	CACertNum int
	Data      []byte
	Err       error
	// contains filtered or unexported fields
}

SCEPResponse is a SCEP server response. Business errors will be encoded as a CertRep message with pkiStatus FAILURE and a failInfo attribute.

type Service

type Service interface {
	// GetCACaps returns a list of options
	// which are supported by the server.
	GetCACaps(ctx context.Context) ([]byte, error)

	// GetCACert returns CA certificate or
	// a CA certificate chain with intermediates
	// in a PKCS#7 Degenerate Certificates format
	GetCACert(ctx context.Context) ([]byte, int, error)

	// PKIOperation handles incoming SCEP messages such as PKCSReq and
	// sends back a CertRep PKIMessag.
	PKIOperation(ctx context.Context, msg []byte) ([]byte, error)

	// GetNextCACert returns a replacement certificate or certificate chain
	// when the old one expires. The response format is a PKCS#7 Degenerate
	// Certificates type.
	GetNextCACert(ctx context.Context) ([]byte, error)
}

Service is the interface for all supported SCEP server operations.

func NewLoggingService

func NewLoggingService(logger log.Logger, s Service) Service

NewLoggingService creates adds logging to the SCEP service

func NewService

func NewService(depot depot.Depot, opts ...ServiceOption) (Service, error)

NewService creates a new scep service

type ServiceOption

type ServiceOption func(*service) error

ServiceOption is a server configuration option

func AllowRenewal

func AllowRenewal(duration int) ServiceOption

allowRenewal sets the days before expiry which we are allowed to renew (optional)

func CAKeyPassword

func CAKeyPassword(pw []byte) ServiceOption

CAKeyPassword is an optional argument to NewService for specifying the CA private key password.

func ChallengePassword

func ChallengePassword(pw string) ServiceOption

ChallengePassword is an optional argument to NewService which allows setting a preshared key for SCEP.

func ClientValidity

func ClientValidity(duration int) ServiceOption

ClientValidity sets the validity of signed client certs in days (optional parameter)

func WithCSRVerifier

func WithCSRVerifier(csrVerifier csrverifier.CSRVerifier) ServiceOption

WithCSRVerifier is an option argument to NewService which allows setting a CSR verifier.

func WithDynamicChallenges

func WithDynamicChallenges(cache challenge.Store) ServiceOption

func WithLogger

func WithLogger(logger log.Logger) ServiceOption

WithLogger configures a logger for the SCEP Service. By default, a no-op logger is used.