gui: Add config to disable notification silences

Source/common/BUILD

@@ -402,8 +402,8 @@ objc_library(
     module_name = "santa_common_SNTConfigState",
     deps = [
         ":CoderMacros",
-        ":SNTConfigurator",
         ":SNTCommonEnums",
+        ":SNTConfigurator",
     ],
 )
 

Source/common/SNTConfigState.h

@@ -23,6 +23,7 @@
 // Properties here mirror the SNTConfigurator at a point in time
 //
 @property(readonly) SNTClientMode clientMode;
+@property(readonly) BOOL enableNotificationSilences;
 
 - (instancetype)initWithConfig:(SNTConfigurator *)config;
 

Source/common/SNTConfigState.m

@@ -23,6 +23,7 @@ - (instancetype)initWithConfig:(SNTConfigurator *)config {
   self = [super init];
   if (self) {
     _clientMode = config.clientMode;
+    _enableNotificationSilences = config.enableNotificationSilences;
   }
   return self;
 }
@@ -33,12 +34,14 @@ + (BOOL)supportsSecureCoding {
 
 - (void)encodeWithCoder:(NSCoder *)coder {
   ENCODE_BOXABLE(coder, clientMode);
+  ENCODE_BOXABLE(coder, enableNotificationSilences);
 }
 
 - (instancetype)initWithCoder:(NSCoder *)decoder {
   self = [super init];
   if (self) {
     DECODE_SELECTOR(decoder, clientMode, NSNumber, integerValue);
+    DECODE_SELECTOR(decoder, enableNotificationSilences, NSNumber, boolValue);
   }
   return self;
 };

Source/common/SNTConfigurator.h

@@ -418,6 +418,15 @@
 ///
 @property(nullable, readonly, nonatomic) NSString *modeNotificationStandalone;
 
+///
+///  If set to true, when a user is presented with a GUI notification there will be
+///  a checkbox and dropdown to allow silencing these notifications for a short
+///  period of time.
+///
+///  Defaults to true.
+///
+@property(readonly, nonatomic) BOOL enableNotificationSilences;
+
 ///
 ///  If this is set to true, the UI will use different fonts on April 1st, May 4th and October 31st.
 ///

Source/common/SNTConfigurator.m

@@ -107,6 +107,7 @@ @implementation SNTConfigurator
 static NSString *const kModeNotificationMonitor = @"ModeNotificationMonitor";
 static NSString *const kModeNotificationLockdown = @"ModeNotificationLockdown";
 static NSString *const kModeNotificationStandalone = @"ModeNotificationStandalone";
+static NSString *const kEnableNotificationSilences = @"EnableNotificationSilences";
 static NSString *const kFunFontsOnSpecificDays = @"FunFontsOnSpecificDays";
 
 static NSString *const kEnablePageZeroProtectionKey = @"EnablePageZeroProtection";
@@ -243,6 +244,7 @@ - (instancetype)initWithSyncStateFile:(NSString *)syncStateFilePath
       kModeNotificationMonitor : string,
       kModeNotificationLockdown : string,
       kModeNotificationStandalone : string,
+      kEnableNotificationSilences : number,
       kFunFontsOnSpecificDays : number,
       kStaticRules : array,
       kSyncBaseURLKey : string,
@@ -469,6 +471,10 @@ + (NSSet *)keyPathsForValuesAffectingModeNotificationLockdown {
   return [self configStateSet];
 }
 
++ (NSSet *)keyPathsForValuesAffectingEnableNotificationSilences {
+  return [self configStateSet];
+}
+
 + (NSSet *)keyPathsForValuesAffectingFunFontsOnSpecificDays {
   return [self configStateSet];
 }
@@ -870,6 +876,11 @@ - (NSString *)modeNotificationStandalone {
   return self.configState[kModeNotificationStandalone];
 }
 
+- (BOOL)enableNotificationSilences {
+  NSNumber *number = self.configState[kEnableNotificationSilences];
+  return number ? [number boolValue] : YES;
+}
+
 - (BOOL)funFontsOnSpecificDays {
   return [self.configState[kFunFontsOnSpecificDays] boolValue];
 }

Source/common/SNTXPCNotifierInterface.h

@@ -34,7 +34,8 @@
 - (void)postFileAccessBlockNotification:(SNTFileAccessEvent *)event
                           customMessage:(NSString *)message
                               customURL:(NSString *)url
-                             customText:(NSString *)text API_AVAILABLE(macos(13.0));
+                             customText:(NSString *)text
+                            configState:(SNTConfigState *)configState API_AVAILABLE(macos(13.0));
 - (void)postClientModeNotification:(SNTClientMode)clientmode;
 - (void)postRuleSyncNotificationWithCustomMessage:(NSString *)message;
 - (void)updateCountsForEvent:(SNTStoredEvent *)event

Source/gui/BUILD

@@ -61,6 +61,7 @@ swift_library(
     deps = [
         ":SNTMessageView",
         "//Source/common:SNTBlockMessage_SantaGUI",
+        "//Source/common:SNTConfigState",
         "//Source/common:SNTFileAccessEvent",
     ],
 )
@@ -101,9 +102,9 @@ objc_library(
         ":SNTFileAccessMessageWindowView",
         "//Source/common:CertificateHelpers",
         "//Source/common:SNTBlockMessage_SantaGUI",
+        "//Source/common:SNTConfigState",
         "//Source/common:SNTConfigurator",
         "//Source/common:SNTDeviceEvent",
-        "//Source/common:SNTConfigState",
         "//Source/common:SNTFileAccessEvent",
         "//Source/common:SNTLogging",
         "//Source/common:SNTStoredEvent",

Source/gui/SNTBinaryMessageWindowView.swift

@@ -272,7 +272,9 @@ struct SNTBinaryMessageWindowView: View {
     ) {
       SNTBinaryMessageEventView(e: event!, customURL: customURL, bundleProgress: bundleProgress)
 
-      SNTNotificationSilenceView(silence: $preventFutureNotifications, period: $preventFutureNotificationPeriod)
+      if configState.enableNotificationSilences {
+        SNTNotificationSilenceView(silence: $preventFutureNotifications, period: $preventFutureNotificationPeriod)
+      }
 
       if event?.needsBundleHash ?? false && !bundleProgress.isFinished {
         if bundleProgress.fractionCompleted == 0.0 {

Source/gui/SNTFileAccessMessageWindowController.h

@@ -18,6 +18,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+@class SNTConfigState;
 @class SNTFileAccessEvent;
 
 ///
@@ -29,7 +30,8 @@ API_AVAILABLE(macos(13.0))
 - (instancetype)initWithEvent:(SNTFileAccessEvent *)event
                 customMessage:(nullable NSString *)message
                     customURL:(nullable NSString *)url
-                   customText:(nullable NSString *)text;
+                   customText:(nullable NSString *)text
+                  configState:(nullable SNTConfigState *)configState;
 
 @property(readonly) SNTFileAccessEvent *event;
 

Source/gui/SNTFileAccessMessageWindowController.m

@@ -17,13 +17,15 @@
 #import "Source/gui/SNTFileAccessMessageWindowView-Swift.h"
 
 #import "Source/common/SNTBlockMessage.h"
+#import "Source/common/SNTConfigState.h"
 #import "Source/common/SNTFileAccessEvent.h"
 #import "Source/common/SNTLogging.h"
 
 @interface SNTFileAccessMessageWindowController ()
 @property NSString *customMessage;
 @property NSString *customURL;
 @property NSString *customText;
+@property SNTConfigState *configState;
 @property SNTFileAccessEvent *event;
 @end
 
@@ -32,13 +34,15 @@ @implementation SNTFileAccessMessageWindowController
 - (instancetype)initWithEvent:(SNTFileAccessEvent *)event
                 customMessage:(nullable NSString *)message
                     customURL:(nullable NSString *)url
-                   customText:(nullable NSString *)text {
+                   customText:(nullable NSString *)text
+                  configState:(nullable SNTConfigState *)configState {
   self = [super init];
   if (self) {
     _event = event;
     _customMessage = message;
     _customURL = url;
     _customText = text;
+    _configState = configState;
   }
   return self;
 }
@@ -70,6 +74,7 @@ - (void)showWindow:(id)sender {
          customMessage:self.customMessage
              customURL:self.customURL
             customText:self.customText
+           configState:self.configState
        uiStateCallback:^(NSTimeInterval preventNotificationsPeriod) {
          self.silenceFutureNotificationsPeriod = preventNotificationsPeriod;
        }];

Source/gui/SNTFileAccessMessageWindowView.swift

@@ -16,6 +16,7 @@
 import SwiftUI
 
 import santa_common_SNTBlockMessage
+import santa_common_SNTConfigState
 import santa_common_SNTFileAccessEvent
 import santa_gui_SNTMessageView
 
@@ -27,6 +28,7 @@ import santa_gui_SNTMessageView
     customMessage: NSString?,
     customURL: NSString?,
     customText: NSString?,
+    configState: SNTConfigState,
     uiStateCallback: ((TimeInterval) -> Void)?
   ) -> NSViewController {
     return NSHostingController(
@@ -36,6 +38,7 @@ import santa_gui_SNTMessageView
         customMessage: customMessage,
         customURL: customURL as String?,
         customText: customText as String?,
+        configState: configState,
         uiStateCallback: uiStateCallback
       )
       .frame(minWidth: MAX_OUTER_VIEW_WIDTH, minHeight: MAX_OUTER_VIEW_HEIGHT)
@@ -168,6 +171,7 @@ struct SNTFileAccessMessageWindowView: View {
   let customMessage: NSString?
   let customURL: String?
   let customText: String?
+  let configState: SNTConfigState
   let uiStateCallback: ((TimeInterval) -> Void)?
 
   @Environment(\.openURL) var openURL
@@ -182,10 +186,9 @@ struct SNTFileAccessMessageWindowView: View {
       Event(e: event!, window: window)
 
       VStack(spacing: 15.0) {
-        SNTNotificationSilenceView(
-          silence: $preventFutureNotifications,
-          period: $preventFutureNotificationPeriod
-        )
+        if configState.enableNotificationSilences {
+          SNTNotificationSilenceView(silence: $preventFutureNotifications, period: $preventFutureNotificationPeriod)
+        }
 
         HStack(spacing: 15.0) {
           if customURL != nil {

Source/gui/SNTNotificationManager.m

@@ -111,7 +111,8 @@ - (BOOL)notificationAlreadyQueued:(SNTMessageWindowController *)pendingMsg {
   return NO;
 }
 
-- (void)queueMessage:(SNTMessageWindowController *)pendingMsg {
+- (void)queueMessage:(SNTMessageWindowController *)pendingMsg
+      enableSilences:(BOOL)enableSilences {
   // Post a distributed notification, regardless of queue state.
   [self postDistributedNotification:pendingMsg];
 
@@ -130,19 +131,21 @@ - (void)queueMessage:(SNTMessageWindowController *)pendingMsg {
     }
 
     // See if this message has been user-silenced.
-    NSString *messageHash = [pendingMsg messageHash];
-    NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
-    NSDate *silenceDate = [ud objectForKey:silencedNotificationsKey][messageHash];
-    if ([silenceDate isKindOfClass:[NSDate class]]) {
-      switch ([silenceDate compare:[NSDate date]]) {
-        case NSOrderedDescending:
-          LOGI(@"Notification silence: dropping notification for %@", messageHash);
-          return;
-        case NSOrderedAscending:
-          LOGI(@"Notification silence: silence has expired, deleting");
-          [self updateSilenceDate:nil forHash:messageHash];
-          break;
-        default: break;
+    if (enableSilences) {
+      NSString *messageHash = [pendingMsg messageHash];
+      NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
+      NSDate *silenceDate = [ud objectForKey:silencedNotificationsKey][messageHash];
+      if ([silenceDate isKindOfClass:[NSDate class]]) {
+        switch ([silenceDate compare:[NSDate date]]) {
+          case NSOrderedDescending:
+            LOGI(@"Notification silence: dropping notification for %@", messageHash);
+            return;
+          case NSOrderedAscending:
+            LOGI(@"Notification silence: silence has expired, deleting");
+            [self updateSilenceDate:nil forHash:messageHash];
+            break;
+          default: break;
+        }
       }
     }
 
@@ -378,7 +381,7 @@ - (void)postBlockNotification:(SNTStoredEvent *)event
                                                   configState:configState
                                                         reply:replyBlock];
 
-  [self queueMessage:pendingMsg];
+  [self queueMessage:pendingMsg enableSilences:configState.enableNotificationSilences];
 }
 
 - (void)postUSBBlockNotification:(SNTDeviceEvent *)event {
@@ -389,13 +392,14 @@ - (void)postUSBBlockNotification:(SNTDeviceEvent *)event {
   SNTDeviceMessageWindowController *pendingMsg =
       [[SNTDeviceMessageWindowController alloc] initWithEvent:event];
 
-  [self queueMessage:pendingMsg];
+  [self queueMessage:pendingMsg enableSilences:YES];
 }
 
 - (void)postFileAccessBlockNotification:(SNTFileAccessEvent *)event
                           customMessage:(NSString *)message
                               customURL:(NSString *)url
-                             customText:(NSString *)text API_AVAILABLE(macos(13.0)) {
+                             customText:(NSString *)text
+                            configState:(SNTConfigState *)configState API_AVAILABLE(macos(13.0)) {
   if (!event) {
     LOGI(@"Error: Missing event object in message received from daemon!");
     return;
@@ -405,9 +409,10 @@ - (void)postFileAccessBlockNotification:(SNTFileAccessEvent *)event
       [[SNTFileAccessMessageWindowController alloc] initWithEvent:event
                                                     customMessage:message
                                                         customURL:url
-                                                       customText:text];
+                                                       customText:text
+                                                      configState:configState];
 
-  [self queueMessage:pendingMsg];
+  [self queueMessage:pendingMsg enableSilences:YES];
 }
 
 // XPC handler. The sync service requests the APNS token, by way of the daemon.

Source/gui/SNTTestGUI.swift

@@ -1,5 +1,6 @@
 import SwiftUI
 
+import santa_common_SNTConfigState
 import santa_common_SNTConfigurator
 import santa_common_SNTCommonEnums
 import santa_common_SNTDeviceEvent
@@ -58,10 +59,11 @@ struct BinaryView: View {
   @State var path: String = "/Applications/Malware.app/Contents/MacOS"
   @State var parent: String = "launchd"
 
-  @State var bannedBlockMessage: String = ""
+  @State var unknownBlockMessage: String = ""
   @State var eventDetailURL: String = "http://sync-server-hostname/blockables/%bundle_or_file_identifier%"
   @State var dateOverride: SpecialDates = .Nov25
   @State var clientModeOverride: SNTClientMode = .lockdown
+  @State var allowNotificationSilence: Bool = true
 
   @State var customMsg: String = ""
   @State var customURL: String = ""
@@ -83,17 +85,17 @@ struct BinaryView: View {
       GroupBox(label: Label("Config Overrides", systemImage: "")) {
         Form {
           HStack {
-            TextField(text: $bannedBlockMessage, label: { Text(verbatim: "Banned Block Message") }).frame(width: 550.0)
+            TextField(text: $unknownBlockMessage, label: { Text(verbatim: "Banned Block Message") }).frame(width: 550.0)
             Button(action: {
-              bannedBlockMessage =
+              unknownBlockMessage =
                 "<img src='https://static.wikia.nocookie.net/villains/images/8/8a/Robot_Santa.png/revision/latest?cb=20200520230856' /><br /><br />Isn't Santa fun?"
             }) {
               Text(verbatim: "Populate (With Image)").font(Font.subheadline)
             }
-            Button(action: { bannedBlockMessage = "You may not run this thing" }) {
+            Button(action: { unknownBlockMessage = "You may not run this thing" }) {
               Text(verbatim: "Populate (1-line)").font(Font.subheadline)
             }
-            Button(action: { bannedBlockMessage = "" }) { Text("Clear").font(Font.subheadline) }
+            Button(action: { unknownBlockMessage = "" }) { Text("Clear").font(Font.subheadline) }
           }
 
           HStack {
@@ -118,17 +120,23 @@ struct BinaryView: View {
               Text(verbatim: "Standalone").tag(SNTClientMode.standalone)
             }.pickerStyle(.segmented)
           }
+          HStack {
+            Toggle(isOn: $allowNotificationSilence) {
+              Text(verbatim: "Allow notification silences")
+            }
+          }
         }
       }
 
       Divider()
 
       Button("Display") {
         var configMap = [
-          "BannedBlockMessage": bannedBlockMessage,
           "FunFontsOnSpecificDays": true,
           "ClientMode": clientModeOverride.rawValue as NSNumber,
           "EnableStandalonePasswordFallback": true,
+          "UnknownBlockMessage": unknownBlockMessage,
+          "EnableNotificationSilences": allowNotificationSilence,
         ]
         if !eventDetailURL.isEmpty {
           configMap["EventDetailURL"] = eventDetailURL
@@ -161,6 +169,7 @@ struct BinaryView: View {
             event: event,
             customMsg: customMsg as NSString?,
             customURL: customURL as NSString?,
+            configState: SNTConfigState(config: SNTConfigurator.configurator()),
             bundleProgress: SNTBundleProgress(),
             uiStateCallback: { interval in print("Silence interval was set to \(interval)") },
             replyCallback: { approved in print("Did user approve execution: \(approved)") }