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