Documentation ¶
Index ¶
- Variables
- type Account
- func (*Account) Descriptor() ([]byte, []int)deprecated
- func (x *Account) GetAuthMethodId() string
- func (x *Account) GetCreateTime() *timestamp.Timestamp
- func (x *Account) GetDescription() string
- func (x *Account) GetLoginName() string
- func (x *Account) GetName() string
- func (x *Account) GetPublicId() string
- func (x *Account) GetUpdateTime() *timestamp.Timestamp
- func (x *Account) GetVersion() uint32
- func (*Account) ProtoMessage()
- func (x *Account) ProtoReflect() protoreflect.Message
- func (x *Account) Reset()
- func (x *Account) String() string
- type Argon2Configuration
- func (*Argon2Configuration) Descriptor() ([]byte, []int)deprecated
- func (x *Argon2Configuration) GetCreateTime() *timestamp.Timestamp
- func (x *Argon2Configuration) GetIterations() uint32
- func (x *Argon2Configuration) GetKeyLength() uint32
- func (x *Argon2Configuration) GetMemory() uint32
- func (x *Argon2Configuration) GetPasswordMethodId() string
- func (x *Argon2Configuration) GetPrivateId() string
- func (x *Argon2Configuration) GetSaltLength() uint32
- func (x *Argon2Configuration) GetThreads() uint32
- func (*Argon2Configuration) ProtoMessage()
- func (x *Argon2Configuration) ProtoReflect() protoreflect.Message
- func (x *Argon2Configuration) Reset()
- func (x *Argon2Configuration) String() string
- type Argon2Credential
- func (*Argon2Credential) Descriptor() ([]byte, []int)deprecated
- func (x *Argon2Credential) GetCreateTime() *timestamp.Timestamp
- func (x *Argon2Credential) GetCtSalt() []byte
- func (x *Argon2Credential) GetDerivedKey() []byte
- func (x *Argon2Credential) GetKeyId() string
- func (x *Argon2Credential) GetPasswordAccountId() string
- func (x *Argon2Credential) GetPasswordConfId() string
- func (x *Argon2Credential) GetPasswordMethodId() string
- func (x *Argon2Credential) GetPrivateId() string
- func (x *Argon2Credential) GetSalt() []byte
- func (x *Argon2Credential) GetUpdateTime() *timestamp.Timestamp
- func (*Argon2Credential) ProtoMessage()
- func (x *Argon2Credential) ProtoReflect() protoreflect.Message
- func (x *Argon2Credential) Reset()
- func (x *Argon2Credential) String() string
- type AuthMethod
- func (*AuthMethod) Descriptor() ([]byte, []int)deprecated
- func (x *AuthMethod) GetCreateTime() *timestamp.Timestamp
- func (x *AuthMethod) GetDescription() string
- func (x *AuthMethod) GetIsPrimaryAuthMethod() bool
- func (x *AuthMethod) GetMinLoginNameLength() uint32
- func (x *AuthMethod) GetMinPasswordLength() uint32
- func (x *AuthMethod) GetName() string
- func (x *AuthMethod) GetPasswordConfId() string
- func (x *AuthMethod) GetPublicId() string
- func (x *AuthMethod) GetScopeId() string
- func (x *AuthMethod) GetUpdateTime() *timestamp.Timestamp
- func (x *AuthMethod) GetVersion() uint32
- func (*AuthMethod) ProtoMessage()
- func (x *AuthMethod) ProtoReflect() protoreflect.Message
- func (x *AuthMethod) Reset()
- func (x *AuthMethod) String() string
- type Credential
- func (*Credential) Descriptor() ([]byte, []int)deprecated
- func (x *Credential) GetPasswordAccountId() string
- func (x *Credential) GetPasswordConfId() string
- func (x *Credential) GetPasswordMethodId() string
- func (x *Credential) GetPrivateId() string
- func (*Credential) ProtoMessage()
- func (x *Credential) ProtoReflect() protoreflect.Message
- func (x *Credential) Reset()
- func (x *Credential) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_controller_storage_auth_password_store_v1_argon2_proto protoreflect.FileDescriptor
View Source
var File_controller_storage_auth_password_store_v1_password_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct { // @inject_tag: `gorm:"primary_key"` PublicId string `protobuf:"bytes,1,opt,name=public_id,json=publicId,proto3" json:"public_id,omitempty" gorm:"primary_key"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // The update_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` UpdateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"` // name is optional. If set, it must be unique within scope_id. // @inject_tag: `gorm:"default:null"` Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty" gorm:"default:null"` // description is optional. // @inject_tag: `gorm:"default:null"` Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty" gorm:"default:null"` // @inject_tag: `gorm:"default:null"` Version uint32 `protobuf:"varint,6,opt,name=version,proto3" json:"version,omitempty" gorm:"default:null"` // @inject_tag: `gorm:"not_null"` AuthMethodId string `protobuf:"bytes,7,opt,name=auth_method_id,json=authMethodId,proto3" json:"auth_method_id,omitempty" gorm:"not_null"` // @inject_tag: `gorm:"not_null"` LoginName string `protobuf:"bytes,8,opt,name=login_name,json=loginName,proto3" json:"login_name,omitempty" gorm:"not_null"` // contains filtered or unexported fields }
func (*Account) Descriptor
deprecated
func (*Account) GetAuthMethodId ¶
func (*Account) GetCreateTime ¶
func (*Account) GetDescription ¶
func (*Account) GetLoginName ¶
func (*Account) GetPublicId ¶
func (*Account) GetUpdateTime ¶
func (*Account) GetVersion ¶
func (*Account) ProtoMessage ¶
func (*Account) ProtoMessage()
func (*Account) ProtoReflect ¶
func (x *Account) ProtoReflect() protoreflect.Message
type Argon2Configuration ¶
type Argon2Configuration struct { // @inject_tag: `gorm:"primary_key"` PrivateId string `protobuf:"bytes,1,opt,name=private_id,json=privateId,proto3" json:"private_id,omitempty" gorm:"primary_key"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // @inject_tag: `gorm:"not_null"` PasswordMethodId string `` /* 127-byte string literal not displayed */ // Iterations is the time parameter in the Argon2 specification. It // specifies the number of passes over the memory. Must be > 0. // @inject_tag: `gorm:"default:null"` Iterations uint32 `protobuf:"varint,4,opt,name=iterations,proto3" json:"iterations,omitempty" gorm:"default:null"` // Memory is the memory parameter in the Argon2 specification. It // specifies the size of the memory in KiB. For example Memory=32*1024 // sets the memory cost to ~32 MB. Must be > 0. // @inject_tag: `gorm:"default:null"` Memory uint32 `protobuf:"varint,5,opt,name=memory,proto3" json:"memory,omitempty" gorm:"default:null"` // Threads is the threads parameter in the Argon2 specification. It can // be adjusted to the number of available CPUs. Must be > 0. // @inject_tag: `gorm:"default:null"` Threads uint32 `protobuf:"varint,6,opt,name=threads,proto3" json:"threads,omitempty" gorm:"default:null"` // SaltLength is in bytes. Must be >= 16. // @inject_tag: `gorm:"default:null"` SaltLength uint32 `protobuf:"varint,7,opt,name=salt_length,json=saltLength,proto3" json:"salt_length,omitempty" gorm:"default:null"` // KeyLength is in bytes. Must be >= 16. // @inject_tag: `gorm:"default:null"` KeyLength uint32 `protobuf:"varint,8,opt,name=key_length,json=keyLength,proto3" json:"key_length,omitempty" gorm:"default:null"` // contains filtered or unexported fields }
Argon2Configuration is a configuration for using the argon2id key derivation function. It is owned by an AuthMethod.
Iterations, Memory, and Threads are the cost parameters. The cost parameters should be increased as memory latency and CPU parallelism increases.
For a detailed specification of Argon2 see: https://github.com/P-H-C/phc-winner-argon2/blob/master/argon2-specs.pdf
func (*Argon2Configuration) Descriptor
deprecated
func (*Argon2Configuration) Descriptor() ([]byte, []int)
Deprecated: Use Argon2Configuration.ProtoReflect.Descriptor instead.
func (*Argon2Configuration) GetCreateTime ¶
func (x *Argon2Configuration) GetCreateTime() *timestamp.Timestamp
func (*Argon2Configuration) GetIterations ¶
func (x *Argon2Configuration) GetIterations() uint32
func (*Argon2Configuration) GetKeyLength ¶
func (x *Argon2Configuration) GetKeyLength() uint32
func (*Argon2Configuration) GetMemory ¶
func (x *Argon2Configuration) GetMemory() uint32
func (*Argon2Configuration) GetPasswordMethodId ¶
func (x *Argon2Configuration) GetPasswordMethodId() string
func (*Argon2Configuration) GetPrivateId ¶
func (x *Argon2Configuration) GetPrivateId() string
func (*Argon2Configuration) GetSaltLength ¶
func (x *Argon2Configuration) GetSaltLength() uint32
func (*Argon2Configuration) GetThreads ¶
func (x *Argon2Configuration) GetThreads() uint32
func (*Argon2Configuration) ProtoMessage ¶
func (*Argon2Configuration) ProtoMessage()
func (*Argon2Configuration) ProtoReflect ¶
func (x *Argon2Configuration) ProtoReflect() protoreflect.Message
func (*Argon2Configuration) Reset ¶
func (x *Argon2Configuration) Reset()
func (*Argon2Configuration) String ¶
func (x *Argon2Configuration) String() string
type Argon2Credential ¶
type Argon2Credential struct { // @inject_tag: `gorm:"primary_key"` PrivateId string `protobuf:"bytes,1,opt,name=private_id,json=privateId,proto3" json:"private_id,omitempty" gorm:"primary_key"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // The update_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` UpdateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"` // @inject_tag: `gorm:"not_null"` PasswordAccountId string `` /* 130-byte string literal not displayed */ // @inject_tag: `gorm:"not_null"` PasswordConfId string `protobuf:"bytes,5,opt,name=password_conf_id,json=passwordConfId,proto3" json:"password_conf_id,omitempty" gorm:"not_null"` // @inject_tag: `gorm:"not_null"` PasswordMethodId string `` /* 127-byte string literal not displayed */ // ct_salt is the encrypted salt which is stored in the database. // @inject_tag: `gorm:"column:salt;not_null" wrapping:"ct,entry_salt"` CtSalt []byte `` /* 132-byte string literal not displayed */ // salt is the unencrypted salt which is not stored in the database. // @inject_tag: `gorm:"-" wrapping:"pt,entry_salt"` Salt []byte `protobuf:"bytes,8,opt,name=salt,proto3" json:"salt,omitempty" gorm:"-" wrapping:"pt,entry_salt"` // derived_key is the derived key produced by the Argon2id key // derivation function. // @inject_tag: `gorm:"not_null"` DerivedKey []byte `protobuf:"bytes,9,opt,name=derived_key,json=derivedKey,proto3" json:"derived_key,omitempty" gorm:"not_null"` // key_id is the key ID that was used for the encryption operation. It can be // used to identify a specific version of the key needed to decrypt the value, // which is useful for caching purposes. // @inject_tag: `gorm:"not_null"` KeyId string `protobuf:"bytes,10,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty" gorm:"not_null"` // contains filtered or unexported fields }
func (*Argon2Credential) Descriptor
deprecated
func (*Argon2Credential) Descriptor() ([]byte, []int)
Deprecated: Use Argon2Credential.ProtoReflect.Descriptor instead.
func (*Argon2Credential) GetCreateTime ¶
func (x *Argon2Credential) GetCreateTime() *timestamp.Timestamp
func (*Argon2Credential) GetCtSalt ¶
func (x *Argon2Credential) GetCtSalt() []byte
func (*Argon2Credential) GetDerivedKey ¶
func (x *Argon2Credential) GetDerivedKey() []byte
func (*Argon2Credential) GetKeyId ¶
func (x *Argon2Credential) GetKeyId() string
func (*Argon2Credential) GetPasswordAccountId ¶
func (x *Argon2Credential) GetPasswordAccountId() string
func (*Argon2Credential) GetPasswordConfId ¶
func (x *Argon2Credential) GetPasswordConfId() string
func (*Argon2Credential) GetPasswordMethodId ¶
func (x *Argon2Credential) GetPasswordMethodId() string
func (*Argon2Credential) GetPrivateId ¶
func (x *Argon2Credential) GetPrivateId() string
func (*Argon2Credential) GetSalt ¶
func (x *Argon2Credential) GetSalt() []byte
func (*Argon2Credential) GetUpdateTime ¶
func (x *Argon2Credential) GetUpdateTime() *timestamp.Timestamp
func (*Argon2Credential) ProtoMessage ¶
func (*Argon2Credential) ProtoMessage()
func (*Argon2Credential) ProtoReflect ¶
func (x *Argon2Credential) ProtoReflect() protoreflect.Message
func (*Argon2Credential) Reset ¶
func (x *Argon2Credential) Reset()
func (*Argon2Credential) String ¶
func (x *Argon2Credential) String() string
type AuthMethod ¶
type AuthMethod struct { // @inject_tag: `gorm:"primary_key"` PublicId string `protobuf:"bytes,1,opt,name=public_id,json=publicId,proto3" json:"public_id,omitempty" gorm:"primary_key"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // The update_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` UpdateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"` // name is optional. If set, it must be unique within scope_id. // @inject_tag: `gorm:"default:null"` Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty" gorm:"default:null"` // description is optional. // @inject_tag: `gorm:"default:null"` Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty" gorm:"default:null"` // The scope_id of the owning scope. Must be set. // @inject_tag: `gorm:"not_null"` ScopeId string `protobuf:"bytes,6,opt,name=scope_id,json=scopeId,proto3" json:"scope_id,omitempty" gorm:"not_null"` // @inject_tag: `gorm:"default:null"` Version uint32 `protobuf:"varint,7,opt,name=version,proto3" json:"version,omitempty" gorm:"default:null"` // @inject_tag: `gorm:"not_null"` PasswordConfId string `protobuf:"bytes,8,opt,name=password_conf_id,json=passwordConfId,proto3" json:"password_conf_id,omitempty" gorm:"not_null"` // @inject_tag: `gorm:"default:null"` MinLoginNameLength uint32 `` /* 140-byte string literal not displayed */ // @inject_tag: `gorm:"default:null"` MinPasswordLength uint32 `` /* 136-byte string literal not displayed */ // is_primary_auth_method is a read-only output field which indicates if the // auth method is set as the scope's primary auth method. // @inject_tag: `gorm:"-"` IsPrimaryAuthMethod bool `` /* 133-byte string literal not displayed */ // contains filtered or unexported fields }
func (*AuthMethod) Descriptor
deprecated
func (*AuthMethod) Descriptor() ([]byte, []int)
Deprecated: Use AuthMethod.ProtoReflect.Descriptor instead.
func (*AuthMethod) GetCreateTime ¶
func (x *AuthMethod) GetCreateTime() *timestamp.Timestamp
func (*AuthMethod) GetDescription ¶
func (x *AuthMethod) GetDescription() string
func (*AuthMethod) GetIsPrimaryAuthMethod ¶ added in v0.2.0
func (x *AuthMethod) GetIsPrimaryAuthMethod() bool
func (*AuthMethod) GetMinLoginNameLength ¶
func (x *AuthMethod) GetMinLoginNameLength() uint32
func (*AuthMethod) GetMinPasswordLength ¶
func (x *AuthMethod) GetMinPasswordLength() uint32
func (*AuthMethod) GetName ¶
func (x *AuthMethod) GetName() string
func (*AuthMethod) GetPasswordConfId ¶
func (x *AuthMethod) GetPasswordConfId() string
func (*AuthMethod) GetPublicId ¶
func (x *AuthMethod) GetPublicId() string
func (*AuthMethod) GetScopeId ¶
func (x *AuthMethod) GetScopeId() string
func (*AuthMethod) GetUpdateTime ¶
func (x *AuthMethod) GetUpdateTime() *timestamp.Timestamp
func (*AuthMethod) GetVersion ¶
func (x *AuthMethod) GetVersion() uint32
func (*AuthMethod) ProtoMessage ¶
func (*AuthMethod) ProtoMessage()
func (*AuthMethod) ProtoReflect ¶
func (x *AuthMethod) ProtoReflect() protoreflect.Message
func (*AuthMethod) Reset ¶
func (x *AuthMethod) Reset()
func (*AuthMethod) String ¶
func (x *AuthMethod) String() string
type Credential ¶
type Credential struct { // @inject_tag: `gorm:"primary_key"` PrivateId string `protobuf:"bytes,1,opt,name=private_id,json=privateId,proto3" json:"private_id,omitempty" gorm:"primary_key"` // @inject_tag: `gorm:"not_null"` PasswordAccountId string `` /* 130-byte string literal not displayed */ // @inject_tag: `gorm:"not_null"` PasswordConfId string `protobuf:"bytes,3,opt,name=password_conf_id,json=passwordConfId,proto3" json:"password_conf_id,omitempty" gorm:"not_null"` // @inject_tag: `gorm:"not_null"` PasswordMethodId string `` /* 127-byte string literal not displayed */ // contains filtered or unexported fields }
func (*Credential) Descriptor
deprecated
func (*Credential) Descriptor() ([]byte, []int)
Deprecated: Use Credential.ProtoReflect.Descriptor instead.
func (*Credential) GetPasswordAccountId ¶
func (x *Credential) GetPasswordAccountId() string
func (*Credential) GetPasswordConfId ¶
func (x *Credential) GetPasswordConfId() string
func (*Credential) GetPasswordMethodId ¶
func (x *Credential) GetPasswordMethodId() string
func (*Credential) GetPrivateId ¶
func (x *Credential) GetPrivateId() string
func (*Credential) ProtoMessage ¶
func (*Credential) ProtoMessage()
func (*Credential) ProtoReflect ¶
func (x *Credential) ProtoReflect() protoreflect.Message
func (*Credential) Reset ¶
func (x *Credential) Reset()
func (*Credential) String ¶
func (x *Credential) String() string
Click to show internal directories.
Click to hide internal directories.