com.netscape.certsrv.security
Interface IStorageKeyUnit

All Superinterfaces:
IEncryptionUnit, IToken

public interface IStorageKeyUnit
extends IEncryptionUnit

An interface represents a storage key unit. This storage unit contains a storage key pair that is used for encrypting the user private key for long term storage.

Version:
$Revision: 1295 $, $Date: 2010-09-15 09:42:56 -0700 (Wed, 15 Sep 2010) $

Method Summary
 boolean changeAgentMN(int n, int m, Credential[] oldcreds, Credential[] newcreds)
          Changes M-N recovery scheme.
 boolean changeAgentPassword(java.lang.String id, java.lang.String oldpwd, java.lang.String newpwd)
          Changes agent password.
 java.util.Enumeration getAgentIdentifiers()
          Retrieves a list of agents in this unit.
 int getNoOfAgents()
          Retrieves total number of recovery agents.
 int getNoOfRequiredAgents()
          Retrieves number of recovery agents required to perform recovery operation.
 org.mozilla.jss.crypto.CryptoToken getToken()
           
 void login(Credential[] ac)
          Logins to this unit.
 void setNoOfRequiredAgents(int number)
          Sets the numer of required recovery agents
 
Methods inherited from interface com.netscape.certsrv.security.IEncryptionUnit
decryptExternalPrivate, decryptInternalPrivate, encryptInternalPrivate, getPublicKey, unwrap, unwrap, verify, wrap
 
Methods inherited from interface com.netscape.certsrv.security.IToken
login, logout
 

Method Detail

getNoOfAgents

int getNoOfAgents()
                  throws EBaseException
Retrieves total number of recovery agents.

Returns:
total number of recovery agents
Throws:
EBaseException

getNoOfRequiredAgents

int getNoOfRequiredAgents()
                          throws EBaseException
Retrieves number of recovery agents required to perform recovery operation.

Returns:
required number of recovery agents for recovery operation
Throws:
EBaseException

setNoOfRequiredAgents

void setNoOfRequiredAgents(int number)
Sets the numer of required recovery agents

Parameters:
number - number of required agents

getAgentIdentifiers

java.util.Enumeration getAgentIdentifiers()
Retrieves a list of agents in this unit.

Returns:
a list of string-based agent identifiers

changeAgentPassword

boolean changeAgentPassword(java.lang.String id,
                            java.lang.String oldpwd,
                            java.lang.String newpwd)
                            throws EBaseException
Changes agent password.

Parameters:
id - agent id
oldpwd - old password
newpwd - new password
Returns:
true if operation successful
Throws:
EBaseException - failed to change password

changeAgentMN

boolean changeAgentMN(int n,
                      int m,
                      Credential[] oldcreds,
                      Credential[] newcreds)
                      throws EBaseException
Changes M-N recovery scheme.

Parameters:
n - total number of agents
m - required number of agents for recovery operation
oldcreds - all old credentials
newcreds - all new credentials
Returns:
true if operation successful
Throws:
EBaseException - failed to change schema

login

void login(Credential[] ac)
           throws EBaseException
Logins to this unit.

Parameters:
ac - agent's credentials
Throws:
EBaseException - failed to login

getToken

org.mozilla.jss.crypto.CryptoToken getToken()