botan-low 0.0.2.0 → 0.1.0.0

raw patch · 126 files changed

+6889/−7684 lines, 126 filesdep +asyncdep +containersdep +tastydep −cryptondep −tasty-benchdep ~basedep ~botan-bindingsdep ~bytestringPVP ok

version bump matches the API change (PVP)

Dependencies added: async, containers, tasty, tasty-hspec, tasty-hunit, tasty-quickcheck

Dependencies removed: crypton, tasty-bench

Dependency ranges changed: base, botan-bindings, bytestring, text

API changes (from Hackage documentation)

Files

• CHANGELOG.md +97/−0
• README.md +8/−3
• bench/Bcrypt.hs +0/−74
• botan-low.cabal +112/−828
• src/Botan/Low/Bcrypt.hs +34/−34
• src/Botan/Low/BlockCipher.hs +412/−255
• src/Botan/Low/Cipher.hs +173/−159
• src/Botan/Low/Error.hs +33/−394
• src/Botan/Low/Error/Internal.hs +282/−0
• src/Botan/Low/FPE.hs +31/−40
• src/Botan/Low/HOTP.hs +52/−51
• src/Botan/Low/Hash.hs +81/−85
• src/Botan/Low/Internal/ByteString.hs +107/−0
• src/Botan/Low/Internal/String.hs +16/−0
• src/Botan/Low/KDF.hs +55/−44
• src/Botan/Low/KeyWrap.hs +10/−13
• src/Botan/Low/MAC.hs +49/−52
• src/Botan/Low/MPI.hs +66/−62
• src/Botan/Low/Make.hs +119/−67
• src/Botan/Low/Prelude.hs +0/−247
• src/Botan/Low/PubKey.hs +240/−246
• src/Botan/Low/PubKey/DH.hs +7/−10
• src/Botan/Low/PubKey/DSA.hs +9/−12
• src/Botan/Low/PubKey/Decrypt.hs +41/−35
• src/Botan/Low/PubKey/ECDH.hs +8/−7
• src/Botan/Low/PubKey/ECDSA.hs +8/−7
• src/Botan/Low/PubKey/Ed25519.hs +12/−11
• src/Botan/Low/PubKey/ElGamal.hs +9/−12
• src/Botan/Low/PubKey/Encrypt.hs +50/−49
• src/Botan/Low/PubKey/KeyAgreement.hs +77/−92
• src/Botan/Low/PubKey/KeyEncapsulation.hs +45/−50
• src/Botan/Low/PubKey/RSA.hs +12/−10
• src/Botan/Low/PubKey/SM2.hs +8/−7
• src/Botan/Low/PubKey/Sign.hs +32/−34
• src/Botan/Low/PubKey/Verify.hs +34/−41
• src/Botan/Low/PubKey/X25519.hs +12/−13
• src/Botan/Low/PwdHash.hs +196/−101
• src/Botan/Low/RNG.hs +32/−37
• src/Botan/Low/Remake.hs +31/−130
• src/Botan/Low/SRP6.hs +420/−259
• src/Botan/Low/TOTP.hs +52/−51
• src/Botan/Low/Utility.hs +94/−106
• src/Botan/Low/Version.hs +30/−36
• src/Botan/Low/View.hs +16/−22
• src/Botan/Low/X509.hs +161/−160
• src/Botan/Low/X509/CA.hs +0/−115
• src/Botan/Low/X509/CRL.hs +0/−151
• src/Botan/Low/X509/CSR.hs +0/−85
• src/Botan/Low/X509/DN.hs +0/−60
• src/Botan/Low/X509/Extensions.hs +0/−26
• src/Botan/Low/X509/Options.hs +0/−157
• src/Botan/Low/X509/Path.hs +0/−141
• src/Botan/Low/X509/Store.hs +0/−326
• src/Botan/Low/ZFEC.hs +23/−21
• test/Botan/Low/BcryptSpec.hs +0/−25
• test/Botan/Low/BlockCipherSpec.hs +0/−68
• test/Botan/Low/CipherSpec.hs +0/−223
• test/Botan/Low/FPESpec.hs +0/−97
• test/Botan/Low/HOTPSpec.hs +0/−27
• test/Botan/Low/HashSpec.hs +0/−48
• test/Botan/Low/KDFSpec.hs +0/−34
• test/Botan/Low/KeyWrapSpec.hs +0/−42
• test/Botan/Low/MACSpec.hs +0/−132
• test/Botan/Low/MPISpec.hs +0/−382
• test/Botan/Low/PubKey/DHSpec.hs +0/−69
• test/Botan/Low/PubKey/DSASpec.hs +0/−76
• test/Botan/Low/PubKey/DecryptSpec.hs +0/−43
• test/Botan/Low/PubKey/ECDHSpec.hs +0/−78
• test/Botan/Low/PubKey/ECDSASpec.hs +0/−72
• test/Botan/Low/PubKey/Ed25519Spec.hs +0/−34
• test/Botan/Low/PubKey/ElGamalSpec.hs +0/−71
• test/Botan/Low/PubKey/EncryptSpec.hs +0/−42
• test/Botan/Low/PubKey/KeyAgreementSpec.hs +0/−50
• test/Botan/Low/PubKey/KeyEncapsulationSpec.hs +0/−67
• test/Botan/Low/PubKey/RSASpec.hs +0/−43
• test/Botan/Low/PubKey/SM2Spec.hs +0/−71
• test/Botan/Low/PubKey/SignSpec.hs +0/−67
• test/Botan/Low/PubKey/VerifySpec.hs +0/−79
• test/Botan/Low/PubKey/X25519Spec.hs +0/−34
• test/Botan/Low/PubKeySpec.hs +0/−188
• test/Botan/Low/PwdHashSpec.hs +0/−61
• test/Botan/Low/RNGSpec.hs +0/−42
• test/Botan/Low/SRP6Spec.hs +0/−71
• test/Botan/Low/TOTPSpec.hs +0/−31
• test/Botan/Low/UtilitySpec.hs +0/−41
• test/Botan/Low/X509Spec.hs +0/−171
• test/Botan/Low/ZFECSpec.hs +0/−27
• test/Main.hs +117/−0
• test/Test/Botan/Low/Bcrypt.hs +38/−0
• test/Test/Botan/Low/BlockCipher.hs +99/−0
• test/Test/Botan/Low/Cipher.hs +244/−0
• test/Test/Botan/Low/FPE.hs +107/−0
• test/Test/Botan/Low/HOTP.hs +39/−0
• test/Test/Botan/Low/Hash.hs +59/−0
• test/Test/Botan/Low/KDF.hs +44/−0
• test/Test/Botan/Low/KeyWrap.hs +52/−0
• test/Test/Botan/Low/MAC.hs +141/−0
• test/Test/Botan/Low/MPI.hs +394/−0
• test/Test/Botan/Low/PubKey.hs +211/−0
• test/Test/Botan/Low/PubKey/DH.hs +82/−0
• test/Test/Botan/Low/PubKey/DSA.hs +70/−0
• test/Test/Botan/Low/PubKey/Decrypt.hs +57/−0
• test/Test/Botan/Low/PubKey/ECDH.hs +91/−0
• test/Test/Botan/Low/PubKey/ECDSA.hs +85/−0
• test/Test/Botan/Low/PubKey/Ed25519.hs +45/−0
• test/Test/Botan/Low/PubKey/ElGamal.hs +78/−0
• test/Test/Botan/Low/PubKey/Encrypt.hs +53/−0
• test/Test/Botan/Low/PubKey/KeyAgreement.hs +63/−0
• test/Test/Botan/Low/PubKey/KeyEncapsulation.hs +82/−0
• test/Test/Botan/Low/PubKey/RSA.hs +57/−0
• test/Test/Botan/Low/PubKey/SM2.hs +84/−0
• test/Test/Botan/Low/PubKey/Sign.hs +81/−0
• test/Test/Botan/Low/PubKey/Verify.hs +91/−0
• test/Test/Botan/Low/PubKey/X25519.hs +45/−0
• test/Test/Botan/Low/PwdHash.hs +169/−0
• test/Test/Botan/Low/RNG.hs +59/−0
• test/Test/Botan/Low/SRP6.hs +75/−0
• test/Test/Botan/Low/SRP6/Example.hs +202/−0
• test/Test/Botan/Low/TOTP.hs +43/−0
• test/Test/Botan/Low/Utility.hs +55/−0
• test/Test/Botan/Low/Version.hs +20/−0
• test/Test/Botan/Low/X509.hs +186/−0
• test/Test/Botan/Low/ZFEC.hs +38/−0
• test/Test/Prelude.hs +0/−50
• test/Test/Util/ByteString.hs +19/−0
• test/Test/Util/Hspec.hs +18/−0

@@ -1,5 +1,102 @@ # Changelog +## 0.1.0.0 -- 2025-12-30++* BREAKING: remove experimental FFI code related to `x509`. See PR+  [#49](https://github.com/haskell-cryptography/botan/pull/49). This code might+  be restored in some form in the future, but as of now it does not compile any+  more, so it is removed. The modules that are removed are:+  - `Botan.Low.X509.CA`+  - `Botan.Low.X509.CRL`+  - `Botan.Low.X509.CSR`+  - `Botan.Low.X509.DN`+  - `Botan.Low.X509.Extensions`+  - `Botan.Low.X509.Options`+  - `Botan.Low.X509.Path`+  - `Botan.Low.X509.Store`+* BREAKING: remove the `XFFI` cabal flag. See PR+  [#49](https://github.com/haskell-cryptography/botan/pull/49). It has no effect+  now that the experimental `x509` code is moved.+* PATCH: enable `-Wall` in addition to a number of other GHC warnings. See PR+  [#52](https://github.com/haskell-cryptography/botan/pull/52).+* PATCH: use `GHC2021` as the default language. See PR+  [#52](https://github.com/haskell-cryptography/botan/pull/52).+* PATCH: update documentation in the `Botan.Low.Error` module. See PR+  [#62](https://github.com/haskell-cryptography/botan/pull/62).+* PATCH: update documentation in the `Botan.Low.Utility` module. See PR+  [#62](https://github.com/haskell-cryptography/botan/pull/62).+* PATCH: update documentation in the `Botan.Low.Version` module. See PR+  [#62](https://github.com/haskell-cryptography/botan/pull/62).+* PATCH: update documentation in the `Botan.Low.View` module. See PR+  [#62](https://github.com/haskell-cryptography/botan/pull/62).+* BREAKING: `Botan.Low.PwdHash.pbkdf2` now takes a `HashName` instead of a+  `MacName`. See PR+  [#63](https://github.com/haskell-cryptography/botan/pull/63).+* PATCH: update documentation in the `Botan.Low.PwdHash` module. See PR+  [#63](https://github.com/haskell-cryptography/botan/pull/63).+* PATCH: introduce a work-around for a bug found in+  `Botan.Low.SRP6.srp6ServerSessionStep1`, which would always throw an+  exception. See PR+  [#65](https://github.com/haskell-cryptography/botan/pull/65).+* BREAKING: add a `DLGroupName` function argument to+  `Botan.Low.SRP6.srp6ServerSessionStep2`. See PR+  [#65](https://github.com/haskell-cryptography/botan/pull/65).+* PATCH: update documentation in the `Botan.Low.SRP6` module. See PR+  [#65](https://github.com/haskell-cryptography/botan/pull/65).+* PATCH: update documentation in the `Botan.Low.BlockCipher` module. See PR+  [#74](https://github.com/haskell-cryptography/botan/pull/74).+* BREAKING: remove the `BlockCipher128Name` type synonym from+  `Botan.Low.BlockCipher`. See PR+  [#74](https://github.com/haskell-cryptography/botan/pull/74).+* NON-BREAKING: in the `BlockCipher` module, add new pattern synonyms `Lion` and+  `Cascade` and accompanying utility functions `lion` and `cascade` for the+  "Lion" and "Cascade" ciphers respectively. See PR+  [#74](https://github.com/haskell-cryptography/botan/pull/74).+* PATCH: fix an "address out of bounds" bug in `blockCipherEncryptBlocks` and+  `blockCipherDecryptBlocks` that occasionally caused segfaults. See PR+  [#74](https://github.com/haskell-cryptography/botan/pull/74).+* PATCH: fix an "insufficient buffer space" bug in+  `Botan.Low.PubKey.Encrypt.encrypt` and `Botan.Low.PubKey.Decrypt.decrypt`. See+  PR [#79](https://github.com/haskell-cryptography/botan/pull/79), PR+  [#87](https://github.com/haskell-cryptography/botan/pull/87).+* PATCH: Fix an "insufficient buffer space" bug in+  `Botan.Low.Cipher.cipherUpdate`. See PR+  [#84](https://github.com/haskell-cryptography/botan/pull/84).+* BREAKING: rework errors. See PR+  [#94](https://github.com/haskell-cryptography/botan/pull/94).+  - Change `BotanErrorCode` from a type synonym to a newtype around `CInt`.+  - Add a new `BotanErrorMessage` newtype around `ByteString`, and use it in+    `botanErrorLastExceptionMessage`.+  - Remove pattern synonyms for `BotanErrorCode`. Use `BOTAN_FFI_ERROR` from+    `botan-bindings` instead.+  - Hide functions related to error number handling in the internals of the+    library. This includes all function names starting with `throwBotan`.+  - Remove `tryBotan`, `catchBotan`, and `handleBotan`.+* BREAKING: change flags from numbers into datatypes. See PR+  [#95](https://github.com/haskell-cryptography/botan/pull/95) The flag+  datatypes come with new helper functions to convert the datatype into a+  number. For example, `CipherInitFlags` gets a `cipherInitFlags` function. The+  changed flag types are:+  - `CipherInitFlags`+  - `CipherUpdateFlags`+  - `FPEFlags`+  - `CheckKeyFlags`+  - `PrivKeyExportFlags`+  - `HexEncodingFlags`+* BREAKING: remove the `botan-low-bench` benchmark. See PR+  [#98](https://github.com/haskell-cryptography/botan/pull/98).+* PATCH: fix a bug where some functions returning a `Bool` were returning+  `False` instead of throwing an exception and vice versa. See PR+  [#105](https://github.com/haskell-cryptography/botan/pull/105). These+  functions are:+  - `pubKeyCheckKey`+  - `x509CertHostnameMatch`+  - `x509IsRevoked`+* BREAKING: enable `NoFieldSelectors`. See PR+  [#106](https://github.com/haskell-cryptography/botan/pull/106). As a result,+  this package no longer exports field selectors for datatypes defined in the+  package.+ ## 0.0.2.0 -- 2025-09-17  * PATCH: update the changelog to change the release date of version 0.0.1.0 from

@@ -1,7 +1,12 @@ # Welcome to botan-low -Low-level bindings to the [Botan](https://botan.randombit.net/) cryptography library.+Low-level bindings to the [Botan](https://botan.randombit.net/) cryptography+library. -> Botan's goal is to be the best option for cryptography in C++ by offering the tools necessary to implement a range of practical systems, such as TLS protocol, X.509 certificates, modern AEAD ciphers, PKCS#11 and TPM hardware support, password hashing, and post quantum crypto schemes.+> Botan's goal is to be the best option for cryptography in C++ by offering the+> tools necessary to implement a range of practical systems, such as TLS+> protocol, X.509 certificates, modern AEAD ciphers, PKCS#11 and TPM hardware+> support, password hashing, and post quantum crypto schemes. -For more information, see the [README on Github](https://github.com/haskellfoundation/botan)+For more information, see the [README on+Github](https://github.com/haskell-cryptography/botan).

@@ -1,74 +0,0 @@-import Test.Tasty.Bench--import Prelude--import Data.ByteString (ByteString(..))-import qualified Data.ByteString as ByteString--import qualified Botan.Bindings.RNG as Botan-import qualified Botan.Bindings.Bcrypt as Botan-import qualified Botan.Low.RNG as Botan-import qualified Botan.Low.Bcrypt as Botan-import qualified Botan.Low.Hash as Botan---import qualified Crypto.KDF.BCrypt as Crypton-import qualified Crypto.Hash as Crypton-import qualified Crypto.Hash.Algorithms as Crypton--password :: ByteString-password = "Fee fi fo fum!"--cryptonBcrypt :: Int -> IO ByteString-cryptonBcrypt factor = Crypton.hashPassword factor password--botanBcrypt :: Int -> IO ByteString-botanBcrypt factor = do-    rng <- Botan.rngInit "system"-    Botan.bcryptGenerate password rng factor---plaintext :: ByteString-plaintext = "Fee fi fo fum! I smell the blood of an Englishman! Be he alive or be he dead, I'll grind his bones to make my bread!"--longtext :: ByteString-longtext = ByteString.concat $ replicate 10000 $ plaintext--cryptonHash :: ByteString -> Crypton.Digest Crypton.SHA3_512-cryptonHash = Crypton.hash---- TODO: hashWithName is not exposed from Botan.Low.Hash. See issue #34.-{- botanHash :: ByteString -> IO Botan.HashDigest-   botanHash = Botan.hashWithName "SHA-3(512)"--}--main :: IO ()-main = defaultMain-    [ bgroup "Bcrypt work factor"-        [ bgroup "Crypton"-            [ bench "twelve"    $ nfIO $ cryptonBcrypt 12-            , bench "fourteen"  $ nfIO $ cryptonBcrypt 14-            , bench "sixteen"   $ nfIO $ cryptonBcrypt 16-            ]-        , bgroup "Botan"-            [ bench "twelve"    $ nfIO $ botanBcrypt 12-            , bench "fourteen"  $ nfIO $ botanBcrypt 14-            , bench "sixteen"   $ nfIO $ botanBcrypt 16-            ]-        ]-    , bgroup "Hash"-        [ bgroup "Crypton"-            [ bench "password"  $ nf cryptonHash password-            , bench "plaintext" $ nf cryptonHash plaintext-            , bench "longtext" $ nf cryptonHash longtext-            ]-        -- TODO: hashWithName is not exposed from Botan.Low.Hash. See issue #34.-        {- , bgroup "Botan"-            [ bench "password"  $ nfIO $ botanHash password-            , bench "plaintext" $ nfIO $ botanHash plaintext-            , bench "longtext" $ nfIO $ botanHash longtext-            ]-        -}-        ]-    ]-

@@ -1,7 +1,7 @@-cabal-version:      3.0-name:               botan-low-version:            0.0.2.0-synopsis:           Low-level Botan bindings+cabal-version: 3.0+name: botan-low+version: 0.1.0.0+synopsis: Low-level Botan bindings description:   Welcome to botan-low @@ -12,19 +12,18 @@   > X.509 certificates, modern AEAD ciphers, PKCS#11 and TPM hardware support,   > password hashing, and post quantum crypto schemes. -  For more information, see the [README on Github](https://github.com/haskellfoundation/botan)+  For more information, see the [README on Github](https://github.com/haskell-cryptography/botan) -author:             Leo D.-maintainer:         joris@well-typed.com, leo@apotheca.io-license:            BSD-3-Clause-license-file:       LICENSE+author: Leo D.+maintainer: joris@well-typed.com, leo@apotheca.io+license: BSD-3-Clause+license-file: LICENSE copyright:   Copyright (c) 2023-2024, Apotheca Labs   Copyright (c) 2024-2025, Haskell Foundation -build-type:         Simple-category:           Cryptography-+build-type: Simple+category: Cryptography -- NOTE: Use data-files instead, if this is inappropriate -- NOTE: This causes a soft error: --      Ignoring trailing fields after sections: "extra-source-files"@@ -40,53 +39,64 @@   README.md  tested-with:-  GHC ==9.2 || ==9.4 || ==9.6 || ==9.8 || ==9.10 || ==9.12+  ghc ==9.2 || ==9.4 || ==9.6 || ==9.8 || ==9.10 || ==9.12  source-repository head-  type:     git-  location: https://github.com/haskellfoundation/botan-  subdir:   botan-low+  type: git+  location: https://github.com/haskell-cryptography/botan+  subdir: botan-low  source-repository this-  type:     git-  location: https://github.com/haskellfoundation/botan-  subdir:   botan-low-  tag:      botan-low-0.0.2.0+  type: git+  location: https://github.com/haskell-cryptography/botan+  subdir: botan-low+  tag: botan-low-0.1.0.0 -flag XFFI-  description: Enable experimental / upstream ffi support-  manual:      True-  default:     False+common warnings+  ghc-options:+    -Wall+    -Wcompat+    -Wincomplete-uni-patterns+    -Wincomplete-record-updates+    -Wpartial-fields+    -Widentities+    -Wredundant-constraints+    -Wmissing-export-lists+    -Wno-unticked-promoted-constructors+    -Wunused-packages+    -Wmissing-deriving-strategies -library-  hs-source-dirs:     src-  default-language:   Haskell2010+common language+  default-language: GHC2021   default-extensions:-    ExistentialQuantification-    NoImplicitPrelude-    OverloadedStrings+    DerivingStrategies+    DuplicateRecordFields+    LambdaCase+    NoFieldSelectors+    OverloadedRecordDot     PatternSynonyms-    RankNTypes-    ScopedTypeVariables-    TupleSections-    TypeApplications+    RoleAnnotations+    ViewPatterns +library+  import: warnings, language+  hs-source-dirs: src   exposed-modules:     Botan.Low.Bcrypt     Botan.Low.BlockCipher     Botan.Low.Cipher     Botan.Low.Error     Botan.Low.FPE-    Botan.Low.Hash     Botan.Low.HOTP+    Botan.Low.Hash     Botan.Low.KDF     Botan.Low.KeyWrap     Botan.Low.MAC     Botan.Low.MPI     Botan.Low.PubKey-    Botan.Low.PubKey.Decrypt     Botan.Low.PubKey.DH     Botan.Low.PubKey.DSA+    Botan.Low.PubKey.Decrypt     Botan.Low.PubKey.ECDH     Botan.Low.PubKey.ECDSA     Botan.Low.PubKey.Ed25519@@ -95,8 +105,8 @@     Botan.Low.PubKey.KeyAgreement     Botan.Low.PubKey.KeyEncapsulation     Botan.Low.PubKey.RSA-    Botan.Low.PubKey.Sign     Botan.Low.PubKey.SM2+    Botan.Low.PubKey.Sign     Botan.Low.PubKey.Verify     Botan.Low.PubKey.X25519     Botan.Low.PwdHash@@ -110,803 +120,77 @@     Botan.Low.ZFEC    other-modules:+    Botan.Low.Error.Internal+    Botan.Low.Internal.ByteString+    Botan.Low.Internal.String     Botan.Low.Make-    Botan.Low.Prelude     Botan.Low.Remake-    Paths_botan_low -  autogen-modules:    Paths_botan_low   build-depends:-    , base            >=4.16 && <4.22-    , botan-bindings  ^>=0.0 || ^>=0.1-    , bytestring      >=0.11 && <0.13-    , deepseq         >=1.1  && <2-    , text            >=1.2  && <1.3   || >=2.0 && <2.2--  if flag(xffi)-    -- Botan.Low.X509.OCSP-    exposed-modules:-      Botan.Low.X509.CA-      Botan.Low.X509.CRL-      Botan.Low.X509.CSR-      Botan.Low.X509.DN-      Botan.Low.X509.Extensions-      Botan.Low.X509.Options-      Botan.Low.X509.Path-      Botan.Low.X509.Store--    cpp-options:     -DXFFI------- Unit tests-----test-suite botan-low-bcrypt-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/BcryptSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-block-cipher-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/BlockCipherSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-cipher-tests-  -- TODO: temporarily disabled because the test suite fails. See issue #33.-  buildable:          False-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/CipherSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-fpe-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/FPESpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-hash-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/HashSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-hotp-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/HOTPSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-kdf-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/KDFSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-keywrap-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/KeyWrapSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-mac-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/MACSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-mpi-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/MPISpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKeySpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-decrypt-tests-  -- TODO: temporarily disabled because the test suite fails. See issue #33.-  buildable:          False-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/DecryptSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-dh-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/DHSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-dsa-tests-  -- TODO: temporarily disabled because the test suite fails. See issue #33.-  buildable:          False-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/DSASpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-ecdh-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/ECDHSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-ecdsa-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/ECDSASpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-ed25519-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/Ed25519Spec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-elgamal-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/ElGamalSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-encrypt-tests-  -- TODO: temporarily disabled because the test suite fails. See issue #33.-  buildable:          False-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/EncryptSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-keyagreement-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/KeyAgreementSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-keyencapsulation-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/KeyEncapsulationSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-rsa-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/RSASpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-sign-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/SignSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-sm2-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/SM2Spec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-verify-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/VerifySpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-pubkey-x25519-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PubKey/X25519Spec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings---- TODO: Pubkey folder tests--test-suite botan-low-pwdhash-tests-  -- TODO: temporarily disabled because the test suite fails. See issue #33.-  buildable:          False-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/PwdHashSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-rng-tests-  if os(osx)-    -- TODO: temporarily disabled because the test suite fails. See issue #33.-    buildable: False--  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/RNGSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-srp6-tests-  -- TODO: temporarily disabled because the test suite fails. See issue #33.-  buildable:          False-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/SRP6Spec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-totp-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/TOTPSpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-utility-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/UtilitySpec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--test-suite botan-low-x509-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/X509Spec.hs-  hs-source-dirs:     test/-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck--  other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings+    base >=4.16 && <4.22,+    botan-bindings ^>=0.2,+    bytestring >=0.11 && <0.13,+    deepseq >=1.1 && <2,+    text >=1.2 && <1.3 || >=2.0 && <2.2, -test-suite botan-low-zfec-tests-  type:               exitcode-stdio-1.0-  main-is:            Botan/Low/ZFECSpec.hs-  hs-source-dirs:     test/+test-suite test+  import: warnings, language+  type: exitcode-stdio-1.0+  main-is: Main.hs+  hs-source-dirs: test/   build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , hspec-    , QuickCheck+    QuickCheck,+    async,+    base,+    botan-bindings,+    botan-low,+    bytestring,+    containers,+    hspec,+    tasty,+    tasty-hspec,+    tasty-hunit,+    tasty-quickcheck,+    text,    other-modules:-    Paths_botan_low-    Test.Prelude--  autogen-modules:    Paths_botan_low-  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings------- Benchmarks-----benchmark botan-low-bench-  hs-source-dirs:     bench-  main-is:            Bcrypt.hs-  type:               exitcode-stdio-1.0-  build-depends:-    , base-    , botan-bindings-    , botan-low-    , bytestring-    , crypton-    , tasty-bench--  default-language:   Haskell2010-  default-extensions:-    NoImplicitPrelude-    OverloadedStrings--  ghc-options:        -with-rtsopts=-A32m+    Test.Botan.Low.Bcrypt+    Test.Botan.Low.BlockCipher+    Test.Botan.Low.Cipher+    Test.Botan.Low.FPE+    Test.Botan.Low.HOTP+    Test.Botan.Low.Hash+    Test.Botan.Low.KDF+    Test.Botan.Low.KeyWrap+    Test.Botan.Low.MAC+    Test.Botan.Low.MPI+    Test.Botan.Low.PubKey+    Test.Botan.Low.PubKey.DH+    Test.Botan.Low.PubKey.DSA+    Test.Botan.Low.PubKey.Decrypt+    Test.Botan.Low.PubKey.ECDH+    Test.Botan.Low.PubKey.ECDSA+    Test.Botan.Low.PubKey.Ed25519+    Test.Botan.Low.PubKey.ElGamal+    Test.Botan.Low.PubKey.Encrypt+    Test.Botan.Low.PubKey.KeyAgreement+    Test.Botan.Low.PubKey.KeyEncapsulation+    Test.Botan.Low.PubKey.RSA+    Test.Botan.Low.PubKey.SM2+    Test.Botan.Low.PubKey.Sign+    Test.Botan.Low.PubKey.Verify+    Test.Botan.Low.PubKey.X25519+    Test.Botan.Low.PwdHash+    Test.Botan.Low.RNG+    Test.Botan.Low.SRP6+    Test.Botan.Low.SRP6.Example+    Test.Botan.Low.TOTP+    Test.Botan.Low.Utility+    Test.Botan.Low.Version+    Test.Botan.Low.X509+    Test.Botan.Low.ZFEC+    Test.Util.ByteString+    Test.Util.Hspec -  if impl(ghc >=8.6)-    ghc-options: -fproc-alignment=64+  other-modules: Paths_botan_low+  autogen-modules: Paths_botan_low

