스프링 부트와 AWS로 혼자 구현하는 웹 서비스[5]

uuuu.jini·2022년 3월 30일
0
post-thumbnail

🐯 05장. 스프링 시큐리티와 OAuth 2.0으로 로그인 기능 구현하기 🐯

  1. 스프링 시큐리티와 스프링 시큐리티 Oauth2 클라이언트
  2. 구글 서비스 등록
  3. 구글 로그인 연동
  4. 어노테이션 기반 개선
  5. 세션 저장소로 데이터베이스 사용
  6. 네이버 로그인
  7. 기존 테스트에 시큐리티 적용

스프링 시큐리티는 인증과 인가(권한 부여) 기능을 가진 프레임워크이다. 스프링 기반의 애플리케이션에서 보안을 위한 표준이라고 보면 된다. 확장성을 고려한 프레임워크로 다양한 요구사항을 손쉽게 추가하고 변경할 수 있다.


1. 스프링 시큐리티와 스프링 시큐리티 Oauth2 클라이언트

많은 서비스에서 로그인 기능을 id/password방식 보다는 구글, 페이스북,네이버 로그인과 같은 소셜 로그인 기능을 사용한다. 많은 서비스에서 소셜 로그인을 사용하는 이유는 직접 구현할 경우 많은 기능(로그인시 보안, 회원가입시 이메일 혹은 전화번호 인증, 비밀번호 찾기/변경 등)을 직접 구현해주어야 하는데 이를 모두 구글,페이스북,네이버 등에 맡기면 되므로 서비스 개발에 집중할 수 있기 때문이다.


2. 구글 서비스 등록

먼저 구글 서비스에 신규 서비스를 생성한다. 여기서 발급된 인증 정보(cliendID/clientSecret)을 통해서 로그인 기능과 소셜 서비스 기능을 사용할 수 있으므로 무조건 발급받고 시작해야 한다.

구글 클라우드 플랫폼 주소(console.cloud.google.com)으로 이동한다. [프로젝트 선택] 탭을 클릭한다. [새 프로젝트]를 클릭하고 등록될 서비스의 이름을 입력한다. (원하는 이름 )

생성이 완료된 프로젝트를 선택하고 왼쪽 메뉴 탭을 클릭해서 API 및 서비스 카테고리로 이동한다. [사용자 인증 정보]를 클릭하고 [사용자 인증 정보 만들기]버튼을 클릭한다.

사용자 인증 정보에는 여러 메뉴가 있는데 이 중 구현할 소셜 로그인은 OAuth 클라이언트 ID로 구현한다. [OAuth 클라이언트 ID]항목을 클릭한다. > [동의 화면 구성] 버튼을 클릭한다.

OAuth 동의 화면 에서 애플리케이션 이름 (구글 로그인시 사용자에게 노출될 애플리케이션 이름을 이야기한다. ) 지원 이메일 ( 사용자 동의 화면에서 노출될 이메일 주소이다. 보통은 서비스 help이메일주소를 사용한다.) Google API 의 범위 (이번에 등록할 구글 서비스에서 사용할 범위목록이다. 기본값은 email/profile/openid이며, 다른 정보를 사용하고 싶으면 범위 추가 버튼으로 추가하면 된다. )

OAuth 클라이언트 ID 만들기

애플리케이션 유형을 웹 애플리케이션으로 해주고 승인된 리디렉션 URI를 지정해야 한다.

승인된 리디렉션 URI는 서비스에서 파라미터로 인증 정보를 주었을 때 인증이 성공하면 구글에서 리다이렉트할 URL이다. 스프링 부트 2 버전의 시큐리티에서는 기본적으로 {도메인}/login/oauth2/code{소셜서비스코드}로 리다이렉트 URL을 지원한다.

생성 버튼을 클릭하면 생성된 클라이언트 정보를 볼 수 있고 생성된 애플리케이션을 클릭하면 인증 정보를 볼 수 있다. 클라이언트 ID와 클라이언트 보안 비밀 코드를 프로젝트에서 설정한다.

