Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature/user-profile-create] 유저 인증 여부 API 구현 완료 #38

Merged
merged 5 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/cd_prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ jobs:
touch ./application-secret.yml
echo "${{ secrets.PROPERTIES_SECRET }}" > ./application-secret.yml
shell: bash
- name: Make application-dev.yml
run: |
cd ./src/main/resources
touch ./application-dev.yml
echo "${{ secrets.PROPERTIES_SECRET_DEV }}" > ./application-dev.yml
shell: bash
- name: Make application-prod.yml
run: |
cd ./src/main/resources
touch ./application-prod.yml
echo "${{ secrets.PROPERTIES_SECRET_PROD }}" > ./application-prod.yml
shell: bash

# 6) 빌드
- name: Build with gradle
Expand Down
11 changes: 1 addition & 10 deletions .github/workflows/ci_dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ jobs:
sonarcloud:
name: SonarCloud
runs-on: ubuntu-latest
strategy:
matrix:
mongodb-version: ['6.0'] # 몽고디비 버전별 병렬 실행
mongodb-db: ['everymeal']
steps:
- uses: actions/checkout@v3
with:
Expand All @@ -34,11 +30,6 @@ jobs:
path: ~/.sonar/cache
key: ${{ runner.os }}-sonar
restore-keys: ${{ runner.os }}-sonar
- name: Start MongoDB v${{ matrix.mongodb-version }}
uses: supercharge/[email protected]
with:
mongodb-version: ${{ matrix.mongodb-version }}
mongodb-db: ${{ matrix.mongodb-db }}
- name: Make application-secret.yml
run: |
cd ./src/main/resources
Expand All @@ -49,4 +40,4 @@ jobs:
run: ./gradlew test sonar --info
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ out/
### VS Code ###
.vscode/

application-dev.yml
application-prod.yml
application-secret.yml

*.log

/src/main/resources/application-secret.yml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ public enum ExceptionList {
INVALID_REQUEST("R0001", HttpStatus.BAD_REQUEST, "Request의 Data Type이 올바르지 않습니다."),

USER_NOT_FOUND("U0001", HttpStatus.NOT_FOUND, "등록된 유저가 아닙니다."),

TOKEN_NOT_VALID("T0001", HttpStatus.NOT_ACCEPTABLE, "해당 토큰은 유효하지 않습니다."),
TOKEN_EXPIRATION("T0002", HttpStatus.FORBIDDEN, "토큰이 만료되었습니다."),
;

public final String CODE;
Expand Down
43 changes: 43 additions & 0 deletions src/main/java/everymeal/server/global/util/JwtUtil.java
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
package everymeal.server.global.util;

import static everymeal.server.global.exception.ExceptionList.TOKEN_EXPIRATION;
import static everymeal.server.global.exception.ExceptionList.TOKEN_NOT_VALID;

import everymeal.server.global.exception.ApplicationException;
import everymeal.server.global.util.authresolver.entity.AuthenticatedUser;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.ExpiredJwtException;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.MalformedJwtException;
import io.jsonwebtoken.SignatureAlgorithm;
import io.jsonwebtoken.security.Keys;
import java.security.Key;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
Expand Down Expand Up @@ -53,4 +61,39 @@ public String generateRefreshToken(Long idx, String accessToken) {
.signWith(Keys.hmacShaKeyFor(refreshSecretKey.getBytes()), SignatureAlgorithm.HS512)
.compact();
}

public AuthenticatedUser getAuthenticateUserFromAccessToken(String token) {
Claims claims = getClaimsFromToken(tokenSubBearer(token), accessSecretKey);
if (claims != null) {
return AuthenticatedUser.builder()
.idx(Long.parseLong(claims.get("CLAIM_KEY_IDX").toString()))
.deviceId(claims.get("CLAIM_KEY_DEVICEID").toString())
.nickName(claims.get("CLAIM_KEY_NICKNAME").toString())
.build();
}
return null;
}

private Claims getClaimsFromToken(String token, String secretKey) {
try {
Key key = Keys.hmacShaKeyFor(secretKey.getBytes());
return Jwts.parserBuilder().setSigningKey(key).build().parseClaimsJws(token).getBody();
} catch (ExpiredJwtException exception) {
log.error("Token Tampered");
throw new ApplicationException(TOKEN_EXPIRATION);
} catch (MalformedJwtException exception) {
log.error("Token MalformedJwtException");
throw new ApplicationException(TOKEN_EXPIRATION);
} catch (Exception exception) {
log.error("Undefined ERROR");
throw new ApplicationException(TOKEN_NOT_VALID);
}
}

private static String tokenSubBearer(String token) {
if (token != null && token.startsWith("Bearer ")) {
token = token.substring(7); // "Bearer " 문자열 제거
}
return token;
}
}
18 changes: 18 additions & 0 deletions src/main/java/everymeal/server/global/util/authresolver/Auth.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package everymeal.server.global.util.authresolver;


