zblach / argon2-jvm

Argon2 Binding for the JVM

Argon2 Binding for the JVM

This is a JVM binding for Argon2.

Maven

With pre-compiled Argon2 libraries:

<dependency>
    <groupId>de.mkammerer</groupId>
    <artifactId>argon2-jvm</artifactId>
    <version>2.1</version>
</dependency>

Without pre-compiled Argon2 libraries:

<dependency>
    <groupId>de.mkammerer</groupId>
    <artifactId>argon2-jvm-nolibs</artifactId>
    <version>2.1</version>
</dependency>

Gradle

With pre-compiled Argon2 libraries:

compile 'de.mkammerer:argon2-jvm:2.1'

Without pre-compiled Argon2 libraries:

compile 'de.mkammerer:argon2-jvm-nolibs:2.1'

Usage

This binding needs the Argon2 C library. Libraries for the following operation systems are included in argon2-jvm library:

• Linux x86
• Linux x86-64
• Windows x86
• Windows x86-64
• Darwin (OSX)

If you'd prefer to install/compile argon2 on your own you can use argon2-jvm-nolibs instead of argon2-jvm.

If you need help to build argon2, have a look at this documentation.

// Create instance
Argon2 argon2 = Argon2Factory.create();

// Read password from user
char[] password = readPasswordFromUser();

try {
    // Hash password
    String hash = argon2.hash(2, 65536, 1, password);

    // Verify password
    if (argon2.verify(hash, password)) {
        // Hash matches password
    } else {
        // Hash doesn't match password
    }
} finally {
    // Wipe confidential data
    argon2.wipeArray(password);
}

Technical details

This library uses JNA to communicate with the Argon2 C library.

Building it yourself

Run ./gradlew clean build to build and test the software.

License

LGPL v3

Maintainer

Moritz Kammerer (@phXql)

Contributing

See contributing.md

Contributor

See contributor.md