@@ -11,41 +11,40 @@ Generate and validate Bcrypt password hashes -} -module Botan.Low.Bcrypt-(+module Botan.Low.Bcrypt ( --- * Bcrypt--- $introduction+  -- * Bcrypt+  -- $introduction --- * Usage--- $usage+  -- * Usage+  -- $usage --- * Generate a bcrypt digest-  bcryptGenerate+  -- * Generate a bcrypt digest+    bcryptGenerate --- * Validate a bcrypt digest-, bcryptIsValid+  -- * Validate a bcrypt digest+  , bcryptIsValid --- * Work factor-, BcryptWorkFactor(..)-, pattern BcryptFast-, pattern BcryptGood-, pattern BcryptStrong-, BcryptPassword(..)-, BcryptDigest(..)+  -- * Work factor+  , BcryptWorkFactor+  , pattern BcryptFast+  , pattern BcryptGood+  , pattern BcryptStrong+  , BcryptPassword+  , BcryptDigest -) where+  ) where +import           Botan.Bindings.Bcrypt+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.RNG+import           Data.ByteString (ByteString) import qualified Data.ByteString as ByteString--import Botan.Bindings.Bcrypt--import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.RNG--import Data.ByteString.Internal as ByteString+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  {- $introduction @@ -151,10 +150,11 @@ False if the combination is not valid (but otherwise well formed), and otherwise throws an exception on error. -}-bcryptIsValid-    :: BcryptPassword   -- ^ __password__: The password to check against-    -> BcryptDigest     -- ^ __hash__: The stored hash to check against-    -> IO Bool-bcryptIsValid password hash = asCString password $ \ passwordPtr -> do-    asCString hash $ \ hashPtr -> do-        throwBotanCatchingSuccess $ botan_bcrypt_is_valid (ConstPtr passwordPtr) (ConstPtr hashPtr)+bcryptIsValid ::+     BcryptPassword   -- ^ __password__: The password to check against+  -> BcryptDigest     -- ^ __hash__: The stored hash to check against+  -> IO Bool+bcryptIsValid password hash =+    asCString password $ \ passwordPtr ->+    asCString hash $ \ hashPtr ->+    throwBotanCatchingInvalidVerifier $ botan_bcrypt_is_valid (ConstPtr passwordPtr) (ConstPtr hashPtr)

