com.jcraft.jsch

Interface IdentityRepository

All Known Implementing Classes:

IdentityRepository.Wrapper

public interface IdentityRepository

A repository for identities (basically key pairs usable for authentication to a server). The default implementation included in the library contains just a list of keys in memory, but other implementations can be provided by the application, using e.g. a hardware storage or external apps like ssh-agent.

Since:

0.1.46

See Also:

JSch.setIdentityRepository(IdentityRepository), JSch.getIdentityRepository(), Session.setIdentityRepository(IdentityRepository), Session.getIdentityRepository()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IdentityRepository.Wrapper JSch will accept ciphered keys, but some implementations of IdentityRepository can not.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOTRUNNING
static int	RUNNING
static int	UNAVAILABLE

Method Summary

Modifier and Type	Method and Description
boolean	add(byte[] identity) Adds a new identity to this repository, in the form of the raw (unencrypted) private key bytes.
Vector	getIdentities() Returns all the identies of this repository, in the form of a vector of Identity objects.
String	getName() The name of the repository instance.
int	getStatus() The status of the repository instance.
boolean	remove(byte[] blob) Removes an identy from the repository, given the public key.
void	removeAll() Removes all identities from this repository.

Field Detail

UNAVAILABLE

static final int UNAVAILABLE

See Also:

Constant Field Values

NOTRUNNING

static final int NOTRUNNING

See Also:

Constant Field Values

RUNNING

static final int RUNNING

See Also:

Constant Field Values

Method Detail

getName

String getName()

The name of the repository instance. This seems to be used nowhere within the library, but could be used by an application for showing it in the UI.

getStatus

int getStatus()

The status of the repository instance. This seems to be used nowhere within the library, but could be used by an application for showing it in the UI.

Returns:

One of UNAVAILABLE, NOTRUNNING and RUNNING.

getIdentities

Vector getIdentities()

Returns all the identies of this repository, in the form of a vector of Identity objects. This will be used by the library when implementing public key authentication.

add

boolean add(byte[] identity)

Adds a new identity to this repository, in the form of the raw (unencrypted) private key bytes.

Parameters:

identity - the key, encoded as a byte[].

Returns:

true if the identity was added successfully, false otherwise.

remove

boolean remove(byte[] blob)

Removes an identy from the repository, given the public key.

Parameters:

blob - the identity's public key, encoded as a byte[].

Returns:

true if there was an identy with the given key to be removed, false otherwise.

removeAll

void removeAll()

Removes all identities from this repository.