Merge pull request #4698 from input-output-hk/jordan/move-cli-signing…

…-key-reading-to-api Move signing key reading to cardano-api
IntersectMBO · Dec 19, 2022 · f24d5b1 · f24d5b1
2 parents 3ffd819 + 45557f4
commit f24d5b1
Show file tree

Hide file tree

Showing 29 changed files with 159 additions and 188 deletions.
diff --git a/cardano-api/cardano-api.cabal b/cardano-api/cardano-api.cabal
@@ -70,10 +70,11 @@ library
                         Cardano.Api.IPC.Monad
                         Cardano.Api.InMode
                         Cardano.Api.Json
-                        Cardano.Api.Key
-                        Cardano.Api.KeysByron
-                        Cardano.Api.KeysPraos
-                        Cardano.Api.KeysShelley
+                        Cardano.Api.Keys.Byron
+                        Cardano.Api.Keys.Class
+                        Cardano.Api.Keys.Praos
+                        Cardano.Api.Keys.Read
+                        Cardano.Api.Keys.Shelley
                         Cardano.Api.LedgerEvent
                         Cardano.Api.LedgerState
                         Cardano.Api.Modes

diff --git a/cardano-api/src/Cardano/Api.hs b/cardano-api/src/Cardano/Api.hs
@@ -512,10 +512,17 @@ module Cardano.Api (
     TextEnvelopeCddlError(..),
 
     -- *** Reading one of several key types
+    readKeyFile,
+    readKeyFileTextEnvelope,
+    readKeyFileAnyOf,
+
+    -- *** Read one of several types
     FromSomeType(..),
     deserialiseFromTextEnvelopeAnyOf,
     readFileTextEnvelopeAnyOf,
 
+
+
     -- * Errors
     Error(..),
     throwErrorAsException,
@@ -750,9 +757,10 @@ import           Cardano.Api.HasTypeProxy
 import           Cardano.Api.InMode
 import           Cardano.Api.IPC
 import           Cardano.Api.IPC.Monad
-import           Cardano.Api.Key
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Class
+import           Cardano.Api.Keys.Read
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.LedgerEvent
 import           Cardano.Api.LedgerState
 import           Cardano.Api.Modes

diff --git a/cardano-api/src/Cardano/Api/Address.hs b/cardano-api/src/Cardano/Api/Address.hs
@@ -102,9 +102,9 @@ import           Cardano.Api.EraCast
 import           Cardano.Api.Eras
 import           Cardano.Api.Hash
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.Key
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Class
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.NetworkId
 import           Cardano.Api.Script
 import           Cardano.Api.SerialiseBech32

diff --git a/cardano-api/src/Cardano/Api/Block.hs b/cardano-api/src/Cardano/Api/Block.hs
@@ -83,7 +83,7 @@ import qualified Cardano.Ledger.Era as Ledger
 import           Cardano.Api.Eras
 import           Cardano.Api.Hash
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.Modes
 import           Cardano.Api.SerialiseRaw
 import           Cardano.Api.SerialiseUsing

diff --git a/cardano-api/src/Cardano/Api/Byron.hs b/cardano-api/src/Cardano/Api/Byron.hs
@@ -89,7 +89,7 @@ module Cardano.Api.Byron
 import           Cardano.Api
 import           Cardano.Api.Address
 import           Cardano.Api.IPC
-import           Cardano.Api.KeysByron
+import           Cardano.Api.Keys.Byron
 import           Cardano.Api.NetworkId
 import           Cardano.Api.SpecialByron
 import           Cardano.Api.Tx

diff --git a/cardano-api/src/Cardano/Api/Certificate.hs b/cardano-api/src/Cardano/Api/Certificate.hs
@@ -64,9 +64,9 @@ import qualified Cardano.Ledger.Shelley.TxBody as Shelley
 import           Cardano.Api.Address
 import           Cardano.Api.HasTypeProxy
 import           Cardano.Api.Hash
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysPraos
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Praos
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseTextEnvelope
 import           Cardano.Api.StakePoolMetadata

diff --git a/cardano-api/src/Cardano/Api/DeserialiseAnyOf.hs b/cardano-api/src/Cardano/Api/DeserialiseAnyOf.hs
@@ -42,10 +42,10 @@ import           Cardano.Api.SerialiseTextEnvelope
 
 -- TODO: Think about if these belong
 import           Cardano.Api.Address
-import           Cardano.Api.Key
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysPraos
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Class
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Praos
+import           Cardano.Api.Keys.Shelley
 
 ------------------------------------------------------------------------------
 -- Formatted/encoded input deserialisation

diff --git a/cardano-api/src/Cardano/Api/KeysByron.hs → cardano-api/src/Cardano/Api/Keys/Byron.hs b/cardano-api/src/Cardano/Api/KeysByron.hs → cardano-api/src/Cardano/Api/Keys/Byron.hs
@@ -10,7 +10,7 @@
 
 -- | Byron key types and their 'Key' class instances
 --
-module Cardano.Api.KeysByron (
+module Cardano.Api.Keys.Byron (
 
     -- * Key types
     ByronKey,
@@ -54,8 +54,8 @@ import qualified Cardano.Crypto.Wallet as Wallet
 
 import           Cardano.Api.HasTypeProxy
 import           Cardano.Api.Hash
-import           Cardano.Api.Key
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Class
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseRaw
 import           Cardano.Api.SerialiseTextEnvelope

diff --git a/cardano-api/src/Cardano/Api/Key.hs → cardano-api/src/Cardano/Api/Keys/Class.hs b/cardano-api/src/Cardano/Api/Key.hs → cardano-api/src/Cardano/Api/Keys/Class.hs
@@ -2,7 +2,7 @@
 {-# LANGUAGE MultiParamTypeClasses #-}
 {-# LANGUAGE TypeFamilies #-}
 
-module Cardano.Api.Key
+module Cardano.Api.Keys.Class
   ( Key(..)
   , generateSigningKey
   , generateInsecureSigningKey

diff --git a/cardano-api/src/Cardano/Api/KeysPraos.hs → cardano-api/src/Cardano/Api/Keys/Praos.hs b/cardano-api/src/Cardano/Api/KeysPraos.hs → cardano-api/src/Cardano/Api/Keys/Praos.hs
@@ -9,7 +9,7 @@
 
 -- | Praos consensus key types and their 'Key' class instances
 --
-module Cardano.Api.KeysPraos (
+module Cardano.Api.Keys.Praos (
 
     -- * Key types
     KesKey,
@@ -36,7 +36,7 @@ import           Cardano.Ledger.Crypto (StandardCrypto)
 
 import           Cardano.Api.HasTypeProxy
 import           Cardano.Api.Hash
-import           Cardano.Api.Key
+import           Cardano.Api.Keys.Class
 import           Cardano.Api.SerialiseBech32
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseRaw

diff --git a/cardano-api/src/Cardano/Api/Keys/Read.hs b/cardano-api/src/Cardano/Api/Keys/Read.hs
@@ -0,0 +1,87 @@
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE RankNTypes #-}
+{-# LANGUAGE TypeFamilies #-}
+
+module Cardano.Api.Keys.Read
+  ( readKeyFile
+  , readKeyFileTextEnvelope
+  , readKeyFileAnyOf
+  ) where
+
+import           Prelude
+
+import           Control.Exception
+import           Data.Bifunctor
+import           Data.ByteString as BS
+import           Data.List.NonEmpty (NonEmpty)
+
+import           Cardano.Api.DeserialiseAnyOf
+import           Cardano.Api.Error
+import           Cardano.Api.HasTypeProxy
+import           Cardano.Api.SerialiseBech32
+import           Cardano.Api.SerialiseTextEnvelope
+import           Cardano.Api.Utils
+
+-- | Read a cryptographic key from a file.
+--
+-- The contents of the file can either be Bech32-encoded, hex-encoded, or in
+-- the text envelope format.
+readKeyFile
+  :: AsType a
+  -> NonEmpty (InputFormat a)
+  -> FilePath
+  -> IO (Either (FileError InputDecodeError) a)
+readKeyFile asType acceptedFormats path = do
+  eContent <- fmap Right (readFileBlocking path) `catches` [Handler handler]
+  case eContent of
+    Left e -> return $ Left e
+    Right content ->
+      return . first (FileError path) $ deserialiseInput asType acceptedFormats content
+ where
+  handler :: IOException -> IO (Either (FileError InputDecodeError) BS.ByteString)
+  handler e = return . Left $ FileIOError path e
+
+-- | Read a cryptographic key from a file.
+--
+-- The contents of the file must be in the text envelope format.
+readKeyFileTextEnvelope
+  :: HasTextEnvelope a
+  => AsType a
+  -> FilePath
+  -> IO (Either (FileError InputDecodeError) a)
+readKeyFileTextEnvelope asType fp =
+    first toInputDecodeError <$> readFileTextEnvelope asType fp
+  where
+    toInputDecodeError
+      :: FileError TextEnvelopeError
+      -> FileError InputDecodeError
+    toInputDecodeError err =
+      case err of
+        FileIOError path ex -> FileIOError path ex
+        FileError path textEnvErr ->
+          FileError path (InputTextEnvelopeError textEnvErr)
+        FileErrorTempFile targetP tempP h ->
+          FileErrorTempFile targetP tempP h
+
+-- | Read a cryptographic key from a file given that it is one of the provided
+-- types.
+--
+-- The contents of the file can either be Bech32-encoded or in the text
+-- envelope format.
+readKeyFileAnyOf
+  :: forall b.
+     [FromSomeType SerialiseAsBech32 b]
+  -> [FromSomeType HasTextEnvelope b]
+  -> FilePath
+  -> IO (Either (FileError InputDecodeError) b)
+readKeyFileAnyOf bech32Types textEnvTypes path = do
+  eContent <- fmap Right (readFileBlocking path) `catches` [Handler handler]
+  case eContent of
+    Left e -> return $ Left e
+    Right content ->
+      return . first (FileError path) $ deserialiseInputAnyOf bech32Types textEnvTypes content
+ where
+  handler :: IOException -> IO (Either (FileError InputDecodeError) BS.ByteString)
+  handler e = return . Left $ FileIOError path e
+
diff --git a/cardano-api/src/Cardano/Api/KeysShelley.hs → cardano-api/src/Cardano/Api/Keys/Shelley.hs b/cardano-api/src/Cardano/Api/KeysShelley.hs → cardano-api/src/Cardano/Api/Keys/Shelley.hs
@@ -14,7 +14,7 @@
 
 -- | Shelley key types and their 'Key' class instances
 --
-module Cardano.Api.KeysShelley (
+module Cardano.Api.Keys.Shelley (
 
     -- * Key types
     PaymentKey,
@@ -56,7 +56,7 @@ import           Cardano.Ledger.Crypto (StandardCrypto)
 import           Cardano.Api.Error
 import           Cardano.Api.Hash
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.Key
+import           Cardano.Api.Keys.Class
 import           Cardano.Api.SerialiseBech32
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseJSON

diff --git a/cardano-api/src/Cardano/Api/LedgerEvent.hs b/cardano-api/src/Cardano/Api/LedgerEvent.hs
@@ -19,7 +19,7 @@ where
 import           Cardano.Api.Address (StakeCredential, fromShelleyStakeCredential)
 import           Cardano.Api.Block (EpochNo)
 import           Cardano.Api.Certificate (Certificate)
-import           Cardano.Api.KeysShelley (Hash (StakePoolKeyHash), StakePoolKey)
+import           Cardano.Api.Keys.Shelley (Hash (StakePoolKeyHash), StakePoolKey)
 import           Cardano.Api.Value (Lovelace, fromShelleyDeltaLovelace, fromShelleyLovelace)
 import qualified Cardano.Ledger.Coin as Ledger
 import qualified Cardano.Ledger.Core as Ledger.Core

diff --git a/cardano-api/src/Cardano/Api/LedgerState.hs b/cardano-api/src/Cardano/Api/LedgerState.hs
@@ -99,7 +99,7 @@ import           Cardano.Api.IPC (ConsensusModeParams (..),
                    LocalChainSyncClient (LocalChainSyncClientPipelined),
                    LocalNodeClientProtocols (..), LocalNodeClientProtocolsInMode,
                    LocalNodeConnectInfo (..), connectToLocalNode)
-import           Cardano.Api.KeysPraos
+import           Cardano.Api.Keys.Praos
 import           Cardano.Api.LedgerEvent (LedgerEvent, toLedgerEvent)
 import           Cardano.Api.Modes (CardanoMode, EpochSlots (..))
 import qualified Cardano.Api.Modes as Api

diff --git a/cardano-api/src/Cardano/Api/OperationalCertificate.hs b/cardano-api/src/Cardano/Api/OperationalCertificate.hs
@@ -30,10 +30,10 @@ import           Cardano.Api.Address
 import           Cardano.Api.Certificate
 import           Cardano.Api.Error
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.Key
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysPraos
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Class
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Praos
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.ProtocolParameters
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseTextEnvelope

diff --git a/cardano-api/src/Cardano/Api/ProtocolParameters.hs b/cardano-api/src/Cardano/Api/ProtocolParameters.hs
@@ -112,8 +112,8 @@ import           Cardano.Api.Eras
 import           Cardano.Api.Error
 import           Cardano.Api.Hash
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.Script
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseRaw

diff --git a/cardano-api/src/Cardano/Api/Query.hs b/cardano-api/src/Cardano/Api/Query.hs
@@ -120,7 +120,7 @@ import           Cardano.Api.Certificate
 import           Cardano.Api.EraCast
 import           Cardano.Api.Eras
 import           Cardano.Api.GenesisParameters
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.Modes
 import           Cardano.Api.NetworkId
 import           Cardano.Api.Orphans ()

diff --git a/cardano-api/src/Cardano/Api/Script.hs b/cardano-api/src/Cardano/Api/Script.hs
@@ -159,7 +159,7 @@ import           Cardano.Api.Eras
 import           Cardano.Api.Error
 import           Cardano.Api.Hash
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.ScriptData
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseJSON

diff --git a/cardano-api/src/Cardano/Api/ScriptData.hs b/cardano-api/src/Cardano/Api/ScriptData.hs
@@ -72,7 +72,7 @@ import           Cardano.Api.Eras
 import           Cardano.Api.Error
 import           Cardano.Api.HasTypeProxy
 import           Cardano.Api.Hash
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseJSON
 import           Cardano.Api.SerialiseRaw

diff --git a/cardano-api/src/Cardano/Api/Shelley.hs b/cardano-api/src/Cardano/Api/Shelley.hs
@@ -238,9 +238,9 @@ import           Cardano.Api.Eras
 import           Cardano.Api.Genesis
 import           Cardano.Api.InMode
 import           Cardano.Api.IPC
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysPraos
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Praos
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.LedgerState
 import           Cardano.Api.NetworkId
 import           Cardano.Api.OperationalCertificate

diff --git a/cardano-api/src/Cardano/Api/SpecialByron.hs b/cardano-api/src/Cardano/Api/SpecialByron.hs
@@ -24,7 +24,7 @@ import           Data.Word
 import           Numeric.Natural
 
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.KeysByron
+import           Cardano.Api.Keys.Byron
 import           Cardano.Api.NetworkId (NetworkId, toByronProtocolMagicId)
 import           Cardano.Api.SerialiseRaw
 

diff --git a/cardano-api/src/Cardano/Api/StakePoolMetadata.hs b/cardano-api/src/Cardano/Api/StakePoolMetadata.hs
@@ -32,9 +32,9 @@ import           Cardano.Api.Eras
 import           Cardano.Api.Error
 import           Cardano.Api.Hash
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.Key
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysPraos
+import           Cardano.Api.Keys.Class
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Praos
 import           Cardano.Api.Script
 import           Cardano.Api.SerialiseJSON
 import           Cardano.Api.SerialiseRaw

diff --git a/cardano-api/src/Cardano/Api/Tx.hs b/cardano-api/src/Cardano/Api/Tx.hs
@@ -109,9 +109,9 @@ import           Cardano.Api.Address
 import           Cardano.Api.Certificate
 import           Cardano.Api.Eras
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.Key
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Class
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.NetworkId
 import           Cardano.Api.SerialiseCBOR
 import           Cardano.Api.SerialiseTextEnvelope

diff --git a/cardano-api/src/Cardano/Api/TxBody.hs b/cardano-api/src/Cardano/Api/TxBody.hs
@@ -259,8 +259,8 @@ import           Cardano.Api.Eras
 import           Cardano.Api.Error
 import           Cardano.Api.Hash
 import           Cardano.Api.HasTypeProxy
-import           Cardano.Api.KeysByron
-import           Cardano.Api.KeysShelley
+import           Cardano.Api.Keys.Byron
+import           Cardano.Api.Keys.Shelley
 import           Cardano.Api.NetworkId
 import           Cardano.Api.ProtocolParameters
 import           Cardano.Api.Script

diff --git a/cardano-api/test/Test/Cardano/Api/KeysByron.hs b/cardano-api/test/Test/Cardano/Api/KeysByron.hs
@@ -4,7 +4,7 @@ module Test.Cardano.Api.KeysByron
   ( tests
   ) where
 
-import           Cardano.Api (AsType(AsByronKey, AsSigningKey), Key(deterministicSigningKey))
+import           Cardano.Api (AsType (AsByronKey, AsSigningKey), Key (deterministicSigningKey))
 import           Cardano.Prelude ((<$>))
 import           Gen.Hedgehog.Roundtrip.CBOR (roundtrip_CBOR)
 import           Hedgehog (Property)