Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
bd43f1b
bump dev version [skip ci]
detilium Dec 1, 2025
35acf29
Use Stream in favour of byte array for optimised performance and memo…
detilium Dec 19, 2025
0bf1ac0
Bump version for dev [skip ci]
detilium Dec 19, 2025
fffd890
Add ZIP validation for ZIP-based file formats (OOXML + ODF)
detilium Dec 21, 2025
5a09654
Add security policy [skip ci]
detilium Dec 21, 2025
f4e33c7
Expanded support for ODF formats (we now support .odp and .ods)
detilium Dec 21, 2025
3dfae55
Add security policy to solution folder [skip ci]
detilium Dec 22, 2025
e5a91a2
Add code of conduct, contributing info, and issue templates [skip ci]
detilium Jan 16, 2026
10a1e6b
Add issue templates content [skip ci]
detilium Jan 16, 2026
024a20d
Convert issue templates to yml [skip ci]
detilium Jan 16, 2026
be00896
Fix wrong template path [skip ci]
detilium Jan 16, 2026
5adc036
Remove setup in config [skip ci]
detilium Jan 16, 2026
15e6b67
Fix bokrn issue template yml [skip ci]
detilium Jan 16, 2026
27bc3c5
Fix feature request issue template [skip ci]
detilium Jan 16, 2026
7b70f0b
Fix issue with system.IO.Packaging for net48 target framework #18 (#19)
detilium Jan 23, 2026
adc0c4f
Basic ODF conformance validation (#22)
detilium Feb 23, 2026
984d1bf
Convert OpenXML conformance validation to configurable validation set…
chaadfh Feb 24, 2026
447a458
Merge remote-tracking branch 'origin/master' into dev
detilium Feb 25, 2026
aac98af
Rename the ODF validation rules
detilium Feb 28, 2026
940efbe
Update readme [skip ci]
detilium Mar 1, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Bug
description: Report a bug in the system
title: "[Bug]: <title>"
labels: bug
body:
- type: textarea
attributes:
label: Description
description: A clear and concise description of the bug.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: Explain what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Steps the reproduce the behavior.
placeholder: |
1. Setup ...
2. Call function ...
3. See exception ...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **NET version**: .NET 9
- **OS**: Windows 11
- **Version**: v1.0.1
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Documentation
description: Suggest updates or additions to documentation
title: "[Docs]: <title>"
labels: docs
body:
- type: textarea
attributes:
label: Documentation update
description: What part of the documentation needs to be updated or added?
validations:
required: true
- type: textarea
attributes:
label: Why is this needed?
description: Explain the importance of this update.
validations:
required: true
- type: textarea
attributes:
label: Suggested changes
description: Provide a detailed description of the changes.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest a new feature or improvement
title: "[Feature]: <title>"
labels: enhancement
body:
- type: textarea
attributes:
label: Feature description
description: What feature would you like to see?
validations:
required: true
- type: textarea
attributes:
label: Why is this needed?
description: Explain the problem or need for this feature.
validations:
required: true
- type: textarea
attributes:
label: Suggested solutions
description: Describe how this feature could be implemented.
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/general_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: General report
description: Provide general feedback or inquiries
title: "[General]: <title>"
labels: general
body:
- type: textarea
attributes:
label: Feedback or inquiry
description: Provide your feedback or inquiry.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
41 changes: 20 additions & 21 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Continout Integration
name: Continous Integration

on:
push:
branches: [ "dev", "master" ]
branches: ["dev", "master"]
pull_request:
branches: [ "dev", "master" ]
branches: ["dev", "master"]

env:
CI_BUILD_NUMBER_BASE: ${{ github.run_number }}
Expand All @@ -13,29 +13,28 @@ env:

jobs:
build:

# We need to run on Windows as we're supporting .NET Framework
runs-on: windows-latest

permissions:
contents: write

steps:
- uses: actions/checkout@v5
- name: Setup .NET
uses: actions/setup-dotnet@v5
with:
dotnet-version: 10.0.x
- name: Compute and set build number
shell: bash
run: |
- uses: actions/checkout@v5
- name: Setup .NET
uses: actions/setup-dotnet@v5
with:
dotnet-version: 10.0.x
- name: Compute and set build number
shell: bash
run: |
echo "CI_BUILD_NUMBER=$(($CI_BUILD_NUMBER_BASE+1000))" >> $GITHUB_ENV
- name: Build & Push
env:
PR_TRIGGER: ${{ env.PR_TRIGGER }}
DOTNET_CLI_TELEMTRY_OPTOUT: true
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
shell: pwsh
run: |
./Build.ps1
- name: Build & Push
env:
PR_TRIGGER: ${{ env.PR_TRIGGER }}
DOTNET_CLI_TELEMTRY_OPTOUT: true
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
shell: pwsh
run: |
./Build.ps1
1 change: 1 addition & 0 deletions ByteGuard.FileValidator.slnx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<File Path="Directory.Version.props" />
<File Path="LICENSE" />
<File Path="README.md" />
<File Path="SECURITY.md" />
</Folder>
<Folder Name="/tests/">
<Project Path="tests/ByteGuard.FileValidator.Tests.Unit/ByteGuard.FileValidator.Tests.Unit.csproj" />
Expand Down
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders 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, 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 community leaders responsible for enforcement at
byteguard-hq@proton.me.
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][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

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.
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing to ByteGuard

Thanks for considering contributing to ByteGuard.

ByteGuard is an open-source initiative focused on practical application-security tooling. Contributions like bug reports, PRs, docs, tests, and feedback help keep the ecosystem useful and trustworthy.

These are lightweight guidelines for contributing to ByteGuard repositories hosted under the ByteGuard organization. This is a living document — improvements via PR are welcome.

## Where to start?

Each repository is the best place to contribute to its own scope:

- **Core libraries/packages**: changes and fixes belong in the relevant package repo.
- **Docs and examples**: improvements are always welcome (especially clarity and real-world usage).

If you’re new, look for issues labeled **good first issue**, **up-for-grabs**, or **help wanted** (if the repo uses them).

Before starting work on a PR, consider commenting on an existing issue or creating one so we can align on approach.

## Reporting an issue

Bugs and enhancements are tracked via GitHub Issues.

When creating an issue, please include:

- What you expected vs. what happened
- Steps to reproduce (a minimal sample helps a lot)
- Version(s) affected
- Environment details (OS/runtime/framework, where relevant)
- Logs/error output (please **redact secrets**)

## Requesting a feature/enhancement

Feature requests are also tracked via GitHub Issues.

Please include:

- The problem you’re trying to solve (use-case)
- Your proposed solution (API/behavior, if relevant)
- Alternatives you considered
- Any security implications or compatibility concerns

## Security vulnerabilities

**Please do not open public issues for security vulnerabilities.**

If the repo has **Security Advisories** enabled, report it there. Otherwise, use the security contact information listed in the repository (README/profile) if available.

Include:

- Description + impact
- Affected versions
- Repro steps / PoC (if safe to share)
- Suggested mitigation (if you have one)

## Making a PR

- If an issue does not already exist, please create one first (or explain the motivation clearly in the PR).
- Fork the repository and create a branch with a descriptive name.
- Keep commits as logical units and reference the related issue when possible.
- Run build/tests locally before opening the PR.
- Prefer small, focused PRs over large multi-purpose changes.
- For behavior changes or fixes, tests are strongly encouraged.

## Questions?

ByteGuard has an active and helpful community who are happy to help point you in the right direction or work through any issues you might encounter. You can get in touch via:

- Our [issue tracker](https://github.com/ByteGuard-HQ/byteguard-file-validator-net/issues)
- Our [Discord server](https://discord.com/invite/XwjdR2jmVZ)

Finally, when contributing please keep in mind our [Code of Conduct](CODE_OF_CONDUCT.md).
Loading