A backup application for the Android Open Source Project.

Find a file

LucasMZ 5605974bb3 Bump version to 15-5.1 Co-authored-by: cdesai <chirayu@calyxinstitute.org>		2024-11-20 18:19:35 -03:00
.github	Remove D2D setting, it is now always on	2024-10-10 13:42:18 -03:00
.idea	Add prototype plumbing for new v2 app backup	2024-10-08 19:36:03 -03:00
.reuse	Make Seedvault almost REUSE compliant	2024-05-23 00:44:51 +05:30
app	Bump version to 15-5.1	2024-11-20 18:19:35 -03:00
contactsbackup	Bump version to 15-5.1	2024-11-20 18:19:35 -03:00
core	Test for free space and allow 0	2024-10-22 17:35:43 -03:00
doc	Add padding to all blobs using the Padmé algorithm	2024-10-08 19:38:14 -03:00
gradle	Upgrade all the binary dependencies we include	2024-10-10 13:42:19 -03:00
libs	Clean up libraries, move to where they are included	2024-10-10 13:42:20 -03:00
LICENSES	Make Seedvault almost REUSE compliant	2024-05-23 00:44:51 +05:30
storage	storage: demo: Adjust for edge to edge support	2024-10-16 20:31:47 +05:30
.cirrus.yml	Install contactsbackup before restart, so default permissions get applied	2024-10-17 13:51:30 -03:00
.editorconfig	Improve .editorconfig setup	2021-08-25 18:24:53 +03:00
.gitignore	Add '/build' folders to .gitignore	2024-01-19 03:34:38 +00:00
allowlist_com.stevesoltys.seedvault.xml	misc: Add SPDX copyright headers	2024-05-23 00:44:51 +05:30
Android.bp	Clean up libraries, move to where they are included	2024-10-10 13:42:20 -03:00
build.gradle.kts	Move AOSP libs to root libs dir	2024-09-12 09:33:59 -03:00
CHANGELOG.md	Bump version to 15-5.1	2024-11-20 18:19:35 -03:00
default-permissions_com.stevesoltys.seedvault.xml	misc: Add SPDX copyright headers	2024-05-23 00:44:51 +05:30
gradle.properties	Don't uninstall the app and clear data after instrumentation tests	2024-10-08 19:38:14 -03:00
gradlew	Bump AGP, Gradle and dependencies to latest stable release	2024-07-27 13:06:19 +07:00
gradlew.bat	Bump AGP, Gradle and dependencies to latest stable release	2024-07-27 13:06:19 +07:00
logcat-verbose.sh	Show when launchable system apps do not allow backup	2024-10-10 13:42:22 -03:00
permissions_com.stevesoltys.seedvault.xml	misc: Add SPDX copyright headers	2024-05-23 00:44:51 +05:30
README.md	Update README	2024-10-14 10:01:38 -03:00
settings.gradle.kts	Add core gradle module with unified storage backends	2024-09-12 09:18:21 -03:00

README.md

Seedvault

A backup application for the Android Open Source Project. Needs to be integrated in your Android ROM and can not be installed as a regular app.

If you are having an issue/question, please look at our FAQ or ask a new question.

Components

Local Contacts Backup - an app that backs up local on-device contacts
File backup library - a library handling efficient backup of files (documentation)
Seedvault app - the main app where all functionality comes together (documentation)

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 along with 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 android15 is meant for usage with Android 15
This is indicated by the version name starting with 15, and the version code starting with 35 - the Android 15 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.

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.QUERY_USERS to get the name of the user profile that gets backed up.
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.

NGI0 Entrust Fund

This project was funded through the NGI0 Entrust 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 101069594.