From 3239c0b28109aa776bdadb9927b22af3a35800bb Mon Sep 17 00:00:00 2001 From: Dan Peterson Date: Thu, 13 Aug 2026 15:17:03 -0600 Subject: [PATCH] Add SECURITY.md and CONTRIBUTING.md Community-health files matching the other Safeguard open source projects: a PVD-first security policy and contributor build/test/PR guidance. --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ SECURITY.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 85 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..20eae53 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing to SafeguardJava + +Thanks for your interest in improving SafeguardJava, the Java SDK for the +One Identity Safeguard Web API. + +## Reporting issues + +- **Bugs and feature requests:** open a GitHub Issue. +- **Security vulnerabilities:** do **not** open a public issue — follow + [SECURITY.md](SECURITY.md). + +## Prerequisites + +- [JDK 8](https://adoptium.net) or later (JDK 9+ is required at runtime for + the SignalR event-listener feature). +- [Maven 3.0.5](https://maven.apache.org/download.cgi) or later. +- (Optional) a Safeguard for Privileged Passwords appliance for the + interactive Java test client under `tests/safeguardjavaclient/`. + +## Building + + mvn package + +## Testing + +`mvn verify` runs the hermetic Surefire unit tests plus the EditorConfig +and SpotBugs checks — no appliance required: + + mvn clean verify + +The interactive, live-appliance client lives under +`tests/safeguardjavaclient/`. + +## Coding conventions + +Static analysis runs during `mvn verify` (EditorConfig line-ending checks +and SpotBugs). See [AGENTS.md](AGENTS.md) for the full conventions. + +## Submitting changes + +1. Fork the repository and create a feature branch. +2. Keep commits focused with clear messages. +3. Ensure `mvn clean verify` passes (unit tests, EditorConfig, SpotBugs). +4. Open a pull request describing the behavior you changed and the tests + that prove it. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..03be5dc --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,40 @@ +# Security Policy + +## Reporting a Vulnerability + +We take the security of One Identity's Safeguard open source projects +seriously. **Please do not report security vulnerabilities through public +GitHub issues, pull requests, or discussions.** Use one of the private +channels below. + +### Preferred: GitHub Private Vulnerability Reporting + +1. Open the **Security** tab of this repository. +2. Click **Report a vulnerability**. +3. Include the affected version(s), a description, reproduction steps, + and impact. + +This opens a private advisory visible only to you and the maintainers. +If we confirm and fix the issue, we will credit you in the published +GitHub Security Advisory unless you ask us not to. + +### Alternative: One Identity responsible disclosure + +You may also report through One Identity's official process at +https://support.oneidentity.com/essentials/reporting-security-vulnerability +(choose **Report Vulnerability**). Use this if you prefer to work through +One Identity Support or are reporting across multiple products. + +## Our commitment + +We will acknowledge and respond to your report within **48 hours** and +keep you informed as we investigate and work toward a fix. Please give us +a reasonable opportunity to address the issue before any public +disclosure. + +## Scope + +This policy covers the code in this repository. Vulnerabilities in the +Safeguard for Privileged Passwords or Safeguard for Privileged Sessions +appliances should be reported through One Identity's process at +https://support.oneidentity.com/essentials/reporting-security-vulnerability. \ No newline at end of file