Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
value: |
### 🛡️ Security & Zero-Secret Reminder
**DO NOT paste real API client secrets, passwords, bearer tokens, or sensitive customer case details.**
Sanitize all output before submitting. For security vulnerabilities, review [SECURITY.md](../SECURITY.md).
Sanitize all output before submitting. For security vulnerabilities, review [SECURITY.md](https://github.com/f5devcentral/myf5-cli/blob/main/SECURITY.md).

- type: textarea
id: description
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: "Security Vulnerability Disclosure"
url: "https://github.com/SalesAmerSP/myf5-cli/blob/main/SECURITY.md"
url: "https://github.com/f5devcentral/myf5-cli/blob/main/SECURITY.md"
about: "Report security vulnerabilities directly to F5 PSIRT and maintainers."
- name: "F5 Network & Firewall Architecture Guide"
url: "https://github.com/SalesAmerSP/myf5-cli/blob/main/docs/network_and_firewall.md"
url: "https://github.com/f5devcentral/myf5-cli/blob/main/docs/network_and_firewall.md"
about: "Review required firewall egress and DNS endpoints for MyF5 APIs."
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ By submitting a contribution to this repository, you agree that your contributio

### Clone and Verify
```bash
git clone https://github.com/SalesAmerSP/myf5-cli.git
git clone https://github.com/f5devcentral/myf5-cli.git
cd myf5-cli
make all
```
Expand Down Expand Up @@ -80,6 +80,6 @@ ci(actions): add windows-latest to CI matrix
### Pull Request Checklist
1. Create a feature branch from `main`.
2. Ensure `make all` passes locally (format, vet, lint, test, build).
3. Open a Pull Request against `SalesAmerSP/myf5-cli:main`.
3. Open a Pull Request against `f5devcentral/myf5-cli:main`.
4. Ensure all CI workflow checks pass.
5. Obtain approval from repository code owners (`@grobf5`).
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A high-performance, memory-safe, zero-dependency Go CLI and client library for **MyF5 Cloud APIs**, **Software Downloads**, **iHealth Diagnostics**, **BIG-IP TMOS Appliances**, and **BIG-IQ Centralized Management**.

> [!IMPORTANT]
> **DISCLAIMER:** This project is a community-maintained tool authored and maintained by **Greg Robinson** ([`g.robinson@f5.com`](mailto:g.robinson@f5.com)) and is **NOT** covered by an official F5 Technical Support SLA.
> **DISCLAIMER:** This project is a community-maintained tool authored and maintained by **Greg Robinson** and is **NOT** covered by an official F5 Technical Support SLA.
>
> **API ENTITLEMENT PREREQUISITE:** While this CLI source code is open source, **the MyF5 API itself is not publicly open**. Using MyF5 Cloud API commands (`downloads`, `cases`) requires F5 to enable API support on your customer account and issue account-specific OAuth2 credentials (`F5_CLIENT_ID` and `F5_CLIENT_SECRET`). Direct appliance commands (`bigip`, `bigiq`, `push`, `pull`, `geoip`) and `ihealth` operate independently with your appliance or iHealth credentials.

Expand Down Expand Up @@ -80,12 +80,12 @@ myf5-cli/
## Installation & Building

### Pre-Compiled Binaries
Download pre-built standalone binaries for Linux, macOS, and Windows from the [GitHub Releases page](https://github.com/SalesAmerSP/myf5-cli/releases).
Download pre-built standalone binaries for Linux, macOS, and Windows from the [GitHub Releases page](https://github.com/f5devcentral/myf5-cli/releases).

### Developer Build with GNU Make
```bash
# Clone the repository
git clone https://github.com/SalesAmerSP/myf5-cli.git
git clone https://github.com/f5devcentral/myf5-cli.git
cd myf5-cli

# Build for host OS & architecture
Expand Down
18 changes: 10 additions & 8 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# Security & Vulnerability Policy

**Maintainer:** Greg Robinson (`g.robinson@f5.com`)
**Maintainer:** Greg Robinson
**License:** Apache License 2.0

---

## 1. Vulnerability Reporting & Responsible Disclosure

To protect users of `myf5-cli`, please report security vulnerabilities privately rather than opening public GitHub issues:
To protect users of `myf5-cli`, please report issues and vulnerabilities through the repository:

1. **Do NOT disclose unpatched security vulnerabilities in public GitHub issues or pull requests.**
2. Report security vulnerabilities, memory safety concerns, or credential exposure vectors in `myf5-cli` confidentially via GitHub Security Advisories or directly to:
- **Greg Robinson:** [g.robinson@f5.com](mailto:g.robinson@f5.com)
3. For F5 product or upstream cloud service vulnerabilities, report directly to the F5 Product Security Incident Response Team (F5 SIRT):
- **Email:** [f5sirt@f5.com](mailto:f5sirt@f5.com) or [security@f5.com](mailto:security@f5.com)
- **Security Portal:** [https://www.f5.com/company/policies/security-vulnerability-response-policy](https://www.f5.com/company/policies/security-vulnerability-response-policy)
1. **GitHub Issues:**
- For bugs, operational issues, or feature requests, please submit an issue at: [https://github.com/f5devcentral/myf5-cli/issues](https://github.com/f5devcentral/myf5-cli/issues)
2. **Confidential Vulnerability Reporting:**
- Report security vulnerabilities, memory safety concerns, or credential exposure vectors in `myf5-cli` confidentially via GitHub Security Advisories ([Private Vulnerability Reporting](https://github.com/f5devcentral/myf5-cli/security/advisories/new)).
3. **Upstream F5 Product Vulnerabilities:**
- For official F5 product or upstream cloud service vulnerabilities, report directly to the F5 Product Security Incident Response Team (F5 SIRT):
- **Email:** [f5sirt@f5.com](mailto:f5sirt@f5.com) or [security@f5.com](mailto:security@f5.com)
- **Security Portal:** [https://www.f5.com/company/policies/security-vulnerability-response-policy](https://www.f5.com/company/policies/security-vulnerability-response-policy)

---

Expand Down
4 changes: 2 additions & 2 deletions cmd/myf5/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,8 @@ func printUsage() {

IMPORTANT NOTICE:
This tool is NOT an officially supported F5 product or service.
For issues, bugs, or questions, please email Greg Robinson (g.robinson@f5.com)
or file an issue at https://github.com/SalesAmerSP/myf5-cli/issues.
For issues, bugs, or questions, please file an issue at:
https://github.com/f5devcentral/myf5-cli/issues

USAGE:
myf5 [options] <command> [subcommand] [arguments...]
Expand Down
2 changes: 1 addition & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ In accordance with enterprise DevSecOps standards, **passing credentials or toke
| [`geoip`](#11-myf5-geoip) | Apply GeoIP updates directly to BIG-IP appliances (alias: `bigip geoip`) |
| [`proxy`](#12-myf5-proxy) | View or configure HTTP/HTTPS/SOCKS5 outbound egress proxy |
| [`doctor`](#8-myf5-doctor) | Run connectivity, DNS, egress, and credential diagnostics |
| [`interactive`](#13-myf5-interactive-alias-shell-repl) | Launch interactive REPL shell with tab completion (`shell`, `repl`, `i`) |
| [`interactive`](#13-myf5-interactive-alias-shell-repl-i) | Launch interactive REPL shell with tab completion (`shell`, `repl`, `i`) |
| [`version`](#9-myf5-version) | Display application version and toolchain info |

---
Expand Down
2 changes: 1 addition & 1 deletion docs/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ The environment variable takes precedence. An `api_key` at the top level of the
> A single override applies to whichever client is in use, so setting it will send that key to every family. It is intended for a rotation affecting the API you are calling, not as general configuration.

> [!NOTE]
> These credentials authenticate to the F5 **cloud** APIs — Downloads, Support Cases, and iHealth. They are unrelated to BIG-IP and BIG-IQ appliance credentials, which are covered in [§3](#3-big-ip--big-iq-appliance-credentials) below and are never issued through MyF5.
> These credentials authenticate to the F5 **cloud** APIs — Downloads, Support Cases, and iHealth. They are unrelated to BIG-IP and BIG-IQ appliance credentials, which are covered in [§3](#3-big-ip-big-iq-appliance-credentials) below and are never issued through MyF5.

Verify a new key end to end with:

Expand Down
Loading