Evervault Android SDK

The Evervault Android SDK is a library that provides secure data encryption and secure credit card input. It's simple to integrate, easy to use and it supports a wide range of data types.

Installation

• Gradle
• Maven

Configuration

This project uses local.properties for all injectable configuration. This file is not checked into version control and contains sensitive information specific to your local setup.

Setting up local.properties

1. Copy the example configuration from the existing local.properties file
2. Replace the placeholder values with your actual Evervault credentials:

# Required
EV_API_KEY=your-actual-api-key
EV_APP_UUID=your-actual-app-uuid
EV_TEAM_UUID=your-actual-team-uuid

# Optional
MERCHANT_ID=your-actual-merchant-id
ENCLAVE_UUID=your-actual-enclave-uuid
PCR_CALLBACK_URL=your-actual-pcr-callback-url
ENCLAVE_URL=your-actual-enclave-url

Configuration Properties

All configuration is injected at build time via BuildConfig fields, ensuring no sensitive data is hardcoded in the source code.

Features

• Encrypt various data types for storing sensitive data.
• Collect credit card information for PCI-DSS compliance with Inputs.
• Connect and Remotely Attest Enclaves

SDK Reference

• Browse the upto date documentation here

Examples

This project includes a sample application that integrates Evervault Inputs and Evervault Enclaves

Commit Formatting & Releases

We use changesets to version manage in this repo.

When creating a pr that needs to be rolled into a version release, do npx changeset, select the level of the version bump required and describe the changes for the change logs. DO NOT select major for releasing breaking changes without team approval.

To release:

Merge the version PR that the changeset bot created to bump the version numbers. This will bump the versions of the packages, create a git tag for the release, and release the new version to npm.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/evervault/evervault-android/issues.

Enclaves

Enclave attestation is written in Rust and Kotlin bindings can be found here that are used to integrate them into this project.

If you wish to update the Rust bindings, make any necessary changes in the Attesation crate and run the following script to build and copy the shared library files for each architecture into this repo.

License

The sample app is released under the MIT License. See the LICENSE file for more information.