From ff8ffbdef0306254094258be326d75fcdc2bcbe1 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 31 Aug 2018 00:48:34 -0400
Subject: add paranoid warnings mode (#590)

---
 src/SMAPI/Framework/ModLoading/AssemblyLoader.cs          | 10 ++++++++++
 src/SMAPI/Framework/ModLoading/InstructionHandleResult.cs |  8 +++++++-
 src/SMAPI/Framework/ModLoading/ModWarning.cs              |  8 +++++++-
 src/SMAPI/Framework/Models/SConfig.cs                     |  3 +++
 src/SMAPI/Framework/SCore.cs                              | 11 +++++++++++
 5 files changed, 38 insertions(+), 2 deletions(-)

(limited to 'src/SMAPI/Framework')

diff --git a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
index e750c659..fdbfdd8d 100644
--- a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
+++ b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
@@ -350,6 +350,16 @@ namespace StardewModdingAPI.Framework.ModLoading
                     mod.SetWarning(ModWarning.UsesDynamic);
                     break;
 
+                case InstructionHandleResult.DetectedFilesystemAccess:
+                    this.Monitor.LogOnce(loggedMessages, $"{logPrefix}Detected filesystem access ({handler.NounPhrase}) in assembly {filename}.");
+                    mod.SetWarning(ModWarning.AccessesFilesystem);
+                    break;
+
+                case InstructionHandleResult.DetectedShellAccess:
+                    this.Monitor.LogOnce(loggedMessages, $"{logPrefix}Detected shell or process access ({handler.NounPhrase}) in assembly {filename}.");
+                    mod.SetWarning(ModWarning.AccessesShell);
+                    break;
+
                 case InstructionHandleResult.None:
                     break;
 
diff --git a/src/SMAPI/Framework/ModLoading/InstructionHandleResult.cs b/src/SMAPI/Framework/ModLoading/InstructionHandleResult.cs
index cfa23d08..f3555c2d 100644
--- a/src/SMAPI/Framework/ModLoading/InstructionHandleResult.cs
+++ b/src/SMAPI/Framework/ModLoading/InstructionHandleResult.cs
@@ -24,6 +24,12 @@ namespace StardewModdingAPI.Framework.ModLoading
         DetectedDynamic,
 
         /// <summary>The instruction is compatible, but references <see cref="SpecialisedEvents.UnvalidatedUpdateTick"/> which may impact stability.</summary>
-        DetectedUnvalidatedUpdateTick
+        DetectedUnvalidatedUpdateTick,
+
+        /// <summary>The instruction accesses the filesystem directly.</summary>
+        DetectedFilesystemAccess,
+
+        /// <summary>The instruction accesses the OS shell or processes directly.</summary>
+        DetectedShellAccess
     }
 }
diff --git a/src/SMAPI/Framework/ModLoading/ModWarning.cs b/src/SMAPI/Framework/ModLoading/ModWarning.cs
index 0e4b2570..c62199b2 100644
--- a/src/SMAPI/Framework/ModLoading/ModWarning.cs
+++ b/src/SMAPI/Framework/ModLoading/ModWarning.cs
@@ -26,6 +26,12 @@ namespace StardewModdingAPI.Framework.ModLoading
         UsesUnvalidatedUpdateTick = 16,
 
         /// <summary>The mod has no update keys set.</summary>
-        NoUpdateKeys = 32
+        NoUpdateKeys = 32,
+
+        /// <summary>Uses .NET APIs for filesystem access.</summary>
+        AccessesFilesystem = 64,
+
+        /// <summary>Uses .NET APIs for shell or process access.</summary>
+        AccessesShell = 128
     }
 }
diff --git a/src/SMAPI/Framework/Models/SConfig.cs b/src/SMAPI/Framework/Models/SConfig.cs
index 15671af4..bdfaa670 100644
--- a/src/SMAPI/Framework/Models/SConfig.cs
+++ b/src/SMAPI/Framework/Models/SConfig.cs
@@ -14,6 +14,9 @@ namespace StardewModdingAPI.Framework.Models
         /// <summary>Whether to check for newer versions of SMAPI and mods on startup.</summary>
         public bool CheckForUpdates { get; set; }
 
+        /// <summary>Whether to add a section to the 'mod issues' list for mods which which directly use potentially sensitive .NET APIs like file or shell access.</summary>
+        public bool ParanoidWarnings { get; set; }
+
         /// <summary>Whether to show beta versions as valid updates.</summary>
         public bool UseBetaChannel { get; set; } = Constants.ApiVersion.IsPrerelease();
 
diff --git a/src/SMAPI/Framework/SCore.cs b/src/SMAPI/Framework/SCore.cs
index 3e93760b..af8df8a0 100644
--- a/src/SMAPI/Framework/SCore.cs
+++ b/src/SMAPI/Framework/SCore.cs
@@ -1026,6 +1026,17 @@ namespace StardewModdingAPI.Framework
                     "These mods change the save serialiser. They may corrupt your save files, or make them unusable if",
                     "you uninstall these mods."
                 );
+                if (this.Settings.ParanoidWarnings)
+                {
+                    LogWarningGroup(ModWarning.AccessesFilesystem, LogLevel.Warn, "Accesses filesystem directly",
+                        "These mods directly access the filesystem, and you enabled paranoid warnings. (Note that this may be",
+                        "legitimate and innocent usage; this warning is meaningless without further investigation.)"
+                    );
+                    LogWarningGroup(ModWarning.AccessesShell, LogLevel.Warn, "Accesses shell/process directly",
+                        "These mods directly access the OS shell or processes, and you enabled paranoid warnings. (Note that",
+                        "this may be legitimate and innocent usage; this warning is meaningless without further investigation.)"
+                    );
+                }
                 LogWarningGroup(ModWarning.PatchesGame, LogLevel.Info, "Patched game code",
                     "These mods directly change the game code. They're more likely to cause errors or bugs in-game; if",
                     "your game has issues, try removing these first. Otherwise you can ignore this warning."
-- 
cgit