SSH Connector
The scripted SSH connector is an implementation of the Scripted Groovy Connector Toolkit, and is based on Java Secure Channel (JSch) and the Java implementation of the Expect library (Expect4j). This connector enables you to interact with any SSH server, using Groovy scripts for the OpenICF operations.
The SSH connector is a poolable connector. This means that each connector instance is placed into a connection pool every time an action is completed. Subsequent actions can re-use connector instances from the connector pool. When a new connector instance is created, a new SSH client connection is created against the target SSH server. This SSH connection remains open as long as the connector instance is in the connection pool. Note that when a new action is performed, it finds the SSH connection in the exact state that it was left by the previous action.
The SSH connector authenticates to the SSH server using either a login/password or a public/private key. The authentication method is specified in the The SSH connector authenticates to the SSH server using either a login/password or a public/ private key. The authentication method is specified in the authenticationType property in the connector configuration file samples/provisioners/provisioner.openicf-ssh.json.
To authenticate with a login and password, set the authenticationType to PASSWORD in the connector configuration file, and set a user and password. For example:
"configurationProperties" : {
...
"authenticationType" : "PASSWORD",
"user" : "<USERNAME>",
"password" : "<PASSWORD>",
...The password is encrypted when OpenIDM loads the provisioner file.
To authenticate with a secure certificate, generate a pair of public/private keys. Install the public key on the server side and the private key on the OpenIDM host (where the connector is located). Set the authenticationType to PUBKEY in the connector configuration file and set the user, passphrase and privateKey properties.
For example:
"configurationProperties" : {
...
"authenticationType" : "PUBKEY",
"user" : "<USERNAME>",
"password" : "<PASSWORD>",
"passphrase" : "secret",
"privateKey" : [
"-----BEGIN DSA PRIVATE KEY-----",
"MIIBugIBAAKBgQDcB0ztVMCFptpJhqlLNZSdN/5cDL3S7aOVy52Ae7vwwCqQPCQr",
"6NyUk+wtkDr07NlYd3sg7a9hbsEnlYChsuX+/WUIvbOKdMfeqcQ+jKK26YdkTCGj",
"g86dBj9JYhobSHDoQ9ov31pYN/cfW5BAZwkm9TdpEjHPvMIaOxx7GPGKWwIVALbD",
"CEuf1yJk9UB7v0dmJS7bKkbxAoGARcbAuDP4rB6MsgAAkVwf+1sHXEiGPShYWrVV",
"qBgCZ/S45ELqUuiaN/1N/nip/Cc/0SBPKqwl7o50CUg9GH9kTAjmXiwmbkwvtUv+",
"Xjn5vCHS0w18yc3rGwyr2wj+D9KtDLFJ8+T5HmsbPoDQ3mIZ9xPmRQuRFfVMd9wr",
"DY0Rs7cCgYAxjGjWDSKThowsvOUCiE0ySz6tWggHH3LTrS4Mfh2t0tnbUfrXq2cw",
"3CN+T6brgnpYbyX5XI17p859C+cw90MD8N6vvBxaN8QMDRFk+hHNUeSy8gXeem9x",
"O0vdIxCgKvA4dh5nSVb5VGKENEGNEHRlYxEPzbqlPa/C/ZvzIvdKXQIUQMoidPFC",
"n9z+mE2dAADnPf2m9vk=",
"-----END DSA PRIVATE KEY-----"
],
...The default value for the passphrase property is null. If you do not set a passphrase for the private key, the passphrase value must be equal to an empty string.
You must set a value for the password property, because the connector uses sudo to perform actions on the SSH server.
The private key (PEM certificate) must be defined as a JSON String array.
The values of the passphrase, password and privateKey are encrypted when OpenIDM loads the provisioner file.
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.
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 promtps, see Customizing Bash Prompt.
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, see 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, see Scripted SSH Connector.
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 will perform the OpenICF operations, relative to your OpenIDM 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-1.4.0.0.jar!/script/kerberos/ in the sample connector configuration.
classpath
The directory in which the compiler should look for compiled classes. The default classpath, if not is specified, is install-dir/lib.
reloadScriptOnExecution
By default, scripts are loaded and compiled when a connector instance is created and initialized. Setting reloadScriptOnExecution to true makes the connector load and compile the script every time it is called. Do not set this property to true in a production environment, because it will have a significant impact on performance.
Default: false
ScriptFileName
The script that is used for each OpenICF operation. Do not change these script names in the bundled Kerberos connector.
The SSH Connector implements the following OpenICF 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.
| Property | Description | Type | Default | Encrypted | Required |
|---|---|---|---|---|---|
| customSensitiveConfiguration | Custom Sensitive Configuration script for Groovy ConfigSlurper | GuardedString | null | Yes | No |
| customConfiguration | Custom Configuration script for Groovy ConfigSlurper | String | null | No |
| Property | Description | Type | Default | Encrypted | Required |
|---|---|---|---|---|---|
| createScriptFileName | The name of the file used to perform the CREATE operation. | String | null | Create | |
| customizerScriptFileName | The script used to customize some function of the connector. Read the documentation for more details. | String | null | No | |
| authenticateScriptFileName | The name of the file used to perform the AUTHENTICATE operation. | String | null | Authenticate | |
| scriptOnResourceScriptFileName | The name of the file used to perform the RUNSCRIPTONRESOURCE operation. | String | null | Script On Resource | |
| deleteScriptFileName | The name of the file used to perform the DELETE operation. | String | null | Delete | |
| resolveUsernameScriptFileName | The name of the file used to perform the RESOLVE_USERNAME operation. | String | null | Resolve Username | |
| searchScriptFileName | The name of the file used to perform the SEARCH operation. | String | null | Get Search | |
| updateScriptFileName | The name of the file used to perform the UPDATE operation. | String | null | Update | |
| schemaScriptFileName | The name of the file used to perform the SCHEMA operation. | String | null | Schema | |
| testScriptFileName | The name of the file used to perform the TEST operation. | String | null | Test | |
| syncScriptFileName | The name of the file used to perform the SYNC operation. | String | null | Sync |
| Property | Description | Type | Default | Encrypted | Required |
|---|---|---|---|---|---|
| targetDirectory | Directory into which to write classes | File | null | No | |
| warningLevel | Warning Level of the compiler | int | 1 | No | |
| scriptExtensions | Description is not available | String[] | ['groovy'] | No | |
| minimumRecompilationInterval | Sets the minimum of time after a script can be recompiled. | int | 100 | No | |
| scriptBaseClass | Base class name for scripts (must derive from Script) | String | null | No | |
| scriptRoots | The root folder to load the scripts from. If the value is null or empty the classpath value is used. | String[] | null | Yes | |
| tolerance | The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. | int | 10 | No | |
| debug | If true, debugging code should be activated | boolean | false | No | |
| classpath | Classpath for use during compilation. | String[] | [] | No | |
| disabledGlobalASTTransformations | 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. | String[] | null | No | |
| verbose | If true, the compiler should produce action information | boolean | false | No | |
| sourceEncoding | Encoding for source files | String | UTF-8 | No | |
| recompileGroovySource | If set to true recompilation is enabled | boolean | false | No |
| Property | Description | Type | Default | Encrypted | Required |
|---|---|---|---|---|---|
| host | The hostname to connect to | String | null | Yes | |
| port | TCP port to use (defaults to 22) | int | 22 | Yes | |
| user | The user name used to login to remote server | String | null | Yes | |
| password | The password used to login to remote server | GuardedString | null | Yes | No |
| passphrase | The passphrase used to read the private key when using Public Key authentication | GuardedString | null | Yes | No |
| privateKey | The base 64 encoded value (PEM) of the private key used for Public Key authentication | String[] | [] | Yes | No |
| authenticationType | Defines which authentication type should be use: PASSWORD or PUBKEY (defaults to PASSWORD) | String | PASSWORD | Yes | |
| prompt | A string representing the remote SSH session prompt (defaults to root@localhost:# ) | String | root@localhost:# | Yes | |
| sudoCommand | A string representing the sudo command (defaults to /usr/bin/sudo) | String | /usr/bin/sudo | Yes | |
| echoOff | Disable the input command echo (default to true) | boolean | true | Yes | |
| terminalType | Defines the terminal type to use for the session (default to vt102) | String | vt102 | Yes | |
| locale | Define the locale for LC_ALL, LANG and LANGUAGE environment variables to use if setLocale=true | String | en_US.utf8 | Yes | |
| setLocale | Defines if the default environment locale should be changed with the value provided for locale (defaults to false) | boolean | false | Yes | |
| connectionTimeout | Defines the connection timeout to the remote server in milliseconds (default to 5000) | int | 5000 | Yes | |
| expectTimeout | Defines the timeout used by the expect() calls in the scripts in milliseconds (default to 5000) | int | 5000 | Yes | |
| throwOperationTimeoutException | Defines if an OperationTimeoutException should be thrown if any call to expect times out (defaults to true) | boolean | true | Yes |
