Add security.txt #262

ljm42 · 2025-04-25T00:02:51Z

Before Submitting This PR, Please Ensure You Have Completed The Following:

Are internal links to wiki documents using relative file links?
Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Is the build succeeding?

Summary by CodeRabbit

New Features
- Added a public security policy file with contact information and guidelines for reporting security vulnerabilities.

coderabbitai · 2025-04-25T00:02:57Z

Walkthrough

A new security.txt file has been introduced in the .well-known directory within the static assets. This file establishes Unraid's official security policy by providing contact details, reporting guidelines, and metadata in compliance with RFC 9116. It includes instructions for reporting vulnerabilities, preferred communication methods, and relevant URLs for policy, encryption, and file verification.

Changes

File(s)	Change Summary
static/.well-known/security.txt	Added a security.txt file specifying the security policy, contact information, and metadata for Unraid.

Poem

A rabbit hops with careful might,
To add a file for all to cite.
Security.txt now marks the way,
For safe disclosures, clear as day.
With contacts, keys, and policy true,
Unraid’s path is clear for you!
🐇🔒

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (3)

static/.well-known/security.txt (3)

8-14: Consider adding optional fields
You might enrich the policy by including sections like Acknowledgements: (to credit reporters) or Hiring: (to signal open roles), which are supported by the spec but not required.

12-12: Prefer relative URLs for maintainability
Switching Canonical: and Signature: from absolute to relative paths (e.g., /.well-known/security.txt) can reduce update overhead if your domain changes.

1-14: Verify web server configuration
Ensure your deployment serves the static/.well-known directory under /.well-known, so that https://unraid.net/.well-known/security.txt is accessible without redirects or blocks.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e100254 and 2b5d3e7.

📒 Files selected for processing (1)

static/.well-known/security.txt (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: build
GitHub Check: AWS Amplify Console Web Preview

🔇 Additional comments (1)

static/.well-known/security.txt (1)

1-7: Header comments are clear and compliant
The introductory comments follow RFC 9116 conventions and provide helpful context for researchers.

coderabbitai · 2025-04-25T00:05:01Z

static/.well-known/security.txt

+Encryption: https://keys.openpgp.org/vks/v1/by-fingerprint/5461B0B9C1CCFB6E53A6760FC5D4DCC26C348C7B
+Preferred-Languages: en
+Canonical: https://unraid.net/.well-known/security.txt
+Expires: 2030-12-31T23:59:00.000Z


🛠️ Refactor suggestion

Shorten the expiration interval
An expiration date in 2030 is overly long. RFC 9116 recommends rotating this file periodically (e.g., every 6–12 months) to ensure the policy stays up to date.

coderabbitai · 2025-04-25T00:05:01Z

static/.well-known/security.txt

+Contact: mailto:security@unraid.net
+Policy: https://unraid.net/policies
+Encryption: https://keys.openpgp.org/vks/v1/by-fingerprint/5461B0B9C1CCFB6E53A6760FC5D4DCC26C348C7B
+Preferred-Languages: en
+Canonical: https://unraid.net/.well-known/security.txt
+Expires: 2030-12-31T23:59:00.000Z
+Signature: https://unraid.net/.well-known/security.txt.sig


⚠️ Potential issue

Missing signature file
Your Signature: https://unraid.net/.well-known/security.txt.sig entry requires the accompanying security.txt.sig file. Please include the PGP signature at that path or update the URL to point to an existing signature.

aws-amplify-us-west-2 · 2025-04-25T00:08:51Z

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-262.d1o5s833kbd339.amplifyapp.com

Add security.txt

2b5d3e7

coderabbitai bot reviewed Apr 25, 2025

View reviewed changes

ljm42 merged commit 97cac11 into main Apr 25, 2025
3 checks passed

ljm42 deleted the add-well-known-security-txt branch April 25, 2025 20:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add security.txt #262

Add security.txt #262

ljm42 commented Apr 25, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 25, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Apr 25, 2025

coderabbitai bot Apr 25, 2025

aws-amplify-us-west-2 bot commented Apr 25, 2025

Add security.txt #262

Add security.txt #262

Conversation

ljm42 commented Apr 25, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Apr 25, 2025 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 25, 2025

Choose a reason for hiding this comment

coderabbitai bot Apr 25, 2025

Choose a reason for hiding this comment

aws-amplify-us-west-2 bot commented Apr 25, 2025

ljm42 commented Apr 25, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)