Getting Started

Kodium is designed to be simple and easy to integrate. This guide will help you get started quickly with the most common cryptographic operations.

Installation

Add Kodium to your common module's dependencies.

Gradle (Kotlin DSL)

implementation("eu.livotov.labs:kodium:1.0.0")

Gradle (Groovy)

implementation 'eu.livotov.labs:kodium:1.0.0'

Maven

<dependency>
    <groupId>eu.livotov.labs</groupId>
    <artifactId>kodium</artifactId>
    <version>1.0.0</version>
</dependency>

First Steps

Once installed, you can access Kodium's API either via the Kodium singleton or specifically via Kodium.pqc for Post-Quantum algorithms.

Generating Keys

// Classical X25519 Key Pair
val classicalKeys = Kodium.generateKeyPair()

// Hybrid Post-Quantum Key Pair (X25519 + ML-KEM-768)
val pqcKeys = Kodium.pqc.generateKeyPair()

Kodium handles complex operations behind simple APIs. Check out the dedicated sections for Asymmetric Encryption, Symmetric Encryption, Double Ratchet, and Post-Quantum cryptography.