lighthouse

package module

Go to main page

Versions in this module

v0

v0.20.3

May 28, 2026

v0.20.2

May 18, 2026

v0.20.1

May 12, 2026

v0.20.0

May 4, 2026

Changes in this version

+ const KMSFilesystem

+ const KMSPKCS11

+ const MaximumEntityConfigurationCachePeriod

+ const PKBackendDatabase

+ const PKBackendFilesystem

+ type AdminAPIOptions struct

+ ActorHeader string

+ ActorSource string

+ CORS CORSConf

+ Enabled bool

+ Port int

+ UsersEnabled bool

+ type CORSConf struct

+ AllowCredentials bool

+ AllowHeaders string

+ AllowMethods string

+ AllowOrigins string

+ Enabled bool

+ ExposeHeaders string

+ MaxAge int

+ type CheckerContext struct

+ Store model.TrustMarkedEntitiesStorageBackend

+ TrustMarkType string

+ type ContextualEntityChecker interface

+ SetContext func(ctx CheckerContext)

+ type DBListEntityChecker struct

+ func (*DBListEntityChecker) UnmarshalYAML(_ *yaml.Node) error

+ func (c *DBListEntityChecker) Check(entityConfiguration *oidfed.EntityStatement, _ []string) (bool, int, *oidfed.Error)

+ func (c *DBListEntityChecker) SetContext(ctx CheckerContext)

+ type DBTrustMarkSpecProvider struct

+ func NewDBTrustMarkSpecProvider(store model.TrustMarkSpecStore) *DBTrustMarkSpecProvider

+ func (p *DBTrustMarkSpecProvider) GetTrustMarkSpec(trustMarkType string) *oidfed.TrustMarkSpec

+ func (p *DBTrustMarkSpecProvider) TrustMarkTypes() []string

+ type EligibilityCache struct

+ func NewEligibilityCache() *EligibilityCache

+ func (c *EligibilityCache) CleanExpired() int

+ func (c *EligibilityCache) Clear()

+ func (c *EligibilityCache) Get(trustMarkType, subject string) (eligible bool, httpCode int, reason string, found bool)

+ func (c *EligibilityCache) Invalidate(trustMarkType, subject string)

+ func (c *EligibilityCache) InvalidateAll(trustMarkType string)

+ func (c *EligibilityCache) InvalidateType(trustMarkType string)

+ func (c *EligibilityCache) Set(trustMarkType, subject string, eligible bool, httpCode int, reason string, ...)

+ func (c *EligibilityCache) Size() int

+ func (c *EligibilityCache) StartCleanupRoutine(interval time.Duration) (stop func())

type EntityChecker

+ func EntityCheckerFromJSONConfig(checkerType string, config map[string]any) (EntityChecker, error)

+ type HTTPListEntityChecker struct

+ CacheTTL int

+ Headers map[string]string

+ Method string

+ Timeout int

+ URL string

+ func (c *HTTPListEntityChecker) Check(entityConfiguration *oidfed.EntityStatement, _ []string) (bool, int, *oidfed.Error)

+ func (c *HTTPListEntityChecker) UnmarshalYAML(node *yaml.Node) error

+ type HTTPListJWTEntityChecker struct

+ CacheTTL int

+ Headers map[string]string

+ ListClaim string

+ Method string

+ Timeout int

+ URL string

+ Verification JWTVerification

+ func (c *HTTPListJWTEntityChecker) Check(entityConfiguration *oidfed.EntityStatement, _ []string) (bool, int, *oidfed.Error)

+ func (c *HTTPListJWTEntityChecker) UnmarshalYAML(node *yaml.Node) error

+ type IssuedTrustMarkCache struct

+ func NewIssuedTrustMarkCache() *IssuedTrustMarkCache

+ func (c *IssuedTrustMarkCache) CleanExpired() int

+ func (c *IssuedTrustMarkCache) Clear()

+ func (c *IssuedTrustMarkCache) Get(trustMarkType, subject string) (string, bool)

+ func (c *IssuedTrustMarkCache) Invalidate(trustMarkType, subject string)

+ func (c *IssuedTrustMarkCache) InvalidateAll(trustMarkType string)

+ func (c *IssuedTrustMarkCache) Set(trustMarkType, subject, trustMarkJWT string, ttl time.Duration)

