com.amazonaws.services.kms.model.VerifyMacRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class VerifyMacRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
*
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*
*/
private java.nio.ByteBuffer message;
/**
*
* The KMS key that will be used in the verification.
*
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
*
*/
private String keyId;
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
* the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
*
*/
private String macAlgorithm;
/**
*
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the
* same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*
*/
private java.nio.ByteBuffer mac;
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*/
private com.amazonaws.internal.SdkInternalList grantTokens;
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*/
private Boolean dryRun;
/**
*
* The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
*
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param message
* The message that will be used in the verification. Enter the same message that was used to generate the
* HMAC.
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*/
public void setMessage(java.nio.ByteBuffer message) {
this.message = message;
}
/**
*
* The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
*
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The message that will be used in the verification. Enter the same message that was used to generate the
* HMAC.
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*/
public java.nio.ByteBuffer getMessage() {
return this.message;
}
/**
*
* The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
*
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param message
* The message that will be used in the verification. Enter the same message that was used to generate the
* HMAC.
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VerifyMacRequest withMessage(java.nio.ByteBuffer message) {
setMessage(message);
return this;
}
/**
*
* The KMS key that will be used in the verification.
*
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
*
*
* @param keyId
* The KMS key that will be used in the verification.
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The KMS key that will be used in the verification.
*
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
*
*
* @return The KMS key that will be used in the verification.
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key,
* the VerifyMac operation fails.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The KMS key that will be used in the verification.
*
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
*
*
* @param keyId
* The KMS key that will be used in the verification.
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VerifyMacRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
* the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
*
*
* @param macAlgorithm
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @see MacAlgorithmSpec
*/
public void setMacAlgorithm(String macAlgorithm) {
this.macAlgorithm = macAlgorithm;
}
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
* the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
*
*
* @return The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @see MacAlgorithmSpec
*/
public String getMacAlgorithm() {
return this.macAlgorithm;
}
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
* the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
*
*
* @param macAlgorithm
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
public VerifyMacRequest withMacAlgorithm(String macAlgorithm) {
setMacAlgorithm(macAlgorithm);
return this;
}
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
* the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
*
*
* @param macAlgorithm
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
public VerifyMacRequest withMacAlgorithm(MacAlgorithmSpec macAlgorithm) {
this.macAlgorithm = macAlgorithm.toString();
return this;
}
/**
*
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the
* same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param mac
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you
* specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*/
public void setMac(java.nio.ByteBuffer mac) {
this.mac = mac;
}
/**
*
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the
* same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you
* specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*/
public java.nio.ByteBuffer getMac() {
return this.mac;
}
/**
*
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the
* same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param mac
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you
* specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VerifyMacRequest withMac(java.nio.ByteBuffer mac) {
setMac(mac);
return this;
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* @return A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
*/
public java.util.List getGrantTokens() {
if (grantTokens == null) {
grantTokens = new com.amazonaws.internal.SdkInternalList();
}
return grantTokens;
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
*/
public void setGrantTokens(java.util.Collection grantTokens) {
if (grantTokens == null) {
this.grantTokens = null;
return;
}
this.grantTokens = new com.amazonaws.internal.SdkInternalList(grantTokens);
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VerifyMacRequest withGrantTokens(String... grantTokens) {
if (this.grantTokens == null) {
setGrantTokens(new com.amazonaws.internal.SdkInternalList(grantTokens.length));
}
for (String ele : grantTokens) {
this.grantTokens.add(ele);
}
return this;
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VerifyMacRequest withGrantTokens(java.util.Collection grantTokens) {
setGrantTokens(grantTokens);
return this;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @param dryRun
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @return Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public Boolean getDryRun() {
return this.dryRun;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @param dryRun
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VerifyMacRequest withDryRun(Boolean dryRun) {
setDryRun(dryRun);
return this;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @return Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public Boolean isDryRun() {
return this.dryRun;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getMessage() != null)
sb.append("Message: ").append("***Sensitive Data Redacted***").append(",");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getMacAlgorithm() != null)
sb.append("MacAlgorithm: ").append(getMacAlgorithm()).append(",");
if (getMac() != null)
sb.append("Mac: ").append(getMac()).append(",");
if (getGrantTokens() != null)
sb.append("GrantTokens: ").append(getGrantTokens()).append(",");
if (getDryRun() != null)
sb.append("DryRun: ").append(getDryRun());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof VerifyMacRequest == false)
return false;
VerifyMacRequest other = (VerifyMacRequest) obj;
if (other.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false)
return false;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getMacAlgorithm() == null ^ this.getMacAlgorithm() == null)
return false;
if (other.getMacAlgorithm() != null && other.getMacAlgorithm().equals(this.getMacAlgorithm()) == false)
return false;
if (other.getMac() == null ^ this.getMac() == null)
return false;
if (other.getMac() != null && other.getMac().equals(this.getMac()) == false)
return false;
if (other.getGrantTokens() == null ^ this.getGrantTokens() == null)
return false;
if (other.getGrantTokens() != null && other.getGrantTokens().equals(this.getGrantTokens()) == false)
return false;
if (other.getDryRun() == null ^ this.getDryRun() == null)
return false;
if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getMacAlgorithm() == null) ? 0 : getMacAlgorithm().hashCode());
hashCode = prime * hashCode + ((getMac() == null) ? 0 : getMac().hashCode());
hashCode = prime * hashCode + ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode());
hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode());
return hashCode;
}
@Override
public VerifyMacRequest clone() {
return (VerifyMacRequest) super.clone();
}
}