Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/curityio/nginx_phantom_token_module
NGINX module that introspects phantom access tokens according to RFC 7662
https://github.com/curityio/nginx_phantom_token_module
api-gateway introspection nginx oauth2 phantom-token
Last synced: 1 day ago
JSON representation
NGINX module that introspects phantom access tokens according to RFC 7662
- Host: GitHub
- URL: https://github.com/curityio/nginx_phantom_token_module
- Owner: curityio
- License: apache-2.0
- Created: 2017-07-14T12:47:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T08:14:58.000Z (about 1 month ago)
- Last Synced: 2024-12-17T05:32:44.117Z (10 days ago)
- Topics: api-gateway, introspection, nginx, oauth2, phantom-token
- Language: C
- Homepage: https://curity.io/resources/learn/nginx-phantom-token-module/
- Size: 586 KB
- Stars: 64
- Watchers: 7
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Phantom Token NGINX Module
[](https://curity.io/resources/code-examples/status/)
[](https://curity.io/resources/code-examples/status/)
NGINX module that introspects access tokens according to [RFC 7662](https://tools.ietf.org/html/rfc7662), producing a "phantom token" that can be forwarded to back-end APIs and Web services. Read more about the [Phantom Token approach](https://curity.io/resources/learn/phantom-token-pattern/).
This module, when enabled, filters incoming requests, denying access to those which do *not* have a valid OAuth access token presented in an `Authorization` header. From this header, the access_token is extracted and introspected using the configured endpoint. The Curity Identity Server replies to this request according to the standard. For an active access token, the body of the Curity Identity Server's response contains the JWT that replaces the access token in the header of the request that is forwarded by NGINX to the back-end. If the token is not valid or absent, no request to the back-end is made and the caller is given a 401, unauthorized, error. This flow is shown in the following diagram:
The initial calls by the app (web or native) are done using [OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html) (OIDC). The important part is that the token that is issued is an opaque access token. It is a GUID or UUID or a few handfuls of random bytes; there is no identity-related data in this token. It is a _phantom_ of the actual user data, hence the name -- _phantom token_. The app presents the token to the NGINX gateway according to the _Bearer Token Usage_ specficiation (i.e., [RFC 6750](https://tools.ietf.org/html/rfc6750)). This standard says that the app should send the phantom token in the `Authorization` request header.
Once the NGINX server receives the access token, this module will kick in. Using configuration like that below, this module will interrogate the request, find the token, and make a sideways call to the Curity Identity Server. This web service request will be done using the _Token Introspection_ standard ([RFC 7662](https://tools.ietf.org/html/rfc7662)) with an `Accept` type of `application/jwt` (as defined in [RFC 7519](https://tools.ietf.org/html/rfc7519#section-10.3.1)). This will cause the Curity Identity Server to return not JSON but just a JWT. Then, the module will forward the JWT token to the back-end APIs and microservices.
If the module is also configured to cache the results of the call to the Curity Identity Server (which it should be for production cases), the phantom token will be used as a cache key for the corresponding JWT token. This will eliminate the need for subsequent calls to the Curity Identity Server for as long as it tells the NGINX module it may cache the JWT for.
The tl;dr is a very simple API gateway that is blazing fast, highly scalable, and without any bells and whistles to get in the way. All the code is here, so it's easy to change and use with other OAuth servers even!
## Configuration Directives
### Required Configuration Directives
All the directives in this subsection are required; if any of these are omitted, the module will be disabled.
#### phantom_token
> **Syntax**: **`phantom_token`** `on` | `off`
>
> **Default**: *`off`*
>
> **Context**: `location`
#### phantom_token_client_credential
> **Syntax**: **`phantom_token_client_credential`** _`string`_ _`string`_
>
> **Default**: *`—`*
>
> **Context**: `location`
The client ID and secret of the OAuth client which will be used for introspection. The first argument to this directive is the client ID and the second is the secret. The maximum total length of the two arguments must be less than 255 characters. Both should be printable ASCII values; non-ASCII values _may_ work but are untested. If this directive is not configured, then the module will be disabled.
#### phantom_token_introspection_endpoint
> **Syntax**: **`phantom_token_introspection_endpoint`** _`string`_
>
> **Default**: *`—`*
>
> **Context**: `location`
The name of the location that proxies requests to the Curity Identity Server. Note that this location needs to be in the same server as the one referring to it using this directive.
Example configuration:
```nginx
server {
location /api {
...
phantom_token_introspection_endpoint my_good_location_name_for_curity;
}
location my_good_location_name_for_curity {
...
}
}
```
### Optional Configuration Directives
The following directives are optional and do not need to be configured.
#### phantom_token_realm
> **Syntax**: **`phantom_token_realm`** _`string`_
>
> **Default**: *`api`*
>
> **Context**: `location`
The name of the protected realm or scope of protection that should be used when a client does not provide an access token.
Example configuration:
```nginx
location / {
...
phantom_token_realm "myGoodRealm";
}
```
#### phantom_token_scopes
> **Syntax**: **`phantom_token_scopes`** _`string`_
>
> **Default**: *`—`*
>
> **Context**: `location`
The space-separated list of scopes that the server should inform the client are required when it does not provide an access token.
Example configuration:
```nginx
location / {
...
phantom_token_scopes "scope_a scope_b scope_c";
}
```
#### phantom_token_scope
> **Syntax**: **`phantom_token_scope`** _`string`_
>
> **Default**: *`—`*
>
> **Context**: `location`
An array of scopes that the server should inform the client are required when it does not provide an access token. If `phantom_token_scopes` is also configured, that value will supersede these.
Example configuration:
```nginx
location / {
...
phantom_token_scope "scope_a";
phantom_token_scope "scope_b";
phantom_token_scope "scope_c";
}
```
## Sample Configuration
### Loading the Module
If the module is downloaded from GitHub or compiled as a shared library (the default) and not explicitly compiled into NGINX, it will need to be loaded using the [load_module](http://nginx.org/en/docs/ngx_core_module.html#load_module) directive. This needs to be done in the _main_ part of the NGINX configuration:
```nginx
load_module modules/ngx_curity_http_phantom_token_module.so;
```
The file can be an absolute or relative path. If it is not absolute, it should be relative to the NGINX root directory.
### Simple Configuration
The following is a simple configuration that might be used in demo or development environments where the NGINX reverse proxy is on the same host as the Curity Identity Server:
```nginx
server {
location /api {
proxy_pass https://example.com/api;
phantom_token on;
phantom_token_client_credential "client_id" "client_secret";
phantom_token_introspection_endpoint curity;
}
location curity {
proxy_pass "https://curity.example.com/oauth/v2/introspection";
}
}
```
### Complex Configuration
The following is a more complex configuration where the NGINX reverse proxy is on a separate host to the Curity Identity Server:
```nginx
server {
server_name server1.example.com;n
location /api {
proxy_pass https://example.com/api;
phantom_token on;
phantom_token_client_credential "client_id" "client_secret";
phantom_token_introspection_endpoint curity;
phantom_token_realm "myGoodAPI";
phantom_token_scopes "scope_a scope_b scope_c";
}
location curity {
proxy_pass "https://server2.example.com:8443/oauth/v2/introspection";
}
}
server {
listen 8443;
server_name server2.example.com;
location / {
proxy_pass "https://curity.example.com";
}
}
```
### More Advanced Configuration with Separate Servers and Caching
This module takes advantage of NGINX built-in _proxy_cache_ directive. In order to be able to cache the requests made to the introspection endpoint, except of the `proxy_cache_path` in http context and `proxy_cache` in location context, you have to add the following 3 directives in the location context of the introspection endpoint.
- `proxy_cache_methods POST;` POST requests are not cached by default.
- `proxy_cache_key $request_body;` The key of the cache is related to the _access_token_ sent in the original request. Different requests using the same _access_token_ reach the same cache.
- `proxy_ignore_headers Set-Cookie;` NGINX will not cache the response if `Set-Cookie` header is not ignored.
```nginx
http {
proxy_cache_path /path/to/cache/cache levels=1:2 keys_zone=my_cache:10m max_size=10g
inactive=60m use_temp_path=off;
server {
server_name server1.example.com;
location /api {
proxy_pass https://example.com/api;
phantom_token on;
phantom_token_client_credential "client_id" "client_secret";
phantom_token_introspection_endpoint curity;
phantom_token_scopes "scope_a scope_b scope_c";
phantom_token_realm "myGoodAPI";
}
location curity {
proxy_pass "https://server2.example.com:8443/oauth/v2/introspection";
proxy_cache_methods POST;
proxy_cache my_cache;
proxy_cache_key $request_body;
proxy_ignore_headers Set-Cookie;
}
}
server {
listen 8443;
server_name server2.example.com;
location / {
proxy_pass "https://curity.example.com";
}
}
}
```
## Cacheless Configuration
It is recommended to cache the results of the call to the Curity Identity Server so that you avoid triggering an introspection request for every API request. If you wish to disable caching you should extend the default [proxy_buffer_size](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#directives) to ensure that the module can read large JWTs. Do so by updating the configuration of the introspection request as in the following example.
```nginx
http {
server {
server_name server1.example.com;
location /api {
proxy_pass https://example.com/api;
phantom_token on;
phantom_token_client_credential "client_id" "client_secret";
phantom_token_introspection_endpoint curity;
phantom_token_scopes "scope_a scope_b scope_c";
phantom_token_realm "myGoodAPI";
}
location curity {
proxy_pass "https://server2.example.com:8443/oauth/v2/introspection";
proxy_ignore_headers Set-Cookie;
proxy_buffer_size 16k;
proxy_buffers 4 16k;
}
}
server {
listen 8443;
server_name server2.example.com;
location / {
proxy_pass "https://curity.example.com";
}
}
}
```
## Compatibility
This module is compatible with Curity Identity Server versions >= 2.2. It has been tested with NGINX 1.13.7 (NGINX Plus Release 14) and NGINX 1.13.10 (NGINX Plus Release 15). It is likely to work with other, newish versions of NGINX, but only these have been tested, pre-built and verified.
### Releases
Pre-built binaries of this module are provided for the following versions of NGINX on the corresponding operating system distributions:
| | NGINX 1.25.5 / NGINX Plus R32 | NGINX 1.25.3 / NGINX Plus R31 | NGINX 1.25.1 / NGINX Plus R30 | NGINX 1.23.4 / NGINX Plus R29 | NGINX 1.23.2 / NGINX Plus R28 |
| -----------------------------------|:-----------------------------:|:-----------------------------:|:-----------------------------:|:------------------------------:|:-----------------------------:|
| Alpine | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/alpine.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/alpine.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/alpine.ngx_curity_http_phantom_token_module_1.25.1.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/alpine.ngx_curity_http_phantom_token_module_1.23.4.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/alpine.ngx_curity_http_phantom_token_module_1.23.2.so) |
| Debian 11.0 (Bullseye) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bullseye.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bullseye.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bullseye.ngx_curity_http_phantom_token_module_1.25.1.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bullseye.ngx_curity_http_phantom_token_module_1.23.4.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bullseye.ngx_curity_http_phantom_token_module_1.23.2.so) |
| Debian 12.0 (Bookworm) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bookworm.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bookworm.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/debian.bookworm.ngx_curity_http_phantom_token_module_1.25.1.so) | X | X |
| Ubuntu 20.04 LTS (Focal Fossa) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.20.04.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.20.04.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.20.04.ngx_curity_http_phantom_token_module_1.25.1.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.20.04.ngx_curity_http_phantom_token_module_1.23.4.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.20.04.ngx_curity_http_phantom_token_module_1.23.2.so) |
| Ubuntu 22.04 LTS (Jammy Jellyfish) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.22.04.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.22.04.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.22.04.ngx_curity_http_phantom_token_module_1.25.1.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.22.04.ngx_curity_http_phantom_token_module_1.23.4.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.22.04.ngx_curity_http_phantom_token_module_1.23.2.so) |
| Ubuntu 24.04 LTS (Noble Numbat) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/ubuntu.24.04.ngx_curity_http_phantom_token_module_1.25.5.so) | X | X | X | X |
| Amazon Linux 2 | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2.ngx_curity_http_phantom_token_module_1.25.1.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2.ngx_curity_http_phantom_token_module_1.23.4.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2.ngx_curity_http_phantom_token_module_1.23.2.so) |
| Amazon Linux 2023 | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2023.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2023.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2023.ngx_curity_http_phantom_token_module_1.25.1.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2023.ngx_curity_http_phantom_token_module_1.23.4.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/amzn2023.ngx_curity_http_phantom_token_module_1.23.2.so) |
| CentOS Stream 9.0+ | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/centos.stream.9.ngx_curity_http_phantom_token_module_1.25.5.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/centos.stream.9.ngx_curity_http_phantom_token_module_1.25.3.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/centos.stream.9.ngx_curity_http_phantom_token_module_1.25.1.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/centos.stream.9.ngx_curity_http_phantom_token_module_1.23.4.so) | [⇓](https://github.com/curityio/nginx_phantom_token_module/releases/download/1.6.0/centos.stream.9.ngx_curity_http_phantom_token_module_1.23.2.so) |
## Status
This module is fit for production usage.
## Development Setup
If you wish to build this module from source, in order to run against other NGINX versions, or to change the module's logic, see the [Development Wiki](https://github.com/curityio/nginx_phantom_token_module/wiki) for instructions.
## More Information
For more information about the Curity Identity Server, its capabilities, and how to use it to issue phantom tokens for microservices, visit [curity.io](https://curity.io/product/token-service/?=use-cases?tab=microservices). For background information on using the Curity Identity Server to secure API access, see our [API security resources](https://curity.io/resources/api-security).
## Licensing
This software is copyright (C) 2022 Curity AB. It is open source software that is licensed under the [Apache v. 2](LICENSE). For commercial support of this module, please contact [Curity sales](mailto:[email protected]).