...

Package restapi

import "github.com/sigstore/timestamp-authority/pkg/generated/restapi"
Overview
Index
Subdirectories

Overview ▾

Package restapi Timestamp Authority

Timestamp Authority provides an RFC3161 timestamp authority.
Schemes:
  http
Host: timestamp.sigstore.dev
BasePath: /
Version: 0.0.1

Consumes:
  - application/timestamp-query
  - application/json

Produces:
  - application/pem-certificate-chain
  - application/timestamp-reply

swagger:meta

Variables

var (
    // SwaggerJSON embedded version of the swagger document used at generation time
    SwaggerJSON json.RawMessage
    // FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
    FlatSwaggerJSON json.RawMessage
)

type Server

Server for the timestamp server API

type Server struct {
    EnabledListeners []string
    CleanupTimeout   time.Duration
    GracefulTimeout  time.Duration
    MaxHeaderSize    flagext.ByteSize

    SocketPath string

    Host         string
    Port         int
    ListenLimit  int
    KeepAlive    time.Duration
    ReadTimeout  time.Duration
    WriteTimeout time.Duration

    TLSHost           string
    TLSPort           int
    TLSCertificate    string
    TLSCertificateKey string
    TLSCACertificate  string
    TLSListenLimit    int
    TLSKeepAlive      time.Duration
    TLSReadTimeout    time.Duration
    TLSWriteTimeout   time.Duration
    // contains filtered or unexported fields
}

func NewServer

func NewServer(api *operations.TimestampServerAPI) *Server

NewServer creates a new api timestamp server server but does not configure it

func (*Server) ConfigureAPI

func (s *Server) ConfigureAPI()

ConfigureAPI configures the API and handlers.

func (*Server) ConfigureFlags

func (s *Server) ConfigureFlags()

ConfigureFlags configures the additional flags defined by the handlers. Needs to be called before the parser.Parse

func (*Server) Fatalf

func (s *Server) Fatalf(f string, args ...interface{})

Fatalf logs message either via defined user logger or via system one if no user logger is defined. Exits with non-zero status after printing

func (*Server) GetHandler

func (s *Server) GetHandler() http.Handler

GetHandler returns a handler useful for testing

func (*Server) HTTPListener

func (s *Server) HTTPListener() (net.Listener, error)

HTTPListener returns the http listener

func (*Server) Listen

func (s *Server) Listen() error

Listen creates the listeners for the server

func (*Server) Logf

func (s *Server) Logf(f string, args ...interface{})

Logf logs message either via defined user logger or via system one if no user logger is defined.

func (*Server) Serve

func (s *Server) Serve() (err error)

Serve the api

func (*Server) SetAPI

func (s *Server) SetAPI(api *operations.TimestampServerAPI)

SetAPI configures the server with the specified API. Needs to be called before Serve

func (*Server) SetHandler

func (s *Server) SetHandler(handler http.Handler)

SetHandler allows for setting a http handler on this server

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown server and clean up resources

func (*Server) TLSListener

func (s *Server) TLSListener() (net.Listener, error)

TLSListener returns the https listener

func (*Server) UnixListener

func (s *Server) UnixListener() (net.Listener, error)

UnixListener returns the domain socket listener

Subdirectories

Name Synopsis
..
operations
timestamp