summaryrefslogtreecommitdiffstats
path: root/security/nss/doc/rst/legacy/reference/fc_signrecoverinit/index.rst
blob: 8fd7a9027aa26fb0a2832ccbca12aa0ff5e66aa5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.. _mozilla_projects_nss_reference_fc_signrecoverinit:

FC_SignRecoverInit
==================

`Name <#name>`__
~~~~~~~~~~~~~~~~

.. container::

   FC_SignRecoverInit - initialize a sign recover operation.

`Syntax <#syntax>`__
~~~~~~~~~~~~~~~~~~~~

.. container::

   .. code::

      CK_RV FC_SignRecoverInit(
        CK_SESSION_HANDLE hSession,
        CK_MECHANISM_PTR pMechanism,
        CK_OBJECT_HANDLE hKey
      );

`Parameters <#parameters>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   ``hSession``
      [in] session handle.
   ``pMechanism``
      [in] mechanism to be used for the signing operation.
   ``hKey``
      [in] handle of the key to be used.

`Description <#description>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   ``FC_SignRecoverInit`` initializes a initializes a signature operation where the (digest) data
   can be recovered from the signature.

   A user must log into the token (to assume the NSS User role) before calling
   ``FC_SignRecoverInit``.

.. _return_value:

`Return value <#return_value>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

`Examples <#examples>`__
~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

.. _see_also:

`See also <#see_also>`__
~~~~~~~~~~~~~~~~~~~~~~~~

.. container::

   -  `NSC_SignRecoverInit </en-US/NSC_SignRecoverInit>`__