func AuthorizeFilter[Orbac.Objecter](h *HTTPAuthorizer, r *http.Request, actionrbac.Action, objects []O) ([]O,error)

func LatencyCheck()http.HandlerFunc

func ReadExperiments(logslog.Logger, raw []string)codersdk.Experiments

type API struct {// DeploymentID is loaded from the database on startup.DeploymentIDstring*Options// ID is a uniquely generated ID on initialization.// This is used to associate objects with a specific// Coder API instance, like workspace agents to a// specific replica.IDuuid.UUIDAuditoratomic.Pointer[audit.Auditor]WorkspaceClientCoordinateOverrideatomic.Pointer[func(rwhttp.ResponseWriter)bool]TailnetCoordinatoratomic.Pointer[tailnet.Coordinator]QuotaCommitteratomic.Pointer[proto.QuotaCommitter]// WorkspaceProxyHostsFn returns the hosts of healthy workspace proxies// for header reasons.WorkspaceProxyHostsFnatomic.Pointer[func() []string]// TemplateScheduleStore is a pointer to an atomic pointer because this is// passed to another struct, and we want them all to be the same reference.TemplateScheduleStore *atomic.Pointer[schedule.TemplateScheduleStore]// UserQuietHoursScheduleStore is a pointer to an atomic pointer for the// same reason as TemplateScheduleStore.UserQuietHoursScheduleStore *atomic.Pointer[schedule.UserQuietHoursScheduleStore]HTTPAuth *HTTPAuthorizer// APIHandler serves "/api/v2"APIHandler chi.Router// RootHandler serves "/"RootHandler chi.Router// SiteHandler serves static files for the dashboard.SiteHandler *site.HandlerWebsocketWaitMutexsync.MutexWebsocketWaitGroupsync.WaitGroupWorkspaceAppsProviderworkspaceapps.SignedTokenProvider// Experiments contains the list of experiments currently enabled.// This is used to gate features that are not yet ready for production.Experimentscodersdk.Experiments// contains filtered or unexported fields}

funcNew¶

func New(options *Options) *API

@securitydefinitions.apiKey CoderSessionToken@in header@name Coder-Session-TokenNew constructs a Coder API handler.

func (*API)Authorize¶added inv0.6.1

func (api *API) Authorize(r *http.Request, actionrbac.Action, objectrbac.Objecter)bool

Authorize will return false if the user is not authorized to do the action.This function will log appropriately, but the caller must return anerror to the api client.Eg:

if !api.Authorize(...) {httpapi.Forbidden(rw)return}

func (*API)Close¶added inv0.6.1

func (api *API) Close()error

Close waits for all WebSocket connections to drain before returning.

func (*API)CreateInMemoryProvisionerDaemon¶added inv0.12.8

func (api *API) CreateInMemoryProvisionerDaemon(ctxcontext.Context, debouncetime.Duration) (clientproto.DRPCProvisionerDaemonClient, errerror)

CreateInMemoryProvisionerDaemon is an in-memory connection to a provisionerd.Useful when starting coderd and provisionerd in the same process.

func (*API)CreateUser¶added inv0.9.0

func (api *API) CreateUser(ctxcontext.Context, storedatabase.Store, reqCreateUserRequest) (database.User,uuid.UUID,error)

func (*API)PrimaryRegion¶added inv0.23.1

func (api *API) PrimaryRegion(ctxcontext.Context) (codersdk.Region,error)

PrimaryRegion exposes the user facing values of a workspace proxy tobe used by a user.

func (*API)PrimaryWorkspaceProxy¶added inv0.24.0

func (api *API) PrimaryWorkspaceProxy(ctxcontext.Context) (database.WorkspaceProxy,error)

PrimaryWorkspaceProxy returns the primary workspace proxy for the site.

func (*API)ValidWorkspaceAppHostname¶added inv0.23.0

func (api *API) ValidWorkspaceAppHostname(ctxcontext.Context, hoststring, optsValidWorkspaceAppHostnameOpts) (string,error)

ValidWorkspaceAppHostname checks if the given host is a valid workspace apphostname based on the provided options. It returns a scheme to force onsuccess. If the hostname is not valid or doesn't match, an empty string isreturned. Any error returned is a 500 error.

For hosts that match a wildcard app hostname, the scheme is forced to be thecorresponding access URL scheme.

type CreateUserRequest struct {codersdk.CreateUserRequestCreateOrganizationboolLoginTypedatabase.LoginType}

type GithubOAuth2Config struct {httpmw.OAuth2ConfigAuthenticatedUser           func(ctxcontext.Context, client *http.Client) (*github.User,error)ListEmails                  func(ctxcontext.Context, client *http.Client) ([]*github.UserEmail,error)ListOrganizationMemberships func(ctxcontext.Context, client *http.Client) ([]*github.Membership,error)TeamMembership              func(ctxcontext.Context, client *http.Client, org, team, usernamestring) (*github.Membership,error)AllowSignupsboolAllowEveryoneboolAllowOrganizations []stringAllowTeams         []GithubOAuth2Team}

type GithubOAuth2Team struct {OrganizationstringSlugstring}

type HTTPAuthorizer struct {Authorizerrbac.AuthorizerLoggerslog.Logger}

func (*HTTPAuthorizer)Authorize¶added inv0.8.7

func (h *HTTPAuthorizer) Authorize(r *http.Request, actionrbac.Action, objectrbac.Objecter)bool

Authorize will return false if the user is not authorized to do the action.This function will log appropriately, but the caller must return anerror to the api client.Eg:

if !h.Authorize(...) {httpapi.Forbidden(rw)return}

func (*HTTPAuthorizer)AuthorizeSQLFilter¶added inv0.9.3

func (h *HTTPAuthorizer) AuthorizeSQLFilter(r *http.Request, actionrbac.Action, objectTypestring) (rbac.PreparedAuthorized,error)

AuthorizeSQLFilter returns an authorization filter that can used in aSQL 'WHERE' clause. If the filter is used, the resulting rows returnedfrom postgres are already authorized, and the caller does not need tocall 'Authorize()' on the returned objects.Note the authorization is only for the given action and object type.

type OAuthConvertStateClaims struct {jwt.RegisteredClaimsUserIDuuid.UUID          `json:"user_id"`Statestring             `json:"state"`FromLoginTypecodersdk.LoginType `json:"from_login_type"`ToLoginTypecodersdk.LoginType `json:"to_login_type"`}

type OIDCConfig struct {httpmw.OAuth2ConfigProvider *oidc.ProviderVerifier *oidc.IDTokenVerifier// EmailDomains are the domains to enforce when a user authenticates.EmailDomain  []stringAllowSignupsbool// IgnoreEmailVerified allows ignoring the email_verified claim// from an upstream OIDC provider. See #5065 for context.IgnoreEmailVerifiedbool// UsernameField selects the claim field to be used as the created user's// username.UsernameFieldstring// EmailField selects the claim field to be used as the created user's// email.EmailFieldstring// AuthURLParams are additional parameters to be passed to the OIDC provider// when requesting an access token.AuthURLParams map[string]string// IgnoreUserInfo causes Coder to only use claims from the ID token to// process OIDC logins. This is useful if the OIDC provider does not// support the userinfo endpoint, or if the userinfo endpoint causes// undesirable behavior.IgnoreUserInfobool// GroupField selects the claim field to be used as the created user's// groups. If the group field is the empty string, then no group updates// will ever come from the OIDC provider.GroupFieldstring// GroupMapping controls how groups returned by the OIDC provider get mapped// to groups within Coder.// map[oidcGroupName]coderGroupNameGroupMapping map[string]string// SignInText is the text to display on the OIDC login buttonSignInTextstring// IconURL points to the URL of an icon to display on the OIDC login buttonIconURLstring}

type Options struct {AccessURL *url.URL// AppHostname should be the wildcard hostname to use for workspace// applications INCLUDING the asterisk, (optional) suffix and leading dot.// It will use the same scheme and port number as the access URL.// E.g. "*.apps.coder.com" or "*-apps.coder.com".AppHostnamestring// AppHostnameRegex contains the regex version of options.AppHostname as// generated by httpapi.CompileHostnamePattern(). It MUST be set if// options.AppHostname is set.AppHostnameRegex *regexp.RegexpLoggerslog.LoggerDatabasedatabase.StorePubsubpubsub.Pubsub// CacheDir is used for caching files served by the API.CacheDirstringAuditoraudit.AuditorAgentConnectionUpdateFrequencytime.DurationAgentInactiveDisconnectTimeouttime.DurationAWSCertificatesawsidentity.CertificatesAuthorizerrbac.AuthorizerAzureCertificatesx509.VerifyOptionsGoogleTokenValidator           *idtoken.ValidatorGithubOAuth2Config             *GithubOAuth2ConfigOIDCConfig                     *OIDCConfigPrometheusRegistry             *prometheus.RegistrySecureAuthCookieboolStrictTransportSecurityCfghttpmw.HSTSConfigSSHKeygenAlgorithmgitsshkey.AlgorithmTelemetrytelemetry.ReporterTracerProvidertrace.TracerProviderGitAuthConfigs                 []*gitauth.ConfigRealIPConfig                   *httpmw.RealIPConfigTrialGenerator                 func(ctxcontext.Context, emailstring)error// TLSCertificates is used to mesh DERP servers securely.TLSCertificates             []tls.CertificateTailnetCoordinatortailnet.CoordinatorDERPServer                  *derp.ServerDERPMap                     *tailcfg.DERPMapSwaggerEndpointboolSetUserGroups               func(ctxcontext.Context, txdatabase.Store, userIDuuid.UUID, groupNames []string)errorTemplateScheduleStore       *atomic.Pointer[schedule.TemplateScheduleStore]UserQuietHoursScheduleStore *atomic.Pointer[schedule.UserQuietHoursScheduleStore]// AppSecurityKey is the crypto key used to sign and encrypt tokens related to// workspace applications. It consists of both a signing and encryption key.AppSecurityKeyworkspaceapps.SecurityKeyHealthcheckFunc    func(ctxcontext.Context, apiKeystring) *healthcheck.ReportHealthcheckTimeouttime.DurationHealthcheckRefreshtime.Duration// OAuthSigningKey is the crypto key used to sign and encrypt state strings// related to OAuth. This is a symmetric secret key using hmac to sign payloads.// So this secret should **never** be exposed to the client.OAuthSigningKey [32]byte// APIRateLimit is the minutely throughput rate limit per user or ip.// Setting a rate limit <0 will disable the rate limiter across the entire// app. Some specific routes have their own configurable rate limits.APIRateLimitintLoginRateLimitintFilesRateLimitintMetricsCacheRefreshIntervaltime.DurationAgentStatsRefreshIntervaltime.DurationDeploymentValues            *codersdk.DeploymentValuesUpdateCheckOptions          *updatecheck.Options// Set non-nil to enable update checking.// SSHConfig is the response clients use to configure config-ssh locally.SSHConfigcodersdk.SSHConfigResponseHTTPClient *http.ClientUpdateAgentMetrics func(ctxcontext.Context, username, workspaceName, agentNamestring, metrics []agentsdk.AgentMetric)}

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

funcNewServerTailnet¶added inv0.26.2

func NewServerTailnet(ctxcontext.Context,loggerslog.Logger,derpServer *derp.Server,derpMap *tailcfg.DERPMap,getMultiAgent func(context.Context) (tailnet.MultiAgentConn,error),cache *wsconncache.Cache,) (*ServerTailnet,error)

NewServerTailnet creates a new tailnet intended for use by coderd. Itautomatically falls back to wsconncache if a legacy agent is encountered.

func (*ServerTailnet)AgentConn¶added inv0.26.2

func (s *ServerTailnet) AgentConn(ctxcontext.Context, agentIDuuid.UUID) (*codersdk.WorkspaceAgentConn, func(),error)

func (*ServerTailnet)Close¶added inv0.26.2

func (s *ServerTailnet) Close()error

func (*ServerTailnet)DialAgentNetConn¶added inv0.26.2

func (s *ServerTailnet) DialAgentNetConn(ctxcontext.Context, agentIDuuid.UUID, network, addrstring) (net.Conn,error)

func (*ServerTailnet)ReverseProxy¶added inv0.26.2

func (s *ServerTailnet) ReverseProxy(targetURL, dashboardURL *url.URL, agentIDuuid.UUID) (_ *httputil.ReverseProxy, release func(), _error)

type ValidWorkspaceAppHostnameOpts struct {AllowPrimaryAccessURLboolAllowPrimaryWildcardboolAllowProxyAccessURLboolAllowProxyWildcardbool}