summaryrefslogtreecommitdiffstats
path: root/base/common/src/com/netscape/cms/servlet/profile/ProfileReviewServlet.java
blob: 2b3ef83bb1ceb27a5ac92c558033fc33afa4dc7b (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
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
// --- 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.cms.servlet.profile;

import java.util.Enumeration;
import java.util.Locale;
import java.util.Map;
import java.util.Random;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.netscape.certsrv.apps.CMS;
import com.netscape.certsrv.authentication.IAuthToken;
import com.netscape.certsrv.authorization.AuthzToken;
import com.netscape.certsrv.authorization.EAuthzAccessDenied;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.ca.ICertificateAuthority;
import com.netscape.certsrv.logging.ILogger;
import com.netscape.certsrv.profile.EProfileException;
import com.netscape.certsrv.profile.IPolicyConstraint;
import com.netscape.certsrv.profile.IPolicyDefault;
import com.netscape.certsrv.profile.IProfile;
import com.netscape.certsrv.profile.IProfileInput;
import com.netscape.certsrv.profile.IProfileOutput;
import com.netscape.certsrv.profile.IProfilePolicy;
import com.netscape.certsrv.profile.IProfileSubsystem;
import com.netscape.certsrv.property.EPropertyException;
import com.netscape.certsrv.property.IDescriptor;
import com.netscape.certsrv.request.IRequest;
import com.netscape.certsrv.request.IRequestQueue;
import com.netscape.certsrv.request.RequestId;
import com.netscape.certsrv.template.ArgList;
import com.netscape.certsrv.template.ArgSet;
import com.netscape.cms.servlet.common.CMSRequest;

/**
 * This servlet allows reviewing of profile-based request.
 *
 * @version $Revision$, $Date$
 */
public class ProfileReviewServlet extends ProfileServlet {

    /**
     *
     */
    private static final long serialVersionUID = -6559751428547928511L;

    private static final String PROP_AUTHORITY_ID = "authorityId";

    private String mAuthorityId = null;
    ICertificateAuthority authority = null;
    private Random mRandom = null;

    public ProfileReviewServlet() {
    }

    /**
     * initialize the servlet. This servlet uses the template file
     * "ImportCert.template" to process the response.
     *
     * @param sc servlet configuration, read from the web.xml file
     */
    public void init(ServletConfig sc) throws ServletException {
        super.init(sc);
        mAuthorityId = sc.getInitParameter(PROP_AUTHORITY_ID);

        if (mAuthorityId != null)
            authority = (ICertificateAuthority) CMS.getSubsystem(mAuthorityId);

        if (authority != null && authority.noncesEnabled()) {
            mRandom = new Random();
        }
    }

    /**
     * Process the HTTP request.
     * <ul>
     * <li>http.param requestId the ID of the profile to review
     * </ul>
     *
     * @param cmsReq the object holding the request and response information
     */
    public void process(CMSRequest cmsReq) throws EBaseException {
        HttpServletRequest request = cmsReq.getHttpReq();
        HttpServletResponse response = cmsReq.getHttpResp();

        CMS.debug("ProfileReviewServlet: start serving");

        Locale locale = getLocale(request);
        ArgSet args = new ArgSet();
        IAuthToken authToken = null;

        if (mAuthMgr != null) {
            try {
                authToken = authenticate(request);
            } catch (EBaseException e) {
                CMS.debug("ReviewReqServlet: " + e.toString());
                log(ILogger.LL_FAILURE,
                        CMS.getLogMessage("ADMIN_SRVLT_AUTH_FAILURE", e.toString()));
                args.set(ARG_ERROR_CODE, "1");
                args.set(ARG_ERROR_REASON, CMS.getUserMessage(locale,
                        "CMS_AUTHENTICATION_ERROR"));
                outputTemplate(request, response, args);
                return;
            }
        }

        AuthzToken authzToken = null;

        try {
            authzToken = authorize(mAclMethod, authToken,
                        mAuthzResourceName, "read");
        } catch (EAuthzAccessDenied e) {
            log(ILogger.LL_FAILURE,
                    CMS.getLogMessage("ADMIN_SRVLT_AUTH_FAILURE", e.toString()));
        } catch (Exception e) {
            log(ILogger.LL_FAILURE,
                    CMS.getLogMessage("ADMIN_SRVLT_AUTH_FAILURE", e.toString()));
        }

        if (authzToken == null) {
            args.set(ARG_ERROR_CODE, "1");
            args.set(ARG_ERROR_REASON, CMS.getUserMessage(locale,
                    "CMS_AUTHORIZATION_ERROR"));
            outputTemplate(request, response, args);
            return;
        }

        // (1) Read request from the database

        // (2) Get profile id from the request
        if (mProfileSubId == null || mProfileSubId.equals("")) {
            mProfileSubId = IProfileSubsystem.ID;
        }
        CMS.debug("ProfileReviewServlet: SubId=" + mProfileSubId);
        IProfileSubsystem ps = (IProfileSubsystem)
                CMS.getSubsystem(mProfileSubId);

        if (ps == null) {
            CMS.debug("ProfileReviewServlet: ProfileSubsystem not found");
            args.set(ARG_ERROR_CODE, "1");
            args.set(ARG_ERROR_REASON, CMS.getUserMessage(locale,
                    "CMS_INTERNAL_ERROR"));
            outputTemplate(request, response, args);
            return;
        }

        // retrieve request

        if (authority == null) {
            CMS.debug("ProfileReviewServlet: Authority " + mAuthorityId +
                    " not found");
            args.set(ARG_ERROR_CODE, "1");
            args.set(ARG_ERROR_REASON, CMS.getUserMessage(locale,
                    "CMS_INTERNAL_ERROR"));
            outputTemplate(request, response, args);
            return;
        }
        IRequestQueue queue = authority.getRequestQueue();

        if (queue == null) {
            CMS.debug("ProfileReviewServlet: Request Queue of " +
                    mAuthorityId + " not found");
            args.set(ARG_ERROR_CODE, "1");
            args.set(ARG_ERROR_REASON, CMS.getUserMessage(locale,
                    "CMS_INTERNAL_ERROR"));
            outputTemplate(request, response, args);
            return;
        }

        String requestId = request.getParameter("requestId");
        IRequest req = null;

        CMS.debug("ProfileReviewServlet: requestId=" + requestId);
        try {
            req = queue.findRequest(new RequestId(requestId));
        } catch (EBaseException e) {
            // request not found
            CMS.debug("ProfileReviewServlet: request not found requestId=" +
                    requestId + " " + e.toString());
        }
        if (req == null) {
            args.set(ARG_ERROR_CODE, "1");
            args.set(ARG_ERROR_REASON, CMS.getUserMessage(locale,
                    "CMS_REQUEST_NOT_FOUND", requestId));
            outputTemplate(request, response, args);
            return;
        }

        String profileId = req.getExtDataInString("profileId");

        CMS.debug("ProfileReviewServlet: requestId=" +
                requestId + " profileId=" + profileId);
        IProfile profile = null;

        try {
            profile = ps.getProfile(profileId);
        } catch (EProfileException e) {
            // profile not found
            CMS.debug("ProfileReviewServlet: profile not found requestId=" +
                    requestId + " profileId=" + profileId + " " + e.toString());
        }
        if (profile == null) {
            args.set(ARG_ERROR_CODE, "1");
            args.set(ARG_ERROR_REASON, CMS.getUserMessage(locale,
                    "CMS_PROFILE_NOT_FOUND", profileId));
            outputTemplate(request, response, args);
            return;
        }

        String profileSetId = req.getExtDataInString("profileSetId");

        CMS.debug("ProfileReviewServlet: profileSetId=" + profileSetId);
        Enumeration<String> policyIds = (profileSetId != null && profileSetId.length() > 0) ?
                                 profile.getProfilePolicyIds(profileSetId) : null;
        ArgList list = new ArgList();

        if (policyIds != null) {
            while (policyIds.hasMoreElements()) {
                String id = policyIds.nextElement();
                IProfilePolicy policy =
                        profile.getProfilePolicy(req.getExtDataInString("profileSetId"),
                                id);

                // (3) query all the profile policies
                // (4) default plugins convert request parameters into string
                //     http parameters
                handlePolicy(list, response, locale,
                        id, policy, req);
            }
        }

        if (authority != null && authority.noncesEnabled()) {
            long n = mRandom.nextLong();
            Map<Object, Long> nonces = authority.getNonces(request, "cert-request");
            nonces.put(req.getRequestId().toBigInteger(), n);
            args.set(ARG_REQUEST_NONCE, Long.toString(n));
        }

        args.set(ARG_REQUEST_ID, req.getRequestId().toString());
        args.set(ARG_REQUEST_TYPE, req.getRequestType());
        args.set(ARG_REQUEST_STATUS, req.getRequestStatus().toString());
        if (req.getRequestOwner() == null) {
            args.set(ARG_REQUEST_OWNER, "");
        } else {
            args.set(ARG_REQUEST_OWNER, req.getRequestOwner());
        }
        args.set(ARG_REQUEST_CREATION_TIME, req.getCreationTime().toString());
        args.set(ARG_REQUEST_MODIFICATION_TIME,
                req.getModificationTime().toString());

        args.set(ARG_PROFILE_ID, profileId);
        args.set(ARG_PROFILE_APPROVED_BY,
                req.getExtDataInString("profileApprovedBy"));
        args.set(ARG_PROFILE_SET_ID, req.getExtDataInString("profileSetId"));
        if (profile.isVisible()) {
            args.set(ARG_PROFILE_IS_VISIBLE, "true");
        } else {
            args.set(ARG_PROFILE_IS_VISIBLE, "false");
        }
        args.set(ARG_PROFILE_NAME, profile.getName(locale));
        args.set(ARG_PROFILE_DESC, profile.getDescription(locale));
        args.set(ARG_PROFILE_REMOTE_HOST,
                req.getExtDataInString("profileRemoteHost"));
        args.set(ARG_PROFILE_REMOTE_ADDR,
                req.getExtDataInString("profileRemoteAddr"));
        if (req.getExtDataInString("requestNotes") == null) {
            args.set(ARG_REQUEST_NOTES, "");
        } else {
            args.set(ARG_REQUEST_NOTES,
                    req.getExtDataInString("requestNotes"));
        }

        args.set(ARG_RECORD, list);
        args.set(ARG_ERROR_CODE, "0");
        args.set(ARG_ERROR_REASON, "");

        ArgList inputlist = new ArgList();

        // populate authentication parameters

        // populate input parameters
        Enumeration<String> inputIds = profile.getProfileInputIds();

        if (inputIds != null) {
            while (inputIds.hasMoreElements()) {
                String inputId = inputIds.nextElement();
                IProfileInput profileInput = profile.getProfileInput(inputId);

                Enumeration<String> inputNames = profileInput.getValueNames();

                if (inputNames != null) {
                    while (inputNames.hasMoreElements()) {
                        ArgSet inputset = new ArgSet();
                        String inputName = inputNames.nextElement();

                        IDescriptor inputDesc = profileInput.getValueDescriptor(locale, inputName);

                        if (inputDesc == null)
                            continue;
                        String inputSyntax = inputDesc.getSyntax();
                        String inputConstraint = inputDesc.getConstraint();
                        String inputValueName = inputDesc.getDescription(locale);
                        String inputValue = null;

                        try {
                            inputValue = profileInput.getValue(inputName, locale, req);
                        } catch (EBaseException e) {
                            CMS.debug("ProfileReviewServlet: " + e.toString());
                        }

                        inputset.set(ARG_INPUT_ID, inputName);
                        inputset.set(ARG_INPUT_SYNTAX, inputSyntax);
                        inputset.set(ARG_INPUT_CONSTRAINT, inputConstraint);
                        inputset.set(ARG_INPUT_NAME, inputValueName);
                        inputset.set(ARG_INPUT_VAL, inputValue);
                        inputlist.add(inputset);
                    }
                }
            }
        }
        args.set(ARG_INPUT_LIST, inputlist);

        // if request in complete state

        ArgList outputlist = new ArgList();
        Enumeration<String> outputIds = profile.getProfileOutputIds();

        if (outputIds != null) {
            while (outputIds.hasMoreElements()) {
                String outputId = outputIds.nextElement();
                IProfileOutput profileOutput = profile.getProfileOutput(outputId
                        );

                Enumeration<String> outputNames = profileOutput.getValueNames();

                if (outputNames != null) {
                    while (outputNames.hasMoreElements()) {
                        ArgSet outputset = new ArgSet();
                        String outputName = outputNames.nextElement
                                ();
                        IDescriptor outputDesc =
                                profileOutput.getValueDescriptor(locale, outputName);

                        if (outputDesc == null)
                            continue;
                        String outputSyntax = outputDesc.getSyntax();
                        String outputConstraint = outputDesc.getConstraint();
                        String outputValueName = outputDesc.getDescription(locale);
                        String outputValue = null;

                        try {
                            outputValue = profileOutput.getValue(outputName,
                                        locale, req);
                        } catch (EProfileException e) {
                            CMS.debug("ProfileSubmitServlet: " + e.toString(
                                    ));
                        }

                        outputset.set(ARG_OUTPUT_ID, outputName);
                        outputset.set(ARG_OUTPUT_SYNTAX, outputSyntax);
                        outputset.set(ARG_OUTPUT_CONSTRAINT, outputConstraint);
                        outputset.set(ARG_OUTPUT_NAME, outputValueName);
                        outputset.set(ARG_OUTPUT_VAL, outputValue);
                        outputlist.add(outputset);
                    }
                }
            }
        }
        args.set(ARG_OUTPUT_LIST, outputlist);

        // (5) return info as template
        outputTemplate(request, response, args);
    }

    private void handlePolicy(ArgList list, ServletResponse response,
            Locale locale, String id, IProfilePolicy policy,
            IRequest req) {
        ArgSet set = new ArgSet();

        set.set(ARG_POLICY_ID, id);

        // handle default policy
        IPolicyDefault def = policy.getDefault();
        String dDesc = def.getText(locale);

        set.set(ARG_DEF_DESC, dDesc);
        ArgList deflist = new ArgList();
        Enumeration<String> defNames = def.getValueNames();

        if (defNames != null) {
            while (defNames.hasMoreElements()) {
                ArgSet defset = new ArgSet();
                String defName = defNames.nextElement();
                IDescriptor defDesc = def.getValueDescriptor(locale, defName);

                if (defDesc == null)
                    continue;
                String defSyntax = defDesc.getSyntax();
                String defConstraint = defDesc.getConstraint();
                String defValueName = defDesc.getDescription(locale);
                String defValue = null;

                try {
                    defValue = def.getValue(defName, locale, req);
                } catch (EPropertyException ee) {
                    CMS.debug("ProfileReviewServlet: " + ee.toString());
                }

                defset.set(ARG_DEF_ID, defName);
                defset.set(ARG_DEF_SYNTAX, defSyntax);
                defset.set(ARG_DEF_CONSTRAINT, defConstraint);
                defset.set(ARG_DEF_NAME, defValueName);
                defset.set(ARG_DEF_VAL, defValue);
                deflist.add(defset);
            }
        }
        set.set(ARG_DEF_LIST, deflist);

        // handle constraint policy
        IPolicyConstraint con = policy.getConstraint();

        if (con != null) {
            String conDesc = con.getText(locale);

            set.set(ARG_CON_DESC, conDesc);
        }

        list.add(set);
    }
}