Kerberos Connector


Connectors continue to be released outside the IDM release. For the latest documentation, refer to the ICF documentation.

The Kerberos connector is an implementation of the SSH connector, and is based on Java Secure Channel (JSch) and the Java implementation of the Expect library (Expect4j). The connector depends on the following files, provided with IDM:

  • /path/to/openidm/lib/ssh-connector-

  • /path/to/openidm/lib/expect4j-<version>.jar

  • /path/to/openidm/lib/jsch-<version>.jar

The Kerberos connector enables you to manage Kerberos user principals from IDM. The connector is provided in /path/to/openidm/connectors/kerberos-connector- and bundles a number of Groovy scripts to interact with a Kerberos admin server. Users of the Kerberos connector are not expected to edit the bundled Groovy scripts. The bundled scripts use the kadmin utility to communicate with the Kerberos server.

The Kerberos connector enables you to perform the following operations on Kerberos user principals:

  • List the existing principals.

  • Display the details of a principal.

  • Add a user principal.

  • Change the password of a user principal and unlock the principal.

  • Delete a user principal.

Kerberos Connector Schema

The Kerberos connector can only be used to manage the Kerberos principal object type (which maps to the ICF __ACCOUNT__ object). The following attributes are supported in the schema:

  • principal - (maps to __NAME__ and __UID__)

  • __PASSWORD__ - updatable, required when an object is created

  • __LOCK_OUT__ - updatable only; unlock an account by setting this attribute to false

  • policy - the password policy used by the principal

  • expirationDate - the date that the user principal expires

  • passwordExpiration - the date that the password expires

  • maximumTicketLife - the maximum ticket life for the principal. At the end of the ticket lifetime, the ticket can no longer be used. However, if the renewable lifetime (maximumRenewableLife) is longer than the ticket lifetime, the ticket holder can present the ticket to the KDC and request a new ticket.

  • maximumRenewableLife - the period during which the ticket can be renewed. A renewed ticket usually has a new ticket lifetime, dating from the time that it was renewed, that is constrained by the renewable ticket lifetime.

In addition, the following read-only attributes are supported:

  • lastPasswordChange

  • lastModified

  • lastSuccessfulAuthentication

  • lastFailedAuthentication

  • failedPasswordAttempts

Configuring the Kerberos Connector

A sample connector configuration (provisioner.openicf-kerberos.json) is provided in the /path/to/openidm/samples/sync-with-kerberos/conf/ directory. You can copy the sample connector configuration to your project's conf/ directory, and adjust it to match your Kerberos environment.

Set the authentication properties, as described in "Configuring Authentication to the SSH Server". In addition, set at least the following properties:


Specify the details of the user principal and the default realm here. The sample provisioner file has the following custom configuration:

"customConfiguration" : "kadmin {
    cmd = '/usr/sbin/kadmin.local';
    user = '<KADMIN USERNAME>';
    default_realm = '<REALM, e.g. EXAMPLE.COM>'

A complete custom configuration will look something like this:

"customConfiguration" : "kadmin {
    cmd = '/usr/sbin/kadmin.local';
    user = 'openidm/admin';
    default_realm = 'EXAMPLE.COM'

Set the password for the user principal here. The sample provisioner has the following configuration:

"customSensitiveConfiguration" : "kadmin {password = '<KADMIN PASSWORD>'}"

Change this to reflect your user principal password, for example:

"customSensitiveConfiguration" : "kadmin {password = 'Passw0rd'}"

The following section describes the configuration parameters in the sample Kerberos connector configuration. For a complete list of the configuration properties for the Kerberos connector, see "Configuration properties":


The host name or IP address of the SSH server on which the kadmin command is run.


The port number on which the SSH server listens.

Default: 22 (the default SSH port)


The username of the account that is used to connect to the SSH server.


This is not the same as your Kerberos user principal. This account must be able to ssh into the server on which Kerberos is running, with the password provided in the next parameter.

If you use the root user, the sudo command in the Test script will never get the 'pass::' prompt. Instead of using the root user, create a regular user and add that user to the group that has sudo privileges. Alternatively, modify the Test script so that it does not use sudo.


The password of the account that is used to connect to the SSH server.


A string representing the remote SSH session prompt. This must be the exact prompt string, in the format username@target:, for example root@localhost:~$ .

If the prompt includes a trailing space, you must include the space in the value of this property.

Consider customizing your Linux prompt with the PS1 and PS2 variables, to set a safe prompt. For information about customizing promtps, see this article.


