proxy

Documentation

Overview

Package proxy is a pomerium service that provides reverse proxying of internal routes. The proxy packages interoperates with other pomerium services over RPC in order to make access control decisions about a given incoming request.

Index

• func ValidateOptions(o *config.Options) error
• type Proxy
  • func New(cfg *config.Config) (*Proxy, error)
  • func (p *Proxy) Callback(w http.ResponseWriter, r *http.Request) error
  • func (p *Proxy) OnConfigChange(cfg *config.Config)
  • func (p *Proxy) ProgrammaticLogin(w http.ResponseWriter, r *http.Request) error
  • func (p *Proxy) RobotsTxt(w http.ResponseWriter, _ *http.Request)
  • func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (p *Proxy) SignOut(w http.ResponseWriter, r *http.Request)
  • func (p *Proxy) UserDashboard(w http.ResponseWriter, r *http.Request)

Functions

func ValidateOptions

func ValidateOptions(o *config.Options) error

ValidateOptions checks that proper configuration settings are set to create a proper Proxy instance

Types

type Proxy

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

Proxy stores all the information associated with proxying a request.

func New

func New(cfg *config.Config) (*Proxy, error)

New takes a Proxy service from options and a validation function. Function returns an error if options fail to validate.

func (*Proxy) Callback

func (p *Proxy) Callback(w http.ResponseWriter, r *http.Request) error

Callback handles the result of a successful call to the authenticate service and is responsible setting returned per-route session.

func (*Proxy) OnConfigChange

func (p *Proxy) OnConfigChange(cfg *config.Config)

OnConfigChange updates internal structures based on config.Options

func (*Proxy) ProgrammaticLogin

func (p *Proxy) ProgrammaticLogin(w http.ResponseWriter, r *http.Request) error

ProgrammaticLogin returns a signed url that can be used to login using the authenticate service.

func (*Proxy) RobotsTxt

func (p *Proxy) RobotsTxt(w http.ResponseWriter, _ *http.Request)

RobotsTxt sets the User-Agent header in the response to be "Disallow"

func (*Proxy) ServeHTTP

func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Proxy) SignOut

func (p *Proxy) SignOut(w http.ResponseWriter, r *http.Request)

SignOut redirects the request to the sign out url. It's the responsibility of the authenticate service to revoke the remote session and clear the local session state.

func (*Proxy) UserDashboard

func (p *Proxy) UserDashboard(w http.ResponseWriter, r *http.Request)

UserDashboard redirects to the authenticate dashboard.