net/base/cert_status_flags.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef NET_BASE_CERT_STATUS_FLAGS_H_
   6 #define NET_BASE_CERT_STATUS_FLAGS_H_
   7 #pragma once
   8
   9 #include "base/basictypes.h"
  10 #include "net/base/net_export.h"
  11
  12 namespace net {
  13
  14 // Bitmask of status flags of a certificate, representing any errors, as well as
  15 // other non-error status information such as whether the certificate is EV.
  16 typedef uint32 CertStatus;
  17
  18 // The possible status bits for CertStatus.
  19 // NOTE: Because these names have appeared in bug reports, we preserve them as
  20 // MACRO_STYLE for continuity, instead of renaming them to kConstantStyle as
  21 // befits most static consts.
  22 // Bits 0 to 15 are for errors.
  23 static const CertStatus CERT_STATUS_ALL_ERRORS                 = 0xFFFF;
  24 static const CertStatus CERT_STATUS_COMMON_NAME_INVALID        = 1 << 0;
  25 static const CertStatus CERT_STATUS_DATE_INVALID               = 1 << 1;
  26 static const CertStatus CERT_STATUS_AUTHORITY_INVALID          = 1 << 2;
  27 // 1 << 3 is reserved for ERR_CERT_CONTAINS_ERRORS (not useful with WinHTTP).
  28 static const CertStatus CERT_STATUS_NO_REVOCATION_MECHANISM    = 1 << 4;
  29 static const CertStatus CERT_STATUS_UNABLE_TO_CHECK_REVOCATION = 1 << 5;
  30 static const CertStatus CERT_STATUS_REVOKED                    = 1 << 6;
  31 static const CertStatus CERT_STATUS_INVALID                    = 1 << 7;
  32 static const CertStatus CERT_STATUS_WEAK_SIGNATURE_ALGORITHM   = 1 << 8;
  33 static const CertStatus CERT_STATUS_NOT_IN_DNS                 = 1 << 9;
  34 static const CertStatus CERT_STATUS_NON_UNIQUE_NAME            = 1 << 10;
  35 static const CertStatus CERT_STATUS_WEAK_KEY                   = 1 << 11;
  36
  37 // Bits 16 to 31 are for non-error statuses.
  38 static const CertStatus CERT_STATUS_IS_EV                      = 1 << 16;
  39 static const CertStatus CERT_STATUS_REV_CHECKING_ENABLED       = 1 << 17;
  40 static const CertStatus CERT_STATUS_IS_DNSSEC                  = 1 << 18;
  41
  42 // Returns true if the specified cert status has an error set.
  43 static inline bool IsCertStatusError(CertStatus status) {
  44   return (CERT_STATUS_ALL_ERRORS & status) != 0;
  45 }
  46
  47 // IsCertStatusMinorError returns true iff |cert_status| indicates a condition
  48 // that should typically be ignored by automated requests. (i.e. a revocation
  49 // check failure.)
  50 NET_EXPORT bool IsCertStatusMinorError(CertStatus cert_status);
  51
  52 // Maps a network error code to the equivalent certificate status flag.  If
  53 // the error code is not a certificate error, it is mapped to 0.
  54 NET_EXPORT CertStatus MapNetErrorToCertStatus(int error);
  55
  56 // Maps the most serious certificate error in the certificate status flags
  57 // to the equivalent network error code.
  58 NET_EXPORT int MapCertStatusToNetError(CertStatus cert_status);
  59
  60 }  // namespace net
  61
  62 #endif  // NET_BASE_CERT_STATUS_FLAGS_H_