학교에서 프로젝트를 진행하면서 웹 사이트를 구축하고 있습니다!
저는 백엔드를 담당하여 Spring Security + OAuth2.0 + JWT를 이용한 소셜로그인 기능을 구현하였는데요.
생각보다 소셜 로그인이 정말 복잡하고 어렵다는 것을 알게 되었습니다..ㅎ
버전 정보
Spring Boot : 3.0.x
Spring Security : 6.x
Spring에서는 인증과 인가를 쉽게 구현할 수 있도록 Spring Security라는 하위 프로젝트를 제공하고 있습니다.
(근데 쉽지 않습니다.)
스프링 시큐리티의 핵심은 Security Filter Chain으로 기본적으로 여러가지 보안 필터를 제공하며 요청에 대한 필터링을 수행합니다.이 필터 체인에 저희가 구현한 커스텀 필터를 추가하여 인증, 인과 과정을 Customizing 할 수 있습니다!
스프링 시큐리티는 기본적으로 Form 기반의 로그인 ( 아이디, 비밀번호가 넘어오면 그걸 기반으로 ) 을 수행하며 이때 Security Filter 중에서 UsernamePasswordAuthenticationFilter 필터가 작용하여 인증 프로세스를 수행합니다.
저희는 Form기반의 로그인이 아닌 JWT를 이용한 토큰 기반의 로그인을 사용할 것이기 떄문에 UsernamePasswordAuthenticationFilter 필터의 앞에 저희의 커스텀 JWT 인증 필터를 만들어서 인증 과정을 대신 수행하도록 하여 인증 성공시 UsernamePasswordAuthenticationFilter를 통과하도록 할 것 입니다.
OAuth2.0의 경우 Authorization Code Grant 방식을 사용하였으며, OAuth2.0 동작 방식까지 포스팅하면 내용이 너무 많아져서 검색한번 해보시는 것을 추천드립니다!
* https://developers.kakao.com/에서 애플리케이션을 등록한 상태여야 합니다.
로그인 프로세스
- 최초 로그인 요청
- 사용자가 저희 웹사이트에 로그인을 요청하는 경우입니다! ( 카카오 로그인 버튼을 누르는 경우) - 소셜 로그인 요청
- 클라이언트(프론트엔드 서버)는 Redirect URI, Client ID, Scope 등을 담아 Resource Server에 로그인 요청을 보냅니다. - 소셜 로그인 페이지 제공
- Redirect URI, Client ID 등을 검증하고 유효한 경우 사용자에게 로그인 페이지를 제공합니다. - 소셜 로그인 ID / PW 제공
- 사용자는 로그인 페이지에 로그인을 합니다. - Authorization Code 발급
- 사용자가 로그인에 성공하면, Authorization code를 발급합니다. - Redirect URI로 리다이렉트
- 위에서 지정한 Redirect URI로 리다이렉트 합니다. - 인가 코드 전달
- 프론트엔드에서 백엔드(API 서버)로 Authorization code를 담아 Post 요청을 보냅니다.
( POST /oauth2/login/kakao/{Authorizationcode} ) - Access token 요청 ( 여기서부터 구현했습니다 )
- 해당 요청을 컨트롤러에서 받고, OAuth2TokenService에서 인가 코드를 이용하여 Authorization Server에 Access token을 요청합니다. - Access token 발급
- 넘어온 요청 정보들 ( 인가코드, 아까 사용한 redirec uri 등 )을 검증하고 성공시 access token을 발급해줍니다. - User Information 요청
- Access token을 발급받았으니 이 토큰으로 로그인한 유저가 동의한 Scope에 있는 소셜 정보들을 불러올 수 있습니다. 제가 구현한 경우에는 이름, 이메일, 식별자(OauthId) 정도만 가져왔습니다! - User Information 응답
- 요청한 정보를 담아 응답해줍니다. ( JSON ) - User 정보 전달 - UserRepository에 받아온 사용자 정보를 전달하여 처리합니다.
- User 저장 or 이미 있으면 Update
- DB에 유저 정보가 없으면 저장하고 만약 이미 있으면 (변경사항이 있을 수도 있으므로 반영을 위해 )수정하는 쿼리를 날립니다! - JwtTokenProvider에게 받아온 유저 정보를 넘겨줍니다.
- 유저 정보를 사용하여 JWT 토큰을 생성합니다 - JWT 토큰 발급 ( ~ 17 )
- JWT 토큰을 발급하여 응답합니다.
OAuth2TokenService
public OauthToken getKakaoAccessToken(String authorizationCode) {
// Set URI
URI uri = UriComponentsBuilder
.fromUriString("https://kauth.kakao.com")
.path("/oauth/token")
.encode()
.build()
.toUri();
RestTemplate restTemplate = new RestTemplate();
// Set header
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
headers.add("Accept", "application/json");
// Set parameter
MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
params.add("grant_type", "authorization_code");
params.add("client_id", KAKAO_REST_API_KEY);
params.add("redirect_uri", KAKAO_REDIRECT_URI);
params.add("code", authorizationCode);
// Set http entity
RequestEntity<MultiValueMap<String, String>> requestEntity = RequestEntity.post(uri).headers(headers).body(params);
ResponseEntity<String> responseEntity;
try {
// 토큰 받기
responseEntity = restTemplate.exchange(requestEntity, String.class);
} catch (Exception e) {
log.error("[kakao] access token 발급 실패 ");
throw (new RuntimeException("authorization code가 잘못되었습니다."));
}
// JSON String to OauthToken
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
OauthToken oauthToken;
try {
oauthToken = objectMapper.readValue(responseEntity.getBody(), OauthToken.class);
} catch (JsonProcessingException e) {
throw new RuntimeException(e);
}
return oauthToken;
}- 카카오의 access token을 받아오는 메서드입니다.
- 카카오 REST API Docs (https://developers.kakao.com/docs/latest/ko/kakaologin/rest-api)를 참고하였습니다.
- 추후에 Custom Exception을 사용하여 예외 처리를 더 명확하게 Refactoring할 예정입니다..
public OAuthAttributes loadKakao(String accessToken, String refreshToken) {
RestTemplate restTemplate = new RestTemplate();
// 유저 정보 불러오기
ResponseEntity<String> responseEntity = null;
try {
responseEntity = restTemplate.exchange(requestEntity, String.class);
} catch (RuntimeException e) {
log.error("[kakao] loadKakao 유저 정보 불러오기 실패");
throw (new RuntimeException());
}
// JSON String to Object
ObjectMapper objectMapper = new ObjectMapper();
Map<String, Object> attributes;
try {
attributes = objectMapper.readValue(responseEntity.getBody(), HashMap.class);
} catch (JsonProcessingException e) {
throw new RuntimeException(e);
}
return OAuthAttributes.of(SocialType.KAKAO, "", attributes);
}- access token을 이용하여 사용자 정보를 불러오는 부분입니다!
- Map<String , Object> 형태로 사용자 정보를 반환합니다.
OAuthAttributes
public class OAuthAttributes {
private Map<String, Object> attributes;
private String oAuthId; // OAuth2.0에서 사용하는 PK
private String nickName; // 닉네임 정보
private String email; // 이메일 주소
private SocialType socialType;
}- 각각의 Resource Server ( 카카오, 구글, 네이버 등) 넘어온 데이터로부터 뽑아낼 정보들입니다.
private static OAuthAttributes ofKakao(String userNameAttributeName, Map<String, Object> attributes) {
Map<String, Object> kakaoAccount = (Map<String, Object>) attributes.get("kakao_account");
Map<String, Object> profile = (Map<String, Object>) kakaoAccount.get("profile");
String nickname = (String) profile.get("nickname");
String email = (String) kakaoAccount.get("email");
// 리소스 서버별 사용자 식별하는 값입니다.
String oAuthId = String.valueOf(attributes.get(userNameAttributeName));
return OAuthAttributes.builder()
.oAuthId(oAuthId)
.email(email)
.nickName(nickname)
.attributes(attributes)
.socialType(SocialType.KAKAO)
.build();
}- Resource Server마다 속성 이름이나 넘겨주는 데이터 구조 등이 달라서 통일화 하기 위한 클래스입니다!
참고 자료 (스프링 부트와 AWS로 혼자 구현하는 웹 서비스 | 이동욱)
JwtTokenProvider
public String createToken(String userOAuthId) {
log.info("[createToken] userOAuthId = {}", userOAuthId);
Claims claims = Jwts.claims().setSubject(userOAuthId);
Date now = new Date();
String token = Jwts.builder()
.setClaims(claims)
.setIssuedAt(now)
.setExpiration(new Date(now.getTime() + tokenValidMillisecond))
.signWith(SignatureAlgorithm.HS256, secretKey)
.compact();
return token;
}- JwtTokenProvider는 JWT 토큰의 생성, 유효성확인, Authentication 생성 등 토큰과 관련된 모든 처리를 담당하는 모듈입니다.
- OAuthId를 받아 그 정보를 토큰의 subject로 지정하고, 토큰을 발급하는 코드입니다.
public boolean validateToken(String token) {
log.info("[validateToken] 토큰 유효성 확인");
try {
Claims body = Jwts.parser().setSigningKey(secretKey).parseClaimsJws(token).getBody();
return !body.getExpiration().before(new Date());
} catch (Exception e) {
log.error("[validateToken] 유효하지 않은 토큰입니다.");
return false;
}
}- 토큰이 넘어오면 유효기간을 체크하는 기능입니다.
public Authentication getAuthentication(String token) {
log.info("[getAuthentication] 토큰 기반 정보 조회 시작");
String userName = getUserName(token);
UserDetails userDetails = new CustomUserDetails(userName);
return new UsernamePasswordAuthenticationToken(userDetails, "", null);
}- 토큰에서 유저 정보를 추출하여 Authentication 객체를 생성합니다. 이 Authentication 객체는 인증 정보를 담고 있으며 Spring Security의 SecurityContextHolder라는 인증 저장소에 담기게 됩니다!
SecurityConfig
@Configuration
@EnableWebSecurity
@EnableWebMvc
public class SecurityConfig{
private final JwtTokenProvider jwtTokenProvider;
@Autowired
public SecurityConfig(JwtTokenProvider jwtTokenProvider) {
this.jwtTokenProvider = jwtTokenProvider;
}
// HttpSecurity 설정
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.httpBasic().disable() // UI 사용하는 것을 기본값으로 가진 시큐리티 설정 비활성화
.formLogin().disable()
.csrf().disable() // CSRF 보안 비활성화
.sessionManagement() // 세션 관리 정책 설정
.sessionCreationPolicy(SessionCreationPolicy.STATELESS) // JWT로 인증, 인증에서 세션은 사용하지 않음
.and()
// swagger 설정
.authorizeHttpRequests().requestMatchers("v3/api-docs/**", "/swagger-resources/**", "/swagger-ui*/**",
"/webjars/**", "/swagger/**").permitAll()
.and()
// 인증이 필요한 요청
.authorizeHttpRequests().requestMatchers("/user/detail/**").authenticated()
.anyRequest().permitAll()
.and()
// 접근 권한이 없는 경우 발생하는 예외 처리
.exceptionHandling().accessDeniedHandler(new CustomAccessDeniedHandler())
.and()
// 인증 실패시 발생하는 예외 처리
.exceptionHandling().authenticationEntryPoint(new CustomAuthenticationEntryPoint())
.and()
// 인증을 담당하는 UsernamePasswordAuthenticationFilter 앞에 커스텀 필터를 배치하여 커스텀 필터가 인증 과정을 수행하도록 하였습니다.
.addFilterBefore(new JwtAuthenticationFilter(jwtTokenProvider), UsernamePasswordAuthenticationFilter.class);
return http.build();
}
}- 스프링 시큐리티 필터에 대한 설정입니다!
- 인증이 필요한 요청에 대해서는 authenticated를 적용해 인증된 접근인지 검증합니다.
- accessDeniedHandler() : 접근 권한이 없는 리소스에 접근할시 해당 클래스에서 예외처리
JwtAuthenticationFilter
public class JwtAuthenticationFilter extends OncePerRequestFilter {
private JwtTokenProvider jwtTokenProvider;
public JwtAuthenticationFilter(JwtTokenProvider jwtTokenProvider) {
this.jwtTokenProvider = jwtTokenProvider;
}
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
String token = jwtTokenProvider.resolveToken(request);
log.info("[JwtAuthenticationFilter] token 값 추출. token : {}", token);
log.info("token 유효성 검증시작");
if (token != null && jwtTokenProvider.validateToken(token)) {
log.info("token 인증성공");
Authentication authentication = jwtTokenProvider.getAuthentication(token);
SecurityContextHolder.getContext().setAuthentication(authentication);
}
filterChain.doFilter(request, response);
}
}- 직접 구현한 커스텀 필터입니다! OncePerRequestFilter 또는 GenericFilterBean를 상속받아 쉽게 구현이 가능합니다. OncePerRequestFilter는 이름 그대로 요청당 한번만 수행되는 필터입니다.
- 토큰을 검증하고, 토큰이 있는 경우 Authentication 객체를 SecurityConyextHolder에 추가하여 인증을 수행합니다.
- 커스텀 필터에 @Component가 없는 이유 : 해당 필터를 스프링 빈으로 등록하게 되면, 스프링 시큐리티의 범위에서 벗어나 스프링 자체에서 필터 역할을 하기 때문에 저희가 지정한 요청 제어 등이 제대로 수행되지 않습니다. 따라서 해당 클래스는 스프링 빈으로 등록하지 않습니다.
이번 프로젝트를 진행하며 처음으로 Spring Security, OAuth2.0, JWT 기능들을 사용해봤는데요. 정말 오래걸리고 힘들었지만 찾아보며 구현하는 재미가 있었던 것 같습니다! 읽어주셔서 감사합니다
'Spring' 카테고리의 다른 글
| [ 스터디 ] 스프링부트 핵심가이드 - 스프링 부트에서의 유효성 검사 (0) | 2023.04.15 |
|---|---|
| [ 스터디 ] 스프링부트 핵심가이드 - 일대일 매핑 (0) | 2023.04.10 |
| [ 스터디 ] 스프링부트 핵심가이드 - 연관관계 매핑 종류와 방향 (0) | 2023.04.10 |
| [ 스터디 ] 스프링부트 핵심가이드 - 정렬과 페이징 처리 (2) (0) | 2023.03.30 |
| [ 스터디 ] 스프링부트 핵심가이드 - 정렬과 페이징 처리 (1) (0) | 2023.03.30 |
