Lazysodium for Android

Lazysodium is a complete Android implementation of the Libsodium library that provides developers with a smooth and effortless cryptography experience.

Why Lazysodium

We created Lazysodium because we really wanted a solid Libsodium compatible Java/Android library that would just work without fuss. We were exasperated and annoyed with current Libsodium implementations as some of them were just poorly maintained and poorly architected.

You can find more info here.

Used by

Features

This library is fully compatible with Kotlin powered Android projects.

You can find an up-to-date feature list here.

Quick start

This is by no means a comprehensive introduction to Lazysodium. Please view the official documentation for a more comprehensive guide.

1. Install

Install by adding the jcenter() repository. For Maven users, please see here.

// Top level build file
repositories {
    jcenter()
}

// Add to dependencies section
dependencies {
    implementation "com.goterl.lazycode:lazysodium-android:[email protected]"
    implementation 'net.java.dev.jna:jna:[email protected]'
}

Substitute VERSION_NUMBER for the version in this box:

2. Let's go!

You can now initialise and start encrypting! Please note that this library follows the official libsodium docs closely. You need to use those docs to help you find the functions you need.

// Let's initialise LazySodium, perhaps in an Application class somewhere
LazySodiumAndroid lazySodium = new LazySodiumAndroid(new SodiumAndroid());

Let's encrypt! Again, most of them are available on the official libsodium documentation.

// Cast our lazySodium object so we're only using "lazy" methods, 
// i.e methods that do the heavy work of encryption.
SecretBox.Lazy secretBoxLazy = (SecretBox.Lazy) lazySodium;
String message = "This is a super secret message.";

// Generate a symmetric key to encrypt the message.
Key key = secretBoxLazy.cryptoSecretBoxKeygen();

// Generate a random nonce.
byte[] nonce = lazySodium.nonce(SecretBox.NONCEBYTES);

// Encrypt now! Now you have a super secure encrypted message
// available in the variable cipher.
String cipher = secretBoxLazy.cryptoSecretBoxEasy(message, nonce, key);

3. You decide

Every project is different, you may need to use lower-level APIs to achieve the control you need so you use the Native interface. Or alternatively you just don't want to deal with the details so you stick to the Lazy interface.

Every interface you can cast to is helpfully all in one directory so you can easily pick the functions you need. This isolates your code and prevents you from making mistakes.

Important: If possible, please stick to using either the Native or the Lazy interface. The reason for this is that the Lazy interface defaults to converting everything to hexadecimal whereas the Native interface assumes everything is non-hexadecimal. If you don't know what you're doing, you could end up making mistakes.

You can provide your own encoder as follows:

// Base64MessageEncoder has to implement our MessageEncoder interface
Base64MessageEncoder encoder = new Base64MessageEncoder(); 
// ... then from now on all Lazy methods will be encoded in Base64.
LazySodiumAndroid lazySodium = new LazySodiumAndroid(new SodiumAndroid(), encoder); 

Documentation

See our official documentation to get started.

Apps

You can preview some of the features in our free Lazysodium app available on Google Play:

Lazysodium for Java

We also have a Java implementation available at Lazysodium for Java. It has the same API as this library so you can share code easily!

Created by Terl.