Skip to content

Repository files navigation

KioskOps SDK for Android Enterprise

Build Coverage CodeQL Fuzz OpenSSF Scorecard Maven Central JitPack API Kotlin License Docs

An enterprise-grade Android SDK for offline-first operational events, local diagnostics, and fleet-friendly observability. Designed for kiosk, retail, logistics, and field service deployments with Samsung Knox / Android Enterprise integration.

API reference: sara-star-quant.github.io/KioskOps-SDK-Android-Enterprise (auto-published from main and release tags).

Disclaimer: Security controls and regulatory-framework references are engineering aids only, not legal, compliance, or security advice. See docs/LEGAL.md.

Installation

Option A: Maven Central (Recommended)

// settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
}

// app/build.gradle.kts
dependencies {
    implementation("com.sarastarquant.kioskops:kiosk-ops-sdk:1.4.0")
}

Option B: GitHub Packages

// settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        maven {
            url = uri("https://maven.pkg.github.com/sara-star-quant/KioskOps-SDK-Android-Enterprise")
            credentials {
                username = providers.gradleProperty("gpr.user").orNull ?: System.getenv("GITHUB_ACTOR")
                password = providers.gradleProperty("gpr.token").orNull ?: System.getenv("GITHUB_TOKEN")
            }
        }
    }
}

// app/build.gradle.kts
dependencies {
    implementation("com.sarastarquant.kioskops:kiosk-ops-sdk:1.4.0")
}

Option C: JitPack

// settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://jitpack.io") }
    }
}

// app/build.gradle.kts
dependencies {
    implementation("com.github.sara-star-quant:KioskOps-SDK-Android-Enterprise:v1.4.0")
}

Quick Start

Want to see it first? A runnable demo APK ships with each release; see Sample app for screenshots and a walkthrough.

1. Initialize SDK

class App : Application() {
    override fun onCreate() {
        super.onCreate()
        KioskOpsSdk.init(
            context = this,
            configProvider = {
                KioskOpsConfig(
                    baseUrl = "https://api.example.com/",
                    locationId = "STORE-001",
                    securityPolicy = SecurityPolicy.maximalistDefaults()
                )
            }
        )
    }
}

2. Enqueue events

// suspend function, call from a coroutine scope
lifecycleScope.launch {
    val accepted = KioskOpsSdk.get().enqueue("button_press", """{"screen": "home"}""")
}

// or use the blocking wrapper from Java / non-coroutine code
val accepted = KioskOpsSdk.get().enqueueBlocking("button_press", """{"screen": "home"}""").get()

Features

  • Encryption at rest - AES-256-GCM via Android Keystore; field-level encryption for sensitive attributes
  • PII detection and redaction - Regex-based scanner with REJECT/REDACT/FLAG actions; pluggable detector interface
  • Event validation - JSON Schema-based validation with strict/permissive modes
  • Anomaly detection - Statistical detector for payload size, event rate, schema deviation, and cardinality tracking
  • Tamper-evident audit - SHA-256 hash-chain, Room-backed, persistent across restarts
  • GDPR compliance APIs - User data export (Art. 20), deletion (Art. 17), full device wipe
  • Fleet operations - Policy drift detection, device posture, diagnostics export, remote config
  • Network sync - Opt-in batch sync with exponential backoff
  • Config presets - fedRampDefaults() and gdprDefaults() for common compliance profiles

See Features for the complete list.

Performance

Microbenchmarks of the per-event hot paths (emulator sdk_gphone64_arm64, API 34; directional, not production hardware):

Operation Median Throughput
Anomaly scoring (per event) 4.8 us ~207k events/s
Field encryption, 3 fields (AES-256-GCM) 46.1 us ~22k ops/s
Field decryption, 3 fields 39.2 us ~25k ops/s

See Benchmarks for methodology and how to reproduce.

Requirements

Requirement Version
Android API 33+ (Android 13)
Java 17+
Kotlin 2.1+
Gradle 8.11+

Documentation

Document Description
Integration Guide Step-by-step setup
Architecture System design, modules, and scope
Features Full feature list and limitations
Benchmarks Microbenchmark results and reproduction
Sample app Runnable demo, screenshots, and integration notes
Security and Compliance Threat model, transport security, key management, audit integrity
Compliance Mappings NIST 800-171, CJIS, ASD, BSI, Australian Privacy Act
Server API Contract OpenAPI spec for batch ingest
Changelog Version history
Roadmap Planned features
Go-To-Market Positioning, target buyer, pricing model, and rollout plan
Contributing Development setup and guidelines

License

Business Source License 1.1 - Copyright (c) 2026 SARA STAR QUANT LLC

Converts to Apache License 2.0 on January 1, 2032. See LICENSE for details.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. The authors and contributors shall not be held liable for any damages arising from the use of this software. See LICENSE for full terms.

About

Enterprise Android SDK for offline-first kiosk, retail, logistics, and field service deployments. Encrypted event queue, PII detection, tamper-evident audit trail, fleet diagnostics, and compliance-oriented presets (FedRAMP, NIST 800-171, CJIS, GDPR, ASD Essential Eight). Android 13+, Kotlin, Maven Central.

Topics

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages