diff --git a/.github/SECURITY_ADVISORY_TEMPLATE.md b/.github/SECURITY_ADVISORY_TEMPLATE.md new file mode 100644 index 00000000..5f3230b9 --- /dev/null +++ b/.github/SECURITY_ADVISORY_TEMPLATE.md @@ -0,0 +1,64 @@ + + +Title: [package]: [short description of the issue] + +Ecosystem: Composer +Package: [vendor/package] +Affected versions: [for example >= 4.0.0, < 4.9.2] +Patched versions: [for example 4.9.2] +Severity: [Low, Moderate, High or Critical], CVSS [score] ([vector]) +Weakness: [CWE identifier and name] +CVE: [CVE identifier], once assigned + +--- + +### Impact + +[What is wrong, under which conditions, and what an attacker could do.] + +Applications are affected if they use [package] [affected versions] and [condition]. + +### Patches + +Fixed in [patched versions]: + +``` +composer update [vendor/package] +``` + +### Workarounds + +[What users can do before upgrading, or "None".] + +### References + +- [Link to the fix: commit or pull request] +- [Link to the release notes] + +### Credits + +Reported by [Reporter], with their agreement. + +--- + +## Release note of the patched version + +### Security + +- [Short description of the issue] ([GHSA identifier], [CVE identifier]). [Severity] severity. Upgrade from [affected versions]. Thanks to [Reporter] for the report. + +--- + +## Social post + +[package] [patched version] fixes a [severity] severity issue: [short description]. Versions [x] to [y] are affected; upgrade to [z]. Details: [advisory link] #php #security diff --git a/README.md b/README.md index b84ff17a..751a3b7d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ -PHP JWT Framework -================= + + + JWT Framework + + +JSON Web Tokens: JWS, JWE and JWK. ![Build Status](https://github.com/web-token/jwt-framework/workflows/Integrate/badge.svg)