Locating JSP files for customizing web pages

The JSP files are shipped in PKIServ_Web.war in PKIServ.ear and are in the following directories:
  • Customers

    JSPs used by end users. Each JSP file in this directory defines all HTML and script for an entire end-user web page. Each file starts with an <HTML> tag and ends with a </HTML> tag. JSP files in this directory can be modified, but contain lines of Java processing that cannot be modified. Lines that cannot be modified are identified with comments. Table 1 lists the JSP files in this directory.

  • PKIServ

    JSPs used by administrators. Each JSP file in this directory defines all HTML and script for an entire administrator web page. Each file starts with an <HTML> tag and ends with a </HTML> tag. JSP files in this directory can be modified, but contain lines of Java™ processing that cannot be modified. Lines that cannot be modified are identified with comments. Table 2 lists the JSP files in this directory.

  • mod_inc

    Modifiable include files. Each JSP file in this directory defines HTML and script (JavaScript) that might be used on multiple web pages, such as running headers or footers for a page, or a form field element (including JavaScript to verify the input). (If you are familiar with the text template file, pkiserv.tmpl, used with the REXX CGIs, these modifiable include files generally correspond to an INSERT section.) Installations are likely to want to customize the code in these files. Some parts of these files cannot be modified and these parts are identified by comments in the file. Table 3 lists the JSP files in this directory. Customizing the PKI Services web application shows an example of customizing a JSP file in this directory.

  • not_mod_inc

    Non-modifiable include files. Each JSP file in this directory defines HTML and script that might be used on more than one web page, and should not be modified.

  • domain_specific

    Contains selectCAdomain.jsp, which an installation would modify if it had multiple domains with a single administrator.

  • WEB-INF

    Contains supporting Java classes, including servlets, that an installation is not expected to modify, and web.xml, which an installation needs to modify to add additional applications or domains. (See Creating application domains when you use JSPs to implement the web application.)

