Merge pull request #2067 from safing/feature/2050-pause

Feature: pause PM/SPN

Author: stenya

desktop/angular/projects/safing/portmaster-api/src/lib/portapi.service.ts

@@ -167,6 +167,23 @@ export class PortapiService {
     });
   }
 
+  /** Triggers a pause of the portmaster or SPN service
+   * @param duration The duration of the pause in seconds
+   * @param onlySPN Whether or not only the SPN should be paused
+   */
+  pause(duration: number, onlySPN: boolean): Observable<any> {
+    return this.http.post(`${this.httpEndpoint}/v1/control/pause`, { duration, onlySPN }, {
+      observe: 'response',
+      responseType: 'arraybuffer',
+    });
+  }
+  /** Triggers a resume of the portmaster (and SPN) service */
+  resume(): Observable<any> {
+    return this.http.post(`${this.httpEndpoint}/v1/control/resume`, undefined, {
+      observe: 'response',
+      responseType: 'arraybuffer',
+    });
+  }  
   /** Force the portmaster to check for updates */
   checkForUpdates(): Observable<any> {
     return this.http.post(`${this.httpEndpoint}/v1/updates/check`, undefined, {

desktop/angular/src/app/layout/navigation/navigation.html

@@ -153,7 +153,7 @@
   </div>
 </div>
 <div class="nav-lower-list">
-  <div class="relative link" sfngTipUpTrigger="navTools" sfngTipUpPassive tooltip="Version and Tools"
+  <div class="relative link" sfngTipUpTrigger="navTools" sfngTipUpPassive sfng-tooltip="Version and Tools"
     sfngTooltipDelay="1000" snfgTooltipPosition="right" (click)="settingsMenu.dropdown.toggle(settingsMenuTrigger)"
     cdkOverlayOrigin #settingsMenuTrigger="cdkOverlayOrigin" [class.active]="settingsMenu.dropdown.isOpen">
 
@@ -202,8 +202,47 @@
     <app-menu-item (click)="cleanupHistory($event)">Cleanup Network History</app-menu-item>
   </app-menu>
 
+  <!-- Pause Menu -->
+  <div sfngTipUpTrigger="navPause" sfngTipUpPassive sfng-tooltip="Pause and Resume" sfngTooltipDelay="1000"
+    snfgTooltipPosition="right" class="link" (click)="pauseMenu.dropdown.toggle(pauseMenuTrigger)" cdkOverlayOrigin
+    #pauseMenuTrigger="cdkOverlayOrigin" [class.active]="pauseMenu.dropdown.isOpen">
+
+    <svg viewBox="0 0 24 24" class="help" xmlns="http://www.w3.org/2000/svg">
+      <g fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"> 
+        <path d="M21 12C21 16.9706 16.9706 21 12 21C7.02944 21 3 16.9706 3 12C3 7.02944 7.02944 3 12 3C16.9706 3 21 7.02944 21 12Z"></path> 
+        <path d="M14 9L14 15"></path> 
+        <path d="M10 9L10 15"></path> 
+      </g>
+    </svg>
+
+  </div>
+  <app-menu #pauseMenu offsetY="0" offsetX="10" overlayClass="rounded-t">
+      <div *ngIf="isPaused">
+        <div class="flex flex-col p-4 text-xxs">            
+          <span class="text-secondary">
+            <span class="text-secondary">{{ pauseInfo }} </span>
+          </span>
+          <span class="text-secondary">
+            Auto-resume at <span class="text-secondary">{{ pauseInfoTillTime }} </span>
+          </span>            
+        </div>
+        <hr/>
+      </div>
+
+      <!-- we show 'Pause SPN...' items even when isPausedSPN to allow pause time modification-->
+      <app-menu-item (click)="pauseSPN($event, 60*5)" *ngIf="spnEnabled || isPausedSPN" [disabled]="isPausedInterception">Pause SPN for 5 minutes</app-menu-item>
+      <app-menu-item (click)="pauseSPN($event, 60*15)" *ngIf="spnEnabled || isPausedSPN" [disabled]="isPausedInterception">Pause SPN for 15 minutes</app-menu-item>
+      <app-menu-item (click)="pauseSPN($event, 60*60)" *ngIf="spnEnabled || isPausedSPN" [disabled]="isPausedInterception">Pause SPN for 1 hour</app-menu-item>
+      <hr/>
+      <app-menu-item (click)="pause($event, 60*5)">Pause for 5 minutes</app-menu-item>
+      <app-menu-item (click)="pause($event, 60*15)">Pause for 15 minutes</app-menu-item>
+      <app-menu-item (click)="pause($event, 60*60)">Pause for 1 hour</app-menu-item>
+      <hr/>
+      <app-menu-item (click)="resume($event)" [disabled]="!isPaused">Resume now</app-menu-item>
+  </app-menu>
+
   <!-- Power Menu -->
-  <div sfngTipUpTrigger="navPower" sfngTipUpPassive tooltip="Shutdown and Restart" sfngTooltipDelay="1000"
+  <div sfngTipUpTrigger="navPower" sfngTipUpPassive sfng-tooltip="Shutdown and Restart" sfngTooltipDelay="1000"
     snfgTooltipPosition="right" class="link" (click)="powerMenu.dropdown.toggle(powerMenuTrigger)" cdkOverlayOrigin
     #powerMenuTrigger="cdkOverlayOrigin" [class.active]="powerMenu.dropdown.isOpen">
 

desktop/angular/src/app/layout/navigation/navigation.ts

@@ -1,10 +1,10 @@
 import { INTEGRATION_SERVICE, IntegrationService } from 'src/app/integration';
 import { ConnectedPosition } from '@angular/cdk/overlay';
 import { ChangeDetectionStrategy, ChangeDetectorRef, Component, EventEmitter, Inject, OnInit, Output, inject } from '@angular/core';
-import { ConfigService, DebugAPI, PortapiService, SPNService, StringSetting } from '@safing/portmaster-api';
+import { ConfigService, DebugAPI, PortapiService, SPNService, StringSetting, BoolSetting } from '@safing/portmaster-api';
 import { tap } from 'rxjs/operators';
 import { AppComponent } from 'src/app/app.component';
-import { NotificationType, NotificationsService, StatusService, VersionStatus } from 'src/app/services';
+import { NotificationType, NotificationsService, StatusService, VersionStatus, GetModuleState, ControlPauseStateData } from 'src/app/services';
 import { ActionIndicatorService } from 'src/app/shared/action-indicator';
 import { fadeInAnimation, fadeOutAnimation } from 'src/app/shared/animations';
 import { ExitService } from 'src/app/shared/exit-screen';
@@ -36,12 +36,34 @@ export class NavigationComponent implements OnInit {
   /** The color to use for the notifcation-available hint (dot) */
   notificationColor: string = 'text-green-300';
 
+  pauseState: ControlPauseStateData | null = null;
+  get isPaused(): boolean { return this.pauseState?.Interception===true || this.pauseState?.SPN===true; }
+  get isPausedInterception(): boolean { return this.pauseState?.Interception===true; }
+  get isPausedSPN(): boolean { return this.pauseState?.SPN===true; }
+  get pauseInfo(): string {
+    if (this.pauseState?.Interception===true && this.pauseState?.SPN===true) 
+      return 'Portmaster and SPN are paused';
+    else if (this.pauseState?.Interception===true)
+      return 'Portmaster is paused';
+    else if (this.pauseState?.SPN===true)
+      return 'SPN is paused';
+    return '';
+  }
+  get pauseInfoTillTime(): string {
+    if (this.isPaused && this.pauseState?.TillTime)
+      return new Date(this.pauseState.TillTime).toLocaleTimeString(undefined, { hour12: false });
+    return '';
+  }
+
   /** Whether or not we have new, unseen prompts */
   hasNewPrompts = false;
 
   /** Whether or not prompting is globally enabled. */
   globalPromptingEnabled = false;
 
+  /** Whether or not the SPN is currently enabled */
+  spnEnabled = false;
+
   @Output()
   sideDashChange = new EventEmitter<'collapsed' | 'expanded' | 'force-overlay'>();
 
@@ -93,11 +115,21 @@ export class NavigationComponent implements OnInit {
         this.cdr.markForCheck();
       });
 
+    this.statusService.status$.subscribe(status => {
+      this.pauseState = GetModuleState(status, 'Control', 'control:paused')?.Data || null;
+    });
+
     this.configService.watch<StringSetting>('filter/defaultAction')
       .subscribe(defaultAction => {
         this.globalPromptingEnabled = defaultAction === 'ask';
         this.cdr.markForCheck();
       })
+    
+    this.configService.watch<BoolSetting>("spn/enable")
+      .subscribe(value => {
+        this.spnEnabled = value;
+        this.cdr.markForCheck();
+      });
 
     this.notificationService.new$
       .subscribe(notif => {
@@ -251,6 +283,43 @@ export class NavigationComponent implements OnInit {
       ))
   }
 
+   pause(event: Event, duration: number) {
+    // prevent default and stop-propagation to avoid
+    // expanding the accordion body.
+    event.preventDefault();
+    event.stopPropagation();
+
+    this.portapi.pause(duration, false)
+      .subscribe(this.actionIndicator.httpObserver(
+        'Pausing ...',
+        'Failed to Pause',
+      ))
+  }
+  pauseSPN(event: Event, duration: number) {
+    // prevent default and stop-propagation to avoid
+    // expanding the accordion body.
+    event.preventDefault();
+    event.stopPropagation();
+
+    this.portapi.pause(duration, true)
+      .subscribe(this.actionIndicator.httpObserver(
+        'Pausing SPN...',
+        'Failed to Pause SPN',
+      ))
+  }
+  resume(event: Event) {
+    // prevent default and stop-propagation to avoid
+    // expanding the accordion body.
+    event.preventDefault();
+    event.stopPropagation();
+
+    this.portapi.resume()
+      .subscribe(this.actionIndicator.httpObserver(
+        'Resuming ...',
+        'Failed to Resume',
+      ))
+  }
+    
   /**
    * @private
    * Opens the data-directory of the portmaster installation.

desktop/angular/src/app/services/status.service.ts

@@ -13,10 +13,7 @@ export class StatusService {
    */
   static trackSubsystem: TrackByFunction<Subsystem> = trackById;
   readonly trackSubsystem = StatusService.trackSubsystem;
-
-  readonly statusPrefix = "runtime:"
-  readonly subsystemPrefix = this.statusPrefix + "subsystems/"
-
+  
   /**
    * status$ watches the global core status. It's mutlicasted using a BehaviorSubject so new
    * subscribers will automatically get the latest version while only one subscription
@@ -48,48 +45,4 @@ export class StatusService {
       SelectedSecurityLevel: securityLevel,
     });
   }
-
-
-  /**
-   * Loads the current status of a subsystem.
-   *
-   * @param name The ID of the subsystem
-   */
-  getSubsystemStatus(id: string): Observable<Subsystem> {
-    return this.portapi.get(this.subsystemPrefix + id);
-  }
-
-  /**
-   * Loads the current status of all subsystems matching idPrefix.
-   * If idPrefix is an empty string all subsystems are returned.
-   *
-   * @param idPrefix An optional ID prefix to limit the returned subsystems
-   */
-  querySubsystem(idPrefix: string = ''): Observable<Subsystem[]> {
-    return this.portapi.query<Subsystem>(this.subsystemPrefix + idPrefix)
-      .pipe(
-        map(reply => reply.data),
-        toArray(),
-      )
-  }
-
-  /**
-   * Watch a subsystem for changes. Completes when the subsystem is
-   * deleted. See {@method PortAPI.watch} for more information.
-   *
-   * @param id The ID of the subsystem to watch.
-   * @param opts Additional options for portapi.watch().
-   */
-  watchSubsystem(id: string, opts?: WatchOpts): Observable<Subsystem> {
-    return this.portapi.watch(this.subsystemPrefix + id, opts);
-  }
-
-  /**
-   * Watch for subsystem changes
-   *
-   * @param opts Additional options for portapi.sub().
-   */
-  watchSubsystems(opts?: RetryableOpts): Observable<Subsystem[]> {
-    return this.portapi.watchAll<Subsystem>(this.subsystemPrefix, opts);
-  }
 }

desktop/angular/src/app/services/status.types.ts

@@ -27,7 +27,7 @@ export function getOnlineStatusString(stat: OnlineStatus): string {
 export interface CoreStatus extends Record {
   OnlineStatus: OnlineStatus;
   CaptivePortal: CaptivePortal;
-  // Modules: []ModuleState; // TODO: Do we need all modules?
+  Modules: StateUpdate[]; // TODO: Do we need all modules?
   WorstState: {
     Module: string,
     ID: string,
@@ -39,6 +39,20 @@ export interface CoreStatus extends Record {
   }
 }
 
+export interface StateUpdate {
+  Module: string;
+  States: State[];
+}
+
+export interface State {  
+  ID: string;             // Program-unique identifier  
+  Name: string;           // State name (may serve as notification title)  
+  Message?: string;       // Detailed message about the state  
+  Type?: ModuleStateType; // State type  
+  Time?: Date;            // Creation time  
+  Data?: any;             // Additional data for processing
+}
+
 export enum ModuleStateType {
   Undefined = "",
   Hint = "hint",
@@ -110,3 +124,55 @@ export interface VersionStatus extends Record {
     [key: string]: Resource
   }
 }
+
+function getModuleStates(status: CoreStatus, moduleID: string): State[] {
+  const module = status.Modules?.find(m => m.Module === moduleID);
+  return module?.States || [];  
+}
+
+/**
+ * Retrieves a specific state from a module within the CoreStatus.
+ * @param status The CoreStatus object containing module states.
+ * @param moduleID The identifier of the module to search within.
+ * @param stateID The identifier of the state to retrieve.
+ * @returns The State object if found; otherwise, null.
+ * @example
+ * ```typescript
+ * const state = GetModuleState(status, 'Control', 'control:paused');
+ * if (state) {
+ *   console.log(`State found: ${state.Name}`);
+ * } else {
+ *   console.log('State not found');
+ * }
+ * ```
+ */
+export function GetModuleState(status: CoreStatus, moduleID: string, stateID: string): State | null {
+  const states = getModuleStates(status, moduleID);
+  for (const state of states) {
+    if (state.ID === stateID) {
+      return state;
+    }
+  }
+  return null;
+}
+
+/**
+ * Data structure for the 'control:paused' state from the 'Control' module.
+ * 
+ * This interface defines the expected structure of the Data field when Portmaster
+ * or its components are temporarily paused by the user.
+ * 
+ * @example
+ * ```typescript
+ * const pausedState = GetModuleState(status, 'Control', 'control:paused');
+ * if (pausedState?.Data) {
+ *   const pauseData = pausedState.Data as ControlPauseStateData;
+ *   console.log(`SPN paused: ${pauseData.SPN}`);
+ * }
+ * ```
+ */
+export interface ControlPauseStateData { 
+    Interception: boolean;  // Whether Portmaster interception is paused
+    SPN:          boolean;  // Whether SPN is paused    
+    TillTime:     string;   // When the pause will end (JSON date as string, has to be converted to Date)
+}

desktop/angular/src/app/shared/security-lock/security-lock.ts

@@ -1,7 +1,7 @@
 import { ChangeDetectionStrategy, ChangeDetectorRef, Component, DestroyRef, Input, OnInit, inject } from "@angular/core";
 import { SecurityLevel } from "@safing/portmaster-api";
 import { combineLatest } from "rxjs";
-import { StatusService, ModuleStateType } from "src/app/services";
+import { StatusService, ModuleStateType, GetModuleState, ControlPauseStateData } from "src/app/services";
 import { fadeInAnimation, fadeOutAnimation } from "../animations";
 
 interface SecurityOption {
@@ -62,6 +62,17 @@ export class SecurityLockComponent implements OnInit {
             break;
         }
 
+        // Checking for Control:Paused state
+        const pausedState = GetModuleState(status, 'Control', 'control:paused');
+        if (pausedState?.Data) {
+          const pauseData = pausedState.Data as ControlPauseStateData;
+          if (pauseData.Interception === true) {
+            this.lockLevel.displayText = 'Insecure: PAUSED';
+          } else if (pauseData.SPN === true) {
+            this.lockLevel.displayText = 'Secure (SPN Paused)';
+          }
+        }
+
         this.cdr.markForCheck();
       });
   }

desktop/angular/src/i18n/helptexts.yaml

@@ -99,6 +99,14 @@ navTools:
   title: Version and Tools
   content: |
     View the Portmaster's version and use special actions and tools.
+  nextKey: navPause
+
+navPause:
+  title: Pause and Resume
+  content: |
+    Temporarily disable Portmaster's protection and network monitoring.
+    
+    Choose to pause SPN only or disable all protection completely.
   nextKey: navPower
 
 navPower: