mirror of
https://github.com/hierynomus/sshj.git
synced 2025-12-06 07:10:53 +03:00
Spelling (#547)
* spelling: accommodate * spelling: algorithms * spelling: containing * spelling: creating * spelling: developed * spelling: environment * spelling: exception * spelling: heartbeat * spelling: hellman * spelling: identifier * spelling: initiated * spelling: interface * spelling: negotiated * spelling: occurred * spelling: possibility * spelling: requesting * spelling: strong * spelling: successfully * spelling: suspended Co-authored-by: Jeroen van Erp <jeroen@hierynomus.com>
This commit is contained in:
2
NOTICE
2
NOTICE
@@ -15,7 +15,7 @@ The Apache Software Foundation (http://www.apache.org/):
|
|||||||
== in this case for the SSHD distribution. ==
|
== in this case for the SSHD distribution. ==
|
||||||
=========================================================================
|
=========================================================================
|
||||||
|
|
||||||
This product contains software developped by JCraft,Inc. and subject to
|
This product contains software developed by JCraft,Inc. and subject to
|
||||||
the following license:
|
the following license:
|
||||||
|
|
||||||
Copyright (c) 2002,2003,2004,2005,2006,2007,2008 Atsuhiko Yamanaka, JCraft,Inc.
|
Copyright (c) 2002,2003,2004,2005,2006,2007,2008 Atsuhiko Yamanaka, JCraft,Inc.
|
||||||
|
|||||||
@@ -73,7 +73,7 @@ key exchange::
|
|||||||
`diffie-hellman-group-exchange-sha1`, `diffie-hellman-group-exchange-sha256`,
|
`diffie-hellman-group-exchange-sha1`, `diffie-hellman-group-exchange-sha256`,
|
||||||
`ecdh-sha2-nistp256`, `ecdh-sha2-nistp384`, `ecdh-sha2-nistp521`, `curve25519-sha256@libssh.org`
|
`ecdh-sha2-nistp256`, `ecdh-sha2-nistp384`, `ecdh-sha2-nistp521`, `curve25519-sha256@libssh.org`
|
||||||
|
|
||||||
SSHJ also supports the following extended (non official) key exchange algoriths:
|
SSHJ also supports the following extended (non official) key exchange algorithms:
|
||||||
`diffie-hellman-group14-sha256@ssh.com`, `diffie-hellman-group15-sha256`, `diffie-hellman-group15-sha256@ssh.com`, `diffie-hellman-group15-sha384@ssh.com`,
|
`diffie-hellman-group14-sha256@ssh.com`, `diffie-hellman-group15-sha256`, `diffie-hellman-group15-sha256@ssh.com`, `diffie-hellman-group15-sha384@ssh.com`,
|
||||||
`diffie-hellman-group16-sha256`, `diffie-hellman-group16-sha384@ssh.com`, `diffie-hellman-group16-sha512@ssh.com`, `diffie-hellman-group18-sha512@ssh.com`
|
`diffie-hellman-group16-sha256`, `diffie-hellman-group16-sha384@ssh.com`, `diffie-hellman-group16-sha512@ssh.com`, `diffie-hellman-group18-sha512@ssh.com`
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ SSHJ 0.19.1 (2016-12-30)::
|
|||||||
* Enabled PKCS5 Key files in DefaultConfig
|
* Enabled PKCS5 Key files in DefaultConfig
|
||||||
* Merged https://github.com/hierynomus/sshj/pulls/291[#291]: Fixed sshj.properties loading and chained exception messages
|
* Merged https://github.com/hierynomus/sshj/pulls/291[#291]: Fixed sshj.properties loading and chained exception messages
|
||||||
* Merged https://github.com/hierynomus/sshj/pulls/284[#284]: Correctly catch interrupt in keepalive thread
|
* Merged https://github.com/hierynomus/sshj/pulls/284[#284]: Correctly catch interrupt in keepalive thread
|
||||||
* Fixed https://github.com/hierynomus/sshj/issues/292[#292]: Pass the configured RandomFactory to Diffie Hellmann KEX
|
* Fixed https://github.com/hierynomus/sshj/issues/292[#292]: Pass the configured RandomFactory to Diffie Hellman KEX
|
||||||
* Fixed https://github.com/hierynomus/sshj/issues/256[#256]: SSHJ now builds if no git repository present
|
* Fixed https://github.com/hierynomus/sshj/issues/256[#256]: SSHJ now builds if no git repository present
|
||||||
* LocalPortForwarder now correctly interrupts its own thread on close()
|
* LocalPortForwarder now correctly interrupts its own thread on close()
|
||||||
SSHJ 0.19.0 (2016-11-25)::
|
SSHJ 0.19.0 (2016-11-25)::
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ import java.math.BigInteger;
|
|||||||
import static net.schmizz.sshj.transport.kex.DHGroupData.*;
|
import static net.schmizz.sshj.transport.kex.DHGroupData.*;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Factory methods for Diffie Hellmann KEX algorithms based on MODP groups / Oakley Groups
|
* Factory methods for Diffie Hellman KEX algorithms based on MODP groups / Oakley Groups
|
||||||
*
|
*
|
||||||
* - https://tools.ietf.org/html/rfc4253
|
* - https://tools.ietf.org/html/rfc4253
|
||||||
* - https://tools.ietf.org/html/draft-ietf-curdle-ssh-modp-dh-sha2-01
|
* - https://tools.ietf.org/html/draft-ietf-curdle-ssh-modp-dh-sha2-01
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ package net.schmizz.concurrent;
|
|||||||
* if (t instanceof SomeException)
|
* if (t instanceof SomeException)
|
||||||
* return (SomeException) t;
|
* return (SomeException) t;
|
||||||
* else
|
* else
|
||||||
* return new SomeExcepion(t);
|
* return new SomeException(t);
|
||||||
* }
|
* }
|
||||||
* };
|
* };
|
||||||
* </pre>
|
* </pre>
|
||||||
|
|||||||
@@ -160,7 +160,7 @@ public interface Config {
|
|||||||
/**
|
/**
|
||||||
* Gets whether the client should first wait for a received server ident, before sending the client ident.
|
* Gets whether the client should first wait for a received server ident, before sending the client ident.
|
||||||
* <p/>
|
* <p/>
|
||||||
* <stong>NB:</stong> This is non-standard behaviour, and can potentially deadlock if the server also waits on the client ident.
|
* <strong>NB:</strong> This is non-standard behaviour, and can potentially deadlock if the server also waits on the client ident.
|
||||||
*
|
*
|
||||||
* The default value is set to false.
|
* The default value is set to false.
|
||||||
*
|
*
|
||||||
@@ -171,7 +171,7 @@ public interface Config {
|
|||||||
/**
|
/**
|
||||||
* Sets whether the SSH client should wait for a received server ident, before sending the client ident.
|
* Sets whether the SSH client should wait for a received server ident, before sending the client ident.
|
||||||
* <p/>
|
* <p/>
|
||||||
* <stong>NB:</stong> This is non-standard behaviour, and can potentially deadlock if the server also waits on the client ident.
|
* <strong>NB:</strong> This is non-standard behaviour, and can potentially deadlock if the server also waits on the client ident.
|
||||||
|
|
||||||
* @param waitForServerIdentBeforeSendingClientIdent Whether to wait for the server ident.
|
* @param waitForServerIdentBeforeSendingClientIdent Whether to wait for the server ident.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -515,7 +515,7 @@ public class SSHClient
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility function for createing a {@link KeyProvider} instance from given location on the file system. Creates a
|
* Utility function for creating a {@link KeyProvider} instance from given location on the file system. Creates a
|
||||||
* one-off {@link PasswordFinder} using {@link PasswordUtils#createOneOff(char[])}, and calls {@link
|
* one-off {@link PasswordFinder} using {@link PasswordUtils#createOneOff(char[])}, and calls {@link
|
||||||
* #loadKeys(String, PasswordFinder)}.
|
* #loadKeys(String, PasswordFinder)}.
|
||||||
*
|
*
|
||||||
@@ -754,7 +754,7 @@ public class SSHClient
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds {@code zlib} compression to preferred compression algorithms. There is no guarantee that it will be
|
* Adds {@code zlib} compression to preferred compression algorithms. There is no guarantee that it will be
|
||||||
* successfully negotiatied.
|
* successfully negotiated.
|
||||||
* <p/>
|
* <p/>
|
||||||
* If the client is already connected renegotiation is done; otherwise this method simply returns (and compression
|
* If the client is already connected renegotiation is done; otherwise this method simply returns (and compression
|
||||||
* will be negotiated during connection establishment).
|
* will be negotiated during connection establishment).
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ package net.schmizz.sshj.common;
|
|||||||
* <a href="http://www.faqs.org/rfcs/rfc3548.html">RFC3548</a>.</li>
|
* <a href="http://www.faqs.org/rfcs/rfc3548.html">RFC3548</a>.</li>
|
||||||
* <li><em>Throws exceptions instead of returning null values.</em> Because some operations
|
* <li><em>Throws exceptions instead of returning null values.</em> Because some operations
|
||||||
* (especially those that may permit the GZIP option) use IO streams, there
|
* (especially those that may permit the GZIP option) use IO streams, there
|
||||||
* is a possiblity of an java.io.IOException being thrown. After some discussion and
|
* is a possibility of an java.io.IOException being thrown. After some discussion and
|
||||||
* thought, I've changed the behavior of the methods to throw java.io.IOExceptions
|
* thought, I've changed the behavior of the methods to throw java.io.IOExceptions
|
||||||
* rather than return null if ever there's an error. I think this is more
|
* rather than return null if ever there's an error. I think this is more
|
||||||
* appropriate, though it will require some changes to your code. Sorry,
|
* appropriate, though it will require some changes to your code. Sorry,
|
||||||
@@ -476,7 +476,7 @@ public class Base64
|
|||||||
* anywhere along their length by specifying
|
* anywhere along their length by specifying
|
||||||
* <var>srcOffset</var> and <var>destOffset</var>.
|
* <var>srcOffset</var> and <var>destOffset</var>.
|
||||||
* This method does not check to make sure your arrays
|
* This method does not check to make sure your arrays
|
||||||
* are large enough to accomodate <var>srcOffset</var> + 3 for
|
* are large enough to accommodate <var>srcOffset</var> + 3 for
|
||||||
* the <var>source</var> array or <var>destOffset</var> + 4 for
|
* the <var>source</var> array or <var>destOffset</var> + 4 for
|
||||||
* the <var>destination</var> array.
|
* the <var>destination</var> array.
|
||||||
* The actual number of significant bytes in your array is
|
* The actual number of significant bytes in your array is
|
||||||
@@ -1007,7 +1007,7 @@ public class Base64
|
|||||||
* anywhere along their length by specifying
|
* anywhere along their length by specifying
|
||||||
* <var>srcOffset</var> and <var>destOffset</var>.
|
* <var>srcOffset</var> and <var>destOffset</var>.
|
||||||
* This method does not check to make sure your arrays
|
* This method does not check to make sure your arrays
|
||||||
* are large enough to accomodate <var>srcOffset</var> + 4 for
|
* are large enough to accommodate <var>srcOffset</var> + 4 for
|
||||||
* the <var>source</var> array or <var>destOffset</var> + 3 for
|
* the <var>source</var> array or <var>destOffset</var> + 3 for
|
||||||
* the <var>destination</var> array.
|
* the <var>destination</var> array.
|
||||||
* This method returns the actual number of bytes that
|
* This method returns the actual number of bytes that
|
||||||
@@ -1928,7 +1928,7 @@ public class Base64
|
|||||||
if( suspendEncoding ) {
|
if( suspendEncoding ) {
|
||||||
this.out.write( theByte );
|
this.out.write( theByte );
|
||||||
return;
|
return;
|
||||||
} // end if: supsended
|
} // end if: suspended
|
||||||
|
|
||||||
// Encode?
|
// Encode?
|
||||||
if( encode ) {
|
if( encode ) {
|
||||||
@@ -1983,7 +1983,7 @@ public class Base64
|
|||||||
if( suspendEncoding ) {
|
if( suspendEncoding ) {
|
||||||
this.out.write( theBytes, off, len );
|
this.out.write( theBytes, off, len );
|
||||||
return;
|
return;
|
||||||
} // end if: supsended
|
} // end if: suspended
|
||||||
|
|
||||||
for( int i = 0; i < len; i++ ) {
|
for( int i = 0; i < len; i++ ) {
|
||||||
write( theBytes[ off + i ] );
|
write( theBytes[ off + i ] );
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ import java.util.List;
|
|||||||
public interface Factory<T> {
|
public interface Factory<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Inteface for a named factory. Named factories are simply factories that are identified by a name. Such names are
|
* Interface for a named factory. Named factories are simply factories that are identified by a name. Such names are
|
||||||
* used mainly in SSH algorithm negotiation.
|
* used mainly in SSH algorithm negotiation.
|
||||||
*
|
*
|
||||||
* @param <T> type of object created by this factory
|
* @param <T> type of object created by this factory
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ import net.schmizz.sshj.transport.TransportException;
|
|||||||
import java.nio.charset.Charset;
|
import java.nio.charset.Charset;
|
||||||
import java.util.concurrent.TimeUnit;
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
/** Base class for direct channels whose open is initated by the client. */
|
/** Base class for direct channels whose open is initiated by the client. */
|
||||||
public abstract class AbstractDirectChannel
|
public abstract class AbstractDirectChannel
|
||||||
extends AbstractChannel
|
extends AbstractChannel
|
||||||
implements Channel.Direct {
|
implements Channel.Direct {
|
||||||
|
|||||||
@@ -191,7 +191,7 @@ public interface Session
|
|||||||
TransportException;
|
TransportException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set an enviornment variable.
|
* Set an environment variable.
|
||||||
*
|
*
|
||||||
* @param name name of the variable
|
* @param name name of the variable
|
||||||
* @param value value to set
|
* @param value value to set
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ public interface ForwardedChannelOpener {
|
|||||||
/**
|
/**
|
||||||
* Delegates a {@code SSH_MSG_CHANNEL_OPEN} request for the channel type claimed by this opener.
|
* Delegates a {@code SSH_MSG_CHANNEL_OPEN} request for the channel type claimed by this opener.
|
||||||
*
|
*
|
||||||
* @param buf {@link SSHPacket} containg the request except for the message identifier and channel type field
|
* @param buf {@link SSHPacket} containing the request except for the message identifier and channel type field
|
||||||
*/
|
*/
|
||||||
void handleOpen(SSHPacket buf)
|
void handleOpen(SSHPacket buf)
|
||||||
throws ConnectionException, TransportException;
|
throws ConnectionException, TransportException;
|
||||||
|
|||||||
@@ -94,7 +94,7 @@ final class KeyExchanger
|
|||||||
* Add a callback for host key verification.
|
* Add a callback for host key verification.
|
||||||
* <p/>
|
* <p/>
|
||||||
* Any of the {@link HostKeyVerifier} implementations added this way can deem a host key to be acceptable, allowing
|
* Any of the {@link HostKeyVerifier} implementations added this way can deem a host key to be acceptable, allowing
|
||||||
* key exchange to successfuly complete. Otherwise, a {@link TransportException} will result during key exchange.
|
* key exchange to successfully complete. Otherwise, a {@link TransportException} will result during key exchange.
|
||||||
*
|
*
|
||||||
* @param hkv object whose {@link HostKeyVerifier#verify} method will be invoked
|
* @param hkv object whose {@link HostKeyVerifier#verify} method will be invoked
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -92,7 +92,7 @@ public interface Transport
|
|||||||
int getHeartbeatInterval();
|
int getHeartbeatInterval();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param interval the interval in seconds, {@code 0} means no hearbeat
|
* @param interval the interval in seconds, {@code 0} means no heartbeat
|
||||||
* @deprecated Moved to {@link net.schmizz.keepalive.KeepAlive#getKeepAliveInterval()}. This is accessible through the {@link net.schmizz.sshj.connection.Connection}.
|
* @deprecated Moved to {@link net.schmizz.keepalive.KeepAlive#getKeepAliveInterval()}. This is accessible through the {@link net.schmizz.sshj.connection.Connection}.
|
||||||
* Scheduled to be removed in 0.12.0
|
* Scheduled to be removed in 0.12.0
|
||||||
*/
|
*/
|
||||||
@@ -156,7 +156,7 @@ public interface Transport
|
|||||||
*
|
*
|
||||||
* @return the sequence number of the packet sent
|
* @return the sequence number of the packet sent
|
||||||
*
|
*
|
||||||
* @throws TransportException if an error occured sending the packet
|
* @throws TransportException if an error occurred sending the packet
|
||||||
*/
|
*/
|
||||||
long sendUnimplemented()
|
long sendUnimplemented()
|
||||||
throws TransportException;
|
throws TransportException;
|
||||||
|
|||||||
@@ -485,8 +485,8 @@ public final class TransportImpl
|
|||||||
* This method is called in the context of the {@link #reader} thread via {@link Decoder#received} when a full
|
* This method is called in the context of the {@link #reader} thread via {@link Decoder#received} when a full
|
||||||
* packet has been decoded.
|
* packet has been decoded.
|
||||||
*
|
*
|
||||||
* @param msg the message identifer
|
* @param msg the message identifier
|
||||||
* @param buf buffer containg rest of the packet
|
* @param buf buffer containing rest of the packet
|
||||||
* @throws SSHException if an error occurs during handling (unrecoverable)
|
* @throws SSHException if an error occurs during handling (unrecoverable)
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ import net.schmizz.sshj.userauth.keyprovider.KeyProvider;
|
|||||||
/**
|
/**
|
||||||
* Implements the {@code "publickey"} SSH authentication method.
|
* Implements the {@code "publickey"} SSH authentication method.
|
||||||
* <p/>
|
* <p/>
|
||||||
* Requesteing authentication with this method first sends a "feeler" request with just the public key, and if the
|
* Requesting authentication with this method first sends a "feeler" request with just the public key, and if the
|
||||||
* server responds with {@code SSH_MSG_USERAUTH_PK_OK} indicating that the key is acceptable, it proceeds to send a
|
* server responds with {@code SSH_MSG_USERAUTH_PK_OK} indicating that the key is acceptable, it proceeds to send a
|
||||||
* request signed with the private key. Therefore, private keys are not requested from the associated {@link
|
* request signed with the private key. Therefore, private keys are not requested from the associated {@link
|
||||||
* KeyProvider} unless needed.
|
* KeyProvider} unless needed.
|
||||||
|
|||||||
Reference in New Issue
Block a user