A string that shows the full path to the sudo command, for example /usr/bin/sudo.


If set to true (the default), the input command echo is disabled. If set to false, every character that is sent to the server is sent back to the client in the expect() call.


Sets the terminal type to use for the session. The list of supported types is determined by your Linux/UNIX system. For more information, see the terminfo manual page (man terminfo).

Default: vt102


If set to true, indicates that the default environment locale should be changed to the value of the locale property.

Default: false


Sets the locale for LC_ALL, LANG and LANGUAGE environment variables, if setLocale is set to true.

Default: en_US.utf8


Specifies the connection timeout to the remote server, in milliseconds.

Default: 5000


Specifies the timeout used by the expect() calls in scripts, in milliseconds.

Default: 5000


Sets the authentication type, either PASSWORD or PUBKEY. For more information, see "Configuring Authentication to the SSH Server".



If true, the connector throws an exception when the timeout is reached for an operation. Otherwise, the operation fails silently.

Default: true


The path to the Groovy scripts that will perform the ICF operations, relative to your installation directory. For the Kerberos connector, the scripts are bundled up in the connector JAR file, so this path is set to jar:file:connectors/kerberos-connector-!/script/kerberos/ in the sample connector configuration.


The directory in which the compiler should look for compiled classes. The default classpath, if not is specified, is install-dir/lib.


The script that is used for each ICF operation. Do not change these script names in the bundled Kerberos connector.

OpenICF Interfaces Implemented by the Kerberos Connector

The Kerberos Connector implements the following OpenICF interfaces.


Provides simple authentication with two parameters, presumed to be a user name and password.


Creates an object and its uid.


Deletes an object, referenced by its uid.

Resolve Username

Resolves an object by its username and returns the uid of the object.


Describes the object types, operations, and options that the connector supports.

Script on Connector

Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics:

  • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access.

  • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration.

  • The script has access to any script-arguments passed in by the application.

Script on Resource

Runs a script on the target resource that is managed by this connector.


Searches the target resource for all objects that match the specified object class and filter.


Polls the target resource for synchronization events, that is, native changes to objects on the target resource.


Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.

This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out).

You can invoke the test operation before a connector configuration has been validated.


Updates (modifies or replaces) objects on a target resource.

Kerberos Connector Configuration

The Kerberos Connector has the following configurable properties.

Configuration properties

PropertyTypeDefault Encrypted [a] Required [b]
customSensitiveConfiguration GuardedString null

Description is not available

createScriptFileName String null

Description is not available

targetDirectory File null

Description is not available

customizerScriptFileName String null

Description is not available

warningLevel int 1

Description is not available

authenticateScriptFileName String null

Description is not available

scriptExtensions String[] ['groovy']

Description is not available

scriptOnResourceScriptFileName String null
Script On Resource

Description is not available

minimumRecompilationInterval int 100

Description is not available

deleteScriptFileName String null

Description is not available

scriptBaseClass String null

Description is not available

scriptRoots String[] null

Description is not available

customConfiguration String null

Description is not available

resolveUsernameScriptFileName String null
Resolve Username

Description is not available

searchScriptFileName String null

Description is not available

tolerance int 10

Description is not available

updateScriptFileName String null

Description is not available

debug boolean false

Description is not available

classpath String[] []

Description is not available

disabledGlobalASTTransformations String[] null

Description is not available

schemaScriptFileName String null

Description is not available

verbose boolean false

Description is not available

testScriptFileName String null

Description is not available

sourceEncoding String UTF-8

Description is not available

syncScriptFileName String null

Description is not available

recompileGroovySource boolean false

Description is not available

host String null

Description is not available

port int 22

Description is not available

user String null

Description is not available

password GuardedString null

Description is not available

passphrase GuardedString null

Description is not available

privateKey String[] []

Description is not available

authenticationType String PASSWORD

Description is not available

prompt String root@localhost:#

Description is not available

sudoCommand String /usr/bin/sudo

Description is not available

echoOff boolean true

Description is not available

terminalType String vt102

Description is not available

locale String en_US.utf8

Description is not available

setLocale boolean false

Description is not available

connectionTimeout int 5000

Description is not available

expectTimeout long 5000

Description is not available

throwOperationTimeoutException boolean true

Description is not available

promptReadyTimeout long 20

Description is not available

[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM.

[b] A list of operations in this column indicates that the property is required for those operations.

Read a different version of :