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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
// --- 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 statement //
///////////////////////
package com.netscape.cms.selftests.tks;
///////////////////////
// import statements //
///////////////////////
import com.netscape.certsrv.apps.*;
import com.netscape.certsrv.base.*;
import com.netscape.certsrv.tks.*;
import com.netscape.certsrv.logging.*;
import com.netscape.certsrv.selftests.*;
import com.netscape.cms.selftests.*;
import java.util.*;
import com.netscape.symkey.*;
//////////////////////
// class definition //
//////////////////////
/**
* This class implements a self test to check for TKS known session key.
* <P>
*
* @author mharmsen
* @author thomask
* @author awnuk
* @version $Revision: 14561 $, $Date: 2007-05-01 10:28:56 -0700 (Tue, 01 May 2007) $
*/
public class TKSKnownSessionKey
extends ASelfTest
{
// parameter information
public static final String PROP_TKS_SUB_ID = "TksSubId";
private String mTksSubId = null;
private String mToken = null;
private String mUseSoftToken = null;
private String mKeyName = null;
private byte[] mKeyInfo = null;
private byte[] mCardChallenge = null;
private byte[] mHostChallenge = null;
private byte[] mCUID = null;
private byte[] mMacKey = null;
private byte[] mSessionKey = null;
/**
* Initializes this subsystem with the configuration store
* associated with this instance name.
* <P>
*
* @param subsystem the associated subsystem
* @param instanceName the name of this self test instance
* @param parameters configuration store (self test parameters)
* @exception EDuplicateSelfTestException subsystem has duplicate name/value
* @exception EInvalidSelfTestException subsystem has invalid name/value
* @exception EMissingSelfTestException subsystem has missing name/value
*/
public void initSelfTest (ISelfTestSubsystem subsystem,
String instanceName,
IConfigStore parameters)
throws EDuplicateSelfTestException,
EInvalidSelfTestException,
EMissingSelfTestException
{
ISubsystem tks = null;
IConfigStore tksConfig = null;
String logMessage = null;
super.initSelfTest( subsystem, instanceName, parameters );
mTksSubId = getConfigString(PROP_TKS_SUB_ID);
mToken = getConfigString("token");
mKeyName = getConfigString("keyName");
mCardChallenge = getConfigByteArray("cardChallenge", 8);
mHostChallenge = getConfigByteArray("hostChallenge", 8);
mKeyInfo = getConfigByteArray("keyName", 2);
mCUID = getConfigByteArray("CUID", 10);
mMacKey = getConfigByteArray("macKey", 16);
mUseSoftToken = getConfigString("useSoftToken");
String defKeySetMacKey = null;
tks = (ISubsystem) CMS.getSubsystem(mTksSubId);
if (tks != null) {
tksConfig = tks.getConfigStore();
if (tksConfig != null) {
try {
defKeySetMacKey = tksConfig.getString("defKeySet.mac_key");
byte defMacKey[] = com.netscape.cmsutil.util.Utils.SpecialDecode(defKeySetMacKey);
if (!Arrays.equals(mMacKey, defMacKey)) {
defKeySetMacKey = null;
}
} catch (EBaseException e) {
defKeySetMacKey = null;
}
}
}
if (defKeySetMacKey == null) {
CMS.debug("TKSKnownSessionKey: invalid mac key");
CMS.debug("TKSKnownSessionKey self test FAILED");
mSelfTestSubsystem.log (mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage("SELFTESTS_INVALID_VALUES",
getSelfTestName(), mPrefix + "." + "macKey"));
throw new EInvalidSelfTestException (mPrefix, "macKey", null);
}
try {
mSessionKey = getConfigByteArray("sessionKey", 16);
} catch (EMissingSelfTestException e) {
if (mSessionKey == null) {
mSessionKey = SessionKey.ComputeSessionKey (mToken, mKeyName,
mCardChallenge, mHostChallenge,
mKeyInfo, mCUID, mMacKey, mUseSoftToken);
if (mSessionKey == null || mSessionKey.length != 16) {
mSelfTestSubsystem.log (mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage("SELFTESTS_MISSING_VALUES",
getSelfTestName(), mPrefix + ".sessionKey"));
throw new EMissingSelfTestException ("sessionKey");
}
String sessionKey = SpecialEncode(mSessionKey);
mConfig.putString("sessionKey", sessionKey);
try {
CMS.getConfigStore().commit(true);
} catch (EBaseException be) {
mSelfTestSubsystem.log (mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage("SELFTESTS_MISSING_VALUES",
getSelfTestName(), mPrefix + ".sessionKey"));
throw new EMissingSelfTestException ("sessionKey");
}
}
}
return;
}
private String SpecialEncode (byte data[])
{
StringBuffer sb = new StringBuffer();
for (int i = 0; i < data.length; i++) {
sb.append("#");
if ((data[i] & 0xff) < 16) {
sb.append("0");
}
sb.append(Integer.toHexString((data[i] & 0xff)));
}
return sb.toString();
}
private String getConfigString (String name) throws EMissingSelfTestException
{
String value = null;
try {
value = mConfig.getString(name);
if (value != null) {
value = value.trim();
} else {
mSelfTestSubsystem.log (mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage("SELFTESTS_MISSING_VALUES",
getSelfTestName(), mPrefix + "." + name));
throw new EMissingSelfTestException (name);
}
} catch (EBaseException e) {
mSelfTestSubsystem.log (mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage("SELFTESTS_MISSING_NAME",
getSelfTestName(), mPrefix + "." + name));
throw new EMissingSelfTestException (mPrefix, name, null);
}
return value;
}
private byte[] getConfigByteArray (String name, int size) throws EMissingSelfTestException,
EInvalidSelfTestException
{
String stringValue = getConfigString(name);
byte byteValue[] = com.netscape.cmsutil.util.Utils.SpecialDecode(stringValue);
if (byteValue == null) {
mSelfTestSubsystem.log (mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage("SELFTESTS_MISSING_NAME",
getSelfTestName(), mPrefix + "." + name));
throw new EMissingSelfTestException (name);
}
if (byteValue.length != size) {
mSelfTestSubsystem.log (mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage("SELFTESTS_INVALID_VALUES",
getSelfTestName(), mPrefix + "." + name));
throw new EInvalidSelfTestException (mPrefix, name, stringValue);
}
return byteValue;
}
/**
* Notifies this subsystem if it is in execution mode.
* <P>
*
* @exception ESelfTestException failed to start
*/
public void startupSelfTest()
throws ESelfTestException
{
return;
}
/**
* Stops this subsystem. The subsystem may call shutdownSelfTest
* anytime after initialization.
* <P>
*/
public void shutdownSelfTest()
{
return;
}
/**
* Returns the name associated with this self test. This method may
* return null if the self test has not been intialized.
* <P>
*
* @return instanceName of this self test
*/
public String getSelfTestName()
{
return super.getSelfTestName();
}
/**
* Returns the root configuration storage (self test parameters)
* associated with this subsystem.
* <P>
*
* @return configuration store (self test parameters) of this subsystem
*/
public IConfigStore getSelfTestConfigStore()
{
return super.getSelfTestConfigStore();
}
/**
* Retrieves description associated with an individual self test.
* This method may return null.
* <P>
*
* @param locale locale of the client that requests the description
* @return description of self test
*/
public String getSelfTestDescription( Locale locale )
{
return CMS.getUserMessage (locale, "CMS_SELFTESTS_TKS_PRESENCE_DESCRIPTION");
}
/**
* Execute an individual self test.
* <P>
*
* @param logger specifies logging subsystem
* @exception ESelfTestException self test exception
*/
public void runSelfTest (ILogEventListener logger)
throws ESelfTestException
{
String logMessage = null;
byte[] sessionKey = SessionKey.ComputeSessionKey (mToken, mKeyName,
mCardChallenge, mHostChallenge,
mKeyInfo, mCUID, mMacKey, mUseSoftToken);
if (sessionKey == null) {
CMS.debug("TKSKnownSessionKey: generated no session key");
CMS.debug("TKSKnownSessionKey self test FAILED");
logMessage = CMS.getLogMessage ("SELFTESTS_TKS_FAILED", getSelfTestName(), getSelfTestName());
mSelfTestSubsystem.log (logger, logMessage);
throw new ESelfTestException( logMessage );
} else if (!Arrays.equals(mSessionKey, sessionKey)) {
CMS.debug("TKSKnownSessionKey: generated invalid session key");
CMS.debug("TKSKnownSessionKey self test FAILED");
logMessage = CMS.getLogMessage ("SELFTESTS_TKS_FAILED", getSelfTestName(), getSelfTestName());
mSelfTestSubsystem.log (logger, logMessage);
throw new ESelfTestException( logMessage );
} else {
logMessage = CMS.getLogMessage ("SELFTESTS_TKS_SUCCEEDED", getSelfTestName(), getSelfTestName());
mSelfTestSubsystem.log (logger, logMessage);
CMS.debug("TKSKnownSessionKey self test SUCCEEDED");
}
return;
}
}
|