""" Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: MIT-0 """ import regex as re from cfnlint.helpers import REGEX_DYN_REF, RESOURCE_SPECS from cfnlint.rules import CloudFormationLintRule, RuleMatch class StringSize(CloudFormationLintRule): """Check if a String has a length within the limit""" id = "E3033" shortdesc = "Check if a string has between min and max number of values specified" description = "Check strings for its length between the minimum and maximum" source_url = "https://github.com/awslabs/cfn-python-lint/blob/main/docs/cfn-resource-specification.md#allowedpattern" tags = ["resources", "property", "string", "size"] def initialize(self, cfn): """Initialize the rule""" for resource_type_spec in RESOURCE_SPECS.get(cfn.regions[0]).get( "ResourceTypes" ): self.resource_property_types.append(resource_type_spec) for property_type_spec in RESOURCE_SPECS.get(cfn.regions[0]).get( "PropertyTypes" ): self.resource_sub_property_types.append(property_type_spec) def _check_string_length(self, value, path, **kwargs): """ """ matches = [] string_min = kwargs.get("string_min") string_max = kwargs.get("string_max") if isinstance(value, str) and not re.match(REGEX_DYN_REF, value): if not string_min <= len(value) <= string_max: message = "String has to have length between {0} and {1} at {2}. Current length {3}." matches.append( RuleMatch( path, message.format( string_min, string_max, "/".join(map(str, path)), len(value) ), ) ) return matches def check(self, cfn, properties, specs, path): """Check itself""" matches = [] for p_value, p_path in properties.items_safe(path[:]): for prop in p_value: if prop in specs: value_type = specs.get(prop).get("Value", {}).get("ValueType", "") if value_type: if specs.get(prop).get("Type") == "List": property_type = specs.get(prop).get("PrimitiveItemType") else: property_type = specs.get(prop).get("PrimitiveType") value_specs = ( RESOURCE_SPECS.get(cfn.regions[0]) .get("ValueTypes") .get(value_type, {}) ) if value_specs == "CACHED": value_specs = ( RESOURCE_SPECS.get("us-east-1") .get("ValueTypes") .get(value_type, {}) ) if value_specs.get("StringMax") and value_specs.get( "StringMin" ): if property_type == "String": matches.extend( cfn.check_value( properties, prop, p_path, check_value=self._check_string_length, string_max=value_specs.get("StringMax"), string_min=value_specs.get("StringMin"), ) ) return matches def match_resource_sub_properties(self, properties, property_type, path, cfn): """Match for sub properties""" matches = [] specs = ( RESOURCE_SPECS.get(cfn.regions[0]) .get("PropertyTypes") .get(property_type, {}) .get("Properties", {}) ) matches.extend(self.check(cfn, properties, specs, path)) return matches def match_resource_properties(self, properties, resource_type, path, cfn): """Check CloudFormation Properties""" matches = [] specs = ( RESOURCE_SPECS.get(cfn.regions[0]) .get("ResourceTypes") .get(resource_type, {}) .get("Properties", {}) ) matches.extend(self.check(cfn, properties, specs, path)) return matches
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
AllowedPattern.py | File | 5.76 KB | 0644 |
|
AllowedValue.py | File | 4.8 KB | 0644 |
|
AtLeastOne.py | File | 4.11 KB | 0644 |
|
AvailabilityZone.py | File | 3.41 KB | 0644 |
|
BasedOnValue.py | File | 6.33 KB | 0644 |
|
Exclusive.py | File | 3.98 KB | 0644 |
|
ImageId.py | File | 2.37 KB | 0644 |
|
Inclusive.py | File | 3.7 KB | 0644 |
|
JsonSize.py | File | 6.08 KB | 0644 |
|
ListDuplicates.py | File | 4.39 KB | 0644 |
|
ListDuplicatesAllowed.py | File | 4.76 KB | 0644 |
|
ListSize.py | File | 4.88 KB | 0644 |
|
NumberSize.py | File | 4.88 KB | 0644 |
|
OnlyOne.py | File | 3.89 KB | 0644 |
|
Password.py | File | 3.63 KB | 0644 |
|
Properties.py | File | 27.49 KB | 0644 |
|
PropertiesTemplated.py | File | 2.44 KB | 0644 |
|
Required.py | File | 4.1 KB | 0644 |
|
RequiredBasedOnValue.py | File | 831 B | 0644 |
|
StringSize.py | File | 4.52 KB | 0644 |
|
UnwantedBasedOnValue.py | File | 837 B | 0644 |
|
ValuePrimitiveType.py | File | 11.6 KB | 0644 |
|
ValueRefGetAtt.py | File | 11.96 KB | 0644 |
|
__init__.py | File | 106 B | 0644 |
|