Skip to content

Commit c9e00b9

Browse files
authored
Update README.md
1 parent a853d56 commit c9e00b9

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
---
1717

1818
## Introduction
19-
**hapi-auth-keycloak** is a plugin for [hapi.js][hapijs] which enables to protect your endpoints in a smart but professional manner using [Keycloak][keycloak] as authentication service. It is inspired by the related [express.js middleware][keycloak-node]. The plugin validates the passed [`Bearer` token][bearer] offline with a provided public key or online with help of the [Keycloak][keycloak] server. Optionally, the successfully validated tokens and the related user data get cached using [`catbox`][catbox]. The caching enables a fast processing even though the user data don't get changed until the token expires. Furthermore it is possible to enable an api key interceptor proxying the request to an api key service which returns the temporary bearer token. It plays well with the [hapi.js][hapijs]-integrated [authentication/authorization feature][hapi-route-options]. Besides the authentication strategy it is possible to validate tokens by yourself, e.g. to authenticate incoming websocket or queue messages.
19+
**hapi-auth-keycloak** is a plugin for [hapi.js][hapijs] which enables to protect your endpoints in a smart but professional manner using [Keycloak][keycloak] as authentication service. It is inspired by the related [express.js middleware][keycloak-node]. The plugin validates the passed [`Bearer` token][bearer] offline with a provided public key or online with help of the [Keycloak][keycloak] server. Optionally, the successfully validated tokens and the related user data get cached using [`catbox`][catbox]. The caching enables a fast processing even though the user data don't get changed until the token expires. Furthermore it is possible to enable an api key interceptor proxying the request to an api key service which returns the temporary bearer token. It plays well with the [hapi.js][hapijs]-integrated [authentication/authorization feature][hapi-route-options]. Besides the authentication strategy it is possible to validate tokens by yourself, e.g. to authenticate incoming websocket or queue messages, and to register/use multiple strategies via [jscheffner/hapi-auth-any](https://github.com/jscheffner/hapi-auth-any).
2020

2121
The modules [`standard`][standardjs] and [`ava`][avajs] are used to grant a high quality implementation.
2222

@@ -276,6 +276,10 @@ In case of multiple registered strategies for this scheme:
276276
- Use at least a different `name` option in each strategy.
277277
- `server.kjwt.validate` requires `name` as second argument
278278

279+
**Attention**
280+
- Needs a custom scheme when multiple strategies are used on single routes. Check [jscheffner/hapi-auth-any](https://github.com/jscheffner/hapi-auth-any).
281+
282+
279283
## Developing and Testing
280284
First you have to install all dependencies:
281285
```

0 commit comments

Comments
 (0)