Skip to content

Commit 87f2861

Browse files
committed
config: Make capabilities and noNewPrivileges Linux-only (again)
Roll back the genericization from 718f9f3 (minor narrative cleanup regarding config compatibility, 2017-01-30, #673). Lifting the restriction there seems to have been motivated by "Solaris supports capabilities", but that was before the split into a capabilities object which happened in eb114f0 (Add ambient and bounding capability support, 2017-02-02, #675). It's not clear if Solaris supports ambient caps, or what Solaris API noNewPrivileges were punting to [1]. And John Howard has recently confirmed that Windows does not support capabilities and is unlikely to do so in the future [2]. He also confirmed that Windows does not support rlimits [3]. John's statement didn't directly address noNewPrivileges, but we can always restore any of these properties to the Solaris/Windows platforms if/when we get docs about which API we're punting to on those platforms. Also add some backticks, remove the hyphens in "OPTIONAL) - the", standardize lines I touch to use "the process" [4], and use four-space indents here to keep Pandoc happy (see 7795661 (runtime.md: Fix sub-bullet indentation, 2016-06-08, #495). [1]: #673 (comment) [2]: #810 (comment) [3]: #835 (comment) [4]: #809 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 3036273 commit 87f2861

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

config.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,6 @@ For Solaris, the mount entry corresponds to the 'fs' resource in the [zonecfg(1M
130130
* **`env`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001's `environ`][ieee-1003.1-2001-xbd-c8.1].
131131
* **`args`** (array of strings, REQUIRED) with similar semantics to [IEEE Std 1003.1-2001 `execvp`'s *argv*][ieee-1003.1-2001-xsh-exec].
132132
This specification extends the IEEE standard in that at least one entry is REQUIRED, and that entry is used with the same semantics as `execvp`'s *file*.
133-
* **`capabilities`** (object, OPTIONAL) is an object containing arrays that specifies the sets of capabilities for the process(es) inside the container. Valid values are platform-specific. For example, valid values for Linux are defined in the [capabilities(7)][capabilities.7] man page, such as `CAP_CHOWN`. Any value which cannot be mapped to a relevant kernel interface MUST cause an error.
134-
capabilities contains the following properties:
135-
* **`effective`** (array of strings, OPTIONAL) - the `effective` field is an array of effective capabilities that are kept for the process.
136-
* **`bounding`** (array of strings, OPTIONAL) - the `bounding` field is an array of bounding capabilities that are kept for the process.
137-
* **`inheritable`** (array of strings, OPTIONAL) - the `inheritable` field is an array of inheritable capabilities that are kept for the process.
138-
* **`permitted`** (array of strings, OPTIONAL) - the `permitted` field is an array of permitted capabilities that are kept for the process.
139-
* **`ambient`** (array of strings, OPTIONAL) - the `ambient` field is an array of ambient capabilities that are kept for the process.
140133
* **`rlimits`** (array of objects, OPTIONAL) allows setting resource limits for a process inside the container.
141134
Each entry has the following structure:
142135

@@ -146,13 +139,23 @@ For Solaris, the mount entry corresponds to the 'fs' resource in the [zonecfg(1M
146139

147140
If `rlimits` contains duplicated entries with same `type`, the runtime MUST error out.
148141

149-
* **`noNewPrivileges`** (bool, OPTIONAL) setting `noNewPrivileges` to true prevents the processes in the container from gaining additional privileges.
150-
As an example, the ['no_new_privs'][no-new-privs] article in the kernel documentation has information on how this is achieved using a prctl system call on Linux.
151142

152143
For Linux-based systems the process structure supports the following process-specific fields.
153144

154145
* **`apparmorProfile`** (string, OPTIONAL) specifies the name of the AppArmor profile to be applied to processes in the container.
155146
For more information about AppArmor, see [AppArmor documentation][apparmor].
147+
* **`capabilities`** (object, OPTIONAL) is an object containing arrays that specifies the sets of capabilities for the process.
148+
Valid values are defined in the [capabilities(7)][capabilities.7] man page, such as `CAP_CHOWN`.
149+
Any value which cannot be mapped to a relevant kernel interface MUST cause an error.
150+
`capabilities` contains the following properties:
151+
152+
* **`effective`** (array of strings, OPTIONAL) the `effective` field is an array of effective capabilities that are kept for the process.
153+
* **`bounding`** (array of strings, OPTIONAL) the `bounding` field is an array of bounding capabilities that are kept for the process.
154+
* **`inheritable`** (array of strings, OPTIONAL) the `inheritable` field is an array of inheritable capabilities that are kept for the process.
155+
* **`permitted`** (array of strings, OPTIONAL) the `permitted` field is an array of permitted capabilities that are kept for the process.
156+
* **`ambient`** (array of strings, OPTIONAL) the `ambient` field is an array of ambient capabilities that are kept for the process.
157+
* **`noNewPrivileges`** (bool, OPTIONAL) setting `noNewPrivileges` to true prevents the process from gaining additional privileges.
158+
As an example, the [`no_new_privs`][no-new-privs] article in the kernel documentation has information on how this is achieved using a `prctl` system call on Linux.
156159
* **`oomScoreAdj`** *(int, OPTIONAL)* adjusts the oom-killer score in `[pid]/oom_score_adj` for the container process's `[pid]` in a [proc pseudo-filesystem][procfs].
157160
If `oomScoreAdj` is set, the runtime MUST set `oom_score_adj` to the given value.
158161
If `oomScoreAdj` is not set, the runtime MUST NOT change the value of `oom_score_adj`.

0 commit comments

Comments
 (0)