diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2015-08-10 11:59:38 -0500 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2015-08-10 13:18:50 -0500 |
| commit | 31c5c3376dee8342ccfdb3fadb481d3c4156382c (patch) | |
| tree | 6d8cadddf031ed219e5899a6d5c61a97db42f4a9 /docs/hazmat/primitives/asymmetric/utils.rst | |
| parent | f9aa0bccac8656067a12b6ff6168f1cc2736beeb (diff) | |
| download | cryptography-31c5c3376dee8342ccfdb3fadb481d3c4156382c.tar.gz cryptography-31c5c3376dee8342ccfdb3fadb481d3c4156382c.tar.bz2 cryptography-31c5c3376dee8342ccfdb3fadb481d3c4156382c.zip | |
resolve incorrect docs/naming around DSA (r, s) tuple encode/decode
Diffstat (limited to 'docs/hazmat/primitives/asymmetric/utils.rst')
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/utils.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/hazmat/primitives/asymmetric/utils.rst b/docs/hazmat/primitives/asymmetric/utils.rst index 7380f0b5..07883598 100644 --- a/docs/hazmat/primitives/asymmetric/utils.rst +++ b/docs/hazmat/primitives/asymmetric/utils.rst @@ -6,10 +6,11 @@ Asymmetric Utilities .. currentmodule:: cryptography.hazmat.primitives.asymmetric.utils -.. function:: decode_rfc6979_signature(signature) +.. function:: decode_dss_signature(signature) - Takes in :rfc:`6979` signatures generated by the DSA/ECDSA signers and - returns a tuple ``(r, s)``. + Takes in signatures generated by the DSA/ECDSA signers and returns a + tuple ``(r, s)``. These signatures are ASN.1 encoded ``Dss-Sig-Value`` + sequences (as defined in :rfc:`3279`) :param bytes signature: The signature to decode. @@ -17,9 +18,10 @@ Asymmetric Utilities :raises ValueError: Raised if the signature is malformed. -.. function:: encode_rfc6979_signature(r, s) +.. function:: encode_dss_signature(r, s) - Creates an :rfc:`6979` byte string from raw signature values. + Creates an ASN.1 encoded ``Dss-Sig-Value`` (as defined in :rfc:`3279`) from + raw ``r`` and ``s`` values. :param int r: The raw signature value ``r``. |