Repository navigation
[Feat/#217] 운영진 로그인 API 추가 (학번·공용 비밀번호) #218
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package kr.ac.kookmin.stream.api.admin.core.auth; | ||
|
|
||
| import io.swagger.v3.oas.annotations.Operation; | ||
| import io.swagger.v3.oas.annotations.tags.Tag; | ||
| import kr.ac.kookmin.stream.api.admin.AdminApiUser; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.request.AdminLoginRequest; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.request.SharedPasswordChangeRequest; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.response.AdminLoginResponse; | ||
| import kr.ac.kookmin.stream.api.common.dto.ApiResponse; | ||
| import kr.ac.kookmin.stream.api.common.openapi.ApiErrorCode; | ||
| import kr.ac.kookmin.stream.auth.domain.admin.domain.AdminAuthErrorCode; | ||
| import kr.ac.kookmin.stream.common.CommonErrorCode; | ||
|
|
||
| /** | ||
| * 운영진 인증 API의 문서 명세. 구현은 {@link AdminAuthController}가 맡는다. | ||
| */ | ||
| @Tag(name = "운영진 인증", description = "운영진 콘솔 로그인·공용 비밀번호 관리") | ||
| public interface AdminAuthApi { | ||
|
|
||
| /** 학번 + 공용 비밀번호 로그인. 인증 없이 호출한다. */ | ||
| @Operation(summary = "운영진 로그인", | ||
| description = """ | ||
| 학번과 운영진 공용 비밀번호로 로그인한다. role이 ADMIN이고 학생회 부서가 있는 회원만 로그인할 수 있다. | ||
| 회원이 없거나, 운영진이 아니거나, 비밀번호가 틀리면 모두 INVALID_ADMIN_CREDENTIALS로 응답한다.""") | ||
| @ApiErrorCode(type = CommonErrorCode.class, codes = {"INVALID_INPUT"}) | ||
| @ApiErrorCode(type = AdminAuthErrorCode.class, codes = {"INVALID_ADMIN_CREDENTIALS"}) | ||
| ApiResponse<AdminLoginResponse> login(AdminLoginRequest request); | ||
|
|
||
| /** 공용 비밀번호 변경. 회장단만 바꿀 수 있다. */ | ||
| @Operation(summary = "운영진 공용 비밀번호 변경", | ||
| description = """ | ||
| 현재 공용 비밀번호를 확인한 뒤 새 비밀번호로 바꾼다. 회장단만 호출할 수 있다. | ||
| 새 비밀번호는 8~16자의 영문·숫자·기호만 쓸 수 있다. 이미 발급된 토큰은 만료될 때까지 그대로 쓸 수 있다.""") | ||
| @ApiErrorCode(type = CommonErrorCode.class, codes = {"INVALID_INPUT", "FORBIDDEN"}) | ||
| @ApiErrorCode(type = AdminAuthErrorCode.class, codes = {"ADMIN_PASSWORD_MISMATCH"}) | ||
| ApiResponse<Void> changeSharedPassword(AdminApiUser apiUser, SharedPasswordChangeRequest request); | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| package kr.ac.kookmin.stream.api.admin.core.auth; | ||
|
|
||
| import jakarta.validation.Valid; | ||
| import kr.ac.kookmin.stream.api.admin.AdminApiUser; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.request.AdminLoginRequest; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.request.SharedPasswordChangeRequest; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.response.AdminLoginResponse; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.usecase.AdminLoginUseCase; | ||
| import kr.ac.kookmin.stream.api.admin.core.auth.usecase.SharedPasswordChangeUseCase; | ||
| import kr.ac.kookmin.stream.api.admin.security.RequireDepartment; | ||
| import kr.ac.kookmin.stream.api.common.dto.ApiResponse; | ||
| import kr.ac.kookmin.stream.common.CouncilDepartment; | ||
| import lombok.RequiredArgsConstructor; | ||
| import org.springframework.web.bind.annotation.PostMapping; | ||
| import org.springframework.web.bind.annotation.PutMapping; | ||
| import org.springframework.web.bind.annotation.RequestBody; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RestController; | ||
|
|
||
| @RestController | ||
| @RequestMapping("/v1/admin/auth") | ||
| @RequiredArgsConstructor | ||
| public class AdminAuthController implements AdminAuthApi { | ||
|
|
||
| private final AdminLoginUseCase adminLoginUseCase; | ||
| private final SharedPasswordChangeUseCase sharedPasswordChangeUseCase; | ||
|
|
||
| @Override | ||
| @PostMapping("/login") | ||
| public ApiResponse<AdminLoginResponse> login(@Valid @RequestBody AdminLoginRequest request) { | ||
| return ApiResponse.success(adminLoginUseCase.login(request.studentId(), request.password())); | ||
| } | ||
|
|
||
| @Override | ||
| @PutMapping("/shared-password") | ||
| @RequireDepartment(CouncilDepartment.PRESIDENCY) | ||
| public ApiResponse<Void> changeSharedPassword( | ||
| AdminApiUser apiUser, | ||
| @Valid @RequestBody SharedPasswordChangeRequest request | ||
| ) { | ||
| sharedPasswordChangeUseCase.change(request.currentPassword(), request.newPassword()); | ||
| return ApiResponse.success(); | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package kr.ac.kookmin.stream.api.admin.core.auth.request; | ||
|
|
||
| import io.swagger.v3.oas.annotations.media.Schema; | ||
| import jakarta.validation.constraints.NotBlank; | ||
|
|
||
| public record AdminLoginRequest( | ||
| @Schema(description = "학번", example = "20231234") | ||
| @NotBlank(message = "학번을 입력해 주세요.") | ||
| String studentId, | ||
|
|
||
| @Schema(description = "운영진 공용 비밀번호") | ||
| @NotBlank(message = "비밀번호를 입력해 주세요.") | ||
| String password | ||
| ) { | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package kr.ac.kookmin.stream.api.admin.core.auth.request; | ||
|
|
||
| import io.swagger.v3.oas.annotations.media.Schema; | ||
| import jakarta.validation.constraints.NotBlank; | ||
| import jakarta.validation.constraints.Pattern; | ||
| import jakarta.validation.constraints.Size; | ||
|
|
||
| public record SharedPasswordChangeRequest( | ||
| @Schema(description = "현재 공용 비밀번호") | ||
| @NotBlank(message = "현재 비밀번호를 입력해 주세요.") | ||
| String currentPassword, | ||
|
|
||
| // 공백 없는 ASCII(영문 대소문자·숫자·기호)만 받는다. 16자 이하 ASCII라 BCrypt의 72바이트 제한에 걸리지 않는다 | ||
| @Schema(description = "새 공용 비밀번호 (8~16자, 영문·숫자·기호)") | ||
| @NotBlank(message = "새 비밀번호를 입력해 주세요.") | ||
| @Size(min = 8, max = 16, message = "새 비밀번호는 8~16자로 입력해 주세요.") | ||
| @Pattern(regexp = "^[\\x21-\\x7E]+$", message = "새 비밀번호는 영문·숫자·기호만 쓸 수 있습니다.") | ||
| String newPassword | ||
| ) { | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package kr.ac.kookmin.stream.api.admin.core.auth.response; | ||
|
|
||
| import kr.ac.kookmin.stream.common.CouncilDepartment; | ||
|
|
||
| public record AdminLoginResponse( | ||
| String accessToken, | ||
| String name, | ||
| CouncilDepartment councilDepartment | ||
| ) {} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| package kr.ac.kookmin.stream.api.admin.core.auth.usecase; | ||
|
|
||
| import kr.ac.kookmin.stream.api.admin.core.auth.response.AdminLoginResponse; | ||
| import kr.ac.kookmin.stream.auth.domain.admin.domain.AdminAuthConfigKeys; | ||
| import kr.ac.kookmin.stream.auth.domain.admin.domain.AdminAuthErrorCode; | ||
| import kr.ac.kookmin.stream.common.BusinessException; | ||
| import kr.ac.kookmin.stream.common.Role; | ||
| import kr.ac.kookmin.stream.internal.domain.config.service.AdminConfigValueService; | ||
| import kr.ac.kookmin.stream.member.domain.member.domain.Member; | ||
| import kr.ac.kookmin.stream.member.domain.member.service.MemberService; | ||
| import kr.ac.kookmin.stream.security.AuthTokenIssuer; | ||
| import kr.ac.kookmin.stream.security.PasswordHasher; | ||
| import lombok.RequiredArgsConstructor; | ||
| import org.springframework.stereotype.Component; | ||
|
|
||
| /** | ||
| * 학번과 운영진 공용 비밀번호로 로그인한다. role이 ADMIN이고 학생회 부서가 있는 회원만 로그인할 수 있다. | ||
| * <p> | ||
| * 실패 이유(회원 없음·운영진 아님·비밀번호 불일치)는 모두 같은 에러로 응답한다. | ||
| * 비밀번호를 회원 조회보다 먼저 확인한다. 회원이 없을 때 BCrypt 비교를 건너뛰면 응답 시간 차이로 운영진 여부가 드러나기 때문이다. | ||
| */ | ||
| @Component | ||
| @RequiredArgsConstructor | ||
| public class AdminLoginUseCase { | ||
|
|
||
| private final AdminConfigValueService adminConfigValueService; | ||
| private final MemberService memberService; | ||
| private final PasswordHasher passwordHasher; | ||
| private final AuthTokenIssuer authTokenIssuer; | ||
|
|
||
| public AdminLoginResponse login(String studentId, String password) { | ||
| validatePassword(password); | ||
| Member member = memberService.findByStudentId(studentId) | ||
| .orElseThrow(() -> new BusinessException(AdminAuthErrorCode.INVALID_ADMIN_CREDENTIALS)); | ||
| validateAdmin(member); | ||
|
|
||
| String accessToken = authTokenIssuer.issue(member.getId(), member.getRole(), member.getCouncilDepartment()); | ||
| return new AdminLoginResponse(accessToken, member.getName(), member.getCouncilDepartment()); | ||
| } | ||
|
|
||
| private void validatePassword(String password) { | ||
| // 해시가 없으면 아무도 로그인할 수 없는 운영 설정 누락이라 500으로 드러낸다 | ||
| String passwordHash = adminConfigValueService.getValue(AdminAuthConfigKeys.PASSWORD_HASH) | ||
| .orElseThrow(() -> new IllegalStateException("운영진 공용 비밀번호가 설정되지 않았습니다.")); | ||
| if (!passwordHasher.matches(password, passwordHash)) { | ||
| throw new BusinessException(AdminAuthErrorCode.INVALID_ADMIN_CREDENTIALS); | ||
| } | ||
| } | ||
|
|
||
| private void validateAdmin(Member member) { | ||
| if (member.getRole() != Role.ADMIN || member.getCouncilDepartment() == null) { | ||
| throw new BusinessException(AdminAuthErrorCode.INVALID_ADMIN_CREDENTIALS); | ||
| } | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| package kr.ac.kookmin.stream.api.admin.core.auth.usecase; | ||
|
|
||
| import kr.ac.kookmin.stream.auth.domain.admin.domain.AdminAuthConfigKeys; | ||
| import kr.ac.kookmin.stream.auth.domain.admin.domain.AdminAuthErrorCode; | ||
| import kr.ac.kookmin.stream.common.BusinessException; | ||
| import kr.ac.kookmin.stream.internal.domain.config.service.AdminConfigValueService; | ||
| import kr.ac.kookmin.stream.security.PasswordHasher; | ||
| import lombok.RequiredArgsConstructor; | ||
| import org.springframework.stereotype.Component; | ||
|
|
||
| /** | ||
| * 운영진 공용 비밀번호를 바꾼다. 현재 비밀번호가 맞을 때만 새 비밀번호의 해시로 덮어쓴다. | ||
| * 이미 발급된 토큰은 만료될 때까지 그대로 쓸 수 있다. | ||
| */ | ||
| @Component | ||
| @RequiredArgsConstructor | ||
| public class SharedPasswordChangeUseCase { | ||
|
|
||
| private final AdminConfigValueService adminConfigValueService; | ||
| private final PasswordHasher passwordHasher; | ||
|
|
||
| public void change(String currentPassword, String newPassword) { | ||
| validateCurrentPassword(currentPassword); | ||
| adminConfigValueService.upsertValue(AdminAuthConfigKeys.PASSWORD_HASH, passwordHasher.hash(newPassword)); | ||
|
Comment on lines
+22
to
+24
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| } | ||
|
|
||
| private void validateCurrentPassword(String currentPassword) { | ||
| String passwordHash = adminConfigValueService.getValue(AdminAuthConfigKeys.PASSWORD_HASH) | ||
| .orElseThrow(() -> new IllegalStateException("운영진 공용 비밀번호가 설정되지 않았습니다.")); | ||
| if (!passwordHasher.matches(currentPassword, passwordHash)) { | ||
| throw new BusinessException(AdminAuthErrorCode.ADMIN_PASSWORD_MISMATCH); | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package kr.ac.kookmin.stream.auth.domain.admin.domain; | ||
|
|
||
| // admin_config_values에 저장되는 운영진 인증 관련 키. 공용 비밀번호는 평문이 아니라 BCrypt 해시로만 저장한다. | ||
| public final class AdminAuthConfigKeys { | ||
|
|
||
| public static final String PASSWORD_HASH = "ADMIN_PASSWORD_HASH"; | ||
|
|
||
| private AdminAuthConfigKeys() {} | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| package kr.ac.kookmin.stream.auth.domain.admin.domain; | ||
|
|
||
| import kr.ac.kookmin.stream.common.ErrorCode; | ||
| import kr.ac.kookmin.stream.common.ErrorStatus; | ||
| import lombok.AllArgsConstructor; | ||
| import lombok.Getter; | ||
| import lombok.experimental.Accessors; | ||
|
|
||
| @Getter | ||
| @Accessors(fluent = true) | ||
| @AllArgsConstructor | ||
| public enum AdminAuthErrorCode implements ErrorCode { | ||
|
|
||
| // 회원 없음·운영진 아님·비밀번호 불일치를 구분하지 않는다. 학번으로 운영진 여부를 알아내지 못하게 하기 위함 | ||
| INVALID_ADMIN_CREDENTIALS(ErrorStatus.UNAUTHORIZED, "학번 또는 비밀번호가 올바르지 않습니다."), | ||
| // 로그인한 상태에서 내는 에러라 401이 아니라 400이다. 401이면 콘솔이 토큰 만료로 보고 로그아웃시킬 수 있다 | ||
| ADMIN_PASSWORD_MISMATCH(ErrorStatus.BAD_REQUEST, "현재 비밀번호가 올바르지 않습니다."); | ||
|
|
||
| private final int status; | ||
| private final String message; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| package kr.ac.kookmin.stream.security; | ||
|
|
||
| import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; | ||
| import org.springframework.security.crypto.password.PasswordEncoder; | ||
| import org.springframework.stereotype.Component; | ||
|
|
||
| /** | ||
| * 비밀번호를 BCrypt로 해시하고 비교한다. | ||
| * BCrypt 구현(spring-security-crypto)은 gateway:auth에만 있어, api 모듈이 Security 타입을 몰라도 쓰도록 여기서 감싼다. | ||
| */ | ||
| @Component | ||
| public class PasswordHasher { | ||
|
|
||
| private final PasswordEncoder passwordEncoder = new BCryptPasswordEncoder(); | ||
|
|
||
| public String hash(String rawPassword) { | ||
| return passwordEncoder.encode(rawPassword); | ||
| } | ||
|
|
||
| public boolean matches(String rawPassword, String hashedPassword) { | ||
| return passwordEncoder.matches(rawPassword, hashedPassword); | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,6 +25,9 @@ public enum PublicEndpoints { | |
| )), | ||
| AUTH(List.of( | ||
| "/v1/auth/login/*" | ||
| )), | ||
| ADMIN_AUTH(List.of( | ||
| "/v1/admin/auth/login" | ||
|
Comment on lines
+29
to
+30
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| )); | ||
|
|
||
| private static final List<PathPattern> ALL_PATH_PATTERNS = Arrays.stream(values()) | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Script executed:
Repository: billilge/stream-server
Length of output: 41562
changeSharedPassword의FORBIDDEN에러 문서화를 제거하세요.이 엔드포인트의
@ApiErrorCode에FORBIDDEN이 포함되어 있습니다. 이 코드는@RequireDepartment(CouncilDepartment.PRESIDENCY)의 부서 인가에서 발생하며, 메서드 본문에서 직접 던지지 않습니다. 에러 문서화 규칙은 부서 인가에서 비롯된FORBIDDEN을 문서화하지 않도록 정하므로, 생성되는 OpenAPI 응답에서 이 코드를 제거하세요.🐛 제안 수정
As per path instructions,
api/**/*.java의 에러 문서화 기준은 "@ApiErrorCode에는각 엔드포인트가 실제로 던지는 개별 코드만 문서화합니다. ApiUser·부서 인가에서 비롯되는 FORBIDDEN과 ... 는 문서화하지 않습니다."입니다.Committable suggestion