Interface HttpReceiverOptions

interface HttpReceiverOptions {
    allowHalfOpen?: boolean;
    ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
    ALPNProtocols?: string[] | Uint8Array | Uint8Array[];
    ca?: string | Buffer | (string | Buffer)[];
    cert?: string | Buffer | (string | Buffer)[];
    ciphers?: string;
    clientCertEngine?: string;
    connectionsCheckingInterval?: number;
    crl?: string | Buffer | (string | Buffer)[];
    dhparam?: string | Buffer;
    ecdhCurve?: string;
    enableTrace?: boolean;
    endpoints?: MaybeArray<string>;
    handshakeTimeout?: number;
    highWaterMark?: number;
    honorCipherOrder?: boolean;
    IncomingMessage?: typeof IncomingMessage;
    insecureHTTPParser?: boolean;
    joinDuplicateHeaders?: boolean;
    keepAlive?: boolean;
    keepAliveInitialDelay?: number;
    keepAliveTimeout?: number;
    key?: string | Buffer | (string | Buffer | KeyObject)[];
    logger?: Logger;
    logLevel?: LogLevel;
    maxHeaderSize?: number;
    maxVersion?: SecureVersion;
    minVersion?: SecureVersion;
    noDelay?: boolean;
    passphrase?: string;
    pauseOnConnect?: boolean;
    pfx?: string | Buffer | (string | Buffer | PxfObject)[];
    port?: string | number;
    privateKeyEngine?: string;
    privateKeyIdentifier?: string;
    pskCallback?: (
        socket: TLSSocket,
        identity: string,
    ) => DataView | TypedArray;
    pskIdentityHint?: string;
    rejectUnauthorized?: boolean;
    requestCert?: boolean;
    requestTimeout?: number;
    secureContext?: SecureContext;
    secureOptions?: number;
    secureProtocol?: string;
    ServerResponse?: typeof ServerResponse;
    sessionIdContext?: string;
    sessionTimeout?: number;
    sigalgs?: string;
    SNICallback?: (
        servername: string,
        cb: (err: Error, ctx?: SecureContext) => void,
    ) => void;
    ticketKeys?: Buffer;
    uniqueHeaders?: (string | string[])[];
    webhooksSecretToken: string;
}

Hierarchy

  • Partial<SecureServerOptions>
    • HttpReceiverOptions

Properties

allowHalfOpen? ALPNCallback? ALPNProtocols? ca? cert? ciphers? clientCertEngine? connectionsCheckingInterval? crl? dhparam? ecdhCurve? enableTrace? endpoints? handshakeTimeout? highWaterMark? honorCipherOrder? IncomingMessage? insecureHTTPParser? joinDuplicateHeaders? keepAlive? keepAliveInitialDelay? keepAliveTimeout? key? logger? logLevel? maxHeaderSize? maxVersion? minVersion? noDelay? passphrase? pauseOnConnect? pfx? port? privateKeyEngine? privateKeyIdentifier? pskCallback? pskIdentityHint? rejectUnauthorized? requestCert? requestTimeout? secureContext? secureOptions? secureProtocol? ServerResponse? sessionIdContext? sessionTimeout? sigalgs? SNICallback? ticketKeys? uniqueHeaders? webhooksSecretToken

Properties

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalALPNCallback

ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

OptionalALPNProtocols

ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

Optionalca

ca?: string | Buffer | (string | Buffer)[]

Optionalcert

cert?: string | Buffer | (string | Buffer)[]

Optionalciphers

ciphers?: string

OptionalclientCertEngine

clientCertEngine?: string

OptionalconnectionsCheckingInterval

connectionsCheckingInterval?: number

Optionalcrl

crl?: string | Buffer | (string | Buffer)[]

Optionaldhparam

dhparam?: string | Buffer

OptionalecdhCurve

ecdhCurve?: string

OptionalenableTrace

enableTrace?: boolean

Optionalendpoints

endpoints?: MaybeArray<string>

OptionalhandshakeTimeout

handshakeTimeout?: number

OptionalhighWaterMark

highWaterMark?: number

OptionalhonorCipherOrder

honorCipherOrder?: boolean

OptionalIncomingMessage

IncomingMessage?: typeof IncomingMessage

OptionalinsecureHTTPParser

insecureHTTPParser?: boolean

OptionaljoinDuplicateHeaders

joinDuplicateHeaders?: boolean

OptionalkeepAlive

keepAlive?: boolean

OptionalkeepAliveInitialDelay

keepAliveInitialDelay?: number

OptionalkeepAliveTimeout

keepAliveTimeout?: number

Optionalkey

key?: string | Buffer | (string | Buffer | KeyObject)[]

Optionallogger

logger?: Logger

OptionallogLevel

logLevel?: LogLevel

OptionalmaxHeaderSize

maxHeaderSize?: number

OptionalmaxVersion

maxVersion?: SecureVersion

OptionalminVersion

minVersion?: SecureVersion

OptionalnoDelay

noDelay?: boolean

Optionalpassphrase

passphrase?: string

OptionalpauseOnConnect

pauseOnConnect?: boolean

Optionalpfx

pfx?: string | Buffer | (string | Buffer | PxfObject)[]

Optionalport

port?: string | number

OptionalprivateKeyEngine

privateKeyEngine?: string

OptionalprivateKeyIdentifier

privateKeyIdentifier?: string

OptionalpskCallback

pskCallback?: (socket: TLSSocket, identity: string) => DataView | TypedArray

Type declaration

    • (socket: TLSSocket, identity: string): DataView | TypedArray

    • Parameters

      • socket: TLSSocket
      • identity: string

        identity parameter sent from the client.

      Returns DataView | TypedArray

      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.

OptionalpskIdentityHint

pskIdentityHint?: string

OptionalrejectUnauthorized

rejectUnauthorized?: boolean

OptionalrequestCert

requestCert?: boolean

OptionalrequestTimeout

requestTimeout?: number

OptionalsecureContext

secureContext?: SecureContext

OptionalsecureOptions

secureOptions?: number

OptionalsecureProtocol

secureProtocol?: string

OptionalServerResponse

ServerResponse?: typeof ServerResponse

OptionalsessionIdContext

sessionIdContext?: string

OptionalsessionTimeout

sessionTimeout?: number

Optionalsigalgs

sigalgs?: string

OptionalSNICallback

SNICallback?: (
    servername: string,
    cb: (err: Error, ctx?: SecureContext) => void,
) => void

OptionalticketKeys

ticketKeys?: Buffer

OptionaluniqueHeaders

uniqueHeaders?: (string | string[])[]

webhooksSecretToken

webhooksSecretToken: string

Settings

Member Visibility

On This Page

Properties