최초 커밋!

This commit is contained in:
kangsunlee
2025-05-27 16:34:20 +09:00
parent 3b8247ecd9
commit 5a66c0542b
1445 changed files with 65703 additions and 65 deletions

View File

@@ -0,0 +1,39 @@
# **ADR-001:** 사용자 인증 및 정보 보안 정책
## Context
스프링 시큐리티를 이용하는 것만으로도 실제 업계에서 요구하는 주요 보안점검 항목들이 상당부분 충족된다.
보안을 중시하는 기업형 어플리케이션을 제작하는데 필요한 몇가지 추가 요구조건들을 구현해 놓으면, 추후 프로젝트를 수행하는데 큰 도움이 된다.
## Decision
스프링 시큐리티의 기본 정책 이외에 필드에서 요구되는 주요한 요구 항목을 아래와 같이 정의한다.
* 패스워드 유효기간은 사용자 설정을 따른다.
* 패스워드 만료 몇일전 부터 안내 메시지를 보여줄지는 사용자 설정을 따른다.
* 관리자는 disabled 필드를 이용해 특정 사용자의 비활성화 여부를 관리한다.
* 패스워드 5회 이상 오류 시 locked 필드를 이용해 사용자는 잠김처리 된다.
* 중복 로그인 허용 횟수는 사용자 설정을 따른다.
* 로그인 세션 유지 기간은 사용자 설정을 따른다.
## Status
`Accepted`
## Consequence
현재 구현된 항목은 아래와 같다.
* 패스워드 유효기간 설정 (90일)
- `app.admin.password.validity.period.days=90`
- -1 을 줄 경우 유효기간 체크를 하지 않는다.
* 패스워드 유효기간 만료 7일전 부터 안내 메시지 보이기
- `app.admin.password.change.notice.period.days=7`
* 관리자는 disabled 필드를 이용해 특정 사용자의 비활성화 여부를 관리한다.
* 패스워드 5회 이상 오류 시 locked 필드를 이용해 사용자는 잠김처리 된다.
- `app.admin.auth.fail.permit=5`
- 잠김 처리 시 사용자가 패스워드를 초기화하는 기능은 아직 구현되지 않았다. 현재는 관리자에게 문의하라는 메세지를 보여준다.
* 중복 로그인 허용 횟수는 유동적으로 조절이 가능하다.
- `app.admin.session.maximum.num=1`
- max 가 1인 경우 중복 로그인이 발생하면 이전 세션을 차단하고 로그인 한다는 메세지가 사용자에게 보여진다.
* 로그인 세션 유지 기간 설정이 가능하다.
- `app.admin.session.validity.period.seconds=3600`

View File

@@ -0,0 +1,66 @@
# **ADR-002:** 파일 업로드 및 참조 정책
## Context
사용자가 업로드한 파일은 전체 공개(public)를 목적으로 한다. 업로드한 파일을 참조하는데 두가지 방식이 있다. 파일 참조 시
브라우저 기본 기능이나 연결 프로그램을 통해 파일이 오픈되는 `INLINE` 방식과
외부 간섭없이 다이렉트 파일 다운로드를 수행하는 `ATTACHMENT` 방식이다.
## Decision
`path.upload.public` 설정을 통해 업로드 경로를 지정한다.
```properties
path.upload.public=${user.home}/upload/public
```
INLINE 파일 참조 URL 은 아래 형식으로 구성된다.
```
/content-disposition/inline/파일경로/파일명.확장자
```
ATTACHMENT 파일 참조 URL 은 아래 형식으로 구성된다.
```
/content-disposition/attachment/파일아이디
```
## Status
`Accepted`
## Consequence
### WAS 의 `Public` `INLINE` 참조 방식 설정
`Public` 공개 범위의 `INLINE` 업로드 경로를 리소스 핸들러로 지정했다.
```java
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry
.addResourceHandler("/content-disposition/inline/**")
.addResourceLocations("file:///" + publicPath + "/")
.setCachePeriod(20);
}
```
* 위 경로에 업로드된 파일은 스프링 @Controller 를 거치지 않고, URL 로 직접 참조가 가능하다.
* 웹서버가 없는 로컬 개발환경에서 테스트하기 적합하다.
### 웹서버의 `Public` `INLINE` 참조 방식 설정
웹서버의 경우, 가상 호스트 설정에서 Alias 를 이용해 `/content-disposition/inline` 경로와 `Public` 업로드 경로를
연결해주면 된다. `<Directory/>` 선언을 추가해서 웹서버가 해당 디렉토리로 접근할 수 있는 권한을 부여한다.
```
JkUnMount /content-disposition/inline/* [워커 이름]
Alias /content-disposition/inline "[Public 업로드 경로]"
<Directory "[Public 업로드 경로]">
Options FollowSymLinks
AllowOverride All
Require all granted
Allow from all
</Directory>
```
* `JkUnMount` 를 지정해 해당 경로의 자원을 WAS 가 아닌 웹서버가 전달하도록 설정한다.
### WAS 의 `ATTACHMENT` 참조 방식 설정
`ATTACHMENT` 참조 방식은 웹서버가 아닌 WAS 에서만 처리 가능하다.
`GetAttachmentController` 가 해당 역할을 담당한다.

View File

@@ -0,0 +1,41 @@
# **ADR-003:** AWS S3 파일 업로드 전략
## Context
로컬 스토리지를 이용해 파일을 업로드하는 기본 전략 (참고: [ADR-002-FILE_UPLOAD_POLICY.md](./ADR-002-FILE_UPLOAD_POLICY.md)) 이외에 AWS S3 로
파일을 올리고 CloudFront 를 통해 파일이 제공되는 새로운 전략이 필요했다.
## Decision
AWS S3 파일 업로드 기능 제공을 위해 새로운 전략을 구현한다.
새로운 전략은 기존과 동일한 파일 업로드 서비스 인터페이스를 이용하며,
`Public`, `Private` 공개범위를 가진다.
공개범위에 따른 `INLINE`, `ATTACHMENT` 응답 해더는 구현 가능한 범위 내에서 한정적으로 제공한다.
## Status
`Accepted`
## Consequence
`aws` maven 서브 모듈이 추가되었다. S3 파일 업로드 전략과 CloudFront 도메인으로 파일을 참조하는 전략을 담고 있다.
(훗날 새로운 AWS 기능이 필요하면 이 모듈에 추가될 것이다.)
S3 업로드가 필요하다면 `aws` 모듈을 종속성에 추가해주면 된다.
```xml
<dependency>
<groupId>app.module</groupId>
<artifactId>aws</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
```
`aws` 모듈의 `aws.properties` 와 `aws-{spring.active.profile}.properties` 에
S3와 CloudFront 를 이용하기 위한 설정 정보를 기입해야 한다.
`Content-Disposition` 은 `INLINE` 참조 방식만 제공한다.
| 공개 범위 | Content-Disposition | URL |
|---|---|---|
| `Public` | `INLINE` | ${app.aws.s3.domain}/파일경로/파일명.확장자
| | `ATTACHMENT` | /content-disposition/attachment/{파일아이디}