How kalinjul/kotlin-multiplatform-oidc works
Project Type & Purpose
• This is a Kotlin Multiplatform library suite implementing the OpenID Connect “Authorization Code Grant” flow (with PKCE), plus convenience modules (HTTP integrations, token persistence) and two application bundles (playground‐app and sample‐app) demonstrating usage on Android, iOS, Desktop, and WasmJS.
Top‐Level Modules & Directory Patterns
• build‐logic: custom Gradle convention plugins (build‐time only).
• oidc‐core: “commonMain” implementation of discovery, flows, types, JWT parsing.
• oidc‐crypto: multiplatform cryptographic support (PKCE challenge, hashing).
• oidc‐appsupport: platform‐specific AuthFlowFactory implementations (Android, iOS, JVM, WasmJS).
• oidc‐ktor, oidc‐okhttp4: optional HTTP‐client integrations (Ktor Auth plugin, OkHttp authenticator).
• oidc‐tokenstore: multiplatform token persistence (EncryptedPreferences, Keychain, in‐memory).
• playground‐app: a toy multiplatform app that assembles UI modules (core, data, domain, ui) using the library.
• sample‐app: a fully‐fledged sample demonstrating integration on each platform.
README for Insights
• Core features: discovery, PKCE, code‐auth flow, JWT parsing.
• Supported platforms & stability matrix.
• Dependencies on multiplatform settings, SQLDelight, Ktor/OkHttp.
• Sample usage patterns (DI, factory creation).
Main Components & Their Relationships
• oidc‐core (common logic)
• oidc‐crypto (crypto helpers)
• oidc‐appsupport (AuthFlowFactory per platform)
• oidc‐tokenstore (Settings‐based persistence per platform)
• HTTP integrations (oidc‐ktor, oidc‐okhttp4)
b. Application Bundles
• playground‐app (composed modules: core, domain, data, ui, shared)
• sample‐app (realistic Android, iOS, Desktop, WasmJS apps)
c. External Services & Libraries
• OAuth2/OIDC Provider endpoints (authorization, token, discovery)
• SQLDelight (for db‐sqldelight in playground app)
• Multiplatform Settings library (used by oidc‐tokenstore)
• Ktor / OkHttp engines
Dependency Flow
• oidc‐appsupport → oidc‐core → oidc‐crypto
• oidc‐ktor / oidc‐okhttp4 → oidc‐core
• oidc‐tokenstore → multiplatform‐settings
• playground‐app / sample‐app → [oidc‐appsupport, oidc‐core, oidc‐tokenstore, HTTP modules]
• playground‐app/data/db‐sqldelight → SQLDelight
• sample‐app/shared → sample‐app/platform code
Key Architectural Patterns
• Layered MPP: “commonMain” for platform‐agnostic code, “*Main” for platform specifics.
• Factory pattern: AuthFlowFactory produces platform flow.
• Optional plugin architecture: HTTP integrations are separate modules.
• DI‐friendly: flow factories and stores passed into client code.
• Persistence abstraction: token store interface with platform adapters.