krb5kdc.8 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. .\" Man page generated from reStructuredText.
  2. .
  3. .TH "KRB5KDC" "8" " " "1.20.1" "MIT Kerberos"
  4. .SH NAME
  5. krb5kdc \- Kerberos V5 KDC
  6. .
  7. .nr rst2man-indent-level 0
  8. .
  9. .de1 rstReportMargin
  10. \\$1 \\n[an-margin]
  11. level \\n[rst2man-indent-level]
  12. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13. -
  14. \\n[rst2man-indent0]
  15. \\n[rst2man-indent1]
  16. \\n[rst2man-indent2]
  17. ..
  18. .de1 INDENT
  19. .\" .rstReportMargin pre:
  20. . RS \\$1
  21. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22. . nr rst2man-indent-level +1
  23. .\" .rstReportMargin post:
  24. ..
  25. .de UNINDENT
  26. . RE
  27. .\" indent \\n[an-margin]
  28. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29. .nr rst2man-indent-level -1
  30. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32. ..
  33. .SH SYNOPSIS
  34. .sp
  35. \fBkrb5kdc\fP
  36. [\fB\-x\fP \fIdb_args\fP]
  37. [\fB\-d\fP \fIdbname\fP]
  38. [\fB\-k\fP \fIkeytype\fP]
  39. [\fB\-M\fP \fImkeyname\fP]
  40. [\fB\-p\fP \fIportnum\fP]
  41. [\fB\-m\fP]
  42. [\fB\-r\fP \fIrealm\fP]
  43. [\fB\-n\fP]
  44. [\fB\-w\fP \fInumworkers\fP]
  45. [\fB\-P\fP \fIpid_file\fP]
  46. [\fB\-T\fP \fItime_offset\fP]
  47. .SH DESCRIPTION
  48. .sp
  49. krb5kdc is the Kerberos version 5 Authentication Service and Key
  50. Distribution Center (AS/KDC).
  51. .SH OPTIONS
  52. .sp
  53. The \fB\-r\fP \fIrealm\fP option specifies the realm for which the server
  54. should provide service. This option may be specified multiple times
  55. to serve multiple realms. If no \fB\-r\fP option is given, the default
  56. realm (as specified in krb5.conf(5)) will be served.
  57. .sp
  58. The \fB\-d\fP \fIdbname\fP option specifies the name under which the
  59. principal database can be found. This option does not apply to the
  60. LDAP database.
  61. .sp
  62. The \fB\-k\fP \fIkeytype\fP option specifies the key type of the master key
  63. to be entered manually as a password when \fB\-m\fP is given; the default
  64. is \fBaes256\-cts\-hmac\-sha1\-96\fP\&.
  65. .sp
  66. The \fB\-M\fP \fImkeyname\fP option specifies the principal name for the
  67. master key in the database (usually \fBK/M\fP in the KDC\(aqs realm).
  68. .sp
  69. The \fB\-m\fP option specifies that the master database password should
  70. be fetched from the keyboard rather than from a stash file.
  71. .sp
  72. The \fB\-n\fP option specifies that the KDC does not put itself in the
  73. background and does not disassociate itself from the terminal.
  74. .sp
  75. The \fB\-P\fP \fIpid_file\fP option tells the KDC to write its PID into
  76. \fIpid_file\fP after it starts up. This can be used to identify whether
  77. the KDC is still running and to allow init scripts to stop the correct
  78. process.
  79. .sp
  80. The \fB\-p\fP \fIportnum\fP option specifies the default UDP and TCP port
  81. numbers which the KDC should listen on for Kerberos version 5
  82. requests, as a comma\-separated list. This value overrides the port
  83. numbers specified in the kdcdefaults section of
  84. kdc.conf(5), but may be overridden by realm\-specific values.
  85. If no value is given from any source, the default port is 88.
  86. .sp
  87. The \fB\-w\fP \fInumworkers\fP option tells the KDC to fork \fInumworkers\fP
  88. processes to listen to the KDC ports and process requests in parallel.
  89. The top level KDC process (whose pid is recorded in the pid file if
  90. the \fB\-P\fP option is also given) acts as a supervisor. The supervisor
  91. will relay SIGHUP signals to the worker subprocesses, and will
  92. terminate the worker subprocess if the it is itself terminated or if
  93. any other worker process exits.
  94. .sp
  95. The \fB\-x\fP \fIdb_args\fP option specifies database\-specific arguments.
  96. See Database Options in kadmin(1) for
  97. supported arguments.
  98. .sp
  99. The \fB\-T\fP \fIoffset\fP option specifies a time offset, in seconds, which
  100. the KDC will operate under. It is intended only for testing purposes.
  101. .SH EXAMPLE
  102. .sp
  103. The KDC may service requests for multiple realms (maximum 32 realms).
  104. The realms are listed on the command line. Per\-realm options that can
  105. be specified on the command line pertain for each realm that follows
  106. it and are superseded by subsequent definitions of the same option.
  107. .sp
  108. For example:
  109. .INDENT 0.0
  110. .INDENT 3.5
  111. .sp
  112. .nf
  113. .ft C
  114. krb5kdc \-p 2001 \-r REALM1 \-p 2002 \-r REALM2 \-r REALM3
  115. .ft P
  116. .fi
  117. .UNINDENT
  118. .UNINDENT
  119. .sp
  120. specifies that the KDC listen on port 2001 for REALM1 and on port 2002
  121. for REALM2 and REALM3. Additionally, per\-realm parameters may be
  122. specified in the kdc.conf(5) file. The location of this file
  123. may be specified by the \fBKRB5_KDC_PROFILE\fP environment variable.
  124. Per\-realm parameters specified in this file take precedence over
  125. options specified on the command line. See the kdc.conf(5)
  126. description for further details.
  127. .SH ENVIRONMENT
  128. .sp
  129. See kerberos(7) for a description of Kerberos environment
  130. variables.
  131. .SH SEE ALSO
  132. .sp
  133. kdb5_util(8), kdc.conf(5), krb5.conf(5),
  134. kdb5_ldap_util(8), kerberos(7)
  135. .SH AUTHOR
  136. MIT
  137. .SH COPYRIGHT
  138. 1985-2022, MIT
  139. .\" Generated by docutils manpage writer.
  140. .