+ func (c *IssuedTrustMarkCache) Size() int

+ func (c *IssuedTrustMarkCache) StartCleanupRoutine(interval time.Duration) (stop func())

+ type JWTVerification struct

+ JWKS *jwx.JWKS

+ Mode JWTVerificationMode

+ TrustAnchors oidfed.TrustAnchors

+ type JWTVerificationMode string

+ const JWTVerificationModeJWKS

+ const JWTVerificationModeTrustAnchor

type LightHouse

+ func (fed *LightHouse) AddTrustMarkEndpointWithConfig(endpoint EndpointConf, config TrustMarkEndpointConfig)

+ func (fed *LightHouse) Stop() error

type ServerConf

+ AdminAPIPort int

+ CORS CORSConf

+ IPListen string

+ Prefork bool

+ type SigningConf struct

+ AutoGenerateKeys bool

+ FileSystemBackend struct{ ... }

+ KMS string

+ PKBackend string

+ PKCS11Backend struct{ ... }

+ type SubordinateListingRequest struct

+ EntityType []string

+ Intermediate bool

+ TrustMarkType string

+ TrustMarked bool

+ type TrustMarkEndpointConfig struct

+ Cache *EligibilityCache

+ Checkers map[string]EntityChecker

+ InstanceStore model.IssuedTrustMarkInstanceStore

+ IssuedTrustMarkCache *IssuedTrustMarkCache

+ SpecStore model.TrustMarkSpecStore

+ Store model.TrustMarkedEntitiesStorageBackend

+ type TrustMarkStatusConfig struct

+ InstanceStore model.IssuedTrustMarkInstanceStore

+ type TrustMarkStatusResponse struct

+ IssuedAt int64

+ Issuer string

+ Status string

+ TrustMark string

v0.20.0-pr3

Mar 18, 2026

v0.20.0-pr2

Mar 16, 2026

v0.20.0-pr1

Mar 16, 2026

v0.8.4

Mar 2, 2026

v0.8.3

Dec 2, 2025

Changes in this version

type LightHouse

+ LogoBanner bool

+ VersionBanner bool

v0.8.2

Nov 20, 2025

v0.8.1

Nov 19, 2025

v0.8.0

Oct 30, 2025

v0.7.0

Aug 22, 2025

Changes in this version

type ServerConf

+ ForwardedIPHeader string

+ TrustedProxies []string

v0.6.0

Aug 4, 2025

Changes in this version

type LightHouse

+ func (fed *LightHouse) AddHistoricalKeysEndpoint(endpoint EndpointConf, historyFnc func() jwx.JWKS)

v0.5.1

Jun 18, 2025

v0.5.0

Jun 17, 2025

Changes in this version

+ var FiberServerConfig = fiber.Config

+ func RegisterEntityChecker(configTypeName string, constructor func() EntityChecker)

+ type AuthorityHintEntityChecker struct

+ EntityID string

+ func (c *AuthorityHintEntityChecker) UnmarshalYAML(node *yaml.Node) error

+ func (c AuthorityHintEntityChecker) Check(entityConfiguration *oidfed.EntityStatement, _ []string) (bool, int, *oidfed.Error)

+ type EndpointConf struct

+ Path string

+ URL string

+ func (c *EndpointConf) ValidateURL(rootURL string) string

+ func (c EndpointConf) IsSet() bool

+ type EntityChecker interface

+ Check func(entityConfiguration *oidfed.EntityStatement, entityTypes []string) (bool, int, *oidfed.Error)

+ func EntityCheckerFromEntityCheckerConfig(c EntityCheckerConfig) (EntityChecker, error)

+ func EntityCheckerFromYAMLConfig(config []byte) (EntityChecker, error)

+ type EntityCheckerConfig struct

+ Config yaml.Node

+ Type string

+ type EntityCheckerNone struct

+ func (EntityCheckerNone) Check(_ *oidfed.EntityStatement, _ []string) (bool, int, *oidfed.Error)

+ func (EntityCheckerNone) UnmarshalYAML(_ *yaml.Node) error

+ type EntityIDEntityChecker struct

+ AllowedIDs []string

+ func (c *EntityIDEntityChecker) UnmarshalYAML(node *yaml.Node) error

