Skip to content

Commit 262149d

Browse files
committed
[fapi] improve documentation
1 parent 12d7ff8 commit 262149d

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99

10+
### Fixed
11+
- Correct FAPI header to `x-fapi-interaction-id` [PR #1557](https://github.com/3scale/APIcast/pull/1557) [THREESCALE-11957](https://issues.redhat.com/browse/THREESCALE-11957)
12+
13+
### Added
14+
- Update APIcast schema manifest [PR #1550](https://github.com/3scale/APIcast/pull/1550)
15+
- Update luarocks to v3.12.0 [PR #1555](https://github.com/3scale/APIcast/pull/1555)
16+
17+
### Removed
18+
1019
## [3.16.0] 2025-05-19
1120

1221
### Fixed

gateway/src/apicast/policy/fapi/README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44

55
The FAPI policy supports various features of the Financial-grade API (FAPI) standard.
66

7-
* FAPI 1.0 Baseline Profile
8-
* FAPI 1.0 Advance Profile
7+
* [FAPI 1.0 Baseline Profile](https://openid.net/specs/openid-financial-api-part-1-1_0.html)
8+
* [FAPI 1.0 Advance Profile](https://openid.net/specs/openid-financial-api-part-2-1_0.html)
99

1010
## Example configuration
1111

12+
FAPI policy set the response header `x-fapi-interaction-id` to the value received from the corresponding FAPI client request header or to a RFC4122 UUID value if the request header was not provided.
13+
1214
```
1315
"policy_chain": [
1416
{ "name": "apicast.policy.fapi", "configuration": {} },
@@ -17,8 +19,24 @@ The FAPI policy supports various features of the Financial-grade API (FAPI) stan
1719
}
1820
]
1921
```
22+
### Log the value of x-fapi-interaction-id header
23+
24+
```
25+
"policy_chain": [
26+
{ "name": "apicast.policy.fapi", "configuration": {} },
27+
{
28+
"name": "apicast.policy.logging",
29+
"configuration": {
30+
"enable_access_logs": false,
31+
"custom_logging": "[{{time_local}}] {{host}}:{{server_port}} {{remote_addr}}:{{remote_port}} x-fapi-interaction-id: {{resp.headers.x-fapi-interaction-id}} \"{{request}}\" {{status}} {{body_bytes_sent}} ({{request_time}}) {{post_action_impact}} ",
32+
}
33+
}
34+
{ "name": "apicast.policy.apicast" }
35+
]
36+
```
2037

2138
### Validate x-fapi-customer-ip-address header
39+
Validate requests with a x-fapi-customer-ip-address header containing a valid IPv4 or IPv6 address
2240

2341
```
2442
"policy_chain": [
@@ -36,6 +54,13 @@ The FAPI policy supports various features of the Financial-grade API (FAPI) stan
3654

3755
### Validate certificate-bound access tokens
3856

57+
Certificate-bound access tokens, as defined in [RFC 8705]((https://datatracker.ietf.org/doc/html/rfc8705)), enhance security by linking tokens to clients, thereby verifying the sender's authorization to access protected resources.
58+
59+
You'll need to:
60+
* Configure an Identity Provider (IdP) such as Keycloak configured with mTLS and X.509 client certificate authentication.
61+
* Configure the gateway to handle mTLS client certificate authentication.
62+
* Enable `validate_oauth2_certificate_bound_access_token` in the FAPI plugin.
63+
3964
```
4065
"policy_chain": [
4166
{

0 commit comments

Comments
 (0)