application-oauth 등록

application.properties가 있는 src/main/resources/ 디렉토리에 application-oauth.properties 파일을 생성한다.

해당 클라이언트 ID와 클라이언트 보안 비밀 코드를 등록한다.

spring.security.oauth2.client.registration.google.client-id=클라이언트ID
spring.security.oauth2.client.registration.google.client-secret = 클라이언트 보안 비밀
spring.security.oauth2.client.registration.google.scope=profile,email

스프링 부트에서는 properties의 이름을 application-xxx.properties로 만들면 xxx라는 이름의 profile이 생성되어 이를 통해 관리할 수 있다. 즉, profile=xxx라는 식으로 호출하면 해당 properties의 설정들을 가져 올 수 있다.

application.properties에서 application-oauth.properties를 포함하도록 구성한다. application.properties에 밑의 코드를 추가한다.

spring.profiles.include = oauth

.gitignore 등록

구글 로그인을 위한 클라이언트 ID와 클라이언트 보안 비밀은 보안이 중요한 정보들이기 때문에 깃허브에 올라가지 않도록 관리해야 하므로 .gitignore에 밑의 코드를 등록한다.

application-oauth.properties

3. 구글 로그인 연동하기

사용자 정보를 담당할 도메인인 User 클래스를 생성한다. 패키지 domain아래에 user 패키지를 생성한다.

User 클래스


@Getter
@NoArgsConstructor
@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @Column(nullable = false)
    private String name;
    
    @Column(nullable = false)
    private String email;
    
    @Column
    private String picture;
    
    @Enumerated(EnumType.STRING)
    @Column(nullable = false)
    private Role role;
    
    @Builder
    public User(String name,String email,String picture,Role role){
        this.name = name;
        this.email = email;
        this.picture = picture;
        this.role = role;
    }
    
    public User update(String name,String picture){
        this.name = name;
        this.picture = picture;
        
        return this;
    }
    
    public String getRoleKey(){
        return this.role.getKey();
    }
    
    
}
  • @Enumerated(EnumType.STRING) : JPA에 데이터베이스로 저장할 때 Enum 값을 어떤 형태로 저장할지를 결정한다. 기본적으로는 int로 된 숫자가 저장된다. 숫자로 저장되면 그 값이 무슨 코드를 의미하는지 알 수 없으므로 문자열(EnumType.STRING)로 저장될 수 있도록 선언한다.

Role enum 클래스

각 사용자의 권한을 관리할 Enum 클래스 Role을 생성한다.

@Getter
@RequiredArgsConstructor
public enum Role {
    GUEST("ROLE_GUEST","손님"),
    USER("ROLE_USER","일반 사용자");
    
    private final String key;
    private final String title;
}

스프링 시큐리티에서는 권한 코드에 항상 ROLE_이 앞에 있어야만 한다. 그래서 코드별 키값을 ROLE_GUEST,ROLE_USER등으로 지정한다.

UserRepository 인터페이스

user의 CRUD를 책임진다.

public interface UserRepository extends JpaRepository<User,Long> {
    Optional<User> findByEmail(String email);
}
  • findByEmail : 소셜 로그인으로 반환되는 값 중 email을 통해 이미 생성된 사용자인지 처음 가입하는 사용자인지 판단하기 위한 메서드이다.

Optional<T> : null이 올 수 있는 값을 감싸는 Wrapper클래스로 참조하더라도 NullPointerException이 발생하지 않도록 도와준다.

스프링 시큐리티 설정

build.gradle에 스프링 시큐리티 관련 의존성을 추가한다.

compile('org.springframework.boot:spring-boot-starter-oauth2-client')

소셜 로그인 등 클라이언트 입장에서 소셜 기능 구현시 필요한 의존성이다.

SecurityConfig 클래스

config.auth패키지를 생성한다. (시큐리티 관련 클래스를 담을 곳 )

