Safe Haskell	None
Language	Haskell2010

Tahoe.CHK.Upload

Synopsis

data UploadResult
data Uploadable = Uploadable {
- uploadableKey :: Key AES128
- uploadableSize :: Size
- uploadableParameters :: Parameters
- uploadableReadCleartext :: Integer -> IO ByteString
}
data Parameters = Parameters SegmentSize Total Happy Required
defaultParameters :: Parameters
filesystemUploadable :: Key AES128 -> FilePath -> Parameters -> IO Uploadable
filesystemUploadableWithConvergence :: ByteString -> FilePath -> Parameters -> IO Uploadable
filesystemUploadableRandomConvergence :: FilePath -> Parameters -> IO Uploadable
memoryUploadableWithConvergence :: ByteString -> Integer -> ByteString -> Parameters -> IO Uploadable
getConvergentKey :: ByteString -> Parameters -> ByteString -> Key AES128
upload :: [StorageServer] -> Key AES128 -> Parameters -> ([ByteString], Reader) -> IO UploadResult
store :: [StorageServer] -> Uploadable -> IO UploadResult
prettyFormatSharemap :: ShareMap -> Text
adjustSegmentSize :: Parameters -> Size -> Parameters
encryptAndEncode :: Uploadable -> IO ([ByteString], Reader)

Documentation

data UploadResult Source #

Instances

Instances details

Show UploadResult Source #
Instance details Defined in Tahoe.CHK.Upload Methods showsPrec :: Int -> UploadResult -> ShowS # show :: UploadResult -> String # showList :: [UploadResult] -> ShowS #

data Uploadable Source #

Constructors

Uploadable
Fields uploadableKey :: Key AES128 uploadableSize :: Size uploadableParameters :: Parameters uploadableReadCleartext :: Integer -> IO ByteString

data Parameters Source #

Constructors

Parameters SegmentSize Total Happy Required

Instances

Instances details

Eq Parameters Source #
Instance details Defined in Tahoe.CHK.Types Methods (==) :: Parameters -> Parameters -> Bool # (/=) :: Parameters -> Parameters -> Bool #
Ord Parameters Source #
Instance details Defined in Tahoe.CHK.Types Methods compare :: Parameters -> Parameters -> Ordering # (<) :: Parameters -> Parameters -> Bool # (<=) :: Parameters -> Parameters -> Bool # (>) :: Parameters -> Parameters -> Bool # (>=) :: Parameters -> Parameters -> Bool # max :: Parameters -> Parameters -> Parameters # min :: Parameters -> Parameters -> Parameters #
Show Parameters Source #
Instance details Defined in Tahoe.CHK.Types Methods showsPrec :: Int -> Parameters -> ShowS # show :: Parameters -> String # showList :: [Parameters] -> ShowS #
Generic Parameters Source #
Instance details Defined in Tahoe.CHK.Types Associated Types type Rep Parameters :: Type -> Type # Methods from :: Parameters -> Rep Parameters x # to :: Rep Parameters x -> Parameters #
ToExpr Parameters Source #
Instance details Defined in Tahoe.CHK.Types Methods toExpr :: Parameters -> Expr # listToExpr :: [Parameters] -> Expr #
type Rep Parameters Source #
Instance details Defined in Tahoe.CHK.Types type Rep Parameters = D1 ('MetaData "Parameters" "Tahoe.CHK.Types" "tahoe-chk-0.2.0.0-inplace" 'False) (C1 ('MetaCons "Parameters" 'PrefixI 'True) ((S1 ('MetaSel ('Just "paramSegmentSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SegmentSize) :: S1 ('MetaSel ('Just "paramTotalShares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Total)) :: (S1 ('MetaSel ('Just "paramHappyShares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Happy) :*: S1 ('MetaSel ('Just "paramRequiredShares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Required))))

defaultParameters :: Parameters Source #

filesystemUploadable :: Key AES128 -> FilePath -> Parameters -> IO Uploadable Source #

filesystemUploadableWithConvergence :: ByteString -> FilePath -> Parameters -> IO Uploadable Source #

filesystemUploadableRandomConvergence :: FilePath -> Parameters -> IO Uploadable Source #

memoryUploadableWithConvergence :: ByteString -> Integer -> ByteString -> Parameters -> IO Uploadable Source #

getConvergentKey :: ByteString -> Parameters -> ByteString -> Key AES128 Source #

upload Source #

Arguments

:: [StorageServer]	The servers to consider uploading shares to.
-> Key AES128	The encryption key (to derive the storage index).
-> Parameters	The encoding parameters (XXX only for happy, right?)
-> ([ByteString], Reader)	The share data to upload.
-> IO UploadResult	Describe the outcome of the upload.

Given some cleartext, some encoding parameters, and some servers: encrypt, encode, and upload some shares that can later be used to reconstruct the cleartext.

This replaces allmydata.immutable.upload.Uploader.upload.

store Source #

Arguments

:: [StorageServer]	The servers to consider using.
-> Uploadable	The application data to operate on.
-> IO UploadResult	The result of the attempt.

Encrypt and encode some application data to some ZFEC shares and upload them to some servers.

prettyFormatSharemap :: ShareMap -> Text Source #

adjustSegmentSize :: Parameters -> Size -> Parameters Source #

encryptAndEncode Source #

Arguments

:: Uploadable	The application data to encrypt and encode.
-> IO ([ByteString], Reader)	An action to get an action that can be repeatedly evaluated to get share data. As long as there is more share data, it evaluates to Left. When shares are done, it evaluates to Right.

Given some cleartext and some encoding parameters: encrypt and encode some shares that can later be used to reconstruct the cleartext.