importCertificateAuthorityCertificate method

Future<void> importCertificateAuthorityCertificate({
  1. required Uint8List certificate,
  2. required String certificateAuthorityArn,
  3. Uint8List? certificateChain,
})

Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:

  1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.
  2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
  3. Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
  4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
ACM Private CA supports three scenarios for installing a CA certificate:
  • Installing a certificate for a root CA hosted by ACM Private CA.
  • Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.
  • Installing a subordinate CA certificate whose parent authority is externally hosted.
The following addtitional requirements apply when you import a CA certificate.
  • Only a self-signed certificate can be imported as a root CA.
  • A self-signed certificate cannot be imported as a subordinate CA.
  • Your certificate chain must not include the private CA certificate that you are importing.
  • Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
  • The chain must be PEM-encoded.
  • The maximum allowed size of a certificate is 32 KB.
  • The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints

ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

  • Basic constraints (must be marked critical)
  • Subject alternative names
  • Key usage
  • Extended key usage
  • Authority key identifier
  • Subject key identifier
  • Issuer alternative name
  • Subject directory attributes
  • Subject information access
  • Certificate policies
  • Policy mappings
  • Inhibit anyPolicy
ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
  • Name constraints
  • Policy constraints
  • CRL distribution points
  • Authority information access
  • Freshest CRL
  • Any other extension

May throw ConcurrentModificationException. May throw RequestInProgressException. May throw RequestFailedException. May throw ResourceNotFoundException. May throw InvalidArnException. May throw InvalidRequestException. May throw InvalidStateException. May throw MalformedCertificateException. May throw CertificateMismatchException.

Parameter certificate : The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.

Parameter certificateAuthorityArn : The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Parameter certificateChain : A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.

Implementation

Future<void> importCertificateAuthorityCertificate({
  required Uint8List certificate,
  required String certificateAuthorityArn,
  Uint8List? certificateChain,
}) async {
  ArgumentError.checkNotNull(certificate, 'certificate');
  ArgumentError.checkNotNull(
      certificateAuthorityArn, 'certificateAuthorityArn');
  _s.validateStringLength(
    'certificateAuthorityArn',
    certificateAuthorityArn,
    5,
    200,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'ACMPrivateCA.ImportCertificateAuthorityCertificate'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Certificate': base64Encode(certificate),
      'CertificateAuthorityArn': certificateAuthorityArn,
      if (certificateChain != null)
        'CertificateChain': base64Encode(certificateChain),
    },
  );
}