Documentation
¶
Overview ¶
Package auth provides resources related to the authentication.
Index ¶
- Constants
- func Enabled(res *Config) bool
- type AccessPolicy
- type AccessPolicyExtension
- type AccessPolicySpec
- type Config
- type ConfigExtension
- type ConfigSpec
- type Identity
- type IdentityExtension
- type IdentitySpec
- type PublicKey
- type PublicKeyExtension
- type PublicKeySpec
- type SAMLAssertion
- type SAMLAssertionExtension
- type SAMLAssertionSpec
- type SAMLLabelRule
- type SAMLLabelRuleExtension
- type SAMLLabelRuleSpec
- type User
- type UserExtension
- type UserSpec
Constants ¶
const ( // AccessPolicyID is the ID of AccessPolicy resource. AccessPolicyID = "access-policy" // AccessPolicyType is the type of AccessPolicy resource. // // tsgen:AccessPolicyType AccessPolicyType = resource.Type("AccessPolicies.omni.sidero.dev") )
const ( // LabelPublicKeyUserID is the label that defines the user ID of the public key. LabelPublicKeyUserID = "user-id" // LabelIdentityUserID is a label linking identity to the user. // tsgen:LabelIdentityUserID LabelIdentityUserID = "user-id" // LabelIdentityTypeServiceAccount is set when the type of the identity is service account. // tsgen:LabelIdentityTypeServiceAccount LabelIdentityTypeServiceAccount = "type-service-account" )
const ( // LabelSAMLRole is the roles attribute that is copied from SAML assertion. LabelSAMLRole = SAMLLabelPrefix + "role" // LabelSAMLGroups is the groups attribute that is copied from SAML assertion. LabelSAMLGroups = SAMLLabelPrefix + "groups" )
const ( // AuthConfigType is the type of Config resource. // // tsgen:AuthConfigType AuthConfigType = resource.Type("AuthConfigs.omni.sidero.dev") )
const ( // ConfigID is the resource ID under which the authentication parameters for auth0 & webauthn will be written to COSI state. // tsgen:AuthConfigID ConfigID = "auth-config" )
const ( // IdentityType is the type of Identity resource. // // tsgen:IdentityType IdentityType = resource.Type("Identities.omni.sidero.dev") )
const ( // PublicKeyType is the type of PublicKey resource. // // tsgen:PublicKeyType PublicKeyType = resource.Type("PublicKeys.omni.sidero.dev") )
const ( // SAMLAssertionType is the type of SAMLAssertion resource. SAMLAssertionType = resource.Type("SAMLAssertions.omni.sidero.dev") )
const ( // SAMLLabelPrefix is the prefix added to all SAML attributes on the User resource. // tsgen:SAMLLabelPrefix SAMLLabelPrefix = "saml.omni.sidero.dev/" )
const ( // SAMLLabelRuleType is the type of SAMLLabelRule resource. // // tsgen:SAMLLabelRuleType SAMLLabelRuleType = resource.Type("SAMLLabelRules.omni.sidero.dev") )
const ( // UserType is the type of User resource. // // tsgen:UserType UserType = resource.Type("Users.omni.sidero.dev") )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AccessPolicy ¶
type AccessPolicy = typed.Resource[AccessPolicySpec, AccessPolicyExtension]
AccessPolicy resource describes a user ACL.
func NewAccessPolicy ¶
func NewAccessPolicy() *AccessPolicy
NewAccessPolicy creates new AccessPolicy resource.
type AccessPolicyExtension ¶
type AccessPolicyExtension struct{}
AccessPolicyExtension providers auxiliary methods for AccessPolicy resource.
func (AccessPolicyExtension) ResourceDefinition ¶
func (AccessPolicyExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type AccessPolicySpec ¶
type AccessPolicySpec = protobuf.ResourceSpec[specs.AccessPolicySpec, *specs.AccessPolicySpec]
AccessPolicySpec wraps specs.AccessPolicySpec.
type Config ¶
type Config = typed.Resource[ConfigSpec, ConfigExtension]
Config resource is the Omni authentication configuration.
Config resource ID is a human-readable string without white-space that uniquely identifies the installation media.
type ConfigExtension ¶
type ConfigExtension struct{}
ConfigExtension providers auxiliary methods for Config resource.
func (ConfigExtension) ResourceDefinition ¶
func (ConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type ConfigSpec ¶
type ConfigSpec = protobuf.ResourceSpec[specs.AuthConfigSpec, *specs.AuthConfigSpec]
ConfigSpec wraps specs.AuthConfigSpec.
type Identity ¶
type Identity = typed.Resource[IdentitySpec, IdentityExtension]
Identity resource describes a user identity.
func NewIdentity ¶
NewIdentity creates a new Identity resource.
type IdentityExtension ¶
type IdentityExtension struct{}
IdentityExtension providers auxiliary methods for Identity resource.
func (IdentityExtension) ResourceDefinition ¶
func (IdentityExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type IdentitySpec ¶
type IdentitySpec = protobuf.ResourceSpec[specs.IdentitySpec, *specs.IdentitySpec]
IdentitySpec wraps specs.IdentitySpec.
type PublicKey ¶
type PublicKey = typed.Resource[PublicKeySpec, PublicKeyExtension]
PublicKey resource describes a user public key.
func NewPublicKey ¶
NewPublicKey creates a new PublicKey resource.
type PublicKeyExtension ¶
type PublicKeyExtension struct{}
PublicKeyExtension providers auxiliary methods for PublicKey resource.
func (PublicKeyExtension) ResourceDefinition ¶
func (PublicKeyExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type PublicKeySpec ¶
type PublicKeySpec = protobuf.ResourceSpec[specs.PublicKeySpec, *specs.PublicKeySpec]
PublicKeySpec wraps specs.PublicKeySpec.
type SAMLAssertion ¶
type SAMLAssertion = typed.Resource[SAMLAssertionSpec, SAMLAssertionExtension]
SAMLAssertion resource describes SAML assertion.
func NewSAMLAssertion ¶
func NewSAMLAssertion(ns, id string) *SAMLAssertion
NewSAMLAssertion creates a new SAMLAssertion resource.
type SAMLAssertionExtension ¶
type SAMLAssertionExtension struct{}
SAMLAssertionExtension providers auxiliary methods for SAMLAssertion resource.
func (SAMLAssertionExtension) ResourceDefinition ¶
func (SAMLAssertionExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type SAMLAssertionSpec ¶
type SAMLAssertionSpec = protobuf.ResourceSpec[specs.SAMLAssertionSpec, *specs.SAMLAssertionSpec]
SAMLAssertionSpec wraps specs.SAMLAssertionSpec.
type SAMLLabelRule ¶
type SAMLLabelRule = typed.Resource[SAMLLabelRuleSpec, SAMLLabelRuleExtension]
SAMLLabelRule resource describes a SAML label rule.
func NewSAMLLabelRule ¶
func NewSAMLLabelRule(ns, id string) *SAMLLabelRule
NewSAMLLabelRule creates a new SAMLLabelRule resource.
type SAMLLabelRuleExtension ¶
type SAMLLabelRuleExtension struct{}
SAMLLabelRuleExtension providers auxiliary methods for SAMLLabelRule resource.
func (SAMLLabelRuleExtension) ResourceDefinition ¶
func (SAMLLabelRuleExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type SAMLLabelRuleSpec ¶
type SAMLLabelRuleSpec = protobuf.ResourceSpec[specs.SAMLLabelRuleSpec, *specs.SAMLLabelRuleSpec]
SAMLLabelRuleSpec wraps specs.SAMLLabelRuleSpec.
type UserExtension ¶
type UserExtension struct{}
UserExtension providers auxiliary methods for User resource.
func (UserExtension) ResourceDefinition ¶
func (UserExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.