Package org.bouncycastle.openpgp.api

Interface KeyPassphraseProvider

All Known Implementing Classes:

KeyPassphraseProvider.DefaultKeyPassphraseProvider

public interface KeyPassphraseProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	KeyPassphraseProvider.DefaultKeyPassphraseProvider

Method Summary

Modifier and Type	Method	Description
char[]	getKeyPassword(OpenPGPKey.OpenPGPSecretKey key)	Return the passphrase for the given key.

Method Details

getKeyPassword

char[] getKeyPassword(OpenPGPKey.OpenPGPSecretKey key)

Return the passphrase for the given key. This callback is only fired, if the key is locked and a passphrase is required to unlock it. Returning null means, that the passphrase is not available.

Parameters:

key - the locked (sub-)key.

Returns:

passphrase or null