Examples Of Obtaining Event Data

Example 1:

command=‘IDMGETVAR "COMMAND"‘
# check for an add event
if [ "$command" = "add" ]; then
  # call the add script
  add.sh
fi

Example 2:

# obtain the event’s association and CN attribute
ASSOCIATION=‘IDMGETVAR "ASSOCIATION"‘
CN=‘IDMGETVAR "ADD_CN"‘
if [ "$CN" = "bob" ]; then
  # for "bob", check to see if he’s been enabled
  ENABLE=‘IDMGETVAR "REMOVE_Login Disabled"‘
  if [ "$ENABLE" = "true" ]; then
    # bob is enabled again
    cmd="appenable -association $ASSOCIATION"
    EXEC "$cmd"
  fi
fi

Handling Associations

The association value indicates which identity has been changed. If the identity has no association, an association must be generated for it using an implementation-specific rule that you have adopted. When Identity Manager processes an event for an identity with no association, it executes the driver’s Matching policy. This policy attempts to match the event’s identity to an identity on the external application’s system. Usually doing this involves executing a query. The default Matching policy included with the Scripting driver queries for matching Users and Groups based on the CN attribute. If the event’s identity matches an identity on the external application, both identities must be assigned the new association. Assigning this association can be done as part of the query-handling script. (Handling queries is discussed in more detail in Handling Query Events.) If no identity matches, an Add event is issued, and the new association can be assigned as part of the Add event-handling script:

# Adding an association
IDMSETVAR "COMMAND" "ADD_ASSOCIATION"
IDMSETVAR "ASSOCIATION" "$MyAssociation"
IDMSETVAR "EVENT_ID" "$EVENT_ID"
IDMSETVAR "DEST_DN" "$SRC_DN"
IDMSETVAR "DEST_ENTRY_ID" "$SRC_ENTRY_ID"

The above example demonstrates each name/value pair that must be set for an association to be assigned by the Identity Manager engine. The values of EVENT_ID, SRC_DN and SRC_ENTRY_ID are always sent by the engine during an add event, and therefore, are available for your add script to obtain using IDMGETVAR. The example above also illustrates the IDMSETVAR function. For detailed information on how to use IDMSETVAR, see Section C.1, UNIX Shell (idmlib.sh) Reference. This function sets a name and value which indicates what action Identity Manager should perform. For example, the pair COMMAND and ADD_ASSOCIATION instructs the shim to create an add-association document to assign an association to an identity, as discussed above. The pair EVENT_ID and $EVENT_ID instruct the shim to assign add-association document an event-id described by the variable $EVENT_ID. This is important for the engine to match documents sent and returned on the subscriber channel.

The Subscriber can also issue MODIFY_ASSOCIATION and REMOVE_ASSOCIATION commands:

# Removing an association
IDMSETVAR "COMMAND" "REMOVE_ASSOCIATION"
IDMSETVAR "ASSOCIATION" "$MyAssociation"
IDMSETVAR "EVENT_ID" "$EVENT_ID"
IDMSETVAR "DEST_DN" "$SRC_DN"
IDMSETVAR "DEST_ENTRY_ID" "$SRC_ENTRY_ID"

# Modifying an association
IDMSETVAR "COMMAND" "MODIFY_ASSOCIATION"
IDMSETVAR "ASSOCIATION" "$OldAssociation"
IDMSETVAR "ASSOCIATION" "$NewAssociation"
IDMSETVAR "EVENT_ID" "$EVENT_ID"
IDMSETVAR "DEST_DN" "$SRC_DN"
IDMSETVAR "DEST_ENTRY_ID" "$SRC_ENTRY_ID"

Returning an Event Status

On the Subscriber channel, you often do not need Identity Manager to perform an action, but simply need to report a status. The STATUS_ subroutines noted below can be used to indicate a status to Identity Manager. They take a message to be logged as their parameter.

Examples Using the STATUS Functions

Example 1:

EXEC "$cmd"
if [ $? -eq 0 ]; then
  STATUS_SUCCESS "Command was successful"
fi

Example 2:

EXEC "$cmd"
if [ $? -eq 0 ]; then
  if [ -z "$password" ]; then
    # created, but no password
    STATUS_WARNING "User added without password"
  fi
