commit | a85462b49cc76c06b565e8d311864808995a3ac9 | [log] [tgz] |
---|---|---|
author | Thomas Wolf <twolf@apache.org> | Thu Mar 14 23:58:50 2024 +0100 |
committer | Thomas Wolf <twolf@apache.org> | Sun May 05 20:13:39 2024 +0200 |
tree | 5064fe31d255cd88536ab95d7af024ec7f60f4e3 | |
parent | 1b9084f2fdc0d53822cdb423332d74ca1d84b288 [diff] |
Improve javadoc on ClientChannel.setIn(InputStream) Closing that input stream when the channel closes is in my view a design mistake. The stream is obtained by the application code from somewhere, and it should be the application's responsibility to close it when appropriate. While changing the implementation (not closing the stream in AbstractClientChannel.getInnerCloseable()) would work, it appears to be too risky a change for a minor version bump. So just explain in the javadoc what to do if the stream should _not_ be closed. (For instance, System.in should never be closed and doing so may even cause hangs on Windows.) Also add a (somewhat contrived) test that chains two remote shells by setting the output of one shell as the input of another shell.
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:
AsynchronousSocketChannel
s.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.
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.
Java 8+ (as of version 1.3)
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.
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-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).
Including tests
mvn clean install
Without tests
mvn -Pquick clean install