1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: document tls.createSecureContext

Browse Source
This commit is contained in:
Fedor Indutny 2014-06-25 14:11:09 +04:00
parent 56d767fd69
commit e50749bb05
No known key found for this signature in database
GPG Key ID: FB0E1095B1797999
2 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/api/crypto.markdown
View File

@ -58,6 +58,8 @@ Example:
## crypto.createCredentials(details) ## crypto.createCredentials(details)
Stability: 0 - Deprecated. Use [tls.createSecureContext][] instead.
Creates a credentials object, with the optional details being a Creates a credentials object, with the optional details being a
dictionary with keys: dictionary with keys:
@ -636,6 +638,7 @@ temporary measure.
[createCipher()]: #crypto_crypto_createcipher_algorithm_password [createCipher()]: #crypto_crypto_createcipher_algorithm_password
[createCipheriv()]: #crypto_crypto_createcipheriv_algorithm_key_iv [createCipheriv()]: #crypto_crypto_createcipheriv_algorithm_key_iv
[crypto.createDiffieHellman()]: #crypto_crypto_creatediffiehellman_prime_encoding [crypto.createDiffieHellman()]: #crypto_crypto_creatediffiehellman_prime_encoding
[tls.createSecureContext]: tls.html#tls_tls_createsecurecontext_details
[diffieHellman.setPublicKey()]: #crypto_diffiehellman_setpublickey_public_key_encoding [diffieHellman.setPublicKey()]: #crypto_diffiehellman_setpublickey_public_key_encoding
[RFC 2412]: http://www.rfc-editor.org/rfc/rfc2412.txt [RFC 2412]: http://www.rfc-editor.org/rfc/rfc2412.txt
[RFC 3526]: http://www.rfc-editor.org/rfc/rfc3526.txt [RFC 3526]: http://www.rfc-editor.org/rfc/rfc3526.txt

27
doc/api/tls.markdown
View File

@ -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 be added to client hello, and `OCSPResponse` event will be emitted on socket
before establishing secure communication 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]) ## tls.createSecurePair([context], [isServer], [requestCert], [rejectUnauthorized])
Stability: 0 - Deprecated. Use tls.TLSSocket instead. Stability: 0 - Deprecated. Use tls.TLSSocket instead.