This is the OPTIGA™ Authenticate NBT Host Library for Java, which supports the utilization of the OPTIGA™ Authenticate NBT in Java-based applications.
The host library offers an extensive API to interact with the OPTIGA™ Authenticate NBT and to utilize its full functionality. The host library is mainly intended to be used in Java-based Android apps interfacing to the OPTIGA™ Authenticate NBT via NFC.
Refer to the OPTIGA™ Authenticate NBT - GitHub overview repository for an overview of the available host software for the OPTIGA™ Authenticate NBT.
- Sends command APDUs (C-APDU) and receives response APDUs (R-APDU) from the OPTIGA™ Authenticate NBT
- Configuration of OPTIGA™ Authenticate NBT via its configurator application
- Personalization and operational commands to support simplified interaction with OPTIGA™ Authenticate NBT
- NDEF host library that enables the host application to build, encode, and decode NDEF records and messages
- NDEF host library that supports "NFC Forum well known type" and "NFC Forum external type"
- NDEF host library that provides brand protection supported NDEF records
This host library's user guide is available in the docs folder.
This section contains information on how to setup the OPTIGA™ Authenticate NBT Host Library for Java and integrate it into custom Java-based applications.
Minimum required versions:
- Gradle version 8.3 and higher
- JDK version 1.8 and higher
├── .github/ # GitHub-related resources (e.g., workflows)
├── .reuse/ # Configuration for the this project's license information
├── LICENSES/ # Licenses used in this project
├── docs/ # Includes documentation sources and images
├── gradle/ # Includes Gradle wrapper configuration files
└── library/ # Includes dependent modules of the host library
The host library uses gradle to build.
# Build the code
.\gradlew buildTo build the documentation use the following command
.\gradlew javadocThe documentation will be put in a directory \build\docs\javadoc.
See this host library's user guide and the included sub-libraries' README.md files for more information.
Please read CONTRIBUTING.md for detailed contribution instructions and refer to our CODE_OF_CONDUCT.md.
In case of questions regarding this repository and its contents, refer to MAINTAINERS.md for the contact details of this project's maintainers.
Please see our LICENSE for copyright and license information.
This project follows the REUSE approach, so copyright and licensing information is available for every file (including third party components) either in the file header, an individual *.license file or the .reuse/dep5 file. All licenses can be found in the LICENSES folder.