summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_verify/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rst/legacy/reference/fc_verify/index.rst')
-rw-r--r--doc/rst/legacy/reference/fc_verify/index.rst75
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/rst/legacy/reference/fc_verify/index.rst b/doc/rst/legacy/reference/fc_verify/index.rst
new file mode 100644
index 000000000..c1588e740
--- /dev/null
+++ b/doc/rst/legacy/reference/fc_verify/index.rst
@@ -0,0 +1,75 @@
+.. _mozilla_projects_nss_reference_fc_verify:
+
+FC_Verify
+=========
+
+`Name <#name>`__
+~~~~~~~~~~~~~~~~
+
+.. container::
+
+ FC_Verify - sign a block of data.
+
+`Syntax <#syntax>`__
+~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ .. code:: eval
+
+ CK_RV FC_Verify(
+ CK_SESSION_HANDLE hSession,
+ CK_BYTE_PTR pData,
+ CK_ULONG usDataLen,
+ CK_BYTE_PTR pSignature,
+ CK_ULONG usSignatureLen
+ );
+
+`Parameters <#parameters>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``hSession``
+ [in] session handle.
+ ``pData``
+ [in] pointer to data block.
+ ``usDataLen``
+ [in] length of the data in bytes.
+ ``pSignature``
+ [in] pointer to the signature.
+ ``usSignatureLen``
+ [in] length of the signature in bytes.
+
+`Description <#description>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``FC_Verify`` verifies a signature in a single-part operation, where the signature is an appendix
+ to the data.
+
+ A user must log into the token (to assume the NSS User role) before calling ``FC_Verify``.
+
+.. _return_value:
+
+`Return value <#return_value>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ ``CKR_OK`` is returned on success. ``CKR_SIGNATURE_INVALID`` is returned for signature mismatch.
+
+`Examples <#examples>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+.. _see_also:
+
+`See also <#see_also>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container::
+
+ - :ref:`mozilla_projects_nss_reference_fc_verifyinit`, `NSC_Verify </en-US/NSC_Verify>`__ \ No newline at end of file