Difference between revisions of "PKI Subsystem Configuration"

From Dogtag
Jump to: navigation, search
m (OCSP)
m
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
= PKI Subsystem Configuration =
+
= Static Subsystems =
  
* [[PKI CA Configuration]]
+
* Debug
* [[PKI KRA Configuration]]
+
* LogSubsystem
* [[PKI OCSP Configuration]]
+
* [[JSS Subsystem]]
* [[PKI TKS Configuration]]
+
* DBSubsystem
* [[PKI TPS Configuration]]
+
* UGSubsystem
 +
* PluginRegistry
 +
* OidLoaderSubsystem
 +
* X500NameSubsystem
 +
* RequestSubsystem
  
 +
= Dynamic Subsystems =
  
 +
Dynamic subsystems can be configured in the CS.cfg.
  
 +
== CA Subsystems ==
  
 +
<pre>
 +
subsystem.0.class=com.netscape.ca.CertificateAuthority
 +
subsystem.0.id=ca
 +
subsystem.1.class=com.netscape.cmscore.profile.[PKI_PROFILE_SUBSYSTEM]
 +
subsystem.1.id=profile
 +
subsystem.1.enabled=false
 +
subsystem.2.class=com.netscape.cmscore.selftests.SelfTestSubsystem
 +
subsystem.2.id=selftests
 +
subsystem.3.class=com.netscape.cmscore.cert.CrossCertPairSubsystem
 +
subsystem.3.id=CrossCertPair
 +
subsystem.4.class=com.netscape.cmscore.util.StatsSubsystem
 +
subsystem.4.id=stats
 +
</pre>
  
== RA ==
+
See also https://github.com/dogtagpki/pki/blob/master/base/ca/shared/conf/CS.cfg.
  
Configuration of this PKI subsystem can be accomplished in one of three ways:
+
== KRA Subsystems ==
  
'''(1)''' The configuration URL is present on the screen. When this occurs, something similar to the following should appear on the screen (e. g. - Dogtag 1.3):
+
<pre>
 +
subsystem.0.class=com.netscape.kra.KeyRecoveryAuthority
 +
subsystem.0.id=kra
 +
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
 +
subsystem.1.id=selftests
 +
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
 +
subsystem.2.id=stats
 +
</pre>
  
    PKI instance creation Utility ...
+
See also https://github.com/dogtagpki/pki/blob/master/base/kra/shared/conf/CS.cfg.
   
 
   
 
    PKI instance creation completed ...
 
   
 
    Starting pki-ra:                                        [  OK  ]
 
   
 
    PKI service(s) are available at https://&lt;fully qualified domain name&gt;:&lt;secure ra port&gt;
 
   
 
    Server can be operated with /etc/init.d/pki-ra start | stop | restart
 
   
 
    Please start the configuration by accessing:
 
    http://&lt;fully qualified domain name&gt;:&lt;ra port&gt;/ra/admin/console/config/login?pin=ZvgA642EXN9R8NX2JqDK
 
  
<table>
+
== OCSP Subsystems ==
<tr>
 
<td>'''NOTE:&nbsp;&nbsp;'''</td>
 
<td>Default secure ra port:&nbsp;&nbsp;</td>
 
<td>12889</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td>
 
<td>Default ra port:</td>
 
<td>12888</td>
 
</tr>
 
