fs2-io/fs2.internal.jsdeps.node.tlsMod/TLSSocket

TLSSocket

@JSImport("tls", "TLSSocket") @native @JSType class TLSSocket extends StObject
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Constructors

def this(socket: Socket)

Construct a new tls.TLSSocket object from an existing TCP socket.

Construct a new tls.TLSSocket object from an existing TCP socket.

def this(socket: Socket, options: TLSSocketOptions)

Concrete methods

def addListener(event: String, listener: Function1[Any, Unit]): TLSSocket
@JSName("addListener")
def addListener_OCSPResponse(event: OCSPResponse, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("addListener")
def addListener_keylog(event: keylog, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("addListener")
def addListener_secureConnect(event: secureConnect, listener: Function0[Unit]): TLSSocket
@JSName("addListener")
def addListener_session(event: session, listener: Function1[Buffer, Unit]): TLSSocket
def disableRenegotiation(): Unit

Disables TLS renegotiation for this TLSSocket instance. Once called, attempts to renegotiate will trigger an 'error' event on the TLSSocket.

Disables TLS renegotiation for this TLSSocket instance. Once called, attempts to renegotiate will trigger an 'error' event on the TLSSocket.

def emit(event: String, args: Any*): Boolean
def emit(event: Symbol, args: Any*): Boolean
@JSName("emit")
def emit_OCSPResponse(event: OCSPResponse, response: Buffer): Boolean
@JSName("emit")
def emit_keylog(event: keylog, line: Buffer): Boolean
@JSName("emit")
def emit_secureConnect(event: secureConnect): Boolean
@JSName("emit")
def emit_session(event: session, session: Buffer): Boolean
def enableTrace(): Unit

When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

Note: The format of the output is identical to the output of openssl s_client -trace or openssl s_server -trace. While it is produced by OpenSSL's SSL_trace() function, the format is undocumented, can change without notice, and should not be relied on.

def exportKeyingMaterial(length: Double, label: String, context: Buffer): Buffer
Value Params
context

optionally provide a context.

label

an application specific label, typically this will be a value from the IANA Exporter Label Registry.

length

number of bytes to retrieve from keying material

def getCertificate(): PeerCertificate | Object | Null

Returns an object representing the local certificate. The returned object has some properties corresponding to the fields of the certificate.

Returns an object representing the local certificate. The returned object has some properties corresponding to the fields of the certificate.

See tls.TLSSocket.getPeerCertificate() for an example of the certificate structure.

If there is no local certificate, an empty object will be returned. If the socket has been destroyed, null will be returned.

def getCipher(): CipherNameAndProtocol

Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection.

Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection.

def getEphemeralKeyInfo(): EphemeralKeyInfo | Object | Null

Returns an object representing the type, name, and size of parameter of an ephemeral key exchange in Perfect Forward Secrecy on a client connection. It returns an empty object when the key exchange is not ephemeral. As this is only supported on a client socket; null is returned if called on a server socket. The supported types are 'DH' and 'ECDH'. The name property is available only when type is 'ECDH'.

Returns an object representing the type, name, and size of parameter of an ephemeral key exchange in Perfect Forward Secrecy on a client connection. It returns an empty object when the key exchange is not ephemeral. As this is only supported on a client socket; null is returned if called on a server socket. The supported types are 'DH' and 'ECDH'. The name property is available only when type is 'ECDH'.

For example: { type: 'ECDH', name: 'prime256v1', size: 256 }.

def getFinished(): UndefOr[Buffer]

Returns the latest Finished message that has been sent to the socket as part of a SSL/TLS handshake, or undefined if no Finished message has been sent yet.

Returns the latest Finished message that has been sent to the socket as part of a SSL/TLS handshake, or undefined if no Finished message has been sent yet.

As the Finished messages are message digests of the complete handshake (with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can be used for external authentication procedures when the authentication provided by SSL/TLS is not desired or is not enough.

Corresponds to the SSL_get_finished routine in OpenSSL and may be used to implement the tls-unique channel binding from RFC 5929.

@JSName("getPeerCertificate")
def getPeerCertificate_PeerCertificate(): PeerCertificate
@JSName("getPeerCertificate")
def getPeerCertificate_false(detailed: `false`): PeerCertificate
@JSName("getPeerCertificate")
def getPeerCertificate_true(detailed: `true`): DetailedPeerCertificate

Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null or an empty object.

Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null or an empty object.

Value Params
detailed
  • If true; the full chain with issuer property will be returned.
def getPeerFinished(): UndefOr[Buffer]

Returns the latest Finished message that is expected or has actually been received from the socket as part of a SSL/TLS handshake, or undefined if there is no Finished message so far.

Returns the latest Finished message that is expected or has actually been received from the socket as part of a SSL/TLS handshake, or undefined if there is no Finished message so far.

As the Finished messages are message digests of the complete handshake (with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can be used for external authentication procedures when the authentication provided by SSL/TLS is not desired or is not enough.

Corresponds to the SSL_get_peer_finished routine in OpenSSL and may be used to implement the tls-unique channel binding from RFC 5929.

def getPeerX509Certificate(): UndefOr[X509Certificate]

If there is no peer certificate, or the socket has been destroyed, undefined will be returned.

If there is no peer certificate, or the socket has been destroyed, undefined will be returned.

def getProtocol(): String | Null

Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information.

Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information.

def getSession(): UndefOr[Buffer]

Could be used to speed up handshake establishment when reconnecting to the server.

Could be used to speed up handshake establishment when reconnecting to the server.

def getSharedSigalgs(): Array[String]

Returns a list of signature algorithms shared between the server and the client in the order of decreasing preference.

Returns a list of signature algorithms shared between the server and the client in the order of decreasing preference.

def getTLSTicket(): UndefOr[Buffer]

NOTE: Works only with client TLS sockets. Useful only for debugging, for session reuse provide session option to tls.connect().

NOTE: Works only with client TLS sockets. Useful only for debugging, for session reuse provide session option to tls.connect().

def getX509Certificate(): UndefOr[X509Certificate]

If there is no local certificate, or the socket has been destroyed, undefined will be returned.

If there is no local certificate, or the socket has been destroyed, undefined will be returned.

def isSessionReused(): Boolean

Returns true if the session was reused, false otherwise.

Returns true if the session was reused, false otherwise.

def on(event: String, listener: Function1[Any, Unit]): TLSSocket
@JSName("on")
def on_OCSPResponse(event: OCSPResponse, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("on")
def on_keylog(event: keylog, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("on")
def on_secureConnect(event: secureConnect, listener: Function0[Unit]): TLSSocket
@JSName("on")
def on_session(event: session, listener: Function1[Buffer, Unit]): TLSSocket
def once(event: String, listener: Function1[Any, Unit]): TLSSocket
@JSName("once")
def once_OCSPResponse(event: OCSPResponse, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("once")
def once_keylog(event: keylog, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("once")
def once_secureConnect(event: secureConnect, listener: Function0[Unit]): TLSSocket
@JSName("once")
def once_session(event: session, listener: Function1[Buffer, Unit]): TLSSocket
def prependListener(event: String, listener: Function1[Any, Unit]): TLSSocket
@JSName("prependListener")
def prependListener_OCSPResponse(event: OCSPResponse, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("prependListener")
def prependListener_keylog(event: keylog, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("prependListener")
def prependListener_secureConnect(event: secureConnect, listener: Function0[Unit]): TLSSocket
@JSName("prependListener")
def prependListener_session(event: session, listener: Function1[Buffer, Unit]): TLSSocket
def prependOnceListener(event: String, listener: Function1[Any, Unit]): TLSSocket
@JSName("prependOnceListener")
def prependOnceListener_OCSPResponse(event: OCSPResponse, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("prependOnceListener")
def prependOnceListener_keylog(event: keylog, listener: Function1[Buffer, Unit]): TLSSocket
@JSName("prependOnceListener")
def prependOnceListener_secureConnect(event: secureConnect, listener: Function0[Unit]): TLSSocket
@JSName("prependOnceListener")
def prependOnceListener_session(event: session, listener: Function1[Buffer, Unit]): TLSSocket
def renegotiate(options: RejectUnauthorized, callback: Function1[Error | Null, Unit]): UndefOr[Boolean]

Initiate TLS renegotiation process.

Initiate TLS renegotiation process.

NOTE: Can be used to request peer's certificate after the secure connection has been established. ANOTHER NOTE: When running as the server, socket will be destroyed with an error after handshakeTimeout timeout.

Value Params
callback
  • callback(err) will be executed with null as err, once the renegotiation is successfully completed.
options
  • The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer() for details).
Returns

undefined when socket is destroy, false if negotiaion can't be initiated.

def setMaxSendFragment(size: Double): Boolean

Set maximum TLS fragment size (default and maximum value is: 16384, minimum is: 512). Smaller fragment size decreases buffering latency on the client: large fragments are buffered by the TLS layer until the entire fragment is received and its integrity is verified; large fragments can span multiple roundtrips, and their processing can be delayed due to packet loss or reordering. However, smaller fragments add extra TLS framing bytes and CPU overhead, which may decrease overall server throughput.

Set maximum TLS fragment size (default and maximum value is: 16384, minimum is: 512). Smaller fragment size decreases buffering latency on the client: large fragments are buffered by the TLS layer until the entire fragment is received and its integrity is verified; large fragments can span multiple roundtrips, and their processing can be delayed due to packet loss or reordering. However, smaller fragments add extra TLS framing bytes and CPU overhead, which may decrease overall server throughput.

Value Params
size
  • TLS fragment size (default and maximum value is: 16384, minimum is: 512).

Inherited methods

def hasOwnProperty(v: String): Boolean
Inherited from
Object
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def toLocaleString(): String
Inherited from
Object
def valueOf(): Any
Inherited from
Object

Concrete fields

var alpnProtocol: UndefOr[String]

String containing the selected ALPN protocol. When ALPN has no selected protocol, tlsSocket.alpnProtocol equals false.

String containing the selected ALPN protocol. When ALPN has no selected protocol, tlsSocket.alpnProtocol equals false.

var authorizationError: Error

The reason why the peer's certificate has not been verified. This property becomes available only when tlsSocket.authorized === false.

The reason why the peer's certificate has not been verified. This property becomes available only when tlsSocket.authorized === false.

var authorized: Boolean

A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false.

A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false.

var encrypted: Boolean

Static boolean value, always true. May be used to distinguish TLS sockets from regular ones.

Static boolean value, always true. May be used to distinguish TLS sockets from regular ones.