index.rst (1922B)
1 .. _mozilla_projects_nss_reference_fc_unwrapkey: 2 3 FC_UnwrapKey 4 ============ 5 6 `Name <#name>`__ 7 ~~~~~~~~~~~~~~~~ 8 9 .. container:: 10 11 FC_UnwrapKey - unwrap a key 12 13 `Syntax <#syntax>`__ 14 ~~~~~~~~~~~~~~~~~~~~ 15 16 .. container:: 17 18 .. code:: 19 20 CK_RV FC_UnwrapKey( 21 CK_SESSION_HANDLE hSession, 22 CK_MECHANISM_PTR pMechanism, 23 CK_OBJECT_HANDLE hUnwrappingKey, 24 CK_BYTE_PTR pWrappedKey, 25 CK_ULONG usWrappedKeyLen, 26 CK_ATTRIBUTE_PTR pTemplate, 27 CK_ULONG usAttributeCount, 28 CK_OBJECT_HANDLE_PTR phKey 29 ); 30 31 `Parameters <#parameters>`__ 32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 33 34 .. container:: 35 36 ``hSession`` 37 [in] session handle. 38 ``pMechanism`` 39 [in] pointer to the mechanism to use. 40 ``hUnwrappingKey`` 41 [in] handle of the ket to use for unwrapping. 42 ``pWrappedKey`` 43 [in] pointer to the wrapped key. 44 ``usWrappedKeyLen`` 45 [in] length of the wrapped key. 46 ``pTemplate`` 47 [in] pointer to the list of attributes for the unwrapped key. 48 ``usAttributeCount`` 49 [in] number of attributes in the template. 50 ``phKey`` 51 [out] pointer to the location to receive the handle of the unwrapped key. 52 53 `Description <#description>`__ 54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 55 56 .. container:: 57 58 ``FC_UnwrapKey`` unwraps (decrypts) a key and creates a new key opbject. If ``pWrappedKey`` is 59 NULL the length of the wrapped key is returned in ``pusWrappedKeyLen`` and FC_UnwrapKey may be 60 called again with ``pWrappedKey`` set to retrieve the wrapped key. 61 62 A user must log into the token (to assume the NSS User role) before calling ``FC_UnwrapKey``. 63 64 .. _return_value: 65 66 `Return value <#return_value>`__ 67 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 68 69 .. container:: 70 71 `Examples <#examples>`__ 72 ~~~~~~~~~~~~~~~~~~~~~~~~ 73 74 .. container:: 75 76 .. _see_also: 77 78 `See also <#see_also>`__ 79 ~~~~~~~~~~~~~~~~~~~~~~~~ 80 81 .. container:: 82 83 - `NSC_UnwrapKey </en-US/NSC_UnwrapKey>`__