httpmw

Documentation

Index

• Constants
• func APIKey(r *http.Request) database.APIKey
• func ExtractAPIKey(db database.Store, oauthConfig OAuth2Config) func(http.Handler) http.Handler
• func ExtractOrganizationParam(db database.Store) func(http.Handler) http.Handler
• func ExtractTemplateParam(db database.Store) func(http.Handler) http.Handler
• func ExtractTemplateVersionParam(db database.Store) func(http.Handler) http.Handler
• func ExtractUserParam(db database.Store) func(http.Handler) http.Handler
• func ExtractWorkspaceAgent(db database.Store) func(http.Handler) http.Handler
• func ExtractWorkspaceAgentParam(db database.Store) func(http.Handler) http.Handler
• func ExtractWorkspaceBuildParam(db database.Store) func(http.Handler) http.Handler
• func ExtractWorkspaceParam(db database.Store) func(http.Handler) http.Handler
• func ExtractWorkspaceResourceParam(db database.Store) func(http.Handler) http.Handler
• func OrganizationMemberParam(r *http.Request) database.OrganizationMember
• func OrganizationParam(r *http.Request) database.Organization
• func RateLimitPerMinute(count int) func(http.Handler) http.Handler
• func TemplateParam(r *http.Request) database.Template
• func TemplateVersionParam(r *http.Request) database.TemplateVersion
• func UserParam(r *http.Request) database.User
• func WorkspaceAgent(r *http.Request) database.WorkspaceAgent
• func WorkspaceAgentParam(r *http.Request) database.WorkspaceAgent
• func WorkspaceBuildParam(r *http.Request) database.WorkspaceBuild
• func WorkspaceParam(r *http.Request) database.Workspace
• func WorkspaceResourceParam(r *http.Request) database.WorkspaceResource
• type OAuth2Config

Constants

const AuthCookie = "session_token"

AuthCookie represents the name of the cookie the API key is stored in.

const UserKey = "user"

Functions

func APIKey

func APIKey(r *http.Request) database.APIKey

APIKey returns the API key from the ExtractAPIKey handler.

func ExtractAPIKey

func ExtractAPIKey(db database.Store, oauthConfig OAuth2Config) func(http.Handler) http.Handler

ExtractAPIKey requires authentication using a valid API key. It handles extending an API key if it comes close to expiry, updating the last used time in the database.

func ExtractOrganizationParam

func ExtractOrganizationParam(db database.Store) func(http.Handler) http.Handler

ExtractOrganizationParam grabs an organization and user membership from the "organization" URL parameter. This middleware requires the API key middleware higher in the call stack for authentication.

func ExtractTemplateParam

func ExtractTemplateParam(db database.Store) func(http.Handler) http.Handler

ExtractTemplateParam grabs a template from the "template" URL parameter.

func ExtractTemplateVersionParam

func ExtractTemplateVersionParam(db database.Store) func(http.Handler) http.Handler

ExtractTemplateVersionParam grabs template version from the "templateversion" URL parameter.

func ExtractUserParam

func ExtractUserParam(db database.Store) func(http.Handler) http.Handler

ExtractUserParam extracts a user from an ID/username in the {user} URL parameter.

func ExtractWorkspaceAgent

func ExtractWorkspaceAgent(db database.Store) func(http.Handler) http.Handler

ExtractWorkspaceAgent requires authentication using a valid agent token.

func ExtractWorkspaceAgentParam

func ExtractWorkspaceAgentParam(db database.Store) func(http.Handler) http.Handler

ExtractWorkspaceAgentParam grabs a workspace agent from the "workspaceagent" URL parameter.

func ExtractWorkspaceBuildParam

func ExtractWorkspaceBuildParam(db database.Store) func(http.Handler) http.Handler

ExtractWorkspaceBuildParam grabs workspace build from the "workspacebuild" URL parameter.

func ExtractWorkspaceParam

func ExtractWorkspaceParam(db database.Store) func(http.Handler) http.Handler

ExtractWorkspaceParam grabs a workspace from the "workspace" URL parameter.

func ExtractWorkspaceResourceParam

func ExtractWorkspaceResourceParam(db database.Store) func(http.Handler) http.Handler

ExtractWorkspaceResourceParam grabs a workspace resource from the "provisionerjob" URL parameter.

func OrganizationMemberParam

func OrganizationMemberParam(r *http.Request) database.OrganizationMember

OrganizationMemberParam returns the organization membership that allowed the query from the ExtractOrganizationParam handler.

func OrganizationParam

func OrganizationParam(r *http.Request) database.Organization

OrganizationParam returns the organization from the ExtractOrganizationParam handler.

func RateLimitPerMinute

func RateLimitPerMinute(count int) func(http.Handler) http.Handler

RateLimitPerMinute returns a handler that limits requests per-minute based on IP, endpoint, and user ID (if available).

func TemplateParam

func TemplateParam(r *http.Request) database.Template

TemplateParam returns the template from the ExtractTemplateParam handler.

func TemplateVersionParam

func TemplateVersionParam(r *http.Request) database.TemplateVersion

TemplateVersionParam returns the template version from the ExtractTemplateVersionParam handler.

func UserParam

func UserParam(r *http.Request) database.User

UserParam returns the user from the ExtractUserParam handler.

func WorkspaceAgent

func WorkspaceAgent(r *http.Request) database.WorkspaceAgent

WorkspaceAgent returns the workspace agent from the ExtractAgent handler.

func WorkspaceAgentParam

func WorkspaceAgentParam(r *http.Request) database.WorkspaceAgent

WorkspaceAgentParam returns the workspace agent from the ExtractWorkspaceAgentParam handler.

func WorkspaceBuildParam

func WorkspaceBuildParam(r *http.Request) database.WorkspaceBuild

WorkspaceBuildParam returns the workspace build from the ExtractWorkspaceBuildParam handler.

func WorkspaceParam

func WorkspaceParam(r *http.Request) database.Workspace

WorkspaceParam returns the workspace from the ExtractWorkspaceParam handler.

func WorkspaceResourceParam

func WorkspaceResourceParam(r *http.Request) database.WorkspaceResource

ProvisionerJobParam returns the template from the ExtractTemplateParam handler.

Types

type OAuth2Config

type OAuth2Config interface {
	TokenSource(context.Context, *oauth2.Token) oauth2.TokenSource
}

OAuth2Config contains a subset of functions exposed from oauth2.Config. It is abstracted for simple testing.