inSpac

^{Developed by Thoughtworks, Inc.}

About

inSpac is the abbreviation for in Singpass Authentication Components, developed and maintained by Thoughtworks, Inc.

inSpac offers an SDK and a Keycloak plugin that can help developers fast integrate OpenID-Connect 1.0 auth scheme into project to interact with Singapore government digital platform -- Singpass.

inSpac is implemented based on the official public documents: For Developers {Login} / Overview

Artifacts & Usage

SDK

The SDK is for helping developers fast integrate with authentication scheme of Singpass platform.

To use the SDK, you have to import the SDK jar as a gradle dependency. For example, build.gradle.kts is configured as below.

dependencies {
    implementation(fileTree(mapOf("dir" to "lib", "include" to listOf("*.jar"))))
    // All [.jar] files under [lib] folder are going to be imported as gradle dependencies
    
    // Other dependencies
    }

1. Download the latest version of SDK artifact (com.thoughtworks.inspac.sdk.jar) at GitHub Releases
2. Create lib folder under the root directory of project (base on the above gradle configuration), put the SDK under lib folder.

📖 We also offer detailed API documentations for developers' reference: https://thoughtworks.github.io/inSpac/

📦 If you would like to check SDK documents / sources codes, please check sdk folder to get more information.

Keycloak Plugin

The Keycloak plugin only works on Keycloak. If you would like to use Keycloak as service provider and finish Singpass authentication with it, then this component is helpful.

📦 If you would like to check Keycloak plugin documents / sources codes, please check keycloak-plugin folder to get more information.

Integration Sample

This is a demo project for demonstrating how to use SDK / Keycloak plugin. If you feel confused about using inSpac, please check the sample folder.

Credits

The project is licensed under MIT.

• Singpass logo, brand, shape and all related services are owned by Government of Singapore.
• All Singpass spellings strictly follow the official guidelines: Logo download & Brand guidelines - Naming Usage session.
• Keycloak is an open source project, owned by Red hat.
• MockPass is an open-source project, owned by GovTech.
• Dokka is used to generate API documents.