BunFetchRequestInitTLS

Bun

Symbol

BunFetchRequestInitTLS

interface BunFetchRequestInitTLS

Extends Bun.TLSOptions with extra properties that are only supported in fetch(url, {tls: ...})

  • ca?: string | Buffer<ArrayBufferLike> | BunFile | string | Buffer<ArrayBufferLike> | BunFile[]

    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.

  • cert?: string | Buffer<ArrayBufferLike> | BunFile | string | Buffer<ArrayBufferLike> | BunFile[]

    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.

  • checkServerIdentity?: (hostname: string, cert: PeerCertificate) => undefined | Error

    Custom function to check the server identity

  • dhParamsFile?: string

    File path to a .pem file custom Diffie Helman parameters

  • key?: string | Buffer<ArrayBufferLike> | BunFile | string | Buffer<ArrayBufferLike> | BunFile[]

    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.

  • lowMemoryMode?: boolean

    This sets OPENSSL_RELEASE_BUFFERS to 1. It reduces overall performance but saves some memory.

  • passphrase?: string

    Passphrase for the TLS key

  • rejectUnauthorized?: boolean

    If set to false, any certificate is accepted. Default is $NODE_TLS_REJECT_UNAUTHORIZED environment variable, or true if it is not set.

  • requestCert?: boolean

    If set to true, the server will request a client certificate.

    Default is false.

  • secureOptions?: number

    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

  • serverName?: string

    Explicitly set a server name