server

Documentation

Overview

Package server provides an http.Handler implementation that includes the Heroku Platform API compatibility layer, GitHub Deployments integration and a simple health check.

Index

• Variables
• type HealthHandler
  • func NewHealthHandler(e *empire.Empire) *HealthHandler
  • func (h *HealthHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Options
• type Server
  • func New(e *empire.Empire, options Options) *Server
  • func (s *Server) Handler(r *http.Request) http.Handler
  • func (s *Server) SAMLACS(w http.ResponseWriter, r *http.Request)
  • func (s *Server) SAMLLogin(w http.ResponseWriter, r *http.Request)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var (
	DefaultOptions = Options{}
)

Types

type HealthHandler

type HealthHandler struct {
	// A function that returns true if empire is healthy.
	IsHealthy func() error
}

HealthHandler is an http.Handler that returns the health of empire.

func NewHealthHandler

func NewHealthHandler(e *empire.Empire) *HealthHandler

NewHealthHandler returns a new HealthHandler using the IsHealthy method from an Empire instance.

func (*HealthHandler) ServeHTTP

func (h *HealthHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Options

type Options struct {
	GitHub struct {
		// Deployments
		Webhooks struct {
			Secret string
		}
		Deployments struct {
			Environments []string
			ImageBuilder github.ImageBuilder
			TugboatURL   string
		}
	}
}

type Server

type Server struct {
	// Base host for the server.
	URL *url.URL

	// The underlying Heroku http.Handler.
	Heroku *heroku.Server

	GitHubWebhooks http.Handler

	Health *HealthHandler

	// If provided, enables the SAML integration.
	ServiceProvider *saml.ServiceProvider
}

Server composes the Heroku API compatibility layer, the GitHub Webhooks handlers and a health check as a single http.Handler.

func New

func New(e *empire.Empire, options Options) *Server

func (*Server) Handler

func (s *Server) Handler(r *http.Request) http.Handler

func (*Server) SAMLACS

func (s *Server) SAMLACS(w http.ResponseWriter, r *http.Request)

SAMLACS handles the SAML Response call. It will validate the SAML Response and assertions, generate an API token, then present the token to the user.

func (*Server) SAMLLogin

func (s *Server) SAMLLogin(w http.ResponseWriter, r *http.Request)

SAMLLogin starts a Service Provider initiated login. It generates an AuthnRequest, signs the generated id and stores it in a cookie, then starts the login with the IdP.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)