Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 1, 2024
1 parent d9b5c04 commit 7d5068a
Show file tree
Hide file tree
Showing 18 changed files with 54 additions and 13 deletions.
4 changes: 2 additions & 2 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54886,7 +54886,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_PROVIDER+++`
endif::add-copy-button-to-env-var[]
--
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `slack`, `spotify`, `strava`, `twitch`, `twitter`, `x`
|

a| [[quarkus-oidc_quarkus-oidc-token-cache-max-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-max-size[`quarkus.oidc.token-cache.max-size`]##
Expand Down Expand Up @@ -57400,7 +57400,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC__TENANT__PROVIDER+++`
endif::add-copy-button-to-env-var[]
--
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `slack`, `spotify`, `strava`, `twitch`, `twitter`, `x`
|


Expand Down
4 changes: 2 additions & 2 deletions _generated-doc/main/config/quarkus-oidc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_PROVIDER+++`
endif::add-copy-button-to-env-var[]
--
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `slack`, `spotify`, `strava`, `twitch`, `twitter`, `x`
|

a| [[quarkus-oidc_quarkus-oidc-token-cache-max-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-max-size[`quarkus.oidc.token-cache.max-size`]##
Expand Down Expand Up @@ -5045,7 +5045,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC__TENANT__PROVIDER+++`
endif::add-copy-button-to-env-var[]
--
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `slack`, `spotify`, `strava`, `twitch`, `twitter`, `x`
|


