보안 이벤트 구독

이 문서는 카카오 로그인의 보안 이벤트 구독 기능 사용 방법을 안내합니다.

기능 소개

보안 이벤트 구독은 카카오 로그인 사용 서비스에 사용자의 보안 이벤트 정보를 전달하는 기능입니다. OpenID 재단의 SSE(Shared Signals and Events) 규격을 바탕으로 설계됐으며, 서비스에서 보다 적극적인 보안 조치를 취할 수 있도록 지원합니다. 예를 들면 앱 연결 및 해제, 비밀번호 변경, 비활성화와 같은 사용자의 보안 이벤트 정보를 제공받아 참고할 수 있습니다.

보안 이벤트 정보는 보안 이벤트 토큰(Security Event Token, 이하 SET) 형식으로 서비스에 전달됩니다. 서비스는 콜백 URL을 통해 전달받은 SET을 보안 이벤트 수신의 안내에 따라 처리해야 합니다.

참고: 보안 이벤트 구독 시스템의 SET 전달 과정

1. 사용자의 보안 이벤트 정보를 수신합니다.
2. 보안 이벤트 정보를 지정된 규격의 SET을 발급합니다.
3. 서비스의 콜백 URL로 SET을 푸시(Push) 전송합니다.

시작하기 전에

사용 방법

보안 이벤트 구독 기능을 사용하려면 다음 순서로 앱 설정과 기능 구현을 진행합니다.

1. 보안 이벤트 타입을 검토해 제공받을 정보 선택
2. 앱 설정
   • 보안 이벤트 구독 설정: 콜백 URL, 이벤트 타입 설정
   • 동의항목 설정: CAEP, RISC 카테고리 사용 시 필요
3. 메타데이터 조회를 통해 카카오 로그인의 보안 이벤트 구독 시스템 규격 확인
4. 콜백 URL을 통해 전달받은 SET을 검증하고 처리하는 기능 구현, 보안 이벤트 수신 참고
5. 설정 및 기능 구현이 올바른지 테스트

보안 이벤트 구독 설정

[내 애플리케이션] > [카카오 로그인] > [보안 이벤트]에서 보안 이벤트 정보를 수신할 콜백 URL과 구독할 이벤트 타입을 설정해야 합니다. 자세한 안내는 설정하기를 참고합니다.

동의항목 설정

일부 카테고리의 보안 이벤트 정보 제공에는 동의항목 설정 및 사용자 동의가 필요합니다.

메타데이터 조회

보안 이벤트 구독 시스템의 규격을 확인하려면 아래와 같이 요청합니다.

GET https://kauth.kakao.com/.well-known/sse-configuration

아래는 응답 상세 정보와 예제입니다.

HTTP/1.1 200 OK
{
    "issuer": "https://kauth.kakao.com",
    "jwks_uri": "https://kauth.kakao.com/.well-known/jwks.json",
    "delivery_methods_supported": "http://schemas.openid.net/secevent/risc/delivery-method/push"
}

보안 이벤트 타입

보안 이벤트 구독 시스템은 다음과 같은 보안 이벤트 정보를 서비스에 전달합니다.

* 기본 제공되지 않음, 동의항목 설정 참고

다음은 카테고리별 보안 이벤트 타입 목록입니다.

보안 이벤트 수신

콜백 정보

사용자의 보안 이벤트 발생 시, 보안 이벤트 정보를 서비스의 콜백 URL에 HTTP POST 요청으로 전달합니다. 콜백 요청의 헤더(Header) Content-Type은 application/secevent+jwt, 본문은 보안 이벤트 정보가 담긴 SET 값입니다.

아래는 콜백 URL로 전달되는 요청 예시입니다.

POST /kakao/events HTTP/1.1
Host: callback.example.com
Content-Type: application/secevent+jwt
Accept: application/json

eyJraWQiOiI2NjVhYmVlYzExOGRkZmMyZDNiZjNlMmFkYWU3OT...

서비스는 콜백 URL에 전달된 콜백에 대해 SET 검증 후 성공 또는 실패로 응답해야 합니다.

SET 정보

서비스는 카카오계정의 보안 이벤트 정보가 담긴 SET을 POST 메서드로 전달받습니다. SET은 JWT(JSON Web Token) 형식의 토큰으로, 다음 세 가지 영역으로 구성돼 있습니다.

SET 구성

아래는 헤더, 페이로드 영역에 포함되는 필드의 상세 정보입니다.

헤더

페이로드

Event

보안 이벤트 상세 정보

Subject

