adapter

README

go-nginx-oauth2-adapter

a golang port for sorah/nginx_omniauth_adapter

PREREQUISITE

• nginx with ngx_http_auth_request_module, or h2o with mruby

USAGE

$ go get github.com/shogo82148/go-nginx-oauth2-adapter/cli/go-nginx-oauth2-adapter
$ go-nginx-oauth2-adapter

CONFIGURATION

The example of configuration file.

address: ":18081" # listen address

# secret tokens to authenticate/encrypt cookie.
# see http://www.gorillatoolkit.org/pkg/sessions for more detail.
# use `-genkey` option to create strong keys.
secrets:
  - new-authentication-key
  - new-encryption-key
  - old-authentication-key
  - old-encryption-key
session_name: go-nginx-oauth2-session
app_refresh_interval: 24h

# cookie settings for saving session
# the following settings are default value.
# we recommend to use this settings.
cookie:
  path: /
  domain:
  max_age: 259200 # 259200 seconds = 3 days
  secure: true
  http_only: true
  same_site: "lax" # valid values are "default", "lax", "strict", "none"

providers:
  # development: {} # For test.
  google_oauth2:
    client_id: YOUR_CLIENT_ID
    client_secret: YOUR_CLIENT_SECRET
    scopes: "openid,email,profile" # default: "openid,email,profile"
    restrictions:
      - example.com # domain of your Google App
      - specific.user@example.com

LICENSE

This software is released under the MIT License, see LICENSE.md.

SEE ALSO

• sorah/nginx_omniauth_adapter
• nginx で omniauth を利用してアクセス制御を行う(written in Japanese)

Documentation

Index

• Variables
• func LoggingHandler(h http.Handler) http.Handler
• func Main(args []string) int
• func RegisterProvider(name string, provider Provider)
• type Config
  • func NewConfig() *Config
  • func (c *Config) LoadEnv() error
  • func (c *Config) LoadYaml(filename string) error
• type CookieConfig
  • func (c *CookieConfig) Options() (*sessions.Options, error)
• type Provider
• type ProviderConfig
• type ProviderInfoContext
• type Server
  • func NewServer(config Config) (*Server, error)
  • func (s *Server) HandlerCallback(w http.ResponseWriter, r *http.Request)
  • func (s *Server) HandlerInitiate(w http.ResponseWriter, r *http.Request)
  • func (s *Server) HandlerTest(w http.ResponseWriter, r *http.Request)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var ErrForbidden = errors.New("shogo82148/go-nginx-oauth2-adapter/provider: access forbidden")

ErrForbidden is the error which the access is forbidden.

var ErrProviderConfigNotFound = errors.New("shogo82148/go-nginx-oauth2-adapter: provider configure not found")

ErrProviderConfigNotFound is the error which provider configure is not found.

Functions

func LoggingHandler

func LoggingHandler(h http.Handler) http.Handler

LoggingHandler logs HTTP requests.

func Main

func Main(args []string) int

Main starts the go-nginx-oauth2-adapter server.

func RegisterProvider

func RegisterProvider(name string, provider Provider)

RegisterProvider registers the OAuth provider.

Types

type Config

type Config struct {
	Address            string                            `yaml:"address" json:"address"`
	Secrets            []*string                         `yaml:"secrets" json:"secrets"`
	SessionName        string                            `yaml:"session_name" json:"session_name"`
	Providers          map[string]map[string]interface{} `yaml:"providers" json:"providers"`
	AppRefreshInterval string                            `yaml:"app_refresh_interval" json:"app_refresh_interval"`

	// set with -configtest option.
	ConfigTest bool `yaml:"-" json:"-"`

	// Fields are a subset of http.Cookie fields.
	Cookie *CookieConfig `yaml:"cookie" json:"cookie"`
}

Config is a configration for go-nginx-oauth2-adapter.

func NewConfig

func NewConfig() *Config

NewConfig returns a new config.

func (*Config) LoadEnv

func (c *Config) LoadEnv() error

LoadEnv loads the config from the environment values.

func (*Config) LoadYaml

func (c *Config) LoadYaml(filename string) error

LoadYaml loads the config from yaml file.

type CookieConfig

type CookieConfig struct {
	Path   string `yaml:"path" json:"path"`
	Domain string `yaml:"domain" json:"domain"`
	// MaxAge=0 means no 'Max-Age' attribute specified.
	// MaxAge<0 means delete cookie now, equivalently 'Max-Age: 0'.
	// MaxAge>0 means Max-Age attribute present and given in seconds.
	MaxAge   int    `yaml:"max_age" json:"max_age"`
	Secure   bool   `yaml:"secure" json:"secure"`
	HTTPOnly bool   `yaml:"http_only" json:"http_only"`
	SameSite string `yaml:"same_site" json:"same_site"`
}

CookieConfig is a configration for the cookie of HTTP.

func (*CookieConfig) Options

func (c *CookieConfig) Options() (*sessions.Options, error)

Options returns the session config.

type Provider

type Provider interface {
	ParseConfig(configFile map[string]interface{}) (ProviderConfig, error)
}

Provider is an OAuth provider.

type ProviderConfig

type ProviderConfig interface {
	Config() oauth2.Config
	Info(c *oauth2.Config, t *oauth2.Token) (string, map[string]interface{}, error)
}

ProviderConfig is a config for an OAuth provider.

type ProviderInfoContext

type ProviderInfoContext interface {
	InfoContext(ctx context.Context, c *oauth2.Config, t *oauth2.Token) (string, map[string]interface{}, error)
}

ProviderInfoContext is for support context.Context.

type Server

type Server struct {
	Config             Config
	DefaultProvider    string
	ProviderConfigs    map[string]ProviderConfig
	SessionStore       sessions.Store
	AppRefreshInterval time.Duration
}

Server is the go-nginx-oauth2-adapter server.

func NewServer

func NewServer(config Config) (*Server, error)

NewServer returns a new go-nginx-oauth2-adapter server.

func (*Server) HandlerCallback

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

HandlerCallback validates the user infomation, set to cookie

func (*Server) HandlerInitiate

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

HandlerInitiate redirects to authorization page.

func (*Server) HandlerTest

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

HandlerTest validates the session.

func (*Server) ServeHTTP

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