Kerberos connector

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 Kerberos connector lets you manage Kerberos user principals from IDM. The connector bundles a number of Groovy scripts, to interact with a Kerberos admin server. You should not edit the bundled Groovy scripts. The scripts use the kadmin utility to communicate with the Kerberos server.

The Kerberos connector lets you 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

Install the Kerberos connector

You can download any connector from Backstage, but some come bundled with Identity Cloud, IDM, or RCS by default. When using a bundled connector, you can skip installing it and move directly to configuration.

Bundle availability
Connector	Identity Cloud	IDM	RCS
Kerberos	No	Yes	Yes

Download the connector .jar file from Backstage.

If you are running the connector locally, place it in the /path/to/openidm/connectors directory, for example:
```
mv ~/Downloads/kerberos-connector-1.5.20.21.jar /path/to/openidm/connectors/
```
If you are using a remote connector server (RCS), place it in the /path/to/openicf/connectors directory on the RCS.

Configure the Kerberos connector

Create a connector configuration using the IDM admin UI:

From the navigation bar, click Configure > Connectors.
On the Connectors page, click New Connector.
On the New Connector page, type a Connector Name.
From the Connector Type drop-down list, select Kerberos Connector - 1.5.20.21.
Complete the Base Connector Details.

For a list of all configuration properties, refer to Kerberos Connector Configuration
Click Save.

When your connector is configured correctly, the connector displays as Active in the admin UI.

Refer to this procedure to create a connector configuration over REST.

Alternatively, configure the connector with a configuration file. A sample connector configuration (provisioner.openicf-kerberos.json) is provided in the /path/to/openidm/samples/sync-with-kerberos/conf/ directory with IDM. 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 Configure Authentication to the SSH Server. In addition, set at least the following properties:
customConfiguration
Specify the details of the user principal and the default realm here. The sample connector configuration is as follows:
"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' }"
customSensitiveConfiguration
Set the password for the user principal here. The sample connector configuration is as follows:
"customSensitiveConfiguration" : "kadmin {password = '<KADMIN PASSWORD>'}"
Change this to reflect your user principal password, for example:
"customSensitiveConfiguration" : "kadmin {password = 'Passw0rd'}"

Basic Kerberos Connector Configuration

This list describes the basic Kerberos connector configuration properties. For a complete list, refer to Configuration Properties:

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

Default: 22 (the default SSH port)
user: 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.
password: The password of the account that is used to connect to the SSH server.
prompt: 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 prompts, refer to this article.
sudoCommand: A string that shows the full path to the sudo command; for example /usr/bin/sudo.
echoOff: 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.
terminalType: Sets the terminal type to use for the session. The list of supported types is determined by your Linux/UNIX system. For more information, refer to the terminfo manual page (man terminfo).

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

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

Default: en_US.utf8
connectionTimeout: Specifies the connection timeout to the remote server, in milliseconds.

Default: 5000
expectTimeout: Specifies the timeout used by the expect() calls in scripts, in milliseconds.

Default: 5000
authenticationType: Sets the authentication type, either PASSWORD or PUBKEY. For more information, refer to connector-reference:ssh.adoc#ssh-authentication.

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

Default: true
scriptRoots: The path to the Groovy scripts that perform the ICF operations, relative to your installation directory. For the Kerberos connector, the scripts are bundled in the connector .jar file, so the sample connector configuration uses the path jar:file:connectors/kerberos-connector-1.5.20.21.jar!/scripts/kerberos/.
classpath: The directory in which the compiler should look for compiled classes. The default classpath, if not is specified, is install-dir/lib.
ScriptFileName: The script that is used for each ICF operation. Do not change these script names in the bundled Kerberos connector.

Kerberos remote connector

If you want to run this connector outside of Identity Cloud or IDM, you can configure the Kerberos connector as a remote connector. Java Connectors installed remotely on a Java Connector Server function identically to those bundled locally within Identity Cloud or installed locally on IDM.

You can download the Kerberos connector from here.

Refer to Remote connectors for configuring the Kerberos remote connector.

OpenICF Interfaces Implemented by the Kerberos Connector

The Kerberos Connector implements the following OpenICF interfaces. For additional details, see ICF interfaces:

Authenticate

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

Create

Creates an object and its uid.

Delete

Deletes an object, referenced by its uid.

Resolve Username

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

Schema

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.

Search

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

Sync

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

Test

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.

Update

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

Kerberos Connector Configuration

The Kerberos Connector has the following configurable properties:

Basic Configuration Properties

Property Type Default Encrypted⁽¹⁾ Required⁽²⁾

