Skip to content

Latest commit

 

History

History
210 lines (157 loc) · 9.18 KB

README.md

File metadata and controls

210 lines (157 loc) · 9.18 KB
Raw

Plugin.Maui.ScreenSecurity

NuGet

Plugin.Maui.ScreenSecurity provides a seamless solution for preventing content exposure, as well as blocking screenshots and recordings within your .NET MAUI application

Platforms supported

Platform Version
.Net MAUI Android API 21+
.Net MAUI iOS iOS 14+
Windows 10.0.17763+

Version 1.2.0

What's new?

  • Added IsProtectionEnabled property to check if screen protection is already enabled or disabled.
  • Added ScreenCaptured event handler, which triggers notifications when a screenshot is taken or the screen is recorded.
  • Fixed iOS issues.
  • Added Blazor sample to showcase the implementation of this plugin.

Click here to see the full Changelog!

Installation

Plugin.Maui.ScreenSecurity is available via NuGet, grab the latest package and install it on your solution:

Install-Package Plugin.Maui.ScreenSecurity

Initialize the plugin in your MauiProgram class:

using Plugin.Maui.ScreenSecurity;

public static MauiApp CreateMauiApp()
{
    var builder = MauiApp.CreateBuilder();

    builder
        .UseMauiApp<App>()
        .ConfigureFonts(fonts =>
        {
            fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
            fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
        })
        .UseScreenSecurity();

    return builder.Build();
}

Android

In your Android.manifest file (Platforms/Android) add the following permission:

<uses-permission android:name="android.permission.DETECT_SCREEN_CAPTURE" />

Using Plugin.Maui.ScreenSecurity

Finally, add the default instance of the plugin as a singleton to inject it in your code late:

builder.Services.AddSingleton<IScreenSecurity>(ScreenSecurity.Default);

⚠️ WARNING ⚠️

It's important to acknowledge that preventing users from taking screenshots or recordings of your app can be a challenging task and achieving complete prevention may not be feasible. It's worth noting that no method can entirely eliminate the possibility of your screen being captured through another physical device or a potential breach in the OS.

👉 It's also important to consider the impact on user experience when implementing any of these methods and striking a balance with the security concerns of your app.

API Usage

If you are still using version 1.0.0, please refer to the Legacy docs for the previous version.

The new unified API includes two methods: ActivateScreenSecurityProtection() and DeactivateScreenSecurityProtection(), with optional parameters applicable only to the iOS platform. It also provides two properties: IsProtectionEnabled, which checks if protection is active, and the ScreenCaptured event handler, which notifies when a screenshot is taken or the screen is recorded.

void ActivateScreenSecurityProtection();

When you activate this protection, your app's content will be safeguarded when it's sent to the Recents screen or the App Switcher. This helps ensure that sensitive information won't be exposed.

Behavior by platform:

  • Android: provides enhanced protection for screen content by preventing exposure when the app is sent to the Background or displayed on the Recents screen. It also effectively prevents unauthorized screenshots or recordings from being captured.
  • Windows: Prevents screenshots and recordings by obscuring the screen of the app.
  • iOS: By default, it apply a blur layer when the app is sent to the Background or displayed on the App Switcher. Also enables the screenshot and screen recording protection.
void ActivateScreenSecurityProtection(bool blurScreenProtection, bool preventScreenshot, bool preventScreenRecording);

This method is similar to the previous method, but with parameters to change the default values in iOS:

  • blurScreenProtection: Enable/disable screen blurring to prevent content visibility in the background. True by default.
  • preventScreenshot: Decide whether users can take screenshots of your app. True by default.
  • preventScreenRecording: Control whether users can record the screen while using your app. True by default.
void ActivateScreenSecurityProtection(ScreenProtectionOptions screenProtectionOptions);

This method is similar to the original method, but takes a ScreenProtectionOptions parameter. This allows you to further customize the screen protection by specifying either a Color or an Image, along with the the screenshot and screen recording protection for iOS devices.

Note: If you set both Color and Image, it will only apply the one you declared first.

ScreenProtectionOptions properties:

  • Color: Represents a color in the form of a hexadecimal string and can be passed as an argument to customize the color layer. It supports formats such as #RGB, #RGBA, #RRGGBB, or #RRGGBBAA. Empty by default.
  • Image: The name of the image file along with its extension. In order to utilize this property, please follow these steps:
    • Save the image you intend to use inside the Resources\Images folder.
    • Ensure you refer to the .Net MAUI Image documentation for detailed instructions on how to accomplish this task effectively.
    • ⚠️ If your app does not recognize the image after setting the build action to MauiImage, consider changing the build action to Embedded resource to ensure proper functionality.
  • PreventScreenshot: Decide whether users can take screenshots of your app. True by default.
  • PreventScreenRecording: Control whether users can record the screen while using your app. True by default.
void DeactivateScreenSecurityProtection();

This method deactivates all screen security protection.

bool IsProtectionEnabled { get; }

This bool checks if screen protection is enabled.

event EventHandler<EventArgs>? ScreenCaptured;

The event handler is triggered when the screen is captured, either through a screenshot or recording on Android and iOS, but only for screenshots on Windows.

Usage Example

public partial class MainPage : ContentPage
{
    private readonly IScreenSecurity _screenSecurity;

    public MainPage(IScreenSecurity screenSecurity)
    {
        InitializeComponent();

        _screenSecurity = screenSecurity;
    }

    protected override void OnAppearing()
    {
        base.OnAppearing();

        // Check if screen security protection is not enabled
        if (!_screenSecurity.IsProtectionEnabled)
        {
            // Activate the screen security protection with default settings
            _screenSecurity.ActivateScreenSecurityProtection();
        }

        // Attach to the ScreenCaptured event handler
        _screenSecurity.ScreenCaptured += OnScreenCaptured;

        /*
        // For changing iOS options, follow one of the next examples:

        // Example 1: Customize with a specific color
        var screenProtectionOptions = new ScreenProtectionOptions
        {
            HexColor = "#6C4675",
            PreventScreenshot = true,
            PreventScreenRecording = false
        };

        // Example 2: Customize with an image
        var screenProtectionOptions = new ScreenProtectionOptions
        {
            Image = "protection_bg.png"
            PreventScreenshot = false,
            PreventScreenRecording = true
        };

        _screenSecurity.ActivateScreenSecurityProtection(screenProtectionOptions);
        */
    }

    protected override void OnDisappearing()
    {
        _screenSecurity.DeactivateScreenSecurityProtection();

        // Detach from the ScreenCaptured event handler
        _screenSecurity.ScreenCaptured -= OnScreenCaptured;

        base.OnDisappearing();
    }

    private async void OnScreenCaptured(object sender, EventArgs e)
    {
        string title = "ScreenSecuritySample";
        string message = "Screen was captured by screenshot or recording.";

        await Shell.Current.DisplayAlert(title, message, "Ok");
    }
}

Sample

Refer to the ScreenSecuritySample for a comprehensive and detailed implementation of this plugin, providing you with a complete understanding of its usage.

Contributions

Please feel free to open an Issue if you encounter any bugs or submit a PR to contribute improvements or fixes. Your contributions are greatly appreciated.

License

The Plugin.Maui.ScreenSecurity is licensed under MIT license.

Contributors