Redamp.io SDK

Integration Disclaimer: Please note that this documentation represents the standard, baseline capabilities of the Redamp.io SDK. The exact APIs, data structures, and integration patterns are highly customizable. Specifically, the authentication mechanisms and device identification parameters required during Initialization are subject to change based on your organization's unique security requirements and our mutual technical discovery.

1. Installation

To ensure the highest level of security and strict access control, the Redamp.io SDK will be distributed via a secure, private Maven repository. You will not need to manage manual archive files or explicit dependency lists.

Step 1: Configure Repository Access

During the technical onboarding and setup phase, your engineering team will be provided with a dedicated, revokable Access Token. You will use this token to authenticate your build environment by adding our private repository to your project's settings.gradle.kts file:

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("[https://maven.pkg.github.com/...]")
            credentials {
                username = "YOUR_COMPANY_IDENTIFIER"
                password = "PROVIDED_SECURE_ACCESS_TOKEN"
            }
        }
    }
}

Step 2: Add the SDK Dependency

Once the secure repository is configured, you will simply declare the Redamp.io SDK as a dependency in your app-level build.gradle.kts file.

dependencies {
    // Note: The final artifact namespace and version will be confirmed prior to launch
    implementation("io.redamp:sdk:1.0.0")
}

2. Initialization

Before you can perform any security scans, you must initialize the SDK. It is highly recommended to do this exactly once in your custom Application class.

The initialize function requires three parameters to configure its dependency graph and authenticate requests:

• context: The application context, required to query device hardware and system services.

• apiKey: Your company's specific Redamp.io API key for authentication.

• deviceId: A unique identifier for the device being scanned, used to accurately track security events.

Example Initialization

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        Redampio.initialize(
            context = this,
            apiKey = "YOUR_REDAMPIO_API_KEY",
            deviceId = "USER_SPECIFIC_DEVICE_ID"
        )
    }
}

3. Performing a Security Scan

Once initialized, you can trigger a full security sweep of the device using a single method.

The performFullScan() function aggregates all internal security checks (OS info, storage encryption, lock screen security, root status, connectivity, and biometrics) and returns a complete FullSecurityScanResult.

Example Usage

try {
    // Perform the scan and retrieve the comprehensive results
    val securityReport = Redampio.performFullScan()

    // Example: Evaluate a specific security vector
    if (securityReport.rootInfo.isRooted) {
        println("Warning: Device is rooted! Proceed with caution.")
    }
} catch (e: IllegalStateException) {
    println("SDK Error: Did you forget to call Redampio.initialize()?")
}