# Packages
Package admin contains controllers for system wide administrative actions.
Package apikey contains web controllers for listing and adding API Keys.
Package appsync syncs the published list of mobile apps to this server's db.
Package associated handles the iOS and Android associated app handler protocols.
Package backup implements data and database backups.
Package certapi implements the token + TEK verification API.
Package cleanup implements periodic data deletion.
Package codes defines a web controller for the code status page of the verification server.
Package e2erunner implements the end-to-end runner.
Package email implements periodic email sending.
Package flash implements flash messages.
Package issueapi implements the API handler for taking a code request, assigning an OTP, saving it to the database and returning the result.
Package jwks handles returning JSON encoded information about the server's encryption keys.
Package login defines the controller for the login page.
Package metricsregistrar implements metrics registration on load.
Package middleware defines shared middleware for handlers.
Package mobileapps contains web controllers for listing and adding mobile apps.
Package modeler implements periodic statistical calculations.
Package realmadmin contains web controllers for changing realm settings.
Package realmkeys contains web controllers for realm certificate key management.
Package redirect defines the controller for the deep link redirector.
Package rotation implements periodic secret rotation.
Package smskeys contains web controllers for realm certificate key management.
Package stats produces statistics.
Package statspuller pulls statistics from the key server.
Package user contains web controllers for listing and adding users.
Package userreport defines the controller for the login page.
Package verifyapi implements the exchange of the verification code (short term token) for a long term token that can be used to get a verification certification to send to the key server.
Package webhooks provides webhook fulfilment endpoints.
# Functions
APIKeyFromSession extracts the API key from the session.
AuthorizedAppFromContext retrieves the authorized app from the context.
Back goes back to the referrer.
BadRequest indicates the client sent an invalid request.
BindForm parses and binds the HTTP form to the provided data interface using the gorilla schema package.
BindJSON provides a common implementation of JSON unmarshaling with well defined error handling.
ClearEmailVerificationPrompted clears the MFA prompt bit.
ClearLastActivity clears the session last activity time.
ClearMFAPrompted clears the MFA prompt bit.
ClearNonceFromSession removes the nonce key from the current session.
ClearPasswordExpireWarned clears the welcome message prompt bit.
ClearSessionAPIKey clears the API key from the session.
ClearSessionCSRFToken clears the CSRF token from the session.
ClearSessionRealm clears the realm from the session.
ClearWelcomeMessageDisplayed clears the welcome message prompt bit.
CSRFTokenFromSession extracts the CSRF token from the session.
EmailVerificationPromptedFromSession extracts if the user was prompted for email verification.
FirebaseUserFromContext retrieves the firebase user from the context.
Flash gets or creates the flash data for the provided session.
No description provided by the author
InternalError handles an internal error, returning the right response to the client.
IsJSONContentType returns true if the request's content type is application/json extra specific details, like UTF encoding schema are allowed.
LastActivityFromSession extracts the last time the user did something.
LocaleFromContext returns nil or the local from the context.
MembershipFromContext retrieves the membership from the context.
MembershipsFromContext retrieves the membership from the context.
MFAPromptedFromSession extracts if the user was prompted for MFA.
MissingAuthorizedApp returns an internal error when the authorized app does not exist.
MissingLocale returns an internal error when the locale does not exist.
MissingMembership returns an error indicating that the request requires a realm selection, but one was not present.
MissingSession returns an internal error when the session does not exist.
MissingUser returns an internal error when the user does not exist.
NonceFromContext retrieves a nonce value from the context.
NonceFromSession returns the current nonce from the session or empty string if there isn't one, or the value is malformed.
NotFound returns an error indicating the URL was not found.
OperatingSystemFromContext retrieves the operating system enum from the context.
PasswordExpireWarnedFromSession extracts if the user was displayed the realm welcome message.
RealHostFromRequest attempts to find the "best" host for the HTTP request.
RealmFromContext retrieves the realm from the context.
RealmIDFromSession extracts the realm from the session.
RedirectToChangePassword redirects to the password reset page.
RedirectToLogout redirects the user to the logout page to terminate the session.
RedirectToMFA redirects to the MFA registration.
RegionFromSession returns the current region from the session or empty string if there isn't one, or the value is malformed.
RequestIDFromContext retrieves the request ID from the context.
SendEmailVerificationEmailFunc returns a function capable of sending an email verification email.
SendInviteEmailFunc returns a function capable of sending a new user invitation.
SendPasswordResetEmailFunc returns a function capable of sending a password reset for the given user.
SessionFromContext retrieves the session on the provided context.
StorePasswordExpireWarned stores if the user was displayed the realm welcome message.
StoreSessionAPIKey stores the API key on the session.
StoreSessionCSRFToken stores the CSRF token on the session.
StoreSessionEmailVerificationPrompted stores if the user was prompted for email verification.
StoreSessionLastActivity stores the last time the user did something.
StoreSessionMFAPrompted stores if the user was prompted for MFA.
StoreSessionNonce stores this sessions current nonce value for processing.
StoreSessionRealm stores the realm's ID in the session.
StoreSessionRegion stores the current operating region in the session.
StoreSessionWelcomeMessageDisplayed stores if the user was displayed the realm welcome message.
TemplateMapFromContext gets the template map on the context.
TracedHTTPClient returns a new HTTP client with the given timeout that automatically injects trace and and request ID tokens to correlate requests that span mutiple services.
TraceIDFromContext retrieves the trace ID from the context.
Unauthorized returns an error indicating the request was unauthorized.
UserFromContext retrieves the user from the context.
WelcomeMessageDisplayedFromSession extracts if the user was displayed the realm welcome message.
WithAuthorizedApp stores the authorized app on the context.
WithFirebaseUser stores the current firebase user on the context.
WithLocale adds the translator / locale to use for this request.
WithMembership stores the current membership on the context.
WithMemberships stores the user's available memberships on the context.
WithNonce adds a nonce value to the request context.
WithOperatingSystem stores the operating system enum in the context.
WithRealm stores the current realm on the context and the realm.ID on the observability context.
WithRequestID stores the request ID on the context.
WithSession stores the session on the request's context for retrieval later.
WithTemplateMap creates a context with the given template map.
WithTraceID stores the trace ID on the context.
WithUser stores the current user on the context.
# Constants
No description provided by the author
No description provided by the author
# Type aliases
TemplateMap is a typemap for the HTML templates.