SSH Credentials Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID ssh-credentials Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Feb 05, 2014
credentials (version:1.9.4)
Source Code
Issue Tracking
Open Issues
Stephen Connolly (id: stephenconnolly)
Usage Installations 2013-Apr 21933
2013-May 31126
2013-Jun 36288
2013-Jul 42658
2013-Aug 46380
2013-Sep 49944
2013-Oct 55648
2013-Nov 57174
2013-Dec 57057
2014-Jan 62567
2014-Feb 65327
2014-Mar 69923

SSH Credentials Plugin

This plugin allows you to store SSH credentials in Jenkins.

For Developers

Using with Trilead SSH client library

Get the authenticator after you have opened the connection and let it handle authentication for you

StandardUsernameCredentials user = ...
Connection connection = ...

SSHAuthenticator authenticator = SSHAuthenticator.newInstance(connection, user);
if (\!authenticator.authenticate()) throw new RuntimeException("Couldn't authenticate"); 

Using with JSch SSH client library

Get the authenticator before you have opened the connection (using the JSchConnector, needed because of the strange dichotomy with JSch between public key authentication and user/password authentication) and let feed in authentication for you:

StandardUsernameCredentials user = ...
JSchConnector connector = new JSchConnector(user.getUsername(), hostName, port);

SSHAuthenticator authenticator = SSHAuthenticator.newInstance(connector, user);
Session session = connector.getSession(); 

Version History

Version 1.6.1 (Feb 5, 2014)

  • Update credentials plugin dependency to 1.9.4

Version 1.6 (Nov 8, 2013)

  • UI bugfix and update credentials plugin dependency to 1.9.2

Version 1.5.1 (Oct 4, 2013)

  • Fix some annoying UI glitches that fell through the cracks

Version 1.5 (Oct 4, 2013)

  • Add a readResolve to FileOnMasterPrivateKeySource that heals any borked upgrades where the key contents were set as the filename.

Version 1.4 (Aug 30, 2013)

  • Add alternative API to allow overriding the username from SSHAuthenticator.newInstance(connector, user, username) - needed to support e.g. SSH connections via JGit

Version 1.3 (Aug 8, 2013)

  • Another binary incompatibility known to affect CloudBees DEV@cloud servers.

Version 1.2 (Aug 8, 2013)

  • Binary incompatibility affecting older versions of the SSH Slaves plugin. (issue #19104)

Version 1.1 (Aug 7, 2013)

Version 1.0 (Aug 7, 2013)

  • Upgrade to Credentials Plugin 1.0 and migrate to new data types.
  • Any existing plugins that request credentials of type SSHUserPrivateKey explicitly will be unaffected.
  • If an existing plugin requests credentials of type BasicSSHUserPassword the resolution mechanism will handle the mapping to a concrete StandardUsernamePasswordCredentials transparently
  • If an existing plugin requests credentials of the base interface type SSHUser it will not be able to locate and StandardUsernamePasswordCredentials implementations and will need to be adapted to integrate correctly with the new class tree.
  • SSHAuthenticator.matcher() and SSHAuthenticator.matcher(Class< Connection type>) can be used to retrieve a CredentialsMatcher to narrow the search for appropriate credentials. 
  • NOTE: This version requires the SSH Slaves plugin be upgraded to at least version 1.0 or it will break the installed SSH Slaves plugin.
  • NOTE: This version modifies the configuration data format from a format that can be read by version 0.4 to a format that can only be read by 1.0 or newer. It will not be possible to downgrade from 1.0 to a previous release without risking configuration data loss. 

Version 0.4 (Jul 1, 2013)

  • Made the authentication usable on slaves.

Version 0.2 (Oct 25, 2012)

  • Add support for the JSch client library

Version 0.1 (Feb 28, 2012)

  • Initial release 
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.