summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_digest/index.rst
blob: 872a7db6947f2a8314def1d881ef272df9417a99 (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_digest:

FC_Digest
=========

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

.. container::

   FC_Digest - digest a block of data.

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

.. container::

   .. code:: eval

      CK_RV FC_Digest(
        CK_SESSION_HANDLE hSession,
        CK_BYTE_PTR pData,
        CK_ULONG usDataLen,
        CK_BYTE_PTR pDigest,
        CK_ULONG_PTR pusDigestLen
      );

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

.. container::

   ``hSession``
      [in] session handle.
   ``pData``
      [in] pointer to data block.
   ``usDataLen``
      [in] length of the data in bytes.
   ``pDigest``
      [out] pointer to location where recovered data is to be stored.
   ``pusDigestLen``
      [in, out] pointer to the maximum size of the output buffer, replaced by the length of the
      message digest if the operation is successful.

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

.. container::

   ``FC_Digest`` digests a message in a single operation according to the attributes of the previous
   call to ``FC_DigestInit``.

   A user may call ``FC_Digest`` without logging into the token (to assume the NSS User role).

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

   -  :ref:`mozilla_projects_nss_reference_fc_digestinit`, `NSC_Digest </en-US/NSC_Digest>`__