Skip to content

Commit

Permalink
Add links in documentation to relevant security guides. (#1512)
Browse files Browse the repository at this point in the history
* Add links to guides for JWT/JWK, OAuth and LDAP.

* Add links to guides for session auth.

* Add links to guides for Client Credentials Flow.
  • Loading branch information
wetted authored Dec 3, 2023
1 parent 09657b0 commit 4edc554
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Read the following guides to learn more about JSON Web Token and JSON Web Keys:

- https://guides.micronaut.io/latest/micronaut-cli-jwkgen.html[JWK generation with a micronaut command line application]
- https://guides.micronaut.io/latest/micronaut-security-keys-jwks.html[JWK keys endpoint]
- https://guides.micronaut.io/latest/micronaut-security-jwt.html[Micronaut JWT authentication]
- https://guides.micronaut.io/latest/micronaut-security-jwt-cookie.html[Micronaut JWT authentication via cookies]
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,5 @@ public class MyContextBuilder implements ContextBuilder {
}
----

TIP: Read https://guides.micronaut.io/latest/micronaut-database-authentication-provider.html[LDAP and database authentication providers] to learn more about LDAP Authentication:
5 changes: 4 additions & 1 deletion src/main/docs/guide/authenticationStrategies/session.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ Check the <<redirection, Redirection configuration>> to customize session based
include::{testsuitegeb}/security/session/SessionAuthenticationSpec.groovy[tag=yamlconfig,indent=0]
----

TIP: Read the https://guides.micronaut.io/latest/micronaut-security-session.html[Session-Based Authentication Micronaut Guide] to learn more.
Read the following guides to learn more abut session based authentication:

- https://guides.micronaut.io/latest/micronaut-security-session.html[Session-Based Authentication Micronaut Guide]
- https://guides.micronaut.io/latest/micronaut-security-session-database-authentication.html[Database Authentication]

== Session-based authentication without redirection

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Read the following guides to learn more abut Client Credentials Flow:

- https://guides.micronaut.io/latest/micronaut-oauth2-client-credentials-auth0.html[Client Credentials Flow with Micronaut and Auth0]
- https://guides.micronaut.io/latest/micronaut-oauth2-client-credentials-cognito.html[Client Credentials Flow with Micronaut and Amazon Cognito]
9 changes: 9 additions & 0 deletions src/main/docs/guide/oauth/oauthGuides.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Read the following guides to learn more abut OAuth:

- https://guides.micronaut.io/latest/micronaut-oauth2-auth0.html[Secure a Micronaut application with Auth0]
- https://guides.micronaut.io/latest/micronaut-oauth2-cognito.html[Secure a Micronaut application with Cognito]
- https://guides.micronaut.io/latest/micronaut-oauth2-github.html[Secure a Micronaut application with Github]
- https://guides.micronaut.io/latest/micronaut-oauth2-oidc-google.html[Secure a Micronaut application with Google]
- https://guides.micronaut.io/latest/micronaut-oauth2-keycloak.html[Secure a Micronaut application with Keycloak]
- https://guides.micronaut.io/latest/micronaut-oauth2-linkedin.html[Secure a Micronaut application with LinkedIn]
- https://guides.micronaut.io/latest/micronaut-oauth2-okta.html[Secure a Micronaut application with Okta]
3 changes: 3 additions & 0 deletions src/main/docs/guide/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ authenticationStrategies:
claimsValidation: Claims Validation
render:
title: Token Render
jwtGuides: Guides
ldap:
title: LDAP Authentication
configuration: Configuration
Expand Down Expand Up @@ -99,6 +100,7 @@ oauth:
clientcredentials:
title: Client Credentials
clientecredentialshttpclient: HTTP Client Filter for Client Credentials
clientCredentialGuides: Guides
password: Password
oauth-endpoints:
title: Endpoints
Expand All @@ -107,6 +109,7 @@ oauth:
revocation: Revocation
user-info: OpenID User Info
custom-client: Custom Clients
oauthGuides: Guides
aot:
title: Ahead-of-time optimizations
aotConfiguration: Micronaut Security AOT Configuration
Expand Down

0 comments on commit 4edc554

Please sign in to comment.