Table 1. JSP files in the Customers directory
File name Description
pkimain.jsp Starting point for all tasks available to the end user, such as requesting a new certificate, picking up a previously requested certificate, renewing or revoking a previously issued browser certificate, or recovering a certificate whose key was generated by PKI Services
certrequest.jsp Web page to request a certificate.
certretrieve.jsp Web page to retrieve a certificate.
genericbad.jsp Displays error information when processing fails.
genericok.jsp Notifies the user of successful processing when no additional information (such as a transaction ID) needs to be returned to the user.
installcert.jsp Contains HTML and JavaScript, functions to install an automatically renewed certificate that is copied from an email notification if using the Internet Explorer browser.
keygenrequestok.jsp Notifies the user of a successful certificate request with PKI-generated keys, and includes the email address where notification has been sent.
pkcs10retrieved.jsp Returns a retrieved PKCS #10 certificate.
qrecover.jsp Implements the web page to recover a certificate.
recoverbad.jsp Displays information for an unsuccessful attempt to find certificates for which the private key is to be recovered.
recoverok.jsp Displays results of a successful attempt to find certificates for which the private key is to be recovered.
renew_revoke.jsp Displays a client-authenticated browser certificate for the user to renew, revoke, or suspend.
requestok.jsp Returns results (such as the transaction ID) of a successful certificate request.
requestbad.jsp Returns error information for an unsuccessful certificate request.
retrievebad.jsp Returns error information for an unsuccessful attempt to retrieve a certificate.
Table 2. JSP files in the PKIServ directory
File name Description
actcertok.jsp Returns results of a successful certificate action, such as deleting, revoking, suspending, or resuming a certificate.
actcertbad.jsp Returns error information for an unsuccessful certificate action, such as deleting, revoking, suspending, or resuming a certificate.
actrequestok.jsp Returns results of a successful action on a certificate request, such as approving, rejecting, or deleting.
acttrequestbad.jsp Returns error information for an unsuccessful action on a certificate request, such as approving, rejecting, or deleting.
adminmain.jsp The main PKI Services administration page, from which the administrator can search certificates or certificate requests, or enter a specific transaction ID or serial number to act upon.
admhome.jsp The PKI Services administration home page, which contains links to the end-user home page for each application and to the main PKI Services administration web page (admmain.jsp)
approvewithmods.jsp Displays the form for an administrator to approve a certificate request with modifications.
certdetailsbad.jsp Displays error information for a failed attempt to display the details of a certificate.
certdetailsok.jsp Displays details of a single certificate.
genericfailure.jsp Displays error information when the requested administration processing fails.
modifybad.jsp Displays error information when an approve with modifications action fails.
modifyok.jsp Displays results of successful approve with modification action.
querycertok.jsp Displays search results when administrator queries certificates.
queryreqok.jsp Displays search results when administrator queries certificate requests.
reqdetailsok.jsp Displays details of a single certificate request.
Table 3. JSP files in the mod.inc directory
File name Description
adminbottomnav.jsp End of page navigation appearing on administrator’s web pages
adminfooter.jsp End footer (the last element) on administrator’s web pages
altdomain.jsp Form field for altdomain
altemail.jsp Form field for altemail
altipaddr.jsp Form field for altipaddr
altother_1_2_3_4_5.jsp altother form field sample for OID 1.2.3.4.5
altother_1_2_3_4_6.jsp altother form field sample for OID 1.2.3.4.6
altother_1_3_6_1_4_1_311_20_2_3.jsp altother form field sample for OID 1.3.6.1.4.1.311.20.2.3
alturi.jsp Form field for alturl
autorenew.jsp Form field for autorenew
bottomnav.jsp End of page navigation on end user web pages
businesscat.jsp Form field for BusinessCat
certrow.jsp Displays a row in a table about certificates, format tied to PKIServ/certdetailsok.jsp
challengepassphrase.jsp Displays passphrase form field when user is prompted to match the passphrase previously entered
clientname.jsp Form field for clientname
commonfunctions.jsp Contains JavaScript functions that are commonly used, such as trim()
commonname.jsp Form field for commonname
country.jsp Form field for country
CustomExt.jsp The HTML and JavaScript for defining custom certificate extensions.
date.jsp Displays validity period form fields as two dates, the date the certificate becomes valid, and the date the certificate expires, used on approve with modification processing
dnqualifier.jsp Form field for distinguished name qualifier
domainname.jsp Form field for domain name
emailaddr.jsp Form field for emailaddr
extkeyusage.jsp Form field for extended key usage
footer.jsp Footer (last element) on end users pages
hostidmap.jsp Form field for host id mapping
jurcountry.jsp Form field for JurCountry
jurlocality.jsp Form field for JurLocality
jurstateprov.jsp Form field for JurStateProv
keysize.jsp Form field for keysize
keyusage.jsp Form field for key usage
label.jsp Form field for label
locality.jsp Form field for locality
mail.jsp Form field for mail
notafter.jsp Form field for the number of days the certificate should be valid (from the time of request)
notbefore.jsp Form field for the number of days before the certificate should be valid
notifyemail.jsp Form field for notifyemail
org.jsp Form field for org
orgunit.jsp Form field for orgunit
passphrase.jsp Form field for user to enter passphrase
postalcode.jsp Form field for postal code
publickey.jsp Public key form field, text box for entering base64-encoded PKCS #10 certificate request
publickey_smartcard.jsp The HTML and JavaScript for the public key form field, when the browser provides the public key after the user selects from a list of available cryptographic providers.
recoveremail.jsp recoveremail form field
requestor.jsp Requestor form field (with prompt for name for tracking this request)
requestor2.jsp Requestor form field (with prompt for email address of requestor)
security.jsp Displays a form field for entering a response to a security question
security2.jsp Displays a form field for entering a response to a second security question
serialnumber.jsp Form field for entering a certificate’s serial number
signwith.jsp Form field for selecting the signer of the requested certificate
stateprov.jsp Form field for stateprov
street.jsp Form field for street
title.jsp Form field for title
transactionid.jsp Form field for entering a certificate request’s transaction ID
uid.jsp Form field for uid
unstructaddr.jsp Form field for unstructaddr
unstructname.jsp Form field for unstructname
userid.jsp Form field for userid