docs

http://api.teamrequin.kro.kr/swaggerdocs

ReQuiz_Backend

Auth

• 로그인
• 레지스터
• 인증
• 동일 계정 찾기

Service

• 단어장 입력
• 문제 풀기 ( 로그인 필요 없음 )
• 문제 수정 / 삭제 ( Need Auth )
• 유저 이름 검색
• 닉네임 검색

API Checklist

API Spec

• Swagger나 Redoc 등을 사용해 API를 문서화하세요.
• 표준화된 API 설계 원칙을 따르세요. (REST, GraphQL 등)
• URL rule에서 되도록이면 언더스코어(_) 대신 하이픈(-)을 사용하세요.

관례

• JSON request/response payload의 각 요소에 대한 네이밍 프로토콜은 camel case로 구성하세요.
• 데이터베이스의 모든 row/document/key-value pair에 대해 타임스탬핑하세요.

CI & CD

• 단위/통합 테스트로 설계 및 구현을 검토하세요.
• 모든 API를 테스트하세요.
• 배포를 자동화하세요.
• 코드 리뷰 절차를 사용하고 자체 승인을 무시하세요.
• 배포에 대한 롤백 솔루션을 설계하세요.

API Security Checklist

인증 (Authentication)

• Basic Auth를 사용하지 말고 표준 인증방식을 사용하세요. (예로, JWT, OAuth 등)
• 인증, 토큰 생성, 패스워드 저장은 직접 개발하지 말고 표준을 사용하세요.
• 로그인에서 Max Retry와 격리 기능을 사용하세요.
• 민감한 데이터는 모두 암호화하세요.

JWT (JSON Web Token)

• 무작위 대입 공격을 어렵게 하기 위해 랜덤하고 복잡한 키값 (JWT Secret)을 사용하세요.
• 요청 페이로드에서 알고리즘을 가져오지 마세요. 알고리즘은 백엔드에서 강제로 적용하세요. (HS256 혹은 RS256)
• 토큰 만료 기간 (TTL, RTTL)은 되도록 짧게 설정하세요.
• JWT 페이로드는 디코딩이 쉽기 때문에 민감한 데이터는 저장하지 마세요.

OAuth

• 허용된 URL만 받기 위해서는 서버 단에서 redirect_uri의 유효성을 항상 검증하세요.
• 항상 토큰 대신 코드를 주고받으세요. (response_type=token을 허용하지 마세요)
• OAuth 인증 프로세스에서 CSRF를 방지하기 위해 랜덤 해쉬값을 가진 state 파라미터를 사용하세요.
• 디폴트 스코프를 정의하고 각 애플리케이션마다 스코프 파라미터의 유효성을 검증하세요.

접근 (Access)

• DDoS나 무작위 대입 공격을 피하려면 요청 수를 제한하세요. (Throttling)
• MITM (중간자 공격)을 피하려면 서버 단에서 HTTPS를 사용하세요.
• SSL Strip 공격을 피하려면 HSTS 헤더를 SSL과 함께 사용하세요.

입력 및 요청 (Input)

• 각 요청의 연산에 맞는 적절한 HTTP 메서드를 사용하세요. GET (읽기), POST (생성), PUT (대체/갱신), DELETE (삭제). 그리고 요청 메소드가 리소스에 적합하지 않은 경우 405 Method Not Allowed로 응답하세요.
• 여러분이 지원하는 포맷 (예를 들어 application/xml이나 application/json 등)만을 허용하려면 요청의 Accept 헤더에서 content-type의 유효성을 검사하고 일치하지 않으면 406 Not Acceptable로 응답하세요.
• 요청받은 POST 데이터의 content-type을 검증하세요. (예를 들어 application/x-www-form-urlencoded나 multipart/form-data 또는 application/json 등)
• 일반적인 취약점들을 피하기 위해선 사용자 입력의 유효성을 검증하세요. (예를 들어 XSS, SQL-Injection 또는 Remote Code Execution 등)
• URL에는 그 어떤 민감한 데이터 (자격 인증 (crendentials), 패스워드, 보안 토큰 또는 API 키)도 포함하고 있어서는 안 되며 이러한 것들은 표준 인증 방식의 헤더를 사용하세요.
• 캐싱과 속도 제한 정책을 제공하는 API 게이트웨이 서비스 (예를 들어 Quota, Spike Arrest, Concurrent Rate Limit)를 사용하고, API 리소스를 동적으로 배포하세요.

서버 처리

• 인증 프로세스가 손상되는 것을 피하기 위해 모든 엔드포인트가 인증 프로세스 뒤에서 보호되고 있는지 확인하세요.
• 사용자 소유의 리소스 식별자는 피해야 합니다. /user/654321/orders 대신 /me/orders를 사용하세요.
• 자동 증가 (auto-increment) 식별자 대신 UUID를 사용하세요.
• XML 파일을 파싱하고 있다면, XXE (XML 외부 엔티티 공격, XML external entity attack)를 피하기 위해 엔티티 파싱을 비활성화하세요.
• XML 파일을 파싱하고 있다면, 지수적 엔티티 확장 공격을 통한 빌리언 러프/XML 폭탄을 피하기 위해 엔티티 확장을 비활성화하세요.
• 파일 업로드에는 CDN을 사용하세요.
• 거대한 양의 데이터를 다루고 있다면, 워커나 큐를 사용하여 가능한 한 백그라운드에서 처리하고, HTTP 블로킹을 피하기 위해 응답을 빠르게 반환하세요.
• 디버그 모드를 꺼놓는 일을 절대 잊지 마세요.

반환 및 응답 (Output)

• X-Content-Type-Options: nosniff 헤더를 반환하세요.
• X-Frame-Options: deny 헤더를 반환하세요.
• Content-Security-Policy: default-src 'none' 헤더를 반환하세요.
• X-Powered-By, Server, X-AspNet-Version 등의 디지털 지문 (fingerprinting) 성격의 헤더는 제거하세요.
• 응답에 content-type을 강제하세요. 만약 application/json 데이터를 반환하고 있다면 응답의 content-type은 application/json입니다.
• 자격 인증 (crendentials), 패스워드, 보안 토큰과 같은 민감한 데이터는 반환하지 마세요.
• 각 작업에 맞는 적절한 상태 코드를 반환하세요. (예를 들어 200 OK, 400 Bad Request, 401 Unauthorized, 405 Method Not Allowed 등)