Netscape NETSCAPE MANAGEMENT SYSTEM 6.01 -... User manual

Customization Guide
Netscape Certificate Management System
Version6.01
May 2002

Netscape Communications Corporation ("Netscape") and its licensors retain all ownership rights to the software programs offered by
Netscape (referred to herein as "Software") and related documentation. Use of the Software and related documentation is governed by the
license agreement for the Software and applicable copyright law.
Your right to copy this documentation is limited by copyright law. Making unauthorized copies, adaptations or compilation works is
prohibited and constitutes a punishable violation of the law. Netscape may revise this documentation from time to time without notice.
THIS DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL NETSCAPE BE LIABLE
FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING FROM ANY ERROR IN THIS
DOCUMENTATION, INCLUDING WITHOUT LIMITATION ANY LOSS OR INTERRUPTION OF BUSINESS, PROFITS, USE, OR DATA.
The Software and documentation are copyright © 2001 Sun Microsystems, Inc. Portions copyright 1999, 2002 Netscape Communications
Corporation. All rights reserved.
Netscape and the Netscape N logo are registered trademarks of Netscape Communications Corporation in the United States and other
countries. Other Netscape logos, product names, and service names are also trademarks of Netscape Communications Corporation, which
may be registered in some countries. Other product and brand names are the exclusive property of their respective owners.
The downloading, exporting, or reexporting of Netscape software or any underlying information or technology must be in full compliance
with all United States and other applicable laws and regulations. Any provision of Netscape software or documentation to the U.S.
government is with restricted rights as described in the license agreement for that Software.

3
Contents
AboutThisGuide.............................................................. 11
What’sinThisGuide....................................................................11
WhatYouShouldAlreadyKnow .........................................................11
ConventionsUsedinThisGuide .........................................................12
WheretoGoforRelatedInformation......................................................14
Chapter 1 BeforeYouBegin ................................................... 17
WhatYouNeedtoKnowtoChangeForms ................................................17
HTTP,QueryURLs,andHTMLForms .................................................18
JavaScript...........................................................................18
HowtheFormsWork ...................................................................18
RequestsSenttotheCMSserver .......................................................19
ResponsesandOutputTemplates ......................................................19
ErrorsandtheErrorTemplate .........................................................21
JavaScriptUsedByAllInterfaces .........................................................22
HowtoRegisterServlets ................................................................26
Part 1 CustomizingEnd-EntityServicesInterface................................ 27
Chapter 2 IntroductiontoEnd-EntityServicesInterface ............................ 29
End-EntityServicesInterface.............................................................29
HowClientTypeDeterminestheEnd-EntityInterface ....................................31
CertificateRequestFormatsSpecifictoEndEntities ......................................32
AccessingtheEnd-EntityServicesInterface ................................................33
End-EntityFormsandTemplates .........................................................33

4 Netscape Certificate Management System Customization Guide • May 2002
LocatingEnd-EntityFormsandTemplates.............................................. 34
FormsforCertificateEnrollment....................................................... 34
FormsforCertificateRenewal ......................................................... 35
FormsforCertificateRevocation....................................................... 36
FormsforCertificateRetrieval......................................................... 36
FormsforKeyRecovery .............................................................. 37
OtherForms ........................................................................ 37
OutputTemplatesforEnd-EntityInterfaces............................................. 38
Chapter 3 End-EntityInterfaceReference........................................ 41
OverviewofEnd-EntityInterfaces........................................................ 42
ApproveRevocationInterface ........................................................... 43
Description ......................................................................... 43
DefaultForms....................................................................... 43
RequestParameters.................................................................. 43
Response ........................................................................... 45
CertificateEnrollmentProtocolInterface .................................................. 47
Description ......................................................................... 47
DefaultForms....................................................................... 47
RequestParameters.................................................................. 47
ChallengeRevocationInterface .......................................................... 48
Description ......................................................................... 48
DefaultForms....................................................................... 48
RequestParameters.................................................................. 48
Response ........................................................................... 50
DisplayCertificateBySerialNumberInterface ............................................. 50
Description ......................................................................... 50
DefaultForms....................................................................... 50
RequestParameters.................................................................. 50
Response ........................................................................... 51
DisplayCertificateFromRequestInterface ................................................ 52
Description ......................................................................... 52
DefaultForms....................................................................... 52
RequestParameters.................................................................. 53
Response ........................................................................... 53
EnrollmentInterface.................................................................... 55
Description ......................................................................... 55
DefaultForms....................................................................... 56
RequestParameters.................................................................. 57
Response ........................................................................... 61
GetCAChainInterface ................................................................. 65
Description ......................................................................... 65
DefaultForms....................................................................... 66

5
RequestParameters ..................................................................66
Response ...........................................................................67
GetCertificateBySerialNumberInterface .................................................67
Description .........................................................................67
DefaultForms .......................................................................68
RequestParameters ..................................................................68
Response ...........................................................................69
GetCertificateFromRequestInterface ....................................................71
Description .........................................................................71
DefaultForms .......................................................................72
RequestParameters ..................................................................72
Response ...........................................................................73
GetCRLInterface ......................................................................75
Description .........................................................................75
DefaultForms .......................................................................76
RequestParameters ..................................................................76
Response ...........................................................................77
ListCertificatesInterface ................................................................78
Description .........................................................................78
DefaultForms .......................................................................79
RequestParameters ..................................................................79
Response ...........................................................................84
OnlineCertificateStatusProtocolInterface.................................................87
Description .........................................................................87
DefaultForms .......................................................................87
RequestParameters ..................................................................87
Response ...........................................................................87
RenewalInterface ......................................................................88
Description .........................................................................88
DefaultForms .......................................................................88
RequestParameters ..................................................................88
Response ...........................................................................89
RevocationInterface ....................................................................89
Description .........................................................................89
DefaultForms .......................................................................90
RequestParameters ..................................................................90
Response ...........................................................................92
Chapter 4 InternationalizationofEnd-EntityInterface.............................. 95
DisplayingFormsinNon-EnglishLanguages ..............................................95

