Gitiles
Code Review Sign In
LeafOS / LeafOS-Project / android_packages_apps_Seedvault / fd90be8776399aafcb289c8d8a19c4c5d393481f
commitfd90be8776399aafcb289c8d8a19c4c5d393481f[log] [tgz]
authorTorsten Grote <t@grobox.de>Mon Feb 12 10:36:51 2024 -0300
committerChirayu Desai <952062+chirayudesai@users.noreply.github.com>Tue Feb 13 23:36:05 2024 +0530
treeab999c00acf02042b24a251c108b932302ee89dc
parent09b7cabd99b5e17acbf3086aa519cad9e9baf580 [diff]
Don't include empty dirs in media backup

Otherwise, the directories would be treated as small files and we would try to backup their content which would fail.
2 files changed
tree: ab999c00acf02042b24a251c108b932302ee89dc
  1. .github/
  2. .idea/
  3. .reuse/
  4. app/
  5. contactsbackup/
  6. gradle/
  7. libs/
  8. LICENSES/
  9. storage/
  10. .cirrus.yml
  11. .editorconfig
  12. .gitignore
  13. allowlist_com.stevesoltys.seedvault.xml
  14. Android.bp
  15. build.gradle.kts
  16. build.libs.toml
  17. build.plugins.toml
  18. CHANGELOG.md
  19. default-permissions_com.stevesoltys.seedvault.xml
  20. gradle.properties
  21. gradlew
  22. gradlew.bat
  23. LICENSE
  24. logcat-verbose.sh
  25. permissions_com.stevesoltys.seedvault.xml
  26. README.md
  27. settings.gradle.kts
README.md

Seedvault

Build

A backup application for the Android Open Source Project.

If you are having an issue/question, please look at our FAQ.

Components

Features

  • Backup application data to a flash drive.
  • Restore application data from a flash drive.
  • User-friendly encryption using a mnemonic phrase (BIP39).
  • Automatic daily backups that run in the background.

Requirements

SeedVault is developed alongwith AOSP releases

We update it every time Google releases a new Android version, make any changes required for basic functionality, and any improvements possible through API changes in the OS.

This means that for ROMs using SeedVault it's recommended to use the same branch as your android version

  • This current branch android14 is meant for usage with Android 14
  • This is indicated by the version name starting with 14, and the version code starting with 34 - the Android 14 API version

For older versions of Android, check out the branches.

Trying to use an older branch on a newer version may lead to issues and is not something we can support.

Getting Started

  • Check out the wiki for information on building the application with AOSP.

What makes this different?

This application is compiled with the operating system and does not require a rooted device for use. It uses the same internal APIs as adb backup which is deprecated and thus needs a replacement.

Permissions

  • android.permission.BACKUP to back up application data.
  • android.permission.ACCESS_NETWORK_STATE to check if there is internet access when network storage is used.
  • android.permission.MANAGE_USB to access the serial number of USB mass storage devices.
  • android.permission.WRITE_SECURE_SETTINGS to change system backup settings and enable call log backup.
  • android.permission.QUERY_ALL_PACKAGES to get information about all installed apps for backup.
  • android.permission.INSTALL_PACKAGES to re-install apps when restoring from backup.
  • android.permission.MANAGE_EXTERNAL_STORAGE to backup and restore files from device storage.
  • android.permission.ACCESS_MEDIA_LOCATION to backup original media files e.g. without stripped EXIF metadata.
  • android.permission.FOREGROUND_SERVICE to do periodic storage backups without interruption.
  • android.permission.FOREGROUND_SERVICE_DATA_SYNC to do periodic storage backups without interruption.
  • android.permission.MANAGE_DOCUMENTS to retrieve the available storage roots (optional) for better UX.
  • android.permission.USE_BIOMETRIC to authenticate saving a new recovery code
  • android.permission.INTERACT_ACROSS_USERS_FULL to use storage roots in other users (optional).
  • android.permission.POST_NOTIFICATIONS to inform users about backup status and errors.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/seedvault-app/seedvault.

See DEVELOPMENT.md for information on developing Seedvault locally.

This project aims to adhere to the official Kotlin coding style.

Third-party tools

⚠ WARNING: the Seedvault developers make no guarantees about external software projects. Please be aware that disclosing your secret recovery key to other software has security risks.

The Seedvault backup parser allows you to decrypt and inspect your backups (version 0 backup). It can also re-encrypt them.

The Seedvault extractor allows you to decrypt and inspect your backups from newer versions of Seedvault (version 1 backup). It is currently work-in-progress.

License

This application is available as open source under the terms of the Apache-2.0 License.

Funding

Calyx Institute

This project is primarily developed and maintained by the Calyx Institute for usage in CalyxOS.

NGI0 PET Fund

This project was funded through the NGI0 PET Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 825310.