#!/usr/bin/env python3 from pathlib import Path from typing import List VERSIONS_FILE = ( Path(__file__).absolute().parent.parent / "list-versions" / "version_date.tsv" ) HEADER = """ # Security Policy ## Security Announcements Security fixes will be announced by posting them in the [security changelog](https://clickhouse.com/docs/en/whats-new/security-changelog/). ## Scope and Supported Versions The following versions of ClickHouse server are currently being supported with security updates: """ FOOTER = """## Reporting a Vulnerability We're extremely grateful for security researchers and users that report vulnerabilities to the ClickHouse Open Source Community. All reports are thoroughly investigated by developers. To report a potential vulnerability in ClickHouse please send the details about it to [security@clickhouse.com](mailto:security@clickhouse.com). We do not offer any financial rewards for reporting issues to us using this method. Alternatively, you can also submit your findings through our public bug bounty program hosted by [Bugcrowd](https://bugcrowd.com/clickhouse) and be rewarded for it as per the program scope and rules of engagement. ### When Should I Report a Vulnerability? - You think you discovered a potential security vulnerability in ClickHouse - You are unsure how a vulnerability affects ClickHouse ### When Should I NOT Report a Vulnerability? - You need help tuning ClickHouse components for security - You need help applying security related updates - Your issue is not security related ## Security Vulnerability Response Each report is acknowledged and analyzed by ClickHouse maintainers within 5 working days. As the security issue moves from triage, to identified fix, to release planning we will keep the reporter updated. ## Public Disclosure Timing A public disclosure date is negotiated by the ClickHouse maintainers and the bug submitter. We prefer to fully disclose the bug as soon as possible once a user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to 90 days. For a vulnerability with a straightforward mitigation, we expect the report date to disclosure date to be on the order of 7 days. """ def generate_supported_versions() -> str: with open(VERSIONS_FILE, "r", encoding="utf-8") as fd: versions = [line.split(maxsplit=1)[0][1:] for line in fd.readlines()] supported_year = 0 # set automatically when all supported versions are filled # 3 regular versions regular = [] # type: List[str] max_regular = 3 # 2 LTS versions, one of them could be in regular lts = [] # type: List[str] max_lts = 2 # The rest are unsupported unsupported = [] # type: List[str] table = [ "| Version | Supported |", "|:-|:-|", ] for version in versions: year = int(version.split(".")[0]) month = int(version.split(".")[1]) version = f"{year}.{month}" to_append = "" if version in regular or version in lts: continue if len(regular) < max_regular: regular.append(version) to_append = f"| {version} | ✔️ |" if len(lts) < max_lts and month in [3, 8]: lts.append(version) to_append = f"| {version} | ✔️ |" if to_append: if len(regular) == max_regular or len(lts) == max_lts: supported_year = year table.append(to_append) continue if year < supported_year: # The whole year is unsupported version = f"{year}.*" if not version in unsupported: unsupported.append(version) table.append(f"| {version} | ❌ |") return "\n".join(table) + "\n" def main() -> None: print(HEADER) print(generate_supported_versions()) print(FOOTER) if __name__ == "__main__": main()