1 files changed, 106 insertions, 0 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/security/IStorageKeyUnit.java b/pki/base/common/src/com/netscape/certsrv/security/IStorageKeyUnit.java
new file mode 100644
index 000000000..0b484bdc7
--- /dev/null
+++ b/pki/base/common/src/com/netscape/certsrv/security/IStorageKeyUnit.java
@@ -0,0 +1,106 @@
+// --- BEGIN COPYRIGHT BLOCK ---
+// This program 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; version 2 of the License.
+//
+// This program 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 this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// (C) 2007 Red Hat, Inc.
+// All rights reserved.
+// --- END COPYRIGHT BLOCK ---
+package com.netscape.certsrv.security;
+
+
+import java.util.*;
+import java.io.*;
+import java.net.*;
+import java.security.*;
+import java.security.cert.X509Certificate;
+import netscape.security.x509.*;
+import netscape.security.util.*;
+import com.netscape.certsrv.base.*;
+import org.mozilla.jss.crypto.*;
+import org.mozilla.jss.crypto.PrivateKey;
+
+
+/**
+ * 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$, $Date$
+ */
+public interface IStorageKeyUnit extends IEncryptionUnit {
+
+    /**
+     * Retrieves total number of recovery agents.
+     *
+     * @return total number of recovery agents
+     */
+    public int getNoOfAgents() throws EBaseException;
+
+    /**
+     * Retrieves number of recovery agents required to
+     * perform recovery operation.
+     * 
+     * @return required number of recovery agents for recovery operation
+     */
+    public int getNoOfRequiredAgents() throws EBaseException;
+
+    /**
+     * Sets the numer of required recovery agents
+     *
+     * @param number number of required agents
+     */
+    public void setNoOfRequiredAgents(int number);
+
+    /**
+     * Retrieves a list of agents in this unit.
+     *
+     * @return a list of string-based agent identifiers
+     */
+    public Enumeration getAgentIdentifiers();
+
+    /**
+     * Changes agent password.
+     *
+     * @param id agent id
+     * @param oldpwd old password
+     * @param newpwd new password
+     * @return true if operation successful
+     * @exception EBaseException failed to change password
+     */
+    public boolean changeAgentPassword(String id, String oldpwd, 
+        String newpwd) throws EBaseException;
+
+    /**
+     * Changes M-N recovery scheme.
+     *
+     * @param n total number of agents
+     * @param m required number of agents for recovery operation
+     * @param oldcreds all old credentials
+     * @param newcreds all new credentials
+     * @return true if operation successful
+     * @exception EBaseException failed to change schema
+     */
+    public boolean changeAgentMN(int n, int m, Credential oldcreds[],
+        Credential newcreds[]) throws EBaseException;
+	
+    /**
+     * Logins to this unit.
+     *
+     * @param ac agent's credentials
+     * @exception EBaseException failed to login
+     */
+    public void login(Credential ac[]) throws EBaseException;
+
+    public CryptoToken getToken();
+
+}