/******************************************************************************* * 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 { /// /// Returns a unique symmetric data key for use outside of KMS. This operation returns /// a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption /// KMS key that you specify. The bytes in the plaintext key are random; they are not /// related to the caller or the KMS key. You can use the plaintext key to encrypt your /// data outside of KMS and store the encrypted data key with the encrypted data. /// /// /// /// To generate a data key, specify the symmetric encryption KMS key that will be used /// to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. /// To get the type of your KMS key, use the DescribeKey operation. /// /// You must also specify the length of the data key. Use either the KeySpec /// or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data /// keys, use the KeySpec parameter. /// /// To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec /// value of AES_128 or a NumberOfBytes value of 16. /// The symmetric encryption key used in China Regions to encrypt your data key is an /// SM4 encryption key. /// /// To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. /// To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext /// operation. To get a cryptographically secure random byte string, use GenerateRandom. /// /// You can use an optional encryption context to add additional security to the encryption /// operation. If you specify an EncryptionContext, you must specify the /// same encryption context (a case-sensitive exact match) when decrypting the encrypted /// data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. /// For more information, see Encryption /// Context in the Key Management Service Developer Guide. /// GenerateDataKey also supports Amazon /// Web Services Nitro Enclaves, which provide an isolated compute environment in /// Amazon EC2. To call GenerateDataKey for an Amazon Web Services 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. GenerateDataKey /// returns a copy of the data key encrypted under the specified KMS key, as usual. But /// instead of a plaintext copy of the data key, the response includes a copy of the data /// key encrypted under 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. /// How to use your data key /// We recommend that you use the following pattern to encrypt data locally in your application. /// You can write your own code or use a client-side encryption library, such as the Amazon Web /// Services Encryption SDK, the Amazon /// DynamoDB Encryption Client, or Amazon /// S3 client-side encryption to do these tasks for you. /// /// To encrypt data outside of KMS: ///
  1. /// Use the GenerateDataKey operation to get a data key. ///
  2. /// Use the plaintext data key (in the Plaintext field of the response) to /// encrypt your data outside of KMS. Then erase the plaintext data key from memory. ///
  3. /// Store the encrypted data key (in the CiphertextBlob field of the response) /// with the encrypted data. ///
/// To decrypt data outside of KMS: ///
  1. /// Use the Decrypt operation to decrypt the encrypted data key. The operation /// returns a plaintext copy of the data key. ///
  2. /// Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext /// data key from memory. ///
Cross-account use: Yes. To perform this operation with a KMS key in a different /// Amazon Web Services account, specify the key ARN or alias ARN in the value of the /// KeyId parameter. /// Required permissions: kms:GenerateDataKey /// (key policy) /// Related operations: /// [Cmdlet("New", "KMSDataKey", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.KeyManagementService.Model.GenerateDataKeyResponse")] [AWSCmdlet("Calls the AWS Key Management Service GenerateDataKey API operation.", Operation = new[] {"GenerateDataKey"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.GenerateDataKeyResponse))] [AWSCmdletOutput("Amazon.KeyManagementService.Model.GenerateDataKeyResponse", "This cmdlet returns an Amazon.KeyManagementService.Model.GenerateDataKeyResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewKMSDataKeyCmdlet : 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 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 EncryptionContext /// /// /// Specifies the encryption context that will be used when encrypting the data key.Do not include confidential or sensitive information in this field. This field may /// be displayed in plaintext in CloudTrail logs and other output.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 symmetric encryption KMS key that encrypts the data key. You cannot /// specify an asymmetric KMS key or a KMS key in a custom key store. To get the type /// and origin of your 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(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String KeyId { get; set; } #endregion #region Parameter KeySpec /// /// /// Specifies the length of the data key. Use AES_128 to generate a 128-bit /// symmetric key, or AES_256 to generate a 256-bit symmetric key.You must specify either the KeySpec or the NumberOfBytes /// parameter (but not both) in every GenerateDataKey request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.KeyManagementService.DataKeySpec")] public Amazon.KeyManagementService.DataKeySpec KeySpec { get; set; } #endregion #region Parameter NumberOfBytes /// /// /// Specifies the length of the data key in bytes. For example, use the value 64 to generate /// a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) /// data keys, use the KeySpec parameter.You must specify either the KeySpec or the NumberOfBytes /// parameter (but not both) in every GenerateDataKey request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? NumberOfBytes { 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.GenerateDataKeyResponse). /// Specifying the name of a property of type Amazon.KeyManagementService.Model.GenerateDataKeyResponse 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 PassThru /// /// Changes the cmdlet behavior to return the value passed to the KeyId parameter. /// The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { 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 = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-KMSDataKey (GenerateDataKey)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.KeyId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DryRun = this.DryRun; 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; #if MODULAR if (this.KeyId == null && ParameterWasBound(nameof(this.KeyId))) { WriteWarning("You are passing $null as a value for parameter KeyId 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.KeySpec = this.KeySpec; context.NumberOfBytes = this.NumberOfBytes; 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 _Recipient_AttestationDocumentStream = null; try { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.KeyManagementService.Model.GenerateDataKeyRequest(); if (cmdletContext.DryRun != null) { request.DryRun = cmdletContext.DryRun.Value; } if (cmdletContext.EncryptionContext != null) { request.EncryptionContext = cmdletContext.EncryptionContext; } if (cmdletContext.GrantToken != null) { request.GrantTokens = cmdletContext.GrantToken; } if (cmdletContext.KeyId != null) { request.KeyId = cmdletContext.KeyId; } if (cmdletContext.KeySpec != null) { request.KeySpec = cmdletContext.KeySpec; } if (cmdletContext.NumberOfBytes != null) { request.NumberOfBytes = cmdletContext.NumberOfBytes.Value; } // 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( _Recipient_AttestationDocumentStream != null) { _Recipient_AttestationDocumentStream.Dispose(); } } } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.KeyManagementService.Model.GenerateDataKeyResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.GenerateDataKeyRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "GenerateDataKey"); try { #if DESKTOP return client.GenerateDataKey(request); #elif CORECLR return client.GenerateDataKeyAsync(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 System.Boolean? DryRun { get; set; } public Dictionary EncryptionContext { get; set; } public List GrantToken { get; set; } public System.String KeyId { get; set; } public Amazon.KeyManagementService.DataKeySpec KeySpec { get; set; } public System.Int32? NumberOfBytes { 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; } } }