-
Notifications
You must be signed in to change notification settings - Fork 14
implement per-container allowlists specified by Docker container labels #69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
amanda-wee
wants to merge
25
commits into
wollomatic:develop
Choose a base branch
from
amanda-wee:per-container-allowlists
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
implement per-container allowlists specified by Docker container labels #69
amanda-wee
wants to merge
25
commits into
wollomatic:develop
from
amanda-wee:per-container-allowlists
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… container name is provided
Owner
|
Thanks @amanda-wee for this amazing work! I'll try to get the review done as soon as possible. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request implements per-container allowlists that are specified using Docker container labels.
Summary
Backwards Compatibility
To enable per-container allowlists, either the
-proxycontainernameparameter must be passed to the command, or theSP_PROXYCONTAINERNAMEenvironment variable must be set. Otherwise, the functionality is skipped entirely, hence only the default allowlist will be used. If the proxy socket endpoint is provided, then likewise the functionality is skipped. Therefore, socket-proxy can still be used to proxy socket connections that are not for the Docker socket.Security
Container labels can be set when a container is created through the Docker Engine API. This means that if a container has a per-container allowed request regex for POST requests that allows
/containers/create, then an attacker that gains access to the container can perform privilege escalation that would not be possible with the default allowlist (without also being able to create an image). Since the usual use of socket-proxy is for read-only access and container creation access should be relatively rare, this risk should be worth the ease of use of Docker container labels to specify allowlists.Docker Engine API Client
For development, the Docker SDK for Go (as in the low-level Moby) was used for API calls. Once a proof-of-concept was working, the part of the client that ended up being used was then extracted into packages under the
internalfolder so that socket-proxy will not need any external dependencies.This client uses the socket path specified by the
-socketpathparameter or theSP_SOCKETPATHenvironment variable, defaulting to the socket-proxy'sdefaultSocketPath. It also does Docker Engine API version negotiation for maximum compatibility.