Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 4.67 KB

README.md

File metadata and controls

113 lines (83 loc) · 4.67 KB
Raw

Identus Keycloak Plugins

unit-tests GitHub Release

Overview

This repository provides a Keycloak Plugin that extends Keycloak's functionality to handle Self-Sovereign Identity (SSI) tasks, including OpenID for verifiable credential issuance.

Getting started

Using published docker image

Default Keycloak plugin image

The plugin is available as a pre-bundled Docker image. This image includes Keycloak and the plugin enabled for basic use cases. For a more complex setup, the JAR file published in the Maven repository should be used to build a custom Keycloak image. The docker-compose configuration below allows spinning up a basic Keycloak instance with the plugin enabled as part of the Identus cloud agent stack.

services:
  keycloak-oid4vci-issuer:
    image: ghcr.io/hyperledger/identus-keycloak-plugins:0.1.0
    ports:
      - "9980:8080"
    command:
      - start-dev
      - --features=preview
      - --health-enabled=true
      - --hostname-url=http://localhost:9980
      - --hostname-admin-url=http://localhost:9980
    environment:
      IDENTUS_URL: <AGENT_URL> # point to cloud agent instance
      KEYCLOAK_ADMIN: admin
      KEYCLOAK_ADMIN_PASSWORD: admin
    restart: always

  # Identus cloud agent and other services below

Customized Keycloak plugin image

In many cases, Keycloak customization is necessary for branding or to meet custom authentication and authorization requirements. The default plugin image can be used in conjunction with docker multi-stage builds to extract the Keycloak plugin JARs and create a customized Keycloak image.

The image contains plugin JARs in the /opt/keycloak/providers directory

Example Dockerfile

FROM ghcr.io/hyperledger/identus-keycloak-plugins:0.1.0 AS dist

FROM quay.io/keycloak/keycloak:23.0.7
COPY --from=dist /opt/keycloak/providers/<PLUGIN_FILE>.jar /opt/keycloak/providers/<PLUGIN_FILE>.jar

# more steps to customize assets / themes / providers

RUN /opt/keycloak/bin/kc.sh build
ENTRYPOINT [ "/opt/keycloak/bin/kc.sh" ]

Please refer to the official Keycloak documentation for customization using JAR providers.

Using published JAR

Each plugin is available individually on Github maven packages, for easy integration with your build process and fine-grained control over which plugins are included when customizing Keycloak.

Please refer to the official Keycloak documentation for customization using JAR providers.

Example

Available Plugins

identus-keycloak-oid4vci

Extends Keycloak for integration with Hyperledger Identus Cloud Agent in OID4VCI flow. The Keycloak instance to use this is the Issuer Authorization Server where the plugin takes care of the OpenID extension in the issuance flow. The plugin supports the Authorization Endpoint and Token Endpoint according to the specification. Additionally, the plugin communicates with the cloud agent during holder authorization to coordinate the issuance session.

Features

Environment Variables

Name Description
IDENTUS_URL URL of the Identus Cloud Agent to coordinate the issuance session. If the variable is not set, the TokenResponse will not contain the nonce parameter.