com.palantir.giraffe.ssh

Class PublicKeySshCredential

java.lang.Object

com.palantir.giraffe.host.Credential<SshAuthenticator>

com.palantir.giraffe.ssh.SshCredential

com.palantir.giraffe.ssh.PublicKeySshCredential

public final class PublicKeySshCredential
extends SshCredential

Authenticates SSH connections using the private key of a key pair. The target server must already have the associated public key.

This class optionally provides a path to the private key on the file system, which is useful to interoperate with external commands like rsync which may not take keys directly. For this reason, clients are encourages to use the fromFile factory method when the private key is stored in a file.

Method Summary

Modifier and Type	Method and Description
void	authenticate(SshAuthenticator authenticator)
static PublicKeySshCredential	fromFile(String username, Path privateKeyFile)
Optional<Path>	getKeyPath() Returns the path of the private key used by this credential if it is available.
byte[]	getPrivateKey()
static PublicKeySshCredential	of(String username, byte[] privateKey)
static PublicKeySshCredential	of(String username, String privateKey)

Methods inherited from class com.palantir.giraffe.ssh.SshCredential

getUsername

Methods inherited from class com.palantir.giraffe.host.Credential

getAuthenticatorType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static PublicKeySshCredential of(String username,
                                        String privateKey)

of

public static PublicKeySshCredential of(String username,
                                        byte[] privateKey)

fromFile

public static PublicKeySshCredential fromFile(String username,
                                              Path privateKeyFile)
                                       throws IOException

Throws:

IOException

authenticate

public void authenticate(SshAuthenticator authenticator)
                  throws IOException

Specified by:

authenticate in class com.palantir.giraffe.host.Credential<SshAuthenticator>

Throws:

IOException

getPrivateKey

public byte[] getPrivateKey()

getKeyPath

public Optional<Path> getKeyPath()

Returns the path of the private key used by this credential if it is available. For example, a path may be unavailable if this credential was constructed using an in-memory key.