# aerogear-attic/aerogear-otp-java architecture

> Architecture diagram of the GitHub repository aerogear-attic/aerogear-otp-java, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aerogear-attic/aerogear-otp-java
- Repository: https://github.com/aerogear-attic/aerogear-otp-java

## Overview

A small Java RFC 4226 OTP library: an application uses Totp to generate time-based codes or verify submitted codes. Totp obtains the time counter, decodes the shared Base32 secret, computes HMAC-SHA1, and reduces the digest to a six-digit value. It also provides an otpauth URI for authenticator setup. The README documents Google Authenticator compatibility; the graph focuses on the sampled runtime implementation and does not infer unsampled integration behavior.

Main entry points: [`src/main/java/org/jboss/aerogear/security/otp/Totp.java`](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/Totp.java) (TOTP API), [`src/main/java/org/jboss/aerogear/security/otp/api/Hmac.java`](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Hmac.java) (HMAC digest), [`src/main/java/org/jboss/aerogear/security/otp/api/Clock.java`](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Clock.java) (Time counter), [`src/main/java/org/jboss/aerogear/security/otp/api/Base32.java`](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Base32.java) (Base32 codec)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_application(("Calling application"))
node_totp["TOTP API<br/>[Totp.java]"]
node_clock["Time counter<br/>[Clock.java]"]
node_base32["Base32 codec<br/>[Base32.java]"]
node_hmac["HMAC digest<br/>[Hmac.java]"]
node_hash["Hash algorithm<br/>[Hash.java]"]
node_digits["OTP modulus<br/>[Digits.java]"]

node_application -->|"uses library"| node_totp
node_totp -->|"gets interval"| node_clock
node_totp -->|"decodes secret"| node_base32
node_totp -->|"computes digest"| node_hmac
node_totp -->|"reduces digest"| node_digits
node_hmac -->|"selects algorithm"| node_hash

click node_totp "https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/Totp.java"
click node_clock "https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Clock.java"
click node_base32 "https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Base32.java"
click node_hmac "https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Hmac.java"
click node_hash "https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Hash.java"
click node_digits "https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Digits.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_application toneIndigo
class node_totp toneMint
class node_clock,node_base32,node_hmac,node_hash,node_digits toneTeal
```

## Components

### Other components

- **Calling application**
- [TOTP API](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/Totp.java): `src/main/java/org/jboss/aerogear/security/otp/Totp.java`
- [Time counter](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Clock.java): `src/main/java/org/jboss/aerogear/security/otp/api/Clock.java`
- [Base32 codec](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Base32.java): `src/main/java/org/jboss/aerogear/security/otp/api/Base32.java`
- [HMAC digest](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Hmac.java): `src/main/java/org/jboss/aerogear/security/otp/api/Hmac.java`
- [Hash algorithm](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Hash.java): `src/main/java/org/jboss/aerogear/security/otp/api/Hash.java`
- [OTP modulus](https://github.com/aerogear-attic/aerogear-otp-java/blob/master/src/main/java/org/jboss/aerogear/security/otp/api/Digits.java): `src/main/java/org/jboss/aerogear/security/otp/api/Digits.java`

## Connections

- Calling application → TOTP API: uses library (evidence: `README.md`)
- TOTP API → Time counter: gets interval (evidence: `src/main/java/org/jboss/aerogear/security/otp/Totp.java`)
- TOTP API → Base32 codec: decodes secret (evidence: `src/main/java/org/jboss/aerogear/security/otp/Totp.java`)
- TOTP API → HMAC digest: computes digest (evidence: `src/main/java/org/jboss/aerogear/security/otp/Totp.java`)
- TOTP API → OTP modulus: reduces digest (evidence: `src/main/java/org/jboss/aerogear/security/otp/Totp.java`)
- HMAC digest → Hash algorithm: selects algorithm (evidence: `src/main/java/org/jboss/aerogear/security/otp/api/Hmac.java`)
