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 (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)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateOptions ¶ added in v0.0.5
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 ¶ added in v0.0.2
New takes a Proxy service from options and a validation function. Function returns an error if options fail to validate.
func (*Proxy) Callback ¶ added in v0.5.0
Callback handles the result of a successful call to the authenticate service and is responsible setting per-route sessions.
func (*Proxy) OnConfigChange ¶ added in v0.11.0
OnConfigChange updates internal structures based on config.Options
func (*Proxy) ProgrammaticLogin ¶ added in v0.5.0
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 ¶ added in v0.6.0
func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)
func (*Proxy) SignOut ¶
func (p *Proxy) SignOut(w http.ResponseWriter, r *http.Request)
SignOut clears the local session and redirects the request to the sign out url. It's the responsibility of the authenticate service to revoke the remote session and clear the authenticate service's session state.