xhttp

Documentation

Index

• func AuthIsBearer(authType string) bool
• func ExtractAuthorizationInfo(r *http.Request, header string) (authType string, authInfo string)
• func ExtractTokenFromRequest(r *http.Request) (string, bool)
• func JSONResponse(w http.ResponseWriter, closure func() (interface{}, error))
• func WriteData(w http.ResponseWriter, data []byte)
• func WriteJsonError(w http.ResponseWriter, err error)
• type CertMaster
  • func NewCertMaster(opts *CertMasterOpts) (*CertMaster, error)
  • func (m *CertMaster) GetCertificate(h *tls.ClientHelloInfo) (*tls.Certificate, error)
  • func (m *CertMaster) Running() bool
  • func (m *CertMaster) Shutdown() error
• type CertMasterOpts
• type DomainConfig
  • func (c *DomainConfig) Validate() error
• type Issuer
  • func NewIssuer(opts *IssuerOpts) (*Issuer, error)
  • func (is *Issuer) GetCertificate(domain string) *tls.Certificate
  • func (is *Issuer) Shutdown()
• type IssuerOpts
• type Middleware
• type Option
  • func WithCORS() Option
  • func WithDisableHTTPv2() Option
  • func WithLogger() Option
  • func WithMetrics() Option
  • func WithMiddleware(mw Middleware) Option
  • func WithSSL(cfg *tls.Config) Option
• type SSLConfig
• type Server
  • func New(opts ...Option) *Server
  • func NewDefault() *Server
  • func NewDefaultSSL(cfg *tls.Config) *Server
  • func NewRedirectToSSL(primaryHost string) *Server
  • func (w *Server) Router() chi.Router
  • func (w *Server) Run(addr string) error
  • func (w *Server) Running() bool
  • func (w *Server) Shutdown() error

Functions

func AuthIsBearer

func AuthIsBearer(authType string) bool

func ExtractAuthorizationInfo

func ExtractAuthorizationInfo(r *http.Request, header string) (authType string, authInfo string)

func ExtractTokenFromRequest

func ExtractTokenFromRequest(r *http.Request) (string, bool)

func JSONResponse

func JSONResponse(w http.ResponseWriter, closure func() (interface{}, error))

JSONResponse calls the closure and respond with data or error. If no error, but the interface is nil it will write "OK" to the response writer.

func WriteData

func WriteData(w http.ResponseWriter, data []byte)

func WriteJsonError

func WriteJsonError(w http.ResponseWriter, err error)

Types

type CertMaster

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

func NewCertMaster

func NewCertMaster(opts *CertMasterOpts) (*CertMaster, error)

func (*CertMaster) GetCertificate

func (m *CertMaster) GetCertificate(h *tls.ClientHelloInfo) (*tls.Certificate, error)

func (*CertMaster) Running

func (m *CertMaster) Running() bool

func (*CertMaster) Shutdown

func (m *CertMaster) Shutdown() error

type CertMasterOpts

type CertMasterOpts struct {
	Email        string
	CacheDir     string
	NonSSLRouter chi.Router
	Domains      []string
}

type DomainConfig

type DomainConfig struct {
	Mode        string   `yaml:"mode" valid:"required"`
	PrimaryName string   `yaml:"name" valid:"dns,required"`
	ExtraNames  []string `yaml:"extra_names,omitempty" valid:"dns"`
	IssueSSL    bool     `yaml:"issue_ssl,omitempty"`
	Schema      string   `yaml:"schema,omitempty"`
	Email       string   `yaml:"email,omitempty" valid:"email"`

	// Dir to store cached certificates, use sub-directory of cfgDir if possible.
	Dir string `yaml:"dir,omitempty" valid:"path"`
}

DomainConfig is the YAML version of the `adminAPI.DomainConfig` struct.

func (*DomainConfig) Validate

func (c *DomainConfig) Validate() error

type Issuer

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

Issuer should be named like certManager

func NewIssuer

func NewIssuer(opts *IssuerOpts) (*Issuer, error)

func (*Issuer) GetCertificate

func (is *Issuer) GetCertificate(domain string) *tls.Certificate

func (*Issuer) Shutdown

func (is *Issuer) Shutdown()

type IssuerOpts

type IssuerOpts struct {
	Domain       string
	CacheDir     string
	Email        string
	NonSSLRouter chi.Router
}

type Middleware

type Middleware = func(http.Handler) http.Handler

type Option

type Option func(w *Server)

func WithCORS

func WithCORS() Option

func WithDisableHTTPv2

func WithDisableHTTPv2() Option

func WithLogger

func WithLogger() Option

func WithMetrics

func WithMetrics() Option

func WithMiddleware

func WithMiddleware(mw Middleware) Option

func WithSSL

func WithSSL(cfg *tls.Config) Option

type SSLConfig

type SSLConfig struct {
	// ListenAddr for HTTPS server, default: ":443"
	ListenAddr string `yaml:"listen_addr" valid:"listen_addr,required"`
}

type Server

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

func New

func New(opts ...Option) *Server

func NewDefault

func NewDefault() *Server

func NewDefaultSSL

func NewDefaultSSL(cfg *tls.Config) *Server

func NewRedirectToSSL

func NewRedirectToSSL(primaryHost string) *Server

func (*Server) Router

func (w *Server) Router() chi.Router

Router exposes chi.Router for the external registration of handlers. usage:

h.Router().Get("/apt/path", myHandler)
h.Router().Post("/apt/verb", myOtherHandler)

func (*Server) Run

func (w *Server) Run(addr string) error

Run starts the http server asynchronously.

func (*Server) Running

func (w *Server) Running() bool

func (*Server) Shutdown

func (w *Server) Shutdown() error