</table>
 
  
<table>
+
<pre>
<tr>
+
subsystem.0.class=com.netscape.ocsp.OCSPAuthority
<td valign="top">'''NOTE:&nbsp;&nbsp;'''</td>
+
subsystem.0.id=ocsp
<td valign="top">Dogtag 9.0 uses a master daemon, 'pki-rad', with an optional specific instance<br>(e. g. - '/sbin/service pki-rad start | stop | restart [RA instance])!</td>
+
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
</tr>
+
subsystem.1.id=selftests
</table>
+
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
 +
subsystem.2.id=stats
 +
</pre>
  
Invoke a browser, insert the configuration URL, and follow the step-by-step instructions displayed in each panel.
+
See also https://github.com/dogtagpki/pki/blob/master/base/ocsp/shared/conf/CS.cfg.
  
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
+
== TKS Subsystems ==
  
'''(2)''' If the user no longer has access to the configuration URL displayed on the screen, one can find the configuration URL at the end of the '''/var/log/&lt;instance name&gt;-install.log'''. For example:
+
<pre>
 +
subsystem.0.class=com.netscape.tks.TKSAuthority
 +
subsystem.0.id=tks
 +
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
 +
subsystem.1.id=selftests
 +
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
 +
subsystem.2.id=stats
 +
</pre>
  
    .
+
See also https://github.com/dogtagpki/pki/blob/master/base/tks/shared/conf/CS.cfg.
    .
 
    .
 
    [2008-02-22 18:23:49] [log] Configuration Wizard listening on
 
    http://&lt;fully qualified domain name&gt;:&lt;ra port&gt;/ra/admin/console/config/login?pin=ZvgA642EXN9R8NX2JqDK
 
  
<table>
+
== TPS Subsystems ==
<tr>
 
<td>'''NOTE:&nbsp;&nbsp;'''</td>
 
<td>The pin is also stored in the '''/etc/&lt;instance name&gt;/CS.cfg''' file as the '''preop.pin''' parameter.</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td>
 
<td>The ra port is also stored in the '''/etc/&lt;instance name&gt;/server.xml''' file as the first uncommented "non-SSL HTTP/1.1 Connector" '''Connector port''' parameter.</td>
 
</tr>
 
</table>
 
  
Invoke a browser, insert the configuration URL, and follow the step-by-step instructions displayed in each panel.
+
<pre>
 +
subsystem.0.class=org.dogtagpki.server.tps.TPSSubsystem
 +
subsystem.0.id=tps
 +
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
 +
subsystem.1.id=selftests
 +
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
 +
subsystem.2.id=stats
 +
</pre>
  
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
+
See also https://github.com/dogtagpki/pki/blob/master/base/tps/shared/conf/CS.cfg.
  
'''(3)''' PKI subsystems can also be configured "automatically" by creating and using the pkisilent component with a predefined profile.
+
= Final Subsystems =
  
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
+
* AuthSubsystem
 
+
* AuthzSubsystem
== TKS ==
+
* [https://github.com/dogtagpki/pki/wiki/Scheduler-Configuration JobsScheduler]
 
 
Configuration of this PKI subsystem can be accomplished in one of three ways:
 
 
 
'''(1)''' The configuration URL is present on the screen.  When this occurs, something similar to the following should appear on the screen (e. g. - Dogtag 1.3):
 
 
 
    PKI instance creation Utility ...
 
   
 
   
 
    PKI instance creation completed ...
 
   
 
    Starting pki-tks:          [ OK  ]
 
   
 
    PKI service(s) are available at https://&lt;fully qualified domain name&gt;:&lt;secure tks port&gt;
 
   
 
    Server can be operated with /etc/init.d/pki-tks start | stop | restart
 
   
 
    Please start the configuration by accessing:
 
    http:/&lt;fully qualified domain name&gt;:&lt;tks port&gt;//tks/admin/console/config/login?pin=ki0R7vMRR75NoIhBrxmf
 
 
 
<table>
 
<tr>
 
<td>'''NOTE:&nbsp;&nbsp;'''</td>
 
<td>Default secure tks port:&nbsp;&nbsp;</td>
 
<td>13443</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td>
 
<td>Default tks port:</td>
 
<td>13080</td>
 
</tr>
 
</table>
 
 
 
<table>
 
<tr>
 
<td valign="top">'''NOTE:&nbsp;&nbsp;'''</td>
 
<td valign="top">Dogtag 9.0 uses a master daemon, 'pki-tksd', with an optional specific instance<br>(e. g. - '/sbin/service pki-tksd start | stop | restart [TKS instance])!</td>
 
</tr>
 
</table>
 
 
 
Invoke a browser, insert the configuration URL, and follow the step-by-step instructions displayed in each panel.
 
 
 
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
 
 
 
'''(2)''' If the user no longer has access to the configuration URL displayed on the screen, one can find the configuration URL at the end of the '''/var/log/&lt;instance name&gt;-install.log'''.  For example:
 
 
 
    .
 
    .
 
    .
 
    [2008-02-22 18:22:46] [log] Configuration Wizard listening on
 
    http:/&lt;fully qualified domain name&gt;:&lt;tks port&gt;//tks/admin/console/config/login?pin=ki0R7vMRR75NoIhBrxmf
 
 
 
<table>
 
<tr>
 
<td>'''NOTE:&nbsp;&nbsp;'''</td>
 
<td>The pin is also stored in the '''/etc/&lt;instance name&gt;/CS.cfg''' file as the '''preop.pin''' parameter.</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td>
 
<td>The tks port is also stored in the '''/etc/&lt;instance name&gt;/server.xml''' file as the first uncommented "non-SSL HTTP/1.1 Connector" '''Connector port''' parameter.</td>
 
</tr>
 
</table>
 
 
 
Invoke a browser, insert the configuration URL, and follow the step-by-step instructions displayed in each panel.
 
 
 
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
 
 
 
'''(3)''' PKI subsystems can also be configured "automatically" by creating and using the pkisilent component with a predefined profile.
 
 
 
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
 
 
 
== TPS ==
 
 
 
Configuration of this PKI subsystem can be accomplished in one of three ways:
 
 
 
'''(1)''' The configuration URL is present on the screen.  When this occurs, something similar to the following should appear on the screen (e. g. - Dogtag 1.3):
 
 
 
    PKI instance creation Utility ...
 
   
 
   
 
    PKI instance creation completed ...
 
   
 
    Starting pki-tps:                                        [  OK  ]
 
   
 
    PKI service(s) are available at https://&lt;fully qualified domain name&gt;:&lt;secure tps port&gt;
 
   
 
    Server can be operated with /etc/init.d/pki-tps start | stop | restart
 
   
 
    Please start the configuration by accessing:
 
    http://&lt;fully qualified domain name&gt;:&lt;tps port&gt;/tps/admin/console/config/login?pin=X4PRHsoagBcuNUGeneUM
 
 
 
<table>
 
<tr>
 
<td>'''NOTE:&nbsp;&nbsp;'''</td>
 
<td>Default secure tps port:&nbsp;&nbsp;</td>
 
<td>7889</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td>
 
<td>Default tps port:</td>
 
<td>7888</td>
 
</tr>
 
</table>
 
 
 
<table>
 
<tr>
 
<td valign="top">'''NOTE:&nbsp;&nbsp;'''</td>
 
<td valign="top">Dogtag 9.0 uses a master daemon, 'pki-tpsd', with an optional specific instance<br>(e. g. - '/sbin/service pki-tpsd start | stop | restart [TPS instance])!</td>
 
</tr>
 
</table>
 
 
 
Invoke a browser, insert the configuration URL, and follow the step-by-step instructions displayed in each panel.
 
 
 
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
 
 
 
'''(2)''' If the user no longer has access to the configuration URL displayed on the screen, one can find the configuration URL at the end of the '''/var/log/&lt;instance name&gt;-install.log'''.  For example:
 
 
 
    .
 
    .
 
    .
 
    [2008-02-22 18:27:58] [log] Configuration Wizard listening on
 
    http://&lt;fully qualified domain name&gt;:&lt;tps port&gt;/tps/admin/console/config/login?pin=X4PRHsoagBcuNUGeneUM
 
 
 
<table>
 
<tr>
 
<td>'''NOTE:&nbsp;&nbsp;'''</td>
 
<td>The pin is also stored in the '''/etc/&lt;instance name&gt;/CS.cfg''' file as the '''preop.pin''' parameter.</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td>
 
<td>The tps port is also stored in the '''/etc/&lt;instance name&gt;/server.xml''' file as the first uncommented "non-SSL HTTP/1.1 Connector" '''Connector port''' parameter.</td>
 
</tr>
 
</table>
 
 
 
Invoke a browser, insert the configuration URL, and follow the step-by-step instructions displayed in each panel.
 
 
 
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
 
 
 
'''(3)''' PKI subsystems can also be configured "automatically" by creating and using the pkisilent component with a predefined profile.
 
 
 
    '''IMPORTANT:&nbsp;&nbsp;''' When finished, don't forget to restart this PKI instance before attempting to use it!
 
 
 
= References =
 
 
 
* [[PKI Server Configuration]]
 

Latest revision as of 23:02, 29 July 2022

Static Subsystems

  • Debug
  • LogSubsystem
  • JSS Subsystem
  • DBSubsystem
  • UGSubsystem
  • PluginRegistry
  • OidLoaderSubsystem
  • X500NameSubsystem
  • RequestSubsystem

Dynamic Subsystems

Dynamic subsystems can be configured in the CS.cfg.

CA Subsystems

subsystem.0.class=com.netscape.ca.CertificateAuthority
subsystem.0.id=ca
subsystem.1.class=com.netscape.cmscore.profile.[PKI_PROFILE_SUBSYSTEM]
subsystem.1.id=profile
subsystem.1.enabled=false
subsystem.2.class=com.netscape.cmscore.selftests.SelfTestSubsystem
subsystem.2.id=selftests
subsystem.3.class=com.netscape.cmscore.cert.CrossCertPairSubsystem
subsystem.3.id=CrossCertPair
subsystem.4.class=com.netscape.cmscore.util.StatsSubsystem
subsystem.4.id=stats

See also https://github.com/dogtagpki/pki/blob/master/base/ca/shared/conf/CS.cfg.

KRA Subsystems

subsystem.0.class=com.netscape.kra.KeyRecoveryAuthority
subsystem.0.id=kra
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
subsystem.1.id=selftests
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
subsystem.2.id=stats

See also https://github.com/dogtagpki/pki/blob/master/base/kra/shared/conf/CS.cfg.

OCSP Subsystems

subsystem.0.class=com.netscape.ocsp.OCSPAuthority
subsystem.0.id=ocsp
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
subsystem.1.id=selftests
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
subsystem.2.id=stats

See also https://github.com/dogtagpki/pki/blob/master/base/ocsp/shared/conf/CS.cfg.

TKS Subsystems

subsystem.0.class=com.netscape.tks.TKSAuthority
subsystem.0.id=tks
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
subsystem.1.id=selftests
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
subsystem.2.id=stats

See also https://github.com/dogtagpki/pki/blob/master/base/tks/shared/conf/CS.cfg.

TPS Subsystems

subsystem.0.class=org.dogtagpki.server.tps.TPSSubsystem
subsystem.0.id=tps
subsystem.1.class=com.netscape.cmscore.selftests.SelfTestSubsystem
subsystem.1.id=selftests
subsystem.2.class=com.netscape.cmscore.util.StatsSubsystem
subsystem.2.id=stats

See also https://github.com/dogtagpki/pki/blob/master/base/tps/shared/conf/CS.cfg.

Final Subsystems