/******************************************************************************* * 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 and then reencrypts it entirely within KMS. You can use this operation /// to change the KMS key under which data is encrypted, such as when you manually /// rotate a KMS key or change the KMS key that protects a ciphertext. You can also /// use it to reencrypt ciphertext under the same KMS key, such as to change the encryption /// context of a ciphertext. /// /// /// /// The ReEncrypt operation can decrypt ciphertext that was encrypted by /// using a KMS key in an KMS operation, such as Encrypt or GenerateDataKey. /// It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric /// KMS key outside of KMS. However, it cannot decrypt 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. /// /// When you use the ReEncrypt operation, you need to provide information /// for the decrypt operation and the subsequent encrypt operation. /// /// 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. The source KMS key and destination KMS key can be /// in different Amazon Web Services accounts. Either or both KMS keys can be in a different /// account than the caller. To specify a KMS key in a different account, you must use /// its key ARN or alias ARN. /// Required permissions: /// /// To permit reencryption from or to a KMS key, include the "kms:ReEncrypt*" /// permission in your key /// policy. This permission is automatically included in the key policy when you use /// the console to create a KMS key. But you must include it manually when you create /// a KMS key programmatically or when you use the PutKeyPolicy operation to set /// a key policy. /// Related operations: /// [Cmdlet("Invoke", "KMSReEncrypt", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.KeyManagementService.Model.ReEncryptResponse")] [AWSCmdlet("Calls the AWS Key Management Service ReEncrypt API operation.", Operation = new[] {"ReEncrypt"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.ReEncryptResponse))] [AWSCmdletOutput("Amazon.KeyManagementService.Model.ReEncryptResponse", "This cmdlet returns an Amazon.KeyManagementService.Model.ReEncryptResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class InvokeKMSReEncryptCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { #region Parameter CiphertextBlob /// /// /// Ciphertext of the data to reencrypt. /// /// 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 DestinationEncryptionAlgorithm /// /// /// Specifies the encryption algorithm that KMS will use to reecrypt the data after it /// has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the /// encryption algorithm used for symmetric encryption KMS keys.This parameter is required only when the destination KMS key is an asymmetric KMS /// key. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.KeyManagementService.EncryptionAlgorithmSpec")] public Amazon.KeyManagementService.EncryptionAlgorithmSpec DestinationEncryptionAlgorithm { get; set; } #endregion #region Parameter DestinationEncryptionContext /// /// /// Specifies that encryption context to use when the reencrypting the data.Do not include confidential or sensitive information in this field. This field may /// be displayed in plaintext in CloudTrail logs and other output.A destination encryption context is valid only when the destination KMS key is a symmetric /// encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not /// include fields for metadata.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 DestinationEncryptionContext { get; set; } #endregion #region Parameter DestinationKeyId /// /// /// A unique identifier for the KMS key that is used to reencrypt the data. Specify a /// symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage /// value of ENCRYPT_DECRYPT. To find the KeyUsage value of /// a KMS key, use the DescribeKey operation.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. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String DestinationKeyId { 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 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 SourceEncryptionAlgorithm /// /// /// Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before /// it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the /// algorithm used for symmetric encryption KMS keys.Specify the same algorithm that was used to encrypt the ciphertext. If you specify /// a different algorithm, the decrypt attempt fails.This parameter is required only when the ciphertext was encrypted under an asymmetric /// KMS key. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.KeyManagementService.EncryptionAlgorithmSpec")] public Amazon.KeyManagementService.EncryptionAlgorithmSpec SourceEncryptionAlgorithm { get; set; } #endregion #region Parameter SourceEncryptionContext /// /// /// Specifies the encryption context to use to decrypt the ciphertext. Enter the same /// encryption context that was used to encrypt the ciphertext.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 SourceEncryptionContext { get; set; } #endregion #region Parameter SourceKeyId /// /// /// Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify /// a different KMS key, the ReEncrypt 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 SourceKeyId { 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.ReEncryptResponse). /// Specifying the name of a property of type Amazon.KeyManagementService.Model.ReEncryptResponse 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 #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.DestinationKeyId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Invoke-KMSReEncrypt (ReEncrypt)")) { return; } 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.DestinationEncryptionAlgorithm = this.DestinationEncryptionAlgorithm; if (this.DestinationEncryptionContext != null) { context.DestinationEncryptionContext = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.DestinationEncryptionContext.Keys) { context.DestinationEncryptionContext.Add((String)hashKey, (String)(this.DestinationEncryptionContext[hashKey])); } } context.DestinationKeyId = this.DestinationKeyId; #if MODULAR if (this.DestinationKeyId == null && ParameterWasBound(nameof(this.DestinationKeyId))) { WriteWarning("You are passing $null as a value for parameter DestinationKeyId 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; if (this.GrantToken != null) { context.GrantToken = new List(this.GrantToken); } context.SourceEncryptionAlgorithm = this.SourceEncryptionAlgorithm; if (this.SourceEncryptionContext != null) { context.SourceEncryptionContext = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.SourceEncryptionContext.Keys) { context.SourceEncryptionContext.Add((String)hashKey, (String)(this.SourceEncryptionContext[hashKey])); } } context.SourceKeyId = this.SourceKeyId; // 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; try { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.KeyManagementService.Model.ReEncryptRequest(); if (cmdletContext.CiphertextBlob != null) { _CiphertextBlobStream = new System.IO.MemoryStream(cmdletContext.CiphertextBlob); request.CiphertextBlob = _CiphertextBlobStream; } if (cmdletContext.DestinationEncryptionAlgorithm != null) { request.DestinationEncryptionAlgorithm = cmdletContext.DestinationEncryptionAlgorithm; } if (cmdletContext.DestinationEncryptionContext != null) { request.DestinationEncryptionContext = cmdletContext.DestinationEncryptionContext; } if (cmdletContext.DestinationKeyId != null) { request.DestinationKeyId = cmdletContext.DestinationKeyId; } if (cmdletContext.DryRun != null) { request.DryRun = cmdletContext.DryRun.Value; } if (cmdletContext.GrantToken != null) { request.GrantTokens = cmdletContext.GrantToken; } if (cmdletContext.SourceEncryptionAlgorithm != null) { request.SourceEncryptionAlgorithm = cmdletContext.SourceEncryptionAlgorithm; } if (cmdletContext.SourceEncryptionContext != null) { request.SourceEncryptionContext = cmdletContext.SourceEncryptionContext; } if (cmdletContext.SourceKeyId != null) { request.SourceKeyId = cmdletContext.SourceKeyId; } 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(); } } } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.KeyManagementService.Model.ReEncryptResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.ReEncryptRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "ReEncrypt"); try { #if DESKTOP return client.ReEncrypt(request); #elif CORECLR return client.ReEncryptAsync(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 Amazon.KeyManagementService.EncryptionAlgorithmSpec DestinationEncryptionAlgorithm { get; set; } public Dictionary DestinationEncryptionContext { get; set; } public System.String DestinationKeyId { get; set; } public System.Boolean? DryRun { get; set; } public List GrantToken { get; set; } public Amazon.KeyManagementService.EncryptionAlgorithmSpec SourceEncryptionAlgorithm { get; set; } public Dictionary SourceEncryptionContext { get; set; } public System.String SourceKeyId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }