gnu.javax.crypto.keyring
Interface IKeyring
- IPrivateKeyring, IPublicKeyring
- BaseKeyring, GnuPrivateKeyring, GnuPublicKeyring
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.
void | add(Entry entry)- Adds a designated
Entry to this keyring.
|
Enumeration<E> | 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<E> | 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<K,V> 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<K,V> attributes)- Stores the contents of this keyring to persistent storage as specified by
the designated
attributes.
|
KEYRING_DATA_IN
public 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.
- "gnu.crypto.keyring.data.in"
KEYRING_DATA_OUT
public static final String KEYRING_DATA_OUT
Property name for the data sink to store the keyring to. The value mapped
must be a
OutputStream.
- "gun.crypto.keyring.data.out"
KEYRING_PASSWORD
public 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.
- "gnu.crypto.keyring.password"
add
public 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.
containsAlias
public boolean containsAlias(String alias)
Tests whether or not this keyring contains the given alias.
alias - The alias to check.
- true if this keyring contains the alias.
get
public List<E> 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.
- A list of all entries (instances of
Entry that have the
given alias, or null if no one
Entry can be found with the designated alias.
load
public void load(Map<K,V> 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
remove
public 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.
reset
public void reset()
Resets this keyring, clearing all sensitive data. This method always
suceeds.
size
public int size()
Returns the number of entries in this keyring.
- The number of current entries in this keyring.
store
public void store(Map<K,V> 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.
IKeyring.java --
Copyright (C) 2003, 2006 Free Software Foundation, Inc.
This file is a part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
USA
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.