Class: AWSCDK::ACMPCA::CfnCertificateAuthority::CrlConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
acmpca/cfn_certificate_authority.rb

Overview

Contains configuration information for a certificate revocation list (CRL).

Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true . Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA by default copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. If you want to configure this default behavior to be something different, you can set the CrlDistributionPointExtensionConfiguration parameter. Your S3 bucket policy must give write permission to AWS Private CA.

AWS Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs .

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.

A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, AWS Private CA makes further attempts every 15 minutes.

CRLs contain the following fields:

  • Version : The current version number defined in RFC 5280 is V2. The integer value is 0x1.
  • Signature Algorithm : The name of the algorithm used to sign the CRL.
  • Issuer : The X.500 distinguished name of your private CA that issued the CRL.
  • Last Update : The issue date and time of this CRL.
  • Next Update : The day and time by which the next CRL will be issued.
  • Revoked Certificates : List of revoked certificates. Each list item contains the following information.
  • Serial Number : The serial number, in hexadecimal format, of the revoked certificate.
  • Revocation Date : Date and time the certificate was revoked.
  • CRL Entry Extensions : Optional extensions for the CRL entry.
  • X509v3 CRL Reason Code : Reason the certificate was revoked.
  • CRL Extensions : Optional extensions for the CRL.
  • X509v3 Authority Key Identifier : Identifies the public key associated with the private key used to sign the certificate.
  • X509v3 CRL Number: : Decimal sequence number for the CRL.
  • Signature Algorithm : Algorithm used by your private CA to sign the CRL.
  • Signature Value : Signature computed over the CRL.

Certificate revocation lists created by AWS Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in *crl_path* -noout

For more information, see Planning a certificate revocation list (CRL) in the AWS Private Certificate Authority User Guide

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled:, crl_distribution_point_extension_configuration: nil, crl_type: nil, custom_cname: nil, custom_path: nil, expiration_in_days: nil, s3_bucket_name: nil, s3_object_acl: nil) ⇒ CrlConfigurationProperty

Returns a new instance of CrlConfigurationProperty.

Parameters:

  • enabled (Boolean, AWSCDK::IResolvable) —

    Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.

  • crl_distribution_point_extension_configuration (AWSCDK::IResolvable, AWSCDK::ACMPCA::CfnCertificateAuthority::CrlDistributionPointExtensionConfigurationProperty, nil) (defaults to: nil) —

    Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA.

  • crl_type (String, nil) (defaults to: nil) —

    Specifies the type of CRL.

  • custom_cname (String, nil) (defaults to: nil) —

    Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.

  • custom_path (String, nil) (defaults to: nil) —

    Designates a custom file path in S3 for CRL(s).

  • expiration_in_days (Numeric, nil) (defaults to: nil) —

    Validity period of the CRL in days.

  • s3_bucket_name (String, nil) (defaults to: nil) —

    Name of the S3 bucket that contains the CRL.

  • s3_object_acl (String, nil) (defaults to: nil) —

    Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket.



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'acmpca/cfn_certificate_authority.rb', line 765