Property	Type	Default	Encrypted⁽¹⁾	Required⁽²⁾
`host`	`String`	`null`		Yes
The hostname to connect to.
`port`	`int`	`22`		Yes
TCP port to use.
`user`	`String`	`null`		Yes
The user name used to login to remote server.
`password`	`GuardedString`	`null`	Yes	No
The password used to login to remote server.
`passphrase`	`GuardedString`	`null`	Yes	No
The passphrase used to read the private key when using Public Key authentication.
`privateKey`	`String[]`	`[]`	Yes	No
The base 64 encoded value (PEM) of the private key used for Public Key authentication.
`authenticationType`	`String`	`PASSWORD`		Yes
Defines which authentication type should be use: PASSWORD or PUBKEY.
`prompt`	`String`	`root@localhost:# `		Yes
A string representing the remote SSH session prompt.
`sudoCommand`	`String`	`/usr/bin/sudo`		Yes
A string representing the sudo command.
`echoOff`	`boolean`	`true`		Yes
Disable the input command echo.
`terminalType`	`String`	`vt102`		Yes
Defines the terminal type to use for the session.
`locale`	`String`	`en_US.utf8`		Yes
Define the locale for LC_ALL, LANG and LANGUAGE environment variables to use if setLocale=true.
`setLocale`	`boolean`	`false`		Yes
Defines if the default environment locale should be changed with the value provided for locale.
`connectionTimeout`	`int`	`5000`		Yes
Defines the connection timeout to the remote server in milliseconds.
`expectTimeout`	`long`	`5000`		Yes
Defines the timeout used by the expect() calls in the scripts in milliseconds.
`throwOperationTimeoutException`	`boolean`	`true`		Yes
Defines if an OperationTimeoutException should be thrown if any call to expect times out.
`promptReadyTimeout`	`long`	`20`		No
Defines the "prompt ready" timeout for the promptReady() command in milliseconds.

host

String

null

Yes

The hostname to connect to.

port

int

22

Yes

TCP port to use.

user

String

null

Yes

The user name used to login to remote server.

password

GuardedString

null

Yes

The password used to login to remote server.

passphrase

GuardedString

null

Yes

The passphrase used to read the private key when using Public Key authentication.

privateKey

String[]

[]

Yes

The base 64 encoded value (PEM) of the private key used for Public Key authentication.

authenticationType

String

PASSWORD

Yes

Defines which authentication type should be use: PASSWORD or PUBKEY.

prompt

String

`root@localhost:# `

Yes

A string representing the remote SSH session prompt.

sudoCommand

String

/usr/bin/sudo

Yes

A string representing the sudo command.

echoOff

boolean

true

Yes

Disable the input command echo.

terminalType

String

vt102

Yes

Defines the terminal type to use for the session.

locale

String

en_US.utf8

Yes

Define the locale for LC_ALL, LANG and LANGUAGE environment variables to use if setLocale=true.

setLocale

boolean

false

Yes

Defines if the default environment locale should be changed with the value provided for locale.

connectionTimeout

int

5000

Yes

Defines the connection timeout to the remote server in milliseconds.

expectTimeout

long

5000

Yes

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

throwOperationTimeoutException

boolean

true

Yes

Defines if an OperationTimeoutException should be thrown if any call to expect times out.

promptReadyTimeout

long

20

Defines the "prompt ready" timeout for the promptReady() command in milliseconds.

⁽¹⁾ Whether the property value is considered confidential, and is therefore encrypted in IDM.

⁽²⁾ A list of operations in this column indicates that the property is required for those operations.

Groovy Engine configuration

Property Type Default Encrypted⁽¹⁾ Required⁽²⁾

Property	Type	Default	Encrypted⁽¹⁾	Required⁽²⁾
`scriptRoots`	`String[]`	`['bundle-file-path!/scripts/kerberos']`		Yes
The root folder to load the scripts from. If the value is null or empty the classpath value is used.
`classpath`	`String[]`	`[]`		No
Classpath for use during compilation.
`debug`	`boolean`	`false`		No
If true, debugging code should be activated.
`disabledGlobalASTTransformations`	`String[]`	`null`		No
Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled.
`minimumRecompilationInterval`	`int`	`100`		No
Sets the minimum of time after a script can be recompiled.
`recompileGroovySource`	`boolean`	`false`		No
If set to true recompilation is enabled.
`scriptBaseClass`	`String`	`null`		No
Base class name for scripts (must derive from Script).
`scriptExtensions`	`String[]`	`['groovy']`		No
Gets the extensions used to find groovy files.
`sourceEncoding`	`String`	`UTF-8`		No
Encoding for source files.
`targetDirectory`	`File`	`null`		No
Directory into which to write classes.
`tolerance`	`int`	`10`		No
The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted.
`verbose`	`boolean`	`false`		No
If true, the compiler should produce action information.
`warningLevel`	`int`	`1`		No
Warning Level of the compiler.
`customConfiguration`	`String`	`kadmin { cmd = '/usr/sbin/kadmin.local'; user='<KADMIN USERNAME>'; default_realm='<REALM, e.g. EXAMPLE.COM>' }`		No
Custom Configuration script for Groovy ConfigSlurper.
`customSensitiveConfiguration`	`GuardedString`	`null`	Yes	No
Custom Sensitive Configuration script for Groovy ConfigSlurper.

scriptRoots

String[]

['bundle-file-path!/scripts/kerberos']

Yes

The root folder to load the scripts from. If the value is null or empty the classpath value is used.

classpath

String[]

[]

Classpath for use during compilation.

debug

boolean

false

If true, debugging code should be activated.

disabledGlobalASTTransformations

String[]

null

Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled.

minimumRecompilationInterval

int

100

Sets the minimum of time after a script can be recompiled.

recompileGroovySource

boolean

false

If set to true recompilation is enabled.

scriptBaseClass

String

null

Base class name for scripts (must derive from Script).

scriptExtensions

String[]

['groovy']

Gets the extensions used to find groovy files.

sourceEncoding

String

UTF-8

Encoding for source files.

targetDirectory

File

null

Directory into which to write classes.

tolerance

int

10

The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted.

verbose

boolean

false

If true, the compiler should produce action information.

warningLevel

int

1

Warning Level of the compiler.

customConfiguration

String

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

Custom Configuration script for Groovy ConfigSlurper.

customSensitiveConfiguration

GuardedString

null

Yes

Custom Sensitive Configuration script for Groovy ConfigSlurper.

⁽¹⁾ Whether the property value is considered confidential, and is therefore encrypted in IDM.

⁽²⁾ A list of operations in this column indicates that the property is required for those operations.

Operation Script Files

Property Type Default Encrypted⁽¹⁾ Required⁽²⁾

Property	Type	Default	Required⁽²⁾
`authenticateScriptFileName`	`String`	`null`	Authenticate
The name of the file used to perform the AUTHENTICATE operation.
`createScriptFileName`	`String`	`CreateKerberos.groovy`	Create
The name of the file used to perform the CREATE operation.
`customizerScriptFileName`	`String`	`null`	No
The script used to customize some function of the connector. Read the documentation for more details.
`deleteScriptFileName`	`String`	`DeleteKerberos.groovy`	Delete
The name of the file used to perform the DELETE operation.
`resolveUsernameScriptFileName`	`String`	`null`	Resolve Username
The name of the file used to perform the RESOLVE_USERNAME operation.
`schemaScriptFileName`	`String`	`SchemaKerberos.groovy`	Schema
The name of the file used to perform the SCHEMA operation.
`scriptOnResourceScriptFileName`	`String`	`ScriptOnResourceKerberos.groovy`	Script on Resource
The name of the file used to perform the RUNSCRIPTONRESOURCE operation.
`searchScriptFileName`	`String`	`SearchKerberos.groovy`	Read Search
The name of the file used to perform the SEARCH operation.
`syncScriptFileName`	`String`	`null`	Sync
The name of the file used to perform the SYNC operation.
`testScriptFileName`	`String`	`TestKerberos.groovy`	Test
The name of the file used to perform the TEST operation.
`updateScriptFileName`	`String`	`UpdateKerberos.groovy`	Update
The name of the file used to perform the UPDATE operation.

authenticateScriptFileName

String

null

Authenticate

The name of the file used to perform the AUTHENTICATE operation.

createScriptFileName

String

CreateKerberos.groovy

Create

The name of the file used to perform the CREATE operation.

customizerScriptFileName

String

null

The script used to customize some function of the connector. Read the documentation for more details.

deleteScriptFileName

String

DeleteKerberos.groovy

Delete

The name of the file used to perform the DELETE operation.

resolveUsernameScriptFileName

String

null

Resolve Username

The name of the file used to perform the RESOLVE_USERNAME operation.

schemaScriptFileName

String

SchemaKerberos.groovy

Schema

The name of the file used to perform the SCHEMA operation.

scriptOnResourceScriptFileName

String

ScriptOnResourceKerberos.groovy

Script on Resource

The name of the file used to perform the RUNSCRIPTONRESOURCE operation.

searchScriptFileName

String

SearchKerberos.groovy

Read
Search

The name of the file used to perform the SEARCH operation.

syncScriptFileName

String

null

Sync

The name of the file used to perform the SYNC operation.

testScriptFileName

String

TestKerberos.groovy

Test

The name of the file used to perform the TEST operation.

updateScriptFileName

String

UpdateKerberos.groovy

Update

The name of the file used to perform the UPDATE operation.

⁽¹⁾ Whether the property value is considered confidential, and is therefore encrypted in IDM.

⁽²⁾ A list of operations in this column indicates that the property is required for those operations.

ICF 1.5.20.21

Kerberos connector

Kerberos connector schema

Install the Kerberos connector

Configure the Kerberos connector

Kerberos remote connector

OpenICF Interfaces Implemented by the Kerberos Connector

Kerberos Connector Configuration

Basic Configuration Properties

Groovy Engine configuration

Operation Script Files