6 Netscape Certificate Management System Customization Guide • May 2002
Part 2 CustomizingAgentServicesInterface ....................................99
Chapter 5 IntroductiontoAgentServicesInterface............................... 101
AgentServicesInterface................................................................ 101
CertificateManagerAgentServices ................................................... 102
RegistrationManagerAgentServices ................................................. 103
DataRecoveryManagerAgentServices ............................................... 104
OnlineCertificateStatusManagerAgentServices....................................... 104
AccessingtheAgentServicesInterface ................................................... 105
AgentFormsandTemplates ............................................................ 106
StructureoftheAgentServicesInterface............................................... 106
LocatingAgentFormsandTemplates ................................................. 107
Chapter 6 AgentInterfaceReference........................................... 109
OverviewofAgentInterfaces ........................................................... 110
AddCAInterface ..................................................................... 112
Description ........................................................................ 112
DefaultForms...................................................................... 112
RequestParameters................................................................. 113
Response .......................................................................... 113
AddCRLInterface .................................................................... 113
Description ........................................................................ 113
DefaultForms...................................................................... 114
RequestParameters................................................................. 114
Response .......................................................................... 114
ApproveRevocationInterface .......................................................... 115
Description ........................................................................ 115
DefaultForms...................................................................... 115
RequestParameters................................................................. 115
Response .......................................................................... 117
BulkEnrollmentInterface .............................................................. 119
Description ........................................................................ 119
ConfigurationParameters ........................................................... 119
DefaultForms...................................................................... 121
RequestParameters................................................................. 121
Response .......................................................................... 126
CheckCertificateInterface.............................................................. 129
Description ........................................................................ 129
DefaultForms...................................................................... 130
RequestParameters................................................................. 130
Response .......................................................................... 130
DisplayKeyBySerialNumberInterface.................................................. 131

7
Description ........................................................................131
DefaultForms ......................................................................131
RequestParameters .................................................................131
Response ..........................................................................132
DisplayKeyForRecoveryInterface ......................................................133
Description ........................................................................133
DefaultForms ......................................................................134
RequestParameters .................................................................134
Response ..........................................................................134
ExamineRecoveryInterface.............................................................136
Description ........................................................................136
DefaultForms ......................................................................136
RequestParameters .................................................................136
Response ..........................................................................137
GetApprovalStatusInterface ...........................................................138
Description ........................................................................138
DefaultForms ......................................................................138
RequestParameters .................................................................139
Response ..........................................................................139
GetPKCS#12DataInterface ............................................................140
Description ........................................................................140
DefaultForms ......................................................................141
RequestParameters .................................................................141
Response ..........................................................................141
GrantRecoveryInterface ...............................................................142
Description ........................................................................142
DefaultForms ......................................................................142
RequestParameters .................................................................142
Response ..........................................................................143
KeyQueryInterface ...................................................................144
Description ........................................................................144
DefaultForms ......................................................................144
RequestParameters .................................................................144
Response ..........................................................................147
KeyRecoveryQueryInterface...........................................................149
Description ........................................................................149
DefaultForms ......................................................................150
RequestParameters .................................................................150
Response ..........................................................................152
ListCAInterface ......................................................................154
Description ........................................................................154
DefaultForms ......................................................................154
RequestParameters .................................................................154

8 Netscape Certificate Management System Customization Guide • May 2002
Response .......................................................................... 154
ProcessCertificateRequestInterface ..................................................... 155
Description ........................................................................ 155
DefaultForms...................................................................... 155
RequestParameters................................................................. 156
Response .......................................................................... 159
ProcessDRMRequestInterface ......................................................... 163
Description ........................................................................ 163
DefaultForms...................................................................... 164
RequestParameters................................................................. 164
Response .......................................................................... 165
ProcessRequestInterface............................................................... 167
Description ........................................................................ 167
DefaultForms...................................................................... 167
RequestParameters................................................................. 168
Response .......................................................................... 168
RecoverKeyBySerialNumberInterface ................................................. 169
Description ........................................................................ 169
DefaultForms...................................................................... 170
RequestParameters................................................................. 170
Response .......................................................................... 171
RemoveCertificateHoldInterface....................................................... 172
Description ........................................................................ 172
DefaultForms...................................................................... 173
RequestParameters................................................................. 173
Response .......................................................................... 174
RequestsQueryInterface............................................................... 175
Description ........................................................................ 175
DefaultForms...................................................................... 175
RequestParameters................................................................. 176
Response .......................................................................... 177
SelectforRevocationInterface .......................................................... 180
Description ........................................................................ 180
DefaultForms...................................................................... 180
RequestParameters................................................................. 181
Response .......................................................................... 181
UpdateCRLInterface.................................................................. 183
Description ........................................................................ 183
DefaultForms...................................................................... 183
RequestParameters................................................................. 183
Response .......................................................................... 184
UpdateDirectoryInterface ............................................................. 184
Description ........................................................................ 184

9
DefaultForms ......................................................................185
RequestParameters .................................................................185
Response ..........................................................................187
Index ....................................................................... 189

10 Netscape Certificate Management System Customization Guide • May 2002