@RequiredArgsConstructor
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    
    private final CustomOAuth2UserService customOAuth2UserService;

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
                .csrf().disable()
                .headers().frameOptions().disable()
                .and()
                .authorizeRequests()
                .antMatchers("/","/css/**","/images/**","/js/**","/h2-console").permitAll()
                .antMatchers("/api/v1/**").hasRole(Role.USER.name())
                .anyRequest().authenticated()
                .and()
                .logout()
                .logoutSuccessUrl("/")
                .and()
                .oauth2Login()
                .userInfoEndpoint()
                .userService(customOAuth2UserService);
    }
}
  • @EnableWebSecurity : Spring Security 설정 활성화
  • csrf().disable().headers().frameOptions().disable() : h2-console화면을 사용하기 위해 해당 옵션들을 disable
  • authorizeRequests : URL 별 권한 관리를 설정하는 옵션의 시작점. authorizeRequests가 선언되어야만 antMatchers옵션을 사용할 수 있다.
  • antMatchers : 권한 관리 대상을 지정하는 옵션. URL,HTTP 메소드 별로 관리가 가능하다. "/" 등 지정된 URL들은 permitAll()옵션을 통해 전체 열람 권한을 주었다. "/api/v1/**" 주소를 가진 API는 USER권한을 가진 사람만 가능하도록 하였다.
  • anyRequest : 설정된 값들 이외 나머지 URL들을 나타낸다. 여기서는 authenticated()를 추가하여 나머지 URL들은 모두 인증된 사용자들에게만 허용한다. ( 로그인한 사용자 )
  • logout().logoutSuccessUrl("/") : 로그아웃 기능에 대한 여러 설정의 진입점이다. 로그아웃 성공시 /주소로 이동
  • oauth2Login() : oAuth2 로그인 기능에 대한 여러 설정의 진입점이다.
  • userInfoEndpoint : OAuth2 로그인 성공 이후 사용자 정보를 가져올 떄의 설정들을 담당한다.
  • userService : 소셜 로그인 성공 시 후속 조치를 진행할 UserService 인터페이스의 구현체를 등록한다. 리소스 서버(소셜 서비스)에서 사용자 정보를 가져온 상태에서 추가로 진행하고자 하는 기능을 명시할 수 있다.

CustomOAuth2UserService 클래스

구글 로그인 이후 가져온 사용자의 정보(email,name,picture)들을 기반으로 가입 및 정보수정, 세션 저장 등의 기능을 지원한다.


@Service
@RequiredArgsConstructor
public class CustomOAuth2UserService implements OAuth2UserService<OAuth2UserRequest, OAuth2User> {
    private final UserRepository userRepository;
    private final HttpSession httpSession;


    @Override
    public OAuth2User loadUser(OAuth2UserRequest userRequest) throws OAuth2AuthenticationException {
        OAuth2UserService<OAuth2UserRequest,OAuth2User> delegate = new DefaultOAuth2UserService();
        OAuth2User oAuth2User = delegate.loadUser(userRequest);
        
        String registrationId = userRequest.getClientRegistration().getRegistrationId();
        String userNameAttributeName = userRequest.getClientRegistration().getProviderDetails().getUserInfoEndpoint().getUserNameAttributeName();
        
        OAuthAttributes attributes = OAuthAttributes.of(registrationId,userNameAttributeName,oAuth2User.getAttributes());
        
        User user = saveOrUpdate(attributes);
        
        httpSession.setAttribute("user",new SessionUser(user));
        
        return new DefaultOAuth2User(
                Collections.singleton(new SimpleGrantedAuthority(user.getRoleKey())),
                attributes.getAttributes(),
                attributes.getNameAttributeKey() 
        );
    }
    
