summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_digestkey/index.rst
blob: df6102b2dc1e88ecf86116f67485bdb8d3e1080e (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
.. _mozilla_projects_nss_reference_fc_digestkey:

FC_DigestKey
============

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

.. container::

   FC_DigestKey - add the digest of a key to a multi-part digest operation.

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

.. container::

   .. code:: eval

      CK_RV FC_DigestKey(
        CK_SESSION_HANDLE hSession,
        CK_OBJECT_HANDLE hKey
      );

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

.. container::

   ``hSession``
      [in] session handle.
   ``hKey``
      [in] handle of the key to be digested.

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

.. container::

   ``FC_DigestKey`` continues a multi-part digest operation by digesting the value of a secret key.
   The digest for the entire message is returned by a call to
   :ref:`mozilla_projects_nss_reference_fc_digestfinal`.

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

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

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