fi

Example 3:

EXEC "$cmd"
if [ $? -ne 0 ]; then
  STATUS_ERROR "Command failed"
fi

Writing Values

IDMSETVAR is used to set values to return to Identity Manager. For detailed information on how tus IDMSETVAR, see Section C.1, UNIX Shell (idmlib.sh) Reference. It is passed a name and value. In the previous ADD_ASSOCIATION example, IDMSETVAR is used to set the ASSOCIATION value. You can specify values for items listed in the table above. Generally, the only time IDMSETVAR is used is to add, modify and delete associations or return information for a query operation. Other information returned to the shim by the scripts is done through other command functions, such as STATUS_SUCCESS, which use IDMSETVAR indirectly.

Handling Query Events

For Query events, Identity Manager submits values that define the parameters of a search of the external application’s identity management system. Queries are usually issued from the Policies you have defined for your system. The table below specifies values that can be specified in queries. Not all values are relevant to your external application.

Execute the query against the external application using application-provided tools. Then return each identity by setting an INSTANCE command, followed by relevant values from the list below.

After returning all identities, call STATUS_SUCCESS to indicate a successful query.

Subscriber Summary and Examples

Below is a more detailed summary of the actions to take for a non-Query event.

Below is an example add.sh, which forms an association from an identity’s CN and class name, and uses a hypothetical tool called appadd.

#!/bin/sh
ClassName=`IDMGETVAR "CLASS_NAME"` CN=`IDMGETVAR "CN"`
EVENT_ID=`IDMGETVAR "EVENT_ID"`
SRC_DN=`IDMGETVAR "SRC_DN"`
SRC_ENTRY_ID=`IDMGETVAR "SRC_ENTRY_ID"`
PhoneNumber=`IDMGETVAR "Telephone"`

if [ -z "$ClassName" -o -z "$CN" ]; then
  STATUS_ERROR "Add event: missing CLASS_NAME and/or CN"
else
  Command="appadd -n $CN -t $PhoneNumber"
  EXEC $Command
  if [ $? -eq 0 ]; then 
    IDMSETVAR "COMMAND" "ADD_ASSOCIATION"
    IDMSETVAR "ASSOCIATION" $CN $ClassName
    IDMSETVAR "EVENT_ID" "$EVENT_ID"
    IDMSETVAR "DEST_DN" "$SRC_DN"
    IDMSETVAR "DEST_ENTRY_ID" "$SRC_ENTRY_ID"

    STATUS_SUCCESS "Add event succeeded"
  else
    STATUS_ERROR "Add event failed with error code $RC"
  fi
fi

Handling a query is a similar process, except that you return INSTANCE items rather than using other commands. Below is an example query.sh that searches an external application for a telephone number. It uses a hypothetical tool called appsearch.

#!/bin/sh
SearchName=`IDMGETVAR "SEARCH_ATTR_CN"`
EVENT_ID=`IDMGETVAR "EVENT_ID"`
ASSOCIATION=`IDMGETVAR "ASSOCIATION"`
CLASS_NAME=`IDMGETVAR "CLASS_NAME"`

if [ -z "$SearchName" ]; then
  STATUS_ERROR "Query: no search value"
else
  Command="appsearch -n $SearchName"
  Results=`$Command`
  if [ -n "$Results" ]; then
  Phone=`echo $Results | awk ’{print $1}'`
  IDMSETVAR "COMMAND" "INSTANCE"
  IDMSETVAR "EVENT_ID" "$EVENT_ID"
  IDMSETVAR "CLASS_NAME" "$CLASS_NAME"
  IDMSETVAR "ASSOCIATION" "$ASSOCIATION"
  IDMSETVAR "ATTR_Telephone" "$Phone"

  STATUS_SUCCESS "Query succeeded"
  else
    # Return success with no results
    STATUS_SUCCESS "Query succeeded (no matches)"
  fi
fi

Polling for Application Events

The Driver calls poll.sh to detect application events. Implement poll.sh as follows:

The following is an example of a poll.sh that checks for a password change. It uses a hypothetical application tool called appchg.