Expand Down
4 changes: 2 additions & 2 deletions _generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_PROVIDER+++`
endif::add-copy-button-to-env-var[]
--
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `slack`, `spotify`, `strava`, `twitch`, `twitter`, `x`
|

a| [[quarkus-oidc_quarkus-oidc-token-cache-max-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-max-size[`quarkus.oidc.token-cache.max-size`]##
Expand Down Expand Up @@ -5045,7 +5045,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC__TENANT__PROVIDER+++`
endif::add-copy-button-to-env-var[]
--
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x`
a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `slack`, `spotify`, `strava`, `twitch`, `twitter`, `x`
|


Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/_attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
:quarkus-blob-url: https://github.com/quarkusio/quarkus/blob/main
:quarkus-tree-url: https://github.com/quarkusio/quarkus/tree/main
:quarkus-issues-url: https://github.com/quarkusio/quarkus/issues
:quarkus-images-url: https://github.com/quarkusio/quarkus-images/tree
:quarkus-images-url: https://github.com/quarkusio/quarkus-images
:quarkus-chat-url: https://quarkusio.zulipchat.com
:quarkus-mailing-list-subscription-email: [email protected]
:quarkus-mailing-list-index: https://groups.google.com/d/forum/quarkus-dev
Expand Down
4 changes: 4 additions & 0 deletions _versions/main/guides/getting-started-reactive.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,10 @@ Create the `src/main/java/org/acme/hibernate/orm/panache/FruitResource.java` fil
----
package org.acme.hibernate.orm.panache;
import java.util.List;
import io.quarkus.panache.common.Sort;
import io.smallrye.mutiny.Uni;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.ws.rs.Path;
Expand Down
Binary file modified _versions/main/guides/images/oidc-facebook-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _versions/main/guides/images/oidc-facebook-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _versions/main/guides/images/oidc-facebook-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _versions/main/guides/images/oidc-facebook-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _versions/main/guides/images/oidc-facebook-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _versions/main/guides/images/oidc-facebook-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _versions/main/guides/images/oidc-slack-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _versions/main/guides/images/oidc-slack-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _versions/main/guides/images/oidc-slack-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _versions/main/guides/images/oidc-slack-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _versions/main/guides/images/oidc-slack-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -1275,7 +1275,7 @@ public interface ProtectedResourceService {

Additionally, `AccessTokenRequestReactiveFilter` can support a complex application that needs to exchange the tokens before propagating them.

If you work with link:https://www.keycloak.org/docs/latest/securing_apps/#_token-exchange[Keycloak] or another OIDC provider that supports a link:https://tools.ietf.org/html/rfc8693[Token Exchange] token grant, then you can configure `AccessTokenRequestReactiveFilter` to exchange the token like this:
If you work with link:https://www.keycloak.org/securing-apps/token-exchange[Keycloak] or another OIDC provider that supports a link:https://tools.ietf.org/html/rfc8693[Token Exchange] token grant, then you can configure `AccessTokenRequestReactiveFilter` to exchange the token like this:

[source,properties]
----
Expand Down Expand Up @@ -1369,7 +1369,7 @@ Alternatively, `AccessTokenRequestFilter` can be registered automatically with a

==== Exchange token before propagation

If the current access token needs to be exchanged before propagation and you work with link:https://www.keycloak.org/docs/latest/securing_apps/#_token-exchange[Keycloak] or other OpenID Connect Provider which supports a link:https://tools.ietf.org/html/rfc8693[Token Exchange] token grant, then you can configure `AccessTokenRequestFilter` like this:
If the current access token needs to be exchanged before propagation and you work with link:https://www.keycloak.org/securing-apps/token-exchange[Keycloak] or other OpenID Connect Provider which supports a link:https://tools.ietf.org/html/rfc8693[Token Exchange] token grant, then you can configure `AccessTokenRequestFilter` like this:

[source,properties]
----
Expand Down
45 changes: 41 additions & 4 deletions _versions/main/guides/security-openid-connect-providers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -165,23 +165,24 @@ Facebook you will not be let you test your application on `localhost` like most
you will need to run it over HTTPS and make it publicly accessible, so for development purposes
you may want to use a service such as https://ngrok.com.

In order to set up OIDC for Facebook start by https://developers.facebook.com/apps/create/[Creating an application], select `None` as an app type, and press `Next`:
In order to set up OIDC for Facebook start by https://developers.facebook.com/apps/create/[Creating an application], select `Other` as an app type, and click `Next`.

image::oidc-facebook-1.png[role="thumb"]

Now enter an application name, and contact email, and press `Create app`:
Now choose your application type. For this guide choose `Consumer` and click `Next` until you reach the screen below. Now enter an application name, and contact email, and press `Create app`:

image::oidc-facebook-2.png[role="thumb"]

On the app page, click `Set up` on the `Facebook login` product:

image::oidc-facebook-3.png[role="thumb"]

Quick the `Quickstarts` page and click on `Facebook login > Settings` on the left menu:
On the `Quickstart` page click on `Facebook login > Settings` on the left menu:

image::oidc-facebook-4.png[role="thumb"]

Enter your `Redirect URIs` (set to `<host>/_renarde/security/oidc-success`) and press `Save changes`:
First click on `Get Advanced Access` to switch `public_profile` to advanced access.
Then enter your `Redirect URIs` (set to `<host>/facebook`) and press `Save changes`:

image::oidc-facebook-5.png[role="thumb"]

Expand Down Expand Up @@ -406,6 +407,42 @@ quarkus.oidc.token.customizer-name=azure-access-token-customizer
====

[[slack]]
=== Slack

Create a https://api.slack.com/authentication/sign-in-with-slack#setup[Slack application]:

image::oidc-slack-1.png[role="thumb"]

Select application name, workspace, and remember it, you will need it later:

image::oidc-slack-2.png[role="thumb"]

Please save client id and secret displayed on the next page, you will need them later:

image::oidc-slack-3.png[role="thumb"]

Configure redirect URLs.
Slack provider requires HTTPS protocol, for development purposes, you can use ngrok:

image::oidc-slack-4.png[role="thumb"]

You can now configure your `application.properties`:

[source,properties]
----
quarkus.oidc.provider=slack
quarkus.oidc.client-id=<Client ID>
quarkus.oidc.credentials.secret=<Client Secret>
quarkus.oidc.authentication.extra-params.team=quarkus-slack <1>
----
<1> Use the `team` parameter to refer to the workspace you chose during the Slack OIDC application registration.

Open your browser and navigate to your application `https://<your ngrok instance>.ngrok-free.app/`.
Quarkus will redirect you to Slack provider on the first request where you can grant required permissions:

image::oidc-slack-5.png[role="thumb"]

[[spotify]]
=== Spotify

Expand Down

0 comments on commit 7d5068a

Please sign in to comment.