hOpenPGP-3.5: native Haskell implementation of OpenPGP (RFC9580)

Safe Haskell	None
Language	Haskell2010

Codec.Encryption.OpenPGP.SecretKey

Synopsis

decryptPrivateKey :: (SomePKPayload, SKAddendum) -> Passphrase -> Either String SKAddendum
mkUnencryptedSKAddendum :: SomePKPayload -> SKey -> Either String SKAddendum
encryptPrivateKeyWithPolicyAndSaltAndIV :: OpenPGPPolicy -> SomePKPayload -> Salt -> IV -> SKAddendum -> Passphrase -> Either String SKAddendum
reencryptPrivateKeyTyped :: forall (v :: KeyVersion). SomePKPayload -> SKAddendumV v -> Salt -> IV -> SKey -> Passphrase -> Either String (SKAddendumV v)
reencryptPrivateKeyTypedWithPolicy :: forall (v :: KeyVersion). OpenPGPPolicy -> SomePKPayload -> SKAddendumV v -> Salt -> IV -> SKey -> Passphrase -> Either String (SKAddendumV v)
reencryptPrivateKeyWithSaltAndIV :: SomePKPayload -> SKAddendum -> Salt -> IV -> SKey -> Passphrase -> Either String SKAddendum
data SecretKeyError
renderSecretKeyError :: SecretKeyError -> String
data SecretKeyEncryptOptions = SecretKeyEncryptOptions {
- skeoPolicy :: OpenPGPPolicy
- skeoGenerateSaltAndIV :: Bool
- skeoSalt :: Maybe Salt
- skeoIV :: Maybe IV
}
decryptSecretKey :: SecretKey -> Passphrase -> Either SecretKeyError SKey
decryptSecretKeyAddendum :: SomePKPayload -> SKAddendum -> Passphrase -> Either SecretKeyError (SKey, SKAddendum)
encryptSecretKey :: MonadRandom m => SomePKPayload -> SKey -> Passphrase -> SecretKeyEncryptOptions -> m (Either SecretKeyError SKAddendum)
encryptSecretKeyWithPolicy :: MonadRandom m => OpenPGPPolicy -> SomePKPayload -> SKey -> Passphrase -> m (Either SecretKeyError SKAddendum)
reencryptSecretKey :: MonadRandom m => SecretKey -> Passphrase -> Passphrase -> SecretKeyEncryptOptions -> m (Either SecretKeyError SecretKey)
reencryptSecretKeyRandom :: MonadRandom m => SecretKey -> Passphrase -> Passphrase -> OpenPGPPolicy -> m (Either SecretKeyError SecretKey)

Documentation

decryptPrivateKey :: (SomePKPayload, SKAddendum) -> Passphrase -> Either String SKAddendum Source #

Deprecated: Use decryptSecretKeyAddendum

mkUnencryptedSKAddendum :: SomePKPayload -> SKey -> Either String SKAddendum Source #

encryptPrivateKeyWithPolicyAndSaltAndIV :: OpenPGPPolicy -> SomePKPayload -> Salt -> IV -> SKAddendum -> Passphrase -> Either String SKAddendum Source #

Deprecated: Use encryptSecretKeyWithPolicy

reencryptPrivateKeyTyped :: forall (v :: KeyVersion). SomePKPayload -> SKAddendumV v -> Salt -> IV -> SKey -> Passphrase -> Either String (SKAddendumV v) Source #

Deprecated: Use reencryptSecretKey

reencryptPrivateKeyTypedWithPolicy :: forall (v :: KeyVersion). OpenPGPPolicy -> SomePKPayload -> SKAddendumV v -> Salt -> IV -> SKey -> Passphrase -> Either String (SKAddendumV v) Source #

Deprecated: Use reencryptSecretKey

reencryptPrivateKeyWithSaltAndIV :: SomePKPayload -> SKAddendum -> Salt -> IV -> SKey -> Passphrase -> Either String SKAddendum Source #

Deprecated: Use reencryptSecretKey

data SecretKeyError Source #

Constructors

SecretKeyDecryptError String
SecretKeyEncryptError String
SecretKeyPolicyError String
SecretKeyUnsupportedLegacyProtection

Instances

Instances details

Show SecretKeyError Source #
Instance details Defined in Codec.Encryption.OpenPGP.SecretKey Methods showsPrec :: Int -> SecretKeyError -> ShowS Source # show :: SecretKeyError -> String Source # showList :: [SecretKeyError] -> ShowS Source #
Eq SecretKeyError Source #
Instance details Defined in Codec.Encryption.OpenPGP.SecretKey Methods (==) :: SecretKeyError -> SecretKeyError -> Bool Source # (/=) :: SecretKeyError -> SecretKeyError -> Bool Source #

renderSecretKeyError :: SecretKeyError -> String Source #

data SecretKeyEncryptOptions Source #

Constructors

SecretKeyEncryptOptions
Fields skeoPolicy :: OpenPGPPolicy skeoGenerateSaltAndIV :: Bool skeoSalt :: Maybe Salt skeoIV :: Maybe IV

decryptSecretKey :: SecretKey -> Passphrase -> Either SecretKeyError SKey Source #

decryptSecretKeyAddendum :: SomePKPayload -> SKAddendum -> Passphrase -> Either SecretKeyError (SKey, SKAddendum) Source #

encryptSecretKey :: MonadRandom m => SomePKPayload -> SKey -> Passphrase -> SecretKeyEncryptOptions -> m (Either SecretKeyError SKAddendum) Source #

encryptSecretKeyWithPolicy :: MonadRandom m => OpenPGPPolicy -> SomePKPayload -> SKey -> Passphrase -> m (Either SecretKeyError SKAddendum) Source #

reencryptSecretKey :: MonadRandom m => SecretKey -> Passphrase -> Passphrase -> SecretKeyEncryptOptions -> m (Either SecretKeyError SecretKey) Source #

reencryptSecretKeyRandom :: MonadRandom m => SecretKey -> Passphrase -> Passphrase -> OpenPGPPolicy -> m (Either SecretKeyError SecretKey) Source #