Package org.sonar.iac.terraform.checks

Class AbstractResourceCheck

java.lang.Object

org.sonar.iac.terraform.checks.AbstractResourceCheck

All Implemented Interfaces:

IacCheck

Direct Known Subclasses:

AnonymousAccessPolicyCheck, AnonymousAccessToResourceCheck, AwsClearTextProtocolsCheckPart, AwsIpRestrictedAdminAccessCheckPart, AwsPrivilegePolicyCheckPart, AwsTagNameConventionCheck, AwsWeakSSLProtocolCheckPart, AzureIpRestrictedAdminAccessCheckPart, CertificateBasedAuthenticationCheck, HighPrivilegedRoleCheck, ManagedIdentityCheck, PublicApiCheck, ResourceAccessPolicyCheck, ResourceSpecificAdminAccountCheck, SubscriptionRoleAssignmentCheck

public abstract class AbstractResourceCheck
extends Object
implements IacCheck

Field Summary

Fields

Modifier and Type	Field	Description
static String	S3_BUCKET

Constructor Summary

Constructors

Constructor	Description
AbstractResourceCheck()

Method Summary

Modifier and Type	Method	Description
protected void	checkResource(CheckContext ctx, BlockTree resource)
static String	getReferenceLabel(BlockTree resource)
static String	getResourceType(BlockTree tree)
static boolean	hasReferenceLabel(BlockTree resource)
void	initialize(InitContext init)
static boolean	isResource(BlockTree tree)
static boolean	isResource(BlockTree tree, String type)
static boolean	isS3Bucket(BlockTree tree)
static boolean	isS3BucketResource(BlockTree tree)
protected void	register(BiConsumer<CheckContext,BlockTree> resourceCheck)
protected void	register(BiConsumer<CheckContext,BlockTree> resourceCheck, String... resourceNames)
protected void	registerResourceChecks()
protected static void	reportOnFalse(CheckContext ctx, AttributeTree attribute, String message, SecondaryLocation... secondaries)
protected static void	reportOnTrue(CheckContext ctx, AttributeTree attribute, String message, SecondaryLocation... secondaries)
static void	reportResource(CheckContext ctx, BlockTree resource, String message)
protected static void	reportSensitiveValue(CheckContext ctx, AttributeTree attribute, String sensitiveValue, String message, SecondaryLocation... secondaries)
protected static void	reportUnexpectedValue(CheckContext ctx, AttributeTree attribute, String expectedValue, String message, SecondaryLocation... secondaries)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

S3_BUCKET

public static final String S3_BUCKET

See Also:

Constant Field Values

Constructor Detail

AbstractResourceCheck

public AbstractResourceCheck()

Method Detail

initialize

public void initialize(InitContext init)

Specified by:

initialize in interface IacCheck

registerResourceChecks

protected void registerResourceChecks()

register

protected void register(BiConsumer<CheckContext,BlockTree> resourceCheck)

register

protected void register(BiConsumer<CheckContext,BlockTree> resourceCheck,
                        String... resourceNames)

checkResource

protected void checkResource(CheckContext ctx,
                             BlockTree resource)

isResource

public static boolean isResource(BlockTree tree)

isResource

public static boolean isResource(BlockTree tree,
                                 String type)

getReferenceLabel

public static String getReferenceLabel(BlockTree resource)

hasReferenceLabel

public static boolean hasReferenceLabel(BlockTree resource)

isS3Bucket

public static boolean isS3Bucket(BlockTree tree)

isS3BucketResource

public static boolean isS3BucketResource(BlockTree tree)

getResourceType

@CheckForNull
public static String getResourceType(BlockTree tree)

reportResource

public static void reportResource(CheckContext ctx,
                                  BlockTree resource,
                                  String message)

reportOnTrue

protected static void reportOnTrue(CheckContext ctx,
                                   AttributeTree attribute,
                                   String message,
                                   SecondaryLocation... secondaries)

reportOnFalse

protected static void reportOnFalse(CheckContext ctx,
                                    AttributeTree attribute,
                                    String message,
                                    SecondaryLocation... secondaries)

reportUnexpectedValue

protected static void reportUnexpectedValue(CheckContext ctx,
                                            AttributeTree attribute,
                                            String expectedValue,
                                            String message,
                                            SecondaryLocation... secondaries)

reportSensitiveValue

protected static void reportSensitiveValue(CheckContext ctx,
                                           AttributeTree attribute,
                                           String sensitiveValue,
                                           String message,
                                           SecondaryLocation... secondaries)