Modulecardano-crypto-1.3.0Haskell2010

Crypto.ECC.Ed25519BIP32

Synopsis

type MasterSecret
type ChildKey
type Key
type Public
type PointCompressed
newtype ChainCode
newtype Hash
type Tag
newtype SerializedIndex
type HMAC_SHA512
data DerivationType
data DerivationMaterial
data DerivationIndex
data DerivationHier
type MaxHardIndex
type MinHardIndex
type MaxSoftIndex
type MinSoftIndex
data ValidIndex
data ValidHardIndex
data ValidSoftIndex
value getValidIndex
value isValidIndex
value getValidHardIndex
value isValidHardIndex
value getValidSoftIndex
value isValidSoftIndex
type ValidDerivationIndex
type ValidDerivationHardIndex
type ValidDerivationSoftIndex
family ValidDerivationIndexForType
family DerivationTag
value leftHalfValid
value toPublic
value kToPoint
value pointAdd
value pointToRepr
value pointFromRepr
family BitsToHashScheme
type ValidTag
value fcp
value hmacSHA512
class GetDerivationMaterial
value derive
value derivePublic
value step2
value indexSerialized

Packagecardano-crypto-1.3.0
Exports47
LanguageHaskell2010
LicenceMIT
SourceEd25519BIP32.hs

typetype MasterSecret = FBits 256

Source#

A Master secret is a 256 bits random quantity

typetype ChildKey (didxs :: DerivationHier) = Key

Source#

A child key is similar to the key in structure except it has an additional annotation representing the indexes for the hierarchy derivation indexes from a base Key (usually the root key)

typetype Key = (FBits 256, FBits 256, ChainCode)

Source#

A key is a 512 bit random value and a chaincode

Left half need to have: * Lowest 3 bits clear * Highest bit clear * Second highest bit set * Third highest bit clear

Right half doesn't have any particular structure.

typetype Public = (PointCompressed, ChainCode)

Source#

A public part of a key

typetype PointCompressed = FBits 256

Source#

