| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ACMPCA::CrlConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has CustomCname => (is => 'ro', isa => 'Str'); | ||
| 5 | has Enabled => (is => 'ro', isa => 'Bool', required => 1); | ||
| 6 | has ExpirationInDays => (is => 'ro', isa => 'Int'); | ||
| 7 | has S3BucketName => (is => 'ro', isa => 'Str'); | ||
| 8 | has S3ObjectAcl => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::ACMPCA::CrlConfiguration | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::ACMPCA::CrlConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CustomCname => $value, ..., S3ObjectAcl => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::ACMPCA::CrlConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CustomCname | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Contains configuration information for a certificate revocation list | ||
| 41 | (CRL). Your private certificate authority (CA) creates base CRLs. Delta | ||
| 42 | CRLs are not supported. You can enable CRLs for your new or an existing | ||
| 43 | private CA by setting the B<Enabled> parameter to C<true>. Your private | ||
| 44 | CA writes CRLs to an S3 bucket that you specify in the B<S3BucketName> | ||
| 45 | parameter. You can hide the name of your bucket by specifying a value | ||
| 46 | for the B<CustomCname> parameter. Your private CA copies the CNAME or | ||
| 47 | the S3 bucket name to the B<CRL Distribution Points> extension of each | ||
| 48 | certificate it issues. Your S3 bucket policy must give write permission | ||
| 49 | to ACM Private CA. | ||
| 50 | |||
| 51 | ACM Private CA assets that are stored in Amazon S3 can be protected | ||
| 52 | with encryption. For more information, see Encrypting Your CRLs | ||
| 53 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption). | ||
| 54 | |||
| 55 | Your private CA uses the value in the B<ExpirationInDays> parameter to | ||
| 56 | calculate the B<nextUpdate> field in the CRL. The CRL is refreshed at | ||
| 57 | 1/2 the age of next update or when a certificate is revoked. When a | ||
| 58 | certificate is revoked, it is recorded in the next CRL that is | ||
| 59 | generated and in the next audit report. Only time valid certificates | ||
| 60 | are listed in the CRL. Expired certificates are not included. | ||
| 61 | |||
| 62 | CRLs contain the following fields: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | B<Version>: The current version number defined in RFC 5280 is V2. The | ||
| 69 | integer value is 0x1. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | B<Signature Algorithm>: The name of the algorithm used to sign the CRL. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | B<Issuer>: The X.500 distinguished name of your private CA that issued | ||
| 78 | the CRL. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | B<Last Update>: The issue date and time of this CRL. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | B<Next Update>: The day and time by which the next CRL will be issued. | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | B<Revoked Certificates>: List of revoked certificates. Each list item | ||
| 91 | contains the following information. | ||
| 92 | |||
| 93 | =over | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | B<Serial Number>: The serial number, in hexadecimal format, of the | ||
| 98 | revoked certificate. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | B<Revocation Date>: Date and time the certificate was revoked. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | B<CRL Entry Extensions>: Optional extensions for the CRL entry. | ||
| 107 | |||
| 108 | =over | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | B<X509v3 CRL Reason Code>: Reason the certificate was revoked. | ||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | =back | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | B<CRL Extensions>: Optional extensions for the CRL. | ||
| 121 | |||
| 122 | =over | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | B<X509v3 Authority Key Identifier>: Identifies the public key | ||
| 127 | associated with the private key used to sign the certificate. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | B<X509v3 CRL Number:>: Decimal sequence number for the CRL. | ||
| 132 | |||
| 133 | =back | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | B<Signature Algorithm>: Algorithm used by your private CA to sign the | ||
| 138 | CRL. | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | B<Signature Value>: Signature computed over the CRL. | ||
| 143 | |||
| 144 | =back | ||
| 145 | |||
| 146 | Certificate revocation lists created by ACM Private CA are DER-encoded. | ||
| 147 | You can use the following OpenSSL command to list a CRL. | ||
| 148 | |||
| 149 | C<openssl crl -inform DER -text -in I<crl_path> -noout> | ||
| 150 | |||
| 151 | =head1 ATTRIBUTES | ||
| 152 | |||
| 153 | |||
| 154 | =head2 CustomCname => Str | ||
| 155 | |||
| 156 | Name inserted into the certificate B<CRL Distribution Points> extension | ||
| 157 | that enables the use of an alias for the CRL distribution point. Use | ||
| 158 | this value if you don't want the name of your S3 bucket to be public. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> Enabled => Bool | ||
| 162 | |||
| 163 | Boolean value that specifies whether certificate revocation lists | ||
| 164 | (CRLs) are enabled. You can use this value to enable certificate | ||
| 165 | revocation for a new CA when you call the CreateCertificateAuthority | ||
| 166 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) | ||
| 167 | action or for an existing CA when you call the | ||
| 168 | UpdateCertificateAuthority | ||
| 169 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) | ||
| 170 | action. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 ExpirationInDays => Int | ||
| 174 | |||
| 175 | Validity period of the CRL in days. | ||
| 176 | |||
| 177 | |||
| 178 | =head2 S3BucketName => Str | ||
| 179 | |||
| 180 | Name of the S3 bucket that contains the CRL. If you do not provide a | ||
| 181 | value for the B<CustomCname> argument, the name of your S3 bucket is | ||
| 182 | placed into the B<CRL Distribution Points> extension of the issued | ||
| 183 | certificate. You can change the name of your bucket by calling the | ||
| 184 | UpdateCertificateAuthority | ||
| 185 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) | ||
| 186 | action. You must specify a bucket policy | ||
| 187 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies) | ||
| 188 | that allows ACM Private CA to write the CRL to your bucket. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 S3ObjectAcl => Str | ||
| 192 | |||
| 193 | Determines whether the CRL will be publicly readable or privately held | ||
| 194 | in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be | ||
| 195 | accessible over the public internet. If you choose | ||
| 196 | BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can | ||
| 197 | access the CRL, and your PKI clients may need an alternative method of | ||
| 198 | access. | ||
| 199 | |||
| 200 | If no value is specified, the default is C<PUBLIC_READ>. | ||
| 201 | |||
| 202 | I<Note:> This default can cause CA creation to fail in some | ||
| 203 | circumstances. If you have have enabled the Block Public Access (BPA) | ||
| 204 | feature in your S3 account, then you must specify the value of this | ||
| 205 | parameter as C<BUCKET_OWNER_FULL_CONTROL>, and not doing so results in | ||
| 206 | an error. If you have disabled BPA in S3, then you can specify either | ||
| 207 | C<BUCKET_OWNER_FULL_CONTROL> or C<PUBLIC_READ> as the value. | ||
| 208 | |||
| 209 | For more information, see Blocking public access to the S3 bucket | ||
| 210 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-bpa). | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head1 SEE ALSO | ||
| 215 | |||
| 216 | This class forms part of L<Paws>, describing an object used in L<Paws::ACMPCA> | ||
| 217 | |||
| 218 | =head1 BUGS and CONTRIBUTIONS | ||
| 219 | |||
| 220 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 221 | |||
| 222 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 223 | |||
| 224 | =cut | ||
| 225 |