Documentation
¶
Index ¶
- Constants
- Variables
- func ChangeUserPassword(ctx context.Context, request *models.ChangePasswordRequest) error
- func CreateUserFromProfileData(ctx context.Context, userSvc UserService, profile *UserProfile) (*models.User, error)
- func DeleteUser(ctx context.Context, id string) error
- func UpdateUser(ctx context.Context, update *UpdateUserData) error
- func UpdateUserCustomisation(ctx context.Context, request *models.EditUserRequest) error
- func UpdateUserMetadata(ctx context.Context, id string, key string, value any) error
- type AuthURLResult
- type Authenticator
- func (a *Authenticator) ClearAuth(ctx context.Context, mgr SessionManager)
- func (a *Authenticator) ClearState(ctx context.Context, mgr SessionManager)
- func (a *Authenticator) GenerateAuthURL(req *http.Request) (*AuthURLResult, error)
- func (a *Authenticator) GenerateLogoutURL(req *http.Request) (*url.URL, error)
- func (a *Authenticator) GetAccessToken(ctx context.Context, mgr SessionManager) (string, error)
- func (a *Authenticator) GetCodeVerifier(ctx context.Context, mgr SessionManager) (string, error)
- func (a *Authenticator) GetRefreshToken(ctx context.Context, mgr SessionManager) (string, error)
- func (a *Authenticator) GetReturnTo(ctx context.Context, mgr SessionManager) (string, error)
- func (a *Authenticator) GetState(ctx context.Context, mgr SessionManager) (string, error)
- func (a *Authenticator) GetTokenExpiry(ctx context.Context, mgr SessionManager) (time.Time, error)
- func (a *Authenticator) IsAccessTokenExpired(ctx context.Context, mgr SessionManager) bool
- func (a *Authenticator) IsAuthenticated(ctx context.Context, mgr SessionManager) bool
- func (a *Authenticator) PerformExchange(ctx context.Context, code, verifier string) (*TokenResponse, *UserProfile, error)
- func (a *Authenticator) PutCodeVerifier(ctx context.Context, mgr SessionManager, verifier string)
- func (a *Authenticator) PutReturnTo(ctx context.Context, mgr SessionManager, path string)
- func (a *Authenticator) PutState(ctx context.Context, mgr SessionManager, state string)
- func (a *Authenticator) RefreshTokens(ctx context.Context, httpClient *resty.Client, refreshToken string) (*TokenResponse, error)
- func (a *Authenticator) SaveTokens(ctx context.Context, mgr SessionManager, token *TokenResponse)
- func (a *Authenticator) VerifyIDToken(ctx context.Context, token *oauth2.Token) (*oidc.IDToken, string, error)
- type Config
- type SessionManager
- type TokenResponse
- type UpdateUserData
- type UserData
- type UserProfile
- type UserService
Constants ¶
const (
// ConfigEnvPrefix is the prefix applied to environment variables for configuring Auth0.
ConfigEnvPrefix = "AUTH0_"
)
Variables ¶
var ErrInvalidToken = errors.New("token is invalid")
var ErrNoIDToken = errors.New("no id_token field in oauth2 token")
var LoadAuthenticator = sync.OnceValues(func() (*Authenticator, error) { err := loadConfigOnce() if err != nil { return nil, fmt.Errorf("load config: %w", err) } provider, err := oidc.NewProvider( context.Background(), "https://"+cfg.Domain+"/", ) if err != nil { return nil, fmt.Errorf("create provider: %w", err) } conf := oauth2.Config{ ClientID: cfg.ClientID, ClientSecret: cfg.ClientSecret, RedirectURL: cfg.CallbackURL, Endpoint: provider.Endpoint(), Scopes: []string{oidc.ScopeOpenID, oidc.ScopeOfflineAccess, "profile", "email"}, } return &Authenticator{ Provider: provider, Config: conf, }, nil })
initAuthenticator will the setup and initialisation of the Auth0 tenant. It can be called multiple times but will only perform initialisation once (so it can be lazily loaded by calling it before any Auth0 actions).
Functions ¶
func ChangeUserPassword ¶
func ChangeUserPassword(ctx context.Context, request *models.ChangePasswordRequest) error
ChangeUserPassword will perform a password change on behalf of a user.
func CreateUserFromProfileData ¶ added in v0.87.0
func CreateUserFromProfileData(ctx context.Context, userSvc UserService, profile *UserProfile) (*models.User, error)
CreateUserFromProfileData creates a new user from the external provider details.
func DeleteUser ¶
DeleteUser will delete the given user from the Auth0 backend.
func UpdateUser ¶
func UpdateUser(ctx context.Context, update *UpdateUserData) error
UpdateUser updates user data in Auth0.
func UpdateUserCustomisation ¶ added in v0.61.0
func UpdateUserCustomisation(ctx context.Context, request *models.EditUserRequest) error
Types ¶
type AuthURLResult ¶ added in v0.104.0
AuthURLResult holds the generated authorization URL along with the state and PKCE code verifier that must be stored in the session before redirecting.
func (AuthURLResult) GetCodeVerifier ¶ added in v0.235.0
func (a AuthURLResult) GetCodeVerifier() string
func (AuthURLResult) GetState ¶ added in v0.235.0
func (a AuthURLResult) GetState() string
func (AuthURLResult) GetURL ¶ added in v0.235.0
func (a AuthURLResult) GetURL() string
type Authenticator ¶
Authenticator is used to authenticate our users.
func (*Authenticator) ClearAuth ¶ added in v0.235.0
func (a *Authenticator) ClearAuth(ctx context.Context, mgr SessionManager)
ClearAuth removes all authentication-related keys from the session.
func (*Authenticator) ClearState ¶ added in v0.235.0
func (a *Authenticator) ClearState(ctx context.Context, mgr SessionManager)
ClearState removes all data related to an authorization exchange from the session.
func (*Authenticator) GenerateAuthURL ¶ added in v0.235.0
func (a *Authenticator) GenerateAuthURL(req *http.Request) (*AuthURLResult, error)
GenerateAuthURL constructs the Auth0 Universal Login redirect URL using PKCE.
func (*Authenticator) GenerateLogoutURL ¶ added in v0.235.0
GenerateLogoutURL generates URL to log the user out from the auth backend.
func (*Authenticator) GetAccessToken ¶ added in v0.235.0
func (a *Authenticator) GetAccessToken(ctx context.Context, mgr SessionManager) (string, error)
func (*Authenticator) GetCodeVerifier ¶ added in v0.235.0
func (a *Authenticator) GetCodeVerifier(ctx context.Context, mgr SessionManager) (string, error)
func (*Authenticator) GetRefreshToken ¶ added in v0.235.0
func (a *Authenticator) GetRefreshToken(ctx context.Context, mgr SessionManager) (string, error)
func (*Authenticator) GetReturnTo ¶ added in v0.235.0
func (a *Authenticator) GetReturnTo(ctx context.Context, mgr SessionManager) (string, error)
func (*Authenticator) GetState ¶ added in v0.235.0
func (a *Authenticator) GetState(ctx context.Context, mgr SessionManager) (string, error)
func (*Authenticator) GetTokenExpiry ¶ added in v0.235.0
func (a *Authenticator) GetTokenExpiry(ctx context.Context, mgr SessionManager) (time.Time, error)
func (*Authenticator) IsAccessTokenExpired ¶ added in v0.235.0
func (a *Authenticator) IsAccessTokenExpired(ctx context.Context, mgr SessionManager) bool
IsAccessTokenExpired returns true if the access token has expired.
func (*Authenticator) IsAuthenticated ¶ added in v0.235.0
func (a *Authenticator) IsAuthenticated(ctx context.Context, mgr SessionManager) bool
IsAuthenticated returns true if the session contains an access token.
func (*Authenticator) PerformExchange ¶ added in v0.235.0
func (a *Authenticator) PerformExchange( ctx context.Context, code, verifier string, ) (*TokenResponse, *UserProfile, error)
Exchange handles verifying and exchanging the authorization code for an access token. It also extracts the ID token and user profile.
func (*Authenticator) PutCodeVerifier ¶ added in v0.235.0
func (a *Authenticator) PutCodeVerifier(ctx context.Context, mgr SessionManager, verifier string)
func (*Authenticator) PutReturnTo ¶ added in v0.235.0
func (a *Authenticator) PutReturnTo(ctx context.Context, mgr SessionManager, path string)
func (*Authenticator) PutState ¶ added in v0.235.0
func (a *Authenticator) PutState(ctx context.Context, mgr SessionManager, state string)
func (*Authenticator) RefreshTokens ¶ added in v0.235.0
func (a *Authenticator) RefreshTokens( ctx context.Context, httpClient *resty.Client, refreshToken string, ) (*TokenResponse, error)
RefreshTokens exchanges a refresh token for a new set of tokens.
func (*Authenticator) SaveTokens ¶ added in v0.235.0
func (a *Authenticator) SaveTokens(ctx context.Context, mgr SessionManager, token *TokenResponse)
SaveTokens saves the access token and data in the session.
type Config ¶
type Config struct {
Domain string `koanf:"domain" validate:"required"`
MgmtDomain string `koanf:"mgmtdomain" validate:"required"`
ClientID string `koanf:"clientid" validate:"required"`
ClientSecret string `koanf:"clientsecret" validate:"required"`
CallbackURL string `koanf:"callbackurl" validate:"required,url"`
}
Config structure.
type SessionManager ¶ added in v0.235.0
type TokenResponse ¶ added in v0.104.0
type TokenResponse struct {
AccessToken string `json:"access_token"`
RefreshToken string `json:"refresh_token"`
IDToken string `json:"id_token"`
TokenType string `json:"token_type"`
ExpiresIn int64 `json:"expires_in"` // seconds until expiry
}
TokenResponse represents the JSON response from the Auth0 /oauth/token endpoint.
type UpdateUserData ¶ added in v0.61.0
type UpdateUserData struct {
*management.UpdateUserRequestContent
ID string
}
type UserData ¶ added in v0.47.0
type UserData struct {
*management.GetUserResponseContent
*management.UserResponseSchema
}
func GetNewInactiveUsers ¶ added in v0.61.0
GetNewInactiveUsers returns all accounts created on the backend that haven't yet logged in to the app.
type UserProfile ¶
type UserProfile struct {
// URL of the server which issued this token.
Issuer string `json:"iss" validate:"required,url"`
// The client ID, or set of client IDs, that this token is issued for.
Audience string `json:"aud" validate:"required"`
// When the token was issued by the provider.
IssuedAt int64 `json:"iat" validate:"required"`
// Expiry of the token.
Expiry int64 `json:"exp" validate:"required"`
// A unique string which identifies the end user.
Subject string `json:"sub" validate:"required"`
// ID of the current session.
SessionID string `json:"sid" validate:"required"`
// The user's email address.
Email string `json:"email" validate:"email"`
// Indicates whether the user has verified their email address.
EmailVerified bool `json:"email_verified"`
// URL pointing to the user's profile picture.
Picture string `json:"picture" validate:"omitempty,url"`
// The user's family name.
FamilyName string `json:"family_name"`
// The user's family name.
GivenName string `json:"given_name"`
// The user's full name.
Name string `json:"name"`
// The user's nickname.
Nickname string `json:"nickname"`
// Timestamp indicating when the user's profile was last updated/modified.
UpdatedAt string `json:"updated_at"`
// LoginsCount is the number of times the user has logged in. If a user is blocked and logs in, the blocked session
// is still counted. For a new user, this will be 1 as creating the account is counted as the first login.
LoginsCount int64 `json:"logins_count" validate:"omitempty,gt=1"`
// Blocked indicates whether the user has been blocked. Importing enables subscribers to ensure that users remain
// blocked when migrating to Auth0.
Blocked bool `json:"blocked"`
// Custom fields that store info about a user that influences the user’s access, such as support plan, security
// roles (if not using the Authorization Core feature set), or access control groups.
AppMetadata map[string]any `json:"app_metadata"`
}
UserProfile represents the data returned from the auth0 backend that represents an authorised user.
https://auth0.com/docs/manage-users/user-accounts/user-profiles/user-profile-structure
https://pkg.go.dev/github.com/coreos/go-oidc/v3@v3.15.0/oidc#IDToken
func (*UserProfile) GetEmail ¶
func (u *UserProfile) GetEmail() string
GetEmail returns the email address associated with the external user.
func (*UserProfile) GetID ¶
func (u *UserProfile) GetID() string
GetID returns a string that represents the ID of the external user.