Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cesp99/screenshield
An Open Source library to hide the screens during screenshots or recordings
https://github.com/cesp99/screenshield
android jetpack-compose kotlin kotlin-android open-source privacy
Last synced: about 1 month ago
JSON representation
An Open Source library to hide the screens during screenshots or recordings
- Host: GitHub
- URL: https://github.com/cesp99/screenshield
- Owner: cesp99
- License: mit
- Created: 2024-09-07T20:30:23.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-09T01:41:59.000Z (2 months ago)
- Last Synced: 2024-10-14T23:02:19.600Z (about 1 month ago)
- Topics: android, jetpack-compose, kotlin, kotlin-android, open-source, privacy
- Language: Kotlin
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ScreenShield: Comprehensive Protection for Sensitive Content
ScreenShield is a robust Kotlin library designed to safeguard your Android app's sensitive content by preventing screenshots and screen recordings. Built with Jetpack Compose, this library leverages Android's `FLAG_SECURE` flag to automatically protect your app's screens while they are active, ensuring that confidential information remains secure.
ScreenShield offers a seamless and efficient solution for enhancing your app's privacy. Part of the library's implementation is based on the work by [@ahmetfurkhans](https://github.com/ahmetfurkans/BlockScreenShotCompose), which inspired this effective approach.
## Key Features
- **Screenshot Protection**: Blocks users from taking screenshots of protected screens within your app.
- **Screen Recording Prevention**: Disables screen recording while your app is in the foreground, ensuring sensitive information cannot be captured.
- **Lifecycle Integration**: Automatically applies protection when your app is in use and removes it when the app goes into the background.
## Installation
To integrate ScreenShield into your Jetpack Compose project, simply drag and drop `ScreenShield.kt` into your codebase, add `import ScreenShield` where you want to use it and wrap the content you wish to protect with it.
## Usage
```kotlin
import ScreenShield
@Composable
fun YourProtectedScreen() {
ScreenShield {
// Your protected UI content
}
}
```
By wrapping your composables with `AntiSS`, you ensure that screenshots and screen recordings are blocked whenever the screen is active.
## How It Works
ScreenShield uses Android's `WindowManager.LayoutParams.FLAG_SECURE` flag to prevent screenshots and screen recordings. The library is lifecycle-aware, automatically managing protection based on the current state of the app. Whether your app is in the foreground or background, ScreenShield ensures that your content is secure.
### Core Components:
1. **AntiSS Composable**: The central composable that blocks screenshots and recordings.
2. **ComposableLifeCycle**: A lifecycle-aware composable that triggers protection based on the app's state.
3. **findActivity()**: A helper function that retrieves the current activity, essential for applying window flags.
## License
This project is distributed under the MIT License. For more details, refer to the [LICENSE](LICENSE) file.
## Contact
For inquiries or support, feel free to reach out to Carlo at [[email protected]](mailto://[email protected]).
## Authors
- [Carlo Esposito](https://www.github.com/cesp99)
- [Ahmet Furkan](https://github.com/ahmetfurkans) (Original implementation)
## Used By
This library is used currently on this apps:
- [Eyed Auth](https://play.google.com/store/apps/details?id=de.aploi.eyedauth)