SSL_CTX_SET_OPTIONS(3ossl)

πŸ“¦
version 15.1 Β· 3 versions
, in freebsd 15.1

πŸ’– NAME πŸ’–

okay so this is the manual page for SSL_CTX_SET_OPTIONS(3ossl) from OpenSSL, and it's literally all about manipulating SSL options, bestie. The whole squad is:

  • SSL_CTX_set_options
  • SSL_set_options
  • SSL_CTX_clear_options
  • SSL_clear_options
  • SSL_CTX_get_options
  • SSL_get_options
  • SSL_get_secure_renegotiation_support

🌸 SYNOPSIS 🌸

#include <openssl/ssl.h>

uint64_t SSL_CTX_set_options(SSL_CTX *ctx, uint64_t options);
uint64_t SSL_set_options(SSL *ssl, uint64_t options);

uint64_t SSL_CTX_clear_options(SSL_CTX *ctx, uint64_t options);
uint64_t SSL_clear_options(SSL *ssl, uint64_t options);

uint64_t SSL_CTX_get_options(const SSL_CTX *ctx);
uint64_t SSL_get_options(const SSL *ssl);

long SSL_get_secure_renegotiation_support(SSL *ssl);

🫢 DESCRIPTION 🫢

  • SSL_CTX_set_options() β€” bestie, this one adds the options set via the bit-mask in options to ctx. ctx MUST NOT be NULL. And no cap: options already set before are not cleared!
  • SSL_set_options() β€” same energy, but for ssl: it adds the options set via the bit-mask in options to ssl. Options already set before are not cleared!
  • SSL_CTX_clear_options() β€” clears the options set via the bit-mask in options on ctx, bestie.
  • SSL_clear_options() β€” clears the options set via the bit-mask in options on ssl.
  • SSL_CTX_get_options() β€” returns the options set for ctx. iconic little getter.
  • SSL_get_options() β€” returns the options set for ssl.
  • SSL_get_secure_renegotiation_support() β€” indicates whether the peer supports secure renegotiation. Note: this is implemented via a macro, iykyk.

✨ NOTES ✨

The behaviour of the SSL library can be changed by setting several options. The options are coded as bit-masks and can be combined by a bitwise or operation (|). slay.

SSL_CTX_set_options() and SSL_set_options() affect the (external) protocol behaviour of the SSL library. The (internal) behaviour of the API can be changed by using the similar SSL_CTX_set_mode(3) and SSL_set_mode() functions.

During a handshake, the option settings of the SSL object are used. When a new SSL object is created from a context using SSL_new(), the current option setting is copied. Changes to ctx do not affect already created SSL objects. SSL_clear() does not affect the settings. periodt.

πŸ› bug workaround options πŸ›

The following bug workaround options are available:

  • SSL_OP_CRYPTOPRO_TLSEXT_BUG β€” add server-hello extension from the early version of cryptopro draft when GOST ciphersuite is negotiated. Required for interoperability with CryptoPro CSP 3.x.
  • SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS β€” disables a countermeasure against an SSL 3.0/TLS 1.0 protocol vulnerability affecting CBC ciphers, which cannot be handled by some broken SSL implementations. This option has no effect for connections using other ciphers.
  • SSL_OP_SAFARI_ECDHE_ECDSA_BUG β€” don't prefer ECDHE-ECDSA ciphers when the client appears to be Safari on OS X. OS X 10.8..10.8.3 has broken support for ECDHE-ECDSA ciphers. classic.
  • SSL_OP_TLSEXT_PADDING β€” adds a padding extension to ensure the ClientHello size is never between 256 and 511 bytes in length. This is needed as a workaround for some implementations.
  • SSL_OP_ALL β€” all of the above bug workarounds. The whole bundle, bestie.

It is usually safe to use SSL_OP_ALL to enable the bug workaround options if compatibility with somewhat broken implementations is desired.

πŸ› οΈ modifying options πŸ› οΈ

