-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Recomposing security overview content to diataxis
Recomposing security overview content to diataxis Addressed Sergey's review comments Further enhancements fix typos grammar Fixed broken links after recomposing to diataxis Fixed headings More link fixes Fix mTLS case
- Loading branch information
1 parent
bdeb0bb
commit cd1451c
Showing
18 changed files
with
442 additions
and
600 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,42 @@ | ||
//// | ||
This document is maintained in the main Quarkus repository | ||
and pull requests should be submitted there: | ||
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc | ||
//// | ||
[id="security-architecture-concept"] | ||
= Quarkus Security architecture | ||
include::_attributes.adoc[] | ||
:categories: security | ||
The Quarkus Security architecture provides several built-in authentication mechanisms. The `HttpAuthenticationMechanism` interface is the main entry mechanism for securing HTTP applications in Quarkus. Quarkus Security is also highly customizable. | ||
|
||
== Core components of Quarkus Security | ||
|
||
Quarkus Security uses `HttpAuthenticationMechanism` to extract the authentication credentials from the HTTP request and delegates them to `IdentityProvider` to convert the credentials to `SecurityIdentity`. | ||
For example, the credentials can come from the `Authorization` header, client HTTPS certificates, or cookies. | ||
|
||
`IdentityProvider` verifies the authentication credentials and maps them to `SecurityIdentity`, which has the username, roles, original authentication credentials, and other attributes. | ||
|
||
For every authenticated resource, you can inject a `SecurityIdentity` instance to get the authenticated identity information. | ||
|
||
In other contexts, it is possible to have other parallel representations of the same information or parts of it, for example, `SecurityContext` for JAX-RS or `JsonWebToken` for JSON Web Tokens (JWT). | ||
|
||
For more information, see xref:security-identity-providers-concept.adoc[Identity providers]. | ||
|
||
== Supported authentication mechanisms | ||
|
||
To learn more about security authentication in Quarkus and the supported mechanisms and protocols, see xref:security-authentication-mechanisms-concept.adoc[Authentication mechanisms in Quarkus]. | ||
|
||
== Proactive authentication | ||
|
||
Proactive authentication is enabled in Quarkus by default. This means that if an incoming request has a credential then that request will always be authenticated, even if the target page does not require authentication. | ||
For more information, see xref:security-proactive-authentication-concept.adoc[Proactive authentication]. | ||
|
||
== Quarkus Security customization | ||
|
||
Quarkus Security is also highly customizable. You can customize the following core security components of Quarkus: | ||
|
||
* `HttpAuthenticationMechanism` | ||
* `IdentityProvider` | ||
* `SecurityidentityAugmentor` | ||
|
||
For more information about customizing Quarkus Security including reactive security and how to register a security provider, see xref:security-customization.adoc[Security customization]. |
198 changes: 164 additions & 34 deletions
198
docs/src/main/asciidoc/security-authentication-mechanisms-concept.adoc
Large diffs are not rendered by default.
Oops, something went wrong.
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
2 changes: 1 addition & 1 deletion
2
docs/src/main/asciidoc/security-basic-authentication-concept.adoc
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
256 changes: 0 additions & 256 deletions
256
docs/src/main/asciidoc/security-built-in-authentication-support-concept.adoc
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.