SetPassword in UNIX-OICF

Sets the password in a UNIX-OICF target system.

A set-password workflow propagates a password from DirX Identity to the accounts of one connected system. It is triggered when a user or an administrator changes a password in the Identity Store, or when the password synchronization workflows distribute a password change. The workflow reads the password over the setPassword channel of the Identity Store port and writes it through the target system port; it does not synchronize any other account attribute.

Because a set-password workflow carries credentials, its ports decrypt the password attribute explicitly through the decrypt.attribute parameter, and failures are reported by a dedicated password notification connector instead of the regular notification connector.

SetPassword in UNIX-OICF sends password changes from DirX Identity to the UNIX target system that is exposed as OpenICF. You use it when DirX Identity must propagate a password reset or synchronization event to the resource identified by unix-cluster and my-domain.

The workflows in this reference are delivered as factory data and are loaded into the Connectivity configuration database during the initial configuration. They are samples: use the Identity Manager to copy a workflow into your own scenario and adapt the copy. Do not change the delivered objects, because a product update can replace them.

At a Glance

Name

SetPassword in UNIX-OICF

Category

Target Realtime / UNIX-OICF

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

OpenICF

Configuration wizard

wf-Provisioning-SetPassword.xml

Active in the factory data

FALSE

Factory data version

8.4

Factory data path

Workflows/Default/Target Realtime/UNIX-OICF/SetPassword in UNIX-OICF

Prerequisites

  • A connected directory of type OpenICF for UNIX-OICF, with the bind profile Admin set to credentials that may change passwords on the UNIX system through the connector.

  • A target system of type OpenICF in the Identity Store that is linked to that connected directory.

  • The Java-based Server that runs the workflow must be able to reach both the OpenICF endpoint for the UNIX system and the Identity Store; the Identity Store is accessed through the bind profile Domain_Admin.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

SetPassword

ProvisionTS

provisioningActivity

setPassword activitity to update passwords in an LDAP target system

IdentityDomain, ts

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

SetPassword

IdentityDomain

provisioningPort

LdapConnector

Identity Store

Domain_Admin

not set

SetPassword

TS

provisioningPort

OpenIcfConnector2Unix

UNIX-OICF

Admin

not set

Channels

Table 1. Channels of port IdentityDomain (activity SetPassword)
Channel Description Reference type Delta type

accounts

Channel for accounts

not set

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for members

not set

SearchAttributes
Table 2. Channels of port TS (activity SetPassword)
Channel Description Reference type Delta type

accounts

Channel for accounts

not set

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for members

OneToOne

SearchAttributes

setPassword

Channel for setting a password

not set

SearchAttributes

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of SetPassword in UNIX-OICF
Parameter Default value

timeout

P0Y0M4DT0H0M0S

topicprefix

dxm.setPasswordRequest.

tscluster

unix-cluster

tsresource

my-domain
Table 4. Parameters of activity error
Parameter Default value

resourcefamily

Mail

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT2H0M0S
Table 5. Parameters of port Message (activity error)
Parameter Default value

decrypt.attribute

dxmPassword
Table 6. Parameters of activity SetPassword
Parameter Default value

resourcefamily

OpenICF

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT0H30M0S
Table 7. Parameters of port IdentityDomain (activity SetPassword)
Parameter Default value

decrypt.attribute

userPassword
Table 8. Parameters of port TS (activity SetPassword)
Parameter Default value

bundlename

org.forgerock.openicf.connectors.solaris-connector

bundleversion

1.1.1.0-SNAPSHOT

connectiontype

ssh

decrypt.attribute

PASSWORD

deletehomedirectory

FALSE

implementationclassname

org.identityconnectors.solaris.SolarisConnector

loginshellprompt

#

makedirectory

FALSE

unixmode

linux

A Java-based real-time workflow runs as a permanently loaded configuration in the Java-based Server (IdS-J). It is triggered by a request or an event rather than by a schedule. Each workflow consists of activities; an activity opens one port per system it talks to, and each port uses a connector to reach that system.

Most provisioning workflows contain a join activity that performs the actual work and an error activity that receives requests which still fail after all retries and sends a notification about them. The retrylimit, waitbeforeretry and timeout parameters of an activity control how often and how long a failed request is retried before it is handed to the error activity.

The event port publishes change events over JMS, and the notify port sends e-mail notifications. Neither port is bound to a connected directory.

The SetPassword activity propagates the password change. Its IdentityDomain port resolves the affected target system entry in the Identity Store over the accounts, groups and members channels, and its TS port writes the new password into the UNIX system over the setPassword channel. The CryptFilter on the TS port decrypts the protected password value before the connector sends it.

A request that fails is retried up to three times (retrylimit) with 30 minutes between the attempts (waitbeforeretry). If it still fails, the error activity takes it over and sends a notification through the Message port; the workflow parameter timeout gives a request four days before it is discarded.

Operation

  1. A password change in the Identity Store creates a provisioning request for the affected UNIX-OICF account.

  2. The Java-based Server passes the request to the SetPassword activity of this workflow.

  3. The IdentityDomain port reads the affected target system object from the Identity Store.

  4. The TS port decrypts the protected password value and writes it to the connected UNIX system over the setPassword channel.

  5. The result is written back into the Identity Store so that the request state reflects the outcome.

  6. Requests that fail permanently are handed to the error activity, which reports them by e-mail.

The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario, connect the copy to your connected directory and activate the copy.