method

tls.TLSSocket.getPeerCertificate

detailed: true

Returns an object representing the peer's certificate. If the peer does not provide a certificate, an empty object will be returned. If the socket has been destroyed, null will be returned.

If the full certificate chain was requested, each certificate will include anissuerCertificate property containing an object representing its issuer's certificate.

@param detailed

Include the full certificate chain if true, otherwise include just the peer's certificate.

@returns

A certificate object.

detailed?: false

Returns an object representing the peer's certificate. If the peer does not provide a certificate, an empty object will be returned. If the socket has been destroyed, null will be returned.

If the full certificate chain was requested, each certificate will include anissuerCertificate property containing an object representing its issuer's certificate.

@param detailed

Include the full certificate chain if true, otherwise include just the peer's certificate.

@returns

A certificate object.

detailed?: boolean

Returns an object representing the peer's certificate. If the peer does not provide a certificate, an empty object will be returned. If the socket has been destroyed, null will be returned.

If the full certificate chain was requested, each certificate will include anissuerCertificate property containing an object representing its issuer's certificate.

@param detailed

Include the full certificate chain if true, otherwise include just the peer's certificate.

@returns

A certificate object.

Referenced types

interface DetailedPeerCertificate

  • asn1Curve?: string

    The ASN.1 name of the OID of the elliptic curve. Well-known curves are identified by an OID. While it is unusual, it is possible that the curve is identified by its mathematical properties, in which case it will not have an OID.

  • bits?: number

    For RSA keys: The RSA bit size.

    For EC keys: The key size in bits.

  • ca: boolean

    true if a Certificate Authority (CA), false otherwise.

  • exponent?: string

    The RSA exponent, as a string in hexadecimal number notation.

  • ext_key_usage?: string[]

    The extended key usage, a set of OIDs.

  • fingerprint: string

    The SHA-1 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

  • fingerprint256: string

    The SHA-256 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

  • fingerprint512: string

    The SHA-512 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

  • infoAccess?: Dict<string[]>

    An array describing the AuthorityInfoAccess, used with OCSP.

  • issuer: Certificate

    The certificate issuer, described in the same terms as the subject.

  • issuerCertificate: DetailedPeerCertificate

    The issuer certificate object. For self-signed certificates, this may be a circular reference.

  • modulus?: string

    The RSA modulus, as a hexadecimal string.

  • nistCurve?: string

    The NIST name for the elliptic curve, if it has one (not all well-known curves have been assigned names by NIST).

  • pubkey?: NonSharedBuffer

    The public key.

  • raw: NonSharedBuffer

    The DER encoded X.509 certificate data.

  • serialNumber: string

    The certificate serial number, as a hex string.

  • subject: Certificate

    The certificate subject.

  • subjectaltname?: string

    A string containing concatenated names for the subject, an alternative to the subject names.

  • valid_from: string

    The date-time the certificate is valid from.

  • valid_to: string

    The date-time the certificate is valid to.

interface PeerCertificate

  • asn1Curve?: string

    The ASN.1 name of the OID of the elliptic curve. Well-known curves are identified by an OID. While it is unusual, it is possible that the curve is identified by its mathematical properties, in which case it will not have an OID.

  • bits?: number

    For RSA keys: The RSA bit size.

    For EC keys: The key size in bits.

  • ca: boolean

    true if a Certificate Authority (CA), false otherwise.

  • exponent?: string

    The RSA exponent, as a string in hexadecimal number notation.

  • ext_key_usage?: string[]

    The extended key usage, a set of OIDs.

  • fingerprint: string

    The SHA-1 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

  • fingerprint256: string

    The SHA-256 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

  • fingerprint512: string

    The SHA-512 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

  • infoAccess?: Dict<string[]>

    An array describing the AuthorityInfoAccess, used with OCSP.

  • issuer: Certificate

    The certificate issuer, described in the same terms as the subject.

  • modulus?: string

    The RSA modulus, as a hexadecimal string.

  • nistCurve?: string

    The NIST name for the elliptic curve, if it has one (not all well-known curves have been assigned names by NIST).

  • pubkey?: NonSharedBuffer

    The public key.

  • raw: NonSharedBuffer

    The DER encoded X.509 certificate data.

  • serialNumber: string

    The certificate serial number, as a hex string.

  • subject: Certificate

    The certificate subject.

  • subjectaltname?: string

    A string containing concatenated names for the subject, an alternative to the subject names.

  • valid_from: string

    The date-time the certificate is valid from.

  • valid_to: string

    The date-time the certificate is valid to.