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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
// --- 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.kra;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.commons.lang.StringUtils;
import org.mozilla.jss.crypto.CryptoToken;
import org.mozilla.jss.crypto.KeyGenAlgorithm;
import org.mozilla.jss.crypto.SymmetricKey;
import com.netscape.certsrv.apps.CMS;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.dbs.keydb.IKeyRecord;
import com.netscape.certsrv.dbs.keydb.IKeyRepository;
import com.netscape.certsrv.dbs.keydb.KeyId;
import com.netscape.certsrv.key.KeyRequestResource;
import com.netscape.certsrv.key.SymKeyGenerationRequest;
import com.netscape.certsrv.kra.IKeyRecoveryAuthority;
import com.netscape.certsrv.logging.ILogger;
import com.netscape.certsrv.logging.LogEvent;
import com.netscape.certsrv.logging.event.SymKeyGenerationProcessedEvent;
import com.netscape.certsrv.request.IRequest;
import com.netscape.certsrv.request.IService;
import com.netscape.certsrv.request.RequestId;
import com.netscape.certsrv.security.IStorageKeyUnit;
import com.netscape.cms.logging.Logger;
import com.netscape.cms.logging.SignedAuditLogger;
import com.netscape.cms.servlet.key.KeyRequestDAO;
import com.netscape.cmscore.dbs.KeyRecord;
import com.netscape.cmsutil.crypto.CryptoUtil;
import netscape.security.util.WrappingParams;
/**
* This implementation implements SecurityData archival operations.
* <p>
*
* @version $Revision$, $Date$
*/
public class SymKeyGenService implements IService {
private static Logger signedAuditLogger = SignedAuditLogger.getLogger();
public final static String ATTR_KEY_RECORD = "keyRecord";
private final static String STATUS_ACTIVE = "active";
private IKeyRecoveryAuthority mKRA = null;
private IStorageKeyUnit mStorageUnit = null;
public SymKeyGenService(IKeyRecoveryAuthority kra) {
mKRA = kra;
mStorageUnit = kra.getStorageKeyUnit();
}
/**
* Performs the service of archiving Security Data.
* represented by this request.
* <p>
*
* @param request
* The request that needs service. The service may use
* attributes stored in the request, and may update the
* values, or store new ones.
* @return
* an indication of whether this request is still pending.
* 'false' means the request will wait for further notification.
* @exception EBaseException indicates major processing failure.
*/
public boolean serviceRequest(IRequest request)
throws EBaseException {
String id = request.getRequestId().toString();
String clientKeyId = request.getExtDataInString(IRequest.SECURITY_DATA_CLIENT_KEY_ID);
String algorithm = request.getExtDataInString(IRequest.KEY_GEN_ALGORITHM);
String realm = request.getRealm();
String usageStr = request.getExtDataInString(IRequest.KEY_GEN_USAGES);
List<String> usages = new ArrayList<String>(
Arrays.asList(StringUtils.split(usageStr, ",")));
String keySizeStr = request.getExtDataInString(IRequest.KEY_GEN_SIZE);
int keySize = Integer.parseInt(keySizeStr);
CMS.debug("SymKeyGenService.serviceRequest. Request id: " + id);
CMS.debug("SymKeyGenService.serviceRequest algorithm: " + algorithm);
String owner = request.getExtDataInString(IRequest.ATTR_REQUEST_OWNER);
String auditSubjectID = owner;
//Check here even though restful layer checks for this.
if (algorithm == null || clientKeyId == null || keySize <= 0) {
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.FAILURE, request.getRequestId(),
clientKeyId, null, "Bad data in request");
throw new EBaseException("Bad data in SymKeyGenService.serviceRequest");
}
IConfigStore configStore = CMS.getConfigStore();
boolean allowEncDecrypt_archival = configStore.getBoolean("kra.allowEncDecrypt.archival", false);
CryptoToken token = mStorageUnit.getToken();
KeyGenAlgorithm kgAlg = KeyRequestDAO.SYMKEY_GEN_ALGORITHMS.get(algorithm);
if (kgAlg == null) {
throw new EBaseException("Invalid algorithm");
}
SymmetricKey.Usage keyUsages[];
if (usages.size() > 0) {
keyUsages = new SymmetricKey.Usage[usages.size()];
int index = 0;
for (String usage : usages) {
switch (usage) {
case SymKeyGenerationRequest.DECRYPT_USAGE:
keyUsages[index] = SymmetricKey.Usage.DECRYPT;
break;
case SymKeyGenerationRequest.ENCRYPT_USAGE:
keyUsages[index] = SymmetricKey.Usage.ENCRYPT;
break;
case SymKeyGenerationRequest.WRAP_USAGE:
keyUsages[index] = SymmetricKey.Usage.WRAP;
break;
case SymKeyGenerationRequest.UWRAP_USAGE:
keyUsages[index] = SymmetricKey.Usage.UNWRAP;
break;
case SymKeyGenerationRequest.SIGN_USAGE:
keyUsages[index] = SymmetricKey.Usage.SIGN;
break;
case SymKeyGenerationRequest.VERIFY_USAGE:
keyUsages[index] = SymmetricKey.Usage.VERIFY;
break;
default:
throw new EBaseException("Invalid usage");
}
index++;
}
} else {
keyUsages = new SymmetricKey.Usage[2];
keyUsages[0] = SymmetricKey.Usage.DECRYPT;
keyUsages[1] = SymmetricKey.Usage.ENCRYPT;
}
SymmetricKey sk = null;
try {
sk = CryptoUtil.generateKey(token, kgAlg, keySize, keyUsages, true);
CMS.debug("SymKeyGenService:wrap() session key generated on slot: " + token.getName());
} catch (Exception e) {
CMS.debugStackTrace();
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.FAILURE, request.getRequestId(),
clientKeyId, null, "Failed to generate symmetric key");
throw new EBaseException("Errors in generating symmetric key: " + e, e);
}
byte[] publicKey = null;
byte privateSecurityData[] = null;
WrappingParams params = null;
if (sk == null) {
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.FAILURE, request.getRequestId(),
clientKeyId, null, "Failed to create security data to archive");
throw new EBaseException("Failed to create security data to archive!");
}
try {
params = mStorageUnit.getWrappingParams(allowEncDecrypt_archival);
privateSecurityData = mStorageUnit.wrap(sk, params);
} catch (Exception e) {
CMS.debug("Failed to generate security data to archive: " + e);
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.FAILURE, request.getRequestId(),
clientKeyId, null, CMS.getUserMessage("CMS_KRA_INVALID_PRIVATE_KEY"));
throw new EBaseException("Failed to generate security data to archive!");
}
// create key record
KeyRecord rec = new KeyRecord(null, publicKey,
privateSecurityData, owner,
algorithm, owner);
rec.set(IKeyRecord.ATTR_CLIENT_ID, clientKeyId);
//Now we need a serial number for our new key.
if (rec.getSerialNumber() != null) {
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.FAILURE, request.getRequestId(),
clientKeyId, null, CMS.getUserMessage("CMS_KRA_INVALID_STATE"));
throw new EBaseException(CMS.getUserMessage("CMS_KRA_INVALID_STATE"));
}
IKeyRepository storage = mKRA.getKeyRepository();
BigInteger serialNo = storage.getNextSerialNumber();
if (serialNo == null) {
mKRA.log(ILogger.LL_FAILURE,
CMS.getLogMessage("CMSCORE_KRA_GET_NEXT_SERIAL"));
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.FAILURE, request.getRequestId(),
clientKeyId, null, "Failed to get next Key ID");
throw new EBaseException(CMS.getUserMessage("CMS_KRA_INVALID_STATE"));
}
rec.set(KeyRecord.ATTR_ID, serialNo);
rec.set(KeyRecord.ATTR_DATA_TYPE, KeyRequestResource.SYMMETRIC_KEY_TYPE);
rec.set(KeyRecord.ATTR_STATUS, STATUS_ACTIVE);
rec.set(KeyRecord.ATTR_KEY_SIZE, keySize);
request.setExtData(ATTR_KEY_RECORD, serialNo);
if (realm != null) {
rec.set(KeyRecord.ATTR_REALM, realm);
}
try {
rec.setWrappingParams(params, allowEncDecrypt_archival);
} catch (Exception e) {
mKRA.log(ILogger.LL_FAILURE,
"Failed to store wrapping parameters: " + e);
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.FAILURE, request.getRequestId(),
clientKeyId, null, "Failed to store wraping parameters.");
throw new EBaseException(CMS.getUserMessage("CMS_KRA_INVALID_STATE"), e);
}
CMS.debug("KRA adding Security Data key record " + serialNo);
storage.addKeyRecord(rec);
auditSymKeyGenRequestProcessed(auditSubjectID, ILogger.SUCCESS, request.getRequestId(),
clientKeyId, new KeyId(serialNo), "None");
request.setExtData(IRequest.RESULT, IRequest.RES_SUCCESS);
mKRA.getRequestQueue().updateRequest(request);
return true;
}
private void audit(String msg) {
signedAuditLogger.log(msg);
}
protected void audit(LogEvent event) {
signedAuditLogger.log(event);
}
private void auditSymKeyGenRequestProcessed(String subjectID, String status, RequestId requestID, String clientKeyID,
KeyId keyID, String reason) {
audit(new SymKeyGenerationProcessedEvent(
subjectID,
status,
requestID,
clientKeyID,
keyID,
reason));
}
}
|
