summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/cryptolib.rst
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2021-08-12 13:56:13 +1000
committerDamien George <damien@micropython.org>2021-08-13 20:31:32 +1000
commit218606351c6f9688a3f90dad791bcb2109adcf1b (patch)
treede051ee21f5ccac3aaccfe3865ab5818f81fca37 /docs/library/cryptolib.rst
parent671f012306e0942cbe59fcd43e25e67c289da351 (diff)
downloadmicropython-218606351c6f9688a3f90dad791bcb2109adcf1b.tar.gz
micropython-218606351c6f9688a3f90dad791bcb2109adcf1b.zip
docs: Rename ufoo.rst to foo.rst.
This is a simple rename of the files, no content changes (other than updating index.rst to use the new paths) Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Diffstat (limited to 'docs/library/cryptolib.rst')
-rw-r--r--docs/library/cryptolib.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/library/cryptolib.rst b/docs/library/cryptolib.rst
new file mode 100644
index 0000000000..79471c2e90
--- /dev/null
+++ b/docs/library/cryptolib.rst
@@ -0,0 +1,40 @@
+:mod:`ucryptolib` -- cryptographic ciphers
+==========================================
+
+.. module:: ucryptolib
+ :synopsis: cryptographic ciphers
+
+Classes
+-------
+
+.. class:: aes
+
+ .. classmethod:: __init__(key, mode, [IV])
+
+ Initialize cipher object, suitable for encryption/decryption. Note:
+ after initialization, cipher object can be use only either for
+ encryption or decryption. Running decrypt() operation after encrypt()
+ or vice versa is not supported.
+
+ Parameters are:
+
+ * *key* is an encryption/decryption key (bytes-like).
+ * *mode* is:
+
+ * ``1`` (or ``ucryptolib.MODE_ECB`` if it exists) for Electronic Code Book (ECB).
+ * ``2`` (or ``ucryptolib.MODE_CBC`` if it exists) for Cipher Block Chaining (CBC).
+ * ``6`` (or ``ucryptolib.MODE_CTR`` if it exists) for Counter mode (CTR).
+
+ * *IV* is an initialization vector for CBC mode.
+ * For Counter mode, *IV* is the initial value for the counter.
+
+ .. method:: encrypt(in_buf, [out_buf])
+
+ Encrypt *in_buf*. If no *out_buf* is given result is returned as a
+ newly allocated `bytes` object. Otherwise, result is written into
+ mutable buffer *out_buf*. *in_buf* and *out_buf* can also refer
+ to the same mutable buffer, in which case data is encrypted in-place.
+
+ .. method:: decrypt(in_buf, [out_buf])
+
+ Like `encrypt()`, but for decryption.