/*******************************************************************************
* 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
{
///
/// Imports a certificate into Certificate Manager (ACM) to use with services that are
/// integrated with ACM. Note that integrated
/// services allow only certificate types and keys they support to be associated with
/// their resources. Further, their support differs depending on whether the certificate
/// is imported into IAM or into ACM. For more information, see the documentation for
/// each service. For more information about importing certificates into ACM, see Importing
/// Certificates in the Certificate Manager User Guide.
///
///
/// ACM does not provide managed
/// renewal for certificates that you import.
///
/// Note the following guidelines when importing third party certificates:
/// -
/// You must enter the private key that matches the certificate you are importing.
///
-
/// The private key must be unencrypted. You cannot import a private key that is protected
/// by a password or a passphrase.
///
-
/// The private key must be no larger than 5 KB (5,120 bytes).
///
-
/// If the certificate you are importing is not self-signed, you must enter its certificate
/// chain.
///
-
/// If a certificate chain is included, the issuer must be the subject of one of the certificates
/// in the chain.
///
-
/// The certificate, private key, and certificate chain must be PEM-encoded.
///
-
/// The current time must be between the
Not Before
and Not After
/// certificate fields.
/// -
/// The
Issuer
field must not be empty.
/// -
/// The OCSP authority URL, if present, must not exceed 1000 characters.
///
-
/// To import a new certificate, omit the
CertificateArn
argument. Include
/// this argument only when you want to replace a previously imported certificate.
/// -
/// When you import a certificate by using the CLI, you must specify the certificate,
/// the certificate chain, and the private key by their file names preceded by
fileb://
.
/// For example, you can specify a certificate saved in the C:\temp
folder
/// as fileb://C:\temp\certificate_to_import.pem
. If you are making an HTTP
/// or HTTPS Query request, include these arguments as BLOBs.
/// -
/// When you import a certificate by using an SDK, you must specify the certificate, the
/// certificate chain, and the private key files in the manner required by the programming
/// language you're using.
///
-
/// The cryptographic algorithm of an imported certificate must match the algorithm of
/// the signing CA. For example, if the signing CA key type is RSA, then the certificate
/// key type must also be RSA.
///
/// This operation returns the Amazon
/// Resource Name (ARN) of the imported certificate.
///
///
[Cmdlet("Import", "ACMCertificate", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Certificate Manager ImportCertificate API operation.", Operation = new[] {"ImportCertificate"}, SelectReturnType = typeof(Amazon.CertificateManager.Model.ImportCertificateResponse))]
[AWSCmdletOutput("System.String or Amazon.CertificateManager.Model.ImportCertificateResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.CertificateManager.Model.ImportCertificateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class ImportACMCertificateCmdlet : AmazonCertificateManagerClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter Certificate
///
///
/// The certificate to import.
///
/// 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[] Certificate { get; set; }
#endregion
#region Parameter CertificateArn
///
///
/// The Amazon
/// Resource Name (ARN) of an imported certificate to replace. To import a new certificate,
/// omit this field.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String CertificateArn { get; set; }
#endregion
#region Parameter CertificateChain
///
///
/// The PEM encoded certificate chain.
///
/// 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[] CertificateChain { get; set; }
#endregion
#region Parameter PrivateKey
///
///
/// The private key that matches the public key in the certificate.
///
/// 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[] PrivateKey { get; set; }
#endregion
#region Parameter Tag
///
///
/// One or more resource tags to associate with the imported certificate. Note: You cannot apply tags when reimporting a certificate.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.CertificateManager.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'CertificateArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CertificateManager.Model.ImportCertificateResponse).
/// Specifying the name of a property of type Amazon.CertificateManager.Model.ImportCertificateResponse 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; } = "CertificateArn";
#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, "Import-ACMCertificate (ImportCertificate)"))
{
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.Certificate = this.Certificate;
#if MODULAR
if (this.Certificate == null && ParameterWasBound(nameof(this.Certificate)))
{
WriteWarning("You are passing $null as a value for parameter Certificate 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.CertificateArn = this.CertificateArn;
context.CertificateChain = this.CertificateChain;
context.PrivateKey = this.PrivateKey;
#if MODULAR
if (this.PrivateKey == null && ParameterWasBound(nameof(this.PrivateKey)))
{
WriteWarning("You are passing $null as a value for parameter PrivateKey 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
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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 _CertificateStream = null;
System.IO.MemoryStream _CertificateChainStream = null;
System.IO.MemoryStream _PrivateKeyStream = null;
try
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.CertificateManager.Model.ImportCertificateRequest();
if (cmdletContext.Certificate != null)
{
_CertificateStream = new System.IO.MemoryStream(cmdletContext.Certificate);
request.Certificate = _CertificateStream;
}
if (cmdletContext.CertificateArn != null)
{
request.CertificateArn = cmdletContext.CertificateArn;
}
if (cmdletContext.CertificateChain != null)
{
_CertificateChainStream = new System.IO.MemoryStream(cmdletContext.CertificateChain);
request.CertificateChain = _CertificateChainStream;
}
if (cmdletContext.PrivateKey != null)
{
_PrivateKeyStream = new System.IO.MemoryStream(cmdletContext.PrivateKey);
request.PrivateKey = _PrivateKeyStream;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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( _CertificateStream != null)
{
_CertificateStream.Dispose();
}
if( _CertificateChainStream != null)
{
_CertificateChainStream.Dispose();
}
if( _PrivateKeyStream != null)
{
_PrivateKeyStream.Dispose();
}
}
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.CertificateManager.Model.ImportCertificateResponse CallAWSServiceOperation(IAmazonCertificateManager client, Amazon.CertificateManager.Model.ImportCertificateRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Certificate Manager", "ImportCertificate");
try
{
#if DESKTOP
return client.ImportCertificate(request);
#elif CORECLR
return client.ImportCertificateAsync(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[] Certificate { get; set; }
public System.String CertificateArn { get; set; }
public byte[] CertificateChain { get; set; }
public byte[] PrivateKey { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.CertificateArn;
}
}
}