Tahoe.SDMF.Internal.Keys

Key types, derivations, and related functionality for SDMF.

See docsspecificationsmutable.rst for details.

Documentation

newtype KeyPair

Constructors

KeyPair

Fields

• toPrivateKey :: PrivateKey

Instances

Show KeyPair

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> KeyPair -> ShowS

show :: KeyPair -> String

showList :: [KeyPair] -> ShowS

toPublicKey :: KeyPair -> PublicKey

toSignatureKey :: KeyPair -> Signature

toVerificationKey :: KeyPair -> Verification

newtype Verification

Constructors

Verification

Fields

• unVerification :: PublicKey

Instances

Eq Verification

Defined in Tahoe.SDMF.Internal.Keys

Methods

(==) :: Verification -> Verification -> Bool

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

Show Verification

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> Verification -> ShowS

show :: Verification -> String

showList :: [Verification] -> ShowS

newtype Signature

Constructors

Signature

Fields

• unSignature :: PrivateKey

Instances

Eq Signature

Defined in Tahoe.SDMF.Internal.Keys

Methods

(==) :: Signature -> Signature -> Bool

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

Show Signature

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

data Write

Constructors

Write

Fields

• unWrite :: AES128
• writeKeyBytes :: ScrubbedBytes

Instances

Eq Write

Defined in Tahoe.SDMF.Internal.Keys

Methods

(==) :: Write -> Write -> Bool

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

Show Write

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> Write -> ShowS

show :: Write -> String

showList :: [Write] -> ShowS

Binary Write

Defined in Tahoe.SDMF.Internal.Keys

Methods

put :: Write -> Put

get :: Get Write

putList :: [Write] -> Put

data Read

Constructors

Read

Fields

• unRead :: AES128
• readKeyBytes :: ScrubbedBytes

Instances

Eq Read

Defined in Tahoe.SDMF.Internal.Keys

Methods

(==) :: Read -> Read -> Bool

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

Show Read

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> Read -> ShowS

show :: Read -> String

showList :: [Read] -> ShowS

Binary Read

Defined in Tahoe.SDMF.Internal.Keys

Methods

put :: Read -> Put

get :: Get Read

putList :: [Read] -> Put

newtype StorageIndex

Constructors

StorageIndex

Fields

• unStorageIndex :: ByteString

Instances

Eq StorageIndex

Defined in Tahoe.SDMF.Internal.Keys

Methods

(==) :: StorageIndex -> StorageIndex -> Bool

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

Ord StorageIndex

Defined in Tahoe.SDMF.Internal.Keys

Methods

compare :: StorageIndex -> StorageIndex -> Ordering

(<) :: StorageIndex -> StorageIndex -> Bool

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

(>) :: StorageIndex -> StorageIndex -> Bool

(>=) :: StorageIndex -> StorageIndex -> Bool

max :: StorageIndex -> StorageIndex -> StorageIndex

min :: StorageIndex -> StorageIndex -> StorageIndex

Show StorageIndex

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> StorageIndex -> ShowS

show :: StorageIndex -> String

showList :: [StorageIndex] -> ShowS

newtype WriteEnablerMaster

Constructors

WriteEnablerMaster ScrubbedBytes

newtype WriteEnabler

Constructors

WriteEnabler ScrubbedBytes

data Data

Constructors

Data

Fields

• unData :: AES128
• dataKeyBytes :: ScrubbedBytes

Instances

Eq Data

Defined in Tahoe.SDMF.Internal.Keys

Methods

(==) :: Data -> Data -> Bool

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

Show Data

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> Data -> ShowS

show :: Data -> String

showList :: [Data] -> ShowS

Binary Data

Defined in Tahoe.SDMF.Internal.Keys

Methods

put :: Data -> Put

get :: Get Data

putList :: [Data] -> Put

newtype SDMF_IV

Constructors

SDMF_IV (IV AES128)

Instances

Eq SDMF_IV

Defined in Tahoe.SDMF.Internal.Keys

Methods

(==) :: SDMF_IV -> SDMF_IV -> Bool

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

Show SDMF_IV

Defined in Tahoe.SDMF.Internal.Keys

Methods

showsPrec :: Int -> SDMF_IV -> ShowS

show :: SDMF_IV -> String

showList :: [SDMF_IV] -> ShowS

ByteArrayAccess SDMF_IV

Defined in Tahoe.SDMF.Internal.Keys

Methods

length :: SDMF_IV -> Int

withByteArray :: SDMF_IV -> (Ptr p -> IO a) -> IO a

copyByteArrayToPtr :: SDMF_IV -> Ptr p -> IO ()

keyPairBits :: Int

The size of the public/private key pair to generate.

keyLength :: Int

The number of bytes in the block cipher key.

newKeyPair :: MonadRandom m => m KeyPair

Create a new, random key pair (publicprivate aka verificationsignature) of the appropriate type and size for SDMF encryption.

deriveWriteKey :: Signature -> Maybe Write

Compute the write key for a given signature key for an SDMF share.

mutableWriteKeyTag :: ByteString

deriveReadKey :: Write -> Maybe Read

Compute the read key for a given write key for an SDMF share.

mutableReadKeyTag :: ByteString

deriveDataKey :: SDMF_IV -> Read -> Maybe Data

Compute the data encryption/decryption key for a given read key for an SDMF share.

mutableDataKeyTag :: ByteString

deriveStorageIndex :: Read -> StorageIndex

Compute the storage index for a given read key for an SDMF share.

mutableStorageIndexTag :: ByteString

deriveWriteEnablerMaster :: Write -> WriteEnablerMaster

Derive the "write enabler master" secret for a given write key for an SDMF share.

mutableWriteEnablerMasterTag :: ByteString

deriveWriteEnabler :: ByteString -> WriteEnablerMaster -> WriteEnabler

Derive the "write enabler" secret for a given peer and "write enabler master" for an SDMF share.

mutableWriteEnablerTag :: ByteString

deriveVerificationHash :: Verification -> ByteString

Compute the verification key hash of the given verification key for inclusion in an SDMF share.

mutableVerificationKeyHashTag :: ByteString

The tag used when hashing the verification key to the verification key hash for inclusion in SDMF shares.

verificationKeyToBytes :: Verification -> ByteString

Encode a public key to the Tahoe-LAFS canonical bytes representation - X.509 SubjectPublicKeyInfo of the ASN.1 DER serialization of an RSA PublicKey.

signatureKeyToBytes :: Signature -> ByteString

Encode a private key to the Tahoe-LAFS canonical bytes representation - X.509 SubjectPublicKeyInfo of the ASN.1 DER serialization of an RSA PublicKey.

signatureKeyFromBytes :: ByteString -> Either String Signature

Decode a private key from the Tahoe-LAFS canonical bytes representation.

encryptSignatureKey :: Write -> Signature -> ByteString

Encrypt the signature key for inclusion in the SDMF share itself.

shorten :: Int -> Text -> Text

Replace most of the tail of a string with a short placeholder. If the string is not much longer than n then the result might not actually be shorter.

TODO: Deduplicate this between here and tahoe-chk.

showBase32 :: ByteString -> Text