The following modifying options are available:

  • SSL_OP_ALLOW_CLIENT_RENEGOTIATION β€” client-initiated renegotiation is disabled by default. Use this option to enable it.
  • SSL_OP_ALLOW_NO_DHE_KEX β€” in TLSv1.3 allow a non-(ec)dhe based key exchange mode on resumption. This means that there will be no forward secrecy for the resumed session. noted.
  • SSL_OP_PREFER_NO_DHE_KEX β€” in TLSv1.3, on resumption let the server prefer a non-(ec)dhe based key exchange mode over an (ec)dhe based one. Ignored without SSL_OP_ALLOW_NO_DHE_KEX being set as well. Always ignored on the client.
  • SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION β€” allow legacy insecure renegotiation between OpenSSL and unpatched clients or servers. See the SECURE RENEGOTIATION section for more details.
⚠️ this one literally says unsafe and legacy, bestie. Don't just vibe with it.
  • SSL_OP_CIPHER_SERVER_PREFERENCE β€” when choosing a cipher, use the server's preferences instead of the client preferences. When not set, the SSL server will always follow the client's preferences. When set, the SSL/TLS server will choose following its own preferences.
  • SSL_OP_CISCO_ANYCONNECT β€” use Cisco's version identifier of DTLS_BAD_VER when establishing a DTLSv1 connection. Only available when using the deprecated DTLSv1_client_method() API.
⚠️ that API is deprecated. Just so we're clear.
  • SSL_OP_CLEANSE_PLAINTEXT β€” by default TLS and QUIC SSL objects keep a copy of received plaintext application data in a static buffer until it is overwritten by the next portion of data. When enabling SSL_OP_CLEANSE_PLAINTEXT deciphered application data is cleansed by calling OPENSSL_cleanse(3) after passing data to the application. Data is also cleansed when releasing the connection (e.g., SSL_free(3)).

Since OpenSSL only cleanses internal buffers, the application is still responsible for cleansing all other buffers. Most notably, this applies to buffers passed to functions like SSL_read(3), SSL_peek(3) but also like SSL_write(3).

TLS connections do not buffer data to be sent in plaintext. QUIC stream objects do buffer plaintext data to be sent and this option will also cause that data to be cleansed when it is discarded.

This option can be set differently on individual QUIC stream objects and has no effect on QUIC connection objects (except where a default stream is being used).

  • SSL_OP_COOKIE_EXCHANGE β€” turn on Cookie Exchange as described in RFC4347 Section 4.2.1. Only affects DTLS connections.
  • SSL_OP_DISABLE_TLSEXT_CA_NAMES β€” disable TLS Extension CA Names. You may want to disable it for security reasons or for compatibility with some Windows TLS implementations crashing when this extension is larger than 1024 bytes.
  • SSL_OP_ENABLE_KTLS β€” enable the use of kernel TLS. In order to benefit from kernel TLS OpenSSL must have been compiled with support for it, and it must be supported by the negotiated ciphersuites and extensions. The specific ciphersuites and extensions that are supported may vary by platform and kernel version.

The kernel TLS data-path implements the record layer, and the encryption algorithm. The kernel will utilize the best hardware available for encryption. Using the kernel data-path should reduce the memory footprint of OpenSSL because no buffering is required. Also, the throughput should improve because data copy is avoided when user data is encrypted into kernel memory instead of the usual encrypt then copy to kernel.

Kernel TLS might not support all the features of OpenSSL. For instance, renegotiation, and setting the maximum fragment size is not possible as of Linux 4.20.

Note that with kernel TLS enabled some cryptographic operations are performed by the kernel directly and not via any available OpenSSL Providers. This might be undesirable if, for example, the application requires all cryptographic operations to be performed by the FIPS provider.

  • SSL_OP_ENABLE_KTLS_TX_ZEROCOPY_SENDFILE β€” with this option, sendfile() will use the zerocopy mode, which gives a performance boost when used with KTLS hardware offload. Note that invalid TLS records might be transmitted if the file is changed while being sent. This option has no effect if SSL_OP_ENABLE_KTLS is not enabled.

This option only applies to Linux. KTLS sendfile on FreeBSD doesn't offer an option to disable zerocopy and always runs in this mode.

⚠️ invalid TLS records might be transmitted if the file changes while it's being sent. read that twice.
  • SSL_OP_ENABLE_MIDDLEBOX_COMPAT β€” if set then dummy Change Cipher Spec (CCS) messages are sent in TLSv1.3. This has the effect of making TLSv1.3 look more like TLSv1.2 so that middleboxes that do not understand TLSv1.3 will not drop the connection. Regardless of whether this option is set or not CCS messages received from the peer will always be ignored in TLSv1.3. This option is set by default. To switch it off use SSL_clear_options(). A future version of OpenSSL may not set this by default.
  • SSL_OP_IGNORE_UNEXPECTED_EOF β€” some TLS implementations do not send the mandatory close_notify alert on shutdown. If the application tries to wait for the close_notify alert but the peer closes the connection without sending it, an error is generated. When this option is enabled the peer does not need to send the close_notify alert and a closed connection will be treated as if the close_notify alert was received.

You should only enable this option if the protocol running over TLS can detect a truncation attack itself, and that the application is checking for that truncation attack.

For more information on shutting down a connection, see SSL_shutdown(3).

⚠️ only enable this if your protocol can detect truncation attacks itself and your app is checking for that. no cap.
  • SSL_OP_LEGACY_SERVER_CONNECT β€” allow legacy insecure renegotiation between OpenSSL and unpatched servers only. See the SECURE RENEGOTIATION section for more details.
  • SSL_OP_NO_ANTI_REPLAY β€” by default, when a server is configured for early data (i.e., max_early_data > 0), OpenSSL will switch on replay protection. See SSL_read_early_data(3) for a description of the replay protection feature. Anti-replay measures are required to comply with the TLSv1.3 specification. Some applications may be able to mitigate the replay risks in other ways and in such cases the built in OpenSSL functionality is not required. Those applications can turn this feature off by setting this option. This is a server-side option only. It is ignored by clients.
  • SSL_OP_NO_TX_CERTIFICATE_COMPRESSION β€” normally clients and servers will transparently attempt to negotiate the RFC8879 certificate compression option on TLSv1.3 connections.

If this option is set, the certificate compression extension is ignored upon receipt and compressed certificates will not be sent to the peer.

  • SSL_OP_NO_RX_CERTIFICATE_COMPRESSION β€” normally clients and servers will transparently attempt to negotiate the RFC8879 certificate compression option on TLSv1.3 connections.

If this option is set, the certificate compression extension will not be sent and compressed certificates will not be accepted from the peer.

  • SSL_OP_NO_COMPRESSION β€” bestie, do not use TLS record compression, even if the peer's out here offering it like it's a gift. 🎁 This one is on by default, so the vibe is already "no thanks". Want to switch it off anyway? Call SSL_clear_options(). Two things tho: TLS record compression is not recommended, and it's literally not available at security level 2 or above. And since OpenSSL 3.2 the default security level is 2 β€” so clearing this option does absolutely nothing unless you also change the default security level. Go read SSL_CTX_set_security_level(3), iykyk. πŸ“š
  • SSL_OP_NO_ENCRYPT_THEN_MAC β€” normally, clients and servers will transparently attempt to negotiate the RFC7366 Encrypt-then-MAC option on TLS and DTLS connections. Cute, right? But if you set this flag, Encrypt-then-MAC is disabled β€” clients won't propose it, and servers won't accept the extension. Shut down. πŸ’€
  • SSL_OP_NO_EXTENDED_MASTER_SECRET β€” same energy, different RFC. Normally clients and servers transparently attempt to negotiate the RFC7627 Extended Master Secret option on TLS and DTLS connections. Set this and Extended Master Secret is disabled β€” clients won't propose it, servers won't accept the extension. 🚫
  • SSL_OP_NO_QUERY_MTU β€” do not query the MTU. That's it. That's the whole thing. Only affects DTLS connections. πŸ¦‹
  • SSL_OP_NO_RENEGOTIATION β€” disable all renegotiation in (D)TLSv1.2 and earlier. No HelloRequest messages get sent, and renegotiation requests arriving via ClientHello get straight-up ignored. πŸ™ˆ
  • SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION β€” when you're doing renegotiation as a server, always start a fresh new session (meaning session resumption requests are only accepted in the initial handshake). Clients do not need this option β€” it's a server-side main character moment only. πŸ‘‘
  • SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1, SSL_OP_NO_TLSv1_2, SSL_OP_NO_TLSv1_3, SSL_OP_NO_DTLSv1, SSL_OP_NO_DTLSv1_2 β€” these turn off the SSLv3, TLSv1, TLSv1.1, TLSv1.2 or TLSv1.3 protocol versions with TLS, or the DTLSv1 and DTLSv1.2 versions with DTLS, respectively. ✨ But β€” as of OpenSSL 1.1.0 these options are deprecated. Use SSL_CTX_set_min_proto_version(3) and SSL_CTX_set_max_proto_version(3) instead. We've moved on, glow up complete. πŸ’…
  • SSL_OP_NO_TICKET β€” okay so this one needs a whole storytime because there are two mechanisms for resuming sessions in SSL/TLS: session ids and stateless session tickets. 🎟️

With session ids, a copy of the session information is cached on the server and a unique id is sent to the client. When the client wants to resume, it hands back that unique id so the server can retrieve the session info from its cache. Classic. Solid. 🫢

With stateless session tickets, the server uses a session ticket encryption key to encrypt the session information, and that encrypted data gets sent to the client as a "ticket". When the client wants to resume, it sends the encrypted data right back to the server. The server uses its key to decrypt it and resume the session. This way the server can operate statelessly β€” no session information needs to be cached locally at all. No cap, it's giving minimalism. 🧚

Now, TLSv1.3 only supports tickets and does not directly support session ids. BUT OpenSSL allows two modes of ticket operation in TLSv1.3: stateful and stateless. Stateless tickets work the same way as in TLSv1.2 and below. Stateful tickets mimic the session id behaviour available in TLSv1.2 and below β€” the session information is cached on the server and the session id is wrapped up in a ticket and sent back to the client. When the client wishes to resume, it presents a ticket in the same way as for stateless tickets, and the server can then extract the session id from the ticket and retrieve the session information from its cache. Iconic behaviour tbh. 🌈

By default OpenSSL will use stateless tickets. The SSL_OP_NO_TICKET option causes stateless tickets to not be issued. In TLSv1.2 and below, that means no ticket gets sent to the client at all. In TLSv1.3, a stateful ticket will be sent instead. This is a server-side option only, just so we're clear. 🚨

Also, in TLSv1.3 it's possible to suppress all tickets (stateful and stateless) from being sent by calling SSL_CTX_set_num_tickets(3) or SSL_set_num_tickets(3). Full silence. 🀫

  • SSL_OP_PRIORITIZE_CHACHA β€” when SSL_OP_CIPHER_SERVER_PREFERENCE is set, this temporarily reprioritizes ChaCha20-Poly1305 ciphers to the top of the server cipher list if a ChaCha20-Poly1305 cipher is at the top of the client cipher list. Very "if they like it, we like it" of it. πŸ’– This helps those clients (e.g. mobile) use ChaCha20-Poly1305 if that cipher is anywhere in the server cipher list, while still letting other clients use AES and other ciphers. Requires SSL_OP_CIPHER_SERVER_PREFERENCE β€” it does not work solo, no matter how much it wants to. πŸŽ€
  • SSL_OP_TLS_ROLLBACK_BUG β€” disable version rollback attack detection. 😭 Here's why that's a thing: during the client key exchange, the client must send the same information about acceptable SSL/TLS protocol levels as it did during the first hello. Some clients violate this rule by adapting to the server's answer. (Example: the client sends an SSLv2 hello and accepts up to SSLv3.1=TLSv1, while the server only understands up to SSLv3. In this case the client must still use the same SSLv3.1=TLSv1 announcement. Some clients step down to SSLv3 with respect to the server's answer and violate the version rollback protection.) So yeah β€” this option turns off the detection entirely. Handle with care, bestie. ⚠️

The following options no longer have any effect, but their identifiers are retained for compatibility purposes β€” they're basically retired icons still showing up to the party: πŸŽ‰

  • SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
  • SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
  • SSL_OP_SSLEAY_080_CLIENT_DH_BUG
  • SSL_OP_TLS_D5_BUG
  • SSL_OP_TLS_BLOCK_PADDING_BUG
  • SSL_OP_MSIE_SSLV2_RSA_PADDING
  • SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
  • SSL_OP_MICROSOFT_SESS_ID_BUG
  • SSL_OP_NETSCAPE_CHALLENGE_BUG
  • SSL_OP_PKCS1_CHECK_1
  • SSL_OP_PKCS1_CHECK_2
  • SSL_OP_SINGLE_DH_USE
  • SSL_OP_SINGLE_ECDH_USE
  • SSL_OP_EPHEMERAL_RSA
  • SSL_OP_NETSCAPE_CA_DN_BUG
  • SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG

πŸ”’ SECURE RENEGOTIATION πŸ”’

OpenSSL always attempts to use secure renegotiation as described in RFC5746. This counters the prefix attack described in CVE-2009-3555 and elsewhere. πŸ’ͺ

This attack has far reaching consequences which application writers should be aware of. In the description below, an implementation supporting secure renegotiation is referred to as patched. A server not supporting secure renegotiation is referred to as unpatched. The following sections describe the operations permitted by OpenSSL's secure renegotiation implementation. 🧠

🌸 Patched client and server

Connections and renegotiation are always permitted by OpenSSL implementations. Slay. Connection secured. No drama. ✨

😬 Unpatched client and patched OpenSSL server

The initial connection succeeds, but client renegotiation is denied by the server with a no_renegotiation warning alert if TLS v1.0 is used, or a fatal handshake_failure alert in SSL v3.0. Ouch. πŸ’€

If the patched OpenSSL server attempts to renegotiate, a fatal handshake_failure alert is sent. Why? Because the server code may be completely unaware of the unpatched nature of the client. It's not being rude, it just doesn't know. πŸ™ˆ

If the option SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION is set, then renegotiation always succeeds. Periodt.

🫢 Patched OpenSSL client and unpatched server

If the option SSL_OP_LEGACY_SERVER_CONNECT or SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION is set, then initial connections and renegotiation between patched OpenSSL clients and unpatched servers succeeds. If neither option is set, then initial connections to unpatched servers will fail. 🚫

Setting the option SSL_OP_LEGACY_SERVER_CONNECT has security implications; clients that are willing to connect to servers that do not implement RFC 5746 secure renegotiation are subject to attacks such as CVE-2009-3555. Like, genuinely. Be careful. ⚠️

OpenSSL client applications wishing to ensure they can connect to unpatched servers should always set SSL_OP_LEGACY_SERVER_CONNECT. πŸ’–

OpenSSL client applications that want to ensure they can not connect to unpatched servers (and thus avoid any security issues) should always clear SSL_OP_LEGACY_SERVER_CONNECT using SSL_CTX_clear_options() or SSL_clear_options(). 🧹

The difference between the SSL_OP_LEGACY_SERVER_CONNECT and SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION options is that SSL_OP_LEGACY_SERVER_CONNECT enables initial connections and secure renegotiation between OpenSSL clients and unpatched servers only, while SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION allows initial connections and renegotiation between OpenSSL and unpatched clients or servers β€” both directions, equal opportunity. 🀝

πŸ¦‹ Applicability of options to QUIC connections and streams

