commit 565f588552002b4c121c3921b557b9cb17e48ada
parent 7f432b06a0a1b2f92baf50b689533209251e1c58
Author: Sebastian <sebastian@sebsite.pw>
Date: Sun, 27 Aug 2023 03:07:56 -0400
crypto: s/SIZE/SZ/g in READMEs
Signed-off-by: Sebastian <sebastian@sebsite.pw>
Diffstat:
5 files changed, 14 insertions(+), 15 deletions(-)
diff --git a/crypto/aes/README b/crypto/aes/README
@@ -4,8 +4,8 @@ AES are provided which are optimized for different scenarios. To choose the most
appropriate one for your system, use [[aes]].
When combined with a block cipher mode from [[crypto::cipher]], suitable buffer
-lengths for static allocation are provided as constants such as [[BLOCKSIZE]],
-[[CTR_BUFSIZE]], and [[CBC_BUFSIZE]].
+lengths for static allocation are provided as constants such as [[BLOOCKSZ]],
+[[CTR_BUFSZ]], and [[CBC_BUFSZ]].
This is a low-level module which implements cryptographic primitives. Direct use
of cryptographic primitives is not recommended for non-experts, as incorrect use
diff --git a/crypto/blowfish/README b/crypto/blowfish/README
@@ -4,7 +4,7 @@ use of this algorithm is not recommended except for legacy use-cases; prefer
[[crypto::aes]] when possible.
When combined with a block cipher mode from [[crypto::cipher]], suitable buffer
-lengths for static allocation are provided as constants such as [[BLOCKSIZE]].
+lengths for static allocation are provided as constants such as [[BLOCKSZ]].
This is a low-level module which implements cryptographic primitives. Direct use
of cryptographic primitives is not recommended for non-experts, as incorrect use
diff --git a/crypto/chacha/README b/crypto/chacha/README
@@ -3,14 +3,13 @@ ciphers.
Use [[chacha20]] to create a [[crypto::cipher::xorstream]] and either
[[chacha20_init]] or [[xchacha20_init]] to set the handle, key and nonce of the
-appropriate size, [[NONCESIZE]] for chacha20 or [[XNONCESIZE]] for XChacha20.
-After calling the appropriate init function, [[io::write]] may be used to
-encrypt blocks to the handle or [[io::read]] to decrypt blocks from the handle.
-The stream must be closed with [[io::close]] to wipe sensitive data from
-memory.
+appropriate size, [[NONCESZ]] for chacha20 or [[XNONCESZ]] for XChacha20. After
+calling the appropriate init function, [[io::write]] may be used to encrypt
+blocks to the handle or [[io::read]] to decrypt blocks from the handle. The
+stream must be closed with [[io::close]] to wipe sensitive data from memory.
-Writing blocks of length [[BLOCKSIZE]] is not required. However, seeking the
-key stream with [[setctr]] only operates in units of [[BLOCKSIZE]].
+Writing blocks of length [[BLOCKSZ]] is not required. However, seeking the key
+stream with [[setctr]] only operates in units of [[BLOCKSZ]].
This is a low-level module which implements cryptographic primitives. Direct
use of cryptographic primitives is not recommended for non-experts, as
diff --git a/crypto/rsa/README b/crypto/rsa/README
@@ -1,8 +1,8 @@
This module provides RSA signature and encryption schemes defined in PKCS #1.
The implementation only supports RSA keys with two prime factors. Most of the
RSA operations in this module require buffers to perform. Buffer sizes are
-provided for keys of a default maximum size of 4096-bits. [[BITSIZE]]
-may be changed with compiler flags to support bigger keys. [[MINBITSIZE]]
+provided for keys of a default maximum size of 4096-bits. [[BITSZ]]
+may be changed with compiler flags to support bigger keys. [[MINBITSZ]]
defines the minimum size accordingly.
Public and private keys are stored in byte slices. [[pubkey_init]] is used
diff --git a/crypto/salsa/README b/crypto/salsa/README
@@ -3,13 +3,13 @@ ciphers, per "Salsa20 specification" by Daniel J. Bernstein.
Use [[salsa20]] to create a stream and either [[xsalsa20_init]] or
[[salsa20_init]] to set handle, key and nonce of the appropriate size,
-[[NONCESIZE]] for salsa20 or [[XNONCESIZE]] for XSalsa20. After calling the
+[[NONCESZ]] for salsa20 or [[XNONCESZ]] for XSalsa20. After calling the
appropriate init function, [[io::write]] may be used to encrypt blocks to the
handle or [[io::read]] to decrypt blocks from the handle. The stream must be
closed with [[io::close]] to wipe sensitive data from memory.
-Writing blocks of length [[BLOCKSIZE]] is not required. However, seeking the key
-stream with [[setctr]] only operates in units of [[BLOCKSIZE]].
+Writing blocks of length [[BLOCKSZ]] is not required. However, seeking the key
+stream with [[setctr]] only operates in units of [[BLOCKSZ]].
This is a low-level module which implements cryptographic primitives. Direct use
of cryptographic primitives is not recommended for non-experts, as incorrect use
