/* * Copyright 2010-2023 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; public class SignResult implements Serializable { /** *

* The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the * message. *

* Constraints:
* Length: 1 - 2048
*/ private String keyId; /** *

* The cryptographic signature that was generated for the message. *

*
* When used with the supported RSA signing algorithms, the encoding of this * value is defined by PKCS #1 * in RFC 8017. *
*
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384 * , or ECDSA_SHA_512 signing algorithms, this value is a * DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section * 2.2.3. This is the most commonly used signature format and is * appropriate for most uses. *
*

* When you use the HTTP API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

* Constraints:
* Length: 1 - 6144
*/ private java.nio.ByteBuffer signature; /** *

* The signing algorithm that was used to sign the message. *

* Constraints:
* Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, * RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, * RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512, * SM2DSA */ private String signingAlgorithm; /** *

* The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the * message. *

* Constraints:
* Length: 1 - 2048
* * @return

* The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the * message. *

*/ public String getKeyId() { return keyId; } /** *

* The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the * message. *

* Constraints:
* Length: 1 - 2048
* * @param keyId

* The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign * the message. *

*/ public void setKeyId(String keyId) { this.keyId = keyId; } /** *

* The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the * message. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2048
* * @param keyId

* The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign * the message. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SignResult withKeyId(String keyId) { this.keyId = keyId; return this; } /** *

* The cryptographic signature that was generated for the message. *

*
* When used with the supported RSA signing algorithms, the encoding of this * value is defined by PKCS #1 * in RFC 8017. *
*
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384 * , or ECDSA_SHA_512 signing algorithms, this value is a * DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section * 2.2.3. This is the most commonly used signature format and is * appropriate for most uses. *
*

* When you use the HTTP API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

* Constraints:
* Length: 1 - 6144
* * @return

* The cryptographic signature that was generated for the message. *

*
* When used with the supported RSA signing algorithms, the encoding * of this value is defined by PKCS #1 in RFC * 8017. *
*
*
* When used with the ECDSA_SHA_256, * ECDSA_SHA_384, or ECDSA_SHA_512 signing * algorithms, this value is a DER-encoded object as defined by ANSI * X9.62–2005 and RFC 3279 * Section 2.2.3. This is the most commonly used signature * format and is appropriate for most uses. *
*

* When you use the HTTP API or the Amazon Web Services CLI, the * value is Base64-encoded. Otherwise, it is not Base64-encoded. *

*/ public java.nio.ByteBuffer getSignature() { return signature; } /** *

* The cryptographic signature that was generated for the message. *

*
* When used with the supported RSA signing algorithms, the encoding of this * value is defined by PKCS #1 * in RFC 8017. *
*
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384 * , or ECDSA_SHA_512 signing algorithms, this value is a * DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section * 2.2.3. This is the most commonly used signature format and is * appropriate for most uses. *
*

* When you use the HTTP API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

* Constraints:
* Length: 1 - 6144
* * @param signature

* The cryptographic signature that was generated for the * message. *

*
* When used with the supported RSA signing algorithms, the * encoding of this value is defined by PKCS #1 in RFC * 8017. *
*
*
* When used with the ECDSA_SHA_256, * ECDSA_SHA_384, or ECDSA_SHA_512 * signing algorithms, this value is a DER-encoded object as * defined by ANSI X9.62–2005 and RFC * 3279 Section 2.2.3. This is the most commonly used * signature format and is appropriate for most uses. *
*

* When you use the HTTP API or the Amazon Web Services CLI, the * value is Base64-encoded. Otherwise, it is not Base64-encoded. *

*/ public void setSignature(java.nio.ByteBuffer signature) { this.signature = signature; } /** *

* The cryptographic signature that was generated for the message. *

*
* When used with the supported RSA signing algorithms, the encoding of this * value is defined by PKCS #1 * in RFC 8017. *
*
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384 * , or ECDSA_SHA_512 signing algorithms, this value is a * DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section * 2.2.3. This is the most commonly used signature format and is * appropriate for most uses. *
*

* When you use the HTTP API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 6144
* * @param signature

* The cryptographic signature that was generated for the * message. *

*
* When used with the supported RSA signing algorithms, the * encoding of this value is defined by PKCS #1 in RFC * 8017. *
*
*
* When used with the ECDSA_SHA_256, * ECDSA_SHA_384, or ECDSA_SHA_512 * signing algorithms, this value is a DER-encoded object as * defined by ANSI X9.62–2005 and RFC * 3279 Section 2.2.3. This is the most commonly used * signature format and is appropriate for most uses. *
*

* When you use the HTTP API or the Amazon Web Services CLI, the * value is Base64-encoded. Otherwise, it is not Base64-encoded. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SignResult withSignature(java.nio.ByteBuffer signature) { this.signature = signature; return this; } /** *

* The signing algorithm that was used to sign the message. *

* @see SigningAlgorithmSpec */ public String getSigningAlgorithm() { return signingAlgorithm; } /** *

* The signing algorithm that was used to sign the message. *

* @see SigningAlgorithmSpec */ public void setSigningAlgorithm(String signingAlgorithm) { this.signingAlgorithm = signingAlgorithm; } /** *

* The signing algorithm that was used to sign the message. *

* Returns a reference to this object so that method calls can be chained * together. *

* The signing algorithm that was used to sign the message. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SigningAlgorithmSpec */ public SignResult withSigningAlgorithm(String signingAlgorithm) { this.signingAlgorithm = signingAlgorithm; return this; } /** *

* The signing algorithm that was used to sign the message. *

* @see SigningAlgorithmSpec */ public void setSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm) { this.signingAlgorithm = signingAlgorithm.toString(); } /** *

* The signing algorithm that was used to sign the message. *

* Returns a reference to this object so that method calls can be chained * together. *

* The signing algorithm that was used to sign the message. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SigningAlgorithmSpec */ public SignResult withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm) { this.signingAlgorithm = signingAlgorithm.toString(); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getKeyId() != null) sb.append("KeyId: " + getKeyId() + ","); if (getSignature() != null) sb.append("Signature: " + getSignature() + ","); if (getSigningAlgorithm() != null) sb.append("SigningAlgorithm: " + getSigningAlgorithm()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getSignature() == null) ? 0 : getSignature().hashCode()); hashCode = prime * hashCode + ((getSigningAlgorithm() == null) ? 0 : getSigningAlgorithm().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SignResult == false) return false; SignResult other = (SignResult) obj; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getSignature() == null ^ this.getSignature() == null) return false; if (other.getSignature() != null && other.getSignature().equals(this.getSignature()) == false) return false; if (other.getSigningAlgorithm() == null ^ this.getSigningAlgorithm() == null) return false; if (other.getSigningAlgorithm() != null && other.getSigningAlgorithm().equals(this.getSigningAlgorithm()) == false) return false; return true; } }