Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cherryperry/gradlefileencrypt
Simply encrypt your sensitive data in repository with password
https://github.com/cherryperry/gradlefileencrypt
encryption gradle gradle-plugin kotlin
Last synced: 4 months ago
JSON representation
Simply encrypt your sensitive data in repository with password
- Host: GitHub
- URL: https://github.com/cherryperry/gradlefileencrypt
- Owner: CherryPerry
- License: apache-2.0
- Created: 2018-06-28T19:01:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-11T19:07:58.000Z (over 2 years ago)
- Last Synced: 2024-03-14T21:12:06.050Z (11 months ago)
- Topics: encryption, gradle, gradle-plugin, kotlin
- Language: Kotlin
- Homepage:
- Size: 375 KB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## File encryption plugin for Gradle
[](https://github.com/CherryPerry/GradleFileEncrypt/actions/workflows/build.yml)
[](https://github.com/CherryPerry/GradleFileEncrypt/releases)
Simply encrypt files of a Gradle project with a password.
The plugin will create an encrypted copy of the file with `.encrypted` extension.
For example: `secret_keys.properties` -> `secret_keys.properties.encrypted`.
Add `secret_keys.properties` to `.gitignore` and add `secret_keys.properties.encrypted` to VCS.
### Add it to your project
#### Gradle plugin DSL
```groovy
plugins {
id 'com.cherryperry.gradle-file-encrypt' version '2.0.3'
}
```
#### Old Gradle version or where dynamic configuration is required
```groovy
buildscript {
repositories {
maven { url 'https://plugins.gradle.org/m2/' }
}
dependencies {
classpath 'gradle.plugin.com.cherryperry.gfe:gradle-file-encrypt:2.0.3'
}
}
apply plugin: 'com.cherryperry.gradle-file-encrypt'
```
### Password setup
Set password `gfe.password` in `local.properties` file in project root
or `GFE_PASSWORD` environment variable or `-DGFE_PASSWORD` Gradle system property.
You can create your own password provider via `passwordProvider`.
### Configuration
```groovy
gradleFileEncrypt {
// files to encrypt
plainFiles.from('signing.properties', 'app/google-services.json')
// (optional) setup file mapping
mapping = [ 'signing.properties' : 'secret/signing.properties' ]
// (optional) setup password provider
// if provided one is not secure enough for you
passwordProvider = { return 'YOUR LOGIC HERE'.toCharArray() }
}
```
#### File mapping
Sometimes you need to save your encrypted files in another directory.
You can configure that behavior with `mapping` configuration.
It is simple `Map`, where key is original file
and value is target file without encrypted extension.
```groovy
gradleFileEncrypt {
plainFiles.from('src/main/resources/secure.properties')
mapping = [ 'src/main/resources/secure.properties' : 'secure/keys' ]
}
```
Encrypted file `secure.properties.encrypted` will be bundled with app without `mapping`,
because it is inside the resources folder. To avoid this behavior `mapping` was provided,
so `secure/keys.encrypted` file will be an encrypted version of `src/main/resources/secure.properties`.
### Encryption and decryption
You **must** setup password before invoking these tasks.
Create encrypted files from plain files:
```bash
./gradlew encryptFiles
```
Create plain files from encrypted files (if files already exist, they will be **overwritten**):
```bash
./gradlew decryptFiles
```
### Git ignore check
You can check, if your plain unencrypted files are ignored by your `.gitignore` files in project,
so they won't appear in version control history.
```bash
./gradlew checkFilesGitIgnored
```
If any is not ignored, the task will fail and print which file is not ignored.
### Gradle
Minimal recommended gradle version is 6.8.3.
Check supported versions [here](https://github.com/CherryPerry/GradleFileEncrypt/blob/master/src/test/kotlin/com/cherryperry/gfe/FileEncryptPluginFunctionalTest.kt#L42).
### Samples
You can also see sample usage in my other projects:
1. [CherryPerry/Amiami-kotlin-backend](https://github.com/CherryPerry/Amiami-kotlin-backend)
1. [CherryPerry/Amiami-android-app](https://github.com/CherryPerry/Amiami-android-app)
Both projects are connected to Travis CI service.
Encryption password was set in [settings tab](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings) of each repository.
`./gradlew decryptFiles` command was added to pre-build script, so all files, that contains private settings required for build, are decrypted before build.
Not encrypted files were added to `.gitignore`, so there are no decrypted versions of them in the repository, only encrypted ones.
For local development I add password to `local.properties` file.