|
For the latest news and information visit The GNU Crypto project |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IKeyring
The top-level interface to a keyring: a file that is used to store and protect public and private cryptographic keys.
A keyring is modelled as a mapping of one alias to one or more entries (optionally of different types).
See also the sub-interfaces IPublicKeyring
and
IPrivateKeyring
for special types of keyrings --the difference
being in the type of entries they contain.
Field Summary | |
---|---|
static String |
KEYRING_DATA_IN
Property name for the source of data to load the keyring from. |
static String |
KEYRING_DATA_OUT
Property name for the data sink to store the keyring to. |
static String |
KEYRING_PASSWORD
Property name for the keyring's top-level password, used to authenticate and/or transform the store itself. |
Method Summary | |
---|---|
void |
add(Entry entry)
Adds a designated Entry to this keyring. |
Enumeration |
aliases()
Returns an Enumeration of all aliases (instances of
String ) in this keyring. |
boolean |
containsAlias(String alias)
Tests whether or not this keyring contains the given alias. |
List |
get(String alias)
Returns a List of entries (instances of Entry ) for the
given alias , or null if there no such entry
exists. |
void |
load(Map attributes)
Loads a keyring into memory. |
void |
remove(String alias)
Removes an entry with the designated alias from this
keyring. |
void |
reset()
Resets this keyring, clearing all sensitive data. |
int |
size()
Returns the number of entries in this keyring. |
void |
store(Map attributes)
Stores the contents of this keyring to persistent storage as specified by the designated attributes . |
Field Detail |
---|
static final String KEYRING_DATA_IN
Property name for the source of data to load the keyring from. The
value mapped must be a InputStream
.
static final String KEYRING_DATA_OUT
Property name for the data sink to store the keyring to. The value
mapped must be a OutputStream
.
static final String KEYRING_PASSWORD
Property name for the keyring's top-level password, used to authenticate and/or transform the store itself. The mapped value must be a char array.
Method Detail |
---|
void load(Map attributes) throws IOException
Loads a keyring into memory.
What happens to the current contents of this keyring? are the new ones merged with the current ones or do they simply replace them?
attributes
- The attributes that designate the source where the store
is to be loaded from. What happens
IllegalArgumentException
- If the attributes are inappropriate.
IOException
- If the keyring file cannot be read.
SecurityException
- If the given password is incorrect, or if the
top-level authentication or decryption fails.void store(Map attributes) throws IOException
Stores the contents of this keyring to persistent storage as specified
by the designated attributes
.
attributes
- the attributes that define where the contents of this
keyring will be stored.
IOException
- if an exception occurs during the process.void reset()
Resets this keyring, clearing all sensitive data. This method always suceeds.
int size()
Returns the number of entries in this keyring.
Enumeration aliases()
Returns an Enumeration
of all aliases (instances of
String
) in this keyring.
String
s each representing an
alias found in this keyring.boolean containsAlias(String alias)
alias
- The alias to check.
List get(String alias)
Returns a List
of entries (instances of Entry
) for the
given alias
, or null
if there no such entry
exists.
alias
- The alias of the entry(ies) to return.
Entry
that have the
given alias
, or null
if no one Entry
can
be found with the designated alias
.void add(Entry entry)
Adds a designated Entry
to this keyring.
What happens if there is already an entry with the same alias?
entry
- The entry to put in this keyring.void remove(String alias)
Removes an entry with the designated alias
from this
keyring. Does nothing if there was no such entry.
What happens if there are more than one?
alias
- The alias of the entry to remove.
|
For the latest news and information visit The GNU Crypto project |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |