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

Safe Haskell	None
Language	Haskell2010

Codec.Encryption.OpenPGP.SecretKey

Synopsis

decryptPrivateKey :: (SomePKPayload, SKAddendum) -> ByteString -> Either String SKAddendum
reinterpretUnknownSKeyForPKPayload :: SomePKPayload -> SKey -> Either String SKey
mkUnencryptedSKAddendum :: SomePKPayload -> SKey -> Either String SKAddendum
encryptPrivateKeyWithPolicyAndSaltAndIV :: OpenPGPPolicy -> SomePKPayload -> Salt -> IV -> SKAddendum -> ByteString -> Either String SKAddendum
encryptPrivateKey :: MonadRandom m => OpenPGPPolicy -> SomePKPayload -> SKAddendum -> ByteString -> m (Either String SKAddendum)
changePrivateKeyPassphrase :: (SomePKPayload, SKAddendum) -> ByteString -> Salt -> IV -> ByteString -> Either String SKAddendum
changePrivateKeyPassphraseRandom :: MonadRandom m => (SomePKPayload, SKAddendum) -> ByteString -> ByteString -> m (Either String SKAddendum)
reencryptSecretKeyRandomEither :: MonadRandom m => SecretKey -> ByteString -> m (Either String SecretKey)
reencryptPrivateKeyTyped :: forall (v :: KeyVersion). SomePKPayload -> SKAddendumV v -> Salt -> IV -> SKey -> ByteString -> Either String (SKAddendumV v)
data SecretKeyError
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)
changeSecretKeyPassphrase :: MonadRandom m => SecretKey -> Passphrase -> Passphrase -> m (Either SecretKeyError SecretKey)

Documentation

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

reinterpretUnknownSKeyForPKPayload :: SomePKPayload -> SKey -> Either String SKey Source #

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

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

encryptPrivateKey :: MonadRandom m => OpenPGPPolicy -> SomePKPayload -> SKAddendum -> ByteString -> m (Either String SKAddendum) Source #

Deprecated: Use encryptSecretKeyWithPolicy instead

generates pseudo-random salt and IV

changePrivateKeyPassphrase :: (SomePKPayload, SKAddendum) -> ByteString -> Salt -> IV -> ByteString -> Either String SKAddendum Source #

Deprecated: Use reencryptSecretKey instead

changePrivateKeyPassphraseRandom :: MonadRandom m => (SomePKPayload, SKAddendum) -> ByteString -> ByteString -> m (Either String SKAddendum) Source #

Deprecated: Use reencryptSecretKeyRandom instead

reencryptSecretKeyRandomEither :: MonadRandom m => SecretKey -> ByteString -> m (Either String SecretKey) Source #

Deprecated: Use changeSecretKeyPassphrase or reencryptSecretKeyRandom instead

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

Version-preserving re-encryption of a typed secret-key addendum.

Each constructor family is re-encrypted in kind: * V6 variants (AEAD, SHA1, Sym, Unencrypted) → SKAAEADV6 (default v6 policy) * SKA16bit / SKASHA1Legacy → same S2K family with updated salt * SKAAEADLegacy → re-protected as SKASHA1Legacy (standard v3/v4 S2K) * SKASymLegacy → legacy CFB re-encryption as SKASymLegacy * SKAUnencryptedLegacy → Left (cannot re-encrypt unencrypted legacy keys)

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 #

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 #

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

Deprecated: Use reencryptSecretKey or reencryptSecretKeyRandom instead