    private User saveOrUpdate(OAuthAttributes attributes){
        User user = userRepository.findByEmail(attributes.getEmail())
                .map(entity -> entity.update(attributes.getName(),attributes.getPicture()))
                .orElse(attributes.toEntity());
        
        return UserRepository.save(user);
    }
}
  • registraionId : 현재 로그인 진행 중인 서비스를 구분하는 코드이다. (현재는 구글만 사용하여 불필요한값이지만, 이후 네이버 로그인 연동시 구분하기 위해 사용)
  • userNameAttributeName : OAuth2 로그인 진행 시 키가 되는 필드값을 이야기한다. 네이버/카카오 등은 기본지원하지 않는다. 구글의 기본코드는 sub이다. 이후 네이버/구글 로그인 동시 지원시 사용한다.
  • OAuthAttributes : OAuth2UserService를 통해 가져온 OAuth2User의 attribute를 담을 클래스이다. 이후 네이버 등 다른 소셜 로그인도 이 클래스를 사용한다.
  • SessionUser : 세션에 사용자 정보를 저장하기 위한 Dto 클래스이다.

OAuthAttributes 클래스


@Getter
public class OAuthAttributes {

    private Map<String,Object> attributes;
    private String nameAttributeKey;
    private String name;
    private String email;
    private String picture;

    @Builder
    public OAuthAttributes(Map<String ,Object> attributes,String nameAttributeKey,String name,String email,String picture){
        this.attributes =attributes;
        this.nameAttributeKey = nameAttributeKey;
        this.name = name;
        this.email = email;
        this.picture = picture;
    }

    public static OAuthAttributes of(String registrationId,String userNameAttributeName,Map<String ,Object> attributes){
        return ofGoogle(userNameAttributeName,attributes);
    }

    private static OAuthAttributes ofGoogle(String userNameAttributeName, Map<String, Object> attributes) {
        return OAuthAttributes.builder()
                .name((String)attributes.get("name"))
                .email((String)attributes.get("email"))
                .picture((String) attributes.get("picture"))
                .attributes(attributes)
                .nameAttributeKey(userNameAttributeName)
                .build();
    }

    public User toEntity(){
        return User.builder()
                .name(name)
                .email(email)
                .picture(picture)
                .role(Role.GUEST)
                .build();
    }


}
  • of() : OAuth2User에서 반환하는 사용자 정보는 Map이기 때문에 값 하나하나를 변환해야만 한다.
  • toEntity() : User엔티티를 생성한다. OAuthAttributes에서 엔티티를 생성하는 시점은 처음 가입할 때이다. 가입할 때의 기본권한을 GUEST로 주기 위해서 role빌더값에는 Role.GUEST를 사용한다.

SessionUser 클래스

@Getter
public class SessionUser {
    private String name;
    private String email;
    private String picture;
    
    public SessionUser(User user) {
        this.email = user.getEmail();
        this.name = user.getName();
        this.picture = user.getPicture();
    }
}

SessionUser에는 인증된 사용자의 정보만 필요하다. 그 외에 필요한 정보들이 없어서 name,email,picture만 필드로 선언한다.

User 클래스를 사용하면 안되는 이유
User클래스를 그대로 사용하면 User클래스를 세션에 저장하려고하여 직렬화를 구현하지 않았다는 의미의 에러가 발생한다. User클래스는 엔티티이기 때문에 언제 다른 엔티티와의 관계가 형성될지 모른다. 그렇다면 직렬화 대상에 자식들까지 포함됨으로써 성능 이슈,부수 효과가 발생할 확률이 높다. 그래서 직렬화 기능을 가진 세션 Dto를 하나 추가로 많드는 것이 이후 운영 및 유지보수 때 많은 도움이 된다.

로그인 테스트

index.mustache

로그인 버튼과 로그인 성공 시 사용자 이름을 보여주는 코드를 추가한다.

