https://github.com/teragrep/jai_02

Teragrep Authentication Info in JSON for Java
https://github.com/teragrep/jai_02

authentication authn java java-library json library teragrep

Last synced: about 1 month ago
JSON representation

Teragrep Authentication Info in JSON for Java

• Host: GitHub
• URL: https://github.com/teragrep/jai_02
• Owner: teragrep
• License: agpl-3.0
• Created: 2024-03-14T12:23:27.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-06T09:00:54.000Z (about 2 years ago)
• Last Synced: 2025-12-30T12:40:24.795Z (5 months ago)
• Topics: authentication, authn, java, java-library, json, library, teragrep
• Language: Java
• Homepage: https://teragrep.com
• Size: 72.3 KB
• Stars: 0
• Watchers: 2
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= jai_02

Java Authentication Info. Provides a secure way of storing authentication information with

encryption and salting.

== Features

* Provides load, save, verify and delete capabilities for Java KeyStore entries.

* Uses PKCS12 KeyStore format by default and PBKDF2WithHmacSHA1 algorithm for SecretKeys.

* The underlying KeyStore file can be modified without disrupting the functionality.

* Utilizes a cache for username-password pairs verification.

* Contains a KeyStoreFactory that is optional to use, but makes loading one easier.

== Documentation

See the official documentation on https://docs.teragrep.com[docs.teragrep.com].

== Limitations

* Not all Java KeyStore formats and SecretKey algorithms are supported. This however is a conscious

design choice as the others were deemed insecure for the purposes of this project.

== How to build and use

Building with Maven:

[source, bash]

----

$ mvn clean [install|package]

----

Example usage:

[source,java]

----

import com.teragrep.jai_02.keystore.*;

import javax.crypto.SecretKey;

public class JAI02Example {

    public static void main(String[] args) {

        // Initialize a Caching and Reloading KeyStoreAccess object.

        // Note: KeyStoreAccess can be used on its own, and you can choose

        // whether to use Reloading and Caching KeyStore accesses.

        CachingKeyStoreAccess cksa = new CachingKeyStoreAccess(

        new ReloadingKeyStoreAccess(

                new KeyStoreAccessImpl(

                        new KeyStoreFactory(path, pw.toCharArray()).build(),

                        path, pw.toCharArray()), 10L),

                10L);

        // Loading a key - this will throw an exception if not present

        PasswordEntry loadedEntry = cksa.loadKey(username);

        EntryAlias loadedAlias = loadedEntry.entryAlias();

        SecretKey loadedSecret = loadedEntry.secretKey();

        // Saving a key - this will throw an exception if it was already present

        cksa.saveKey(username, pw.toCharArray());

        // Deleting an entry

        int deleted = cksa.deleteKey(username);

        System.out.printf("Deleted <%s> entries for username <[%s]>\n", deleted, username);

        // Check if the username-password combination was correct

        boolean authOk = cksa.verifyKey(username, pw.toCharArray());

        if (authOk) {

            System.out.printf("User <[%s]> was authenticated!\n", username);

        } else {

            System.out.printf("User <[%s]> was NOT authenticated!\n", username);

        }

    }

}

----

== Contributing

You can involve yourself with our project by https://github.com/teragrep/repo-template/issues/new/choose[opening an issue] or submitting a pull request.

Contribution requirements:

. *All changes must be accompanied by a new or changed test.* If you think testing is not required in your pull request, include a sufficient explanation as why you think so.

. Security checks must pass

. Pull requests must align with the principles and http://www.extremeprogramming.org/values.html[values] of extreme programming.

. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).

Read more in our https://github.com/teragrep/teragrep/blob/main/contributing.adoc[Contributing Guideline].

=== Contributor License Agreement

Contributors must sign https://github.com/teragrep/teragrep/blob/main/cla.adoc[Teragrep Contributor License Agreement] before a pull request is accepted to organization's repositories.

You need to submit the CLA only once. After submitting the CLA you can contribute to all Teragrep's repositories.