/******************************************************************************* * 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.ACMPCA; using Amazon.ACMPCA.Model; namespace Amazon.PowerShell.Cmdlets.PCA { /// /// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you /// enable a certificate revocation list (CRL) when you create or update your private /// CA, information about the revoked certificates will be included in the CRL. Amazon /// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is /// typically updated approximately 30 minutes after a certificate is revoked. If for /// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further /// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics /// CRLGenerated and MisconfiguredCRLBucket. For more information, /// see Supported /// CloudWatch Metrics. /// /// /// Both Amazon Web Services Private CA and the IAM principal must have permission to /// write to the S3 bucket that you specify. If the IAM principal making the call does /// not have permission to write to the bucket, then an exception is thrown. For more /// information, see Access /// policies for CRLs in Amazon S3. /// /// Amazon Web Services Private CA also writes revocation information to the audit report. /// For more information, see CreateCertificateAuthorityAuditReport. /// /// You cannot revoke a root CA self-signed certificate. /// /// [Cmdlet("Revoke", "PCACertificate", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Certificate Manager Private Certificate Authority RevokeCertificate API operation.", Operation = new[] {"RevokeCertificate"}, SelectReturnType = typeof(Amazon.ACMPCA.Model.RevokeCertificateResponse))] [AWSCmdletOutput("None or Amazon.ACMPCA.Model.RevokeCertificateResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.ACMPCA.Model.RevokeCertificateResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RevokePCACertificateCmdlet : AmazonACMPCAClientCmdlet, IExecutor { #region Parameter CertificateAuthorityArn /// /// /// Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. /// This must be of the form:arn:aws:acm-pca:region:account:certificate-authority/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 CertificateAuthorityArn { get; set; } #endregion #region Parameter CertificateSerial /// /// /// Serial number of the certificate to be revoked. This must be in hexadecimal format. /// You can retrieve the serial number by calling GetCertificate /// with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your /// private CA. The GetCertificate action retrieves the certificate in the PEM /// format. You can use the following OpenSSL command to list the certificate in text /// format and copy the hexadecimal serial number. openssl x509 -in file_path -text -nooutYou can also copy the serial number from the console or use the DescribeCertificate /// action in the Certificate Manager API Reference. /// /// #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 CertificateSerial { get; set; } #endregion #region Parameter RevocationReason /// /// /// Specifies why you revoked the certificate. /// /// #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] [AWSConstantClassSource("Amazon.ACMPCA.RevocationReason")] public Amazon.ACMPCA.RevocationReason RevocationReason { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ACMPCA.Model.RevokeCertificateResponse). /// 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 CertificateAuthorityArn parameter. /// The -PassThru parameter is deprecated, use -Select '^CertificateAuthorityArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CertificateAuthorityArn' 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.CertificateAuthorityArn), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Revoke-PCACertificate (RevokeCertificate)")) { 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.CertificateAuthorityArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CertificateAuthorityArn = this.CertificateAuthorityArn; #if MODULAR if (this.CertificateAuthorityArn == null && ParameterWasBound(nameof(this.CertificateAuthorityArn))) { WriteWarning("You are passing $null as a value for parameter CertificateAuthorityArn 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.CertificateSerial = this.CertificateSerial; #if MODULAR if (this.CertificateSerial == null && ParameterWasBound(nameof(this.CertificateSerial))) { WriteWarning("You are passing $null as a value for parameter CertificateSerial 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.RevocationReason = this.RevocationReason; #if MODULAR if (this.RevocationReason == null && ParameterWasBound(nameof(this.RevocationReason))) { WriteWarning("You are passing $null as a value for parameter RevocationReason 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) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.ACMPCA.Model.RevokeCertificateRequest(); if (cmdletContext.CertificateAuthorityArn != null) { request.CertificateAuthorityArn = cmdletContext.CertificateAuthorityArn; } if (cmdletContext.CertificateSerial != null) { request.CertificateSerial = cmdletContext.CertificateSerial; } if (cmdletContext.RevocationReason != null) { request.RevocationReason = cmdletContext.RevocationReason; } 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; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.ACMPCA.Model.RevokeCertificateResponse CallAWSServiceOperation(IAmazonACMPCA client, Amazon.ACMPCA.Model.RevokeCertificateRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Certificate Manager Private Certificate Authority", "RevokeCertificate"); try { #if DESKTOP return client.RevokeCertificate(request); #elif CORECLR return client.RevokeCertificateAsync(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 CertificateAuthorityArn { get; set; } public System.String CertificateSerial { get; set; } public Amazon.ACMPCA.RevocationReason RevocationReason { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }