aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/asymmetric
diff options
context:
space:
mode:
Diffstat (limited to 'docs/hazmat/primitives/asymmetric')
-rw-r--r--docs/hazmat/primitives/asymmetric/dsa.rst4
-rw-r--r--docs/hazmat/primitives/asymmetric/ec.rst6
-rw-r--r--docs/hazmat/primitives/asymmetric/index.rst2
-rw-r--r--docs/hazmat/primitives/asymmetric/interfaces.rst33
-rw-r--r--docs/hazmat/primitives/asymmetric/rsa.rst20
5 files changed, 53 insertions, 12 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst
index 36bc801f..3a47da45 100644
--- a/docs/hazmat/primitives/asymmetric/dsa.rst
+++ b/docs/hazmat/primitives/asymmetric/dsa.rst
@@ -275,7 +275,7 @@ Key interfaces
provider.
:returns:
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
+ :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricSignatureContext`
.. attribute:: key_size
@@ -338,7 +338,7 @@ Key interfaces
provider.
:returns:
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricVerificationContext`
+ :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricVerificationContext`
.. class:: DSAPublicKeyWithNumbers
diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst
index 5b114710..8b9a584b 100644
--- a/docs/hazmat/primitives/asymmetric/ec.rst
+++ b/docs/hazmat/primitives/asymmetric/ec.rst
@@ -304,7 +304,7 @@ Key Interfaces
:class:`EllipticCurveSignatureAlgorithm` provider.
:returns:
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
+ :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricSignatureContext`
.. method:: public_key()
@@ -344,7 +344,7 @@ Key Interfaces
:class:`EllipticCurveSignatureAlgorithm` provider.
:returns:
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
+ :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricVerificationContext`
.. attribute:: curve
@@ -370,7 +370,7 @@ Key Interfaces
.. _`FIPS 186-4`: http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf
.. _`some concern`: https://crypto.stackexchange.com/questions/10263/should-we-trust-the-nist-recommended-ecc-parameters
.. _`less than 224 bits`: http://www.ecrypt.eu.org/documents/D.SPA.20.pdf
-.. _`64x lower computational cost than DH`: http://www.nsa.gov/business/programs/elliptic_curve.shtml
+.. _`64x lower computational cost than DH`: https://www.nsa.gov/business/programs/elliptic_curve.shtml
.. _`minimize the number of security concerns for elliptic-curve cryptography`: http://cr.yp.to/ecdh/curve25519-20060209.pdf
.. _`SafeCurves`: http://safecurves.cr.yp.to/
.. _`ECDSA`: https://en.wikipedia.org/wiki/ECDSA
diff --git a/docs/hazmat/primitives/asymmetric/index.rst b/docs/hazmat/primitives/asymmetric/index.rst
index 43761fde..59f00c5d 100644
--- a/docs/hazmat/primitives/asymmetric/index.rst
+++ b/docs/hazmat/primitives/asymmetric/index.rst
@@ -30,6 +30,8 @@ and Elliptic Curve.
ec
rsa
serialization
+ interfaces
utils
+
.. _`proof of identity`: https://en.wikipedia.org/wiki/Public-key_infrastructure
diff --git a/docs/hazmat/primitives/asymmetric/interfaces.rst b/docs/hazmat/primitives/asymmetric/interfaces.rst
new file mode 100644
index 00000000..4932faa5
--- /dev/null
+++ b/docs/hazmat/primitives/asymmetric/interfaces.rst
@@ -0,0 +1,33 @@
+.. hazmat::
+
+.. module:: cryptography.hazmat.primitives.asymmetric
+
+Signature Interfaces
+====================
+
+.. class:: AsymmetricSignatureContext
+
+ .. versionadded:: 0.2
+
+ .. method:: update(data)
+
+ :param bytes data: The data you want to sign.
+
+ .. method:: finalize()
+
+ :return bytes signature: The signature.
+
+
+.. class:: AsymmetricVerificationContext
+
+ .. versionadded:: 0.2
+
+ .. method:: update(data)
+
+ :param bytes data: The data you wish to verify using the signature.
+
+ .. method:: verify()
+
+ :raises cryptography.exceptions.InvalidSignature: If the signature does
+ not validate.
+
diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst
index 4855a45c..fd97d75b 100644
--- a/docs/hazmat/primitives/asymmetric/rsa.rst
+++ b/docs/hazmat/primitives/asymmetric/rsa.rst
@@ -186,7 +186,13 @@ Once you have an encrypted message, it can be decrypted using the private key:
Padding
~~~~~~~
-.. currentmodule:: cryptography.hazmat.primitives.asymmetric.padding
+.. module:: cryptography.hazmat.primitives.asymmetric.padding
+
+.. class:: AsymmetricPadding
+
+ .. versionadded:: 0.2
+
+ .. attribute:: name
.. class:: PSS(mgf, salt_length)
@@ -425,7 +431,7 @@ Key interfaces
Sign data which can be verified later by others using the public key.
:param padding: An instance of a
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
+ :class:`~cryptography.hazmat.primitives.asymmetric.padding.AsymmetricPadding`
provider.
:param algorithm: An instance of a
@@ -433,7 +439,7 @@ Key interfaces
provider.
:returns:
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
+ :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricSignatureContext`
.. method:: decrypt(ciphertext, padding)
@@ -444,7 +450,7 @@ Key interfaces
:param bytes ciphertext: The ciphertext to decrypt.
:param padding: An instance of an
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
+ :class:`~cryptography.hazmat.primitives.asymmetric.padding.AsymmetricPadding`
provider.
:return bytes: Decrypted data.
@@ -495,7 +501,7 @@ Key interfaces
:param bytes signature: The signature to verify.
:param padding: An instance of a
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
+ :class:`~cryptography.hazmat.primitives.asymmetric.padding.AsymmetricPadding`
provider.
:param algorithm: An instance of a
@@ -503,7 +509,7 @@ Key interfaces
provider.
:returns:
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricVerificationContext`
+ :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricVerificationContext`
.. method:: encrypt(plaintext, padding)
@@ -514,7 +520,7 @@ Key interfaces
:param bytes plaintext: The plaintext to encrypt.
:param padding: An instance of a
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
+ :class:`~cryptography.hazmat.primitives.asymmetric.padding.AsymmetricPadding`
provider.
:return bytes: Encrypted data.