Security is built into myf5 at the architectural level. This document details credential storage, profile management, environment variable resolution, and the defense-in-depth zero-secret security guarantees.
Flags that accept passwords or client secrets (--password, -pw, --client-secret) are strictly forbidden in myf5. The short flag -p is not among them — it sets the port on appliance commands.
- Process Table Inspection: On multi-user Unix/Linux jump hosts and bastion servers, command-line arguments are globally visible to all unprivileged users via
/proc/$PID/cmdlineand commands likeps auxortop. - Persistent Shell Histories: Commands entered on the terminal are written in plaintext to
~/.bash_historyand~/.zsh_history. - Host Auditing & EDR Logs: System telemetry daemons (such as
auditd, Sysmon for Linux, and Falco) log command-line invocations, creating plaintext secret exposures in centralized logging pipelines.
In myf5, any command containing --password or --client-secret is aborted by auth.CheckNoCLISecrets before flag evaluation begins:
[SECURITY ERROR] Passing credentials via CLI arguments (--password, --client-secret) is prohibited.
Store secrets in ~/.f5api_credentials or export F5_CLIENT_ID / F5_CLIENT_SECRET.
Before any of the storage options below will work, you need an API key — a client_id and client_secret pair — issued from your MyF5 account. Access is not enabled by default; it is granted per account on request.
- Log in to MyF5. Sign in at my.f5.com with the account associated with your organization's F5 entitlements.
- Request access to the API Catalog. Raise a request with F5 Support asking for API Catalog access on your account. This is an entitlement grant rather than a self-service toggle, so it is not instantaneous — expect it to be handled on support's normal turnaround.
- Create an API key. Once support confirms the grant, the API Catalog becomes available in MyF5. Create a key there; it is issued as a
client_idandclient_secretpair.
The client_secret is shown once at creation. Copy it straight into ~/.f5api_credentials or your CI secret store — if it is lost, generate a new key rather than attempting to recover the old one.
iHealth does not use your MyF5 client credentials. It is a distinct OAuth resource server (api://ciam-api-ihealth), and a MyF5 client holds no grant on it — using one produces:
403 Client "..." is not authorized to access resource server "api://ciam-api-myf5".
Per F5 article K000130498, generate a dedicated pair at ihealth.f5.com/qkview-analyzer/settings → API Token → Generate New Credentials.
Important
Key lifecycle considerations:
- Generating new credentials invalidates the previous pair immediately.
- The client secret is shown once and never again.
- The pair expires after six months, after which you must regenerate.
Store them prefixed, alongside your MyF5 pair in the same file:
client_id = your_myf5_client_id
client_secret = your_myf5_client_secret
ihealth_client_id = your_ihealth_client_id
ihealth_client_secret = your_ihealth_client_secretOr by environment variable:
export IHEALTH_CLIENT_ID="..."
export IHEALTH_CLIENT_SECRET="..."myf5 selects the prefixed pair for ihealth commands and the unprefixed pair for everything else, falling back to the unprefixed pair when no iHealth-specific one is present. It also sends the correct audience automatically — note that an iHealth token request carries no scope parameter; access comes from the audience alone. Bearer tokens last 30 minutes and are re-requested as needed.
Endpoints on support.apis.f5.com require a k query parameter — an "API usage key" — alongside the OAuth bearer token. F5's published OpenAPI specification marks it required on every such operation.
You do not normally need to configure this. Despite the name, it is not a per-user secret — the value is published in F5's specification, and myf5 includes the working default key automatically.
Note
Downloads does not use a k key. api.software.downloads.f5.com authenticates exclusively via the OAuth2 Bearer token; the k query parameter applies only to support.apis.f5.com.
If you need to diagnose a k rejection, note that the API is rate limited — test with single requests spaced out rather than tight loops, as rate-limited responses can resemble key errors.
Should F5 rotate a key or issue a tenant-specific one, override it:
export F5_API_KEY="your_api_usage_key"[default]
client_id = your_oauth2_client_id
client_secret = your_oauth2_client_secret
api_key = your_api_usage_keyThe environment variable takes precedence. An api_key at the top level of the file applies to every profile; one inside a profile section overrides it.
Note
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 below and are never issued through MyF5.
Verify a new key end to end with:
myf5 doctormyf5 supports INI-style credential profiles in ~/.f5api_credentials:
[default]
client_id = your_oauth2_client_id
client_secret = your_oauth2_client_secret
[production]
client_id = prod_oauth2_client_id
client_secret = prod_oauth2_client_secret
[lab]
client_id = lab_oauth2_client_id
client_secret = lab_oauth2_client_secret- Recommended file permission:
0600(-rw-------). myf5permits0640and0644with a security warning if the file is world-readable (perm & 0004 != 0).- World-writable files (
perm & 0002 != 0) are strictly rejected to prevent unauthorized credential tampering.
chmod 600 ~/.f5api_credentialsSelect an alternative profile with the --profile flag:
myf5 downloads families --profile productionFor automated pipelines (e.g., GitHub Actions, GitLab CI, Kubernetes jobs), provide credentials via environment variables:
export F5_CLIENT_ID="your_oauth2_client_id"
export F5_CLIENT_SECRET="your_oauth2_client_secret"When set, environment variables take precedence over profile files.
myf5 supports both modern F5 CIAM token issuing infrastructures:
- Auth0 (Primary):
https://idp.identity.f5.com/oauth/token(standard client credentials grant). - Okta CIAM (Dedicated Server):
https://identity.account.f5.com/oauth2/ausp95yxb4ShxMGvW357/v1/tokenwith audienceapi://ciam-api-myf5and scopemyf5_scope.
When managing BIG-IP TMOS or BIG-IQ Centralized Management appliances via myf5 bigip, myf5 bigiq, myf5 push, or post-download push flags (--push):
-
Username Resolution:
- Command flag:
-u,--user <username>or--push-user <username>. - Environment variable:
$BIGIQ_USER(for BIG-IQ) or$BIGIP_USER(for BIG-IP and fallback). - Default:
"admin".
- Command flag:
-
Password Resolution:
- Environment variables:
- BIG-IQ:
$BIGIQ_PASSWORD(falls back to$BIGIP_PASSWORD). - BIG-IP:
$BIGIP_PASSWORD.
- BIG-IQ:
- Interactive Masked Terminal Prompt:
If no password environment variable is set and an interactive terminal (TTY) is detected,
myf5securely prompts for the appliance password with terminal echo suppressed viagolang.org/x/term:In non-interactive environments (cron, headless CI/CD), if the password is not provided via environment variables or SSH keys,Enter BIG-IP password for admin@10.1.1.4:myf5halts execution with exit code1rather than hanging. - F5 K2873 Character Policy & Shell Quoting:
Appliance passwords follow the F5 K2873 specification: alphanumeric characters and all 32 allowed special characters (
!,@,#,$,%,^,&,*,(,),`,~,-,+,=,[,],{,},;,’,:,",',.,/,<,>,|,\,?,_) are supported. Whitespace and control characters are prohibited. When exporting passwords containing shell-active special characters (such as!,$,`,\, or") inbashorzsh, wrap the value in single quotes to prevent shell expansion:export BIGIP_PASSWORD='MyP@ssw0rd!$`123'
- Environment variables:
-
SSH Key & Agent Authentication (SCP Method): When using native Go SCP transfers (
--method scpor--push-method scp):- Explicit Private Key: Specify
-i/--identity <path>(appliancepush/download) or--push-key <path>(download-then-push), both supporting encrypted keys with passphrase. Note that--keyis not a valid flag: it appears inForbiddenSecretFlags, so passing it aborts the command before any work is done. - SSH Agent: Connects automatically to
$SSH_AUTH_SOCKif active. - Default Key Fallback: Inspects standard user keys (
~/.ssh/id_ed25519,~/.ssh/id_rsa,~/.ssh/id_ecdsa). - Password / PAM Fallback: Uses password or interactive prompt if no keys are found.
- Explicit Private Key: Specify
Important
TMOS User Shell Requirements for SCP: On BIG-IP TMOS, the admin user is configured with tmsh shell by default (Terminal Access: tmsh), which restricts SCP operations to whitelisted directories (/var/tmp/). To transfer files directly to /shared/images/ or system directories via SCP, either authenticate as root (which defaults to bash), grant the user Advanced Shell (bash) terminal access (tmsh modify auth user <username> shell bash), or utilize --method icontrol which operates independent of the user's interactive shell.
- Stringer Redaction: Go structs containing tokens or client secrets implement custom
fmt.Stringerandfmt.GoStringerinterfaces that redact sensitive strings to prevent leaks in stack traces or logs. - Crash Dump Protection: Error messages never format raw credential values into returned error strings.
- Memory Scrubbing: Sensitive byte slices allocated during masked password entry are zeroed out after use.