Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrTenantNotResolved = errors.New("approval: cannot resolve caller tenant from principal")
ErrTenantNotResolved indicates the resolver received a principal whose Details shape doesn't expose a tenant_id / tenantId / TenantID key. The resource layer surfaces this as an authentication failure so a misconfigured host can't accidentally serve cross-tenant data through a zero-value CallerContext.
var Module = fx.Module( "vef:approval:auth", fx.Provide( fx.Annotate( NewDefaultPrincipalTenantResolver, fx.As(new(approval.PrincipalTenantResolver)), ), fx.Annotate( NewDefaultInstanceGlobalsResolver, fx.As(new(approval.InstanceGlobalsResolver)), ), ), )
Module provides identity-resolution defaults (tenant resolver, instance globals resolver). Hosts override a resolver via fx.Replace — the tenant resolver when their principal carries tenant info in a typed struct instead of a generic map, the globals resolver when their flows route on host-defined global variables.
Functions ¶
func NewDefaultInstanceGlobalsResolver ¶ added in v0.35.0
func NewDefaultInstanceGlobalsResolver() approval.InstanceGlobalsResolver
NewDefaultInstanceGlobalsResolver constructs the default resolver.
func NewDefaultPrincipalTenantResolver ¶
func NewDefaultPrincipalTenantResolver() approval.PrincipalTenantResolver
NewDefaultPrincipalTenantResolver constructs the default resolver.
Types ¶
type DefaultInstanceGlobalsResolver ¶ added in v0.35.0
type DefaultInstanceGlobalsResolver struct{}
DefaultInstanceGlobalsResolver resolves no globals: flows route on form data and the built-in applicant subjects only. Hosts whose flows reference global variables (tenant attributes, applicant roles, business limits, …) replace it via fx.Replace with a resolver that derives them server-side from their own principal / business context.
type DefaultPrincipalTenantResolver ¶
type DefaultPrincipalTenantResolver struct{}
DefaultPrincipalTenantResolver extracts the tenant id from Principal.Details. It handles two common shapes:
- map[string]any (JWT claims deserialized without a typed model) — looks up the candidate keys in order.
- typed struct or pointer to struct — looks up the candidate field names in order via reflection.
Anonymous and system principals (Details == nil) are explicitly recognized: they return an empty tenant without an error so the resource layer can treat them as needing an explicit fallback (e.g. the system caller marker). Authenticated principals whose Details does not expose a tenant return ErrTenantNotResolved — fail-closed.
Source Files