summaryrefslogtreecommitdiff
path: root/doc/rst/legacy/reference/fc_decrypt/index.rst
blob: 75fd869a9e5081e970ce1a0d046de2c305746807 (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
.. _mozilla_projects_nss_reference_fc_decrypt:

FC_Decrypt
==========

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

.. container::

   FC_Decrypt - Decrypt a block of data.

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

.. container::

   .. code:: eval

      CK_RV FC_Decrypt(
        CK_SESSION_HANDLE hSession,
        CK_BYTE_PTR pEncryptedData,
        CK_ULONG usEncryptedDataLen,
        CK_BYTE_PTR pData,
        CK_ULONG_PTR pusDataLen
      );

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

.. container::

   ``hSession``
      [in] session handle.
   ``pEncryptedData``
      [in] pointer to encrypted data block.
   ``usEncryptedDataLen``
      [in] length of the data in bytes.
   ``pData``
      [out] pointer to location where recovered data is to be stored.
   ``pusDataLen``
      [in,out] pointer to location where the length of recovered data is to be stored.

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

.. container::

   ``FC_Decrypt`` decrypts a block of data according to the attributes of the previous call to
   ``FC_DecryptInit``.

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

.. _return_value:

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

.. container::

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

.. container::

.. _see_also:

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

.. container::

   -  :ref:`mozilla_projects_nss_reference_fc_decryptinit`, `NSC_Decrypt </en-US/NSC_Decrypt>`__