/******************************************************************************* * 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.CertificateManager; using Amazon.CertificateManager.Model; namespace Amazon.PowerShell.Cmdlets.ACM { /// /// Exports a private certificate issued by a private certificate authority (CA) for use /// anywhere. The exported file contains the certificate, the certificate chain, and the /// encrypted private 2048-bit RSA key associated with the public key that is embedded /// in the certificate. For security, you must assign a passphrase for the private key /// when exporting it. /// /// /// /// For information about exporting and formatting a certificate using the ACM console /// or CLI, see Export /// a Private Certificate. /// /// [Cmdlet("Export", "ACMCertificate", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.CertificateManager.Model.ExportCertificateResponse")] [AWSCmdlet("Calls the AWS Certificate Manager ExportCertificate API operation.", Operation = new[] {"ExportCertificate"}, SelectReturnType = typeof(Amazon.CertificateManager.Model.ExportCertificateResponse))] [AWSCmdletOutput("Amazon.CertificateManager.Model.ExportCertificateResponse", "This cmdlet returns an Amazon.CertificateManager.Model.ExportCertificateResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ExportACMCertificateCmdlet : AmazonCertificateManagerClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter CertificateArn /// /// /// An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 /// /// #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 CertificateArn { get; set; } #endregion #region Parameter Passphrase /// /// /// Passphrase to associate with the encrypted exported private key. When creating your passphrase, you can use any ASCII character except #, $, or %.If you want to later decrypt the private key, you must have the passphrase. You can /// use the following OpenSSL command to decrypt a private key. After entering the command, /// you are prompted for the passphrase.openssl rsa -in encrypted_key.pem -out decrypted_key.pem /// /// 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[] Passphrase { 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.CertificateManager.Model.ExportCertificateResponse). /// Specifying the name of a property of type Amazon.CertificateManager.Model.ExportCertificateResponse 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 CertificateArn parameter. /// The -PassThru parameter is deprecated, use -Select '^CertificateArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CertificateArn' 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 = FormatParameterValuesForConfirmationMsg(nameof(this.CertificateArn), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Export-ACMCertificate (ExportCertificate)")) { 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.CertificateArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CertificateArn = this.CertificateArn; #if MODULAR if (this.CertificateArn == null && ParameterWasBound(nameof(this.CertificateArn))) { WriteWarning("You are passing $null as a value for parameter CertificateArn 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.Passphrase = this.Passphrase; #if MODULAR if (this.Passphrase == null && ParameterWasBound(nameof(this.Passphrase))) { WriteWarning("You are passing $null as a value for parameter Passphrase 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 // 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 _PassphraseStream = null; try { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.CertificateManager.Model.ExportCertificateRequest(); if (cmdletContext.CertificateArn != null) { request.CertificateArn = cmdletContext.CertificateArn; } if (cmdletContext.Passphrase != null) { _PassphraseStream = new System.IO.MemoryStream(cmdletContext.Passphrase); request.Passphrase = _PassphraseStream; } 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( _PassphraseStream != null) { _PassphraseStream.Dispose(); } } } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.CertificateManager.Model.ExportCertificateResponse CallAWSServiceOperation(IAmazonCertificateManager client, Amazon.CertificateManager.Model.ExportCertificateRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Certificate Manager", "ExportCertificate"); try { #if DESKTOP return client.ExportCertificate(request); #elif CORECLR return client.ExportCertificateAsync(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.String CertificateArn { get; set; } public byte[] Passphrase { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }