Authenticator

Table of Contents

• About
• Contacts
• Usage
• License
• Downloads
• Issues
• Building
• Contributing

About

Lightweight Java implementations of the HOTP and TOTP specifications for writing multi-factor authentication providers in Java.

Contacts

• Website
• IRC #Torchmind on Freenode
• GitHub

Usage

Authenticator is available via the maven central repository and thus you may directly specify it as a dependency in your maven project configuration:

<dependency>
        <groupId>com.torchmind</groupId>
        <artifactId>authenticator</artifactId>
        <version>1.1.0</version>
</dependency>

If you do however require an unstable revision of the library you will need to add the Sonatype snapshot repository to the list of your repositories as maven central does not ship unstable versions:

<repository>
        <id>sonatype</id>
        <name>Sonatype Open Source Repository</name>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>

        <snapshots>
                <enabled>true</enabled>
        </snapshots>
</repository>

License

Copyright (C) 2016 Johannes "Akkarin" Donath and other copyright owners as documented in the project's IP log.

Downloads

Released versions of the library can be found on GitHub.

Issues

You encountered problems with the library or have a suggestion? Create an issue!

1. Make sure your issue has not been fixed in a newer version (check the list of closed issues
2. Create a new issue from the issues page
3. Enter your issue's title (something that summarizes your issue) and create a detailed description containing:
   • What is the expected result?
   • What problem occurs?
   • How to reproduce the problem?
   • Crash Log (Please use a Pastebin service)
4. Click "Submit" and wait for further instructions

Building

1. Clone this repository via git clone https://github.com/Torchmind/Authenticator.git or download a zip
2. Build the modification by running mvn clean install
3. The resulting jars can be found in their respective target directories as well as your local maven repository

Contributing

Before you add any major changes to the library you may want to discuss them with us (see Contact) as we may choose to reject your changes for various reasons. All contributions are applied via Pull-Requests. Patches will not be accepted. Also be aware that all of your contributions are made available under the terms of the Apache License 2.0. Please read the Contribution Guidelines for more information.