summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/cms/selftests/ca/CAValidity.java
blob: ec86510594ae08b1c50eeee48ce9572ede05eb7d (plain)
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
// --- 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.ca;



///////////////////////
// import statements //
///////////////////////

import com.netscape.certsrv.apps.*;
import com.netscape.certsrv.base.*;
import com.netscape.certsrv.ca.*;
import com.netscape.certsrv.logging.*;
import com.netscape.certsrv.selftests.*;
import com.netscape.cms.selftests.*;
import java.security.cert.*;
import java.util.*;
import netscape.security.x509.*;



//////////////////////
// class definition //
//////////////////////

/**
 * This class implements a self test to check the validity of the CA. 
 * <P>
 * 
 * @author mharmsen
 * @author thomask
 * @version $Revision$, $Date$
 */
public class CAValidity
extends ASelfTest
{
    ////////////////////////
    // default parameters //
    ////////////////////////



    ///////////////////////////
    // CAValidity parameters //
    ///////////////////////////

    // parameter information
    public static final String PROP_CA_SUB_ID = "CaSubId";
    private String mCaSubId                   = null;



    /////////////////////
    // default methods //
    /////////////////////



    ////////////////////////
    // CAValidity methods //
    ////////////////////////

    /**
     * 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
    {
        super.initSelfTest( subsystem, instanceName, parameters );

        // retrieve mandatory parameter(s)
        try {
            mCaSubId = mConfig.getString( PROP_CA_SUB_ID );
            if( mCaSubId != null ) {
                mCaSubId = mCaSubId.trim();
            } else {
                mSelfTestSubsystem.log( mSelfTestSubsystem.getSelfTestLogger(),
                                        CMS.getLogMessage(
                                        "SELFTESTS_MISSING_VALUES",
                                        getSelfTestName(),
                                        mPrefix
                                      + "."
                                      + PROP_CA_SUB_ID ) );

                throw new EMissingSelfTestException( PROP_CA_SUB_ID );
            }
        } catch( EBaseException e ) {
            mSelfTestSubsystem.log( mSelfTestSubsystem.getSelfTestLogger(),
                                    CMS.getLogMessage(
                                    "SELFTESTS_MISSING_NAME",
                                    getSelfTestName(),
                                    mPrefix
                                  + "."
                                  + PROP_CA_SUB_ID ) );

            throw new EMissingSelfTestException( mPrefix,
                                                 PROP_CA_SUB_ID,
                                                 null );
        }

        // retrieve optional parameter(s)

        return;
    }


    /**
     * 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_CA_VALIDITY_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;
        ICertificateAuthority ca = null;
        X509CertImpl caCert = null;

        ca = ( ICertificateAuthority ) CMS.getSubsystem( mCaSubId );

        if( ca == null ) {
            // log that the CA is not installed
            logMessage = CMS.getLogMessage( "SELFTESTS_CA_IS_NOT_PRESENT",
                                            getSelfTestName() );

            mSelfTestSubsystem.log( logger,
                                    logMessage );

            throw new ESelfTestException( logMessage );
        } else {
            // Retrieve the CA certificate
            caCert = ca.getCACert();

            if( caCert == null ) {
                // log that the CA is not yet initialized
                logMessage = CMS.getLogMessage( 
                             "SELFTESTS_CA_IS_NOT_INITIALIZED",
                             getSelfTestName() );

                mSelfTestSubsystem.log( logger,
                                        logMessage );

                throw new ESelfTestException( logMessage );
            }

            // Retrieve the CA validity period
            try {
                caCert.checkValidity();
            } catch( CertificateNotYetValidException e ) {
                // log that the CA is not yet valid
                logMessage = CMS.getLogMessage( "SELFTESTS_CA_IS_NOT_YET_VALID",
                                                getSelfTestName() );

                mSelfTestSubsystem.log( logger,
                                        logMessage );

                throw new ESelfTestException( logMessage );
            } catch( CertificateExpiredException e ) {
                // log that the CA is expired
                logMessage = CMS.getLogMessage( "SELFTESTS_CA_IS_EXPIRED",
                                                getSelfTestName() );

                mSelfTestSubsystem.log( logger,
                                        logMessage );

                throw new ESelfTestException( logMessage );
            }

            // log that the CA is valid
            logMessage = CMS.getLogMessage( "SELFTESTS_CA_IS_VALID",
                                            getSelfTestName() );

            mSelfTestSubsystem.log( logger,
                                    logMessage );
        }

        return;
    }
}