apache/mina-sshd
Apache MINA sshd is a comprehensive Java library for client- and server-side SSH. https://mina.apache.org/sshd-project/
Download
Step 1. Add the JitPack repository to your build file
Add it in your root build.gradle at the end of repositories:
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
} <repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>Add it in your build.sbt at the end of resolvers:
resolvers += "jitpack" at "https://jitpack.io"
Add it in your project.clj at the end of repositories:
:repositories [["jitpack" "https://jitpack.io"]]
Step 2. Add the dependency
dependencies {
implementation 'com.github.apache:mina-sshd:sshd-2.12.1'
} <dependency>
<groupId>com.github.apache</groupId>
<artifactId>mina-sshd</artifactId>
<version>sshd-2.12.1</version>
</dependency>
libraryDependencies += "com.github.apache" % "mina-sshd" % "sshd-2.12.1"
:dependencies [[com.github.apache/mina-sshd "sshd-2.12.1"]]
Readme
Apache MINA SSHD
Apache MINA SSHD is a 100% pure java library to support the SSH protocols on both the client and server side. It does not aim at being a replacement for the SSH client or SSH server from Unix operating systems, but rather provides support for Java based applications requiring SSH support.
The library can leverage several I/O back-ends:
- The default transport is built-in and uses Java's
AsynchronousSocketChannels. - Apache MINA, a scalable and high performance asynchronous I/O library, can be used instead, or
- the Netty asynchronous event-driven network framework is also supported.
Releases
Releases of Apache MINA sshd are available at Maven Central. tar.gz and
ZIP source and binary distributions are available at the Apache MINA sshd
web site.
Snapshot releases from the main branch are published on each push or merge on the main branch, if the tests pass successfully. These snapshot releases are available at the Apache Snapshot maven repository.
Release notes
Issue reporting
Bug reports and improvement or feature requests can be filed at the GitHub issue tracker or at the Apache issue tracker.
Sensitive issues such as security vulnerabilities must be reported through private channels, not via either issue tracker.
Supported standards
Core requirements
- Java 8+ at runtime (as of version 2.3)
-
Java 17+ at build time (as of version 2.14)
The code only requires the core abstract slf4j-api module. The actual implementation of the logging API can be selected from the many existing adaptors.
Basic artifacts structure
-
sshd-common - contains basic classes used throughout the project as well as code that does not require client or server network support.
-
sshd-core - contains the basic SSH client/server code implementing the connection, transport, channels, forwarding, etc..
-
sshd-sftp - contains the server side SFTP subsystem and the SFTP client code.
- sshd-spring-sftp - contains a Spring Integration compatible SFTP adapter
-
sshd-scp - contains the server side SCP command handler and the SCP client code.
-
sshd-ldap - contains server-side password and public key authenticators that use an LDAP server.
-
sshd-git - contains replacements for JGit SSH session factory.
-
sshd-osgi - contains an artifact that combines sshd-common and sshd-core so it can be deployed in OSGi environments.
-
sshd-putty - contains code that can parse PUTTY key files.
-
sshd-openpgp - contains code that can parse OpenPGP key files (with some limitations - see relevant section)
-
sshd-cli - contains simple templates for command-line client/server - used to provide look-and-feel similar to the Linux ssh/sshd commands.
-
sshd-contrib - experimental code that is currently under review and may find its way into one of the other artifacts (or become an entirely new artifact - e.g., sshd-putty evolved this way).
-
sshd-benchmarks - contains some JMH benchmarks for SSH operations. The benchmarks are intended to be run by developers locally; the artifact is not part of the binary distribution, and is not deployed to any maven repository.
Optional dependencies
Quick reference
Building the code
Including tests
mvn clean install
Without tests
mvn -Pquick clean install