<h1> 스프링 부트로 시작하는 웹 서비스</h1>
<div class = "col-md-12">
    <!-- 로그인 기능 영역 -->
    <div class = "row">
        <a href="/posts/save" role = "button" class = "btn btn-primary">글 등록</a>
        
        {{#username}}
            Logged in as: <span id="user">{{userName}}</span>
            <a href="/logout" class = "btn btn-info active" role = "button">Logout</a>
        {{/username}}
        {{^username}}
            <a href="/oauth2/authorization/google" class = "btn btn-success active" role="button">Google Login</a>
        {{/username}}
    </div>
</div>
  • {{#userName}} : 머스테치는 다른 언어와 같은 if문 등을 제공하지 앟ㄴ는다. true/false여부만 판단한다. 그래서 머스테치에는 항상 최종값을 넘겨줘야 한다. 여기서도 userName이 있다면 userName을 노출시키도록 구성하였다.

  • a href="/logout" : 스프링 시큐리티에서 기본적으로 제공하는 로그아웃 url이다. 해당 컨트롤러 만들 필요 없음

  • {{^userName}} : 머스테치에서는 해당 값이 존재하지 않는 경우에는 ^ 를 사용한다. userName이 없는 경우 로그인 버튼을 노출시키도록 구성했다.

  • a href="/oauth2/authorization/google" : 기본적으로 제공하는 로그인 URL이다. 별도의 컨트롤러 생성할 필요 없다.

IndexController 클래스

index.mustache에서 userName을 사용할 수 있도록 userName을 Model에 추가하는 코드 추가.

    @GetMapping("/")
    public String index(Model model){
        model.addAttribute("posts",postsService.findAllDesc());
        SessionUser user = (SessionUser)httpSession.getAttribute("user");
        
        if(user !=null){
            model.addAttribute("userName",user.getName());
        }
        return "index";
    }
  • (SessionUser)httpSession.getAttribute("user") : 앞서 작성된 CustomOAuth2UserService에서 로그인 성공 시 세션에 Sessionuser를 저장하도록 구성하였다. 즉, 로그인 성공 시 httpSession.getAttribute("user")에서 값을 가져올 수 있다.
  • if(user!=null) : 세션에 저장된 값이 있을 경우에는 model에 userName으로 등록한다. 저장된 값이 없을 경우 model엔 아무 값도 없으므로 로그인 버튼이 보이게 된다.

프로젝트 실행 화면

login시 username이 뜨지않고 user라고 뜨는 현상 발생

위의 mustach의 attribute를 userName에서 myName으로 바꾸니 문제 해결됨 (이유 불분명)

h2-console 화면

데이터베이스에도 잘 들어있는지 확인할 수 있다.

현재 로그인된 사용자의 권한은 GUEST로서 posts 기능을 전혀 사용할 수 없다. 실제 테스트를 위해 글 쓰기를 진행하면 403에러(권한 거부)가 발생한다.

h2-console에서 role을 USER 로 변경하여 테스트를 다시 해본다. role변경이후 세션엔 이미 GUEST가 저장되어 있으므로 로그아웃 후 다시 로그인을 진행하여 테스트 하는 경우 아래와 같이 글이 등록되는 것을 확인할 수 있다.


4. 어노테이션 기반으로 개선하기

일반적인 프로그래밍에서 개선이 필요한 나쁜 코드에는 대표적으로 같은 코드가 반복되는 부분이 있다. 앞서 만든 코드에서 개선할 부분을 개선해보겠다.

IndexController에서 세션값 가져오는 부분

SessionUser user = (SessionUser)httpSession.getAttribute("user");

index메소드 외에도 다른 컨트롤러와 메소드에서 세션값이 필요하면 그 때마다 직접 세션에서 값을 가져와야 한다. 같은 코드가 계속 반복되는 것은 불필요하다. 그래서 이 부분을 메소드 인자로 세션값을 바로 받을 수 있도록 변경해보겟다.

config.auth 패키지에 @LoginUser 어노테이션을 생성한다.

@LoginUser 어노테이션 생성

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginUser {
}
  • @Target(ElementType.PARAMETER) : 어노테이션이 생성될 수 있는 위치를 지정한다. PARAMETER - 파라미터로 선언된 객체에서 사용가능
  • @Interface : 어노테이션 클래스로 지정한다는 어노테이션

LoginUserArgumentResolver 클래스

HandlerMethodArgumentResolver인터페이스를 구현한 클래스이다. 해당 인터페이스는 조건에 맞는 경우 메소드가 있다면 HandlerMethodArgumentResolver의 구현체가 지정한 값으로 해당 메소드의 파라미터로 넘길 수 있다.

@RequiredArgsConstructor
@Component
public class LoginUserArgumentResolver implements HandlerMethodArgumentResolver {
    private final HttpSession httpSession;

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        boolean isLoginUserAnnotation = parameter.getParameterAnnotation(LoginUser.class) != null;
        boolean isUserClass = SessionUser.class.equals(parameter.getParameterType());
        return isLoginUserAnnotation && isUserClass;

    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {

        return httpSession.getAttribute("user");
    }
}
  • supportParameter() : 컨트롤러 메서드의 특정 파라미터를 지원하는지 판단한다. 여기서는 파라미터에 @LoginUser어노테이션이 붙어 있고, 파라미터 클래스 타입이 Sessionuser.class 인경우 true를 반환한다.
  • resolveArgument() : 파라미터에 전달할 객체를 생성한다. 여기서는 세션에서 객체를 가져온다.

WebConfig 클래스

생성된 LoginuserArgumentResolver가 스프링에서 인식될 수 있도록 WebMvcConfigurer에 추가한다.

@RequiredArgsConstructor
@Configuration
public class WebConfig implements WebMvcConfigurer {
    private final LoginUserArgumentResolver loginUserArgumentResolver;

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(loginUserArgumentResolver);
    }
}

HandlerMethodArgumentResolver는 항상 WebMvcConfigurer의 addArgumentResolvers()를 통해 추가해야 한다.

IndexController 클래스 수정

IndexController의 반복되는 부분들을 모두 @LoginUser로 개선하였다.

    @GetMapping("/")
    public String index(Model model, @LoginUser SessionUser user){
        model.addAttribute("posts",postsService.findAllDesc());

        if(user !=null){
            model.addAttribute("myName",user.getName());
        }
        return "index";
    }
  • @LoginUser SessionUser user : 기존에 (SessionUser)httpSession.getAttribute("user")로 가져오던 세션 정보 값이 개선되었다. 이제 어느 컨트롤러이든지 @LoginUser만 사용하면 세션 정보를 가져올 수 있게 되었다.

    정리

  1. 어노테이션 생성
  2. HandlerMethodArgumentResolver를 구현한 클래스 생성 ( 메소드 구현 - 파라미터 값 검사 & 넘겨줄 파라미터 )
  3. WebMvcConfigurer 구현한 클래스 생성 ( addArgumentResolvers로 위의 클래스 등록 )

5. 세션 저장소로 데이터베이스 사용하기

지금 만든 서비스는 애플리케이션을 재실행하면 로그인이 풀린다. 그 이유는 세션이 내장 톰캣의 메모리에 저장되기 때문이다. 메모리에 저장되다 보니 내장 톰캣처럼 애플리케이션 실행 시 실행되는 구조에선 항상 초기화가 된다. 즉, 배포할 때마다 톰캣이 재시작 되는 것이다.

이외에도 톰캣마다 세션 동기화 설정을 해야 한다. 그래서 실제 현업에서는 세션 저장소에 대해 다음의 3가지 중 한가지를 선택한다.

1) 톰캣 세션을 사용한다. : 일반적으로 별다른 설정을 하지 않을 때 선택, 톰캣에 세션이 저장되기 때문에 2대 이상의 WAS가 구동되는 환경에서는 톰캣들 간의 세션 공유를 위한 추가 설정이 필요하다.

2) MySQL과 같은 데이터베이스를 세션 저장소로 사용한다. : 여러 WAS간의 공용 세션을 사용할 수 있는 가장 쉬운 방법이다. 많은 설정이 필요없지만 로그인 요청마다 DB IO가 발생하여 성능 이슈가 발생할 수 있다. 로그인 요청 많이 없는 백오피스,사내 시스템 용도

3) Redis,Memcached와 같은 메모리 DB를 세션 저장소로 사용한다. : B2C서비스에서 가장 많이 사용한다. 실제 서비스로 사용하기 위해서는 ㄸmbedded Redis와 같은 방식이 아닌 외부 메모리 서버가 필요하다.

