+
+Why is this an issue?
+
+
+
+
+How to fix it
+ +
+
+{metadata.title}
+
+ {metadata.isInQualityProfile ? <> : <>
Covered Since
diff --git a/frontend/src/__tests__/__snapshots__/RulePage.test.tsx.snap b/frontend/src/__tests__/__snapshots__/RulePage.test.tsx.snap index b8f34734953..fbf9efc5c13 100644 --- a/frontend/src/__tests__/__snapshots__/RulePage.test.tsx.snap +++ b/frontend/src/__tests__/__snapshots__/RulePage.test.tsx.snap @@ -2217,7 +2217,18 @@ exports[`renders closed rule S1007 1`] = ` class="MuiContainer-root MuiContainer-maxWidthMd" >- When the absolute positioning of bits representing a bit-field is required, then the behaviour and packing of bit-fields shall be documented + + When the absolute positioning of bits representing a bit-field is required, then the behaviour and packing of bit-fields shall be documented
= 3 ? 'error' : 'warning';
+ if (typeof message === "string") {
+ this.logger.log({
+ level,
+ message,
+ source: path.basename(__filename)
+ });
+ return;
+ }
const location = message.getSourceLocation();
this.logger.log({
- level: level,
+ level,
message: message.getText(),
source: path.basename(__filename),
file: location.getFile(),
diff --git a/frontend/src/deployment/pullRequestIndexing.ts b/frontend/src/deployment/pullRequestIndexing.ts
index 756baa3ef63..12b4e9fe8b9 100644
--- a/frontend/src/deployment/pullRequestIndexing.ts
+++ b/frontend/src/deployment/pullRequestIndexing.ts
@@ -31,7 +31,7 @@ export async function process_incomplete_rspecs(tmpRepoDir: string,
const repo = await (() => {
if (!fs.existsSync(path.join(tmpRepoDir, '.git'))) {
if (process.env.GITHUB_TOKEN) {
- return Git.Clone.clone('https://' + process.env.GITHUB_TOKEN + '@github.com/SonarSource/rspec/', tmpRepoDir);
+ return Git.Clone.clone(`https://${process.env.GITHUB_TOKEN}@github.com/SonarSource/rspec/`, tmpRepoDir);
} else {
return Git.Clone.clone('https://github.com/SonarSource/rspec/', tmpRepoDir);
}
diff --git a/frontend/src/types/RuleMetadata.ts b/frontend/src/types/RuleMetadata.ts
index 90064d44f32..1972ad94a40 100644
--- a/frontend/src/types/RuleMetadata.ts
+++ b/frontend/src/types/RuleMetadata.ts
@@ -16,5 +16,6 @@ export default interface RuleMetadata {
languagesSupport: LanguageSupport[],
allKeys: string[],
branch: string,
+ defaultQualityProfiles: string[],
prUrl?: string
}
diff --git a/frontend/src/utils/useRuleCoverage.ts b/frontend/src/utils/useRuleCoverage.ts
index dcdb6248614..ccf53627bac 100644
--- a/frontend/src/utils/useRuleCoverage.ts
+++ b/frontend/src/utils/useRuleCoverage.ts
@@ -6,10 +6,11 @@ type RuleCoverage = Record>;
const languageToSonarpedia = new Map(Object.entries({
'abap': ['ABAP'],
'apex': ['APEX'],
- 'azureresourcemanager': ['AZURERESOURCEMANAGER'],
+ 'azureresourcemanager': ['AZURE_RESOURCE_MANAGER'],
'cfamily': ['CPP', 'C', 'OBJC'],
'cobol': ['COBOL'],
'csharp': ['CSH'],
+ 'dart': ['DART'],
'docker': ['DOCKER'],
'vbnet': ['VBNET'],
'css': ['CSS'],
@@ -20,6 +21,7 @@ const languageToSonarpedia = new Map(Object.entries({
'go': ['GO'],
'java': ['JAVA'],
'javascript': ['JAVASCRIPT', 'JS', 'TYPESCRIPT'],
+ 'jcl': ['JCL'],
'php': ['PHP'],
'pli': ['PLI'],
'plsql': ['PLSQL'],
@@ -35,7 +37,8 @@ const languageToSonarpedia = new Map(Object.entries({
'cloudformation': ['CLOUDFORMATION'],
'terraform': ['TERRAFORM'],
'kubernetes': ['KUBERNETES'],
- 'text': ['TEXT']
+ 'text': ['TEXT'],
+ 'ansible': ['ANSIBLE']
}));
export function useRuleCoverage() {
diff --git a/rspec-tools/Pipfile b/rspec-tools/Pipfile
index d40c75b8257..c5cf3882816 100644
--- a/rspec-tools/Pipfile
+++ b/rspec-tools/Pipfile
@@ -17,8 +17,8 @@ slackclient = "*"
[dev-packages]
pytest = ">=6.2.2"
mypy = ">=0.800"
-rspec-tools = {file = ".", editable = true}
pytest-snapshot = "*"
+rspec-tools = {file = ".", editable = true}
[requires]
python_version = "3.9"
diff --git a/rspec-tools/README.adoc b/rspec-tools/README.adoc
index ea46a5793bf..3e961e4d404 100644
--- a/rspec-tools/README.adoc
+++ b/rspec-tools/README.adoc
@@ -55,5 +55,5 @@ In order to generate an HTML file from the ASCIIdoc, you can use [asciidoctor](h
[source,sh]
----
-$ asciidoctor -e rule.adoc
+$ asciidoctor rule.adoc
----
diff --git a/rspec-tools/rspec_template/single_language/secrets/metadata.json b/rspec-tools/rspec_template/single_language/secrets/metadata.json
new file mode 100644
index 00000000000..8635b7d61ca
--- /dev/null
+++ b/rspec-tools/rspec_template/single_language/secrets/metadata.json
@@ -0,0 +1,56 @@
+{
+ "title": "SECRET_TYPE should not be disclosed",
+ "type": "VULNERABILITY",
+ "code": {
+ "impacts": {
+ "SECURITY": "HIGH"
+ },
+ "attribute": "TRUSTWORTHY"
+ },
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "30min"
+ },
+ "tags": [
+ "cwe",
+ "cert"
+ ],
+ "defaultSeverity": "Blocker",
+ "ruleSpecification": "RSPEC-${RSPEC_ID}",
+ "sqKey": "S${RSPEC_ID}",
+ "scope": "All",
+ "securityStandards": {
+ "CWE": [
+ 798,
+ 259
+ ],
+ "OWASP": [
+ "A3"
+ ],
+ "CERT": [
+ "MSC03-J."
+ ],
+ "OWASP Top 10 2021": [
+ "A7"
+ ],
+ "PCI DSS 3.2": [
+ "6.5.10"
+ ],
+ "PCI DSS 4.0": [
+ "6.2.4"
+ ],
+ "ASVS 4.0": [
+ "2.10.4",
+ "3.5.2",
+ "6.4.1"
+ ],
+ "STIG ASD_V5R3": [
+ "V-222642"
+ ]
+ },
+ "defaultQualityProfiles": [
+ "Sonar way"
+ ],
+ "quickfix": "unknown"
+}
diff --git a/rspec-tools/rspec_template/single_language/secrets/rule.adoc b/rspec-tools/rspec_template/single_language/secrets/rule.adoc
new file mode 100644
index 00000000000..28f3a64def8
--- /dev/null
+++ b/rspec-tools/rspec_template/single_language/secrets/rule.adoc
@@ -0,0 +1,50 @@
+
+include::../../../shared_content/secrets/description.adoc[]
+
+== Why is this an issue?
+
+include::../../../shared_content/secrets/rationale.adoc[]
+
+=== What is the potential impact?
+
+// Optional: Give a general description of the secret and what it's used for.
+
+Below are some real-world scenarios that illustrate some impacts of an attacker
+exploiting the secret.
+
+// Set value that can be used to refer to the type of secret in, for example:
+// "An attacker can use this {secret_type} to ..."
+:secret_type: secret
+
+// Where possible, use predefined content for common impacts. This content can
+// be found in the folder "shared_content/secrets/impact".
+// When using predefined content, search for any required variables to be set and include them in this file.
+// Not adding them will not trigger warnings.
+
+//include::../../../shared_content/secrets/impact/some_impact.adoc[]
+
+== How to fix it
+
+include::../../../shared_content/secrets/fix/revoke.adoc[]
+
+include::../../../shared_content/secrets/fix/vault.adoc[]
+
+=== Code examples
+
+:example_secret: example_secret_value
+:example_name: java-property-name
+:example_env: ENV_VAR_NAME
+
+include::../../../shared_content/secrets/examples.adoc[]
+
+//=== How does this work?
+
+//=== Pitfalls
+
+//=== Going the extra mile
+
+== Resources
+
+include::../../../shared_content/secrets/resources/standards.adoc[]
+
+//=== Benchmarks
diff --git a/rspec-tools/rspec_tools/checklinks.py b/rspec-tools/rspec_tools/checklinks.py
index ec422268386..39a4da39f6f 100644
--- a/rspec-tools/rspec_tools/checklinks.py
+++ b/rspec-tools/rspec_tools/checklinks.py
@@ -1,21 +1,28 @@
-import os,io
-import re
-import requests
+import datetime
import json
+import pathlib
import random
-import datetime
+import socket
+
+import requests
from bs4 import BeautifulSoup
-from socket import timeout
-import pathlib
TOLERABLE_LINK_DOWNTIME = datetime.timedelta(days=7)
LINK_PROBES_HISTORY_FILE = './link_probes.history'
-PROBING_COOLDOWN = datetime.timedelta(days=1)
-PROBING_SPREAD = 100 # minutes
+PROBING_COOLDOWN = datetime.timedelta(days=2)
+PROBING_SPREAD = 60 * 24 # in minutes, 1 day
link_probes_history = {}
# These links consistently fail in CI, but work-on-my-machine
-EXCEPTIONS = [
+EXCEPTION_PREFIXES = [
+ # It seems the server certificate was renewed on 2nd of August 2024.
+ # The server is sending only its certificate, without including the
+ # Intermediate certificate used to issue the server cert. Because of that
+ # some application are not able to verify the complete chain of trust.
+ "https://wiki.sei.cmu.edu/",
+ # The CI reports 403 on drupal.org while it works locally.
+ # Maybe the CI's IP is blocklisted...
+ "https://www.drupal.org/",
]
def show_files(filenames):
@@ -65,7 +72,7 @@ def live_url(url: str, timeout=5):
req = requests.Request('GET', url, headers = {'sec-ch-ua': '" Not A;Brand";v="99", "Chromium";v="90"',
'sec-ch-ua-mobile': '?0',
'Upgrade-Insecure-Requests': '1',
- 'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.93 Safari/537.36',
+ 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36 GLS/100.10.9939.100',
'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9',
'Sec-Fetch-Site':'none',
'Sec-Fetch-Mode':'navigate',
@@ -94,13 +101,13 @@ def live_url(url: str, timeout=5):
print(f"ERROR: Too many redirects: {rr}")
return False
except requests.Timeout as t:
- print(f"ERROR: timeout ", t)
+ print(f"ERROR: Request timeout {t}")
return False
- except timeout as t:
- print(f"ERROR: timeout ", t)
+ except socket.timeout as t:
+ print(f"ERROR: Socket timeout {t}")
return False
except Exception as e:
- print(f"ERROR: ", e)
+ print(f"ERROR: {e}")
return False
def findurl_in_html(filename,urls):
@@ -145,20 +152,51 @@ def get_all_links_from_htmls(dir):
print("All html files crawled")
return urls
-def probe_links(urls):
+def url_is_exception(url: str) -> bool:
+ return any(
+ url.startswith(e) for e in EXCEPTION_PREFIXES
+ )
+
+def probe_links(urls: dict) -> bool:
errors = []
+ link_cache_exception = 0
+ link_cache_hit = 0
+ link_cache_miss = 0
print("Testing links")
- for url in urls:
- print(f"{url} in {len(urls[url])} files")
- if url in EXCEPTIONS:
+ link_count = len(urls)
+ for idx, url in enumerate(urls):
+ print(f"[{idx+1}/{link_count}] {url} in {len(urls[url])} files")
+ if url_is_exception(url):
+ link_cache_exception += 1
print("skip as an exception")
elif url_was_reached_recently(url):
+ link_cache_hit += 1
print("skip probing because it was reached recently")
elif live_url(url, timeout=5):
+ link_cache_miss += 1
rejuvenate_url(url)
elif url_is_long_dead(url):
+ link_cache_miss += 1
errors.append(url)
- return errors
+ else:
+ link_cache_miss += 1
+
+ confirmed_errors = confirm_errors(errors, urls)
+
+ print(f"\n\n\n{'=' * 80}\n\n\n")
+ if confirmed_errors:
+ report_errors(confirmed_errors, urls)
+ print(f"{len(confirmed_errors)}/{len(urls)} links are dead, see above ^^ the list and the related files\n\n")
+ print("Cache statistics:")
+ print(f"\t{link_cache_hit=}")
+ print(f"\t{link_cache_miss=}")
+ link_cache_hit_ratio = (link_cache_hit) / (link_cache_hit + link_cache_miss)
+ print(f"\t{link_cache_hit_ratio:03.2%} hits")
+ print(f"\t{link_cache_exception=}")
+ print(f"\n\n\n{'=' * 80}\n\n\n")
+
+ success = len(confirmed_errors) == 0
+ return success
def confirm_errors(presumed_errors, urls):
confirmed_errors = []
@@ -180,16 +218,9 @@ def report_errors(errors, urls):
def check_html_links(dir):
load_url_probing_history()
urls = get_all_links_from_htmls(dir)
- errors = probe_links(urls)
- exit_code = 0
- if errors:
- confirmed_errors = confirm_errors(errors, urls)
- if confirmed_errors:
- report_errors(confirmed_errors, urls)
- print(f"{len(confirmed_errors)}/{len(urls)} links are dead, see above ^^ the list and the related files")
- exit_code = 1
- if exit_code == 0:
+ success = probe_links(urls)
+ if success:
print(f"All {len(urls)} links are good")
save_url_probing_history()
- exit(exit_code)
+ exit(0 if success else 1)
diff --git a/rspec-tools/rspec_tools/cli.py b/rspec-tools/rspec_tools/cli.py
index 0b1e85e44bb..71abb95b6d4 100644
--- a/rspec-tools/rspec_tools/cli.py
+++ b/rspec-tools/rspec_tools/cli.py
@@ -17,7 +17,8 @@
validate_parameters,
validate_section_levels,
validate_section_names,
- validate_source_language)
+ validate_source_language,
+ validate_security_standard_links)
from rspec_tools.validation.sanitize_asciidoc import sanitize_asciidoc
from rspec_tools.validation.metadata import validate_rule_metadata
@@ -104,6 +105,7 @@ def check_asciidoc(files):
validate_section_levels,
validate_parameters,
validate_source_language,
+ validate_security_standard_links,
]
def _validate_rule_specialization(lang_spec_rule: LanguageSpecificRule):
error_counter = 0
diff --git a/rspec-tools/rspec_tools/coverage.py b/rspec-tools/rspec_tools/coverage.py
index 909b49793d5..48e4e5cae92 100644
--- a/rspec-tools/rspec_tools/coverage.py
+++ b/rspec-tools/rspec_tools/coverage.py
@@ -1,13 +1,43 @@
+import collections
+import json
import os
+import re
import sys
-import json
-from git import Repo
-from git import Git
from pathlib import Path
-from rspec_tools.utils import (load_json, pushd)
-
-REPOS = ['sonar-abap','sonar-cpp','sonar-cobol','sonar-dotnet','sonar-css','sonar-flex','slang-enterprise','sonar-java','SonarJS','sonar-php','sonar-pli','sonar-plsql','sonar-python','sonar-rpg','sonar-swift','sonar-text','sonar-tsql','sonar-vb','sonar-html','sonar-xml','sonar-kotlin', 'sonar-secrets', 'sonar-security', 'sonar-iac']
+from git import Git, Repo
+from rspec_tools.utils import load_json, pushd
+
+REPOS = [
+ 'sonar-abap',
+ 'sonar-apex',
+ 'sonar-architecture',
+ 'sonar-cobol',
+ 'sonar-cpp',
+ 'sonar-dart',
+ 'sonar-dataflow-bug-detection',
+ 'sonar-dotnet-enterprise',
+ 'sonar-flex',
+ 'sonar-go-enterprise',
+ 'sonar-html',
+ 'sonar-iac-enterprise',
+ 'sonar-java',
+ 'SonarJS',
+ 'sonar-kotlin',
+ 'sonar-php',
+ 'sonar-pli',
+ 'sonar-plsql',
+ 'sonar-python',
+ 'sonar-rpg',
+ 'sonar-ruby',
+ 'sonar-scala',
+ 'sonar-security',
+ 'sonar-swift',
+ 'sonar-text-enterprise',
+ 'sonar-tsql',
+ 'sonar-vb',
+ 'sonar-xml'
+]
CANONICAL_NAMES = {
'CLOUD_FORMATION': 'CLOUDFORMATION',
@@ -16,14 +46,14 @@
'WEB': 'HTML'
}
+
RULES_FILENAME = 'covered_rules.json'
+
def get_rule_id(filename):
rule_id = filename[:-5]
- if '_' in rule_id:
- return rule_id[:rule_id.find('_')]
- else:
- return rule_id
+ return rule_id.removesuffix('_abap').removesuffix('_java')
+
def compatible_languages(rule, languages_from_sonarpedia):
'''
@@ -42,7 +72,7 @@ def get_implemented_rules(path, languages_from_sonarpedia):
for lang in languages_from_sonarpedia:
implemented_rules[lang] = []
for filename in os.listdir(path):
- if filename.endswith(".json") and not filename.startswith("Sonar_way"):
+ if filename.endswith(".json") and 'profile' not in filename:
rule = load_json(os.path.join(path, filename))
rule_id = get_rule_id(filename)
for language in compatible_languages(rule, languages_from_sonarpedia):
@@ -133,7 +163,7 @@ def add_analyzer_version(self, analyzer, version, implemented_rules_per_language
self.rule_implemented(rule_id, language, analyzer, version)
def all_implemented_rules():
- implemented_rules = {}
+ implemented_rules = collections.defaultdict(list)
for sp_file in Path('.').rglob('sonarpedia.json'):
print(sp_file)
sonarpedia_path=sp_file.parents[0]
@@ -141,7 +171,10 @@ def all_implemented_rules():
sonarpedia = load_json(sp_file)
path = str(sonarpedia_path) + '/' + sonarpedia['rules-metadata-path'].replace('\\', '/')
languages = sonarpedia['languages']
- implemented_rules.update(get_implemented_rules(path, languages))
+
+ implemented_rules_in_path = get_implemented_rules(path, languages)
+ for lang, rules in implemented_rules_in_path.items():
+ implemented_rules[lang] += rules
except Exception as e:
print(f"failed to collect implemented rules for {sp_file}: {e}")
continue
@@ -151,17 +184,29 @@ def checkout_repo(repo):
git_url=f"https://github.com/SonarSource/{repo}"
token=os.getenv('GITHUB_TOKEN')
if token:
- git_url=f"https://{token}@github.com/SonarSource/{repo}"
+ git_url=f"https://oauth2:{token}@github.com/SonarSource/{repo}"
if not os.path.exists(repo):
return Repo.clone_from(git_url, repo)
else:
return Repo(repo)
+
+VERSION_RE = re.compile(r'\d[\d\.]+')
+def is_version_tag(name):
+ return bool(re.fullmatch(VERSION_RE, name))
+
+
+def comparable_version(key):
+ if not is_version_tag(key):
+ return [0]
+ return list(map(int, key.split('.')))
+
+
def collect_coverage_for_all_versions(repo, coverage):
git_repo = checkout_repo(repo)
tags = git_repo.tags
- tags.sort(key = lambda t: t.commit.committed_date)
- versions = [tag.name for tag in tags if '-' not in tag.name]
+ versions = [tag.name for tag in tags if is_version_tag(tag.name)]
+ versions.sort(key = comparable_version)
for version in versions:
collect_coverage_for_version(repo, git_repo, version, coverage)
collect_coverage_for_version(repo, git_repo, 'master', coverage)
diff --git a/rspec-tools/rspec_tools/create_rule.py b/rspec-tools/rspec_tools/create_rule.py
index c9f57af1535..c247730ca2e 100644
--- a/rspec-tools/rspec_tools/create_rule.py
+++ b/rspec-tools/rspec_tools/create_rule.py
@@ -95,7 +95,7 @@ def _fill_language_name_in_the_template(self, lang_dir: Path, language: str):
if rule_item.is_file():
template_content = rule_item.read_text()
lang = LANG_TO_SOURCE[language]
- final_content = template_content.replace('[source,text]', f'[source,{lang}]')
+ final_content = template_content.replace('[source,text', f'[source,{lang}')
rule_item.write_text(final_content)
def _fill_multi_lang_template_files(self, rule_dir: Path, rule_number: int, languages: Iterable[str]):
@@ -113,7 +113,9 @@ def _fill_multi_lang_template_files(self, rule_dir: Path, rule_number: int, lang
def _fill_single_lang_template_files(self, rule_dir: Path, rule_number: int, language: str):
common_template = self.TEMPLATE_PATH / 'single_language' / 'common'
- lang_specific_template = self.TEMPLATE_PATH / 'single_language' / 'language_specific'
+ lang_specific_template = self.TEMPLATE_PATH / 'single_language' / language
+ if not Path(lang_specific_template).exists():
+ lang_specific_template = self.TEMPLATE_PATH / 'single_language' / 'language_specific'
copy_directory_content(common_template, rule_dir)
lang_dir = rule_dir /language
diff --git a/rspec-tools/rspec_tools/utils.py b/rspec-tools/rspec_tools/utils.py
index 885a4dad030..a80caac0db9 100644
--- a/rspec-tools/rspec_tools/utils.py
+++ b/rspec-tools/rspec_tools/utils.py
@@ -16,12 +16,14 @@
'cobol': 'cobol',
'csharp': 'dotnet',
'css': 'css',
+ 'dart': 'dart',
'docker': 'iac',
'flex': 'flex',
'go': 'slang',
'html': 'html',
'java': 'java',
'javascript': 'jsts',
+ 'jcl': 'jcl',
'kotlin': 'kotlin',
'php': 'php',
'pli': 'pli',
@@ -38,6 +40,7 @@
'tsql': 'tsql',
'vb6': 'vb6',
'vbnet': 'dotnet',
+ 'ansible': 'iac',
'cloudformation': 'iac',
'terraform': 'iac',
'kubernetes': 'iac',
@@ -51,10 +54,12 @@
'cloudformation': 'yaml',
'csharp': 'csharp',
'css': 'css',
+ 'dart': 'dart',
'docker': 'docker',
'go': 'go',
'html': 'html',
'java': 'java',
+ 'jcl': 'jcl',
'javascript': 'javascript',
'json': 'json',
'kotlin': 'kotlin',
@@ -72,6 +77,7 @@
'c': 'c',
'objectivec': 'objectivec',
'vb': 'vb',
+ 'ansible': 'yaml',
# these languages are not supported by highlight.js as the moment:
'apex': 'apex',
'azureresourcemanager': 'bicep',
diff --git a/rspec-tools/rspec_tools/validation/description.py b/rspec-tools/rspec_tools/validation/description.py
index f566bc95a5a..96271728293 100644
--- a/rspec-tools/rspec_tools/validation/description.py
+++ b/rspec-tools/rspec_tools/validation/description.py
@@ -1,12 +1,12 @@
-from bs4 import BeautifulSoup
+import re
from pathlib import Path
-from typing import Final
+from typing import Dict, Final, List, Union
+from bs4 import BeautifulSoup
from rspec_tools.errors import RuleValidationError
from rspec_tools.rules import LanguageSpecificRule
from rspec_tools.utils import LANG_TO_SOURCE
-import re
def read_file(path):
section_names_path = Path(__file__).parent.parent.parent.parent.joinpath(path)
@@ -16,8 +16,35 @@ def parse_names(path):
section_names_path = read_file(path)
return [s.replace('* ', '').strip() for s in section_names_path if s.strip()]
+def parse_security_standard_links(descr):
+ link_nodes = descr.find_all('a')
+ security_standards_links: Dict[str, List] = {}
+ for node in link_nodes:
+ href = node.attrs['href']
+ for standard_key in SECURITY_STANDARD_URL:
+ standard = SECURITY_STANDARD_URL[standard_key]
+ url_pattern = standard["url_pattern"]
+ result = re.match(url_pattern, href)
+ if result is not None:
+ convert = standard["convert_id"]
+ category = convert(result[1])
+ if standard_key not in security_standards_links.keys():
+ security_standards_links[standard_key] = []
+ security_standards_links[standard_key].append(category)
+ return security_standards_links
+
HOW_TO_FIX_IT = 'How to fix it'
HOW_TO_FIX_IT_REGEX = re.compile(HOW_TO_FIX_IT)
+SECURITY_STANDARD_URL = {
+ "OWASP": {
+ "url_pattern": r"https://(?:www\.)?owasp\.org/www-project-top-ten/2017/A(10|[1-9])_2017-",
+ "convert_id": lambda value: f"A{value.lstrip('0')}",
+ },
+ "OWASP Top 10 2021": {
+ "url_pattern": r"https://(?:www\.)?owasp\.org/Top10/A(10|0[1-9])_2021-",
+ "convert_id": lambda value: f"A{value.lstrip('0')}",
+ },
+}
# The list of all the sections currently accepted by the script.
# The list includes multiple variants for each title because they all occur
@@ -33,7 +60,7 @@ def parse_names(path):
CODE_EXAMPLES='Code examples'
OPTIONAL_SECTIONS = {
# Also covers 'How to fix it in {Framework Display Name}'
- 'How to fix it': [CODE_EXAMPLES, 'How does this work?', 'Pitfalls', 'Going the extra mile'],
+ HOW_TO_FIX_IT: [], # Empty list because we now accept anything as sub-section
'Resources': ['Documentation', 'Articles & blog posts', 'Conference presentations', 'Standards', 'External coding guidelines', 'Benchmarks', 'Related rules']
}
SUBSECTIONS = {
@@ -51,15 +78,26 @@ def intersection(list1, list2):
def difference(list1, list2):
return list(set(list1) - set(list2))
+def validate_titles_are_not_misclassified_as_subtitles(rule_language: LanguageSpecificRule, subtitles: list[str], allowed_h2_sections: list[str]):
+ # TODO This does not validate "How to fix it" section for frameworks as the section names are a bit special.
+ misclassified = intersection(subtitles, allowed_h2_sections)
+ if misclassified:
+ misclassified.sort()
+ misclassified_str = ', '.join(misclassified)
+ raise RuleValidationError(f'Rule {rule_language.id} has some sections misclassified. Ensure there are not too many `=` in the asciidoc file for: {misclassified_str}')
+
def validate_section_names(rule_language: LanguageSpecificRule):
"""Validates all h2-level section names"""
+ def get_titles(level: Union[str, list[str]]) -> list[str]:
+ return list(map(lambda x: x.text.strip(), rule_language.description.find_all(level)))
- descr = rule_language.description
- h2_titles = list(map(lambda x: x.text.strip(), descr.find_all('h2')))
-
+ h2_titles = get_titles('h2')
+ subtitles = get_titles(['h3', 'h4', 'h5', 'h6'])
+ allowed_h2_sections = list(MANDATORY_SECTIONS) + list(OPTIONAL_SECTIONS.keys())
+ validate_titles_are_not_misclassified_as_subtitles(rule_language, subtitles, allowed_h2_sections)
validate_duplications(h2_titles, rule_language)
- education_titles = intersection(h2_titles, list(MANDATORY_SECTIONS) + list(OPTIONAL_SECTIONS.keys()))
+ education_titles = intersection(h2_titles, allowed_h2_sections)
if education_titles:
# Using the education format.
validate_how_to_fix_it_sections_names(rule_language, h2_titles)
@@ -192,8 +230,32 @@ def validate_subsections_for_section(rule_language: LanguageSpecificRule, sectio
subsections_seen = set()
for title in titles:
name = title.text.strip()
- if name not in allowed_subsections:
+ if allowed_subsections and name not in allowed_subsections:
raise RuleValidationError(f'Rule {rule_language.id} has a "{section_name}" subsection with an unallowed name: "{name}"')
if name in subsections_seen and not is_duplicate_allowed:
raise RuleValidationError(f'Rule {rule_language.id} has duplicate "{section_name}" subsections. There are 2 occurences of "{name}"')
subsections_seen.add(name)
+
+
+def validate_security_standard_links(rule_language: LanguageSpecificRule):
+ descr = rule_language.description
+ security_standards_links = parse_security_standard_links(descr)
+ metadata = rule_language.metadata
+
+ # Avoid raising mismatch issues on deprecated or closed rules
+ if metadata.get('status') != 'ready':
+ return
+
+ security_standards_metadata = metadata.get('securityStandards', {})
+ for standard in SECURITY_STANDARD_URL.keys():
+
+ metadata_mapping = security_standards_metadata[standard] if standard in security_standards_metadata.keys() else []
+ links_mapping = security_standards_links[standard] if standard in security_standards_links.keys() else []
+
+ extra_links = difference(links_mapping, metadata_mapping)
+ if len(extra_links) > 0:
+ raise RuleValidationError(f'Rule {rule_language.id} has a mismatch for the {standard} security standards. Remove links from the Resources/See section ({extra_links}) or fix the rule metadata')
+
+ missing_links = difference(metadata_mapping, links_mapping)
+ if len(missing_links) > 0:
+ raise RuleValidationError(f'Rule {rule_language.id} has a mismatch for the {standard} security standards. Add links to the Resources/See section ({missing_links}) or fix the rule metadata')
diff --git a/rspec-tools/rspec_tools/validation/rule-metadata-schema.json b/rspec-tools/rspec_tools/validation/rule-metadata-schema.json
index 7dd0ac04e2b..18fceff5ee8 100644
--- a/rspec-tools/rspec_tools/validation/rule-metadata-schema.json
+++ b/rspec-tools/rspec_tools/validation/rule-metadata-schema.json
@@ -218,6 +218,15 @@
"pattern": "^\\d+\\.\\d+\\.\\d+$"
},
"uniqueItems": true
+ },
+ "STIG ASD_V5R3": {
+ "type": "array",
+ "minItems": 0,
+ "items": {
+ "type": "string",
+ "pattern": "^V-\\d+$"
+ },
+ "uniqueItems": true
}
}
},
@@ -258,15 +267,15 @@
"properties": {
"MAINTAINABILITY": {
"type": "string",
- "enum": ["LOW", "MEDIUM", "HIGH"]
+ "enum": ["INFO", "LOW", "MEDIUM", "HIGH", "BLOCKER"]
},
"RELIABILITY": {
"type": "string",
- "enum": ["LOW", "MEDIUM", "HIGH"]
+ "enum": ["INFO", "LOW", "MEDIUM", "HIGH", "BLOCKER"]
},
"SECURITY": {
"type": "string",
- "enum": ["LOW", "MEDIUM", "HIGH"]
+ "enum": ["INFO", "LOW", "MEDIUM", "HIGH", "BLOCKER"]
}
}
},
diff --git a/rspec-tools/rspec_tools/validation/sanitize_asciidoc.py b/rspec-tools/rspec_tools/validation/sanitize_asciidoc.py
index 9f0e3fd52b3..8732be852d9 100644
--- a/rspec-tools/rspec_tools/validation/sanitize_asciidoc.py
+++ b/rspec-tools/rspec_tools/validation/sanitize_asciidoc.py
@@ -4,71 +4,82 @@
* "ifdef"/"endif" blocks should be well-formed for RSPEC
* Inline code with backquotes is correctly escaped and balanced
* Include commands are not appended to other code
+* "C++" is referred to using the {cpp} attribute
+* rules.sonarsource.com is not linked directly
"""
-from pathlib import Path
-import re
+import re
+from pathlib import Path
VALID_IFDEF = "ifdef::env-github,rspecator-view[]"
VALID_ENDIF = "endif::env-github,rspecator-view[]"
-VARIABLE_DECL = re.compile(r':\w+: ')
+VARIABLE_DECL = re.compile(r":\w+: ")
-INCLUDE = re.compile(r'include::')
+INCLUDE = re.compile(r"include::")
-FORMATTING_CHARS = ['_', r'\*', r'\#']
-WORD_FORMATTING_CHARS = [r'\~', r'\^']
+FORMATTING_CHARS = ["_", r"\*", r"\#"]
+WORD_FORMATTING_CHARS = [r"\~", r"\^"]
# If the formatting char is repeated twice, it can go anywhere
-UNCONSTRAINED_FORMATTING = '|'.join(x + x for x in FORMATTING_CHARS)
+UNCONSTRAINED_FORMATTING = "|".join(x + x for x in FORMATTING_CHARS)
# Single formatting char are dangerous at the beginning of a word
-FORMATTING_OPENING = '|'.join(r'(\W|^)' + x + r'\w' for x in FORMATTING_CHARS)
+FORMATTING_OPENING = "|".join(r"(\W|^)" + x + r"\w" for x in FORMATTING_CHARS)
# Single formatting char are dangerous at the end of a word
-FORMATTING_CLOSING = '|'.join(r'\w' + x + r'(\W|$)' for x in FORMATTING_CHARS)
+FORMATTING_CLOSING = "|".join(r"\w" + x + r"(\W|$)" for x in FORMATTING_CHARS)
# Word formatting is broken by spaces so we look for things like `#word#`
-WORD_FORMATTING = "|".join(x + r'\S+' + x for x in WORD_FORMATTING_CHARS)
+WORD_FORMATTING = "|".join(x + r"\S+" + x for x in WORD_FORMATTING_CHARS)
# We combine all the matchers
-NEED_PROTECTION = re.compile('('
- f'{UNCONSTRAINED_FORMATTING}|'
- f'{FORMATTING_OPENING}|'
- f'{FORMATTING_CLOSING}|'
- f'{WORD_FORMATTING}'
- ')')
+NEED_PROTECTION = re.compile(
+ "("
+ f"{UNCONSTRAINED_FORMATTING}|"
+ f"{FORMATTING_OPENING}|"
+ f"{FORMATTING_CLOSING}|"
+ f"{WORD_FORMATTING}"
+ ")"
+)
# There is a regex trick here:
# We want to stop the search if there is a backquote
# We do that by matching backquote OR the closing passthrough
# Then we'll ignore any match of backquote
-CLOSE_CONSTRAINED_PASSTHROUGH = re.compile(r'`|((?(``+)|(?(``+)|(? 0:
# `+++a++` will display '+a' in case of inbalance, we try to find the biggest closing block
if count == 1:
- if not line[pos + count].isspace() and line[pos - 1] == '`':
- #constrained '+'. It is a passthrough only if it is directly around text and surrounded by backquotes: `+Some Content+`
+ if not line[pos + count].isspace() and line[pos - 1] == "`":
+ # constrained '+'. It is a passthrough only if it is directly around text and surrounded by backquotes: `+Some Content+`
close_pattern = CLOSE_CONSTRAINED_PASSTHROUGH
else:
return pos
else:
- close_pattern = re.compile('(' + r'\+' * count + ')')
+ close_pattern = re.compile("(" + r"\+" * count + ")")
end = close_pattern.search(line, pos + count)
if end and end.group(1):
return end.end()
@@ -77,8 +88,8 @@ def close_passthrough(count, pos, line):
def skip_passthrough_macro(line, pos):
- '''If this is a passthrough macro, skip to the end'''
- if line[pos] == 'p':
+ """If this is a passthrough macro, skip to the end"""
+ if line[pos] == "p":
pm = PASSTHROUGH_MACRO.match(line, pos)
if pm:
return pm.end()
@@ -86,10 +97,10 @@ def skip_passthrough_macro(line, pos):
def skip_passthrough_plus(line, pos):
- '''If this is a passthrough +, skip to the end'''
- if line[pos] == '+':
+ """If this is a passthrough +, skip to the end"""
+ if line[pos] == "+":
count = 1
- while pos + count < len(line) and line[pos + count] == '+':
+ while pos + count < len(line) and line[pos + count] == "+":
count += 1
return close_passthrough(count, pos, line)
return pos
@@ -126,10 +137,10 @@ def process(self) -> bool:
lines = content.splitlines(keepends=False)
for line_index, line in enumerate(lines):
if self._is_inside_code:
- if line == '----':
+ if line == "----":
self._is_inside_code = False
continue
- if line == '----':
+ if line == "----":
self._is_inside_code = True
continue
line_number = line_index + 1
@@ -185,33 +196,65 @@ def _process_close_ifdef(self, line_number: int, line: str):
f'Incorrect endif command. "{VALID_ENDIF}" should be used instead.',
)
+ def _advance_to_next_backquote(self, line: str, pos: int, line_number: int):
+ next_pos = BACKQUOTE.search(line, pos)
+ if next_pos:
+ cpp = CPP.search(line, pos, endpos=next_pos.pos)
+ else:
+ cpp = CPP.search(line, pos)
+ if cpp:
+ self._on_error(
+ line_number,
+ 'To avoid rendering issues, always use the "{cpp}" attribute to refer to the language C++.',
+ )
+ return next_pos
+
def _process_description(self, line_number: int, line: str):
if VARIABLE_DECL.match(line):
return
if self._previous_line_was_include and not self._empty_line:
- self._on_error(line_number - 1, '''An empty line is missing after the include.
+ self._on_error(
+ line_number - 1,
+ """An empty line is missing after the include.
This may result in broken tags and other display issues.
-Make sure there are always empty lines before and after each include''')
+Make sure there are always empty lines before and after each include.""",
+ )
if INCLUDE.match(line):
self._previous_line_was_include = True
if not self._empty_line:
- self._on_error(line_number, '''An empty line is missing before the include.
+ self._on_error(
+ line_number,
+ """An empty line is missing before the include.
This may result in broken tags and other display issues.
-Make sure there are always empty lines before and after each include''')
+Make sure there are always empty lines before and after each include.""",
+ )
return
else:
self._previous_line_was_include = False
+ if RULES_SONARSOURCE.search(line) and not self._is_env_open:
+ self._on_error(
+ line_number,
+ """Do not put direct links to https://rules.sonarsource.com/.
+Just use the rule ID and let cross-reference substitution do its job.""",
+ )
pos = 0
- res = BACKQUOTE.search(line, pos)
+ res = self._advance_to_next_backquote(line, pos, line_number)
# We filter out matches for passthrough. See comment near the BACKQUOTE declaration
- while res and res.group('backquote'):
- pos = self._check_inlined_code(line_number, res.end(), line, res.group('backquote'))
- res = BACKQUOTE.search(line, pos)
+ while res and res.group("backquote"):
+ pos = self._check_inlined_code(
+ line_number, res.end(), line, res.group("backquote")
+ )
+ res = self._advance_to_next_backquote(line, pos, line_number)
- def _check_inlined_code(self, line_number: int, pos: int, line: str, opening_pattern: str):
+ def _check_inlined_code(
+ self, line_number: int, pos: int, line: str, opening_pattern: str
+ ):
if len(opening_pattern) > 2:
# Part of the backquotes are displayed as backquotes.
- self._on_error(line_number, 'Use "++" to isolate the backquotes you want to display from the ones that should be interpreted by AsciiDoc.')
+ self._on_error(
+ line_number,
+ 'Use "++" to isolate the backquotes you want to display from the ones that should be interpreted by AsciiDoc.',
+ )
return pos
elif len(opening_pattern) == 2:
closing_pattern = CLOSE_UNCONSTRAINED_BACKQUOTE
@@ -220,27 +263,30 @@ def _check_inlined_code(self, line_number: int, pos: int, line: str, opening_pat
content_end, content = close_inline_block(line, pos, closing_pattern)
if content_end < 0:
- message='Unbalanced code inlining tags.'
+ message = "Unbalanced code inlining tags."
if len(opening_pattern) == 1:
- message += '''
+ message += """
If you are trying to write inline code that is glued to text without a space,
you need to use double backquotes:
> Replace all `reference`s.
Will not display correctly. You need to write:
> Replace all ``reference``s.
-'''
+"""
self._on_error(line_number, message)
return len(line)
pos = content_end + len(opening_pattern)
if NEED_PROTECTION.search(content):
- self._on_error (line_number, f'''
+ self._on_error(
+ line_number,
+ f"""
Using backquotes does not protect against asciidoc interpretation. Starting or
ending a word with '*', '#', '_' or having two of them consecutively will
trigger unintended behavior with the rest of the text.
Use ``++{content}++`` to avoid that.
If you really want to have formatting inside your code, you can write
``pass:n[{content}]``
-''')
+""",
+ )
return pos
return pos
diff --git a/rspec-tools/tests/resources/asciidoc/valid.adoc b/rspec-tools/tests/resources/asciidoc/valid.adoc
index 70bdc8ded4d..dc272cffe9a 100644
--- a/rspec-tools/tests/resources/asciidoc/valid.adoc
+++ b/rspec-tools/tests/resources/asciidoc/valid.adoc
@@ -24,8 +24,13 @@ The pass:[``++Can have __ [escaped brackets\] __ ++``]
[source,python]
----
# We don't care about `in the code
+
+We also don't care about writing C++ or c++
+
----
+Inside descriptions, we only use {cpp} to refer to the language
+
We can have a sole ` surrounded by spaces
This file does not exist but we only check that the include is well placed:
diff --git a/rspec-tools/tests/resources/invalid-asciidoc/link_rule_sonarsource_com.adoc b/rspec-tools/tests/resources/invalid-asciidoc/link_rule_sonarsource_com.adoc
new file mode 100644
index 00000000000..60368548401
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-asciidoc/link_rule_sonarsource_com.adoc
@@ -0,0 +1,16 @@
+== Title
+
+In this case, there is also an impact on reliability and so it is handled by the rule https://rules.sonarsource.com/java/RSPEC-5810/[S5810].
+
+=== Documentation
+
+* https://rules.sonarsource.com/csharp/RSPEC-6420/[S6420 - Client instances should not be recreated on each Azure Function invocation]
+
+
+ifdef::env-github,rspecator-view[]
+
+https://rules.sonarsource.com/csharp/RSPEC-6420/[We ignore rspecator view]
+
+endif::env-github,rspecator-view[]
+
+http://rules.sonarsource.com/csharp/RSPEC-6420/[We detect http too]
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_after.txt b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_after.txt
index 69927bfa99a..07be556778b 100644
--- a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_after.txt
+++ b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_after.txt
@@ -1,3 +1,3 @@
$PATH/include_stuck_after.adoc:3 An empty line is missing after the include.
This may result in broken tags and other display issues.
-Make sure there are always empty lines before and after each include
+Make sure there are always empty lines before and after each include.
diff --git a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_before.txt b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_before.txt
index 77d256f177f..98c4a3ee2ee 100644
--- a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_before.txt
+++ b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/include_stuck_before.txt
@@ -1,3 +1,3 @@
$PATH/include_stuck_before.adoc:2 An empty line is missing before the include.
This may result in broken tags and other display issues.
-Make sure there are always empty lines before and after each include
+Make sure there are always empty lines before and after each include.
diff --git a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/link_rule_sonarsource_com.txt b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/link_rule_sonarsource_com.txt
new file mode 100644
index 00000000000..2ddadb4def8
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/link_rule_sonarsource_com.txt
@@ -0,0 +1,6 @@
+$PATH/link_rule_sonarsource_com.adoc:3 Do not put direct links to https://rules.sonarsource.com/.
+Just use the rule ID and let cross-reference substitution do its job.
+$PATH/link_rule_sonarsource_com.adoc:7 Do not put direct links to https://rules.sonarsource.com/.
+Just use the rule ID and let cross-reference substitution do its job.
+$PATH/link_rule_sonarsource_com.adoc:16 Do not put direct links to https://rules.sonarsource.com/.
+Just use the rule ID and let cross-reference substitution do its job.
diff --git a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/two_stuck_includes.txt b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/two_stuck_includes.txt
index 10bf28381bb..340e4acdfe5 100644
--- a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/two_stuck_includes.txt
+++ b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/two_stuck_includes.txt
@@ -1,6 +1,6 @@
$PATH/two_stuck_includes.adoc:3 An empty line is missing after the include.
This may result in broken tags and other display issues.
-Make sure there are always empty lines before and after each include
+Make sure there are always empty lines before and after each include.
$PATH/two_stuck_includes.adoc:4 An empty line is missing before the include.
This may result in broken tags and other display issues.
-Make sure there are always empty lines before and after each include
+Make sure there are always empty lines before and after each include.
diff --git a/rspec-tools/tests/resources/invalid-asciidoc/snapshots/unnamed_language.txt b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/unnamed_language.txt
new file mode 100644
index 00000000000..19e273406d6
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-asciidoc/snapshots/unnamed_language.txt
@@ -0,0 +1,2 @@
+$PATH/unnamed_language.adoc:1 To avoid rendering issues, always use the "{cpp}" attribute to refer to the language C++.
+$PATH/unnamed_language.adoc:3 To avoid rendering issues, always use the "{cpp}" attribute to refer to the language C++.
diff --git a/rspec-tools/tests/resources/invalid-asciidoc/unnamed_language.adoc b/rspec-tools/tests/resources/invalid-asciidoc/unnamed_language.adoc
new file mode 100644
index 00000000000..40c0898e715
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-asciidoc/unnamed_language.adoc
@@ -0,0 +1,5 @@
+We shouldn't mention the language C++ by its name.
+
+Nor by c++ for what it's worth.
+
+We should use the built-in attribute {cpp} instead.
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/invalid-rules/S100/metadata.json b/rspec-tools/tests/resources/invalid-rules/S100/metadata.json
new file mode 100644
index 00000000000..2c63c085104
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-rules/S100/metadata.json
@@ -0,0 +1,2 @@
+{
+}
diff --git a/rspec-tools/tests/resources/invalid-rules/S100/php/metadata.json b/rspec-tools/tests/resources/invalid-rules/S100/php/metadata.json
new file mode 100644
index 00000000000..68702a9782c
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-rules/S100/php/metadata.json
@@ -0,0 +1,6 @@
+{
+ "title": "Function names should comply with a naming convention",
+ "defaultQualityProfiles": [
+
+ ]
+}
diff --git a/rspec-tools/tests/resources/invalid-rules/S100/php/rule.adoc b/rspec-tools/tests/resources/invalid-rules/S100/php/rule.adoc
new file mode 100644
index 00000000000..63f64743211
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-rules/S100/php/rule.adoc
@@ -0,0 +1,5 @@
+== Why is this an issue?
+
+=== How to fix it
+
+=== Resources
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/invalid-rules/S100/php/rule.html b/rspec-tools/tests/resources/invalid-rules/S100/php/rule.html
new file mode 100644
index 00000000000..d7afbf83140
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-rules/S100/php/rule.html
@@ -0,0 +1,457 @@
+
+
+
+
+
+
+
+Why is this an issue?
+
+
+
+
+' isn't an UpperCamelCase identifier.
+
+=== Highlighting
+
+The type name (without generic parameters, or representation type declaration).
+
+'''
+== Comments And Links
+(visible only on this page)
+
+include::../comments-and-links.adoc[]
+
+endif::env-github,rspecator-view[]
diff --git a/rules/S101/java/metadata.json b/rules/S101/java/metadata.json
index 17971333806..f4b27f0bb34 100644
--- a/rules/S101/java/metadata.json
+++ b/rules/S101/java/metadata.json
@@ -1,3 +1,3 @@
{
-
+ "scope": "Main"
}
diff --git a/rules/S103/java/metadata.json b/rules/S103/java/metadata.json
index 17971333806..f4b27f0bb34 100644
--- a/rules/S103/java/metadata.json
+++ b/rules/S103/java/metadata.json
@@ -1,3 +1,3 @@
{
-
+ "scope": "Main"
}
diff --git a/rules/S103/php/metadata.json b/rules/S103/php/metadata.json
index d860fd4691d..0db3279e44b 100644
--- a/rules/S103/php/metadata.json
+++ b/rules/S103/php/metadata.json
@@ -1,5 +1,3 @@
{
- "defaultQualityProfiles": [
- "Sonar way"
- ]
+
}
diff --git a/rules/S1032/cfamily/metadata.json b/rules/S1032/cfamily/metadata.json
index 336c9a190f8..9730fd0059b 100644
--- a/rules/S1032/cfamily/metadata.json
+++ b/rules/S1032/cfamily/metadata.json
@@ -3,7 +3,7 @@
"type": "CODE_SMELL",
"code": {
"impacts": {
- "MAINTAINABILITY": "HIGH"
+ "MAINTAINABILITY": "BLOCKER"
},
"attribute": "CLEAR"
},
@@ -17,19 +17,13 @@
"based-on-misra"
],
"extra": {
- "replacementRules": [
-
- ],
- "legacyKeys": [
-
- ]
+ "replacementRules": [],
+ "legacyKeys": []
},
"defaultSeverity": "Blocker",
"ruleSpecification": "RSPEC-1032",
"sqKey": "S1032",
"scope": "Main",
- "defaultQualityProfiles": [
-
- ],
+ "defaultQualityProfiles": [],
"quickfix": "unknown"
}
diff --git a/rules/S1032/cfamily/rule.adoc b/rules/S1032/cfamily/rule.adoc
index 8051d38152e..24a17f2b59f 100644
--- a/rules/S1032/cfamily/rule.adoc
+++ b/rules/S1032/cfamily/rule.adoc
@@ -44,7 +44,7 @@ bool isMax(T t){
== Resources
* MISRA {cpp}:2008, 14-8-1
-* https://github.com/isocpp/CppCoreGuidelines/blob/036324/CppCoreGuidelines.md#t144-dont-specialize-function-templates[{cpp} Core Guidelines T.144] - Don’t specialize function templates
+* {cpp} Core Guidelines - https://github.com/isocpp/CppCoreGuidelines/blob/e49158a/CppCoreGuidelines.md#t144-dont-specialize-function-templates[T.144: Don't specialize function templates]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S1036/cfamily/metadata.json b/rules/S1036/cfamily/metadata.json
index 1b1a972b491..c5de7df80b0 100644
--- a/rules/S1036/cfamily/metadata.json
+++ b/rules/S1036/cfamily/metadata.json
@@ -3,7 +3,7 @@
"type": "CODE_SMELL",
"code": {
"impacts": {
- "MAINTAINABILITY": "HIGH"
+ "MAINTAINABILITY": "BLOCKER"
},
"attribute": "CLEAR"
},
@@ -19,12 +19,8 @@
"pitfall"
],
"extra": {
- "replacementRules": [
-
- ],
- "legacyKeys": [
-
- ]
+ "replacementRules": [],
+ "legacyKeys": []
},
"defaultSeverity": "Blocker",
"ruleSpecification": "RSPEC-1036",
diff --git a/rules/S104/java/metadata.json b/rules/S104/java/metadata.json
index 17971333806..f4b27f0bb34 100644
--- a/rules/S104/java/metadata.json
+++ b/rules/S104/java/metadata.json
@@ -1,3 +1,3 @@
{
-
+ "scope": "Main"
}
diff --git a/rules/S104/rpg/metadata.json b/rules/S104/rpg/metadata.json
index c6f2fc9c713..17971333806 100644
--- a/rules/S104/rpg/metadata.json
+++ b/rules/S104/rpg/metadata.json
@@ -1,3 +1,3 @@
{
- "title": "Files should not have too many lines"
+
}
diff --git a/rules/S104/rpg/rule.adoc b/rules/S104/rpg/rule.adoc
index 9987aa501a9..a73deaa3f69 100644
--- a/rules/S104/rpg/rule.adoc
+++ b/rules/S104/rpg/rule.adoc
@@ -6,7 +6,9 @@ ifdef::env-github,rspecator-view[]
== Implementation Specification
(visible only on this page)
-include::../message.adoc[]
+=== Message
+
+File "XXXX" has {0} lines of code, which is greater than {1} authorized. Split it into smaller files.
include::../parameters.adoc[]
diff --git a/rules/S1041/plsql/rule.adoc b/rules/S1041/plsql/rule.adoc
index 223a082d54b..0e5c7c51b98 100644
--- a/rules/S1041/plsql/rule.adoc
+++ b/rules/S1041/plsql/rule.adoc
@@ -46,7 +46,7 @@ END;
== Resources
-* https://cwe.mitre.org/data/definitions/391[MITRE, CWE-391] - Unchecked Error Condition
+* CWE - https://cwe.mitre.org/data/definitions/391[CWE-391 - Unchecked Error Condition]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S1044/cfamily/rule.adoc b/rules/S1044/cfamily/rule.adoc
index 89fc1511a49..5bd62777161 100644
--- a/rules/S1044/cfamily/rule.adoc
+++ b/rules/S1044/cfamily/rule.adoc
@@ -47,7 +47,7 @@ try {
* CERT - https://wiki.sei.cmu.edu/confluence/x/SXs-BQ[ERR61-CPP. Catch exceptions by lvalue reference]
=== External coding guidelines
-* {cpp} Core Guidelines - https://github.com/isocpp/CppCoreGuidelines/blob/036324/CppCoreGuidelines.md#e15-catch-exceptions-from-a-hierarchy-by-reference[E.15 Catch exceptions from a hierarchy by reference]
+* {cpp} Core Guidelines - https://github.com/isocpp/CppCoreGuidelines/blob/e49158a/CppCoreGuidelines.md#e15-throw-by-value-catch-exceptions-from-a-hierarchy-by-reference[E.15: Throw by value, catch exceptions from a hierarchy by reference]
* MISRA {cpp}:2008, 15-3-5 - A class type exception shall always be caught by reference
=== Related rules
diff --git a/rules/S1045/python/metadata.json b/rules/S1045/python/metadata.json
index 89d10e37816..2a1561a45ff 100644
--- a/rules/S1045/python/metadata.json
+++ b/rules/S1045/python/metadata.json
@@ -1,3 +1,6 @@
{
- "title": "All \"except\" blocks should be able to catch exceptions"
+ "title": "All \"except\" blocks should be able to catch exceptions",
+ "tags": [
+ "suspicious"
+ ]
}
diff --git a/rules/S1048/csharp/metadata.json b/rules/S1048/csharp/metadata.json
index 1a385910efb..7f94eb8fb1e 100644
--- a/rules/S1048/csharp/metadata.json
+++ b/rules/S1048/csharp/metadata.json
@@ -2,7 +2,7 @@
"title": "Finalizers should not throw exceptions",
"code": {
"impacts": {
- "RELIABILITY": "HIGH"
+ "RELIABILITY": "BLOCKER"
},
"attribute": "LOGICAL"
},
diff --git a/rules/S1048/vbnet/metadata.json b/rules/S1048/vbnet/metadata.json
index 61023668772..e9440f22ce0 100644
--- a/rules/S1048/vbnet/metadata.json
+++ b/rules/S1048/vbnet/metadata.json
@@ -2,7 +2,7 @@
"title": "Finalize method should not throw exceptions",
"code": {
"impacts": {
- "RELIABILITY": "HIGH"
+ "RELIABILITY": "BLOCKER"
},
"attribute": "LOGICAL"
},
diff --git a/rules/S1049/cfamily/rule.adoc b/rules/S1049/cfamily/rule.adoc
index b533f75cd83..98b5819893b 100644
--- a/rules/S1049/cfamily/rule.adoc
+++ b/rules/S1049/cfamily/rule.adoc
@@ -18,8 +18,8 @@ void foo () // no exceptions specified
throw ( 21 ); // anything can be thrown
}
-void goo ( ) throw ( Exception )
-{
+void goo ( ) throw ( Exception )
+{
foo ( ); // Noncompliant; an int could be thrown
}
----
@@ -34,8 +34,8 @@ void foo () // no exceptions specified
throw ( 21 ); // this is legal; anything can be thrown
}
-void goo ( ) throw ( Exception, int )
-{
+void goo ( ) throw ( Exception, int )
+{
foo ( );
}
----
@@ -44,8 +44,7 @@ void goo ( ) throw ( Exception, int )
== Resources
* MISRA {cpp}:2008, 15-5-2
-* https://cwe.mitre.org/data/definitions/391[MITRE, CWE-391] - Unchecked Error Condition
-* https://www.securecoding.cert.org/confluence/x/EADTAQ[CERT, ERR55-CPP.] - Honor exception specifications
+* CWE - https://cwe.mitre.org/data/definitions/391[CWE-391 - Unchecked Error Condition]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S105/java/metadata.json b/rules/S105/java/metadata.json
index 17971333806..f4b27f0bb34 100644
--- a/rules/S105/java/metadata.json
+++ b/rules/S105/java/metadata.json
@@ -1,3 +1,3 @@
{
-
+ "scope": "Main"
}
diff --git a/rules/S1053/cfamily/rule.adoc b/rules/S1053/cfamily/rule.adoc
index d057c5499a7..6335330c635 100644
--- a/rules/S1053/cfamily/rule.adoc
+++ b/rules/S1053/cfamily/rule.adoc
@@ -38,7 +38,7 @@ void fn ( std::string str )
== Resources
* MISRA {cpp}:2008, 18-0-5
-* https://cwe.mitre.org/data/definitions/120[MITRE, CWE-120] - Buffer Copy without Checking Size of Input ('Classic Buffer Overflow')
+* CWE - https://cwe.mitre.org/data/definitions/120[CWE-120 - Buffer Copy without Checking Size of Input ('Classic Buffer Overflow')]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S1057/plsql/rule.adoc b/rules/S1057/plsql/rule.adoc
index 594d1a0dbfd..a7830fcabd0 100644
--- a/rules/S1057/plsql/rule.adoc
+++ b/rules/S1057/plsql/rule.adoc
@@ -27,9 +27,9 @@ END;
== Resources
-* https://owasp.org/Top10/A04_2021-Insecure_Design/[OWASP Top 10 2021 Category A4] - Insecure Design
-* https://cwe.mitre.org/data/definitions/269[MITRE, CWE-269] - Improper Privilege Management
-* https://cwe.mitre.org/data/definitions/270[MITRE, CWE-270] - Privilege Context Switching Error
+* OWASP - https://owasp.org/Top10/A04_2021-Insecure_Design/[Top 10 2021 Category A4 - Insecure Design]
+* CWE - https://cwe.mitre.org/data/definitions/269[CWE-269 - Improper Privilege Management]
+* CWE - https://cwe.mitre.org/data/definitions/270[CWE-270 - Privilege Context Switching Error]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S1058/plsql/metadata.json b/rules/S1058/plsql/metadata.json
index 613fd0eb4e4..4e0b9a53f6a 100644
--- a/rules/S1058/plsql/metadata.json
+++ b/rules/S1058/plsql/metadata.json
@@ -3,7 +3,7 @@
"type": "BUG",
"code": {
"impacts": {
- "RELIABILITY": "HIGH"
+ "RELIABILITY": "BLOCKER"
},
"attribute": "LOGICAL"
},
@@ -12,13 +12,9 @@
"func": "Constant\/Issue",
"constantCost": "30min"
},
- "tags": [
-
- ],
+ "tags": [],
"extra": {
- "replacementRules": [
-
- ],
+ "replacementRules": [],
"legacyKeys": [
"PipelinedFunctionsWithoutPipeRow"
]
diff --git a/rules/S106/cfamily/rule.adoc b/rules/S106/cfamily/rule.adoc
index 2201acb8fe4..44b3db57d38 100644
--- a/rules/S106/cfamily/rule.adoc
+++ b/rules/S106/cfamily/rule.adoc
@@ -1,4 +1,4 @@
-:language_std_outputs: std::cout, std::cerr, printf
+:language_std_outputs: std::cout, std::cerr, printf, std::print
== Why is this an issue?
@@ -32,8 +32,8 @@ void doSomething()
== Resources
-* https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[OWASP Top 10 2021 Category A9] - Security Logging and Monitoring Failures
-* https://www.owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[OWASP Top 10 2017 Category A3] - Sensitive Data Exposure
+* OWASP - https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[Top 10 2021 Category A9 - Security Logging and Monitoring Failures]
+* OWASP - https://owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[Top 10 2017 Category A3 - Sensitive Data Exposure]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S106/csharp/rule.adoc b/rules/S106/csharp/rule.adoc
index f40656a6432..b9acb4b61c0 100644
--- a/rules/S106/csharp/rule.adoc
+++ b/rules/S106/csharp/rule.adoc
@@ -52,7 +52,8 @@ public class MyClass
== Resources
-* https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[OWASP Top 10 2021 Category A9] - Security Logging and Monitoring Failures
+* OWASP - https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[Top 10 2021 Category A9 - Security Logging and Monitoring Failures]
+* OWASP - https://www.owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[Top 10 2017 Category A3 - Sensitive Data Exposure]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S106/dart/metadata.json b/rules/S106/dart/metadata.json
new file mode 100644
index 00000000000..e54ab34bfd4
--- /dev/null
+++ b/rules/S106/dart/metadata.json
@@ -0,0 +1,5 @@
+{
+ "defaultQualityProfiles": [
+
+ ]
+}
diff --git a/rules/S106/dart/rule.adoc b/rules/S106/dart/rule.adoc
new file mode 100644
index 00000000000..72091558ab3
--- /dev/null
+++ b/rules/S106/dart/rule.adoc
@@ -0,0 +1,84 @@
+:language_std_outputs: print
+
+== Why is this an issue?
+
+include::../description.adoc[]
+
+If you are using Flutter, you can use `debugPrint` or surround print calls with a check for `kDebugMode`.
+
+=== Code examples
+
+==== Noncompliant code example
+
+[source,dart]
+----
+void doSomething(int x) {
+ // ...
+ print('debug: $x');
+ // ...
+}
+----
+
+==== Compliant solution
+
+[source,dart]
+----
+void doSomething(int x) {
+ // ...
+ debugPrint('debug: $x');
+ // ...
+}
+----
+
+or
+
+[source,dart]
+----
+void doSomething(int x) {
+ // ...
+ if (kDebugMode) {
+ print('debug: $x');
+ }
+ // ...
+}
+----
+
+or
+
+[source,dart]
+----
+void doSomething(int x) {
+ // ...
+ log('log: $x');
+ // ...
+}
+----
+
+== Resources
+
+* OWASP - https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[Top 10 2021 Category A9 - Security Logging and Monitoring Failures]
+* OWASP - https://owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[Top 10 2017 Category A3 - Sensitive Data Exposure]
+* Dart Docs - https://dart.dev/tools/linter-rules/avoid_print[Dart Linter rule - avoid_print]
+* Flutter API Docs - https://api.flutter.dev/flutter/foundation/kDebugMode-constant.html[kDebugMode top-level constant]
+
+ifdef::env-github,rspecator-view[]
+
+'''
+== Implementation Specification
+(visible only on this page)
+
+=== Message
+
+* Don't invoke 'print' in production code.
+
+=== Highlighting
+
+The identifier of the `print` method, without argument list.
+
+'''
+== Comments And Links
+(visible only on this page)
+
+include::../comments-and-links.adoc[]
+
+endif::env-github,rspecator-view[]
diff --git a/rules/S106/java/rule.adoc b/rules/S106/java/rule.adoc
index 58d8a6e2969..051e651e07a 100644
--- a/rules/S106/java/rule.adoc
+++ b/rules/S106/java/rule.adoc
@@ -40,8 +40,8 @@ class MyClass {
=== Documentation
* https://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html[Java SE 7 API Specification: java.util.logging.Logger]
-* https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[OWASP Top 10 2021 Category A9] - Security Logging and Monitoring Failures
-* https://www.owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[OWASP Top 10 2017 Category A3] - Sensitive Data Exposure
+* OWASP - https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[Top 10 2021 Category A9 - Security Logging and Monitoring Failures]
+* OWASP - https://owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[Top 10 2017 Category A3 - Sensitive Data Exposure]
* https://wiki.sei.cmu.edu/confluence/x/nzdGBQ[CERT, ERR02-J.] - Prevent exceptions while logging data
ifdef::env-github,rspecator-view[]
diff --git a/rules/S106/javascript/rule.adoc b/rules/S106/javascript/rule.adoc
index f98542da721..effdd0772a5 100644
--- a/rules/S106/javascript/rule.adoc
+++ b/rules/S106/javascript/rule.adoc
@@ -39,8 +39,8 @@ function doSomething() {
== Resources
-* https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[OWASP Top 10 2021 Category A9] - Security Logging and Monitoring Failures
-* https://www.owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[OWASP Top 10 2017 Category A3] - Sensitive Data Exposure
+* OWASP - https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[Top 10 2021 Category A9 - Security Logging and Monitoring Failures]
+* OWASP - https://owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[Top 10 2017 Category A3 - Sensitive Data Exposure]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S1065/dart/metadata.json b/rules/S1065/dart/metadata.json
new file mode 100644
index 00000000000..0db3279e44b
--- /dev/null
+++ b/rules/S1065/dart/metadata.json
@@ -0,0 +1,3 @@
+{
+
+}
diff --git a/rules/S1065/dart/rule.adoc b/rules/S1065/dart/rule.adoc
new file mode 100644
index 00000000000..6f84c12c53b
--- /dev/null
+++ b/rules/S1065/dart/rule.adoc
@@ -0,0 +1,57 @@
+== Why is this an issue?
+
+include::../description.adoc[]
+
+=== Noncompliant code example
+
+[source,dart,diff-id=1,diff-type=noncompliant]
+----
+void foo() {
+ outer: //label is not used.
+ for(int i = 0; i < 10; i++) {
+ break;
+ }
+}
+----
+
+=== Compliant solution
+
+[source,dart,diff-id=1,diff-type=compliant]
+----
+void foo() {
+ for(int i = 0; i < 10; i++) {
+ break;
+ }
+}
+----
+
+== Resources
+
+=== Documentation
+
+* CERT - https://wiki.sei.cmu.edu/confluence/x/5dUxBQ[CERT, MSC12-C.] - Detect and remove code that has no effect or is never executed
+* Dart Docs - https://dart.dev/tools/diagnostic-messages?utm_source=dartdev&utm_medium=redir&utm_id=diagcode&utm_content=unnecessary_cast#unused_label[Dart Linter rule - unused_label]
+
+ifdef::env-github,rspecator-view[]
+
+'''
+== Implementation Specification
+(visible only on this page)
+
+=== Message
+
+* The label '' isn't used.
+
+`` doesn't include the semicolon.
+
+=== Highlighting
+
+The label name, including the semicolon.
+
+'''
+== Comments And Links
+(visible only on this page)
+
+include::../comments-and-links.adoc[]
+
+endif::env-github,rspecator-view[]
diff --git a/rules/S1065/java/metadata.json b/rules/S1065/java/metadata.json
index 8033d8a15a8..59ddee43052 100644
--- a/rules/S1065/java/metadata.json
+++ b/rules/S1065/java/metadata.json
@@ -7,5 +7,6 @@
"CERT": [
"MSC12-C."
]
- }
+ },
+ "scope": "Main"
}
diff --git a/rules/S1067/java/metadata.json b/rules/S1067/java/metadata.json
index 17971333806..f4b27f0bb34 100644
--- a/rules/S1067/java/metadata.json
+++ b/rules/S1067/java/metadata.json
@@ -1,3 +1,3 @@
{
-
+ "scope": "Main"
}
diff --git a/rules/S1068/dart/metadata.json b/rules/S1068/dart/metadata.json
new file mode 100644
index 00000000000..0db3279e44b
--- /dev/null
+++ b/rules/S1068/dart/metadata.json
@@ -0,0 +1,3 @@
+{
+
+}
diff --git a/rules/S1068/dart/rule.adoc b/rules/S1068/dart/rule.adoc
new file mode 100644
index 00000000000..ecde6b6dc2f
--- /dev/null
+++ b/rules/S1068/dart/rule.adoc
@@ -0,0 +1,22 @@
+== Why is this an issue?
+
+include::../description.adoc[]
+
+[source,dart]
+----
+class MyClass {
+ final String _str; // Noncompliant, _str private field is never read
+
+ C(this._str);
+}
+----
+
+== How to fix it
+
+If the field isn't needed, then remove it.
+
+If the field was intended to be used, then add the missing code.
+
+== Resources
+
+* https://dart.dev/tools/diagnostic-messages?utm_source=dartdev&utm_medium=redir&utm_id=diagcode&utm_content=unnecessary_cast#unused_field[Dart compiler diagnostic - unused field]
diff --git a/rules/S1068/java/rule.adoc b/rules/S1068/java/rule.adoc
index 5fedb1fb43f..4dd96f4907a 100644
--- a/rules/S1068/java/rule.adoc
+++ b/rules/S1068/java/rule.adoc
@@ -34,9 +34,10 @@ public class MyClass implements java.io.Serializable {
}
----
-* Annotated fields
+* Annotated fields and classes annotated with Lombok annotations
-The unused field in this class will not be reported by the rule as it is annotated.
+The unused field in this class will not be reported by the rule as it is annotated,
+except if annotation class `SomeAnnotation` is listed in the `ignoreAnnotations` parameter (see Parameters).
[source,java]
----
public class MyClass {
@@ -62,6 +63,18 @@ ifdef::env-github,rspecator-view[]
== Implementation Specification
(visible only on this page)
+=== Parameters
+
+.ignoreAnnotations
+****
+
+----
+""
+----
+
+A comma separated list of fully qualified annotation class names that do not prevent a private field from being reported.
+****
+
include::../message.adoc[]
'''
diff --git a/rules/S1069/metadata.json b/rules/S1069/metadata.json
index 7522076aed1..6a30b9dc6b8 100644
--- a/rules/S1069/metadata.json
+++ b/rules/S1069/metadata.json
@@ -3,7 +3,7 @@
"type": "CODE_SMELL",
"code": {
"impacts": {
- "MAINTAINABILITY": "HIGH"
+ "MAINTAINABILITY": "BLOCKER"
},
"attribute": "CONVENTIONAL"
},
@@ -17,12 +17,8 @@
"sql"
],
"extra": {
- "replacementRules": [
-
- ],
- "legacyKeys": [
-
- ]
+ "replacementRules": [],
+ "legacyKeys": []
},
"defaultSeverity": "Blocker",
"ruleSpecification": "RSPEC-1069",
diff --git a/rules/S107/cfamily/rule.adoc b/rules/S107/cfamily/rule.adoc
index 3f12ddad2de..b6538823d05 100644
--- a/rules/S107/cfamily/rule.adoc
+++ b/rules/S107/cfamily/rule.adoc
@@ -4,7 +4,7 @@ include::../rule.adoc[]
== Resources
-* https://github.com/isocpp/CppCoreGuidelines/blob/036324/CppCoreGuidelines.md#i23-keep-the-number-of-function-arguments-low[{cpp} Core Guidelines I.23]: Keep the number of function arguments low
+* {cpp} Core Guidelines - https://github.com/isocpp/CppCoreGuidelines/blob/e49158a/CppCoreGuidelines.md#i23-keep-the-number-of-function-arguments-low[I.23: Keep the number of function arguments low]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S107/dart/metadata.json b/rules/S107/dart/metadata.json
new file mode 100644
index 00000000000..17971333806
--- /dev/null
+++ b/rules/S107/dart/metadata.json
@@ -0,0 +1,3 @@
+{
+
+}
diff --git a/rules/S107/dart/noncompliant.adoc b/rules/S107/dart/noncompliant.adoc
new file mode 100644
index 00000000000..4cfbe840119
--- /dev/null
+++ b/rules/S107/dart/noncompliant.adoc
@@ -0,0 +1,6 @@
+[source,dart]
+----
+void setCoordinates(int x1, int y1, int z1, int x2, int y2, int z2) { // Noncompliant
+ // ...
+}
+----
diff --git a/rules/S107/dart/rule.adoc b/rules/S107/dart/rule.adoc
new file mode 100644
index 00000000000..358c7676b0c
--- /dev/null
+++ b/rules/S107/dart/rule.adoc
@@ -0,0 +1,21 @@
+:language: dart
+
+include::../rule.adoc[]
+
+ifdef::env-github,rspecator-view[]
+
+'''
+== Implementation Specification
+(visible only on this page)
+
+include::../message.adoc[]
+
+include::../parameters.adoc[]
+
+'''
+== Comments And Links
+(visible only on this page)
+
+include::../comments-and-links.adoc[]
+
+endif::env-github,rspecator-view[]
diff --git a/rules/S107/dart/split-example.adoc b/rules/S107/dart/split-example.adoc
new file mode 100644
index 00000000000..10b5cfd1aba
--- /dev/null
+++ b/rules/S107/dart/split-example.adoc
@@ -0,0 +1,11 @@
+[source,dart]
+----
+// Each function does a part of what the original setCoordinates function was doing, so confusion risks are lower
+void setOrigin(int x, int y, int z) {
+ // ...
+}
+
+void setSize(int width, int height, int depth) {
+ // ...
+}
+----
diff --git a/rules/S107/dart/struct-example.adoc b/rules/S107/dart/struct-example.adoc
new file mode 100644
index 00000000000..0437a69ad68
--- /dev/null
+++ b/rules/S107/dart/struct-example.adoc
@@ -0,0 +1,13 @@
+[source,dart]
+----
+class Point { // In geometry, Point is a logical structure to group data
+ int x;
+ int y;
+
+ Point(this.x, this.y);
+}
+
+void setCoordinates(Point p1, Point p2) {
+ // ...
+}
+----
diff --git a/rules/S107/description.adoc b/rules/S107/description.adoc
index 41b94db1674..46dbd0516cd 100644
--- a/rules/S107/description.adoc
+++ b/rules/S107/description.adoc
@@ -1,6 +1,6 @@
== Why is this an issue?
-{upper_function}s with a long parameter list are difficult to use, as maintainers must figure out the role of each parameter and keep track of their position.
+{upper_function}s with a long parameter list are difficult to use because maintainers must figure out the role of each parameter and keep track of their position.
include::{language}/noncompliant.adoc[]
diff --git a/rules/S107/java/metadata.json b/rules/S107/java/metadata.json
index 76308d08f10..883315ce156 100644
--- a/rules/S107/java/metadata.json
+++ b/rules/S107/java/metadata.json
@@ -1,3 +1,4 @@
{
- "title": "Methods should not have too many parameters"
+ "title": "Methods should not have too many parameters",
+ "scope": "Main"
}
diff --git a/rules/S1074/plsql/metadata.json b/rules/S1074/plsql/metadata.json
index 80e0ed55d7a..54b0c65f9d4 100644
--- a/rules/S1074/plsql/metadata.json
+++ b/rules/S1074/plsql/metadata.json
@@ -3,7 +3,7 @@
"type": "BUG",
"code": {
"impacts": {
- "RELIABILITY": "HIGH"
+ "RELIABILITY": "BLOCKER"
},
"attribute": "COMPLETE"
},
@@ -12,13 +12,9 @@
"func": "Constant\/Issue",
"constantCost": "1h"
},
- "tags": [
-
- ],
+ "tags": [],
"extra": {
- "replacementRules": [
-
- ],
+ "replacementRules": [],
"legacyKeys": [
"ForallStatementShouldUseSaveExceptionsClause"
]
diff --git a/rules/S1075/java/rule.adoc b/rules/S1075/java/rule.adoc
index 35c761c2566..8a6b7dd22cc 100644
--- a/rules/S1075/java/rule.adoc
+++ b/rules/S1075/java/rule.adoc
@@ -1,5 +1,13 @@
include::../description.adoc[]
+=== Exceptions
+
+This rule does not raise an issue when:
+
+* A constant path is relative and contains at most two parts.
+* A constant path is used in an annotation
+* A path is annotated
+
== How to fix it
=== Code examples
@@ -9,6 +17,8 @@ include::../description.adoc[]
[source,java,diff-id=1,diff-type=noncompliant]
----
public class Foo {
+ public static final String FRIENDS_ENDPOINT = "/user/friends"; // Compliant path is relative and has only two parts
+
public Collection listUsers() {
File userList = new File("/home/mylogin/Dev/users.txt"); // Noncompliant
Collection users = parse(userList);
@@ -38,6 +48,24 @@ public class Foo {
}
----
+Exceptions examples:
+
+[source,java]
+----
+public class Foo {
+ public static final String FRIENDS_ENDPOINT = "/user/friends"; // Compliant path is relative and has only two parts
+
+ public static final String ACCOUNT = "/account/group/list.html"; // Compliant path is used in an annotation
+
+ @Value("${base.url}" + ACCOUNT)
+ private String groupUrl;
+
+ @MyAnnotation()
+ String path = "/default/url/for/site"; // Compliant path is annotated
+
+}
+----
+
ifdef::env-github,rspecator-view[]
'''
diff --git a/rules/S1077/html/metadata.json b/rules/S1077/html/metadata.json
index 860e6eb5623..791b63f2443 100644
--- a/rules/S1077/html/metadata.json
+++ b/rules/S1077/html/metadata.json
@@ -1,35 +1,4 @@
{
- "title": "Image, area and button with image tags should have an \"alt\" attribute",
- "type": "BUG",
- "code": {
- "impacts": {
- "RELIABILITY": "LOW"
- },
- "attribute": "COMPLETE"
- },
- "status": "ready",
- "remediation": {
- "func": "Constant\/Issue",
- "constantCost": "5min"
- },
- "tags": [
- "accessibility",
- "wcag2-a"
- ],
- "extra": {
- "replacementRules": [
-
- ],
- "legacyKeys": [
- "ImgWithoutAltCheck"
- ]
- },
- "defaultSeverity": "Minor",
- "ruleSpecification": "RSPEC-1077",
- "sqKey": "ImgWithoutAltCheck",
- "scope": "Main",
- "defaultQualityProfiles": [
- "Sonar way"
- ],
- "quickfix": "unknown"
+ "title": "Image, area and button with image elements should have an \"alt\" attribute",
+ "sqKey": "ImgWithoutAltCheck"
}
diff --git a/rules/S1077/html/rule.adoc b/rules/S1077/html/rule.adoc
index d226704870f..36c28bb5e98 100644
--- a/rules/S1077/html/rule.adoc
+++ b/rules/S1077/html/rule.adoc
@@ -8,57 +8,19 @@ Common reasons for that include:
* The image can no longer be found
* Visually impaired users using a screen reader software
-* Images loading is disabled, to reduce data consumption on mobile phones
+* Image loading is disabled, to reduce data consumption on mobile phones
-It is also very important to not set an ``++alt++`` attribute to a non-informative value. For example ``++![logo]()
++`` is useless as it doesn't give any information to the user. In this case, as for any other decorative image, it is better to use a CSS background image instead of an ``++![]()
++`` tag. If using CSS background-image is not possible, an empty ``++alt=""++`` is tolerated. See Exceptions bellow.
+It is also very important not to set an ``++alt++`` attribute to a non-informative value. For example, ``++![logo]()
++`` is useless as it doesn't give any information to the user. In this case, as for any other decorative image, it is better to use a CSS background image instead of an ``++![]()
++`` tag. If using CSS ``++background-image++`` is not possible, an empty ``++alt=""++`` is tolerated. See Exceptions below.
-This rule raises an issue when
-
-* an ``++++`` tag or an ``++++`` tag have no ``++alt++`` attribute or their ``++alt++`` attribute has an empty string value.
-* an ``++![]()
++`` tag has no ``++alt++`` attribute.
-
-
-=== Noncompliant code example
-
-[source,html]
-----
-
-
-
-
-
-
-----
-
-
-=== Compliant solution
-
-[source,html]
-----
-
-
-
-
-
-----
+This rule raises an issue when:
+* An ``++++`` or ``++++`` element has no ``++alt++`` attribute or it holds an empty string value.
+* An ``++![]()
++`` element has no ``++alt++`` attribute.
=== Exceptions
-``++![]()
++`` tags with empty string ``++alt=""++`` attributes won't raise any issue. However this technic should be used in two cases only:
+``++![]()
++`` elements with an empty string ``++alt=""++`` attribute won't raise any issue. However, this way should be used in two cases only:
When the image is decorative and it is not possible to use a CSS background image. For example, when the decorative ``++![]()
++`` is generated via javascript with a source image coming from a database, it is better to use an ``++![]()
++`` tag rather than generate CSS code.
@@ -69,7 +31,7 @@ When the image is decorative and it is not possible to use a CSS background imag
![]()
----
-When the image is not decorative but it's ``++alt++`` text would repeat a nearby text. For example, images contained in links should not duplicate the link's text in their ``++alt++`` attribute, as it would make the screen reader repeat the text twice.
+When the image is not decorative but its ``++alt++`` text would repeat a nearby text. For example, images contained in links should not duplicate the link's text in their ``++alt++`` attribute, as it would make the screen reader repeat the text twice.
[source,html]
----
@@ -80,20 +42,59 @@ When the image is not decorative but it's ``++alt++`` text would repeat a nearby
----
In all other cases you should use CSS background images.
+== How to fix it
-See https://www.w3.org/WAI/tutorials/images/decision-tree/[W3C WAI Web Accessibility Tutorials] for more information.
+Add an alternative text to the HTML element.
+=== Code examples
-== Resources
+==== Noncompliant code example
-* https://www.w3.org/TR/WCAG20-TECHS/H24.html[WCAG2, H24] - Providing text alternatives for the area elements of image maps
-* https://www.w3.org/TR/WCAG20-TECHS/H36.html[WCAG2, H36] - Using alt attributes on images used as submit buttons
-* https://www.w3.org/TR/WCAG20-TECHS/H37.html[WCAG2, H37] - Using alt attributes on img elements
-* https://www.w3.org/TR/WCAG20-TECHS/H67.html[WCAG2, H67] - Using null alt text and no title attribute on img elements for images that AT should ignore
-* https://www.w3.org/TR/WCAG20-TECHS/H2.html[WCAG2, H2] - Combining adjacent image and text links for the same resource
-* https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-text-equiv-all[WCAG2, 1.1.1] - Non-text Content
-* https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-navigation-mechanisms-refs[WCAG2, 2.4.4] - Link Purpose (In Context)
-* https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-navigation-mechanisms-link[WCAG2, 2.4.9] - Link Purpose (Link Only)
+[source,html,diff-id=1,diff-type=noncompliant]
+----
+
+
+
+
+
+
+----
+
+==== Compliant solution
+
+[source,html,diff-id=1,diff-type=compliant]
+----
+
+
+
+
+
+----
+
+== Resources
+=== Documentation
+
+* W3C - https://www.w3.org/WAI/tutorials/images/decision-tree/[W3C WAI Web Accessibility Tutorials]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H24.html[Providing text alternatives for the area elements of image maps]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H36.html[Using alt attributes on images used as submit buttons]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H37.html[Using alt attributes on img elements]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H67.html[Using null alt text and no title attribute on img elements for images that AT should ignore]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H2.html[Combining adjacent image and text links for the same resource]
+* W3C - https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-text-equiv-all[Non-text Content]
+* W3C - https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-navigation-mechanisms-refs[Link Purpose (In Context)]
+* W3C - https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-navigation-mechanisms-link[Link Purpose (Link Only)]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S1077/javascript/metadata.json b/rules/S1077/javascript/metadata.json
new file mode 100644
index 00000000000..d1b8102e318
--- /dev/null
+++ b/rules/S1077/javascript/metadata.json
@@ -0,0 +1,7 @@
+{
+ "tags": [
+ "accessibility",
+ "wcag2-a",
+ "react"
+ ]
+}
diff --git a/rules/S1077/javascript/rule.adoc b/rules/S1077/javascript/rule.adoc
new file mode 100644
index 00000000000..847e0b6eac9
--- /dev/null
+++ b/rules/S1077/javascript/rule.adoc
@@ -0,0 +1,103 @@
+== Why is this an issue?
+
+The ``++alt++``, ``++aria-label++`` and ``++aria-labelledby++`` attributes provide a textual alternative to an image.
+
+It is used whenever the actual image cannot be rendered.
+
+Common reasons for that include:
+
+* The image can no longer be found
+* Visually impaired users using a screen reader software
+* Image loading is disabled, to reduce data consumption on mobile phones
+
+It is also very important not to set an alternative text attribute to a non-informative value. For example, ``++![logo]()
++`` is useless as it doesn't give any information to the user. In this case, as for any other decorative image, it is better to use a CSS background image instead of an ``++![]()
++`` tag. If using CSS ``++background-image++`` is not possible, an empty ``++alt=""++`` is tolerated. See Exceptions below.
+
+
+This rule raises an issue when:
+
+* An ``++![]()
++`` element has no ``++alt++`` attribute.
+* An ``++++`` element has no ``++alt++``, ``++aria-label++`` or ``++aria-labelledby++`` attribute or they hold an empty string.
+* An ``++++`` element within an image map has no ``++alt++``, ``++aria-label++`` or ``++aria-labelledby++`` attribute.
+* An ``++
+
+
+
+
+
+
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/invalid-rules/S101/metadata.json b/rspec-tools/tests/resources/invalid-rules/S101/metadata.json
new file mode 100644
index 00000000000..2c63c085104
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-rules/S101/metadata.json
@@ -0,0 +1,2 @@
+{
+}
diff --git a/rspec-tools/tests/resources/invalid-rules/S200/cobol/rule.adoc b/rspec-tools/tests/resources/invalid-rules/S200/cobol/rule.adoc
deleted file mode 100644
index 96c98479cae..00000000000
--- a/rspec-tools/tests/resources/invalid-rules/S200/cobol/rule.adoc
+++ /dev/null
@@ -1,5 +0,0 @@
-== Why is this an issue?
-== How to fix it
-// there's a typo, it's "Code examples"
-=== Coding examples
-== Resources
diff --git a/rspec-tools/tests/resources/invalid-rules/S200/cobol/rule.html b/rspec-tools/tests/resources/invalid-rules/S200/cobol/rule.html
deleted file mode 100644
index 230f82fa43e..00000000000
--- a/rspec-tools/tests/resources/invalid-rules/S200/cobol/rule.html
+++ /dev/null
@@ -1,21 +0,0 @@
-
-
-Why is this an issue?
-
-
-
-
-
-How to fix it
-
-
-
-
-Coding examples
- -
-
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/invalid-rules/S200/java/rule.adoc b/rspec-tools/tests/resources/invalid-rules/S200/java/rule.adoc
deleted file mode 100644
index 0f89d78f435..00000000000
--- a/rspec-tools/tests/resources/invalid-rules/S200/java/rule.adoc
+++ /dev/null
@@ -1,5 +0,0 @@
-== Why is this an issue?
-== How to fix it in Razor
-=== Yolo (invalid section name)
-
-
diff --git a/rspec-tools/tests/resources/invalid-rules/S200/java/rule.html b/rspec-tools/tests/resources/invalid-rules/S200/java/rule.html
deleted file mode 100644
index adf59b4a8da..00000000000
--- a/rspec-tools/tests/resources/invalid-rules/S200/java/rule.html
+++ /dev/null
@@ -1,15 +0,0 @@
-Resources
-
-
-
-
-
-Why is this an issue?
-
-
-
-
-
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/invalid-rules/S200/metadata.json b/rspec-tools/tests/resources/invalid-rules/S200/metadata.json
new file mode 100644
index 00000000000..2c63c085104
--- /dev/null
+++ b/rspec-tools/tests/resources/invalid-rules/S200/metadata.json
@@ -0,0 +1,2 @@
+{
+}
diff --git a/rspec-tools/tests/resources/rules/S200/docker/metadata.json b/rspec-tools/tests/resources/rules/S200/docker/metadata.json
new file mode 100644
index 00000000000..6692ce5d21c
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/docker/metadata.json
@@ -0,0 +1,10 @@
+{
+ "securityStandards": {
+ "OWASP": [
+ "A1","A10"
+ ],
+ "OWASP Top 10 2021": [
+
+ ]
+ }
+}
diff --git a/rspec-tools/tests/resources/rules/S200/docker/rule.adoc b/rspec-tools/tests/resources/rules/S200/docker/rule.adoc
new file mode 100644
index 00000000000..f7e4c4ee409
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/docker/rule.adoc
@@ -0,0 +1,12 @@
+== Why is this an issue?
+== How to fix it
+== Resources
+=== Documentation
+
+* OWASP - https://www.owasp.org/index.php/HTTP_Response_Splitting[HTTP Response Splitting]
+
+=== Standards
+
+* OWASP - https://www.owasp.org/www-project-top-ten/2017/A1_2017-Injection[Top 10 2017 Category A1 - Injection]
+* CWE - https://cwe.mitre.org/data/definitions/20[CWE-20 - Improper Input Validation]
+* CWE - https://cwe.mitre.org/data/definitions/113[CWE-113 - Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting')]
diff --git a/rspec-tools/tests/resources/rules/S200/docker/rule.html b/rspec-tools/tests/resources/rules/S200/docker/rule.html
new file mode 100644
index 00000000000..c2ee5cdb3b3
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/docker/rule.html
@@ -0,0 +1,43 @@
+How to fix it in Razor
-
-
-
-
-Yolo (invalid section name)
- -
+
+Why is this an issue?
+
+
+
+
+
+How to fix it
+
+
+
+
+
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/rules/S200/python/metadata.json b/rspec-tools/tests/resources/rules/S200/python/metadata.json
new file mode 100644
index 00000000000..3c10dc2e77f
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/python/metadata.json
@@ -0,0 +1,13 @@
+{
+ "securityStandards": {
+ "ASVS 4.0": [
+ "1.23.4"
+ ],
+ "OWASP": [
+ "A1","A10"
+ ],
+ "OWASP Top 10 2021": [
+ "A3"
+ ]
+ }
+}
diff --git a/rspec-tools/tests/resources/rules/S200/python/rule.adoc b/rspec-tools/tests/resources/rules/S200/python/rule.adoc
new file mode 100644
index 00000000000..d4b7cb15421
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/python/rule.adoc
@@ -0,0 +1,14 @@
+== Why is this an issue?
+== How to fix it
+== Resources
+=== Documentation
+
+* OWASP - https://www.owasp.org/index.php/HTTP_Response_Splitting[HTTP Response Splitting]
+
+=== Standards
+
+* OWASP - https://owasp.org/www-project-top-ten/2017/A1_2017-Injection[Top 10 2017 Category A1 - Injection]
+* OWASP - https://owasp.org/www-project-top-ten/2017/A10_2017-Insufficient_Logging%2526Monitoring[Top 10 2017 Category A10 - Insufficient Logging & Monitoring]
+* OWASP - https://owasp.org/Top10/A03_2021-Injection/[Top 10 2021 Category A3 - Injection]
+* CWE - https://cwe.mitre.org/data/definitions/20[CWE-20 - Improper Input Validation]
+* CWE - https://cwe.mitre.org/data/definitions/113[CWE-113 - Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting')]
diff --git a/rspec-tools/tests/resources/rules/S200/python/rule.html b/rspec-tools/tests/resources/rules/S200/python/rule.html
new file mode 100644
index 00000000000..fd2c3db56aa
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/python/rule.html
@@ -0,0 +1,49 @@
+Resources
+
+
+
+
+Documentation
+
+
+-
+
-
+
OWASP - HTTP Response Splitting
+
+
+
+Standards
+
+
+
+
+
+Why is this an issue?
+
+
+
+
+
+How to fix it
+
+
+
+
+
\ No newline at end of file
diff --git a/rspec-tools/tests/resources/rules/S200/terraform/metadata.json b/rspec-tools/tests/resources/rules/S200/terraform/metadata.json
new file mode 100644
index 00000000000..9daf4a8d319
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/terraform/metadata.json
@@ -0,0 +1,10 @@
+{
+ "securityStandards": {
+ "OWASP": [
+ "A1"
+ ],
+ "OWASP Top 10 2021": [
+ "A3"
+ ]
+ }
+}
diff --git a/rspec-tools/tests/resources/rules/S200/terraform/rule.adoc b/rspec-tools/tests/resources/rules/S200/terraform/rule.adoc
new file mode 100644
index 00000000000..ecb0a7f9261
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/terraform/rule.adoc
@@ -0,0 +1,14 @@
+== Why is this an issue?
+== How to fix it
+== Resources
+=== Documentation
+
+* OWASP - https://www.owasp.org/index.php/HTTP_Response_Splitting[HTTP Response Splitting]
+
+=== Standards
+
+* OWASP - https://owasp.org/www-project-top-ten/2017/A1_2017-Injection[Top 10 2017 Category A1 - Injection]
+* OWASP - https://owasp.org/www-project-top-ten/2017/A10_2017-Insufficient_Logging%2526Monitoring[Top 10 2017 Category A10 - Insufficient Logging & Monitoring]
+* OWASP - https://www.owasp.org/Top10/A03_2021-Injection/[Top 10 2021 Category A3 - Injection]
+* CWE - https://cwe.mitre.org/data/definitions/20[CWE-20 - Improper Input Validation]
+* CWE - https://cwe.mitre.org/data/definitions/113[CWE-113 - Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting')]
diff --git a/rspec-tools/tests/resources/rules/S200/terraform/rule.html b/rspec-tools/tests/resources/rules/S200/terraform/rule.html
new file mode 100644
index 00000000000..8941ef5b719
--- /dev/null
+++ b/rspec-tools/tests/resources/rules/S200/terraform/rule.html
@@ -0,0 +1,49 @@
+Resources
+
+
+
+
+Documentation
+
+
+-
+
-
+
OWASP - HTTP Response Splitting
+
+
+
+Standards
+
+
+-
+
- + + +
-
+
OWASP - Top 10 2017 Category A10 - Insufficient Logging & Monitoring
+
+ - + + +
- + + +
-
+
CWE - CWE-113 - Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting')
+
+
+
+Why is this an issue?
+
+
+
+
+
+How to fix it
+
+
+
+
+
\ No newline at end of file
diff --git a/rspec-tools/tests/test_coverage.py b/rspec-tools/tests/test_coverage.py
index 6246a1eaf19..fcf99ca647e 100644
--- a/rspec-tools/tests/test_coverage.py
+++ b/rspec-tools/tests/test_coverage.py
@@ -65,6 +65,17 @@ def rules_dir():
['sonarpedia.json', '{"rules-metadata-path": "rules", "languages":["XML"]}'],
['rules/S103.json', '{}']]}
]},
+ {'name':'sonar-java',
+ 'versions': [
+ {'name': '1.2.0.123',
+ 'date': '2020-01-02 10:00:00',
+ 'files': [['module1/rules/Sonar_way_profile.json', '{}'],
+ ['module1/sonarpedia.json', '{"rules-metadata-path": "rules", "languages":["JAVA"]}'],
+ ['module1/rules/S100.json', '{}'],
+ ['module2/rules/Sonar_way_profile.json', '{}'],
+ ['module2/sonarpedia.json', '{"rules-metadata-path": "rules", "languages":["JAVA"]}'],
+ ['module2/rules/S101.json', '{}']]}
+ ]},
{'name':'broken',
'versions': [
{'name': 'v1',
@@ -159,19 +170,20 @@ def test_update_coverage_for_repo(tmpdir, rules_dir: Path, mock_git_analyzer_rep
assert cov['JAVASCRIPT']['S1145'] == {'since': REPO + ' 3.3.0.5702', 'until': REPO + ' 6.7.0.14237'}
-@patch('rspec_tools.coverage.REPOS', ['SonarJS', 'sonar-xml'])
+@patch('rspec_tools.coverage.REPOS', ['SonarJS', 'sonar-xml', 'sonar-java'])
def test_update_coverage_for_all_repos(tmpdir, rules_dir: Path, mock_git_analyzer_repos):
with pushd(tmpdir), patch('rspec_tools.coverage.Repo', mock_git_analyzer_repos):
update_coverage_for_all_repos(rules_dir)
coverage = tmpdir.join('covered_rules.json')
assert coverage.exists()
cov = load_json(coverage)
- assert {'JAVASCRIPT', 'TYPESCRIPT', 'XML', 'CSS'} == set(cov.keys())
+ assert {'JAVASCRIPT', 'TYPESCRIPT', 'XML', 'CSS', 'JAVA'} == set(cov.keys())
assert 'S100' in cov['JAVASCRIPT']
assert 'MethodName' not in cov['JAVASCRIPT'] # MethodName is a legacy key for S100
assert {'S100'} == set(cov['CSS'].keys())
assert {'S103', 'S1000'} == set(cov['XML'].keys())
assert cov['XML']['S1000'] == 'SonarJS 7.0.0.14528'
+ assert {'S100', 'S101'} == set(cov['JAVA'].keys())
def test_update_coverage_no_sonarpedia(tmpdir, rules_dir: Path, mock_git_analyzer_repos, capsys):
with pushd(tmpdir), patch('rspec_tools.coverage.Repo', mock_git_analyzer_repos):
diff --git a/rspec-tools/tests/test_create_rule.py b/rspec-tools/tests/test_create_rule.py
index adcb65e269a..a0deb0ebbb2 100644
--- a/rspec-tools/tests/test_create_rule.py
+++ b/rspec-tools/tests/test_create_rule.py
@@ -43,10 +43,13 @@ def test_create_new_multi_lang_rule_branch(rule_creator: RuleCreator, mock_git_r
for lang_item in lang_root.glob('**/*'):
if lang_item.is_file():
expected_content = lang_item.read_text().replace('${RSPEC_ID}', str(rule_number))
- expected_content = expected_content.replace('[source,text]', f'[source,{LANG_TO_SOURCE[os.path.basename(lang)]}]')
+ expected_content = expected_content.replace('[source,text', f'[source,{LANG_TO_SOURCE[os.path.basename(lang)]}')
relative_path = lang_item.relative_to(lang_root)
actual_content = rule_dir.joinpath(lang, relative_path).read_text()
assert actual_content == expected_content
+ if lang_item.suffix == '.adoc':
+ assert 'source,text' not in actual_content
+ assert LANG_TO_SOURCE[os.path.basename(lang)] in actual_content
def test_create_new_single_lang_rule_branch(rule_creator: RuleCreator, mock_git_rspec_repo: Repo):
@@ -75,10 +78,13 @@ def test_create_new_single_lang_rule_branch(rule_creator: RuleCreator, mock_git_
if lang_item.is_file():
expected_content = lang_item.read_text().replace('${RSPEC_ID}', str(rule_number))
dir_name = os.path.basename(lang)
- expected_content = expected_content.replace('[source,text]', f'[source,{LANG_TO_SOURCE[dir_name]}]')
+ expected_content = expected_content.replace('[source,text', f'[source,{LANG_TO_SOURCE[dir_name]}')
relative_path = lang_item.relative_to(lang_root)
actual_content = rule_dir.joinpath(lang, relative_path).read_text()
assert actual_content == expected_content
+ if lang_item.suffix == '.adoc':
+ assert 'source,text' not in actual_content
+ assert LANG_TO_SOURCE[dir_name] in actual_content
def test_create_new_rule_pull_request(rule_creator: RuleCreator):
@@ -138,10 +144,13 @@ def test_add_lang_singlelang_nonconventional_rule_create_branch(rule_creator: Ru
for lang_item in lang_root.glob('**/*'):
if lang_item.is_file():
expected_content = lang_item.read_text().replace('${RSPEC_ID}', str(rule_number))
- expected_content = expected_content.replace('[source,text]', f'[source,{LANG_TO_SOURCE[language]}]')
+ expected_content = expected_content.replace('[source,text', f'[source,{LANG_TO_SOURCE[language]}')
relative_path = lang_item.relative_to(lang_root)
actual_content = rule_dir.joinpath(language, relative_path).read_text()
assert actual_content == expected_content
+ if lang_item.suffix == '.adoc':
+ assert 'source,text' not in actual_content
+ assert LANG_TO_SOURCE[language] in actual_content
def test_add_lang_singlelang_conventional_rule_create_branch(rule_creator: RuleCreator, mock_git_rspec_repo: Repo):
@@ -186,10 +195,13 @@ def test_add_lang_multilang_rule_create_branch(rule_creator: RuleCreator, mock_g
for lang_item in lang_root.glob('**/*'):
if lang_item.is_file():
expected_content = lang_item.read_text().replace('${RSPEC_ID}', str(rule_number))
- expected_content = expected_content.replace('[source,text]', f'[source,{LANG_TO_SOURCE[language]}]')
+ expected_content = expected_content.replace('[source,text', f'[source,{LANG_TO_SOURCE[language]}')
relative_path = lang_item.relative_to(lang_root)
actual_content = rule_dir.joinpath(language, relative_path).read_text()
assert actual_content == expected_content
+ if lang_item.suffix == '.adoc':
+ assert 'source,text' not in actual_content
+ assert LANG_TO_SOURCE[language] in actual_content
@patch('rspec_tools.create_rule.RuleCreator')
diff --git a/rspec-tools/tests/validation/test_asciidoc_sanitization.py b/rspec-tools/tests/validation/test_asciidoc_sanitization.py
index 43512b2df7e..45c235ff13e 100644
--- a/rspec-tools/tests/validation/test_asciidoc_sanitization.py
+++ b/rspec-tools/tests/validation/test_asciidoc_sanitization.py
@@ -6,38 +6,46 @@
def relative_output(capsys, path: Path):
- return capsys.readouterr().out.replace(str(path), '$PATH')
+ return capsys.readouterr().out.replace(str(path), "$PATH")
-@pytest.mark.parametrize('invalid_file,expected_count', [('unbalanced_single_backquotes', 1),
- ('unbalanced_double_backquotes', 1),
- ('triple_backquotes', 1),
- ('unprotected_formatting', 4),
- ('unprotected_formatting_with_plusses', 1),
- ('wrong_constrained_passthrough', 1),
- ('unclosed_ifdef', 1),
- ('close_unopened_ifdef', 1),
- ('two_ifdef', 1),
- ('two_ifdef_unclosed', 1),
- ('vscode_ifdef', 2),
- ('wrong_ifdef', 1),
- ('wrong_endif', 1),
- ('include_stuck_before', 1),
- ('include_stuck_after', 1),
- ('two_stuck_includes', 2)
- ])
-def test_need_sanitation(mockinvalidasciidoc: Path, invalid_file, expected_count, capsys, snapshot):
- '''Check that we detect needs for sanitation.'''
+@pytest.mark.parametrize(
+ "invalid_file,expected_count",
+ [
+ ("unbalanced_single_backquotes", 1),
+ ("unbalanced_double_backquotes", 1),
+ ("triple_backquotes", 1),
+ ("unprotected_formatting", 4),
+ ("unprotected_formatting_with_plusses", 1),
+ ("wrong_constrained_passthrough", 1),
+ ("unclosed_ifdef", 1),
+ ("close_unopened_ifdef", 1),
+ ("two_ifdef", 1),
+ ("two_ifdef_unclosed", 1),
+ ("vscode_ifdef", 2),
+ ("wrong_ifdef", 1),
+ ("wrong_endif", 1),
+ ("include_stuck_before", 1),
+ ("include_stuck_after", 1),
+ ("two_stuck_includes", 2),
+ ("unnamed_language", 2),
+ ("link_rule_sonarsource_com", 3),
+ ],
+)
+def test_need_sanitation(
+ mockinvalidasciidoc: Path, invalid_file, expected_count, capsys, snapshot
+):
+ """Check that we detect needs for sanitation."""
name_path = Path(invalid_file)
- adoc = mockinvalidasciidoc / name_path.with_suffix('.adoc')
- expected = mockinvalidasciidoc / 'snapshots' / name_path.with_suffix('.txt')
+ adoc = mockinvalidasciidoc / name_path.with_suffix(".adoc")
+ expected = mockinvalidasciidoc / "snapshots" / name_path.with_suffix(".txt")
assert sanitize_asciidoc(adoc) == expected_count
- snapshot.snapshot_dir = mockinvalidasciidoc / 'snapshots'
+ snapshot.snapshot_dir = mockinvalidasciidoc / "snapshots"
snapshot.assert_match(relative_output(capsys, mockinvalidasciidoc), expected)
def test_correctly_sanitized(mockasciidoc: Path):
- '''Check that we raise no issue on correctly sanitized asciidoc'''
- name_path = Path('valid')
- adoc = mockasciidoc / name_path.with_suffix('.adoc')
+ """Check that we raise no issue on correctly sanitized asciidoc"""
+ name_path = Path("valid")
+ adoc = mockasciidoc / name_path.with_suffix(".adoc")
assert sanitize_asciidoc(adoc) == 0
diff --git a/rspec-tools/tests/validation/test_description_validation.py b/rspec-tools/tests/validation/test_description_validation.py
index 9b4cf03bab5..f92772f84ce 100644
--- a/rspec-tools/tests/validation/test_description_validation.py
+++ b/rspec-tools/tests/validation/test_description_validation.py
@@ -4,8 +4,14 @@
import pytest
from rspec_tools.errors import RuleValidationError
from rspec_tools.rules import RulesRepository
-from rspec_tools.validation.description import validate_section_names, \
- validate_section_levels, validate_parameters, validate_source_language, validate_subsections
+from rspec_tools.validation.description import (
+ validate_parameters,
+ validate_section_levels,
+ validate_section_names,
+ validate_security_standard_links,
+ validate_source_language,
+ validate_subsections,
+)
@pytest.fixture
@@ -33,6 +39,11 @@ def test_unexpected_section_fails_validation(invalid_rule):
with pytest.raises(RuleValidationError, match=fr'^Rule {rule.id} has an unconventional header "Invalid header"'):
validate_section_names(rule)
+def test_sections_with_wrong_level_fails_validation(invalid_rule):
+ rule = invalid_rule('S100', 'php')
+ with pytest.raises(RuleValidationError, match=fr'^Rule {rule.id} has some sections misclassified. Ensure there are not too many `=` in the asciidoc file for: How to fix it, Resources'):
+ validate_section_names(rule)
+
def test_valid_section_levels_passes_validation(rule_language):
'''Check that description with correct formatting is considered valid.'''
validate_section_levels(rule_language('S100', 'cfamily'))
@@ -119,12 +130,6 @@ def test_wrong_format_how_to_fix_it_section_validation(invalid_rule):
with pytest.raises(RuleValidationError, match=f'Rule typescript:S200 has a "How to fix it" section with an unsupported format: "How to fix it wrong format". Either use "How to fix it" or "How to fix it in FRAMEWORK NAME"'):
validate_section_names(rule)
-def test_unallowed_subsections_in_how_to_fix_it_validation(invalid_rule):
- '''Check that having "How to fix it" subsections with unallowed names breaks validation'''
- rule = invalid_rule('S200', 'java')
- with pytest.raises(RuleValidationError, match=f'Rule java:S200 has a "How to fix it" subsection with an unallowed name: "Yolo \\(invalid section name\\)"'):
- validate_subsections(rule)
-
def test_duplicate_subsections_in_how_to_fix_it_validation(invalid_rule):
'''Check that having duplicate "How to fix it" subsections breaks validation'''
rule = invalid_rule('S200', 'csharp')
@@ -149,12 +154,6 @@ def test_education_format_missing_mandatory_sections_validation(invalid_rule):
with pytest.raises(RuleValidationError, match=f'Rule common:S200 is missing the "Why is this an issue\\?" section'):
validate_section_names(rule)
-def test_code_examples_with_typo_validation(invalid_rule):
- '''Check that the "Code examples" subsection with a typo in the education format breaks validation'''
- rule = invalid_rule('S200', 'cobol')
- with pytest.raises(RuleValidationError, match=f'Rule cobol:S200 has a "How to fix it" subsection with an unallowed name: "Coding examples"'):
- validate_subsections(rule)
-
def test_noncompliant_examples_with_typo_validation(invalid_rule):
'''Check that the "Non-compliant examples" sub-subsection with a typo in the education format breaks validation'''
rule = invalid_rule('S200', 'apex')
@@ -186,3 +185,20 @@ def test_valid_why_is_this_an_issue_subsections_validation(rule_language):
'''Check that any substitle is considered valid in the "why is this an issue?" section'''
rule = rule_language('S200', 'java')
validate_subsections(rule)
+
+def test_valid_security_standard_links(rule_language):
+ '''Check that the security standards links match what is define in th rule metadata'''
+ rule = rule_language('S200', 'python')
+ validate_security_standard_links(rule)
+
+def test_missing_security_standard_links_fails_validation(rule_language):
+ '''Check that the security standards links match what is define in th rule metadata'''
+ rule = rule_language('S200', 'docker')
+ with pytest.raises(RuleValidationError, match=re.escape('Rule docker:S200 has a mismatch for the OWASP security standards. Add links to the Resources/See section ([\'A10\']) or fix the rule metadata')):
+ validate_security_standard_links(rule)
+
+def test_extra_security_standard_links_fails_validation(rule_language):
+ '''Check that the security standards links match what is define in th rule metadata'''
+ rule = rule_language('S200', 'terraform')
+ with pytest.raises(RuleValidationError, match=re.escape('Rule terraform:S200 has a mismatch for the OWASP security standards. Remove links from the Resources/See section ([\'A10\']) or fix the rule metadata')):
+ validate_security_standard_links(rule)
diff --git a/rspec-tools/tests/validation/test_metadata_validation.py b/rspec-tools/tests/validation/test_metadata_validation.py
index 87d25427d5a..e525b39d677 100644
--- a/rspec-tools/tests/validation/test_metadata_validation.py
+++ b/rspec-tools/tests/validation/test_metadata_validation.py
@@ -82,7 +82,7 @@ def test_rule_with_invalid_impacts(invalid_rules: RulesRepository):
def test_rule_with_invalid_impact_level(invalid_rules: RulesRepository):
s506 = invalid_rules.get_rule('S506')
- with pytest.raises(RuleValidationError, match=re.escape("Rule S506 failed validation for these reasons:\n - Rule scala:S506 has invalid metadata in MAINTAINABILITY: 'INVALID' is not one of ['LOW', 'MEDIUM', 'HIGH']")):
+ with pytest.raises(RuleValidationError, match=re.escape("Rule S506 failed validation for these reasons:\n - Rule scala:S506 has invalid metadata in MAINTAINABILITY: 'INVALID' is not one of ['INFO', 'LOW', 'MEDIUM', 'HIGH', 'BLOCKER']")):
validate_rule_metadata(s506)
diff --git a/rules/S100/java/metadata.json b/rules/S100/java/metadata.json
index 706bf8d862e..518fbf86811 100644
--- a/rules/S100/java/metadata.json
+++ b/rules/S100/java/metadata.json
@@ -1,3 +1,4 @@
{
- "title": "Method names should comply with a naming convention"
+ "title": "Method names should comply with a naming convention",
+ "scope": "Main"
}
diff --git a/rules/S100/jcl/metadata.json b/rules/S100/jcl/metadata.json
new file mode 100644
index 00000000000..76bc286efd4
--- /dev/null
+++ b/rules/S100/jcl/metadata.json
@@ -0,0 +1,3 @@
+{
+ "title": "Procedure names should comply with a naming convention"
+}
\ No newline at end of file
diff --git a/rules/S100/jcl/rule.adoc b/rules/S100/jcl/rule.adoc
new file mode 100644
index 00000000000..c81f51b090a
--- /dev/null
+++ b/rules/S100/jcl/rule.adoc
@@ -0,0 +1,36 @@
+== Why is this an issue?
+
+Shared naming conventions allow teams to collaborate efficiently.
+
+This rule raises an issue when a procedure name does not match a provided regular expression.
+
+For example, with the default provided regular expression ``++^[A-Z][A-Z0-9]*$++``, the procedure:
+
+[source,jcl]
+----
+//* Noncompliant
+//$PROC1 PROC
+----
+
+should be renamed to
+
+[source,jcl]
+----
+//PROC1 PROC
+----
+
+ifdef::env-github,rspecator-view[]
+
+'''
+== Implementation Specification
+(visible only on this page)
+
+include::../message.adoc[]
+
+'''
+== Comments And Links
+(visible only on this page)
+
+include::../comments-and-links.adoc[]
+
+endif::env-github,rspecator-view[]
diff --git a/rules/S100/message.adoc b/rules/S100/message.adoc
index c1006b34f32..2f3efe0a4b3 100644
--- a/rules/S100/message.adoc
+++ b/rules/S100/message.adoc
@@ -1,4 +1,4 @@
=== Message
-Rename [method|function|subroutine] "XXXX" to match the regular expression ${format}.
+Rename [method|function|subroutine|procedure] "XXXX" to match the regular expression ${format}.
diff --git a/rules/S100/php/rule.adoc b/rules/S100/php/rule.adoc
index e3dd0b48e9f..db24c191d25 100644
--- a/rules/S100/php/rule.adoc
+++ b/rules/S100/php/rule.adoc
@@ -2,7 +2,7 @@ include::../rule.adoc[]
For example, with the default provided regular expression ``++^[a-z][a-zA-Z0-9]*$++``, the function:
-[source,php]
+[source,php,diff-id=1,diff-type=noncompliant]
----
function DoSomething(){ // Noncompliant
// ...
@@ -11,13 +11,31 @@ function DoSomething(){ // Noncompliant
should be renamed to
-[source,php]
+[source,php,diff-id=1,diff-type=compliant]
----
function doSomething(){
// ...
}
----
+In case the Drupal framework is detected and the default regex is not replaced, it will follow the PHP coding standards for Drupal.
+
+[source,php,diff-id=2,diff-type=noncompliant]
+----
+function doSomething(){ // Noncompliant
+ // ...
+}
+----
+
+should be renamed to
+
+[source,php,diff-id=2,diff-type=compliant]
+----
+function do_something(){
+ // ...
+}
+----
+
=== Exceptions
Methods with an ``++@inheritdoc++`` annotation, as well as magic methods (``++__construct()++``, ``++__destruct()++``, ``++__call()++``, ``++__callStatic()++``, ``++__get()++``, ``++__set()++``, ``++__isset()++``, ``++__unset()++``, ``++__sleep()++``, ``++__wakeup()++``, ``++__toString()++``, ``++__invoke()++``, ``++__set_state()++``, ``++__clone()++``, ``++__debugInfo()++``) are ignored.
@@ -34,6 +52,10 @@ function __destruct(){...} // Compliant by exception
function myFunc(){...} // Compliant by exception
----
+== References
+
+* https://www.drupal.org/docs/develop/standards/php/php-coding-standards#s-functions-and-variables[Drupal - Naming Conventions - Functions and variables]
+
ifdef::env-github,rspecator-view[]
'''
diff --git a/rules/S1001/cfamily/rule.adoc b/rules/S1001/cfamily/rule.adoc
index 7d7a9bac8e4..df2079bc164 100644
--- a/rules/S1001/cfamily/rule.adoc
+++ b/rules/S1001/cfamily/rule.adoc
@@ -2,8 +2,11 @@
`using` directives add additional scopes to the set of scopes searched during name lookup. All identifiers in these scopes become visible, increasing the possibility that the identifier found by the compiler does not meet developer expectations.
-Using-declarations or fully-qualified names restricts the set of names considered to only the name explicitly specified, and so these are safer options.
+_Using-declarations_ or fully-qualified names restricts the set of names considered to only the name explicitly specified, and so these are safer options.
+=== Exceptions
+
+It is not easy to fully qualify the content of the `std::literals` and `std::placeholders` namespaces. Therefore, this rule does not raise violations for `using` directives that target these namespaces or their sub-namespaces.
=== Noncompliant code example
diff --git a/rules/S1003/cfamily/rule.adoc b/rules/S1003/cfamily/rule.adoc
index 8fff8267062..dba448e95af 100644
--- a/rules/S1003/cfamily/rule.adoc
+++ b/rules/S1003/cfamily/rule.adoc
@@ -1,13 +1,12 @@
== Why is this an issue?
-A using directive makes names from another namespace available in the current scope. It should only be used when those names do not create an ambiguity with other names, otherwise, it is better to fully qualify the names you want to use.
+A using-directive (e.g., `using namespace std;`) makes names from another namespace available in the current scope. It should only be used when those names do not create an ambiguity with other names. Otherwise, it is better to fully qualify the names you want to use.
+The effect of using-directives inside a function body ceases at the end of the current scope. However, when the using-directives are at the global or namespace scope, their effects propagate to the rest of the scope.
-When you write a header file, you don't know from which context it will be included. Therefore, if this header contains using directives, you cannot be sure that they will not create ambiguities in that context. Those ambiguities could lead to compilation failures or, worse, to a different function being selected by overload resolution depending on the order of inclusion of headers.
-
-
-A using declaration behaves in the same way but only for one name. Because of their much narrower scope, this rule does not apply to using declarations.
+When you write a header file, you don't know from which contexts it will be included. Therefore, if this header contains using-directives at the global or namespace scope, you cannot be sure that they will not create ambiguities in some of the including contexts. Those ambiguities could lead to compilation failures or, worse, to a different function being selected by overload resolution depending on the order of inclusion of headers.
+This rule will raise an issue on using-directives in header files.
=== Noncompliant code example
@@ -52,13 +51,22 @@ void m2 ( )
=== Exceptions
-The issue only happens if the using directive is at global scope or at namespace scope. If is is inside a function body, it will cease to be in effect at the end of the current scope, and will not propagate to the users of the header file.
+Using-declarations (e.g., `using std::cout;`) behave in the same way but only for one name. This rule does not apply to them because their scope is much narrower.
+Additionally, since it isn't easy to fully qualify the content of the `std::literals` and `std::placeholders` namespaces, this rule doesn't raise violations for using-directives that target these namespaces or their sub-namespaces, such as ``++std::literals::chrono_literals++``.
== Resources
+=== Documentation
+
+* {cpp} reference - https://en.cppreference.com/w/cpp/language/namespace#Using-directives[using-directives]
+
+
+=== External coding guidelines
+
* MISRA {cpp}:2008, 7-3-6 - using-directives and using-declarations (excluding class scope or function scope using-declarations) shall not be used in header files.
-* https://github.com/isocpp/CppCoreGuidelines/blob/036324/CppCoreGuidelines.md#sf7-dont-write-using-namespace-at-global-scope-in-a-header-file[{cpp} Core Guidelines SF.7] - Don’t write ``++using namespace++`` at global scope in a header file
+
+* {cpp} Core Guidelines - https://github.com/isocpp/CppCoreGuidelines/blob/e49158a/CppCoreGuidelines.md#sf7-dont-write-using-namespace-at-global-scope-in-a-header-file[SF.7: Don't write `using namespace` at global scope in a header file]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S101/dart/metadata.json b/rules/S101/dart/metadata.json
new file mode 100644
index 00000000000..17971333806
--- /dev/null
+++ b/rules/S101/dart/metadata.json
@@ -0,0 +1,3 @@
+{
+
+}
diff --git a/rules/S101/dart/rule.adoc b/rules/S101/dart/rule.adoc
new file mode 100644
index 00000000000..234ca3cc8d4
--- /dev/null
+++ b/rules/S101/dart/rule.adoc
@@ -0,0 +1,56 @@
+== Why is this an issue?
+
+Shared naming conventions allow teams to collaborate efficiently. In Dart, the convention is that all type names should be in camel-case starting with a capital letter (aka Pascal case).
+
+This rule raises an issue when a class name does not comply with this convention.
+
+== How to fix it
+
+=== Code examples
+
+==== Noncompliant code example
+
+[source,dart]
+----
+class My_Class { } // Noncompliant: contains a dash
+class myClass { } // Noncompliant: starts with a lowercase
+class myclass { } // Noncompliant: all in lowercase
+----
+
+==== Compliant solution
+
+[source,dart]
+----
+class MyClass { }
+----
+
+== Resources
+
+* Dart Docs - https://dart.dev/tools/linter-rules/camel_case_types[Dart Linter rule - camel_case_types]
+
+=== Related rules
+
+* S7046 - Extension identifiers should comply with a naming convention
+* S7075 - Non-constant names should comply with a naming convention
+
+ifdef::env-github,rspecator-view[]
+
+'''
+== Implementation Specification
+(visible only on this page)
+
+=== Message
+
+* The type name 'Resources
+
+
+
+
+Documentation
+
+
+-
+
-
+
OWASP - HTTP Response Splitting
+
+
+
+Standards
+
+
+-
+
- + + +
-
+
OWASP - Top 10 2017 Category A10 - Insufficient Logging & Monitoring
+
+ - + + +
- + + +
-
+
CWE - CWE-113 - Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting')
+
+
-
-
-
-
-
-----
-
-
-=== Compliant solution
-
-[source,html]
-----
-
-
-
-
-
-----
+This rule raises an issue when:
+* An ``++++`` or ``++++`` element has no ``++alt++`` attribute or it holds an empty string value.
+* An ``++
+
+
+
+
+
+----
+
+==== Compliant solution
+
+[source,html,diff-id=1,diff-type=compliant]
+----
+
+
+
+
+
+----
+
+== Resources
+=== Documentation
+
+* W3C - https://www.w3.org/WAI/tutorials/images/decision-tree/[W3C WAI Web Accessibility Tutorials]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H24.html[Providing text alternatives for the area elements of image maps]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H36.html[Using alt attributes on images used as submit buttons]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H37.html[Using alt attributes on img elements]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H67.html[Using null alt text and no title attribute on img elements for images that AT should ignore]
+* W3C - https://www.w3.org/TR/WCAG20-TECHS/H2.html[Combining adjacent image and text links for the same resource]
+* W3C - https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-text-equiv-all[Non-text Content]
+* W3C - https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-navigation-mechanisms-refs[Link Purpose (In Context)]
+* W3C - https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-navigation-mechanisms-link[Link Purpose (Link Only)]
ifdef::env-github,rspecator-view[]
diff --git a/rules/S1077/javascript/metadata.json b/rules/S1077/javascript/metadata.json
new file mode 100644
index 00000000000..d1b8102e318
--- /dev/null
+++ b/rules/S1077/javascript/metadata.json
@@ -0,0 +1,7 @@
+{
+ "tags": [
+ "accessibility",
+ "wcag2-a",
+ "react"
+ ]
+}
diff --git a/rules/S1077/javascript/rule.adoc b/rules/S1077/javascript/rule.adoc
new file mode 100644
index 00000000000..847e0b6eac9
--- /dev/null
+++ b/rules/S1077/javascript/rule.adoc
@@ -0,0 +1,103 @@
+== Why is this an issue?
+
+The ``++alt++``, ``++aria-label++`` and ``++aria-labelledby++`` attributes provide a textual alternative to an image.
+
+It is used whenever the actual image cannot be rendered.
+
+Common reasons for that include:
+
+* The image can no longer be found
+* Visually impaired users using a screen reader software
+* Image loading is disabled, to reduce data consumption on mobile phones
+
+It is also very important not to set an alternative text attribute to a non-informative value. For example, ``++