Record: ClientSecureSocket

Provides configurations for facilitating secure communication with a remote HTTP endpoint.

Closed record


  • enable boolean(default true)
  • Enable SSL validation

  • cert TrustStore | string?
  • Configurations associated with crypto:TrustStore or single certificate file that the client trusts

  • key KeyStore | CertKey?
  • Configurations associated with crypto:KeyStore or combination of certificate and private key of the client

  • protocol record {| name Protocol, versions string[ ] |}?
  • SSL/TLS protocol related options

  • certValidation record {| 'type CertValidationType, cacheSize int, cacheValidityPeriod int |}?
  • Certificate validation against OCSP_CRL, OCSP_STAPLING related options

  • ciphers string[ ]?
  • List of ciphers to be used eg: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

  • verifyHostName boolean(default true)
  • Enable/disable host name verification

  • shareSession boolean(default true)
  • Enable/disable new SSL session creation

  • handshakeTimeout decimal?
  • SSL handshake time out

  • sessionTimeout decimal?
  • SSL session time out