Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
107 lines (81 sloc) 3.28 KB

Installation

This page is devoted to showing you how to install Lazysodium into your project.

Java

Requirements

Lazysodium for Java requires:

  • JDK 8 or higher.
  • Gradle 4.7 or higher (if compiling and building).
  • No effort whatsoever.

Add the library

Substitute VERSION_NUMBER with the latest version available on this page (located in the bottom right). Substitute LATEST_JNA_VERSION for the latest JNA version.

{% tabs %} {% tab title="Gradle" %}

// Top level build file
repositories {
    maven {
        url  "https://dl.bintray.com/terl/lazysodium-maven"
    }
}

// Add to dependencies section
dependencies {
    implementation "com.goterl.lazycode:lazysodium-java:VERSION_NUMBER"
    implementation "net.java.dev.jna:jna:LATEST_JNA_VERSION"
}

{% endtab %}

{% tab title="Maven" %}

// Add the repo first
<repositories>
    <repository>
      <id>lazysodium-java</id>
      <url>https://dl.bintray.com/terl/lazysodium-maven</url>
    </repository>
 </repositories>

<dependency>
  <groupId>com.goterl.lazycode</groupId>
  <artifactId>lazysodium-java</artifactId>
  <version>VERSION_NUMBER</version>
</dependency>

<dependency>
  <groupId>net.java.dev.jna</groupId>
  <artifactId>jna</artifactId>
  <version>LATEST_JNA_VERSION</version>
</dependency>

{% endtab %}

{% tab title="JARs" %} If you're wanting to just add the JAR then grab it from the files section on the Bintray page. Then verify it using our GPG key which can be found on our FAQ page. You will also need the Java JNA jar file (link above). {% endtab %} {% endtabs %}

Android

Requirements

Lazysodium for Android requires:

  • Android 19 or higher. Untested on lower versions.
  • Gradle (if compiling and building).
  • No effort whatsoever.

Add the library

Substitute VERSION_NUMBER with the latest version available on this page (located in the bottom right). Substitute LATEST_JNA_VERSION for version 4.5.2. Versions 5.0.0 and above of the JNA library come up with an error that it cannot find the libjnidispatch.so file.

{% tabs %} {% tab title="Gradle" %}

// Top level build file
repositories {
    maven {
        url  "https://dl.bintray.com/terl/lazysodium-maven"
    }
}

// Add to dependencies section.
dependencies {
    implementation "com.goterl.lazycode:lazysodium-android:VERSION_NUMBER@aar"
    implementation "net.java.dev.jna:jna:LATEST_JNA_VERSION@aar"
}

{% endtab %}

{% tab title="AARs" %} If you're wanting to just add the AAR then grab it from the files section on the Bintray page. Then optionally verify it using our GPG key which can be found on our FAQ page. You will also need to grab the AAR JNA file (link above). {% endtab %} {% endtabs %}

Verification using GPG

If you want to verify an AAR or a JAR or any file, then this question in the FAQ on GPG usage will help you out.