summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel G. Taylor <dan@programmer-art.org>2013-05-15 13:16:09 -0600
committerBen Noordhuis <info@bnoordhuis.nl>2013-05-28 21:43:37 +0200
commit675e85813f2c2083f9b401fadbf1b56c144c986b (patch)
tree1e3dc885b69da94e87792da99688be346f98c912
parent30cb9fec918112b07b695e4830b8aa0b43fa3ac5 (diff)
downloadnode-675e85813f2c2083f9b401fadbf1b56c144c986b.tar.gz
https: Add `secureProtocol` docs
Add `secureProtocol` parameter docs to the https.request method.
-rw-r--r--doc/api/https.markdown4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/https.markdown b/doc/api/https.markdown
index 9efe2065e..8f608b1a7 100644
--- a/doc/api/https.markdown
+++ b/doc/api/https.markdown
@@ -126,6 +126,9 @@ The following options from [tls.connect()][] can also be specified. However, a
the list of supplied CAs. An `'error'` event is emitted if verification
fails. Verification happens at the connection level, *before* the HTTP
request is sent. Default `true`.
+- `secureProtocol`: The SSL method to use, e.g. `SSLv3_method` to force
+ SSL version 3. The possible values depend on your installation of
+ OpenSSL and are defined in the constant [SSL_METHODS][].
In order to specify these options, use a custom `Agent`.
@@ -207,3 +210,4 @@ Global instance of [https.Agent][] for all HTTPS client requests.
[https.request()]: #https_https_request_options_callback
[tls.connect()]: tls.html#tls_tls_connect_options_callback
[tls.createServer()]: tls.html#tls_tls_createserver_options_secureconnectionlistener
+[SSL_METHODS]: http://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_PROTOCOL_METHODS