Tahoe.SDMF

Expose the library's public interface.

Documentation

data Share

Structured representation of a single version SDMF share.

See Tahoe-LAFS "mutable" specification document, section title "SDMF Slot Format".

Since the only version of SDMF that is specified uses version 0, this implicitly represents a version 0 SDMF. If new versions of SDMF are specified then new constructors may be added.

Constructors

Share

Fields

• shareSequenceNumber :: Word64

  sequence number. 2^64-1 must be handled specially, TBD

• shareRootHash :: ByteString

  R (root of share hash merkle tree)

• shareIV :: SDMF_IV

  The IV for encryption of share data.

• shareTotalShares :: Word8

  The total number of encoded shares (k).

• shareRequiredShares :: Word8

  The number of shares required for decoding (N).

• shareSegmentSize :: Word64

  The size of a single ciphertext segment. This differs from shareDataLength in that it includes padding.

• shareDataLength :: Word64

  The length of the original plaintext.

• shareVerificationKey :: Verification

  The 2048 bit "verification" RSA key.

• shareSignature :: ByteString

  The RSA signature of H('x00'+shareSequenceNumber+shareRootHash+shareIV+encoding parameters) where 'x00' gives the version of this share format (0) and the encoding parameters are a certain serialization of shareRequiredShares and shareTotalShares.

• shareHashChain :: HashChain

  The share numbers and shareRootHash values which are required to ... something about verification I dunno. XXX

• shareBlockHashTree :: MerkleTree ByteString SHA256d

  A merkle tree where leaves are the hashes of the blocks in this share.

• shareData :: ByteString

  The share data (erasure encoded ciphertext).

• shareEncryptedPrivateKey :: ByteString

  The encrypted 2048 bit "signature" RSA key.

Instances

Eq Share

Defined in Tahoe.SDMF.Internal.Share

Methods

(==) :: Share -> Share -> Bool

(/=) :: Share -> Share -> Bool

Show Share

Defined in Tahoe.SDMF.Internal.Share

Methods

showsPrec :: Int -> Share -> ShowS

show :: Share -> String

showList :: [Share] -> ShowS

Binary Share

Defined in Tahoe.SDMF.Internal.Share

Methods

put :: Share -> Put

get :: Get Share

putList :: [Share] -> Put

data Writer

A write capability for an SDMF object.

Constructors

Writer

Fields

• writerWriteKey :: Write
• writerReader :: Reader

Instances

Eq Writer

Defined in Tahoe.SDMF.Internal.Capability

Methods

(==) :: Writer -> Writer -> Bool

(/=) :: Writer -> Writer -> Bool

Ord Writer

Defined in Tahoe.SDMF.Internal.Capability

Methods

compare :: Writer -> Writer -> Ordering

(<) :: Writer -> Writer -> Bool

(<=) :: Writer -> Writer -> Bool

(>) :: Writer -> Writer -> Bool

(>=) :: Writer -> Writer -> Bool

max :: Writer -> Writer -> Writer

min :: Writer -> Writer -> Writer

Show Writer

Defined in Tahoe.SDMF.Internal.Capability

Methods

showsPrec :: Int -> Writer -> ShowS

show :: Writer -> String

showList :: [Writer] -> ShowS

ConfidentialShowable Writer

Defined in Tahoe.SDMF.Internal.Capability

Methods

confidentiallyShow :: Writer -> Text

data Reader

A read capability for an SDMF object.

Constructors

Reader

Fields

• readerReadKey :: Read
• readerVerifier :: Verifier

Instances

Eq Reader

Defined in Tahoe.SDMF.Internal.Capability

Methods

(==) :: Reader -> Reader -> Bool

(/=) :: Reader -> Reader -> Bool

Ord Reader

Defined in Tahoe.SDMF.Internal.Capability

Methods

compare :: Reader -> Reader -> Ordering

(<) :: Reader -> Reader -> Bool

(<=) :: Reader -> Reader -> Bool

(>) :: Reader -> Reader -> Bool

