summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFedor Indutny <fedor@indutny.com>2014-06-25 14:11:09 +0400
committerFedor Indutny <fedor@indutny.com>2014-06-25 14:11:09 +0400
commite50749bb056d84763b89b9f96a584592ab262c55 (patch)
tree263bb35f0c28ec26c0cc08597de0a5dbce7eb9bf /doc
parent56d767fd698bbe1e3bdf5bf286cc573ef3248b5a (diff)
downloadandroid-node-v8-e50749bb056d84763b89b9f96a584592ab262c55.tar.gz
android-node-v8-e50749bb056d84763b89b9f96a584592ab262c55.tar.bz2
android-node-v8-e50749bb056d84763b89b9f96a584592ab262c55.zip
doc: document `tls.createSecureContext`
Diffstat (limited to 'doc')
-rw-r--r--doc/api/crypto.markdown3
-rw-r--r--doc/api/tls.markdown27
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown
index 2ebdc1fb7a..dcb25c34e1 100644
--- a/doc/api/crypto.markdown
+++ b/doc/api/crypto.markdown
@@ -58,6 +58,8 @@ Example:
## crypto.createCredentials(details)
+Stability: 0 - Deprecated. Use [tls.createSecureContext][] instead.
+
Creates a credentials object, with the optional details being a
dictionary with keys:
@@ -636,6 +638,7 @@ temporary measure.
[createCipher()]: #crypto_crypto_createcipher_algorithm_password
[createCipheriv()]: #crypto_crypto_createcipheriv_algorithm_key_iv
[crypto.createDiffieHellman()]: #crypto_crypto_creatediffiehellman_prime_encoding
+[tls.createSecureContext]: tls.html#tls_tls_createsecurecontext_details
[diffieHellman.setPublicKey()]: #crypto_diffiehellman_setpublickey_public_key_encoding
[RFC 2412]: http://www.rfc-editor.org/rfc/rfc2412.txt
[RFC 3526]: http://www.rfc-editor.org/rfc/rfc3526.txt
diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown
index 8e00c6378e..fb9e2617be 100644
--- a/doc/api/tls.markdown
+++ b/doc/api/tls.markdown
@@ -415,6 +415,33 @@ Construct a new TLSSocket object from existing TCP socket.
be added to client hello, and `OCSPResponse` event will be emitted on socket
before establishing secure communication
+
+## tls.createSecureContext(details)
+
+Stability: 0 - Deprecated. Use tls.createSecureContext instead.
+
+Creates a credentials object, with the optional details being a
+dictionary with keys:
+
+* `pfx` : A string or buffer holding the PFX or PKCS12 encoded private
+ key, certificate and CA certificates
+* `key` : A string holding the PEM encoded private key
+* `passphrase` : A string of passphrase for the private key or pfx
+* `cert` : A string holding the PEM encoded certificate
+* `ca` : Either a string or list of strings of PEM encoded CA
+ certificates to trust.
+* `crl` : Either a string or list of strings of PEM encoded CRLs
+ (Certificate Revocation List)
+* `ciphers`: A string describing the ciphers to use or exclude.
+ Consult
+ <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>
+ for details on the format.
+
+If no 'ca' details are given, then node.js will use the default
+publicly trusted list of CAs as given in
+<http://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt>.
+
+
## tls.createSecurePair([context], [isServer], [requestCert], [rejectUnauthorized])
Stability: 0 - Deprecated. Use tls.TLSSocket instead.