여기서는 두번째 방식인 데이터베이스를 세션 저장소로 사용하는 방식을 선택하여 진행한다. 설정이 간단하고 사용자가 많은 서비스가 아니며 비용절감을 위해서 이다.

spring-session-jdbc 등록

먼저 build.gradle에 의존성을 등록한다.

compile('org.springframework.session:spring-session-jdbc')

application.properties에 세션 저장소를 jdbc로 선택하도록 코드를 추가한다.

spring.session.store-type=jdbc

로그인을 테스트한뒤, h2-console로 접속하는 경우 세션을 위한 테이블이 2개가 생성된 것을 볼 수 있다. JPA로 인해 세션테이블이 자동 생성되었기 때문이다. 지금은 기존과 동일하게 스프링을 재시작하면 세션이 풀린다. 이유는 H2기반으로 스프링이 재실행될때 H2도 재시작되기 때문이다.


6. 네이버 로그인

네이버 API 등록

먼저 네이버 오픈 api로 이동한다.

서비스 URL은 필수이므로 localhost8080으로 등록한다. callback Url은 구글에서 등록한 리디렉션 URL과 같은 역할을 한다. /login/oauth2/code/naver로 등록한다. 등록을 완료시 ClientID와 ClientSecret이 생성된다.

해당 키값들을 application-oauth.properties에 등록한다. 네이버에서는 스프링 시큐리티를 공식 지원하지 않기 때문에 그동안 Common-OAuth2Provider에서 해주던 값들도 전부 수동으로 입력해야 한다.