+ func (c EntityIDEntityChecker) Check(entityConfiguration *oidfed.EntityStatement, _ []string) (bool, int, *oidfed.Error)

+ type LightHouse struct

+ func NewLightHouse(entityID string, authorityHints []string, metadata *oidfed.Metadata, ...) (*LightHouse, error)

+ func (fed *LightHouse) AddEnrollEndpoint(endpoint EndpointConf, store storage.SubordinateStorageBackend, ...)

+ func (fed *LightHouse) AddEnrollRequestEndpoint(endpoint EndpointConf, store storage.SubordinateStorageBackend)

+ func (fed *LightHouse) AddEntityCollectionEndpoint(endpoint EndpointConf)

+ func (fed *LightHouse) AddFetchEndpoint(endpoint EndpointConf, store storage.SubordinateStorageBackend)

+ func (fed *LightHouse) AddResolveEndpoint(endpoint EndpointConf)

+ func (fed *LightHouse) AddSubordinateListingEndpoint(endpoint EndpointConf, store storage.SubordinateStorageBackend, ...)

+ func (fed *LightHouse) AddTrustMarkEndpoint(endpoint EndpointConf, store storage.TrustMarkedEntitiesStorageBackend, ...)

+ func (fed *LightHouse) AddTrustMarkRequestEndpoint(endpoint EndpointConf, store storage.TrustMarkedEntitiesStorageBackend)

+ func (fed *LightHouse) AddTrustMarkStatusEndpoint(endpoint EndpointConf, store storage.TrustMarkedEntitiesStorageBackend)

+ func (fed *LightHouse) AddTrustMarkedEntitiesListingEndpoint(endpoint EndpointConf, store storage.TrustMarkedEntitiesStorageBackend)

+ func (fed LightHouse) CreateSubordinateStatement(subordinate *storage.SubordinateInfo) oidfed.EntityStatementPayload

+ func (fed LightHouse) HttpHandlerFunc() http.HandlerFunc

+ func (fed LightHouse) Listen(addr string) error

+ func (fed LightHouse) Start(conf ServerConf)

+ type MultipleEntityCheckerAnd struct

+ Checkers []EntityChecker

+ func NewMultipleEntityCheckerAnd(checkers ...EntityChecker) *MultipleEntityCheckerAnd

+ func (c *MultipleEntityCheckerAnd) UnmarshalYAML(node *yaml.Node) error

+ func (c MultipleEntityCheckerAnd) Check(entityStatement ..., entityTypes []string) (bool, int, *oidfed.Error)

+ type MultipleEntityCheckerOr struct

+ Checkers []EntityChecker

+ func NewMultipleEntityCheckerOr(checkers ...EntityChecker) *MultipleEntityCheckerOr

+ func (c *MultipleEntityCheckerOr) UnmarshalYAML(node *yaml.Node) error

+ func (c MultipleEntityCheckerOr) Check(entityStatement *oidfed.EntityStatement, entityTypes []string) (bool, int, *oidfed.Error)

+ type ServerConf struct

+ Port int

+ TLS tlsConf

+ type SubordinateStatementsConfig struct

+ Constraints *oidfed.ConstraintSpecification

+ CriticalExtensions []string

+ Extra map[string]any

+ MetadataPolicies *oidfed.MetadataPolicies

+ MetadataPolicyCrit []oidfed.PolicyOperatorName

+ SubordinateStatementLifetime int64

+ type TrustMarkEntityChecker struct

+ TrustAnchors oidfed.TrustAnchors

+ TrustMarkIssuerJWKS jwks.JWKS

+ TrustMarkOwnerSpec oidfed.TrustMarkOwnerSpec

+ TrustMarkType string

+ func (c *TrustMarkEntityChecker) UnmarshalYAML(node *yaml.Node) error

+ func (c TrustMarkEntityChecker) Check(entityConfiguration *oidfed.EntityStatement, entityTypes []string) (bool, int, *oidfed.Error)

+ type TrustPathEntityChecker struct

+ TrustAnchors oidfed.TrustAnchors

+ func (c *TrustPathEntityChecker) UnmarshalYAML(node *yaml.Node) error

+ func (c TrustPathEntityChecker) Check(entityConfiguration *oidfed.EntityStatement, entityTypes []string) (bool, int, *oidfed.Error)

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