auth

package

v0.5.0 Latest Latest Go to latest Published: Aug 13, 2026 License: AGPL-3.0 Imports: 37 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/agentstation/starmap

Links

Open Source Insights

Documentation ¶

Overview ¶

Package auth resolves and reports catalog-acquisition credentials.

Index ¶

type Checker
- func NewChecker(options ...CheckerOption) *Checker
- func (c *Checker) CheckProvider(provider *catalogs.Provider, supportedMap map[string]bool) *Status
type CheckerOption
- func WithCredentialResolver(resolver sources.ProviderCredentialResolver) CheckerOption
type CredentialFieldKey
type ProfileDetails
type Reference
- func ParseReference(value string) (Reference, error)
type ReferenceBackend
type ReferencePolicy
type Resolver
- func NewResolver(options ...ResolverOption) *Resolver
- func (r *Resolver) ResolveCatalog(ctx context.Context, provider *catalogs.Provider) (sources.ProviderCredentialMaterial, error)
type ResolverOption
- func WithReferencePolicies(policies map[CredentialFieldKey]ReferencePolicy) ResolverOption
type SourceErrorKind
type State
type Status

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Checker ¶

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

Checker checks authentication status for providers.

func NewChecker ¶

func NewChecker(options ...CheckerOption) *Checker

NewChecker creates a new authentication checker.

func (*Checker) CheckProvider ¶

func (c *Checker) CheckProvider(
	provider *catalogs.Provider,
	supportedMap map[string]bool,
) *Status

CheckProvider checks local catalog-acquisition authentication state.

type CheckerOption ¶ added in v0.3.0

type CheckerOption func(*Checker)

CheckerOption configures a Checker.

func WithCredentialResolver ¶ added in v0.3.0

func WithCredentialResolver(resolver sources.ProviderCredentialResolver) CheckerOption

WithCredentialResolver replaces catalog credential resolution.

type CredentialFieldKey ¶ added in v0.4.0

type CredentialFieldKey struct {
	ProviderID catalogs.ProviderID
	FieldID    catalogs.ProviderCredentialFieldID
}

CredentialFieldKey identifies one deployment-owned provider field policy.

type ProfileDetails ¶ added in v0.4.0

type ProfileDetails struct {
	ID        catalogs.ProviderCredentialProfileID
	Primitive catalogs.ProviderAuthenticationPrimitive
}

ProfileDetails identifies the selected secret-free authentication profile.

type Reference ¶ added in v0.4.0

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

Reference identifies one operator-selected credential source without containing source authentication values.

func ParseReference ¶ added in v0.4.0

func ParseReference(value string) (Reference, error)

ParseReference parses backend:resource?version=VERSION#field syntax.

type ReferenceBackend ¶ added in v0.4.0

type ReferenceBackend string

ReferenceBackend identifies one credential source primitive.

type ReferencePolicy ¶ added in v0.4.0

type ReferencePolicy struct {
	Reference       Reference
	FallbackAmbient bool
}

ReferencePolicy selects an explicit source and an optional not-configured fallback to ambient discovery.

type Resolver ¶ added in v0.4.0

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

Resolver selects catalog-declared authentication primitives and resolves deployment-owned credential sources. It contains no provider roster.

func NewResolver ¶ added in v0.4.0

func NewResolver(options ...ResolverOption) *Resolver

NewResolver creates the built-in catalog credential resolver.

func (*Resolver) ResolveCatalog ¶ added in v0.4.0

func (r *Resolver) ResolveCatalog(
	ctx context.Context,
	provider *catalogs.Provider,
) (sources.ProviderCredentialMaterial, error)

ResolveCatalog resolves the first configured catalog-acquisition profile. A malformed or unavailable selected explicit source is terminal unless its policy permits a not-configured ambient fallback.

type ResolverOption ¶ added in v0.4.0

type ResolverOption func(*Resolver)

ResolverOption configures credential resolution.

func WithReferencePolicies ¶ added in v0.4.0

func WithReferencePolicies(policies map[CredentialFieldKey]ReferencePolicy) ResolverOption

WithReferencePolicies configures deployment-owned field references.

type SourceErrorKind ¶ added in v0.4.0

type SourceErrorKind string

SourceErrorKind classifies a secret-free credential source failure.

const (
	// SourceErrorNotConfigured means that the selected source has no material.
	SourceErrorNotConfigured SourceErrorKind = "not_configured"
	// SourceErrorDenied means that source access or authentication was denied.
	SourceErrorDenied SourceErrorKind = "denied"
	// SourceErrorInvalid means that the source reference or material is invalid.
	SourceErrorInvalid SourceErrorKind = "invalid"
	// SourceErrorUnavailable means that a configured source could not complete.
	SourceErrorUnavailable SourceErrorKind = "unavailable"
)

type State ¶

type State int

State represents the authentication state of a provider.

const (
	// StateConfigured means the provider has credentials configured.
	StateConfigured State = iota
	// StateMissing means required credentials are missing.
	StateMissing
	// StateInvalid means credentials are found but malformed or invalid.
	StateInvalid
	// StateOptional means the provider has optional or no auth requirements.
	StateOptional
	// StateUnsupported means the provider has no client implementation.
	StateUnsupported
)

type Status ¶

type Status struct {
	State   State
	Summary string
	Profile *ProfileDetails
}

Status represents catalog-acquisition authentication status.

Source Files ¶

View all Source files

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