Skip to content

Fix encryptedDerivePublic to return Either instead of throwing on har… #687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lehins merged 2 commits into from
Jul 13, 2026
Merged

Fix encryptedDerivePublic to return Either instead of throwing on har… #687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4524878
Fix encryptedDerivePublic to return Either instead of throwing on har…
disassembler Jul 13, 2026
c767a53
Bump cardano-crypto-wallet to 0.2.0.0; fix fourmolu formatting
disassembler Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions cardano-crypto-wallet/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Changelog for cardano-crypto-wallet

## 0.1.0.1
## 0.2.0.0

*
* Breaking: `encryptedDerivePublic` now returns `Either XPrvError (PublicKey, ChainCode)`
instead of throwing on hardened indices.
* Breaking: `XPrvHardenedDerivationUnsupported` constructor added to `XPrvError`.

## 0.1.0.0

Expand Down
2 changes: 1 addition & 1 deletion cardano-crypto-wallet/cardano-crypto-wallet.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cabal-version: 3.0
name: cardano-crypto-wallet
version: 0.1.0.0
version: 0.2.0.0
synopsis: Authenticated v2 envelope for HD wallet keys
description:
Provides authenticated encryption and key derivation for HD wallet keys,
Expand Down
25 changes: 13 additions & 12 deletions cardano-crypto-wallet/src/Cardano/Crypto/WalletHD/Encrypted.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,7 @@ data XPrvError
| XPrvInvalidChainCode
| XPrvPublicKeyMismatch
| XPrvInternalError
| XPrvHardenedDerivationUnsupported
deriving (Eq, Show)

newtype EncryptedKey = EncryptedKey ByteString
Expand Down Expand Up @@ -673,26 +674,26 @@ encryptedDerivePublic ::
DerivationScheme ->
(PublicKey, ChainCode) ->
DerivationIndex ->
(PublicKey, ChainCode)
Either XPrvError (PublicKey, ChainCode)
Comment thread
lehins marked this conversation as resolved.
encryptedDerivePublic dscheme (publicKey, cc) childIndex
| childIndex >= 0x80000000 =
error "encryptedDerivePublic: cannot derive hardened key from public key"
| otherwise = unsafePerformIO $ do
fmap (first PublicKey) $ psbCreateResult $ \publicKeyPtrOut ->
fmap ChainCode $ psbCreate $ \ccOutPtr ->
withPublicKeyPtr publicKey $ \publicKeyPtr ->
withChainCodePtr cc $ \chainCodePtr -> do
r <-
| childIndex >= 0x80000000 = Left XPrvHardenedDerivationUnsupported
| otherwise = unsafePerformIO $
withPublicKeyPtr publicKey $ \publicKeyPtr ->
withChainCodePtr cc $ \chainCodePtr -> do
(pubKeyBytes, (ccBytes, r)) <-
psbCreateResult $ \publicKeyPtrOut ->
psbCreateResult $ \ccOutPtr ->
wallet_derive_public
publicKeyPtr
chainCodePtr
childIndex
(PublicKeyPtr publicKeyPtrOut)
(ChainCodePtr ccOutPtr)
(dschemeToC dscheme)
if r /= 0
then error "encryptedDerivePublic: hardened index check failed"
else pure ()
pure $
if r /= 0
then Left XPrvInternalError
else Right (PublicKey pubKeyBytes, ChainCode ccBytes)

encryptedPublic :: HasCallStack => EncryptedKey -> PublicKey
encryptedPublic eKey@(EncryptedKey eKeyBytes) =
Expand Down
14 changes: 9 additions & 5 deletions cardano-crypto-wallet/test/Test/Cardano/Crypto/Wallet/RoundTripSpec.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,9 @@ tests = describe "RoundTrip" $ do
case res' of
Left err -> expectationFailure $ "derivePrivate failed: " ++ show err
Right child ->
let (derivedPub, _) = encryptedDerivePublic DerivationScheme2 (pub, cc) idx
in encryptedPublic child `shouldBe` derivedPub
case encryptedDerivePublic DerivationScheme2 (pub, cc) idx of
Left err -> expectationFailure $ "derivePublic failed: " ++ show err
Right (derivedPub, _) -> encryptedPublic child `shouldBe` derivedPub

it "encryptedDerivePublic is consistent for both schemes" $ do
res <- encryptedCreate testSeed testPass testCC
Expand All @@ -92,9 +93,12 @@ tests = describe "RoundTrip" $ do
Right key -> do
let pub = encryptedPublic key
cc = encryptedChainCode key
(pub1, _) = encryptedDerivePublic DerivationScheme1 (pub, cc) 0
(pub2, _) = encryptedDerivePublic DerivationScheme2 (pub, cc) 0
pub1 `shouldNotBe` pub2
case ( encryptedDerivePublic DerivationScheme1 (pub, cc) 0
, encryptedDerivePublic DerivationScheme2 (pub, cc) 0
) of
(Right (pub1, _), Right (pub2, _)) -> pub1 `shouldNotBe` pub2
(Left err, _) -> expectationFailure $ "derivePublic scheme1 failed: " ++ show err
(_, Left err) -> expectationFailure $ "derivePublic scheme2 failed: " ++ show err

prop "mkEncryptedKey . unEncryptedKey is identity" $
\(key :: EncryptedKey) ->
Expand Down
Loading