1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
// --- 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.dbs.keydb;
import java.math.BigInteger;
import java.security.PublicKey;
import java.util.Enumeration;
import netscape.security.x509.X500Name;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.dbs.ModificationSet;
import com.netscape.certsrv.dbs.repository.IRepository;
/**
* An interface represents a Key repository. This is the
* container of archived keys.
* <P>
*
* @version $Revision$, $Date$
*/
public interface IKeyRepository extends IRepository {
/**
* Archives a key to the repository.
* <P>
*
* @param record key record
* @exception EBaseException failed to archive key
*/
public void addKeyRecord(IKeyRecord record) throws EBaseException;
/**
* Reads an archived key by serial number.
* <P>
*
* @param serialNo serial number
* @return key record
* @exception EBaseException failed to recover key
*/
public IKeyRecord readKeyRecord(BigInteger serialNo)
throws EBaseException;
/**
* Reads an archived key by b64 encoded cert.
* <P>
*
* @param cert b64 encoded cert
* @return key record
* @exception EBaseException failed to recover key
*/
public IKeyRecord readKeyRecord(String cert)
throws EBaseException;
/**
* Reads an archived key by owner name.
* <P>
*
* @param ownerName owner name
* @return key record
* @exception EBaseException failed to recover key
*/
public IKeyRecord readKeyRecord(X500Name ownerName)
throws EBaseException;
/**
* Reads archived key using public key.
*
* @param publicKey public key that is corresponding
* to the private key
* @return key record
* @exception EBaseException failed to read key
*/
public IKeyRecord readKeyRecord(PublicKey publicKey)
throws EBaseException;
/**
* Searches for private keys.
*
* @param filter LDAP filter for the search
* @param maxSize maximium number of entries to be returned
* @return a list of private key records
* @exception EBaseException failed to search keys
*/
public Enumeration<IKeyRecord> searchKeys(String filter, int maxSize)
throws EBaseException;
/**
* Searches for private keys.
*
* @param filter LDAP filter for the search
* @param maxSize maximium number of entries to be returned
* @param timeLimt timeout value
* @return a list of private key records
* @exception EBaseException failed to search keys
*/
public Enumeration<IKeyRecord> searchKeys(String filter, int maxSize, int timeLimt)
throws EBaseException;
/**
* Deletes a key record.
*
* @param serialno key identifier
* @exception EBaseException failed to delete key record
*/
public void deleteKeyRecord(BigInteger serialno)
throws EBaseException;
/**
* Modifies key record in this repository.
*
* @param serialNo key identifier
* @param mods modification of key records
* @exception EBaseException failed to modify key record
*/
public void modifyKeyRecord(BigInteger serialNo,
ModificationSet mods) throws EBaseException;
/**
* Searchs for a list of key records.
* Here is a list of supported filter attributes:
*
* <pre>
* keySerialNumber
* keyState
* algorithm
* keySize
* keyOwnerName
* privateKey
* publicKey
* dateOfRecovery
* keyCreateTime
* keyModifyTime
* keyMetaInfo
* </pre>
*
* @param filter search filter
* @param attrs list of attributes to be returned
* @param pageSize virtual list page size
* @return list of key records
* @exception EBaseException failed to search key records
*/
public IKeyRecordList findKeyRecordsInList(String filter,
String attrs[], int pageSize) throws EBaseException;
/**
* Searchs for a list of key records.
*
* @param filter search filter
* @param attrs list of attributes to be returned
* @param sortKey name of attribute that the list should be sorted by
* @param pageSize virtual list page size
* @return list of key records
* @exception EBaseException failed to search key records
*/
public IKeyRecordList findKeyRecordsInList(String filter,
String attrs[], String sortKey, int pageSize)
throws EBaseException;
}
|
