`POST /signup`のエンドポイントの実装

[K-Kizuku]

ユーザー作成のエンドポイントを実装する nameとpasswordをリクエストで受け取って、jwt tokenとtoken typeを返す感じで。 FireStoreで使えない文字等があるので、そのバリデーション処理も https://firebase.google.com/docs/firestore/quotas?hl=ja#collections_documents_and_fields

[rayfiyo]

https://github.com/c3-kotatsuneko/backend/issues/1

リクエストのサンプル

• POST

{
  "name": "user_name",
  "password": "H0ge"
}

リクエストの型

{
  "name": string,
  "password": string
}

レスポンスのサンプル

• （token_type は Bearer認証，Basic認証 などを書く）

{
  "token_type": "Bearer",
  "jwt_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMzUwOTc3Ny1hNGRlLTQ3MjItYWI2Yi00NzZlYTRmZDU2YjkiLCJuYW1lIjoidXNlcl9uYW1lIiwiaWF0IjoxNjkzOTA2ODIwLCJleHAiOjk5OTk5OTk5OTl9.r2nd7bbyOqTW3hNVF7oSfYWjODzlm9Uj_gMlZ-0MA5M"
}

JWTのクレームのサンプル

• HEADER

{
  "alg": "HS256",
  "typ": "JWT"
}

• PAYLOAD

{
  "sub": "13509777-a4de-4722-ab6b-476ea4fd56b9",
  "name": "user_name",
  "iat": 1693906820
}

• VERIFY SIGNATURE

HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret
)

レスポンスの型

ステータスコード: 200

• 成功

{
  "token_type": string,
  "jwt_token": string
}

ステータスコード: 400

• 失敗
• Bad Request
  • 空のリクエスト
  • フォーマットが無効

{
  "error": "bad_request",
  "message": "リクエストが不適切"
}

ステータスコード: 401

• 失敗
  • 失敗の原因は秘匿
• Unauthorized

{
  "error": "invalid_credentials",
  "message": "ユーザ名またはパスワードが無効"
}

例外処理

• UTF-8 ではない文字
• 1,500 バイト超過の文字
  • 100文字超えるユーザー名必要になること少なそうだから最大長を 100文字 に制 限
  • ユーザー名最大長: 100文字
• 特殊な記号
  • /
  • *
  • . のみ
  • .. のみ
• パスワードの長さ
  • 最大長: 72 byte
• ユーザー名の重複