Netscape NETSCAPE MANAGEMENT SYSTEM 4.5 - CUSTOMIZATION... User manual

Customization Guide
Netscape Certificate Management System
Version4.5
October 2001

Netscape Communications Corporation (“Netscape”), a subsidiary of America Online, Inc., 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 accompanying 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.
Software applications: © 2001 Sun Microsystems, Inc.
Some software code: © 1999, 2001 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 other 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 accompanying Netscape software.

3
Contents
AboutThisGuide............................................................... 9
What’sinThisGuide.....................................................................9
WhatYouShouldAlreadyKnow ..........................................................9
ConventionsUsedinThisGuide .........................................................10
WheretoGoforRelatedInformation......................................................12
Chapter 1 BeforeYouBegin ................................................... 15
WhatYouNeedtoKnowtoChangeForms ................................................15
HTTP,QueryURLs,andHTMLForms .................................................16
JavaScript...........................................................................16
HowtheFormsWork ...................................................................16
RequestsSenttotheCMSserver .......................................................17
ResponsesandOutputTemplates ......................................................17
ErrorsandtheErrorTemplate .........................................................19
JavaScriptUsedByAllInterfaces .........................................................20
Part 1 CustomizingEnd-EntityServicesInterface................................ 25
Chapter 2 IntroductiontoEnd-EntityServicesInterface ............................ 27
End-EntityServicesInterface.............................................................27
HowClientTypeDeterminestheEnd-EntityInterface ....................................29
CertificateRequestFormatsSpecifictoEndEntities ......................................29
AccessingtheEnd-EntityServicesInterface ................................................31
End-EntityFormsandTemplates .........................................................31
LocatingEnd-EntityFormsandTemplates ..............................................31

4 Netscape Certificate Management System Customization Guide • October 2001
FormsforCertificateEnrollment....................................................... 32
FormsforCertificateRenewal ......................................................... 33
FormsforCertificateRevocation....................................................... 34
FormsforCertificateRetrieval......................................................... 34
FormsforKeyRecovery .............................................................. 35
OtherForms ........................................................................ 35
OutputTemplatesforEnd-EntityInterfaces............................................. 36
Chapter 3 End-EntityInterfaceReference........................................ 39
OverviewofEnd-EntityInterfaces........................................................ 40
CertificateEnrollmentProtocolInterface .................................................. 41
Description ......................................................................... 41
DefaultForms....................................................................... 41
RequestParameters.................................................................. 41
ChallengeRevocationInterface .......................................................... 42
Description ......................................................................... 42
DefaultForms....................................................................... 42
RequestParameters.................................................................. 42
Response ........................................................................... 44
DisplayCertificateBySerialNumberInterface ............................................. 44
Description ......................................................................... 44
DefaultForms....................................................................... 44
RequestParameters.................................................................. 44
Response ........................................................................... 45
DisplayCertificateFromRequestInterface ................................................ 46
Description ......................................................................... 46
DefaultForms....................................................................... 46
RequestParameters.................................................................. 47
Response ........................................................................... 47
EnrollmentInterface.................................................................... 49
Description ......................................................................... 49
DefaultForms....................................................................... 50
RequestParameters.................................................................. 51
Response ........................................................................... 55
GetCAChainInterface ................................................................. 59
Description ......................................................................... 59
DefaultForms....................................................................... 60
RequestParameters.................................................................. 60
Response ........................................................................... 61
GetCertificateBySerialNumberInterface................................................. 61
Description ......................................................................... 61
DefaultForms....................................................................... 62
RequestParameters.................................................................. 62

5
Response ...........................................................................63
GetCertificateFromRequestInterface ....................................................65
Description .........................................................................65
DefaultForms .......................................................................66
RequestParameters ..................................................................66
Response ...........................................................................67
GetCRLInterface ......................................................................69
Description .........................................................................69
DefaultForms .......................................................................70
RequestParameters ..................................................................70
Response ...........................................................................71
ListCertificatesInterface ................................................................72
Description .........................................................................72
DefaultForms .......................................................................73
RequestParameters ..................................................................73
Response ...........................................................................78
RenewalInterface ......................................................................80
Description .........................................................................80
DefaultForms .......................................................................81
RequestParameters ..................................................................81
Response ...........................................................................81
RevocationInterface ....................................................................82
Description .........................................................................82
DefaultForms .......................................................................82
RequestParameters ..................................................................82
Response ...........................................................................85
Chapter 4 InternationalizationofEnd-EntityInterface.............................. 87
DisplayingFormsinNon-EnglishLanguages ..............................................87
Part 2 CustomizingAgentServicesInterface.................................... 91
Chapter 5 IntroductiontoAgentServicesInterface................................ 93
AgentServicesInterface .................................................................93
CertificateManagerAgentServices ....................................................94
RegistrationManagerAgentServices...................................................95
DataRecoveryManagerAgentServices.................................................96
AccessingtheAgentServicesInterface ....................................................96
AgentFormsandTemplates .............................................................97
StructureoftheAgentServicesInterface ................................................97
LocatingAgentFormsandTemplates ..................................................98

