/******************************************************************************* * Copyright 2012-2019 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. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.KeyManagementService; using Amazon.KeyManagementService.Model; namespace Amazon.PowerShell.Cmdlets.KMS { /// /// Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: /// /// /// You can use this operation to decrypt ciphertext that was encrypted under a symmetric /// encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, /// you must specify the KMS key and the encryption algorithm that was used to encrypt /// the ciphertext. For information about asymmetric KMS keys, see Asymmetric /// KMS keys in the Key Management Service Developer Guide. /// /// The Decrypt operation also decrypts ciphertext that was encrypted outside /// of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt /// symmetric ciphertext produced by other libraries, such as the Amazon /// Web Services Encryption SDK or Amazon /// S3 client-side encryption. These libraries return a ciphertext format that is /// incompatible with KMS. /// /// If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId /// parameter is optional. KMS can get this information from metadata that it adds to /// the symmetric ciphertext blob. This feature adds durability to your implementation /// by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, /// even if they've lost track of the key ID. However, specifying the KMS key is always /// recommended as a best practice. When you use the KeyId parameter to specify /// a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted /// under a different KMS key, the Decrypt operation fails. This practice /// ensures that you use the KMS key that you intend. /// /// Whenever possible, use key policies to give users permission to call the Decrypt /// operation on a particular KMS key, instead of using &IAM; policies. Otherwise, /// you might create an &IAM; policy that gives the user Decrypt permission /// on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys /// in other accounts if the key policy for the cross-account KMS key permits it. If you /// must use an IAM policy for Decrypt permissions, limit the user to particular /// KMS keys or particular trusted accounts. For details, see Best /// practices for IAM policies in the Key Management Service Developer Guide. /// Decrypt also supports Amazon /// Web Services Nitro Enclaves, which provide an isolated compute environment in /// Amazon EC2. To call Decrypt for a Nitro enclave, use the Amazon /// Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient /// parameter to provide the attestation document for the enclave. Instead of the plaintext /// data, the response includes the plaintext data encrypted with the public key from /// the attestation document (CiphertextForRecipient).For information about /// the interaction between KMS and Amazon Web Services Nitro Enclaves, see How /// Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer /// Guide.. /// /// The KMS key that you use for this operation must be in a compatible key state. For /// details, see Key /// states of KMS keys in the Key Management Service Developer Guide. /// Cross-account use: Yes. If you use the KeyId parameter to identify /// a KMS key in a different Amazon Web Services account, specify the key ARN or the alias /// ARN of the KMS key. /// Required permissions: kms:Decrypt /// (key policy) /// Related operations: /// [Cmdlet("Invoke", "KMSDecrypt")] [OutputType("Amazon.KeyManagementService.Model.DecryptResponse")] [AWSCmdlet("Calls the AWS Key Management Service Decrypt API operation.", Operation = new[] {"Decrypt"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.DecryptResponse))] [AWSCmdletOutput("Amazon.KeyManagementService.Model.DecryptResponse", "This cmdlet returns an Amazon.KeyManagementService.Model.DecryptResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class InvokeKMSDecryptCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter Recipient_AttestationDocument /// /// /// The attestation document for an Amazon Web Services Nitro Enclave. This document includes /// the enclave's public key. /// /// The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Amazon.PowerShell.Common.MemoryStreamParameterConverter] public byte[] Recipient_AttestationDocument { get; set; } #endregion #region Parameter CiphertextBlob /// /// /// Ciphertext to be decrypted. The blob includes metadata. /// /// The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service. /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Amazon.PowerShell.Common.MemoryStreamParameterConverter] public byte[] CiphertextBlob { get; set; } #endregion #region Parameter 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? DryRun { get; set; } #endregion #region Parameter EncryptionAlgorithm /// /// /// Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify /// the same algorithm that was used to encrypt the data. If you specify a different algorithm, /// the Decrypt operation fails.This parameter is required only when the ciphertext was encrypted under an asymmetric /// KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported /// algorithm that is valid for symmetric encryption KMS keys. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.KeyManagementService.EncryptionAlgorithmSpec")] public Amazon.KeyManagementService.EncryptionAlgorithmSpec EncryptionAlgorithm { get; set; } #endregion #region Parameter EncryptionContext /// /// /// Specifies the encryption context to use when decrypting the data. An encryption context /// is valid only for cryptographic /// operations with a symmetric encryption KMS key. The standard asymmetric encryption /// algorithms and HMAC algorithms that KMS uses do not support an encryption context.An encryption context is a collection of non-secret key-value pairs that represent /// additional authenticated data. When you use an encryption context to encrypt data, /// you must specify the same (an exact case-sensitive match) encryption context to decrypt /// the data. An encryption context is supported only on operations with symmetric encryption /// KMS keys. On operations with symmetric encryption KMS keys, an encryption context /// is optional, but it is strongly recommended.For more information, see Encryption /// context in the Key Management Service Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Collections.Hashtable EncryptionContext { get; set; } #endregion #region Parameter GrantToken /// /// /// 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("GrantTokens")] public System.String[] GrantToken { get; set; } #endregion #region Parameter Recipient_KeyEncryptionAlgorithm /// /// /// The encryption algorithm that KMS should use with the public key for an Amazon Web /// Services Nitro Enclave to encrypt plaintext values for the response. The only valid /// value is RSAES_OAEP_SHA_256. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.KeyManagementService.KeyEncryptionMechanism")] public Amazon.KeyManagementService.KeyEncryptionMechanism Recipient_KeyEncryptionAlgorithm { get; set; } #endregion #region Parameter KeyId /// /// /// Specifies the KMS key that KMS uses to decrypt the ciphertext.Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify /// a different KMS key, the Decrypt operation throws an IncorrectKeyException.This parameter is required only when the ciphertext was encrypted under an asymmetric /// KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from /// metadata that it adds to the symmetric ciphertext blob. However, it is always recommended /// as a best practice. This practice ensures that you use the KMS key that you intend.To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using /// an alias name, prefix it with "alias/". To specify a KMS key in a different /// Amazon Web Services account, you must use the key ARN or alias ARN.For example:To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. /// To get the alias name and alias ARN, use ListAliases. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KeyId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyManagementService.Model.DecryptResponse). /// Specifying the name of a property of type Amazon.KeyManagementService.Model.DecryptResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.CiphertextBlob = this.CiphertextBlob; #if MODULAR if (this.CiphertextBlob == null && ParameterWasBound(nameof(this.CiphertextBlob))) { WriteWarning("You are passing $null as a value for parameter CiphertextBlob which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.DryRun = this.DryRun; context.EncryptionAlgorithm = this.EncryptionAlgorithm; if (this.EncryptionContext != null) { context.EncryptionContext = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.EncryptionContext.Keys) { context.EncryptionContext.Add((String)hashKey, (String)(this.EncryptionContext[hashKey])); } } if (this.GrantToken != null) { context.GrantToken = new List(this.GrantToken); } context.KeyId = this.KeyId; context.Recipient_AttestationDocument = this.Recipient_AttestationDocument; context.Recipient_KeyEncryptionAlgorithm = this.Recipient_KeyEncryptionAlgorithm; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { System.IO.MemoryStream _CiphertextBlobStream = null; System.IO.MemoryStream _Recipient_AttestationDocumentStream = null; try { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.KeyManagementService.Model.DecryptRequest(); if (cmdletContext.CiphertextBlob != null) { _CiphertextBlobStream = new System.IO.MemoryStream(cmdletContext.CiphertextBlob); request.CiphertextBlob = _CiphertextBlobStream; } if (cmdletContext.DryRun != null) { request.DryRun = cmdletContext.DryRun.Value; } if (cmdletContext.EncryptionAlgorithm != null) { request.EncryptionAlgorithm = cmdletContext.EncryptionAlgorithm; } if (cmdletContext.EncryptionContext != null) { request.EncryptionContext = cmdletContext.EncryptionContext; } if (cmdletContext.GrantToken != null) { request.GrantTokens = cmdletContext.GrantToken; } if (cmdletContext.KeyId != null) { request.KeyId = cmdletContext.KeyId; } // populate Recipient var requestRecipientIsNull = true; request.Recipient = new Amazon.KeyManagementService.Model.RecipientInfo(); System.IO.MemoryStream requestRecipient_recipient_AttestationDocument = null; if (cmdletContext.Recipient_AttestationDocument != null) { _Recipient_AttestationDocumentStream = new System.IO.MemoryStream(cmdletContext.Recipient_AttestationDocument); requestRecipient_recipient_AttestationDocument = _Recipient_AttestationDocumentStream; } if (requestRecipient_recipient_AttestationDocument != null) { request.Recipient.AttestationDocument = requestRecipient_recipient_AttestationDocument; requestRecipientIsNull = false; } Amazon.KeyManagementService.KeyEncryptionMechanism requestRecipient_recipient_KeyEncryptionAlgorithm = null; if (cmdletContext.Recipient_KeyEncryptionAlgorithm != null) { requestRecipient_recipient_KeyEncryptionAlgorithm = cmdletContext.Recipient_KeyEncryptionAlgorithm; } if (requestRecipient_recipient_KeyEncryptionAlgorithm != null) { request.Recipient.KeyEncryptionAlgorithm = requestRecipient_recipient_KeyEncryptionAlgorithm; requestRecipientIsNull = false; } // determine if request.Recipient should be set to null if (requestRecipientIsNull) { request.Recipient = null; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } finally { if( _CiphertextBlobStream != null) { _CiphertextBlobStream.Dispose(); } if( _Recipient_AttestationDocumentStream != null) { _Recipient_AttestationDocumentStream.Dispose(); } } } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.KeyManagementService.Model.DecryptResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.DecryptRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "Decrypt"); try { #if DESKTOP return client.Decrypt(request); #elif CORECLR return client.DecryptAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public byte[] CiphertextBlob { get; set; } public System.Boolean? DryRun { get; set; } public Amazon.KeyManagementService.EncryptionAlgorithmSpec EncryptionAlgorithm { get; set; } public Dictionary EncryptionContext { get; set; } public List GrantToken { get; set; } public System.String KeyId { get; set; } public byte[] Recipient_AttestationDocument { get; set; } public Amazon.KeyManagementService.KeyEncryptionMechanism Recipient_KeyEncryptionAlgorithm { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }