auth

package
v0.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

README

Platform93 Server Authorization

Verifier.Verify validates ordinary application JWTs and deliberately rejects resource_access tokens. Resource backends instead use ResourceAuthorizer:

authorizer := auth.ResourceAuthorizer{
    Verifier: verifier,
    Resource: "https://resource.example/api",
    MachineClient: machineClient,
}
claims, err := authorizer.Authorize(ctx, bearerToken, "documents:read", workspaceID)

Use an empty workspace ID for personal access. machineClient is a sdk/go/client.Client granted the application's resource_access:check permission. Every successful call includes local JWT validation and a fresh live check. Denial, malformed decisions, and service failures return errors, never authorized claims. There is no offline fallback or positive decision cache. Resource JWTs are limited to 16 KiB.

ResourceMetadata builds protected-resource discovery metadata with canonical capability scopes. ResourceChallenge validates and escapes a WWW-Authenticate value. Both reject non-HTTPS, query-bearing, or fragment-bearing resource URIs.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CapabilityScope added in v0.5.0

func CapabilityScope(applicationID, capability string) (string, error)

func ResourceChallenge added in v0.5.0

func ResourceChallenge(metadataURI, code, description string) (string, error)

Types

type Actor

type Actor struct {
	Subject string `json:"sub"`
	Type    string `json:"type"`
}

type Claims

type Claims struct {
	Issuer        string         `json:"iss"`
	Subject       string         `json:"sub"`
	Audience      []string       `json:"aud"`
	ExpiresAt     int64          `json:"exp"`
	IssuedAt      int64          `json:"iat"`
	NotBefore     int64          `json:"nbf"`
	ApplicationID string         `json:"application_id"`
	TokenKind     string         `json:"token_kind"`
	ActorType     string         `json:"actor_type"`
	Scope         string         `json:"scope"`
	Roles         RoleClaims     `json:"roles"`
	Locale        string         `json:"locale,omitempty"`
	EmailVerified bool           `json:"email_verified"`
	IsOrgVerified bool           `json:"is_org_verified"`
	CustomClaims  map[string]any `json:"custom_claims,omitempty"`
	Actor         *Actor         `json:"act,omitempty"`
	SessionID     string         `json:"sid,omitempty"`
	ClientID      string         `json:"client_id,omitempty"`
	ConnectionID  string         `json:"connection_id,omitempty"`
}

func (Claims) HasPermission

func (c Claims) HasPermission(permission string) bool

type ProtectedResourceMetadata added in v0.5.0

type ProtectedResourceMetadata struct {
	Resource             string   `json:"resource"`
	AuthorizationServers []string `json:"authorization_servers"`
	ScopesSupported      []string `json:"scopes_supported"`
}

func ResourceMetadata added in v0.5.0

func ResourceMetadata(resource, issuer, applicationID string, capabilities []string) (ProtectedResourceMetadata, error)

type ResourceAuthorizer added in v0.5.0

type ResourceAuthorizer struct {
	Verifier      *Verifier
	Resource      string
	MachineClient ResourceCheckClient
}

func (*ResourceAuthorizer) Authorize added in v0.5.0

func (a *ResourceAuthorizer) Authorize(ctx context.Context, token, capability, workspaceID string) (Claims, error)

Authorize never caches decisions and never authorizes without a live check.

type ResourceCheckClient added in v0.5.0

type ResourceCheckClient interface {
	CheckResourceAccess(context.Context, client.ResourceAccessCheckRequest) (client.ResourceAccessCheckResponse, error)
}

type RoleClaims

type RoleClaims struct {
	Application []string            `json:"application"`
	Workspaces  map[string][]string `json:"workspaces"`
}

type Verifier

type Verifier struct {
	Issuer, Audience, ApplicationID string
	Client                          *http.Client
	// contains filtered or unexported fields
}

func (*Verifier) Verify

func (v *Verifier) Verify(ctx context.Context, token string) (Claims, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL