Module org.eclipse.jgit.ssh.apache

Package org.eclipse.jgit.internal.transport.sshd.pkcs11

Class Pkcs11Provider

java.lang.Object

org.eclipse.jgit.internal.transport.sshd.pkcs11.Pkcs11Provider

public class Pkcs11Provider
extends Object

Bridge for using a PKCS11 HSM (Hardware Security Module) for public-key authentication.

Method Summary

Modifier and Type	Method	Description
Iterable<org.apache.sshd.client.auth.pubkey.KeyAgentIdentity>	getKeys(org.apache.sshd.common.session.SessionContext session)	Obtains the identities provided by the PKCS11 library.
String	getName()	Retrieves an identifying name of this Pkcs11Provider.
static Pkcs11Provider	getProvider(Path library, int slotListIndex)	Creates a new Pkcs11Provider.

Methods inherited from class java.lang.Object

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

Method Details

getProvider

public static Pkcs11Provider getProvider(@NonNull
 Path library,
 int slotListIndex)
                                  throws IOException

Creates a new Pkcs11Provider.

Parameters:

library - Path to the library the SunPKCS11 provider shall use

slotListIndex - index identifying the token; if < 0, ignored and 0 is used

Returns:

a new Pkcs11Provider, or null if SunPKCS11 is not available

Throws:

IOException - if the configuration file cannot be created

ProviderException - if the Java Provider encounters a problem

UnsupportedOperationException - if PKCS#11 is unsupported

getName

public String getName()

Retrieves an identifying name of this Pkcs11Provider.

Returns:

the name

getKeys

public Iterable<org.apache.sshd.client.auth.pubkey.KeyAgentIdentity> getKeys(org.apache.sshd.common.session.SessionContext session)
                                                                      throws IOException,
GeneralSecurityException

Obtains the identities provided by the PKCS11 library.

Parameters:

session - in which we to load the identities

Returns:

all the available identities

Throws:

IOException - if keys cannot be accessed

GeneralSecurityException - if keys cannot be accessed