Class Webhook

java.lang.Object

kr.paysync.sdk.webhook.Webhook

public final class Webhook
extends Object

웹훅 서명을 검증하고 이벤트를 읽습니다.

Webhook webhook = new Webhook(System.getenv("PAYSYNC_WEBHOOK_SECRET"));
WebhookEvent event = webhook.verify(rawBody, headers);

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_TOLERANCE	기본 허용 시각 차이입니다.
static final String	HEADER_ID
static final String	HEADER_SIGNATURE
static final String	HEADER_TIMESTAMP

Constructor Summary

Constructors

Constructor	Description
Webhook(String secret)
Webhook(String secret, Duration tolerance, Clock clock)

Method Summary

Modifier and Type	Method	Description
static WebhookEvent	parse(String body)	서명을 검증하지 않고 본문을 이벤트로 읽습니다.
String	sign(String id, Instant timestamp, String body)	테스트용 webhook-signature 값을 만듭니다.
WebhookEvent	verify(String body, @Nullable String id, @Nullable String timestamp, @Nullable String signature)	서명을 검증하고 이벤트를 읽습니다.
WebhookEvent	verify(String body, Map<String, ? extends Collection<String>> headers)	서명을 검증하고 이벤트를 읽습니다.
void	verifySignature(String body, @Nullable String id, @Nullable String timestamp, @Nullable String signature)	서명만 검증합니다.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HEADER_ID

public static final String HEADER_ID

See Also:

• Constant Field Values

HEADER_TIMESTAMP

public static final String HEADER_TIMESTAMP

See Also:

• Constant Field Values

HEADER_SIGNATURE

public static final String HEADER_SIGNATURE

See Also:

• Constant Field Values

DEFAULT_TOLERANCE

public static final Duration DEFAULT_TOLERANCE

기본 허용 시각 차이입니다. 전송 시각이 이보다 오래된 요청은 거부합니다.

Constructor Details

Webhook

public Webhook(String secret)

Parameters:

secret - 대시보드에서 확인한 웹훅 서명 키 (whsec_...)

Webhook

public Webhook(String secret,
 Duration tolerance,
 Clock clock)

Parameters:

secret - 웹훅 서명 키 (whsec_...)

tolerance - 허용할 전송 시각 차이

clock - 현재 시각

Method Details

verify

public WebhookEvent verify(String body,
 Map<String, ? extends Collection<String>> headers)

서명을 검증하고 이벤트를 읽습니다.

Parameters:

body - 받은 본문 그대로의 문자열

headers - 요청 헤더

Throws:

WebhookVerificationException - 서명이 맞지 않습니다.

verify

public WebhookEvent verify(String body,
 @Nullable String id,
 @Nullable String timestamp,
 @Nullable String signature)

서명을 검증하고 이벤트를 읽습니다.

Parameters:

body - 받은 본문 그대로의 문자열

id - webhook-id 헤더

timestamp - webhook-timestamp 헤더

signature - webhook-signature 헤더

Throws:

WebhookVerificationException - 서명이 맞지 않습니다.

verifySignature

public void verifySignature(String body,
 @Nullable String id,
 @Nullable String timestamp,
 @Nullable String signature)

서명만 검증합니다.

Throws:

WebhookVerificationException - 서명이 맞지 않습니다.

sign

public String sign(String id,
 Instant timestamp,
 String body)

테스트용 webhook-signature 값을 만듭니다.

parse

public static WebhookEvent parse(String body)

서명을 검증하지 않고 본문을 이벤트로 읽습니다.