@@ -8,179 +8,456 @@ Stability   : experimental Portability : POSIX -This is a ‘raw’ interface to ECB mode block ciphers.-Most applications want the higher level cipher API which provides authenticated encryption.-This API exists as an escape hatch for applications which need to implement custom primitives using a PRP.+This module is based on the [Block+Ciphers](https://botan.randombit.net/handbook/api_ref/ffi.html#block-ciphers)+section of the C Botan FFI documentation, and on the [Block+Ciphers](https://botan.randombit.net/handbook/api_ref/block_cipher.html) section+of the C++ API reference. -} -module Botan.Low.BlockCipher-(---- * Block ciphers--- $introduction---- * Usage--- $usage--  BlockCipher(..)-, BlockCipherName(..)-, BlockCipher128Name(..)-, BlockCipherKey(..)-, BlockCipherCiphertext(..)-, withBlockCipher-, blockCipherInit-, blockCipherDestroy-, blockCipherName-, blockCipherBlockSize-, blockCipherGetKeyspec-, blockCipherSetKey-, blockCipherEncryptBlocks-, blockCipherDecryptBlocks-, blockCipherClear---- * 64-bit block ciphers--, pattern Blowfish-, pattern CAST128-, pattern DES-, pattern TripleDES-, pattern GOST_28147_89-, pattern IDEA---- * 128-bit block ciphers--, pattern AES128-, pattern AES192-, pattern AES256-, pattern ARIA128-, pattern ARIA192-, pattern ARIA256-, pattern Camellia128-, pattern Camellia192-, pattern Camellia256-, pattern Noekeon-, pattern SEED-, pattern SM4-, pattern Serpent-, pattern Twofish---- * 256-bit block ciphers--, pattern SHACAL2---- * 512-bit block ciphers--, pattern Threefish512---- * Convenience--, blockCiphers-, blockCipher128s-, allBlockCiphers+{-# LANGUAGE OverloadedStrings #-} -) where+module Botan.Low.BlockCipher (+    -- * Introduction+    -- $introduction+    -- * Example usage+    -- $usage+    -- * Block ciphers+    BlockCipher(..)+  , BlockCipherName+  , BlockCipherKey+  , BlockCipherCiphertext+  , withBlockCipher+  , blockCipherInit+  , blockCipherDestroy+  , blockCipherName+  , blockCipherBlockSize+  , blockCipherGetKeyspec+  , blockCipherSetKey+  , blockCipherEncryptBlocks+  , blockCipherDecryptBlocks+  , blockCipherClear+    -- * Available ciphers+    -- $available-ciphers+  , pattern AES128+  , pattern AES192+  , pattern AES256+  , pattern ARIA128+  , pattern ARIA192+  , pattern ARIA256+  , pattern Blowfish+  , pattern Camellia128+  , pattern Camellia192+  , pattern Camellia256+  , pattern Cascade+  , cascade+  , pattern CAST128+  , pattern DES+  , pattern TripleDES+  , pattern GOST_28147_89+  , pattern IDEA+  , pattern Lion+  , lion+  , pattern Noekeon+  , pattern SEED+  , pattern Serpent+  , pattern SHACAL2+  , pattern SM4+  , pattern Threefish512+  , pattern Twofish+    -- ** Convenience+  , blockCiphers+  , blockCipher128s+  , allBlockCiphers+  ) where -import qualified Data.ByteString as ByteString+import           Botan.Bindings.BlockCipher+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Low.Error.Internal+import           Botan.Low.Hash+import           Botan.Low.Internal.ByteString+import           Botan.Low.Internal.String+import           Botan.Low.Make+import           Botan.Low.Remake+import           Control.Monad+import           Data.ByteString (ByteString)+import qualified Data.ByteString as BS+import qualified Data.ByteString.Char8 as BSC+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Ptr -import Botan.Bindings.BlockCipher+{- $setup+>>> import Control.Monad+>>> import Botan.Low.Hash+-} -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.Remake+{-------------------------------------------------------------------------------+  Introduction+-------------------------------------------------------------------------------}  {- $introduction -A `block cipher` is a deterministic, cryptographic primitive suitable for+A /block cipher/ is a deterministic, cryptographic primitive suitable for encrypting or decrypting a single, fixed-size block of data at a time. Block ciphers are used as building blocks for more complex cryptographic operations. If you are looking to encrypt user data, you are probably looking for-`Botan.Low.Cipher` instead.-+"Botan.Low.Cipher" instead. -} +{-------------------------------------------------------------------------------+  Example usage+-------------------------------------------------------------------------------}+ {- $usage -Unless you need a specific block cipher, it is strongly recommended that you use the `AES256` algorithm.+Unless you need a specific block cipher, it is strongly recommended that you use+the 'AES256' algorithm. -> import Botan.Low.BlockCipher-> blockCipher <- blockCipherInit AES256+>>> :{+{-# OPTIONS_GHC -Wall #-}+{-# LANGUAGE OverloadedStrings #-}+import Botan.Low.BlockCipher+import Botan.Low.RNG+import Control.Exception+import Data.ByteString as BS+:} -To use a block cipher, we first need to generate (if we haven't already) a secret key.+For this example, we will use the 'AES256' algorithm. To use a block cipher, we+first need a secret key of the appropriate length. Such keys should be generated+securely, but to keep it simple in this example, we will just use a random+number+generator to generate a secret key. -> import Botan.Low.RNG-> rng <- rngInit "user"-> -- We will use the maximum key size; AES256 keys are always 16 bytes-> (_,keySize,_) <- blockCipherGetKeyspec blockCipher-> -- Block cipher keys are randomly generated-> key <- rngGet rng keySize+>>> :{+generateKey :: BlockCipher -> IO ByteString+generateKey blockCipher = do+    rng <- rngInit "user"+    (_,keySize,_) <- blockCipherGetKeyspec blockCipher+    key <- rngGet rng keySize+    pure key+:} -After the key is generated, we must set it as the block cipher key:+We can now initialise a block cipher object and set its secret key. -> blockCipherSetKey blockCipher key+>>> :{+initBlockCipher :: IO BlockCipher+initBlockCipher = do+    blockCipher <- blockCipherInit AES256+    key <- generateKey blockCipher+    blockCipherSetKey blockCipher key+    pure blockCipher+:} +Using the initialised block cipher, we can now encrypt a message. To encrypt a message, it must be a multiple of the block size.+To decrypt a message, simply reverse the process. As a sanity check,+we show that decryption after encryption yields the original message -> blockSize <- blockCipherBlockSize blockCipher-> -- AES256 block size is always 16 bytes-> message = "0000DEADBEEF0000" :: ByteString-> ciphertext <- blockCipherEncryptBlocks blockCipher message+>>> :{+roundtrip :: BlockCipher -> ByteString -> IO ()+roundtrip blockCipher message = do+    ciphertext <- blockCipherEncryptBlocks blockCipher message+    plaintext <- blockCipherDecryptBlocks blockCipher ciphertext+    print $ message == plaintext+:} -To decrypt a message, simply reverse the process:+Now we tie together the program. We initialise the block cipher+(and set its secret key). Then, we generate a message, and check that it+roundtrips through the encryption and decryption functions. -> plaintext <- blockCipherDecryptBlocks blockCipher ciphertext-> message == plaintext -- True+>>> :{+main :: IO ()+main = do+    blockCipher <- initBlockCipher+    blockSize <- blockCipherBlockSize blockCipher+    -- AES256 block size is always 16 bytes+    let message = "0000DEADBEEF0000"+    assert (BS.length message == blockSize) $ pure ()+    roundtrip blockCipher message+:} +All that is left to do is run the program.++>>> main+True+ -} +{-------------------------------------------------------------------------------+  Block ciphers+-------------------------------------------------------------------------------}+ -- | A mutable block cipher object newtype BlockCipher = MkBlockCipher { getBlockCipherForeignPtr :: ForeignPtr BotanBlockCipherStruct } -newBlockCipher      :: BotanBlockCipher -> IO BlockCipher withBlockCipher     :: BlockCipher -> (BotanBlockCipher -> IO a) -> IO a -- | Destroy a block cipher object immediately blockCipherDestroy  :: BlockCipher -> IO () createBlockCipher   :: (Ptr BotanBlockCipher -> IO CInt) -> IO BlockCipher-(newBlockCipher, withBlockCipher, blockCipherDestroy, createBlockCipher, _)+(withBlockCipher, blockCipherDestroy, createBlockCipher)     = mkBindings-        MkBotanBlockCipher runBotanBlockCipher-        MkBlockCipher getBlockCipherForeignPtr+        MkBotanBlockCipher (.runBotanBlockCipher)+        MkBlockCipher (.getBlockCipherForeignPtr)         botan_block_cipher_destroy --- | 128-bit block cipher name type-type BlockCipher128Name = BlockCipherName -pattern AES128-    ,   AES192-    ,   AES256-    ,   ARIA128-    ,   ARIA192-    ,   ARIA256-    ,   Camellia128-    ,   Camellia192-    ,   Camellia256-    ,   Noekeon-    ,   SEED-    ,   SM4-    ,   Serpent-    ,   Twofish-    :: BlockCipher128Name+-- | A block cipher secret key+type BlockCipherKey = ByteString -pattern AES128      = BOTAN_BLOCK_CIPHER_128_AES_128-pattern AES192      = BOTAN_BLOCK_CIPHER_128_AES_192-pattern AES256      = BOTAN_BLOCK_CIPHER_128_AES_256-pattern ARIA128     = BOTAN_BLOCK_CIPHER_128_ARIA_128-pattern ARIA192     = BOTAN_BLOCK_CIPHER_128_ARIA_192-pattern ARIA256     = BOTAN_BLOCK_CIPHER_128_ARIA_256-pattern Camellia128 = BOTAN_BLOCK_CIPHER_128_CAMELLIA_128-pattern Camellia192 = BOTAN_BLOCK_CIPHER_128_CAMELLIA_192-pattern Camellia256 = BOTAN_BLOCK_CIPHER_128_CAMELLIA_256-pattern Noekeon     = BOTAN_BLOCK_CIPHER_128_NOEKEON-pattern SEED        = BOTAN_BLOCK_CIPHER_128_SEED-pattern SM4         = BOTAN_BLOCK_CIPHER_128_SM4-pattern Serpent     = BOTAN_BLOCK_CIPHER_128_SERPENT-pattern Twofish     = BOTAN_BLOCK_CIPHER_128_TWOFISH+-- | A block cipher ciphertext+type BlockCipherCiphertext = ByteString +-- | Initialize a block cipher object+blockCipherInit ::+     BlockCipherName  -- ^ __cipher_name__+  -> IO BlockCipher   -- ^ __bc__+blockCipherInit = mkCreateObjectCString createBlockCipher botan_block_cipher_init++-- | Reinitializes a block cipher+--+-- You must call blockCipherSetKey in order to use the block cipher again.+blockCipherClear ::+     BlockCipher  -- ^ __bc__: The cipher object+  -> IO ()+blockCipherClear = mkWithObjectAction withBlockCipher botan_block_cipher_clear++-- | Set the key for a block cipher+--+-- Throws an error if the key is not valid.+blockCipherSetKey ::+     BlockCipher      -- ^ __bc__: The cipher object+  -> BlockCipherKey   -- ^ __key[]__: A cipher key+  -> IO ()+blockCipherSetKey = mkSetBytesLen withBlockCipher $ \cipher key ->+    botan_block_cipher_set_key cipher (ConstPtr key)++-- | Return the block size of a block cipher.+blockCipherBlockSize ::+     BlockCipher  -- ^ __bc__: The cipher object+  -> IO Int+blockCipherBlockSize = mkGetIntCode withBlockCipher botan_block_cipher_block_size++-- | Encrypt one or more blocks with a block cipher+--+-- Precondition: the length of the plaintext should be a multiple of the block+-- size, or this function throws an error.+blockCipherEncryptBlocks ::+     BlockCipher              -- ^ __bc__: The cipher object+  -> ByteString               -- ^ __in[]__: The plaintext+  -> IO BlockCipherCiphertext -- ^ __out[]__: The ciphertext+blockCipherEncryptBlocks blockCipher bytes = do+    blockSize <- blockCipherBlockSize blockCipher+    let (numBlocks,remBytes) = BS.length bytes `quotRem` blockSize+    when (remBytes /= 0) $+      error "blockCipherEncryptBlocks: length of the input plaintext is not a\+            \multiple of the block size"+    go (fromIntegral numBlocks)+  where+    go :: CSize -> IO BlockCipherCiphertext+    go numBlocks =+      withBlockCipher blockCipher $ \ blockCipherPtr ->+      asBytesLen bytes $ \ bytesPtr bytesLen ->+      allocBytes (fromIntegral bytesLen) $ \ destPtr ->+      throwBotanIfNegative_ $ botan_block_cipher_encrypt_blocks+          blockCipherPtr+          (ConstPtr bytesPtr)+          destPtr+          numBlocks++-- | Decrypt one or more blocks with a block cipher.+--+-- Precondition: the length of the ciphertext should be a multiple of the block size,+-- or this function throws an error.+--+-- If an incorrect key was set, the content of the decrypted plaintext is+-- unspecified.+blockCipherDecryptBlocks ::+     BlockCipher              -- ^ __bc__: The cipher object+  -> BlockCipherCiphertext    -- ^ __in[]__: The ciphertext+  -> IO ByteString            -- ^ __out[]__: The plaintext+blockCipherDecryptBlocks blockCipher bytes = do+    blockSize <- blockCipherBlockSize blockCipher+    let (numBlocks,remBytes) = BS.length bytes `quotRem` blockSize+    when (remBytes /= 0) $+      error "blockCipherDecryptBlocks: length of the input plaintext is not a\+            \multiple of the block size"+    go (fromIntegral numBlocks)+  where+    go :: CSize -> IO ByteString+    go numBlocks =+      withBlockCipher blockCipher $ \ blockCipherPtr ->+      asBytesLen bytes $ \ bytesPtr bytesLen ->+      allocBytes (fromIntegral bytesLen) $ \ destPtr ->+      throwBotanIfNegative_ $ botan_block_cipher_decrypt_blocks+          blockCipherPtr+          (ConstPtr bytesPtr)+          destPtr+          numBlocks++-- | Get the name of a block cipher.+--+-- This function is not guaranteed to return the same exact value as used to initialize the context.+blockCipherName ::+     BlockCipher          -- ^ __bc__+  -> IO BlockCipherName   -- ^ __name__+blockCipherName = mkGetCString withBlockCipher botan_block_cipher_name++-- | Get the key specification of a block cipher+--+-- Returns the minimum, maximum, and modulo of valid keys.+blockCipherGetKeyspec ::+     BlockCipher      -- ^ __bc__+  -> IO (Int,Int,Int) -- ^ __(min,max,mod)__+blockCipherGetKeyspec = mkGetSizes3 withBlockCipher botan_block_cipher_get_keyspec++{-------------------------------------------------------------------------------+  Available ciphers+-------------------------------------------------------------------------------}++{- $available-ciphers++A number of algorithms are available to be used as block ciphers. An algorithm+is selected by passing the /algorithm specification name/ of the algorithm as a+string to the block cipher functions. In some cases an algorithm specification+name is just the /algorithm name/, like @"AES-128"@. In other cases an algorithm+specification name is a combination of an algorithm name paired with some+parameters, such as @"Cascade(Serpent, AES-256)"@ where @"Cascade"@ is the+algorithm name followed by a 2-tuple of parameters. Pattern synonyms are+included for each available /algorithm name/. Where necessary, such as in the+@"Cascade"@ case, these algorithm names should be manually extended to full+algorithm specification names, or by using utility functions like 'cascade' that+this module also provides.++WARNING: 64-bit block ciphers should be avoided.++WARNING: the @Kuznyechik@ block ciphier is not included because its security is+disputed.++See the [Available+Ciphers](https://botan.randombit.net/handbook/api_ref/block_cipher.html#available-ciphers)+section of the C++ API reference for more information about available ciphers.++Each algorithm expects a certain size of block to encrypt or decrypt. For the+available algorithms, these block sizes in number of bits are listed below. For+algorithms that require parameters, the block size may vary depending on the+parameters. For the examples below, we pick some arbitrary parameters.++>>> :{+forM_ allBlockCiphers $ \name -> do+  let name' =+        if name == Cascade+        then cascade Serpent AES256+        else if name == Lion+        then lion SHA1 "RC4" (Just 64)+        else name+  blockCipher <- blockCipherInit name'+  sz <- blockCipherBlockSize blockCipher+  print (name, sz * 8)+:}+("AES-128",128)+("AES-192",128)+("AES-256",128)+("ARIA-128",128)+("ARIA-192",128)+("ARIA-256",128)+("Camellia-128",128)+("Camellia-192",128)+("Camellia-256",128)+("Noekeon",128)+("SEED",128)+("Serpent",128)+("SM4",128)+("Twofish",128)+("Blowfish",64)+("Cascade",128)+("CAST-128",64)+("DES",64)+("TripleDES",64)+("GOST-28147-89",64)+("IDEA",64)+("Lion",512)+("SHACAL2",256)+("Threefish-512",512)++-}++-- | Block cipher name type+type BlockCipherName = ByteString++pattern+    AES128+  , AES192+  , AES256+  , ARIA128+  , ARIA192+  , ARIA256+  , Blowfish+  , Camellia128+  , Camellia192+  , Camellia256+  , Cascade+  , CAST128+  , DES+  , TripleDES+  , GOST_28147_89+  , IDEA+  , Lion+  , Noekeon+  , SEED+  , Serpent+  , SHACAL2+  , SM4+  , Threefish512+  , Twofish+  :: BlockCipherName++pattern AES128        = BOTAN_BLOCK_CIPHER_AES_128+pattern AES192        = BOTAN_BLOCK_CIPHER_AES_192+pattern AES256        = BOTAN_BLOCK_CIPHER_AES_256+pattern ARIA128       = BOTAN_BLOCK_CIPHER_ARIA_128+pattern ARIA192       = BOTAN_BLOCK_CIPHER_ARIA_192+pattern ARIA256       = BOTAN_BLOCK_CIPHER_ARIA_256+pattern Blowfish      = BOTAN_BLOCK_CIPHER_BLOWFISH+pattern Camellia128   = BOTAN_BLOCK_CIPHER_CAMELLIA_128+pattern Camellia192   = BOTAN_BLOCK_CIPHER_CAMELLIA_192+pattern Camellia256   = BOTAN_BLOCK_CIPHER_CAMELLIA_256+pattern Cascade       = BOTAN_BLOCK_CIPHER_CASCADE++-- |+-- >>> cascade Serpent AES256+-- "Cascade(Serpent,AES-256)"+cascade :: BlockCipherName -> BlockCipherName -> BlockCipherName+cascade ciph1 ciph2 = Cascade /$ ciph1 <> "," <> ciph2++pattern CAST128       = BOTAN_BLOCK_CIPHER_CAST_128+pattern DES           = BOTAN_BLOCK_CIPHER_DES+pattern TripleDES     = BOTAN_BLOCK_CIPHER_TRIPLEDES+pattern GOST_28147_89 = BOTAN_BLOCK_CIPHER_GOST_28147_89+pattern IDEA          = BOTAN_BLOCK_CIPHER_IDEA+pattern Lion          = BOTAN_BLOCK_CIPHER_LION++-- |+-- >>> lion SHA1 "RC4" Nothing+-- "Lion(SHA-1,RC4)"+--+-- >>> lion SHA1 "RC4" (Just 64)+-- "Lion(SHA-1,RC4,64)"+lion :: HashName -> ByteString -> Maybe Word -> BlockCipherName+lion hashFun streamCiph optBlockSize =+    Lion /$ hashFun <> "," <> streamCiph <> case optBlockSize of+      Nothing        -> ""+      Just blockSize -> "," <> BSC.pack (show blockSize)++pattern Noekeon       = BOTAN_BLOCK_CIPHER_NOEKEON+pattern SEED          = BOTAN_BLOCK_CIPHER_SEED+pattern Serpent       = BOTAN_BLOCK_CIPHER_SERPENT+pattern SHACAL2       = BOTAN_BLOCK_CIPHER_SHACAL2+pattern SM4           = BOTAN_BLOCK_CIPHER_SM4+pattern Threefish512  = BOTAN_BLOCK_CIPHER_THREEFISH_512+pattern Twofish       = BOTAN_BLOCK_CIPHER_TWOFISH++blockCipher128s :: [BlockCipherName] blockCipher128s =     [ AES128     , AES192@@ -193,144 +470,24 @@     , Camellia256     , Noekeon     , SEED-    , SM4     , Serpent+    , SM4     , Twofish     ] --- | Block cipher name type-type BlockCipherName = ByteString--pattern Blowfish-    ,   CAST128-    ,   DES-    ,   TripleDES-    ,   GOST_28147_89-    ,   IDEA-    ,   SHACAL2-    ,   Threefish512-    :: BlockCipherName--pattern Blowfish        = BOTAN_BLOCK_CIPHER_BLOWFISH-pattern CAST128         = BOTAN_BLOCK_CIPHER_CAST_128-pattern DES             = BOTAN_BLOCK_CIPHER_DES-pattern TripleDES       = BOTAN_BLOCK_CIPHER_TRIPLEDES-pattern GOST_28147_89   = BOTAN_BLOCK_CIPHER_GOST_28147_89-pattern IDEA            = BOTAN_BLOCK_CIPHER_IDEA-pattern SHACAL2         = BOTAN_BLOCK_CIPHER_SHACAL2-pattern Threefish512    = BOTAN_BLOCK_CIPHER_THREEFISH_512-+blockCiphers :: [BlockCipherName] blockCiphers =     [ Blowfish+    , Cascade     , CAST128     , DES     , TripleDES     , GOST_28147_89     , IDEA+    , Lion     , SHACAL2     , Threefish512     ]  allBlockCiphers :: [BlockCipherName] allBlockCiphers = blockCipher128s ++ blockCiphers---- | A block cipher secret key-type BlockCipherKey = ByteString---- | A block cipher ciphertext-type BlockCipherCiphertext = ByteString---- | Initialize a block cipher object-blockCipherInit-    :: BlockCipherName  -- ^ __cipher_name__-    -> IO BlockCipher   -- ^ __bc__-blockCipherInit = mkCreateObjectCString createBlockCipher botan_block_cipher_init---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withBlockCipherInit :: BlockCipherName -> (BlockCipher -> IO a) -> IO a-withBlockCipherInit = mkWithTemp1 blockCipherInit blockCipherDestroy--{- |-Reinitializes a block cipher--You must call blockCipherSetKey in order to use the block cipher again.--}-blockCipherClear-    :: BlockCipher  -- ^ __bc__: The cipher object-    -> IO ()-blockCipherClear = mkWithObjectAction withBlockCipher botan_block_cipher_clear--{- |-Set the key for a block cipher--Throws an error if the key is not valid.--}-blockCipherSetKey-    :: BlockCipher      -- ^ __bc__: The cipher object-    -> BlockCipherKey   -- ^ __key[]__: A cipher key-    -> IO ()-blockCipherSetKey = mkSetBytesLen withBlockCipher (\ cipher key -> botan_block_cipher_set_key cipher (ConstPtr key))---- | Return the block size of a block cipher.-blockCipherBlockSize-    :: BlockCipher  -- ^ __bc__: The cipher object-    -> IO Int-blockCipherBlockSize = mkGetIntCode withBlockCipher botan_block_cipher_block_size--{- |-Encrypt one or more blocks with a block cipher--The plaintext length should be a multiple of the block size.--}-blockCipherEncryptBlocks-    :: BlockCipher              -- ^ __bc__: The cipher object-    -> ByteString               -- ^ __in[]__: The plaintext-    -> IO BlockCipherCiphertext -- ^ __out[]__: The ciphertext-blockCipherEncryptBlocks blockCipher bytes = withBlockCipher blockCipher $ \ blockCipherPtr -> do-    asBytesLen bytes $ \ bytesPtr bytesLen -> do-        allocBytes (fromIntegral bytesLen) $ \ destPtr -> do-            throwBotanIfNegative_ $ botan_block_cipher_encrypt_blocks-                blockCipherPtr-                (ConstPtr bytesPtr)-                destPtr-                bytesLen--{- |-Decrypt one or more blocks with a block cipher.--The ciphertext length should be a multiple of the block size.--If an incorrect key was set, the content of the decrypted plaintext is unspecified.--}-blockCipherDecryptBlocks-    :: BlockCipher              -- ^ __bc__: The cipher object-    -> BlockCipherCiphertext    -- ^ __in[]__: The ciphertext-    -> IO ByteString            -- ^ __out[]__: The plaintext-blockCipherDecryptBlocks blockCipher bytes = withBlockCipher blockCipher $ \ blockCipherPtr -> do-    asBytesLen bytes $ \ bytesPtr bytesLen -> do-        allocBytes (fromIntegral bytesLen) $ \ destPtr -> do-            throwBotanIfNegative_ $ botan_block_cipher_decrypt_blocks-                blockCipherPtr-                (ConstPtr bytesPtr)-                destPtr-                bytesLen--{- |-Get the name of a block cipher.--This function is not guaranteed to return the same exact value as used to initialize the context.--}-blockCipherName-    :: BlockCipher          -- ^ __bc__-    -> IO BlockCipherName   -- ^ __name__-blockCipherName = mkGetCString withBlockCipher botan_block_cipher_name--{- |-Get the key specification of a block cipher--Returns the minimum, maximum, and modulo of valid keys.--}-blockCipherGetKeyspec-    :: BlockCipher      -- ^ __bc__-    -> IO (Int,Int,Int) -- ^ __(min,max,mod)__-blockCipherGetKeyspec = mkGetSizes3 withBlockCipher botan_block_cipher_get_keyspec

@@ -14,101 +14,105 @@ repeatedly to encrypt an entire message. -} -module Botan.Low.Cipher-(---- * Cipher--- $introduction---- * Usage--- $usage+{-# LANGUAGE OverloadedStrings #-} -  Cipher(..)-, CipherName(..)-, CipherKey(..)-, CipherNonce(..)-, CipherInitFlags(..)-, pattern MaskDirection-, pattern Encrypt-, pattern Decrypt-, CipherUpdateFlags(..)-, pattern CipherUpdate-, pattern CipherFinal-, withCipher-, cipherInit-, cipherDestroy-, cipherName-, cipherOutputLength-, cipherValidNonceLength-, cipherGetTagLength-, cipherGetDefaultNonceLength-, cipherGetUpdateGranularity-, cipherGetIdealUpdateGranularity-, cipherQueryKeylen-, cipherGetKeyspec-, cipherSetKey-, cipherReset-, cipherSetAssociatedData-, cipherStart-, cipherUpdate-, cipherEncrypt-, cipherDecrypt-, cipherClear+module Botan.Low.Cipher ( --- * Cipher modes-, CipherMode(..)-, cbcMode-, cfbMode-, cfbModeWith-, xtsMode+  -- * Cipher+  -- $introduction --- ** CBC padding-, CBCPaddingName(..)-, pattern PKCS7-, pattern OneAndZeros-, pattern X9_23-, pattern ESP-, pattern CTS-, pattern NoPadding+  -- * Usage+  -- $usage --- * AEAD-, AEADName(..)-, pattern ChaCha20Poly1305-, chaCha20Poly1305+    Cipher(..)+  , CipherName+  , CipherKey+  , CipherNonce+  , CipherInitFlags (..)+  , cipherInitFlags+  , CipherUpdateFlags (..)+  , cipherUpdateFlags+  , withCipher+  , cipherInit+  , cipherDestroy+  , cipherName+  , cipherOutputLength+  , cipherValidNonceLength+  , cipherGetTagLength+  , cipherGetDefaultNonceLength+  , cipherGetUpdateGranularity+  , cipherGetIdealUpdateGranularity+  , cipherQueryKeylen+  , cipherGetKeyspec+  , cipherSetKey+  , cipherReset+  , cipherSetAssociatedData+  , cipherStart+  , cipherUpdate+  , cipherEncrypt+  , cipherDecrypt+  , cipherClear --- * AEAD modes-, AEADMode(..)-, gcmMode-, gcmModeWith-, ocbMode-, ocbModeWith-, eaxMode-, eaxModeWith-, sivMode-, ccmMode-, ccmModeWith+  -- * Cipher modes+  , CipherMode+  , cbcMode+  , cfbMode+  , cfbModeWith+  , xtsMode --- * Convenience-, cipherEncryptOnline-, cipherDecryptOnline-, cipherModes-, cbcPaddings-, aeads-, allCiphers+  -- ** CBC padding+  , CBCPaddingName+  , pattern PKCS7+  , pattern OneAndZeros+  , pattern X9_23+  , pattern ESP+  , pattern CTS+  , pattern NoPadding -) where+  -- * AEAD+  , AEADName+  , pattern ChaCha20Poly1305+  , chaCha20Poly1305 -import qualified Data.ByteString as ByteString+  -- * AEAD modes+  , AEADMode+  , gcmMode+  , gcmModeWith+  , ocbMode+  , ocbModeWith+  , eaxMode+  , eaxModeWith+  , sivMode+  , ccmMode+  , ccmModeWith -import Botan.Bindings.Cipher+  -- * Convenience+  , cipherEncryptOnline+  , cipherDecryptOnline+  , cipherModes+  , cbcPaddings+  , aeads+  , allCiphers -import Botan.Low.BlockCipher-import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.Remake+  ) where -import Botan.Low.RNG+import           Botan.Bindings.Cipher+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Low.BlockCipher+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.Internal.String+import           Botan.Low.Make+import           Botan.Low.Remake+import           Control.Exception+import           Data.ByteString (ByteString)+import qualified Data.ByteString as ByteString+import           Data.Word+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  {- $introduction @@ -193,19 +197,16 @@  newtype Cipher = MkCipher { getCipherForeignPtr :: ForeignPtr BotanCipherStruct } -newCipher      :: BotanCipher -> IO Cipher withCipher     :: Cipher -> (BotanCipher -> IO a) -> IO a -- | Destroy the cipher object immediately cipherDestroy  :: Cipher -> IO () createCipher   :: (Ptr BotanCipher -> IO CInt) -> IO Cipher-(newCipher, withCipher, cipherDestroy, createCipher, _)+(withCipher, cipherDestroy, createCipher)     = mkBindings-        MkBotanCipher runBotanCipher-        MkCipher getCipherForeignPtr+        MkBotanCipher (.runBotanCipher)+        MkCipher (.getCipherForeignPtr)         botan_cipher_destroy -type CipherInitFlags = Word32-type CipherUpdateFlags = Int type CipherNonce = ByteString type CipherKey = ByteString @@ -252,16 +253,16 @@  type AEADMode = ByteString -gcmMode :: BlockCipher128Name -> AEADName+gcmMode :: BlockCipherName -> AEADName gcmMode bc = bc // BOTAN_AEAD_MODE_GCM -gcmModeWith :: BlockCipher128Name -> Int -> AEADName+gcmModeWith :: BlockCipherName -> Int -> AEADName gcmModeWith bc tagSz = gcmMode bc /$ showBytes tagSz -ocbMode :: BlockCipher128Name -> AEADName+ocbMode :: BlockCipherName -> AEADName ocbMode bc = bc // BOTAN_AEAD_MODE_OCB -ocbModeWith :: BlockCipher128Name -> Int -> AEADName+ocbModeWith :: BlockCipherName -> Int -> AEADName ocbModeWith bc tagSz = ocbMode bc /$ showBytes tagSz  eaxMode :: BlockCipherName -> AEADName@@ -270,15 +271,16 @@ eaxModeWith :: BlockCipherName -> Int -> AEADName eaxModeWith bc tagSz = eaxMode bc /$ showBytes tagSz -sivMode :: BlockCipher128Name -> AEADName+sivMode :: BlockCipherName -> AEADName sivMode bc = bc // BOTAN_AEAD_MODE_SIV -ccmMode :: BlockCipher128Name -> AEADName+ccmMode :: BlockCipherName -> AEADName ccmMode bc = bc // BOTAN_AEAD_MODE_CCM -ccmModeWith :: BlockCipher128Name -> Int -> Int -> AEADName+ccmModeWith :: BlockCipherName -> Int -> Int -> AEADName ccmModeWith bc tagSz l = ccmMode bc /$ showBytes tagSz <> "," <> showBytes l +cbcPaddings :: [CBCPaddingName] cbcPaddings =     [ PKCS7     , OneAndZeros@@ -288,12 +290,14 @@     , NoPadding     ] +cipherModes :: [CipherName] cipherModes = concat     [ [ cbcMode bc pd | bc <- allBlockCiphers, pd <- cbcPaddings ]     , [ cfbMode bc    | bc <- allBlockCiphers ]     , [ xtsMode bc    | bc <- allBlockCiphers ]     ] +aeads :: [AEADName] aeads = concat     [ [ chaCha20Poly1305 ]     , [ gcmMode bc | bc <- blockCipher128s ]@@ -303,36 +307,35 @@     , [ ccmMode bc | bc <- blockCipher128s ]     ] +allCiphers :: [CipherName] allCiphers = cipherModes ++ aeads --- TODO: Rename CipherMaskDirection, CipherEncrypt, CipherDecrypt;---  Leave slim terminology for botan-pattern MaskDirection-    ,   Encrypt         -- ^ May be renamed Encipher to avoid confusion with PKEncrypt-    ,   Decrypt         -- ^ May be renamed Decipher to avoid confusion with PKDecrypt-    ::  CipherInitFlags+data CipherInitFlags =+    CipherMaskDirection+  | CipherEncrypt+  | CipherDecrypt+  deriving stock (Show, Eq) -pattern MaskDirection = BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION-pattern Encrypt = BOTAN_CIPHER_INIT_FLAG_ENCRYPT-pattern Decrypt = BOTAN_CIPHER_INIT_FLAG_DECRYPT+cipherInitFlags :: CipherInitFlags -> Word32+cipherInitFlags CipherMaskDirection = BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION+cipherInitFlags CipherEncrypt       = BOTAN_CIPHER_INIT_FLAG_ENCRYPT+cipherInitFlags CipherDecrypt       = BOTAN_CIPHER_INIT_FLAG_DECRYPT -pattern CipherUpdate-    ,   CipherFinal-    ::  CipherUpdateFlags+data CipherUpdateFlags =+    CipherUpdate+  | CipherFinal+  deriving stock (Show, Eq) -pattern CipherUpdate    = BOTAN_CIPHER_UPDATE_FLAG_NONE-pattern CipherFinal     = BOTAN_CIPHER_UPDATE_FLAG_FINAL+cipherUpdateFlags :: CipherUpdateFlags -> Word32+cipherUpdateFlags CipherUpdate = BOTAN_CIPHER_UPDATE_FLAG_NONE+cipherUpdateFlags CipherFinal  = BOTAN_CIPHER_UPDATE_FLAG_FINAL  -- |Initialize a cipher object cipherInit     :: CipherName       -- ^ __name__     -> CipherInitFlags  -- ^ __flags__     -> IO Cipher        -- ^ __cipher__-cipherInit = mkCreateObjectCString1 createCipher botan_cipher_init---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withCipherInit :: CipherName -> CipherInitFlags -> (Cipher -> IO a) -> IO a-withCipherInit = mkWithTemp2 cipherInit cipherDestroy+cipherInit name flags = mkCreateObjectCString1 createCipher botan_cipher_init name (cipherInitFlags flags)  -- |Return the name of the cipher object cipherName@@ -446,31 +449,50 @@ --  https://github.com/randombit/botan/blob/72dc18bbf598f2c3bef81a4fb2915e9c3c524ac4/src/lib/ffi/ffi_cipher.cpp#L133 -- -- Some ciphers (ChaChaPoly, EAX) may consume less input than the reported ideal granularity-cipherUpdate-    :: Cipher               -- ^ __cipher__-    -> CipherUpdateFlags    -- ^ __flags__-    -> Int                  -- ^ __output_size__-    -> ByteString           -- ^ __input_bytes[]__-    -> IO (Int,ByteString)  -- ^ __(input_consumed,output[])__-cipherUpdate ctx flags outputSz input = withCipher ctx $ \ ctxPtr -> do-    unsafeAsBytesLen input $ \ inputPtr inputSz -> do-        alloca $ \ consumedPtr -> do-            alloca $ \ writtenPtr -> do-                output <- allocBytes outputSz $ \ outputPtr -> do-                    throwBotanIfNegative_ $ botan_cipher_update-                        ctxPtr-                        (fromIntegral flags)-                        outputPtr-                        (fromIntegral outputSz)-                        writtenPtr-                        (ConstPtr inputPtr)-                        inputSz-                        consumedPtr-                consumed <- fromIntegral <$> peek consumedPtr-                written <- fromIntegral <$> peek writtenPtr-                -- NOTE: The safety of this function is suspect - may require deepseq-                let processed = ByteString.take written output-                    in processed `seq` return (consumed,processed)+cipherUpdate ::+     Cipher               -- ^ __cipher__+  -> CipherUpdateFlags    -- ^ __flags__+  -> Int                  -- ^ __output_size__+  -> ByteString           -- ^ __input_bytes[]__+  -> IO (Int,ByteString)  -- ^ __(input_consumed,output[])__+cipherUpdate ctx flags outputSz input =+    withCipher ctx $ \ ctxPtr ->+    unsafeAsBytesLen input $ \ inputPtr inputSz ->+    alloca $ \ consumedPtr ->+    alloca $ \ writtenPtr -> do+      eithOutput <-+        try $ allocBytes outputSz $ \ outputPtr ->do+          throwBotanIfNegative_ $ botan_cipher_update+              ctxPtr+              (cipherUpdateFlags flags)+              outputPtr+              (fromIntegral outputSz)+              writtenPtr+              (ConstPtr inputPtr)+              inputSz+              consumedPtr+      -- If inssuficient buffer space, try again+      output <- case eithOutput of+        Left InsufficientBufferSpaceException{} -> do+          outputSz' <- peek writtenPtr+          allocBytes (fromIntegral outputSz') $ \ outputPtr ->do+            throwBotanIfNegative_ $ botan_cipher_update+                ctxPtr+                (cipherUpdateFlags flags)+                outputPtr+                outputSz'+                writtenPtr+                (ConstPtr inputPtr)+                -- No input should be provided on the second try if the first+                -- try had the FINAL flags set+                (if flags == CipherFinal then 0 else inputSz)+                consumedPtr+        Right bs -> pure bs+      consumed <- fromIntegral <$> peek consumedPtr+      written <- fromIntegral <$> peek writtenPtr+      -- NOTE: The safety of this function is suspect - may require deepseq+      let processed = ByteString.take written output+          in processed `seq` return (consumed,processed)  {- | Encrypt and finalize a complete piece of data.@@ -504,7 +526,7 @@     o <- cipherOutputLength ctx input  -- NOTE: Flawed but usable     u <- cipherGetUpdateGranularity ctx -- TODO: When u == 1, it should be just input + t, right?     t <- cipherGetTagLength ctx-    if flags == BOTAN_CIPHER_INIT_FLAG_ENCRYPT+    if flags == CipherEncrypt         then return (o + u + t)         else return (o + u - t) -- TODO: Maybe just 'o'... @@ -539,15 +561,15 @@ cipherProcessOffline ctx flags msg = do     o <- cipherEstimateOutputLength ctx flags (ByteString.length msg)     -- snd <$> cipherUpdate ctx BOTAN_CIPHER_UPDATE_FLAG_FINAL o msg-    fst <$> cipherProcess ctx BOTAN_CIPHER_UPDATE_FLAG_FINAL o msg+    fst <$> cipherProcess ctx CipherFinal o msg  {-# WARNING cipherEncryptOffline "May be renamed to cipherEncrypt, may be moved to botan" #-} cipherEncryptOffline :: Cipher -> ByteString -> IO ByteString-cipherEncryptOffline ctx = cipherProcessOffline ctx BOTAN_CIPHER_INIT_FLAG_ENCRYPT+cipherEncryptOffline ctx = cipherProcessOffline ctx CipherEncrypt  {-# WARNING cipherDecryptOffline "May be renamed to cipherDecrypt, may be moved to botan" #-} cipherDecryptOffline :: Cipher -> ByteString -> IO ByteString-cipherDecryptOffline ctx = cipherProcessOffline ctx BOTAN_CIPHER_INIT_FLAG_DECRYPT+cipherDecryptOffline ctx = cipherProcessOffline ctx CipherDecrypt  {- Experiments with online processing@@ -570,14 +592,6 @@ --                 encrest <- go (i + g) u t g rest --                 return $! encblock : encrest ---  NOTE: Some ciphers (SIV, CCM) are not online-capable algorithms, but Botan does not throw---  an error even though it should.-{-# DEPRECATED cipherProcessOnline "Moving from botan-low to botan" #-}-cipherProcessOnline :: Cipher -> CipherInitFlags -> ByteString -> IO ByteString-cipherProcessOnline ctx flags = if flags == BOTAN_CIPHER_INIT_FLAG_ENCRYPT-    then cipherEncryptOnline ctx-    else cipherDecryptOnline ctx- -- TODO: Consolidate online encipher / decipher -- TODO: Use Builder to do this --  https://hackage.haskell.org/package/bytestring-0.12.0.2/docs/Data-ByteString-Builder.html@@ -589,11 +603,11 @@     where         go i g bs = case ByteString.splitAt g bs of             (block,"")      -> do-                o <- cipherEstimateFinalOutputLength ctx BOTAN_CIPHER_INIT_FLAG_ENCRYPT i (ByteString.length block)-                (processed,_) <- cipherProcess ctx BOTAN_CIPHER_UPDATE_FLAG_FINAL o block+                o <- cipherEstimateFinalOutputLength ctx CipherEncrypt i (ByteString.length block)+                (processed,_) <- cipherProcess ctx CipherFinal o block                 return [processed]             (block,rest)    -> do-                (processed,remaining) <- cipherProcess ctx BOTAN_CIPHER_UPDATE_FLAG_NONE g block+                (processed,remaining) <- cipherProcess ctx CipherUpdate g block                 (processed :) <$> go (i + g) g (remaining <> rest)                 -- Though this following version may be more efficient especially with lazy bytestrings                 --  or builder, though note *which* update function it uses - the original@@ -610,9 +624,9 @@     where         go i g t bs = case ByteString.splitAt g bs of             (block,"")      -> do-                o <- cipherEstimateFinalOutputLength ctx BOTAN_CIPHER_INIT_FLAG_DECRYPT i (ByteString.length block)-                (processed,_) <- cipherProcess ctx BOTAN_CIPHER_UPDATE_FLAG_FINAL o block+                o <- cipherEstimateFinalOutputLength ctx CipherDecrypt i (ByteString.length block)+                (processed,_) <- cipherProcess ctx CipherFinal o block                 return [processed]             (block,rest)    -> do-                (processed,remaining) <- cipherProcess ctx BOTAN_CIPHER_UPDATE_FLAG_NONE g block+                (processed,remaining) <- cipherProcess ctx CipherUpdate g block                 (processed :) <$> go (i + g) g t (remaining <> rest)

@@ -7,401 +7,40 @@ Maintainer  : joris@well-typed.com, leo@apotheca.io Stability   : experimental Portability : POSIX--} -module Botan.Low.Error-( BotanErrorCode(..)-, pattern Success-, pattern InvalidIdentifier-, pattern InvalidInput-, pattern BadMAC-, pattern InsufficientBufferSpace-, pattern StringConversionError-, pattern ExceptionThrown-, pattern OutOfMemory-, pattern SystemError-, pattern InternalError-, pattern BadFlag-, pattern NullPointer-, pattern BadParameter-, pattern KeyNotSet-, pattern InvalidKeyLength-, pattern InvalidObjectState-, pattern NotImplemented-, pattern InvalidObject-, pattern TLSError-, pattern HttpError-, pattern RoughtimeError-, pattern UnknownError-, botanErrorDescription-, botanErrorLastExceptionMessage-, SomeBotanException(..)-, toBotanException-, fromBotanException-, InvalidInputException(..)-, BadMACException(..)-, InsufficientBufferSpaceException(..)-, StringConversionException(..)-, ExceptionThrownException(..)-, OutOfMemoryException(..)-, SystemErrorException(..)-, InternalErrorException(..)-, BadFlagException(..)-, NullPointerException(..)-, BadParameterException(..)-, KeyNotSetException(..)-, InvalidKeyLengthException(..)-, InvalidObjectStateException(..)-, NotImplementedException(..)-, InvalidObjectException(..)-, UnknownException(..)-, throwBotanError-, throwBotanIfNegative-, throwBotanIfNegative_-, throwBotanCatchingSuccess-, throwBotanCatchingBool-, throwBotanCatchingInt-, throwBotanErrorWithCallstack-, tryBotan-, catchBotan-, handleBotan-) where--import Data.Typeable--import Botan.Bindings.Error--import Botan.Low.Prelude--import qualified Data.ByteString        as ByteString-import qualified Data.ByteString.Char8  as Char8-import qualified Data.Text              as Text---- | Botan error code data type-type BotanErrorCode = CInt--{--Botan error code patterns--}--pattern Success-    ,   InvalidIdentifier-    ,   InvalidInput-    ,   BadMAC-    ,   InsufficientBufferSpace-    ,   StringConversionError-    ,   ExceptionThrown-    ,   OutOfMemory-    ,   SystemError-    ,   InternalError-    ,   BadFlag-    ,   NullPointer-    ,   BadParameter-    ,   KeyNotSet-    ,   InvalidKeyLength-    ,   InvalidObjectState-    ,   NotImplemented-    ,   InvalidObject-    ,   TLSError-    ,   HttpError-    ,   RoughtimeError-    ,   UnknownError-    :: BotanErrorCode--pattern Success = BOTAN_FFI_SUCCESS-pattern InvalidIdentifier = BOTAN_FFI_INVALID_VERIFIER-pattern InvalidInput = BOTAN_FFI_ERROR_INVALID_INPUT-pattern BadMAC = BOTAN_FFI_ERROR_BAD_MAC-pattern InsufficientBufferSpace = BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE-pattern StringConversionError = BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR-pattern ExceptionThrown = BOTAN_FFI_ERROR_EXCEPTION_THROWN-pattern OutOfMemory = BOTAN_FFI_ERROR_OUT_OF_MEMORY-pattern SystemError = BOTAN_FFI_ERROR_SYSTEM_ERROR-pattern InternalError = BOTAN_FFI_ERROR_INTERNAL_ERROR-pattern BadFlag = BOTAN_FFI_ERROR_BAD_FLAG-pattern NullPointer = BOTAN_FFI_ERROR_NULL_POINTER-pattern BadParameter = BOTAN_FFI_ERROR_BAD_PARAMETER-pattern KeyNotSet = BOTAN_FFI_ERROR_KEY_NOT_SET-pattern InvalidKeyLength = BOTAN_FFI_ERROR_INVALID_KEY_LENGTH-pattern InvalidObjectState = BOTAN_FFI_ERROR_INVALID_OBJECT_STATE-pattern NotImplemented = BOTAN_FFI_ERROR_NOT_IMPLEMENTED-pattern InvalidObject = BOTAN_FFI_ERROR_INVALID_OBJECT-pattern TLSError = BOTAN_FFI_ERROR_TLS_ERROR-pattern HttpError = BOTAN_FFI_ERROR_HTTP_ERROR-pattern RoughtimeError = BOTAN_FFI_ERROR_ROUGHTIME_ERROR-pattern UnknownError = BOTAN_FFI_ERROR_UNKNOWN_ERROR--{--Botan error code functions--}---- | Convert an error code into a string. Returns "Unknown error" if the error code is not a known one.-botanErrorDescription :: BotanErrorCode -> IO ByteString-botanErrorDescription e = do-    descPtr <- botan_error_description e-    peekCString (unConstPtr descPtr)---- | Returns a static string stored in a thread local variable which contains the last exception message thrown.---  WARNING: This string buffer is overwritten on the next call to the FFI layer-botanErrorLastExceptionMessage :: IO ErrorMessage-botanErrorLastExceptionMessage = do-    msgPtr <- botan_error_last_exception_message-    peekCString (unConstPtr msgPtr)--type ErrorMessage = ByteString--{--Exceptions--}---- | The SomeBotanException type is the root of the botan exception type hierarchy.-data SomeBotanException = forall e . Exception e => SomeBotanException e--instance Show SomeBotanException where-    show (SomeBotanException e) = show e--instance Exception SomeBotanException--toBotanException :: Exception e => e -> SomeException-toBotanException = toException . SomeBotanException--fromBotanException :: Exception e => SomeException -> Maybe e-fromBotanException x = do-    SomeBotanException a <- fromException x-    cast a--data InvalidVerifierException-    = InvalidVerifierException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception InvalidVerifierException where-    toException = toBotanException-    fromException = fromBotanException--data InvalidInputException-    = InvalidInputException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception InvalidInputException where-    toException = toBotanException-    fromException = fromBotanException--data BadMACException-    = BadMACException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception BadMACException where-    toException = toBotanException-    fromException = fromBotanException--data InsufficientBufferSpaceException-    = InsufficientBufferSpaceException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception InsufficientBufferSpaceException where-    toException = toBotanException-    fromException = fromBotanException--data StringConversionException-    = StringConversionException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception StringConversionException where-    toException = toBotanException-    fromException = fromBotanException--data ExceptionThrownException-    = ExceptionThrownException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception ExceptionThrownException where-    toException = toBotanException-    fromException = fromBotanException--data OutOfMemoryException-    = OutOfMemoryException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception OutOfMemoryException where-    toException = toBotanException-    fromException = fromBotanException--data SystemErrorException-    = SystemErrorException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception SystemErrorException where-    toException = toBotanException-    fromException = fromBotanException--data InternalErrorException-    = InternalErrorException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception InternalErrorException where-    toException = toBotanException-    fromException = fromBotanException--data BadFlagException-    = BadFlagException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception BadFlagException where-    toException = toBotanException-    fromException = fromBotanException--data NullPointerException-    = NullPointerException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception NullPointerException where-    toException = toBotanException-    fromException = fromBotanException--data BadParameterException-    = BadParameterException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception BadParameterException where-    toException = toBotanException-    fromException = fromBotanException--data KeyNotSetException-    = KeyNotSetException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception KeyNotSetException where-    toException = toBotanException-    fromException = fromBotanException--data InvalidKeyLengthException-    = InvalidKeyLengthException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception InvalidKeyLengthException where-    toException = toBotanException-    fromException = fromBotanException--data InvalidObjectStateException-    = InvalidObjectStateException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception InvalidObjectStateException where-    toException = toBotanException-    fromException = fromBotanException--data NotImplementedException-    = NotImplementedException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception NotImplementedException where-    toException = toBotanException-    fromException = fromBotanException--data InvalidObjectException-    = InvalidObjectException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception InvalidObjectException where-    toException = toBotanException-    fromException = fromBotanException--data UnknownException-    = UnknownException BotanErrorCode ErrorMessage CallStack-    deriving (Show)--instance Exception UnknownException where-    toException = toBotanException-    fromException = fromBotanException--{--Throwing exceptions+This module is based on the [Return+codes](https://botan.randombit.net/handbook/api_ref/ffi.html#return-codes)+section of the C Botan FFI documentation. -} -throwBotanError :: HasCallStack => BotanErrorCode -> IO a-throwBotanError r = throwBotanErrorWithCallstack r callStack--throwBotanIfNegative :: HasCallStack => IO BotanErrorCode -> IO BotanErrorCode-throwBotanIfNegative act = do-    e <- act-    when (e < 0) $ throwBotanErrorWithCallstack (fromIntegral e) callStack-    return e--throwBotanIfNegative_ :: HasCallStack => IO BotanErrorCode -> IO ()-throwBotanIfNegative_ act = do-    e <- act-    when (e < 0) $ throwBotanErrorWithCallstack (fromIntegral e) callStack---- TODO: Rename to throwBotanCatchingInvalidIdentifier, make:--- throwBotanCatchingSuccess :: HasCallStack => IO BotanErrorCode -> IO Bool--- throwBotanCatchingSuccess act = do---     result <- act---     case result of---         BOTAN_FFI_SUCCESS           -> return True---         _                           -> throwBotanErrorWithCallstack (fromIntegral result) callStack--- NOTE: Catches 0 / Success as True and 1 / InvalidIdentifier as False, throws all other values-throwBotanCatchingSuccess :: HasCallStack => IO BotanErrorCode -> IO Bool-throwBotanCatchingSuccess act = do-    result <- act-    case result of-        BOTAN_FFI_SUCCESS           -> return True-        BOTAN_FFI_INVALID_VERIFIER  -> return False-        _                           -> throwBotanErrorWithCallstack (fromIntegral result) callStack---- NOTE: Catches 1 as True and 0 as False, throws all other values-throwBotanCatchingBool :: HasCallStack => IO BotanErrorCode -> IO Bool-throwBotanCatchingBool act = do-    result <- act-    case result of-        0 -> return False-        1 -> return True-        _ -> throwBotanErrorWithCallstack result callStack----- NOTE: Catches positive numbers including zero, throws all other values--- Equivalent to fromIntegral . throwBotanIfNegative-throwBotanCatchingInt :: HasCallStack => IO BotanErrorCode -> IO Int-throwBotanCatchingInt act = do-    result <- act-    when (result < 0) $ throwBotanErrorWithCallstack (fromIntegral result) callStack-    return (fromIntegral result)--throwBotanErrorWithCallstack :: BotanErrorCode -> CallStack -> IO a-throwBotanErrorWithCallstack e cs =  do-    emsg <- botanErrorLastExceptionMessage-    case e of-        -- BOTAN_FFI_SUCCESS                           -> throwIO $ SUCCESS e cs-        BOTAN_FFI_INVALID_VERIFIER                  -> throwIO $ InvalidVerifierException e emsg cs-        BOTAN_FFI_ERROR_INVALID_INPUT               -> throwIO $ InvalidInputException e emsg cs-        BOTAN_FFI_ERROR_BAD_MAC                     -> throwIO $ BadMACException e emsg cs-        BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE   -> throwIO $ InsufficientBufferSpaceException e emsg cs-        BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR     -> throwIO $ StringConversionException e emsg cs-        BOTAN_FFI_ERROR_EXCEPTION_THROWN            -> throwIO $ ExceptionThrownException e emsg cs-        BOTAN_FFI_ERROR_OUT_OF_MEMORY               -> throwIO $ OutOfMemoryException e emsg cs-        BOTAN_FFI_ERROR_SYSTEM_ERROR                -> throwIO $ SystemErrorException e emsg cs-        BOTAN_FFI_ERROR_INTERNAL_ERROR              -> throwIO $ InternalErrorException e emsg cs-        BOTAN_FFI_ERROR_BAD_FLAG                    -> throwIO $ BadFlagException e emsg cs-        BOTAN_FFI_ERROR_NULL_POINTER                -> throwIO $ NullPointerException e emsg cs-        BOTAN_FFI_ERROR_BAD_PARAMETER               -> throwIO $ BadParameterException e emsg cs-        BOTAN_FFI_ERROR_KEY_NOT_SET                 -> throwIO $ KeyNotSetException e emsg cs-        BOTAN_FFI_ERROR_INVALID_KEY_LENGTH          -> throwIO $ InvalidKeyLengthException e emsg cs-        BOTAN_FFI_ERROR_INVALID_OBJECT_STATE        -> throwIO $ InvalidObjectStateException e emsg cs-        BOTAN_FFI_ERROR_NOT_IMPLEMENTED             -> throwIO $ NotImplementedException e emsg cs-        BOTAN_FFI_ERROR_INVALID_OBJECT              -> throwIO $ InvalidObjectException e emsg cs-        _                                           -> throwIO $ UnknownException e emsg cs---- TODO: catchingBotan--- r0 <- botan_foo--- if r0 < 0---   then pure r0---   else do---     r1 <- botan_bar--tryBotan :: IO a -> IO (Either SomeBotanException a)-tryBotan = try--catchBotan :: IO a -> (SomeBotanException -> IO a) -> IO a-catchBotan = catch+module Botan.Low.Error (+    -- * Error codes+    Internal.BotanErrorCode+  , Internal.botanErrorDescription+  , Internal.BotanErrorMessage(..)+  , Internal.botanErrorLastExceptionMessage+    -- * Exception hierarchy+  , Internal.SomeBotanException(..)+  , Internal.toBotanException+  , Internal.fromBotanException+    -- * Individual exceptions+  , Internal.InvalidInputException(..)+  , Internal.BadMACException(..)+  , Internal.InsufficientBufferSpaceException(..)+  , Internal.StringConversionException(..)+  , Internal.ExceptionThrownException(..)+  , Internal.OutOfMemoryException(..)+  , Internal.SystemErrorException(..)+  , Internal.InternalErrorException(..)+  , Internal.BadFlagException(..)+  , Internal.NullPointerException(..)+  , Internal.BadParameterException(..)+  , Internal.KeyNotSetException(..)+  , Internal.InvalidKeyLengthException(..)+  , Internal.InvalidObjectStateException(..)+  , Internal.NotImplementedException(..)+  , Internal.InvalidObjectException(..)+  , Internal.UnknownException(..)+  ) where -handleBotan :: (SomeBotanException -> IO a) -> IO a -> IO a-handleBotan = flip catch+import           Botan.Low.Error.Internal as Internal

@@ -0,0 +1,282 @@+{-|+Module      : Botan.Low.Error+Description : Error codes and exception handling+Copyright   : (c) 2023-2024, Apotheca Labs+              (c) 2024-2025, Haskell Foundation+License     : BSD-3-Clause+Maintainer  : joris@well-typed.com, leo@apotheca.io+Stability   : experimental+Portability : POSIX+-}++{-# LANGUAGE DerivingVia #-}++module Botan.Low.Error.Internal (+    -- * Error codes+    BotanErrorCode+  , botanErrorDescription+  , BotanErrorMessage(..)+  , botanErrorLastExceptionMessage+    -- * Exception hierarchy+  , SomeBotanException(..)+  , toBotanException+  , fromBotanException+    -- ** Individual exceptions+  , InvalidInputException(..)+  , BadMACException(..)+  , InsufficientBufferSpaceException(..)+  , StringConversionException(..)+  , ExceptionThrownException(..)+  , OutOfMemoryException(..)+  , SystemErrorException(..)+  , InternalErrorException(..)+  , BadFlagException(..)+  , NullPointerException(..)+  , BadParameterException(..)+  , KeyNotSetException(..)+  , InvalidKeyLengthException(..)+  , InvalidObjectStateException(..)+  , NotImplementedException(..)+  , InvalidObjectException(..)+  , UnknownException(..)+    -- ** Throwing and catching+  , throwBotanError+  , throwBotanIfNegative+  , throwBotanIfNegative_+  , throwBotanCatchingInvalidVerifier+  , throwBotanCatchingInvalidInput+  , throwBotanCatchingBool+  , throwBotanCatching+  , throwBotanErrorWithCallstack+  ) where++import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.Error+import           Botan.Low.Internal.ByteString+import           Control.Exception+import           Control.Monad+import           Data.ByteString (ByteString)+import           Data.Typeable+import           Foreign.C.Types+import           GHC.Stack+import           Prelude++{-------------------------------------------------------------------------------+  Errors+-------------------------------------------------------------------------------}++newtype BotanErrorCode = BotanErrorCode CInt+  deriving stock (Show, Eq)++-- | Convert an error code into a string. Returns "Unknown error" if the error+-- code is not a known one.+botanErrorDescription :: BotanErrorCode -> IO ByteString+botanErrorDescription (BotanErrorCode e) = do+    descPtr <- botan_error_description e+    peekCString descPtr.unConstPtr++newtype BotanErrorMessage = BotanErrorMessage ByteString+  deriving newtype Show++-- | Returns a static string stored in a thread local variable which contains+--  the last exception message thrown. WARNING: This string buffer is+--  overwritten on the next call to the FFI layer+botanErrorLastExceptionMessage :: IO BotanErrorMessage+botanErrorLastExceptionMessage = do+    msgPtr <- botan_error_last_exception_message+    BotanErrorMessage <$> peekCString msgPtr.unConstPtr++{-------------------------------------------------------------------------------+  Exception hierarchy+-------------------------------------------------------------------------------}++-- | The SomeBotanException type is the root of the botan exception type+-- hierarchy.+data SomeBotanException = forall e . Exception e => SomeBotanException e++instance Show SomeBotanException where+    show (SomeBotanException e) = show e++instance Exception SomeBotanException++toBotanException :: Exception e => e -> SomeException+toBotanException = toException . SomeBotanException++fromBotanException :: Exception e => SomeException -> Maybe e+fromBotanException x = do+    SomeBotanException a <- fromException x+    cast a++newtype ViaSomeBotanException e = ViaSomeBotanException e+  deriving stock Show++instance (Show e, Typeable e) => Exception (ViaSomeBotanException e) where+  toException = toBotanException+  fromException = fromBotanException++{-------------------------------------------------------------------------------+  Individual exceptions+-------------------------------------------------------------------------------}++data InvalidVerifierException+    = InvalidVerifierException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException InvalidVerifierException++data InvalidInputException+    = InvalidInputException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException InvalidInputException++data BadMACException+    = BadMACException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException BadMACException++data InsufficientBufferSpaceException+    = InsufficientBufferSpaceException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException InsufficientBufferSpaceException++data StringConversionException+    = StringConversionException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException StringConversionException++data ExceptionThrownException+    = ExceptionThrownException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException ExceptionThrownException++data OutOfMemoryException+    = OutOfMemoryException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException OutOfMemoryException++data SystemErrorException+    = SystemErrorException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException SystemErrorException++data InternalErrorException+    = InternalErrorException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException InternalErrorException++data BadFlagException+    = BadFlagException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException BadFlagException++data NullPointerException+    = NullPointerException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException NullPointerException++data BadParameterException+    = BadParameterException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException BadParameterException++data KeyNotSetException+    = KeyNotSetException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException KeyNotSetException++data InvalidKeyLengthException+    = InvalidKeyLengthException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException InvalidKeyLengthException++data InvalidObjectStateException+    = InvalidObjectStateException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException InvalidObjectStateException++data NotImplementedException+    = NotImplementedException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException NotImplementedException++data InvalidObjectException+    = InvalidObjectException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException InvalidObjectException++data UnknownException+    = UnknownException BotanErrorCode BotanErrorMessage CallStack+    deriving stock (Show)+    deriving Exception via ViaSomeBotanException UnknownException++{-------------------------------------------------------------------------------+  Exceptions: throwing and catching+-------------------------------------------------------------------------------}++throwBotanError :: HasCallStack => CInt -> IO a+throwBotanError r = throwBotanErrorWithCallstack r callStack++throwBotanIfNegative :: HasCallStack => IO CInt -> IO CInt+throwBotanIfNegative act = do+    e <- act+    when (e < 0) $ throwBotanErrorWithCallstack e callStack+    return e++throwBotanIfNegative_ :: HasCallStack => IO CInt -> IO ()+throwBotanIfNegative_ act = do+    e <- act+    when (e < 0) $ throwBotanErrorWithCallstack e callStack++-- | 'throwBotanCatching' with @retCode = 'BOTAN_FFI_INVALID_VERIFIER'@.+throwBotanCatchingInvalidVerifier :: HasCallStack => IO CInt -> IO Bool+throwBotanCatchingInvalidVerifier = throwBotanCatching BOTAN_FFI_INVALID_VERIFIER++-- | 'throwBotanCatching' with @retCode = 'BOTAN_FFI_ERROR_INVALID_INPUT'@.+throwBotanCatchingInvalidInput :: HasCallStack => IO CInt -> IO Bool+throwBotanCatchingInvalidInput = throwBotanCatching BOTAN_FFI_ERROR_INVALID_INPUT++-- | @'throwBotanCatching' retCode action@ runs the @action@ and catches return+-- code 0 (Success) as True and @retCode@ as False. All other return codes are+-- thrown as exceptions.+throwBotanCatching :: HasCallStack => CInt -> IO CInt -> IO Bool+throwBotanCatching x act = do+    result <- act+    case result of+      BOTAN_FFI_SUCCESS -> return True+      _ | x == result   -> return False+        | otherwise     -> throwBotanErrorWithCallstack result callStack++-- NOTE: Catches 1 as True and 0 as False, throws all other values+throwBotanCatchingBool :: HasCallStack => IO CInt -> IO Bool+throwBotanCatchingBool act = do+    result <- act+    case result of+        0 -> return False+        1 -> return True+        _ -> throwBotanErrorWithCallstack result callStack++throwBotanErrorWithCallstack :: CInt -> CallStack -> IO a+throwBotanErrorWithCallstack e cs =  do+    emsg <- botanErrorLastExceptionMessage+    case e of+        -- Note: we do not include a case for @BOTAN_FFI_SUCCESS@ since it+        -- signals that the function call was successful.+        BOTAN_FFI_INVALID_VERIFIER                  -> throwIO $ InvalidVerifierException bec emsg cs+        BOTAN_FFI_ERROR_INVALID_INPUT               -> throwIO $ InvalidInputException bec emsg cs+        BOTAN_FFI_ERROR_BAD_MAC                     -> throwIO $ BadMACException bec emsg cs+        BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE   -> throwIO $ InsufficientBufferSpaceException bec emsg cs+        BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR     -> throwIO $ StringConversionException bec emsg cs+        BOTAN_FFI_ERROR_EXCEPTION_THROWN            -> throwIO $ ExceptionThrownException bec emsg cs+        BOTAN_FFI_ERROR_OUT_OF_MEMORY               -> throwIO $ OutOfMemoryException bec emsg cs+        BOTAN_FFI_ERROR_SYSTEM_ERROR                -> throwIO $ SystemErrorException bec emsg cs+        BOTAN_FFI_ERROR_INTERNAL_ERROR              -> throwIO $ InternalErrorException bec emsg cs+        BOTAN_FFI_ERROR_BAD_FLAG                    -> throwIO $ BadFlagException bec emsg cs+        BOTAN_FFI_ERROR_NULL_POINTER                -> throwIO $ NullPointerException bec emsg cs+        BOTAN_FFI_ERROR_BAD_PARAMETER               -> throwIO $ BadParameterException bec emsg cs+        BOTAN_FFI_ERROR_KEY_NOT_SET                 -> throwIO $ KeyNotSetException bec emsg cs+        BOTAN_FFI_ERROR_INVALID_KEY_LENGTH          -> throwIO $ InvalidKeyLengthException bec emsg cs+        BOTAN_FFI_ERROR_INVALID_OBJECT_STATE        -> throwIO $ InvalidObjectStateException bec emsg cs+        BOTAN_FFI_ERROR_NOT_IMPLEMENTED             -> throwIO $ NotImplementedException bec emsg cs+        BOTAN_FFI_ERROR_INVALID_OBJECT              -> throwIO $ InvalidObjectException bec emsg cs+        _                                           -> throwIO $ UnknownException bec emsg cs+  where+    bec = BotanErrorCode e

@@ -33,30 +33,30 @@ the number of words in the dictionary. -} -module Botan.Low.FPE-(--  FPE(..)-, FPEFlags(..)-, pattern FPENone-, pattern FPEFE1CompatMode-, withFPE-, fpeInitFE1-, fpeDestroy-, fpeEncrypt-, fpeDecrypt--) where+module Botan.Low.FPE ( -import qualified Data.ByteString as ByteString+    FPE(..)+  , FPEFlags(..)+  , fPEFlags+  , withFPE+  , fpeInitFE1+  , fpeDestroy+  , fpeEncrypt+  , fpeDecrypt -import Botan.Bindings.FPE+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.Remake+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.FPE+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.MPI+import           Botan.Low.Remake+import           Data.ByteString (ByteString)+import           Data.Word+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Ptr  -- NOTE: This module lacks documentation, and is not mentioned in the FFI bindings. --  It is mentioned in the C++ docs, but the construction significantly differs.@@ -75,23 +75,22 @@  newtype FPE = MkFPE { getFPEForeignPtr :: ForeignPtr BotanFPEStruct } -newFPE      :: BotanFPE -> IO FPE withFPE     :: FPE -> (BotanFPE -> IO a) -> IO a fpeDestroy  :: FPE -> IO () createFPE   :: (Ptr BotanFPE -> IO CInt) -> IO FPE-(newFPE, withFPE, fpeDestroy, createFPE, _)+(withFPE, fpeDestroy, createFPE)     = mkBindings-        MkBotanFPE runBotanFPE-        MkFPE getFPEForeignPtr+        MkBotanFPE (.runBotanFPE)+        MkFPE (.getFPEForeignPtr)         botan_fpe_destroy -type FPEFlags = Word32+data FPEFlags =+    FPENone+  | FPEFE1CompatMode -pattern FPENone-    ,   FPEFE1CompatMode-    ::  FPEFlags-pattern FPENone          = BOTAN_FPE_FLAG_NONE-pattern FPEFE1CompatMode = BOTAN_FPE_FLAG_FE1_COMPAT_MODE+fPEFlags :: FPEFlags -> Word32+fPEFlags FPENone          = BOTAN_FPE_FLAG_NONE+fPEFlags FPEFE1CompatMode = BOTAN_FPE_FLAG_FE1_COMPAT_MODE  -- | Initialize a FE1 FPE context fpeInitFE1@@ -108,11 +107,7 @@             (ConstPtr keyPtr)             keyLen             (fromIntegral rounds)-            flags---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withFPEInitFE1 :: MP -> ByteString -> Int -> FPEFlags -> (FPE -> IO a) -> IO a-withFPEInitFE1 = mkWithTemp4 fpeInitFE1 fpeDestroy+            (fPEFlags flags)  -- -- NOTE: Referentially transparent, move to botan -- fpeEncrypt :: FPE -> MP -> ByteString -> IO MP@@ -155,7 +150,3 @@         withMP mp $ \ mpPtr -> do             asBytesLen tweak $ \ tweakPtr tweakLen -> do                 throwBotanIfNegative_ $ botan_fpe_decrypt fpePtr mpPtr (ConstPtr tweakPtr) tweakLen--data FE1InitFlags-    = FE1None       -- BOTAN_FPE_FLAG_NONE-    | FE1CompatMode -- BOTAN_FPE_FLAG_FE1_COMPAT_MODE

@@ -17,47 +17,51 @@ as a mobile phone. -} -module Botan.Low.HOTP-(---- * Hash-based One Time Password--- $introduction--- * Usage--- $usage---- * HOTP+module Botan.Low.HOTP ( -  HOTP(..)-, HOTPHashName(..)-, HOTPCounter(..)-, HOTPCode(..)-, withHOTP-, hotpInit-, hotpDestroy-, hotpGenerate-, hotpCheck+  -- * Hash-based One Time Password+  -- $introduction+  -- * Usage+  -- $usage --- * HOTP Hashes+  -- * HOTP -, pattern HOTP_SHA1-, pattern HOTP_SHA256-, pattern HOTP_SHA512+    HOTP(..)+  , HOTPHashName+  , HOTPCounter+  , HOTPCode+  , withHOTP+  , hotpInit+  , hotpDestroy+  , hotpGenerate+  , hotpCheck --- * Convenience+  -- * HOTP Hashes -, hotpHashes+  , pattern HOTP_SHA1+  , pattern HOTP_SHA256+  , pattern HOTP_SHA512 -) where+  -- * Convenience -import qualified Data.ByteString as ByteString+  , hotpHashes -import Botan.Bindings.HOTP-import Botan.Low.Hash+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.Remake+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.HOTP+import           Botan.Low.Error.Internal+import           Botan.Low.Hash+import           Botan.Low.Internal.ByteString+import           Botan.Low.Remake+import           Control.Monad+import           Data.ByteString (ByteString)+import           Data.Word+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  -- NOTE: RFC 4226 -- NOTE: I think this *only* takes SHA-2, specificaly "SHA-256" and "SHA-512",@@ -164,14 +168,13 @@  newtype HOTP = MkHOTP { getHOTPForeignPtr :: ForeignPtr BotanHOTPStruct } -newHOTP      :: BotanHOTP -> IO HOTP withHOTP     :: HOTP -> (BotanHOTP -> IO a) -> IO a hotpDestroy  :: HOTP -> IO () createHOTP   :: (Ptr BotanHOTP -> IO CInt) -> IO HOTP-(newHOTP, withHOTP, hotpDestroy, createHOTP, _)+(withHOTP, hotpDestroy, createHOTP)     = mkBindings-        MkBotanHOTP runBotanHOTP-        MkHOTP getHOTPForeignPtr+        MkBotanHOTP (.runBotanHOTP)+        MkHOTP (.getHOTPForeignPtr)         botan_hotp_destroy  type HOTPHashName = HashName@@ -186,6 +189,7 @@ pattern HOTP_SHA512 = SHA512  -- TODO: Do any other hashes work?+hotpHashes :: [HOTPHashName] hotpHashes =     [ HOTP_SHA1     , HOTP_SHA256@@ -210,10 +214,6 @@             (ConstPtr algoPtr)             (fromIntegral digits) --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withHOTPInit :: ByteString -> ByteString -> Int -> (HOTP -> IO a) -> IO a-withHOTPInit = mkWithTemp3 hotpInit hotpDestroy- -- NOTE: User is responsible for incrementing counter at this level hotpGenerate     :: HOTP         -- ^ __hotp__@@ -221,7 +221,7 @@     -> IO HOTPCode  -- ^ __hotp_code__ hotpGenerate hotp counter = withHOTP hotp $ \ hotpPtr -> do     alloca $ \ outPtr -> do-        throwBotanIfNegative $ botan_hotp_generate hotpPtr outPtr counter+        void $ throwBotanIfNegative $ botan_hotp_generate hotpPtr outPtr counter         peek outPtr  -- NOTE:@@ -229,14 +229,15 @@ --      invalid then always returns (false,starting_counter), since the --      last successful authentication counter has not changed. "" -- NOTE: "Depending on the environment a resync_range of 3 to 10 might be appropriate."-hotpCheck-    :: HOTP                     -- ^ __hotp__-    -> HOTPCode                 -- ^ __hotp_code__-    -> HOTPCounter              -- ^ __hotp_counter__-    -> Int                      -- ^ __resync_range__-    -> IO (Bool, HOTPCounter)   -- ^ __(valid,next_counter)__-hotpCheck hotp code counter resync = withHOTP hotp $ \ hotpPtr -> do+hotpCheck ::+     HOTP                     -- ^ __hotp__+  -> HOTPCode                 -- ^ __hotp_code__+  -> HOTPCounter              -- ^ __hotp_counter__+  -> Int                      -- ^ __resync_range__+  -> IO (Bool, HOTPCounter)   -- ^ __(valid,next_counter)__+hotpCheck hotp code counter resync =+    withHOTP hotp $ \ hotpPtr ->     alloca $ \ outPtr -> do-        valid <- throwBotanCatchingSuccess $ botan_hotp_check hotpPtr outPtr code counter (fromIntegral resync)-        nextCounter <- peek outPtr-        return (valid, nextCounter)+      valid <- throwBotanCatchingInvalidVerifier $ botan_hotp_check hotpPtr outPtr code counter (fromIntegral resync)+      nextCounter <- peek outPtr+      return (valid, nextCounter)

@@ -26,83 +26,84 @@ hashFinal), the internal state is reset to begin hashing a new message. -} -module Botan.Low.Hash-(---- * Hashing--- $introduction---- * Usage--- $usage+{-# LANGUAGE OverloadedStrings #-} -  Hash(..)-, HashName(..)-, HashDigest(..)-, withHash-, hashInit-, hashDestroy-, hashName-, hashBlockSize-, hashOutputLength-, hashCopyState-, hashUpdate-, hashFinal-, hashUpdateFinalize-, hashUpdateFinalizeClear-, hashClear+module Botan.Low.Hash ( --- * Hash algorithms+  -- * Hashing+  -- $introduction -, pattern BLAKE2b-, blake2b-, pattern Keccak1600-, keccak1600-, pattern GOST_34_11-, pattern MD4-, pattern MD5-, pattern RIPEMD160-, pattern SHA1-, pattern SHA224-, pattern SHA256-, pattern SHA384-, pattern SHA512-, pattern SHA512_256-, pattern SHA3-, sha3-, pattern SHAKE128-, shake128-, pattern SHAKE256-, shake256-, pattern SM3-, pattern Skein512-, skein512-, pattern Streebog256-, pattern Streebog512-, pattern Whirlpool-, pattern Parallel-, pattern Comb4P-, pattern Adler32-, pattern CRC24-, pattern CRC32+  -- * Usage+  -- $usage --- * Convenience+    Hash(..)+  , HashName+  , HashDigest+  , withHash+  , hashInit+  , hashDestroy+  , hashName+  , hashBlockSize+  , hashOutputLength+  , hashCopyState+  , hashUpdate+  , hashFinal+  , hashUpdateFinalize+  , hashUpdateFinalizeClear+  , hashClear -, cryptohashes-, checksums-, allHashes+  -- * Hash algorithms -) where+  , pattern BLAKE2b+  , blake2b+  , pattern Keccak1600+  , keccak1600+  , pattern GOST_34_11+  , pattern MD4+  , pattern MD5+  , pattern RIPEMD160+  , pattern SHA1+  , pattern SHA224+  , pattern SHA256+  , pattern SHA384+  , pattern SHA512+  , pattern SHA512_256+  , pattern SHA3+  , sha3+  , pattern SHAKE128+  , shake128+  , pattern SHAKE256+  , shake256+  , pattern SM3+  , pattern Skein512+  , skein512+  , pattern Streebog256+  , pattern Streebog512+  , pattern Whirlpool+  , pattern Parallel+  , pattern Comb4P+  , pattern Adler32+  , pattern CRC24+  , pattern CRC32 -import qualified Data.ByteString as ByteString+  -- * Convenience -import System.IO.Unsafe+  , cryptohashes+  , checksums+  , allHashes -import Botan.Bindings.Hash+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.Remake+import           Botan.Bindings.Hash+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.Internal.String+import           Botan.Low.Make+import           Botan.Low.Remake+import           Data.ByteString (ByteString)+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Ptr  {- $introduction @@ -140,14 +141,13 @@  newtype Hash = MkHash { getHashForeignPtr :: ForeignPtr BotanHashStruct } -newHash      :: BotanHash -> IO Hash withHash     :: Hash -> (BotanHash -> IO a) -> IO a hashDestroy  :: Hash -> IO () createHash   :: (Ptr BotanHash -> IO CInt) -> IO Hash-(newHash, withHash, hashDestroy, createHash, _)+(withHash, hashDestroy, createHash)     = mkBindings-        MkBotanHash runBotanHash-        MkHash getHashForeignPtr+        MkBotanHash (.runBotanHash)+        MkHash (.getHashForeignPtr)         botan_hash_destroy  type HashName = ByteString@@ -182,10 +182,12 @@ pattern BLAKE2b         = BOTAN_HASH_BLAKE2B -- TODO: function -- sz is digest size in bits, must be 1-64 bytes, eg: 8-512 in multiples of 8+blake2b :: (Ord a, Num a, Show a) => a -> HashName blake2b sz | sz <= 512 = BLAKE2b /$ showBytes sz blake2b _ = error "Invalid BLAKE2b variant" pattern Keccak1600     = BOTAN_HASH_KECCAK_1600 -- TODO: function or pattern+keccak1600 :: (Eq a, Num a, Show a) => a -> HashName keccak1600 n | n `elem` [224, 256, 384, 512] = Keccak1600 /$ showBytes n keccak1600 _ = error "Invalid Keccak-1600 variant" -- pattern Keccak1600_224 = "Keccak-1600(224)"@@ -204,6 +206,7 @@ pattern SHA512_256  = BOTAN_HASH_SHA_512_256 pattern SHA3        = BOTAN_HASH_SHA_3 -- TODO: function or pattern+sha3 :: (Eq a, Num a, Show a) => a -> HashName sha3 n | n `elem` [224, 256, 384, 512] = SHA3 /$ showBytes n sha3 _ = error "Invalid SHA-3 variant" -- pattern SHA3_224 = "SHA-3(224)"@@ -212,13 +215,16 @@ -- pattern SHA3_512 = "SHA-3(512)" pattern SHAKE128       = BOTAN_HASH_SHAKE_128 -- TODO: function+shake128 :: Show a => a -> HashName shake128 sz = SHAKE128 /$ showBytes sz pattern SHAKE256       = BOTAN_HASH_SHAKE_256 -- TODO: function+shake256 :: Show a => a -> HashName shake256 sz = SHAKE256 /$ showBytes sz pattern SM3             = BOTAN_HASH_SM3 pattern Skein512       = BOTAN_HASH_SKEIN_512 -- TODO: function+skein512 :: Show a => a -> HashName -> HashName skein512 sz salt = Skein512 /$ showBytes sz <> "," <> salt pattern Streebog256    = BOTAN_HASH_STREEBOG_256 pattern Streebog512    = BOTAN_HASH_STREEBOG_512@@ -260,12 +266,12 @@     -- , "SHA-3(384)"     -- , "SHA-3(512)"     -- NOTE: SHAKE-128 has no default value, a parameter *MUST* be supplied-    , shake128 128+    , shake128 @Int 128     -- , "SHAKE-128(128)"     -- , "SHAKE-128(256)"     -- , "SHAKE-128(512)"     -- NOTE: SHAKE-256 has no default value, a parameter *MUST* be supplied-    , shake256 128+    , shake256 @Int 128     -- , "SHAKE-256(128)"     -- , "SHAKE-256(256)"     -- , "SHAKE-256(512)"@@ -283,12 +289,14 @@ -- hashStrategies :: [HashName] -- hashStrategies = undefined +checksums :: [HashName] checksums =     [ Adler32     , CRC24     , CRC32     ] +allHashes :: [HashName] allHashes = cryptohashes ++ checksums  type HashDigest = ByteString@@ -298,10 +306,6 @@     -> IO Hash  -- ^ __hash__: hash object hashInit = mkCreateObjectCString createHash (\ out name -> botan_hash_init out name 0) --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withHashInit :: HashName -> (Hash -> IO a) -> IO a-withHashInit = mkWithTemp1 hashInit hashDestroy- hashName     :: Hash             -- ^ __hash__: the object to read     -> IO HashDigest    -- ^ __name__: output buffer@@ -366,11 +370,3 @@     hashClear ctx     return dg -- Or: hashUpdateFinalize ctx bytes <* hashClear ctx--hashWithHash :: Hash -> ByteString -> IO HashDigest-hashWithHash = hashUpdateFinalizeClear--hashWithName :: HashName -> ByteString -> IO HashDigest-hashWithName name bytes = do-    ctx <- hashInit name-    hashWithHash ctx bytes

@@ -0,0 +1,107 @@+module Botan.Low.Internal.ByteString (+    peekCString+  , withCString+  , withCBytes+  , withCBytesLen+  , allocBytes+  , allocBytesWith+  , asCString+  , asCStringLen+  , asBytes+  , unsafeAsBytes+  , asBytesLen+  , unsafeAsBytesLen+  , showBytes+  ) where++import           Control.DeepSeq+import           Data.ByteString (ByteString)+import qualified Data.ByteString as ByteString+import qualified Data.ByteString.Char8 as Char8+import qualified Data.ByteString.Internal as ByteString+import qualified Data.ByteString.Unsafe as ByteString+import           Data.Word+import           Foreign.C.String hiding (peekCString, peekCStringLen,+                     withCString, withCStringLen)+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Ptr++{-+Small rant: CString is a bit of a mess++- CString doesn't work with const+- There is no CBytes+- Doesn't work with ConstPtr+- Different names for different types (peek vs pack, useAs vs with)+    - Data.ByteString+        - packCString :: CString -> IO ByteString+        - useAsCString :: ByteString -> (CString -> IO a) -> IO a+    - Text+    - Foreign.C.String+        - peekCString :: CString -> IO String+        - withCString :: String -> (CString -> IO a) -> IO a+-}++peekCString :: CString -> IO ByteString+peekCString = ByteString.packCString++withCString :: ByteString -> (CString -> IO a) -> IO a+withCString = ByteString.useAsCString++type CBytes = Ptr Word8++withCBytes :: ByteString -> (CBytes -> IO a) -> IO a+withCBytes bs act = ByteString.useAsCStringLen bs (\ (ptr,_) -> act (castPtr ptr))++type CBytesLen = (Ptr Word8, Int)++withCBytesLen :: ByteString -> (CBytesLen -> IO a) -> IO a+withCBytesLen bs act = ByteString.useAsCStringLen bs (\ (ptr,len) -> act (castPtr ptr, len))++-- A cheap knockoff of ByteArray.alloc / allocRet+-- We'll make this safer in the future+-- NOTE: THIS IS NOT LIKE Foriegn.Marshal.Alloc.allocaBytes, though it is close+--  Instead of returning the thing, we always return a bytestring.+--  Also, allocaBytes frees the memory after, but this is a malloc freed on garbage collect.+-- I basically ripped the relevant bits from ByteArray for ease of continuity+allocBytes :: Int -> (Ptr byte -> IO ()) -> IO ByteString+-- allocBytes sz f = snd <$> allocBytesWith sz f+-- NOTE: This is probably better than mallocByteString withForeignPtr+--  Use of mallocByteString without mkDeferredByteString / deferForeignPtrAvailability+--  is possibly a factor in our InsufficientBufferSpaceException issues+-- NOTE: Most of the comments are rendered moot now :) this needs cleanup+allocBytes sz f = ByteString.create sz (f . castPtr)++allocBytesWith :: Int -> (Ptr byte -> IO a) -> IO (a, ByteString)+allocBytesWith sz f+    | sz < 0    = allocBytesWith 0 f+    | otherwise = do+        fptr <- ByteString.mallocByteString sz+        a <- withForeignPtr fptr (f . castPtr)+        -- return (a, ByteString.PS fptr 0 sz)+        -- NOTE: The safety of this function is suspect, may require deepseq+        let bs = ByteString.PS fptr 0 sz+            in bs `deepseq` return (a,bs)++asCString :: ByteString -> (Ptr CChar -> IO a) -> IO a+asCString = ByteString.useAsCString++asCStringLen :: ByteString -> (Ptr CChar -> CSize -> IO a) -> IO a+asCStringLen bs f = ByteString.useAsCStringLen bs (\ (ptr,len) -> f ptr (fromIntegral len))++asBytes :: ByteString -> (Ptr byte -> IO a) -> IO a+asBytes bs f = asBytesLen bs (\ ptr _ -> f ptr)++unsafeAsBytes :: ByteString -> (Ptr byte -> IO a) -> IO a+unsafeAsBytes bs f = unsafeAsBytesLen bs (\ ptr _ -> f ptr)++-- WARNING: This should not be using `useAsCStringLen`+asBytesLen :: ByteString -> (Ptr byte -> CSize -> IO a) -> IO a+asBytesLen bs f = ByteString.useAsCStringLen bs (\ (ptr,len) -> f (castPtr ptr) (fromIntegral len))++unsafeAsBytesLen :: ByteString -> (Ptr byte -> CSize -> IO a) -> IO a+unsafeAsBytesLen bs f = ByteString.unsafeUseAsCStringLen bs (\ (ptr,len) -> f (castPtr ptr) (fromIntegral len))++showBytes :: (Show a) => a -> ByteString+showBytes = Char8.pack . show

@@ -0,0 +1,16 @@+{-# LANGUAGE OverloadedStrings #-}++module Botan.Low.Internal.String (+    (//)+  , (/$)+  ) where++import           Data.String (IsString (..))++infixr 6 //+(//) :: (IsString a, Semigroup a) => a -> a -> a+a // b = a <> "/" <> b++infixr 0 /$+(/$) :: (IsString a, Semigroup a) => a -> a -> a+a /$ b = a <> "(" <> b <> ")"

@@ -27,58 +27,56 @@ still use different keys in the two contexts. -} -module Botan.Low.KDF-(---- * Key derivation function--  KDFName(..)-, kdf+module Botan.Low.KDF ( --- * KDF algorithms+  -- * Key derivation function -, pattern HKDF-, hkdf-, pattern HKDF_Extract-, hkdf_extract-, pattern HKDF_Expand-, hkdf_expand-, pattern KDF2-, kdf2-, pattern KDF1_18033-, kdf1_18033-, pattern KDF1-, kdf1-, pattern TLS_12_PRF-, tls_12_prf-, pattern X9_42_PRF-, x9_42_prf-, pattern SP800_108_Counter-, sp800_108_counter-, pattern SP800_108_Feedback-, sp800_108_feedback-, pattern SP800_108_Pipeline-, sp800_108_pipeline-, pattern SP800_56A-, sp800_56A-, pattern SP800_56C-, sp800_56C+    KDFName+  , kdf --- * Convenience+  -- * KDF algorithms -, kdfs+  , pattern HKDF+  , hkdf+  , pattern HKDF_Extract+  , hkdf_extract+  , pattern HKDF_Expand+  , hkdf_expand+  , pattern KDF2+  , kdf2+  , pattern KDF1_18033+  , kdf1_18033+  , pattern KDF1+  , kdf1+  , pattern TLS_12_PRF+  , tls_12_prf+  , pattern X9_42_PRF+  , x9_42_prf+  , pattern SP800_108_Counter+  , sp800_108_counter+  , pattern SP800_108_Feedback+  , sp800_108_feedback+  , pattern SP800_108_Pipeline+  , sp800_108_pipeline+  , pattern SP800_56A+  , sp800_56A+  , pattern SP800_56C+  , sp800_56C -) where+  -- * Convenience -import qualified Data.ByteString as ByteString+  , kdfs -import Botan.Bindings.KDF+  ) where -import Botan.Low.Hash-import Botan.Low.MAC-import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.KDF+import           Botan.Low.Error.Internal+import           Botan.Low.Hash+import           Botan.Low.Internal.ByteString+import           Botan.Low.Internal.String+import           Botan.Low.MAC+import           Data.ByteString (ByteString)  type KDFName = ByteString @@ -113,19 +111,32 @@  hkdf :: HashName -> KDFName hkdf h = HKDF /$ h+hkdf_extract :: KDFName -> KDFName hkdf_extract h = HKDF_Extract /$ h+hkdf_expand :: KDFName -> KDFName hkdf_expand h = HKDF_Expand /$ h+kdf2 :: KDFName -> KDFName kdf2 h = KDF2 /$ h+kdf1_18033 :: KDFName -> KDFName kdf1_18033 h = KDF1_18033 /$ h+kdf1 :: KDFName -> KDFName kdf1 h = KDF1 /$ h+tls_12_prf :: KDFName -> KDFName tls_12_prf h = TLS_12_PRF /$ h+x9_42_prf :: KDFName -> KDFName x9_42_prf h = X9_42_PRF /$ h+sp800_108_counter :: KDFName -> KDFName sp800_108_counter h = SP800_108_Counter /$ HMAC /$ h+sp800_108_feedback :: KDFName -> KDFName sp800_108_feedback h = SP800_108_Feedback /$ HMAC /$ h+sp800_108_pipeline :: KDFName -> KDFName sp800_108_pipeline h = SP800_108_Pipeline /$ HMAC /$ h+sp800_56A :: KDFName -> KDFName sp800_56A h = SP800_56A /$ HMAC /$ h+sp800_56C :: KDFName -> KDFName sp800_56C h = SP800_56C /$ HMAC /$ h +kdfs :: [KDFName] kdfs = concat     [ [ hkdf h | h <- cryptohashes ]     , [ hkdf_extract h | h <- cryptohashes ]

@@ -22,22 +22,19 @@ Use AES for best interop. -} -module Botan.Low.KeyWrap-(--  nistKeyWrapEncode-, nistKeyWrapDecode--) where+module Botan.Low.KeyWrap ( -import qualified Data.ByteString as ByteString+    nistKeyWrapEncode+  , nistKeyWrapDecode -import Botan.Bindings.KeyWrap+  ) where -import Botan.Low.BlockCipher-import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.KeyWrap+import           Botan.Low.BlockCipher+import           Botan.Low.Internal.ByteString+import           Botan.Low.Make+import           Data.ByteString (ByteString)  nistKeyWrapEncode     :: BlockCipherName  -- ^ __cipher_algo__

@@ -35,59 +35,61 @@ - Finalize the MAC computation. -} -module Botan.Low.MAC-(---- * Message authentication codes--- $introduction+{-# LANGUAGE OverloadedStrings #-} --- * Usage--- $usage+module Botan.Low.MAC ( -  MAC(..)-, MACName(..)-, MACKey(..)-, MACNonce(..)-, MACDigest(..)-, withMAC-, macInit-, macDestroy-, macName-, macOutputLength-, macGetKeyspec-, macSetKey-, macSetNonce-, macUpdate-, macFinal-, macClear+  -- * Message authentication codes+  -- $introduction --- * MAC algorithms+  -- * Usage+  -- $usage -, pattern CMAC-, cmac-, pattern GMAC-, gmac-, pattern HMAC-, hmac-, pattern Poly1305-, pattern SipHash-, sipHash-, pattern X9_19_MAC+    MAC(..)+  , MACName+  , MACKey+  , MACNonce+  , MACDigest+  , withMAC+  , macInit+  , macDestroy+  , macName+  , macOutputLength+  , macGetKeyspec+  , macSetKey+  , macSetNonce+  , macUpdate+  , macFinal+  , macClear --- * Convenience+  -- * MAC algorithms -) where+  , pattern CMAC+  , cmac+  , pattern GMAC+  , gmac+  , pattern HMAC+  , hmac+  , pattern Poly1305+  , pattern SipHash+  , sipHash+  , pattern X9_19_MAC -import qualified Data.ByteString as ByteString+  -- * Convenience -import Botan.Bindings.MAC+  ) where -import Botan.Low.BlockCipher-import Botan.Low.Error-import Botan.Low.Hash-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.Remake+import           Botan.Bindings.MAC+import           Botan.Low.BlockCipher+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.Internal.String+import           Botan.Low.Make+import           Botan.Low.Remake+import           Data.ByteString (ByteString)+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Ptr  {- $introduction @@ -162,14 +164,13 @@  newtype MAC = MkMAC { getMACForeignPtr :: ForeignPtr BotanMACStruct } -newMAC      :: BotanMAC -> IO MAC withMAC     :: MAC -> (BotanMAC -> IO a) -> IO a macDestroy  :: MAC -> IO () createMAC   :: (Ptr BotanMAC -> IO CInt) -> IO MAC-(newMAC, withMAC, macDestroy, createMAC, _)+(withMAC, macDestroy, createMAC)     = mkBindings-        MkBotanMAC runBotanMAC-        MkMAC getMACForeignPtr+        MkBotanMAC (.runBotanMAC)+        MkMAC (.getMACForeignPtr)         botan_mac_destroy  type MACName = ByteString@@ -228,10 +229,6 @@     :: MACName  -- ^ __mac_name__: name of the hash function, e.g., "HMAC(SHA-384)"     -> IO MAC   -- ^ __mac__: mac object macInit = mkCreateObjectCString createMAC (\ out name -> botan_mac_init out name 0)---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withMACInit :: MACName -> (MAC -> IO a) -> IO a-withMACInit = mkWithTemp1 macInit macDestroy  -- | Writes the output length of the message authentication code to *output_length macOutputLength

@@ -9,63 +9,68 @@ Portability : POSIX -} -module Botan.Low.MPI-(+module Botan.Low.MPI ( -  MP(..)-, withMP-, mpInit-, mpDestroy-, mpToHex-, mpToStr-, mpClear-, mpSetFromInt-, mpSetFromMP-, mpCopy-, mpSetFromStr-, mpSetFromRadixStr-, mpNumBits-, mpNumBytes-, mpToBin-, mpFromBin-, mpToWord32-, mpIsPositive-, mpIsNegative-, mpFlipSign-, mpIsZero-, mpAddWord32-, mpSubWord32-, mpAdd-, mpSub-, mpMul-, mpDiv-, mpModMul-, mpEqual-, mpCmp-, mpSwap-, mpPowMod-, mpLeftShift-, mpRightShift-, mpModInverse-, mpRandBits-, mpRandRange-, mpGCD-, mpIsPrime-, mpGetBit-, mpSetBit-, mpClearBit+    MP(..)+  , withMP+  , mpInit+  , mpDestroy+  , mpToHex+  , mpToStr+  , mpClear+  , mpSetFromInt+  , mpSetFromMP+  , mpCopy+  , mpSetFromStr+  , mpSetFromRadixStr+  , mpNumBits+  , mpNumBytes+  , mpToBin+  , mpFromBin+  , mpToWord32+  , mpIsPositive+  , mpIsNegative+  , mpFlipSign+  , mpIsZero+  , mpAddWord32+  , mpSubWord32+  , mpAdd+  , mpSub+  , mpMul+  , mpDiv+  , mpModMul+  , mpEqual+  , mpCmp+  , mpSwap+  , mpPowMod+  , mpLeftShift+  , mpRightShift+  , mpModInverse+  , mpRandBits+  , mpRandRange+  , mpGCD+  , mpIsPrime+  , mpGetBit+  , mpSetBit+  , mpClearBit -) where+  ) where +import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.MPI+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.Make+import           Botan.Low.Remake+import           Botan.Low.RNG+import           Data.ByteString (ByteString) import qualified Data.ByteString as ByteString--import Botan.Bindings.MPI--import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.Remake-import Botan.Low.RNG+import           Data.Word+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  -- Yes, the module is named MPI, but the type is MP. -- I'm probably renaming the module / type to `Botan.Integer` for ergonomics,@@ -82,14 +87,13 @@  newtype MP = MkMP { getMPForeignPtr :: ForeignPtr BotanMPStruct } -newMP      :: BotanMP -> IO MP withMP     :: MP -> (BotanMP -> IO a) -> IO a mpDestroy  :: MP -> IO () createMP   :: (Ptr BotanMP -> IO CInt) -> IO MP-(newMP, withMP, mpDestroy, createMP, _)+(withMP, mpDestroy, createMP)     = mkBindings-        MkBotanMP runBotanMP-        MkMP getMPForeignPtr+        MkBotanMP (.runBotanMP)+        MkMP (.getMPForeignPtr)         botan_mp_destroy  mpInit :: IO MP@@ -261,7 +265,7 @@ --  -- int botan_...(botan_mp_t dest, const botan_mp_t source);-type UnaryOp ptr = ptr -> ptr -> IO BotanErrorCode+type UnaryOp ptr = ptr -> ptr -> IO CInt  mkUnaryOp :: WithPtr typ ptr -> UnaryOp ptr -> typ -> typ -> IO () mkUnaryOp withPtr unary dest source = withPtr dest $ \ destPtr -> do@@ -269,7 +273,7 @@         throwBotanIfNegative_ $ unary destPtr sourcePtr  -- int botan_...(botan_mp_t dest, const botan_mp_t source, size_t factor);-type UnaryOp_csize ptr = ptr -> ptr -> CSize -> IO BotanErrorCode+type UnaryOp_csize ptr = ptr -> ptr -> CSize -> IO CInt  mkUnaryOp_csize :: WithPtr typ ptr -> UnaryOp_csize ptr -> typ -> typ -> Int -> IO () mkUnaryOp_csize withPtr unary dest source factor  = withPtr dest $ \ destPtr -> do@@ -277,7 +281,7 @@         throwBotanIfNegative_ $ unary destPtr sourcePtr (fromIntegral factor)  -- int botan_...(botan_mp_t dest, const botan_mp_t a, const botan_mp_t b);-type BinaryOp ptr = ptr -> ptr -> ptr -> IO BotanErrorCode+type BinaryOp ptr = ptr -> ptr -> ptr -> IO CInt  mkBinaryOp :: WithPtr typ ptr -> BinaryOp ptr -> typ -> typ -> typ -> IO () mkBinaryOp withPtr binary dest a b = withPtr dest $ \ destPtr -> do@@ -286,7 +290,7 @@             throwBotanIfNegative_ $ binary destPtr aPtr bPtr  -- int botan_...(botan_mp_t a, botan_mp_t b, const botan_mp_t x, const botan_mp_t y);-type BinaryDuplexOp ptr = ptr -> ptr -> ptr -> ptr -> IO BotanErrorCode+type BinaryDuplexOp ptr = ptr -> ptr -> ptr -> ptr -> IO CInt  -- NOTE: Do not confuse for mkTrinaryOp mkBinaryDuplexOp :: WithPtr typ ptr -> BinaryDuplexOp ptr -> typ -> typ -> typ -> typ -> IO ()@@ -297,7 +301,7 @@                 throwBotanIfNegative_ $ binary aPtr bPtr xPtr yPtr  -- int botan_...(botan_mp_t a, botan_mp_t b, const botan_mp_t x, const botan_mp_t y);-type TrinaryOp ptr = ptr -> ptr -> ptr -> ptr -> IO BotanErrorCode+type TrinaryOp ptr = ptr -> ptr -> ptr -> ptr -> IO CInt  -- NOTE: Do not confuse for mkBinaryDuplexOp mkTrinaryOp :: WithPtr typ ptr -> TrinaryOp ptr -> typ -> typ -> typ -> typ -> IO ()

@@ -1,9 +1,80 @@-module Botan.Low.Make where+module Botan.Low.Make (+    WithPtr+  , Constr+  , Initializer+  , Initializer_name+  , Initializer_name_flags+  , Initializer_bytes+  , Initializer_bytes_len+  , Destructor+  , mkInit+  , mkInit_name+  , mkInit_name_flags+  , mkInit_bytes+  , mkInit_bytes_len+  , Initializer_with+  , mkInit_with+  , GetBytes+  , mkGetBytes+  , GetCString+  , mkGetCString+  , GetInt+  , mkGetInt+  , GetSize+  , GetSize_csize+  , GetSizes2+  , GetSizes3+  , mkGetSize+  , mkGetSize_csize+  , mkGetSizes2+  , mkGetSizes3+  , GetBoolCode+  , GetBoolCode_csize+  , mkGetBoolCode+  , mkGetBoolCode_csize+  , GetIntCode+  , GetIntCode_csize+  , mkGetIntCode+  , mkGetIntCode_csize+  , Action+  , mkAction+  , mkSet+  , mkSetOn+  , SetCSize+  , SetCInt+  , mkSetCSize+  , mkSetCInt+  , SetCString+  , SetCString_csize+  , mkSetCString+  , mkSetCString_csize+  , SetBytesLen+  , mkSetBytesLen+  , allocBytesQuerying+  , allocBytesQueryingCString+  , mkWithTemp+  , mkWithTemp1+  , mkWithTemp2+  , mkWithTemp3+  , mkWithTemp4+  , withPtrs+  ) where +import           Botan.Bindings.Error+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Control.DeepSeq+import           Control.Exception+import           Data.ByteString (ByteString) import qualified Data.ByteString as ByteString--import Botan.Low.Error-import Botan.Low.Prelude+import           Data.Word+import           Foreign.C.String+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable+import           Prelude hiding (init)  {- Basic botan type template@@ -45,7 +116,7 @@ {- type Construct struct typ = ForeignPtr struct -> typ type Destruct struct = FinalizerPtr struct-type Initialize0 struct = Ptr (Ptr struct) -> IO BotanErrorCode+type Initialize0 struct = Ptr (Ptr struct) -> IO CInt  mkInit0     :: Construct struct typ@@ -93,11 +164,11 @@  type Constr struct typ = ForeignPtr struct -> typ -type Initializer struct = Ptr (Ptr struct) -> IO BotanErrorCode-type Initializer_name struct = Ptr (Ptr struct) -> CString -> IO BotanErrorCode-type Initializer_name_flags struct = Ptr (Ptr struct) -> CString -> Word32 -> IO BotanErrorCode-type Initializer_bytes struct = Ptr (Ptr struct) -> Ptr Word8 -> IO BotanErrorCode-type Initializer_bytes_len struct = Ptr (Ptr struct) -> Ptr Word8 -> CSize -> IO BotanErrorCode+type Initializer struct = Ptr (Ptr struct) -> IO CInt+type Initializer_name struct = Ptr (Ptr struct) -> CString -> IO CInt+type Initializer_name_flags struct = Ptr (Ptr struct) -> CString -> Word32 -> IO CInt+type Initializer_bytes struct = Ptr (Ptr struct) -> Ptr Word8 -> IO CInt+type Initializer_bytes_len struct = Ptr (Ptr struct) -> Ptr Word8 -> CSize -> IO CInt  type Destructor struct = FinalizerPtr struct @@ -169,7 +240,7 @@ -- Initializing with another botan object -- TODO: Use this in already-implemented functions as appropriate -type Initializer_with struct withptr = Ptr (Ptr struct) -> withptr -> IO BotanErrorCode+type Initializer_with struct withptr = Ptr (Ptr struct) -> withptr -> IO CInt  mkInit_with     :: Constr struct typ@@ -188,7 +259,7 @@ Non-effectful queries -} --- type GetName ptr = ptr -> Ptr CChar -> Ptr CSize -> IO BotanErrorCode+-- type GetName ptr = ptr -> Ptr CChar -> Ptr CSize -> IO CInt  -- Replaced by the new mkGetCString -- -- TODO: Prefer mkGetBytes / mkGetCString to mkGetName@@ -209,7 +280,7 @@  -- NOTE: This now handles both Ptr Word8 and Ptr CChar --  This reads the entire byte buffer, including any \NUL bytes-type GetBytes ptr byte = ptr -> Ptr byte -> Ptr CSize -> IO BotanErrorCode+type GetBytes ptr byte = ptr -> Ptr byte -> Ptr CSize -> IO CInt  mkGetBytes     :: WithPtr typ ptr@@ -219,7 +290,7 @@     allocBytesQuerying $ \ outPtr outLen -> get typPtr outPtr outLen  -- NOTE This reads a CString, up to the first \NUL-type GetCString ptr byte = ptr -> Ptr byte -> Ptr CSize -> IO BotanErrorCode+type GetCString ptr byte = ptr -> Ptr byte -> Ptr CSize -> IO CInt  mkGetCString     :: WithPtr typ ptr@@ -228,7 +299,7 @@ mkGetCString withPtr get typ = withPtr typ $ \ typPtr -> do     allocBytesQueryingCString $ \ outPtr outLen -> get typPtr outPtr outLen -type GetInt ptr = ptr -> Ptr CInt -> IO BotanErrorCode+type GetInt ptr = ptr -> Ptr CInt -> IO CInt  mkGetInt     :: WithPtr typ ptr@@ -239,10 +310,10 @@         throwBotanIfNegative_ $ get typPtr szPtr         fromIntegral <$> peek szPtr -type GetSize ptr = ptr -> Ptr CSize -> IO BotanErrorCode-type GetSize_csize ptr = ptr -> CSize -> Ptr CSize -> IO BotanErrorCode-type GetSizes2 ptr = ptr -> Ptr CSize -> Ptr CSize -> IO BotanErrorCode-type GetSizes3 ptr = ptr -> Ptr CSize -> Ptr CSize -> Ptr CSize -> IO BotanErrorCode+type GetSize ptr = ptr -> Ptr CSize -> IO CInt+type GetSize_csize ptr = ptr -> CSize -> Ptr CSize -> IO CInt+type GetSizes2 ptr = ptr -> Ptr CSize -> Ptr CSize -> IO CInt+type GetSizes3 ptr = ptr -> Ptr CSize -> Ptr CSize -> Ptr CSize -> IO CInt  mkGetSize     :: WithPtr typ ptr@@ -285,33 +356,14 @@         szC <- fromIntegral <$> peek szPtrC         return (szA,szB,szC) --- type GetBytes ptr = ptr -> Ptr Word8 -> CSize -> IO BotanErrorCode+-- type GetBytes ptr = ptr -> Ptr Word8 -> CSize -> IO CInt  -- NOTE: Get...Code nomenclature signifies that we get the desired return value --  from the error code error code, eg they use something other than throwBotanIfNegative_ -- --type GetSuccessCode ptr = ptr -> IO BotanErrorCode-type GetSuccessCode_csize ptr = ptr -> CSize -> IO BotanErrorCode--mkGetSuccessCode-    :: WithPtr typ ptr-    -> GetSuccessCode ptr-    -> typ -> IO Bool-mkGetSuccessCode withPtr get typ = withPtr typ $ \ typPtr -> do-    throwBotanCatchingSuccess $ get typPtr--mkGetSuccessCode_csize-    :: WithPtr typ ptr-    -> GetSuccessCode_csize ptr-    -> typ -> Int -> IO Bool-mkGetSuccessCode_csize withPtr get typ sz = withPtr typ $ \ typPtr -> do-    throwBotanCatchingSuccess $ get typPtr (fromIntegral sz)---type GetBoolCode ptr = ptr -> IO BotanErrorCode-type GetBoolCode_csize ptr = ptr -> CSize -> IO BotanErrorCode+type GetBoolCode ptr = ptr -> IO CInt+type GetBoolCode_csize ptr = ptr -> CSize -> IO CInt  mkGetBoolCode     :: WithPtr typ ptr@@ -327,28 +379,28 @@ mkGetBoolCode_csize withPtr get typ sz = withPtr typ $ \ typPtr -> do     throwBotanCatchingBool $ get typPtr (fromIntegral sz) -type GetIntCode ptr = ptr -> IO BotanErrorCode-type GetIntCode_csize ptr = ptr -> CSize -> IO BotanErrorCode+type GetIntCode ptr = ptr -> IO CInt+type GetIntCode_csize ptr = ptr -> CSize -> IO CInt -mkGetIntCode-    :: WithPtr typ ptr-    -> GetIntCode ptr-    -> typ -> IO Int+mkGetIntCode ::+     WithPtr typ ptr+  -> GetIntCode ptr+  -> typ -> IO Int mkGetIntCode withPtr get typ = withPtr typ $ \ typPtr -> do-    throwBotanCatchingInt $ get typPtr+    fmap fromIntegral $ throwBotanIfNegative $ get typPtr -mkGetIntCode_csize-    :: WithPtr typ ptr-    -> GetIntCode_csize ptr-    -> typ -> CSize -> IO Int+mkGetIntCode_csize ::+     WithPtr typ ptr+  -> GetIntCode_csize ptr+  -> typ -> CSize -> IO Int mkGetIntCode_csize withPtr get typ sz = withPtr typ $ \ typPtr -> do-    throwBotanCatchingInt $ get typPtr sz+    fmap fromIntegral $ throwBotanIfNegative $ get typPtr sz  {- Effectful actions -} -type Action ptr = ptr -> IO BotanErrorCode+type Action ptr = ptr -> IO CInt mkAction     :: WithPtr typ ptr     -> Action ptr@@ -358,7 +410,7 @@  mkSet     :: WithPtr typ ptr-    -> (ptr -> a -> IO BotanErrorCode)+    -> (ptr -> a -> IO CInt)     -> typ -> a -> IO () mkSet withPtr set typ a = withPtr typ $ \ typPtr -> do     throwBotanIfNegative_ $ set typPtr a@@ -366,13 +418,13 @@ mkSetOn     :: WithPtr typ ptr     -> (a -> b)-    -> (ptr -> b -> IO BotanErrorCode)+    -> (ptr -> b -> IO CInt)     -> typ -> a -> IO () mkSetOn withPtr fn set typ sz = withPtr typ $ \ typPtr -> do     throwBotanIfNegative_ $ set typPtr (fn sz) -type SetCSize ptr = ptr -> CSize -> IO BotanErrorCode-type SetCInt ptr = ptr -> CInt -> IO BotanErrorCode+type SetCSize ptr = ptr -> CSize -> IO CInt+type SetCInt ptr = ptr -> CInt -> IO CInt  mkSetCSize     :: WithPtr typ ptr@@ -388,8 +440,8 @@ mkSetCInt withPtr set typ sz = withPtr typ $ \ typPtr -> do     throwBotanIfNegative_ $ set typPtr (fromIntegral sz) -type SetCString ptr = ptr -> CString -> IO BotanErrorCode-type SetCString_csize ptr = ptr -> CString -> CSize -> IO BotanErrorCode+type SetCString ptr = ptr -> CString -> IO CInt+type SetCString_csize ptr = ptr -> CString -> CSize -> IO CInt  mkSetCString     :: WithPtr typ ptr@@ -407,7 +459,7 @@     asCString cstring $ \ cstringPtr -> do         throwBotanIfNegative_ $ set typPtr cstringPtr (fromIntegral sz) -type SetBytesLen ptr = ptr -> Ptr Word8 -> CSize -> IO BotanErrorCode+type SetBytesLen ptr = ptr -> Ptr Word8 -> CSize -> IO CInt  mkSetBytesLen     :: WithPtr typ ptr@@ -423,20 +475,20 @@  -- NOTE: This properly takes advantage of szPtr, queries the buffer size - use this elsewhere -- NOTE: This throws any botan codes other than BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE-allocBytesQuerying :: (Ptr byte -> Ptr CSize -> IO BotanErrorCode) -> IO ByteString+allocBytesQuerying :: (Ptr byte -> Ptr CSize -> IO CInt) -> IO ByteString allocBytesQuerying fn = do     alloca $ \ szPtr -> do-        -- TODO: Maybe poke szPtr 0 for extra safety in cas its not initially zero+        poke szPtr 0         code <- fn nullPtr szPtr         case code of-            InsufficientBufferSpace -> do+            BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE -> do                 sz <- fromIntegral <$> peek szPtr                 allocBytes sz $ \ outPtr -> throwBotanIfNegative_ $ fn outPtr szPtr             _                       -> do                 throwBotanError code  -- NOTE: Does not check length of taken string, vulnerable to null byte injection-allocBytesQueryingCString :: (Ptr byte -> Ptr CSize -> IO BotanErrorCode) -> IO ByteString+allocBytesQueryingCString :: (Ptr byte -> Ptr CSize -> IO CInt) -> IO ByteString allocBytesQueryingCString action = do     cstring <- allocBytesQuerying action     return $!! ByteString.takeWhile (/= 0) cstring@@ -463,8 +515,8 @@ --  withPtrs :: (forall a . typ -> (ptr -> IO a) -> IO a) -> [typ] -> ([ptr] -> IO b) -> IO b-withPtrs withPtr []         act = act []-withPtrs withPtr (typ:typs) act = withPtr typ $ \ typPtr -> withPtrs withPtr typs (act . (typPtr:))+withPtrs _withPtr []         act = act []+withPtrs withPtr  (typ:typs) act = withPtr typ $ \ typPtr -> withPtrs withPtr typs (act . (typPtr:))  -- withNullablePtr 

@@ -1,247 +0,0 @@-module Botan.Low.Prelude-( module Prelude-, module Control.Monad-, module Control.Exception-, module Control.DeepSeq-, module Data.ByteString-, module Data.String-, module Data.Text-, module Data.Word-, module System.IO-, module Foreign.C.String-, module Foreign.C.Types-, module Foreign.ForeignPtr-, module Foreign.Marshal.Alloc-, module Foreign.Marshal.Array-, module Foreign.Ptr-, module Foreign.Storable-, module GHC.Stack-, ConstPtr(..)-, peekCString-, withCString-, withCBytes-, withCBytesLen-, withConstCString-, withMany--- Old-, peekCStringText-, allocBytes-, allocBytesWith-, asCString-, asCStringLen-, asBytes-, unsafeAsBytes-, asBytesLen-, unsafeAsBytesLen--- Helpers-, (//)-, (/$)-, showBytes-) where---- Re-exported modules--import Prelude--import Control.Monad-import Control.Exception-import Control.DeepSeq--import Data.ByteString (ByteString)-import Data.String (IsString(..))-import Data.Text (Text)--import Data.Word--import System.IO--import Foreign.C.String hiding (peekCString, peekCStringLen, withCString, withCStringLen)-import Foreign.C.Types-import Foreign.ForeignPtr-import Foreign.Marshal.Alloc-import Foreign.Marshal.Array-import Foreign.Ptr-import Foreign.Storable--import GHC.Stack---- Other Imports--import qualified Data.ByteString as ByteString-import qualified Data.ByteString.Internal as ByteString-import qualified Data.ByteString.Unsafe as ByteString--import qualified Data.ByteString.Char8 as Char8--import qualified Data.Text.Encoding as Text--import Botan.Bindings.Prelude (ConstPtr(..))--{--Small rant: CString is a bit of a mess--- CString doesn't work with const-- There is no CBytes-- Doesn't work with ConstPtr-- Different names for different types (peek vs pack, useAs vs with)-    - Data.ByteString-        - packCString :: CString -> IO ByteString-        - useAsCString :: ByteString -> (CString -> IO a) -> IO a-    - Text-    - Foreign.C.String-        - peekCString :: CString -> IO String-        - withCString :: String -> (CString -> IO a) -> IO a--}--{--BETTER VERSIONS--}---- Types---- Safe functions that make a temporary copy--- Only care about ByteString, leave Text for higher-level botan---- type CString = Ptr CChar--peekCString :: CString -> IO ByteString-peekCString = ByteString.packCString---- Replaces 'asCString'-withCString :: ByteString -> (CString -> IO a) -> IO a-withCString = ByteString.useAsCString---- type CStringLen = (Ptr CChar, Int)--peekCStringLen :: CStringLen -> IO ByteString-peekCStringLen = ByteString.packCStringLen---- Replaces 'asCStringLen'-withCStringLen :: ByteString -> (CStringLen -> IO a) -> IO a-withCStringLen = ByteString.useAsCStringLen--type CBytes = Ptr Word8---- peekCBytes :: CBytes -> Int -> IO ByteString--- peekCBytes = undefined--withCBytes :: ByteString -> (CBytes -> IO a) -> IO a-withCBytes bs act = ByteString.useAsCStringLen bs (\ (ptr,_) -> act (castPtr ptr))--type CBytesLen = (Ptr Word8, Int)--peekCBytesLen :: CBytesLen -> IO ByteString-peekCBytesLen (ptr, len) = ByteString.packCStringLen (castPtr ptr, len)---- Replaces 'asBytesLen'-withCBytesLen :: ByteString -> (CBytesLen -> IO a) -> IO a-withCBytesLen bs act = ByteString.useAsCStringLen bs (\ (ptr,len) -> act (castPtr ptr, len))---- QUESTION: Is it worth it to have extra types for ConstPtr versions?--{--type ConstCString       = ConstPtr CChar-type ConstCStringLen    = (ConstPtr CChar, Int)--type ConstCBytes    = ConstPtr Word8-type ConstCBytesLen = (ConstPtr Word8, Int)--}---- TODO: Replace---      withCString str $ \ cstr -> ... (ConstPtr cstr) ...---  with---      withConstCString str $ \ cstr -> ... cstr ...-withConstCString :: ByteString -> (ConstPtr CChar -> IO a) -> IO a-withConstCString bs act = ByteString.useAsCString bs (act . ConstPtr)--{--Misc--}--withMany-    :: (forall a . object -> (cobject -> IO a) -> IO a)-    -> [object]-    -> ([cobject] -> IO b)-    -> IO b-withMany withObject []         act = act []-withMany withObject (obj:objs) act = withObject obj $ \ cobj -> withMany withObject objs (act . (cobj:))--{--OLD--}----- Because:---  https://github.com/haskell/text/issues/239--- Is still an issue-peekCStringText :: CString -> IO Text-peekCStringText cs = do-    bs <- ByteString.unsafePackCString cs-    return $! Text.decodeUtf8 bs---- A cheap knockoff of ByteArray.alloc / allocRet--- We'll make this safer in the future--- NOTE: THIS IS NOT LIKE Foriegn.Marshal.Alloc.allocaBytes, though it is close---  Instead of returning the thing, we always return a bytestring.---  Also, allocaBytes frees the memory after, but this is a malloc freed on garbage collect.--- I basically ripped the relevant bits from ByteArray for ease of continuity-allocBytes :: Int -> (Ptr byte -> IO ()) -> IO ByteString--- allocBytes sz f = snd <$> allocBytesWith sz f--- NOTE: This is probably better than mallocByteString withForeignPtr---  Use of mallocByteString without mkDeferredByteString / deferForeignPtrAvailability---  is possibly a factor in our InsufficientBufferSpaceException issues--- NOTE: Most of the comments are rendered moot now :) this needs cleanup-allocBytes sz f = ByteString.create sz (f . castPtr)--allocBytesWith :: Int -> (Ptr byte -> IO a) -> IO (a, ByteString)-allocBytesWith sz f-    | sz < 0    = allocBytesWith 0 f-    | otherwise = do-        fptr <- ByteString.mallocByteString sz-        a <- withForeignPtr fptr (f . castPtr)-        -- return (a, ByteString.PS fptr 0 sz)-        -- NOTE: The safety of this function is suspect, may require deepseq-        let bs = ByteString.PS fptr 0 sz-            in bs `deepseq` return (a,bs)---- ByteString.create' doesn't exist--- TODO: Replace allocBytesWith with this-createByteString' :: Int -> (Ptr byte -> IO a) -> IO (ByteString,a)-createByteString' sz action = ByteString.createUptoN' sz $ \ ptr -> do-    a <- action (castPtr ptr)-    return (sz,a)-{-# INLINE createByteString' #-}------asCString :: ByteString -> (Ptr CChar -> IO a) -> IO a-asCString = ByteString.useAsCString--asCStringLen :: ByteString -> (Ptr CChar -> CSize -> IO a) -> IO a-asCStringLen bs f = ByteString.useAsCStringLen bs (\ (ptr,len) -> f ptr (fromIntegral len))--asBytes :: ByteString -> (Ptr byte -> IO a) -> IO a-asBytes bs f = asBytesLen bs (\ ptr _ -> f ptr)--unsafeAsBytes :: ByteString -> (Ptr byte -> IO a) -> IO a-unsafeAsBytes bs f = unsafeAsBytesLen bs (\ ptr _ -> f ptr)---- WARNING: This should not be using `useAsCStringLen`-asBytesLen :: ByteString -> (Ptr byte -> CSize -> IO a) -> IO a-asBytesLen bs f = ByteString.useAsCStringLen bs (\ (ptr,len) -> f (castPtr ptr) (fromIntegral len))--unsafeAsBytesLen :: ByteString -> (Ptr byte -> CSize -> IO a) -> IO a-unsafeAsBytesLen bs f = ByteString.unsafeUseAsCStringLen bs (\ (ptr,len) -> f (castPtr ptr) (fromIntegral len))---- Helpers used in a few name constructors--infixr 6 //-(//) :: (IsString a, Semigroup a) => a -> a -> a-a // b = a <> "/" <> b--infixr 0 /$-(/$) :: (IsString a, Semigroup a) => a -> a -> a-a /$ b = a <> "(" <> b <> ")"--showBytes :: (Show a) => a -> ByteString-showBytes = Char8.pack . show

@@ -12,187 +12,192 @@ for encryption, signatures, and key agreement. -} -module Botan.Low.PubKey-(---- * Private keys-  PrivKey(..)-, CheckKeyFlags(..)-, pattern CheckKeyNormalTests-, pattern CheckKeyExpensiveTests-, PrivKeyExportFlags(..)-, pattern PrivKeyExportDER-, pattern PrivKeyExportPEM-, withPrivKey-, privKeyCreate-, privKeyLoad-, privKeyDestroy-, privKeyAlgoName-, privKeyCheckKey-, privKeyGetField-, privKeyExport-, privKeyExportPubKey+{-# LANGUAGE LambdaCase        #-}+{-# LANGUAGE OverloadedStrings #-} --- * Public Keys+module Botan.Low.PubKey ( -, PubKey(..)-, withPubKey-, pubKeyLoad-, pubKeyDestroy-, pubKeyAlgoName-, pubKeyCheckKey-, pubKeyEstimatedStrength-, pubKeyFingerprint-, pubKeyGetField-, pubKeyExport+  -- * Private keys+    PrivKey(..)+  , CheckKeyFlags(..)+  , checkKeyFlags+  , PrivKeyExportFlags(..)+  , privKeyExportFlags+  , withPrivKey+  , privKeyCreate+  , privKeyLoad+  , privKeyDestroy+  , privKeyAlgoName+  , privKeyCheckKey+  , privKeyGetField+  , privKeyExport+  , privKeyExportPubKey --- * PK Algorithms+  -- * Public Keys -, PKName(..)-, pattern RSA-, pattern SM2-, pattern ElGamal-, pattern DSA-, pattern ECDSA-, pattern ECKCDSA-, pattern ECGDSA-, pattern GOST_34_10-, pattern Ed25519-, pattern XMSS-, pattern DH-, pattern ECDH-, pattern Curve25519-, pattern Dilithium-, pattern Kyber-, pattern McEliece+  , PubKey(..)+  , withPubKey+  , pubKeyLoad+  , pubKeyDestroy+  , pubKeyAlgoName+  , pubKeyCheckKey+  , pubKeyEstimatedStrength+  , pubKeyFingerprint+  , pubKeyGetField+  , pubKeyExport --- ** DLGroup+  -- * PK Algorithms -, DLGroupName(..)-, pattern FFDHE_IETF_2048-, pattern FFDHE_IETF_3072-, pattern FFDHE_IETF_4096-, pattern FFDHE_IETF_6144-, pattern FFDHE_IETF_8192-, pattern MODP_IETF_1024-, pattern MODP_IETF_1536-, pattern MODP_IETF_2048-, pattern MODP_IETF_3072-, pattern MODP_IETF_4096-, pattern MODP_IETF_6144-, pattern MODP_IETF_8192-, pattern MODP_SRP_1024-, pattern MODP_SRP_1536-, pattern MODP_SRP_2048-, pattern MODP_SRP_3072-, pattern MODP_SRP_4096-, pattern MODP_SRP_6144-, pattern MODP_SRP_8192-, pattern DSA_JCE_1024-, pattern DSA_BOTAN_2048-, pattern DSA_BOTAN_3072+  , PKName+  , pattern RSA+  , pattern SM2+  , pattern ElGamal+  , pattern DSA+  , pattern ECDSA+  , pattern ECKCDSA+  , pattern ECGDSA+  , pattern GOST_34_10+  , pattern Ed25519+  , pattern XMSS+  , pattern DH+  , pattern ECDH+  , pattern Curve25519+  , pattern Dilithium+  , pattern Kyber+  , pattern McEliece --- ** ECGroup+  -- ** DLGroup -, ECGroupName(..)-, pattern Secp160k1-, pattern Secp160r1-, pattern Secp160r2-, pattern Secp192k1-, pattern Secp192r1-, pattern Secp224k1-, pattern Secp224r1-, pattern Secp256k1-, pattern Secp256r1-, pattern Secp384r1-, pattern Secp521r1-, pattern Brainpool160r1-, pattern Brainpool192r1-, pattern Brainpool224r1-, pattern Brainpool256r1-, pattern Brainpool320r1-, pattern Brainpool384r1-, pattern Brainpool512r1-, pattern X962_p192v2-, pattern X962_p192v3-, pattern X962_p239v1-, pattern X962_p239v2-, pattern X962_p239v3-, pattern Gost_256A-, pattern Gost_512A-, pattern Frp256v1-, pattern Sm2p256v1+  , DLGroupName+  , pattern FFDHE_IETF_2048+  , pattern FFDHE_IETF_3072+  , pattern FFDHE_IETF_4096+  , pattern FFDHE_IETF_6144+  , pattern FFDHE_IETF_8192+  , pattern MODP_IETF_1024+  , pattern MODP_IETF_1536+  , pattern MODP_IETF_2048+  , pattern MODP_IETF_3072+  , pattern MODP_IETF_4096+  , pattern MODP_IETF_6144+  , pattern MODP_IETF_8192+  , pattern MODP_SRP_1024+  , pattern MODP_SRP_1536+  , pattern MODP_SRP_2048+  , pattern MODP_SRP_3072+  , pattern MODP_SRP_4096+  , pattern MODP_SRP_6144+  , pattern MODP_SRP_8192+  , pattern DSA_JCE_1024+  , pattern DSA_BOTAN_2048+  , pattern DSA_BOTAN_3072 --- ** XMSS+  -- ** ECGroup -, XMSSName(..)-, pattern XMSS_SHA2_10_256-, pattern XMSS_SHA2_16_256-, pattern XMSS_SHA2_20_256-, pattern XMSS_SHA2_10_512-, pattern XMSS_SHA2_16_512-, pattern XMSS_SHA2_20_512-, pattern XMSS_SHAKE_10_256-, pattern XMSS_SHAKE_16_256-, pattern XMSS_SHAKE_20_256-, pattern XMSS_SHAKE_10_512-, pattern XMSS_SHAKE_16_512-, pattern XMSS_SHAKE_20_512+  , ECGroupName+  , pattern Secp160k1+  , pattern Secp160r1+  , pattern Secp160r2+  , pattern Secp192k1+  , pattern Secp192r1+  , pattern Secp224k1+  , pattern Secp224r1+  , pattern Secp256k1+  , pattern Secp256r1+  , pattern Secp384r1+  , pattern Secp521r1+  , pattern Brainpool160r1+  , pattern Brainpool192r1+  , pattern Brainpool224r1+  , pattern Brainpool256r1+  , pattern Brainpool320r1+  , pattern Brainpool384r1+  , pattern Brainpool512r1+  , pattern X962_p192v2+  , pattern X962_p192v3+  , pattern X962_p239v1+  , pattern X962_p239v2+  , pattern X962_p239v3+  , pattern Gost_256A+  , pattern Gost_512A+  , pattern Frp256v1+  , pattern Sm2p256v1 --- * EME+  -- ** XMSS -, EMEName(..)-, pattern EME_RAW-, pattern EME_PKCS1_v1_5-, pattern EME_OAEP-, eme_raw-, eme_pkcs1_v1_5-, eme_oaep--- , eme_oaep_mgf-, eme_hash-, eme_sm2EncParam+  , XMSSName+  , pattern XMSS_SHA2_10_256+  , pattern XMSS_SHA2_16_256+  , pattern XMSS_SHA2_20_256+  , pattern XMSS_SHA2_10_512+  , pattern XMSS_SHA2_16_512+  , pattern XMSS_SHA2_20_512+  , pattern XMSS_SHAKE_10_256+  , pattern XMSS_SHAKE_16_256+  , pattern XMSS_SHAKE_20_256+  , pattern XMSS_SHAKE_10_512+  , pattern XMSS_SHAKE_16_512+  , pattern XMSS_SHAKE_20_512 --- * EMSA+  -- * EME -, EMSAName(..)-, emsa_none-, emsa_emsa4-, emsa_hash-, emsa_ed25519Pure-, emsa_ed25519Prehashed-, emsa_ed25519GnuPG-, emsa_sm2SignParam+  , EMEName+  , pattern EME_RAW+  , pattern EME_PKCS1_v1_5+  , pattern EME_OAEP+  , eme_raw+  , eme_pkcs1_v1_5+  , eme_oaep+  -- , eme_oaep_mgf+  , eme_hash+  , eme_sm2EncParam --- * Convenience+  -- * EMSA --- , PKPaddingName(..)-, createPrivKey-, createPubKey-, mkPrivKeyLoad1_name-, mkPrivKeyLoad3-, mkPrivKeyLoad4-, mkPubKeyLoad2-, mkPubKeyLoad2_name-, mkPubKeyLoad3-, mkPubKeyLoad4+  , EMSAName+  , emsa_none+  , emsa_emsa4+  , emsa_hash+  , emsa_ed25519Pure+  , emsa_ed25519Prehashed+  , emsa_ed25519GnuPG+  , emsa_sm2SignParam -) where+  -- * Convenience -import qualified Data.ByteString as ByteString-import qualified Data.ByteString.Unsafe as ByteString+  -- , PKPaddingName(..)+  , createPrivKey+  , createPubKey+  , mkPrivKeyLoad1_name+  , mkPrivKeyLoad3+  , mkPrivKeyLoad4+  , mkPubKeyLoad2+  , mkPubKeyLoad2_name+  , mkPubKeyLoad3+  , mkPubKeyLoad4 -import Botan.Bindings.MPI-import Botan.Bindings.PubKey-import Botan.Bindings.RNG+  ) where -import Botan.Low.Error-import Botan.Low.Hash-import Botan.Low.Make-import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.Remake-import Botan.Low.RNG-import Botan.Low.View+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.MPI+import           Botan.Bindings.PubKey+import           Botan.Bindings.RNG+import           Botan.Low.Error.Internal+import           Botan.Low.Hash+import           Botan.Low.Internal.ByteString+import           Botan.Low.Internal.String+import           Botan.Low.Make+import           Botan.Low.MPI+import           Botan.Low.Remake+import           Botan.Low.RNG+import           Data.ByteString (ByteString)+import qualified Data.ByteString as ByteString+import           Data.Word+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  {- $introduction @@ -272,26 +277,21 @@  -- Associated types -type PKPaddingName = ByteString- -- /* -- * Public/private key creation, import, ... -- */  newtype PrivKey = MkPrivKey { getPrivKeyForeignPtr :: ForeignPtr BotanPrivKeyStruct } -newPrivKey      :: BotanPrivKey -> IO PrivKey withPrivKey     :: PrivKey -> (BotanPrivKey -> IO a) -> IO a privKeyDestroy  :: PrivKey -> IO () createPrivKey   :: (Ptr BotanPrivKey -> IO CInt) -> IO PrivKey-(newPrivKey, withPrivKey, privKeyDestroy, createPrivKey, _)+(withPrivKey, privKeyDestroy, createPrivKey)     = mkBindings-        MkBotanPrivKey runBotanPrivKey-        MkPrivKey getPrivKeyForeignPtr+        MkBotanPrivKey (.runBotanPrivKey)+        MkPrivKey (.getPrivKeyForeignPtr)         botan_privkey_destroy -type PrivKeyName = ByteString- type PKName = ByteString  pattern RSA@@ -503,16 +503,7 @@ eme_sm2EncParam :: HashName -> EMEName eme_sm2EncParam h = h -type MGFName = ByteString -pattern MGF1-    :: MGFName--pattern MGF1 = BOTAN_MGF_MGF1--mgf1 :: HashName -> MGFName-mgf1 h = MGF1 /$ h- {- | Encoding Method for Signature with Appendix @@ -562,17 +553,13 @@                 (ConstPtr paramsPtr)                 botanRNG --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withPrivKeyCreate :: ByteString -> ByteString -> RNG -> (PrivKey -> IO a) -> IO a-withPrivKeyCreate = mkWithTemp3 privKeyCreate privKeyDestroy--type CheckKeyFlags = Word32+data CheckKeyFlags =+    CheckKeyNormalTests+  | CheckKeyExpensiveTests -pattern CheckKeyNormalTests-    ,   CheckKeyExpensiveTests-    ::  CheckKeyFlags-pattern CheckKeyNormalTests    = BOTAN_CHECK_KEY_NORMAL_TESTS-pattern CheckKeyExpensiveTests = BOTAN_CHECK_KEY_EXPENSIVE_TESTS+checkKeyFlags :: CheckKeyFlags -> Word32+checkKeyFlags CheckKeyNormalTests    = BOTAN_CHECK_KEY_NORMAL_TESTS+checkKeyFlags CheckKeyExpensiveTests = BOTAN_CHECK_KEY_EXPENSIVE_TESTS  -- TODO: Probably catch -1 (INVALID_INPUT), return Bool -- | Check the validity of a private key@@ -583,7 +570,7 @@     -> IO () privKeyCheckKey sk rng flags = withPrivKey sk $ \ skPtr -> do     withRNG rng $ \ botanRNG -> do-        throwBotanIfNegative_ $ botan_privkey_check_key skPtr botanRNG flags+        throwBotanIfNegative_ $ botan_privkey_check_key skPtr botanRNG (checkKeyFlags flags)  -- NOTE: Expectes PKCS #8 / PEM structure -- botan_privkey_export -> null password? and botan_privkey_export_encrypted_... -> use a password?@@ -611,14 +598,13 @@             bitsLen             (ConstPtr passwordPtr) -type PrivKeyExportFlags = Word32--pattern PrivKeyExportDER-    ,   PrivKeyExportPEM-    ::  PrivKeyExportFlags+data PrivKeyExportFlags =+    PrivKeyExportDER+  | PrivKeyExportPEM -pattern PrivKeyExportDER = BOTAN_PRIVKEY_EXPORT_FLAG_DER-pattern PrivKeyExportPEM = BOTAN_PRIVKEY_EXPORT_FLAG_PEM+privKeyExportFlags :: PrivKeyExportFlags -> Word32+privKeyExportFlags PrivKeyExportDER = BOTAN_PRIVKEY_EXPORT_FLAG_DER+privKeyExportFlags PrivKeyExportPEM = BOTAN_PRIVKEY_EXPORT_FLAG_PEM  -- NOTE: Different from allocBytesQuerying / INSUFFICIENT_BUFFER_SPACE {- |@@ -636,13 +622,13 @@     alloca $ \szPtr -> do         poke szPtr 0         -- NOTE: Presumed be -1-        _ <- botan_privkey_export skPtr nullPtr szPtr flags+        _ <- botan_privkey_export skPtr nullPtr szPtr (privKeyExportFlags flags)         sz <- peek szPtr         allocBytes (fromIntegral sz) $ \ bytesPtr -> do-            throwBotanIfNegative_ $ botan_privkey_export skPtr bytesPtr szPtr flags+            throwBotanIfNegative_ $ botan_privkey_export skPtr bytesPtr szPtr (privKeyExportFlags flags)  -- TODO:--- | View the private key's DER encoding+-- View the private key's DER encoding -- privKeyViewDER --         :: BotanPrivKey                         -- ^ __key__ --         -> BotanViewContext ctx                 -- ^ __ctx__@@ -650,7 +636,7 @@ --         -> IO CInt  -- TODO:--- | View the private key's PEM encoding+-- View the private key's PEM encoding -- privKeyViewPEM --         :: BotanPrivKey                         -- ^ __key__ --         -> BotanViewContext ctx                 -- ^ __ctx__@@ -688,27 +674,20 @@  newtype PubKey = MkPubKey { getPubKeyForeignPtr :: ForeignPtr BotanPubKeyStruct } -newPubKey      :: BotanPubKey -> IO PubKey withPubKey     :: PubKey -> (BotanPubKey -> IO a) -> IO a pubKeyDestroy  :: PubKey -> IO () createPubKey   :: (Ptr BotanPubKey -> IO CInt) -> IO PubKey-(newPubKey, withPubKey, pubKeyDestroy, createPubKey, _)+(withPubKey, pubKeyDestroy, createPubKey)     = mkBindings-        MkBotanPubKey runBotanPubKey-        MkPubKey getPubKeyForeignPtr+        MkBotanPubKey (.runBotanPubKey)+        MkPubKey (.getPubKeyForeignPtr)         botan_pubkey_destroy -type PubKeyName = ByteString- pubKeyLoad     :: ByteString   -- ^ __bits[]__     -> IO PubKey    -- ^ __key__ pubKeyLoad = mkCreateObjectCBytesLen createPubKey botan_pubkey_load --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withPubKeyLoad :: ByteString -> (PubKey -> IO a) -> IO a-withPubKeyLoad = mkWithTemp1 pubKeyLoad pubKeyDestroy- privKeyExportPubKey     :: PrivKey      -- ^ __in__     -> IO PubKey    -- ^ __out__@@ -716,13 +695,7 @@  type PubKeyExportFlags = PrivKeyExportFlags -pattern PubKeyExportDER-    ,   PubKeyExportPEM-    ::  PubKeyExportFlags -pattern PubKeyExportDER = PrivKeyExportDER-pattern PubKeyExportPEM = PrivKeyExportPEM- -- NOTE: Different from allocBytesQuerying / INSUFFICIENT_BUFFER_SPACE pubKeyExport     :: PubKey               -- ^ __key__@@ -732,10 +705,10 @@     alloca $ \szPtr -> do         poke szPtr 0         -- NOTE: Presumed be -1-        _ <- botan_pubkey_export pkPtr nullPtr szPtr flags+        _ <- botan_pubkey_export pkPtr nullPtr szPtr (privKeyExportFlags flags)         sz <- peek szPtr         allocBytes (fromIntegral sz) $ \ bytesPtr -> do-            throwBotanIfNegative_ $ botan_pubkey_export pkPtr bytesPtr szPtr flags+            throwBotanIfNegative_ $ botan_pubkey_export pkPtr bytesPtr szPtr (privKeyExportFlags flags)   pubKeyAlgoName@@ -743,21 +716,22 @@     -> IO ByteString    -- ^ __out[]__ pubKeyAlgoName = mkGetCString withPubKey botan_pubkey_algo_name -pubKeyCheckKey-    :: PubKey           -- ^ __key__-    -> RNG              -- ^ __rng__-    -> CheckKeyFlags    -- ^ __flags__-    -> IO Bool-pubKeyCheckKey pk rng flags = withPubKey pk $ \ pkPtr -> do-    withRNG rng $ \ botanRNG -> do-        throwBotanCatchingSuccess $ botan_pubkey_check_key pkPtr botanRNG flags+pubKeyCheckKey ::+     PubKey           -- ^ __key__+  -> RNG              -- ^ __rng__+  -> CheckKeyFlags    -- ^ __flags__+  -> IO Bool+pubKeyCheckKey pk rng flags =+    withPubKey pk $ \ pkPtr ->+    withRNG rng $ \ botanRNG ->+    throwBotanCatchingInvalidInput $ botan_pubkey_check_key pkPtr botanRNG (checkKeyFlags flags)  -- Annoying - this mixes cint and csize --  I need to consolidate getsize / getint pubKeyEstimatedStrength     :: PubKey   -- ^ __key__     -> IO Int   -- ^ __estimate__-pubKeyEstimatedStrength pk = fromIntegral <$> mkGetSize withPubKey botan_pubkey_estimated_strength pk+pubKeyEstimatedStrength pk = mkGetSize withPubKey botan_pubkey_estimated_strength pk  pubKeyFingerprint     :: PubKey           -- ^ __key__@@ -802,47 +776,67 @@ -- Helpers  mkPrivKeyLoad1_name-    :: (Ptr BotanPrivKey -> BotanMP -> ConstPtr CChar -> IO BotanErrorCode)+    :: (Ptr BotanPrivKey -> BotanMP -> ConstPtr CChar -> IO CInt)     -> MP -> ByteString -> IO PrivKey mkPrivKeyLoad1_name load a name = withMP a $ \ aPtr -> do     asCString name $ \ namePtr -> do         createPrivKey $ \ out -> load out aPtr (ConstPtr namePtr)  mkPrivKeyLoad3-    :: (Ptr BotanPrivKey -> BotanMP -> BotanMP -> BotanMP -> IO BotanErrorCode)+    :: (Ptr BotanPrivKey -> BotanMP -> BotanMP -> BotanMP -> IO CInt)     -> MP -> MP -> MP -> IO PrivKey-mkPrivKeyLoad3 load a b c = withMany withMP [a,b,c] $ \ [aPtr,bPtr,cPtr] -> do-    createPrivKey $ \ out -> load out aPtr bPtr cPtr+mkPrivKeyLoad3 load a b c = withMany withMP [a,b,c] $ \case+    [aPtr,bPtr,cPtr] -> do+      createPrivKey $ \ out -> load out aPtr bPtr cPtr+    _ -> error "mkPrivKeyLoad3: impossible"  mkPrivKeyLoad4-    :: (Ptr BotanPrivKey -> BotanMP -> BotanMP -> BotanMP -> BotanMP -> IO BotanErrorCode)+    :: (Ptr BotanPrivKey -> BotanMP -> BotanMP -> BotanMP -> BotanMP -> IO CInt)     -> MP -> MP -> MP -> MP -> IO PrivKey-mkPrivKeyLoad4 load a b c d = withMany withMP [a,b,c,d] $ \ [aPtr,bPtr,cPtr,dPtr] -> do-    createPrivKey $ \ out -> load out aPtr bPtr cPtr dPtr+mkPrivKeyLoad4 load a b c d = withMany withMP [a,b,c,d] $ \case+    [aPtr,bPtr,cPtr,dPtr] -> do+      createPrivKey $ \ out -> load out aPtr bPtr cPtr dPtr+    _ -> error "mkPrivKeyLoad4: impossible"  --  mkPubKeyLoad2-    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> IO BotanErrorCode)+    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> IO CInt)     -> MP -> MP -> IO PubKey-mkPubKeyLoad2 load a b = withMany withMP [a,b] $ \ [aPtr,bPtr] -> do-    createPubKey $ \ out -> load out aPtr bPtr+mkPubKeyLoad2 load a b = withMany withMP [a,b] $ \case+    [aPtr,bPtr] -> do+      createPubKey $ \ out -> load out aPtr bPtr+    _ -> error "mkPubKeyLoad2: impossible"  mkPubKeyLoad2_name-    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> ConstPtr CChar -> IO BotanErrorCode)+    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> ConstPtr CChar -> IO CInt)     -> MP -> MP -> ByteString -> IO PubKey-mkPubKeyLoad2_name load x y name = withMany withMP [x,y] $ \ [xPtr,yPtr] -> do-    asCString name $ \ namePtr -> do+mkPubKeyLoad2_name load x y name = withMany withMP [x,y] $ \case+    [xPtr,yPtr] -> do+      asCString name $ \ namePtr -> do         createPubKey $ \ out -> load out xPtr yPtr (ConstPtr namePtr)+    _ -> error "mkPubKeyLoad2_name: impossible"  mkPubKeyLoad3-    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> BotanMP -> IO BotanErrorCode)+    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> BotanMP -> IO CInt)     -> MP -> MP -> MP -> IO PubKey-mkPubKeyLoad3 load a b c = withMany withMP [a,b,c] $ \ [aPtr,bPtr,cPtr] -> do-    createPubKey $ \ out -> load out aPtr bPtr cPtr+mkPubKeyLoad3 load a b c = withMany withMP [a,b,c] $ \case+    [aPtr,bPtr,cPtr] -> do+      createPubKey $ \ out -> load out aPtr bPtr cPtr+    _ -> error "mkPubKeyLoad3: impossible"  mkPubKeyLoad4-    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> BotanMP -> BotanMP -> IO BotanErrorCode)+    :: (Ptr BotanPubKey -> BotanMP -> BotanMP -> BotanMP -> BotanMP -> IO CInt)     -> MP -> MP -> MP -> MP -> IO PubKey-mkPubKeyLoad4 load a b c d = withMany withMP [a,b,c,d] $ \ [aPtr,bPtr,cPtr,dPtr] -> do-    createPubKey $ \ out -> load out aPtr bPtr cPtr dPtr+mkPubKeyLoad4 load a b c d = withMany withMP [a,b,c,d] $ \case+    [aPtr,bPtr,cPtr,dPtr] -> do+      createPubKey $ \ out -> load out aPtr bPtr cPtr dPtr+    _ -> error "mkPubKeyLoad4: impossible"++withMany ::+     (forall a . object -> (cobject -> IO a) -> IO a)+  -> [object]+  -> ([cobject] -> IO b)+  -> IO b+withMany _withObject []         act = act []+withMany withObject  (obj:objs) act = withObject obj $ \ cobj -> withMany withObject objs (act . (cobj:))

@@ -9,17 +9,14 @@ Portability : POSIX -} -module Botan.Low.PubKey.DH where--import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey.DH+module Botan.Low.PubKey.DH (+    privKeyLoadDH+  , pubKeyLoadDH+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey+import           Botan.Bindings.PubKey.DH+import           Botan.Low.MPI+import           Botan.Low.PubKey  privKeyLoadDH     :: MP           -- ^ __p__: prime order of a Z_p group

@@ -9,19 +9,16 @@ Portability : POSIX -} -module Botan.Low.PubKey.DSA where--import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey-import Botan.Bindings.PubKey.DSA+module Botan.Low.PubKey.DSA (+    privKeyCreateDSA+  , privKeyLoadDSA+  , pubKeyLoadDSA+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey-import Botan.Low.RNG+import           Botan.Bindings.PubKey.DSA+import           Botan.Low.MPI+import           Botan.Low.PubKey+import           Botan.Low.RNG  privKeyCreateDSA     :: RNG          -- ^ __rng__: initialized PRNG

@@ -9,29 +9,33 @@ Portability : POSIX -} -module Botan.Low.PubKey.Decrypt-(---- * Public key decryption-  Decrypt(..)-, withDecrypt-, decryptCreate-, decryptDestroy-, decryptOutputLength-, decrypt--) where+module Botan.Low.PubKey.Decrypt ( -import qualified Data.ByteString as ByteString+  -- * Public key decryption+    Decrypt(..)+  , withDecrypt+  , decryptCreate+  , decryptDestroy+  , decryptOutputLength+  , decrypt -import Botan.Bindings.PubKey.Decrypt+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.RNG-import Botan.Low.PubKey-import Botan.Low.Remake+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.PubKey.Decrypt+import           Botan.Low.Error.Internal (throwBotanIfNegative_)+import           Botan.Low.Internal.ByteString+import           Botan.Low.Make+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Data.ByteString (ByteString)+import qualified Data.ByteString as BS+import qualified Data.ByteString.Internal as BSI+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  -- /* -- * Public Key Decryption@@ -39,14 +43,13 @@  newtype Decrypt = MkDecrypt { getDecryptForeignPtr :: ForeignPtr BotanPKOpDecryptStruct } -newDecrypt      :: BotanPKOpDecrypt -> IO Decrypt withDecrypt     :: Decrypt -> (BotanPKOpDecrypt -> IO a) -> IO a decryptDestroy  :: Decrypt -> IO () createDecrypt   :: (Ptr BotanPKOpDecrypt -> IO CInt) -> IO Decrypt-(newDecrypt, withDecrypt, decryptDestroy, createDecrypt, _)+(withDecrypt, decryptDestroy, createDecrypt)     = mkBindings-        MkBotanPKOpDecrypt runBotanPKOpDecrypt-        MkDecrypt getDecryptForeignPtr+        MkBotanPKOpDecrypt (.runBotanPKOpDecrypt)+        MkDecrypt (.getDecryptForeignPtr)         botan_pk_op_decrypt_destroy  decryptCreate@@ -61,25 +64,28 @@             paddingPtr             BOTAN_PUBKEY_DECRYPT_FLAGS_NONE --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withDecryptCreate :: PrivKey -> EMEName -> (Decrypt -> IO a) -> IO a-withDecryptCreate = mkWithTemp2 decryptCreate decryptDestroy- decryptOutputLength     :: Decrypt  -- ^ __op__     -> Int      -- ^ __ctext_len__     -> IO Int   -- ^ __ptext_len__ decryptOutputLength = mkGetSize_csize withDecrypt botan_pk_op_decrypt_output_length -decrypt-    :: Decrypt          -- ^ __op__-    -> ByteString       -- ^ __ciphertext__-    -> IO ByteString    -- ^ __plaintext__-decrypt dec ctext = withDecrypt dec $ \ decPtr -> do-    asBytesLen ctext $ \ ctextPtr ctextLen -> do-        allocBytesQuerying $ \ outPtr szPtr -> botan_pk_op_decrypt+decrypt ::+     Decrypt          -- ^ __op__+  -> ByteString       -- ^ __ciphertext__+  -> IO ByteString    -- ^ __plaintext__+decrypt dec ctext =+    withDecrypt dec $ \ decPtr ->+    asBytesLen ctext $ \ ctextPtr ctextLen ->+    alloca $ \szPtr -> do+      sz <- decryptOutputLength dec (BS.length ctext)+      poke szPtr (fromIntegral sz)+      BSI.createAndTrim sz $ \outPtr -> do+        throwBotanIfNegative_ $+          botan_pk_op_decrypt             decPtr             outPtr             szPtr             (ConstPtr ctextPtr)             ctextLen+        fromIntegral <$> peek szPtr

@@ -1,11 +1,12 @@-module Botan.Low.PubKey.ECDH where--import Botan.Bindings.PubKey-import Botan.Bindings.PubKey.ECDH+module Botan.Low.PubKey.ECDH (+    privKeyLoadECDH+  , pubKeyLoadECDH+  ) where -import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey+import           Botan.Bindings.PubKey.ECDH+import           Botan.Low.MPI+import           Botan.Low.PubKey+import           Data.ByteString (ByteString)  privKeyLoadECDH     :: MP           -- ^ __scalar__

@@ -1,11 +1,12 @@-module Botan.Low.PubKey.ECDSA where--import Botan.Bindings.PubKey-import Botan.Bindings.PubKey.ECDSA+module Botan.Low.PubKey.ECDSA (+    privKeyLoadECDSA+  , pubKeyLoadECDSA+  ) where -import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey+import           Botan.Bindings.PubKey.ECDSA+import           Botan.Low.MPI+import           Botan.Low.PubKey+import           Data.ByteString (ByteString)  privKeyLoadECDSA     :: MP           -- ^ __scalar__

@@ -9,18 +9,19 @@ Portability : POSIX -} -module Botan.Low.PubKey.Ed25519 where--import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey-import Botan.Bindings.PubKey.Ed25519+module Botan.Low.PubKey.Ed25519 (+    privKeyLoadEd25519+  , pubKeyLoadEd25519+  , privKeyEd25519GetPrivKey+  , pubKeyEd25519GetPubKey+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.PubKey-import Botan.Low.Remake+import           Botan.Bindings.PubKey.Ed25519+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Data.ByteString (ByteString)  -- /* -- * Algorithm specific key operations: Ed25519

@@ -9,19 +9,16 @@ Portability : POSIX -} -module Botan.Low.PubKey.ElGamal where--import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey-import Botan.Bindings.PubKey.ElGamal+module Botan.Low.PubKey.ElGamal (+    privKeyCreateElGamal+  , privKeyLoadElGamal+  , pubKeyLoadElGamal+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey-import Botan.Low.RNG+import           Botan.Bindings.PubKey.ElGamal+import           Botan.Low.MPI+import           Botan.Low.PubKey+import           Botan.Low.RNG  -- /* -- * Algorithm specific key operations: ElGamal

@@ -9,29 +9,34 @@ Portability : POSIX -} -module Botan.Low.PubKey.Encrypt-(---- * Public key encryption-  Encrypt(..)-, withEncrypt-, encryptCreate-, encryptDestroy-, encryptOutputLength-, encrypt--) where+module Botan.Low.PubKey.Encrypt ( -import qualified Data.ByteString as ByteString+  -- * Public key encryption+    Encrypt(..)+  , withEncrypt+  , encryptCreate+  , encryptDestroy+  , encryptOutputLength+  , encrypt -import Botan.Bindings.PubKey.Encrypt+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.RNG-import Botan.Low.PubKey-import Botan.Low.Remake+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.PubKey.Encrypt+import           Botan.Low.Error.Internal (throwBotanIfNegative_)+import           Botan.Low.Internal.ByteString+import           Botan.Low.Make+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Botan.Low.RNG+import           Data.ByteString (ByteString)+import qualified Data.ByteString as BS+import qualified Data.ByteString.Internal as BSI+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  -- /* -- * Public Key Encryption@@ -39,14 +44,13 @@  newtype Encrypt = MkEncrypt { getEncryptForeignPtr :: ForeignPtr BotanPKOpEncryptStruct } -newEncrypt      :: BotanPKOpEncrypt -> IO Encrypt withEncrypt     :: Encrypt -> (BotanPKOpEncrypt -> IO a) -> IO a encryptDestroy  :: Encrypt -> IO () createEncrypt   :: (Ptr BotanPKOpEncrypt -> IO CInt) -> IO Encrypt-(newEncrypt, withEncrypt, encryptDestroy, createEncrypt, _)+(withEncrypt, encryptDestroy, createEncrypt)     = mkBindings-        MkBotanPKOpEncrypt runBotanPKOpEncrypt-        MkEncrypt getEncryptForeignPtr+        MkBotanPKOpEncrypt (.runBotanPKOpEncrypt)+        MkEncrypt (.getEncryptForeignPtr)         botan_pk_op_encrypt_destroy  encryptCreate@@ -61,34 +65,31 @@             (ConstPtr paddingPtr)             0 --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withEncryptCreate :: PubKey -> EMEName -> (Encrypt -> IO a) -> IO a-withEncryptCreate = mkWithTemp2 encryptCreate encryptDestroy- encryptOutputLength     :: Encrypt  -- ^ __op__     -> Int      -- ^ __ptext_len__     -> IO Int   -- ^ __ctext_len__ encryptOutputLength = mkGetSize_csize withEncrypt botan_pk_op_encrypt_output_length --- NOTE: This properly takes advantage of szPtr, queries the buffer size - do this elsewhere--- NOTE: SM2 take a hash instead of a padding, and encrypt fails with InsufficientBufferSpace---  if sm2p256v1 is not used as the curve when creating the key (but creating the key and---  the encryption context do not fail)---  This implies that encryptOutputLength may be wrong or hardcoded for SM2 or that we---  are not supposed to use curves other than sm2p256v1 - this needs investigating-encrypt-    :: Encrypt          -- ^ __op__-    -> RNG              -- ^ __rng__-    -> ByteString       -- ^ __plaintext[]__-    -> IO ByteString    -- ^ __ciphertext[]__-encrypt enc rng ptext = withEncrypt enc $ \ encPtr -> do-    withRNG rng $ \ botanRNG -> do-        asBytesLen ptext $ \ ptextPtr ptextLen -> do-            allocBytesQuerying $ \ outPtr szPtr -> botan_pk_op_encrypt-                encPtr-                botanRNG-                outPtr-                szPtr-                ptextPtr-                ptextLen+encrypt ::+     Encrypt          -- ^ __op__+  -> RNG              -- ^ __rng__+  -> ByteString       -- ^ __plaintext[]__+  -> IO ByteString    -- ^ __ciphertext[]__+encrypt enc rng ptext =+    withEncrypt enc $ \ encPtr ->+    withRNG rng $ \ botanRNG ->+    asBytesLen ptext $ \ ptextPtr ptextLen ->+    alloca $ \szPtr -> do+      sz <- encryptOutputLength enc (BS.length ptext)+      poke szPtr (fromIntegral sz)+      BSI.createAndTrim sz $ \outPtr -> do+        throwBotanIfNegative_ $+          botan_pk_op_encrypt+            encPtr+            botanRNG+            outPtr+            szPtr+            ptextPtr+            ptextLen+        fromIntegral <$> peek szPtr

@@ -9,35 +9,39 @@ Portability : POSIX -} -module Botan.Low.PubKey.KeyAgreement-(+module Botan.Low.PubKey.KeyAgreement ( --- * PK Key Agreement--- $introduction--- * Usage--- $usage+  -- * PK Key Agreement+  -- $introduction+  -- * Usage+  -- $usage --- * Key agreement-  KeyAgreement(..)-, withKeyAgreement-, keyAgreementCreate-, keyAgreementDestroy-, keyAgreementExportPublic-, keyAgreementSize-, keyAgreement+  -- * Key agreement+    KeyAgreement(..)+  , withKeyAgreement+  , keyAgreementCreate+  , keyAgreementDestroy+  , keyAgreementExportPublic+  , keyAgreementSize+  , keyAgreement -) where+  ) where +import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.PubKey.KeyAgreement+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.KDF+import           Botan.Low.Make+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Data.ByteString (ByteString) import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey.KeyAgreement--import Botan.Low.Error-import Botan.Low.KDF-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.PubKey-import Botan.Low.Remake+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  {- $introduction @@ -113,89 +117,70 @@  newtype KeyAgreement = MkKeyAgreement { getKeyAgreementForeignPtr :: ForeignPtr BotanPKOpKeyAgreementStruct } -newKeyAgreement      :: BotanPKOpKeyAgreement -> IO KeyAgreement withKeyAgreement     :: KeyAgreement -> (BotanPKOpKeyAgreement -> IO a) -> IO a keyAgreementDestroy  :: KeyAgreement -> IO () createKeyAgreement   :: (Ptr BotanPKOpKeyAgreement -> IO CInt) -> IO KeyAgreement-(newKeyAgreement, withKeyAgreement, keyAgreementDestroy, createKeyAgreement, _)+(withKeyAgreement, keyAgreementDestroy, createKeyAgreement)     = mkBindings-        MkBotanPKOpKeyAgreement runBotanPKOpKeyAgreement-        MkKeyAgreement getKeyAgreementForeignPtr+        MkBotanPKOpKeyAgreement (.runBotanPKOpKeyAgreement)+        MkKeyAgreement (.getKeyAgreementForeignPtr)         botan_pk_op_key_agreement_destroy  -- NOTE: Silently uses the system RNG-keyAgreementCreate-    :: PrivKey          -- ^ __key__-    -> KDFName          -- ^ __kdf__-    -> IO KeyAgreement  -- ^ __op__-keyAgreementCreate sk algo = withPrivKey sk $ \ skPtr -> do-    asCString algo $ \ algoPtr -> do-        createKeyAgreement $ \ out -> botan_pk_op_key_agreement_create-            out-            skPtr-            (ConstPtr algoPtr)-            0---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withKeyAgreementCreate :: PrivKey -> KDFName -> (KeyAgreement -> IO a) -> IO a-withKeyAgreementCreate = mkWithTemp2 keyAgreementCreate keyAgreementDestroy+keyAgreementCreate ::+     PrivKey          -- ^ __key__+  -> KDFName          -- ^ __kdf__+  -> IO KeyAgreement  -- ^ __op__+keyAgreementCreate sk algo =+    withPrivKey sk $ \ skPtr ->+    asCString algo $ \ algoPtr ->+    createKeyAgreement $ \ out ->+      botan_pk_op_key_agreement_create+        out+        skPtr+        (ConstPtr algoPtr)+        0  -- NOTE: I do not know if this provides a different functionality than just being --  an alias for botan_privkey_export_pubkey / privKeyExportPubKey --  Observe that it *does* just take a privkey, instead of a keyagreement --  It may simply be here for convenience.-{--int botan_pk_op_key_agreement_export_public(botan_privkey_t key, uint8_t out[], size_t* out_len) {-   return copy_view_bin(out, out_len, botan_pk_op_key_agreement_view_public, key);-}--int botan_pk_op_key_agreement_view_public(botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view) {-   return BOTAN_FFI_VISIT(key, [=](const auto& k) -> int {-      if(auto kak = dynamic_cast<const Botan::PK_Key_Agreement_Key*>(&k))-         return invoke_view_callback(view, ctx, kak->public_value());-      else-         return BOTAN_FFI_ERROR_INVALID_INPUT;-   });-}--}-keyAgreementExportPublic-    :: PrivKey          -- ^ __key__-    -> IO ByteString    -- ^ __out[]__-keyAgreementExportPublic sk = withPrivKey sk $ \ skPtr -> do-    allocBytesQuerying $ \ outPtr outLen -> botan_pk_op_key_agreement_export_public+keyAgreementExportPublic ::+     PrivKey          -- ^ __key__+  -> IO ByteString    -- ^ __out[]__+keyAgreementExportPublic sk =+    withPrivKey sk $ \ skPtr ->+    allocBytesQuerying $ \ outPtr outLen ->+      botan_pk_op_key_agreement_export_public         skPtr         outPtr         outLen -keyAgreementSize-    :: KeyAgreement -- ^ __op__-    -> IO Int       -- ^ __out_len__+keyAgreementSize ::+     KeyAgreement -- ^ __op__+  -> IO Int       -- ^ __out_len__ keyAgreementSize = mkGetSize withKeyAgreement botan_pk_op_key_agreement_size --- | TODO: This function was leaking memory and causing crashes. Please observe--- carefully and report any future leaks. See issue #35.-keyAgreement-    :: KeyAgreement     -- ^ __op__-    -> ByteString       -- ^ __out[]__-    -> ByteString       -- ^ __other_key[]__-    -> IO ByteString    -- ^ __salt[]__-keyAgreement ka key salt = withKeyAgreement ka $ \ kaPtr -> do-    asBytesLen key $ \ keyPtr keyLen -> do-        asBytesLen salt $ \ saltPtr saltLen -> do-            outSz <- keyAgreementSize ka-            alloca $ \ szPtr -> do-                -- NOTE: This poke was necessary to stop a memory leak-                -- Similar pokes have been needed elsewere-                -- TODO: Ensure that all alloca szPtr elsewhere are properly poked-                poke szPtr (fromIntegral outSz)-                out <- allocBytes outSz $ \ outPtr -> do-                    throwBotanIfNegative_ $ botan_pk_op_key_agreement-                        kaPtr-                        outPtr-                        szPtr-                        (ConstPtr keyPtr)-                        keyLen-                        (ConstPtr saltPtr)-                        saltLen-                sz <- fromIntegral <$> peek szPtr-                return $! ByteString.take sz out+keyAgreement ::+     KeyAgreement     -- ^ __op__+  -> ByteString       -- ^ __out[]__+  -> ByteString       -- ^ __other_key[]__+  -> IO ByteString    -- ^ __salt[]__+keyAgreement ka key salt =+    withKeyAgreement ka $ \ kaPtr ->+    asBytesLen key $ \ keyPtr keyLen ->+    asBytesLen salt $ \ saltPtr saltLen -> do+      outSz <- keyAgreementSize ka+      alloca $ \ szPtr -> do+        poke szPtr (fromIntegral outSz)+        out <- allocBytes outSz $ \ outPtr -> do+            throwBotanIfNegative_ $ botan_pk_op_key_agreement+                kaPtr+                outPtr+                szPtr+                (ConstPtr keyPtr)+                keyLen+                (ConstPtr saltPtr)+                saltLen+        sz <- fromIntegral <$> peek szPtr+        return $! ByteString.take sz out

@@ -9,46 +9,51 @@ Portability : POSIX -} -module Botan.Low.PubKey.KeyEncapsulation-(+module Botan.Low.PubKey.KeyEncapsulation ( --- * PK Key Encapsulation--- $introduction--- * Usage--- $usage+  -- * PK Key Encapsulation+  -- $introduction+  -- * Usage+  -- $usage --- * KEM Encryption-  KEMSharedKey(..)-, KEMEncapsulatedKey(..)-, KEMEncrypt(..)-, withKEMEncrypt-, kemEncryptDestroy-, kemEncryptCreate-, kemEncryptSharedKeyLength-, kemEncryptEncapsulatedKeyLength-, kemEncryptCreateSharedKey+  -- * KEM Encryption+    KEMSharedKey+  , KEMEncapsulatedKey+  , KEMEncrypt(..)+  , withKEMEncrypt+  , kemEncryptDestroy+  , kemEncryptCreate+  , kemEncryptSharedKeyLength+  , kemEncryptEncapsulatedKeyLength+  , kemEncryptCreateSharedKey --- * KEM Decryption-, KEMDecrypt(..)-, withKEMDecrypt-, kemDecryptDestroy-, kemDecryptCreate-, kemDecryptSharedKeyLength-, kemDecryptSharedKey+  -- * KEM Decryption+  , KEMDecrypt(..)+  , withKEMDecrypt+  , kemDecryptDestroy+  , kemDecryptCreate+  , kemDecryptSharedKeyLength+  , kemDecryptSharedKey -) where+  ) where +import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.PubKey.KeyEncapsulation+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.KDF+import           Botan.Low.Make+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Botan.Low.RNG+import           Control.DeepSeq+import           Data.ByteString (ByteString) import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey.KeyEncapsulation--import Botan.Low.Error-import Botan.Low.KDF-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.PubKey-import Botan.Low.Remake-import Botan.Low.RNG+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  {- $introduction @@ -117,14 +122,13 @@  newtype KEMEncrypt = MkKEMEncrypt { getKEMEncryptForeignPtr :: ForeignPtr BotanPKOpKEMEncryptStruct } -newKEMEncrypt      :: BotanPKOpKEMEncrypt -> IO KEMEncrypt withKEMEncrypt     :: KEMEncrypt -> (BotanPKOpKEMEncrypt -> IO a) -> IO a kemEncryptDestroy  :: KEMEncrypt -> IO () createKEMEncrypt   :: (Ptr BotanPKOpKEMEncrypt -> IO CInt) -> IO KEMEncrypt-(newKEMEncrypt, withKEMEncrypt, kemEncryptDestroy, createKEMEncrypt, _)+(withKEMEncrypt, kemEncryptDestroy, createKEMEncrypt)     = mkBindings-        MkBotanPKOpKEMEncrypt runBotanPKOpKEMEncrypt-        MkKEMEncrypt getKEMEncryptForeignPtr+        MkBotanPKOpKEMEncrypt (.runBotanPKOpKEMEncrypt)+        MkKEMEncrypt (.getKEMEncryptForeignPtr)         botan_pk_op_kem_encrypt_destroy  @@ -142,10 +146,6 @@             pkPtr             (ConstPtr algoPtr) --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withKEMEncryptCreate :: PubKey -> KDFName -> (KEMEncrypt -> IO a) -> IO a-withKEMEncryptCreate = mkWithTemp2 kemEncryptCreate kemEncryptDestroy- kemEncryptSharedKeyLength     :: KEMEncrypt   -- ^ __op__     -> Int          -- ^ __desired_shared_key_length__@@ -193,14 +193,13 @@  newtype KEMDecrypt = MkKEMDecrypt { getKEMDecryptForeignPtr :: ForeignPtr BotanPKOpKEMDecryptStruct } -newKEMDecrypt      :: BotanPKOpKEMDecrypt -> IO KEMDecrypt withKEMDecrypt     :: KEMDecrypt -> (BotanPKOpKEMDecrypt -> IO a) -> IO a kemDecryptDestroy  :: KEMDecrypt -> IO () createKEMDecrypt   :: (Ptr BotanPKOpKEMDecrypt -> IO CInt) -> IO KEMDecrypt-(newKEMDecrypt, withKEMDecrypt, kemDecryptDestroy, createKEMDecrypt, _)+(withKEMDecrypt, kemDecryptDestroy, createKEMDecrypt)     = mkBindings-        MkBotanPKOpKEMDecrypt runBotanPKOpKEMDecrypt-        MkKEMDecrypt getKEMDecryptForeignPtr+        MkBotanPKOpKEMDecrypt (.runBotanPKOpKEMDecrypt)+        MkKEMDecrypt (.getKEMDecryptForeignPtr)         botan_pk_op_kem_decrypt_destroy  kemDecryptCreate@@ -213,10 +212,6 @@             out             skPtr             (ConstPtr algoPtr)---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withKEMDecryptCreate :: PrivKey -> KDFName -> (KEMDecrypt -> IO a) -> IO a-withKEMDecryptCreate = mkWithTemp2 kemDecryptCreate kemDecryptDestroy  kemDecryptSharedKeyLength     :: KEMDecrypt   -- ^ __op__

@@ -9,17 +9,19 @@ Portability : POSIX -} -module Botan.Low.PubKey.RSA where--import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey.RSA+module Botan.Low.PubKey.RSA (+    privKeyLoadRSA+  , privKeyLoadRSA_PKCS1+  , privKeyRSAGetPrivKey+  , pubKeyLoadRSA+  ) where -import Botan.Low.Error-import Botan.Low.Remake-import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey+import           Botan.Bindings.PubKey.RSA+import           Botan.Low.MPI+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Data.ByteString (ByteString)+import           Data.Word  -- /* -- * Algorithm specific key operations: RSA

@@ -1,11 +1,12 @@-module Botan.Low.PubKey.SM2 where--import Botan.Bindings.PubKey-import Botan.Bindings.PubKey.SM2+module Botan.Low.PubKey.SM2 (+    privKeyLoadSM2+  , pubKeyLoadSM2+  ) where -import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey+import           Botan.Bindings.PubKey.SM2+import           Botan.Low.MPI+import           Botan.Low.PubKey+import           Data.ByteString (ByteString)  privKeyLoadSM2     :: MP           -- ^ __scalar__

@@ -9,33 +9,39 @@ Portability : POSIX -} -module Botan.Low.PubKey.Sign-(+module Botan.Low.PubKey.Sign ( --- * Public key signatures-  Sign(..)-, SigningFlags(..)-, pattern StandardFormatSignature-, pattern DERFormatSignature-, withSign-, signCreate-, signDestroy-, signOutputLength-, signUpdate-, signFinish+  -- * Public key signatures+    Sign(..)+  , SigningFlags+  , pattern StandardFormatSignature+  , pattern DERFormatSignature+  , withSign+  , signCreate+  , signDestroy+  , signOutputLength+  , signUpdate+  , signFinish -) where+  ) where +import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.PubKey.Sign+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.Make+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Botan.Low.RNG+import           Control.DeepSeq+import           Data.ByteString (ByteString) import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey.Sign--import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.RNG-import Botan.Low.PubKey-import Botan.Low.Remake+import           Data.Word+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable  -- /* -- * Signature Generation@@ -43,19 +49,15 @@  newtype Sign = MkSign { getSignForeignPtr :: ForeignPtr BotanPKOpSignStruct } -newSign      :: BotanPKOpSign -> IO Sign withSign     :: Sign -> (BotanPKOpSign -> IO a) -> IO a signDestroy  :: Sign -> IO () createSign   :: (Ptr BotanPKOpSign -> IO CInt) -> IO Sign-(newSign, withSign, signDestroy, createSign, _)+(withSign, signDestroy, createSign)     = mkBindings-        MkBotanPKOpSign runBotanPKOpSign-        MkSign getSignForeignPtr+        MkBotanPKOpSign (.runBotanPKOpSign)+        MkSign (.getSignForeignPtr)         botan_pk_op_sign_destroy --- TODO: Rename SignAlgoParams / SigningParams-type SignAlgoName = ByteString- type SigningFlags = Word32  pattern StandardFormatSignature   -- ^ Not an actual flags@@ -76,10 +78,6 @@             skPtr             (ConstPtr algoPtr)             flags---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withSignCreate :: PrivKey -> EMSAName -> SigningFlags -> (Sign -> IO a) -> IO a-withSignCreate = mkWithTemp3 signCreate signDestroy  signOutputLength     :: Sign     -- ^ __op__

@@ -9,30 +9,29 @@ Portability : POSIX -} -module Botan.Low.PubKey.Verify-(---- * Public key signature verification-  Verify(..)-, withVerify-, verifyCreate-, verifyDestroy-, verifyUpdate-, verifyFinish--) where+module Botan.Low.PubKey.Verify ( -import qualified Data.ByteString as ByteString+  -- * Public key signature verification+    Verify(..)+  , withVerify+  , verifyCreate+  , verifyDestroy+  , verifyUpdate+  , verifyFinish -import Botan.Bindings.PubKey.Verify+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude-import Botan.Low.RNG-import Botan.Low.PubKey-import Botan.Low.PubKey.Sign (SigningFlags(..))-import Botan.Low.Remake+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.PubKey.Verify+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.PubKey+import           Botan.Low.PubKey.Sign (SigningFlags)+import           Botan.Low.Remake+import           Data.ByteString (ByteString)+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Ptr  -- /* -- * Signature Verification@@ -40,18 +39,15 @@  newtype Verify = MkVerify { getVerifyForeignPtr :: ForeignPtr BotanPKOpVerifyStruct } -newVerify      :: BotanPKOpVerify -> IO Verify withVerify     :: Verify -> (BotanPKOpVerify -> IO a) -> IO a verifyDestroy  :: Verify -> IO () createVerify   :: (Ptr BotanPKOpVerify -> IO CInt) -> IO Verify-(newVerify, withVerify, verifyDestroy, createVerify, _)+(withVerify, verifyDestroy, createVerify)     = mkBindings-        MkBotanPKOpVerify runBotanPKOpVerify-        MkVerify getVerifyForeignPtr+        MkBotanPKOpVerify (.runBotanPKOpVerify)+        MkVerify (.getVerifyForeignPtr)         botan_pk_op_verify_destroy -type VerifyAlgo = ByteString- verifyCreate     :: PubKey       -- ^ __key__     -> EMSAName     -- ^ __hash_and_padding__@@ -65,10 +61,6 @@             (ConstPtr algoPtr)             flags --- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withVerifyCreate :: PubKey -> EMSAName -> SigningFlags -> (Verify -> IO a) -> IO a-withVerifyCreate = mkWithTemp3 verifyCreate verifyDestroy- verifyUpdate     :: Verify       -- ^ __op__     -> ByteString   -- ^ __in[]__@@ -76,13 +68,14 @@ verifyUpdate = mkWithObjectSetterCBytesLen withVerify botan_pk_op_verify_update  -- TODO: Signature type-verifyFinish-    :: Verify       -- ^ __op__-    -> ByteString   -- ^ __sig[]__-    -> IO Bool-verifyFinish verify sig = withVerify verify $ \ verifyPtr -> do-    asBytesLen sig $ \ sigPtr sigLen -> do-        throwBotanCatchingSuccess $ botan_pk_op_verify_finish-            verifyPtr-            (ConstPtr sigPtr)-            sigLen+verifyFinish ::+     Verify       -- ^ __op__+  -> ByteString   -- ^ __sig[]__+  -> IO Bool+verifyFinish verify sig =+    withVerify verify $ \ verifyPtr ->+    asBytesLen sig $ \ sigPtr sigLen ->+    throwBotanCatchingInvalidVerifier $ botan_pk_op_verify_finish+      verifyPtr+      (ConstPtr sigPtr)+      sigLen

@@ -9,20 +9,19 @@ Portability : POSIX -} -module Botan.Low.PubKey.X25519 where--import qualified Data.ByteString as ByteString--import Botan.Bindings.PubKey--import Botan.Bindings.PubKey.X25519+module Botan.Low.PubKey.X25519 (+    privKeyLoadX25519+  , pubKeyLoadX25519+  , privKeyX25519GetPrivKey+  , pubKeyX25519GetPubKey+  ) where -import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.MPI-import Botan.Low.Prelude-import Botan.Low.PubKey-import Botan.Low.Remake+import           Botan.Bindings.PubKey.X25519+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.PubKey+import           Botan.Low.Remake+import           Data.ByteString (ByteString)  -- /* -- * Algorithm specific key operations: X25519

@@ -8,129 +8,224 @@ Stability   : experimental Portability : POSIX -Derive a key from a passphrase+This module is based on the [Password Based Key+Deriviation](https://botan.randombit.net/handbook/api_ref/pbkdf.html) section of+the C++ API reference. -} -module Botan.Low.PwdHash-(+module Botan.Low.PwdHash (+    pwdhash+  , pwdhashTimed+    -- * Available schemes+    -- $available-schemes+  , PBKDFName+  , pattern PBKDF2+  , pbkdf2+  , pattern Scrypt+  , pattern Argon2d+  , pattern Argon2i+  , pattern Argon2id+  , pattern Bcrypt_PBKDF+  , pattern OpenPGP_S2K+  , openPGP_S2K+  ) where --- * Password hashing+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.PwdHash+import           Botan.Low.Error.Internal+import           Botan.Low.Hash+import           Botan.Low.Internal.ByteString+import           Botan.Low.Internal.String+import           Data.ByteString (ByteString)+import           Foreign.Marshal.Alloc+import           Foreign.Storable -  PBKDFName(..)-, pwdhash-, pwdhashTimed+{- $setup+>>> import Botan.Low.Hash+-} --- * Password hashing algorithms+{-------------------------------------------------------------------------------+  Password hashing+-------------------------------------------------------------------------------} -, pattern PBKDF2-, pbkdf2-, pattern Scrypt-, pattern Argon2d-, pattern Argon2i-, pattern Argon2id-, pattern Bcrypt_PBKDF-, pattern OpenPGP_S2K-, openPGP_S2K+-- | Derive a cryptographic key from a passphrase using algorithm-specific parameters+--+-- NOTE: the interpretation of parameters @param1@, @param2@, and @param3@ are+-- different depending on the PBKDF algorithm that is picked. See the+-- documentation of the+-- [@from_params@](https://botan.randombit.net/handbook/api_ref/pbkdf.html#passwordhash)+-- C++ function for more information about the meaning of the parameters.+--+pwdhash ::+     PBKDFName     -- ^ __algo__: PBKDF algorithm, e.g., "Scrypt" or "PBKDF2(SHA-256)"+  -> Int           -- ^ __param1__: the first PBKDF algorithm parameter+  -> Int           -- ^ __param2__: the second PBKDF algorithm parameter (may be zero if unneeded)+  -> Int           -- ^ __param3__: the third PBKDF algorithm parameter (may be zero if unneeded)+  -> Int           -- ^ __out_len__: the desired length of the key to produce+  -> ByteString    -- ^ __passphrase__: the password to derive the key from+  -> ByteString    -- ^ __salt[]__: a randomly chosen salt+  -> IO ByteString -- ^ __out[]__: buffer to store the derived key, must be of out_len bytes+pwdhash algo p1 p2 p3 outLen passphrase salt =+    allocBytes outLen $ \ outPtr ->+    asCString algo $ \ algoPtr ->+    asCStringLen passphrase $ \ passphrasePtr passphraseLen ->+    asBytesLen salt $ \ saltPtr saltLen ->+      throwBotanIfNegative_ $ botan_pwdhash+        (ConstPtr algoPtr)+        (fromIntegral p1)+        (fromIntegral p2)+        (fromIntegral p3)+        outPtr+        (fromIntegral outLen)+        (ConstPtr passphrasePtr)+        passphraseLen+        (ConstPtr saltPtr)+        saltLen -) where+-- | Derive a cryptographic key from a passphrase using algorithm-specific+-- parameters that are tuned automatically for a desired running time of the+-- algorithm.+--+-- NOTE: for the @Argon2@ and @Scrypt@ PBKDF algorithms, 'pwdhashTimed' returns+-- parameters in a different order than the order in which they should be passed+-- to 'pwdhash'. This is a known issue with the Botan C++ library. See+-- <https://github.com/randombit/botan/issues/2144> for more information.+--+-- 'pwdhashTimed' always returns parameters in this order:+--+-- > (iterations, parallelism, memoryParam)+--+-- 'pwdhash' shoulds be given parameters in this order for the+-- @Argon2@ and @Scrypt@ algorithms:+--+-- > param1 = memoryParam+-- > param2 = iterations+-- > param3 = parallelism+--+pwdhashTimed ::+     -- | __algo__: PBKDF algorithm, e.g., "Scrypt" or "PBKDF2(SHA-256)"+    PBKDFName+     -- | __msec__: the desired runtime in milliseconds+  -> Int+     -- | __out_len__: the desired length of the key to produce+  -> Int+     -- | __passphrase__: the password to derive the key from+  -> ByteString+     -- | __salt[]__: a randomly chosen salt+  -> ByteString+     -- | A tuple of four elements (in order):+     --+     -- * __param1__: the first PBKDF algorithm parameter+     -- * __param2__: the second PBKDF algorithm parameter (may be zero if unneeded)+     -- * __param3__: the third PBKDF algorithm parameter (may be zero if unneeded)+     -- * __out[]__: buffer to store the derived key, must be of out_len bytes+  -> IO (Int, Int, Int, ByteString)+pwdhashTimed algo msec outLen passphrase salt =+    alloca $ \ p1Ptr ->+    alloca $ \ p2Ptr ->+    alloca $ \ p3Ptr -> do+      out <- allocBytes outLen $ \ outPtr ->+        asCString algo $ \ algoPtr ->+        asCStringLen passphrase $ \ passphrasePtr passphraseLen ->+        asBytesLen salt $ \ saltPtr saltLen -> do+          throwBotanIfNegative_ $ botan_pwdhash_timed+            (ConstPtr algoPtr)+            (fromIntegral msec)+            p1Ptr+            p2Ptr+            p3Ptr+            outPtr+            (fromIntegral outLen)+            (ConstPtr passphrasePtr)+            passphraseLen+            (ConstPtr saltPtr)+            saltLen+      p1 <- fromIntegral <$> peek p1Ptr+      p2 <- fromIntegral <$> peek p2Ptr+      p3 <- fromIntegral <$> peek p3Ptr+      return (p1, p2, p3, out) -import qualified Data.ByteString as ByteString+{-------------------------------------------------------------------------------+  Available schemes+-------------------------------------------------------------------------------} -import Botan.Bindings.PwdHash+{- $available-schemes -import Botan.Low.Hash-import Botan.Low.MAC-import Botan.Low.Error-import Botan.Low.Make-import Botan.Low.Prelude+A number of algorithms are available to be used as password derivation schemes.+An algorithm is selected by passing the /algorithm specification name/ of the+algorithm as a string to the password hashing functions. In some cases an+algorithm specification name is just the /algorithm name/, like @"Scrypt"@. In+other cases an algorithm specification name is a combination of an algorithm+name paired with some parameters, such as @"PKBDF2(SHA-256)"@ where @"PBKDF2"@+is the algorithm name followed by a single parameter. Pattern synonyms are+included for each available /algorithm name/. Where necessary, such as in the+@"PBKDF2"@ case, these algorithm names can be be manually extended to full+algorithm specification names, or by using utility functions like 'pbkdf2' that+this module also provides. +See the [Available+Schemes](https://botan.randombit.net/handbook/api_ref/pbkdf.html#available-schemes)+section of the C++ API reference for more information about available schemes.+-}++-- | The name of a key derivation scheme used as a PBKDF algorithm type PBKDFName = ByteString  pattern PBKDF2-    ,   Scrypt-    ,   Argon2d-    ,   Argon2i-    ,   Argon2id-    ,   Bcrypt_PBKDF-    ,   OpenPGP_S2K-    :: PBKDFName+      , Scrypt+      , Argon2d+      , Argon2i+      , Argon2id+      , Bcrypt_PBKDF+      , OpenPGP_S2K+      :: PBKDFName +-- |+-- >>> PBKDF2+-- "PBKDF2" pattern PBKDF2 = BOTAN_PBKDF_PBKDF2++-- |+-- >>> pbkdf2 SHA256+-- "PBKDF2(SHA-256)"+--+-- NOTE: "PBKDF(HMAC(SHA-256))" is equivalent to "PBKDF(SHA-256)". 'pbkdf2'+-- always outputs the latter given a hash function name.+pbkdf2 :: HashName -> PBKDFName+pbkdf2 m = PBKDF2 /$ m++-- |+-- >>> Scrypt+-- "Scrypt" pattern Scrypt = BOTAN_PBKDF_SCRYPT++-- |+-- >>> Argon2d+-- "Argon2d" pattern Argon2d = BOTAN_PBKDF_ARGON2D++-- |+-- >>> Argon2i+-- "Argon2i" pattern Argon2i = BOTAN_PBKDF_ARGON2I++-- |+-- >>> Argon2id+-- "Argon2id" pattern Argon2id = BOTAN_PBKDF_ARGON2ID++-- |+-- >>> Bcrypt_PBKDF+-- "Bcrypt-PBKDF" pattern Bcrypt_PBKDF = BOTAN_PBKDF_BCRYPT_PBKDF-pattern OpenPGP_S2K = BOTAN_PBKDF_OPENPGP_S2K --- NOTE: May require HMAC-pbkdf2 :: MACName -> PBKDFName-pbkdf2 m = PBKDF2 /$ m+-- |+-- >>> OpenPGP_S2K+-- "OpenPGP-S2K"+pattern OpenPGP_S2K = BOTAN_PBKDF_OPENPGP_S2K +-- |+-- >>> openPGP_S2K SHA256+-- "OpenPGP-S2K(SHA-256)" openPGP_S2K:: HashName -> PBKDFName openPGP_S2K h = OpenPGP_S2K /$ h---- NOTE: Should passphrase be Text or ByteString? Text is implied by use of const char*---  as well as the non-null context implied by passphrase_len == 0. ByteString for now.---- | Password hash------ 'pwdhash' and 'pwdhashTimed'\'s parameter order may be inconsistent.  See--- botan-low\/test\/Botan\/Low\/PwdHashSpec.hs for more information.-pwdhash-    :: PBKDFName        -- ^ __algo__: PBKDF algorithm, e.g., "Scrypt" or "PBKDF2(SHA-256)"-    -> Int              -- ^ __param1__: the first PBKDF algorithm parameter-    -> Int              -- ^ __param2__: the second PBKDF algorithm parameter (may be zero if unneeded)-    -> Int              -- ^ __param3__: the third PBKDF algorithm parameter (may be zero if unneeded)-    -> Int              -- ^ __out_len__: the desired length of the key to produce-    -> ByteString       -- ^ __passphrase__: the password to derive the key from-    -> ByteString       -- ^ __salt[]__: a randomly chosen salt-    -> IO ByteString    -- ^ __out[]__: buffer to store the derived key, must be of out_len bytes-pwdhash algo p1 p2 p3 outLen passphrase salt = allocBytes outLen $ \ outPtr -> do-    asCString algo $ \ algoPtr -> do-        asCStringLen passphrase $ \ passphrasePtr passphraseLen -> do-            asBytesLen salt $ \ saltPtr saltLen -> do-                throwBotanIfNegative_ $ botan_pwdhash-                    (ConstPtr algoPtr)-                    (fromIntegral p1)-                    (fromIntegral p2)-                    (fromIntegral p3)-                    outPtr-                    (fromIntegral outLen)-                    (ConstPtr passphrasePtr)-                    passphraseLen-                    (ConstPtr saltPtr)-                    saltLen---- | Timed password hash------ 'pwdhash' and 'pwdhashTimed'\'s parameter order may be inconsistent. See--- botan-low\/test\/Botan\/Low\/PwdHashSpec.hs for more information.-pwdhashTimed-    :: PBKDFName                    -- ^ __algo__: PBKDF algorithm, e.g., "Scrypt" or "PBKDF2(SHA-256)"-    -> Int                          -- ^ __msec__: the desired runtime in milliseconds-    -> Int                          -- ^ __out_len__: the desired length of the key to produce-    -> ByteString                   -- ^ __passphrase__: the password to derive the key from-    -> ByteString                   -- ^ __salt[]__: a randomly chosen salt-    -> IO (Int,Int,Int,ByteString)  -- ^ __out[]__: buffer to store the derived key, must be of out_len bytes-pwdhashTimed algo msec outLen passphrase salt = alloca $ \ p1Ptr -> alloca $ \ p2Ptr -> alloca $ \ p3Ptr -> do-    out <- allocBytes outLen $ \ outPtr -> do-        asCString algo $ \ algoPtr -> do-            asCStringLen passphrase $ \ passphrasePtr passphraseLen -> do-                asBytesLen salt $ \ saltPtr saltLen -> do-                    throwBotanIfNegative_ $ botan_pwdhash_timed-                        (ConstPtr algoPtr)-                        (fromIntegral msec)-                        p1Ptr-                        p2Ptr-                        p3Ptr-                        outPtr-                        (fromIntegral outLen)-                        (ConstPtr passphrasePtr)-                        passphraseLen-                        (ConstPtr saltPtr)-                        saltLen-    p1 <- fromIntegral <$> peek p1Ptr-    p2 <- fromIntegral <$> peek p2Ptr-    p3 <- fromIntegral <$> peek p3Ptr-    return (p1,p2,p3,out)

@@ -11,43 +11,43 @@ Pseudo-random number generation. -} -module Botan.Low.RNG-(---- * Random number generators--- $introduction---- * Usage--- $usage+module Botan.Low.RNG ( -  RNG(..)-, RNGType(..)-, withRNG-, rngInit-, rngDestroy-, rngGet-, systemRNGGet-, rngReseed-, rngReseedFromRNG-, rngAddEntropy+  -- * Random number generators+  -- $introduction --- * RNG Types+  -- * Usage+  -- $usage -, pattern SystemRNG-, pattern UserRNG-, pattern UserThreadsafeRNG-, pattern RDRandRNG+    RNG(..)+  , RNGType+  , withRNG+  , rngInit+  , rngDestroy+  , rngGet+  , systemRNGGet+  , rngReseed+  , rngReseedFromRNG+  , rngAddEntropy -) where+  -- * RNG Types -import qualified Data.ByteString as ByteString+  , pattern SystemRNG+  , pattern UserRNG+  , pattern UserThreadsafeRNG+  , pattern RDRandRNG -import Botan.Bindings.RNG+  ) where -import Botan.Low.Error ( throwBotanIfNegative_ )-import Botan.Low.Make ( mkWithTemp1 )-import Botan.Low.Remake-import Botan.Low.Prelude+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Bindings.RNG+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.Remake+import           Data.ByteString (ByteString)+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Ptr  {- $introduction @@ -92,13 +92,12 @@  newtype RNG = MkRNG { getRNGForeignPtr :: ForeignPtr BotanRNGStruct } -newRNG      :: BotanRNG -> IO RNG withRNG     :: RNG -> (BotanRNG -> IO a) -> IO a -- | Destroy a random number generator object immediately rngDestroy  :: RNG -> IO () createRNG   :: (Ptr BotanRNG -> IO CInt) -> IO RNG-(newRNG, withRNG, rngDestroy, createRNG, _)-    = mkBindings MkBotanRNG runBotanRNG MkRNG getRNGForeignPtr botan_rng_destroy+(withRNG, rngDestroy, createRNG)+    = mkBindings MkBotanRNG (.runBotanRNG) MkRNG (.getRNGForeignPtr) botan_rng_destroy  type RNGType = ByteString @@ -128,10 +127,6 @@     :: RNGType  -- ^ __rng_type__: type of the rng     -> IO RNG   -- ^ __rng__ rngInit = mkCreateObjectCString createRNG botan_rng_init---- WARNING: withFooInit-style limited lifetime functions moved to high-level botan-withRNGInit :: RNGType -> (RNG -> IO a) -> IO a-withRNGInit = mkWithTemp1 rngInit rngDestroy  -- | Get random bytes from a random number generator rngGet

@@ -11,82 +11,33 @@ Generate low-level bindings automatically -} -module Botan.Low.Remake-( mkBindings-, mkCreateObject-, mkCreateObjects-, mkCreateObjectWith-, mkCreateObjectCString-, mkCreateObjectCString1-, mkCreateObjectCBytes-, mkCreateObjectCBytesLen-, mkCreateObjectCBytesLen1-, mkWithObjectAction-, mkWithObjectGetterCBytesLen-, mkWithObjectGetterCBytesLen1-, mkWithObjectSetterCString-, mkWithObjectSetterCBytesLen-) where--import Botan.Low.Prelude-import Botan.Low.Error--import qualified Data.ByteString.Internal as ByteString--import Botan.Low.Make (allocBytesQuerying)---- ByteString Helpers---- NOTE: Was allocBytes-createByteString :: Int -> (Ptr byte -> IO ()) -> IO ByteString-createByteString sz f = ByteString.create sz (f . castPtr)---- NOTE: Was allocBytesWith--- createByteString' :: Int -> (Ptr byte -> IO a) -> IO (a, ByteString)---- NOTE: Was allocBytesQuerying--- createByteStringQuerying :: (Ptr byte -> Ptr CSize -> IO CInt) -> IO ByteString--- createByteStringQuerying fn = do---     alloca $ \ szPtr -> do---         -- TODO: Maybe poke szPtr 0 for extra safety in cas its not initially zero---         code <- fn nullPtr szPtr---         case code of---             InsufficientBufferSpace -> do---                 sz <- fromIntegral <$> peek szPtr---                 allocBytes sz $ \ outPtr -> throwBotanIfNegative_ $ fn outPtr szPtr---             _                       -> do---                 throwBotanError code---- NOTE: Was allocBytesQueryingCString--- NOTE: Does not check length of taken string, vulnerable to null byte injection--- createByteStringQueryingCString :: (Ptr byte -> Ptr CSize -> IO CInt) -> IO ByteString--- createByteStringQueryingCString action = do---     cstring <- allocBytesQuerying action---     return $!! ByteString.takeWhile (/= 0) cstring-------- type NewObject      object botan = botan -> IO object--- type WithObject     object botan = (forall a . object -> (botan -> IO a) -> IO a)--- type DestroyObject  object botan = object -> IO ()--- type CreateObject   object botan = (Ptr botan -> IO CInt) -> IO object--- type CreateObjects  object botan = (Ptr botan -> Ptr CSize -> IO CInt) -> IO object---- Example usage-{--newtype RNG = MkRNG { getRNGForeignPtr :: ForeignPtr BotanRNGStruct }+module Botan.Low.Remake (+    mkBindings+  , mkCreateObject+  , mkCreateObjectWith+  , mkCreateObjectCString+  , mkCreateObjectCString1+  , mkCreateObjectCBytes+  , mkCreateObjectCBytesLen+  , mkWithObjectAction+  , mkWithObjectGetterCBytesLen1+  , mkWithObjectSetterCBytesLen+  ) where -newRNG      :: BotanRNG -> IO RNG-withRNG     :: RNG -> (BotanRNG -> IO a) -> IO a-rngDestroy  :: RNG -> IO ()-createRNG   :: (Ptr BotanRNG -> IO CInt) -> IO RNG-(newRNG, withRNG, rngDestroy, createRNG, _)-    = mkBindings MkBotanRNG runBotanRNG MkRNG getRNGForeignPtr botan_rng_destroy+import           Botan.Bindings.ConstPtr (ConstPtr (..))+import           Botan.Low.Error.Internal+import           Botan.Low.Internal.ByteString+import           Botan.Low.Make+import           Control.Exception+import           Data.ByteString (ByteString)+import           Data.Word+import           Foreign.C.Types+import           Foreign.ForeignPtr+import           Foreign.Marshal.Alloc+import           Foreign.Ptr+import           Foreign.Storable+import           Prelude hiding (init) -rngInit :: RNGType -> IO RNG-rngInit name = asCString name $ \ namePtr -> do-    createRNG $ \ outPtr -> botan_rng_init outPtr (ConstPtr namePtr)--} mkBindings     ::  (Storable botan)     =>  (Ptr struct -> botan)                                   -- mkBotan@@ -94,14 +45,12 @@     ->  (ForeignPtr struct -> object)                           -- mkForeign     ->  (object -> ForeignPtr struct)                           -- runForeign     ->  FinalizerPtr struct                                     -- destroy / finalizer-    ->  (   botan -> IO object                                  -- newObject-        ,   object -> (botan -> IO a) -> IO a                   -- withObject+    ->  (   object -> (botan -> IO a) -> IO a                   -- withObject         ,   object -> IO ()                                     -- destroyObject         ,   (Ptr botan -> IO CInt) -> IO object                 -- createObject-        ,   (Ptr botan -> Ptr CSize -> IO CInt) -> IO [object]  -- createObjects         ) mkBindings mkBotan runBotan mkForeign runForeign destroy = bindings where-    bindings = (newObject, withObject, objectDestroy, createObject, createObjects)+    bindings = (withObject, objectDestroy, createObject)     newObject botan = do         foreignPtr <- newForeignPtr destroy (runBotan botan)         return $ mkForeign foreignPtr@@ -112,7 +61,6 @@     --      objectFinalize obj = new stable foreign ptr ... destroy     --      objectDestroy obj = withObject obj destroy     createObject = mkCreateObject newObject-    createObjects = mkCreateObjects newObject  {- Create functions@@ -129,23 +77,6 @@         out <- peek outPtr         newObject out --- TODO: Rename mkCreates-mkCreateObjects-    :: (Storable botan)-    => (botan -> IO object)-    -> (Ptr botan -> Ptr CSize -> IO CInt)-    -> IO [object]-mkCreateObjects newObject inits = mask_ $ alloca $ \ szPtr -> do-        code <- inits nullPtr szPtr-        case code of-            InsufficientBufferSpace -> do-                sz <- fromIntegral <$> peek szPtr-                allocaArray sz $ \ arrPtr -> do-                    throwBotanIfNegative_ $ inits arrPtr szPtr-                    outs <- peekArray sz arrPtr-                    forM outs newObject-            _ -> throwBotanError code- mkCreateObjectWith     :: ((Ptr botan -> IO CInt) -> IO object)     -> (arg -> (carg -> IO object) -> IO object)@@ -164,6 +95,8 @@ -- mkCreateObjectCString createObject init cstr = withCString cstr $ \ namePtr -> do --     createObject $ \ outPtr -> init outPtr (ConstPtr namePtr) mkCreateObjectCString createObject = mkCreateObjectWith createObject withConstCString+  where+    withConstCString bs k = withCString bs $ \ptr -> k (ConstPtr ptr)  -- TODO: Rename mkCreateCString1 mkCreateObjectCString1@@ -195,15 +128,6 @@ mkCreateObjectCBytesLen createObject init bytes = withCBytesLen bytes $ \ (cbytes,len) -> do     createObject $ \ out -> init out (ConstPtr cbytes) (fromIntegral len) -mkCreateObjectCBytesLen1-    :: ((Ptr botan -> IO CInt) -> IO object)-    -> (Ptr botan -> ConstPtr Word8 -> CSize -> a -> IO CInt)-    -> ByteString-    -> a-    -> IO object-mkCreateObjectCBytesLen1 createObject init bytes a = withCBytesLen bytes $ \ (cbytes,len) -> do-    createObject $ \ out -> init out (ConstPtr cbytes) (fromIntegral len) a- {- Action -}@@ -222,20 +146,8 @@ -}  -- TODO: getter parameter order may be improper - switch up if problematic-mkWithObjectGetterCBytesLen-    :: (forall a . object -> (botan -> IO a) -> IO a)-    -> (botan -> Ptr Word8 -> Ptr CSize -> IO CInt)-    -> object-    -> IO ByteString-mkWithObjectGetterCBytesLen withObject getter obj = withObject obj $ \ cobj -> do-    allocBytesQuerying $ \ outPtr outLen -> getter-        cobj-        outPtr-        outLen---- TODO: getter parameter order may be improper - switch up if problematic mkWithObjectGetterCBytesLen1-    :: (forall a . object -> (botan -> IO a) -> IO a)+    :: (forall b . object -> (botan -> IO b) -> IO b)     -> (botan -> a -> Ptr Word8 -> Ptr CSize -> IO CInt)     -> object     -> a@@ -251,22 +163,11 @@ Setters -} --- TODO: Rename mkSetterCString-mkWithObjectSetterCString-    :: (forall a . object -> (botan -> IO a) -> IO a)-    -> (botan -> ConstPtr CChar -> IO BotanErrorCode)-    -> object-    -> ByteString-    -> IO ()-mkWithObjectSetterCString withObject setter obj str = withObject obj $ \ cobj -> do-    withCString str $ \ cstr -> do-        throwBotanIfNegative_ $ setter cobj (ConstPtr cstr)- -- Replaces mkSetBytesLen -- TODO: Rename mkSetterCBytesLen mkWithObjectSetterCBytesLen     :: (forall a . object -> (botan -> IO a) -> IO a)-    -> (botan -> ConstPtr Word8 -> CSize -> IO BotanErrorCode)+    -> (botan -> ConstPtr Word8 -> CSize -> IO CInt)     -> object     -> ByteString     -> IO ()