diff options
author | Benjamin Beurdouche <bbeurdouche@mozilla.com> | 2022-01-28 19:34:47 +0100 |
---|---|---|
committer | Benjamin Beurdouche <bbeurdouche@mozilla.com> | 2022-01-28 19:34:47 +0100 |
commit | 0bc3a823701633901130766e83684ae4e13096d4 (patch) | |
tree | 18b7786784893ea62fa873e7d1fd316617b1dc1f /doc/rst/legacy/reference/fc_signrecover/index.rst | |
parent | 1378f8355e07050e9cbd6e44a87af86cbef5c972 (diff) | |
download | nss-hg-0bc3a823701633901130766e83684ae4e13096d4.tar.gz |
Documentation: import legacy documentation from MDN
Differential Revision: https://phabricator.services.mozilla.com/D137312
Diffstat (limited to 'doc/rst/legacy/reference/fc_signrecover/index.rst')
-rw-r--r-- | doc/rst/legacy/reference/fc_signrecover/index.rst | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/rst/legacy/reference/fc_signrecover/index.rst b/doc/rst/legacy/reference/fc_signrecover/index.rst new file mode 100644 index 000000000..4b99bfdf6 --- /dev/null +++ b/doc/rst/legacy/reference/fc_signrecover/index.rst @@ -0,0 +1,75 @@ +.. _mozilla_projects_nss_reference_fc_signrecover: + +FC_SignRecover +============== + +`Name <#name>`__ +~~~~~~~~~~~~~~~~ + +.. container:: + + FC_SignRecover - Sign data in a single recoverable operation. + +`Syntax <#syntax>`__ +~~~~~~~~~~~~~~~~~~~~ + +.. container:: + + .. code:: eval + + CK_RV FC_SignRecover( + CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pData, + CK_ULONG usDataLen, + CK_BYTE_PTR pSignature, + CK_ULONG_PTR pusSignatureLen + ); + +`Parameters <#parameters>`__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. container:: + + ``hSession`` + [in] session handle. + ``pData`` + [in] mechanism to be used for the signing operation. + ``usDataLen`` + [in] handle of the key to be usedn. + ``pSignature`` + [out] pointer to the buffer or NULL. + ``pusSignatureLen`` + [in, out] pointer to the size of the output buffer, replaced by the length of the signature if + the operation is successful. + +`Description <#description>`__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. container:: + + ``FC_SignRecover`` signs data in a single operation where the (digest) data can be recovered from + the signature. If ``pSignature`` is NULL only the length of the signature is returned in + ``*pusSignatureLen``. + + A user must log into the token (to assume the NSS User role) before calling ``FC_SignRecover``. + +.. _return_value: + +`Return value <#return_value>`__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. container:: + +`Examples <#examples>`__ +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. container:: + +.. _see_also: + +`See also <#see_also>`__ +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. container:: + + - `NSC_SignRecover </en-US/NSC_SignRecover>`__
\ No newline at end of file |