스프링 부트 백엔드 개발 강좌, OAuth2로 로그인 로그아웃 구현, OAuth2 서비스 구현하기

오늘 강좌에서는 스프링 부트를 사용하여 OAuth2를 기반으로 한 로그인 및 로그아웃 기능을 어떻게 구현하는지에 대해 자세히 알아보겠습니다. OAuth2는 대표적인 인증 프로토콜로, 외부 서비스와의 통합을 통해 효율적이고 안전한 인증을 가능하게 합니다. 이 글을 통해 실질적인 예제와 함께 스프링 부트에서 어떻게 OAuth2 서비스를 구현할 수 있는지를 단계별로 설명하겠습니다.

1. OAuth2란 무엇인가?

OAuth2는 자원 소유자가 아닌 제3의 애플리케이션이 자원 소유자의 자원에 접근할 수 있도록 하는 프로토콜입니다. 이를 통해 사용자는 비밀번호를 공유할 필요 없이 애플리케이션에 접근할 수 있습니다. OAuth2는 두 가지 주요 역할을 가지고 있습니다:

  • 자원 소유자 (Resource Owner): 보통 사용자를 의미하며, 자신의 데이터를 제3의 서비스에 제공할 권한을 부여합니다.
  • 클라이언트 (Client): 사용자의 데이터를 요청하는 애플리케이션입니다.

1.1 OAuth2의 주요 구성 요소

  • Authorization Server: 사용자 인증 및 권한 부여를 처리하는 서버입니다.
  • Resource Server: 보호된 자원(예: API)을 제공하는 서버입니다.
  • Client Credentials: 애플리케이션을 식별하는 정보를 담고 있습니다.
  • Access Token: 자원 서버에 대한 접근 권한을 나타내는 토큰입니다.

2. 스프링 부트 환경 설정

스프링 부트를 사용하여 OAuth2를 설정하기 위해, 먼저 필요한 의존성을 추가해야 합니다. Gradle 또는 Maven을 사용할 수 있습니다. 여기서는 Maven을 기준으로 설명하겠습니다.

2.1 Maven 의존성 추가

pom.xml
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-oauth2-client</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
</dependencies>

2.2 application.properties 설정

OAuth2 클라이언트가 사용할 기본 설정을 application.properties 파일에 추가합니다.

application.properties
spring.security.oauth2.client.registration.google.client-id=YOUR_CLIENT_ID
spring.security.oauth2.client.registration.google.client-secret=YOUR_CLIENT_SECRET
spring.security.oauth2.client.registration.google.redirect-uri={baseUrl}/login/oauth2/code/{registrationId}
spring.security.oauth2.client.registration.google.scope=email,profile
spring.security.oauth2.client.provider.google.authorization-uri=https://accounts.google.com/o/oauth2/auth
spring.security.oauth2.client.provider.google.token-uri=https://oauth2.googleapis.com/token
spring.security.oauth2.client.provider.google.user-info-uri=https://www.googleapis.com/oauth2/v3/userinfo
spring.security.oauth2.client.provider.google.user-name-attribute=sub

주의: 위의 YOUR_CLIENT_ID 및 YOUR_CLIENT_SECRET는 Google Developer Console에서 생성한 OAuth 2.0 클라이언트의 자격 증명을 입력해야 합니다.

3. OAuth2 로그인/로그아웃 구현

이제 OAuth2를 적용할 수 있는 기본 설정이 완료되었습니다. 다음 단계로, 로그인 및 로그아웃 기능을 구현하겠습니다.

3.1 Security Configuration

스프링 시큐리티를 사용하여 웹 애플리케이션에 대한 보안 설정을 구성합니다. 다음 코드를 SecurityConfig.java 클래스에 추가합니다:

SecurityConfig.java
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/login", "/css/**", "/js/**").permitAll()
                .anyRequest().authenticated()
            .and()
            .logout()
                .logoutSuccessUrl("/")
                .permitAll()
            .and()
            .oauth2Login();
    }
}

3.2 로그인 페이지 구현

로그인 페이지를 만들기 위해 login.html 파일을 생성하고 다음 내용을 추가합니다:

login.html
<!DOCTYPE html>
<html lang="ko">
<head>
    <meta charset="UTF-8">
    <title>로그인</title>
</head>
<body>
    <h1>로그인 페이지</h1>
    <a href="/oauth2/authorization/google">Google로 로그인</a>
</body>
</html>

3.3 사용자 정보 처리

로그인 후 사용자의 정보를 처리하는 방법을 알아보겠습니다. OAuth2UserService를 구현하여 사용자 정보를 가져올 수 있습니다.

CustomOAuth2UserService.java
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest;
import org.springframework.security.oauth2.client.userinfo.OAuth2UserService;
import org.springframework.security.oauth2.core.OAuth2AuthenticationException;
import org.springframework.security.oauth2.core.user.OAuth2User;
import org.springframework.stereotype.Service;

@Service
public class CustomOAuth2UserService implements OAuth2UserService<OAuth2UserRequest, OAuth2User> {

    @Override
    public OAuth2User loadUser(OAuth2UserRequest userRequest) throws OAuth2AuthenticationException {
        // 사용자 정보 처리
        // 예를 들어, 사용자 정보를 데이터베이스에 저장하거나 세션에 추가
    }
}

4. OAuth2 로그아웃 구현

로그아웃 기능은 스프링 시큐리티의 기본 제공 기능으로 쉽게 구현할 수 있습니다. SecurityConfig 클래스에서 로그아웃 성공 후 리다이렉션할 URL을 설정하였으므로, 로그아웃 버튼을 추가하면 됩니다.

4.1 로그아웃 버튼 추가

메인 페이지에 로그아웃 버튼을 추가하여 사용자가 로그아웃할 수 있도록 합니다. 대략적인 HTML 코드는 다음과 같습니다:

index.html
<!DOCTYPE html>
<html lang="ko">
<head>
    <meta charset="UTF-8">
    <title>홈 페이지</title>
</head>
<body>
    <h1>환영합니다!</h1>
    <a href="/logout">로그아웃</a>
</body>
</html>

5. 결론

오늘 강좌에서는 스프링 부트를 사용하여 OAuth2를 통한 로그인 및 로그아웃 기능을 구현하는 방법에 대해 알아보았습니다. OAuth2는 외부 서비스를 활용하여 사용자 인증을 보다 쉽고 안전하게 처리할 수 있는 유용한 방법입니다. 이번 강좌를 통해 스프링 부트와 OAuth2 설정 과정을 이해하고, 실질적인 구현 방법을 익혔기를 바랍니다.

5.1 추가 리소스

더욱 깊이 있는 내용을 원하신다면 아래의 리소스를 참고하시기 바랍니다: