corosync-qnetd-certutil.8 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. .\"/*
  2. .\" * Copyright (C) 2016-2026 Red Hat, Inc.
  3. .\" *
  4. .\" * All rights reserved.
  5. .\" *
  6. .\" * Author: Jan Friesse <jfriesse@redhat.com>
  7. .\" *
  8. .\" * This software licensed under BSD license, the text of which follows:
  9. .\" *
  10. .\" * Redistribution and use in source and binary forms, with or without
  11. .\" * modification, are permitted provided that the following conditions are met:
  12. .\" *
  13. .\" * - Redistributions of source code must retain the above copyright notice,
  14. .\" * this list of conditions and the following disclaimer.
  15. .\" * - Redistributions in binary form must reproduce the above copyright notice,
  16. .\" * this list of conditions and the following disclaimer in the documentation
  17. .\" * and/or other materials provided with the distribution.
  18. .\" * - Neither the name of Red Hat, Inc. nor the names of its
  19. .\" * contributors may be used to endorse or promote products derived from this
  20. .\" * software without specific prior written permission.
  21. .\" *
  22. .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25. .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26. .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27. .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28. .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29. .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30. .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31. .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32. .\" * THE POSSIBILITY OF SUCH DAMAGE.
  33. .\" */
  34. .TH COROSYNC-QNETD-CERTUTIL 8 2026-07-01
  35. .SH NAME
  36. corosync-qnetd-certutil - tool to generate qnetd TLS certificates
  37. .SH SYNOPSIS
  38. .B "corosync-qnetd-certutil [-i|-s] [-c certificate] [-G] [-g keysize] [-k keytype] [-n cluster_name] [-q paramset]"
  39. .SH DESCRIPTION
  40. .B corosync-qnetd-certutil
  41. is a frontend for the NSS certutil, it is used for generating the QNetd CA (Certificate Authority),
  42. server certificate and signing cluster certificate used by
  43. .B corosync-qdevice
  44. when using the model 'net'.
  45. .SH OPTIONS
  46. .TP
  47. .B -i
  48. Initialize the QNetd NSS certificate database and generate the QNetd CA and server certificates.
  49. The default directory for the database is /etc/corosync/qnetd. This directory must be
  50. writeable by the current user. The QNetd CA certificate is also exported into the file
  51. /etc/corosync/qnetd/nssdb/qnetd-cacert.crt.
  52. .TP
  53. .B -s
  54. Sign the cluster certificate. It is necessary to pass the cluster name (as
  55. configured in corosync.conf) and the certificate request file - see options below.
  56. The signed certificate will be written to the
  57. file /etc/corosync/qnetd/nssdb/cluster-$ClusterName.crt
  58. .TP
  59. .B -c
  60. Certificate request file to sign.
  61. .TP
  62. .B -G
  63. Do not set group write bit for new files. This option has effect only when used together with
  64. .B -i
  65. option. It is useful when extended security is needed and it's viable to prohibit daemon to change its
  66. configuration. Expected usage is to first set owner of the /etc/corosync/qnetd directory
  67. to root:$COROQNETD with permissions 0750 and then create database (as a root):
  68. .nf
  69. # corosync-qnetd-certutil -i -G
  70. .fi
  71. .TP
  72. .B -g
  73. Specify the key size to use when generating new public and private key pairs.
  74. This option is passed directly to the
  75. .B certutil
  76. command. By default, this is left empty, meaning
  77. .B -g
  78. is not passed to
  79. .B certutil
  80. at all.
  81. .TP
  82. .B -k
  83. Specify the key type to use when generating new public and private key pairs.
  84. This option is passed directly to the
  85. .B certutil
  86. command. By default, this is left empty, meaning
  87. .B -k
  88. is not passed to
  89. .B certutil
  90. at all.
  91. .TP
  92. .B -n
  93. Name of the cluster.
  94. .TP
  95. .B -q
  96. Specify the curve-name or ml-dsa-parameter-set to use when generating new public
  97. and private key pairs. This option is passed directly to the
  98. .B certutil
  99. command. By default, this is left empty, meaning
  100. .B -q
  101. is not passed to
  102. .B certutil
  103. at all.
  104. .SH NOTES
  105. If qnetd is executed by a non root user, /etc/corosync/qnetd and its subdirectories must be owned by (or have group access for) the given user. If
  106. .B corosync-qnetd-certutil
  107. is executed as root it tries to copy the owner and group of /etc/corosync/qnetd to all of the created files.
  108. .SH SEE ALSO
  109. .BR corosync-qnetd (8)
  110. .BR corosync-qdevice (8)
  111. .BR certutil(1)
  112. .SH AUTHOR
  113. Jan Friesse
  114. .PP