SET은 세 영역의 값을 Base64 인코딩(Encoding) 한 후 온점(.)으로 이어 붙인 하나의 문자열로 생성됩니다. 따라서 온점을 기준으로 각 영역을 분리하고, Base64 디코딩(Decoding)하여 내용을 확인할 수 있습니다. 서비스는 SET 검증 후 페이로드 내용을 확인하여 필요한 사용자 계정 보호 조치를 수행할 수 있습니다. 아래는 디코딩된 SET 헤더와 페이로드 예제입니다.

{
    "kid": "665abeec118ddfc2d3bf3e2adae799",
    "typ": "secevent+jwt",
    "alg": "RS256"
}

{
    "iss": "https://kauth.kakao.com",
    "aud": "${REST_API_KEY}",
    "sub": "${USER_ID}",
    "txm": "92a79799-3ae3-4112-8fe2-921c710daa38",
    "iat": 1674702636,
    "jti": "6a1a7a3e-b923-4eb8-886c-cbcbd1621fb0",
    "events": {
        "https://schemas.openid.net/secevent/oauth/event-type/user-linked": {
            "subject": {
                "sub": "1376016924429759243",
                "subject_type": "iss-sub",
                "iss": "https://kauth.kakao.com"
            }
        }
    }
}

SET 검증

서비스는 보안 이벤트 정보에 따른 사용자 계정 보호 조치를 수행하기 전 반드시 SET 내용을 확인하고 검증해야 합니다. 다음 순서로 SET 내용을 확인하고 검증할 수 있습니다.

1. 온점(.)을 기준으로 헤더, 페이로드, 서명을 분리
2. 페이로드를 Base64 방식으로 디코딩
3. 페이로드의 iss 값이 https://kauth.kakao.com와 일치하는지 확인
4. 페이로드의 aud 값이 서비스 앱의 REST API 키와 일치하는지 확인
5. 서명 검증

서명 검증은 다음 순서로 진행합니다.

1. 헤더를 Base64 방식으로 디코딩
2. OIDC: 공개키 목록 조회하기를 통해 카카오 인증 서버가 서명 시 사용하는 공개키 목록 조회
3. 공개키 목록에서 헤더의 kid에 해당하는 공개키 값 확인
   • 공개키는 일정 기간 캐싱(Caching)하여 사용할 것을 권장하며, 지나치게 빈번한 요청 시 요청이 차단될 수 있으므로 유의
4. JWT 서명 검증을 지원하는 라이브러리를 사용해 공개키로 서명 검증
   • 참고: OpenID Foundation, jwt.io
   • 라이브러리를 사용하지 않고 직접 서명 검증 구현 시, RFC7515 규격에 따라 서명 검증 과정 진행 가능

성공 응답

콜백 URL을 통해 SET 수신 서버가 콜백 요청을 전달받아 SET 검증에 성공한 경우, Response Body 없이 HTTP 응답 코드 202 Accepted로 응답해야 합니다. 아래 예제를 참고합니다.

HTTP/1.1 202 Accepted

실패 응답

콜백 URL을 통해 SET 수신 서버에서 콜백 요청을 전달받았으나 SET 검증에 실패한 경우, HTTP 응답코드 400 Bad Request로 응답해야 합니다. 응답 헤더의 Content-Type은 application/json이어야 하며, 본문에 JSON 형식으로 RFC8935 규격에 따라 에러 코드(err)와 사유(description)를 전달합니다. 아래 예제를 참고합니다.

HTTP/1.1 400 Bad Request 
Content-Type: application/json
{
    "err": "invalid_key",
    "description": "Key ID 12345 has been revoked."
}

실패 응답 에러 코드

테스트

[도구] > [보안 이벤트 테스트]에서 보안 이벤트 테스트 전송이 가능합니다. 해당 기능을 사용해 보안 이벤트 수신 처리가 올바르게 구현되었는지 확인할 수 있습니다.

🅐 App: 테스트 대상 앱 선택 🅑 콜백 URL: 보안 이벤트 설정을 완료한 경우, 설정된 콜백 URL 출력 🅒 카테고리: 보안 이벤트 카테고리 선택, 테스트 시에는 모든 카테고리 선택 가능 🅓 이벤트 타입: 테스트 전송할 보안 이벤트 타입 선택, 테스트 시에는 모든 타입 선택 가능

[발송]을 누르면 페이지 하단에 아래와 같은 테스트 정보가 나타납니다.

🅐 보안 이벤트 요청: 테스트 전송된 요청 전문, 콜백 URL 미설정 시 Host와 URL 미포함 예시 출력 🅑 보안 이벤트 토큰: 🅐의 요청에 포함된 SET을 디코딩한 값, header와 payload 각각 출력, 디버깅 시 참고