README.md

Databridges Java for Android NaCl Wrapper Library

Databridges NACL wrapper gives you a simple write and read function using implementation of the secretbox encryption standard defined in NaCl.

Databridges NACL wrapper is available for

• JavaScript
• NodeJS
• C#
• Python
• Java for Android
• iOS Swift

The above wrappers can be used to send encrypted messages between them.

The Databridges NACL wrapper for Java Language binding uses io.github.instantwebp2p:tweetnacl-java to deliver implementation of the secretbox encryption standard defined in NaCl.

Usage Overview

The following topics are covered:

• Supported platforms
• Installation.
• Initialization
• Global Configuration
• How to use with Databridges Java for Android Library
• Change Log
• License

Supported platforms

• Minimum required : Android 5 SDK 21 (Lollipop) and above

Installation.

Using Gradle

The dataBridges NaCl wrapper is available in the Maven central repository, and can be imported as a standard dependency in your build.gradle file:

dependencies {
    implementation 'io.databridges:databridges_nacl_wrapper:1.0.2'
}

If you need the latest and greatest before Maven central updates, you can use:

repositories {
    jcenter()
    maven {
        url "https://oss.sonatype.org/content/repositories/releases"
    }
}

Initialization

import io.databridges.databridges_nacl_wrapper.databridges_nacl_wrapper;
import io.databridges.databridges_nacl_wrapper.dbnwError;
databridges_nacl_wrapper secretData = new databridges_nacl_wrapper();

Global Configuration

Required

The following is the required properties before using to dataBridges NaCl wrapper.

secretData.secret = '32 char alphanumeric string';

Properties	Description
secret	(string) 32 char alpha numeric string. NaCl encryption secret.

Encrypt data

To encrypt data using NaCl, databridges wrapper exposes a method named write, This will return encrypted data if successful else it will throw error.

write()

try {
    String encData = secretData.write("Your Data..");
    Log.d("Encrypted:", encData);
} catch (dbnwError err) {
    Log.d("Errors:", "" + err.source + "," + err.code + "," + err.message);
}

Parameter	Description
data	(string) data to be encrypted.

Return Values	Description
string	Encrypted string.

Exceptions:

Source	Code	Description
DBLIB_NACL_WRAPPER	INVALID_SECRET	secret is not set with the wrapper instance.
DBLIB_NACL_WRAPPER	INVALID_DATA	If data is not passed to the function.
DBLIB_NACL_WRAPPER	NACL_EXCEPTION	Exceptions generated by NaCl library.

Decrypt data

To decrypt data using NaCl, databridges wrapper exposes a method named read, This will return decrypted data if successful else it will throw error.

read()

try {
    String decData = secretData.read("<Encrypted data.>");
	Log.d("Decrypted:", decData);
} catch (dbnwError err) {
    Log.d("Errors", "" + err.source + "," + err.code + "," + err.message);
}

Parameter	Description
data	(string) data to be encrypted.

Return Values	Description
string	Encrypted string.

Exceptions:

Source	Code	Description
DBLIB_NACL_WRAPPER	INVALID_SECRET	secret is not set with the wrapper instance.
DBLIB_NACL_WRAPPER	INVALID_DATA	If data is not passed to the function OR data is not a valid encrypted string.
DBLIB_NACL_WRAPPER	NACL_EXCEPTION	Exceptions generated by NaCl library.
DBLIB_NACL_WRAPPER	NACL_DECRYPT_FAILED	If decryption fails due to invalid secret or manipulated data.

How to use with Databridges Java for Android Library

Below code shows how to integrate the NaCl wrapper with the Databridges library. After initialize you can use the wrapper library to encrypt and decrypt the data when publishing and receiving events.

// Initialize both databridges-sio-client-lib and databridges-nacl-wrapper
import io.databridges.databridges_nacl_wrapper.databridges_nacl_wrapper;
import io.databridges.databridges_nacl_wrapper.dbnwError;
import io.databridges:databridges_sio_java_client.dBridges;
import io.databridges.databridges-sio-java-client.exception.dBError;

databridges_nacl_wrapper secretData = new databridges_nacl_wrapper();
dBridges dbridge = new dBridges();

secretData.secret = "Your32 char secret.";

// .... Your databridges code comes here.

// On Subscription success event.
subscribeChannel.bind("dbridges:subscribe.success", new eventHandler() {
	@Override
	public void onEvent(Object message, metaData metadata) {
        try {
    		String encData = secretData.write("Your Data..");
            subscribeChannel.publish("eventName", encData, "1") 
        } catch (dbnwError err) {
    		Log.d("Errors", "" + err.source + "," + err.code + "," + err.message);
        }
	}
});

// On payload Received event.
subscribeChannel.bind("eventName", new eventHandler() {
	@Override
	public void onEvent(String message, metaData metadata) {
        try {
            String decData = secretData.read(message);
            Log.d("Decrypted:", decData);
        } catch (dbnwError err) {
            Log.d("Errors", "" + err.source + "," + err.code + "," + err.message);
        }
	}
});

Change Log

• Change log: Changes in the recent versions

License

DataBridges NaCl Wrapper is released under the MIT license.

    Copyright 2022 Optomate Technologies Private Limited.

    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.