blob: 8e46c251bebc72ddda63e6415cccfc0c2548239b [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_SSL_SSL_INFO_H_
#define NET_SSL_SSL_INFO_H_
#include <vector>
#include "base/memory/ref_counted.h"
#include "net/base/net_export.h"
#include "net/cert/cert_status_flags.h"
#include "net/cert/ct_verify_result.h"
#include "net/cert/ocsp_verify_result.h"
#include "net/cert/sct_status_flags.h"
#include "net/cert/signed_certificate_timestamp_and_status.h"
#include "net/cert/x509_cert_types.h"
#include "net/ssl/ssl_config.h"
namespace net {
namespace ct {
enum class CertPolicyCompliance;
enum class EVPolicyCompliance;
} // namespace ct
class X509Certificate;
// SSL connection info.
// This is really a struct. All members are public.
class NET_EXPORT SSLInfo {
public:
// HandshakeType enumerates the possible resumption cases after an SSL
// handshake.
enum HandshakeType {
HANDSHAKE_UNKNOWN = 0,
HANDSHAKE_RESUME, // we resumed a previous session.
HANDSHAKE_FULL, // we negotiated a new session.
};
SSLInfo();
SSLInfo(const SSLInfo& info);
~SSLInfo();
SSLInfo& operator=(const SSLInfo& info);
void Reset();
bool is_valid() const { return cert.get() != NULL; }
// Adds the specified |error| to the cert status.
void SetCertError(int error);
// Adds the SignedCertificateTimestamps and policy compliance details
// from ct_verify_result to |signed_certificate_timestamps| and
// |ct_policy_compliance_details|. SCTs are held in three separate
// vectors in ct_verify_result, each vetor representing a particular
// verification state, this method associates each of the SCTs with
// the corresponding SCTVerifyStatus as it adds it to the
// |signed_certificate_timestamps| list.
void UpdateCertificateTransparencyInfo(
const ct::CTVerifyResult& ct_verify_result);
// The SSL certificate.
scoped_refptr<X509Certificate> cert;
// The SSL certificate as received by the client. Can be different
// from |cert|, which is the chain as built by the client during
// validation.
scoped_refptr<X509Certificate> unverified_cert;
// Bitmask of status info of |cert|, representing, for example, known errors
// and extended validation (EV) status.
// See cert_status_flags.h for values.
CertStatus cert_status;
// The security strength, in bits, of the SSL cipher suite.
// 0 means the connection is not encrypted.
// -1 means the security strength is unknown.
int security_bits;
// Security information of the SSL connection handshake.
// The meaning depends on the cipher used, see BoringSSL's |SSL_SESSION|'s
// key_exchange_info for more information.
// A zero indicates that the value is unknown.
int key_exchange_info;
// Information about the SSL connection itself. See
// ssl_connection_status_flags.h for values. The protocol version,
// ciphersuite, and compression in use are encoded within.
int connection_status;
// If the certificate is valid, then this is true iff it was rooted at a
// standard CA root. (As opposed to a user-installed root.)
bool is_issued_by_known_root;
// True if pinning was bypassed on this connection.
bool pkp_bypassed;
// True if a client certificate was sent to the server. Note that sending
// a Certificate message with no client certificate in it does not count.
bool client_cert_sent;
// True if a channel ID was sent to the server.
bool channel_id_sent;
// True if Token Binding was negotiated with the server and we agreed on a
// version and key params.
bool token_binding_negotiated;
// Only valid if |token_binding_negotiated| is true. Contains the key param
// negotiated by the client and server in the Token Binding Negotiation TLS
// extension.
TokenBindingParam token_binding_key_param;
HandshakeType handshake_type;
// The hashes, in several algorithms, of the SubjectPublicKeyInfos from
// each certificate in the chain.
HashValueVector public_key_hashes;
// pinning_failure_log contains a message produced by
// TransportSecurityState::PKPState::CheckPublicKeyPins in the event of a
// pinning failure. It is a (somewhat) human-readable string.
std::string pinning_failure_log;
// List of SignedCertificateTimestamps and their corresponding validation
// status.
SignedCertificateTimestampAndStatusList signed_certificate_timestamps;
// True if Certificate Transparency policies were applied on this
// connection and results are available. If true, the field below
// (|ev_policy_compliance|) will contain information about whether
// the connection complied with the policy and why the connection
// was considered non-compliant, if applicable.
bool ct_compliance_details_available;
// Whether the connection complied with the CT EV policy, and if not,
// why not. Only meaningful if |ct_compliance_details_available| is
// true.
ct::EVPolicyCompliance ct_ev_policy_compliance;
// Whether the connection complied with the CT cert policy, and if
// not, why not. Only meaningful it |ct_compliance_details_available|
// is true.
ct::CertPolicyCompliance ct_cert_policy_compliance;
// OCSP stapling details.
OCSPVerifyResult ocsp_result;
};
} // namespace net
#endif // NET_SSL_SSL_INFO_H_