openssl-s_server.1ossl 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "OPENSSL-S_SERVER 1ossl"
  136. .TH OPENSSL-S_SERVER 1ossl "2025-06-29" "3.3.2" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. openssl\-s_server \- SSL/TLS server program
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl\fR \fBs_server\fR
  146. [\fB\-help\fR]
  147. [\fB\-port\fR \fI+int\fR]
  148. [\fB\-accept\fR \fIval\fR]
  149. [\fB\-unix\fR \fIval\fR]
  150. [\fB\-4\fR]
  151. [\fB\-6\fR]
  152. [\fB\-unlink\fR]
  153. [\fB\-context\fR \fIval\fR]
  154. [\fB\-verify\fR \fIint\fR]
  155. [\fB\-Verify\fR \fIint\fR]
  156. [\fB\-cert\fR \fIinfile\fR]
  157. [\fB\-cert2\fR \fIinfile\fR]
  158. [\fB\-certform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR]
  159. [\fB\-cert_chain\fR \fIinfile\fR]
  160. [\fB\-build_chain\fR]
  161. [\fB\-serverinfo\fR \fIval\fR]
  162. [\fB\-key\fR \fIfilename\fR|\fIuri\fR]
  163. [\fB\-key2\fR \fIfilename\fR|\fIuri\fR]
  164. [\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR]
  165. [\fB\-pass\fR \fIval\fR]
  166. [\fB\-dcert\fR \fIinfile\fR]
  167. [\fB\-dcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR]
  168. [\fB\-dcert_chain\fR \fIinfile\fR]
  169. [\fB\-dkey\fR \fIfilename\fR|\fIuri\fR]
  170. [\fB\-dkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR]
  171. [\fB\-dpass\fR \fIval\fR]
  172. [\fB\-nbio_test\fR]
  173. [\fB\-crlf\fR]
  174. [\fB\-debug\fR]
  175. [\fB\-msg\fR]
  176. [\fB\-msgfile\fR \fIoutfile\fR]
  177. [\fB\-state\fR]
  178. [\fB\-nocert\fR]
  179. [\fB\-quiet\fR]
  180. [\fB\-no_resume_ephemeral\fR]
  181. [\fB\-www\fR]
  182. [\fB\-WWW\fR]
  183. [\fB\-http_server_binmode\fR]
  184. [\fB\-no_ca_names\fR]
  185. [\fB\-ignore_unexpected_eof\fR]
  186. [\fB\-servername\fR]
  187. [\fB\-servername_fatal\fR]
  188. [\fB\-tlsextdebug\fR]
  189. [\fB\-HTTP\fR]
  190. [\fB\-id_prefix\fR \fIval\fR]
  191. [\fB\-keymatexport\fR \fIval\fR]
  192. [\fB\-keymatexportlen\fR \fI+int\fR]
  193. [\fB\-CRL\fR \fIinfile\fR]
  194. [\fB\-CRLform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
  195. [\fB\-crl_download\fR]
  196. [\fB\-chainCAfile\fR \fIinfile\fR]
  197. [\fB\-chainCApath\fR \fIdir\fR]
  198. [\fB\-chainCAstore\fR \fIuri\fR]
  199. [\fB\-verifyCAfile\fR \fIinfile\fR]
  200. [\fB\-verifyCApath\fR \fIdir\fR]
  201. [\fB\-verifyCAstore\fR \fIuri\fR]
  202. [\fB\-no_cache\fR]
  203. [\fB\-ext_cache\fR]
  204. [\fB\-verify_return_error\fR]
  205. [\fB\-verify_quiet\fR]
  206. [\fB\-ign_eof\fR]
  207. [\fB\-no_ign_eof\fR]
  208. [\fB\-no_etm\fR]
  209. [\fB\-no_ems\fR]
  210. [\fB\-status\fR]
  211. [\fB\-status_verbose\fR]
  212. [\fB\-status_timeout\fR \fIint\fR]
  213. [\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path]\fR]
  214. [\fB\-no_proxy\fR \fIaddresses\fR]
  215. [\fB\-status_url\fR \fIval\fR]
  216. [\fB\-status_file\fR \fIinfile\fR]
  217. [\fB\-ssl_config\fR \fIval\fR]
  218. [\fB\-trace\fR]
  219. [\fB\-security_debug\fR]
  220. [\fB\-security_debug_verbose\fR]
  221. [\fB\-brief\fR]
  222. [\fB\-rev\fR]
  223. [\fB\-async\fR]
  224. [\fB\-max_send_frag\fR \fI+int\fR]
  225. [\fB\-split_send_frag\fR \fI+int\fR]
  226. [\fB\-max_pipelines\fR \fI+int\fR]
  227. [\fB\-naccept\fR \fI+int\fR]
  228. [\fB\-read_buf\fR \fI+int\fR]
  229. [\fB\-bugs\fR]
  230. [\fB\-no_tx_cert_comp\fR]
  231. [\fB\-no_rx_cert_comp\fR]
  232. [\fB\-no_comp\fR]
  233. [\fB\-comp\fR]
  234. [\fB\-no_ticket\fR]
  235. [\fB\-serverpref\fR]
  236. [\fB\-legacy_renegotiation\fR]
  237. [\fB\-no_renegotiation\fR]
  238. [\fB\-no_resumption_on_reneg\fR]
  239. [\fB\-allow_no_dhe_kex\fR]
  240. [\fB\-prefer_no_dhe_kex\fR]
  241. [\fB\-prioritize_chacha\fR]
  242. [\fB\-strict\fR]
  243. [\fB\-sigalgs\fR \fIval\fR]
  244. [\fB\-client_sigalgs\fR \fIval\fR]
  245. [\fB\-groups\fR \fIval\fR]
  246. [\fB\-curves\fR \fIval\fR]
  247. [\fB\-named_curve\fR \fIval\fR]
  248. [\fB\-cipher\fR \fIval\fR]
  249. [\fB\-ciphersuites\fR \fIval\fR]
  250. [\fB\-dhparam\fR \fIinfile\fR]
  251. [\fB\-record_padding\fR \fIval\fR]
  252. [\fB\-debug_broken_protocol\fR]
  253. [\fB\-nbio\fR]
  254. [\fB\-psk_identity\fR \fIval\fR]
  255. [\fB\-psk_hint\fR \fIval\fR]
  256. [\fB\-psk\fR \fIval\fR]
  257. [\fB\-psk_session\fR \fIfile\fR]
  258. [\fB\-srpvfile\fR \fIinfile\fR]
  259. [\fB\-srpuserseed\fR \fIval\fR]
  260. [\fB\-timeout\fR]
  261. [\fB\-mtu\fR \fI+int\fR]
  262. [\fB\-listen\fR]
  263. [\fB\-sctp\fR]
  264. [\fB\-sctp_label_bug\fR]
  265. [\fB\-use_srtp\fR \fIval\fR]
  266. [\fB\-no_dhe\fR]
  267. [\fB\-nextprotoneg\fR \fIval\fR]
  268. [\fB\-alpn\fR \fIval\fR]
  269. [\fB\-ktls\fR]
  270. [\fB\-sendfile\fR]
  271. [\fB\-zerocopy_sendfile\fR]
  272. [\fB\-keylogfile\fR \fIoutfile\fR]
  273. [\fB\-recv_max_early_data\fR \fIint\fR]
  274. [\fB\-max_early_data\fR \fIint\fR]
  275. [\fB\-early_data\fR]
  276. [\fB\-stateless\fR]
  277. [\fB\-anti_replay\fR]
  278. [\fB\-no_anti_replay\fR]
  279. [\fB\-num_tickets\fR]
  280. [\fB\-tfo\fR]
  281. [\fB\-cert_comp\fR]
  282. [\fB\-nameopt\fR \fIoption\fR]
  283. [\fB\-no_ssl3\fR]
  284. [\fB\-no_tls1\fR]
  285. [\fB\-no_tls1_1\fR]
  286. [\fB\-no_tls1_2\fR]
  287. [\fB\-no_tls1_3\fR]
  288. [\fB\-ssl3\fR]
  289. [\fB\-tls1\fR]
  290. [\fB\-tls1_1\fR]
  291. [\fB\-tls1_2\fR]
  292. [\fB\-tls1_3\fR]
  293. [\fB\-dtls\fR]
  294. [\fB\-dtls1\fR]
  295. [\fB\-dtls1_2\fR]
  296. [\fB\-allow_proxy_certs\fR]
  297. [\fB\-attime\fR \fItimestamp\fR]
  298. [\fB\-no_check_time\fR]
  299. [\fB\-check_ss_sig\fR]
  300. [\fB\-crl_check\fR]
  301. [\fB\-crl_check_all\fR]
  302. [\fB\-explicit_policy\fR]
  303. [\fB\-extended_crl\fR]
  304. [\fB\-ignore_critical\fR]
  305. [\fB\-inhibit_any\fR]
  306. [\fB\-inhibit_map\fR]
  307. [\fB\-partial_chain\fR]
  308. [\fB\-policy\fR \fIarg\fR]
  309. [\fB\-policy_check\fR]
  310. [\fB\-policy_print\fR]
  311. [\fB\-purpose\fR \fIpurpose\fR]
  312. [\fB\-suiteB_128\fR]
  313. [\fB\-suiteB_128_only\fR]
  314. [\fB\-suiteB_192\fR]
  315. [\fB\-trusted_first\fR]
  316. [\fB\-no_alt_chains\fR]
  317. [\fB\-use_deltas\fR]
  318. [\fB\-auth_level\fR \fInum\fR]
  319. [\fB\-verify_depth\fR \fInum\fR]
  320. [\fB\-verify_email\fR \fIemail\fR]
  321. [\fB\-verify_hostname\fR \fIhostname\fR]
  322. [\fB\-verify_ip\fR \fIip\fR]
  323. [\fB\-verify_name\fR \fIname\fR]
  324. [\fB\-x509_strict\fR]
  325. [\fB\-issuer_checks\fR]
  326. [\fB\-bugs\fR]
  327. [\fB\-no_comp\fR]
  328. [\fB\-comp\fR]
  329. [\fB\-no_ticket\fR]
  330. [\fB\-serverpref\fR]
  331. [\fB\-client_renegotiation\fR]
  332. [\fB\-legacy_renegotiation\fR]
  333. [\fB\-no_renegotiation\fR]
  334. [\fB\-no_resumption_on_reneg\fR]
  335. [\fB\-legacy_server_connect\fR]
  336. [\fB\-no_legacy_server_connect\fR]
  337. [\fB\-no_etm\fR]
  338. [\fB\-allow_no_dhe_kex\fR]
  339. [\fB\-prefer_no_dhe_kex\fR]
  340. [\fB\-prioritize_chacha\fR]
  341. [\fB\-strict\fR]
  342. [\fB\-sigalgs\fR \fIalgs\fR]
  343. [\fB\-client_sigalgs\fR \fIalgs\fR]
  344. [\fB\-groups\fR \fIgroups\fR]
  345. [\fB\-curves\fR \fIcurves\fR]
  346. [\fB\-named_curve\fR \fIcurve\fR]
  347. [\fB\-cipher\fR \fIciphers\fR]
  348. [\fB\-ciphersuites\fR \fI1.3ciphers\fR]
  349. [\fB\-min_protocol\fR \fIminprot\fR]
  350. [\fB\-max_protocol\fR \fImaxprot\fR]
  351. [\fB\-record_padding\fR \fIpadding\fR]
  352. [\fB\-debug_broken_protocol\fR]
  353. [\fB\-no_middlebox\fR]
  354. [\fB\-xkey\fR \fIinfile\fR]
  355. [\fB\-xcert\fR \fIfile\fR]
  356. [\fB\-xchain\fR \fIfile\fR]
  357. [\fB\-xchain_build\fR \fIfile\fR]
  358. [\fB\-xcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]>
  359. [\fB\-xkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]>
  360. [\fB\-CAfile\fR \fIfile\fR]
  361. [\fB\-no\-CAfile\fR]
  362. [\fB\-CApath\fR \fIdir\fR]
  363. [\fB\-no\-CApath\fR]
  364. [\fB\-CAstore\fR \fIuri\fR]
  365. [\fB\-no\-CAstore\fR]
  366. [\fB\-rand\fR \fIfiles\fR]
  367. [\fB\-writerand\fR \fIfile\fR]
  368. [\fB\-engine\fR \fIid\fR]
  369. [\fB\-provider\fR \fIname\fR]
  370. [\fB\-provider\-path\fR \fIpath\fR]
  371. [\fB\-propquery\fR \fIpropq\fR]
  372. [\fB\-enable_server_rpk\fR]
  373. [\fB\-enable_client_rpk\fR]
  374. .SH "DESCRIPTION"
  375. .IX Header "DESCRIPTION"
  376. This command implements a generic \s-1SSL/TLS\s0 server which
  377. listens for connections on a given port using \s-1SSL/TLS.\s0
  378. .SH "OPTIONS"
  379. .IX Header "OPTIONS"
  380. In addition to the options below, this command also supports
  381. the common and server only options documented
  382. \&\*(L"Supported Command Line Commands\*(R" in \fBSSL_CONF_cmd\fR\|(3)
  383. .IP "\fB\-help\fR" 4
  384. .IX Item "-help"
  385. Print out a usage message.
  386. .IP "\fB\-port\fR \fI+int\fR" 4
  387. .IX Item "-port +int"
  388. The \s-1TCP\s0 port to listen on for connections. If not specified 4433 is used.
  389. .IP "\fB\-accept\fR \fIval\fR" 4
  390. .IX Item "-accept val"
  391. The optional \s-1TCP\s0 host and port to listen on for connections. If not specified, *:4433 is used.
  392. .IP "\fB\-unix\fR \fIval\fR" 4
  393. .IX Item "-unix val"
  394. Unix domain socket to accept on.
  395. .IP "\fB\-4\fR" 4
  396. .IX Item "-4"
  397. Use IPv4 only.
  398. .IP "\fB\-6\fR" 4
  399. .IX Item "-6"
  400. Use IPv6 only.
  401. .IP "\fB\-unlink\fR" 4
  402. .IX Item "-unlink"
  403. For \-unix, unlink any existing socket first.
  404. .IP "\fB\-context\fR \fIval\fR" 4
  405. .IX Item "-context val"
  406. Sets the \s-1SSL\s0 context id. It can be given any string value. If this option
  407. is not present a default value will be used.
  408. .IP "\fB\-verify\fR \fIint\fR, \fB\-Verify\fR \fIint\fR" 4
  409. .IX Item "-verify int, -Verify int"
  410. The verify depth to use. This specifies the maximum length of the
  411. client certificate chain and makes the server request a certificate from
  412. the client. With the \fB\-verify\fR option a certificate is requested but the
  413. client does not have to send one, with the \fB\-Verify\fR option the client
  414. must supply a certificate or an error occurs.
  415. .Sp
  416. If the cipher suite cannot request a client certificate (for example an
  417. anonymous cipher suite or \s-1PSK\s0) this option has no effect.
  418. .IP "\fB\-cert\fR \fIinfile\fR" 4
  419. .IX Item "-cert infile"
  420. The certificate to use, most servers cipher suites require the use of a
  421. certificate and some require a certificate with a certain public key type:
  422. for example the \s-1DSS\s0 cipher suites require a certificate containing a \s-1DSS\s0
  423. (\s-1DSA\s0) key. If not specified then the filename \fIserver.pem\fR will be used.
  424. .IP "\fB\-cert2\fR \fIinfile\fR" 4
  425. .IX Item "-cert2 infile"
  426. The certificate file to use for servername; default is \f(CW\*(C`server2.pem\*(C'\fR.
  427. .IP "\fB\-certform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR" 4
  428. .IX Item "-certform DER|PEM|P12"
  429. The server certificate file format; unspecified by default.
  430. See \fBopenssl\-format\-options\fR\|(1) for details.
  431. .IP "\fB\-cert_chain\fR" 4
  432. .IX Item "-cert_chain"
  433. A file or \s-1URI\s0 of untrusted certificates to use when attempting to build the
  434. certificate chain related to the certificate specified via the \fB\-cert\fR option.
  435. These untrusted certificates are sent to clients and used for generating
  436. certificate status (aka \s-1OCSP\s0 stapling) requests.
  437. The input can be in \s-1PEM, DER,\s0 or PKCS#12 format.
  438. .IP "\fB\-build_chain\fR" 4
  439. .IX Item "-build_chain"
  440. Specify whether the application should build the server certificate chain to be
  441. provided to the client.
  442. .IP "\fB\-serverinfo\fR \fIval\fR" 4
  443. .IX Item "-serverinfo val"
  444. A file containing one or more blocks of \s-1PEM\s0 data. Each \s-1PEM\s0 block
  445. must encode a \s-1TLS\s0 ServerHello extension (2 bytes type, 2 bytes length,
  446. followed by \*(L"length\*(R" bytes of extension data). If the client sends
  447. an empty \s-1TLS\s0 ClientHello extension matching the type, the corresponding
  448. ServerHello extension will be returned.
  449. .IP "\fB\-key\fR \fIfilename\fR|\fIuri\fR" 4
  450. .IX Item "-key filename|uri"
  451. The private key to use. If not specified then the certificate file will
  452. be used.
  453. .IP "\fB\-key2\fR \fIfilename\fR|\fIuri\fR" 4
  454. .IX Item "-key2 filename|uri"
  455. The private Key file to use for servername if not given via \fB\-cert2\fR.
  456. .IP "\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR" 4
  457. .IX Item "-keyform DER|PEM|P12|ENGINE"
  458. The key format; unspecified by default.
  459. See \fBopenssl\-format\-options\fR\|(1) for details.
  460. .IP "\fB\-pass\fR \fIval\fR" 4
  461. .IX Item "-pass val"
  462. The private key and certificate file password source.
  463. For more information about the format of \fIval\fR,
  464. see \fBopenssl\-passphrase\-options\fR\|(1).
  465. .IP "\fB\-dcert\fR \fIinfile\fR, \fB\-dkey\fR \fIfilename\fR|\fIuri\fR" 4
  466. .IX Item "-dcert infile, -dkey filename|uri"
  467. Specify an additional certificate and private key, these behave in the
  468. same manner as the \fB\-cert\fR and \fB\-key\fR options except there is no default
  469. if they are not specified (no additional certificate and key is used). As
  470. noted above some cipher suites require a certificate containing a key of
  471. a certain type. Some cipher suites need a certificate carrying an \s-1RSA\s0 key
  472. and some a \s-1DSS\s0 (\s-1DSA\s0) key. By using \s-1RSA\s0 and \s-1DSS\s0 certificates and keys
  473. a server can support clients which only support \s-1RSA\s0 or \s-1DSS\s0 cipher suites
  474. by using an appropriate certificate.
  475. .IP "\fB\-dcert_chain\fR" 4
  476. .IX Item "-dcert_chain"
  477. A file or \s-1URI\s0 of untrusted certificates to use when attempting to build the
  478. server certificate chain when a certificate specified via the \fB\-dcert\fR option
  479. is in use.
  480. The input can be in \s-1PEM, DER,\s0 or PKCS#12 format.
  481. .IP "\fB\-dcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR" 4
  482. .IX Item "-dcertform DER|PEM|P12"
  483. The format of the additional certificate file; unspecified by default.
  484. See \fBopenssl\-format\-options\fR\|(1) for details.
  485. .IP "\fB\-dkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR" 4
  486. .IX Item "-dkeyform DER|PEM|P12|ENGINE"
  487. The format of the additional private key; unspecified by default.
  488. See \fBopenssl\-format\-options\fR\|(1) for details.
  489. .IP "\fB\-dpass\fR \fIval\fR" 4
  490. .IX Item "-dpass val"
  491. The passphrase for the additional private key and certificate.
  492. For more information about the format of \fIval\fR,
  493. see \fBopenssl\-passphrase\-options\fR\|(1).
  494. .IP "\fB\-nbio_test\fR" 4
  495. .IX Item "-nbio_test"
  496. Tests non blocking I/O.
  497. .IP "\fB\-crlf\fR" 4
  498. .IX Item "-crlf"
  499. This option translated a line feed from the terminal into \s-1CR+LF.\s0
  500. .IP "\fB\-debug\fR" 4
  501. .IX Item "-debug"
  502. Print extensive debugging information including a hex dump of all traffic.
  503. .IP "\fB\-security_debug\fR" 4
  504. .IX Item "-security_debug"
  505. Print output from \s-1SSL/TLS\s0 security framework.
  506. .IP "\fB\-security_debug_verbose\fR" 4
  507. .IX Item "-security_debug_verbose"
  508. Print more output from \s-1SSL/TLS\s0 security framework
  509. .IP "\fB\-msg\fR" 4
  510. .IX Item "-msg"
  511. Show all protocol messages with hex dump.
  512. .IP "\fB\-msgfile\fR \fIoutfile\fR" 4
  513. .IX Item "-msgfile outfile"
  514. File to send output of \fB\-msg\fR or \fB\-trace\fR to, default standard output.
  515. .IP "\fB\-state\fR" 4
  516. .IX Item "-state"
  517. Prints the \s-1SSL\s0 session states.
  518. .IP "\fB\-CRL\fR \fIinfile\fR" 4
  519. .IX Item "-CRL infile"
  520. The \s-1CRL\s0 file to use.
  521. .IP "\fB\-CRLform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  522. .IX Item "-CRLform DER|PEM"
  523. The \s-1CRL\s0 file format; unspecified by default.
  524. See \fBopenssl\-format\-options\fR\|(1) for details.
  525. .IP "\fB\-crl_download\fR" 4
  526. .IX Item "-crl_download"
  527. Download CRLs from distribution points given in \s-1CDP\s0 extensions of certificates
  528. .IP "\fB\-verifyCAfile\fR \fIfilename\fR" 4
  529. .IX Item "-verifyCAfile filename"
  530. A file in \s-1PEM\s0 format \s-1CA\s0 containing trusted certificates to use
  531. for verifying client certificates.
  532. .IP "\fB\-verifyCApath\fR \fIdir\fR" 4
  533. .IX Item "-verifyCApath dir"
  534. A directory containing trusted certificates to use
  535. for verifying client certificates.
  536. This directory must be in \*(L"hash format\*(R",
  537. see \fBopenssl\-verify\fR\|(1) for more information.
  538. .IP "\fB\-verifyCAstore\fR \fIuri\fR" 4
  539. .IX Item "-verifyCAstore uri"
  540. The \s-1URI\s0 of a store containing trusted certificates to use
  541. for verifying client certificates.
  542. .IP "\fB\-chainCAfile\fR \fIfile\fR" 4
  543. .IX Item "-chainCAfile file"
  544. A file in \s-1PEM\s0 format containing trusted certificates to use
  545. when attempting to build the server certificate chain.
  546. .IP "\fB\-chainCApath\fR \fIdir\fR" 4
  547. .IX Item "-chainCApath dir"
  548. A directory containing trusted certificates to use
  549. for building the server certificate chain provided to the client.
  550. This directory must be in \*(L"hash format\*(R",
  551. see \fBopenssl\-verify\fR\|(1) for more information.
  552. .IP "\fB\-chainCAstore\fR \fIuri\fR" 4
  553. .IX Item "-chainCAstore uri"
  554. The \s-1URI\s0 of a store containing trusted certificates to use
  555. for building the server certificate chain provided to the client.
  556. The \s-1URI\s0 may indicate a single certificate, as well as a collection of them.
  557. With URIs in the \f(CW\*(C`file:\*(C'\fR scheme, this acts as \fB\-chainCAfile\fR or
  558. \&\fB\-chainCApath\fR, depending on if the \s-1URI\s0 indicates a directory or a
  559. single file.
  560. See \fBossl_store\-file\fR\|(7) for more information on the \f(CW\*(C`file:\*(C'\fR scheme.
  561. .IP "\fB\-nocert\fR" 4
  562. .IX Item "-nocert"
  563. If this option is set then no certificate is used. This restricts the
  564. cipher suites available to the anonymous ones (currently just anonymous
  565. \&\s-1DH\s0).
  566. .IP "\fB\-quiet\fR" 4
  567. .IX Item "-quiet"
  568. Inhibit printing of session and certificate information.
  569. .IP "\fB\-no_resume_ephemeral\fR" 4
  570. .IX Item "-no_resume_ephemeral"
  571. Disable caching and tickets if ephemeral (\s-1EC\s0)DH is used.
  572. .IP "\fB\-tlsextdebug\fR" 4
  573. .IX Item "-tlsextdebug"
  574. Print a hex dump of any \s-1TLS\s0 extensions received from the server.
  575. .IP "\fB\-www\fR" 4
  576. .IX Item "-www"
  577. Sends a status message back to the client when it connects. This includes
  578. information about the ciphers used and various session parameters.
  579. The output is in \s-1HTML\s0 format so this option can be used with a web browser.
  580. The special \s-1URL\s0 \f(CW\*(C`/renegcert\*(C'\fR turns on client cert validation, and \f(CW\*(C`/reneg\*(C'\fR
  581. tells the server to request renegotiation.
  582. The \fB\-early_data\fR option cannot be used with this option.
  583. .IP "\fB\-WWW\fR, \fB\-HTTP\fR" 4
  584. .IX Item "-WWW, -HTTP"
  585. Emulates a simple web server. Pages will be resolved relative to the
  586. current directory, for example if the \s-1URL\s0 \f(CW\*(C`https://myhost/page.html\*(C'\fR is
  587. requested the file \fI./page.html\fR will be sent.
  588. If the \fB\-HTTP\fR flag is used, the files are sent directly, and should contain
  589. any \s-1HTTP\s0 response headers (including status response line).
  590. If the \fB\-WWW\fR option is used,
  591. the response headers are generated by the server, and the file extension is
  592. examined to determine the \fBContent-Type\fR header.
  593. Extensions of \f(CW\*(C`html\*(C'\fR, \f(CW\*(C`htm\*(C'\fR, and \f(CW\*(C`php\*(C'\fR are \f(CW\*(C`text/html\*(C'\fR and all others are
  594. \&\f(CW\*(C`text/plain\*(C'\fR.
  595. In addition, the special \s-1URL\s0 \f(CW\*(C`/stats\*(C'\fR will return status
  596. information like the \fB\-www\fR option.
  597. Neither of these options can be used in conjunction with \fB\-early_data\fR.
  598. .IP "\fB\-http_server_binmode\fR" 4
  599. .IX Item "-http_server_binmode"
  600. When acting as web-server (using option \fB\-WWW\fR or \fB\-HTTP\fR) open files requested
  601. by the client in binary mode.
  602. .IP "\fB\-no_ca_names\fR" 4
  603. .IX Item "-no_ca_names"
  604. Disable \s-1TLS\s0 Extension \s-1CA\s0 Names. You may want to disable it for security reasons
  605. or for compatibility with some Windows \s-1TLS\s0 implementations crashing when this
  606. extension is larger than 1024 bytes.
  607. .IP "\fB\-ignore_unexpected_eof\fR" 4
  608. .IX Item "-ignore_unexpected_eof"
  609. Some \s-1TLS\s0 implementations do not send the mandatory close_notify alert on
  610. shutdown. If the application tries to wait for the close_notify alert but the
  611. peer closes the connection without sending it, an error is generated. When this
  612. option is enabled the peer does not need to send the close_notify alert and a
  613. closed connection will be treated as if the close_notify alert was received.
  614. For more information on shutting down a connection, see \fBSSL_shutdown\fR\|(3).
  615. .IP "\fB\-servername\fR" 4
  616. .IX Item "-servername"
  617. Servername for HostName \s-1TLS\s0 extension.
  618. .IP "\fB\-servername_fatal\fR" 4
  619. .IX Item "-servername_fatal"
  620. On servername mismatch send fatal alert (default: warning alert).
  621. .IP "\fB\-id_prefix\fR \fIval\fR" 4
  622. .IX Item "-id_prefix val"
  623. Generate \s-1SSL/TLS\s0 session IDs prefixed by \fIval\fR. This is mostly useful
  624. for testing any \s-1SSL/TLS\s0 code (e.g. proxies) that wish to deal with multiple
  625. servers, when each of which might be generating a unique range of session
  626. IDs (e.g. with a certain prefix).
  627. .IP "\fB\-keymatexport\fR" 4
  628. .IX Item "-keymatexport"
  629. Export keying material using label.
  630. .IP "\fB\-keymatexportlen\fR" 4
  631. .IX Item "-keymatexportlen"
  632. Export the given number of bytes of keying material; default 20.
  633. .IP "\fB\-no_cache\fR" 4
  634. .IX Item "-no_cache"
  635. Disable session cache.
  636. .IP "\fB\-ext_cache\fR." 4
  637. .IX Item "-ext_cache."
  638. Disable internal cache, set up and use external cache.
  639. .IP "\fB\-verify_return_error\fR" 4
  640. .IX Item "-verify_return_error"
  641. Verification errors normally just print a message but allow the
  642. connection to continue, for debugging purposes.
  643. If this option is used, then verification errors close the connection.
  644. .IP "\fB\-verify_quiet\fR" 4
  645. .IX Item "-verify_quiet"
  646. No verify output except verify errors.
  647. .IP "\fB\-ign_eof\fR" 4
  648. .IX Item "-ign_eof"
  649. Ignore input \s-1EOF\s0 (default: when \fB\-quiet\fR).
  650. .IP "\fB\-no_ign_eof\fR" 4
  651. .IX Item "-no_ign_eof"
  652. Do not ignore input \s-1EOF.\s0
  653. .IP "\fB\-no_etm\fR" 4
  654. .IX Item "-no_etm"
  655. Disable Encrypt-then-MAC negotiation.
  656. .IP "\fB\-no_ems\fR" 4
  657. .IX Item "-no_ems"
  658. Disable Extended master secret negotiation.
  659. .IP "\fB\-status\fR" 4
  660. .IX Item "-status"
  661. Enables certificate status request support (aka \s-1OCSP\s0 stapling).
  662. .IP "\fB\-status_verbose\fR" 4
  663. .IX Item "-status_verbose"
  664. Enables certificate status request support (aka \s-1OCSP\s0 stapling) and gives
  665. a verbose printout of the \s-1OCSP\s0 response.
  666. Use the \fB\-cert_chain\fR option to specify the certificate of the server's
  667. certificate signer that is required for certificate status requests.
  668. .IP "\fB\-status_timeout\fR \fIint\fR" 4
  669. .IX Item "-status_timeout int"
  670. Sets the timeout for \s-1OCSP\s0 response to \fIint\fR seconds.
  671. .IP "\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path]\fR" 4
  672. .IX Item "-proxy [http[s]://][userinfo@]host[:port][/path]"
  673. The \s-1HTTP\s0(S) proxy server to use for reaching the \s-1OCSP\s0 server unless \fB\-no_proxy\fR
  674. applies, see below.
  675. The proxy port defaults to 80 or 443 if the scheme is \f(CW\*(C`https\*(C'\fR; apart from that
  676. the optional \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`https://\*(C'\fR prefix is ignored,
  677. as well as any userinfo and path components.
  678. Defaults to the environment variable \f(CW\*(C`http_proxy\*(C'\fR if set, else \f(CW\*(C`HTTP_PROXY\*(C'\fR
  679. in case no \s-1TLS\s0 is used, otherwise \f(CW\*(C`https_proxy\*(C'\fR if set, else \f(CW\*(C`HTTPS_PROXY\*(C'\fR.
  680. .IP "\fB\-no_proxy\fR \fIaddresses\fR" 4
  681. .IX Item "-no_proxy addresses"
  682. List of \s-1IP\s0 addresses and/or \s-1DNS\s0 names of servers
  683. not to use an \s-1HTTP\s0(S) proxy for, separated by commas and/or whitespace
  684. (where in the latter case the whole argument must be enclosed in \*(L"...\*(R").
  685. Default is from the environment variable \f(CW\*(C`no_proxy\*(C'\fR if set, else \f(CW\*(C`NO_PROXY\*(C'\fR.
  686. .IP "\fB\-status_url\fR \fIval\fR" 4
  687. .IX Item "-status_url val"
  688. Sets a fallback responder \s-1URL\s0 to use if no responder \s-1URL\s0 is present in the
  689. server certificate. Without this option an error is returned if the server
  690. certificate does not contain a responder address.
  691. The optional userinfo and fragment \s-1URL\s0 components are ignored.
  692. Any given query component is handled as part of the path component.
  693. .IP "\fB\-status_file\fR \fIinfile\fR" 4
  694. .IX Item "-status_file infile"
  695. Overrides any \s-1OCSP\s0 responder URLs from the certificate and always provides the
  696. \&\s-1OCSP\s0 Response stored in the file. The file must be in \s-1DER\s0 format.
  697. .IP "\fB\-ssl_config\fR \fIval\fR" 4
  698. .IX Item "-ssl_config val"
  699. Configure \s-1SSL_CTX\s0 using the given configuration value.
  700. .IP "\fB\-trace\fR" 4
  701. .IX Item "-trace"
  702. Show verbose trace output of protocol messages.
  703. .IP "\fB\-brief\fR" 4
  704. .IX Item "-brief"
  705. Provide a brief summary of connection parameters instead of the normal verbose
  706. output.
  707. .IP "\fB\-rev\fR" 4
  708. .IX Item "-rev"
  709. Simple echo server that sends back received text reversed. Also sets \fB\-brief\fR.
  710. Cannot be used in conjunction with \fB\-early_data\fR.
  711. .IP "\fB\-async\fR" 4
  712. .IX Item "-async"
  713. Switch on asynchronous mode. Cryptographic operations will be performed
  714. asynchronously. This will only have an effect if an asynchronous capable engine
  715. is also used via the \fB\-engine\fR option. For test purposes the dummy async engine
  716. (dasync) can be used (if available).
  717. .IP "\fB\-max_send_frag\fR \fI+int\fR" 4
  718. .IX Item "-max_send_frag +int"
  719. The maximum size of data fragment to send.
  720. See \fBSSL_CTX_set_max_send_fragment\fR\|(3) for further information.
  721. .IP "\fB\-split_send_frag\fR \fI+int\fR" 4
  722. .IX Item "-split_send_frag +int"
  723. The size used to split data for encrypt pipelines. If more data is written in
  724. one go than this value then it will be split into multiple pipelines, up to the
  725. maximum number of pipelines defined by max_pipelines. This only has an effect if
  726. a suitable cipher suite has been negotiated, an engine that supports pipelining
  727. has been loaded, and max_pipelines is greater than 1. See
  728. \&\fBSSL_CTX_set_split_send_fragment\fR\|(3) for further information.
  729. .IP "\fB\-max_pipelines\fR \fI+int\fR" 4
  730. .IX Item "-max_pipelines +int"
  731. The maximum number of encrypt/decrypt pipelines to be used. This will only have
  732. an effect if an engine has been loaded that supports pipelining (e.g. the dasync
  733. engine) and a suitable cipher suite has been negotiated. The default value is 1.
  734. See \fBSSL_CTX_set_max_pipelines\fR\|(3) for further information.
  735. .IP "\fB\-naccept\fR \fI+int\fR" 4
  736. .IX Item "-naccept +int"
  737. The server will exit after receiving the specified number of connections,
  738. default unlimited.
  739. .IP "\fB\-read_buf\fR \fI+int\fR" 4
  740. .IX Item "-read_buf +int"
  741. The default read buffer size to be used for connections. This will only have an
  742. effect if the buffer size is larger than the size that would otherwise be used
  743. and pipelining is in use (see \fBSSL_CTX_set_default_read_buffer_len\fR\|(3) for
  744. further information).
  745. .IP "\fB\-bugs\fR" 4
  746. .IX Item "-bugs"
  747. There are several known bugs in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
  748. option enables various workarounds.
  749. .IP "\fB\-no_tx_cert_comp\fR" 4
  750. .IX Item "-no_tx_cert_comp"
  751. Disables support for sending TLSv1.3 compressed certificates.
  752. .IP "\fB\-no_rx_cert_comp\fR" 4
  753. .IX Item "-no_rx_cert_comp"
  754. Disables support for receiving TLSv1.3 compressed certificates.
  755. .IP "\fB\-no_comp\fR" 4
  756. .IX Item "-no_comp"
  757. Disable negotiation of \s-1TLS\s0 compression.
  758. \&\s-1TLS\s0 compression is not recommended and is off by default as of
  759. OpenSSL 1.1.0.
  760. .IP "\fB\-comp\fR" 4
  761. .IX Item "-comp"
  762. Enables support for \s-1SSL/TLS\s0 compression.
  763. This option was introduced in OpenSSL 1.1.0.
  764. \&\s-1TLS\s0 compression is not recommended and is off by default as of
  765. OpenSSL 1.1.0. \s-1TLS\s0 compression can only be used in security level 1 or
  766. lower. From OpenSSL 3.2.0 and above the default security level is 2, so this
  767. option will have no effect without also changing the security level. Use the
  768. \&\fB\-cipher\fR option to change the security level. See \fBopenssl\-ciphers\fR\|(1) for
  769. more information.
  770. .IP "\fB\-no_ticket\fR" 4
  771. .IX Item "-no_ticket"
  772. Disable RFC4507bis session ticket support. This option has no effect if TLSv1.3
  773. is negotiated. See \fB\-num_tickets\fR.
  774. .IP "\fB\-num_tickets\fR" 4
  775. .IX Item "-num_tickets"
  776. Control the number of tickets that will be sent to the client after a full
  777. handshake in TLSv1.3. The default number of tickets is 2. This option does not
  778. affect the number of tickets sent after a resumption handshake.
  779. .IP "\fB\-serverpref\fR" 4
  780. .IX Item "-serverpref"
  781. Use the server's cipher preferences, rather than the client's preferences.
  782. .IP "\fB\-prioritize_chacha\fR" 4
  783. .IX Item "-prioritize_chacha"
  784. Prioritize ChaCha ciphers when preferred by clients. Requires \fB\-serverpref\fR.
  785. .IP "\fB\-no_resumption_on_reneg\fR" 4
  786. .IX Item "-no_resumption_on_reneg"
  787. Set the \fB\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0\fR option.
  788. .IP "\fB\-client_sigalgs\fR \fIval\fR" 4
  789. .IX Item "-client_sigalgs val"
  790. Signature algorithms to support for client certificate authentication
  791. (colon-separated list).
  792. .IP "\fB\-named_curve\fR \fIval\fR" 4
  793. .IX Item "-named_curve val"
  794. Specifies the elliptic curve to use. \s-1NOTE:\s0 this is single curve, not a list.
  795. .Sp
  796. The list of all supported groups includes named \s-1EC\s0 parameters as well as X25519
  797. and X448 or \s-1FFDHE\s0 groups, and may also include groups implemented in 3rd\-party
  798. providers. For a list of named \s-1EC\s0 parameters, use:
  799. .Sp
  800. .Vb 1
  801. \& $ openssl ecparam \-list_curves
  802. .Ve
  803. .IP "\fB\-cipher\fR \fIval\fR" 4
  804. .IX Item "-cipher val"
  805. This allows the list of TLSv1.2 and below ciphersuites used by the server to be
  806. modified. This list is combined with any TLSv1.3 ciphersuites that have been
  807. configured. When the client sends a list of supported ciphers the first client
  808. cipher also included in the server list is used. Because the client specifies
  809. the preference order, the order of the server cipherlist is irrelevant. See
  810. \&\fBopenssl\-ciphers\fR\|(1) for more information.
  811. .IP "\fB\-ciphersuites\fR \fIval\fR" 4
  812. .IX Item "-ciphersuites val"
  813. This allows the list of TLSv1.3 ciphersuites used by the server to be modified.
  814. This list is combined with any TLSv1.2 and below ciphersuites that have been
  815. configured. When the client sends a list of supported ciphers the first client
  816. cipher also included in the server list is used. Because the client specifies
  817. the preference order, the order of the server cipherlist is irrelevant. See
  818. \&\fBopenssl\-ciphers\fR\|(1) command for more information. The format for this list is
  819. a simple colon (\*(L":\*(R") separated list of TLSv1.3 ciphersuite names.
  820. .IP "\fB\-dhparam\fR \fIinfile\fR" 4
  821. .IX Item "-dhparam infile"
  822. The \s-1DH\s0 parameter file to use. The ephemeral \s-1DH\s0 cipher suites generate keys
  823. using a set of \s-1DH\s0 parameters. If not specified then an attempt is made to
  824. load the parameters from the server certificate file.
  825. If this fails then a static set of parameters hard coded into this command
  826. will be used.
  827. .IP "\fB\-nbio\fR" 4
  828. .IX Item "-nbio"
  829. Turns on non blocking I/O.
  830. .IP "\fB\-timeout\fR" 4
  831. .IX Item "-timeout"
  832. Enable timeouts.
  833. .IP "\fB\-mtu\fR" 4
  834. .IX Item "-mtu"
  835. Set link-layer \s-1MTU.\s0
  836. .IP "\fB\-psk_identity\fR \fIval\fR" 4
  837. .IX Item "-psk_identity val"
  838. Expect the client to send \s-1PSK\s0 identity \fIval\fR when using a \s-1PSK\s0
  839. cipher suite, and warn if they do not. By default, the expected \s-1PSK\s0
  840. identity is the string \*(L"Client_identity\*(R".
  841. .IP "\fB\-psk_hint\fR \fIval\fR" 4
  842. .IX Item "-psk_hint val"
  843. Use the \s-1PSK\s0 identity hint \fIval\fR when using a \s-1PSK\s0 cipher suite.
  844. .IP "\fB\-psk\fR \fIval\fR" 4
  845. .IX Item "-psk val"
  846. Use the \s-1PSK\s0 key \fIval\fR when using a \s-1PSK\s0 cipher suite. The key is
  847. given as a hexadecimal number without leading 0x, for example \-psk
  848. 1a2b3c4d.
  849. This option must be provided in order to use a \s-1PSK\s0 cipher.
  850. .IP "\fB\-psk_session\fR \fIfile\fR" 4
  851. .IX Item "-psk_session file"
  852. Use the pem encoded \s-1SSL_SESSION\s0 data stored in \fIfile\fR as the basis of a \s-1PSK.\s0
  853. Note that this will only work if TLSv1.3 is negotiated.
  854. .IP "\fB\-srpvfile\fR" 4
  855. .IX Item "-srpvfile"
  856. The verifier file for \s-1SRP.\s0
  857. This option is deprecated.
  858. .IP "\fB\-srpuserseed\fR" 4
  859. .IX Item "-srpuserseed"
  860. A seed string for a default user salt.
  861. This option is deprecated.
  862. .IP "\fB\-listen\fR" 4
  863. .IX Item "-listen"
  864. This option can only be used in conjunction with one of the \s-1DTLS\s0 options above.
  865. With this option, this command will listen on a \s-1UDP\s0 port for incoming
  866. connections.
  867. Any ClientHellos that arrive will be checked to see if they have a cookie in
  868. them or not.
  869. Any without a cookie will be responded to with a HelloVerifyRequest.
  870. If a ClientHello with a cookie is received then this command will
  871. connect to that peer and complete the handshake.
  872. .IP "\fB\-sctp\fR" 4
  873. .IX Item "-sctp"
  874. Use \s-1SCTP\s0 for the transport protocol instead of \s-1UDP\s0 in \s-1DTLS.\s0 Must be used in
  875. conjunction with \fB\-dtls\fR, \fB\-dtls1\fR or \fB\-dtls1_2\fR. This option is only
  876. available where OpenSSL has support for \s-1SCTP\s0 enabled.
  877. .IP "\fB\-sctp_label_bug\fR" 4
  878. .IX Item "-sctp_label_bug"
  879. Use the incorrect behaviour of older OpenSSL implementations when computing
  880. endpoint-pair shared secrets for \s-1DTLS/SCTP.\s0 This allows communication with
  881. older broken implementations but breaks interoperability with correct
  882. implementations. Must be used in conjunction with \fB\-sctp\fR. This option is only
  883. available where OpenSSL has support for \s-1SCTP\s0 enabled.
  884. .IP "\fB\-use_srtp\fR" 4
  885. .IX Item "-use_srtp"
  886. Offer \s-1SRTP\s0 key management with a colon-separated profile list.
  887. .IP "\fB\-no_dhe\fR" 4
  888. .IX Item "-no_dhe"
  889. If this option is set then no \s-1DH\s0 parameters will be loaded effectively
  890. disabling the ephemeral \s-1DH\s0 cipher suites.
  891. .IP "\fB\-alpn\fR \fIval\fR, \fB\-nextprotoneg\fR \fIval\fR" 4
  892. .IX Item "-alpn val, -nextprotoneg val"
  893. These flags enable the Application-Layer Protocol Negotiation
  894. or Next Protocol Negotiation (\s-1NPN\s0) extension, respectively. \s-1ALPN\s0 is the
  895. \&\s-1IETF\s0 standard and replaces \s-1NPN.\s0
  896. The \fIval\fR list is a comma-separated list of supported protocol
  897. names. The list should contain the most desirable protocols first.
  898. Protocol names are printable \s-1ASCII\s0 strings, for example \*(L"http/1.1\*(R" or
  899. \&\*(L"spdy/3\*(R".
  900. The flag \fB\-nextprotoneg\fR cannot be specified if \fB\-tls1_3\fR is used.
  901. .IP "\fB\-ktls\fR" 4
  902. .IX Item "-ktls"
  903. Enable Kernel \s-1TLS\s0 for sending and receiving.
  904. This option was introduced in OpenSSL 3.2.0.
  905. Kernel \s-1TLS\s0 is off by default as of OpenSSL 3.2.0.
  906. .IP "\fB\-sendfile\fR" 4
  907. .IX Item "-sendfile"
  908. If this option is set and \s-1KTLS\s0 is enabled, \fBSSL_sendfile()\fR will be used
  909. instead of \fBBIO_write()\fR to send the \s-1HTTP\s0 response requested by a client.
  910. This option is only valid when \fB\-ktls\fR along with \fB\-WWW\fR or \fB\-HTTP\fR
  911. are specified.
  912. .IP "\fB\-zerocopy_sendfile\fR" 4
  913. .IX Item "-zerocopy_sendfile"
  914. If this option is set, \fBSSL_sendfile()\fR will use the zerocopy \s-1TX\s0 mode, which gives
  915. a performance boost when used with \s-1KTLS\s0 hardware offload. Note that invalid
  916. \&\s-1TLS\s0 records might be transmitted if the file is changed while being sent.
  917. This option depends on \fB\-sendfile\fR; when used alone, \fB\-sendfile\fR is implied,
  918. and a warning is shown. Note that \s-1KTLS\s0 sendfile on FreeBSD always runs in the
  919. zerocopy mode.
  920. .IP "\fB\-keylogfile\fR \fIoutfile\fR" 4
  921. .IX Item "-keylogfile outfile"
  922. Appends \s-1TLS\s0 secrets to the specified keylog file such that external programs
  923. (like Wireshark) can decrypt \s-1TLS\s0 connections.
  924. .IP "\fB\-max_early_data\fR \fIint\fR" 4
  925. .IX Item "-max_early_data int"
  926. Change the default maximum early data bytes that are specified for new sessions
  927. and any incoming early data (when used in conjunction with the \fB\-early_data\fR
  928. flag). The default value is approximately 16k. The argument must be an integer
  929. greater than or equal to 0.
  930. .IP "\fB\-recv_max_early_data\fR \fIint\fR" 4
  931. .IX Item "-recv_max_early_data int"
  932. Specify the hard limit on the maximum number of early data bytes that will
  933. be accepted.
  934. .IP "\fB\-early_data\fR" 4
  935. .IX Item "-early_data"
  936. Accept early data where possible. Cannot be used in conjunction with \fB\-www\fR,
  937. \&\fB\-WWW\fR, \fB\-HTTP\fR or \fB\-rev\fR.
  938. .IP "\fB\-stateless\fR" 4
  939. .IX Item "-stateless"
  940. Require TLSv1.3 cookies.
  941. .IP "\fB\-anti_replay\fR, \fB\-no_anti_replay\fR" 4
  942. .IX Item "-anti_replay, -no_anti_replay"
  943. Switches replay protection on or off, respectively. Replay protection is on by
  944. default unless overridden by a configuration file. When it is on, OpenSSL will
  945. automatically detect if a session ticket has been used more than once, TLSv1.3
  946. has been negotiated, and early data is enabled on the server. A full handshake
  947. is forced if a session ticket is used a second or subsequent time. Any early
  948. data that was sent will be rejected.
  949. .IP "\fB\-tfo\fR" 4
  950. .IX Item "-tfo"
  951. Enable acceptance of \s-1TCP\s0 Fast Open (\s-1RFC7413\s0) connections.
  952. .IP "\fB\-cert_comp\fR" 4
  953. .IX Item "-cert_comp"
  954. Pre-compresses certificates (\s-1RFC8879\s0) that will be sent during the handshake.
  955. .IP "\fB\-nameopt\fR \fIoption\fR" 4
  956. .IX Item "-nameopt option"
  957. This specifies how the subject or issuer names are displayed.
  958. See \fBopenssl\-namedisplay\-options\fR\|(1) for details.
  959. .IP "\fB\-no_ssl3\fR, \fB\-no_tls1\fR, \fB\-no_tls1_1\fR, \fB\-no_tls1_2\fR, \fB\-no_tls1_3\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-tls1_1\fR, \fB\-tls1_2\fR, \fB\-tls1_3\fR" 4
  960. .IX Item "-no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3, -ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3"
  961. See \*(L"\s-1TLS\s0 Version Options\*(R" in \fBopenssl\fR\|(1).
  962. .IP "\fB\-dtls\fR, \fB\-dtls1\fR, \fB\-dtls1_2\fR" 4
  963. .IX Item "-dtls, -dtls1, -dtls1_2"
  964. These specify the use of \s-1DTLS\s0 instead of \s-1TLS.\s0
  965. See \*(L"\s-1TLS\s0 Version Options\*(R" in \fBopenssl\fR\|(1).
  966. .IP "\fB\-bugs\fR, \fB\-comp\fR, \fB\-no_comp\fR, \fB\-no_ticket\fR, \fB\-serverpref\fR, \fB\-client_renegotiation\fR, \fB\-legacy_renegotiation\fR, \fB\-no_renegotiation\fR, \fB\-no_resumption_on_reneg\fR, \fB\-legacy_server_connect\fR, \fB\-no_legacy_server_connect\fR, \fB\-no_etm\fR \fB\-allow_no_dhe_kex\fR, \fB\-prefer_no_dhe_kex\fR, \fB\-prioritize_chacha\fR, \fB\-strict\fR, \fB\-sigalgs\fR \fIalgs\fR, \fB\-client_sigalgs\fR \fIalgs\fR, \fB\-groups\fR \fIgroups\fR, \fB\-curves\fR \fIcurves\fR, \fB\-named_curve\fR \fIcurve\fR, \fB\-cipher\fR \fIciphers\fR, \fB\-ciphersuites\fR \fI1.3ciphers\fR, \fB\-min_protocol\fR \fIminprot\fR, \fB\-max_protocol\fR \fImaxprot\fR, \fB\-record_padding\fR \fIpadding\fR, \fB\-debug_broken_protocol\fR, \fB\-no_middlebox\fR" 4
  967. .IX Item "-bugs, -comp, -no_comp, -no_ticket, -serverpref, -client_renegotiation, -legacy_renegotiation, -no_renegotiation, -no_resumption_on_reneg, -legacy_server_connect, -no_legacy_server_connect, -no_etm -allow_no_dhe_kex, -prefer_no_dhe_kex, -prioritize_chacha, -strict, -sigalgs algs, -client_sigalgs algs, -groups groups, -curves curves, -named_curve curve, -cipher ciphers, -ciphersuites 1.3ciphers, -min_protocol minprot, -max_protocol maxprot, -record_padding padding, -debug_broken_protocol, -no_middlebox"
  968. See \*(L"\s-1SUPPORTED COMMAND LINE COMMANDS\*(R"\s0 in \fBSSL_CONF_cmd\fR\|(3) for details.
  969. .IP "\fB\-xkey\fR \fIinfile\fR, \fB\-xcert\fR \fIfile\fR, \fB\-xchain\fR \fIfile\fR, \fB\-xchain_build\fR \fIfile\fR, \fB\-xcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR, \fB\-xkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  970. .IX Item "-xkey infile, -xcert file, -xchain file, -xchain_build file, -xcertform DER|PEM, -xkeyform DER|PEM"
  971. Set extended certificate verification options.
  972. See \*(L"Extended Verification Options\*(R" in \fBopenssl\-verification\-options\fR\|(1) for details.
  973. .IP "\fB\-CAfile\fR \fIfile\fR, \fB\-no\-CAfile\fR, \fB\-CApath\fR \fIdir\fR, \fB\-no\-CApath\fR, \fB\-CAstore\fR \fIuri\fR, \fB\-no\-CAstore\fR" 4
  974. .IX Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore"
  975. See \*(L"Trusted Certificate Options\*(R" in \fBopenssl\-verification\-options\fR\|(1) for details.
  976. .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
  977. .IX Item "-rand files, -writerand file"
  978. See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details.
  979. .IP "\fB\-engine\fR \fIid\fR" 4
  980. .IX Item "-engine id"
  981. See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1).
  982. This option is deprecated.
  983. .IP "\fB\-provider\fR \fIname\fR" 4
  984. .IX Item "-provider name"
  985. .PD 0
  986. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  987. .IX Item "-provider-path path"
  988. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  989. .IX Item "-propquery propq"
  990. .PD
  991. See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  992. .IP "\fB\-allow_proxy_certs\fR, \fB\-attime\fR, \fB\-no_check_time\fR, \fB\-check_ss_sig\fR, \fB\-crl_check\fR, \fB\-crl_check_all\fR, \fB\-explicit_policy\fR, \fB\-extended_crl\fR, \fB\-ignore_critical\fR, \fB\-inhibit_any\fR, \fB\-inhibit_map\fR, \fB\-no_alt_chains\fR, \fB\-partial_chain\fR, \fB\-policy\fR, \fB\-policy_check\fR, \fB\-policy_print\fR, \fB\-purpose\fR, \fB\-suiteB_128\fR, \fB\-suiteB_128_only\fR, \fB\-suiteB_192\fR, \fB\-trusted_first\fR, \fB\-use_deltas\fR, \fB\-auth_level\fR, \fB\-verify_depth\fR, \fB\-verify_email\fR, \fB\-verify_hostname\fR, \fB\-verify_ip\fR, \fB\-verify_name\fR, \fB\-x509_strict\fR \fB\-issuer_checks\fR" 4
  993. .IX Item "-allow_proxy_certs, -attime, -no_check_time, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -partial_chain, -policy, -policy_check, -policy_print, -purpose, -suiteB_128, -suiteB_128_only, -suiteB_192, -trusted_first, -use_deltas, -auth_level, -verify_depth, -verify_email, -verify_hostname, -verify_ip, -verify_name, -x509_strict -issuer_checks"
  994. Set various options of certificate chain verification.
  995. See \*(L"Verification Options\*(R" in \fBopenssl\-verification\-options\fR\|(1) for details.
  996. .Sp
  997. If the server requests a client certificate, then
  998. verification errors are displayed, for debugging, but the command will
  999. proceed unless the \fB\-verify_return_error\fR option is used.
  1000. .IP "\fB\-enable_server_rpk\fR" 4
  1001. .IX Item "-enable_server_rpk"
  1002. Enable support for sending raw public keys (\s-1RFC7250\s0) to the client.
  1003. A raw public key will be sent by the server, if solicited by the client,
  1004. provided a suitable key and public certificate pair is configured.
  1005. Clients that don't support raw public keys or prefer to use X.509
  1006. certificates can still elect to receive X.509 certificates as usual.
  1007. .Sp
  1008. Raw public keys are extracted from the configured certificate/private key.
  1009. .IP "\fB\-enable_client_rpk\fR" 4
  1010. .IX Item "-enable_client_rpk"
  1011. Enable support for receiving raw public keys (\s-1RFC7250\s0) from the client.
  1012. Use of X.509 certificates by the client becomes optional, and clients that
  1013. support raw public keys may elect to use them.
  1014. Clients that don't support raw public keys or prefer to use X.509
  1015. certificates can still elect to send X.509 certificates as usual.
  1016. .Sp
  1017. Raw public keys are extracted from the configured certificate/private key.
  1018. .SH "CONNECTED COMMANDS"
  1019. .IX Header "CONNECTED COMMANDS"
  1020. If a connection request is established with an \s-1SSL\s0 client and neither the
  1021. \&\fB\-www\fR nor the \fB\-WWW\fR option has been used then normally any data received
  1022. from the client is displayed and any key presses will be sent to the client.
  1023. .PP
  1024. Certain commands are also recognized which perform special operations. These
  1025. commands are a letter which must appear at the start of a line. They are listed
  1026. below.
  1027. .IP "\fBq\fR" 4
  1028. .IX Item "q"
  1029. End the current \s-1SSL\s0 connection but still accept new connections.
  1030. .IP "\fBQ\fR" 4
  1031. .IX Item "Q"
  1032. End the current \s-1SSL\s0 connection and exit.
  1033. .IP "\fBr\fR" 4
  1034. .IX Item "r"
  1035. Renegotiate the \s-1SSL\s0 session (TLSv1.2 and below only).
  1036. .IP "\fBR\fR" 4
  1037. .IX Item "R"
  1038. Renegotiate the \s-1SSL\s0 session and request a client certificate (TLSv1.2 and below
  1039. only).
  1040. .IP "\fBP\fR" 4
  1041. .IX Item "P"
  1042. Send some plain text down the underlying \s-1TCP\s0 connection: this should
  1043. cause the client to disconnect due to a protocol violation.
  1044. .IP "\fBS\fR" 4
  1045. .IX Item "S"
  1046. Print out some session cache status information.
  1047. .IP "\fBk\fR" 4
  1048. .IX Item "k"
  1049. Send a key update message to the client (TLSv1.3 only)
  1050. .IP "\fBK\fR" 4
  1051. .IX Item "K"
  1052. Send a key update message to the client and request one back (TLSv1.3 only)
  1053. .IP "\fBc\fR" 4
  1054. .IX Item "c"
  1055. Send a certificate request to the client (TLSv1.3 only)
  1056. .SH "NOTES"
  1057. .IX Header "NOTES"
  1058. This command can be used to debug \s-1SSL\s0 clients. To accept connections
  1059. from a web browser the command:
  1060. .PP
  1061. .Vb 1
  1062. \& openssl s_server \-accept 443 \-www
  1063. .Ve
  1064. .PP
  1065. can be used for example.
  1066. .PP
  1067. Although specifying an empty list of CAs when requesting a client certificate
  1068. is strictly speaking a protocol violation, some \s-1SSL\s0 clients interpret this to
  1069. mean any \s-1CA\s0 is acceptable. This is useful for debugging purposes.
  1070. .PP
  1071. The session parameters can printed out using the \fBopenssl\-sess_id\fR\|(1) command.
  1072. .SH "BUGS"
  1073. .IX Header "BUGS"
  1074. Because this program has a lot of options and also because some of the
  1075. techniques used are rather old, the C source for this command is rather
  1076. hard to read and not a model of how things should be done.
  1077. A typical \s-1SSL\s0 server program would be much simpler.
  1078. .PP
  1079. The output of common ciphers is wrong: it just gives the list of ciphers that
  1080. OpenSSL recognizes and the client supports.
  1081. .PP
  1082. There should be a way for this command to print out details
  1083. of any unknown cipher suites a client says it supports.
  1084. .SH "SEE ALSO"
  1085. .IX Header "SEE ALSO"
  1086. \&\fBopenssl\fR\|(1),
  1087. \&\fBopenssl\-sess_id\fR\|(1),
  1088. \&\fBopenssl\-s_client\fR\|(1),
  1089. \&\fBopenssl\-ciphers\fR\|(1),
  1090. \&\fBSSL_CONF_cmd\fR\|(3),
  1091. \&\fBSSL_CTX_set_max_send_fragment\fR\|(3),
  1092. \&\fBSSL_CTX_set_split_send_fragment\fR\|(3),
  1093. \&\fBSSL_CTX_set_max_pipelines\fR\|(3),
  1094. \&\fBossl_store\-file\fR\|(7)
  1095. .SH "HISTORY"
  1096. .IX Header "HISTORY"
  1097. The \-no_alt_chains option was added in OpenSSL 1.1.0.
  1098. .PP
  1099. The
  1100. \&\-allow\-no\-dhe\-kex and \-prioritize_chacha options were added in OpenSSL 1.1.1.
  1101. .PP
  1102. The \fB\-srpvfile\fR, \fB\-srpuserseed\fR, and \fB\-engine\fR
  1103. option were deprecated in OpenSSL 3.0.
  1104. .PP
  1105. The
  1106. \&\fB\-enable_client_rpk\fR,
  1107. \&\fB\-enable_server_rpk\fR,
  1108. \&\fB\-no_rx_cert_comp\fR,
  1109. \&\fB\-no_tx_cert_comp\fR,
  1110. and \fB\-tfo\fR
  1111. options were added in OpenSSL 3.2.
  1112. .SH "COPYRIGHT"
  1113. .IX Header "COPYRIGHT"
  1114. Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
  1115. .PP
  1116. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  1117. this file except in compliance with the License. You can obtain a copy
  1118. in the file \s-1LICENSE\s0 in the source distribution or at
  1119. <https://www.openssl.org/source/license.html>.