summaryrefslogtreecommitdiffstats
path: root/security/nss/doc/rst/legacy/reference/fc_sign/index.rst
blob: f1bc78658796923fbccb4914d33488e1a6368e59 (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
69
70
71
72
73
74
.. _mozilla_projects_nss_reference_fc_sign:

FC_Sign
=======

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

.. container::

   FC_Sign - sign a block of data.

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

.. container::

   .. code::

      CK_RV FC_Sign(
        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] pointer to data block.
   ``usDataLen``
      [in] length of the data in bytes.
   ``pSignature``
      [out] pointer to location where recovered data is to be stored.
   ``pusSignatureLen``
      [in, out] pointer to the maximum size of the output buffer, replaced by the length of the
      signature if the operation is successful.

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

.. container::

   ``FC_Sign`` signs a message in a single operation according to the attributes of the previous
   call to ``FC_SignInit``.

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

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

   -  :ref:`mozilla_projects_nss_reference_fc_signinit`, `NSC_Sign </en-US/NSC_Sign>`__