def initialize(enabled:, crl_distribution_point_extension_configuration: nil, crl_type: nil, custom_cname: nil, custom_path: nil, expiration_in_days: nil, s3_bucket_name: nil, s3_object_acl: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled")
  @crl_distribution_point_extension_configuration = crl_distribution_point_extension_configuration.is_a?(Hash) ? ::AWSCDK::ACMPCA::CfnCertificateAuthority::CrlDistributionPointExtensionConfigurationProperty.new(**crl_distribution_point_extension_configuration.transform_keys(&:to_sym)) : crl_distribution_point_extension_configuration
  Jsii::Type.check_type(@crl_distribution_point_extension_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hY21wY2EuQ2ZuQ2VydGlmaWNhdGVBdXRob3JpdHkuQ3JsRGlzdHJpYnV0aW9uUG9pbnRFeHRlbnNpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "crlDistributionPointExtensionConfiguration") unless @crl_distribution_point_extension_configuration.nil?
  @crl_type = crl_type
  Jsii::Type.check_type(@crl_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "crlType") unless @crl_type.nil?
  @custom_cname = custom_cname
  Jsii::Type.check_type(@custom_cname, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customCname") unless @custom_cname.nil?
  @custom_path = custom_path
  Jsii::Type.check_type(@custom_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customPath") unless @custom_path.nil?
  @expiration_in_days = expiration_in_days
  Jsii::Type.check_type(@expiration_in_days, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "expirationInDays") unless @expiration_in_days.nil?
  @s3_bucket_name = s3_bucket_name
  Jsii::Type.check_type(@s3_bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketName") unless @s3_bucket_name.nil?
  @s3_object_acl = s3_object_acl
  Jsii::Type.check_type(@s3_object_acl, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3ObjectAcl") unless @s3_object_acl.nil?
end

Instance Attribute Details

#crl_distribution_point_extension_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA.

If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.

Returns:

See Also:



797
798
799
 
# File 'acmpca/cfn_certificate_authority.rb', line 797

def crl_distribution_point_extension_configuration
  @crl_distribution_point_extension_configuration
end

#crl_type ⇒ String? (readonly)

Specifies the type of CRL.

This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see AWS Private CA quotas .

  • COMPLETE - The default setting. AWS Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that AWS Private CA issues is bound to a specific CRL through the CRL distribution point (CDP) defined in RFC 5280 .
  • PARTITIONED - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue.

When using partitioned CRLs, you must validate that the CRL's associated issuing distribution point (IDP) URI matches the certiļ¬cate's CDP URI to ensure the right CRL has been fetched. AWS Private CA marks the IDP extension as critical, which your client must be able to process.

Returns:

  • (String, nil)

See Also:



809
810
811
 
# File 'acmpca/cfn_certificate_authority.rb', line 809

def crl_type
  @crl_type
end

#custom_cname ⇒ String? (readonly)

Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.

Use this value if you don't want the name of your S3 bucket to be public.

The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".

Returns:

  • (String, nil)

See Also:



818
819
820
 
# File 'acmpca/cfn_certificate_authority.rb', line 818

def custom_cname
  @custom_cname
end

#custom_path ⇒ String? (readonly)

Designates a custom file path in S3 for CRL(s).

For example, http://<CustomName>/<CustomPath>/<CrlPartition_GUID>.crl .

Returns:

  • (String, nil)

See Also:



825
826
827
 
# File 'acmpca/cfn_certificate_authority.rb', line 825

def custom_path
  @custom_path
end

#enabled ⇒ Boolean, AWSCDK::IResolvable (readonly)

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.

You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority operation or for an existing CA when you call the UpdateCertificateAuthority operation.

Returns:

See Also:



790
791
792
 
# File 'acmpca/cfn_certificate_authority.rb', line 790

def enabled
  @enabled
end

#expiration_in_days ⇒ Numeric? (readonly)

Validity period of the CRL in days.

Returns:

  • (Numeric, nil)

See Also:



830
831
832
 
# File 'acmpca/cfn_certificate_authority.rb', line 830

def expiration_in_days
  @expiration_in_days
end

#s3_bucket_name ⇒ String? (readonly)

Name of the S3 bucket that contains the CRL.

If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows AWS Private CA to write the CRL to your bucket.

The S3BucketName parameter must conform to the S3 bucket naming rules .

Returns:

  • (String, nil)

See Also:



839
840
841
 
# File 'acmpca/cfn_certificate_authority.rb', line 839

def s3_bucket_name
  @s3_bucket_name
end

#s3_object_acl ⇒ String? (readonly)

Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket.

If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

If no value is specified, the default is PUBLIC_READ.

Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL , and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.

For more information, see Blocking public access to the S3 bucket .

Returns:

  • (String, nil)

See Also:



852
853
854
 
# File 'acmpca/cfn_certificate_authority.rb', line 852

def s3_object_acl
  @s3_object_acl
end

Class Method Details

.jsii_properties ⇒ Object 



854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'acmpca/cfn_certificate_authority.rb', line 854

def self.jsii_properties
  {
    :enabled => "enabled",
    :crl_distribution_point_extension_configuration => "crlDistributionPointExtensionConfiguration",
    :crl_type => "crlType",
    :custom_cname => "customCname",
    :custom_path => "customPath",
    :expiration_in_days => "expirationInDays",
    :s3_bucket_name => "s3BucketName",
    :s3_object_acl => "s3ObjectAcl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



867
868
869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'acmpca/cfn_certificate_authority.rb', line 867

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "crlDistributionPointExtensionConfiguration" => @crl_distribution_point_extension_configuration,
    "crlType" => @crl_type,
    "customCname" => @custom_cname,
    "customPath" => @custom_path,
    "expirationInDays" => @expiration_in_days,
    "s3BucketName" => @s3_bucket_name,
    "s3ObjectAcl" => @s3_object_acl,
  })
  result.compact
end