Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.0.9

May 11, 2026

Changes in this version

+ const FlowPKCE

+ const FlowPKCEImplicit

+ const FlowPlain

+ const FlowVerify

+ var ContextKeyAccessToken = contextKey

+ var ContextKeyClientID = contextKey

+ var ContextKeyClientName = contextKey

+ var DB up.Session

+ var Descriptions = map[error]string

+ var ErrAccessDenied = errors.New("access_denied")

+ var ErrCodeChallengeRequired = errors.New("invalid_request")

+ var ErrExpiredRefreshToken = errors.New("expired refresh token")

+ var ErrInvalidClient = errors.New("invalid_client")

+ var ErrInvalidCodeChallenge = errors.New("invalid code challenge")

+ var ErrInvalidCodeChallengeLen = errors.New("invalid_request")

+ var ErrInvalidGrant = errors.New("invalid_grant")

+ var ErrInvalidRedirectURI = errors.New("invalid redirect uri")

+ var ErrInvalidRefreshToken = errors.New("invalid refresh token")

+ var ErrInvalidRequest = errors.New("invalid_request")

+ var ErrInvalidScope = errors.New("invalid_scope")

+ var ErrServerError = errors.New("server_error")

+ var ErrTemporarilyUnavailable = errors.New("temporarily_unavailable")

+ var ErrUnauthorizedClient = errors.New("unauthorized_client")

+ var ErrUnsupportedCodeChallengeMethod = errors.New("invalid_request")

+ var ErrUnsupportedGrantType = errors.New("unsupported_grant_type")

+ var ErrUnsupportedResponseType = errors.New("unsupported_response_type")

+ var StatusCodes = map[error]int

+ func BearerTokenHandler(unguardedRoute []string, GuardedRouteGroups []string, ErrorLogger *log.Logger, ...) func(next http.Handler) http.Handler

+ func ChallengeCodeValidate(challengeCode, method string) (bool, error)

+ func GenerateTokenExpiry(hours int) time.Time

+ func IsExpired(token interface{}) bool

+ func ScopeHandler(UnguardedRoutes []string, GuardedRouteGroups []string, ErrorLogger *log.Logger, ...) func(next http.Handler) http.Handler

+ type AuthorizationResponse struct

+ CSRFToken string

+ Code string

+ GrantType string

+ RedirectUri RedirectUri

+ State string

+ TokenType string

+ type AuthorizationToken struct

+ ChallengeCode string

+ ChallengeCodeMethod string

+ ClientID int

+ CreatedAt time.Time

+ Expires time.Time

+ Hash []byte

+ ID int

+ PlainText string

+ State string

+ UpdatedAt time.Time

+ UserID *int

+ type Client struct

+ CreatedAt time.Time

+ Flow string

+ ID int

+ Name string

+ PlainText string

+ RedirectUrl string

+ Revoked int

+ Secret string

+ Type string

+ UpdatedAt time.Time

+ UserID *int

+ type Configuration struct

+ AuthorizationTokenTTL time.Duration

+ GuardedRouteGroups []string

+ OauthTokenTTL time.Duration

+ PkceImplicitAuthorizationScopes map[string]string

+ PkceImplicitTTL time.Duration

+ RefreshTokenTokenTTL time.Duration

+ Scopes Scopes

+ UnguardedRoutes []string

+ VerifyTemplatePath string

+ type ErrorResponse struct

+ Description string

+ Error string

+ ErrorCode int

+ URI string

+ func NewErrorResponse(err error) *ErrorResponse

+ type OauthResponse struct

+ AccessToken string

+ ExpiresIn int64

+ GrantType string

+ RefreshToken string

+ Scope string

+ TokenType string

+ type OauthToken struct

+ ClientID int

+ CreatedAt time.Time

+ Expires time.Time

+ Hash []byte

+ ID int

+ PlainText string

+ RefreshToken string

+ Scopes string

+ UpdatedAt time.Time

+ UserID *int

+ type RedirectUri struct

+ Path string

+ Query string

+ URI string

+ type RefreshToken struct

+ AccessTokenID int

+ CreatedAt time.Time

+ Expires time.Time

+ Hash []byte

+ ID int

+ PlainText string

+ UpdatedAt time.Time

+ type Scopes = map[string]string

+ type Service struct

+ Config Configuration

+ DB *database.Database

+ ErrorLog *log.Logger

+ GrantTypes map[string]string

+ Mux *mux.Mux

+ Renderer *render.Render

+ Session *scs.SessionManager

+ func New(a *adele.Adele) (Service, error)

+ func NewWithConfig(a *adele.Adele, config Configuration) (Service, error)

+ func (o *Service) AccessTokenGrantExchange(w http.ResponseWriter, r *http.Request) (*OauthResponse, *ErrorResponse)

