123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537 |
- // Copyright 2014 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.
- #include "net/log/net_log_util.h"
- #include <algorithm>
- #include <string>
- #include <utility>
- #include <vector>
- #include "base/check_op.h"
- #include "base/feature_list.h"
- #include "base/metrics/field_trial.h"
- #include "base/strings/strcat.h"
- #include "base/strings/string_number_conversions.h"
- #include "base/strings/string_split.h"
- #include "base/strings/string_util.h"
- #include "base/time/time.h"
- #include "base/values.h"
- #include "net/base/address_family.h"
- #include "net/base/load_states.h"
- #include "net/base/net_errors.h"
- #include "net/base/net_info_source_list.h"
- #include "net/cert/cert_verifier.h"
- #include "net/cert/pki/simple_path_builder_delegate.h"
- #include "net/cert/pki/trust_store.h"
- #include "net/disk_cache/disk_cache.h"
- #include "net/dns/host_cache.h"
- #include "net/dns/host_resolver.h"
- #include "net/dns/public/dns_query_type.h"
- #include "net/dns/public/doh_provider_entry.h"
- #include "net/dns/public/secure_dns_mode.h"
- #include "net/http/http_cache.h"
- #include "net/http/http_network_session.h"
- #include "net/http/http_server_properties.h"
- #include "net/http/http_transaction_factory.h"
- #include "net/log/net_log_capture_mode.h"
- #include "net/log/net_log_entry.h"
- #include "net/log/net_log_event_type.h"
- #include "net/log/net_log_values.h"
- #include "net/log/net_log_with_source.h"
- #include "net/proxy_resolution/proxy_config.h"
- #include "net/proxy_resolution/proxy_resolution_service.h"
- #include "net/proxy_resolution/proxy_retry_info.h"
- #include "net/socket/ssl_client_socket.h"
- #include "net/third_party/quiche/src/quiche/quic/core/quic_error_codes.h"
- #include "net/third_party/quiche/src/quiche/quic/core/quic_packets.h"
- #include "net/url_request/url_request.h"
- #include "net/url_request/url_request_context.h"
- #if BUILDFLAG(ENABLE_REPORTING)
- #include "net/network_error_logging/network_error_logging_service.h"
- #include "net/reporting/reporting_service.h"
- #endif // BUILDFLAG(ENABLE_REPORTING)
- namespace net {
- namespace {
- // This should be incremented when significant changes are made that will
- // invalidate the old loading code.
- const int kLogFormatVersion = 1;
- struct StringToConstant {
- const char* name;
- const int constant;
- };
- const StringToConstant kCertStatusFlags[] = {
- #define CERT_STATUS_FLAG(label, value) {#label, value},
- #include "net/cert/cert_status_flags_list.h"
- #undef CERT_STATUS_FLAG
- };
- const StringToConstant kLoadFlags[] = {
- #define LOAD_FLAG(label, value) {#label, value},
- #include "net/base/load_flags_list.h"
- #undef LOAD_FLAG
- };
- const StringToConstant kLoadStateTable[] = {
- #define LOAD_STATE(label, value) {#label, LOAD_STATE_##label},
- #include "net/base/load_states_list.h"
- #undef LOAD_STATE
- };
- const short kNetErrors[] = {
- #define NET_ERROR(label, value) value,
- #include "net/base/net_error_list.h"
- #undef NET_ERROR
- };
- // Returns the disk cache backend for |context| if there is one, or NULL.
- // Despite the name, can return an in memory "disk cache".
- disk_cache::Backend* GetDiskCacheBackend(URLRequestContext* context) {
- if (!context->http_transaction_factory())
- return nullptr;
- HttpCache* http_cache = context->http_transaction_factory()->GetCache();
- if (!http_cache)
- return nullptr;
- return http_cache->GetCurrentBackend();
- }
- // Returns true if |request1| was created before |request2|.
- bool RequestCreatedBefore(const URLRequest* request1,
- const URLRequest* request2) {
- // Only supported when both requests have the same non-null NetLog.
- DCHECK(request1->net_log().net_log());
- DCHECK_EQ(request1->net_log().net_log(), request2->net_log().net_log());
- if (request1->creation_time() < request2->creation_time())
- return true;
- if (request1->creation_time() > request2->creation_time())
- return false;
- // If requests were created at the same time, sort by NetLogSource ID. Some
- // NetLog tests assume the returned order exactly matches creation order, even
- // creation times of two events are potentially the same.
- return request1->net_log().source().id < request2->net_log().source().id;
- }
- base::Value GetActiveFieldTrialList() {
- base::FieldTrial::ActiveGroups active_groups;
- base::FieldTrialList::GetActiveFieldTrialGroups(&active_groups);
- base::Value::List field_trial_groups;
- for (const auto& group : active_groups) {
- field_trial_groups.Append(group.trial_name + ":" + group.group_name);
- }
- return base::Value(std::move(field_trial_groups));
- }
- } // namespace
- base::Value::Dict GetNetConstants() {
- base::Value::Dict constants_dict;
- // Version of the file format.
- constants_dict.Set("logFormatVersion", kLogFormatVersion);
- // Add a dictionary with information on the relationship between event type
- // enums and their symbolic names.
- constants_dict.Set("logEventTypes", NetLog::GetEventTypesAsValue());
- // Add a dictionary with information about the relationship between CertStatus
- // flags and their symbolic names.
- {
- base::Value::Dict dict;
- for (const auto& flag : kCertStatusFlags)
- dict.Set(flag.name, flag.constant);
- constants_dict.Set("certStatusFlag", std::move(dict));
- }
- // Add a dictionary with information about the relationship between
- // CertVerifier::VerifyFlags and their symbolic names.
- {
- base::Value::Dict dict;
- dict.Set("VERIFY_DISABLE_NETWORK_FETCHES",
- CertVerifier::VERIFY_DISABLE_NETWORK_FETCHES);
- static_assert(CertVerifier::VERIFY_FLAGS_LAST == (1 << 0),
- "Update with new flags");
- constants_dict.Set("certVerifierFlags", std::move(dict));
- }
- {
- base::Value::Dict dict;
- dict.Set("kStrong", static_cast<int>(
- SimplePathBuilderDelegate::DigestPolicy::kStrong));
- dict.Set("kWeakAllowSha1",
- static_cast<int>(
- SimplePathBuilderDelegate::DigestPolicy::kWeakAllowSha1));
- static_assert(SimplePathBuilderDelegate::DigestPolicy::kMaxValue ==
- SimplePathBuilderDelegate::DigestPolicy::kWeakAllowSha1,
- "Update with new flags");
- constants_dict.Set("certPathBuilderDigestPolicy", std::move(dict));
- }
- {
- base::Value::Dict dict;
- dict.Set("DISTRUSTED", static_cast<int>(CertificateTrustType::DISTRUSTED));
- dict.Set("UNSPECIFIED",
- static_cast<int>(CertificateTrustType::UNSPECIFIED));
- dict.Set("TRUSTED_ANCHOR",
- static_cast<int>(CertificateTrustType::TRUSTED_ANCHOR));
- dict.Set(
- "TRUSTED_ANCHOR_WITH_EXPIRATION",
- static_cast<int>(CertificateTrustType::TRUSTED_ANCHOR_WITH_EXPIRATION));
- dict.Set("TRUSTED_ANCHOR_WITH_CONSTRAINTS",
- static_cast<int>(
- CertificateTrustType::TRUSTED_ANCHOR_WITH_CONSTRAINTS));
- static_assert(CertificateTrustType::LAST ==
- CertificateTrustType::TRUSTED_ANCHOR_WITH_CONSTRAINTS,
- "Update with new flags");
- constants_dict.Set("certificateTrustType", std::move(dict));
- }
- // Add a dictionary with information about the relationship between load flag
- // enums and their symbolic names.
- {
- base::Value::Dict dict;
- for (const auto& flag : kLoadFlags)
- dict.Set(flag.name, flag.constant);
- constants_dict.Set("loadFlag", std::move(dict));
- }
- // Add a dictionary with information about the relationship between load state
- // enums and their symbolic names.
- {
- base::Value::Dict dict;
- for (const auto& state : kLoadStateTable)
- dict.Set(state.name, state.constant);
- constants_dict.Set("loadState", std::move(dict));
- }
- // Add information on the relationship between net error codes and their
- // symbolic names.
- {
- base::Value::Dict dict;
- for (const auto& error : kNetErrors)
- dict.Set(ErrorToShortString(error), error);
- constants_dict.Set("netError", std::move(dict));
- }
- // Add information on the relationship between QUIC error codes and their
- // symbolic names.
- {
- base::Value::Dict dict;
- for (quic::QuicErrorCode error = quic::QUIC_NO_ERROR;
- error < quic::QUIC_LAST_ERROR;
- error = static_cast<quic::QuicErrorCode>(error + 1)) {
- dict.Set(QuicErrorCodeToString(error), static_cast<int>(error));
- }
- constants_dict.Set("quicError", std::move(dict));
- }
- // Add information on the relationship between QUIC RST_STREAM error codes
- // and their symbolic names.
- {
- base::Value::Dict dict;
- for (quic::QuicRstStreamErrorCode error = quic::QUIC_STREAM_NO_ERROR;
- error < quic::QUIC_STREAM_LAST_ERROR;
- error = static_cast<quic::QuicRstStreamErrorCode>(error + 1)) {
- dict.Set(QuicRstStreamErrorCodeToString(error), static_cast<int>(error));
- }
- constants_dict.Set("quicRstStreamError", std::move(dict));
- }
- // Information about the relationship between event phase enums and their
- // symbolic names.
- {
- base::Value::Dict dict;
- dict.Set("PHASE_BEGIN", static_cast<int>(NetLogEventPhase::BEGIN));
- dict.Set("PHASE_END", static_cast<int>(NetLogEventPhase::END));
- dict.Set("PHASE_NONE", static_cast<int>(NetLogEventPhase::NONE));
- constants_dict.Set("logEventPhase", std::move(dict));
- }
- // Information about the relationship between source type enums and
- // their symbolic names.
- constants_dict.Set("logSourceType", NetLog::GetSourceTypesAsValue());
- // Information about the relationship between address family enums and
- // their symbolic names.
- {
- base::Value::Dict dict;
- dict.Set("ADDRESS_FAMILY_UNSPECIFIED", ADDRESS_FAMILY_UNSPECIFIED);
- dict.Set("ADDRESS_FAMILY_IPV4", ADDRESS_FAMILY_IPV4);
- dict.Set("ADDRESS_FAMILY_IPV6", ADDRESS_FAMILY_IPV6);
- constants_dict.Set("addressFamily", std::move(dict));
- }
- // Information about the relationship between DnsQueryType enums and their
- // symbolic names.
- {
- base::Value::Dict dict;
- for (const auto& type : kDnsQueryTypes) {
- dict.Set(type.second, static_cast<int>(type.first));
- }
- constants_dict.Set("dnsQueryType", std::move(dict));
- }
- // Information about the relationship between SecureDnsMode enums and their
- // symbolic names.
- {
- base::Value::Dict dict;
- for (const auto& mode : kSecureDnsModes) {
- dict.Set(mode.second, static_cast<int>(mode.first));
- }
- constants_dict.Set("secureDnsMode", std::move(dict));
- }
- // Information about how the "time ticks" values we have given it relate to
- // actual system times. Time ticks are used throughout since they are stable
- // across system clock changes. Note: |timeTickOffset| is only comparable to
- // TimeTicks values in milliseconds.
- // TODO(csharrison): This is an imprecise way to convert TimeTicks to unix
- // time. In fact, there isn't really a good way to do this unless we log Time
- // and TimeTicks values side by side for every event. crbug.com/593157 tracks
- // a change where the user will be notified if a timing anomaly occured that
- // would skew the conversion (i.e. the machine entered suspend mode while
- // logging).
- {
- base::TimeDelta time_since_epoch =
- base::Time::Now() - base::Time::UnixEpoch();
- base::TimeDelta reference_time_ticks =
- base::TimeTicks::Now() - base::TimeTicks();
- int64_t tick_to_unix_time_ms =
- (time_since_epoch - reference_time_ticks).InMilliseconds();
- constants_dict.Set("timeTickOffset",
- NetLogNumberValue(tick_to_unix_time_ms));
- }
- // TODO(eroman): Is this needed?
- // "clientInfo" key is required for some log readers. Provide a default empty
- // value for compatibility.
- constants_dict.Set("clientInfo", base::Value::Dict());
- // Add a list of field experiments active at the start of the capture.
- // Additional trials may be enabled later in the browser session.
- constants_dict.Set(kNetInfoFieldTrials, GetActiveFieldTrialList());
- return constants_dict;
- }
- NET_EXPORT base::Value::Dict GetNetInfo(URLRequestContext* context) {
- // May only be called on the context's thread.
- context->AssertCalledOnValidThread();
- base::Value::Dict net_info_dict =
- context->proxy_resolution_service()->GetProxyNetLogValues();
- // Log Host Resolver info.
- {
- HostResolver* host_resolver = context->host_resolver();
- DCHECK(host_resolver);
- HostCache* cache = host_resolver->GetHostCache();
- if (cache) {
- base::Value::Dict dict;
- base::Value dns_config = host_resolver->GetDnsConfigAsValue();
- dict.Set("dns_config", std::move(dns_config));
- base::Value::Dict cache_info_dict;
- base::Value::List cache_contents_list;
- cache_info_dict.Set("capacity", static_cast<int>(cache->max_entries()));
- cache_info_dict.Set("network_changes", cache->network_changes());
- cache->GetList(cache_contents_list, true /* include_staleness */,
- HostCache::SerializationType::kDebug);
- cache_info_dict.Set("entries", std::move(cache_contents_list));
- dict.Set("cache", std::move(cache_info_dict));
- net_info_dict.Set(kNetInfoHostResolver, std::move(dict));
- }
- // Construct a list containing the names of the disabled DoH providers.
- base::Value::List disabled_doh_providers_list;
- for (const DohProviderEntry* provider : DohProviderEntry::GetList()) {
- if (!base::FeatureList::IsEnabled(provider->feature)) {
- disabled_doh_providers_list.Append(
- NetLogStringValue(provider->provider));
- }
- }
- net_info_dict.Set(kNetInfoDohProvidersDisabledDueToFeature,
- base::Value(std::move(disabled_doh_providers_list)));
- }
- HttpNetworkSession* http_network_session =
- context->http_transaction_factory()->GetSession();
- // Log Socket Pool info.
- {
- net_info_dict.Set(kNetInfoSocketPool,
- http_network_session->SocketPoolInfoToValue());
- }
- // Log SPDY Sessions.
- {
- net_info_dict.Set(kNetInfoSpdySessions,
- base::Value::FromUniquePtrValue(
- http_network_session->SpdySessionPoolInfoToValue()));
- }
- // Log SPDY status.
- {
- base::Value::Dict status_dict;
- status_dict.Set("enable_http2",
- http_network_session->params().enable_http2);
- const NextProtoVector& alpn_protos = http_network_session->GetAlpnProtos();
- if (!alpn_protos.empty()) {
- std::string next_protos_string;
- for (NextProto proto : alpn_protos) {
- if (!next_protos_string.empty())
- next_protos_string.append(",");
- next_protos_string.append(NextProtoToString(proto));
- }
- status_dict.Set("alpn_protos", next_protos_string);
- }
- const SSLConfig::ApplicationSettings& application_settings =
- http_network_session->GetApplicationSettings();
- if (!application_settings.empty()) {
- base::Value::Dict application_settings_dict;
- for (const auto& setting : application_settings) {
- application_settings_dict.Set(
- NextProtoToString(setting.first),
- base::HexEncode(setting.second.data(), setting.second.size()));
- }
- status_dict.Set("application_settings",
- std::move(application_settings_dict));
- }
- net_info_dict.Set(kNetInfoSpdyStatus, std::move(status_dict));
- }
- // Log ALT_SVC mappings.
- {
- const HttpServerProperties& http_server_properties =
- *context->http_server_properties();
- net_info_dict.Set(
- kNetInfoAltSvcMappings,
- http_server_properties.GetAlternativeServiceInfoAsValue());
- }
- // Log QUIC info.
- { net_info_dict.Set(kNetInfoQuic, http_network_session->QuicInfoToValue()); }
- // Log HTTP Cache info.
- {
- base::Value::Dict info_dict;
- base::Value::Dict stats_dict;
- disk_cache::Backend* disk_cache = GetDiskCacheBackend(context);
- if (disk_cache) {
- // Extract the statistics key/value pairs from the backend.
- base::StringPairs stats;
- disk_cache->GetStats(&stats);
- for (auto& stat : stats) {
- stats_dict.Set(stat.first, std::move(stat.second));
- }
- }
- info_dict.Set("stats", std::move(stats_dict));
- net_info_dict.Set(kNetInfoHTTPCache, std::move(info_dict));
- }
- // Log Reporting API info.
- {
- #if BUILDFLAG(ENABLE_REPORTING)
- ReportingService* reporting_service = context->reporting_service();
- if (reporting_service) {
- base::Value reporting_value = reporting_service->StatusAsValue();
- NetworkErrorLoggingService* network_error_logging_service =
- context->network_error_logging_service();
- if (network_error_logging_service) {
- reporting_value.GetDict().Set(
- "networkErrorLogging",
- network_error_logging_service->StatusAsValue());
- }
- net_info_dict.Set(kNetInfoReporting, std::move(reporting_value));
- } else {
- base::Value::Dict reporting_dict;
- reporting_dict.Set("reportingEnabled", false);
- net_info_dict.Set(kNetInfoReporting, std::move(reporting_dict));
- }
- #else // BUILDFLAG(ENABLE_REPORTING)
- base::Value::Dict reporting_dict;
- reporting_dict.Set("reportingEnabled", false);
- net_info_dict.Set(kNetInfoReporting, std::move(reporting_dict));
- #endif // BUILDFLAG(ENABLE_REPORTING)
- }
- // Log currently-active field trials. New trials may have been enabled since
- // the start of this browser session (crbug.com/1133396).
- net_info_dict.Set(kNetInfoFieldTrials, GetActiveFieldTrialList());
- return net_info_dict;
- }
- NET_EXPORT void CreateNetLogEntriesForActiveObjects(
- const std::set<URLRequestContext*>& contexts,
- NetLog::ThreadSafeObserver* observer) {
- // Put together the list of all requests.
- std::vector<const URLRequest*> requests;
- for (auto* context : contexts) {
- // May only be called on the context's thread.
- context->AssertCalledOnValidThread();
- // Contexts should all be using the same NetLog.
- DCHECK_EQ((*contexts.begin())->net_log(), context->net_log());
- for (auto* request : *context->url_requests()) {
- requests.push_back(request);
- }
- }
- // Sort by creation time.
- std::sort(requests.begin(), requests.end(), RequestCreatedBefore);
- // Create fake events.
- for (auto* request : requests) {
- NetLogEntry entry(NetLogEventType::REQUEST_ALIVE,
- request->net_log().source(), NetLogEventPhase::BEGIN,
- request->creation_time(), request->GetStateAsValue());
- observer->OnAddEntry(entry);
- }
- }
- } // namespace net
|