The Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Find a file
Sebastiaan van Stijn 1eadbf1bd0
DebugRequestMiddleware: unconditionally scrub data field
Commit 77b8465d7e added a secret update
endpoint to allow updating labels on existing secrets. However, when
implementing the endpoint, the DebugRequestMiddleware was not updated
to scrub the Data field (as is being done when creating a secret).

When updating a secret (to set labels), the Data field should be either
`nil` (not set), or contain the same value as the existing secret. In
situations where the Data field is set, and the `dockerd` daemon is
running with debugging enabled / log-level debug, the base64-encoded
value of the secret is printed to the daemon logs.

The docker cli does not have a `docker secret update` command, but
when using `docker stack deploy`, the docker cli sends the secret
data both when _creating_ a stack, and when _updating_ a stack, thus
leaking the secret data if the daemon runs with debug enabled:

1. Start the daemon in debug-mode

        dockerd --debug

2. Initialize swarm

        docker swarm init

3. Create a file containing a secret

        echo secret > my_secret.txt

4. Create a docker-compose file using that secret

        cat > docker-compose.yml <<'EOF'
        version: "3.3"
        services:
          web:
            image: nginx:alpine
            secrets:
              - my_secret
        secrets:
          my_secret:
            file: ./my_secret.txt
        EOF

5. Deploy the stack

        docker stack deploy -c docker-compose.yml test

6. Verify that the secret is scrubbed in the daemon logs

        DEBU[2019-07-01T22:36:08.170617400Z] Calling POST /v1.30/secrets/create
        DEBU[2019-07-01T22:36:08.171364900Z] form data: {"Data":"*****","Labels":{"com.docker.stack.namespace":"test"},"Name":"test_my_secret"}

7. Re-deploy the stack to trigger an "update"

        docker stack deploy -c docker-compose.yml test

8. Notice that this time, the Data field is not scrubbed, and the base64-encoded secret is logged

        DEBU[2019-07-01T22:37:35.828819400Z] Calling POST /v1.30/secrets/w3hgvwpzl8yooq5ctnyp71v52/update?version=34
        DEBU[2019-07-01T22:37:35.829993700Z] form data: {"Data":"c2VjcmV0Cg==","Labels":{"com.docker.stack.namespace":"test"},"Name":"test_my_secret"}

This patch modifies `maskSecretKeys` to unconditionally scrub `Data` fields.
Currently, only the `secrets` and `configs` endpoints use a field with this
name, and no other POST API endpoints use a data field, so scrubbing this
field unconditionally will only scrub requests for those endpoints.

If a new endpoint is added in future where this field should not be scrubbed,
we can re-introduce more fine-grained (path-specific) handling.

This patch introduces some change in behavior:

- In addition to secrets, requests to create or update _configs_ will
  now have their `Data` field scrubbed. Generally, the actual data should
  not be interesting for debugging, so likely will not be problematic.
  In addition, scrubbing this data for configs may actually be desirable,
  because (even though they are not explicitely designed for this purpose)
  configs may contain sensitive data (credentials inside a configuration
  file, e.g.).
- Requests that send key/value pairs as a "map" and that contain a
  key named "data", will see the value of that field scrubbed. This
  means that (e.g.) setting a `label` named `data` on a config, will
  scrub/mask the value of that label.
- Note that this is already the case for any label named `jointoken`,
  `password`, `secret`, `signingcakey`, or `unlockkey`.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit c7ce4be93ae8edd2da62a588e01c67313a4aba0c)
