|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Supported Versions |
| 4 | + |
| 5 | +Currently supported versions of jcommons: |
| 6 | + |
| 7 | +| Version | Supported | |
| 8 | +| ------- | ------------------ | |
| 9 | +| 1.x | :white_check_mark: | |
| 10 | +| < 1.0 | :x: | |
| 11 | + |
| 12 | +## Reporting a Vulnerability |
| 13 | + |
| 14 | +**Please do not report security vulnerabilities through public GitHub issues.** |
| 15 | + |
| 16 | +Instead, please report them via one of the following methods: |
| 17 | + |
| 18 | +### Option 1: GitHub Security Advisories (Preferred) |
| 19 | +1. Go to https://github.com/FlossWare/jcommons/security/advisories |
| 20 | +2. Click "New draft security advisory" |
| 21 | +3. Fill in the details |
| 22 | + |
| 23 | +### Option 2: Email |
| 24 | +Send an email to: **sfloess@gmail.com** |
| 25 | + |
| 26 | +Please include: |
| 27 | +- Type of vulnerability |
| 28 | +- Full paths of source file(s) related to the vulnerability |
| 29 | +- Location of the affected source code (tag/branch/commit) |
| 30 | +- Step-by-step instructions to reproduce the issue |
| 31 | +- Proof-of-concept or exploit code (if possible) |
| 32 | +- Impact of the issue, including how an attacker might exploit it |
| 33 | + |
| 34 | +### What to Expect |
| 35 | +- **Acknowledgment**: Within 48 hours |
| 36 | +- **Initial assessment**: Within 1 week |
| 37 | +- **Fix timeline**: Depends on severity (critical: days, high: weeks, medium/low: next release) |
| 38 | +- **Disclosure**: We follow coordinated disclosure - public disclosure after fix is available |
| 39 | + |
| 40 | +## Security Considerations in jcommons |
| 41 | + |
| 42 | +### Known Security Concerns |
| 43 | +1. **Java Serialization** (`StringUtil.fromString`, `StringUtil.fromCompressedString`) |
| 44 | + - Deprecated since v1.22, planned for removal in v2.0 |
| 45 | + - **Never use with untrusted data** |
| 46 | + - Only for internal, trusted sources |
| 47 | + - Consider using JSON libraries instead |
| 48 | + - **ObjectInputFilter** protection has been added as of v1.30 to restrict deserialization to trusted packages |
| 49 | + |
| 50 | +2. **File Operations** (`FileUtil`) |
| 51 | + - Validate file paths to prevent directory traversal |
| 52 | + - Be cautious with user-supplied file paths |
| 53 | + |
| 54 | +### Best Practices |
| 55 | +- Always use the latest version of jcommons |
| 56 | +- Review CHANGELOG.md for security-related updates |
| 57 | +- Enable OWASP dependency checking in your builds |
| 58 | +- Subscribe to GitHub security advisories for this repository |
| 59 | + |
| 60 | +## Security Update Process |
| 61 | +1. Security patch is developed and tested |
| 62 | +2. CVE is requested (if applicable) |
| 63 | +3. Version is released with security notes in CHANGELOG.md |
| 64 | +4. GitHub Security Advisory is published |
| 65 | +5. Users are notified via release notes |
| 66 | + |
| 67 | +## Attribution |
| 68 | +We appreciate the security research community and will credit researchers (with permission) in: |
| 69 | +- CHANGELOG.md |
| 70 | +- GitHub Security Advisory |
| 71 | +- Release notes |
| 72 | + |
| 73 | +Thank you for helping keep jcommons and its users safe! |
0 commit comments