Skip to content

Commit

Permalink
GitHub: Add security policy (#501)
Browse files Browse the repository at this point in the history
  • Loading branch information
Lamparter authored Jul 29, 2024
1 parent cf2887f commit 2919093
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 21 deletions.
64 changes: 64 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!-- Copyright (c) 2022-2024 0x5BFA. Licensed under the MIT License. See the LICENSE. -->

# Security Policy

This is our policy for reporting security vulnerabilities and overall guidelines on what you should do upon discovering one.

> [!NOTE]
> This document also outlines the measures we have put in to prevent security vulnerabilities in the first place.
---

<!--
### Supported Versions
Use this section to tell people about which versions of your project are
currently being supported with security updates.
| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
-->

## Reporting Security Vulnerabilities

<!--
Use this section to tell people how to report a vulnerability.
Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
-->

**Please report security advistiry from "New draft security advisory" in the Security tab**

In order to report a security vulnerability, you can use [GitHub's built-in tool](https://github.com/0x5bfa/FluentHub/security/advisories/new) which easily allows you to calculate an _attack vector/CVSS string_ or attribute to an existing [`CVE`](https://cve.org) code. This allows the FluentHub Team to accurately calculate the severity and/or importance of preventing it.

### Spotting secrets in code

If you spot a secret in the code, please let us know by contacting us on Discord via private DM. This helps us quietly remove the vulnerability without letting others abuse it.
If you notice that we've accidentally published an `AppCredentials.config` file or removed it from the `.gitignore` in the project root, please notify us.

### GitHub API

FluentHub relies heavily on the GitHub `GraphQL` and legacy `REST` API. If you believe that you have found a security vulnerability in the API and not FluentHub, _please please please_ report it on via [`bounty.github.com`](https://bounty.github.com/), GitHub's official site for reporting vulnerabilities. This helps keep all open-source code safe and protects millions of developers, governments and other organisations across the world.
> All bounty submissions are rated by GitHub using a purposefully simple scale.
## Our Measures

What have we done to keep FluentHub safe?

### Dependabot

We have implemented Dependabot alerts to automatically track security vulnerabilities that apply to the repository's dependencies.

### Code scanning

We have enabled GitHub Code Scanning to automatically scan our code for potential GitHub client secrets and other API tokens.

### Security advisories

We have enabled GitHub security advisories to let us know if a potential security problem might affect our repository or if something doesn't look right with any of our other security vulnerability countermeasures. This makes it easy to track potential errors or problems that might expose user credentials publicly or cause other similar problems.
21 changes: 0 additions & 21 deletions SECURITY.md

This file was deleted.

4 changes: 4 additions & 0 deletions src/FluentHub.App/Views/AppSettings/GeneralPage.xaml
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,10 @@
Grid.Column="3"
Content="Code of conduct"
NavigateUri="https://github.com/0x5BFa/FluentHub/blob/main/.github/CODE_OF_CONDUCT.md" />
<HyperlinkButton
Grid.Column="4"
Content="Security guidelines"
NavigateUri="https://github.com/0x5BFa/FluentHub/blob/main/.github/SECURITY.md" />
</Grid>
</uc:SettingsBlockControl.ExpandableContent>
</uc:SettingsBlockControl>
Expand Down

0 comments on commit 2919093

Please sign in to comment.