# registration
spring.security.oauth2.client.registration.naver.client-id=네이버 클라이언트 아이디
spring.security.oauth2.client.registration.naver.client-secret=클라이언트 비밀
spring.security.oauth2.client.registration.naver.redirect-uri={baseUrl}/{action}/oauth2/code/{registrationId}
spring.security.oauth2.client.registration.naver.authorization-grant-type=authorization_code
spring.security.oauth2.client.registration.naver.scope=name,email,profile_image
spring.security.oauth2.client.registration.naver.client-name=Naver

# provider
spring.security.oauth2.client.provider.naver.authorization-uri=https://nid.naver.com/oauth2.0/authorize
spring.security.oauth2.client.provider.naver.token-uri=https://nid.naver.com/oauth2.0/token
spring.security.oauth2.client.provider.naver.user-info-uri=https://openapi.naver.com/v1/nid/me
spring.security.oauth2.client.provider.naver.user-name-attribute=response

스프링 시큐리티에선 하위 필드를 명시할 수 없다. 최상위 필드들만 user_name으로 지정이 가능하다. 하지만 네이버의 응답값 최상위 필드는 resultCode,message,response이다.

이러한 이유로 스프링 시큐리티에서 인식 가능한 필드는 저 3개중에 골라야 한다. 본문에서 담고있는 response를 user_name으로 지정하고 이후 자바 코드로 response의 id를 user_name으로 지정한다.

스프링 시큐리티 설정 등록

OAuthAttributes에 네이버 인지 판단하는 코드와 네이버 생성자만 추가해주면 된다.

    public static OAuthAttributes of(String registrationId,String userNameAttributeName,Map<String ,Object> attributes){
        if("naver".equals(registrationId)){
            return ofNaver("id",attributes);
        }
        return ofGoogle(userNameAttributeName,attributes);
    }
    
...
    private static OAuthAttributes ofNaver(String userNameAttributeName, Map<String, Object> attributes) {
        Map<String,Object> response = (Map<String,Object>)attributes.get("response");

        return OAuthAttributes.builder()
                .name((String)response.get("name"))
                .email((String)response.get("email"))
                .picture((String)response.get("profile_image"))
                .attributes(response)
                .nameAttributeKey(userNameAttributeName)
                .build();
    }

index.mustache

네이버 로그인 버튼을 추가한다.

profile
멋쟁이 토마토

0개의 댓글