io.apimatic.core.security

Class HmacSignatureVerifier

java.lang.Object

io.apimatic.core.security.HmacSignatureVerifier

All Implemented Interfaces:

io.apimatic.coreinterfaces.security.SignatureVerifier

public class HmacSignatureVerifier
extends Object
implements io.apimatic.coreinterfaces.security.SignatureVerifier

HMAC-based signature verifier for HTTP requests.

Supports signature templates such as:

• Sha256={digest}
• Sha256={digest}=abc
• signature="{digest}"; ts=1690000000

The template is matched inside the header value (noise tolerated before/after).

Constructor Summary

Constructors

Constructor and Description
HmacSignatureVerifier(String secretKey, String signatureHeaderName, DigestCodec digestCodec, Function<io.apimatic.coreinterfaces.http.request.Request,byte[]> requestBytesResolver, String algorithm, String signatureValueTemplate) Initializes a new instance of the HmacSignatureVerifier class.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<io.apimatic.coreinterfaces.security.VerificationResult>	verifyAsync(io.apimatic.coreinterfaces.http.request.Request request) Verifies the HMAC signature of the specified HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Detail

HmacSignatureVerifier

public HmacSignatureVerifier(String secretKey,
                             String signatureHeaderName,
                             DigestCodec digestCodec,
                             Function<io.apimatic.coreinterfaces.http.request.Request,byte[]> requestBytesResolver,
                             String algorithm,
                             String signatureValueTemplate)

Initializes a new instance of the HmacSignatureVerifier class.

Parameters:

secretKey - Secret key for HMAC computation.

signatureHeaderName - Name of the header containing the signature.

digestCodec - Encoding type for the signature.

requestBytesResolver - Optional custom resolver for extracting data to sign.

algorithm - Algorithm (default HmacSHA256).

signatureValueTemplate - Template for signature format.

Method Detail

verifyAsync

public CompletableFuture<io.apimatic.coreinterfaces.security.VerificationResult> verifyAsync(io.apimatic.coreinterfaces.http.request.Request request)

Verifies the HMAC signature of the specified HTTP request.

Specified by:

verifyAsync in interface io.apimatic.coreinterfaces.security.SignatureVerifier

Parameters:

request - The HTTP request to verify.

Returns:

A CompletableFuture containing the verification result.