gnu.crypto.keyring

Interface IPrivateKeyring

public interface IPrivateKeyring extends IKeyring

An interface to private, or "personal", keyrings, which contain private credentials. The contract is that each such entry is known by a unique alias.

What about public keys? and certificate-path?

Version: $Revision: 1.4 $

Method Summary
booleancontainsCertPath(String alias)

Checks if this keyring contains a certificate path with the given alias.

booleancontainsPrivateKey(String alias)

Tests if this keyring contains a private key entry with the given alias.

booleancontainsPublicKey(String alias)

Checks if this keyring contains a public key with the given alias.

Certificate[]getCertPath(String alias)

Returns the certificate path with the given alias, or null if there is no such entry.

KeygetPrivateKey(String alias, char[] password)

Returns the private key with the given alias.

PublicKeygetPublicKey(String alias)

Returns the public key with the given alias, or null if there is no such entry.

voidputCertPath(String alias, Certificate[] path)

Sets a certificate path entry.

voidputPrivateKey(String alias, Key key, char[] password)

Adds a private key to this keyring.

voidputPublicKey(String alias, PublicKey key)

Sets a public key entry.

Method Detail

containsCertPath

public boolean containsCertPath(String alias)

Checks if this keyring contains a certificate path with the given alias.

Parameters: alias The alias to check.

Returns: true if this keyring contains a certificate path with the given alias; false otherwise.

containsPrivateKey

public boolean containsPrivateKey(String alias)

Tests if this keyring contains a private key entry with the given alias.

Parameters: alias The alias to check.

Returns: true if this keyring contains a private key with the given alias; false otherwise.

containsPublicKey

public boolean containsPublicKey(String alias)

Checks if this keyring contains a public key with the given alias.

Parameters: alias The alias to test.

Returns: true if this keyring contains a public key entry with the given alias; false otherwise.

getCertPath

public Certificate[] getCertPath(String alias)

Returns the certificate path with the given alias, or null if there is no such entry.

Parameters: alias The alias of the certificate path to find.

Returns: The certificate path for the designated alias; or null if none were found.

getPrivateKey

public Key getPrivateKey(String alias, char[] password)

Returns the private key with the given alias.

Parameters: alias The alias of the private key to find. password The password of the private key.

Returns: The private, or secret, key if one is found; null if none were found.

Throws: UnrecoverableKeyException If the private key could not be recovered, possibly due to a bad password.

getPublicKey

public PublicKey getPublicKey(String alias)

Returns the public key with the given alias, or null if there is no such entry.

Parameters: alias The alias of the public key to find.

Returns: The public key; or null if none were found.

putCertPath

public void putCertPath(String alias, Certificate[] path)

Sets a certificate path entry.

Parameters: alias The alias for this certificate path. path The certificate path.

putPrivateKey

public void putPrivateKey(String alias, Key key, char[] password)

Adds a private key to this keyring.

Parameters: alias The alias of the private key. key The private key. password The password used to protect this private key.

putPublicKey

public void putPublicKey(String alias, PublicKey key)

Sets a public key entry.

Parameters: alias The alias for this public key. key The public key.

Copyright © 2001, 2002, 2003 Free Software Foundation, Inc. All Rights Reserved.