blob: afec6227752af8e7032cc5e7bde8ee400f0b8d03 (
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
75
76
77
78
79
80
81
82
83
|
.. _mozilla_projects_nss_reference_fc_unwrapkey:
FC_UnwrapKey
============
`Name <#name>`__
~~~~~~~~~~~~~~~~
.. container::
FC_UnwrapKey - unwrap a key
`Syntax <#syntax>`__
~~~~~~~~~~~~~~~~~~~~
.. container::
.. code::
CK_RV FC_UnwrapKey(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hUnwrappingKey,
CK_BYTE_PTR pWrappedKey,
CK_ULONG usWrappedKeyLen,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG usAttributeCount,
CK_OBJECT_HANDLE_PTR phKey
);
`Parameters <#parameters>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. container::
``hSession``
[in] session handle.
``pMechanism``
[in] pointer to the mechanism to use.
``hUnwrappingKey``
[in] handle of the ket to use for unwrapping.
``pWrappedKey``
[in] pointer to the wrapped key.
``usWrappedKeyLen``
[in] length of the wrapped key.
``pTemplate``
[in] pointer to the list of attributes for the unwrapped key.
``usAttributeCount``
[in] number of attributes in the template.
``phKey``
[out] pointer to the location to receive the handle of the unwrapped key.
`Description <#description>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. container::
``FC_UnwrapKey`` unwraps (decrypts) a key and creates a new key opbject. If ``pWrappedKey`` is
NULL the length of the wrapped key is returned in ``pusWrappedKeyLen`` and FC_UnwrapKey may be
called again with ``pWrappedKey`` set to retrieve the wrapped key.
A user must log into the token (to assume the NSS User role) before calling ``FC_UnwrapKey``.
.. _return_value:
`Return value <#return_value>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. container::
`Examples <#examples>`__
~~~~~~~~~~~~~~~~~~~~~~~~
.. container::
.. _see_also:
`See also <#see_also>`__
~~~~~~~~~~~~~~~~~~~~~~~~
.. container::
- `NSC_UnwrapKey </en-US/NSC_UnwrapKey>`__
|
