ssl_error_info.h revision 5821806d5e7f356e8fa4b058a389a808ea183019 
1// Copyright (c) 2011 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 CHROME_BROWSER_SSL_SSL_ERROR_INFO_H_
6#define CHROME_BROWSER_SSL_SSL_ERROR_INFO_H_
7
8#include <string>
9#include <vector>
10
11#include "base/string16.h"
12#include "net/base/cert_status_flags.h"
13#include "net/base/x509_certificate.h"
14
15class GURL;
16
17// This class describes an error that happened while showing a page over SSL.
18// An SSLErrorInfo object only exists on the UI thread and only contains
19// information about an error (type of error and text details).
20// Note no DISALLOW_COPY_AND_ASSIGN as we want the copy constructor.
21class SSLErrorInfo {
22 public:
23  enum ErrorType {
24    CERT_COMMON_NAME_INVALID = 0,
25    CERT_DATE_INVALID,
26    CERT_AUTHORITY_INVALID,
27    CERT_CONTAINS_ERRORS,
28    CERT_NO_REVOCATION_MECHANISM,
29    CERT_UNABLE_TO_CHECK_REVOCATION,
30    CERT_REVOKED,
31    CERT_INVALID,
32    CERT_WEAK_SIGNATURE_ALGORITHM,
33    CERT_WEAK_KEY,
34    UNKNOWN
35  };
36
37  virtual ~SSLErrorInfo();
38
39  // Converts a network error code to an ErrorType.
40  static ErrorType NetErrorToErrorType(int net_error);
41
42  static SSLErrorInfo CreateError(ErrorType error_type,
43                                  net::X509Certificate* cert,
44                                  const GURL& request_url);
45
46  // Populates the specified |errors| vector with the errors contained in
47  // |cert_status|.  Returns the number of errors found.
48  // Callers only interested in the error count can pass NULL for |errors|.
49  // TODO(wtc): Document |cert_id| and |url| arguments.
50  static int GetErrorsForCertStatus(int cert_id,
51                                    net::CertStatus cert_status,
52                                    const GURL& url,
53                                    std::vector<SSLErrorInfo>* errors);
54
55  // A title describing the error, usually to be used with the details below.
56  const string16& title() const { return title_; }
57
58  // A description of the error.
59  const string16& details() const { return details_; }
60
61  // A short message describing the error (1 line).
62  const string16& short_description() const { return short_description_; }
63
64  // A lengthy explanation of what the error is.  Each entry in the returned
65  // vector is a paragraph.
66  const std::vector<string16>& extra_information() const {
67    return extra_information_;
68  }
69
70 private:
71  SSLErrorInfo(const string16& title,
72               const string16& details,
73               const string16& short_description,
74               const std::vector<string16>& extra_info);
75
76  string16 title_;
77  string16 details_;
78  string16 short_description_;
79  // Extra-informations contains paragraphs of text explaining in details what
80  // the error is and what the risks are.
81  std::vector<string16> extra_information_;
82};
83
84#endif  // CHROME_BROWSER_SSL_SSL_ERROR_INFO_H_
85