com.nimbusds.jose.aws.kms.crypto.impl

Class KmsAsymmetricRSASSAProvider

java.lang.Object

com.nimbusds.jose.crypto.impl.BaseJWSProvider

com.nimbusds.jose.aws.kms.crypto.impl.KmsAsymmetricRSASSAProvider

All Implemented Interfaces:

com.nimbusds.jose.jca.JCAAware<com.nimbusds.jose.jca.JCAContext>, com.nimbusds.jose.JOSEProvider, com.nimbusds.jose.JWSProvider

Direct Known Subclasses:

KmsAsymmetricRSASSASigner, KmsAsymmetricRSASSAVerifier

public abstract class KmsAsymmetricRSASSAProvider
extends com.nimbusds.jose.crypto.impl.BaseJWSProvider

This class provides cryptography support for RSA-SSA based signing/verification with keys stored in AWS KMS.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<com.nimbusds.jose.JWSAlgorithm,java.lang.String>	JWS_ALGORITHM_TO_MESSAGE_DIGEST_ALGORITHM
static java.util.Set<com.nimbusds.jose.JWSAlgorithm>	SUPPORTED_ALGORITHMS The supported JWS algorithms (alg) by the RSA-SSA provider class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KmsAsymmetricRSASSAProvider(@NonNull com.amazonaws.services.kms.AWSKMS kms, @NonNull java.lang.String privateKeyId, @NonNull com.amazonaws.services.kms.model.MessageType messageType)

Method Summary

Modifier and Type	Method and Description
protected @NonNull com.amazonaws.services.kms.AWSKMS	getKms() AWS-KMS client.
protected java.nio.ByteBuffer	getMessage(com.nimbusds.jose.JWSHeader header, byte[] payloadBytes)
protected @NonNull com.amazonaws.services.kms.model.MessageType	getMessageType() KMS Message Type.
protected @NonNull java.lang.String	getPrivateKeyId() KMS private-key (CMK) ID (it can be a key ID, key ARN, key alias or key alias ARN)

Methods inherited from class com.nimbusds.jose.crypto.impl.BaseJWSProvider

getJCAContext, supportedJWSAlgorithms

Methods inherited from class java.lang.Object

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

Field Detail

JWS_ALGORITHM_TO_MESSAGE_DIGEST_ALGORITHM

public static final java.util.Map<com.nimbusds.jose.JWSAlgorithm,java.lang.String> JWS_ALGORITHM_TO_MESSAGE_DIGEST_ALGORITHM

SUPPORTED_ALGORITHMS

public static final java.util.Set<com.nimbusds.jose.JWSAlgorithm> SUPPORTED_ALGORITHMS

The supported JWS algorithms (alg) by the RSA-SSA provider class. Note: We are using KMS prescribed algorithm names here. Ref: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html#key-spec-rsa-sign

Constructor Detail

KmsAsymmetricRSASSAProvider

protected KmsAsymmetricRSASSAProvider(@NonNull
                                      @NonNull com.amazonaws.services.kms.AWSKMS kms,
                                      @NonNull
                                      @NonNull java.lang.String privateKeyId,
                                      @NonNull
                                      @NonNull com.amazonaws.services.kms.model.MessageType messageType)

Method Detail

getMessage

protected java.nio.ByteBuffer getMessage(com.nimbusds.jose.JWSHeader header,
                                         byte[] payloadBytes)
                                  throws com.nimbusds.jose.JOSEException

Throws:

com.nimbusds.jose.JOSEException

getKms

@NonNull
protected @NonNull com.amazonaws.services.kms.AWSKMS getKms()

AWS-KMS client.

getPrivateKeyId

@NonNull
protected @NonNull java.lang.String getPrivateKeyId()

KMS private-key (CMK) ID (it can be a key ID, key ARN, key alias or key alias ARN)

getMessageType

@NonNull
protected @NonNull com.amazonaws.services.kms.model.MessageType getMessageType()

KMS Message Type. Refer KMS's sign and verify APIs for details. Ref: https://docs.aws.amazon.com/kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType