diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..959de44 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,118 @@ +name: CI + +on: + push: + branches: [master] + tags: ['v*'] + pull_request: + branches: [master] + +env: + CARGO_TERM_COLOR: always + +permissions: + contents: write + +jobs: + rust-format: + name: Rust Format + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: + components: rustfmt + - uses: Swatinem/rust-cache@v2 + - run: cargo fmt --check --all + + clippy: + name: Clippy + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: + components: clippy + - uses: Swatinem/rust-cache@v2 + - name: Install system dependencies + run: sudo apt-get update && sudo apt-get install -y pkg-config libssl-dev libfontconfig1-dev + - run: cargo clippy --all-targets --all-features + + rust-test: + name: Rust Tests + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 + - name: Install system dependencies + run: sudo apt-get update && sudo apt-get install -y pkg-config libssl-dev libfontconfig1-dev + - run: cargo test --workspace --all-features --lib --bins --tests + + security-audit: + name: Security Audit + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - run: cargo install cargo-audit && cargo audit + + frontend-lint: + name: Frontend Lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + - name: Install & Lint + run: cd frontend && npm ci && npx eslint src/ --ext .ts,.tsx --max-warnings 0 && npx tsc --noEmit + + build-and-release: + name: Build & Release + needs: [rust-format, clippy, rust-test, security-audit, frontend-lint] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Free disk space + run: | + sudo rm -rf /usr/local/lib/android /usr/share/dotnet /opt/ghc + df -h + - uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 + - name: Install system dependencies + run: sudo apt-get update && sudo apt-get install -y pkg-config libssl-dev libfontconfig1-dev dpkg-dev + - name: Build Rust release + run: cargo build --release + - name: Strip binaries + run: strip target/release/pm-web target/release/pm-worker + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + - name: Build frontend + run: cd frontend && npm ci && npm run build + - name: Build .deb package + run: chmod +x scripts/build-package.sh && scripts/build-package.sh + - name: Generate release notes + if: startsWith(github.ref, 'refs/tags/v') + id: release_notes + run: | + PREV_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "") + if [ -n "$PREV_TAG" ]; then + NOTES=$(git log ${PREV_TAG}..HEAD --pretty=format:"- %s (%h)" --no-merges) + else + NOTES=$(git log --pretty=format:"- %s (%h)" --no-merges) + fi + echo "notes<> $GITHUB_OUTPUT + echo "$NOTES" >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + - name: Upload to GitHub Release + if: startsWith(github.ref, 'refs/tags/v') + uses: softprops/action-gh-release@v2 + with: + body: ${{ steps.release_notes.outputs.notes }} + files: linux-patch-manager_*.deb diff --git a/.gitignore b/.gitignore index 4ee6f5e..2049b6b 100644 --- a/.gitignore +++ b/.gitignore @@ -27,3 +27,6 @@ frontend/dist # Package build artifacts *.deb package-build/ + +# TLS certificates - generated on first run +crates/pm-agent-client/certs/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4abfa98 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# Contributing to Linux-Patch-Manager + +Thank you for your interest in contributing to Linux-Patch-Manager! We appreciate every contribution — from bug reports and documentation improvements to new features and security fixes. + +## Code of Conduct + +This project follows the [Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) code of conduct. By participating, you are expected to uphold this standard. Please report unacceptable behavior to the maintainers. + +## How to Contribute + +1. **Fork** the repository +2. Create a **feature branch** from `main`: + ```bash + git checkout -b feat/my-feature + ``` +3. Make your changes +4. Ensure all CI checks pass: + ```bash + # Rust backend + cargo fmt --check + cargo clippy -- -D warnings + cargo test + + # TypeScript/React frontend + cd frontend + npm run lint + npm run build + npm test + ``` +5. **Commit** using conventional commit format (see below) +6. Open a **Pull Request** against `main` + +## Development Setup + +### Prerequisites + +- **Rust toolchain** (stable) — [rustup](https://rustup.rs/) +- **Node.js** 20+ (for the frontend) — [nvm](https://github.com/nvm-sh/nvm) recommended +- **System dependencies**: + ```bash + sudo apt-get install build-essential libsystemd-dev pkg-config libssl-dev + ``` + +### Build & Run + +```bash +# Backend +cargo build +cargo test + +# Frontend +cd frontend +npm install +npm run build +npm test +``` + +## Commit Messages + +We use [Conventional Commits](https://www.conventionalcommits.org/): + +| Prefix | Usage | +|----------|------------------------| +| `feat:` | New feature | +| `fix:` | Bug fix | +| `docs:` | Documentation changes | +| `chore:` | Maintenance tasks | +| `refactor:` | Code refactoring | +| `test:` | Adding or updating tests | +| `ci:` | CI configuration changes | + +Example: +``` +feat: add patch scheduling to manager dashboard +``` + +## Pull Request Requirements + +- All CI checks must pass (fmt, clippy, test, audit, build) +- One feature or fix per PR — keep changes focused +- Include a clear description of what changed and why +- Update documentation if your change affects behavior + +## Reporting Issues + +Use [GitHub Issues](https://github.com/Draco-Lunaris/Linux-Patch-Manager/issues) to report bugs, request features, or ask questions. Please include: + +- Steps to reproduce (for bugs) +- Expected vs. actual behavior +- Relevant logs or error messages + +## License + +By contributing, you agree that your contributions are licensed under the [Apache License 2.0](LICENSE), the same license as this project. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c2da141 --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to the Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by the Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text file from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2025-2026 Draco Lunaris + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..52106ad --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,46 @@ +# Security Policy + +## Supported Versions + +Only the **latest release** is currently supported with security updates. + +| Version | Supported | +|---------|----------| +| Latest | ✅ | +| Older | ❌ | + +## Reporting a Vulnerability + +**Do not report security vulnerabilities through public GitHub Issues.** + +Instead, use GitHub's private vulnerability reporting: + +👉 [Report a vulnerability for Linux-Patch-Manager](https://github.com/Draco-Lunaris/Linux-Patch-Manager/security/advisories/new) + +This allows us to coordinate a fix before public disclosure. + +### Response Timeline + +- **Acknowledgment** within 48 hours +- **Initial assessment** within 7 days +- **Ongoing updates** on remediation progress + +## Disclosure Policy + +We follow **coordinated disclosure**: + +- We ask for **90 days** before public disclosure of a vulnerability +- Security advisories are published via [GitHub Security Advisories](https://github.com/Draco-Lunaris/Linux-Patch-Manager/security/advisories) +- We will work with you to determine an appropriate disclosure timeline when a fix requires more time + +## Security Best Practices + +This project is a security tool — we hold ourselves to a high standard: + +- **Signed commits**: All commits must be signed (SSH signing) +- **CI enforcement**: All PRs require passing CI checks (fmt, clippy, test, audit, build) +- **Dependency auditing**: `cargo audit` runs in CI to catch known vulnerabilities + +## Credit + +Contributors who responsibly report vulnerabilities will be credited in the corresponding GitHub Security Advisory. diff --git a/scripts/bump-version.sh b/scripts/bump-version.sh new file mode 100755 index 0000000..5ea53ef --- /dev/null +++ b/scripts/bump-version.sh @@ -0,0 +1,82 @@ +#!/bin/bash +# Bump version across all version source files for linux_patch_manager +# Usage: ./scripts/bump-version.sh +# Example: ./scripts/bump-version.sh 0.1.10 0.1.9 +set -euo pipefail + +NEW_VERSION="${1:?Usage: bump-version.sh }" +OLD_VERSION="${2:?Usage: bump-version.sh }" + +REPO_DIR="$(cd "$(dirname "$0")/.." && pwd)" +cd "$REPO_DIR" + +echo "=== Bumping version from $OLD_VERSION to $NEW_VERSION ===" +echo "" + +# 1. Cargo.toml (PRIMARY - workspace.package.version) +sed -i "s/version = \"$OLD_VERSION\"/version = \"$NEW_VERSION\"/" Cargo.toml +echo "[1/5] Cargo.toml: $OLD_VERSION -> $NEW_VERSION" + +# 2. debian/changelog - Prepend new entry using temp file +TEMP_CHANGELOG=$(mktemp) +echo "linux-patch-manager ($NEW_VERSION-1) unstable; urgency=low" > "$TEMP_CHANGELOG" +echo "" >> "$TEMP_CHANGELOG" +echo " * Release v$NEW_VERSION" >> "$TEMP_CHANGELOG" +echo "" >> "$TEMP_CHANGELOG" +echo " -- git-echo $(date -R)" >> "$TEMP_CHANGELOG" +echo "" >> "$TEMP_CHANGELOG" +cat debian/changelog >> "$TEMP_CHANGELOG" +mv "$TEMP_CHANGELOG" debian/changelog +echo "[2/5] debian/changelog: Added entry for $NEW_VERSION" + +# 3. debian/control - Update Version field +if grep -q "^Version:" debian/control 2>/dev/null; then + sed -i "s/^Version: .*/Version: $NEW_VERSION-1/" debian/control + echo "[3/5] debian/control: -> $NEW_VERSION-1" +else + echo "[3/5] debian/control: Version field not found, skipping" +fi + +# 4. scripts/build-package.sh - Update VERSION variable +if [ -f scripts/build-package.sh ]; then + sed -i "s/^VERSION=\".*\"/VERSION=\"$NEW_VERSION\"/" scripts/build-package.sh + echo "[4/5] scripts/build-package.sh: -> $NEW_VERSION" +else + echo "[4/5] scripts/build-package.sh: Not found, skipping" +fi + +# 5. frontend/package.json - Update version field +if [ -f frontend/package.json ]; then + sed -i "s/\"version\": \"[^\"]*\"/\"version\": \"$NEW_VERSION\"/" frontend/package.json + echo "[5/5] frontend/package.json: -> $NEW_VERSION" +else + echo "[5/5] frontend/package.json: Not found, skipping" +fi + +echo "" +echo "=== Version bump complete ===" +echo "" +echo "Verification:" +echo " Cargo.toml: $(grep '^version' Cargo.toml | head -1)" +echo " debian/changelog: $(head -1 debian/changelog)" +if [ -f debian/control ]; then + echo " debian/control: $(grep '^Version' debian/control)" +fi +if [ -f scripts/build-package.sh ]; then + echo " build-package.sh: $(grep '^VERSION=' scripts/build-package.sh)" +fi +if [ -f frontend/package.json ]; then + echo " frontend/package.json: $(grep '"version"' frontend/package.json | head -1)" +fi + +echo "" +echo "Stale references check:" +grep -r "$OLD_VERSION" --include='*.toml' --include='*.sh' --include='*.json' --include='control' . 2>/dev/null | grep -v 'target/' | grep -v '.git/' | grep -v 'node_modules/' | grep -v 'bump-version.sh' || echo " No stale references found" + +echo "" +echo "Next steps:" +echo " 1. Review changes: git diff" +echo " 2. Commit: git commit -am 'chore: bump version to $NEW_VERSION'" +echo " 3. Push: git push origin master" +echo " 4. Tag: git tag v$NEW_VERSION && git push origin v$NEW_VERSION" +echo " 5. Create release via Gitea API"