Signed-off-by: Tibor Vass <tibor@docker.com>
(cherry picked from commit 73db8c77bf)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-07-17 17:33:27 +02:00
.github Remove myself from codeowners 😅 2019-01-10 17:32:26 +01:00
api DebugRequestMiddleware: unconditionally scrub data field 2019-07-17 17:33:27 +02:00
builder vendor: update buildkit to 37d53758 2019-06-04 11:17:10 +02:00
cli allow running dockerd in an unprivileged user namespace (rootless mode) 2019-02-04 00:24:27 +09:00
client client: do not fallback to GET if HEAD on _ping fail to connect 2019-05-13 15:17:51 -07:00
cmd/dockerd Remove v1 manifest code 2019-06-18 18:54:59 +00:00
container Entropy cannot be saved 2019-06-11 17:40:09 +02:00
contrib dockerd-rootless.sh: use exec 2019-05-16 22:06:01 +09:00
daemon Add test for keeping same daemon ID on upgrade 2019-06-18 18:55:00 +00:00
distribution Add deprecation message for schema1 2019-06-18 18:55:02 +00:00
dockerversion Remove version-checks for containerd and runc 2018-10-04 23:17:13 +02:00
docs fix: fix lack of copyUIDGID in swagger.yaml 2019-06-07 14:40:21 +02:00
errdefs errdefs: remove "ErrAlreadyExists" because it's not an error 2019-03-21 21:25:15 +00:00
hack validate: temporarily disable deprecate-integration-cli as part of a revert 2019-06-18 18:55:04 +00:00
image Merge pull request #38888 from quasilyte/fix_copying 2019-03-21 01:48:27 +01:00
integration For ipvlan tests check that the ipvlan module is enabled (instead of just ensuring the kernel version is greater than 4.2) 2019-06-25 00:40:32 +02:00
integration-cli Revert "Remove the rest of v1 manifest support" 2019-06-18 18:54:57 +00:00
internal Remove v1 manifest code 2019-06-18 18:54:59 +00:00
layer layer: protect from same-name races 2019-05-25 22:33:45 +02:00
libcontainerd Remove inmemory container map 2019-04-05 15:48:07 -04:00
oci Capabilities refactor 2019-01-22 21:50:41 +02:00
opts dockerd: fix rootless detection (alternative to #39024) 2019-05-13 15:31:31 -07:00
pkg pkg/archive: keep walkRoot clean if source is / 2019-06-14 04:02:08 +00:00
plugin Entropy cannot be saved 2019-06-11 17:40:09 +02:00
profiles seccomp: whitelist io_pgetevents() 2019-03-18 20:46:16 +02:00
project Add support for setting GOARM in cross target. 2019-04-17 13:19:14 -07:00
reference Merge pull request #37781 from mtrmac/reference-race-upstream 2018-10-18 12:35:57 -07:00
registry Remove v1 manifest code 2019-06-18 18:54:59 +00:00
reports Fix typos 2018-05-16 09:15:43 +08:00
restartmanager Add canonical import comment 2018-02-05 16:51:57 -05:00
rootless dockerd: fix rootless detection (alternative to #39024) 2019-05-13 15:31:31 -07:00
runconfig Format code with gofmt -s from go-1.11beta1 2018-09-06 15:24:16 -07:00
vendor Merge pull request #260 from thaJeztah/19.03_backport_buildkit_systemd_resolvconf 2019-06-04 11:44:18 -07:00
volume Entropy cannot be saved 2019-06-11 17:40:09 +02:00
.DEREK.yml Update Derek behaviour 2019-02-28 11:20:18 +00:00
.dockerignore [EXPERIMENTAL] Integration Test on Swarm 2017-02-28 02:10:09 +00:00
.gitignore Add code coverage report and codecov config 2018-01-16 16:50:56 -05:00
.mailmap Update AUTHORS and .mailmap 2019-04-17 13:22:59 +02:00
AUTHORS Update AUTHORS and .mailmap 2019-04-17 13:22:59 +02:00
CHANGELOG.md Fix some typos 2018-09-07 13:13:47 +08:00
codecov.yml Add code coverage report and codecov config 2018-01-16 16:50:56 -05:00
CONTRIBUTING.md Fix link anchors in CONTRIBUTING.md 2018-06-13 21:58:48 +09:00
Dockerfile Revert "Remove Schema1 integration test suite" 2019-06-18 18:54:45 +00:00
Dockerfile.e2e Bump Golang 1.12.5 2019-05-13 15:37:07 -07:00
Dockerfile.simple Bump Golang 1.12.5 2019-05-13 15:37:07 -07:00
Dockerfile.windows Bump Golang 1.12.5 2019-05-13 15:37:07 -07:00
Jenkinsfile Add Jenkinsfile 2019-02-26 20:03:29 +00:00
LICENSE Update LICENSE 2018-09-12 14:27:53 +01:00
MAINTAINERS MAINTAINERS: update Akihiro Suda's email address 2019-04-17 18:26:21 +09:00
Makefile Fix DOCKER_CROSS being overwritten 2019-04-15 18:37:56 +02:00
NOTICE Update LICENSE date 2017-02-15 17:34:33 +01:00
poule.yml Poule:Add Windows RS5 2018-10-08 15:38:27 -07:00
README.md Add "Lego set" back in README.md 2017-10-10 14:10:39 +00:00
ROADMAP.md Fix some typos in ROADMAP.md 2019-01-25 14:27:13 +08:00
TESTING.md Merge pull request #37249 from AntaresS/add-test-guidline 2018-06-25 20:44:42 +02:00
vendor.conf Merge pull request #260 from thaJeztah/19.03_backport_buildkit_systemd_resolvconf 2019-06-04 11:44:18 -07:00
VENDORING.md fix the bare url and the Summary of http://semver.org 2017-01-17 16:20:11 +08:00

The Moby Project

Moby Project logo

Moby is an open-source project created by Docker to enable and accelerate software containerization.

It provides a "Lego set" of toolkit components, the framework for assembling them into custom container-based systems, and a place for all container enthusiasts and professionals to experiment and exchange ideas. Components include container build tools, a container registry, orchestration tools, a runtime and more, and these can be used as building blocks in conjunction with other tools and projects.

Principles

Moby is an open project guided by strong principles, aiming to be modular, flexible and without too strong an opinion on user experience. It is open to the community to help set its direction.

  • Modular: the project includes lots of components that have well-defined functions and APIs that work together.
  • Batteries included but swappable: Moby includes enough components to build fully featured container system, but its modular architecture ensures that most of the components can be swapped by different implementations.
  • Usable security: Moby provides secure defaults without compromising usability.
  • Developer focused: The APIs are intended to be functional and useful to build powerful tools. They are not necessarily intended as end user tools but as components aimed at developers. Documentation and UX is aimed at developers not end users.

Audience

The Moby Project is intended for engineers, integrators and enthusiasts looking to modify, hack, fix, experiment, invent and build systems based on containers. It is not for people looking for a commercially supported system, but for people who want to work and learn with open source code.

Relationship with Docker

The components and tools in the Moby Project are initially the open source components that Docker and the community have built for the Docker Project. New projects can be added if they fit with the community goals. Docker is committed to using Moby as the upstream for the Docker Product. However, other projects are also encouraged to use Moby as an upstream, and to reuse the components in diverse ways, and all these uses will be treated in the same way. External maintainers and contributors are welcomed.

The Moby project is not intended as a location for support or feature requests for Docker products, but as a place for contributors to work on open source code, fix bugs, and make the code more useful. The releases are supported by the maintainers, community and users, on a best efforts basis only, and are not intended for customers who want enterprise or commercial support; Docker EE is the appropriate product for these use cases.


Legal

Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.

Use and transfer of Moby may be subject to certain restrictions by the United States and other governments.

It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see https://www.bis.doc.gov

Licensing

Moby is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.