OPTIGA™ Authenticate NBT Host Library for Swift

This is the OPTIGA™ Authenticate NBT Host Library for Swift, which supports the utilization of the OPTIGA™ Authenticate NBT in Swift-based applications.

Overview

The OPTIGA™ Authenticate NBT Host Library for Swift 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 Swift-based iOS 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.

Features

• 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 the OPTIGA™ Authenticate NBT
• Enables the host application to build, encode, and decode NDEF records and messages with the NDEF library
• Supports building and parsing NDEF records of types "NFC Forum well known type" and "NFC Forum external type"
• Supports OPTIGA™ Authenticate NBT brand protection record

User guide

This host library's user guide is available in the docs folder.

Getting started

This section contains information on how to setup the OPTIGA™ Authenticate NBT Host Library for Swift and integrate it into custom Swift-based iOS/macOS applications.

Setup and requirements

Minimum required versions:

• iOS version 15 and higher
• macOS version 11 and higher

Project layout

├── .github/         # GitHub-related resources (e.g., workflows)
├── LICENSES/        # Licenses used in this project
├── Sources/         # Includes dependent modules of the host library
└── docs/            # Includes documentation sources and images

Build

The host library uses the Swift Package Manager to build.

# Build the code
swift build

To build the documentation use the following command

swift package generate-documentation

Usage

See this host library's user guide and the included sub-libraries' README.md files for more information.

Additional information

Related resources

• OPTIGA™ Authenticate NBT - product page
• OPTIGA™ Authenticate NBT - GitHub overview

Contributing

Please read CONTRIBUTING.md for detailed contribution instructions and refer to our CODE_OF_CONDUCT.md.

Contact

In case of questions regarding this repository and its contents, refer to MAINTAINERS.md for the contact details of this project's maintainers.

Licensing

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.