Keycloak WaverifyPlus

Keycloak WaverifyPlus is a multi-project Gradle-based application designed to integrate with Keycloak for extended functionality. It comprises three subprojects:

1. mock-vp
2. authenticator-demographic
3. authenticator-pin

---

Subprojects

1. mock-vp

mock-vp is a Spring Boot application that simulates a validation provider server. It provides REST endpoints for verifying demographic information. This is used to mock real-world integrations in a controlled environment for testing and development.

For more details, see the mock-vp README.

---

2. authenticator-demographic

authenticator-demographic is a Keycloak Service Provider Interface (SPI) implementation that integrates demographic validation into the Keycloak ecosystem. It communicates with the mock-vp server to perform demographic validation and provides a mechanism to extend Keycloak functionality with custom logic.

For more details, see the authenticator-demographic README.

---

3. authenticator-pin

authenticator-pin is another Keycloak Service Provider Interface (SPI) implementation. It provides functionality for PIN-based authentication within Keycloak. This subproject extends Keycloak’s authentication mechanisms, enabling PIN-based workflows for secure user authentication.

For more details, see the authenticator-pin README.

---

How to Build and Run

1. Clone the repository:

   git clone https://github.com/uwcirg/keycloak-waverifyplus.git
   cd keycloak-waverifyplus

2. Build the entire project:

   ./gradlew build

3. To run mock-vp, execute:

   ./gradlew :mock-vp:bootRun

Running Tests and Integration Tests

mock-vp

• To run unit tests:

  ./gradlew test

authenticator-demographic

• To run unit tests:

  ./gradlew test

• To run integration tests:

  ./gradlew integrationTest