| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "SSL_CTX_SET_DOMAIN_FLAGS 3SSL" |
| 58 |
.TH SSL_CTX_SET_DOMAIN_FLAGS 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
SSL_CTX_set_domain_flags, SSL_CTX_get_domain_flags, SSL_get_domain_flags, |
| 65 |
SSL_DOMAIN_FLAG_SINGLE_THREAD, |
| 66 |
SSL_DOMAIN_FLAG_MULTI_THREAD, |
| 67 |
SSL_DOMAIN_FLAG_THREAD_ASSISTED, |
| 68 |
SSL_DOMAIN_FLAG_BLOCKING, |
| 69 |
SSL_DOMAIN_FLAG_LEGACY_BLOCKING |
| 70 |
\&\- control the concurrency model used by a QUIC domain |
| 71 |
.SH SYNOPSIS |
| 72 |
.IX Header "SYNOPSIS" |
| 73 |
.Vb 1 |
| 74 |
\& #include <openssl/ssl.h> |
| 75 |
\& |
| 76 |
\& #define SSL_DOMAIN_FLAG_SINGLE_THREAD |
| 77 |
\& #define SSL_DOMAIN_FLAG_MULTI_THREAD |
| 78 |
\& #define SSL_DOMAIN_FLAG_LEGACY_BLOCKING |
| 79 |
\& #define SSL_DOMAIN_FLAG_BLOCKING |
| 80 |
\& #define SSL_DOMAIN_FLAG_THREAD_ASSISTED |
| 81 |
\& |
| 82 |
\& int SSL_CTX_set_domain_flags(SSL_CTX *ctx, uint64_t flags); |
| 83 |
\& int SSL_CTX_get_domain_flags(SSL_CTX *ctx, uint64_t *flags); |
| 84 |
\& |
| 85 |
\& int SSL_get_domain_flags(SSL *ssl, uint64_t *flags); |
| 86 |
.Ve |
| 87 |
.SH DESCRIPTION |
| 88 |
.IX Header "DESCRIPTION" |
| 89 |
\&\fBSSL_CTX_set_domain_flags()\fR and \fBSSL_CTX_get_domain_flags()\fR set and get the QUIC |
| 90 |
domain flags on a \fBSSL_CTX\fR using a QUIC \fBSSL_METHOD\fR. These flags determine |
| 91 |
the concurrency model which is used for a QUIC domain. A detailed introduction |
| 92 |
to these concepts can be found in \fBopenssl\-quic\-concurrency\fR\|(7). |
| 93 |
.PP |
| 94 |
Applications may use either one the flags here: |
| 95 |
.IP \fBSSL_DOMAIN_FLAG_SINGLE_THREAD\fR 4 |
| 96 |
.IX Item "SSL_DOMAIN_FLAG_SINGLE_THREAD" |
| 97 |
Specifying this flag configures the Single-Threaded Concurrency Model (SCM). |
| 98 |
.IP \fBSSL_DOMAIN_FLAG_MULTI_THREAD\fR 4 |
| 99 |
.IX Item "SSL_DOMAIN_FLAG_MULTI_THREAD" |
| 100 |
Specifying this flag configures the Contentive Concurrency Model (CCM) (unless |
| 101 |
\&\fBSSL_DOMAIN_FLAG_THREAD_ASSISTED\fR is also specified). |
| 102 |
.Sp |
| 103 |
If OpenSSL was built without thread support, this is identical to |
| 104 |
\&\fBSSL_DOMAIN_FLAG_SINGLE_THREAD\fR. |
| 105 |
.IP \fBSSL_DOMAIN_FLAG_THREAD_ASSISTED\fR 4 |
| 106 |
.IX Item "SSL_DOMAIN_FLAG_THREAD_ASSISTED" |
| 107 |
Specifying this flag configures the Thread-Assisted Concurrency Model (TACM). |
| 108 |
It implies \fBSSL_DOMAIN_FLAG_MULTI_THREAD\fR and \fBSSL_DOMAIN_FLAG_BLOCKING\fR. |
| 109 |
.Sp |
| 110 |
This concurrency model is not available if OpenSSL was built without thread |
| 111 |
support, in which case attempting to configure it will result in an error. |
| 112 |
.IP \fBSSL_DOMAIN_FLAG_BLOCKING\fR 4 |
| 113 |
.IX Item "SSL_DOMAIN_FLAG_BLOCKING" |
| 114 |
Enable reliable support for blocking I/O calls, allocating whatever OS resources |
| 115 |
are necessary to realise this. If this flag is specified, |
| 116 |
\&\fBSSL_DOMAIN_FLAG_LEGACY_BLOCKING\fR is ignored. |
| 117 |
.IP \fBSSL_DOMAIN_FLAG_LEGACY_BLOCKING\fR 4 |
| 118 |
.IX Item "SSL_DOMAIN_FLAG_LEGACY_BLOCKING" |
| 119 |
Enables legacy blocking compatibility mode. See |
| 120 |
"Legacy Blocking Support Compatibility" in \fBopenssl\-quic\-concurrency\fR\|(7). |
| 121 |
.PP |
| 122 |
Mutually exclusive flag combinations result in an error (for example, combining |
| 123 |
\&\fBSSL_DOMAIN_FLAG_SINGLE_THREAD\fR and \fBSSL_DOMAIN_FLAG_MULTI_THREADED\fR). |
| 124 |
.PP |
| 125 |
Because exactly one concurrency model must be chosen, the domain flags cannot be |
| 126 |
set to 0 and attempting to do so will result in an error. |
| 127 |
.PP |
| 128 |
Changing these flags using \fBSSL_CTX_set_domain_flags()\fR has no effect on QUIC |
| 129 |
domains which have already been created. |
| 130 |
.PP |
| 131 |
The default set of domain flags set on a newly created \fBSSL_CTX\fR may vary by |
| 132 |
OpenSSL version, chosen \fBSSL_METHOD\fR, and operating environment. See |
| 133 |
\&\fBopenssl\-quic\-concurrency\fR\|(7) for details. An application can retrieve the |
| 134 |
default domain flags by calling \fBSSL_CTX_get_domain_flags()\fR immediately after |
| 135 |
constructing a \fBSSL_CTX\fR. |
| 136 |
.PP |
| 137 |
\&\fBSSL_get_domain_flags()\fR retrieves the domain flags which are effective for a QUIC |
| 138 |
domain when called on any QUIC SSL object under that domain. |
| 139 |
.SH "RETURN VALUES" |
| 140 |
.IX Header "RETURN VALUES" |
| 141 |
\&\fBSSL_CTX_set_domain_flags()\fR, \fBSSL_CTX_get_domain_flags()\fR and |
| 142 |
\&\fBSSL_get_domain_flags()\fR return 1 on success and 0 on failure. |
| 143 |
.PP |
| 144 |
\&\fBSSL_CTX_set_domain_flags()\fR fails if called with a set of flags which are |
| 145 |
inconsistent or which cannot be supported given the current environment. |
| 146 |
.PP |
| 147 |
\&\fBSSL_CTX_set_domain_flags()\fR and \fBSSL_CTX_get_domain_flags()\fR fail if called on a |
| 148 |
\&\fBSSL_CTX\fR which is not using a QUIC \fBSSL_METHOD\fR. |
| 149 |
.PP |
| 150 |
\&\fBSSL_get_domain_flags()\fR fails if called on a non-QUIC SSL object. |
| 151 |
.SH "SEE ALSO" |
| 152 |
.IX Header "SEE ALSO" |
| 153 |
\&\fBSSL_new_domain\fR\|(3), \fBopenssl\-quic\-concurrency\fR\|(7) |
| 154 |
.SH HISTORY |
| 155 |
.IX Header "HISTORY" |
| 156 |
These functions were added in OpenSSL 3.5. |
| 157 |
.SH COPYRIGHT |
| 158 |
.IX Header "COPYRIGHT" |
| 159 |
Copyright 2024\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 160 |
.PP |
| 161 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 162 |
this file except in compliance with the License. You can obtain a copy |
| 163 |
in the file LICENSE in the source distribution or at |
| 164 |
<https://www.openssl.org/source/license.html>. |