快捷導(dǎo)航

如何在Spring?Boot中使用OAuth2認證和授權(quán)

更新時間：2023年12月01日 16:33:49 作者：畢設(shè)徐師兄

這篇文章主要介紹了如何在Spring?Boot中使用OAuth2認證和授權(quán)的相關(guān)資料,OAuth2.0是一種開放的授權(quán)協(xié)議,它允許用戶授權(quán)第三方應(yīng)用訪問其賬戶(或資源),而無需共享其用戶賬戶憑據(jù),需要的朋友可以參考下

前言

OAuth2 是一種授權(quán)協(xié)議，用于授權(quán)第三方應(yīng)用程序訪問受保護的資源。Spring Security 是一個強大的安全框架，支持 OAuth2 協(xié)議。在本文中，我們將介紹如何在 Spring Boot 中使用 Spring Security 實現(xiàn) OAuth2 認證和授權(quán)。

什么是 OAuth2

OAuth2 是一種流行的授權(quán)協(xié)議，用于授權(quán)第三方應(yīng)用程序訪問受保護的資源。OAuth2 協(xié)議定義了四種角色：資源所有者、客戶端、授權(quán)服務(wù)器和資源服務(wù)器。資源所有者是資源的擁有者，客戶端是請求訪問資源的應(yīng)用程序，授權(quán)服務(wù)器是授權(quán)客戶端訪問資源的服務(wù)器，資源服務(wù)器是托管受保護資源的服務(wù)器。

OAuth2 協(xié)議涉及以下幾個步驟：

客戶端向授權(quán)服務(wù)器發(fā)送請求，請求授權(quán)訪問某個資源。
授權(quán)服務(wù)器向資源所有者詢問是否授權(quán)客戶端訪問該資源。
如果資源所有者授權(quán)客戶端訪問該資源，則授權(quán)服務(wù)器向客戶端頒發(fā)訪問令牌。
客戶端使用訪問令牌向資源服務(wù)器請求訪問受保護的資源。

OAuth2 協(xié)議定義了多種授權(quán)方式，包括授權(quán)碼模式、隱式授權(quán)模式、密碼模式和客戶端憑證模式。每種授權(quán)方式都適用于不同的場景。

Spring Security OAuth2

Spring Security 是一個強大的安全框架，支持 OAuth2 協(xié)議。Spring Security OAuth2 提供了一組類和接口，用于實現(xiàn) OAuth2 認證和授權(quán)。Spring Security OAuth2 支持多種授權(quán)方式，包括授權(quán)碼模式、隱式授權(quán)模式、密碼模式和客戶端憑證模式。

Spring Boot 中使用 OAuth2

在 Spring Boot 中使用 OAuth2，我們需要添加以下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.security.oauth.boot</groupId>
    <artifactId>spring-security-oauth2-autoconfigure</artifactId>
</dependency>

Spring Boot 會自動配置 Spring Security 和 Spring Security OAuth2。

為了使用 OAuth2，我們需要定義以下三個組件：

授權(quán)服務(wù)器：用于頒發(fā)訪問令牌。
資源服務(wù)器：用于托管受保護的資源。
客戶端：用于請求訪問受保護的資源。

配置授權(quán)服務(wù)器

我們可以使用 @EnableAuthorizationServer 注解來啟用授權(quán)服務(wù)器。以下是一個示例配置：

@Configuration
@EnableAuthorizationServer
public class AuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {

    @Autowired
    private AuthenticationManager authenticationManager;

    @Autowired
    private UserDetailsService userDetailsService;

    @Bean
    public TokenStore tokenStore() {
        return new InMemoryTokenStore();
    }

    @Bean
    public DefaultTokenServices tokenServices() {
        DefaultTokenServices tokenServices = new DefaultTokenServices();
        tokenServices.setTokenStore(tokenStore());
        tokenServices.setSupportRefreshToken(true);
        tokenServices.setAccessTokenValiditySeconds(60 * 60);
        tokenServices.setRefreshTokenValiditySeconds(60 * 60 * 24);
        return tokenServices;
    }

    @Override
    public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
        clients.inMemory()
                .withClient("client")
                .secret("secret")
                .authorizedGrantTypes("password", "refresh_token")
                .scopes("read", "write")
                .accessTokenValiditySeconds(60 * 60)
                .refreshTokenValiditySeconds(60 * 60 * 24);
    }

    @Override
    public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
        endpoints.tokenStore(tokenStore())
                .tokenServices(tokenServices())
                .authenticationManager(authenticationManager)
                .userDetailsService(userDetailsService);
    }
}

