NSSSSetEPMasterPassword

A special function for use by administrative utilities.

Syntax

    #include <nssscl.h> 
     
    SS_EXTERN_LIBCALL(int) NSSSSetEPMasterPassword 
    (
     SSS_CONTEXT_T    *callerContext, 
     SS_OBJECT_DN_T   *targetObjDN, 
     unsigned long     ssFlags, 
     SS_PWORD_T       *password, 
     SS_HINT_T        *hint, 
     SS_EXT_T         *ext
    );

Parameters

callerContext
(IN) Points to an optional structure that can be initialized by making a call to NSSSGetServiceInformation prior to use here. The flags field of the structure can take on the following values to indicate the type of context used.NSSS_NCP_CTX_F—Directory Service API context indicator flagNSSS_LDAP_CTX_F—LDAP context indicator flag <reserved>
targetObject
(IN) Points to the optional RDN (relative distinguished name or "short name") of the target object that contains the user's secrets. The caller should have at least READ/WRITE privileges over the target object.
ssFlags
(IN) Specifies the set of flags for initializing secrets:

Value

Description

NSSS_ALL_STRINGS_UNICODE_F

Indicates that all applicable char strings such as targetObject, secretID, etc., are already in Unicode and the API does not need to perform conversion from local code page to Unicode. This flag instructs the API not to convert the return char strings to local code page as well. This is a feature of SSO client Version 1.1 and will not work on the older versions.

NSSS_REMOVE_LOCK_FROM_STORE_F

Causes SecretStore to delete all of the enhanced protected secrets that are locked and, therefore, remove the lock from SecretStore.

NSSS_EP_MASTER_PWORD_USED_F

Enables the user to supply the EP master password to unlock the SecretStore in place of the previous eDirectory password.

NSSS_SET_TREE_NAME_F

Sets the tree name.

NSSS_DESTROY_CONTEXT_F

***
password
(IN) Points to the master password to be set.
hint
(IN) Points to the hint for the master password to be set by the user.
ext
(OUT) If present, points to a set of applicable future extension returns for the secrets.

Return Values

These are common return values for this function; see Section 4.0, Return Values for more information.

Remarks

This call can set a master password on the user's SecretStore if it is allowed by the service and if the user has enhanced protection set on their SecretStore.

See Also