cpi

README

Context Provider Interface for credential providers

Documentation

Index

• Constants
• Variables
• func ErrUnknownCredentials(name string) error
• func ErrUnknownRepository(kind, name string) error
• func RegisterRepositoryType(rtype RepositoryType)
• func RegisterRepositoryTypeVersions(s RepositoryTypeVersionScheme)
• func RegisterStandardIdentity(typ string, matcher IdentityMatcher, desc string, attrs string)
• func RegisterStandardIdentityMatcher(typ string, matcher IdentityMatcher, desc string)
• type AliasRegistry
• type ConsumerIdentity
  • func NewConsumerIdentity(typ string, attrs ...string) ConsumerIdentity
• type ConsumerIdentityProvider
• type ConsumerProvider
• type Context
  • func FromProvider(p ContextProvider) Context
  • func New(m ...datacontext.BuilderMode) Context
• type ContextProvider
• type Credentials
  • func CredentialsForConsumer(ctx ContextProvider, id ConsumerIdentity, matchers ...IdentityMatcher) (Credentials, error)
  • func NewCredentials(props common.Properties) Credentials
  • func RequiredCredentialsForConsumer(ctx ContextProvider, id ConsumerIdentity, matchers ...IdentityMatcher) (Credentials, error)
• type CredentialsChain
• type CredentialsSource
• type CredentialsSpec
  • func NewCredentialsSpec(name string, repospec RepositorySpec) CredentialsSpec
• type DirectCredentials
• type GenericCredentialsSpec
  • func NewGenericCredentialsSpec(name string, repospec *GenericRepositorySpec) *GenericCredentialsSpec
  • func ToGenericCredentialsSpec(spec CredentialsSpec) (*GenericCredentialsSpec, error)
• type GenericRepositorySpec
  • func ToGenericRepositorySpec(spec RepositorySpec) (*GenericRepositorySpec, error)
• type IdentityMatcher
• type IdentityMatcherInfo
• type IdentityMatcherRegistry
• type ProviderIdentity
• type Repository
• type RepositoryOption
  • func WithDescription(v string) RepositoryOption
  • func WithFormatSpec(v string) RepositoryOption
• type RepositorySpec
• type RepositoryType
  • func NewAliasRegistry(t RepositoryType, setter internal.SetAliasFunction) RepositoryType
  • func NewRepositoryType[I RepositorySpec](name string, opts ...RepositoryOption) RepositoryType
  • func NewRepositoryTypeByConverter[I RepositorySpec, V runtime.TypedObject](name string, converter runtime.Converter[I, V], opts ...RepositoryOption) RepositoryType
  • func NewRepositoryTypeByFormatVersion(name string, fmt runtime.FormatVersion[RepositorySpec], ...) RepositoryType
• type RepositoryTypeProvider
• type RepositoryTypeScheme
• type RepositoryTypeVersionScheme
  • func NewRepositoryTypeVersionScheme(kind string) RepositoryTypeVersionScheme
• type StringUsageContext
• type UsageContext

Constants

const (
	ID_TYPE = internal.ID_TYPE

	ATTR_TYPE                  = internal.ATTR_TYPE
	ATTR_USERNAME              = internal.ATTR_USERNAME
	ATTR_EMAIL                 = internal.ATTR_EMAIL
	ATTR_PASSWORD              = internal.ATTR_PASSWORD
	ATTR_SERVER_ADDRESS        = internal.ATTR_SERVER_ADDRESS
	ATTR_TOKEN                 = internal.ATTR_TOKEN
	ATTR_IDENTITY_TOKEN        = internal.ATTR_IDENTITY_TOKEN
	ATTR_REGISTRY_TOKEN        = internal.ATTR_REGISTRY_TOKEN
	ATTR_KEY                   = internal.ATTR_KEY
	ATTR_CERTIFICATE_AUTHORITY = internal.ATTR_CERTIFICATE_AUTHORITY
	ATTR_CERTIFICATE           = internal.ATTR_CERTIFICATE
	ATTR_PRIVATE_KEY           = internal.ATTR_PRIVATE_KEY
)

const (
	KIND_CREDENTIALS = internal.KIND_CREDENTIALS
	KIND_REPOSITORY  = internal.KIND_REPOSITORY
)

const AliasRepositoryType = internal.AliasRepositoryType

const CONTEXT_TYPE = internal.CONTEXT_TYPE

Variables

var (
	CompleteMatch = internal.CompleteMatch
	NoMatch       = internal.NoMatch
	PartialMatch  = internal.PartialMatch
)

var DefaultContext = internal.DefaultContext

Functions

func ErrUnknownCredentials

func ErrUnknownCredentials(name string) error

func ErrUnknownRepository

func ErrUnknownRepository(kind, name string) error

func RegisterRepositoryType

