Skip to main content
Version: 2.5.0

OAuth2 Plugin

Description#

  • The OAuth2 plugin is implemented using Webflux OAuth2, used to support OAuth protocol.

Plugin Setting#

Please refer to the deployment document, choose a way to start shenyu-admin. For example, Local Deployment.

  • In shenyu-admin BasicConfig --> plugin -> oauth2 set to enable. If you don't want to use this function, please disable this plugin in the shenyu-admin.

  • Add configuration mode in plugin editing.

Plugin Use#

  • Add support for oauth2 to the pom file of the gateway
  <!-- apache shenyu oauth2 plugin start-->  <dependency>      <groupId>org.apache.shenyu</groupId>      <artifactId>shenyu-spring-boot-starter-plugin-oauth2</artifactId>      <version>${project.version}</version>  </dependency>  <!-- apache shenyu oauth2 plugin end-->
  • Configuration oauth2 at shenyu-bootstrap

spring: security:   oauth2:     client:       registration:         <your client-registration-id>:           client-id: <your client-id>           client-secret: <your client-secret>           # the next part is authorize server‘s config       provider:         <your client-registration-id>:           authorization-uri: <your authorization-uri>           token-uri: <your access-token-uri>           user-info-uri: <your user-info-uri>           jwk-set-uri: <your jwk-set-uri>
  • Configure the relevant configuration of spring.security.oauth2 in the configuration file of the gateway. For detailed configuration instructions, please refer to Spring Webflux OAuth2
  • Configure the selector and rule as the request address that you need OAuth2 authorization, and release all requests by default. For more instructions on selector and rule configuration, please refer to: Selector And Rule Config.