Safe Haskell	None
Language	Haskell2010

Tahoe.CHK.Share

Description

A share is a single data object comprising some erasure-encoded data and some cryptographic hashes which allow certain determinations to be made about that that data. One or more shares can be interpreted together, typically to recover a particular ciphertext object.

This modules exposes a structured representation of the share object along with an encoder to and decoder from the canonical serialized representation.

Synopsis

type Crypttext = ByteString
data Share = Share {
- _blockSize :: Word64
- _dataSize :: Word64
- _blocks :: [ByteString]
- _plaintextHashTree :: MerkleTree ByteString SHA256d
- _crypttextHashTree :: MerkleTree Crypttext SHA256d
- _blockHashTree :: MerkleTree ByteString SHA256d
- _neededHashes :: [(ShareNum, Digest' SHA256d)]
- _uriExtension :: URIExtension
}
uriExtension :: Lens' Share URIExtension
plaintextHashTree :: Lens' Share (MerkleTree ByteString SHA256d)
neededHashes :: Lens' Share [(ShareNum, Digest' SHA256d)]
dataSize :: Lens' Share Word64
crypttextHashTree :: Lens' Share (MerkleTree Crypttext SHA256d)
blocks :: Lens' Share [ByteString]
blockSize :: Lens' Share Word64
blockHashTree :: Lens' Share (MerkleTree ByteString SHA256d)
getWord32 :: Get Word64
getWord64 :: Get Word64
word64To4Bytes :: Word64 -> Maybe ByteString
word64To4Bytes' :: Word64 -> Either String ByteString
word64To8Bytes :: Word64 -> ByteString
segmentLazyBytes :: Int64 -> ByteString -> [ByteString]
isolateBetween :: String -> Word64 -> Word64 -> Get a -> Get a
getLazyByteStringInBoundsFrom :: String -> Word64 -> Word64 -> Get ByteString
getInt64FromWord64 :: String -> Word64 -> Get Int64
word64ToInt64 :: Word64 -> Maybe Int64
word64ToWord32 :: Word64 -> Maybe Word32
maxWord32 :: Integral i => i
serializeNeededShares :: HashAlgorithm hash => [(ShareNum, Digest' hash)] -> ByteString
unserializeNeededShares :: forall hash. HashAlgorithm hash => ByteString -> Maybe [(ShareNum, Digest' hash)]
intToWord64 :: Int -> Word64
int64ToWord64 :: Int64 -> Word64
getVersion :: Get (Word8, Get Word64)
chooseVersion :: Word64 -> (Word8, Word64 -> ByteString, Word64 -> Put)
fieldSizeForVersion :: Word8 -> Int
word64To4BytesPartial :: Word64 -> ByteString
newtype EncodingError = Word64OutOfBounds Word64

Documentation

type Crypttext = ByteString Source #

A byte string of encrypted data.

data Share Source #

Structured representation of a single CHK share.

Constructors

Fields

_blockSize :: Word64
The ZFEC block size. Legacy value. Unused.
_dataSize :: Word64
The share data length. Legacy value. Unused.
_blocks :: [ByteString]
The ZFEC encoded ciphertext blocks.
_plaintextHashTree :: MerkleTree ByteString SHA256d
A merkle tree of plaintext segment hashes. Unimplemented.
_crypttextHashTree :: MerkleTree Crypttext SHA256d
A merkle tree of ciphertext segment hashes.
_blockHashTree :: MerkleTree ByteString SHA256d
A merkle tree of hashes of shareBlocks.
_neededHashes :: [(ShareNum, Digest' SHA256d)]
The information needed to complete a merkle proof for this share.
_uriExtension :: URIExtension
Additional metadata about this share.

Instances

uriExtension :: Lens' Share URIExtension Source #

plaintextHashTree :: Lens' Share (MerkleTree ByteString SHA256d) Source #

neededHashes :: Lens' Share [(ShareNum, Digest' SHA256d)] Source #

dataSize :: Lens' Share Word64 Source #

crypttextHashTree :: Lens' Share (MerkleTree Crypttext SHA256d) Source #

blocks :: Lens' Share [ByteString] Source #

blockSize :: Lens' Share Word64 Source #

blockHashTree :: Lens' Share (MerkleTree ByteString SHA256d) Source #

getWord32 :: Get Word64 Source #

getWord64 :: Get Word64 Source #

word64To4Bytes :: Word64 -> Maybe ByteString Source #

word64To4Bytes' :: Word64 -> Either String ByteString Source #

word64To8Bytes :: Word64 -> ByteString Source #

segmentLazyBytes :: Int64 -> ByteString -> [ByteString] Source #

isolateBetween :: String -> Word64 -> Word64 -> Get a -> Get a Source #

getLazyByteStringInBoundsFrom :: String -> Word64 -> Word64 -> Get ByteString Source #

getInt64FromWord64 :: String -> Word64 -> Get Int64 Source #

word64ToInt64 :: Word64 -> Maybe Int64 Source #

word64ToWord32 :: Word64 -> Maybe Word32 Source #

maxWord32 :: Integral i => i Source #

serializeNeededShares :: HashAlgorithm hash => [(ShareNum, Digest' hash)] -> ByteString Source #

Serialize the list of (share number, block tree root hash) pairs for inclusion in the serialized form of a Share. The inverse of unserializeNeededShares.

unserializeNeededShares :: forall hash. HashAlgorithm hash => ByteString -> Maybe [(ShareNum, Digest' hash)] Source #

Unserialize a a list of (share number, block tree root hash) pairs from their form in a serialized Share. The inverse of serializeNeededShares.

intToWord64 :: Int -> Word64 Source #

int64ToWord64 :: Int64 -> Word64 Source #

getVersion :: Get (Word8, Get Word64) Source #

chooseVersion :: Word64 -> (Word8, Word64 -> ByteString, Word64 -> Put) Source #

fieldSizeForVersion :: Word8 -> Int Source #

word64To4BytesPartial :: Word64 -> ByteString Source #

Serialize a Word64 to 4 bytes or throw an exception if the value can not fit.

newtype EncodingError Source #

Constructors

Word64OutOfBounds Word64

Instances

Instances details

Eq EncodingError Source #
Instance details Defined in Tahoe.CHK.Share Methods (==) :: EncodingError -> EncodingError -> Bool # (/=) :: EncodingError -> EncodingError -> Bool #
Ord EncodingError Source #
Instance details Defined in Tahoe.CHK.Share Methods compare :: EncodingError -> EncodingError -> Ordering # (<) :: EncodingError -> EncodingError -> Bool # (<=) :: EncodingError -> EncodingError -> Bool # (>) :: EncodingError -> EncodingError -> Bool # (>=) :: EncodingError -> EncodingError -> Bool # max :: EncodingError -> EncodingError -> EncodingError # min :: EncodingError -> EncodingError -> EncodingError #
Show EncodingError Source #
Instance details Defined in Tahoe.CHK.Share Methods showsPrec :: Int -> EncodingError -> ShowS # show :: EncodingError -> String # showList :: [EncodingError] -> ShowS #
Exception EncodingError Source #
Instance details Defined in Tahoe.CHK.Share Methods toException :: EncodingError -> SomeException # fromException :: SomeException -> Maybe EncodingError # displayException :: EncodingError -> String #

Eq Share Source #
Instance details Defined in Tahoe.CHK.Share Methods (==) :: Share -> Share -> Bool # (/=) :: Share -> Share -> Bool #
Ord Share Source #
Instance details Defined in Tahoe.CHK.Share Methods compare :: Share -> Share -> Ordering # (<) :: Share -> Share -> Bool # (<=) :: Share -> Share -> Bool # (>) :: Share -> Share -> Bool # (>=) :: Share -> Share -> Bool # max :: Share -> Share -> Share # min :: Share -> Share -> Share #
Show Share Source #
Instance details Defined in Tahoe.CHK.Share Methods showsPrec :: Int -> Share -> ShowS # show :: Share -> String # showList :: [Share] -> ShowS #
Generic Share Source #
Instance details Defined in Tahoe.CHK.Share Associated Types type Rep Share :: Type -> Type # Methods from :: Share -> Rep Share x # to :: Rep Share x -> Share #
Binary Share Source #
Instance details Defined in Tahoe.CHK.Share Methods put :: Share -> Put # get :: Get Share # putList :: [Share] -> Put #
ToExpr Share Source #
Instance details Defined in Tahoe.CHK.Share Methods toExpr :: Share -> Expr # listToExpr :: [Share] -> Expr #
type Rep Share Source #
Instance details Defined in Tahoe.CHK.Share type Rep Share = D1 ('MetaData "Share" "Tahoe.CHK.Share" "tahoe-chk-0.2.0.0-inplace" 'False) (C1 ('MetaCons "Share" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_blockSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :: S1 ('MetaSel ('Just "_dataSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)) :: (S1 ('MetaSel ('Just "_blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ByteString]) :: S1 ('MetaSel ('Just "_plaintextHashTree") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MerkleTree ByteString SHA256d)))) :: ((S1 ('MetaSel ('Just "_crypttextHashTree") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MerkleTree Crypttext SHA256d)) :: S1 ('MetaSel ('Just "_blockHashTree") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MerkleTree ByteString SHA256d))) :: (S1 ('MetaSel ('Just "_neededHashes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(ShareNum, Digest' SHA256d)]) :*: S1 ('MetaSel ('Just "_uriExtension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URIExtension)))))