Skip to content

Commit 6c8d37b

Browse files
committed
Client Certificate Mapper Documentation
This change adds the missing documentation for the Client Certificate Mapper.
1 parent a14e12f commit 6c8d37b

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ To learn how to configure various properties of the buildpack, follow the "Confi
7373
* [Tomcat](docs/container-tomcat.md) ([Configuration](docs/container-tomcat.md#configuration))
7474
* Standard Frameworks
7575
* [AppDynamics Agent](docs/framework-app_dynamics_agent.md) ([Configuration](docs/framework-app_dynamics_agent.md#configuration))
76+
* [Client Certificate Mapper](docs/framework-client_certificate_mapper.md) ([Configuration](docs/framework-client_certificate_mapper.md#configuration))
7677
* [Container Customizer](docs/framework-container_customizer.md) ([Configuration](docs/framework-container_customizer.md#configuration))
7778
* [Container Security Provider](docs/framework-container_security_provider.md) ([Configuration](docs/framework-container_security_provider.md#configuration))
7879
* [Contrast Security Agent](docs/framework-contrast_security_agent.md) ([Configuration](docs/framework-contrast_security_agent.md#configuration))
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Client Certificate Mapper
2+
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.
3+
4+
<table>
5+
<tr>
6+
<td><strong>Detection Criterion</strong></td>
7+
<td>Unconditional</td>
8+
</tr>
9+
<tr>
10+
<td><strong>Tags</strong></td>
11+
<td><tt>client-certificate-mapper=&lt;version&gt;</tt></td>
12+
</tr>
13+
</table>
14+
Tags are printed to standard output by the buildpack detect script
15+
16+
## Configuration
17+
For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to [Configuration and Extension][].
18+
19+
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.
20+
21+
| Name | Description
22+
| ---- | -----------
23+
| `repository_root` | The URL of the Container Customizer repository index ([details][repositories]).
24+
| `version` | The version of Container Customizer to use. Candidate versions can be found in [this listing][].
25+
26+
## Servlet Filter
27+
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.
28+
29+
[`config/client_certificate_mapper.yml`]: ../config/client_certificate_mapper.yml
30+
[Configuration and Extension]: ../README.md#configuration-and-extension
31+
[repositories]: extending-repositories.md
32+
[Servlet Filter]: https://github.com/cloudfoundry/java-buildpack-client-certificate-mapper
33+
[this listing]: http://download.pivotal.io.s3.amazonaws.com/container-security-provider/index.yml
34+
[version syntax]: extending-repositories.md#version-syntax-and-ordering

0 commit comments

Comments
 (0)