aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/asymmetric/ec.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2016-11-19 09:49:10 +0800
committerAlex Gaynor <alex.gaynor@gmail.com>2016-11-18 20:49:10 -0500
commit533a3c909d59698259456233041a3d4e232bf87e (patch)
treea6b443972c93af54ac4cba0e04705243fc4feb00 /docs/hazmat/primitives/asymmetric/ec.rst
parente929c3c613d5ba5bd8f0c6ba08563a211ef70601 (diff)
downloadcryptography-533a3c909d59698259456233041a3d4e232bf87e.tar.gz
cryptography-533a3c909d59698259456233041a3d4e232bf87e.tar.bz2
cryptography-533a3c909d59698259456233041a3d4e232bf87e.zip
change derive_elliptic_curve_public_point to return EllipticCurvePubl… (#3243)
* change derive_elliptic_curve_public_point to return EllipticCurvePublicKey * also rename the backend interface method * review feedback * Rename to derive_elliptic_curve_private_key * Returns EllipticCurvePrivateKey * Reuses the EC_POINT in the openssl impl * Rename "secret" arg to "private_value" which is consistent with our naming for the value in ECPrivateNumbers.
Diffstat (limited to 'docs/hazmat/primitives/asymmetric/ec.rst')
-rw-r--r--docs/hazmat/primitives/asymmetric/ec.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst
index 33ebee0f..27debfa1 100644
--- a/docs/hazmat/primitives/asymmetric/ec.rst
+++ b/docs/hazmat/primitives/asymmetric/ec.rst
@@ -20,13 +20,14 @@ Elliptic curve cryptography
:returns: A new instance of :class:`EllipticCurvePrivateKey`.
-.. function:: derive_private_key(secret, curve, backend)
+.. function:: derive_private_key(private_value, curve, backend)
.. versionadded:: 1.6
- Derive a private key from ``secret`` on ``curve`` for use with ``backend``.
+ Derive a private key from ``private_value`` on ``curve`` for use with
+ ``backend``.
- :param int secret: The secret scalar value.
+ :param int private_value: The secret scalar value.
:param curve: An instance of :class:`EllipticCurve`.