Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

auth

package

Go to main page

Versions in this module

v0

v0.9.1

Jan 1, 2024

Changes in this version

+ const ClientVersion

+ const DefaultDeviceName

+ const DefaultKeeperServer

+ const DefaultLocale

+ const SessionRestriction_AcceptInvite

+ const SessionRestriction_AccountExpired

+ const SessionRestriction_AccountRecovery

+ const SessionRestriction_ShareAccount

+ const SessionRestriction_Unrestricted

+ func AdjustServerName(servername string) string

+ func AdjustUserName(username string) string

+ func CopyConfiguration(fromConfig IKeeperConfiguration, toConfig IKeeperConfiguration)

+ func GetTeamKeys(keeperAuth IKeeperAuth, teamKeys map[string][]byte) (errs []error)

+ func GetUserPublicKeys(keeperAuth IKeeperAuth, userKeys map[string]*PublicKeys) (errs []error)

+ func PrepareApiRequest(keyId int32, payload []byte, transmissionKey []byte, sessionToken []byte, ...) (result *proto_auth.ApiRequest, err error)

+ type AccountAuthType int32

+ const AuthType_ManagedCompany

+ const AuthType_OnsiteSso

+ const AuthType_Regular

+ const AuthType_SsoCloud

+ type DataKeyShareChannel = int32

+ const DataKeyShare_AdminApproval

+ const DataKeyShare_KeeperPush

+ type DeviceApprovalChannel = int32

+ const DeviceApproval_Email

+ const DeviceApproval_KeeperPush

+ const DeviceApproval_TwoFactorAuth

+ type DeviceConfiguration struct

+ func CloneDeviceConfiguration(other IDeviceConfiguration) *DeviceConfiguration

+ func NewDeviceConfiguration(deviceToken string, deviceKey []byte) *DeviceConfiguration

+ func (d *DeviceConfiguration) DeviceKey() []byte

+ func (d *DeviceConfiguration) DeviceToken() string

+ func (d *DeviceConfiguration) Id() string

+ func (d *DeviceConfiguration) ServerInfo() IConfigurationCollection[IDeviceServerConfiguration]

+ type DeviceServerConfiguration struct

+ func CloneDeviceServerConfiguration(other IDeviceServerConfiguration) *DeviceServerConfiguration

+ func NewDeviceServerConfiguration(server string) *DeviceServerConfiguration

+ func (ds *DeviceServerConfiguration) CloneCode() string

+ func (ds *DeviceServerConfiguration) Id() string

+ func (ds *DeviceServerConfiguration) Server() string

+ func (ds *DeviceServerConfiguration) SetCloneCode(cloneCode string)

+ type IAuthContext interface

+ AccountUid func() string

+ ClientKey func() []byte

+ DataKey func() []byte

+ DevicePrivateKey func() *ecdh.PrivateKey

+ DeviceToken func() []byte

+ EcPrivateKey func() *ecdh.PrivateKey

+ EcPublicKey func() *ecdh.PublicKey

+ Enforcements func() *proto_account_summary.Enforcements

+ EnterpriseEcPublicKey func() *ecdh.PublicKey

+ EnterpriseRsaPublicKey func() *rsa.PublicKey

+ IsEnterpriseAdmin func() bool

+ License func() *proto_account_summary.License

+ RsaPrivateKey func() *rsa.PrivateKey

+ SessionRestriction func() SessionRestriction

+ SessionToken func() []byte

+ Settings func() *proto_account_summary.Settings

+ SsoLoginInfo func() ISsoLoginInfo

+ Username func() string

+ type IConfigurationCollection interface

+ Delete func(string)

+ Get func(string) T

+ List func(func(T) bool)

+ Put func(T)

+ type IConfigurationStorage interface

+ Get func() (IKeeperConfiguration, error)

+ Put func(IKeeperConfiguration) error

+ func NewCommanderConfiguration(filename string) IConfigurationStorage

+ func NewInMemoryConfigurationStorage(configuration IKeeperConfiguration) IConfigurationStorage

+ func NewJsonConfigurationFile(filePath string) IConfigurationStorage

+ func NewJsonConfigurationStorage(loader IJsonConfigurationLoader) IConfigurationStorage

+ type IConnectedStep interface

+ TakeKeeperAuth func() (IKeeperAuth, error)

+ type IDeviceApprovalStep interface

+ Resume func() error

+ SendCode func(DeviceApprovalChannel, string) error

+ SendPush func(DeviceApprovalChannel) error

+ type IDeviceConfiguration interface

+ DeviceKey func() []byte

+ DeviceToken func() string

+ ServerInfo func() IConfigurationCollection[IDeviceServerConfiguration]

+ type IDeviceServerConfiguration interface

