[Documentation] 회원 기능 문서화

[this-is-spear]

요구사항

기능 요구사항

• [x] 회원 기능을 문서화합니다.
• [x] 회원가입, 로그인, 로그아웃 기능을 명세합니다.

프로그래밍 요구사항

• [x] Rest Docs로 작성합니다.
• [ ] 각 기능의 Fields에 대한 설명을 추가합니다.

[this-is-spear]

인증 정책

1. 로그인 페이지로 이동한다.(URI : /kakao/login)
2. 로그인을 진행한다.(URI : /kakao/login/callback)
   1. 사용자가 소셜 로그인을 진행해 토큰을 발급받는다.
   2. 발급받은 토큰으로 사용자의 정보를 조회하고 사용자 정보가 없는 경우 사용자 정보를 저장한다.
   3. 카카오 ID를 이용해 사용자 정보를 확인한다.
   4. 이메일을 이용해 사용자 정보를 확인한다.
   5. 카카오에 접근할 수 있는 Bearer 타입의 Access 토큰과 Refresh 토큰과 유효시간을 데이터베이스에 저장한다. (이 때, 데이터베이스는 RDBMS가 맡지만 추후, 레디스가 적용될 수 있다는 점을 고려하자)
   6. 토큰을 생성한다. 토큰안에는 데이터베이스에 저장된 사용자의 ID와 유효시간 정보가 포함되어 있다.
      1. 유효시간은 카카오 API 토큰의 유효시간을 따른다.
   7. 헤더에 토큰을 추가해 응답한다.

인가 정책

• 토큰 정보를 가져와 권한을 확인한다.
  • 토큰 정보가 없으면 익명의 사용자(Anonymous)로 판단한다.
  • 유효하지 않은 토큰이면 익명의 사용자(Anonymous)로 판단한다.
  • 토큰에서 사용자의 권한을 확인한다.
  • 토큰의 만료시간을 확인해 10 분 미만이면 토큰을 재발급해서 새로운 토큰을 발급한다.

[this-is-spear]

인증

Admin 사용자 토큰 발급

1. 로그인(/login)해 서버의 AccessCode를 발급한다.
2. AccessToken과 RefreshToken을 발급 받기 위해 AccessCode를 입력해 인증 요청(/login/token)한다.
3. AccessCode에 대한 유효성 검사를 진행한다.
4. 식별자와 권한을 담은 Access Token과 식별자와 유효시간을 담은 Refresh Token을 발급한다.

Kakao Login API 사용자 토큰 발급

1. 카카오 페이지(kakao/login)에서 로그인 한 후 서버의 AccessCode를 발급한다.
2. AccessToken과 RefreshToken을 발급 받기 위해 AccessCode를 입력해 인증 요청(/login/token)한다.
3. AccessCode에 대한 유효성 검사를 진행한다.
4. 식별자와 권한을 담은 Access Token과 식별자와 유효시간을 담은 Refresh Token을 발급한다.

토큰 갱신

1. Refresh Token을 입력해 토큰 갱신 요청(/refresh)을 한다.
2. Refresh Token 유효성 검사를 진행한다.
3. Access Token을 발급한다.

인가

토큰을 가진 사용자 접근

1. Access Token을 헤더에 입력한 요청한다.
2. Access Token 유효성 검사를 진행한다.
3. SecurityContext에 사용자 정보와 권한을 저장한다.