Experimental
@aws-cdk/aws-iot-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
CheckConfiguration Struct
The types of audit checks.
Example
ts
new iot.AccountAuditConfiguration(this, 'AuditConfiguration', {
checkConfiguration: {
// enabled
authenticatedCognitoRoleOverlyPermissiveCheck: true,
// enabled by default
caCertificateExpiringCheck: undefined,
// disabled
caCertificateKeyQualityCheck: false,
conflictingClientIdsCheck: false,
deviceCertificateAgeCheck: false,
deviceCertificateExpiringCheck: false,
deviceCertificateKeyQualityCheck: false,
deviceCertificateSharedCheck: false,
intermediateCaRevokedForActiveDeviceCertificatesCheck: false,
ioTPolicyPotentialMisConfigurationCheck: false,
iotPolicyOverlyPermissiveCheck: false,
iotRoleAliasAllowsAccessToUnusedServicesCheck: false,
iotRoleAliasOverlyPermissiveCheck: false,
loggingDisabledCheck: false,
revokedCaCertificateStillActiveCheck: false,
revokedDeviceCertificateStillActiveCheck: false,
unauthenticatedCognitoRoleOverlyPermissiveCheck: false,
},
});
Properties
authenticatedCognitoRoleOverlyPermissiveCheckoptionalbooleanauthenticated_cognito_role_overly_permissive_checkoptionalboolauthenticatedCognitoRoleOverlyPermissiveCheckoptionalBooleanAuthenticatedCognitoRoleOverlyPermissiveCheckoptionalboolAuthenticatedCognitoRoleOverlyPermissiveCheckoptional*bool= true#Checks the permissiveness of an authenticated Amazon Cognito identity pool role.
For this check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been used to connect to the AWS IoT message broker during the 31 days before the audit is performed.
caCertificateExpiringCheckoptionalbooleanca_certificate_expiring_checkoptionalboolcaCertificateExpiringCheckoptionalBooleanCaCertificateExpiringCheckoptionalboolCaCertificateExpiringCheckoptional*bool= true#Checks if a CA certificate is expiring.
This check applies to CA certificates expiring within 30 days or that have expired.
caCertificateKeyQualityCheckoptionalbooleanca_certificate_key_quality_checkoptionalboolcaCertificateKeyQualityCheckoptionalBooleanCaCertificateKeyQualityCheckoptionalboolCaCertificateKeyQualityCheckoptional*bool= true#Checks the quality of the CA certificate key.
The quality checks if the key is in a valid format, not expired, and if the key meets a minimum required size.
This check applies to CA certificates that are ACTIVE or PENDING_TRANSFER.
conflictingClientIdsCheckoptionalbooleanconflicting_client_ids_checkoptionalboolconflictingClientIdsCheckoptionalBooleanConflictingClientIdsCheckoptionalboolConflictingClientIdsCheckoptional*bool= true#Checks if multiple devices connect using the same client ID.
deviceCertificateAgeCheckoptionalbooleandevice_certificate_age_checkoptionalbooldeviceCertificateAgeCheckoptionalBooleanDeviceCertificateAgeCheckoptionalboolDeviceCertificateAgeCheckoptional*bool= true#Checks when a device certificate has been active for a number of days greater than or equal to the number you specify.
deviceCertificateAgeCheckDurationoptionalDurationdevice_certificate_age_check_durationoptionalDurationdeviceCertificateAgeCheckDurationoptionalDurationDeviceCertificateAgeCheckDurationoptionalDurationDeviceCertificateAgeCheckDurationoptionalDuration#The duration used to check if a device certificate has been active for a number of days greater than or equal to the number you specify.
Default: 365 days
Valid values range from 30 days (minimum) to 3650 days (10 years, maximum).
You cannot specify a value for this check if deviceCertificateAgeCheck is set to false.
deviceCertificateExpiringCheckoptionalbooleandevice_certificate_expiring_checkoptionalbooldeviceCertificateExpiringCheckoptionalBooleanDeviceCertificateExpiringCheckoptionalboolDeviceCertificateExpiringCheckoptional*bool= true#Checks if a device certificate is expiring.
This check applies to device certificates expiring within 30 days or that have expired.
deviceCertificateKeyQualityCheckoptionalbooleandevice_certificate_key_quality_checkoptionalbooldeviceCertificateKeyQualityCheckoptionalBooleanDeviceCertificateKeyQualityCheckoptionalboolDeviceCertificateKeyQualityCheckoptional*bool= true#Checks the quality of the device certificate key.
The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority, and if the key meets a minimum required size.
intermediateCaRevokedForActiveDeviceCertificatesCheckoptionalbooleanintermediate_ca_revoked_for_active_device_certificates_checkoptionalboolintermediateCaRevokedForActiveDeviceCertificatesCheckoptionalBooleanIntermediateCaRevokedForActiveDeviceCertificatesCheckoptionalboolIntermediateCaRevokedForActiveDeviceCertificatesCheckoptional*bool= true#Checks if device certificates are still active despite being revoked by an intermediate CA.
iotPolicyOverlyPermissiveCheckoptionalbooleaniot_policy_overly_permissive_checkoptionalbooliotPolicyOverlyPermissiveCheckoptionalBooleanIotPolicyOverlyPermissiveCheckoptionalboolIotPolicyOverlyPermissiveCheckoptional*bool= true#Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role.
ioTPolicyPotentialMisConfigurationCheckoptionalbooleanio_t_policy_potential_mis_configuration_checkoptionalboolioTPolicyPotentialMisConfigurationCheckoptionalBooleanIoTPolicyPotentialMisConfigurationCheckoptionalboolIoTPolicyPotentialMisConfigurationCheckoptional*bool= true#Checks if an AWS IoT policy is potentially misconfigured.
notes
Misconfigured policies, including overly permissive policies, can cause security incidents like allowing devices access to unintended resources.
This check is a warning for you to make sure that only intended actions are allowed before updating the policy.
iotRoleAliasAllowsAccessToUnusedServicesCheckoptionalbooleaniot_role_alias_allows_access_to_unused_services_checkoptionalbooliotRoleAliasAllowsAccessToUnusedServicesCheckoptionalBooleanIotRoleAliasAllowsAccessToUnusedServicesCheckoptionalboolIotRoleAliasAllowsAccessToUnusedServicesCheckoptional*bool= true#Checks if a role alias has access to services that haven't been used for the AWS IoT device in the last year.
iotRoleAliasOverlyPermissiveCheckoptionalbooleaniot_role_alias_overly_permissive_checkoptionalbooliotRoleAliasOverlyPermissiveCheckoptionalBooleanIotRoleAliasOverlyPermissiveCheckoptionalboolIotRoleAliasOverlyPermissiveCheckoptional*bool= true#Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive.
loggingDisabledCheckoptionalbooleanlogging_disabled_checkoptionalboolloggingDisabledCheckoptionalBooleanLoggingDisabledCheckoptionalboolLoggingDisabledCheckoptional*bool= true#Checks if AWS IoT logs are disabled.
revokedCaCertificateStillActiveCheckoptionalbooleanrevoked_ca_certificate_still_active_checkoptionalboolrevokedCaCertificateStillActiveCheckoptionalBooleanRevokedCaCertificateStillActiveCheckoptionalboolRevokedCaCertificateStillActiveCheckoptional*bool= true#Checks if a revoked CA certificate is still active.
revokedDeviceCertificateStillActiveCheckoptionalbooleanrevoked_device_certificate_still_active_checkoptionalboolrevokedDeviceCertificateStillActiveCheckoptionalBooleanRevokedDeviceCertificateStillActiveCheckoptionalboolRevokedDeviceCertificateStillActiveCheckoptional*bool= true#Checks if a revoked device certificate is still active.
unauthenticatedCognitoRoleOverlyPermissiveCheckoptionalbooleanunauthenticated_cognito_role_overly_permissive_checkoptionalboolunauthenticatedCognitoRoleOverlyPermissiveCheckoptionalBooleanUnauthenticatedCognitoRoleOverlyPermissiveCheckoptionalboolUnauthenticatedCognitoRoleOverlyPermissiveCheckoptional*bool= true#Checks if policy attached to an unauthenticated Amazon Cognito identity pool role is too permissive.