security/manager/ssl/nsITransportSecurityInfo.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 interface nsIObjectOutputStream;
  10 interface nsIX509Cert;
  11
  12 %{ C++
  13 namespace IPC {
  14 class MessageWriter;
  15 }
  16 %}
  17
  18 [ptr] native IpcMessageWriterPtr(IPC::MessageWriter);
  19
  20 [builtinclass, scriptable, uuid(216112d3-28bc-4671-b057-f98cc09ba1ea)]
  21 interface nsITransportSecurityInfo : nsISupports {
  22     cenum OverridableErrorCategory : 32 {
  23       ERROR_UNSET,
  24       ERROR_TRUST,
  25       ERROR_DOMAIN,
  26       ERROR_TIME,
  27     };
  28
  29     readonly attribute unsigned long securityState;
  30     readonly attribute long errorCode; // PRErrorCode
  31     // errorCode as string (e.g. "SEC_ERROR_UNKNOWN_ISSUER")
  32     readonly attribute AString errorCodeString;
  33
  34     /**
  35      * The following parameters are only valid after the TLS handshake
  36      * has completed.  Check securityState first.
  37      */
  38
  39     /**
  40      * If certificate verification failed, this will be the peer certificate
  41      * chain provided in the handshake, so it can be used for error reporting.
  42      * If verification succeeded, this will be empty.
  43      */
  44     readonly attribute Array<nsIX509Cert> failedCertChain;
  45
  46     readonly attribute nsIX509Cert serverCert;
  47     readonly attribute Array<nsIX509Cert> succeededCertChain;
  48
  49     [must_use]
  50     readonly attribute ACString cipherName;
  51     [must_use]
  52     readonly attribute unsigned long keyLength;
  53     [must_use]
  54     readonly attribute unsigned long secretKeyLength;
  55     [must_use]
  56     readonly attribute ACString keaGroupName;
  57     [must_use]
  58     readonly attribute ACString signatureSchemeName;
  59
  60     const short SSL_VERSION_3   = 0;
  61     const short TLS_VERSION_1   = 1;
  62     const short TLS_VERSION_1_1 = 2;
  63     const short TLS_VERSION_1_2 = 3;
  64     const short TLS_VERSION_1_3 = 4;
  65     [must_use]
  66     readonly attribute unsigned short protocolVersion;
  67
  68     const short CERTIFICATE_TRANSPARENCY_NOT_APPLICABLE          = 0;
  69     const short CERTIFICATE_TRANSPARENCY_POLICY_COMPLIANT        = 5;
  70     const short CERTIFICATE_TRANSPARENCY_POLICY_NOT_ENOUGH_SCTS  = 6;
  71     const short CERTIFICATE_TRANSPARENCY_POLICY_NOT_DIVERSE_SCTS = 7;
  72     [must_use]
  73     readonly attribute unsigned short certificateTransparencyStatus;
  74
  75     [must_use]
  76     readonly attribute boolean isAcceptedEch;
  77     [must_use]
  78     readonly attribute boolean isDelegatedCredential;
  79     [must_use]
  80     readonly attribute nsITransportSecurityInfo_OverridableErrorCategory overridableErrorCategory;
  81
  82     /**
  83      * True if OCSP requests were made to query the status of certificates
  84      * used in this connection.
  85      */
  86     [must_use]
  87     readonly attribute boolean madeOCSPRequests;
  88
  89     /**
  90      * True if the DNS record used for this connection was fetched over an encrypted connection.
  91      */
  92     [must_use]
  93     readonly attribute boolean usedPrivateDNS;
  94
  95     /**
  96      * True only if (and after) serverCert was successfully validated as
  97      * Extended Validation (EV).
  98      */
  99     [must_use]
 100     readonly attribute boolean isExtendedValidation;
 101
 102     [notxpcom, noscript]
 103     void SerializeToIPC(in IpcMessageWriterPtr aWriter);
 104
 105     /**
 106      * Serializes the data represented in this interface to a base64-encoded
 107      * string that can be deserialized using TransportSecurityInfo::Read.
 108      */
 109     [must_use]
 110     ACString toString();
 111
 112     /* negotiatedNPN is '' if no NPN list was provided by the client,
 113      * or if the server did not select any protocol choice from that
 114      * list. That also includes the case where the server does not
 115      * implement NPN.
 116      *
 117      * If negotiatedNPN is read before NPN has progressed to the point
 118      * where this information is available NS_ERROR_NOT_CONNECTED is
 119      * raised.
 120      */
 121     readonly attribute ACString negotiatedNPN;
 122
 123     /**
 124      * True iff the connection was resumed using the resumption token.
 125      */
 126     readonly attribute boolean resumed;
 127
 128     /**
 129      * True iff the succeededCertChain is built in root.
 130      */
 131     readonly attribute boolean isBuiltCertChainRootBuiltInRoot;
 132
 133     /**
 134      * The id used to uniquely identify the connection to the peer.
 135      */
 136     readonly attribute ACString peerId;
 137 };