在這個示例中，我們創(chuàng)建了一個 AuthorizationServerConfig 類，并使用 @EnableAuthorizationServer注解來啟用授權(quán)服務(wù)器。我們注入了 AuthenticationManager 和 UserDetailsService 對象，并定義了一個 InMemoryTokenStore 對象來存儲訪問令牌。

我們使用 configure 方法來配置客戶端詳細信息。在這個示例中，我們定義了一個名為 “client” 的客戶端，使用密碼模式和刷新令牌模式來授權(quán)訪問資源。我們還定義了 read 和 write 兩個范圍，并設(shè)置訪問令牌的有效期和刷新令牌的有效期。

我們使用 configure 方法來配置授權(quán)服務(wù)器的端點。在這個示例中，我們使用 tokenStore、tokenServices、authenticationManager 和 userDetailsService 屬性來配置授權(quán)服務(wù)器的端點。

配置資源服務(wù)器

我們可以使用 @EnableResourceServer 注解來啟用資源服務(wù)器。以下是一個示例配置：

@Configuration
@EnableResourceServer
public class ResourceServerConfig extends ResourceServerConfigurerAdapter {

    @Override
    public void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/api/**").authenticated()
                .anyRequest().permitAll();
    }
}

在這個示例中，我們創(chuàng)建了一個 ResourceServerConfig 類，并使用 @EnableResourceServer 注解來啟用資源服務(wù)器。我們使用 configure 方法來配置資源服務(wù)器的安全性。在這個示例中，我們配置了 /api/** 路徑需要身份驗證，其他路徑允許匿名訪問。

配置客戶端

我們可以使用 @EnableOAuth2Client 注解來啟用 OAuth2 客戶端。以下是一個示例配置：

@Configuration
@EnableOAuth2Client
public class OAuth2ClientConfig {

    @Bean
    public OAuth2ProtectedResourceDetails clientCredentialsResourceDetails() {
        ClientCredentialsResourceDetails details = new ClientCredentialsResourceDetails();
        details.setAccessTokenUri("http://localhost:8080/oauth/token");
        details.setClientId("client");
        details.setClientSecret("secret");
        details.setGrantType("client_credentials");
        details.setScope(Arrays.asList("read", "write"));
        return details;
    }

    @Bean
    public RestTemplate restTemplate(OAuth2ClientContext oauth2ClientContext) {
        return new OAuth2RestTemplate(clientCredentialsResourceDetails(), oauth2ClientContext);
    }
}

在這個示例中，我們創(chuàng)建了一個 OAuth2ClientConfig 類，并使用 @EnableOAuth2Client 注解來啟用 OAuth2 客戶端。我們定義了一個 OAuth2ProtectedResourceDetails 對象，用于配置客戶端詳細信息。我們設(shè)置了訪問令牌的 URI、客戶端 ID、客戶端密碼、授權(quán)類型、范圍等屬性。

我們還定義了一個 RestTemplate 對象，并使用 OAuth2RestTemplate 類來包裝它。OAuth2RestTemplate 類會自動處理 OAuth2 認證，并在每個請求中包含訪問令牌。

測試 OAuth2

我們可以使用以下代碼測試 OAuth2：

@RestController
@RequestMapping("/api")
public class ApiController {

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/hello")
    public String hello() {
        ResponseEntity<String> response = restTemplate.getForEntity("http://localhost:8080/hello", String.class);
        return response.getBody();
    }
}

在這個示例中，我們創(chuàng)建了一個 ApiController 類，并定義了一個 hello 方法。在 hello 方法中，我們使用 RestTemplate 對象發(fā)送 GET 請求，并訪問受保護的資源。RestTemplate 對象會自動處理 OAuth2 認證。

總結(jié)

在本文中，我們介紹了如何在 Spring Boot 中使用 OAuth2。我們使用 Spring Security OAuth2 實現(xiàn)了授權(quán)服務(wù)器、資源服務(wù)器和客戶端，并使用 @EnableAuthorizationServer、@EnableResourceServer 和 @EnableOAuth2Client 注解來啟用它們。希望本文可以幫助你了解如何在 Spring Boot 中使用 OAuth2。

到此這篇關(guān)于如何在Spring Boot中使用OAuth2認證和授權(quán)的文章就介紹到這了,更多相關(guān)SpringBoot OAuth2認證和授權(quán)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: