rest

Documentation

Overview

Package rest provides an http oauth REST API

Index

• Constants
• Variables
• type Option
  • func WithAddr(addr string) Option
  • func WithAllowPasswordGrant(allow bool) Option
  • func WithAllowSignup(allow bool) Option
  • func WithBasepath(basePath string) Option
  • func WithCodeStore(store oauth.CodeStore) Option
  • func WithLogger(logger *logrus.Logger) Option
  • func WithRouter(router *mux.Router) Option
  • func WithSessionCookieName(name string) Option
  • func WithSessionIntervals(lifetime, timeout time.Duration) Option
  • func WithSessionStore(store sessions.Store) Option
• type Server
  • func New(ctrl oauth.Controller, signingKey *rsa.PrivateKey, opts ...Option) *Server
  • func (s *Server) AuthorizeRequest(r *http.Request, scope ...oauth.Permissions) (oauth.Context, error)
  • func (s *Server) Router() *mux.Router
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown(ctx context.Context) error

Constants

const (
	// AuthRequestParam is the name of the request token parameter
	AuthRequestParam = "request_token"

	// SessionCookie is the name the session cookie
	SessionCookie = "_atomic_session"
)

const (
	// Name the server name
	Name = "libatomic-oauth"

	// Version is the binary version
	Version = "1.0.0"
)

Variables

var (
	// SwaggerJSON embedded version of the swagger document used at generation time
	SwaggerJSON json.RawMessage
	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
	FlatSwaggerJSON json.RawMessage

	SpecDoc *loads.Document
)

Types

type Option

type Option func(*Server)

Option provides the server options, these will override th defaults and instance values.

func WithAddr

func WithAddr(addr string) Option

WithAddr sets the listen address for the server

func WithAllowPasswordGrant

func WithAllowPasswordGrant(allow bool) Option

WithAllowPasswordGrant enables password grants which require client secrets

func WithAllowSignup

func WithAllowSignup(allow bool) Option

WithAllowSignup enables the signup/register paths

func WithBasepath

func WithBasepath(basePath string) Option

WithBasepath sets the server basepath

func WithCodeStore

func WithCodeStore(store oauth.CodeStore) Option

WithCodeStore sets the code store for the server

func WithLogger

func WithLogger(logger *logrus.Logger) Option

WithLogger specifies a new logger

func WithRouter

func WithRouter(router *mux.Router) Option

WithRouter specifies the router to use

func WithSessionCookieName

func WithSessionCookieName(name string) Option

WithSessionCookieName sets the session cookie name

func WithSessionIntervals

func WithSessionIntervals(lifetime, timeout time.Duration) Option

WithSessionIntervals sets the session lifetime and activity timeout

func WithSessionStore

func WithSessionStore(store sessions.Store) Option

WithSessionStore sets the session store

type Server

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

Server is an API server it can be used standalone vi Server() or integrared via Handler()

func New

func New(ctrl oauth.Controller, signingKey *rsa.PrivateKey, opts ...Option) *Server

New returns a new Server instance

func (*Server) AuthorizeRequest

func (s *Server) AuthorizeRequest(r *http.Request, scope ...oauth.Permissions) (oauth.Context, error)

AuthorizeRequest implements the auth.Authorizer interface

func (*Server) Router

func (s *Server) Router() *mux.Router

Router returns the server router

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the http server

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown shuts down the http server with the context