feat: 애플 로그인 API 구현 (#267)

sejineer · web-flow · commit 75dfd832d371 · 2024-02-22T00:04:40.000+09:00
* feat: 외부 API 호출 툴 Feign 설정

* feat: Apple 로그인 구현 + 회원가입 Reqeust Provider 추가
diff --git a/build.gradle b/build.gradle
@@ -25,6 +25,7 @@ dependencies {
 
 	//외부 API 호출할 때 쓰는 RestTemplate 라이브러리
 	implementation group: 'org.apache.httpcomponents.client5', name: 'httpclient5', version: '5.2.1'
+	implementation 'org.springframework.cloud:spring-cloud-starter-openfeign:4.1.0'
 
 	//S3
 	implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
diff --git a/src/main/java/com/shallwe/domain/auth/application/AuthService.java b/src/main/java/com/shallwe/domain/auth/application/AuthService.java
@@ -5,6 +5,7 @@
 import com.shallwe.domain.auth.dto.*;
 import com.shallwe.domain.auth.exception.AlreadyExistEmailException;
 import com.shallwe.domain.auth.exception.InvalidPasswordException;
+import com.shallwe.domain.auth.exception.UnRegisteredUserException;
 import com.shallwe.domain.common.Status;
 import com.shallwe.domain.shopowner.domain.ShopOwner;
 import com.shallwe.domain.shopowner.domain.repository.ShopOwnerRepository;
@@ -21,11 +22,14 @@
 import com.shallwe.domain.user.domain.User;
 import com.shallwe.global.config.security.token.UserPrincipal;
 import com.shallwe.global.error.DefaultAuthenticationException;
+import com.shallwe.global.infrastructure.feign.apple.AppleClient;
 import com.shallwe.global.payload.ErrorCode;
 import com.shallwe.global.payload.Message;
 import com.shallwe.domain.auth.domain.repository.TokenRepository;
 import com.shallwe.domain.user.domain.repository.UserRepository;
 
+import com.shallwe.global.utils.AppleJwtUtils;
+import io.jsonwebtoken.Claims;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.security.authentication.AuthenticationManager;
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
@@ -36,17 +40,18 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import lombok.RequiredArgsConstructor;
+import org.springframework.web.client.RestTemplate;
 
 
-@RequiredArgsConstructor
 @Service
-@Transactional(readOnly = true)
+@RequiredArgsConstructor
 @Slf4j
+@Transactional(readOnly = true)
 public class AuthService {
 
     private final CustomTokenProviderService customTokenProviderService;
+    private final AppleJwtUtils appleJwtUtils;
     private final PasswordEncoder passwordEncoder;
-    private final AuthenticationManager authenticationManager;
 
     private final TokenRepository tokenRepository;
     private final UserRepository userRepository;
@@ -59,7 +64,7 @@ public AuthRes signUp(final SignUpReq signUpReq) {
 
         User newUser = User.builder()
                 .providerId(signUpReq.getProviderId())
-                .provider(Provider.kakao)
+                .provider(signUpReq.getProvider())
                 .name(signUpReq.getNickname())
                 .email(signUpReq.getEmail())
                 .profileImgUrl(signUpReq.getProfileImgUrl())
@@ -256,4 +261,36 @@ private boolean valid(final String refreshToken) {
         return true;
     }
 
+    @Transactional
+    public AuthRes appleSignIn(AppleSignInReq appleSignInReq) {
+        Claims claims = appleJwtUtils.getClaimsBy(appleSignInReq.getIdentityToken());
+        Long userId = Long.parseLong(claims.getId());
+
+        User user = userRepository.findById(userId).orElseThrow(InvalidUserException::new);
+        if(user.getName() == null || user.getPhoneNumber() == null || user.getAge() == null || user.getGender() == null) {
+            throw new UnRegisteredUserException();
+        }
+
+        UserPrincipal userPrincipal = UserPrincipal.createUser(user);
+        Authentication authentication = new UsernamePasswordAuthenticationToken(
+                userPrincipal,
+                null,
+                userPrincipal.getAuthorities()
+        );
+
+        TokenMapping tokenMapping = customTokenProviderService.createToken(authentication);
+        Token token = Token.builder()
+                .refreshToken(tokenMapping.getRefreshToken())
+                .userEmail(tokenMapping.getUserEmail())
+                .build();
+        tokenRepository.save(token);
+
+        AuthRes authRes = AuthRes.builder()
+                .accessToken(tokenMapping.getAccessToken())
+                .refreshToken(token.getRefreshToken())
+                .build();
+
+        return authRes;
+    }
+
 }
diff --git a/src/main/java/com/shallwe/domain/auth/application/CustomTokenProviderService.java b/src/main/java/com/shallwe/domain/auth/application/CustomTokenProviderService.java
@@ -7,7 +7,8 @@
 import com.shallwe.global.config.security.token.UserPrincipal;
 import com.shallwe.domain.auth.dto.TokenMapping;
 
-import org.springframework.beans.factory.annotation.Autowired;
+import com.shallwe.global.infrastructure.feign.apple.AppleClient;
+import lombok.RequiredArgsConstructor;
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.userdetails.UserDetails;
@@ -21,13 +22,12 @@
 
 @Slf4j
 @Service
+@RequiredArgsConstructor
 public class CustomTokenProviderService {
 
-    @Autowired
-    private OAuth2Config oAuth2Config;
-
-    @Autowired
-    private CustomUserDetailsService customUserDetailsService;
+    private final OAuth2Config oAuth2Config;
+    private final CustomUserDetailsService customUserDetailsService;
+    private final AppleClient appleClient;
 
     public TokenMapping refreshToken(Authentication authentication, String refreshToken) {
         UserPrincipal userPrincipal = (UserPrincipal) authentication.getPrincipal();
diff --git a/src/main/java/com/shallwe/domain/auth/dto/AppleSignInReq.java b/src/main/java/com/shallwe/domain/auth/dto/AppleSignInReq.java
@@ -0,0 +1,15 @@
+package com.shallwe.domain.auth.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+
+@Data
+public class AppleSignInReq {
+
+    @Schema(type = "string", description = "애플 로그인을 위한 AuthorizationCode")
+    private String authorizationCode;
+
+    @Schema(type = "string", description = "애플 로그인을 위한 IdentityToken")
+    private String identityToken;
+
+}
diff --git a/src/main/java/com/shallwe/domain/auth/dto/AppleSignInRes.java b/src/main/java/com/shallwe/domain/auth/dto/AppleSignInRes.java
@@ -0,0 +1,10 @@
+package com.shallwe.domain.auth.dto;
+
+import lombok.Data;
+
+@Data
+public class AppleSignInRes {
+
+    private Boolean isSignUpComplete;
+
+}
diff --git a/src/main/java/com/shallwe/domain/auth/dto/SignUpReq.java b/src/main/java/com/shallwe/domain/auth/dto/SignUpReq.java
@@ -1,15 +1,19 @@
 package com.shallwe.domain.auth.dto;
 
+import com.shallwe.domain.user.domain.Provider;
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.Email;
 import lombok.Data;
 
 @Data
 public class SignUpReq {
 
-    @Schema( type = "string", example = "123123", description="카카오 고유 유저 ID 입니다.")
+    @Schema( type = "string", example = "123123", description="카카오/애플 고유 유저 ID 입니다.")
     private String providerId;
 
+    @Schema( type = "string", example = "KAKAO / APPLE", description="카카오/애플/구글 로그인 제공자 입니다.")
+    private Provider provider;
+
     @Schema( type = "string", example = "string", description="카카오톡 닉네임 입니다.")
     private String nickname;
 
diff --git a/src/main/java/com/shallwe/domain/auth/exception/UnRegisteredUserException.java b/src/main/java/com/shallwe/domain/auth/exception/UnRegisteredUserException.java
@@ -0,0 +1,9 @@
+package com.shallwe.domain.auth.exception;
+
+public class UnRegisteredUserException extends RuntimeException {
+
+    public UnRegisteredUserException() {
+        super("회원가입이 완료되지 않은 유저입니다.");
+    }
+
+}
diff --git a/src/main/java/com/shallwe/domain/auth/presentation/AuthController.java b/src/main/java/com/shallwe/domain/auth/presentation/AuthController.java
@@ -59,6 +59,18 @@ public ResponseCustom<AuthRes> signIn(
         return ResponseCustom.OK(authService.signIn(signInReq));
     }
 
+    @Operation(summary = "애플 로그인", description = "애플 로그인을 수행합니다.")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "애플 로그인 성공", content = { @Content(mediaType = "application/json", schema = @Schema(implementation = AppleSignInRes.class) ) } ),
+            @ApiResponse(responseCode = "400", description = "애플 로그인 실패", content = { @Content(mediaType = "application/json", schema = @Schema(implementation = ErrorResponse.class) ) } ),
+    })
+    @PostMapping(value="/sign-in/apple")
+    public ResponseCustom<AuthRes> appleSignIn(
+            @Parameter(description = "SignInReq Schema를 확인해주세요.", required = true) @RequestBody AppleSignInReq appleSignInReq
+    ) {
+        return ResponseCustom.OK(authService.appleSignIn(appleSignInReq));
+    }
+
     @Operation(summary = "토큰 갱신", description = "신규 토큰 갱신을 수행합니다.")
     @ApiResponses(value = {
             @ApiResponse(responseCode = "200", description = "토큰 갱신 성공", content = { @Content(mediaType = "application/json", schema = @Schema(implementation = AuthRes.class) ) } ),
diff --git a/src/main/java/com/shallwe/domain/user/domain/Provider.java b/src/main/java/com/shallwe/domain/user/domain/Provider.java
@@ -1,10 +1,5 @@
 package com.shallwe.domain.user.domain;
 
 public enum Provider {
-    local,
-    facebook,
-    google,
-    github,
-    kakao,
-    naver
+    KAKAO, APPLE, GOOGLE
 }
diff --git a/src/main/java/com/shallwe/global/config/FeignConfig.java b/src/main/java/com/shallwe/global/config/FeignConfig.java
@@ -0,0 +1,9 @@
+package com.shallwe.global.config;
+
+import org.springframework.cloud.openfeign.EnableFeignClients;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnableFeignClients(basePackages = "com.shallwe.global.infrastructure.feign")
+public class FeignConfig {
+}
diff --git a/src/main/java/com/shallwe/global/config/security/auth/OAuth2UserInfoFactory.java b/src/main/java/com/shallwe/global/config/security/auth/OAuth2UserInfoFactory.java
@@ -9,7 +9,7 @@
 public class OAuth2UserInfoFactory {
 
     public static OAuth2UserInfo getOAuth2UserInfo(String registrationId, Map<String, Object> attributes) {
-        if(registrationId.equalsIgnoreCase(Provider.kakao.toString())) {
+        if(registrationId.equalsIgnoreCase(Provider.KAKAO.toString())) {
             return new Kakao(attributes);
         } else {
             DefaultAssert.isAuthentication("해당 oauth2 기능은 지원하지 않습니다.");
diff --git a/src/main/java/com/shallwe/global/config/security/auth/company/Kakao.java b/src/main/java/com/shallwe/global/config/security/auth/company/Kakao.java
@@ -49,7 +49,7 @@ public String getImageUrl() {
 
     @Override
     public String getProvider(){
-        return Provider.kakao.toString();
+        return Provider.KAKAO.toString();
     }
 
     @Override
diff --git a/src/main/java/com/shallwe/global/infrastructure/feign/apple/AppleClient.java b/src/main/java/com/shallwe/global/infrastructure/feign/apple/AppleClient.java
@@ -0,0 +1,14 @@
+package com.shallwe.global.infrastructure.feign.apple;
+
+import com.shallwe.global.config.FeignConfig;
+import com.shallwe.global.infrastructure.feign.apple.dto.ApplePublicKeyRes;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@FeignClient(name = "appleClient", url = "https://appleid.apple.com/auth", configuration = FeignConfig.class)
+public interface AppleClient {
+
+    @GetMapping(value = "/keys")
+    ApplePublicKeyRes getAppleAuthPublicKey();
+
+}
diff --git a/src/main/java/com/shallwe/global/infrastructure/feign/apple/dto/ApplePublicKeyRes.java b/src/main/java/com/shallwe/global/infrastructure/feign/apple/dto/ApplePublicKeyRes.java
@@ -0,0 +1,29 @@
+package com.shallwe.global.infrastructure.feign.apple.dto;
+
+import lombok.Data;
+
+import java.util.List;
+import java.util.Optional;
+
+@Data
+public class ApplePublicKeyRes {
+
+    private List<Key> keys;
+
+    @Data
+    public static class Key {
+        private String kty;
+        private String kid;
+        private String use;
+        private String alg;
+        private String n;
+        private String e;
+    }
+
+    public Optional<Key> getMatchedKeyBy(String kid, String alg) {
+        return this.keys.stream()
+                .filter(key -> key.getKid().equals(kid) && key.getAlg().equals(alg))
+                .findFirst();
+    }
+
+}
diff --git a/src/main/java/com/shallwe/global/utils/AppleJwtUtils.java b/src/main/java/com/shallwe/global/utils/AppleJwtUtils.java
@@ -0,0 +1,63 @@
+package com.shallwe.global.utils;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.shallwe.global.infrastructure.feign.apple.AppleClient;
+import com.shallwe.global.infrastructure.feign.apple.dto.ApplePublicKeyRes;
+import io.jsonwebtoken.Claims;
+import io.jsonwebtoken.ExpiredJwtException;
+import io.jsonwebtoken.Jwts;
+import io.jsonwebtoken.MalformedJwtException;
+import io.jsonwebtoken.security.SignatureException;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+
+import java.math.BigInteger;
+import java.security.KeyFactory;
+import java.security.NoSuchAlgorithmException;
+import java.security.PublicKey;
+import java.security.spec.InvalidKeySpecException;
+import java.security.spec.RSAPublicKeySpec;
+import java.util.Base64;
+import java.util.Map;
+
+@Component
+@RequiredArgsConstructor
+public class AppleJwtUtils {
+
+    private final AppleClient appleClient;
+
+    public Claims getClaimsBy(String identityToken) {
+        try {
+            ApplePublicKeyRes response = appleClient.getAppleAuthPublicKey();
+
+            String headerOfIdentityToken = identityToken.substring(0, identityToken.indexOf("."));
+            Map<String, String> header = new ObjectMapper().readValue(new String(Base64.getDecoder().decode(headerOfIdentityToken), "UTF-8"), Map.class);
+            ApplePublicKeyRes.Key key = response.getMatchedKeyBy(header.get("kid"), header.get("alg")).orElseThrow(() -> new IllegalArgumentException("Not found matched key"));
+
+            byte[] nBytes = Base64.getUrlDecoder().decode(key.getN());
+            byte[] eBytes = Base64.getUrlDecoder().decode(key.getE());
+
+            BigInteger n = new BigInteger(1, nBytes);
+            BigInteger e = new BigInteger(1, eBytes);
+
+            RSAPublicKeySpec publicKeySpec = new RSAPublicKeySpec(n, e);
+            KeyFactory keyFactory = KeyFactory.getInstance(key.getKty());
+            PublicKey publicKey = keyFactory.generatePublic(publicKeySpec);
+
+            return Jwts.parser().setSigningKey(publicKey).parseClaimsJws(identityToken).getBody();
+        } catch (NoSuchAlgorithmException e) {
+            throw new IllegalArgumentException("Not found algorithm");
+        } catch (InvalidKeySpecException e) {
+            throw new IllegalArgumentException("Invalid key spec");
+        } catch (SignatureException e) {
+            throw new IllegalArgumentException("Invalid signature");
+        } catch (MalformedJwtException e) {
+            throw new IllegalArgumentException("Malformed jwt");
+        } catch (ExpiredJwtException e) {
+            throw new IllegalArgumentException("Expired jwt");
+        } catch (Exception e) {
+            throw new IllegalArgumentException("Invalid jwt");
+        }
+    }
+
+}
