Documentation
¶
Index ¶
- Constants
- func APIGroupFromContext(c *gin.Context) string
- func CORS() gin.HandlerFunc
- func CheckTeamAccessForRoute(c *gin.Context, team *types.Team) error
- func EnforceBlockedTeam() gin.HandlerFunc
- func EnforceReadOnlyMember() gin.HandlerFunc
- func InitLaunchDarklyContext(c *gin.Context)
- func LabelMetricsWithTeam() gin.HandlerFunc
- func ReadRequestBody(limit int64) gin.HandlerFunc
- func RefuseDeletedProject(isProjectDeleted func(ctx context.Context, projectID uuid.UUID) (bool, error)) gin.HandlerFunc
- func WithAPIGroup(authenticate openapi3filter.AuthenticationFunc) openapi3filter.AuthenticationFunc
Constants ¶
const APIGroupExtension = "x-api-group"
Variables ¶
This section is empty.
Functions ¶
func APIGroupFromContext ¶
func CORS ¶
func CORS() gin.HandlerFunc
CORS returns the gin CORS middleware for the api service. A preflight is answered and the chain stopped, since no route serves OPTIONS.
func CheckTeamAccessForRoute ¶
CheckTeamAccessForRoute applies CheckTeamBanned, the api blocked-team allowlist and the read-only member check to a late-resolved team.
func EnforceBlockedTeam ¶
func EnforceBlockedTeam() gin.HandlerFunc
EnforceBlockedTeam returns the gin middleware for the api service, configured with the api-specific blocked-team allowlist.
func EnforceReadOnlyMember ¶
func EnforceReadOnlyMember() gin.HandlerFunc
EnforceReadOnlyMember returns the gin middleware for the api service, configured with the api-specific denied reads.
func InitLaunchDarklyContext ¶
func LabelMetricsWithTeam ¶
func LabelMetricsWithTeam() gin.HandlerFunc
LabelMetricsWithTeam puts the authenticated team, its cluster and byoc (true for every cluster but the local one) on the request's metrics through the gin keys the metrics middleware reads once the chain has run, so the team the auth middleware resolves further down still labels the request.
func ReadRequestBody ¶
func ReadRequestBody(limit int64) gin.HandlerFunc
ReadRequestBody reads the whole request body, up to limit bytes, before the request validator runs, and answers a body it cannot read itself: 413 when it is over the limit, else 400. The validator reads a routed request's body before authenticating anyway, so reading it here first adds only a copy in memory. A request no route matches gets 404, and nothing reads its body.
func RefuseDeletedProject ¶
func RefuseDeletedProject(isProjectDeleted func(ctx context.Context, projectID uuid.UUID) (bool, error)) gin.HandlerFunc
RefuseDeletedProject answers 404 to a write addressed to a deleted project. A deleted project keeps its team row, so without this the handlers would still find it and apply the write.
func WithAPIGroup ¶
func WithAPIGroup(authenticate openapi3filter.AuthenticationFunc) openapi3filter.AuthenticationFunc
WithAPIGroup records the validator's matched API group in Gin after authentication succeeds.
Types ¶
This section is empty.