import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Auth {

boolean optional() default false;

boolean require() default false;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package everymeal.server.global.util.authresolver;


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface AuthUser {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package everymeal.server.global.util.authresolver;


import everymeal.server.global.util.JwtUtil;
import everymeal.server.global.util.authresolver.entity.AuthenticatedUser;
import jakarta.validation.constraints.NotNull;
import lombok.RequiredArgsConstructor;
import org.springframework.core.MethodParameter;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

@RequiredArgsConstructor
@Component
public class UserJwtResolver implements HandlerMethodArgumentResolver {

private final JwtUtil jwtUtil;

@Override
public boolean supportsParameter(MethodParameter parameter) {
return parameter.hasParameterAnnotation(AuthUser.class)
&& AuthenticatedUser.class.equals(parameter.getParameterType());
}

@Nullable
@Override
public Object resolveArgument(
@NotNull MethodParameter parameter,
ModelAndViewContainer mavContainer,
@NotNull NativeWebRequest webRequest,
WebDataBinderFactory binderFactory)
throws Exception {
Auth auth = parameter.getMethodAnnotation(Auth.class);
if (auth == null) {
throw new Exception("토큰을 통해 userId를 추출하는 메서드에는 @Auth 어노테이션을 붙여주세요.");
}
String authorization = webRequest.getHeader("Authorization");
if (!auth.require() && authorization == null) {
return null;
} else {
return jwtUtil.getAuthenticateUserFromAccessToken(authorization);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package everymeal.server.global.util.authresolver.entity;


import lombok.Builder;
import lombok.Getter;

@Getter
public class AuthenticatedUser {
private Long idx;
private String deviceId;
private String nickName;

@Builder
public AuthenticatedUser(Long idx, String deviceId, String nickName) {
this.idx = idx;
this.deviceId = deviceId;
this.nickName = nickName;
}
}
13 changes: 13 additions & 0 deletions src/main/java/everymeal/server/user/controller/UserController.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@


import everymeal.server.global.dto.response.ApplicationResponse;
import everymeal.server.global.util.authresolver.Auth;
import everymeal.server.global.util.authresolver.AuthUser;
import everymeal.server.global.util.authresolver.entity.AuthenticatedUser;
import everymeal.server.user.controller.dto.response.UserLoginRes;
import everymeal.server.user.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseCookie;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
Expand Down Expand Up @@ -58,4 +63,12 @@ public ResponseEntity<ApplicationResponse<UserLoginRes>> login(
.header("Set-Cookie", cookie.toString())
.body(ApplicationResponse.ok(response));
}

@Auth(require = true)
@GetMapping("/auth")
@Operation(summary = "유저 인증 여부")
@SecurityRequirement(name = "bearerAuth")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 어노테이션은 처음봐요 😮

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이중 어느것 일가요?
@Auth는 커스텀 어노테이션!
@operation는 API 설명!
@securityrequirement 이 API는 Swagger에서 토큰 전달하는 설정입니다! -> Swagger에서 자물쇠가 생깁니다!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@securityrequirement 이거였어요 : )

public ApplicationResponse<Boolean> isAuth(@AuthUser AuthenticatedUser authenticatedUser) {
return ApplicationResponse.ok(userService.isAuth(authenticatedUser));
}
}
2 changes: 1 addition & 1 deletion src/main/java/everymeal/server/user/entity/Review.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ public class Review {
private Double grade;
private Integer awesomeCount;

@ManyToOne private Users user;
@ManyToOne private User user;
}
2 changes: 1 addition & 1 deletion src/main/java/everymeal/server/user/entity/Scrap.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ public class Scrap {

@ManyToOne private Store store;

@ManyToOne private Users user;
@ManyToOne private User user;
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

@Getter
@Table
@Entity
@Entity(name = "users")
@NoArgsConstructor(access = lombok.AccessLevel.PROTECTED)
public class Users extends BaseEntity {
public class User extends BaseEntity {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
Expand All @@ -34,7 +34,7 @@ public class Users extends BaseEntity {
@ManyToOne private University university;

@Builder
public Users(String deviceId, String nickName, String email, University university) {
public User(String deviceId, String nickName, String email, University university) {
this.deviceId = deviceId;
this.nickName = nickName;
this.email = email;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package everymeal.server.user.repository;


import everymeal.server.user.entity.Users;
import everymeal.server.user.entity.User;
import java.util.Optional;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends JpaRepository<Users, Long> {
Optional<Users> findByDeviceId(String deviceId);
public interface UserRepository extends JpaRepository<User, Long> {
Optional<User> findByDeviceId(String deviceId);
}
3 changes: 3 additions & 0 deletions src/main/java/everymeal/server/user/service/UserService.java
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
package everymeal.server.user.service;


import everymeal.server.global.util.authresolver.entity.AuthenticatedUser;
import everymeal.server.user.controller.dto.response.UserLoginRes;

public interface UserService {

Boolean signUp(String userDeviceId);

UserLoginRes login(String userDeviceId);

Boolean isAuth(AuthenticatedUser authenticatedUser);
}
16 changes: 13 additions & 3 deletions src/main/java/everymeal/server/user/service/UserServiceImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
import everymeal.server.global.exception.ApplicationException;
import everymeal.server.global.exception.ExceptionList;
import everymeal.server.global.util.JwtUtil;
import everymeal.server.global.util.authresolver.entity.AuthenticatedUser;
import everymeal.server.user.controller.dto.response.UserLoginRes;
import everymeal.server.user.entity.Users;
import everymeal.server.user.entity.User;
import everymeal.server.user.repository.UserRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
Expand All @@ -19,19 +20,28 @@ public class UserServiceImpl implements UserService {

@Override
public Boolean signUp(String userDeviceId) {
Users user = Users.builder().deviceId(userDeviceId).build();
User user = User.builder().deviceId(userDeviceId).build();
userRepository.save(user);
return true;
}

@Override
public UserLoginRes login(String userDeviceId) {
Users user =
User user =
userRepository
.findByDeviceId(userDeviceId)
.orElseThrow(() -> new ApplicationException(ExceptionList.USER_NOT_FOUND));
String accessToken = jwtUtil.generateAccessToken(user.getIdx());
String refreshToken = jwtUtil.generateRefreshToken(user.getIdx(), accessToken);
return UserLoginRes.builder().accessToken(accessToken).refreshToken(refreshToken).build();
}

@Override
public Boolean isAuth(AuthenticatedUser authenticatedUser) {
User user =
userRepository
.findByDeviceId(authenticatedUser.getDeviceId())
.orElseThrow(() -> new ApplicationException(ExceptionList.USER_NOT_FOUND));
return !user.getEmail().isBlank();
}
}
Loading
Loading