SSH Key Grabber Adapter
The SSH Key Grabber adapter is used by the Known Host Key UI wizard to get the SSH Known Host Key from a trading partner's SFTP or SCP server by way of perimeter services.
This adapter is not used as a standalone adapter.
The following table provides an overview of the SSH Key Grabber adapter:
Category | Description |
---|---|
System name | SSH Key Grabber Adapter |
Graphical Process Modeler (GPM) category | All Services |
Description | This adapter is used by the Known Host Key UI wizard to get the SSH Known Host Key from a trading partner's SFTP or SCP server by way of perimeter services. The SSH Key Grabber Adapter is not used as a standalone adapter. |
Business usage | Use this adapter to obtain the SSH key (Known Host Key) from the trading partner's SFTP/SCP servers. By providing the host and port information to the adapter, it will obtain the Known Host Key directly from the server. The SSH key fetched by the adapter can be saved to local disk, checked in to the application database as a Known Host Key, or both. This is a quicker and more convenient option than receiving SSH keys by email (or similar means) from the trading partner and checking them into the application. |
Usage example | This adapter is used by the Known Host Key UI wizard
to get the SSH key of the trading partner server.
|
Preconfigured? | This adapter must be installed and deployed before it can be invoked. |
Requires third-party files? | SSH 3SP libraries (currently available with the system) |
Platform availability | All supported platforms |
Related services | None |
Application requirements | When this adapter is configured with a perimeter server set to a mode other than local, the perimeter server must be installed and running. This perimeter server is typically installed in a DMZ environment, separated from the application by a firewall. Refer to the Perimeter Server documentation for details. |
Initiates business processes? | No |
Invocation | Invoked by:
|
Business process context considerations | The configuration parameters and the outgoing document are picked up by the SSH Key Grabber adapter in the workflow context. |
Workflow Context Considerations | None |
Returned status values | Values:
|
Restrictions | None |
Persistence level | System default |
Testing considerations | Debug information for this adapter can be found in the SSH Key Grabber Adapter and services log files logs. |
Implement the SSH Key Grabber Adapter
To implement the SSH Key Grabber Adapter, complete the following tasks:
- Configure the perimeter server.
- Edit the SSH Key Grabber adapter's service instance to configure the perimeter server and proxy server.
Configure the SSH Key Grabber Adapter
To configure the SSH Key Grabber Adapter, edit the out of the box SSH Key Grabber Adapter service instance.
Parameters Passed from Business Process to Service
The following table describes the SSH Key Grabber Adapter parameters passed from the Business Process to the Service:
Field or Parameter Name | Description |
---|---|
Name | Unique and meaningful name for the adapter configuration. Required. |
Description | Meaningful description for the adapter configuration. Required. |
Select a Group | Whether to include this adapter instance in a group.
Optional. Select one of the options:
|
Perimeter Server | Select the perimeter server to use with this adapter.
Required. Valid values are:
|
Local Port Range | Ports that the client can use to establish an SSH channel to the remote server. Optional. Port value can be a single number or a range, list, or a combination. |
Connection Retries (ConnectionRetries) | Number of times that the adapter attempts to connect
to the remote SSH host. Required. Valid values are:
|
Retry delay (ms) (RetryDelay) | Number of milliseconds that the adapter waits between
retry attempts. Required. Valid values are:
|
ResponseTimeout (ResponseTimeOut) (secs) | The maximum number of seconds that the trading partner's system can take to respond before the session times out and terminates. Optional. Default value is 40 seconds. |
Use Proxy Server (myProxyServer) | User can specify proxy setting for the adapter.
Required. Valid values are:
|
Proxy Configuration Parameters Passed from Business Process to Service
The following table describes the SSH Key Grabber Adapter proxy configuration parameters passed from the Business Process to the Service:
Parm Name (Display Name) | Description |
---|---|
Proxy Host (ProxyHost) | Host name or IP address of the target proxy server.
Required. Valid values:
Note: Trading Partner profile setting can override this value.
|
Proxy Port (ProxyPort) | Port number of the target proxy server. Required
if Use Proxy Server is Yes. Valid value is any available port. Note: Trading
Partner profile setting can override this value.
|
Proxy retries (ProxyRetries) | Number of times the adapter attempts to connect
to the proxy server. Required if Use Proxy Server is set to Yes. Valid
values are:
|
Proxy Authentication (ProxyBasicAuthentication) | Indicates whether the proxy server requires basic
authentication. Required. Valid values are:
|
UserName (ProxyUserId) | User ID used for proxy authentication. Required if Proxy Authentication is Yes. |
Password (ProxyPasswd) | Password that is used for proxy authentication. Required if Proxy Authentication is Yes. |
Proxy Configuration Parameters Passed from Service to Business Process
The following table describes the SSH Key Grabber Adapter proxy configuration parameters passed from the Service to the Business Process:
Parameter | Description |
---|---|
Remote Host (rHost) | External Trading Partner host system (SFTP Server
IP Address or DNS name). Required. Valid values are:
|
Remote Port (rPort) | External Trading Partner port number. Valid value is any valid port number. No default value. |
Parameter Passed from Service to Business Process
The following table describes the SSH Key Grabber Adapter parameter passed from the Service to the Business Process:
Parameter Name | Description |
---|---|
Primary Document | SSH key information fetched by adapter and placed in the primary document. |