feat : mail authentication add

bm-agent/build.gradle

@@ -11,6 +11,7 @@ version = '1.0.0'
 
 def excludeJacocoTestCoverageReport = [
         // bmagent
+        'org/benchmarker/bmagent/consts/**',
         'org/benchmarker/bmagent/BmAgentApplication**',
         'org/benchmarker/bmagent/sse/**',
         'org/benchmarker/bmagent/consts/SystemSchedulerConst',

bm-controller/build.gradle

@@ -29,6 +29,8 @@ testlogger {
 
 // define exclude classes for Jacoco test coverage report
 def excludeJacocoTestCoverageReport = [
+        'org/benchmarker/bmcontroller/mail/service/**',
+        'org/benchmarker/bmcontroller/mail/common/**',
         'org/benchmarker/bmcontroller/home/**',
         'org/benchmarker/bmcontroller/template/**',
         'org/benchmarker/bmcontroller/prerun/**',
@@ -105,10 +107,10 @@ dependencies {
     implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-client'
 
     implementation 'org.springframework.cloud:spring-cloud-starter-kubernetes-client'
+    implementation 'org.springframework.boot:spring-boot-starter-mail' //mail
     implementation 'org.webjars:webjars-locator-core'
     implementation 'org.webjars:chartjs:2.9.3'
 
-
     implementation 'org.springframework.boot:spring-boot-starter-validation'
     asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
     testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'

bm-controller/src/main/java/org/benchmarker/bmcontroller/common/beans/RandomNumberConfig.java

@@ -0,0 +1,15 @@
+package org.benchmarker.bmcontroller.common.beans;
+
+import org.benchmarker.bmcontroller.mail.common.strategy.IRandomCodeGenerator;
+import org.benchmarker.bmcontroller.mail.common.strategy.RandomCodeGenerator;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class RandomNumberConfig {
+    @Bean
+    public IRandomCodeGenerator randomNumber() {
+        return new RandomCodeGenerator();
+    }
+
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/common/factory/EmailBodyGenerator.java

@@ -0,0 +1,6 @@
+package org.benchmarker.bmcontroller.mail.common.factory;
+
+public interface EmailBodyGenerator {
+
+    String createBody(String... args);
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/common/factory/EmailVerificationFactory.java

@@ -0,0 +1,12 @@
+package org.benchmarker.bmcontroller.mail.common.factory;
+
+public class EmailVerificationFactory implements EmailBodyGenerator {
+
+    @Override
+    public String createBody(String... args) {
+
+        String authNum = args[0];
+
+        return "안녕하세요!\n\n, 회원 가입을 위한 인증 코드를 안내드립니다. 아래의 인증 코드를 입력하여 계정을 활성화하세요:\n\n인증 코드: " + authNum;
+    }
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/common/strategy/IRandomCodeGenerator.java

@@ -0,0 +1,6 @@
+package org.benchmarker.bmcontroller.mail.common.strategy;
+
+public interface IRandomCodeGenerator {
+
+    String generateVerificationCode();
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/common/strategy/RandomCodeGenerator.java

@@ -0,0 +1,20 @@
+package org.benchmarker.bmcontroller.mail.common.strategy;
+
+import java.util.Random;
+
+public class RandomCodeGenerator implements IRandomCodeGenerator {
+
+    private static final int CODE_LENGTH = 6;
+
+    @Override
+    public String generateVerificationCode() {
+
+        Random random = new Random();
+        StringBuilder codeBuilder = new StringBuilder();
+        for (int i = 0; i < CODE_LENGTH; i++) {
+            codeBuilder.append(random.nextInt(10));
+        }
+
+        return codeBuilder.toString();
+    }
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/controller/MailController.java

@@ -0,0 +1,90 @@
+package org.benchmarker.bmcontroller.mail.controller;
+
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpSession;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.benchmarker.bmcontroller.mail.common.factory.EmailBodyGenerator;
+import org.benchmarker.bmcontroller.mail.common.factory.EmailVerificationFactory;
+import org.benchmarker.bmcontroller.mail.controller.dto.*;
+import org.benchmarker.bmcontroller.mail.service.IMailSender;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.time.LocalDateTime;
+import java.util.Objects;
+
+@Slf4j
+@RestController
+@RequestMapping("/api")
+@RequiredArgsConstructor
+public class MailController {
+
+    private final IMailSender mailSender;
+
+    @PostMapping("/mail/certification")
+    public ResponseEntity<EmailResDto> mailSend(HttpServletRequest request,
+                                                      @Valid @RequestBody EmailCertificationDto emailCertification) {
+
+        EmailBodyGenerator emailBodyGenerator = new EmailVerificationFactory();
+        EmailResDto mailResDto = mailSender.sendMail(emailCertification, emailBodyGenerator);
+
+        HttpSession session = request.getSession();
+
+        UserSessionInfo userSessionInfo = UserSessionInfo.builder()
+                .certificationCode(mailResDto.getCertificationCode())
+                .userMail(mailResDto.getMail())
+                .isVerification(false)
+                .verificationTime(LocalDateTime.now())
+                .build();
+
+        session.setAttribute("userSessionInfo", userSessionInfo);
+
+        log.info("Session data: {}", session.getAttribute("userSessionInfo").toString());
+
+        return ResponseEntity.ok(mailResDto);
+    }
+
+    @PostMapping("/mail/certification/code")
+    public ResponseEntity<EmailCodeCertificationResultDto> certificationCode(HttpServletRequest request,
+                                                                             @Valid @RequestBody EmailCodeDto emailCode) {
+
+        HttpSession session = request.getSession();
+        UserSessionInfo userSessionInfo = (UserSessionInfo) session.getAttribute("userSessionInfo");
+
+        // 세션에 userSessionInfo가 존재하지 않을 때
+        if (userSessionInfo == null) {
+
+            EmailCodeCertificationResultDto failRes = EmailCodeCertificationResultDto.builder()
+                    .status("fail")
+                    .message("Session expired or invalid. Please try again.")
+                    .build();
+
+            return ResponseEntity.ok(failRes);
+        } else {
+            if (!userSessionInfo.verificationCode(emailCode.getCode())) {
+
+                EmailCodeCertificationResultDto failRes = EmailCodeCertificationResultDto.builder()
+                        .status("fail")
+                        .message("Please enter the authentication number correctly")
+                        .build();
+
+                return ResponseEntity.ok(failRes);
+            }
+        }
+
+        EmailCodeCertificationResultDto successRes = EmailCodeCertificationResultDto.builder()
+                .status("success")
+                .message("Authentication successful!!")
+                .build();
+
+        Objects.requireNonNull(userSessionInfo).changeStatus();
+        session.setAttribute("userSessionInfo", userSessionInfo);
+
+        return ResponseEntity.ok(successRes);
+    }
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/controller/dto/EmailCertificationDto.java

@@ -0,0 +1,21 @@
+package org.benchmarker.bmcontroller.mail.controller.dto;
+
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Pattern;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class EmailCertificationDto {
+
+    @NotBlank
+    @Pattern(regexp = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", message = "Please write in email format")
+    private String email;
+
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/controller/dto/EmailCodeCertificationResultDto.java

@@ -0,0 +1,17 @@
+package org.benchmarker.bmcontroller.mail.controller.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class EmailCodeCertificationResultDto {
+
+    private String status;
+
+    private String message;
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/controller/dto/EmailCodeDto.java

@@ -0,0 +1,18 @@
+package org.benchmarker.bmcontroller.mail.controller.dto;
+
+import jakarta.validation.constraints.NotBlank;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class EmailCodeDto {
+
+    @NotBlank
+    private String code;
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/controller/dto/EmailResDto.java

@@ -0,0 +1,17 @@
+package org.benchmarker.bmcontroller.mail.controller.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class EmailResDto {
+
+    private String mail;
+
+    private String certificationCode;
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/controller/dto/UserSessionInfo.java

@@ -0,0 +1,34 @@
+package org.benchmarker.bmcontroller.mail.controller.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+import java.time.LocalDateTime;
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class UserSessionInfo {
+
+    private String certificationCode;
+
+    private String userMail;
+
+    private boolean isVerification;
+
+    private LocalDateTime verificationTime;
+
+    private LocalDateTime updateTime;
+
+    public boolean verificationCode(String code) {
+        return this.certificationCode.equals(code);
+    }
+
+    public void changeStatus() {
+        this.isVerification = !this.isVerification;
+        this.updateTime = LocalDateTime.now();
+    }
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/service/IMailSender.java

@@ -0,0 +1,10 @@
+package org.benchmarker.bmcontroller.mail.service;
+
+import org.benchmarker.bmcontroller.mail.common.factory.EmailBodyGenerator;
+import org.benchmarker.bmcontroller.mail.controller.dto.EmailCertificationDto;
+import org.benchmarker.bmcontroller.mail.controller.dto.EmailResDto;
+
+public interface IMailSender {
+
+    EmailResDto sendMail(EmailCertificationDto emailCertificationDto, EmailBodyGenerator emailBodyGenerator);
+}

bm-controller/src/main/java/org/benchmarker/bmcontroller/mail/service/impl/MailSenderImpl.java

@@ -0,0 +1,53 @@
+package org.benchmarker.bmcontroller.mail.service.impl;
+
+import jakarta.mail.MessagingException;
+import jakarta.mail.internet.MimeMessage;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.benchmarker.bmcontroller.mail.common.factory.EmailBodyGenerator;
+import org.benchmarker.bmcontroller.mail.controller.dto.EmailCertificationDto;
+import org.benchmarker.bmcontroller.mail.controller.dto.EmailResDto;
+import org.benchmarker.bmcontroller.mail.service.IMailSender;
+import org.benchmarker.bmcontroller.mail.common.strategy.IRandomCodeGenerator;
+import org.springframework.mail.javamail.JavaMailSender;
+import org.springframework.mail.javamail.MimeMessageHelper;
+import org.springframework.stereotype.Service;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class MailSenderImpl implements IMailSender {
+
+    private final JavaMailSender javaMailSender;
+
+    private final IRandomCodeGenerator randomNumber;
+
+    @Override
+    public EmailResDto sendMail(EmailCertificationDto emailCertificationDto, EmailBodyGenerator emailBodyGenerator) {
+        String authNum = randomNumber.generateVerificationCode();
+
+        String subject = "회원 가입 인증 코드";
+        String body = emailBodyGenerator.createBody(authNum);
+
+        log.info("Start mail sender!!");
+        try {
+            MimeMessage mimeMessage = javaMailSender.createMimeMessage();
+            MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, false, "UTF-8");
+            mimeMessageHelper.setTo(emailCertificationDto.getEmail()); // 메일 수신자
+            mimeMessageHelper.setSubject(subject); // 메일 제목
+            mimeMessageHelper.setText(body, false); // 메일 본문 내용, HTML 여부
+
+            javaMailSender.send(mimeMessage);
+
+        } catch (MessagingException e) {
+            log.info("Mail sender fail!!");
+            throw new RuntimeException(e);
+        }
+
+        return EmailResDto.builder()
+                .mail(emailCertificationDto.getEmail())
+                .certificationCode(authNum)
+                .build();
+    }
+
+}

bm-controller/src/main/resources/application.yaml

@@ -38,6 +38,17 @@ spring:
         jdbc:
           time_zone: UTC
           batch_size: 50
+  mail:
+    host: smtp.gmail.com
+    port: 587
+    username: 'apple4rhk'
+    password: 'rdndiwbefqkbvnau'
+    properties:
+      mail:
+        debug: true
+        smtp.auth: true
+        smtp.timeout: 50000
+        smtp.starttls.enable: true
   data:
     redis:
       host: localhost