+ CloneCode func() string

+ Server func() string

+ type IEntityId interface

+ Id func() string

+ type IErrorStep interface

+ Error func() error

+ type IJsonConfigurationLoader interface

+ LoadJson func() ([]byte, error)

+ StoreJson func([]byte) error

+ func NewJsonConfigurationFileLoader(filename string) IJsonConfigurationLoader

+ type IKeeperAuth interface

+ AuthContext func() IAuthContext

+ Endpoint func() IKeeperEndpoint

+ ExecuteAuthCommand func(api.IKeeperCommand, api.IKeeperResponse, bool) error

+ ExecuteAuthRest func(string, proto.Message, proto.Message) error

+ ExecuteBatch func([]api.IKeeperCommand) ([]*api.KeeperApiResponse, error)

+ OnIdle func()

+ PushNotifications func() IPushEndpoint

+ type IKeeperConfiguration interface

+ Devices func() IConfigurationCollection[IDeviceConfiguration]

+ LastLogin func() string

+ LastServer func() string

+ Servers func() IConfigurationCollection[IServerConfiguration]

+ SetLastLogin func(string)

+ SetLastServer func(string)

+ Users func() IConfigurationCollection[IUserConfiguration]

+ type IKeeperEndpoint interface

+ ClientVersion func() string

+ CommunicateKeeper func(string, []byte, []byte) ([]byte, error)

+ ConfigurationStorage func() IConfigurationStorage

+ ConnectToPushServer func(*proto_auth.WssConnectionRequest) (IPushEndpoint, error)

+ DeviceName func() string

+ Locale func() string

+ PushServer func() string

+ Server func() string

+ ServerKeyId func() int32

+ SetClientVersion func(string)

+ SetDeviceName func(string)

+ SetLocale func(string)

+ SetServer func(string)

+ func NewKeeperEndpoint(server string, storage IConfigurationStorage) IKeeperEndpoint

+ type ILoginAuth interface

+ AlternatePassword func() bool

+ Endpoint func() IKeeperEndpoint

+ Login func(string, ...string)

+ LoginSso func(string)

+ OnNextStep func() func()

+ OnRegionChanged func() func(string)

+ ResumeSession func() bool

+ SetAlternatePassword func(bool)

+ SetOnNextStep func(func())

+ SetOnRegionChanged func(func(string))

+ SetResumeSession func(bool)

+ Step func() ILoginStep

+ func NewLoginAuth(endpoint IKeeperEndpoint) ILoginAuth

+ type ILoginStep interface

+ LoginState func() LoginState

+ type IPasswordStep interface

+ Username func() string

+ VerifyBiometricKey func([]byte) error

+ VerifyPassword func(string) error

+ type IPushEndpoint interface

+ IsClosed func() bool

+ Push func(*NotificationEvent)

+ RegisterCallback func(PushCallback)

+ RemoveAllCallback func()

+ RemoveCallback func(PushCallback)

+ SendToPushChannel func([]byte, bool) error

+ func NewWebSocketEndpoint(url string, key []byte) IPushEndpoint

+ type IServerConfiguration interface

+ Server func() string

+ ServerKeyId func() int32

+ type ISsoDataKeyStep interface

+ Channels func() []DataKeyShareChannel

+ RequestDataKey func(DataKeyShareChannel) error

+ Resume func() error

+ type ISsoLoginInfo interface

+ IdpSessionId func() string

+ IsCloud func() bool

+ SsoProvider func() string

+ SsoUrl func() string

+ type ISsoTokenStep interface

+ IsCloudSso func() bool

+ LoginAsProvider func() bool

+ LoginName func() string

+ LoginWithPassword func() error

+ SetSsoToken func(string) error

+ SsoLoginUrl func() string

+ type ITwoFactorChannelInfo interface

+ ChannelName func() string

+ ChannelType func() TwoFactorChannel

+ ChannelUid func() []byte

+ MaxDuration func() TwoFactorDuration

+ Phone func() string

+ PushActions func() []TwoFactorPushAction

+ type ITwoFactorStep interface

+ Channels func() []ITwoFactorChannelInfo

+ Duration func() TwoFactorDuration

+ Resume func() error

+ SendCode func([]byte, string) error

+ SendPush func([]byte, TwoFactorPushAction) error

+ SetDuration func(TwoFactorDuration)

+ type IUserConfiguration interface

+ LastDevice func() IUserDeviceConfiguration

+ Password func() string

+ Server func() string

+ Username func() string

+ type IUserDeviceConfiguration interface

+ DeviceToken func() string

+ type KeeperConfiguration struct

+ func CloneKeeperConfiguration(other IKeeperConfiguration) *KeeperConfiguration

+ func NewKeeperConfiguration() *KeeperConfiguration