6 Netscape Certificate Management System Customization Guide • October 2001
Chapter 6 AgentInterfaceReference............................................ 99
OverviewofAgentInterfaces ........................................................... 100
ApproveRevocationInterface .......................................................... 101
Description ........................................................................ 101
DefaultForms...................................................................... 102
RequestParameters................................................................. 102
Response .......................................................................... 104
BulkEnrollmentInterface .............................................................. 105
Description ........................................................................ 105
ConfigurationParameters ........................................................... 106
DefaultForms...................................................................... 107
RequestParameters................................................................. 107
Response .......................................................................... 112
DisplayKeyBySerialNumberInterface.................................................. 115
Description ........................................................................ 115
DefaultForms...................................................................... 116
RequestParameters................................................................. 116
Response .......................................................................... 116
DisplayKeyForRecoveryInterface...................................................... 118
Description ........................................................................ 118
DefaultForms...................................................................... 118
RequestParameters................................................................. 118
Response .......................................................................... 119
ExamineRecoveryInterface ............................................................ 120
Description ........................................................................ 120
DefaultForms...................................................................... 121
RequestParameters................................................................. 121
Response .......................................................................... 122
GetApprovalStatusInterface........................................................... 122
Description ........................................................................ 122
DefaultForms...................................................................... 123
RequestParameters................................................................. 123
Response .......................................................................... 124
GetPKCS#12DataInterface............................................................ 125
Description ........................................................................ 125
DefaultForms...................................................................... 125
RequestParameters................................................................. 125
Response .......................................................................... 126
GrantRecoveryInterface............................................................... 126
Description ........................................................................ 126
DefaultForms...................................................................... 126
RequestParameters................................................................. 126
Response .......................................................................... 127

7
KeyQueryInterface ...................................................................128
Description ........................................................................128
DefaultForms ......................................................................128
RequestParameters .................................................................129
Response ..........................................................................131
KeyRecoveryQueryInterface...........................................................133
Description ........................................................................133
DefaultForms ......................................................................134
RequestParameters .................................................................134
Response ..........................................................................136
ProcessCertificateRequestInterface .....................................................138
Description ........................................................................138
DefaultForms ......................................................................139
RequestParameters .................................................................139
Response ..........................................................................142
ProcessDRMRequestInterface..........................................................147
Description ........................................................................147
DefaultForms ......................................................................147
RequestParameters .................................................................147
Response ..........................................................................148
ProcessRequestInterface ...............................................................150
Description ........................................................................150
DefaultForms ......................................................................151
RequestParameters .................................................................151
Response ..........................................................................152
RecoverKeyBySerialNumberInterface..................................................152
Description ........................................................................152
DefaultForms ......................................................................153
RequestParameters .................................................................153
Response ..........................................................................155
RemoveCertificateHoldInterface .......................................................156
Description ........................................................................156
DefaultForms ......................................................................156
RequestParameters .................................................................156
Response ..........................................................................157
RequestsQueryInterface ...............................................................158
Description ........................................................................158
DefaultForms ......................................................................159
RequestParameters .................................................................159
Response ..........................................................................160
SelectforRevocationInterface...........................................................163
Description ........................................................................163
DefaultForms ......................................................................164

8 Netscape Certificate Management System Customization Guide • October 2001
RequestParameters................................................................. 164
Response .......................................................................... 165
UpdateCRLInterface.................................................................. 166
Description ........................................................................ 166
DefaultForms...................................................................... 166
RequestParameters................................................................. 166
Response .......................................................................... 167
UpdateDirectoryInterface ............................................................. 168
Description ........................................................................ 168
DefaultForms...................................................................... 168
RequestParameters................................................................. 168
Response .......................................................................... 170
Index ....................................................................... 173

9
About This Guide
The Customization Guide provides reference information about the HTTP interface
of Netscape Certificate Management System (CMS). The information helps you
customize Certificate Management System, and use it for issuing and managing
certificates to various end entities, such as web browsers (users), servers, Virtual
Private Network (VPN) clients, and Cisco™ routers.
This chapter has the following sections:
• What’s in This Guide (page 9)
• What You Should Already Know (page 9)
• Conventions Used in This Guide (page 10)
• Where to Go for Related Information (page 12)
What’s in This Guide
This guide covers topics that help you customize CMS agent and end-entity
interfaces. You should use this guide in conjunction with the other CMS
documentation, such as the one that explains how to install and configure
Certificate Management System. Complete list of CMS documentation is provided
later in this preface.
What You Should Already Know
This guide is intended for experienced system administrators who are planning to
deploy Certificate Management System. CMS agents should refer to CMS Agent’s
Guide for information on how to perform agent tasks, such as handling certificate
requests and revoking certificates.

Conventions Used in This Guide
10 Netscape Certificate Management System Customization Guide • October 2001
This guide assumes that you
• Are familiar with the basic concepts of public-key cryptography and the Secure
Sockets Layer (SSL) protocol.
❍SSL cipher suites
❍The purpose of and major steps in the SSL handshake
• Understand the concepts of intranet, extranet, and the Internet security and the
role of digital certificates in a secure enterprise. These include the following
topics:
❍Encryption and decryption
❍Public keys, private keys, and symmetric keys
❍Significance of key lengths
❍Digital signatures
❍Digital certificates, including various types of digital certificates
❍The role of digital certificates in a public-key infrastructure (PKI)
❍Certificate hierarchies
If you are new to these concepts, we recommend that you read the
security-related appendixes ( Appendix D and Appendix E ) of the
accompanying manual, Managing Servers with Netscape Console.
• Are familiar with the role of Netscape Console in managing Netscape version
4.x servers. Otherwise, see the accompanying manual, Managing Servers with
Netscape Console.
• Are reading this guide in conjunction with the documentation listed in “Where
to Go for Related Information” on page 12.
Conventions Used in This Guide
The following conventions are used in this guide:
•Monospaced font—Thistypefaceisusedforanytextthatappearsonthe
computer screen or text that you should type. It’s also used for filenames,
functions, and examples.
Example: Server Root is the directory where the CMS binaries are kept.