Guide

TACACS+ AAA

Ze authenticates SSH logins against TACACS+ servers (RFC 8907) when the system.authentication.tacacs block is present. Local bcrypt users keep working as the fallback so an unreachable server cannot lock you out of the device.

What it does

Function Status Notes
Authentication Production PAP (login over the SSH password callback). RFC 8907 §5.
Accounting Production START + STOP records around every dispatched CLI command.
Authorization Production authorization true switches per-command authorization on. By default the bridge falls back to local profiles on TACACS+ ERROR; strict-fallback true denies instead.

Minimal config

system {
    authentication {
        tacacs {
            server 10.0.0.1 { port 49; key "$9$encrypted-key"; }
            server 10.0.0.2 { port 49; key "$9$encrypted-key"; }
            timeout 5
        }
        tacacs-profile 15 { profile [ admin ]; }
        tacacs-profile 1  { profile [ read-only ]; }
    }
    authorization {
        profile admin     { run { default-action allow; } edit { default-action allow; } }
        profile read-only { run { default-action allow; } edit { default-action deny;  } }
    }
}
Leaf Type Default Notes
tacacs.server <ip> list, ordered-by-user - Tried in declaration order on connection failure
tacacs.server <ip>.port uint16 49 TCP
tacacs.server <ip>.key string (ze:sensitive) required Shared secret, stored as $9$ ciphertext
tacacs.timeout uint16 (1-300) 5 Per-server connection timeout in seconds
tacacs.source-address ip-address none Local source IP for outbound TACACS+ TCP
tacacs.authorization boolean false Enable per-command TACACS+ authorization
tacacs.strict-fallback boolean false Deny authorization when TACACS+ is unavailable instead of falling back to local RBAC
tacacs.accounting boolean false Enable START/STOP accounting records
tacacs-profile <N>.profile leaf-list required Maps priv-lvl N (0-15) to one or more local authz profiles

Authentication flow

  1. SSH client connects with username + password.
  2. Daemon's AAA chain calls TacacsAuthenticator first (priority 100; local bcrypt is priority 200).
  3. The client opens TCP to the first configured server and sends a PAP AUTHEN START. The body is XOR-encrypted with the MD5 pseudo-pad keyed on the shared secret.
  4. PASS -- the server's reply data byte is the priv-lvl. The authenticator looks up tacacs-profile <priv-lvl>.profile. A matching entry yields the authz profiles attached to the SSH session. An unmapped priv-lvl rejects the login (AC-18) so adding new TACACS+ levels in the upstream server does not accidentally grant access.
  5. FAIL -- explicit rejection. The chain stops here. Local bcrypt is NOT tried. This prevents a wrong password against TACACS+ from succeeding via a stale local hash.
  6. Connection error / ERROR status -- the next server in the list is tried. When every server is unreachable (or all return ERROR) the chain falls through to the local bcrypt authenticator.

Privilege level mapping

TACACS+ servers send a numeric priv-lvl (0-15) in the AUTHEN REPLY. Ze's internal authorization model is name-based, so each priv-lvl must be mapped to one or more locally-defined system.authorization.profile entries.

priv-lvl Common convention Example mapping
15 full administrator profile [ admin ]
5 site operator profile [ operator ]
1 read-only / NOC profile [ read-only ]
0 minimal access rarely used; map only if the upstream server returns it
2-14 site-defined only map the levels your TACACS+ server actually returns

Levels not present in tacacs-profile, and levels mapped to an empty profile list, reject the login. Look for TACACS+ unmapped privilege level in the daemon log when extending the upstream config. A TACACS+ user therefore always reaches authorization with at least one resolved profile, or does not authenticate at all: there is no path where an authenticated TACACS+ user has no profile.

Even so, authorization fails closed at the second layer: if a session ever reaches authorization resolving no applicable profile, every command is denied rather than allowed. A priv-level whose mapping names only profiles you have not defined resolves nothing and is denied, not granted admin. Local break-glass accounts (the ze init bootstrap admin, or any system.authentication.user you keep) are the way back into a box whose mapping is wrong.

What the mapped profiles govern

The mapped profiles decide every command the session may run after login succeeds. Ze resolves them once at authentication and authorizes each command against them, so tacacs-profile 1 { profile [ read-only ]; } gives that session exactly what the local read-only profile allows and refuses the rest with command restricted by access control.

Only the profile names are fixed at login. Each command is evaluated against the profile as it is defined at that moment, so editing read-only and committing applies to sessions already open, without a reconnect.

A local system.authentication.user block with the same username takes precedence over the mapped profiles: an explicit local assignment is a stated intent for that name, so it is not widened or narrowed by how the user logged in.

Verify the mapping with a command the profile denies, not with one Ze does not have. A command that does not exist reports unknown command and exits non-zero for everyone, so it passes whatever the mapping says and proves nothing.

Setting authorization true moves the per-command decision to the TACACS+ server itself: Ze sends an AUTHOR REQUEST per command, and the profiles above apply only as the fallback when the server is unreachable, unless strict-fallback true makes that case deny.

Accounting

When accounting true is set, every command dispatched through the CLI emits two records:

Flag When Args
START (0x02) Just after authorization passes, before the handler runs task_id, service=shell, cmd=<input>, start_time
STOP (0x04) After the handler returns, regardless of outcome task_id, service=shell, cmd=<input>, stop_time

Records are queued to a single long-lived background worker. The worker sends one record at a time over the same TACACS+ client used for authentication, with the same server failover. Accounting failures are logged (TACACS+ accounting failed) and never block the command. Records that cannot be queued increment the local drop counter.

Use ze show aaa accounting to inspect the counter:

ze show aaa accounting

The response includes dropped-records. A non-zero value means at least one START/STOP record was lost locally before the TACACS+ client could send it.

Verification

The .ci tests in test/plugin/ cover the main behaviours:

Test Asserts
tacacs-auth.ci TACACS+ PASS + priv-lvl 15 -> admin profile, no local fallback consulted
tacacs-author.ci TACACS+ command authorization PASS/FAIL with local fallback
tacacs-fallback.ci Server unreachable -> local bcrypt accepted, log shows source=local
tacacs-local-only.ci
tacacs-readonly.ci Read-only profile restricts write commands
tacacs-acct.ci accounting true -> mock receives ACCT START followed by STOP
tacacs-singleconnect.ci Single-connect mode TCP reuse
tacacs-show.ci ze tacacs show offline config display

Strict fallback is covered by TestExtractConfigStrictFallback and TestTacacsAuthorizerStrictFallbackDeniesUnreachable in the TACACS+ unit tests.

For ad-hoc verification, point the daemon at a real TACACS+ server and run any command via ze cli -c "show bgp summary" -- the daemon log tags the satisfying backend on every login, e.g.:

INFO SSH auth success subsystem=ssh username=alice remote=10.0.0.1:51408 source=tacacs

source=tacacs confirms the chain consulted TACACS+ and returned PASS. source=local means TACACS+ was unreachable (or unconfigured) and the local bcrypt user accepted the credentials.

Operational notes

RFC reference