From 8dc8e0884b3d1d7c8dd0c208991210f960679564 Mon Sep 17 00:00:00 2001 From: mahach666 <79989386+mahach666@users.noreply.github.com> Date: Sun, 15 Nov 2026 16:08:33 +0300 Subject: [PATCH 1/2] Add clean-room rule, Code of Conduct and full security policy, ignore private fixtures - CONTRIBUTING.md: new Clean-room rule section and the noreply commit email rule. - SECURITY.md: Supported versions, Reporting and Scope sections. - CODE_OF_CONDUCT.md added; README.md already links to it. - .gitignore: test_files/, IFC and Revit file extensions, .env. The committed synthetic fixture under tests/**/Fixtures stays tracked. --- .gitignore | 11 +++++++ CODE_OF_CONDUCT.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 12 ++++++++ SECURITY.md | 28 ++++++++++++----- 4 files changed, 121 insertions(+), 7 deletions(-) create mode 100644 CODE_OF_CONDUCT.md diff --git a/.gitignore b/.gitignore index be51501..7adae05 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,14 @@ __pycache__/ # Documentation site (DocFX output and generated API pages) _site/ docs/api/ + +# Private test fixtures and customer models never go into the repository +test_files/ +*.ifc +*.ifczip +*.rvt +# Small synthetic fixtures are committed on purpose +!tests/**/Fixtures/** + +# Local secrets +.env diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..cb4c787 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,77 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders of IfcIO pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the IfcIO repository owner via GitHub: report through GitHub private vulnerability reporting or by contacting the maintainers listed on the repository page. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e9b947..9730097 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,18 @@ Report security vulnerabilities privately through the **Security** tab. - Keep nullable reference types enabled. - Warnings are treated as errors. +## Clean-room rule + +All code is written independently from the ISO 10303-21 and buildingSMART +specifications. Do not add vendor code, SDKs, SDK internals, headers or +binaries, decompiled or leaked source, or code copied from other IFC +libraries. Do not add customer models or other confidential data, or names, +paths, sizes, GUIDs or other details of private sample files to the repository, +including tests, comments and documentation. Test inputs are built +synthetically in the tests; keep private test files outside version control. + +Do not put personal data in code, documentation, test data or commit metadata. Use your GitHub noreply address as the commit email. + ## Scene adapter `src/IfcIO.Scene` converts IfcIO models into `IOScene` documents and uses only the public API of `IfcIO`; the `IfcIO` diff --git a/SECURITY.md b/SECURITY.md index bf302ea..f5e10f4 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,10 +1,24 @@ -# Security Policy +# Security policy -## Reporting a Vulnerability +## Supported versions -Report security vulnerabilities through GitHub private vulnerability reporting: -1. Go to the **Security** tab of this repository. -2. Select **Report a vulnerability**. -3. Describe the vulnerability, its potential impact, and clear steps to reproduce. +IfcIO is in preview (0.x). Security fixes are made on the latest release only. -Do not report security issues or sensitive data through public GitHub issues. +## Reporting a vulnerability + +Please do not open a public issue for a security problem. Use GitHub private vulnerability reporting: +open the Security tab of the repository and choose "Report a vulnerability". Include the version of IfcIO, the +command or API call, and a description of the problem. A file that triggers it helps, but do not send files with +confidential content; a crafted or cut-down file is usually enough. + +You can expect an acknowledgement within a few days. Fixes are released as soon as they are verified, and the report +is credited unless you prefer otherwise. + +## Scope + +IfcIO parses files that can come from untrusted sources. Problems that matter most: + +- crashes, hangs or unbounded memory use caused by a crafted `.ifc` or `.ifczip` file (for example an archive that + unpacks to far more than its size suggests); +- writing files outside the folder or path a command was given (path traversal in output paths); +- any behaviour that executes code or contacts the network (the library does neither). From 3b43ac6bea7f0b15014efe0aeef274f09a2781c1 Mon Sep 17 00:00:00 2001 From: mahach666 <79989386+mahach666@users.noreply.github.com> Date: Sun, 15 Nov 2026 13:21:50 +0000 Subject: [PATCH 2/2] Allow only the synthetic placement fixture through the ignore rules The broad exception for tests/**/Fixtures let any model or binary under a Fixtures folder be added by accident. --- .gitignore | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 7adae05..eb83290 100644 --- a/.gitignore +++ b/.gitignore @@ -20,8 +20,8 @@ test_files/ *.ifc *.ifczip *.rvt -# Small synthetic fixtures are committed on purpose -!tests/**/Fixtures/** +# The one synthetic fixture that is committed on purpose +!tests/IfcIO.Scene.Tests/Fixtures/placement.ifc # Local secrets .env