blindnet encryption engine
Java Client SDK

End-to-end encryption made easy

blindnet.dev

Documentation  •  Submit an Issue  •  Online Chat

About

This is the Java client-side SDK of the blindnet encryption engine allowing you to:

• encrypt and decrypt data for users,
• and manage user and data encryption keys.

Those functionalities are provided through two submodules:

• Core: this module uses Bouncy Castle library in order to expose API using which a client is able to perform encrypt/decrypt of data for users and manage users and their encryption keys. The module is provided through the interface named

  Blindnet

• Signal: this module uses Signal library in order to expose API using which a client is able to perform encrypt/decrypt of data for users and manage users and their encryption keys. The module is provided through the interface named

  BlindnetSignal

Get Started

🚀 Check out our Quick Start Guide to get started in a snap.

Installation

This project requires Java v11+ {...} Gradle v7.3.1+ {...}

Use Gradle Build Tool to build, install and test the project. To build project run:

gradle build

In order to run tests use:

gradle clean test

Usage

Requirements

In order to use the SDK, it is important to note that it is mandatory to add the Bouncy Castle Security provider, and that can be done by simply doing:

Security.addProvider(new BouncyCastleProvider());

Signal example

The usage example is provided within two classes, both residing in the main package.

The class names are Alice and Bob.

In order to run a simple example, a couple of arguments need to be provided in both classes.

During initialization of the BlindnetSignal class, the database path and user token need to be provided. The database path is the path to SQLite database of the device, while the token is generated using Blindnet API. Furthermore, the username must be provided as well, and it has to be the same one as the one used for token generation.

Contributing

Contributions of all kinds are always welcome!

If you see a bug or room for improvement in this project in particular, please open an issue or directly fork this repository to submit a Pull Request.

If you have any broader questions or suggestions, just open a simple informal DevRel Request, and we'll make sure to quickly find the best solution for you.

Community

All community participation is subject to blindnet’s Code of Conduct. Stay up to date with new releases and projects, learn more about how to protect your privacy and that of our users, and share projects and feedback with our team.

• Join our Slack Workspace to chat with the blindnet community and team
• Follow us on Twitter to stay up to date with the latest news
• Check out our Openness Framework and Product Management on Github to see how we operate and give us feedback.

License

The blindnet devkit sdk-java-client is available under MIT (and here is why).