| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Crypto.Age.Payload.Counter
Description
ChaCha20-Poly1305 counter nonces for decrypting chunks of an age file
payload.
Synopsis
- data PayloadChunkCounter
- unPayloadChunkCounter :: PayloadChunkCounter -> Integer
- mkPayloadChunkCounter :: Integer -> Maybe PayloadChunkCounter
- zeroPayloadChunkCounter :: PayloadChunkCounter
- incrementPayloadChunkCounter :: PayloadChunkCounter -> Maybe PayloadChunkCounter
- maxPayloadChunkCounter :: Integer
- data IsFinalChunk
- toChaCha20Poly1305Nonce :: IsFinalChunk -> PayloadChunkCounter -> Nonce
Documentation
data PayloadChunkCounter Source #
Payload chunk counter.
Instances
| Show PayloadChunkCounter Source # | |
Defined in Crypto.Age.Payload.Counter Methods showsPrec :: Int -> PayloadChunkCounter -> ShowS # show :: PayloadChunkCounter -> String # showList :: [PayloadChunkCounter] -> ShowS # | |
| Eq PayloadChunkCounter Source # | |
Defined in Crypto.Age.Payload.Counter Methods (==) :: PayloadChunkCounter -> PayloadChunkCounter -> Bool # (/=) :: PayloadChunkCounter -> PayloadChunkCounter -> Bool # | |
mkPayloadChunkCounter :: Integer -> Maybe PayloadChunkCounter Source #
Construct a PayloadChunkCounter.
Note that, if the provided Integer value is less than 0 or greater than
0xFFFFFFFFFFFFFFFFFFFFFF (i.e. the maximum integer value that can be
stored in 11 bytes), this function will return Nothing.
zeroPayloadChunkCounter :: PayloadChunkCounter Source #
Construct a PayloadChunkCounter initialized to 0.
incrementPayloadChunkCounter :: PayloadChunkCounter -> Maybe PayloadChunkCounter Source #
Increment a PayloadChunkCounter by 1.
Note that, if this operation would result in a PayloadChunkCounter that is
greater than 0xFFFFFFFFFFFFFFFFFFFFFF (i.e. the maximum integer value that
can be stored in 11 bytes), this function will return Nothing.
maxPayloadChunkCounter :: Integer Source #
Maximum payload chunk counter value (0xFFFFFFFFFFFFFFFFFFFFFF, i.e. the
maximum integer value that can be stored in 11 bytes).
data IsFinalChunk Source #
Whether this is the final payload chunk.
Constructors
| IsFinalChunk | This is the final payload chunk. |
| IsNotFinalChunk | This is not the final payload chunk. |
Instances
| Show IsFinalChunk Source # | |
Defined in Crypto.Age.Payload.Counter Methods showsPrec :: Int -> IsFinalChunk -> ShowS # show :: IsFinalChunk -> String # showList :: [IsFinalChunk] -> ShowS # | |
| Eq IsFinalChunk Source # | |
Defined in Crypto.Age.Payload.Counter | |
toChaCha20Poly1305Nonce :: IsFinalChunk -> PayloadChunkCounter -> Nonce Source #
Encode a PayloadChunkCounter as a 12-byte Nonce.