Skip to main content

Capabilities

A capability is something a plugin's code may do. List what you need in capabilities in manifest.json. People see this list before they install your plugin, worst first. The SDK method that needs a capability throws if the manifest does not list it.

Capabilities are not user permissions. A capability says what the plugin's code can reach. A permission says which users can use a feature.

Critical​

CapabilityShown asWhat it means
credentials:readSee your passwords and keysIt can read the stored secret for any host you can reach.
system:tlsManage certificatesIt can replace the certificate Termix serves over HTTPS and answer domain checks from certificate authorities.

High​

CapabilityShown asWhat it means
ssh:connectRun commands on your serversAny command, on hosts you connect it to, with your access.
process:spawnRun programs on this machinePrograms run on the Termix server itself, not on your hosts.
users:writeCreate and change user accountsIt can add users and change their roles.
users:impersonateAct as other usersRuns background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
db:core-refsRead core account tablesCan query users, roles and hosts directly from the database.
auth:provideHandle sign inIt can add a login method, a second factor or an SSH sign-in type.
auth:policySet sign in rulesIt can sign people out when idle, limit session length, turn off remember me and require a second factor.
sync:provideRun syncIt can answer all sync requests, so it sees the data that devices and servers sync.
ssh:transportChoose how hosts are reachedIt can carry the SSH connection to a host over its own route, so it sees everything sent to and from those hosts, passwords included.
device:serialAccess serial and USB devicesIt can open a physical serial port on the machine running Termix.
config:secretsRead secrets the server holdsEnvironment variables and files on the server, except Termix's own keys.
network:socketsOpen its own network connectionsIt can listen on ports and connect to any address directly, without Termix checking each connection.
notify:hubReceive every alertStores and delivers the alerts all plugins send, including their contents.
operations:invokeRun other plugins' actionsActs for the signed-in user on the actions its manifest lists. Approval rules still apply.
operations:approveDecide what needs approvalCan let actions run with no approval, or block them, for every user.
ui:layoutReplace the whole app layoutWhen chosen, its code draws every screen, including your terminals and settings.
hosts:exportExport hosts with their secretsCan read your hosts in full, including saved passwords and keys, and hand them out. Every export is written to the audit log.
hosts:connect-policyDecide who can connectCan block or allow every SSH and remote desktop connection to any host.
desktop:localUse this computerCan read and change files, run a shell and open local ports on this computer. Only in the Termix desktop app.

Medium​

CapabilityShown asWhat it means
hosts:writeCreate and change hostsIt can add hosts and edit the ones you already have.
credentials:useConnect to your serversIt cannot see your passwords or keys.
credentials:writeSave new credentialsIt can add passwords and keys to your saved credentials.
network:outboundReach the internetIt can send requests to outside services.
network:serveAccept connectionsIt opens a port on the Termix server.
network:broadcastSend network broadcastsIt can send packets to devices on the local network, such as a Wake-on-LAN signal.
network:probeCheck if ports answerCan open a plain connection to any address from the server, to see if it is reachable, and look up host names.
hosts:status-provideProvide host statusBecomes the source of the online and offline dots for every host.
hosts:activity-provideStore recent activityBecomes the store for the recent activity list of every user.
hosts:lockManage hosts as read onlyHosts it manages can't be edited, deleted or reshared by anyone else.
users:readSee usernames and rolesNever password hashes, never two factor state.
events:coreWatch everything happeningIncluding activity from other users, not just yours.
notify:sendSend alertsTo you or other users, and through the channels they set up.
operations:provideOffer actionsIts actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
audit:readRead the audit logIt can see who did what and when.
desktop:windowOpen desktop windowsOnly in the Termix desktop app.

Low​

CapabilityShown asWhat it means
hosts:readSee your host listNames and addresses for hosts you can already see.
db:ownStore its own dataKept in its own tables, separate from other plugins.
kv:ownRemember small settingsKept separate from other plugins.
files:ownStore its own filesIn its own folder on disk, separate from other plugins.
secrets:ownStore its own secretsEncrypted by Termix. The plugin never holds the key.
settings:read-coreRead Termix settingsServer settings, not your hosts or credentials.
plugins:readSee installed pluginsIt can see which plugins are installed and running.
ui:surfaceAdd its own screensTabs, panels and settings you can hide later.
ui:themeAdd color themesOnly colors and styles. No code runs for a theme.