netwerk/cookie/CookieLogging.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "CookieLogging.h"
   7 #include "Cookie.h"
   8 #include "nsIConsoleReportCollector.h"
   9
  10 constexpr auto TIME_STRING_LENGTH = 40;
  11
  12 namespace mozilla {
  13 namespace net {
  14
  15 LazyLogModule gCookieLog("cookie");
  16
  17 static const char* SameSiteToString(uint32_t aSameSite) {
  18   switch (aSameSite) {
  19     case nsICookie::SAMESITE_NONE:
  20       return "none";
  21     case nsICookie::SAMESITE_LAX:
  22       return "lax";
  23     case nsICookie::SAMESITE_STRICT:
  24       return "strict";
  25     default:
  26       MOZ_CRASH("Invalid nsICookie sameSite value");
  27       return "";
  28   }
  29 }
  30
  31 // static
  32 void CookieLogging::LogSuccess(bool aSetCookie, nsIURI* aHostURI,
  33                                const nsACString& aCookieString, Cookie* aCookie,
  34                                bool aReplacing) {
  35   // if logging isn't enabled, return now to save cycles
  36   if (!MOZ_LOG_TEST(gCookieLog, LogLevel::Debug)) {
  37     return;
  38   }
  39
  40   nsAutoCString spec;
  41   if (aHostURI) {
  42     aHostURI->GetAsciiSpec(spec);
  43   }
  44
  45   MOZ_LOG(gCookieLog, LogLevel::Debug,
  46           ("===== %s =====\n", aSetCookie ? "COOKIE ACCEPTED" : "COOKIE SENT"));
  47   MOZ_LOG(gCookieLog, LogLevel::Debug, ("request URL: %s\n", spec.get()));
  48   MOZ_LOG(gCookieLog, LogLevel::Debug,
  49           ("cookie string: %s\n", aCookieString.BeginReading()));
  50   if (aSetCookie) {
  51     MOZ_LOG(gCookieLog, LogLevel::Debug,
  52             ("replaces existing cookie: %s\n", aReplacing ? "true" : "false"));
  53   }
  54
  55   LogCookie(aCookie);
  56
  57   MOZ_LOG(gCookieLog, LogLevel::Debug, ("\n"));
  58 }
  59
  60 // static
  61 void CookieLogging::LogFailure(bool aSetCookie, nsIURI* aHostURI,
  62                                const nsACString& aCookieString,
  63                                const char* aReason) {
  64   // if logging isn't enabled, return now to save cycles
  65   if (!MOZ_LOG_TEST(gCookieLog, LogLevel::Warning)) {
  66     return;
  67   }
  68
  69   nsAutoCString spec;
  70   if (aHostURI) {
  71     aHostURI->GetAsciiSpec(spec);
  72   }
  73
  74   MOZ_LOG(gCookieLog, LogLevel::Warning,
  75           ("===== %s =====\n",
  76            aSetCookie ? "COOKIE NOT ACCEPTED" : "COOKIE NOT SENT"));
  77   MOZ_LOG(gCookieLog, LogLevel::Warning, ("request URL: %s\n", spec.get()));
  78   if (aSetCookie) {
  79     MOZ_LOG(gCookieLog, LogLevel::Warning,
  80             ("cookie string: %s\n", aCookieString.BeginReading()));
  81   }
  82
  83   PRExplodedTime explodedTime;
  84   PR_ExplodeTime(PR_Now(), PR_GMTParameters, &explodedTime);
  85   char timeString[TIME_STRING_LENGTH];
  86   PR_FormatTimeUSEnglish(timeString, TIME_STRING_LENGTH, "%c GMT",
  87                          &explodedTime);
  88
  89   MOZ_LOG(gCookieLog, LogLevel::Warning, ("current time: %s", timeString));
  90   MOZ_LOG(gCookieLog, LogLevel::Warning, ("rejected because %s\n", aReason));
  91   MOZ_LOG(gCookieLog, LogLevel::Warning, ("\n"));
  92 }
  93
  94 // static
  95 void CookieLogging::LogCookie(Cookie* aCookie) {
  96   PRExplodedTime explodedTime;
  97   PR_ExplodeTime(PR_Now(), PR_GMTParameters, &explodedTime);
  98   char timeString[TIME_STRING_LENGTH];
  99   PR_FormatTimeUSEnglish(timeString, TIME_STRING_LENGTH, "%c GMT",
 100                          &explodedTime);
 101
 102   MOZ_LOG(gCookieLog, LogLevel::Debug, ("current time: %s", timeString));
 103
 104   if (aCookie) {
 105     MOZ_LOG(gCookieLog, LogLevel::Debug, ("----------------\n"));
 106     MOZ_LOG(gCookieLog, LogLevel::Debug, ("name: %s\n", aCookie->Name().get()));
 107     MOZ_LOG(gCookieLog, LogLevel::Debug,
 108             ("value: %s\n", aCookie->Value().get()));
 109     MOZ_LOG(gCookieLog, LogLevel::Debug,
 110             ("%s: %s\n", aCookie->IsDomain() ? "domain" : "host",
 111              aCookie->Host().get()));
 112     MOZ_LOG(gCookieLog, LogLevel::Debug, ("path: %s\n", aCookie->Path().get()));
 113
 114     PR_ExplodeTime(aCookie->Expiry() * int64_t(PR_USEC_PER_SEC),
 115                    PR_GMTParameters, &explodedTime);
 116     PR_FormatTimeUSEnglish(timeString, TIME_STRING_LENGTH, "%c GMT",
 117                            &explodedTime);
 118     MOZ_LOG(gCookieLog, LogLevel::Debug,
 119             ("expires: %s%s", timeString,
 120              aCookie->IsSession() ? " (at end of session)" : ""));
 121
 122     PR_ExplodeTime(aCookie->CreationTime(), PR_GMTParameters, &explodedTime);
 123     PR_FormatTimeUSEnglish(timeString, TIME_STRING_LENGTH, "%c GMT",
 124                            &explodedTime);
 125     MOZ_LOG(gCookieLog, LogLevel::Debug, ("created: %s", timeString));
 126
 127     MOZ_LOG(gCookieLog, LogLevel::Debug,
 128             ("is secure: %s\n", aCookie->IsSecure() ? "true" : "false"));
 129     MOZ_LOG(gCookieLog, LogLevel::Debug,
 130             ("is httpOnly: %s\n", aCookie->IsHttpOnly() ? "true" : "false"));
 131     MOZ_LOG(gCookieLog, LogLevel::Debug,
 132             ("sameSite: %s - rawSameSite: %s\n",
 133              SameSiteToString(aCookie->SameSite()),
 134              SameSiteToString(aCookie->RawSameSite())));
 135     MOZ_LOG(
 136         gCookieLog, LogLevel::Debug,
 137         ("schemeMap %d (http: %s | https: %s | file: %s)\n",
 138          aCookie->SchemeMap(),
 139          (aCookie->SchemeMap() & nsICookie::SCHEME_HTTP ? "true" : "false"),
 140          (aCookie->SchemeMap() & nsICookie::SCHEME_HTTPS ? "true" : "false"),
 141          (aCookie->SchemeMap() & nsICookie::SCHEME_FILE ? "true" : "false")));
 142
 143     nsAutoCString suffix;
 144     aCookie->OriginAttributesRef().CreateSuffix(suffix);
 145     MOZ_LOG(gCookieLog, LogLevel::Debug,
 146             ("origin attributes: %s\n",
 147              suffix.IsEmpty() ? "{empty}" : suffix.get()));
 148   }
 149 }
 150
 151 // static
 152 void CookieLogging::LogEvicted(Cookie* aCookie, const char* details) {
 153   MOZ_LOG(gCookieLog, LogLevel::Debug, ("===== COOKIE EVICTED =====\n"));
 154   MOZ_LOG(gCookieLog, LogLevel::Debug, ("%s\n", details));
 155
 156   LogCookie(aCookie);
 157
 158   MOZ_LOG(gCookieLog, LogLevel::Debug, ("\n"));
 159 }
 160
 161 // static
 162 void CookieLogging::LogMessageToConsole(nsIConsoleReportCollector* aCRC,
 163                                         nsIURI* aURI, uint32_t aErrorFlags,
 164                                         const nsACString& aCategory,
 165                                         const nsACString& aMsg,
 166                                         const nsTArray<nsString>& aParams) {
 167   if (!aCRC) {
 168     return;
 169   }
 170
 171   nsAutoCString uri;
 172   if (aURI) {
 173     nsresult rv = aURI->GetSpec(uri);
 174     if (NS_WARN_IF(NS_FAILED(rv))) {
 175       return;
 176     }
 177   }
 178
 179   aCRC->AddConsoleReport(aErrorFlags, aCategory,
 180                          nsContentUtils::eNECKO_PROPERTIES, uri, 0, 0, aMsg,
 181                          aParams);
 182 }
 183
 184 }  // namespace net
 185 }  // namespace mozilla