diff options
| author | root <sina@snix.ir> | 2022-07-24 04:59:38 +0000 |
|---|---|---|
| committer | root <sina@snix.ir> | 2022-07-24 04:59:38 +0000 |
| commit | d62eb3933af344a019a07a3aae25e28d176aa493 (patch) | |
| tree | 45a89b057393fe97fbc89c13dcaeda09e90d05a7 | |
| parent | ceb0457abe923746acd4eced87a0733d9c816000 (diff) | |
update readme
| -rw-r--r-- | Readme.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -7,7 +7,7 @@ with associated io chunk and io stream interfaces. - **open**: opens a rabbit aead ciphertext. **panic** occurs if nonce len is not equal to IVXLen (8byte) or zero <p align="center"> - <img src="seal.png" alt="seal"/> + <img src="https://git.snix.ir/rabaead/seal.png" alt="seal"/> </p> @@ -17,7 +17,7 @@ with associated io chunk and io stream interfaces. - **chunkReader**: seal() and write data in chunks, there is 8byte + 16byte overhead per chunk. this writer has a chunk size in-memory buffer, large chunk size can make application to runs out of memory, thus this is most suitable for sliced data, like network data transmit and so.. <p align="center"> - <img src="chunkio.png" alt="chunkio"/> + <img src="https://git.snix.ir/rabaead/chunkio.png" alt="chunkio"/> </p> - **streamReader**: this reader open() and read aead ciphertext which have 16-byte poly1305 tag overhead. **read data is unreliable until underlying reader returns EOF**, after that Read return EOF or ErrAuthMsg if integrity of data has been compromised. in such a case, you need to unread data. a simple demonstration would be to delete or truncate the file if ErrAuthMsg is returned |