| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Cardano.Crypto.VRF.Praos
Description
Verifiable Random Function (VRF) implemented as FFI wrappers around the implementation in https://github.com/input-output-hk/libsodium
Synopsis
- data PraosVRF
- certSizeVRF ∷ Int
- signKeySizeVRF ∷ Int
- verKeySizeVRF ∷ Int
- vrfKeySizeVRF ∷ Int
- data Seed
- genSeed ∷ IO Seed
- keypairFromSeed ∷ Seed → (VerKey, SignKey)
- outputBytes ∷ Output → ByteString
- outputFromBytes ∷ MonadFail m ⇒ ByteString → m Output
- outputFromProof ∷ Proof → Maybe Output
- proofBytes ∷ Proof → ByteString
- skBytes ∷ SignKey → ByteString
- vkBytes ∷ VerKey → ByteString
- skToVerKey ∷ SignKey → VerKey
- skToSeed ∷ SignKey → Seed
- proofFromBytes ∷ MonadFail m ⇒ ByteString → m Proof
- skFromBytes ∷ MonadFail m ⇒ ByteString → m SignKey
- vkFromBytes ∷ MonadFail m ⇒ ByteString → m VerKey
- vkToBatchCompat ∷ VerKeyVRF PraosVRF → VerKeyVRF PraosBatchCompatVRF
- skToBatchCompat ∷ SignKeyVRF PraosVRF → SignKeyVRF PraosBatchCompatVRF
- outputToBatchCompat ∷ OutputVRF PraosVRF → OutputVRF PraosBatchCompatVRF
- prove ∷ SignKey → ByteString → Maybe Proof
- verify ∷ VerKey → Proof → ByteString → Maybe Output
- data family SignKeyVRF v
- data family VerKeyVRF v
- data family CertVRF v
- data Proof
- data SignKey
- data VerKey
- data Output
VRFAlgorithm API
Instances
Key sizes
Seed and key generation
A random seed, used to derive a key pair.
Generate a random seed.
Uses randombytes_buf to create random data.
This function provides an alternative way of generating seeds specifically
for the PraosVRF algorithm. Unlike the genKeyPairVRF method, which uses
a ByteString-based Seed, this seed generation method
bypasses the GHC heap, keeping the seed in C-allocated memory instead.
This provides two advantages:
1. It avoids the overhead of unnecessary GHC-side heap allocations.
2. It avoids leaking the seed via the GHC heap; the Seed type itself
takes care of zeroing out its memory upon finalization.
Conversions
outputBytes ∷ Output → ByteString Source #
Convert a proof verification output hash into a ByteString that we can
inspect.
outputFromBytes ∷ MonadFail m ⇒ ByteString → m Output Source #
proofBytes ∷ Proof → ByteString Source #
Deprecated: Use rawEncodeFixedSized instead
Convert a proof into a ByteString that we can inspect.
skBytes ∷ SignKey → ByteString Source #
Deprecated: Use rawEncodeFixedSized instead
Convert a signing key into a ByteString that we can inspect.
vkBytes ∷ VerKey → ByteString Source #
Deprecated: Use rawEncodeFixedSized instead
Convert a verification key into a ByteString that we can inspect.
skToVerKey ∷ SignKey → VerKey Source #
Derive a Verification Key from a Signing Key.
proofFromBytes ∷ MonadFail m ⇒ ByteString → m Proof Source #
Deprecated: Use rawDecodeFixedSized instead
skFromBytes ∷ MonadFail m ⇒ ByteString → m SignKey Source #
Deprecated: Use rawDecodeFixedSized instead
vkFromBytes ∷ MonadFail m ⇒ ByteString → m VerKey Source #
Deprecated: Use rawDecodeFixedSized instead
vkToBatchCompat ∷ VerKeyVRF PraosVRF → VerKeyVRF PraosBatchCompatVRF Source #
Construct a BatchCompat vkey from praos, non-batchcompat
skToBatchCompat ∷ SignKeyVRF PraosVRF → SignKeyVRF PraosBatchCompatVRF Source #
Construct a BatchCompat skey from praos, non-batchcompat
outputToBatchCompat ∷ OutputVRF PraosVRF → OutputVRF PraosBatchCompatVRF Source #
Construct a BatchCompat output from praos, non-batchcompat
Core VRF operations
data family SignKeyVRF v Source #
Instances
data family VerKeyVRF v Source #
Instances
data family CertVRF v Source #
Instances
Internal types
A proof, as constructed by the prove function.
Instances
| Generic Proof Source # | |
| Show Proof Source # | |
| FixedSizeCodec Proof Source # | |
Defined in Cardano.Crypto.VRF.Praos Methods rawEncodeFixedSized ∷ Proof → ByteString Source # rawDecodeFixedSized ∷ MonadFail m ⇒ ByteString → m Proof Source # | |
| FromCBOR Proof Source # | |
| ToCBOR Proof Source # | |
| NFData Proof Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
| Eq Proof Source # | |
| Ord Proof Source # | |
| NoThunks Proof Source # | |
| type Rep Proof Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
| type FixedSize Proof Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
Signing key. In this implementation, the signing key is actually a 64-byte value that contains both the 32-byte signing key and the corresponding 32-byte verification key.
Instances
| Generic SignKey Source # | |
| Show SignKey Source # | |
| FixedSizeCodec SignKey Source # | |
Defined in Cardano.Crypto.VRF.Praos Methods rawEncodeFixedSized ∷ SignKey → ByteString Source # rawDecodeFixedSized ∷ MonadFail m ⇒ ByteString → m SignKey Source # | |
| FromCBOR SignKey Source # | |
| ToCBOR SignKey Source # | |
| NFData SignKey Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
| Eq SignKey Source # | |
| NoThunks SignKey Source # | |
| type Rep SignKey Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
| type FixedSize SignKey Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
Verification key.
Instances
| Generic VerKey Source # | |
| Show VerKey Source # | |
| FixedSizeCodec VerKey Source # | |
Defined in Cardano.Crypto.VRF.Praos Methods rawEncodeFixedSized ∷ VerKey → ByteString Source # rawDecodeFixedSized ∷ MonadFail m ⇒ ByteString → m VerKey Source # | |
| FromCBOR VerKey Source # | |
| ToCBOR VerKey Source # | |
| NFData VerKey Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
| Eq VerKey Source # | |
| NoThunks VerKey Source # | |
| type Rep VerKey Source # | |
Defined in Cardano.Crypto.VRF.Praos | |
| type FixedSize VerKey Source # | |
Defined in Cardano.Crypto.VRF.Praos | |