feat: remove CustomRule Field and move to UsedRule (#83)

Floodnut · Floodnut · commit 1556aef40490 · 2023-05-11T19:54:20.000+09:00
diff --git a/src/main/java/scanner/checklist/dto/CheckListDetailDto.java b/src/main/java/scanner/checklist/dto/CheckListDetailDto.java
@@ -8,6 +8,7 @@
 import scanner.checklist.entity.CustomRuleDetails;
 import scanner.checklist.entity.UsedRule;
 import scanner.checklist.enums.SecurityType;
+import scanner.common.enums.Language;
 
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 public class CheckListDetailDto {
@@ -51,6 +52,11 @@ public Detail(String ruleName, List<TagDto> tags, List<SecurityType> type, Strin
 
 		public Detail(UsedRule usedRule) {
 			CustomRule rule = usedRule.getOriginRule();
+			CustomRuleDetails details = rule.getRuleDetails()
+				.stream()
+				.filter(d -> d.getLanguage().equals(Language.ENGLISH))
+				.findAny()
+				.orElse(rule.getRuleDetails().get(0));
 
 			this.ruleName = usedRule.getRuleName();
 			this.state = usedRule.getIsOn().toString();
@@ -60,12 +66,12 @@ public Detail(UsedRule usedRule) {
 			this.tags = rule.getTagDto();
 			this.type = null;
 			this.level = rule.getLevel();
-			this.description = rule.getDescription();
-			this.explanation = rule.getExplanation();
-			this.possibleImpact = rule.getPossibleImpact();
+			this.description = details.getDescription();
+			this.explanation = details.getExplanation();
+			this.possibleImpact = details.getPossibleImpact();
 			this.insecureExample = rule.getInsecureExample();
 			this.secureExample = rule.getSecureExample();
-			this.solution = new Solution(rule.getSol(), rule.getCode());
+			this.solution = new Solution(details.getSol(), rule.getCode());
 			this.isModifiable = rule.getIsModifiable();
 		}
 	}
@@ -97,26 +103,5 @@ public static Detail toDetailsDto(final UsedRule usedRule, final CustomRuleDetai
 			.isModifiable(rule.getIsModifiable())
 			.build();
 	}
-
-	public static Detail toDto(final UsedRule usedRule) {
-		CustomRule rule = usedRule.getOriginRule();
-		return Detail.checklistDetailsBuilder()
-
-			.ruleName(usedRule.getRuleName())
-			.state(usedRule.getIsOn().toString())
-			.isModified(usedRule.getIsModified())
-			.customDetail(usedRule.getCustomDetail())
-
-			.tags(rule.getTagDto())
-			.level(rule.getLevel())
-			.description(rule.getDescription())
-			.explanation(rule.getExplanation())
-			.possibleImpact(rule.getPossibleImpact())
-			.insecureExample(rule.getInsecureExample())
-			.secureExample(rule.getSecureExample())
-			.solution(new Solution(rule.getSol(), rule.getCode()))
-			.isModifiable(rule.getIsModifiable())
-			.build();
-	}
 }
 
diff --git a/src/main/java/scanner/checklist/entity/CustomRule.java b/src/main/java/scanner/checklist/entity/CustomRule.java
@@ -52,24 +52,12 @@ public class CustomRule extends BaseEntity {
 	@NotNull
 	private Character isModifiable;
 
-	@Column(name = "DESCRIPTION")
-	private String description;
-
-	@Column(name = "EXPLANATION")
-	private String explanation;
-
-	@Column(name = "POSSIBLE_IMPACT")
-	private String possibleImpact;
-
 	@Column(name = "INSECURE_EXAMPLE")
 	private String insecureExample;
 
 	@Column(name = "SECURE_EXAMPLE")
 	private String secureExample;
 
-	@Column(name = "SOLUTION")
-	private String sol;
-
 	@Column(name = "CODE")
 	private String code;
 
@@ -98,21 +86,15 @@ public List<TagDto> getTagDto() {
 	}
 
 	@Builder(builderClassName = "customRuleAddBuilder", builderMethodName = "customRuleAddBuilder")
-	public CustomRule(String defaultRuleName, Provider provider, String ruleType,
-		String level, Character isModifiable, String description, String explanation,
-		String possibleImpact, String insecureExample, String secureExample, String sol, String code,
-		String customDefault) {
+	public CustomRule(String defaultRuleName, Provider provider, String ruleType, String level, Character isModifiable,
+		String insecureExample, String secureExample, String code, String customDefault) {
 
 		this.defaultRuleName = defaultRuleName;
 		this.provider = provider;
 		this.ruleType = ruleType;
 		this.level = level;
-		this.description = description;
-		this.explanation = explanation;
-		this.possibleImpact = possibleImpact;
 		this.insecureExample = insecureExample;
 		this.secureExample = secureExample;
-		this.sol = sol;
 		this.code = code;
 		this.isModifiable = isModifiable;
 		this.customDefault = customDefault;
@@ -131,9 +113,11 @@ public CustomRule(String defaultRuleName, Provider provider, List<ComplianceKor>
 	public void addComplianceKorsForTest(List<ComplianceKor> kors) {
 		this.complianceKors = kors;
 	}
+
 	public void addComplianceEngsForTest(List<ComplianceEng> engs) {
 		this.complianceEngs = engs;
 	}
+
 	public void addHistoryDetailsForTest(List<ScanHistoryDetail> details) {
 		this.historyDetails = details;
 	}
diff --git a/src/main/java/scanner/common/client/OAuthFeignClient.java b/src/main/java/scanner/common/client/OAuthFeignClient.java
@@ -10,5 +10,5 @@
 public interface OAuthFeignClient {
 
 	@PostMapping(value = "/login/oauth/access_token")
-	OAuthDto.GithubTokenResponse requestGithubAccessToken(@RequestBody OAuthDto.GithubTokenRequest tokenRequest);
+	String requestGithubAccessToken(@RequestBody OAuthDto.GithubTokenRequest tokenRequest);
 }
diff --git a/src/main/java/scanner/oauth/dto/OAuthDto.java b/src/main/java/scanner/oauth/dto/OAuthDto.java
@@ -7,6 +7,7 @@
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import scanner.security.config.Properties;
 
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 public class OAuthDto {
@@ -25,12 +26,20 @@ public static class GithubTokenResponse {
 	}
 
 	@Getter
-	@AllArgsConstructor
 	@NoArgsConstructor(access = AccessLevel.PROTECTED)
 	@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 	public static class GithubTokenRequest {
+		private String clientId;
 		private String clientSecret;
 		private String code;
+		private String redirectUri;
+
+		public GithubTokenRequest(Properties properties, String code) {
+			this.clientId = properties.getGithubClientId();
+			this.clientSecret = properties.getGithubClientSecret();
+			this.redirectUri = properties.getGithubRedirectUri();
+			this.code = code;
+		}
 	}
 
 	@Getter
diff --git a/src/main/java/scanner/oauth/middleware/OAuthRequestFacade.java b/src/main/java/scanner/oauth/middleware/OAuthRequestFacade.java
@@ -5,6 +5,8 @@
 import lombok.RequiredArgsConstructor;
 import scanner.common.client.OAuthFeignClient;
 import scanner.common.client.OAuthInfoFeignClient;
+import scanner.common.enums.ResponseCode;
+import scanner.common.exception.ApiAuthException;
 import scanner.oauth.dto.OAuthDto;
 import scanner.security.config.Properties;
 import scanner.security.dto.Token;
@@ -21,19 +23,28 @@ public class OAuthRequestFacade {
 
 	/**
 	 * Request Github Access Token by auth code.
-	 * @return access token in OAuthDto.GithubTokenResponse
+	 * @return access token in String
 	 */
-	public OAuthDto.GithubTokenResponse requestGithubOAuthToken(String code) {
-		OAuthDto.GithubTokenRequest tokenRequest = new OAuthDto.GithubTokenRequest(properties.getGithubClientSecret(), code);
-		return oauthFeignClient.requestGithubAccessToken(tokenRequest);
+	public String requestGithubOAuthToken(String code) {
+		OAuthDto.GithubTokenRequest tokenRequest = new OAuthDto.GithubTokenRequest(properties, code);
+		String resultString = oauthFeignClient.requestGithubAccessToken(tokenRequest);
+
+		String[] arr = resultString.split("&");
+
+		for(String s : arr) {
+			if(s.startsWith("access_token"))
+				return s;
+		}
+
+		throw new ApiAuthException(ResponseCode.INVALID_TOKEN);
 	}
 
 	/**
 	 * Request Github User info by access token.
 	 * @return user detail in OAuthDto.GithubUserDetail
 	 */
 	public OAuthDto.GithubUserDetail requestGithubUserDetail(String accessToken) {
-		return infoFeignClient.requestGithubUserDetail("Bearer " + accessToken);
+		return infoFeignClient.requestGithubUserDetail("Bearer " + accessToken.split("=")[1]);
 	}
 
 	/**
diff --git a/src/main/java/scanner/oauth/service/AuthService.java b/src/main/java/scanner/oauth/service/AuthService.java
@@ -34,9 +34,8 @@ public class AuthService {
 	 * @return user Token
 	 */
 	public Token getUserAccessToken(@NotNull String code) {
-		OAuthDto.GithubTokenResponse tokenResponse = oauthRequestFacade.requestGithubOAuthToken(code);
-		OAuthDto.GithubUserDetail userDetail = oauthRequestFacade.requestGithubUserDetail(
-			tokenResponse.getAccessToken());
+		String tokenResponse = oauthRequestFacade.requestGithubOAuthToken(code);
+		OAuthDto.GithubUserDetail userDetail = oauthRequestFacade.requestGithubUserDetail(tokenResponse);
 
 		User user = getUserIfExist(userDetail);
 
diff --git a/src/main/java/scanner/security/config/Properties.java b/src/main/java/scanner/security/config/Properties.java
@@ -25,11 +25,15 @@ public class Properties {
 	@Getter
 	private String githubClientSecret;
 
+	@Getter
+	private String githubRedirectUri;
+
 	@PostConstruct
 	public void jwtInit() {
 		this.secret = environment.getProperty("JWT_SECRET");
 		this.githubClientId = environment.getProperty("GITHUB_CLIENT_ID");
 		this.githubClientSecret = environment.getProperty("GITHUB_CLIENT_SECRET");
+		this.githubRedirectUri = environment.getProperty("GITHUB_CALLBACK");
 		log.info("JWT_SECRET is " + this.secret);
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@`
`10`	`10`	`public interface OAuthFeignClient {`
`11`	`11`
`12`	`12`	`@PostMapping(value = "/login/oauth/access_token")`
`13`		`- OAuthDto.GithubTokenResponse requestGithubAccessToken(@RequestBody OAuthDto.GithubTokenRequest tokenRequest);`
	`13`	`+ String requestGithubAccessToken(@RequestBody OAuthDto.GithubTokenRequest tokenRequest);`
`14`	`14`	`}`