This is an automated email from the ASF dual-hosted git repository.
coheigea pushed a commit to branch camel-2.x
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 4049d9a742c9e67695cbabb83ceafec9e65da848
Author: Colm O hEigeartaigh <cohei...@apache.org>
AuthorDate: Thu Jun 27 15:41:20 2019 +0100
CAMEL-13692 - Don't use ssh-rsa as the default keytype for client keys
---
.../camel-ssh/src/main/docs/ssh-component.adoc | 4 +-
.../camel/component/ssh/SshConfiguration.java | 12 +-
.../org/apache/camel/component/ssh/SshHelper.java | 37 ++-
.../component/ssh/SshComponentSecurityTest.java | 17 ++
components/camel-ssh/src/test/resources/ec.pem | 7 +
.../modules/ROOT/pages/ssh-component.adoc | 283 ++++++++++++++++++++-
.../ssh/springboot/SshComponentConfiguration.java | 2 +-
7 files changed, 339 insertions(+), 23 deletions(-)
diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc
b/components/camel-ssh/src/main/docs/ssh-component.adoc
index e533904..42c4718 100644
--- a/components/camel-ssh/src/main/docs/ssh-component.adoc
+++ b/components/camel-ssh/src/main/docs/ssh-component.adoc
@@ -113,7 +113,7 @@ with the following path and query parameters:
| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
| *certResource* (security) | Sets the resource path of the certificate to use
for Authentication. Will use ResourceHelperKeyPairProvider to resolve file
based certificate, and depends on keyType setting. | | String
| *keyPairProvider* (security) | Sets the KeyPairProvider reference to use
when connecting using Certificates to the remote SSH Server. | |
KeyPairProvider
-| *keyType* (security) | Sets the key type to pass to the KeyPairProvider as
part of authentication. KeyPairProvider.loadKey(...) will be passed this value.
Defaults to ssh-rsa. | ssh-rsa | String
+| *keyType* (security) | Sets the key type to pass to the KeyPairProvider as
part of authentication. KeyPairProvider.loadKey(...) will be passed this value.
Defaults to ssh-rsa. | | String
| *password* (security) | Sets the password to use in connecting to remote SSH
server. Requires keyPairProvider to be set to null. | | String
| *username* (security) | Sets the username to use in logging into the remote
SSH server. | | String
|===
@@ -196,7 +196,7 @@ and which options are set.
set, and if so, use it to locate the referenced Public Key certificate
and use that for authentication.
2. If `certResource` is not set, it will look to see if a
-`keyPairProvider` has been set, and if so, it will use that to for
+`keyPairProvider` has been set, and if so, it will use that for
certificate based authentication.
3. If neither `certResource` nor `keyPairProvider` are set, it will use
the `username` and `password` options for authentication. Even though the
`username`
diff --git
a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java
b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java
index e2cf293..dcaf2c0 100644
---
a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java
+++
b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java
@@ -44,8 +44,8 @@ public class SshConfiguration implements Cloneable {
private String pollCommand;
@UriParam(label = "security")
private KeyPairProvider keyPairProvider;
- @UriParam(label = "security", defaultValue = KeyPairProvider.SSH_RSA)
- private String keyType = KeyPairProvider.SSH_RSA;
+ @UriParam(label = "security")
+ private String keyType;
@UriParam(label = "security")
private String certResource;
@UriParam(defaultValue = "30000")
@@ -60,7 +60,7 @@ public class SshConfiguration implements Cloneable {
private String shellPrompt;
@UriParam(label = "advanced", defaultValue = "100")
private long sleepForShellPrompt;
-
+
public SshConfiguration() {
}
@@ -289,7 +289,7 @@ public class SshConfiguration implements Cloneable {
public void setFailOnUnknownHost(boolean failOnUnknownHost) {
this.failOnUnknownHost = failOnUnknownHost;
}
-
+
public String getChannelType() {
return channelType;
}
@@ -306,7 +306,7 @@ public class SshConfiguration implements Cloneable {
public void setChannelType(String channelType) {
this.channelType = channelType;
}
-
+
public String getShellPrompt() {
return shellPrompt;
}
@@ -315,7 +315,7 @@ public class SshConfiguration implements Cloneable {
* Sets the shellPrompt to be dropped when response is read after command
execution
*
* @param shellPrompt
- * String defining ending string of command line which has to
be dropped when response is
+ * String defining ending string of command line which has to
be dropped when response is
* read after command execution.
*/
public void setShellPrompt(String shellPrompt) {
diff --git
a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshHelper.java
b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshHelper.java
index 02082c0..dbfef18 100644
---
a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshHelper.java
+++
b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshHelper.java
@@ -24,6 +24,7 @@ import java.io.PipedOutputStream;
import java.io.UnsupportedEncodingException;
import java.security.KeyPair;
import java.util.Arrays;
+import java.util.Iterator;
import java.util.Map;
import java.util.Set;
@@ -41,12 +42,12 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public final class SshHelper {
-
+
protected static final Logger LOG =
LoggerFactory.getLogger(SshHelper.class);
-
+
private SshHelper() {
}
-
+
public static SshResult sendExecCommand(Map<String, Object> headers,
String command, SshEndpoint endpoint, SshClient client) throws Exception {
SshConfiguration configuration = endpoint.getConfiguration();
@@ -73,11 +74,11 @@ public final class SshHelper {
ClientChannel channel = null;
ClientSession session = null;
-
+
try {
AuthFuture authResult;
session = connectFuture.getSession();
-
+
KeyPairProvider keyPairProvider;
final String certResource = configuration.getCertResource();
if (certResource != null) {
@@ -90,7 +91,17 @@ public final class SshHelper {
// either provide a keypair or password identity first
if (keyPairProvider != null) {
LOG.debug("Attempting to authenticate username '{}' using a
key identity", userName);
- KeyPair pair =
keyPairProvider.loadKey(configuration.getKeyType());
+ KeyPair pair = null;
+ // If we have no configured key type then just use the first
keypair
+ if (configuration.getKeyType() == null) {
+ Iterator<KeyPair> iterator =
keyPairProvider.loadKeys().iterator();
+ if (iterator.hasNext()) {
+ pair = iterator.next();
+ }
+ } else {
+ pair = keyPairProvider.loadKey(configuration.getKeyType());
+ }
+
session.addPublicKeyIdentity(pair);
} else {
String password = configuration.getPassword();
@@ -108,15 +119,15 @@ public final class SshHelper {
authResult = session.auth();
authResult.await(configuration.getTimeout());
-
+
if (!authResult.isDone() || authResult.isFailure()) {
LOG.debug("Failed to authenticate");
throw new RuntimeCamelException("Failed to authenticate
username " + configuration.getUsername());
}
-
+
InputStream in = null;
PipedOutputStream reply = new PipedOutputStream();
-
+
// for now only two channel types are supported
// shell option is added for specific purpose for now
// may need further maintainance for further use cases
@@ -131,10 +142,10 @@ public final class SshHelper {
}
channel.setIn(in);
-
+
ByteArrayOutputStream out = new ByteArrayOutputStream();
channel.setOut(out);
-
+
ByteArrayOutputStream err = new ByteArrayOutputStream();
channel.setErr(err);
OpenFuture openFuture = channel.open();
@@ -163,12 +174,12 @@ public final class SshHelper {
if (channel != null) {
channel.close(true);
}
- // need to make sure the session is closed
+ // need to make sure the session is closed
if (session != null) {
session.close(false);
}
}
-
+
}
private static String getPrompt(ClientChannel channel,
ByteArrayOutputStream output, SshEndpoint endpoint)
diff --git
a/components/camel-ssh/src/test/java/org/apache/camel/component/ssh/SshComponentSecurityTest.java
b/components/camel-ssh/src/test/java/org/apache/camel/component/ssh/SshComponentSecurityTest.java
index 9a3fb9d..d83fbcd 100644
---
a/components/camel-ssh/src/test/java/org/apache/camel/component/ssh/SshComponentSecurityTest.java
+++
b/components/camel-ssh/src/test/java/org/apache/camel/component/ssh/SshComponentSecurityTest.java
@@ -52,6 +52,19 @@ public class SshComponentSecurityTest extends
SshComponentTestSupport {
assertMockEndpointsSatisfied();
}
+ @Test
+ public void testECFile() throws Exception {
+ final String msg = "test";
+
+ MockEndpoint mock = getMockEndpoint("mock:ecFile");
+ mock.expectedMinimumMessageCount(1);
+ mock.expectedBodiesReceived(msg);
+
+ template.sendBody("direct:ssh-ecFile", msg);
+
+ assertMockEndpointsSatisfied();
+ }
+
@Override
protected RouteBuilder createRouteBuilder() throws Exception {
return new RouteBuilder() {
@@ -77,6 +90,10 @@ public class SshComponentSecurityTest extends
SshComponentTestSupport {
from("direct:ssh-rsaFile")
.to("ssh://smx@localhost:" + port +
"?certResource=file:src/test/resources/hostkey.pem")
.to("mock:rsaFile");
+
+ from("direct:ssh-ecFile")
+ .to("ssh://smx@localhost:" + port +
"?certResource=file:src/test/resources/ec.pem")
+ .to("mock:ecFile");
}
};
}
diff --git a/components/camel-ssh/src/test/resources/ec.pem
b/components/camel-ssh/src/test/resources/ec.pem
new file mode 100644
index 0000000..5cfea18
--- /dev/null
+++ b/components/camel-ssh/src/test/resources/ec.pem
@@ -0,0 +1,7 @@
+-----BEGIN EC PRIVATE KEY-----
+MIHcAgEBBEIB5Twq2mxiOAieZslZlOkOG1Pi4PEmAWJ78+bRLAV7Q4F5Nd4u0bAd
+zGIEMFARoeVb/2C8ZFjNhL8xgOUPWJqY316gBwYFK4EEACOhgYkDgYYABADMulfT
+EOAzU9gsMEfrOuTJj9J8c4SNaAeeUb6uDHYfKPnYvfMJrBcGlnRePjJjeWpGHOyk
+qB8NYpCFk/TPgYFGpQGpz51EZngsQwpEEQXw/jzBHZsVOdrTADYu09Cy/AMLu3wA
+naQ5rWm41G3eC8mfZ1Q0BQ7Fc0K103mxlayEM605jw==
+-----END EC PRIVATE KEY-----
diff --git a/docs/components/modules/ROOT/pages/ssh-component.adoc
b/docs/components/modules/ROOT/pages/ssh-component.adoc
deleted file mode 120000
index 1d85339..0000000
--- a/docs/components/modules/ROOT/pages/ssh-component.adoc
+++ /dev/null
@@ -1 +0,0 @@
-../../../../../components/camel-ssh/src/main/docs/ssh-component.adoc
\ No newline at end of file
diff --git a/docs/components/modules/ROOT/pages/ssh-component.adoc
b/docs/components/modules/ROOT/pages/ssh-component.adoc
new file mode 100644
index 0000000..3215588
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/ssh-component.adoc
@@ -0,0 +1,282 @@
+[[ssh-component]]
+== SSH Component
+
+*Available as of Camel version 2.10*
+
+The SSH component enables access to SSH servers such that you can send
+an SSH command, and process the response.
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-ssh</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+### URI format
+
+[source,java]
+-----------------------------------------------
+ssh:[username[:password]@]host[:port][?options]
+-----------------------------------------------
+
+### Options
+
+
+
+// component options: START
+The SSH component supports 15 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *configuration* (advanced) | To use the shared SSH configuration | |
SshConfiguration
+| *host* (common) | Sets the hostname of the remote SSH server. | | String
+| *port* (common) | Sets the port number for the remote SSH server. | | int
+| *username* (security) | Sets the username to use in logging into the remote
SSH server. | | String
+| *password* (security) | Sets the password to use in connecting to remote SSH
server. Requires keyPairProvider to be set to null. | | String
+| *pollCommand* (common) | Sets the command string to send to the remote SSH
server during every poll cycle. Only works with camel-ssh component being used
as a consumer, i.e. from(ssh://...). You may need to end your command with a
newline, and that must be URL encoded %0A | | String
+| *keyPairProvider* (security) | Sets the KeyPairProvider reference to use
when connecting using Certificates to the remote SSH Server. | |
KeyPairProvider
+| *keyType* (security) | Sets the key type to pass to the KeyPairProvider as
part of authentication. KeyPairProvider.loadKey(...) will be passed this value.
Defaults to ssh-rsa. | | String
+| *timeout* (common) | Sets the timeout in milliseconds to wait in
establishing the remote SSH server connection. Defaults to 30000 milliseconds.
| | long
+| *certResource* (security) | Sets the resource path of the certificate to use
for Authentication. Will use ResourceHelperKeyPairProvider to resolve file
based certificate, and depends on keyType setting. | | String
+| *channelType* (advanced) | Sets the channel type to pass to the Channel as
part of command execution. Defaults to exec. | | String
+| *shellPrompt* (advanced) | Sets the shellPrompt to be dropped when response
is read after command execution | | String
+| *sleepForShellPrompt* (advanced) | Sets the sleep period in milliseconds to
wait reading response from shell prompt. Defaults to 100 milliseconds. | | long
+| *resolveProperty Placeholders* (advanced) | Whether the component should
resolve property placeholders on itself when starting. Only properties which
are of String type can use property placeholders. | true | boolean
+| *basicPropertyBinding* (advanced) | Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+|===
+// component options: END
+
+
+
+
+// endpoint options: START
+The SSH endpoint is configured using URI syntax:
+
+----
+ssh:host:port
+----
+
+with the following path and query parameters:
+
+==== Path Parameters (2 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *host* | *Required* Sets the hostname of the remote SSH server. | | String
+| *port* | Sets the port number for the remote SSH server. | 22 | int
+|===
+
+
+==== Query Parameters (33 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *failOnUnknownHost* (common) | Specifies whether a connection to an unknown
host should fail or not. This value is only checked when the property
knownHosts is set. | false | boolean
+| *knownHostsResource* (common) | Sets the resource path for a known_hosts
file | | String
+| *timeout* (common) | Sets the timeout in milliseconds to wait in
establishing the remote SSH server connection. Defaults to 30000 milliseconds.
| 30000 | long
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
+| *pollCommand* (consumer) | Sets the command string to send to the remote SSH
server during every poll cycle. Only works with camel-ssh component being used
as a consumer, i.e. from(ssh://...) You may need to end your command with a
newline, and that must be URL encoded %0A | | String
+| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
+| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
+| *pollStrategy* (consumer) | A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the
poll operation before an Exchange have been created and being routed in Camel.
| | PollingConsumerPoll Strategy
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
+| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+| *channelType* (advanced) | Sets the channel type to pass to the Channel as
part of command execution. Defaults to exec. | exec | String
+| *shellPrompt* (advanced) | Sets the shellPrompt to be dropped when response
is read after command execution | | String
+| *sleepForShellPrompt* (advanced) | Sets the sleep period in milliseconds to
wait reading response from shell prompt. Defaults to 100 milliseconds. | 100 |
long
+| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
+| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
+| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls
that should happen before the backoffMultipler should kick-in. | | int
+| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer
backoff if there has been a number of subsequent idles/errors in a row. The
multiplier is then the number of polls that will be skipped before the next
actual attempt is happening again. When this option is in use then
backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | |
int
+| *delay* (scheduler) | Milliseconds before the next poll. You can also
specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and
30 seconds), and 1h (1 hour). | 500 | long
+| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer
will run immediately again, if the previous run polled 1 or more messages. |
false | boolean
+| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You
can also specify time values using units, such as 60s (60 seconds), 5m30s (5
minutes and 30 seconds), and 1h (1 hour). | 1000 | long
+| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line
when it polls. This option allows you to configure the logging level for that.
| TRACE | LoggingLevel
+| *scheduledExecutorService* (scheduler) | Allows for configuring a
custom/shared thread pool to use for the consumer. By default each consumer has
its own single threaded thread pool. | | ScheduledExecutor Service
+| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring
or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| *schedulerProperties* (scheduler) | To configure additional properties when
using a custom scheduler or any of the Quartz2, Spring based scheduler. | | Map
+| *startScheduler* (scheduler) | Whether the scheduler should be auto started.
| true | boolean
+| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. |
MILLISECONDS | TimeUnit
+| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
+| *certResource* (security) | Sets the resource path of the certificate to use
for Authentication. Will use ResourceHelperKeyPairProvider to resolve file
based certificate, and depends on keyType setting. | | String
+| *keyPairProvider* (security) | Sets the KeyPairProvider reference to use
when connecting using Certificates to the remote SSH Server. | |
KeyPairProvider
+| *keyType* (security) | Sets the key type to pass to the KeyPairProvider as
part of authentication. KeyPairProvider.loadKey(...) will be passed this value.
Defaults to ssh-rsa. | | String
+| *password* (security) | Sets the password to use in connecting to remote SSH
server. Requires keyPairProvider to be set to null. | | String
+| *username* (security) | Sets the username to use in logging into the remote
SSH server. | | String
+|===
+// endpoint options: END
+// spring-boot-auto-configure options: START
+=== Spring Boot Auto-Configuration
+
+When using Spring Boot make sure to use the following Maven dependency to have
support for auto configuration:
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-ssh-starter</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+----
+
+
+The component supports 30 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *camel.component.ssh.basic-property-binding* | Whether the component should
use basic property binding (Camel 2.x) or the newer property binding with
additional capabilities | false | Boolean
+| *camel.component.ssh.cert-resource* | Sets the resource path of the
certificate to use for Authentication. Will use ResourceHelperKeyPairProvider
to resolve file based certificate, and depends on keyType setting. | | String
+| *camel.component.ssh.channel-type* | Sets the channel type to pass to the
Channel as part of command execution. Defaults to exec. | | String
+| *camel.component.ssh.configuration.cert-resource* | Sets the resource path
of the certificate to use for Authentication. Will use {@link
ResourceHelperKeyPairProvider} to resolve file based certificate, and depends
on keyType setting. | | String
+| *camel.component.ssh.configuration.channel-type* | Sets the channel type to
pass to the Channel as part of command execution. Defaults to "exec". | exec |
String
+| *camel.component.ssh.configuration.fail-on-unknown-host* | Specifies whether
a connection to an unknown host should fail or not. This value is only checked
when the property knownHosts is set. | false | Boolean
+| *camel.component.ssh.configuration.host* | Sets the hostname of the remote
SSH server. | | String
+| *camel.component.ssh.configuration.key-pair-provider* | Sets the
KeyPairProvider reference to use when connecting using Certificates to the
remote SSH Server. | | KeyPairProvider
+| *camel.component.ssh.configuration.key-type* | Sets the key type to pass to
the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...)
will be passed this value. Defaults to "ssh-rsa". | ssh-rsa | String
+| *camel.component.ssh.configuration.known-hosts-resource* | Sets the resource
path for a known_hosts file | | String
+| *camel.component.ssh.configuration.password* | Sets the password to use in
connecting to remote SSH server. Requires keyPairProvider to be set to null. |
| String
+| *camel.component.ssh.configuration.poll-command* | Sets the command string
to send to the remote SSH server during every poll cycle. Only works with
camel-ssh component being used as a consumer, i.e. from("ssh://...") You may
need to end your command with a newline, and that must be URL encoded %0A | |
String
+| *camel.component.ssh.configuration.port* | Sets the port number for the
remote SSH server. | 22 | Integer
+| *camel.component.ssh.configuration.shell-prompt* | Sets the shellPrompt to
be dropped when response is read after command execution | | String
+| *camel.component.ssh.configuration.sleep-for-shell-prompt* | Sets the sleep
period in milliseconds to wait reading response from shell prompt. Defaults to
100 milliseconds. | 100 | Long
+| *camel.component.ssh.configuration.timeout* | Sets the timeout in
milliseconds to wait in establishing the remote SSH server connection. Defaults
to 30000 milliseconds. | 30000 | Long
+| *camel.component.ssh.configuration.username* | Sets the username to use in
logging into the remote SSH server. | | String
+| *camel.component.ssh.enabled* | Enable ssh component | true | Boolean
+| *camel.component.ssh.host* | Sets the hostname of the remote SSH server. |
| String
+| *camel.component.ssh.key-pair-provider* | Sets the KeyPairProvider reference
to use when connecting using Certificates to the remote SSH Server. The option
is a org.apache.sshd.common.keyprovider.KeyPairProvider type. | | String
+| *camel.component.ssh.key-type* | Sets the key type to pass to the
KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be
passed this value. Defaults to ssh-rsa. | | String
+| *camel.component.ssh.password* | Sets the password to use in connecting to
remote SSH server. Requires keyPairProvider to be set to null. | | String
+| *camel.component.ssh.poll-command* | Sets the command string to send to the
remote SSH server during every poll cycle. Only works with camel-ssh component
being used as a consumer, i.e. from(ssh://...). You may need to end your
command with a newline, and that must be URL encoded %0A | | String
+| *camel.component.ssh.port* | Sets the port number for the remote SSH server.
| | Integer
+| *camel.component.ssh.resolve-property-placeholders* | Whether the component
should resolve property placeholders on itself when starting. Only properties
which are of String type can use property placeholders. | true | Boolean
+| *camel.component.ssh.shell-prompt* | Sets the shellPrompt to be dropped when
response is read after command execution | | String
+| *camel.component.ssh.sleep-for-shell-prompt* | Sets the sleep period in
milliseconds to wait reading response from shell prompt. Defaults to 100
milliseconds. | | Long
+| *camel.component.ssh.timeout* | Sets the timeout in milliseconds to wait in
establishing the remote SSH server connection. Defaults to 30000 milliseconds.
| | Long
+| *camel.component.ssh.username* | Sets the username to use in logging into
the remote SSH server. | | String
+| *camel.component.ssh.configuration.cert-filename* | *Deprecated* | | String
+|===
+// spring-boot-auto-configure options: END
+
+
+
+### Usage as a Producer endpoint
+
+When the SSH Component is used as a Producer (`.to("ssh://...")`), it
+will send the message body as the command to execute on the remote SSH
+server.
+
+Here is an example of this within the XML DSL. Note that the command has
+an XML encoded newline (`+ +`).
+
+[source,xml]
+----------------------------------------------
+<route id="camel-example-ssh-producer">
+ <from uri="direct:exampleSshProducer"/>
+ <setBody>
+ <constant>features:list </constant>
+ </setBody>
+ <to uri="ssh://karaf:karaf@localhost:8101"/>
+ <log message="${body}"/>
+</route>
+----------------------------------------------
+
+### Authentication
+
+The SSH Component can authenticate against the remote SSH server using
+one of two mechanisms: Public Key certificate or username/password.
+Configuring how the SSH Component does authentication is based on how
+and which options are set.
+
+1. First, it will look to see if the `certResource` option has been
+set, and if so, use it to locate the referenced Public Key certificate
+and use that for authentication.
+2. If `certResource` is not set, it will look to see if a
+`keyPairProvider` has been set, and if so, it will use that for
+certificate based authentication.
+3. If neither `certResource` nor `keyPairProvider` are set, it will use
+the `username` and `password` options for authentication. Even though the
`username`
+and `password` are provided in the endpoint configuration and headers set with
+`SshConstants.USERNAME_HEADER` (`CamelSshUsername`) and
+`SshConstants.PASSWORD_HEADER` (`CamelSshPassword`), the endpoint
+configuration is surpassed and credentials set in the headers are used.
+
+The following route fragment shows an SSH polling consumer using a
+certificate from the classpath.
+
+In the XML DSL,
+
+[source,xml]
+-------------------------------------------------------------------------------------------------------------------------------------------------
+<route>
+ <from
uri="ssh://scott@localhost:8101?certResource=classpath:test_rsa&useFixedDelay=true&delay=5000&pollCommand=features:list%0A"/>
+ <log message="${body}"/>
+</route>
+-------------------------------------------------------------------------------------------------------------------------------------------------
+
+In the Java DSL,
+
+[source,java]
+-----------------------------------------------------------------------------------------------------------------------------
+from("ssh://scott@localhost:8101?certResource=classpath:test_rsa&useFixedDelay=true&delay=5000&pollCommand=features:list%0A")
+ .log("${body}");
+-----------------------------------------------------------------------------------------------------------------------------
+
+An example of using Public Key authentication is provided in
+`examples/camel-example-ssh-security`.
+
+[[SSH-CertificateDependencies]]
+Certificate Dependencies
+
+You will need to add some additional runtime dependencies if you use
+certificate based authentication. You may need to use later versions depending
what version
+of Camel you are using.
+
+[source,xml]
+-----------------------------------------
+<dependency>
+ <groupId>org.apache.sshd</groupId>
+ <artifactId>sshd-core</artifactId>
+ <version>0.8.0</version>
+</dependency>
+<dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcpg-jdk15on</artifactId>
+ <version>1.47</version>
+</dependency>
+<dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcpkix-jdk15on</artifactId>
+ <version>1.47</version>
+</dependency>
+-----------------------------------------
+
+### Example
+
+See the `examples/camel-example-ssh` and
+`examples/camel-example-ssh-security` in the Camel distribution.
+
+### See Also
+
+* Configuring Camel
+* Component
+* Endpoint
+* Getting Started
diff --git
a/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
b/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
index dc1050b..715acfc 100644
---
a/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
+++
b/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
@@ -278,7 +278,7 @@ public class SshComponentConfiguration
* authentication. KeyPairProvider.loadKey(...) will be passed this
* value. Defaults to ssh-rsa.
*/
- private String keyType = "ssh-rsa";
+ private String keyType;
/**
* Sets the timeout in milliseconds to wait in establishing the remote
* SSH server connection. Defaults to 30000 milliseconds.
