Type Alias HttpsOptions

Type declaration

• OptionalalpnProtocols?: string[]

• OptionalrejectUnauthorized?: NativeRequestOptions["rejectUnauthorized"]

• OptionalcheckServerIdentity?: CheckServerIdentityFunction

• OptionalcertificateAuthority?: SecureContextOptions["ca"]

  Override the default Certificate Authorities (from Mozilla).

  Example

  // Single Certificate Authority
  await got('https://example.com', {
      https: {
          certificateAuthority: fs.readFileSync('./my_ca.pem')
      }
  });
  Copy

• Optionalkey?: SecureContextOptions["key"]

  Private keys in PEM format.

  PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.https.passphrase.

  Multiple keys with different passphrases can be provided as an array of {pem: <string | Buffer>, passphrase: <string>}

• Optionalcertificate?: SecureContextOptions["cert"]

  Certificate chains in PEM format.

  One cert chain should be provided per private key (options.https.key).

  When providing multiple cert chains, they do not have to be in the same order as their private keys in options.https.key.

  If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

• Optionalpassphrase?: SecureContextOptions["passphrase"]

  The passphrase to decrypt the options.https.key (if different keys have different passphrases refer to options.https.key documentation).

• Optionalpfx?: PfxType

• Optionalciphers?: SecureContextOptions["ciphers"]

• OptionalhonorCipherOrder?: SecureContextOptions["honorCipherOrder"]

• OptionalminVersion?: SecureContextOptions["minVersion"]

• OptionalmaxVersion?: SecureContextOptions["maxVersion"]

• OptionalsignatureAlgorithms?: SecureContextOptions["sigalgs"]

• OptionaltlsSessionLifetime?: SecureContextOptions["sessionTimeout"]

• Optionaldhparam?: SecureContextOptions["dhparam"]

• OptionalecdhCurve?: SecureContextOptions["ecdhCurve"]

• OptionalcertificateRevocationLists?: SecureContextOptions["crl"]