https://github.com/curityio/short-key-oidc

An authenticator plugin implementing OpenID Connect with a provider that signs its ID token using a key that is too small to allowed to be used by the built-in OIDC authenticator.
https://github.com/curityio/short-key-oidc

Last synced: 10 months ago
JSON representation

An authenticator plugin implementing OpenID Connect with a provider that signs its ID token using a key that is too small to allowed to be used by the built-in OIDC authenticator.

• Host: GitHub
• URL: https://github.com/curityio/short-key-oidc
• Owner: curityio
• License: apache-2.0
• Created: 2023-12-05T13:13:32.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T09:52:15.000Z (almost 2 years ago)
• Last Synced: 2025-01-30T13:29:57.846Z (11 months ago)
• Language: Kotlin
• Size: 32.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
ShortKeyOidc Authenticator Plug-in

===================================

.. image:: https://travis-ci.org/curityio/short-key-oidc-authenticator.svg?branch=dev

     :target: https://travis-ci.org/curityio/short-key-oidc-authenticator

This project provides an Authenticator plug-in for the Curity Identity Server. The plugin is a basic authenticator using an OIDC provider for authentication. This plugin is specifically made to work with OIDC providers that sign their ID token with a key that is too short to be accepted by the built-in OIDC authenticator, but may also serve as an example of how such an authenticator can be implemented.

.. note::

    This authenticator does not implement its own client authentication, meaning that the configured HTTP client must have the Basic authentication scheme enabled, and the provider must support Basic authentication for the token request.

System Requirements

~~~~~~~~~~~~~~~~~~~

* Curity Identity Server 8.6.0 and `its system requirements `_ (Older versions may be supported if the SDK version is changed in the pom.xml)

Requirements for Building from Source

"""""""""""""""""""""""""""""""""""""

* Maven 3

* Java JDK v. 8

Compiling the Plug-in from Source

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The source is very easy to compile. To do so from a shell, issue this command: ``mvn package``. The result will be the plugin jar in the `target` folder, as well as the necessary dependencies in `target/dependency`

Installation

~~~~~~~~~~~~

To install this plug-in, compile it from source (as described above). The resulting JAR file as well as the dependencies needs to placed in the directory ``${IDSVR_HOME}/usr/share/plugins/short-key-oidc``. (The name of the last directory, ``short-key-oidc``, which is the plug-in group, is arbitrary and can be anything.) After doing so, the plug-in will become available as soon as the node is restarted.

.. note::

    The JAR file needs to be deployed to each run-time node and the admin node. For simple test deployments where the admin node is a run-time node, the JAR file only needs to be copied to one location.

For a more detailed explanation of installing plug-ins, refer to the `Curity developer guide `_.

License

~~~~~~~

This plugin and its associated documentation is listed under the `Apache 2 license `_.

More Information

~~~~~~~~~~~~~~~~

Please visit `curity.io `_ for more information about the Curity Identity Server.

Copyright (C) 2018 Curity AB.