updates docs

pull/1/head v3.14.0-1
Moisés Guimarães 2018-03-19 22:07:53 +01:00
parent 9e087d578b
commit 07b547b80c
5 changed files with 27 additions and 21 deletions

View File

@ -49,6 +49,7 @@ clean-test: ## remove test and coverage artifacts
lint: ## check style with flake8 lint: ## check style with flake8
flake8 src tests flake8 src tests
pylint src tests/*
test: install ## run tests quickly with the default Python test: install ## run tests quickly with the default Python
py.test tests py.test tests

View File

@ -20,8 +20,7 @@ RSA
:members: :members:
:inherited-members: :inherited-members:
Example **Example:**
~~~~~~~
>>> from wolfcrypt.ciphers import RsaPrivate, RsaPublic >>> from wolfcrypt.ciphers import RsaPrivate, RsaPublic
>>> from wolfcrypt.utils import h2b >>> from wolfcrypt.utils import h2b

View File

@ -7,17 +7,25 @@ Symmetric Key Algorithms
cryptographic key** for both encryption and decryption of data. cryptographic key** for both encryption and decryption of data.
This operation is also known as **Symmetric Key Encryption**. This operation is also known as **Symmetric Key Encryption**.
``wolfcrypt`` provides access to the following **Symmetric Key Ciphers**: Symmetric Key Encryption Classes
--------------------------------
Interface
~~~~~~~~~
All **Symmetric Key Ciphers** available in this module implements the following
interface:
.. autoclass:: _Cipher
:members:
AES AES
--- ~~~
.. autoclass:: Aes .. autoclass:: Aes
:members: :members:
:inherited-members:
Example **Example:**
~~~~~~~
.. doctest:: .. doctest::
@ -31,14 +39,12 @@ Example
b'now is the time ' b'now is the time '
Triple DES Triple DES
---------- ~~~~~~~~~~
.. autoclass:: Des3 .. autoclass:: Des3
:members: :members:
:inherited-members:
Example **Example:**
~~~~~~~
.. doctest:: .. doctest::

View File

@ -308,7 +308,7 @@ def test_ecc_make_shared_secret():
b_pub = EccPublic() b_pub = EccPublic()
b_pub.import_x963(b.export_x963()) b_pub.import_x963(b.export_x963())
assert a.shared_secret(b) == \ assert a.shared_secret(b) \
b.shared_secret(a) == \ == b.shared_secret(a) \
a.shared_secret(b_pub) == \ == a.shared_secret(b_pub) \
b.shared_secret(a_pub) == b.shared_secret(a_pub)