From 868f29828c64cbc113e08a88468fcc3549ec59d1 Mon Sep 17 00:00:00 2001 From: Hardcore Sushi Date: Wed, 24 Jul 2024 14:01:10 +0200 Subject: [PATCH] Update Usf doc --- README.md | 80 +++++++++++++++++++++++++------------------------------ 1 file changed, 37 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index d48efc5..1877862 100644 --- a/README.md +++ b/README.md @@ -28,41 +28,47 @@ Do not use this app with volumes containing sensitive data unless you know exact - Unlocking volumes using fingerprint authentication - Volume auto-locking when the app goes in background -_For upcoming features, see [TODO.md](https://forge.chapril.org/hardcoresushi/DroidFS/src/branch/master/TODO.md)._ +For planned features, see [TODO.md](https://forge.chapril.org/hardcoresushi/DroidFS/src/branch/master/TODO.md). # Unsafe features Some available features are considered risky and are therefore disabled by default. It is strongly recommended that you read the following documentation if you wish to activate one of these options. -\* These features can work in two ways: temporarily writing the plain file to disk (DroidFS internal storage) or sharing it via memory. By default, DroidFS will choose to keep the file only in memory as it's more secure, but will fallback to disk export if the file is too large to be held in memory. This behavior can be changed with the *"Export method"* parameter in the settings. Please note that some applications require the file to be stored on disk, and therefore do not work with memory-exported files. +⁽¹⁾: These features can work in two ways: temporarily writing the plain file to disk (DroidFS internal storage) or sharing it via memory. By default, DroidFS will choose to keep the file only in memory as it's more secure, but will fallback to disk export if the file is too large to be held in memory. This behavior can be changed with the *"Export method"* parameter in the settings. Please note that some applications require the file to be stored on disk, and therefore do not work with memory-exported files. # Download @@ -90,23 +96,11 @@ F-Droid APKs should be signed with the F-Droid key. More details [here](https:// # Permissions DroidFS needs some permissions for certain features. However, you are free to deny them if you do not wish to use these features. - +- **Read & write access to shared storage**: Required to access volumes located on shared storage. +- **Biometric/Fingerprint hardware**: Required to encrypt/decrypt password hashes using a fingerprint protected key. +- **Camera**: Required to take encrypted photos or videos directly from the app. +- **Record audio**: Required if you want sound on video recorded with DroidFS. +- **Notifications**: Used to report file operations progress and notify about volumes kept open. # Limitations DroidFS works as a wrapper around modified versions of the original encrypted container implementations ([libgocryptfs](https://forge.chapril.org/hardcoresushi/libgocryptfs) and [libcryfs](https://forge.chapril.org/hardcoresushi/libcryfs)). These programs were designed to run on standard x86 Linux systems: they access the underlying file system with file paths and syscalls. However, on Android, you can't access files from other applications using file paths. Instead, one has to use the [ContentProvider](https://developer.android.com/guide/topics/providers/content-providers) API. Obviously, neither Gocryptfs nor CryFS support this API. As a result, DroidFS cannot open volumes provided by other applications (such as cloud storage clients). If you want to synchronize your volumes on a cloud, the cloud application must synchronize the encrypted directory from disk.