configuration

package

v0.2.61 Latest Latest Go to latest Published: Jul 30, 2026 License: MIT Imports: 5 Imported by: 0

Details

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

Repository

github.com/codefly-dev/core

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func LooksSecret(value string) bool
func ValidateOpaqueReference(reference string) error
type BrowserExposure
type Classification
type ConsumerClass
type Contract
type CredentialPurpose
type Key
type Mutator
type Provenance
type Registry
- func NewRegistry() *Registry
type Value
type ValueType

Constants ¶

View Source

const (
	BillingContract            = "codefly.dev/configuration/billing@1"
	EmailContract              = "codefly.dev/configuration/email@1"
	ErrorTrackingContract      = "codefly.dev/configuration/error-tracking@1"
	ErrorTrackingBuildContract = "codefly.dev/configuration/error-tracking-build@1"
)

Variables ¶

This section is empty.

Functions ¶

func LooksSecret ¶

func LooksSecret(value string) bool

func ValidateOpaqueReference ¶

func ValidateOpaqueReference(reference string) error

Types ¶

type BrowserExposure ¶

type BrowserExposure string

const (
	BrowserDenied  BrowserExposure = "denied"
	BrowserAllowed BrowserExposure = "allowed"
)

type Classification ¶

type Classification string

const (
	ClassificationPublic    Classification = "public"
	ClassificationSensitive Classification = "sensitive"
	ClassificationSecret    Classification = "secret"
)

type ConsumerClass ¶

type ConsumerClass string

const (
	ConsumerRuntime ConsumerClass = "runtime"
	ConsumerBrowser ConsumerClass = "browser"
	ConsumerBuild   ConsumerClass = "build"
)

type Contract ¶

type Contract struct {
	ID   string
	Keys map[string]Key
}

type CredentialPurpose ¶

type CredentialPurpose string

const (
	PurposeNone                CredentialPurpose = "none"
	PurposeManagement          CredentialPurpose = "management"
	PurposeRuntime             CredentialPurpose = "runtime"
	PurposeBuild               CredentialPurpose = "build"
	PurposeWebhookVerification CredentialPurpose = "webhook-verification"
)

type Key ¶

type Key struct {
	Type                  ValueType
	Required              bool
	ClassificationFloor   Classification
	ClassificationCeiling Classification
	CredentialPurpose     CredentialPurpose
	BrowserExposure       BrowserExposure
	Consumer              ConsumerClass
	ProviderMutable       bool
	HostMutable           bool
	RequiredProvenance    []Provenance
}

type Mutator ¶

type Mutator string

const (
	MutatorHost     Mutator = "host"
	MutatorProvider Mutator = "provider"
)

type Provenance ¶

type Provenance string

const (
	ProvenanceProvider Provenance = "provider"
	ProvenanceBinding  Provenance = "binding"
	ProvenanceArtifact Provenance = "artifact"
	ProvenanceHost     Provenance = "host"
)

type Registry ¶

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

func NewRegistry ¶

func NewRegistry() *Registry

func (*Registry) Contracts ¶

func (r *Registry) Contracts() []string

func (*Registry) Lookup ¶

func (r *Registry) Lookup(id string) (Contract, error)

func (*Registry) Validate ¶

func (r *Registry) Validate(id string, values map[string]Value) error

type Value ¶

type Value struct {
	Type              ValueType
	String            string
	Boolean           bool
	Integer           int64
	OpaqueReference   string
	Classification    Classification
	CredentialPurpose CredentialPurpose
	BrowserExposure   BrowserExposure
	Consumer          ConsumerClass
	MutatedBy         Mutator
	Provenance        map[Provenance]string
}

type ValueType ¶

type ValueType string

const (
	ValueString          ValueType = "string"
	ValueBoolean         ValueType = "boolean"
	ValueInteger         ValueType = "integer"
	ValueOpaqueReference ValueType = "opaque-reference"
)

Source Files ¶

View all Source files

registry.go

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