Docker Swarm Unlock Key

ID

docker_swarm_unlock_key

Severity

low

Vendor

Docker

Family

API Token

Description

Docker swarm is a container orchestration tool, meaning that it allows the user to manage multiple containers deployed across multiple host machines that have been configured to join together in a cluster. The activities of the cluster are controlled by a swarm manager, and machines that have joined the cluster are referred to as nodes.

Swarms can be configured to lock themselves after Manager Docker daemons have been restarted. Unlocking them requires an unlock-key.

Security

Any hardcoded Docker Swarm Unlock Key is a potential secret reported by this detector.

Accidentally checking-in the key to source control repositories could compromise the Docker Swarm cluster.

Examples

docker swarm unlock -key -1
  SWMKEY-1-zsZ7UH37F4myuZwDB5dIW0LrG3KmsFsh2XKYXAZeyTR

Mitigation / Fix

  1. Remove the Key from the source code or committed configuration file.

  2. Follow your policy for handling leaked secrets, which typically require revoking the secret in the target system(s). The unlock key can be rotated with docker swarm unlock-key --rotate

  3. If under a git repository, you may remove unwanted files from the repository history using tools like git filter-repo or BFG Repo-Cleaner. You may follow the procedure listed here for GitHub.

You should consider any sensitive data in commits with secrets as compromised.

Remember that secrets may be removed from history in your projects, but not in other users' cloned or forked repositories.

Reference

https://docs.docker.com/engine/reference/commandline/swarm_unlock-key/