-
Notifications
You must be signed in to change notification settings - Fork 240
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
36 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Authentication Configuration | ||
|
||
This extension allows to secure a set of APIs grouped by a web context. It inspects | ||
all `web.http.<context>` and if the authentication is configured it applies the `AuthenticationRequestFilter` | ||
to the `<context>` with the chosen `AuthenticationService`. The chosen `AuthenticationService` is currently registered | ||
in the `ApiAuthenticationRegistry`. This will be removed once the `ApiAuthenticationRegistry` will be refactored out. | ||
|
||
## Configuration | ||
|
||
| Key | Description | Mandatory | | ||
|:--------------------------------|:-------------------------------------------------------------------------------------------|-----------| | ||
| web.http.<context>.auth.type | The type of authentication to apply to the `<context>` | | | ||
| web.http.<context>.auth.context | Override the name of the context in the `ApiAuthenticationRegistry` instead of `<context>` | | | ||
|
||
Depending on the `web.http.<context>.auth.type` chosen, additional properties might be required in order to configure | ||
the `AuthenticationService`. | ||
|
||
Example of a complete configuration for a custom context with token based authentication | ||
|
||
```properties | ||
web.http.custom.path=/custom | ||
web.http.custom.port=8081 | ||
web.http.custom.auth.type=tokenbased | ||
web.http.custom.auth.key=apiKey | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters