summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel G. Taylor <dan@programmer-art.org>2013-05-15 13:14:20 -0600
committerBen Noordhuis <info@bnoordhuis.nl>2013-05-28 21:40:52 +0200
commit30cb9fec918112b07b695e4830b8aa0b43fa3ac5 (patch)
treebec793cd2c4e59f7e191179460f0350267e8bcea
parentf523f7041dc8c2b3c2e9be35b437ffa486f952a7 (diff)
downloadnode-new-30cb9fec918112b07b695e4830b8aa0b43fa3ac5.tar.gz
tls: Add `secureProtocol` docs
Add `secureProtocol` parameter docs to the tls.connect method.
-rw-r--r--doc/api/tls.markdown5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown
index f89de22059..b9d22d0135 100644
--- a/doc/api/tls.markdown
+++ b/doc/api/tls.markdown
@@ -274,6 +274,10 @@ Creates a new client connection to the given `port` and `host` (old API) or
- `servername`: Servername for SNI (Server Name Indication) TLS extension.
+ - `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][].
+
The `callback` parameter will be added as a listener for the
['secureConnect'][] event.
@@ -560,4 +564,5 @@ The numeric representation of the remote port. For example, `443`.
['secureConnect']: #tls_event_secureconnect
[secureConnection]: #tls_event_secureconnection
[Stream]: stream.html#stream_stream
+[SSL_METHODS]: http://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_PROTOCOL_METHODS
[tls.Server]: #tls_class_tls_server