func RegisterRepositoryType(rtype RepositoryType)

func RegisterRepositoryTypeVersions

func RegisterRepositoryTypeVersions(s RepositoryTypeVersionScheme)

func RegisterStandardIdentity

func RegisterStandardIdentity(typ string, matcher IdentityMatcher, desc string, attrs string)

func RegisterStandardIdentityMatcher

func RegisterStandardIdentityMatcher(typ string, matcher IdentityMatcher, desc string)

Types

type AliasRegistry

type AliasRegistry = internal.AliasRegistry

type ConsumerIdentity

type ConsumerIdentity = internal.ConsumerIdentity

func NewConsumerIdentity

func NewConsumerIdentity(typ string, attrs ...string) ConsumerIdentity

type ConsumerIdentityProvider

type ConsumerIdentityProvider = internal.ConsumerIdentityProvider

type ConsumerProvider

type ConsumerProvider = internal.ConsumerProvider

type Context

type Context = internal.Context

func FromProvider

func FromProvider(p ContextProvider) Context

func New

func New(m ...datacontext.BuilderMode) Context

type ContextProvider

type ContextProvider = internal.ContextProvider

type Credentials

type Credentials = internal.Credentials

func CredentialsForConsumer

func CredentialsForConsumer(ctx ContextProvider, id ConsumerIdentity, matchers ...IdentityMatcher) (Credentials, error)

func NewCredentials

func NewCredentials(props common.Properties) Credentials

func RequiredCredentialsForConsumer

func RequiredCredentialsForConsumer(ctx ContextProvider, id ConsumerIdentity, matchers ...IdentityMatcher) (Credentials, error)

type CredentialsChain

type CredentialsChain = internal.CredentialsChain

type CredentialsSource

type CredentialsSource = internal.CredentialsSource

type CredentialsSpec

type CredentialsSpec = internal.CredentialsSpec

func NewCredentialsSpec

func NewCredentialsSpec(name string, repospec RepositorySpec) CredentialsSpec

type DirectCredentials

type DirectCredentials = internal.DirectCredentials

type GenericCredentialsSpec

type GenericCredentialsSpec = internal.GenericCredentialsSpec

func NewGenericCredentialsSpec

func NewGenericCredentialsSpec(name string, repospec *GenericRepositorySpec) *GenericCredentialsSpec

func ToGenericCredentialsSpec

func ToGenericCredentialsSpec(spec CredentialsSpec) (*GenericCredentialsSpec, error)

type GenericRepositorySpec

type GenericRepositorySpec = internal.GenericRepositorySpec

func ToGenericRepositorySpec

func ToGenericRepositorySpec(spec RepositorySpec) (*GenericRepositorySpec, error)

type IdentityMatcher

type IdentityMatcher = internal.IdentityMatcher

type IdentityMatcherInfo

type IdentityMatcherInfo = internal.IdentityMatcherInfo

type IdentityMatcherRegistry

type IdentityMatcherRegistry = internal.IdentityMatcherRegistry

type ProviderIdentity

type ProviderIdentity = internal.ProviderIdentity

type Repository

type Repository = internal.Repository

type RepositoryOption

type RepositoryOption = descriptivetype.Option

func WithDescription

func WithDescription(v string) RepositoryOption

func WithFormatSpec

func WithFormatSpec(v string) RepositoryOption

type RepositorySpec

type RepositorySpec = internal.RepositorySpec

type RepositoryType

type RepositoryType = internal.RepositoryType

func NewAliasRegistry

func NewAliasRegistry(t RepositoryType, setter internal.SetAliasFunction) RepositoryType

func NewRepositoryType

func NewRepositoryType[I RepositorySpec](name string, opts ...RepositoryOption) RepositoryType

func NewRepositoryTypeByConverter

func NewRepositoryTypeByConverter[I RepositorySpec, V runtime.TypedObject](name string, converter runtime.Converter[I, V], opts ...RepositoryOption) RepositoryType

func NewRepositoryTypeByFormatVersion

func NewRepositoryTypeByFormatVersion(name string, fmt runtime.FormatVersion[RepositorySpec], opts ...RepositoryOption) RepositoryType

type RepositoryTypeProvider

type RepositoryTypeProvider = internal.RepositoryTypeProvider

type RepositoryTypeScheme

type RepositoryTypeScheme = internal.RepositoryTypeScheme

type RepositoryTypeVersionScheme

type RepositoryTypeVersionScheme = runtime.TypeVersionScheme[RepositorySpec, RepositoryType]

func NewRepositoryTypeVersionScheme

func NewRepositoryTypeVersionScheme(kind string) RepositoryTypeVersionScheme

type StringUsageContext

type StringUsageContext = internal.StringUsageContext

type UsageContext

type UsageContext = internal.UsageContext