diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2015-10-27 09:02:36 +0900 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2015-10-27 09:02:36 +0900 |
| commit | d9cfab3fe2d9772d4f5812377a89d40624d20673 (patch) | |
| tree | 447ed0faf0af3a4fc89ffd61071f81c303b42589 /docs/hazmat/primitives/asymmetric/utils.rst | |
| parent | 467072f7d50778f064f192b4e318c19c6cf98293 (diff) | |
| download | cryptography-d9cfab3fe2d9772d4f5812377a89d40624d20673.tar.gz cryptography-d9cfab3fe2d9772d4f5812377a89d40624d20673.tar.bz2 cryptography-d9cfab3fe2d9772d4f5812377a89d40624d20673.zip | |
fix some docs
Diffstat (limited to 'docs/hazmat/primitives/asymmetric/utils.rst')
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/utils.rst | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/docs/hazmat/primitives/asymmetric/utils.rst b/docs/hazmat/primitives/asymmetric/utils.rst index 825fe3c1..e67dd734 100644 --- a/docs/hazmat/primitives/asymmetric/utils.rst +++ b/docs/hazmat/primitives/asymmetric/utils.rst @@ -34,10 +34,12 @@ Asymmetric Utilities .. versionadded:: 1.1 Encodes an elliptic curve point to a byte string as described in - _`SEC 1 v2.0` section 2.3.3. This function only supports uncompressed + `SEC 1 v2.0`_ section 2.3.3. This function only supports uncompressed points. - :param curve: A :class:`EllipticCurve` provider. + :param curve: A + :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurve` + provider. :param x: The x value of the point. @@ -47,17 +49,20 @@ Asymmetric Utilities :return bytes: The encoded point. - :raises TypeError: Raised when curve is not an :class:`EllipticCurve`. + :raises TypeError: Raised when curve is not an + :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurve`. .. function:: decode_ec_point(key_length, data) .. versionadded:: 1.1 - Decodes a byte string as described in _`SEC 1 v2.0` section 2.3.3 to the + Decodes a byte string as described in `SEC 1 v2.0`_ section 2.3.3 to the ``x`` and ``y`` integer values. This function only supports uncompressed points. - :param curve: A :class:`EllipticCurve` provider. + :param curve: A + :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurve` + provider. :param bytes data: The serialized point byte string. @@ -65,7 +70,8 @@ Asymmetric Utilities :raises ValueError: Raised on invalid point type or data length. - :raises TypeError: Raised when curve is not an :class:`EllipticCurve`. + :raises TypeError: Raised when curve is not an + :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurve`. .. _`SEC 1 v2.0`: http://www.secg.org/sec1-v2.pdf |