Merge pull request #684 from Scrumplex/logging-categories

Prevents private credentials from leaking in the logs of general users

CMakeLists.txt

@@ -268,6 +268,8 @@ if(NOT Launcher_FORCE_BUNDLED_LIBS)
     find_package(ghc_filesystem QUIET)
 endif()
 
+include(ECMQtDeclareLoggingCategory)
+
 ####################################### Program Info #######################################
 
 set(Launcher_APP_BINARY_NAME "prismlauncher" CACHE STRING "Name of the Launcher binary")

launcher/CMakeLists.txt

@@ -551,6 +551,24 @@ set(ATLAUNCHER_SOURCES
     modplatform/atlauncher/ATLShareCode.h
 )
 
+######## Logging categories ########
+
+ecm_qt_declare_logging_category(CORE_SOURCES
+    HEADER Logging.h
+    IDENTIFIER authCredentials
+    CATEGORY_NAME "launcher.auth.credentials"
+    DEFAULT_SEVERITY Warning
+    DESCRIPTION "Secrets and credentials for debugging purposes"
+    EXPORT "${Launcher_Name}"
+)
+
+if(KDE_INSTALL_LOGGINGCATEGORIESDIR)  # only install if there is a standard path for this
+    ecm_qt_install_logging_categories(
+        EXPORT "${Launcher_Name}"
+        DESTINATION "${KDE_INSTALL_LOGGINGCATEGORIESDIR}"
+    )
+endif()
+
 ################################ COMPILE ################################
 
 set(LOGIC_SOURCES

launcher/minecraft/auth/Parsers.cpp

@@ -1,5 +1,6 @@
 #include "Parsers.h"
 #include "Json.h"
+#include "Logging.h"
 
 #include <QJsonDocument>
 #include <QJsonArray>
@@ -75,9 +76,7 @@ bool getBool(QJsonValue value, bool & out) {
 
 bool parseXTokenResponse(QByteArray & data, Katabasis::Token &output, QString name) {
     qDebug() << "Parsing" << name <<":";
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
     QJsonParseError jsonError;
     QJsonDocument doc = QJsonDocument::fromJson(data, &jsonError);
     if(jsonError.error) {
@@ -137,9 +136,7 @@ bool parseXTokenResponse(QByteArray & data, Katabasis::Token &output, QString na
 
 bool parseMinecraftProfile(QByteArray & data, MinecraftProfile &output) {
     qDebug() << "Parsing Minecraft profile...";
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
 
     QJsonParseError jsonError;
     QJsonDocument doc = QJsonDocument::fromJson(data, &jsonError);
@@ -275,9 +272,7 @@ decoded base64 "value":
 
 bool parseMinecraftProfileMojang(QByteArray & data, MinecraftProfile &output) {
     qDebug() << "Parsing Minecraft profile...";
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
 
     QJsonParseError jsonError;
     QJsonDocument doc = QJsonDocument::fromJson(data, &jsonError);
@@ -389,9 +384,7 @@ bool parseMinecraftProfileMojang(QByteArray & data, MinecraftProfile &output) {
 
 bool parseMinecraftEntitlements(QByteArray & data, MinecraftEntitlement &output) {
     qDebug() << "Parsing Minecraft entitlements...";
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
 
     QJsonParseError jsonError;
     QJsonDocument doc = QJsonDocument::fromJson(data, &jsonError);
@@ -424,9 +417,7 @@ bool parseMinecraftEntitlements(QByteArray & data, MinecraftEntitlement &output)
 
 bool parseRolloutResponse(QByteArray & data, bool& result) {
     qDebug() << "Parsing Rollout response...";
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
 
     QJsonParseError jsonError;
     QJsonDocument doc = QJsonDocument::fromJson(data, &jsonError);
@@ -455,9 +446,7 @@ bool parseRolloutResponse(QByteArray & data, bool& result) {
 bool parseMojangResponse(QByteArray & data, Katabasis::Token &output) {
     QJsonParseError jsonError;
     qDebug() << "Parsing Mojang response...";
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
     QJsonDocument doc = QJsonDocument::fromJson(data, &jsonError);
     if(jsonError.error) {
         qWarning() << "Failed to parse response from api.minecraftservices.com/launcher/login as JSON: " << jsonError.errorString();

launcher/minecraft/auth/steps/EntitlementsStep.cpp

@@ -3,6 +3,7 @@
 #include <QNetworkRequest>
 #include <QUuid>
 
+#include "Logging.h"
 #include "minecraft/auth/AuthRequest.h"
 #include "minecraft/auth/Parsers.h"
 
@@ -41,9 +42,7 @@ void EntitlementsStep::onRequestDone(
     auto requestor = qobject_cast<AuthRequest *>(QObject::sender());
     requestor->deleteLater();
 
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
 
     // TODO: check presence of same entitlementsRequestId?
     // TODO: validate JWTs?

launcher/minecraft/auth/steps/LauncherLoginStep.cpp

@@ -2,9 +2,10 @@
 
 #include <QNetworkRequest>
 
+#include "Logging.h"
+#include "minecraft/auth/AccountTask.h"
 #include "minecraft/auth/AuthRequest.h"
 #include "minecraft/auth/Parsers.h"
-#include "minecraft/auth/AccountTask.h"
 #include "net/NetUtils.h"
 
 LauncherLoginStep::LauncherLoginStep(AccountData* data) : AuthStep(data) {
@@ -51,14 +52,10 @@ void LauncherLoginStep::onRequestDone(
     auto requestor = qobject_cast<AuthRequest *>(QObject::sender());
     requestor->deleteLater();
 
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
     if (error != QNetworkReply::NoError) {
         qWarning() << "Reply error:" << error;
-#ifndef NDEBUG
-        qDebug() << data;
-#endif
+        qCDebug(authCredentials()) << data;
         if (Net::isApplicationError(error)) {
             emit finished(
                 AccountTaskState::STATE_FAILED_SOFT,
@@ -76,9 +73,7 @@ void LauncherLoginStep::onRequestDone(
 
     if(!Parsers::parseMojangResponse(data, m_data->yggdrasilToken)) {
         qWarning() << "Could not parse login_with_xbox response...";
-#ifndef NDEBUG
-        qDebug() << data;
-#endif
+        qCDebug(authCredentials()) << data;
         emit finished(
             AccountTaskState::STATE_FAILED_SOFT,
             tr("Failed to parse the Minecraft access token response.")

launcher/minecraft/auth/steps/MSAStep.cpp

@@ -42,6 +42,7 @@
 #include "minecraft/auth/Parsers.h"
 
 #include "Application.h"
+#include "Logging.h"
 
 using OAuth2 = Katabasis::DeviceFlow;
 using Activity = Katabasis::Activity;
@@ -117,14 +118,12 @@ void MSAStep::onOAuthActivityChanged(Katabasis::Activity activity) {
             // Succeeded or did not invalidate tokens
             emit hideVerificationUriAndCode();
             QVariantMap extraTokens = m_oauth2->extraTokens();
-#ifndef NDEBUG
             if (!extraTokens.isEmpty()) {
-                qDebug() << "Extra tokens in response:";
+                qCDebug(authCredentials()) << "Extra tokens in response:";
                 foreach (QString key, extraTokens.keys()) {
-                    qDebug() << "\t" << key << ":" << extraTokens.value(key);
+                    qCDebug(authCredentials()) << "\t" << key << ":" << extraTokens.value(key);
                 }
             }
-#endif
             emit finished(AccountTaskState::STATE_WORKING, tr("Got "));
             return;
         }

launcher/minecraft/auth/steps/MinecraftProfileStep.cpp

@@ -2,6 +2,7 @@
 
 #include <QNetworkRequest>
 
+#include "Logging.h"
 #include "minecraft/auth/AuthRequest.h"
 #include "minecraft/auth/Parsers.h"
 #include "net/NetUtils.h"
@@ -40,9 +41,7 @@ void MinecraftProfileStep::onRequestDone(
     auto requestor = qobject_cast<AuthRequest *>(QObject::sender());
     requestor->deleteLater();
 
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
     if (error == QNetworkReply::ContentNotFoundError) {
         // NOTE: Succeed even if we do not have a profile. This is a valid account state.
         if(m_data->type == AccountType::Mojang) {

launcher/minecraft/auth/steps/MinecraftProfileStepMojang.cpp

@@ -2,6 +2,7 @@
 
 #include <QNetworkRequest>
 
+#include "Logging.h"
 #include "minecraft/auth/AuthRequest.h"
 #include "minecraft/auth/Parsers.h"
 #include "net/NetUtils.h"
@@ -43,9 +44,7 @@ void MinecraftProfileStepMojang::onRequestDone(
     auto requestor = qobject_cast<AuthRequest *>(QObject::sender());
     requestor->deleteLater();
 
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
     if (error == QNetworkReply::ContentNotFoundError) {
         // NOTE: Succeed even if we do not have a profile. This is a valid account state.
         if(m_data->type == AccountType::Mojang) {

launcher/minecraft/auth/steps/XboxAuthorizationStep.cpp

@@ -4,6 +4,7 @@
 #include <QJsonParseError>
 #include <QJsonDocument>
 
+#include "Logging.h"
 #include "minecraft/auth/AuthRequest.h"
 #include "minecraft/auth/Parsers.h"
 #include "net/NetUtils.h"
@@ -58,9 +59,7 @@ void XboxAuthorizationStep::onRequestDone(
     auto requestor = qobject_cast<AuthRequest *>(QObject::sender());
     requestor->deleteLater();
 
-#ifndef NDEBUG
-    qDebug() << data;
-#endif
+    qCDebug(authCredentials()) << data;
     if (error != QNetworkReply::NoError) {
         qWarning() << "Reply error:" << error;
         if (Net::isApplicationError(error)) {

launcher/minecraft/auth/steps/XboxProfileStep.cpp

@@ -3,7 +3,7 @@
 #include <QNetworkRequest>
 #include <QUrlQuery>
 
-
+#include "Logging.h"
 #include "minecraft/auth/AuthRequest.h"
 #include "minecraft/auth/Parsers.h"
 #include "net/NetUtils.h"
@@ -56,9 +56,7 @@ void XboxProfileStep::onRequestDone(
 
     if (error != QNetworkReply::NoError) {
         qWarning() << "Reply error:" << error;
-#ifndef NDEBUG
-        qDebug() << data;
-#endif
+        qCDebug(authCredentials()) << data;
         if (Net::isApplicationError(error)) {
             emit finished(
                 AccountTaskState::STATE_FAILED_SOFT,
@@ -74,9 +72,7 @@ void XboxProfileStep::onRequestDone(
         return;
     }
 
-#ifndef NDEBUG
-    qDebug() << "XBox profile: " << data;
-#endif
+    qCDebug(authCredentials()) << "XBox profile: " << data;
 
     emit finished(AccountTaskState::STATE_WORKING, tr("Got Xbox profile"));
 }

libraries/katabasis/CMakeLists.txt

@@ -38,6 +38,15 @@ set( katabasis_PUBLIC
     include/katabasis/RequestParameter.h
 )
 
+ecm_qt_declare_logging_category(katabasis_PRIVATE
+    HEADER KatabasisLogging.h  # NOTE: this won't be in src/, but CMAKE_BINARY_DIR/src isn't included by default so this should be fine
+    IDENTIFIER katabasisCredentials
+    CATEGORY_NAME "katabasis.credentials"
+    DEFAULT_SEVERITY Warning
+    DESCRIPTION "Secrets and credentials from Katabasis"
+    EXPORT "Katabasis"
+)
+
 add_library( Katabasis STATIC ${katabasis_PRIVATE} ${katabasis_PUBLIC} )
 target_link_libraries(Katabasis Qt${QT_VERSION_MAJOR}::Core Qt${QT_VERSION_MAJOR}::Network)
 

libraries/katabasis/include/katabasis/DeviceFlow.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <QLoggingCategory>
 #include <QNetworkAccessManager>
 #include <QNetworkRequest>
 #include <QNetworkReply>

libraries/katabasis/src/DeviceFlow.cpp

@@ -19,9 +19,11 @@
 #include "katabasis/PollServer.h"
 #include "katabasis/Globals.h"
 
+#include "KatabasisLogging.h"
 #include "JsonResponse.h"
 
 namespace {
+
 // ref: https://tools.ietf.org/html/rfc8628#section-3.2
 // Exception: Google sign-in uses "verification_url" instead of "*_uri" - we'll accept both.
 bool hasMandatoryDeviceAuthParams(const QVariantMap& params)
@@ -333,9 +335,7 @@ QString DeviceFlow::refreshToken() {
 }
 
 void DeviceFlow::setRefreshToken(const QString &v) {
-#ifndef NDEBUG
-    qDebug() << "DeviceFlow::setRefreshToken" << v << "...";
-#endif
+    qCDebug(katabasisCredentials) << "new refresh token:" << v;
     token_.refresh_token = v;
 }