Documentation ¶
Overview ¶
PaperKeyPrimary creates the initial paper backup key for a user. It differs from the PaperKey engine in that it already knows the signing key and it doesn't offer to revoke any devices, plus it uses a different UI call to display the phrase.
PerUserKeyRoll creates a new per-user-key for the active user. This can be the first per-user-key for the user.
PerUserKeyUpgrade creates a per-user-key for the active user if they do not already have one. It adds a per-user-key link to the sigchain and adds the key to the local keyring.
PerUserKeyUpkeep rolls the user's per-user-key if the last PUK was added by a now-revoked device. Does not add a first per-user-key. Use PerUserKeyUpgrade for that. This engine makes up for the fact that after a self-deprovision the latest PUK for a user was generated on the very machine they wanted to deprovision. This will not notice if a device revoked another device but neglected to roll the PUK. No clients should do that.
Index ¶
- Variables
- func CheckUsernameAvailable(g *libkb.GlobalContext, s string) (err error)
- func GetFullName(m libkb.MetaContext, uid keybase1.UID) (string, error)
- func GetMySecretKey(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, ...) (libkb.GenericKey, error)
- func GetPGPExportPassphrase(m libkb.MetaContext, ui libkb.SecretUI, desc string) (keybase1.GetPassphraseRes, error)
- func LoadScanProofsIgnore(filepath string) ([]string, error)
- func OutputSignatureSuccess(m libkb.MetaContext, fingerprint libkb.PGPFingerprint, owner *libkb.User, ...) error
- func OutputSignatureSuccessNonKeybase(m libkb.MetaContext, keyID uint64, signatureTime time.Time) error
- func PGPCheckMulti(me *libkb.User, allowMulti bool) (err error)
- func PerUserKeyUpgradeBackgroundRound(m libkb.MetaContext) error
- func PerUserKeyUpkeepBackgroundRound(m libkb.MetaContext) error
- func RunEngine2(m libkb.MetaContext, e Engine2) (err error)
- func SignED25519(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, ...) (ret keybase1.ED25519SignatureInfo, err error)
- func SignED25519ForKBFS(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, ...) (ret keybase1.ED25519SignatureInfo, err error)
- func SignToString(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, ...) (sig string, err error)
- func UnboxBytes32(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, ...) (bytes32 keybase1.Bytes32, err error)
- func UnboxBytes32Any(m libkb.MetaContext, getSecretUI func() libkb.SecretUI, ...) (res keybase1.UnboxAnyRes, err error)
- func WalletInitBackgroundRound(m libkb.MetaContext) error
- func WalletUpkeepBackgroundRound(m libkb.MetaContext) error
- type AccountDelete
- type BackgroundIdentifier
- func (b *BackgroundIdentifier) Add(u keybase1.UID) bool
- func (b *BackgroundIdentifier) Name() string
- func (b *BackgroundIdentifier) Prereqs() Prereqs
- func (b *BackgroundIdentifier) Remove(u keybase1.UID)
- func (b *BackgroundIdentifier) RequiredUIs() []libkb.UIKind
- func (b *BackgroundIdentifier) Run(m libkb.MetaContext) (err error)
- func (b *BackgroundIdentifier) SetSnooperChannel(ch chan<- IdentifyJob)
- func (b *BackgroundIdentifier) SubConsumers() []libkb.UIConsumer
- type BackgroundIdentifierSettings
- type BackgroundIdentifierTestArgs
- type BackgroundTask
- type BackgroundTaskArgs
- type BackgroundTaskSettings
- type Bootstrap
- type CheckError
- type CryptocurrencyEngine
- func (e *CryptocurrencyEngine) Name() string
- func (e *CryptocurrencyEngine) Prereqs() Prereqs
- func (e *CryptocurrencyEngine) RequiredUIs() []libkb.UIKind
- func (e *CryptocurrencyEngine) Result() keybase1.RegisterAddressRes
- func (e *CryptocurrencyEngine) Run(m libkb.MetaContext) (err error)
- func (e *CryptocurrencyEngine) SubConsumers() []libkb.UIConsumer
- type DeprovisionEngine
- type DevList
- type DeviceAdd
- type DeviceHistory
- func (e *DeviceHistory) Devices() []keybase1.DeviceDetail
- func (e *DeviceHistory) Name() string
- func (e *DeviceHistory) Prereqs() Prereqs
- func (e *DeviceHistory) RequiredUIs() []libkb.UIKind
- func (e *DeviceHistory) Run(m libkb.MetaContext) error
- func (e *DeviceHistory) SubConsumers() []libkb.UIConsumer
- type DeviceKeyfinder
- func (e *DeviceKeyfinder) Name() string
- func (e *DeviceKeyfinder) Prereqs() Prereqs
- func (e *DeviceKeyfinder) RequiredUIs() []libkb.UIKind
- func (e *DeviceKeyfinder) Run(m libkb.MetaContext) (err error)
- func (e *DeviceKeyfinder) SubConsumers() []libkb.UIConsumer
- func (e *DeviceKeyfinder) UsersPlusKeys() map[keybase1.UID](*keybase1.UserPlusKeys)
- type DeviceKeyfinderArg
- type DeviceKeygen
- func (e *DeviceKeygen) EncryptionKey() libkb.NaclDHKeyPair
- func (e *DeviceKeygen) Name() string
- func (e *DeviceKeygen) Prereqs() Prereqs
- func (e *DeviceKeygen) Push(m libkb.MetaContext, pargs *DeviceKeygenPushArgs) error
- func (e *DeviceKeygen) RequiredUIs() []libkb.UIKind
- func (e *DeviceKeygen) Run(m libkb.MetaContext) (err error)
- func (e *DeviceKeygen) SigningKey() libkb.NaclKeyPair
- func (e *DeviceKeygen) SigningKeyPublic() (libkb.NaclSigningKeyPublic, error)
- func (e *DeviceKeygen) SubConsumers() []libkb.UIConsumer
- type DeviceKeygenArgs
- type DeviceKeygenPushArgs
- type DeviceWrap
- func (e *DeviceWrap) DeviceID() keybase1.DeviceID
- func (e *DeviceWrap) EncryptionKey() libkb.NaclDHKeyPair
- func (e *DeviceWrap) Name() string
- func (e *DeviceWrap) Prereqs() Prereqs
- func (e *DeviceWrap) RequiredUIs() []libkb.UIKind
- func (e *DeviceWrap) Run(m libkb.MetaContext) (err error)
- func (e *DeviceWrap) SigningKey() libkb.GenericKey
- func (e *DeviceWrap) SubConsumers() []libkb.UIConsumer
- type DeviceWrapArgs
- type EmailChange
- type Engine2
- type FavoriteAdd
- func (e *FavoriteAdd) Name() string
- func (e *FavoriteAdd) Prereqs() Prereqs
- func (e *FavoriteAdd) RequiredUIs() []libkb.UIKind
- func (e *FavoriteAdd) Run(m libkb.MetaContext) error
- func (e *FavoriteAdd) SubConsumers() []libkb.UIConsumer
- func (e *FavoriteAdd) Wait()
- func (e *FavoriteAdd) WantDelegate(kind libkb.UIKind) bool
- type FavoriteIgnore
- type FavoriteList
- type FavoritesAPIResult
- type GPGExportingError
- type GPGImportKeyArg
- type GPGImportKeyEngine
- func (e *GPGImportKeyEngine) LastKey() *libkb.PGPKeyBundle
- func (e *GPGImportKeyEngine) Name() string
- func (e *GPGImportKeyEngine) Prereqs() Prereqs
- func (e *GPGImportKeyEngine) RequiredUIs() []libkb.UIKind
- func (e *GPGImportKeyEngine) Run(m libkb.MetaContext) (err error)
- func (e *GPGImportKeyEngine) SubConsumers() []libkb.UIConsumer
- func (e *GPGImportKeyEngine) WantsGPG(m libkb.MetaContext) (bool, error)
- type HasServerKeys
- func (e *HasServerKeys) GetResult() keybase1.HasServerKeysRes
- func (e *HasServerKeys) Name() string
- func (e *HasServerKeys) Prereqs() Prereqs
- func (e *HasServerKeys) RequiredUIs() []libkb.UIKind
- func (e *HasServerKeys) Run(m libkb.MetaContext) error
- func (e *HasServerKeys) SubConsumers() []libkb.UIConsumer
- type Identify2TestStats
- type Identify2WithUID
- func (e *Identify2WithUID) CCLCheckCompleted(lcr *libkb.LinkCheckResult)
- func (e *Identify2WithUID) ConfirmResult() keybase1.ConfirmResult
- func (e *Identify2WithUID) FullMeUser() *libkb.User
- func (e *Identify2WithUID) FullThemUser() *libkb.User
- func (e *Identify2WithUID) GetProofSet() *libkb.ProofSet
- func (e *Identify2WithUID) Name() string
- func (e *Identify2WithUID) Prereqs() Prereqs
- func (e *Identify2WithUID) RequiredUIs() []libkb.UIKind
- func (e *Identify2WithUID) Result() *keybase1.Identify2Res
- func (e *Identify2WithUID) Run(m libkb.MetaContext) (err error)
- func (e *Identify2WithUID) SetResponsibleGregorItem(item gregor.Item)
- func (e *Identify2WithUID) SubConsumers() []libkb.UIConsumer
- func (e *Identify2WithUID) TrackToken() keybase1.TrackToken
- func (e *Identify2WithUID) WantDelegate(k libkb.UIKind) bool
- type Identify2WithUIDTestArgs
- type IdentifyJob
- type Kex2Provisionee
- func (e *Kex2Provisionee) APIArgs() (token, csrf string)
- func (e *Kex2Provisionee) AddSecret(s kex2.Secret)
- func (e *Kex2Provisionee) Cancel()
- func (e *Kex2Provisionee) Device() *libkb.Device
- func (e *Kex2Provisionee) EncryptionKey() (libkb.NaclDHKeyPair, error)
- func (e *Kex2Provisionee) GetLKSec() *libkb.LKSec
- func (e *Kex2Provisionee) GetLogFactory() rpc.LogFactory
- func (e *Kex2Provisionee) GetName() string
- func (e *Kex2Provisionee) GetUID() keybase1.UID
- func (e *Kex2Provisionee) HandleDidCounterSign(_ context.Context, sig []byte) (err error)
- func (e *Kex2Provisionee) HandleDidCounterSign2(_ context.Context, arg keybase1.DidCounterSign2Arg) (err error)
- func (e *Kex2Provisionee) HandleHello(_ context.Context, harg keybase1.HelloArg) (res keybase1.HelloRes, err error)
- func (e *Kex2Provisionee) HandleHello2(_ context.Context, harg keybase1.Hello2Arg) (res keybase1.Hello2Res, err error)
- func (e *Kex2Provisionee) Invalidate()
- func (e *Kex2Provisionee) IsLoggedIn() bool
- func (e *Kex2Provisionee) Logout() error
- func (e *Kex2Provisionee) Name() string
- func (e *Kex2Provisionee) Prereqs() Prereqs
- func (e *Kex2Provisionee) RequiredUIs() []libkb.UIKind
- func (e *Kex2Provisionee) Run(m libkb.MetaContext) error
- func (e *Kex2Provisionee) SigningKey() (libkb.GenericKey, error)
- func (e *Kex2Provisionee) SubConsumers() []libkb.UIConsumer
- type Kex2Provisioner
- func (e *Kex2Provisioner) AddSecret(s kex2.Secret)
- func (e *Kex2Provisioner) CounterSign(input keybase1.HelloRes) (sig []byte, err error)
- func (e *Kex2Provisioner) CounterSign2(input keybase1.Hello2Res) (output keybase1.DidCounterSign2Arg, err error)
- func (e *Kex2Provisioner) GetHello2Arg() (arg2 keybase1.Hello2Arg, err error)
- func (e *Kex2Provisioner) GetHelloArg() (arg keybase1.HelloArg, err error)
- func (e *Kex2Provisioner) GetLogFactory() rpc.LogFactory
- func (e *Kex2Provisioner) Name() string
- func (e *Kex2Provisioner) Prereqs() Prereqs
- func (e *Kex2Provisioner) RequiredUIs() []libkb.UIKind
- func (e *Kex2Provisioner) Run(m libkb.MetaContext) error
- func (e *Kex2Provisioner) SubConsumers() []libkb.UIConsumer
- type ListTrackers2Engine
- func (e *ListTrackers2Engine) GetResults() keybase1.UserSummary2Set
- func (e *ListTrackers2Engine) Name() string
- func (e *ListTrackers2Engine) Prereqs() Prereqs
- func (e *ListTrackers2Engine) RequiredUIs() []libkb.UIKind
- func (e *ListTrackers2Engine) Run(m libkb.MetaContext) error
- func (e *ListTrackers2Engine) SubConsumers() []libkb.UIConsumer
- type ListTrackersEngine
- func (e *ListTrackersEngine) ExportedList() (ret []keybase1.Tracker)
- func (e *ListTrackersEngine) List() []libkb.Tracker
- func (e *ListTrackersEngine) Name() string
- func (e *ListTrackersEngine) Prereqs() Prereqs
- func (e *ListTrackersEngine) RequiredUIs() []libkb.UIKind
- func (e *ListTrackersEngine) Run(m libkb.MetaContext) error
- func (e *ListTrackersEngine) SubConsumers() []libkb.UIConsumer
- type ListTrackingEngine
- func (e *ListTrackingEngine) JSONResult() string
- func (e *ListTrackingEngine) Name() string
- func (e *ListTrackingEngine) Prereqs() Prereqs
- func (e *ListTrackingEngine) RequiredUIs() []libkb.UIKind
- func (e *ListTrackingEngine) Run(m libkb.MetaContext) (err error)
- func (e *ListTrackingEngine) SubConsumers() []libkb.UIConsumer
- func (e *ListTrackingEngine) TableResult() []keybase1.UserSummary
- type ListTrackingEngineArg
- type Login
- type LoginOffline
- type LoginOneshot
- type LoginProvisionedDevice
- type LoginWithPaperKey
- type PGPDecrypt
- func (e *PGPDecrypt) Name() string
- func (e *PGPDecrypt) Prereqs() Prereqs
- func (e *PGPDecrypt) RequiredUIs() []libkb.UIKind
- func (e *PGPDecrypt) Run(m libkb.MetaContext) (err error)
- func (e *PGPDecrypt) SignatureStatus() *libkb.SignatureStatus
- func (e *PGPDecrypt) Signer() *libkb.User
- func (e *PGPDecrypt) SubConsumers() []libkb.UIConsumer
- type PGPDecryptArg
- type PGPEncrypt
- type PGPEncryptArg
- type PGPImportStubbedError
- type PGPKey
- type PGPKeyExportEngine
- func NewPGPKeyExportByFingerprintEngine(g *libkb.GlobalContext, arg keybase1.PGPExportByFingerprintArg) *PGPKeyExportEngine
- func NewPGPKeyExportByKIDEngine(g *libkb.GlobalContext, arg keybase1.PGPExportByKIDArg) *PGPKeyExportEngine
- func NewPGPKeyExportEngine(g *libkb.GlobalContext, arg keybase1.PGPExportArg) *PGPKeyExportEngine
- func (e *PGPKeyExportEngine) Name() string
- func (e *PGPKeyExportEngine) Prereqs() Prereqs
- func (e *PGPKeyExportEngine) RequiredUIs() []libkb.UIKind
- func (e *PGPKeyExportEngine) Results() []keybase1.KeyInfo
- func (e *PGPKeyExportEngine) Run(m libkb.MetaContext) (err error)
- func (e *PGPKeyExportEngine) SubConsumers() []libkb.UIConsumer
- type PGPKeyGen
- type PGPKeyImportEngine
- func (e *PGPKeyImportEngine) GetKID() (kid keybase1.KID)
- func (e *PGPKeyImportEngine) Name() string
- func (e *PGPKeyImportEngine) Prereqs() Prereqs
- func (e *PGPKeyImportEngine) RequiredUIs() []libkb.UIKind
- func (e *PGPKeyImportEngine) Run(m libkb.MetaContext) (err error)
- func (e *PGPKeyImportEngine) SubConsumers() []libkb.UIConsumer
- type PGPKeyImportEngineArg
- type PGPKeyfinder
- type PGPKeyfinderArg
- type PGPNotActiveForLocalImport
- type PGPPullEngine
- type PGPPullEngineArg
- type PGPPurge
- type PGPSignArg
- type PGPSignEngine
- type PGPUpdateEngine
- type PGPVerify
- func (e *PGPVerify) Name() string
- func (e *PGPVerify) Prereqs() Prereqs
- func (e *PGPVerify) RequiredUIs() []libkb.UIKind
- func (e *PGPVerify) Run(m libkb.MetaContext) error
- func (e *PGPVerify) SignatureStatus() *libkb.SignatureStatus
- func (e *PGPVerify) Signer() *libkb.User
- func (e *PGPVerify) SubConsumers() []libkb.UIConsumer
- type PGPVerifyArg
- type PaperKey
- func (e *PaperKey) EncKey() libkb.GenericKey
- func (e *PaperKey) Name() string
- func (e *PaperKey) Passphrase() string
- func (e *PaperKey) Prereqs() Prereqs
- func (e *PaperKey) RequiredUIs() []libkb.UIKind
- func (e *PaperKey) Run(m libkb.MetaContext) error
- func (e *PaperKey) SigKey() libkb.GenericKey
- func (e *PaperKey) SubConsumers() []libkb.UIConsumer
- type PaperKeyGen
- func (e *PaperKeyGen) DeviceWithKeys() *libkb.DeviceWithKeys
- func (e *PaperKeyGen) EncKey() libkb.NaclDHKeyPair
- func (e *PaperKeyGen) Name() string
- func (e *PaperKeyGen) Prereqs() Prereqs
- func (e *PaperKeyGen) RequiredUIs() []libkb.UIKind
- func (e *PaperKeyGen) Run(m libkb.MetaContext) error
- func (e *PaperKeyGen) SigKey() libkb.GenericKey
- func (e *PaperKeyGen) SubConsumers() []libkb.UIConsumer
- type PaperKeyGenArg
- type PaperKeyPrimary
- type PaperKeyPrimaryArgs
- type PaperKeySubmit
- type PaperProvisionEngine
- func (e *PaperProvisionEngine) Name() string
- func (e *PaperProvisionEngine) Prereqs() Prereqs
- func (e *PaperProvisionEngine) RequiredUIs() []libkb.UIKind
- func (e *PaperProvisionEngine) Result() error
- func (e *PaperProvisionEngine) Run(m libkb.MetaContext) (err error)
- func (e *PaperProvisionEngine) SubConsumers() []libkb.UIConsumer
- type PassphraseChange
- type PerUserKeyRoll
- type PerUserKeyRollArgs
- type PerUserKeyUpgrade
- type PerUserKeyUpgradeArgs
- type PerUserKeyUpgradeBackground
- func (e *PerUserKeyUpgradeBackground) Name() string
- func (e *PerUserKeyUpgradeBackground) Prereqs() Prereqs
- func (e *PerUserKeyUpgradeBackground) RequiredUIs() []libkb.UIKind
- func (e *PerUserKeyUpgradeBackground) Run(m libkb.MetaContext) (err error)
- func (e *PerUserKeyUpgradeBackground) Shutdown()
- func (e *PerUserKeyUpgradeBackground) SubConsumers() []libkb.UIConsumer
- type PerUserKeyUpgradeBackgroundArgs
- type PerUserKeyUpkeep
- type PerUserKeyUpkeepArgs
- type PerUserKeyUpkeepBackground
- func (e *PerUserKeyUpkeepBackground) Name() string
- func (e *PerUserKeyUpkeepBackground) Prereqs() Prereqs
- func (e *PerUserKeyUpkeepBackground) RequiredUIs() []libkb.UIKind
- func (e *PerUserKeyUpkeepBackground) Run(m libkb.MetaContext) (err error)
- func (e *PerUserKeyUpkeepBackground) Shutdown()
- func (e *PerUserKeyUpkeepBackground) SubConsumers() []libkb.UIConsumer
- type PerUserKeyUpkeepBackgroundArgs
- type Prereqs
- type ProfileEdit
- type Proofs
- type Prove
- type ProveCheck
- func (e *ProveCheck) Name() string
- func (e *ProveCheck) Prereqs() Prereqs
- func (e *ProveCheck) RequiredUIs() []libkb.UIKind
- func (e *ProveCheck) Results() (found bool, status keybase1.ProofStatus, state keybase1.ProofState, ...)
- func (e *ProveCheck) Run(m libkb.MetaContext) error
- func (e *ProveCheck) SubConsumers() []libkb.UIConsumer
- type ResolveThenIdentify2
- func (e *ResolveThenIdentify2) ConfirmResult() keybase1.ConfirmResult
- func (e *ResolveThenIdentify2) GetProofSet() *libkb.ProofSet
- func (e *ResolveThenIdentify2) Name() string
- func (e *ResolveThenIdentify2) Prereqs() Prereqs
- func (e *ResolveThenIdentify2) RequiredUIs() []libkb.UIKind
- func (e *ResolveThenIdentify2) Result() *keybase1.Identify2Res
- func (e *ResolveThenIdentify2) Run(m libkb.MetaContext) (err error)
- func (e *ResolveThenIdentify2) SetResponsibleGregorItem(item gregor.Item)
- func (e *ResolveThenIdentify2) SubConsumers() []libkb.UIConsumer
- func (e *ResolveThenIdentify2) TrackToken() keybase1.TrackToken
- type RevokeDeviceEngineArgs
- type RevokeEngine
- type RevokeMode
- type RevokeSigsEngine
- type SaltpackDecrypt
- func (e *SaltpackDecrypt) MessageInfo() keybase1.SaltpackEncryptedMessageInfo
- func (e *SaltpackDecrypt) Name() string
- func (e *SaltpackDecrypt) Prereqs() Prereqs
- func (e *SaltpackDecrypt) RequiredUIs() []libkb.UIKind
- func (e *SaltpackDecrypt) Run(m libkb.MetaContext) (err error)
- func (e *SaltpackDecrypt) SubConsumers() []libkb.UIConsumer
- type SaltpackDecryptArg
- type SaltpackEncrypt
- type SaltpackEncryptArg
- type SaltpackSenderIdentify
- func (e *SaltpackSenderIdentify) Name() string
- func (e *SaltpackSenderIdentify) Prereqs() Prereqs
- func (e *SaltpackSenderIdentify) RequiredUIs() []libkb.UIKind
- func (e *SaltpackSenderIdentify) Result() keybase1.SaltpackSender
- func (e *SaltpackSenderIdentify) Run(m libkb.MetaContext) (err error)
- func (e *SaltpackSenderIdentify) SubConsumers() []libkb.UIConsumer
- type SaltpackSenderIdentifyArg
- type SaltpackSign
- type SaltpackSignArg
- type SaltpackVerify
- type SaltpackVerifyArg
- type ScanKeys
- func (s *ScanKeys) Count() int
- func (s *ScanKeys) DecryptionKeys() []openpgp.Key
- func (s *ScanKeys) KeyOwner(keyID uint64) *libkb.User
- func (s *ScanKeys) KeyOwnerByEntity(entity *openpgp.Entity) *libkb.User
- func (s *ScanKeys) KeysById(id uint64, fp []byte) []openpgp.Key
- func (s *ScanKeys) KeysByIdUsage(id uint64, fp []byte, requiredUsage byte) []openpgp.Key
- func (s *ScanKeys) Name() string
- func (s *ScanKeys) RequiredUIs() []libkb.UIKind
- func (s *ScanKeys) SubConsumers() []libkb.UIConsumer
- type ScanProofsCache
- type ScanProofsCacheData
- type ScanProofsEngine
- func (e *ScanProofsEngine) CheckOne(m libkb.MetaContext, rec map[string]string, tickers ScanProofsTickers) (libkb.ProofError, bool, error)
- func (e *ScanProofsEngine) GetRemoteProofChainLink(m libkb.MetaContext, uid keybase1.UID, sigid keybase1.SigID) (libkb.RemoteProofChainLink, error)
- func (e *ScanProofsEngine) GetSigHint(m libkb.MetaContext, uid keybase1.UID, sigid keybase1.SigID) (*libkb.SigHint, error)
- func (e *ScanProofsEngine) Name() string
- func (e *ScanProofsEngine) ParseIndices(indices string) (start int, end int, reterr error)
- func (e *ScanProofsEngine) Prereqs() Prereqs
- func (e *ScanProofsEngine) ProcessOne(m libkb.MetaContext, i int, rec map[string]string, cache *ScanProofsCache, ...) error
- func (e *ScanProofsEngine) RequiredUIs() []libkb.UIKind
- func (e *ScanProofsEngine) Run(m libkb.MetaContext) (err error)
- func (e *ScanProofsEngine) SubConsumers() []libkb.UIConsumer
- type ScanProofsTickers
- type SearchEngine
- func (e *SearchEngine) GetResults() []keybase1.SearchResult
- func (e *SearchEngine) Name() string
- func (e *SearchEngine) Prereqs() Prereqs
- func (e *SearchEngine) RequiredUIs() []libkb.UIKind
- func (e *SearchEngine) Run(m libkb.MetaContext) error
- func (e *SearchEngine) SubConsumers() []libkb.UIConsumer
- type SearchEngineArgs
- type SecretKeysEngine
- func (e *SecretKeysEngine) Name() string
- func (e *SecretKeysEngine) Prereqs() Prereqs
- func (e *SecretKeysEngine) RequiredUIs() []libkb.UIKind
- func (e *SecretKeysEngine) Result() keybase1.SecretKeys
- func (e *SecretKeysEngine) Run(m libkb.MetaContext) (err error)
- func (e *SecretKeysEngine) SubConsumers() []libkb.UIConsumer
- type SignupEngine
- type SignupEngineRunArg
- type SignupJoinEngine
- func (s *SignupJoinEngine) CheckRegistered() (err error)
- func (s *SignupJoinEngine) Init() error
- func (s *SignupJoinEngine) Post(m libkb.MetaContext, arg SignupJoinEngineRunArg) (err error)
- func (s *SignupJoinEngine) PostInviteRequest(ctx context.Context, arg libkb.InviteRequestArg) error
- func (s *SignupJoinEngine) Run(m libkb.MetaContext, arg SignupJoinEngineRunArg) (res SignupJoinEngineRunRes)
- func (s *SignupJoinEngine) WriteOut(m libkb.MetaContext, salt []byte) error
- type SignupJoinEngineRunArg
- type SignupJoinEngineRunRes
- type SigsList
- func (e *SigsList) JSON() (string, error)
- func (e *SigsList) Name() string
- func (e *SigsList) Prereqs() Prereqs
- func (e *SigsList) RequiredUIs() []libkb.UIKind
- func (e *SigsList) Run(m libkb.MetaContext) error
- func (e *SigsList) Sigs() []keybase1.Sig
- func (e *SigsList) SubConsumers() []libkb.UIConsumer
- type SigsListArgs
- type SocialProof
- type SocialProofList
- type Summary
- type TaskFunc
- type TrackEngine
- func (e *TrackEngine) ConfirmResult() keybase1.ConfirmResult
- func (e *TrackEngine) Name() string
- func (e *TrackEngine) Prereqs() Prereqs
- func (e *TrackEngine) RequiredUIs() []libkb.UIKind
- func (e *TrackEngine) Run(m libkb.MetaContext) error
- func (e *TrackEngine) SubConsumers() []libkb.UIConsumer
- func (e *TrackEngine) User() *libkb.User
- type TrackEngineArg
- type TrackList
- type TrackToken
- type TrackTokenArg
- type UIDelegateWanter
- type Unlock
- type UntrackEngine
- type UntrackEngineArg
- type UserConfigEngine
- type UserConfigEngineArg
- type UserPlusKeys
- type UserSummary
- func (e *UserSummary) ExportedSummariesList() (ret []keybase1.UserSummary)
- func (e *UserSummary) Name() string
- func (e *UserSummary) Prereqs() Prereqs
- func (e *UserSummary) RequiredUIs() []libkb.UIKind
- func (e *UserSummary) Run(m libkb.MetaContext) error
- func (e *UserSummary) SubConsumers() []libkb.UIConsumer
- func (e *UserSummary) Summaries() map[keybase1.UID]*Summary
- func (e *UserSummary) SummariesList() []*Summary
- type WalletInitBackground
- func (e *WalletInitBackground) Name() string
- func (e *WalletInitBackground) Prereqs() Prereqs
- func (e *WalletInitBackground) RequiredUIs() []libkb.UIKind
- func (e *WalletInitBackground) Run(m libkb.MetaContext) (err error)
- func (e *WalletInitBackground) Shutdown()
- func (e *WalletInitBackground) SubConsumers() []libkb.UIConsumer
- type WalletInitBackgroundArgs
- type WalletUpkeepBackground
- func (e *WalletUpkeepBackground) Name() string
- func (e *WalletUpkeepBackground) Prereqs() Prereqs
- func (e *WalletUpkeepBackground) RequiredUIs() []libkb.UIKind
- func (e *WalletUpkeepBackground) Run(m libkb.MetaContext) (err error)
- func (e *WalletUpkeepBackground) Shutdown()
- func (e *WalletUpkeepBackground) SubConsumers() []libkb.UIConsumer
- type WalletUpkeepBackgroundArgs
- type WebProof
- type WebProofList
Constants ¶
This section is empty.
Variables ¶
var BackgroundIdentifierDefaultSettings = BackgroundIdentifierSettings{ Enabled: true, WaitClean: 4 * time.Hour, WaitHardFailure: 90 * time.Minute, WaitSoftFailure: 10 * time.Minute, DelaySlot: 3 * time.Minute, }
var ErrKeyGenArgNoDefNoCustom = errors.New("invalid args: NoDefPGPUid set, but no custom PGPUids")
var PerUserKeyUpgradeBackgroundSettings = BackgroundTaskSettings{ Start: 30 * time.Second, WakeUp: 10 * time.Second, Interval: 1 * time.Hour, Limit: 5 * time.Minute, }
var PerUserKeyUpkeepBackgroundSettings = BackgroundTaskSettings{ Start: 20 * time.Second, WakeUp: 15 * time.Second, Interval: 6 * time.Hour, Limit: 5 * time.Minute, }
var WalletInitBackgroundSettings = BackgroundTaskSettings{ Start: 15 * time.Second, WakeUp: 12 * time.Second, Interval: 6 * time.Hour, Limit: 5 * time.Minute, }
var WalletUpkeepBackgroundSettings = BackgroundTaskSettings{ Start: 40 * time.Second, WakeUp: 20 * time.Second, Interval: 24 * time.Hour, Limit: 10 * time.Minute, }
Functions ¶
func CheckUsernameAvailable ¶
func CheckUsernameAvailable(g *libkb.GlobalContext, s string) (err error)
XXX why is this here?
func GetFullName ¶ added in v1.0.27
func GetMySecretKey ¶ added in v1.0.18
func GetMySecretKey(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, secretKeyType libkb.SecretKeyType, reason string) (libkb.GenericKey, error)
GetMySecretKey uses ActiveDevice to get a secret key for the current user.
It used to have functionality to load the user and prompt for a passphrase to unlock the keys, but that is outdated now. Either you are logged in and have your device keys cached, or you aren't.
If the key isn't found in the ActiveDevice cache, this will return LoginRequiredError.
func GetPGPExportPassphrase ¶ added in v1.0.29
func GetPGPExportPassphrase(m libkb.MetaContext, ui libkb.SecretUI, desc string) (keybase1.GetPassphraseRes, error)
func LoadScanProofsIgnore ¶ added in v1.0.18
LoadScanProofsIgnore loads an ignore file and returns the list of proofids to ignore.
func OutputSignatureSuccess ¶
func OutputSignatureSuccess(m libkb.MetaContext, fingerprint libkb.PGPFingerprint, owner *libkb.User, signatureTime time.Time) error
OutputSignatureSuccess prints the details of a successful verification.
func OutputSignatureSuccessNonKeybase ¶ added in v1.0.19
func OutputSignatureSuccessNonKeybase(m libkb.MetaContext, keyID uint64, signatureTime time.Time) error
OutputSignatureSuccessNonKeybase prints the details of successful signature verification when signing key is not known to keybase.
func PerUserKeyUpgradeBackgroundRound ¶ added in v1.0.27
func PerUserKeyUpgradeBackgroundRound(m libkb.MetaContext) error
func PerUserKeyUpkeepBackgroundRound ¶ added in v1.0.27
func PerUserKeyUpkeepBackgroundRound(m libkb.MetaContext) error
func RunEngine2 ¶
func RunEngine2(m libkb.MetaContext, e Engine2) (err error)
func SignED25519 ¶
func SignED25519(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, arg keybase1.SignED25519Arg) (ret keybase1.ED25519SignatureInfo, err error)
SignED25519 signs the given message with the current user's private signing key.
func SignED25519ForKBFS ¶ added in v1.0.19
func SignED25519ForKBFS(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, arg keybase1.SignED25519ForKBFSArg) ( ret keybase1.ED25519SignatureInfo, err error)
SignED25519ForKBFS signs the given message with the current user's private signing key on behalf of KBFS.
func SignToString ¶
func SignToString(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, arg keybase1.SignToStringArg) (sig string, err error)
SignToString signs the given message with the current user's private signing key and outputs the serialized NaclSigInfo string.
func UnboxBytes32 ¶
func UnboxBytes32(ctx context.Context, g *libkb.GlobalContext, getSecretUI func() libkb.SecretUI, arg keybase1.UnboxBytes32Arg) (bytes32 keybase1.Bytes32, err error)
UnboxBytes32 decrypts the given message with the current user's private encryption key and the given nonce and peer public key.
func UnboxBytes32Any ¶
func UnboxBytes32Any(m libkb.MetaContext, getSecretUI func() libkb.SecretUI, arg keybase1.UnboxBytes32AnyArg) (res keybase1.UnboxAnyRes, err error)
UnboxBytes32Any will decrypt any of the KID, ciphertext, nonce bundles in arg.Bundles. Key preference order: cached device keys, cached paper keys, local device key, user-entered paper key. It returns the KID and bundle index along with the plaintext.
func WalletInitBackgroundRound ¶ added in v1.0.46
func WalletInitBackgroundRound(m libkb.MetaContext) error
func WalletUpkeepBackgroundRound ¶ added in v1.0.46
func WalletUpkeepBackgroundRound(m libkb.MetaContext) error
Types ¶
type AccountDelete ¶ added in v1.0.18
type AccountDelete struct {
libkb.Contextified
}
AccountDelete is an engine.
func NewAccountDelete ¶ added in v1.0.18
func NewAccountDelete(g *libkb.GlobalContext) *AccountDelete
NewAccountDelete creates a AccountDelete engine.
func (*AccountDelete) Name ¶ added in v1.0.18
func (e *AccountDelete) Name() string
Name is the unique engine name.
func (*AccountDelete) Prereqs ¶ added in v1.0.18
func (e *AccountDelete) Prereqs() Prereqs
Prereqs returns the engine prereqs.
func (*AccountDelete) RequiredUIs ¶ added in v1.0.18
func (e *AccountDelete) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*AccountDelete) Run ¶ added in v1.0.18
func (e *AccountDelete) Run(m libkb.MetaContext) error
Run starts the engine.
func (*AccountDelete) SubConsumers ¶ added in v1.0.18
func (e *AccountDelete) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type BackgroundIdentifier ¶ added in v1.0.19
type BackgroundIdentifier struct { libkb.Contextified sync.Mutex // contains filtered or unexported fields }
func NewBackgroundIdentifier ¶ added in v1.0.19
func NewBackgroundIdentifier(g *libkb.GlobalContext, untilCh chan struct{}) *BackgroundIdentifier
func (*BackgroundIdentifier) Add ¶ added in v1.0.19
func (b *BackgroundIdentifier) Add(u keybase1.UID) bool
func (*BackgroundIdentifier) Name ¶ added in v1.0.19
func (b *BackgroundIdentifier) Name() string
func (*BackgroundIdentifier) Prereqs ¶ added in v1.0.19
func (b *BackgroundIdentifier) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*BackgroundIdentifier) Remove ¶ added in v1.0.19
func (b *BackgroundIdentifier) Remove(u keybase1.UID)
func (*BackgroundIdentifier) RequiredUIs ¶ added in v1.0.19
func (b *BackgroundIdentifier) RequiredUIs() []libkb.UIKind
func (*BackgroundIdentifier) Run ¶ added in v1.0.19
func (b *BackgroundIdentifier) Run(m libkb.MetaContext) (err error)
func (*BackgroundIdentifier) SetSnooperChannel ¶ added in v1.0.19
func (b *BackgroundIdentifier) SetSnooperChannel(ch chan<- IdentifyJob)
A snooper channel wants to know what's going on and will be notified accordingly.
func (*BackgroundIdentifier) SubConsumers ¶ added in v1.0.19
func (b *BackgroundIdentifier) SubConsumers() []libkb.UIConsumer
type BackgroundIdentifierSettings ¶ added in v1.0.19
type BackgroundIdentifierTestArgs ¶ added in v1.0.19
type BackgroundIdentifierTestArgs struct {
// contains filtered or unexported fields
}
type BackgroundTask ¶ added in v1.0.27
type BackgroundTask struct { libkb.Contextified sync.Mutex // contains filtered or unexported fields }
BackgroundTask is an engine.
func NewBackgroundTask ¶ added in v1.0.27
func NewBackgroundTask(g *libkb.GlobalContext, args *BackgroundTaskArgs) *BackgroundTask
NewBackgroundTask creates a BackgroundTask engine.
func (*BackgroundTask) Name ¶ added in v1.0.27
func (e *BackgroundTask) Name() string
Name is the unique engine name.
func (*BackgroundTask) Prereqs ¶ added in v1.0.27
func (e *BackgroundTask) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*BackgroundTask) RequiredUIs ¶ added in v1.0.27
func (e *BackgroundTask) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*BackgroundTask) Run ¶ added in v1.0.27
func (e *BackgroundTask) Run(m libkb.MetaContext) (err error)
Run starts the engine. Returns immediately, kicks off a background goroutine.
func (*BackgroundTask) Shutdown ¶ added in v1.0.27
func (e *BackgroundTask) Shutdown()
func (*BackgroundTask) SubConsumers ¶ added in v1.0.27
func (e *BackgroundTask) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type BackgroundTaskArgs ¶ added in v1.0.27
type BackgroundTaskArgs struct { Name string F TaskFunc Settings BackgroundTaskSettings // contains filtered or unexported fields }
type BackgroundTaskSettings ¶ added in v1.0.27
type BackgroundTaskSettings struct { // Wait after starting the app Start time.Duration // When waking up on mobile lots of timers will go off at once. We wait an additional // delay so as not to add to that herd and slow down the mobile experience when opening the app. WakeUp time.Duration // Wait between runs Interval time.Duration // Time limit on each round Limit time.Duration }
type Bootstrap ¶ added in v1.0.22
type Bootstrap struct { libkb.Contextified // contains filtered or unexported fields }
Bootstrap is an engine.
func NewBootstrap ¶ added in v1.0.22
func NewBootstrap(g *libkb.GlobalContext) *Bootstrap
NewBootstrap creates a Bootstrap engine.
func (*Bootstrap) RequiredUIs ¶ added in v1.0.22
RequiredUIs returns the required UIs.
func (*Bootstrap) Run ¶ added in v1.0.22
func (e *Bootstrap) Run(m libkb.MetaContext) error
Run starts the engine.
func (*Bootstrap) Status ¶ added in v1.0.22
func (e *Bootstrap) Status() keybase1.BootstrapStatus
func (*Bootstrap) SubConsumers ¶ added in v1.0.22
func (e *Bootstrap) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type CheckError ¶
type CheckError struct {
// contains filtered or unexported fields
}
func (CheckError) Error ¶
func (e CheckError) Error() string
type CryptocurrencyEngine ¶ added in v1.0.19
type CryptocurrencyEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewCryptocurrencyEngine ¶ added in v1.0.19
func NewCryptocurrencyEngine(g *libkb.GlobalContext, arg keybase1.RegisterAddressArg) *CryptocurrencyEngine
func (*CryptocurrencyEngine) Name ¶ added in v1.0.19
func (e *CryptocurrencyEngine) Name() string
func (*CryptocurrencyEngine) Prereqs ¶ added in v1.0.19
func (e *CryptocurrencyEngine) Prereqs() Prereqs
func (*CryptocurrencyEngine) RequiredUIs ¶ added in v1.0.19
func (e *CryptocurrencyEngine) RequiredUIs() []libkb.UIKind
func (*CryptocurrencyEngine) Result ¶ added in v1.0.19
func (e *CryptocurrencyEngine) Result() keybase1.RegisterAddressRes
func (*CryptocurrencyEngine) Run ¶ added in v1.0.19
func (e *CryptocurrencyEngine) Run(m libkb.MetaContext) (err error)
func (*CryptocurrencyEngine) SubConsumers ¶ added in v1.0.19
func (e *CryptocurrencyEngine) SubConsumers() []libkb.UIConsumer
type DeprovisionEngine ¶
type DeprovisionEngine struct { libkb.Contextified // contains filtered or unexported fields }
XXX: THIS ENGINE DELETES SECRET KEYS. Deleting the wrong secret keys can make you lose all your data forever. Apart from `keybase deprovision`, which shows a ton of SCARY ALL CAPS prompts to the user, we probably never want to use this engine.
func NewDeprovisionEngine ¶
func NewDeprovisionEngine(g *libkb.GlobalContext, username string, doRevoke bool) *DeprovisionEngine
func (*DeprovisionEngine) Name ¶
func (e *DeprovisionEngine) Name() string
func (*DeprovisionEngine) Prereqs ¶
func (e *DeprovisionEngine) Prereqs() Prereqs
func (*DeprovisionEngine) RequiredUIs ¶
func (e *DeprovisionEngine) RequiredUIs() []libkb.UIKind
func (*DeprovisionEngine) Run ¶
func (e *DeprovisionEngine) Run(m libkb.MetaContext) (err error)
func (*DeprovisionEngine) SubConsumers ¶
func (e *DeprovisionEngine) SubConsumers() []libkb.UIConsumer
type DevList ¶
type DevList struct { libkb.Contextified // contains filtered or unexported fields }
DevList is an engine that gets a list of all the user's devices.
func NewDevList ¶
func NewDevList(g *libkb.GlobalContext) *DevList
NewDevList creates a DevList engine.
func (*DevList) RequiredUIs ¶
func (*DevList) SubConsumers ¶
func (d *DevList) SubConsumers() []libkb.UIConsumer
type DeviceAdd ¶
type DeviceAdd struct {
libkb.Contextified
}
DeviceAdd is an engine.
func NewDeviceAdd ¶
func NewDeviceAdd(g *libkb.GlobalContext) *DeviceAdd
NewDeviceAdd creates a DeviceAdd engine.
func (*DeviceAdd) RequiredUIs ¶
RequiredUIs returns the required UIs.
func (*DeviceAdd) Run ¶
func (e *DeviceAdd) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*DeviceAdd) SubConsumers ¶
func (e *DeviceAdd) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type DeviceHistory ¶ added in v1.0.16
type DeviceHistory struct { libkb.Contextified // contains filtered or unexported fields }
DeviceHistory is an engine.
func NewDeviceHistory ¶ added in v1.0.16
func NewDeviceHistory(g *libkb.GlobalContext, username string) *DeviceHistory
NewDeviceHistory creates a DeviceHistory engine to lookup the device history for username.
func NewDeviceHistorySelf ¶ added in v1.0.16
func NewDeviceHistorySelf(g *libkb.GlobalContext) *DeviceHistory
NewDeviceHistorySelf creates a DeviceHistory engine to lookup the device history of the current user.
func (*DeviceHistory) Devices ¶ added in v1.0.16
func (e *DeviceHistory) Devices() []keybase1.DeviceDetail
func (*DeviceHistory) Name ¶ added in v1.0.16
func (e *DeviceHistory) Name() string
Name is the unique engine name.
func (*DeviceHistory) Prereqs ¶ added in v1.0.16
func (e *DeviceHistory) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*DeviceHistory) RequiredUIs ¶ added in v1.0.16
func (e *DeviceHistory) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*DeviceHistory) Run ¶ added in v1.0.16
func (e *DeviceHistory) Run(m libkb.MetaContext) error
Run starts the engine.
func (*DeviceHistory) SubConsumers ¶ added in v1.0.16
func (e *DeviceHistory) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type DeviceKeyfinder ¶
type DeviceKeyfinder struct { libkb.Contextified // contains filtered or unexported fields }
DeviceKeyfinder is an engine to find device keys for users (loaded by assertions), possibly tracking them if necessary.
func NewDeviceKeyfinder ¶
func NewDeviceKeyfinder(g *libkb.GlobalContext, arg DeviceKeyfinderArg) *DeviceKeyfinder
NewDeviceKeyfinder creates a DeviceKeyfinder engine.
func (*DeviceKeyfinder) Name ¶
func (e *DeviceKeyfinder) Name() string
Name is the unique engine name.
func (*DeviceKeyfinder) Prereqs ¶
func (e *DeviceKeyfinder) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*DeviceKeyfinder) RequiredUIs ¶
func (e *DeviceKeyfinder) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*DeviceKeyfinder) Run ¶
func (e *DeviceKeyfinder) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*DeviceKeyfinder) SubConsumers ¶
func (e *DeviceKeyfinder) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
func (*DeviceKeyfinder) UsersPlusKeys ¶
func (e *DeviceKeyfinder) UsersPlusKeys() map[keybase1.UID](*keybase1.UserPlusKeys)
UsersPlusDeviceKeys returns the users found while running the engine, plus their device keys.
type DeviceKeyfinderArg ¶
type DeviceKeygen ¶
type DeviceKeygen struct { libkb.Contextified // contains filtered or unexported fields }
func NewDeviceKeygen ¶
func NewDeviceKeygen(g *libkb.GlobalContext, args *DeviceKeygenArgs) *DeviceKeygen
NewDeviceKeygen creates a DeviceKeygen engine.
func (*DeviceKeygen) EncryptionKey ¶
func (e *DeviceKeygen) EncryptionKey() libkb.NaclDHKeyPair
func (*DeviceKeygen) Prereqs ¶
func (e *DeviceKeygen) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*DeviceKeygen) Push ¶
func (e *DeviceKeygen) Push(m libkb.MetaContext, pargs *DeviceKeygenPushArgs) error
Push pushes the generated keys to the api server and stores the local key security server half on the api server as well.
func (*DeviceKeygen) RequiredUIs ¶
func (e *DeviceKeygen) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*DeviceKeygen) Run ¶
func (e *DeviceKeygen) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*DeviceKeygen) SigningKey ¶
func (e *DeviceKeygen) SigningKey() libkb.NaclKeyPair
func (*DeviceKeygen) SigningKeyPublic ¶
func (e *DeviceKeygen) SigningKeyPublic() (libkb.NaclSigningKeyPublic, error)
func (*DeviceKeygen) SubConsumers ¶
func (e *DeviceKeygen) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type DeviceKeygenArgs ¶
type DeviceKeygenPushArgs ¶
type DeviceKeygenPushArgs struct { SkipSignerPush bool Signer libkb.GenericKey EldestKID keybase1.KID User *libkb.User // optional }
DeviceKeygenPushArgs determines how the push will run. There are currently three different paths it can take:
1. this device is the eldest device: pushes eldest signing key, encryption subkey. (IsEldest => true)
2. this device is a sibling (but we're not in a key exchange scenario): pushes sibkey signing key, encryption subkey. (IsEldest => False, SkipSignerPush => false, Signer != nil, EldestKID != nil)
3. this device is a sibling, but another device pushed the signing key, so skip that part. (IsEldest => False, SkipSignerPush => true, Signer != nil, EldestKID != nil)
The User argument is optional, but it is necessary if the user's sigchain changes between key generation and key push.
type DeviceWrap ¶
type DeviceWrap struct { libkb.Contextified // contains filtered or unexported fields }
DeviceWrap is an engine that wraps DeviceRegister and DeviceKeygen.
func NewDeviceWrap ¶
func NewDeviceWrap(g *libkb.GlobalContext, args *DeviceWrapArgs) *DeviceWrap
NewDeviceWrap creates a DeviceWrap engine.
func (*DeviceWrap) DeviceID ¶
func (e *DeviceWrap) DeviceID() keybase1.DeviceID
func (*DeviceWrap) EncryptionKey ¶
func (e *DeviceWrap) EncryptionKey() libkb.NaclDHKeyPair
func (*DeviceWrap) Prereqs ¶
func (e *DeviceWrap) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*DeviceWrap) RequiredUIs ¶
func (e *DeviceWrap) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*DeviceWrap) Run ¶
func (e *DeviceWrap) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*DeviceWrap) SigningKey ¶
func (e *DeviceWrap) SigningKey() libkb.GenericKey
func (*DeviceWrap) SubConsumers ¶
func (e *DeviceWrap) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type DeviceWrapArgs ¶
type EmailChange ¶ added in v1.0.18
type EmailChange struct { libkb.Contextified // contains filtered or unexported fields }
EmailChange is an engine that changes a user's email via signed statement.
func NewEmailChange ¶ added in v1.0.18
func NewEmailChange(g *libkb.GlobalContext, a *keybase1.EmailChangeArg) *EmailChange
NewEmailChange creates a new engine for changing a user's email address via signature (and therefore without passphrase required)
func (*EmailChange) Name ¶ added in v1.0.18
func (c *EmailChange) Name() string
Name provides the name of the engine for the engine interface
func (*EmailChange) Prereqs ¶ added in v1.0.18
func (c *EmailChange) Prereqs() Prereqs
Prereqs returns engine prereqs
func (*EmailChange) RequiredUIs ¶ added in v1.0.18
func (c *EmailChange) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*EmailChange) Run ¶ added in v1.0.18
func (c *EmailChange) Run(m libkb.MetaContext) (err error)
Run the engine
func (*EmailChange) SubConsumers ¶ added in v1.0.18
func (c *EmailChange) SubConsumers() []libkb.UIConsumer
SubConsumers requires the other UI consumers of this engine
type Engine2 ¶
type Engine2 interface { Run(libkb.MetaContext) error Prereqs() Prereqs libkb.UIConsumer }
type FavoriteAdd ¶
type FavoriteAdd struct { libkb.Contextified // contains filtered or unexported fields }
FavoriteAdd is an engine.
func NewFavoriteAdd ¶
func NewFavoriteAdd(g *libkb.GlobalContext, arg *keybase1.FavoriteAddArg) *FavoriteAdd
NewFavoriteAdd creates a FavoriteAdd engine.
func (*FavoriteAdd) Prereqs ¶
func (e *FavoriteAdd) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*FavoriteAdd) RequiredUIs ¶
func (e *FavoriteAdd) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*FavoriteAdd) Run ¶
func (e *FavoriteAdd) Run(m libkb.MetaContext) error
Run starts the engine.
func (*FavoriteAdd) SubConsumers ¶
func (e *FavoriteAdd) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
func (*FavoriteAdd) Wait ¶ added in v1.0.16
func (e *FavoriteAdd) Wait()
Wait until the checkInviteNeeded goroutine is done.
func (*FavoriteAdd) WantDelegate ¶ added in v1.0.16
func (e *FavoriteAdd) WantDelegate(kind libkb.UIKind) bool
type FavoriteIgnore ¶ added in v1.0.17
type FavoriteIgnore struct { libkb.Contextified // contains filtered or unexported fields }
FavoriteIgnore is an engine.
func NewFavoriteIgnore ¶ added in v1.0.17
func NewFavoriteIgnore(g *libkb.GlobalContext, arg *keybase1.FavoriteIgnoreArg) *FavoriteIgnore
NewFavoriteIgnore creates a FavoriteIgnore engine.
func (*FavoriteIgnore) Name ¶ added in v1.0.17
func (e *FavoriteIgnore) Name() string
Name is the unique engine name.
func (*FavoriteIgnore) Prereqs ¶ added in v1.0.17
func (e *FavoriteIgnore) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*FavoriteIgnore) RequiredUIs ¶ added in v1.0.17
func (e *FavoriteIgnore) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*FavoriteIgnore) Run ¶ added in v1.0.17
func (e *FavoriteIgnore) Run(m libkb.MetaContext) error
Run starts the engine.
func (*FavoriteIgnore) SubConsumers ¶ added in v1.0.17
func (e *FavoriteIgnore) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type FavoriteList ¶
type FavoriteList struct { libkb.Contextified // contains filtered or unexported fields }
FavoriteList is an engine.
func NewFavoriteList ¶
func NewFavoriteList(g *libkb.GlobalContext) *FavoriteList
NewFavoriteList creates a FavoriteList engine.
func (*FavoriteList) Prereqs ¶
func (e *FavoriteList) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*FavoriteList) RequiredUIs ¶
func (e *FavoriteList) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*FavoriteList) Result ¶ added in v1.0.17
func (e *FavoriteList) Result() keybase1.FavoritesResult
Favorites returns the list of favorites that Run generated.
func (*FavoriteList) Run ¶
func (e *FavoriteList) Run(m libkb.MetaContext) error
Run starts the engine.
func (*FavoriteList) SubConsumers ¶
func (e *FavoriteList) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type FavoritesAPIResult ¶ added in v1.0.17
type FavoritesAPIResult struct { Status libkb.AppStatus `json:"status"` Favorites []keybase1.Folder `json:"favorites"` Ignored []keybase1.Folder `json:"ignored"` New []keybase1.Folder `json:"new"` }
func (*FavoritesAPIResult) GetAppStatus ¶ added in v1.0.17
func (f *FavoritesAPIResult) GetAppStatus() *libkb.AppStatus
type GPGExportingError ¶ added in v1.0.29
type GPGExportingError struct {
// contains filtered or unexported fields
}
func (GPGExportingError) Error ¶ added in v1.0.29
func (e GPGExportingError) Error() string
type GPGImportKeyArg ¶
type GPGImportKeyEngine ¶
type GPGImportKeyEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewGPGImportKeyEngine ¶
func NewGPGImportKeyEngine(g *libkb.GlobalContext, arg *GPGImportKeyArg) *GPGImportKeyEngine
func (*GPGImportKeyEngine) LastKey ¶
func (e *GPGImportKeyEngine) LastKey() *libkb.PGPKeyBundle
func (*GPGImportKeyEngine) Name ¶
func (e *GPGImportKeyEngine) Name() string
func (*GPGImportKeyEngine) Prereqs ¶
func (e *GPGImportKeyEngine) Prereqs() Prereqs
func (*GPGImportKeyEngine) RequiredUIs ¶
func (e *GPGImportKeyEngine) RequiredUIs() []libkb.UIKind
func (*GPGImportKeyEngine) Run ¶
func (e *GPGImportKeyEngine) Run(m libkb.MetaContext) (err error)
func (*GPGImportKeyEngine) SubConsumers ¶
func (e *GPGImportKeyEngine) SubConsumers() []libkb.UIConsumer
func (*GPGImportKeyEngine) WantsGPG ¶
func (e *GPGImportKeyEngine) WantsGPG(m libkb.MetaContext) (bool, error)
type HasServerKeys ¶ added in v1.0.18
type HasServerKeys struct { libkb.Contextified // contains filtered or unexported fields }
HasServerKeys is an engine.
func NewHasServerKeys ¶ added in v1.0.18
func NewHasServerKeys(g *libkb.GlobalContext) *HasServerKeys
NewHasServerKeys creates a HasServerKeys engine.
func (*HasServerKeys) GetResult ¶ added in v1.0.18
func (e *HasServerKeys) GetResult() keybase1.HasServerKeysRes
func (*HasServerKeys) Name ¶ added in v1.0.18
func (e *HasServerKeys) Name() string
Name is the unique engine name.
func (*HasServerKeys) Prereqs ¶ added in v1.0.18
func (e *HasServerKeys) Prereqs() Prereqs
Prereqs returns the engine prereqs.
func (*HasServerKeys) RequiredUIs ¶ added in v1.0.18
func (e *HasServerKeys) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*HasServerKeys) Run ¶ added in v1.0.18
func (e *HasServerKeys) Run(m libkb.MetaContext) error
Run starts the engine.
func (*HasServerKeys) SubConsumers ¶ added in v1.0.18
func (e *HasServerKeys) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type Identify2TestStats ¶ added in v1.0.19
type Identify2TestStats struct {
// contains filtered or unexported fields
}
type Identify2WithUID ¶
type Identify2WithUID struct { libkb.Contextified // If we just resolved a user, then we can plumb this through to loadUser() ResolveBody *jsonw.Wrapper // contains filtered or unexported fields }
Identify2WithUID is the Identify engine used in KBFS and as a subroutine of command-line crypto.
func NewIdentify2WithUID ¶
func NewIdentify2WithUID(g *libkb.GlobalContext, arg *keybase1.Identify2Arg) *Identify2WithUID
func (*Identify2WithUID) CCLCheckCompleted ¶
func (e *Identify2WithUID) CCLCheckCompleted(lcr *libkb.LinkCheckResult)
CCLCheckCompleted is triggered whenever a remote proof check completes. We get these calls as a result of being a "CheckCompletedListener". When each result comes in, we check against our pool of needed remote assertions. If the set is complete, or if one that we need errors, we can unblock the caller.
func (*Identify2WithUID) ConfirmResult ¶ added in v1.0.17
func (e *Identify2WithUID) ConfirmResult() keybase1.ConfirmResult
func (*Identify2WithUID) FullMeUser ¶ added in v1.0.27
func (e *Identify2WithUID) FullMeUser() *libkb.User
func (*Identify2WithUID) FullThemUser ¶ added in v1.0.27
func (e *Identify2WithUID) FullThemUser() *libkb.User
func (*Identify2WithUID) GetProofSet ¶
func (e *Identify2WithUID) GetProofSet() *libkb.ProofSet
func (*Identify2WithUID) Name ¶
func (e *Identify2WithUID) Name() string
Name is the unique engine name.
func (*Identify2WithUID) Prereqs ¶
func (e *Identify2WithUID) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*Identify2WithUID) RequiredUIs ¶
func (e *Identify2WithUID) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*Identify2WithUID) Result ¶
func (e *Identify2WithUID) Result() *keybase1.Identify2Res
func (*Identify2WithUID) Run ¶
func (e *Identify2WithUID) Run(m libkb.MetaContext) (err error)
Run then engine
func (*Identify2WithUID) SetResponsibleGregorItem ¶ added in v1.0.17
func (e *Identify2WithUID) SetResponsibleGregorItem(item gregor.Item)
func (*Identify2WithUID) SubConsumers ¶
func (e *Identify2WithUID) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
func (*Identify2WithUID) TrackToken ¶ added in v1.0.17
func (e *Identify2WithUID) TrackToken() keybase1.TrackToken
func (*Identify2WithUID) WantDelegate ¶
func (e *Identify2WithUID) WantDelegate(k libkb.UIKind) bool
type Identify2WithUIDTestArgs ¶
type Identify2WithUIDTestArgs struct {
// contains filtered or unexported fields
}
type IdentifyJob ¶ added in v1.0.19
type IdentifyJob struct {
// contains filtered or unexported fields
}
func NewIdentifyJob ¶ added in v1.0.19
func NewIdentifyJob(uid keybase1.UID, err, lastError error) IdentifyJob
func (IdentifyJob) ErrorChanged ¶ added in v1.0.19
func (ij IdentifyJob) ErrorChanged() bool
func (IdentifyJob) LastError ¶ added in v1.0.19
func (ij IdentifyJob) LastError() error
func (IdentifyJob) ThisError ¶ added in v1.0.19
func (ij IdentifyJob) ThisError() error
func (IdentifyJob) UID ¶ added in v1.0.19
func (ij IdentifyJob) UID() keybase1.UID
type Kex2Provisionee ¶
type Kex2Provisionee struct { libkb.Contextified // contains filtered or unexported fields }
Kex2Provisionee is an engine.
func NewKex2Provisionee ¶
func NewKex2Provisionee(g *libkb.GlobalContext, device *libkb.Device, secret kex2.Secret, salt []byte) *Kex2Provisionee
NewKex2Provisionee creates a Kex2Provisionee engine.
func (*Kex2Provisionee) APIArgs ¶
func (e *Kex2Provisionee) APIArgs() (token, csrf string)
APIArgs implements libkb.SessionReader interface.
func (*Kex2Provisionee) AddSecret ¶
func (e *Kex2Provisionee) AddSecret(s kex2.Secret)
AddSecret inserts a received secret into the provisionee's secret channel.
func (*Kex2Provisionee) Cancel ¶
func (e *Kex2Provisionee) Cancel()
Cancel cancels the kex2 run if it is running.
func (*Kex2Provisionee) Device ¶
func (e *Kex2Provisionee) Device() *libkb.Device
Device returns the new device struct.
func (*Kex2Provisionee) EncryptionKey ¶ added in v1.0.22
func (e *Kex2Provisionee) EncryptionKey() (libkb.NaclDHKeyPair, error)
func (*Kex2Provisionee) GetLKSec ¶ added in v1.0.19
func (e *Kex2Provisionee) GetLKSec() *libkb.LKSec
func (*Kex2Provisionee) GetLogFactory ¶
func (e *Kex2Provisionee) GetLogFactory() rpc.LogFactory
GetLogFactory implements GetLogFactory in kex2.Provisionee.
func (*Kex2Provisionee) GetName ¶
func (e *Kex2Provisionee) GetName() string
GetName implements libkb.UserBasic interface.
func (*Kex2Provisionee) GetUID ¶
func (e *Kex2Provisionee) GetUID() keybase1.UID
GetUID implements libkb.UserBasic interface.
func (*Kex2Provisionee) HandleDidCounterSign ¶
func (e *Kex2Provisionee) HandleDidCounterSign(_ context.Context, sig []byte) (err error)
HandleDidCounterSign implements HandleDidCounterSign in kex2.Provisionee interface.
func (*Kex2Provisionee) HandleDidCounterSign2 ¶ added in v1.0.18
func (e *Kex2Provisionee) HandleDidCounterSign2(_ context.Context, arg keybase1.DidCounterSign2Arg) (err error)
func (*Kex2Provisionee) HandleHello ¶
func (e *Kex2Provisionee) HandleHello(_ context.Context, harg keybase1.HelloArg) (res keybase1.HelloRes, err error)
HandleHello implements HandleHello in kex2.Provisionee.
func (*Kex2Provisionee) HandleHello2 ¶ added in v1.0.18
func (e *Kex2Provisionee) HandleHello2(_ context.Context, harg keybase1.Hello2Arg) (res keybase1.Hello2Res, err error)
HandleHello2 implements HandleHello2 in kex2.Provisionee.
func (*Kex2Provisionee) Invalidate ¶
func (e *Kex2Provisionee) Invalidate()
Invalidate implements libkb.SessionReader interface.
func (*Kex2Provisionee) IsLoggedIn ¶
func (e *Kex2Provisionee) IsLoggedIn() bool
IsLoggedIn implements libkb.SessionReader interface. For the sake of kex2 provisionee, we are logged in because we have a session token.
func (*Kex2Provisionee) Logout ¶
func (e *Kex2Provisionee) Logout() error
Logout implements libkb.SessionReader interface. Noop.
func (*Kex2Provisionee) Name ¶
func (e *Kex2Provisionee) Name() string
Name is the unique engine name.
func (*Kex2Provisionee) Prereqs ¶
func (e *Kex2Provisionee) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*Kex2Provisionee) RequiredUIs ¶
func (e *Kex2Provisionee) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*Kex2Provisionee) Run ¶
func (e *Kex2Provisionee) Run(m libkb.MetaContext) error
Run starts the engine.
func (*Kex2Provisionee) SigningKey ¶ added in v1.0.22
func (e *Kex2Provisionee) SigningKey() (libkb.GenericKey, error)
func (*Kex2Provisionee) SubConsumers ¶
func (e *Kex2Provisionee) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type Kex2Provisioner ¶
type Kex2Provisioner struct { libkb.Contextified // contains filtered or unexported fields }
Kex2Provisioner is an engine.
func NewKex2Provisioner ¶
func NewKex2Provisioner(g *libkb.GlobalContext, secret kex2.Secret, pps *libkb.PassphraseStream) *Kex2Provisioner
NewKex2Provisioner creates a Kex2Provisioner engine.
func (*Kex2Provisioner) AddSecret ¶
func (e *Kex2Provisioner) AddSecret(s kex2.Secret)
AddSecret inserts a received secret into the provisioner's secret channel.
func (*Kex2Provisioner) CounterSign ¶
func (e *Kex2Provisioner) CounterSign(input keybase1.HelloRes) (sig []byte, err error)
CounterSign implements CounterSign in kex2.Provisioner.
func (*Kex2Provisioner) CounterSign2 ¶ added in v1.0.18
func (e *Kex2Provisioner) CounterSign2(input keybase1.Hello2Res) (output keybase1.DidCounterSign2Arg, err error)
CounterSign2 implements CounterSign in kex2.Provisioner.
func (*Kex2Provisioner) GetHello2Arg ¶ added in v1.0.18
func (e *Kex2Provisioner) GetHello2Arg() (arg2 keybase1.Hello2Arg, err error)
GetHello2Arg implements GetHello2Arg in kex2.Provisioner.
func (*Kex2Provisioner) GetHelloArg ¶
func (e *Kex2Provisioner) GetHelloArg() (arg keybase1.HelloArg, err error)
GetHelloArg implements GetHelloArg in kex2.Provisioner.
func (*Kex2Provisioner) GetLogFactory ¶
func (e *Kex2Provisioner) GetLogFactory() rpc.LogFactory
GetLogFactory implements GetLogFactory in kex2.Provisioner.
func (*Kex2Provisioner) Name ¶
func (e *Kex2Provisioner) Name() string
Name is the unique engine name.
func (*Kex2Provisioner) Prereqs ¶
func (e *Kex2Provisioner) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*Kex2Provisioner) RequiredUIs ¶
func (e *Kex2Provisioner) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*Kex2Provisioner) Run ¶
func (e *Kex2Provisioner) Run(m libkb.MetaContext) error
Run starts the provisioner engine.
func (*Kex2Provisioner) SubConsumers ¶
func (e *Kex2Provisioner) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type ListTrackers2Engine ¶ added in v1.0.17
type ListTrackers2Engine struct { libkb.Contextified // contains filtered or unexported fields }
func NewListTrackers2 ¶ added in v1.0.17
func NewListTrackers2(g *libkb.GlobalContext, arg keybase1.ListTrackers2Arg) *ListTrackers2Engine
func (*ListTrackers2Engine) GetResults ¶ added in v1.0.17
func (e *ListTrackers2Engine) GetResults() keybase1.UserSummary2Set
func (*ListTrackers2Engine) Name ¶ added in v1.0.17
func (e *ListTrackers2Engine) Name() string
Name is the unique engine name.
func (*ListTrackers2Engine) Prereqs ¶ added in v1.0.17
func (e *ListTrackers2Engine) Prereqs() Prereqs
GetPrereqs returns the engine prereqs (none).
func (*ListTrackers2Engine) RequiredUIs ¶ added in v1.0.17
func (e *ListTrackers2Engine) RequiredUIs() []libkb.UIKind
func (*ListTrackers2Engine) Run ¶ added in v1.0.17
func (e *ListTrackers2Engine) Run(m libkb.MetaContext) error
func (*ListTrackers2Engine) SubConsumers ¶ added in v1.0.17
func (e *ListTrackers2Engine) SubConsumers() []libkb.UIConsumer
type ListTrackersEngine ¶
type ListTrackersEngine struct { libkb.Contextified // contains filtered or unexported fields }
TrackerList is an engine to get a list of user's trackers (other users tracking this user).
func NewListTrackers ¶
func NewListTrackers(g *libkb.GlobalContext, uid keybase1.UID) *ListTrackersEngine
NewListTrackers creates a TrackerList engine for uid.
func NewListTrackersByName ¶
func NewListTrackersByName(username string) *ListTrackersEngine
NewListTrackersByName creates a TrackerList engine that will do a lookup by username.
func NewListTrackersSelf ¶
func NewListTrackersSelf() *ListTrackersEngine
func (*ListTrackersEngine) ExportedList ¶
func (e *ListTrackersEngine) ExportedList() (ret []keybase1.Tracker)
func (*ListTrackersEngine) List ¶
func (e *ListTrackersEngine) List() []libkb.Tracker
List returns the array of trackers for this user.
func (*ListTrackersEngine) Name ¶
func (e *ListTrackersEngine) Name() string
Name is the unique engine name.
func (*ListTrackersEngine) Prereqs ¶
func (e *ListTrackersEngine) Prereqs() Prereqs
GetPrereqs returns the engine prereqs (none).
func (*ListTrackersEngine) RequiredUIs ¶
func (e *ListTrackersEngine) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*ListTrackersEngine) Run ¶
func (e *ListTrackersEngine) Run(m libkb.MetaContext) error
Run starts the engine.
func (*ListTrackersEngine) SubConsumers ¶
func (e *ListTrackersEngine) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type ListTrackingEngine ¶
type ListTrackingEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewListTrackingEngine ¶
func NewListTrackingEngine(g *libkb.GlobalContext, arg *ListTrackingEngineArg) *ListTrackingEngine
func (*ListTrackingEngine) JSONResult ¶
func (e *ListTrackingEngine) JSONResult() string
func (*ListTrackingEngine) Name ¶
func (e *ListTrackingEngine) Name() string
func (*ListTrackingEngine) Prereqs ¶
func (e *ListTrackingEngine) Prereqs() Prereqs
func (*ListTrackingEngine) RequiredUIs ¶
func (e *ListTrackingEngine) RequiredUIs() []libkb.UIKind
func (*ListTrackingEngine) Run ¶
func (e *ListTrackingEngine) Run(m libkb.MetaContext) (err error)
func (*ListTrackingEngine) SubConsumers ¶
func (e *ListTrackingEngine) SubConsumers() []libkb.UIConsumer
func (*ListTrackingEngine) TableResult ¶
func (e *ListTrackingEngine) TableResult() []keybase1.UserSummary
type ListTrackingEngineArg ¶
type Login ¶
type Login struct { libkb.Contextified // contains filtered or unexported fields }
Login is an engine.
func NewLogin ¶
func NewLogin(g *libkb.GlobalContext, deviceType string, usernameOrEmail string, ct keybase1.ClientType) *Login
NewLogin creates a Login engine. username is optional. deviceType should be libkb.DeviceTypeDesktop or libkb.DeviceTypeMobile.
func (*Login) RequiredUIs ¶
RequiredUIs returns the required UIs.
func (*Login) SubConsumers ¶
func (e *Login) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type LoginOffline ¶ added in v1.0.22
type LoginOffline struct {
libkb.Contextified
}
func NewLoginOffline ¶ added in v1.0.22
func NewLoginOffline(g *libkb.GlobalContext) *LoginOffline
func (*LoginOffline) Name ¶ added in v1.0.22
func (e *LoginOffline) Name() string
Name is the unique engine name.
func (*LoginOffline) Prereqs ¶ added in v1.0.22
func (e *LoginOffline) Prereqs() Prereqs
Prereqs returns the engine prereqs.
func (*LoginOffline) RequiredUIs ¶ added in v1.0.22
func (e *LoginOffline) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*LoginOffline) Run ¶ added in v1.0.22
func (e *LoginOffline) Run(m libkb.MetaContext) error
func (*LoginOffline) SubConsumers ¶ added in v1.0.22
func (e *LoginOffline) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type LoginOneshot ¶ added in v1.0.48
type LoginOneshot struct { libkb.Contextified // contains filtered or unexported fields }
"Oneshot login" is a login that works only once, say in an ephemeral context like a docker image. Bootstrap such a session with a paperkey, but the existence of the login won't hit the user's sigchain.
func NewLoginOneshot ¶ added in v1.0.48
func NewLoginOneshot(g *libkb.GlobalContext, arg keybase1.LoginOneshotArg) *LoginOneshot
func (*LoginOneshot) Name ¶ added in v1.0.48
func (e *LoginOneshot) Name() string
func (*LoginOneshot) Prereqs ¶ added in v1.0.48
func (e *LoginOneshot) Prereqs() Prereqs
func (*LoginOneshot) RequiredUIs ¶ added in v1.0.48
func (e *LoginOneshot) RequiredUIs() []libkb.UIKind
func (*LoginOneshot) Run ¶ added in v1.0.48
func (e *LoginOneshot) Run(m libkb.MetaContext) (err error)
func (*LoginOneshot) SubConsumers ¶ added in v1.0.48
func (e *LoginOneshot) SubConsumers() []libkb.UIConsumer
type LoginProvisionedDevice ¶ added in v1.0.18
type LoginProvisionedDevice struct { libkb.Contextified SecretStoreOnly bool // this should only be set by the service on its startup login attempt // contains filtered or unexported fields }
LoginProvisionedDevice is an engine that tries to login using the current device, if there is an existing provisioned device.
func NewLoginProvisionedDevice ¶ added in v1.0.18
func NewLoginProvisionedDevice(g *libkb.GlobalContext, username string) *LoginProvisionedDevice
newLoginCurrentDevice creates a loginProvisionedDevice engine.
func (*LoginProvisionedDevice) Name ¶ added in v1.0.18
func (e *LoginProvisionedDevice) Name() string
Name is the unique engine name.
func (*LoginProvisionedDevice) Prereqs ¶ added in v1.0.18
func (e *LoginProvisionedDevice) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*LoginProvisionedDevice) RequiredUIs ¶ added in v1.0.18
func (e *LoginProvisionedDevice) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*LoginProvisionedDevice) Run ¶ added in v1.0.18
func (e *LoginProvisionedDevice) Run(m libkb.MetaContext) error
func (*LoginProvisionedDevice) SubConsumers ¶ added in v1.0.18
func (e *LoginProvisionedDevice) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type LoginWithPaperKey ¶ added in v1.0.19
type LoginWithPaperKey struct {
libkb.Contextified
}
LoginWithPaperKey is an engine.
func NewLoginWithPaperKey ¶ added in v1.0.19
func NewLoginWithPaperKey(g *libkb.GlobalContext) *LoginWithPaperKey
NewLoginWithPaperKey creates a LoginWithPaperKey engine. Uses the paperkey to log in and unlock LKS.
func (*LoginWithPaperKey) Name ¶ added in v1.0.19
func (e *LoginWithPaperKey) Name() string
Name is the unique engine name.
func (*LoginWithPaperKey) Prereqs ¶ added in v1.0.19
func (e *LoginWithPaperKey) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*LoginWithPaperKey) RequiredUIs ¶ added in v1.0.19
func (e *LoginWithPaperKey) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*LoginWithPaperKey) Run ¶ added in v1.0.19
func (e *LoginWithPaperKey) Run(m libkb.MetaContext) error
Run starts the engine.
func (*LoginWithPaperKey) SubConsumers ¶ added in v1.0.19
func (e *LoginWithPaperKey) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PGPDecrypt ¶
type PGPDecrypt struct { libkb.Contextified // contains filtered or unexported fields }
PGPDecrypt decrypts data read from source into sink for the logged in user.
func NewPGPDecrypt ¶
func NewPGPDecrypt(g *libkb.GlobalContext, arg *PGPDecryptArg) *PGPDecrypt
NewPGPDecrypt creates a PGPDecrypt engine.
func (*PGPDecrypt) Prereqs ¶
func (e *PGPDecrypt) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PGPDecrypt) RequiredUIs ¶
func (e *PGPDecrypt) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PGPDecrypt) Run ¶
func (e *PGPDecrypt) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*PGPDecrypt) SignatureStatus ¶
func (e *PGPDecrypt) SignatureStatus() *libkb.SignatureStatus
func (*PGPDecrypt) Signer ¶ added in v1.0.19
func (e *PGPDecrypt) Signer() *libkb.User
func (*PGPDecrypt) SubConsumers ¶
func (e *PGPDecrypt) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PGPDecryptArg ¶
type PGPEncrypt ¶
type PGPEncrypt struct { libkb.Contextified // contains filtered or unexported fields }
PGPEncrypt encrypts data read from a source into a sink for a set of users. It will track them if necessary.
func NewPGPEncrypt ¶
func NewPGPEncrypt(g *libkb.GlobalContext, arg *PGPEncryptArg) *PGPEncrypt
NewPGPEncrypt creates a PGPEncrypt engine.
func (*PGPEncrypt) Prereqs ¶
func (e *PGPEncrypt) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PGPEncrypt) RequiredUIs ¶
func (e *PGPEncrypt) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PGPEncrypt) SubConsumers ¶
func (e *PGPEncrypt) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PGPEncryptArg ¶
type PGPImportStubbedError ¶ added in v1.0.46
type PGPImportStubbedError struct {
KeyIDString string
}
func (PGPImportStubbedError) Error ¶ added in v1.0.46
func (e PGPImportStubbedError) Error() string
type PGPKey ¶
type PGPKeyExportEngine ¶
type PGPKeyExportEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewPGPKeyExportByFingerprintEngine ¶
func NewPGPKeyExportByFingerprintEngine(g *libkb.GlobalContext, arg keybase1.PGPExportByFingerprintArg) *PGPKeyExportEngine
func NewPGPKeyExportByKIDEngine ¶
func NewPGPKeyExportByKIDEngine(g *libkb.GlobalContext, arg keybase1.PGPExportByKIDArg) *PGPKeyExportEngine
func NewPGPKeyExportEngine ¶
func NewPGPKeyExportEngine(g *libkb.GlobalContext, arg keybase1.PGPExportArg) *PGPKeyExportEngine
func (*PGPKeyExportEngine) Name ¶
func (e *PGPKeyExportEngine) Name() string
func (*PGPKeyExportEngine) Prereqs ¶
func (e *PGPKeyExportEngine) Prereqs() Prereqs
func (*PGPKeyExportEngine) RequiredUIs ¶
func (e *PGPKeyExportEngine) RequiredUIs() []libkb.UIKind
func (*PGPKeyExportEngine) Results ¶
func (e *PGPKeyExportEngine) Results() []keybase1.KeyInfo
func (*PGPKeyExportEngine) Run ¶
func (e *PGPKeyExportEngine) Run(m libkb.MetaContext) (err error)
func (*PGPKeyExportEngine) SubConsumers ¶
func (e *PGPKeyExportEngine) SubConsumers() []libkb.UIConsumer
type PGPKeyGen ¶ added in v1.0.18
type PGPKeyGen struct { libkb.Contextified // contains filtered or unexported fields }
PGPKeyGen is an engine.
func NewPGPKeyGen ¶ added in v1.0.18
func NewPGPKeyGen(g *libkb.GlobalContext, arg keybase1.PGPKeyGenDefaultArg) *PGPKeyGen
NewPGPKeyGen creates a PGPKeyGen engine.
func (*PGPKeyGen) RequiredUIs ¶ added in v1.0.18
RequiredUIs returns the required UIs.
func (*PGPKeyGen) Run ¶ added in v1.0.18
func (e *PGPKeyGen) Run(m libkb.MetaContext) error
Run starts the engine.
func (*PGPKeyGen) SubConsumers ¶ added in v1.0.18
func (e *PGPKeyGen) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PGPKeyImportEngine ¶
type PGPKeyImportEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewPGPKeyImportEngine ¶
func NewPGPKeyImportEngine(g *libkb.GlobalContext, arg PGPKeyImportEngineArg) *PGPKeyImportEngine
func NewPGPKeyImportEngineFromBytes ¶
func NewPGPKeyImportEngineFromBytes(g *libkb.GlobalContext, key []byte, pushPrivate bool) (eng *PGPKeyImportEngine, err error)
func (*PGPKeyImportEngine) GetKID ¶
func (e *PGPKeyImportEngine) GetKID() (kid keybase1.KID)
func (*PGPKeyImportEngine) Name ¶
func (e *PGPKeyImportEngine) Name() string
func (*PGPKeyImportEngine) Prereqs ¶
func (e *PGPKeyImportEngine) Prereqs() Prereqs
func (*PGPKeyImportEngine) RequiredUIs ¶
func (e *PGPKeyImportEngine) RequiredUIs() []libkb.UIKind
func (*PGPKeyImportEngine) Run ¶
func (e *PGPKeyImportEngine) Run(m libkb.MetaContext) (err error)
func (*PGPKeyImportEngine) SubConsumers ¶
func (e *PGPKeyImportEngine) SubConsumers() []libkb.UIConsumer
type PGPKeyImportEngineArg ¶
type PGPKeyImportEngineArg struct { Gen *libkb.PGPGenArg Pregen *libkb.PGPKeyBundle SigningKey libkb.GenericKey Me *libkb.User Lks *libkb.LKSec NoSave bool PushSecret bool OnlySave bool AllowMulti bool DoExport bool // export to GPG keychain? ExportEncrypted bool // encrypt secret key before exporting to GPG? DoUnlock bool GPGFallback bool PreloadTsec libkb.Triplesec PreloadStreamGen libkb.PassphraseGeneration }
func ImportPGPKeyImportEngineArg ¶
func ImportPGPKeyImportEngineArg(a keybase1.PGPKeyGenArg) (ret PGPKeyImportEngineArg)
func (*PGPKeyImportEngineArg) Export ¶
func (a *PGPKeyImportEngineArg) Export() (ret keybase1.PGPKeyGenArg)
type PGPKeyfinder ¶
type PGPKeyfinder struct { libkb.Contextified // contains filtered or unexported fields }
PGPKeyfinder is an engine to find PGP Keys for users (loaded by assertions), possibly tracking them if necessary.
func NewPGPKeyfinder ¶
func NewPGPKeyfinder(g *libkb.GlobalContext, arg *PGPKeyfinderArg) *PGPKeyfinder
NewPGPKeyfinder creates a PGPKeyfinder engine.
func (*PGPKeyfinder) Prereqs ¶
func (e *PGPKeyfinder) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PGPKeyfinder) RequiredUIs ¶
func (e *PGPKeyfinder) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PGPKeyfinder) Run ¶
func (e *PGPKeyfinder) Run(m libkb.MetaContext) error
Run starts the engine.
func (*PGPKeyfinder) SubConsumers ¶
func (e *PGPKeyfinder) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
func (*PGPKeyfinder) UsersPlusKeys ¶
func (e *PGPKeyfinder) UsersPlusKeys() []*UserPlusKeys
UsersPlusKeys returns the users found while running the engine, plus their pgp keys.
type PGPKeyfinderArg ¶
type PGPKeyfinderArg struct {
Usernames []string // must be keybase usernames
}
type PGPNotActiveForLocalImport ¶
type PGPNotActiveForLocalImport struct {
// contains filtered or unexported fields
}
func (PGPNotActiveForLocalImport) Error ¶
func (e PGPNotActiveForLocalImport) Error() string
type PGPPullEngine ¶
type PGPPullEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewPGPPullEngine ¶
func NewPGPPullEngine(g *libkb.GlobalContext, arg *PGPPullEngineArg) *PGPPullEngine
func (*PGPPullEngine) Name ¶
func (e *PGPPullEngine) Name() string
func (*PGPPullEngine) Prereqs ¶
func (e *PGPPullEngine) Prereqs() Prereqs
func (*PGPPullEngine) RequiredUIs ¶
func (e *PGPPullEngine) RequiredUIs() []libkb.UIKind
func (*PGPPullEngine) Run ¶
func (e *PGPPullEngine) Run(m libkb.MetaContext) error
func (*PGPPullEngine) SubConsumers ¶
func (e *PGPPullEngine) SubConsumers() []libkb.UIConsumer
type PGPPullEngineArg ¶
type PGPPullEngineArg struct {
UserAsserts []string
}
type PGPPurge ¶ added in v1.0.18
type PGPPurge struct { libkb.Contextified // contains filtered or unexported fields }
PGPPurge is an engine.
func NewPGPPurge ¶ added in v1.0.18
func NewPGPPurge(g *libkb.GlobalContext, arg keybase1.PGPPurgeArg) *PGPPurge
NewPGPPurge creates a PGPPurge engine.
func (*PGPPurge) RequiredUIs ¶ added in v1.0.18
RequiredUIs returns the required UIs.
func (*PGPPurge) Run ¶ added in v1.0.18
func (e *PGPPurge) Run(m libkb.MetaContext) error
Run starts the engine.
func (*PGPPurge) SubConsumers ¶ added in v1.0.18
func (e *PGPPurge) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PGPSignArg ¶
type PGPSignArg struct { Sink io.WriteCloser Source io.ReadCloser Opts keybase1.PGPSignOptions }
type PGPSignEngine ¶
type PGPSignEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewPGPSignEngine ¶
func NewPGPSignEngine(g *libkb.GlobalContext, arg *PGPSignArg) *PGPSignEngine
func (*PGPSignEngine) Name ¶
func (p *PGPSignEngine) Name() string
func (*PGPSignEngine) Prereqs ¶
func (p *PGPSignEngine) Prereqs() Prereqs
func (*PGPSignEngine) RequiredUIs ¶
func (p *PGPSignEngine) RequiredUIs() []libkb.UIKind
func (*PGPSignEngine) Run ¶
func (p *PGPSignEngine) Run(m libkb.MetaContext) (err error)
func (*PGPSignEngine) SubConsumers ¶
func (p *PGPSignEngine) SubConsumers() []libkb.UIConsumer
type PGPUpdateEngine ¶
type PGPUpdateEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewPGPUpdateEngine ¶
func NewPGPUpdateEngine(g *libkb.GlobalContext, fingerprints []string, all bool) *PGPUpdateEngine
func (*PGPUpdateEngine) Name ¶
func (e *PGPUpdateEngine) Name() string
func (*PGPUpdateEngine) Prereqs ¶
func (e *PGPUpdateEngine) Prereqs() Prereqs
func (*PGPUpdateEngine) RequiredUIs ¶
func (e *PGPUpdateEngine) RequiredUIs() []libkb.UIKind
func (*PGPUpdateEngine) Run ¶
func (e *PGPUpdateEngine) Run(m libkb.MetaContext) error
func (*PGPUpdateEngine) SubConsumers ¶
func (e *PGPUpdateEngine) SubConsumers() []libkb.UIConsumer
type PGPVerify ¶
type PGPVerify struct { libkb.Contextified // contains filtered or unexported fields }
PGPVerify is an engine.
func NewPGPVerify ¶
func NewPGPVerify(g *libkb.GlobalContext, arg *PGPVerifyArg) *PGPVerify
NewPGPVerify creates a PGPVerify engine.
func (*PGPVerify) RequiredUIs ¶
RequiredUIs returns the required UIs.
func (*PGPVerify) SignatureStatus ¶
func (e *PGPVerify) SignatureStatus() *libkb.SignatureStatus
func (*PGPVerify) SubConsumers ¶
func (e *PGPVerify) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PaperKey ¶
type PaperKey struct { libkb.Contextified // contains filtered or unexported fields }
PaperKey is an engine.
func NewPaperKey ¶
func NewPaperKey(g *libkb.GlobalContext) *PaperKey
NewPaperKey creates a PaperKey engine.
func (*PaperKey) EncKey ¶
func (e *PaperKey) EncKey() libkb.GenericKey
func (*PaperKey) Passphrase ¶
func (*PaperKey) RequiredUIs ¶
RequiredUIs returns the required UIs.
func (*PaperKey) SigKey ¶
func (e *PaperKey) SigKey() libkb.GenericKey
func (*PaperKey) SubConsumers ¶
func (e *PaperKey) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PaperKeyGen ¶
type PaperKeyGen struct { libkb.Contextified // contains filtered or unexported fields }
PaperKeyGen is an engine.
func NewPaperKeyGen ¶
func NewPaperKeyGen(g *libkb.GlobalContext, arg *PaperKeyGenArg) *PaperKeyGen
NewPaperKeyGen creates a PaperKeyGen engine.
func (*PaperKeyGen) DeviceWithKeys ¶
func (e *PaperKeyGen) DeviceWithKeys() *libkb.DeviceWithKeys
func (*PaperKeyGen) EncKey ¶
func (e *PaperKeyGen) EncKey() libkb.NaclDHKeyPair
func (*PaperKeyGen) Prereqs ¶
func (e *PaperKeyGen) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PaperKeyGen) RequiredUIs ¶
func (e *PaperKeyGen) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PaperKeyGen) Run ¶
func (e *PaperKeyGen) Run(m libkb.MetaContext) error
Run starts the engine.
func (*PaperKeyGen) SigKey ¶
func (e *PaperKeyGen) SigKey() libkb.GenericKey
func (*PaperKeyGen) SubConsumers ¶
func (e *PaperKeyGen) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PaperKeyGenArg ¶
type PaperKeyGenArg struct { Passphrase libkb.PaperKeyPhrase SkipPush bool // One of Me or UID is required // Me is required if not SkipPush Me *libkb.User UID keybase1.UID SigningKey libkb.GenericKey // optional EncryptionKey libkb.NaclDHKeyPair // optional PerUserKeyring *libkb.PerUserKeyring // optional }
type PaperKeyPrimary ¶
type PaperKeyPrimary struct { libkb.Contextified // contains filtered or unexported fields }
PaperKeyPrimary is an engine.
func NewPaperKeyPrimary ¶
func NewPaperKeyPrimary(g *libkb.GlobalContext, args *PaperKeyPrimaryArgs) *PaperKeyPrimary
NewPaperKeyPrimary creates a PaperKeyPrimary engine.
func (*PaperKeyPrimary) Name ¶
func (e *PaperKeyPrimary) Name() string
Name is the unique engine name.
func (*PaperKeyPrimary) Prereqs ¶
func (e *PaperKeyPrimary) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PaperKeyPrimary) RequiredUIs ¶
func (e *PaperKeyPrimary) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PaperKeyPrimary) Run ¶
func (e *PaperKeyPrimary) Run(m libkb.MetaContext) error
Run starts the engine.
func (*PaperKeyPrimary) SubConsumers ¶
func (e *PaperKeyPrimary) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PaperKeyPrimaryArgs ¶
type PaperKeyPrimaryArgs struct { SigningKey libkb.GenericKey EncryptionKey libkb.NaclDHKeyPair Me *libkb.User PerUserKeyring *libkb.PerUserKeyring // optional }
type PaperKeySubmit ¶ added in v1.0.17
type PaperKeySubmit struct { libkb.Contextified // contains filtered or unexported fields }
PaperKeySubmit is an engine.
func NewPaperKeySubmit ¶ added in v1.0.17
func NewPaperKeySubmit(g *libkb.GlobalContext, paperPhrase string) *PaperKeySubmit
NewPaperKeySubmit creates a PaperKeySubmit engine.
func (*PaperKeySubmit) Name ¶ added in v1.0.17
func (e *PaperKeySubmit) Name() string
Name is the unique engine name.
func (*PaperKeySubmit) Prereqs ¶ added in v1.0.17
func (e *PaperKeySubmit) Prereqs() Prereqs
Prereqs returns the engine prereqs.
func (*PaperKeySubmit) RequiredUIs ¶ added in v1.0.17
func (e *PaperKeySubmit) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PaperKeySubmit) Run ¶ added in v1.0.17
func (e *PaperKeySubmit) Run(m libkb.MetaContext) error
Run starts the engine.
func (*PaperKeySubmit) SubConsumers ¶ added in v1.0.17
func (e *PaperKeySubmit) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PaperProvisionEngine ¶ added in v1.0.16
type PaperProvisionEngine struct { libkb.Contextified Username string DeviceName string PaperKey string User *libkb.User // contains filtered or unexported fields }
func NewPaperProvisionEngine ¶ added in v1.0.16
func NewPaperProvisionEngine(g *libkb.GlobalContext, username, deviceName, paperKey string) *PaperProvisionEngine
func (*PaperProvisionEngine) Name ¶ added in v1.0.16
func (e *PaperProvisionEngine) Name() string
func (*PaperProvisionEngine) Prereqs ¶ added in v1.0.16
func (e *PaperProvisionEngine) Prereqs() Prereqs
func (*PaperProvisionEngine) RequiredUIs ¶ added in v1.0.16
func (e *PaperProvisionEngine) RequiredUIs() []libkb.UIKind
func (*PaperProvisionEngine) Result ¶ added in v1.0.16
func (e *PaperProvisionEngine) Result() error
func (*PaperProvisionEngine) Run ¶ added in v1.0.16
func (e *PaperProvisionEngine) Run(m libkb.MetaContext) (err error)
func (*PaperProvisionEngine) SubConsumers ¶ added in v1.0.16
func (e *PaperProvisionEngine) SubConsumers() []libkb.UIConsumer
type PassphraseChange ¶
type PassphraseChange struct { libkb.Contextified // contains filtered or unexported fields }
PassphraseChange engine is used for changing the user's passphrase, either by replacement or by force.
func NewPassphraseChange ¶
func NewPassphraseChange(g *libkb.GlobalContext, a *keybase1.PassphraseChangeArg) *PassphraseChange
NewPassphraseChange creates a new engine for changing user passphrases, either if the current passphrase is known, or in "force" mode
func (*PassphraseChange) Name ¶
func (c *PassphraseChange) Name() string
Name provides the name of the engine for the engine interface
func (*PassphraseChange) Prereqs ¶
func (c *PassphraseChange) Prereqs() Prereqs
Prereqs returns engine prereqs
func (*PassphraseChange) RequiredUIs ¶
func (c *PassphraseChange) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PassphraseChange) Run ¶
func (c *PassphraseChange) Run(m libkb.MetaContext) (err error)
Run the engine
func (*PassphraseChange) SubConsumers ¶
func (c *PassphraseChange) SubConsumers() []libkb.UIConsumer
SubConsumers requires the other UI consumers of this engine
type PerUserKeyRoll ¶ added in v1.0.27
type PerUserKeyRoll struct { libkb.Contextified DidNewKey bool // contains filtered or unexported fields }
PerUserKeyRoll is an engine.
func NewPerUserKeyRoll ¶ added in v1.0.27
func NewPerUserKeyRoll(g *libkb.GlobalContext, args *PerUserKeyRollArgs) *PerUserKeyRoll
NewPerUserKeyRoll creates a PerUserKeyRoll engine.
func (*PerUserKeyRoll) Name ¶ added in v1.0.27
func (e *PerUserKeyRoll) Name() string
Name is the unique engine name.
func (*PerUserKeyRoll) Prereqs ¶ added in v1.0.27
func (e *PerUserKeyRoll) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PerUserKeyRoll) RequiredUIs ¶ added in v1.0.27
func (e *PerUserKeyRoll) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PerUserKeyRoll) Run ¶ added in v1.0.27
func (e *PerUserKeyRoll) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*PerUserKeyRoll) SubConsumers ¶ added in v1.0.27
func (e *PerUserKeyRoll) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PerUserKeyRollArgs ¶ added in v1.0.27
type PerUserKeyUpgrade ¶ added in v1.0.27
type PerUserKeyUpgrade struct { libkb.Contextified DidNewKey bool // contains filtered or unexported fields }
PerUserKeyUpgrade is an engine.
func NewPerUserKeyUpgrade ¶ added in v1.0.27
func NewPerUserKeyUpgrade(g *libkb.GlobalContext, args *PerUserKeyUpgradeArgs) *PerUserKeyUpgrade
NewPerUserKeyUpgrade creates a PerUserKeyUpgrade engine.
func (*PerUserKeyUpgrade) Name ¶ added in v1.0.27
func (e *PerUserKeyUpgrade) Name() string
Name is the unique engine name.
func (*PerUserKeyUpgrade) Prereqs ¶ added in v1.0.27
func (e *PerUserKeyUpgrade) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PerUserKeyUpgrade) RequiredUIs ¶ added in v1.0.27
func (e *PerUserKeyUpgrade) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PerUserKeyUpgrade) Run ¶ added in v1.0.27
func (e *PerUserKeyUpgrade) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*PerUserKeyUpgrade) SubConsumers ¶ added in v1.0.27
func (e *PerUserKeyUpgrade) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PerUserKeyUpgradeArgs ¶ added in v1.0.27
type PerUserKeyUpgradeArgs struct{}
type PerUserKeyUpgradeBackground ¶ added in v1.0.27
type PerUserKeyUpgradeBackground struct { libkb.Contextified sync.Mutex // contains filtered or unexported fields }
PerUserKeyUpgradeBackground is an engine.
func NewPerUserKeyUpgradeBackground ¶ added in v1.0.27
func NewPerUserKeyUpgradeBackground(g *libkb.GlobalContext, args *PerUserKeyUpgradeBackgroundArgs) *PerUserKeyUpgradeBackground
NewPerUserKeyUpgradeBackground creates a PerUserKeyUpgradeBackground engine.
func (*PerUserKeyUpgradeBackground) Name ¶ added in v1.0.27
func (e *PerUserKeyUpgradeBackground) Name() string
Name is the unique engine name.
func (*PerUserKeyUpgradeBackground) Prereqs ¶ added in v1.0.27
func (e *PerUserKeyUpgradeBackground) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PerUserKeyUpgradeBackground) RequiredUIs ¶ added in v1.0.27
func (e *PerUserKeyUpgradeBackground) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PerUserKeyUpgradeBackground) Run ¶ added in v1.0.27
func (e *PerUserKeyUpgradeBackground) Run(m libkb.MetaContext) (err error)
Run starts the engine. Returns immediately, kicks off a background goroutine.
func (*PerUserKeyUpgradeBackground) Shutdown ¶ added in v1.0.27
func (e *PerUserKeyUpgradeBackground) Shutdown()
func (*PerUserKeyUpgradeBackground) SubConsumers ¶ added in v1.0.27
func (e *PerUserKeyUpgradeBackground) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PerUserKeyUpgradeBackgroundArgs ¶ added in v1.0.27
type PerUserKeyUpgradeBackgroundArgs struct {
// contains filtered or unexported fields
}
type PerUserKeyUpkeep ¶ added in v1.0.27
type PerUserKeyUpkeep struct { libkb.Contextified DidRollKey bool // contains filtered or unexported fields }
PerUserKeyUpkeep is an engine.
func NewPerUserKeyUpkeep ¶ added in v1.0.27
func NewPerUserKeyUpkeep(g *libkb.GlobalContext, args *PerUserKeyUpkeepArgs) *PerUserKeyUpkeep
NewPerUserKeyUpkeep creates a PerUserKeyUpkeep engine.
func (*PerUserKeyUpkeep) Name ¶ added in v1.0.27
func (e *PerUserKeyUpkeep) Name() string
Name is the unique engine name.
func (*PerUserKeyUpkeep) Prereqs ¶ added in v1.0.27
func (e *PerUserKeyUpkeep) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PerUserKeyUpkeep) RequiredUIs ¶ added in v1.0.27
func (e *PerUserKeyUpkeep) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PerUserKeyUpkeep) Run ¶ added in v1.0.27
func (e *PerUserKeyUpkeep) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*PerUserKeyUpkeep) SubConsumers ¶ added in v1.0.27
func (e *PerUserKeyUpkeep) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PerUserKeyUpkeepArgs ¶ added in v1.0.27
type PerUserKeyUpkeepArgs struct{}
type PerUserKeyUpkeepBackground ¶ added in v1.0.27
type PerUserKeyUpkeepBackground struct { libkb.Contextified sync.Mutex // contains filtered or unexported fields }
PerUserKeyUpkeepBackground is an engine.
func NewPerUserKeyUpkeepBackground ¶ added in v1.0.27
func NewPerUserKeyUpkeepBackground(g *libkb.GlobalContext, args *PerUserKeyUpkeepBackgroundArgs) *PerUserKeyUpkeepBackground
NewPerUserKeyUpkeepBackground creates a PerUserKeyUpkeepBackground engine.
func (*PerUserKeyUpkeepBackground) Name ¶ added in v1.0.27
func (e *PerUserKeyUpkeepBackground) Name() string
Name is the unique engine name.
func (*PerUserKeyUpkeepBackground) Prereqs ¶ added in v1.0.27
func (e *PerUserKeyUpkeepBackground) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*PerUserKeyUpkeepBackground) RequiredUIs ¶ added in v1.0.27
func (e *PerUserKeyUpkeepBackground) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*PerUserKeyUpkeepBackground) Run ¶ added in v1.0.27
func (e *PerUserKeyUpkeepBackground) Run(m libkb.MetaContext) (err error)
Run starts the engine. Returns immediately, kicks off a background goroutine.
func (*PerUserKeyUpkeepBackground) Shutdown ¶ added in v1.0.27
func (e *PerUserKeyUpkeepBackground) Shutdown()
func (*PerUserKeyUpkeepBackground) SubConsumers ¶ added in v1.0.27
func (e *PerUserKeyUpkeepBackground) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type PerUserKeyUpkeepBackgroundArgs ¶ added in v1.0.27
type PerUserKeyUpkeepBackgroundArgs struct {
// contains filtered or unexported fields
}
type ProfileEdit ¶ added in v1.0.19
type ProfileEdit struct { libkb.Contextified // contains filtered or unexported fields }
func NewProfileEdit ¶ added in v1.0.19
func NewProfileEdit(g *libkb.GlobalContext, arg keybase1.ProfileEditArg) *ProfileEdit
func (*ProfileEdit) Name ¶ added in v1.0.19
func (e *ProfileEdit) Name() string
Name is the unique engine name.
func (*ProfileEdit) Prereqs ¶ added in v1.0.19
func (e *ProfileEdit) Prereqs() Prereqs
GetPrereqs returns the engine prereqs (none).
func (*ProfileEdit) RequiredUIs ¶ added in v1.0.19
func (e *ProfileEdit) RequiredUIs() []libkb.UIKind
func (*ProfileEdit) Run ¶ added in v1.0.19
func (e *ProfileEdit) Run(m libkb.MetaContext) (err error)
func (*ProfileEdit) SubConsumers ¶ added in v1.0.19
func (e *ProfileEdit) SubConsumers() []libkb.UIConsumer
type Proofs ¶
type Proofs struct { Social SocialProofList `json:"social,omitempty"` Web WebProofList `json:"web,omitempty"` PGPKeys []*PGPKey `json:"pgp_keys,omitempty"` }
type Prove ¶
type Prove struct { libkb.Contextified // contains filtered or unexported fields }
Prove is an engine used for proving ownership of remote accounts, like Twitter, GitHub, etc.
func NewProve ¶
func NewProve(g *libkb.GlobalContext, arg *keybase1.StartProofArg) *Prove
NewProve makes a new Prove Engine given an RPC-friendly ProveArg.
func (*Prove) RequiredUIs ¶
RequiredUIs returns the required UIs.
func (*Prove) Run ¶
func (p *Prove) Run(m libkb.MetaContext) (err error)
Run runs the Prove engine, performing all steps of the proof process.
func (*Prove) SubConsumers ¶
func (p *Prove) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type ProveCheck ¶
type ProveCheck struct { libkb.Contextified // contains filtered or unexported fields }
ProveCheck is an engine.
func NewProveCheck ¶
func NewProveCheck(g *libkb.GlobalContext, sigID keybase1.SigID) *ProveCheck
NewProveCheck creates a ProveCheck engine.
func (*ProveCheck) Prereqs ¶
func (e *ProveCheck) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*ProveCheck) RequiredUIs ¶
func (e *ProveCheck) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*ProveCheck) Results ¶
func (e *ProveCheck) Results() (found bool, status keybase1.ProofStatus, state keybase1.ProofState, proofText string)
func (*ProveCheck) SubConsumers ¶
func (e *ProveCheck) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type ResolveThenIdentify2 ¶
type ResolveThenIdentify2 struct { libkb.Contextified // contains filtered or unexported fields }
func NewResolveThenIdentify2 ¶
func NewResolveThenIdentify2(g *libkb.GlobalContext, arg *keybase1.Identify2Arg) *ResolveThenIdentify2
func NewResolveThenIdentify2WithTrack ¶ added in v1.0.17
func NewResolveThenIdentify2WithTrack(g *libkb.GlobalContext, arg *keybase1.Identify2Arg, topts keybase1.TrackOptions) *ResolveThenIdentify2
func (*ResolveThenIdentify2) ConfirmResult ¶ added in v1.0.17
func (e *ResolveThenIdentify2) ConfirmResult() keybase1.ConfirmResult
func (*ResolveThenIdentify2) GetProofSet ¶ added in v1.0.33
func (e *ResolveThenIdentify2) GetProofSet() *libkb.ProofSet
func (*ResolveThenIdentify2) Name ¶
func (e *ResolveThenIdentify2) Name() string
Name is the unique engine name.
func (*ResolveThenIdentify2) Prereqs ¶
func (e *ResolveThenIdentify2) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*ResolveThenIdentify2) RequiredUIs ¶
func (e *ResolveThenIdentify2) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*ResolveThenIdentify2) Result ¶
func (e *ResolveThenIdentify2) Result() *keybase1.Identify2Res
func (*ResolveThenIdentify2) Run ¶
func (e *ResolveThenIdentify2) Run(m libkb.MetaContext) (err error)
func (*ResolveThenIdentify2) SetResponsibleGregorItem ¶ added in v1.0.17
func (e *ResolveThenIdentify2) SetResponsibleGregorItem(item gregor.Item)
func (*ResolveThenIdentify2) SubConsumers ¶
func (e *ResolveThenIdentify2) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
func (*ResolveThenIdentify2) TrackToken ¶ added in v1.0.17
func (e *ResolveThenIdentify2) TrackToken() keybase1.TrackToken
type RevokeDeviceEngineArgs ¶
type RevokeEngine ¶
type RevokeEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewRevokeDeviceEngine ¶
func NewRevokeDeviceEngine(g *libkb.GlobalContext, args RevokeDeviceEngineArgs) *RevokeEngine
func NewRevokeKeyEngine ¶
func NewRevokeKeyEngine(g *libkb.GlobalContext, kid keybase1.KID) *RevokeEngine
func (*RevokeEngine) Name ¶
func (e *RevokeEngine) Name() string
func (*RevokeEngine) Prereqs ¶
func (e *RevokeEngine) Prereqs() Prereqs
func (*RevokeEngine) RequiredUIs ¶
func (e *RevokeEngine) RequiredUIs() []libkb.UIKind
func (*RevokeEngine) Run ¶
func (e *RevokeEngine) Run(m libkb.MetaContext) error
func (*RevokeEngine) SubConsumers ¶
func (e *RevokeEngine) SubConsumers() []libkb.UIConsumer
type RevokeSigsEngine ¶
type RevokeSigsEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewRevokeSigsEngine ¶
func NewRevokeSigsEngine(g *libkb.GlobalContext, sigIDQueries []string) *RevokeSigsEngine
func (*RevokeSigsEngine) Name ¶
func (e *RevokeSigsEngine) Name() string
func (*RevokeSigsEngine) Prereqs ¶
func (e *RevokeSigsEngine) Prereqs() Prereqs
func (*RevokeSigsEngine) RequiredUIs ¶
func (e *RevokeSigsEngine) RequiredUIs() []libkb.UIKind
func (*RevokeSigsEngine) Run ¶
func (e *RevokeSigsEngine) Run(m libkb.MetaContext) error
func (*RevokeSigsEngine) SubConsumers ¶
func (e *RevokeSigsEngine) SubConsumers() []libkb.UIConsumer
type SaltpackDecrypt ¶
type SaltpackDecrypt struct { libkb.Contextified // contains filtered or unexported fields }
SaltpackDecrypt decrypts data read from a source into a sink.
func NewSaltpackDecrypt ¶
func NewSaltpackDecrypt(g *libkb.GlobalContext, arg *SaltpackDecryptArg) *SaltpackDecrypt
NewSaltpackDecrypt creates a SaltpackDecrypt engine.
func (*SaltpackDecrypt) MessageInfo ¶
func (e *SaltpackDecrypt) MessageInfo() keybase1.SaltpackEncryptedMessageInfo
func (*SaltpackDecrypt) Name ¶
func (e *SaltpackDecrypt) Name() string
Name is the unique engine name.
func (*SaltpackDecrypt) Prereqs ¶
func (e *SaltpackDecrypt) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*SaltpackDecrypt) RequiredUIs ¶
func (e *SaltpackDecrypt) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*SaltpackDecrypt) Run ¶
func (e *SaltpackDecrypt) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*SaltpackDecrypt) SubConsumers ¶
func (e *SaltpackDecrypt) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type SaltpackDecryptArg ¶
type SaltpackDecryptArg struct { Source io.Reader Sink io.WriteCloser Opts keybase1.SaltpackDecryptOptions }
type SaltpackEncrypt ¶
type SaltpackEncrypt struct { libkb.Contextified // contains filtered or unexported fields }
SaltpackEncrypt encrypts data read from a source into a sink for a set of users. It will track them if necessary.
func NewSaltpackEncrypt ¶
func NewSaltpackEncrypt(g *libkb.GlobalContext, arg *SaltpackEncryptArg) *SaltpackEncrypt
NewSaltpackEncrypt creates a SaltpackEncrypt engine.
func (*SaltpackEncrypt) Name ¶
func (e *SaltpackEncrypt) Name() string
Name is the unique engine name.
func (*SaltpackEncrypt) Prereqs ¶
func (e *SaltpackEncrypt) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*SaltpackEncrypt) RequiredUIs ¶
func (e *SaltpackEncrypt) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*SaltpackEncrypt) Run ¶
func (e *SaltpackEncrypt) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*SaltpackEncrypt) SubConsumers ¶
func (e *SaltpackEncrypt) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type SaltpackEncryptArg ¶
type SaltpackEncryptArg struct { Opts keybase1.SaltpackEncryptOptions Source io.Reader Sink io.WriteCloser }
type SaltpackSenderIdentify ¶
type SaltpackSenderIdentify struct { libkb.Contextified // contains filtered or unexported fields }
func NewSaltpackSenderIdentify ¶
func NewSaltpackSenderIdentify(g *libkb.GlobalContext, arg *SaltpackSenderIdentifyArg) *SaltpackSenderIdentify
func (*SaltpackSenderIdentify) Name ¶
func (e *SaltpackSenderIdentify) Name() string
func (*SaltpackSenderIdentify) Prereqs ¶
func (e *SaltpackSenderIdentify) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*SaltpackSenderIdentify) RequiredUIs ¶
func (e *SaltpackSenderIdentify) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*SaltpackSenderIdentify) Result ¶
func (e *SaltpackSenderIdentify) Result() keybase1.SaltpackSender
func (*SaltpackSenderIdentify) Run ¶
func (e *SaltpackSenderIdentify) Run(m libkb.MetaContext) (err error)
func (*SaltpackSenderIdentify) SubConsumers ¶
func (e *SaltpackSenderIdentify) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type SaltpackSenderIdentifyArg ¶
type SaltpackSenderIdentifyArg struct {
// contains filtered or unexported fields
}
type SaltpackSign ¶
type SaltpackSign struct { libkb.Contextified // contains filtered or unexported fields }
SaltpackSign is an engine.
func NewSaltpackSign ¶
func NewSaltpackSign(g *libkb.GlobalContext, arg *SaltpackSignArg) *SaltpackSign
NewSaltpackSign creates a SaltpackSign engine.
func (*SaltpackSign) Prereqs ¶
func (e *SaltpackSign) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*SaltpackSign) RequiredUIs ¶
func (e *SaltpackSign) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*SaltpackSign) Run ¶
func (e *SaltpackSign) Run(m libkb.MetaContext) error
Run starts the engine.
func (*SaltpackSign) SubConsumers ¶
func (e *SaltpackSign) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type SaltpackSignArg ¶
type SaltpackSignArg struct { Sink io.WriteCloser Source io.ReadCloser Opts keybase1.SaltpackSignOptions }
type SaltpackVerify ¶
type SaltpackVerify struct { libkb.Contextified // contains filtered or unexported fields }
SaltpackVerify is an engine.
func NewSaltpackVerify ¶
func NewSaltpackVerify(g *libkb.GlobalContext, arg *SaltpackVerifyArg) *SaltpackVerify
NewSaltpackVerify creates a SaltpackVerify engine.
func (*SaltpackVerify) Name ¶
func (e *SaltpackVerify) Name() string
Name is the unique engine name.
func (*SaltpackVerify) Prereqs ¶
func (e *SaltpackVerify) Prereqs() Prereqs
Prereqs returns the engine prereqs.
func (*SaltpackVerify) RequiredUIs ¶
func (e *SaltpackVerify) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*SaltpackVerify) Run ¶
func (e *SaltpackVerify) Run(m libkb.MetaContext) error
Run starts the engine.
func (*SaltpackVerify) SubConsumers ¶
func (e *SaltpackVerify) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type SaltpackVerifyArg ¶
type SaltpackVerifyArg struct { Sink io.WriteCloser Source io.Reader Opts keybase1.SaltpackVerifyOptions }
SaltpackVerifyArg are engine args.
type ScanKeys ¶
type ScanKeys struct { sync.Mutex // protect keyOwners map libkb.MetaContextified // contains filtered or unexported fields }
ScanKeys finds pgp decryption keys in SKB and also if there is one stored on the server. It satisfies the openpgp.KeyRing interface.
It also will find public pgp keys for signature verification.
It is not an engine, but uses an engine and is used by engines, so has to be in the engine package. It is a UIConsumer.
func NewScanKeys ¶
func NewScanKeys(m libkb.MetaContext) (sk *ScanKeys, err error)
NewScanKeys creates a ScanKeys type. If there is a login session, it will load the pgp keys for that user.
func (*ScanKeys) DecryptionKeys ¶
DecryptionKeys returns all private keys that are valid for decryption. It is only used if there is no key id in the message.
func (*ScanKeys) KeyOwner ¶ added in v1.0.19
KeyOwner returns the owner of the keys found by ScanKeys that were used in KeysById or KeysByIdUsage, indexed by keyID.
func (*ScanKeys) KeyOwnerByEntity ¶ added in v1.0.19
func (*ScanKeys) KeysById ¶
KeysById returns the set of keys that have the given key id. It is only called during decryption by openpgp.
func (*ScanKeys) KeysByIdUsage ¶
KeysByIdAndUsage returns the set of public keys with the given id that also meet the key usage given by requiredUsage.
The requiredUsage is expressed as the bitwise-OR of packet.KeyFlag* values.
It is only called during signature verification so therefore requiredUsage will only equal KeyFlagSign, thus only public keys are required. If this ever changes upstream in openpgp, this function will panic.
func (*ScanKeys) RequiredUIs ¶
func (*ScanKeys) SubConsumers ¶
func (s *ScanKeys) SubConsumers() []libkb.UIConsumer
type ScanProofsCache ¶ added in v1.0.18
type ScanProofsCache struct {
// contains filtered or unexported fields
}
func LoadScanProofsCache ¶ added in v1.0.18
func LoadScanProofsCache(filepath string) (*ScanProofsCache, error)
func NewScanProofsCache ¶ added in v1.0.18
func NewScanProofsCache() *ScanProofsCache
func (*ScanProofsCache) Get ¶ added in v1.0.18
func (c *ScanProofsCache) Get(sigID string) bool
func (*ScanProofsCache) Save ¶ added in v1.0.18
func (c *ScanProofsCache) Save(filepath string) error
func (*ScanProofsCache) Set ¶ added in v1.0.18
func (c *ScanProofsCache) Set(sigID string)
type ScanProofsCacheData ¶ added in v1.0.18
type ScanProofsEngine ¶ added in v1.0.18
type ScanProofsEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewScanProofsEngine ¶ added in v1.0.18
func NewScanProofsEngine(infile string, indices string, sigid string, ratelimit int, cachefile string, ignorefile string, g *libkb.GlobalContext) *ScanProofsEngine
func (*ScanProofsEngine) CheckOne ¶ added in v1.0.18
func (e *ScanProofsEngine) CheckOne(m libkb.MetaContext, rec map[string]string, tickers ScanProofsTickers) (libkb.ProofError, bool, error)
CheckOne checks one proof using two checkers (default, pvl). NOTE: This doesn't make sense anymore because pvl is the default. Returns nil or an error, whether a hint was found, and any more serious error
func (*ScanProofsEngine) GetRemoteProofChainLink ¶ added in v1.0.18
func (e *ScanProofsEngine) GetRemoteProofChainLink(m libkb.MetaContext, uid keybase1.UID, sigid keybase1.SigID) (libkb.RemoteProofChainLink, error)
func (*ScanProofsEngine) GetSigHint ¶ added in v1.0.18
func (e *ScanProofsEngine) GetSigHint(m libkb.MetaContext, uid keybase1.UID, sigid keybase1.SigID) (*libkb.SigHint, error)
GetSigHint gets the SigHint. This can return (nil, nil) if nothing goes wrong but there is no hint.
func (*ScanProofsEngine) Name ¶ added in v1.0.18
func (e *ScanProofsEngine) Name() string
func (*ScanProofsEngine) ParseIndices ¶ added in v1.0.18
func (e *ScanProofsEngine) ParseIndices(indices string) (start int, end int, reterr error)
func (*ScanProofsEngine) Prereqs ¶ added in v1.0.18
func (e *ScanProofsEngine) Prereqs() Prereqs
func (*ScanProofsEngine) ProcessOne ¶ added in v1.0.18
func (e *ScanProofsEngine) ProcessOne(m libkb.MetaContext, i int, rec map[string]string, cache *ScanProofsCache, ignored []string, tickers ScanProofsTickers) error
func (*ScanProofsEngine) RequiredUIs ¶ added in v1.0.18
func (e *ScanProofsEngine) RequiredUIs() []libkb.UIKind
func (*ScanProofsEngine) Run ¶ added in v1.0.18
func (e *ScanProofsEngine) Run(m libkb.MetaContext) (err error)
func (*ScanProofsEngine) SubConsumers ¶ added in v1.0.18
func (e *ScanProofsEngine) SubConsumers() []libkb.UIConsumer
type ScanProofsTickers ¶ added in v1.0.18
type SearchEngine ¶
type SearchEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewSearchEngine ¶
func NewSearchEngine(g *libkb.GlobalContext, args SearchEngineArgs) *SearchEngine
func (*SearchEngine) GetResults ¶
func (e *SearchEngine) GetResults() []keybase1.SearchResult
func (*SearchEngine) Name ¶
func (e *SearchEngine) Name() string
func (*SearchEngine) Prereqs ¶
func (e *SearchEngine) Prereqs() Prereqs
func (*SearchEngine) RequiredUIs ¶
func (e *SearchEngine) RequiredUIs() []libkb.UIKind
func (*SearchEngine) Run ¶
func (e *SearchEngine) Run(m libkb.MetaContext) error
func (*SearchEngine) SubConsumers ¶
func (e *SearchEngine) SubConsumers() []libkb.UIConsumer
type SearchEngineArgs ¶
type SecretKeysEngine ¶
type SecretKeysEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewSecretKeysEngine ¶
func NewSecretKeysEngine(g *libkb.GlobalContext) *SecretKeysEngine
func (*SecretKeysEngine) Name ¶
func (e *SecretKeysEngine) Name() string
func (*SecretKeysEngine) Prereqs ¶
func (e *SecretKeysEngine) Prereqs() Prereqs
func (*SecretKeysEngine) RequiredUIs ¶
func (e *SecretKeysEngine) RequiredUIs() []libkb.UIKind
func (*SecretKeysEngine) Result ¶
func (e *SecretKeysEngine) Result() keybase1.SecretKeys
func (*SecretKeysEngine) Run ¶
func (e *SecretKeysEngine) Run(m libkb.MetaContext) (err error)
func (*SecretKeysEngine) SubConsumers ¶
func (e *SecretKeysEngine) SubConsumers() []libkb.UIConsumer
type SignupEngine ¶
type SignupEngine struct {
// contains filtered or unexported fields
}
func NewSignupEngine ¶
func NewSignupEngine(g *libkb.GlobalContext, arg *SignupEngineRunArg) *SignupEngine
func (*SignupEngine) GetMe ¶
func (s *SignupEngine) GetMe() *libkb.User
func (*SignupEngine) Name ¶
func (s *SignupEngine) Name() string
func (*SignupEngine) Prereqs ¶
func (s *SignupEngine) Prereqs() Prereqs
func (*SignupEngine) RequiredUIs ¶
func (s *SignupEngine) RequiredUIs() []libkb.UIKind
func (*SignupEngine) Run ¶
func (s *SignupEngine) Run(m libkb.MetaContext) (err error)
func (*SignupEngine) SubConsumers ¶
func (s *SignupEngine) SubConsumers() []libkb.UIConsumer
type SignupEngineRunArg ¶
type SignupJoinEngine ¶
type SignupJoinEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewSignupJoinEngine ¶
func NewSignupJoinEngine(g *libkb.GlobalContext) *SignupJoinEngine
func (*SignupJoinEngine) CheckRegistered ¶
func (s *SignupJoinEngine) CheckRegistered() (err error)
func (*SignupJoinEngine) Init ¶
func (s *SignupJoinEngine) Init() error
func (*SignupJoinEngine) Post ¶
func (s *SignupJoinEngine) Post(m libkb.MetaContext, arg SignupJoinEngineRunArg) (err error)
func (*SignupJoinEngine) PostInviteRequest ¶
func (s *SignupJoinEngine) PostInviteRequest(ctx context.Context, arg libkb.InviteRequestArg) error
func (*SignupJoinEngine) Run ¶
func (s *SignupJoinEngine) Run(m libkb.MetaContext, arg SignupJoinEngineRunArg) (res SignupJoinEngineRunRes)
func (*SignupJoinEngine) WriteOut ¶
func (s *SignupJoinEngine) WriteOut(m libkb.MetaContext, salt []byte) error
type SignupJoinEngineRunArg ¶
type SignupJoinEngineRunRes ¶
type SignupJoinEngineRunRes struct { PassphraseOk bool PostOk bool WriteOk bool UID keybase1.UID User *libkb.User Err error PpGen libkb.PassphraseGeneration }
func (SignupJoinEngineRunRes) Error ¶
func (r SignupJoinEngineRunRes) Error() string
type SigsList ¶
type SigsList struct { SigsListArgs libkb.Contextified // contains filtered or unexported fields }
SigsList is an engine for the sigs-list command.
func NewSigsList ¶
func NewSigsList(g *libkb.GlobalContext, args SigsListArgs) *SigsList
NewSigsList creates a SigsList engine.
func (*SigsList) RequiredUIs ¶
RequiredUIs returns the required UIs.
func (*SigsList) SubConsumers ¶
func (e *SigsList) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type SigsListArgs ¶
type SocialProof ¶
func (SocialProof) Export ¶
func (s SocialProof) Export() keybase1.TrackProof
type SocialProofList ¶
type SocialProofList []SocialProof
func (SocialProofList) Export ¶
func (s SocialProofList) Export() []keybase1.TrackProof
type Summary ¶
type Summary struct { UID keybase1.UID `json:"-"` Username string `json:"username"` Thumbnail string `json:"thumbnail"` IDVersion int `json:"id_version"` FullName string `json:"full_name"` Bio string `json:"bio"` Proofs *Proofs `json:"remote_proofs,omitempty"` }
func (Summary) Export ¶
func (s Summary) Export() keybase1.UserSummary
type TaskFunc ¶ added in v1.0.27
type TaskFunc func(m libkb.MetaContext) error
Function to run periodically. The error is logged but otherwise ignored.
type TrackEngine ¶
type TrackEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewTrackEngine ¶
func NewTrackEngine(g *libkb.GlobalContext, arg *TrackEngineArg) *TrackEngine
NewTrackEngine creates a default TrackEngine for tracking theirName.
func (*TrackEngine) ConfirmResult ¶ added in v1.0.22
func (e *TrackEngine) ConfirmResult() keybase1.ConfirmResult
func (*TrackEngine) Name ¶
func (e *TrackEngine) Name() string
func (*TrackEngine) Prereqs ¶
func (e *TrackEngine) Prereqs() Prereqs
func (*TrackEngine) RequiredUIs ¶
func (e *TrackEngine) RequiredUIs() []libkb.UIKind
func (*TrackEngine) Run ¶
func (e *TrackEngine) Run(m libkb.MetaContext) error
func (*TrackEngine) SubConsumers ¶
func (e *TrackEngine) SubConsumers() []libkb.UIConsumer
func (*TrackEngine) User ¶
func (e *TrackEngine) User() *libkb.User
type TrackEngineArg ¶
type TrackEngineArg struct { UserAssertion string Me *libkb.User Options keybase1.TrackOptions ForceRemoteCheck bool AllowSelfIdentify bool SigVersion libkb.SigVersion }
type TrackList ¶
type TrackList []*libkb.TrackChainLink
type TrackToken ¶
type TrackToken struct { libkb.Contextified // contains filtered or unexported fields }
TrackToken is an engine.
func NewTrackToken ¶
func NewTrackToken(g *libkb.GlobalContext, arg *TrackTokenArg) *TrackToken
NewTrackToken creates a TrackToken engine.
func (*TrackToken) Prereqs ¶
func (e *TrackToken) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*TrackToken) RequiredUIs ¶
func (e *TrackToken) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*TrackToken) Run ¶
func (e *TrackToken) Run(m libkb.MetaContext) (err error)
Run starts the engine.
func (*TrackToken) SubConsumers ¶
func (e *TrackToken) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type TrackTokenArg ¶
type TrackTokenArg struct { Token keybase1.TrackToken Me *libkb.User Options keybase1.TrackOptions }
type UIDelegateWanter ¶
type Unlock ¶
type Unlock struct { libkb.Contextified // contains filtered or unexported fields }
Unlock is an engine.
func NewUnlockWithPassphrase ¶
func NewUnlockWithPassphrase(g *libkb.GlobalContext, passphrase string) *Unlock
NewUnlock creates a Unlock engine.
func (*Unlock) RequiredUIs ¶
RequiredUIs returns the required UIs.
func (*Unlock) SubConsumers ¶
func (e *Unlock) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type UntrackEngine ¶
type UntrackEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewUntrackEngine ¶
func NewUntrackEngine(g *libkb.GlobalContext, arg *UntrackEngineArg) *UntrackEngine
NewUntrackEngine creates a default UntrackEngine for tracking theirName.
func (*UntrackEngine) Name ¶
func (e *UntrackEngine) Name() string
func (*UntrackEngine) Prereqs ¶
func (e *UntrackEngine) Prereqs() Prereqs
func (*UntrackEngine) RequiredUIs ¶
func (e *UntrackEngine) RequiredUIs() []libkb.UIKind
func (*UntrackEngine) Run ¶
func (e *UntrackEngine) Run(m libkb.MetaContext) (err error)
func (*UntrackEngine) SubConsumers ¶
func (e *UntrackEngine) SubConsumers() []libkb.UIConsumer
type UntrackEngineArg ¶
type UntrackEngineArg struct { Username libkb.NormalizedUsername Me *libkb.User SigVersion libkb.SigVersion }
type UserConfigEngine ¶
type UserConfigEngine struct { libkb.Contextified // contains filtered or unexported fields }
func NewUserConfigEngine ¶
func NewUserConfigEngine(g *libkb.GlobalContext, arg *UserConfigEngineArg) *UserConfigEngine
func (*UserConfigEngine) Name ¶
func (e *UserConfigEngine) Name() string
func (*UserConfigEngine) Prereqs ¶
func (e *UserConfigEngine) Prereqs() Prereqs
func (*UserConfigEngine) RequiredUIs ¶
func (e *UserConfigEngine) RequiredUIs() []libkb.UIKind
func (*UserConfigEngine) Run ¶
func (e *UserConfigEngine) Run(m libkb.MetaContext) (err error)
func (*UserConfigEngine) SubConsumers ¶
func (e *UserConfigEngine) SubConsumers() []libkb.UIConsumer
type UserConfigEngineArg ¶
type UserPlusKeys ¶
type UserPlusKeys struct { User *libkb.User IsTracked bool Keys []*libkb.PGPKeyBundle }
type UserSummary ¶
type UserSummary struct { libkb.Contextified // contains filtered or unexported fields }
func NewUserSummary ¶
func NewUserSummary(g *libkb.GlobalContext, uids []keybase1.UID) *UserSummary
func (*UserSummary) ExportedSummariesList ¶
func (e *UserSummary) ExportedSummariesList() (ret []keybase1.UserSummary)
func (*UserSummary) Prereqs ¶
func (e *UserSummary) Prereqs() Prereqs
GetPrereqs returns the engine prereqs (none).
func (*UserSummary) RequiredUIs ¶
func (e *UserSummary) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*UserSummary) Run ¶
func (e *UserSummary) Run(m libkb.MetaContext) error
Run starts the engine.
func (*UserSummary) SubConsumers ¶
func (e *UserSummary) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
func (*UserSummary) SummariesList ¶
func (e *UserSummary) SummariesList() []*Summary
type WalletInitBackground ¶ added in v1.0.46
type WalletInitBackground struct { libkb.Contextified sync.Mutex // contains filtered or unexported fields }
WalletInitBackground is an engine.
func NewWalletInitBackground ¶ added in v1.0.46
func NewWalletInitBackground(g *libkb.GlobalContext, args *WalletInitBackgroundArgs) *WalletInitBackground
NewWalletInitBackground creates a WalletInitBackground engine.
func (*WalletInitBackground) Name ¶ added in v1.0.46
func (e *WalletInitBackground) Name() string
Name is the unique engine name.
func (*WalletInitBackground) Prereqs ¶ added in v1.0.46
func (e *WalletInitBackground) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*WalletInitBackground) RequiredUIs ¶ added in v1.0.46
func (e *WalletInitBackground) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*WalletInitBackground) Run ¶ added in v1.0.46
func (e *WalletInitBackground) Run(m libkb.MetaContext) (err error)
Run starts the engine. Returns immediately, kicks off a background goroutine.
func (*WalletInitBackground) Shutdown ¶ added in v1.0.46
func (e *WalletInitBackground) Shutdown()
func (*WalletInitBackground) SubConsumers ¶ added in v1.0.46
func (e *WalletInitBackground) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type WalletInitBackgroundArgs ¶ added in v1.0.46
type WalletInitBackgroundArgs struct {
// contains filtered or unexported fields
}
type WalletUpkeepBackground ¶ added in v1.0.46
type WalletUpkeepBackground struct { libkb.Contextified sync.Mutex // contains filtered or unexported fields }
WalletUpkeepBackground is an engine.
func NewWalletUpkeepBackground ¶ added in v1.0.46
func NewWalletUpkeepBackground(g *libkb.GlobalContext, args *WalletUpkeepBackgroundArgs) *WalletUpkeepBackground
NewWalletUpkeepBackground creates a WalletUpkeepBackground engine.
func (*WalletUpkeepBackground) Name ¶ added in v1.0.46
func (e *WalletUpkeepBackground) Name() string
Name is the unique engine name.
func (*WalletUpkeepBackground) Prereqs ¶ added in v1.0.46
func (e *WalletUpkeepBackground) Prereqs() Prereqs
GetPrereqs returns the engine prereqs.
func (*WalletUpkeepBackground) RequiredUIs ¶ added in v1.0.46
func (e *WalletUpkeepBackground) RequiredUIs() []libkb.UIKind
RequiredUIs returns the required UIs.
func (*WalletUpkeepBackground) Run ¶ added in v1.0.46
func (e *WalletUpkeepBackground) Run(m libkb.MetaContext) (err error)
Run starts the engine. Returns immediately, kicks off a background goroutine.
func (*WalletUpkeepBackground) Shutdown ¶ added in v1.0.46
func (e *WalletUpkeepBackground) Shutdown()
func (*WalletUpkeepBackground) SubConsumers ¶ added in v1.0.46
func (e *WalletUpkeepBackground) SubConsumers() []libkb.UIConsumer
SubConsumers returns the other UI consumers for this engine.
type WalletUpkeepBackgroundArgs ¶ added in v1.0.46
type WalletUpkeepBackgroundArgs struct {
// contains filtered or unexported fields
}
type WebProofList ¶
type WebProofList []WebProof
func (WebProofList) Export ¶
func (w WebProofList) Export() []keybase1.WebProof
Source Files ¶
- account_delete.go
- background_task.go
- bg_identifier.go
- bootstrap.go
- buffered_identify_ui.go
- common.go
- crypto.go
- cryptocurrency.go
- deprovision.go
- device_add.go
- device_history.go
- device_keyfinder.go
- device_keygen.go
- device_wrap.go
- devlist.go
- email_change.go
- engine.go
- errors.go
- favorite_add.go
- favorite_ignore.go
- favorite_list.go
- gpg_import_key.go
- hasserverkeys.go
- identify2_with_uid.go
- kex2_provisionee.go
- kex2_provisioner.go
- list_trackers.go
- list_trackers2.go
- list_tracking.go
- login.go
- login_load_user.go
- login_offline.go
- login_oneshot.go
- login_provision.go
- login_provisioned_device.go
- login_with_paperkey.go
- loopback_identify_ui.go
- paperkey.go
- paperkey_gen.go
- paperkey_primary.go
- paperkey_submit.go
- paperprovision.go
- passphrase_change.go
- pgp_common.go
- pgp_decrypt.go
- pgp_encrypt.go
- pgp_export_key.go
- pgp_import_key.go
- pgp_keyfinder.go
- pgp_keygen.go
- pgp_pull.go
- pgp_purge.go
- pgp_sign.go
- pgp_update.go
- pgp_verify.go
- profile_edit.go
- prove.go
- prove_check.go
- puk_roll.go
- puk_upgrade.go
- puk_upgrade_background.go
- puk_upkeep.go
- puk_upkeep_background.go
- resolve_identify2.go
- revoke.go
- revoke_sigs.go
- rpc_exim.go
- saltpack_decrypt.go
- saltpack_encrypt.go
- saltpack_sender_identify.go
- saltpack_sign.go
- saltpack_verify.go
- scankeys.go
- scanproofs.go
- search.go
- secretkeys.go
- signup.go
- signup_join.go
- sigslist.go
- track.go
- track_token.go
- unlock.go
- untrack.go
- user_card.go
- user_config.go
- user_summary.go
- wallet_init_background.go
- wallet_upkeep_background.go