Skip to content

Document the Net F/T network security model - #13

Merged
han-xudong merged 1 commit into
mainfrom
docs/security-network-policy
Jul 24, 2026
Merged

Document the Net F/T network security model#13
han-xudong merged 1 commit into
mainfrom
docs/security-network-policy

Conversation

@han-xudong

@han-xudong han-xudong commented Jul 24, 2026

Copy link
Copy Markdown
Member

Summary

  • define the trusted, isolated network model for ATI Net F/T HTTP and UDP traffic
  • document that automatic calibration discovery and RDT records are not authenticated
  • provide deployment controls, configuration-integrity guidance, and private reporting instructions
  • record the device protocol limitation without claiming unsupported HTTPS compatibility

Verification

  • pixi run test: 13 of 13 passed
  • pixi run format-check
  • git diff --check

This documentation change provides the accepted-risk context for Code Scanning alert 1. It does not change runtime behavior or add prose-based tests.

Summary by CodeRabbit

  • Documentation
    • Added network security guidance covering sensor discovery and data streaming limitations.
    • Documented recommended deployment controls, including trusted networks, firewall allowlists, and authenticated boundaries.
    • Added guidance for verifying calibration and units before enabling controllers.
    • Added a security policy with vulnerability reporting instructions, supported network models, and hardware safety considerations.

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: fdce0aeb-b604-428b-a916-762ccc43409d

📥 Commits

Reviewing files that changed from the base of the PR and between 7ea502b and 83e69e1.

📒 Files selected for processing (2)
  • README.md
  • SECURITY.md

📝 Walkthrough

Walkthrough

Adds documentation describing ATI sensor network security limitations, deployment controls, configuration verification, safety guidance, and vulnerability reporting procedures.

Changes

Network security documentation

Layer / File(s) Summary
Security model and deployment guidance
README.md, SECURITY.md
Documents missing encryption, authentication, and integrity for HTTP discovery and UDP streaming, recommends trusted network boundaries and verification controls, explains manual calibration limitations, and defines vulnerability reporting and safety guidance.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: documenting the Net F/T network security model in README and SECURITY.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/security-network-policy

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Jul 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@han-xudong
han-xudong merged commit 1f0b7a7 into main Jul 24, 2026
17 checks passed
@han-xudong
han-xudong deleted the docs/security-network-policy branch July 24, 2026 02:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant