summaryrefslogtreecommitdiff
path: root/ext/openssl/ossl_ssl.c
diff options
context:
space:
mode:
authorKazuki Yamaguchi <[email protected]>2024-06-12 02:26:18 +0900
committergit <[email protected]>2024-12-07 08:15:07 +0000
commit33196b7ab007c82ebd3fa3759850b1ddc10d50ef (patch)
tree94f84eb412cbb889db513eaf4f80f83ea4a86c81 /ext/openssl/ossl_ssl.c
parent09d516b62e0859af364b23f9bd0128dae31d7e38 (diff)
[ruby/openssl] ssl: improve documentation of SSLContext#options=
https://github.com/ruby/openssl/commit/9120fcde6a
Diffstat (limited to 'ext/openssl/ossl_ssl.c')
-rw-r--r--ext/openssl/ossl_ssl.c17
1 files changed, 15 insertions, 2 deletions
diff --git a/ext/openssl/ossl_ssl.c b/ext/openssl/ossl_ssl.c
index 7bd395b760..2525d0c872 100644
--- a/ext/openssl/ossl_ssl.c
+++ b/ext/openssl/ossl_ssl.c
@@ -746,7 +746,10 @@ ssl_info_cb(const SSL *ssl, int where, int val)
}
/*
- * Gets various OpenSSL options.
+ * call-seq:
+ * ctx.options -> integer
+ *
+ * Gets various \OpenSSL options.
*/
static VALUE
ossl_sslctx_get_options(VALUE self)
@@ -761,7 +764,17 @@ ossl_sslctx_get_options(VALUE self)
}
/*
- * Sets various OpenSSL options.
+ * call-seq:
+ * ctx.options = integer
+ *
+ * Sets various \OpenSSL options. The options are a bit field and can be
+ * combined with the bitwise OR operator (<tt>|</tt>). Available options are
+ * defined as constants in OpenSSL::SSL that begin with +OP_+.
+ *
+ * For backwards compatibility, passing +nil+ has the same effect as passing
+ * OpenSSL::SSL::OP_ALL.
+ *
+ * See also man page SSL_CTX_set_options(3).
*/
static VALUE
ossl_sslctx_set_options(VALUE self, VALUE options)