Security

Security란 무엇인가요?

Nodit은 API Key외에 추가적인 보안 기능을 제공합니다. Security는 Domain Name과 Source IP를 이용해 프로젝트의 리소스에 접근할 수 있는 사용자를 식별하여 비인가된 사용자의 프로젝트 리소스 사용과 API 호출을 방지하는 기능입니다. Allowlist에 등록되지 않은 IP 또는 Domain으로부터의 요청에는 HTTP 403 Status Code와 함께 다음과 같은 메시지와 함께 에러 응답이 반환됩니다.

{
  "code": "PERMISSION_DENIED",
  "message": "Permission denied. Check your security settings and ensure your domain is allowlisted."
}

or

{
  "code": "PERMISSION_DENIED",
  "message": "Permission denied. Check your security settings and ensure your IP is allowlisted."
}

Security 설정은 어디서 할 수 있나요?

프로젝트 상세 화면에서 제공되는 Security 탭에서 Domain/IP Allowlist를 설정하고 관리할 수 있습니다.

1. Domain Name 등록하기

Domain Name을 기준으로 미인가된 Origin으로부터의 리소스 접근을 막는 방법입니다. Allowlist에 Domain Name을 추가하는 방법은 다음과 같습니다.

• [Domain Allowlist] 좌측의 토글을 클릭해 Domain Name을 이용한 보안 설정을 활성화합니다.
• 등록하는 Domain Name에 대한 간단한 설명을 [Name] 박스에 입력할 수 있습니다.(Optional)
• [Domain Name] 박스에 Domain Name을 입력합니다.
• 우측의 [Add] 버튼을 클릭해 Domain Name Allowlist에 Domain Name을 추가합니다.

Allowlist에 최대 25개의 Domain Name을 등록할 수 있으며 옵션을 활성화한 순간부터 allowlist에 등록된 Domain Name외의 Origin으로부터의 요청에는 403 에러를 반환합니다.

2. Source IP 등록하기

Source IP를 기준으로 미인가된 Origin으로부터의 리소스 접근을 막는 방법입니다. Allowlist에 IP를 추가하는 방법은 다음과 같습니다.

• [Source IP] 좌측의 토글을 클릭해 Source IP를 이용한 보안 설정을 활성화합니다.
• 등록하는 Source IP에 대한 간단한 설명을 [Name] 박스에 입력할 수 있습니다.(Optional)
• [Source IP] 박스에 IP 주소를 입력합니다.
• 우측의 [Add] 버튼을 클릭해 Source IP Allowlist에 Source IP를 추가합니다.

Source IP는 allowlist에 최대 25개 까지 등록할 수 있으며 보안을 활성화한 순간부터 allowlist에 등록된 Source IP외의 Origin으로부터의 요청에는 403 에러를 반환합니다.

❗️

Allowlist의 활성화 여부를 확인해 주세요!

Domain 혹은 Source IP Allowlist가 활성화 되어있는 경우, 등록되지 않은 Domain 혹은 Source IP에서 API를 호출하면 403 에러를 반환합니다. Security를 이용하지 않을 때에는 반드시 Allowlist의 비활성화 상태를 유지해야 정상적인 API 호출이 가능합니다.