com.box.sdk

Class BoxWebHookSignatureVerifier

Object

BoxWebHookSignatureVerifier

public class BoxWebHookSignatureVerifier
extends Object

Signature verifier for Webhook Payload.

Since:

2.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxWebHookSignatureVerifier.BoxSignatureAlgorithm Box Signature Algorithms.

Constructor Summary

Constructors

Constructor and Description
BoxWebHookSignatureVerifier(String primarySignatureKey, String secondarySignatureKey) Creates a new instance of verifier specified with given primary and secondary keys.

Method Summary

Modifier and Type	Method and Description
String	sign(BoxWebHookSignatureVerifier.BoxSignatureAlgorithm algorithm, String key, String webHookPayload, String deliveryTimestamp) Calculates signature for a provided information.
boolean	verify(String signatureVersion, String signatureAlgorithm, String primarySignature, String secondarySignature, String webHookPayload, String deliveryTimestamp) Verifies given web-hook information.

Methods inherited from class Object

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

Constructor Detail

BoxWebHookSignatureVerifier

public BoxWebHookSignatureVerifier(String primarySignatureKey,
                                   String secondarySignatureKey)

Creates a new instance of verifier specified with given primary and secondary keys. Primary key and secondary key are needed for rotating purposes, at least at one has to be valid.

Parameters:

primarySignatureKey - primary signature key for web-hooks (can not be null)

secondarySignatureKey - secondary signature key for web-hooks (can be null)

Throws:

IllegalArgumentException - primary key can not be null

Method Detail

verify

public boolean verify(String signatureVersion,
                      String signatureAlgorithm,
                      String primarySignature,
                      String secondarySignature,
                      String webHookPayload,
                      String deliveryTimestamp)

Verifies given web-hook information.

Parameters:

signatureVersion - signature version received from web-hook

signatureAlgorithm - signature algorithm received from web-hook

primarySignature - primary signature received from web-hook

secondarySignature - secondary signature received from web-hook

webHookPayload - payload of web-hook

deliveryTimestamp - devilery timestamp received from web-hook

Returns:

true, if given payload is successfully verified against primary and secondary signatures, false otherwise

sign

public String sign(BoxWebHookSignatureVerifier.BoxSignatureAlgorithm algorithm,
                   String key,
                   String webHookPayload,
                   String deliveryTimestamp)

Calculates signature for a provided information.

Parameters:

algorithm - for which algorithm

key - used by signing

webHookPayload - for singing

deliveryTimestamp - for signing

Returns:

calculated signature