nixos/oci-containers: document firewall bypass

Add explanation about the security impact of the
ports option.
Provide a safer example.

The problem is discussed in greater depth here:
https://github.com/NixOS/nixpkgs/issues/111852
This commit is contained in:
Jakob Klepp 2024-07-18 14:29:06 +02:00
parent 9def6d0121
commit c5c92feff7
No known key found for this signature in database
GPG key ID: 5B3D75E720D55016

View file

@ -148,12 +148,17 @@ let
somewhere within the specified `hostPort` range.
Example: `1234-1236:1234/tcp`
Publishing a port bypasses the NixOS firewall. If the port is not
supposed to be shared on the network, make sure to publish the
port to localhost.
Example: `127.0.0.1:1234:1234`
Refer to the
[Docker engine documentation](https://docs.docker.com/engine/reference/run/#expose-incoming-ports) for full details.
'';
example = literalExpression ''
[
"8080:9000"
"127.0.0.1:8080:9000"
]
'';
};