Skip to content

Add client certificate mapper ability to choose version #1043

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

Merged
merged 2 commits into from
Dec 14, 2023
Merged

Add client certificate mapper ability to choose version #1043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bf69dd
Fix #1039: Make client certificate mapper support Spring Boot 3
anthonydahanne Nov 8, 2023
f9b4a20
Fix cloudfoundry#1039
anthonydahanne Dec 14, 2023
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
6 changes: 4 additions & 2 deletions config/client_certificate_mapper.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,7 @@

# Container security provider configuration
---
version: 1.+
repository_root: "{default.repository.root}/client-certificate-mapper"
version: 2.+
version_lines:
- 2.+
repository_root: "{default.repository.root}/client-certificate-mapper"
11 changes: 7 additions & 4 deletions docs/framework-client_certificate_mapper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Client Certificate Mapper
The Client Certificate Mapper Framework adds a Servlet Filter to applications that will that maps the `X-Forwarded-Client-Cert` to the `javax.servlet.request.X509Certificate` Servlet attribute.
The Client Certificate Mapper Framework adds a Servlet Filter to applications that will that maps the `X-Forwarded-Client-Cert` to the `javax|jakarta.servlet.request.X509Certificate` Servlet attribute.

The Client Certificate Mapper Framework will download a helper library, [java-buildpack-client-certificate-mapper][library repository], that will enrich Spring Boot (2 and 3), as well as JEE / JakartaEE applications classpath with a servlet filter.

<table>
<tr>
Expand All @@ -18,10 +20,10 @@ For general information on configuring the buildpack, including how to specify c

The framework can be configured by modifying the [`config/client_certificate_mapper.yml`][] file in the buildpack fork. The framework uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.

| Name | Description
| ---- | -----------
| Name | Description
|-------------------| -----------
| `repository_root` | The URL of the Container Customizer repository index ([details][repositories]).
| `version` | The version of Container Customizer to use. Candidate versions can be found in [this listing][].
| `version` | The version of Container Customizer to use. Candidate versions can be found in [this listing][].

## Servlet Filter
The [Servlet Filter][] added by this framework maps the `X-Forwarded-Client-Cert` to the `javax.servlet.request.X509Certificate` Servlet attribute for each request. The `X-Forwarded-Client-Cert` header is contributed by the Cloud Foundry Router and contains the any TLS certificate presented by a client for mututal TLS authentication. This certificate can then be used by any standard Java security framework to establish authentication and authorization for a request.
Expand All @@ -32,3 +34,4 @@ The [Servlet Filter][] added by this framework maps the `X-Forwarded-Client-Cert
[Servlet Filter]: https://github.com/cloudfoundry/java-buildpack-client-certificate-mapper
[this listing]: http://download.pivotal.io.s3.amazonaws.com/container-security-provider/index.yml
[version syntax]: extending-repositories.md#version-syntax-and-ordering
[library repository]: https://github.com:cloudfoundry/java-buildpack-client-certificate-mapper.git