These options apply to SSL objects referencing a QUIC connection:

  • SSL_OP_ALLOW_NO_DHE_KEX
  • SSL_OP_NO_TX_CERTIFICATE_COMPRESSION
  • SSL_OP_NO_RX_CERTIFICATE_COMPRESSION
  • SSL_OP_NO_TICKET
  • SSL_OP_PRIORITIZE_CHACHA

These options apply to SSL objects referencing a QUIC stream:

  • SSL_OP_CLEANSE_PLAINTEXT

Options on QUIC connections are initialized from the options set on SSL_CTX before a QUIC connection SSL object is created. Options on QUIC streams are initialised from the options configured on the QUIC connection SSL object they are created from. Inheritance! 🧬

Setting options which relate to QUIC streams on a QUIC connection SSL object has no direct effect on the QUIC connection SSL object itself, but it will change the options set on the default stream (if there is one) and will also determine the default options set on any future streams which are created. It's giving "I'm not changing, but my kids will be different". 😭

Other options not mentioned above do not have an effect and will be ignored. Straight up ignored. πŸ’…

Options which relate to QUIC streams may also be set directly on QUIC stream SSL objects. Setting connection-related options on such an object has no effect. Nope. Zero. Nada. πŸ™…


πŸŽ€ RETURN VALUES πŸŽ€

  • SSL_CTX_set_options() and SSL_set_options() return the new options bit-mask after adding options. ✨
  • SSL_CTX_clear_options() and SSL_clear_options() return the new options bit-mask after clearing options. 🧹
  • SSL_CTX_get_options() and SSL_get_options() return the current bit-mask. πŸ‘€
  • SSL_get_secure_renegotiation_support() returns 1 if the peer supports secure renegotiation and 0 if it does not. (Yes, the original says "1 is the peer supports" β€” it's a typo, but the meaning is totally clear: 1 = yes bestie, 0 = nope.) 🫢

🌈 SEE ALSO 🌈

ssl(7), SSL_new(3), SSL_clear(3), SSL_shutdown(3), SSL_CTX_set_tmp_dh_callback(3), SSL_CTX_set_min_proto_version(3), openssl-dhparam(1)

Go read them, they're all part of the extended universe. πŸ“šβœ¨


πŸ‘‘ HISTORY πŸ‘‘

The attempt to always try to use secure renegotiation was added in OpenSSL 0.9.8m. Ancient history but still iconic. πŸ›οΈ

The SSL_OP_PRIORITIZE_CHACHA and SSL_OP_NO_RENEGOTIATION options were added in OpenSSL 1.1.1. πŸ’…

The SSL_OP_NO_EXTENDED_MASTER_SECRET and SSL_OP_IGNORE_UNEXPECTED_EOF options were added in OpenSSL 3.0. ✨

The SSL_OP_ constants and the corresponding parameter and return values of the affected functions were changed to "uint64_t" type in OpenSSL 3.0. 🫠 For that reason it is no longer possible to use the SSL_OP_ macro values in preprocessor "#if" conditions. However, it is still possible to test whether these macros are defined or not β€” that part still works, bestie. πŸ’–

okay so legally speaking (and yes bestie I am being serious for one sec) πŸ’…

Copyright 2001-2025 The OpenSSL Project Authors. All Rights Reserved.

That's the whole squad, the entire OpenSSL Project Authors, holding it down from 2001 all the way to 2025. Respect the elders fr fr 🫢

This file is licensed under the Apache License 2.0 (that's "the License" for short, capital L, main character energy πŸ‘‘). And here's the vibe check: you may not use this file except in compliance with the License. Like, that's not a suggestion, that's the whole deal, no cap.

Wanna actually read it? You can grab a copy right here:

bestie pls actually read the license before you ship anything, it's giving "read the group chat before replying" energy 😭 it's iconic of you to check, honestly

and that's the whole page, we made it to the end πŸŽ‰πŸ’– you're officially the kind of person who reads the entire manual page and I'm obsessed with that for you. slay.

🌸 source/version: 3.5.6 β€” dated 2026-04-07 🌸

go forth and set your options, queen πŸŽ€πŸ¦‹βœ¨

πŸ“¦ where this page comes from