The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- Variables
- func CompileHostnamePattern(pattern string) (*regexp.Regexp, error)
- func ExecuteHostnamePattern(pattern *regexp.Regexp, hostname string) (string, bool)
- func Forbidden(rw http.ResponseWriter)
- func Heartbeat(ctx context.Context, conn *websocket.Conn)
- func HeartbeatClose(ctx context.Context, exit func(), conn *websocket.Conn)
- func HostnamesMatch(a, b string) bool
- func InternalServerError(rw http.ResponseWriter, err error)
- func Is404Error(err error) bool
- func IsWebsocketUpgrade(r *http.Request) bool
- func NameValid(str string) error
- func ParseCustom[T any](parser *QueryParamParser, vals url.Values, def T, queryParam string, ...) T
- func ParseCustomList[T any](parser *QueryParamParser, vals url.Values, def []T, queryParam string, ...) []T
- func ParseEnum[T ValidEnum](term string) (T, error)
- func Read(ctx context.Context, rw http.ResponseWriter, r *http.Request, ...) bool
- func RequestHost(r *http.Request) string
- func ResourceNotFound(rw http.ResponseWriter)
- func RouteNotFound(rw http.ResponseWriter)
- func ServerSentEventSender(rw http.ResponseWriter, r *http.Request) (sendEvent func(ctx context.Context, sse codersdk.ServerSentEvent) error, ...)
- func StripCoderCookies(header string) string
- func TemplateDisplayNameValid(str string) error
- func TemplateVersionNameValid(str string) error
- func UsernameFrom(str string) string
- func WebsocketCloseSprintf(format string, vars ...any) string
- func Write(ctx context.Context, rw http.ResponseWriter, status int, response interface{})
- func WriteIndent(ctx context.Context, rw http.ResponseWriter, status int, response interface{})
- type ApplicationURL
- type Duration
- type QueryParamParser
- func (p *QueryParamParser) ErrorExcessParams(values url.Values)
- func (p *QueryParamParser) Int(vals url.Values, def int, queryParam string) int
- func (p *QueryParamParser) Required(queryParam string) *QueryParamParser
- func (p *QueryParamParser) String(vals url.Values, def string, queryParam string) string
- func (p *QueryParamParser) Strings(vals url.Values, def []string, queryParam string) []string
- func (p *QueryParamParser) Time(vals url.Values, def time.Time, queryParam, layout string) time.Time
- func (p *QueryParamParser) Time3339Nano(vals url.Values, def time.Time, queryParam string) time.Time
- func (p *QueryParamParser) UInt(vals url.Values, def uint64, queryParam string) uint64
- func (p *QueryParamParser) UUID(vals url.Values, def uuid.UUID, queryParam string) uuid.UUID
- func (p *QueryParamParser) UUIDorMe(vals url.Values, def uuid.UUID, me uuid.UUID, queryParam string) uuid.UUID
- func (p *QueryParamParser) UUIDs(vals url.Values, def []uuid.UUID, queryParam string) []uuid.UUID
- type ValidEnum
Constants ¶
const ( // XForwardedHostHeader is a header used by proxies to indicate the // original host of the request. XForwardedHostHeader = "X-Forwarded-Host" )
Variables ¶
var ResourceNotFoundResponse = codersdk.Response{Message: "Resource not found or you do not have access to this resource"}
var (
UsernameValidRegex = regexp.MustCompile("^[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*$")
)
var Validate *validator.Validate
Functions ¶
func CompileHostnamePattern ¶ added in v0.10.0
CompileHostnamePattern compiles a hostname pattern into a regular expression. A hostname pattern is a string that may contain a single wildcard character at the beginning. The wildcard character matches any number of hostname-safe characters excluding periods. The pattern is case-insensitive.
The supplied pattern:
- must not start or end with a period
- must contain exactly one asterisk at the beginning
- must not contain any other wildcard characters
- must not contain any other characters that are not hostname-safe (including whitespace)
- must contain at least two hostname labels/segments (i.e. "foo" or "*" are not valid patterns, but "foo.bar" and "*.bar" are).
The returned regular expression will match an entire hostname with optional trailing periods and whitespace. The first submatch will be the wildcard match.
func ExecuteHostnamePattern ¶ added in v0.10.0
ExecuteHostnamePattern executes a pattern generated by CompileHostnamePattern and returns the wildcard match. If the pattern does not match the hostname, returns false.
func Forbidden ¶ added in v0.5.10
func Forbidden(rw http.ResponseWriter)
func Heartbeat ¶ added in v0.9.3
Heartbeat loops to ping a WebSocket to keep it alive. Default idle connection timeouts are typically 60 seconds. See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#connection-idle-timeout
func HeartbeatClose ¶ added in v0.26.2
Heartbeat loops to ping a WebSocket to keep it alive. It kills the connection on ping failure.
func HostnamesMatch ¶ added in v0.9.0
HostnamesMatch returns true if the hostnames are equal, disregarding capitalization, extra leading or trailing periods, and ports.
func InternalServerError ¶ added in v0.8.10
func InternalServerError(rw http.ResponseWriter, err error)
func Is404Error ¶ added in v0.22.1
Is404Error returns true if the given error should return a 404 status code. Both actual 404s and unauthorized errors should return 404s to not leak information about the existence of resources.
func IsWebsocketUpgrade ¶ added in v0.8.10
func NameValid ¶ added in v0.12.6
NameValid returns whether the input string is a valid name. It is a generic validator for any name (user, workspace, template, etc.).
func ParseCustom ¶ added in v0.7.5
func ParseCustom[T any](parser *QueryParamParser, vals url.Values, def T, queryParam string, parseFunc func(v string) (T, error)) T
ParseCustom has to be a function, not a method on QueryParamParser because generics cannot be used on struct methods.
func ParseCustomList ¶ added in v0.18.1
func ParseCustomList[T any](parser *QueryParamParser, vals url.Values, def []T, queryParam string, parseFunc func(v string) (T, error)) []T
ParseCustomList is a function that handles csv query params.
func ParseEnum ¶ added in v0.18.1
ParseEnum is a function that can be passed into ParseCustom that handles enum validation.
func Read ¶
Read decodes JSON from the HTTP request into the value provided. It uses go-validator to validate the incoming request body. ctx is used for tracing and can be nil. Although tracing this function isn't likely too helpful, it was done to be consistent with Write.
func RequestHost ¶ added in v0.8.10
RequestHost returns the name of the host from the request. It prioritizes 'X-Forwarded-Host' over r.Host since most requests are being proxied.
func ResourceNotFound ¶ added in v0.7.0
func ResourceNotFound(rw http.ResponseWriter)
ResourceNotFound is intentionally vague. All 404 responses should be identical to prevent leaking existence of resources.
func RouteNotFound ¶ added in v0.9.0
func RouteNotFound(rw http.ResponseWriter)
func ServerSentEventSender ¶ added in v0.9.0
func ServerSentEventSender(rw http.ResponseWriter, r *http.Request) (sendEvent func(ctx context.Context, sse codersdk.ServerSentEvent) error, closed chan struct{}, err error)
func StripCoderCookies ¶ added in v0.8.6
StripCoderCookies removes the session token from the cookie header provided.
func TemplateDisplayNameValid ¶ added in v0.12.6
TemplateDisplayNameValid returns whether the input string is a valid template display name.
func TemplateVersionNameValid ¶ added in v0.21.3
TemplateVersionNameValid returns whether the input string is a valid template version name.
func UsernameFrom ¶ added in v0.8.2
UsernameFrom returns a best-effort username from the provided string.
It first attempts to validate the incoming string, which will be returned if it is valid. It then will attempt to extract the username from an email address. If no success happens during these steps, a random username will be returned.
func WebsocketCloseSprintf ¶
WebsocketCloseSprintf formats a websocket close message and ensures it is truncated to the maximum allowed length.
func Write ¶
func Write(ctx context.Context, rw http.ResponseWriter, status int, response interface{})
Write outputs a standardized format to an HTTP response body. ctx is used for tracing and can be nil for tracing to be disabled. Tracing this function is helpful because JSON marshaling can sometimes take a non-insignificant amount of time, and could help us catch outliers. Additionally, we can enrich span data a bit more since we have access to the actual interface{} we're marshaling, such as the number of elements in an array, which could help us spot routes that need to be paginated.
func WriteIndent ¶ added in v0.24.0
func WriteIndent(ctx context.Context, rw http.ResponseWriter, status int, response interface{})
Types ¶
type ApplicationURL ¶ added in v0.8.15
type ApplicationURL struct {
AppSlugOrPort string
AgentName string
WorkspaceName string
Username string
}
ApplicationURL is a parsed application URL hostname.
func ParseSubdomainAppURL ¶ added in v0.8.15
func ParseSubdomainAppURL(subdomain string) (ApplicationURL, error)
ParseSubdomainAppURL parses an ApplicationURL from the given subdomain. If the subdomain is not a valid application URL hostname, returns a non-nil error. If the hostname is not a subdomain of the given base hostname, returns a non-nil error.
The base hostname should not include a scheme, leading asterisk or dot.
Subdomains should be in the form:
{PORT/APP_SLUG}--{AGENT_NAME}--{WORKSPACE_NAME}--{USERNAME}
(eg. https://8080--main--dev--dean.hi.c8s.io)
func (ApplicationURL) String ¶ added in v0.8.15
func (a ApplicationURL) String() string
String returns the application URL hostname without scheme. You will likely want to append a period and the base hostname.
type Duration ¶ added in v0.12.2
Duration wraps time.Duration and provides better JSON marshaling and unmarshalling. The default time.Duration marshals as an integer and only accepts integers when unmarshalling, which is not very user friendly as users cannot write durations like "1h30m".
This type marshals as a string like "1h30m", and unmarshals from either a string or an integer.
func (Duration) MarshalJSON ¶ added in v0.12.2
MarshalJSON implements json.Marshaler.
func (*Duration) UnmarshalJSON ¶ added in v0.12.2
UnmarshalJSON implements json.Unmarshaler.
type QueryParamParser ¶ added in v0.7.0
type QueryParamParser struct {
// Errors is the set of errors to return via the API. If the length
// of this set is 0, there are no errors!.
Errors []codersdk.ValidationError
// Parsed is a map of all query params that were parsed. This is useful
// for checking if extra query params were passed in.
Parsed map[string]bool
// RequiredParams is a map of all query params that are required. This is useful
// for forcing a value to be provided.
RequiredParams map[string]bool
}
QueryParamParser is a helper for parsing all query params and gathering all errors in 1 sweep. This means all invalid fields are returned at once, rather than only returning the first error
func NewQueryParamParser ¶ added in v0.7.0
func NewQueryParamParser() *QueryParamParser
func (*QueryParamParser) ErrorExcessParams ¶ added in v0.18.1
func (p *QueryParamParser) ErrorExcessParams(values url.Values)
ErrorExcessParams checks if any query params were passed in that were not parsed. If so, it adds an error to the parser as these values are not valid query parameters.
func (*QueryParamParser) Required ¶ added in v0.22.0
func (p *QueryParamParser) Required(queryParam string) *QueryParamParser
func (*QueryParamParser) Time3339Nano ¶ added in v0.25.0
func (p *QueryParamParser) Time3339Nano(vals url.Values, def time.Time, queryParam string) time.Time
Time uses the default time format of RFC3339Nano and always returns a UTC time.
type ValidEnum ¶ added in v0.18.1
type ValidEnum interface {
database.ResourceType | database.AuditAction | database.BuildReason | database.UserStatus |
database.WorkspaceStatus
// Valid is required on the enum type to be used with ParseEnum.
Valid() bool
}
ValidEnum parses enum query params. Add more to the list as needed.
Source Files