(>=) :: Reader -> Reader -> Bool

max :: Reader -> Reader -> Reader

min :: Reader -> Reader -> Reader

Show Reader

Defined in Tahoe.SDMF.Internal.Capability

Methods

showsPrec :: Int -> Reader -> ShowS

show :: Reader -> String

showList :: [Reader] -> ShowS

ConfidentialShowable Reader

Defined in Tahoe.SDMF.Internal.Capability

Methods

confidentiallyShow :: Reader -> Text

data Verifier

A verify capability for an SDMF object.

Constructors

Verifier

Fields

• verifierStorageIndex :: StorageIndex
• verifierVerificationKeyHash :: Digest' SHA256d

Instances

Eq Verifier

Defined in Tahoe.SDMF.Internal.Capability

Methods

(==) :: Verifier -> Verifier -> Bool

(/=) :: Verifier -> Verifier -> Bool

Ord Verifier

Defined in Tahoe.SDMF.Internal.Capability

Methods

compare :: Verifier -> Verifier -> Ordering

(<) :: Verifier -> Verifier -> Bool

(<=) :: Verifier -> Verifier -> Bool

(>) :: Verifier -> Verifier -> Bool

(>=) :: Verifier -> Verifier -> Bool

max :: Verifier -> Verifier -> Verifier

min :: Verifier -> Verifier -> Verifier

Show Verifier

Defined in Tahoe.SDMF.Internal.Capability

Methods

showsPrec :: Int -> Verifier -> ShowS

show :: Verifier -> String

showList :: [Verifier] -> ShowS

ConfidentialShowable Verifier

Defined in Tahoe.SDMF.Internal.Capability

Methods

confidentiallyShow :: Verifier -> Text

data SDMF

Any kind of SDMF capability.

Constructors

SDMFVerifier Verifier

SDMFReader Reader

SDMFWriter Writer

Instances

Eq SDMF

Defined in Tahoe.SDMF.Internal.Capability

Methods

(==) :: SDMF -> SDMF -> Bool

(/=) :: SDMF -> SDMF -> Bool

Show SDMF

Defined in Tahoe.SDMF.Internal.Capability

Methods

showsPrec :: Int -> SDMF -> ShowS

show :: SDMF -> String

showList :: [SDMF] -> ShowS

ConfidentialShowable SDMF

Defined in Tahoe.SDMF.Internal.Capability

Methods

confidentiallyShow :: SDMF -> Text

pCapability :: Parser SDMF

A parser for any kind of SDMF capability type.

pVerifier :: Parser Verifier

A parser for an SDMF verifier capability.

pReader :: Parser Reader

A parser for an SDMF reader capability.

pWriter :: Parser Writer

A parser for an SDMF writer capability.

dangerRealShow :: SDMF -> Text

Deprecated: Use the ConfidentialShowable instance

Show an SDMF capability, including all secret information.

encode :: (MonadFail m, MonadIO m, MonadRandom m) => KeyPair -> SDMF_IV -> Word64 -> Word16 -> Word16 -> ByteString -> m ([Share], Writer)

Given a pre-determined key pair and sequence number, encode some ciphertext into a collection of SDMF shares.

A key pair *uniquely identifies* a "slot" (the storage location for the shares). Thus they cannot be re-used for "different" data. Any shares created with a given key pair are part of the same logical data object.

decode :: (MonadFail m, MonadIO m) => Reader -> [(Word16, Share)] -> m ByteString

Decode some SDMF shares to recover the original ciphertext.

TODO: Use the read capability to verify the shares were constructed with information from the matching write capability.

randomIV :: MonadRandom m => m (Maybe SDMF_IV)

Randomly generate a new IV suitable for use with the block cipher used by SDMF.

encrypt :: KeyPair -> SDMF_IV -> ByteString -> ByteString

Encrypt plaintext bytes according to the scheme used for SDMF share construction.

decrypt :: Read -> SDMF_IV -> ByteString -> ByteString

Decrypt ciphertext bytes according to the scheme used for SDMF share construction.