#!/bin/sh
# look for password changes
Results=`appchg --passwd-changes`
for Result in $Results; do
  # Entries are in the format "association:password"
  Association=`echo $Result | awk -F: '{print $1}'`
  Password=`echo $Result | awk -F: '{print $2}'`

  # submit a password change event
  usclh -t modify-password -a $Association <<EOF
$Password
EOF
done

# look for attribute values being added to each user
Results=`appchg --add-attr-changes`
for Result in $Results; do
  # Entries are in the format "association:attribute:value"
  Association=`echo $Result | awk -F: '{print $1}'`
  Attribute=`echo $Result | awk -F: '{print $2}'`
  Value=`echo $Result | awk -F: '{print $3}'`

  # submit the added attribute value
  usclh -t modify -c User -a $Association <<EOF
ADD_$Attribute=$Value
EOF
done

# look for attribute values being removed from each user
Results=`appchg --remove-attr-changes`
for Result in $Results; do
  # Entries are in the format "association:attribute:value"
  Association=`echo $Result | awk -F: '{print $1}'`
  Attribute=`echo $Result | awk -F: '{print $2}'`
  Value=`echo $Result | awk -F: '{print $3}'`

  # submit the removed attribute value
  usclh -t modify -c User -a $Association <<EOF
REMOVE_$Attribute=$Value
EOF
done

In the above example, three separate events are submitted to the publisher change log using the change log tool, usclh. The first invocation submits a modify-password event to be published. The second event submits a modify event to be published for an attribute add. The third invocation submits another modify event to be published for an attribute removal. The second and third invocations can be combined into a single modify event, if desired.

Events submitted using usclh are processed through your driver’s Publisher channel policies. See your Identity Manager 3.6.1 Policy guides for more information.

Using the Heartbeat Script

Another script executed in the Publisher Channel is heartbeat.sh. This script is executed when the Publisher Channel is idle for the interval specified in the Driver parameters. (You can set the interval to 0 so no heartbeat is issued.) You can use the heartbeat to check the availability of the external system or do “idle state” tasks. The HEARTBEAT_SUCCESS, HEARTBEAT_WARNING, and HEARTBEAT_ERROR subroutines can be used to indicate the result of the heartbeat. Below is an example based on a hypothetical tool called apphealth.

  apphealth
  RC=$?
  if [ $RC -eq 0 ]; then
    HEARTBEAT_SUCCESS "Heartbeat succeeded"
  else
    HEARTBEAT_ERROR "Heartbeat failed with error code $RC"
  fi

The response to the heartbeat is implementation-dependent, and can be defined in Policies or in the script itself. You could send a message to auditing using Novell Audit. You could store a value in a file, and have Subscriber scripts read the file and call STATUS_RETRY if they find that value in the file.

Driver Parameters

A driver has values known as driver parameters. The driver parameters are divided into driver settings applicable to the whole driver, and Subscriber and Publisher settings for their respective channels. The IDMGETDRVVAR, IDMGETSUBVAR, and IDMGETPUBVAR functions can be used to retrieve these values. The table below shows parameters in the default Scripting driver. Other parameters can be added to the driver’s XML configuration file see “Managing Identity Manager Drivers” in the Identity Manager 3.6.1 Administration Guide).

In the following example, a script retrieves the Publisher polling interval.

  PollingInterval=`IDMGETPUBVAR "pub-polling-interval"`

Querying the Identity Vault

Scripts might need to retrieve information from the Identity Vault. They can do this by issuing a query.

Query support is currently limited. It only returns one instance based on the specified association or DN. (If both association and DN are specified, association is used.) The functions below allow you to retrieve information from the instance.

The following is an example of a query of the Identity Vault that retrieves the address and ZIP code for user Bob.

  IDMQUERY "User" "Bob" "SA,Postal Code"

  Address=`IDMGETQVAR "SA"`
  ZIPCode=`IDMGETQVAR "Postal Code"`
  # ... etc. ...

Tracing and Debugging

The IDMTRACE function allows you to write a message to the Trace Log. Tracing is useful for script debugging and auditing.

  IDMTRACE "Trace message"

When developing scripts, you might need to do some debugging to track down problems. The following list indicates some facilities for debugging.

Although it is best to start the driver in production environments from the startup script, you can run usdrv manually. When you do so, any text written to standard output from scripts is displayed in the interactive shell.