Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Guardsquare/appsweep-gradle
This Gradle plugin can be used to continuously integrate app scanning using AppSweep into your Android app build process
https://github.com/Guardsquare/appsweep-gradle
android-development app-testing security-tools
Last synced: 3 months ago
JSON representation
This Gradle plugin can be used to continuously integrate app scanning using AppSweep into your Android app build process
- Host: GitHub
- URL: https://github.com/Guardsquare/appsweep-gradle
- Owner: Guardsquare
- License: apache-2.0
- Created: 2021-07-23T07:44:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-07T10:18:16.000Z (5 months ago)
- Last Synced: 2024-06-07T11:39:21.140Z (5 months ago)
- Topics: android-development, app-testing, security-tools
- Language: Kotlin
- Homepage: http://guardsquare.com/appsweep-mobile-application-security-testing
- Size: 174 KB
- Stars: 46
- Watchers: 10
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - Guardsquare/appsweep-gradle - This Gradle plugin can be used to continuously integrate app scanning using AppSweep into your Android app build process (Kotlin)
README
Gradle Plugin for Continuous Integration of AppSweep App Testing.
Configuring the Plugin •
Initiate the Scan •
Further Configuration
## Configuring the Plugin
The AppSweep plugin is published in the Gradle Public Repository, and can be easily added to your Android project by adding
```Groovy
plugins {
// Keep your other plugins here
id "com.guardsquare.appsweep" version "latest.release"
}
```
Important: Appsweep must run after the Android and Dexguard plugins. Please add the Appsweep plugin below Android and Dexguard in the plugins section.
Note: the dynamic version `latest.release` requires at least Gradle 7. If you want to build with an older Gradle version, you need to specify a version number.
Next, you need to configure the plugin by providing an API key for your project.
### Creating an API Key
🚀 You can create an API key directly in AppSweep. To do so, you need to visit
[AppSweep](https://appsweep.guardsquare.com), go to the project you want to create
the key for, go to the settings of the project and create the key in the API section.
This API key can then either be stored in the environment variable `APPSWEEP_API_KEY`, or by adding a appsweep block to your `app/build.gradle`.
## Initiate the Scan
When the Gradle plugin is enabled and configured, some multiple `uploadToAppSweep*` Gradle tasks are registered.
More specifically, one task will be registered for each build variant of your app. For example, if you want to upload your release build variant, you can run:
```bash
gradle uploadToAppSweepRelease
```
in the root folder of your app.
Moreover, if you have obfuscation enabled for a specific build variant, the plugin will pick up the obfuscation mapping file and upload that alongside the app.
To see all available AppSweep tasks, use
```bash
gradle tasks --group=AppSweep
```
## Further Configuration
In the `appsweep`-block in your `app/build.gradle(.kts)` file, you can make additional configurations.
### API key
Instead of using the environment variable for the API key, you can also specify it in the `appsweep`-block:
```Groovy
appsweep {
apiKey "gs_appsweep_SOME_API_KEY"
}
```
### Tags
By default, the Gradle plugin will tag each uploaded build with the variant name (e.g. `Debug` or `Release`). Additionally it will add a `Protected` tag for builds uploaded using the `uploadToAppSweep{variant}Protected` tasks. You can override this behavior and set your own tags:
```Groovy
appsweep {
apiKey "gs_appsweep_SOME_API_KEY"
configurations {
release {
tags "Public"
}
}
}
```
This will tag all builds of the release variant with `Public`.
### Commit hash
By default, the Gradle plugin will keep track of the current commit hash. This will then be displayed along with your build results so you can easily identify which version was analysed. By default the command `git rev-parse HEAD` is used to obtain this commit hash.
If you don't want to keep track of the commit hash, you can turn off this feature by specifying the `addCommitHash` option:
```Groovy
appsweep {
apiKey "gs_appsweep_SOME_API_KEY"
addCommitHash false
}
```
You can also use an alternative command to retrieve the commit hash by overriding the `commitHashCommand` option:
```Groovy
appsweep {
apiKey "gs_appsweep_SOME_API_KEY"
commitHashCommand "hg id -i"
}
```
The output of the command is attached to the newly created build, and will be shown in the results to identify that specific commit.
### Task caching
By default, the upload tasks are cached and won't run if the app is unchanged.
If this is not the desired behavior you can disable the caching and guarantee the creation of a new scan everytime an upload task
is run (Android Studio might show a warning in this case, but it can be ignored):
```Groovy
appsweep {
apiKey "gs_appsweep_SOME_API_KEY"
cacheTask false
}
```