Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc update #8

Merged
merged 1 commit into from
Oct 11, 2024
Merged

doc update #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
pull_request:
branches:
- main
- master

jobs:
build:
Expand Down
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# Keycloak X509 Client Certificate Lookup SPI for Envoy
# Keycloak X509 Client Certificate Lookup for Envoy

This project provides an X509 client certificate lookup SPI for Keycloak.
It allows Keycloak to retrieve the client certificate from the `x-forwarded-client-cert` (XFCC) header set by [Envoy proxy](https://www.envoyproxy.io/) and use it for authentication.
This project provides an X509 client certificate lookup implementation for Envoy.
It allows Keycloak to retrieve the client certificate from the `x-forwarded-client-cert` (XFCC) header set by [Envoy proxy](https://www.envoyproxy.io/) and use it for authorization.
For more information, refer to [Keycloak's reverse proxy documentation](https://www.keycloak.org/server/reverseproxy) and the section [Enabling client certificate lookup](https://www.keycloak.org/server/reverseproxy#_enabling_client_certificate_lookup).

Why this project? The extension was submitted as a pull request [keycloak#33159](https://github.com/keycloak/keycloak/pull/33159), but client certificate lookup implementations for new proxies are no longer accepted.
Instead, implementations are encouraged to be developed as extensions.
See also [Envoy's documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/headers#x-forwarded-client-cert) on XFCC header.

See [Configuring Kubernetes Ingress Controllers for Client Certificate Forwarding](docs/ingress-controllers.md) for more information on how to configure Kubernetes ingress controllers for client certificate forwarding.

> ⚠️ **Alert:** There are implications that you should be aware of when enabling client certificate lookup in Keycloak.
For more information, see [Understanding Client Certificate Forwarding and Security Implications](docs/security-and-client-cert-forwarding.md).

This project was created because the code submitted in [keycloak#33159](https://github.com/keycloak/keycloak/pull/33159) was not accepted.
Instead, Keycloak encourages the development of implementations for different proxies as extensions.

## Installation

This project is not available on Maven Central.
Expand All @@ -38,8 +39,8 @@ You will see a warning in the logs when the JAR file is loaded:
2024-10-11 09:15:29,052 WARN [org.key.services] (build-13) KC-SERVICES0047: envoy (io.github.nordix.keycloak.services.x509.EnvoyProxySslClientCertificateLookupFactory) is implementing the internal SPI x509cert-lookup. This SPI is internal and may change without notice
```

This warning is expected.
Since the X509 client certificate lookup SPI is not stable across Keycloak versions, this project may require updates for newer Keycloak versions.
This warning is expected, since the X509 client certificate lookup SPI is not guaranteed to be stable across Keycloak versions.
This project may require updates for newer Keycloak versions.

Refer to Keycloak's [Configuring Providers](https://www.keycloak.org/server/configuration-provider) documentation for more information.

Expand Down
2 changes: 1 addition & 1 deletion src/test/java/io/github/nordix/keycloak/services/x509/ClientCertificateLookupIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import jakarta.ws.rs.core.Response;

/**
* Integration tests that test the client certificate lookup functionality with Envoy and Keycloak.
* Integration tests with Envoy and Keycloak.
*/
public class ClientCertificateLookupIT {

Expand Down