+ func (c *KeeperConfiguration) Devices() IConfigurationCollection[IDeviceConfiguration]

+ func (c *KeeperConfiguration) LastLogin() string

+ func (c *KeeperConfiguration) LastServer() string

+ func (c *KeeperConfiguration) Servers() IConfigurationCollection[IServerConfiguration]

+ func (c *KeeperConfiguration) SetLastLogin(lastLogin string)

+ func (c *KeeperConfiguration) SetLastServer(lastServer string)

+ func (c *KeeperConfiguration) Users() IConfigurationCollection[IUserConfiguration]

+ type LoginState = int

+ const LoginState_Connected

+ const LoginState_DeviceApproval

+ const LoginState_Error

+ const LoginState_Password

+ const LoginState_Ready

+ const LoginState_SsoDataKey

+ const LoginState_SsoToken

+ const LoginState_TwoFactor

+ type NotificationEvent struct

+ Approved bool

+ Command string

+ DeviceName string

+ Email string

+ EncryptedDeviceToken string

+ EncryptedLoginToken string

+ Event string

+ IPAddress string

+ Message string

+ Passcode string

+ Sync bool

+ Username string

+ type PublicKeys struct

+ EcPublicKey *ecdh.PublicKey

+ RsaPublicKey *rsa.PublicKey

+ type PushCallback = func(*NotificationEvent) bool

+ type PushEndpoint struct

+ func (p *PushEndpoint) Close() error

+ func (p *PushEndpoint) IsClosed() bool

+ func (p *PushEndpoint) Push(event *NotificationEvent)

+ func (p *PushEndpoint) RegisterCallback(cb PushCallback)

+ func (p *PushEndpoint) RemoveAllCallback()

+ func (p *PushEndpoint) RemoveCallback(cb PushCallback)

+ func (p *PushEndpoint) SendToPushChannel(_ []byte, _ bool) error

+ type ServerConfiguration struct

+ func CloneServerConfiguration(other IServerConfiguration) *ServerConfiguration

+ func NewServerConfiguration(server string) *ServerConfiguration

+ func (s *ServerConfiguration) Id() string

+ func (s *ServerConfiguration) Server() string

+ func (s *ServerConfiguration) ServerKeyId() int32

+ func (s *ServerConfiguration) SetServerKeyId(keyId int32)

+ type SessionRestriction int32

+ func (r SessionRestriction) Has(restriction SessionRestriction) bool

+ type TwoFactorChannel = int32

+ const TwoFactorChannel_Authenticator

+ const TwoFactorChannel_Backup

+ const TwoFactorChannel_DuoSecurity

+ const TwoFactorChannel_KeeperDNA

+ const TwoFactorChannel_Other

+ const TwoFactorChannel_RSASecurID

+ const TwoFactorChannel_SecurityKey

+ const TwoFactorChannel_TextMessage

+ type TwoFactorDuration = int32

+ const TwoFactorDuration_Every12Hour

+ const TwoFactorDuration_Every30Days

+ const TwoFactorDuration_EveryDay

+ const TwoFactorDuration_EveryLogin

+ const TwoFactorDuration_Forever

+ type TwoFactorPushAction = int32

+ const TwoFactorAction_DuoPush

+ const TwoFactorAction_DuoTextMessage

+ const TwoFactorAction_DuoVoiceCall

+ const TwoFactorAction_KeeperDna

+ const TwoFactorAction_TextMessage

+ type UserConfiguration struct

+ func CloneUserConfiguration(other IUserConfiguration) *UserConfiguration

+ func NewUserConfiguration(username string) *UserConfiguration

+ func (u *UserConfiguration) Id() string

+ func (u *UserConfiguration) LastDevice() IUserDeviceConfiguration

+ func (u *UserConfiguration) Password() string

+ func (u *UserConfiguration) Server() string

+ func (u *UserConfiguration) SetLastDevice(lastDevice IUserDeviceConfiguration)

+ func (u *UserConfiguration) SetPassword(password string)

+ func (u *UserConfiguration) SetServer(server string)

+ func (u *UserConfiguration) Username() string

+ type UserDeviceConfiguration struct

+ func CloneUserDeviceConfiguration(other IUserDeviceConfiguration) *UserDeviceConfiguration

+ func NewUserDeviceConfiguration(deviceToken string) *UserDeviceConfiguration

+ func (ud *UserDeviceConfiguration) DeviceToken() string

+ func (ud *UserDeviceConfiguration) Id() string

v0.9.0-alpha3

Dec 30, 2023

retracted

v0.9.0-alpha2

Dec 30, 2023

retracted

v0.9.0-alpha1

Dec 20, 2023

retracted

v0.9.0-alpha

Dec 20, 2023

retracted