A point is 1 bit of x sign and 255 bit of y coordinate (y's 256th bit is always 0)

newtypenewtype ChainCode

Source#

A 256 bits chain code

Constructors

ChainCode
- unChainCode :: Bytes 32

Instances3Eq, GetDerivationMaterial

Eq ChainCodeDefined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32
GetDerivationMaterial 'Hard KeyDefined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32
GetDerivationMaterial 'Soft KeyDefined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32

newtypenewtype Hash (n :: Nat)

Source#

A n bits Digest

Constructors

Hash
- unHash :: FBits n

Instances1Eq

Eq (Hash n)Defined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32

typetype Tag = Bytes 1

Source#

A Serialized tag used during HMAC

newtypenewtype SerializedIndex

Source#

Serialized Index

Constructors

SerializedIndex (Bytes 4)

Instances1Eq

Eq SerializedIndexDefined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32

typetype HMAC_SHA512 = Bytes 64

datadata DerivationType

Hard Soft

datadata DerivationMaterial

ChainCodeMaterial KeyMaterial

datadata DerivationIndex (k :: DerivationType) (n :: Nat)

DerivationIndex

datadata DerivationHier

typetype MaxHardIndex = 4294967295

typetype MinHardIndex = 2147483648

typetype MaxSoftIndex = MinHardIndex - 1

typetype MinSoftIndex = 0

datadata ValidIndex (a :: Nat) where

Constructors

IsValidIndex :: ValidDerivationIndex a :~: 'True -> ValidIndex a
IsNotValidIndex :: ValidDerivationIndex a :~: 'False -> ValidIndex a

datadata ValidHardIndex (a :: Nat) where

Constructors

IsValidHardIndex :: ValidDerivationHardIndex a :~: 'True -> ValidHardIndex a
IsNotValidHardIndex :: ValidDerivationHardIndex a :~: 'False -> ValidHardIndex a

datadata ValidSoftIndex (a :: Nat) where

Constructors

IsValidSoftIndex :: ValidDerivationSoftIndex a :~: 'True -> ValidSoftIndex a
IsNotValidSoftIndex :: ValidDerivationSoftIndex a :~: 'False -> ValidSoftIndex a

valuegetValidIndex

:: KnownNat n
=> Proxy n
-> Maybe (ValidDerivationIndex n :~: 'True)

valueisValidIndex :: KnownNat n => Proxy n -> ValidIndex n

valuegetValidHardIndex

:: KnownNat n
=> Proxy n
-> Maybe (ValidDerivationHardIndex n :~: 'True)

valueisValidHardIndex :: KnownNat n => Proxy n -> ValidHardIndex n

valuegetValidSoftIndex

:: KnownNat n
=> Proxy n
-> Maybe (ValidDerivationSoftIndex n :~: 'True)

valueisValidSoftIndex :: KnownNat n => Proxy n -> ValidSoftIndex n

typetype ValidDerivationIndex (n :: Nat) = (MinSoftIndex <=? n) && (n <=? MaxHardIndex)

typetype ValidDerivationHardIndex (n :: Nat) = (MinHardIndex <=? n) && (n <=? MaxHardIndex)

typetype ValidDerivationSoftIndex (n :: Nat) = (MinSoftIndex <=? n) && (n <=? MaxSoftIndex)

familytype family ValidDerivationIndexForType (k :: DerivationType) (n :: Nat) :: Bool where

Equations

ValidDerivationIndexForType 'Hard n = ValidDerivationHardIndex n
ValidDerivationIndexForType 'Soft n = ValidDerivationSoftIndex n

familytype family DerivationTag (ty :: DerivationType) (material :: DerivationMaterial) :: Nat where

Equations

DerivationTag 'Hard 'KeyMaterial = 0
DerivationTag 'Hard 'ChainCodeMaterial = 1
DerivationTag 'Soft 'KeyMaterial = 2
DerivationTag 'Soft 'ChainCodeMaterial = 3

valueleftHalfValid :: FBits 256 -> Bool

Source#

Check if the left half is valid

valuetoPublic :: Key -> Public

valuekToPoint :: FBits 256 -> PointCompressed

valuepointAdd :: PointCompressed -> PointCompressed -> PointCompressed

valuepointToRepr :: PointCompressed -> PointCompressed

valuepointFromRepr :: PointCompressed -> PointCompressed

familytype family BitsToHashScheme (n :: Nat) where

Equations

BitsToHashScheme 256 = SHA256
BitsToHashScheme 512 = SHA512

typetype ValidTag (tag :: Natural) = (0 <= tag, tag <= 3)

valuefcp

:: (KnownNat (DerivationTag deriveType deriveMaterial), KnownNat idx, DerivationTag deriveType deriveMaterial ~ tag, ValidDerivationIndex idx ~ 'True, ValidDerivationIndexForType deriveType idx ~ 'True)
=> Proxy deriveMaterial
-> Proxy deriveType
-> Proxy idx
-> ChainCode
-> DerivationIndex deriveType idx
-> [Word8]
-> HMAC_SHA512

Source#

Compute the HMAC-SHA512 using the ChainCode as the key

valuehmacSHA512 :: Bytes keyLength -> Bytes input -> HMAC_SHA512

classclass GetDerivationMaterial (dtype :: DerivationType) mat where

Methods

getDerivationMaterial :: Proxy dtype -> mat -> [Word8]

Instances3GetDerivationMaterial

GetDerivationMaterial 'Hard KeyDefined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32
GetDerivationMaterial 'Soft KeyDefined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32
GetDerivationMaterial 'Soft PointCompressedDefined in cardano-crypto-1.3.0 · Crypto.ECC.Ed25519BIP32

valuederive

:: (KnownNat (DerivationTag dtype 'KeyMaterial), KnownNat (DerivationTag dtype 'ChainCodeMaterial), KnownNat idx, ValidDerivationIndex idx ~ 'True, ValidDerivationIndexForType dtype idx ~ 'True, GetDerivationMaterial dtype Key)
=> DerivationIndex dtype idx
-> Key
-> Key

valuederivePublic

:: (dtype ~ 'Soft, KnownNat (DerivationTag dtype 'KeyMaterial), KnownNat (DerivationTag dtype 'ChainCodeMaterial), KnownNat idx, ValidDerivationIndex idx ~ 'True, ValidDerivationIndexForType dtype idx ~ 'True, GetDerivationMaterial dtype PointCompressed)
=> DerivationIndex 'Soft idx
-> PointCompressed
-> ChainCode
-> (PointCompressed, ChainCode)

valuestep2 :: Bytes 64 -> (FBits 256, FBits 256)

Source#

Given Z, return 8*ZL(28Bytes) and ZR

valueindexSerialized

:: (KnownNat idx, ValidDerivationIndex idx ~ 'True)
=> Proxy idx
-> SerializedIndex

Source#

Serialized index