Packages

trait ServerOptions extends Object with StObject with TlsOptions with httpMod.ServerOptions

Annotations
@JSType() @native()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerOptions
  2. ServerOptions
  3. TlsOptions
  4. ServerOpts
  5. CommonConnectionOptions
  6. SecureContextOptions
  7. StObject
  8. Object
  9. Any
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val ALPNProtocols: UndefOr[|[Array[|[String, Uint8Array]], Uint8Array]]

    An array of strings or a Buffer naming possible ALPN protocols.

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    Definition Classes
    CommonConnectionOptions
  5. val IncomingMessage: UndefOr[Instantiable1[Socket, IncomingMessage]]
    Definition Classes
    ServerOptions
  6. val SNICallback: UndefOr[Function2[String, Function2[|[Error, Null], UndefOr[SecureContext], Unit], Unit]]

    SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension.

    SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).

    Definition Classes
    CommonConnectionOptions
  7. val ServerResponse: UndefOr[Instantiable1[IncomingMessage, ServerResponse]]
    Definition Classes
    ServerOptions
  8. val allowHalfOpen: UndefOr[Boolean]

    Indicates whether half-opened TCP connections are allowed.

    Indicates whether half-opened TCP connections are allowed.

    Definition Classes
    ServerOpts
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val ca: UndefOr[|[|[String, Buffer], Array[|[String, Buffer]]]]

    Optionally override the trusted CA certificates.

    Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

    Definition Classes
    SecureContextOptions
  11. val cert: UndefOr[|[|[String, Buffer], Array[|[String, Buffer]]]]

    Cert chains in PEM format.

    Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

    Definition Classes
    SecureContextOptions
  12. val ciphers: UndefOr[String]

    Cipher suite specification, replacing the default.

    Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

    Definition Classes
    SecureContextOptions
  13. val clientCertEngine: UndefOr[String]

    Name of an OpenSSL engine which can provide the client certificate.

    Name of an OpenSSL engine which can provide the client certificate.

    Definition Classes
    SecureContextOptions
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  15. val crl: UndefOr[|[|[String, Buffer], Array[|[String, Buffer]]]]

    PEM formatted CRLs (Certificate Revocation Lists).

    PEM formatted CRLs (Certificate Revocation Lists).

    Definition Classes
    SecureContextOptions
  16. val dhparam: UndefOr[|[String, Buffer]]

    Diffie Hellman parameters, required for Perfect Forward Secrecy.

    Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.

    Definition Classes
    SecureContextOptions
  17. val ecdhCurve: UndefOr[String]

    A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement.

    A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

    Definition Classes
    SecureContextOptions
  18. val enableTrace: UndefOr[Boolean]

    When enabled, TLS packet trace information is written to stderr.

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

    Definition Classes
    CommonConnectionOptions
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val handshakeTimeout: UndefOr[Double]

    Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds.

    Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds).

    Definition Classes
    TlsOptions
  23. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. val honorCipherOrder: UndefOr[Boolean]

    Attempt to use the server's cipher suite preferences instead of the client's.

    Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions

    Definition Classes
    SecureContextOptions
  26. val insecureHTTPParser: UndefOr[Boolean]

    Use an insecure HTTP parser that accepts invalid HTTP headers when true.

    Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.

    Definition Classes
    ServerOptions
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  29. val key: UndefOr[|[|[String, Buffer], Array[|[Buffer, KeyObject]]]]

    Private keys in PEM format.

    Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    Definition Classes
    SecureContextOptions
  30. val maxHeaderSize: UndefOr[Double]

    Optionally overrides the value of --max-http-header-size for requests received by this server, i.e.

    Optionally overrides the value of --max-http-header-size for requests received by this server, i.e. the maximum length of request headers in bytes.

    Definition Classes
    ServerOptions
  31. val maxVersion: UndefOr[SecureVersion]

    Optionally set the maximum TLS version to allow.

    Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. **Default:** 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

    Definition Classes
    SecureContextOptions
  32. val minVersion: UndefOr[SecureVersion]

    Optionally set the minimum TLS version to allow.

    Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. **Default:** 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

    Definition Classes
    SecureContextOptions
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. val passphrase: UndefOr[String]

    Shared passphrase used for a single private key and/or a PFX.

    Shared passphrase used for a single private key and/or a PFX.

    Definition Classes
    SecureContextOptions
  37. val pauseOnConnect: UndefOr[Boolean]

    Indicates whether the socket should be paused on incoming connections.

    Indicates whether the socket should be paused on incoming connections.

    Definition Classes
    ServerOpts
  38. val pfx: UndefOr[|[|[String, Buffer], Array[|[|[String, Buffer], PxfObject]]]]

    PFX or PKCS12 encoded private key and certificate chain.

    PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    Definition Classes
    SecureContextOptions
  39. val privateKeyEngine: UndefOr[String]

    Name of an OpenSSL engine to get private key from.

    Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.

    Definition Classes
    SecureContextOptions
  40. val privateKeyIdentifier: UndefOr[String]

    Identifier of a private key managed by an OpenSSL engine.

    Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.

    Definition Classes
    SecureContextOptions
  41. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  42. val pskCallback: UndefOr[Function2[TLSSocket, String, |[|[DataView, TypedArray], Null]]]

    returns

    pre-shared key that must either be a buffer or null to stop the negotiation process. Returned PSK must be compatible with the selected cipher's digest. When negotiating TLS-PSK (pre-shared keys), this function is called with the identity provided by the client. If the return value is null the negotiation process will stop and an "unknown_psk_identity" alert message will be sent to the other party. If the server wishes to hide the fact that the PSK identity was not known, the callback must provide some random data as psk to make the connection fail with "decrypt_error" before negotiation is finished. PSK ciphers are disabled by default, and using TLS-PSK thus requires explicitly specifying a cipher suite with the ciphers option. More information can be found in the RFC 4279.

    Definition Classes
    TlsOptions
  43. val pskIdentityHint: UndefOr[String]

    hint to send to a client to help with selecting the identity during TLS-PSK negotiation.

    hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint tlsClientError will be emitted with ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED code.

    Definition Classes
    TlsOptions
  44. val rejectUnauthorized: UndefOr[Boolean]

    If true the server will reject any connection which is not authorized with the list of supplied CAs.

    If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

    Definition Classes
    CommonConnectionOptions
  45. val requestCert: UndefOr[Boolean]

    If true the server will request a certificate from clients that connect and attempt to verify that certificate.

    If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

    Definition Classes
    CommonConnectionOptions
  46. val secureContext: UndefOr[SecureContext]

    An optional TLS context object from tls.createSecureContext()

    An optional TLS context object from tls.createSecureContext()

    Definition Classes
    CommonConnectionOptions
  47. val secureOptions: UndefOr[Double]

    Optionally affect the OpenSSL protocol behavior, which is not usually necessary.

    Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options

    Definition Classes
    SecureContextOptions
  48. val secureProtocol: UndefOr[String]

    Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3.

    Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    Definition Classes
    SecureContextOptions
  49. val sessionIdContext: UndefOr[String]

    Opaque identifier used by servers to ensure session state is not shared between applications.

    Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.

    Definition Classes
    SecureContextOptions
  50. val sessionTimeout: UndefOr[Double]

    The number of seconds after which a TLS session created by the server will no longer be resumable.

    The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.

    Definition Classes
    SecureContextOptions
  51. val sigalgs: UndefOr[String]

    Colon-separated list of supported signature algorithms.

    Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).

    Definition Classes
    SecureContextOptions
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. val ticketKeys: UndefOr[Buffer]

    48-bytes of cryptographically strong pseudo-random data.

    48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.

    Definition Classes
    SecureContextOptions
  54. def toLocaleString(): String
    Definition Classes
    Object
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. def valueOf(): Any
    Definition Classes
    Object
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from httpMod.ServerOptions

Inherited from TlsOptions

Inherited from ServerOpts

Inherited from SecureContextOptions

Inherited from StObject

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped