Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add added: information for tls #7018

Closed
wants to merge 25 commits into from
Closed

doc: add added: information for tls #7018

Changes from 4 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
5af646c
adding added to Class CruptoStream
italoacasas May 27, 2016
40d345a
adding added to a few methods
italoacasas May 27, 2016
28217fc
adding added to Class tls.TLSSocket
italoacasas May 27, 2016
e993b2e
adding YAML and added for OCSResponse event
italoacasas May 27, 2016
8d8aaca
adding added before version
italoacasas May 27, 2016
b0c3498
adding add to a few evetns
italoacasas May 27, 2016
8eefd49
adding added for the resumeSession event
italoacasas May 27, 2016
f12bed4
adding added for secureConnection event
italoacasas May 27, 2016
aba37d5
adding added for the addContext method
italoacasas May 27, 2016
9f4fb60
adding added to the secureConnect event
italoacasas May 27, 2016
7460fff
adding added to server.close event
italoacasas May 27, 2016
2e167f4
adding added to the connections method
italoacasas May 27, 2016
e8bfe2c
adding added to the class and the address method
italoacasas May 27, 2016
7235213
adding added to the getTicketKeys
italoacasas May 27, 2016
a2fff23
adding added to the setTicketKeys method
italoacasas May 27, 2016
5550764
Adding added to the address and authorized methods for tlsSocket
italoacasas May 27, 2016
e20d2b2
adding added to all tls methods
italoacasas May 28, 2016
69a7e5c
finish adding added and deprecated
italoacasas May 28, 2016
a093711
removing release candidate version
italoacasas May 28, 2016
e8a9bfa
adding added to SecurePair class
italoacasas May 28, 2016
456a59f
fixing missing YAML's and adding space
italoacasas May 28, 2016
2b73b0c
adding space between added comment and text
italoacasas May 28, 2016
9269977
fixing tls.Server added date
italoacasas Jun 9, 2016
6c48020
fixing some errors
italoacasas Jun 12, 2016
092e015
fixing whitespace change
italoacasas Jun 12, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions doc/api/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ threshold is exceeded. The limits are configurable:
requests. Defaults to `3`.
* `tls.CLIENT_RENEG_WINDOW` {number} Specifies the time renegotiation window
in seconds. Defaults to `600` (10 minutes).

*Note*: The default renegotiation limits should not be modified without a full
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary whitespace change

understanding of the implications and risks.

Expand Down Expand Up @@ -385,7 +384,9 @@ previous keys.


## Class: tls.TLSSocket

<!--YAML
added: v0.11.4
-->
The `tls.TLSSocket` is a subclass of [`net.Socket`][] that performs transparent
encryption of written data and all required TLS negotiation.

Expand All @@ -396,7 +397,9 @@ Instances of `tls.TLSSocket` implement the duplex [Stream][] interface.
connection is open.

### new tls.TLSSocket(socket[, options])

<!--YAML
added: v0.11.4
-->
* `socket` {net.Socket} An instance of [`net.Socket`][]
* `options` {Object}
* `secureContext`: An optional TLS context object from
Expand All @@ -417,7 +420,9 @@ connection is open.
Construct a new `tls.TLSSocket` object from an existing TCP socket.

### Event: 'OCSPResponse'

<!--YAML
added: v0.11.13
-->
The `'OCSPResponse'` event is emitted if the `requestOCSP` option was set
when the `tls.TLSSocket` was created and an OCSP response has been received.
The listener callback is passed a single argument when called:
Expand Down Expand Up @@ -1019,6 +1024,9 @@ openssl s_client -connect 127.0.0.1:8000
```

## tls.getCiphers()
<!--YAML
v0.10.2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should have added: before it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sigh.. completely overlooked that ;-) good catch.

-->

Returns an array with the names of the supported SSL ciphers.

Expand All @@ -1031,7 +1039,9 @@ console.log(tls.getCiphers()); // ['AES128-SHA', 'AES256-SHA', ...]
## Deprecated APIs

### Class: CryptoStream

<!-- YAML
added: v0.3.2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should, ideally, mention when it was deprecated, i.e. an additional deprecated: vx.y.z line

-->
Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.

The `tls.CryptoStream` class represents a stream of encrypted data. This class
Expand Down