+ func (o *Service) AnyScope(r *http.Request, anyScopes Scopes) bool

+ func (o *Service) AuthenticateToken(r *http.Request) (bool, *OauthToken, error)

+ func (o *Service) AuthenticationCheckForScopes() func(next http.Handler) http.Handler

+ func (o *Service) AuthenticationTokenMiddleware() func(next http.Handler) http.Handler

+ func (o *Service) AuthorizationClientCodeExchange(w http.ResponseWriter, r *http.Request, client *Client) (*AuthorizationResponse, *ErrorResponse)

+ func (o *Service) AuthorizationClientCodeExchangeImplicit(w http.ResponseWriter, r *http.Request, client *Client) (*AuthorizationResponse, *ErrorResponse)

+ func (o *Service) AuthorizationClientExchange(w http.ResponseWriter, r *http.Request, client *Client) (*AuthorizationResponse, *ErrorResponse)

+ func (o *Service) AuthorizationGrantExchange(w http.ResponseWriter, r *http.Request) (*AuthorizationResponse, *ErrorResponse)

+ func (o *Service) AuthorizationGrantExchangePost(w http.ResponseWriter, r *http.Request) (*AuthorizationResponse, *ErrorResponse)

+ func (o *Service) CheckUserPasswordMatches(plainText string, user User) bool

+ func (o *Service) ConsumeAuthorizationToken(plainText string) (*AuthorizationToken, error)

+ func (o *Service) DeleteAuthorizationToken(id int) error

+ func (o *Service) DeleteOauthToken(id int) error

+ func (o *Service) DeleteRefreshTokenByToken(plainText string) error

+ func (o *Service) GenerateAuthorizationToken() (*AuthorizationToken, error)

+ func (o *Service) GenerateOauthToken() (*OauthToken, error)

+ func (o *Service) GenerateRefreshToken(userID int, AccessTokenID int, clientID int) (*RefreshToken, error)

+ func (o *Service) GetAuthTokenFromHeader(r *http.Request) (*OauthToken, error)

+ func (o *Service) GetAuthenticatedUser(r *http.Request) *User

+ func (o *Service) GetAuthorizationTokenByToken(plainText string) (*AuthorizationToken, error)

+ func (o *Service) GetByToken(plainText string) (*OauthToken, error)

+ func (o *Service) GetClient(id int) (*Client, error)

+ func (o *Service) GetOauthToken(id int) (*OauthToken, error)

+ func (o *Service) GetRefreshByToken(plainText string) (*RefreshToken, error)

+ func (o *Service) GetUserByEmail(email string) (*User, error)

+ func (o *Service) HasScope(r *http.Request, requiredScopes Scopes) bool

+ func (o *Service) InsertAuthorizationToken(token *AuthorizationToken) (*AuthorizationToken, error)

+ func (o *Service) InsertClient(client Client) (*Client, error)

+ func (o *Service) InsertOauthToken(token *OauthToken) (*OauthToken, error)

+ func (o *Service) InsertRefreshToken(token *RefreshToken) error

+ func (o *Service) RefreshTokenExchange(w http.ResponseWriter, r *http.Request) (*OauthResponse, *ErrorResponse)

+ func (o *Service) ResourceOwnerTokenExchange(r *http.Request, w http.ResponseWriter, client Client) (*OauthToken, *RefreshToken, *ErrorResponse)

+ func (o *Service) TokenIsExpired(token interface{}) bool

+ func (o *Service) UserIsLoggedIn(r *http.Request) bool

+ func (o *Service) ValidateClientRedirect(uri string, client *Client) bool

+ func (o *Service) VerifyAuthorizationCode(token AuthorizationToken, codeVerifier string) bool

+ type User struct

+ Active int

+ CreatedAt time.Time

+ Email string

+ FirstName string

+ ID int

+ LastName string

+ Password string

+ Token OauthToken

+ UpdatedAt time.Time

v1.0.9-rc1

May 11, 2026

v1.0.8

May 11, 2026

v1.0.8-rc1

May 11, 2026

v1.0.7

May 10, 2026

v1.0.7-rc1

May 10, 2026

v1.0.6

May 10, 2026

v1.0.6-rc1

May 10, 2026

v1.0.5

May 9, 2026

v1.0.5-rc1

May 9, 2026

v1.0.4

May 9, 2026

v1.0.4-rc1

May 9, 2026

v1.0.3

May 7, 2026

v1.0.3-rc2

May 7, 2026

v1.0.3-rc1

May 7, 2026

v1.0.3-rc

May 7, 2026

v1.0.2

May 7, 2026

v1.0.2-rc

Apr 23, 2026

v1.0.1

Apr 18, 2026

v1.0.1-rc

Apr 18, 2026

v1.0.0

Apr 17, 2026

v1.0.0-rc

Apr 17, 2026