Package com.adaptris.aws.kms

Class VerifySignatureService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.aws.kms.AWSKMSServiceImpl

com.adaptris.aws.kms.SignatureService

com.adaptris.aws.kms.VerifySignatureService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, ConnectedService, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Verify a signature using AWS KMS",
                  recommended=AWSKMSConnection.class,
                  since="3.10.1")
public class VerifySignatureService
extends SignatureService

Verify a signature using AWS KMS.

If the signature does not verify for any reason then a normal ServiceException will be thrown.

In the adapter configuration file this class is aliased as aws-kms-verify-signature which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
VerifySignatureService()

Method Summary

Modifier and Type	Method	Description
void	doService(AdaptrisMessage msg)
MessageWrapper<byte[]>	getDataToBeVerified()	The data that needs to be checked against the signature.
MessageWrapper<byte[]>	getSignature()	The source of the signature.
void	prepare()
void	setDataToBeVerified(MessageWrapper<byte[]> dataToBeVerified)	The data that needs to be checked against the signature.
void	setSignature(MessageWrapper<byte[]> signature)	The source of the signature.
VerifySignatureService	withDataToBeVerified(MessageWrapper<byte[]> w)
VerifySignatureService	withSignature(MessageWrapper<byte[]> w)

Methods inherited from class com.adaptris.aws.kms.SignatureService

extendedLogging, getExtendedLogging, getMessageType, getSigningAlgorithm, messageType, setExtendedLogging, setMessageType, setSigningAlgorithm, signingAlgorithm, withMessageType, withSigningAlgorithm

Methods inherited from class com.adaptris.aws.kms.AWSKMSServiceImpl

awsClient, closeService, getConnection, getKeyId, initService, setConnection, setKeyId, start, stop, withConnection, withKeyId

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getComments, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setComments, setContinueOnFail, setIsTrackingEndpoint, setUniqueId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Methods inherited from interface com.adaptris.core.ConfigComment

getComments, setComments

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Constructor Details

VerifySignatureService

public VerifySignatureService()

Method Details

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class AWSKMSServiceImpl

Throws:

CoreException

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Throws:

ServiceException

withSignature

public VerifySignatureService withSignature(MessageWrapper<byte[]> w)

withDataToBeVerified

public VerifySignatureService withDataToBeVerified(MessageWrapper<byte[]> w)

getSignature

public MessageWrapper<byte[]> getSignature()

The source of the signature.

Where the signature is stored; it's probably going to be a ByteArrayFromMetadata or similar.

setSignature

public void setSignature(MessageWrapper<byte[]> signature)

The source of the signature.

Where the signature is stored; it's probably going to be a ByteArrayFromMetadata or similar.

getDataToBeVerified

public MessageWrapper<byte[]> getDataToBeVerified()

The data that needs to be checked against the signature.

Since KMS enforces a 4096 byte max on the data that can be used with it; this is likely to be a hash of the payload, so again a ByteArrayFromMetadata or similar where you have previously generated a hash of the data.

setDataToBeVerified

public void setDataToBeVerified(MessageWrapper<byte[]> dataToBeVerified)

The data that needs to be checked against the signature.

Since KMS enforces a 4096 byte max on the data that can be used with it; this is likely to be a hash of the payload, so again a ByteArrayFromMetadata or similar where you have previously generated a hash of the data.