summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2018-01-10 21:47:08 +0200
committerDamien George <damien.p.george@gmail.com>2018-06-27 14:57:11 +1000
commit12fde67a2593447f12b3430efa10636f622d2dd8 (patch)
tree82e58a5650c0aae7d434c7583ae224989dd3f469 /docs/library
parent771911028c7fb9cfee701d7348b52f3985c28a22 (diff)
docs/ucryptolib: Add docs for new ucryptolib module.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/index.rst1
-rw-r--r--docs/library/ucryptolib.rst38
2 files changed, 39 insertions, 0 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst
index d5678d37e..40fe641c8 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -179,6 +179,7 @@ the following libraries.
machine.rst
micropython.rst
network.rst
+ ucryptolib.rst
uctypes.rst
diff --git a/docs/library/ucryptolib.rst b/docs/library/ucryptolib.rst
new file mode 100644
index 000000000..4b2c45f07
--- /dev/null
+++ b/docs/library/ucryptolib.rst
@@ -0,0 +1,38 @@
+: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 for Electronic Code Book (ECB).
+ * 2 for Cipher Block Chaining (CBC)
+
+ * *IV* is an initialization vector for CBC mode.
+
+ .. 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.