DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (f2644bf19c9f)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsIArray;
interface nsIX509CertValidity;
interface nsIASN1Object;
interface nsICertVerificationListener;

%{ C++
namespace IPC {
  class Message;
}
class PickleIterator;

 /* forward declaration */
 typedef struct CERTCertificateStr CERTCertificate;
%}

[ptr] native CERTCertificatePtr(CERTCertificate);
[ptr] native IpcMessagePtr(IPC::Message);
[ptr] native PickleIteratorPtr(PickleIterator);

/**
 * This represents a X.509 certificate.
 *
 * NOTE: Service workers persist x.509 certs in object form on disk.  If you
 *       change this uuid you probably need a hack in nsBinaryInputStream to
 *       read the old uuid.  If you change the format of the object
 *       serialization then more complex changes will be needed.
 */
[scriptable, builtinclass, uuid(bdc3979a-5422-4cd5-8589-696b6e96ea83)]
interface nsIX509Cert : nsISupports {

  /**
   *  The primary email address of the certificate, if present.
   */
  readonly attribute AString emailAddress;

  /**
   * Did this certificate ship with the platform as a built-in root?
   */
  [must_use]
  readonly attribute bool isBuiltInRoot;

  /**
   *  Obtain a list of all email addresses
   *  contained in the certificate.
   *
   *  @return An array of email addresses.
   */
  [must_use]
  Array<AString> getEmailAddresses();

  /**
   *  Check whether a given address is contained in the certificate.
   *  The comparison will convert the email address to lowercase.
   *  The behaviour for non ASCII characters is undefined.
   *
   *  @param aEmailAddress The address to search for.
   *
   *  @return True if the address is contained in the certificate.
   */
  [must_use]
  boolean containsEmailAddress(in AString aEmailAddress);

  /**
   *  The subject owning the certificate.
   */
  readonly attribute AString subjectName;

  /**
   *  The subject alternative names of the certificate.
   *  It's a comma separated string of subject alt names.
   */
  readonly attribute AString subjectAltNames;

  /**
   *  The subject's common name.
   */
  readonly attribute AString commonName;

  /**
   *  The subject's organization.
   */
  readonly attribute AString organization;

  /**
   *  The subject's organizational unit.
   */
  [must_use]
  readonly attribute AString organizationalUnit;

  /**
   *  The fingerprint of the certificate's DER encoding,
   *  calculated using the SHA-256 algorithm.
   */
  readonly attribute AString sha256Fingerprint;

  /**
   *  The fingerprint of the certificate's DER encoding,
   *  calculated using the SHA1 algorithm.
   */
  [must_use]
  readonly attribute AString sha1Fingerprint;

  /**
   *  A human readable name identifying the hardware or
   *  software token the certificate is stored on.
   */
  readonly attribute AString tokenName;

  /**
   *  The subject identifying the issuer certificate.
   */
  readonly attribute AString issuerName;

  /**
   *  The serial number the issuer assigned to this certificate.
   */
  [must_use]
  readonly attribute AString serialNumber;

  /**
   *  The issuer subject's common name.
   */
  [must_use]
  readonly attribute AString issuerCommonName;

  /**
   *  The issuer subject's organization.
   */
  readonly attribute AString issuerOrganization;

  /**
   *  The issuer subject's organizational unit.
   */
  [must_use]
  readonly attribute AString issuerOrganizationUnit;

  /**
   *  This certificate's validity period.
   */
  readonly attribute nsIX509CertValidity validity;

  /**
   *  A unique identifier of this certificate within the local storage.
   */
  [must_use]
  readonly attribute ACString dbKey;

  /**
   *  A human readable identifier to label this certificate.
   */
  [must_use]
  readonly attribute AString displayName;

  /**
   *  Constants to classify the type of a certificate.
   */
  const unsigned long UNKNOWN_CERT =      0;
  const unsigned long CA_CERT      = 1 << 0;
  const unsigned long USER_CERT    = 1 << 1;
  const unsigned long EMAIL_CERT   = 1 << 2;
  const unsigned long SERVER_CERT  = 1 << 3;
  const unsigned long ANY_CERT     = 0xffff;

  /**
   * Type of this certificate
   */
  readonly attribute unsigned long certType;

  /**
   *  True if the certificate is self-signed. CA issued
   *  certificates are always self-signed.
   */
  [must_use]
  readonly attribute boolean isSelfSigned;

  /**
   * A comma separated list of localized strings representing the contents of
   * the certificate's key usage extension, if present. The empty string if the
   * certificate doesn't have the key usage extension, or has an empty extension.
   */
  [must_use]
  readonly attribute AString keyUsages;

  /**
   *  This is the attribute which describes the ASN1 layout
   *  of the certificate.  This can be used when doing a
   *  "pretty print" of the certificate's ASN1 structure.
   */
  [must_use]
  readonly attribute nsIASN1Object ASN1Structure;

  /**
   *  Obtain a raw binary encoding of this certificate
   *  in DER format.
   *
   *  @return The bytes representing the DER encoded certificate.
   */
  [must_use]
  Array<octet> getRawDER();

  /**
   *  Obtain a base 64 string representation of this certificate
   *  in DER format.
   *
   *  @return The DER encoded certificate as a string.
   */
  [must_use]
  ACString getBase64DERString();

  /**
   *  Test whether two certificate instances represent the
   *  same certificate.
   *
   *  @return Whether the certificates are equal
   */
  [must_use]
  boolean equals(in nsIX509Cert other);

  /**
   * The base64 encoding of the DER encoded public key info using the specified
   * digest.
   */
  [must_use]
  readonly attribute ACString sha256SubjectPublicKeyInfoDigest;

  /**
   * Retrieves the NSS certificate object wrapped by this interface
   */
  [notxpcom, noscript, must_use]
  CERTCertificatePtr getCert();

  /**
   * Either delete the certificate from all cert databases,
   * or mark it as untrusted.
   */
  [must_use]
  void markForPermDeletion();

  [notxpcom, noscript]
  void SerializeToIPC(in IpcMessagePtr aMsg);

  [notxpcom, noscript]
  bool DeserializeFromIPC([const] in IpcMessagePtr aMsg, in PickleIteratorPtr aIter);
};