You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

88 lines
2.9 KiB

5 years ago
4 years ago
  1. .\" Copyright (c) 2019-2020 Rodolphe Bréard <rodolphe@breard.tf>
  2. .\"
  3. .\" Copying and distribution of this file, with or without modification,
  4. .\" are permitted in any medium without royalty provided the copyright
  5. .\" notice and this notice are preserved. This file is offered as-is,
  6. .\" without any warranty.
  7. .Dd June 12, 2020
  8. .Dt TACD 8
  9. .Os
  10. .Sh NAME
  11. .Nm tacd
  12. .Nd TLS-ALPN Challenge Daemon
  13. .Sh SYNOPSIS
  14. .Nm
  15. .Op Fl e|--acme-ext Ar STRING
  16. .Op Fl -acme-ext-file Ar FILE
  17. .Op Fl -crt-signature-alg Ar STRING
  18. .Op Fl d|--domain Ar STRING
  19. .Op Fl -domain-file Ar STRING
  20. .Op Fl f|--foreground
  21. .Op Fl h|--help
  22. .Op Fl l|--listen Ar host:port
  23. .Op Fl -log-stderr
  24. .Op Fl -log-syslog
  25. .Op Fl -log-level Ar LEVEL
  26. .Op Fl -pid-file Ar FILE
  27. .Op Fl V|--version
  28. .Sh DESCRIPTION
  29. .Nm
  30. is a server that will listen to incoming Transport Layer Security
  31. .Pq TLS
  32. connections and, if the
  33. .Em acme-tls/1
  34. protocol has been declared during the Application-Layer Protocol Negotiation
  35. .Pq ALPN ,
  36. present a self-signed certificate in order to attempt to solve the TLS-ALPN-01 challenge. It then drops the connection.
  37. .Pp
  38. In order to generate the self-signed certificate, it is required to specify both the
  39. .Em domain name
  40. to validate and the
  41. .Em acmeIdentifier extension .
  42. If one of those values is not specified using the available options, it is read from the standard input. When reading from the standard input, a new line character is expected at the end. In the case both values needs to be read from the standard input, the
  43. .Em domain name
  44. is read first, then the
  45. .Em acmeIdentifier extension .
  46. .Pp
  47. The options are as follows:
  48. .Bl -tag
  49. .It Fl e, -acme-ext Ar STRING
  50. The acmeIdentifier extension to set in the self-signed certificate.
  51. .It Fl -acme-ext-file Ar FILE
  52. File from which is read the acmeIdentifier extension to set in the self-signed certificate.
  53. .It Fl -crt-signature-alg Ar STRING
  54. Set the certificate's signature algorithm. Possible values depends on the cryptographic library support and can be listed using the
  55. .Em --help
  56. flag.
  57. .It Fl d, -domain Ar STRING
  58. The domain that is being validated.
  59. .It Fl -domain-file Ar STRING
  60. File from which is read the domain that is being validated.
  61. .It Fl f, -foreground
  62. Runs in the foreground.
  63. .It Fl h, -help
  64. Prints help information.
  65. .It Fl i, -listen Ar host:port | unix:path
  66. Specifies the host and port combination or the unix socket to listen on.
  67. .It Fl -log-stderr
  68. Prints log messages to the standard error output.
  69. .It Fl -log-syslog
  70. Sends log messages via syslog.
  71. .It Fl -log-level Ar LEVEL
  72. Specify the log level. Possible values: error, warn, info, debug and trace.
  73. .It Fl -pid-file Ar FILE
  74. Specifies the location of the PID file.
  75. .It Fl V, -version
  76. Prints version information.
  77. .Sh SEE ALSO
  78. .Xr acmed.toml 5
  79. .Sh STANDARDS
  80. .Rs
  81. .%A R.B. Shoemaker
  82. .%D February 2020
  83. .%R RFC 8737
  84. .%T Automated Certificate Management Environment (ACME) TLS Application-Layer Protocol Negotiation (ALPN) Challenge Extension
  85. .Re
  86. .Sh AUTHORS
  87. .An Rodolphe Bréard
  88. .Aq rodolphe@breard.tf