From d0bd12930fb7f228b4f9778279e263f75d40fdf7 Mon Sep 17 00:00:00 2001 From: Abel Feng Date: Thu, 7 Dec 2023 10:40:56 +0800 Subject: [PATCH] runc: add copyright and CI scripts Signed-off-by: Abel Feng --- .github/workflows/ci.yml | 4 +- Makefile | 11 +- runc/deny.toml | 274 +++++++++++++++++++++++++++++++++++++++ runc/src/common.rs | 20 +-- runc/src/main.rs | 30 ++++- runc/src/runc.rs | 4 +- runc/src/sandbox.rs | 28 +++- runc/src/task.rs | 18 ++- 8 files changed, 360 insertions(+), 29 deletions(-) create mode 100644 runc/deny.toml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 994a6f0c..e0415e42 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,7 +12,7 @@ jobs: checks: strategy: matrix: - directories: [vmm/sandbox, vmm/task, shim, quark] + directories: [vmm/sandbox, vmm/task, shim, quark, runc] features: [--all-features] include: - directories: wasm @@ -49,7 +49,7 @@ jobs: tests: strategy: matrix: - directories: [vmm/sandbox, vmm/task, shim, quark] + directories: [vmm/sandbox, vmm/task, shim, quark, runc] features: [--all-features] include: - directories: wasm diff --git a/Makefile b/Makefile index f4986d6b..2cdfb123 100644 --- a/Makefile +++ b/Makefile @@ -42,8 +42,13 @@ bin/quark-sandboxer: @cd quark && cargo build --release @mkdir -p bin && cp quark/target/release/quark-sandboxer bin/quark-sandboxer +bin/runc-sandboxer: + @cd runc && cargo build --release + @mkdir -p bin && cp runc/target/release/runc-sandboxer bin/runc-sandboxer + wasm: bin/wasm-sandboxer quark: bin/quark-sandboxer +runc: bin/runc-sandboxer ifeq ($(HYPERVISOR), stratovirt) vmm: bin/vmm-sandboxer bin/kuasar.initrd bin/vmlinux.bin @@ -57,6 +62,7 @@ clean: @cd vmm/task && cargo clean @cd wasm && cargo clean @cd quark && cargo clean + @cd runc && cargo clean install-vmm: @install -d -m 750 ${DEST_DIR}${BIN_DIR} @@ -82,4 +88,7 @@ install-wasm: install-quark: @install -p -m 550 bin/quark-sandboxer ${DEST_DIR}${BIN_DIR}/quark-sandboxer -install: all install-vmm install-wasm install-quark +install-runc: + @install -p -m 550 bin/runc-sandboxer ${DEST_DIR}${BIN_DIR}/runc-sandboxer + +install: all install-vmm install-wasm install-quark install-runc diff --git a/runc/deny.toml b/runc/deny.toml new file mode 100644 index 00000000..1098ed45 --- /dev/null +++ b/runc/deny.toml @@ -0,0 +1,274 @@ +# This template contains all of the possible sections and their default values + +# Note that all fields that take a lint level have these possible values: +# * deny - An error will be produced and the check will fail +# * warn - A warning will be produced, but the check will not fail +# * allow - No warning or error will be produced, though in some cases a note +# will be + +# The values provided in this template are the default values that will be used +# when any section or field is not specified in your own configuration + +# Root options + +# If 1 or more target triples (and optionally, target_features) are specified, +# only the specified targets will be checked when running `cargo deny check`. +# This means, if a particular package is only ever used as a target specific +# dependency, such as, for example, the `nix` crate only being used via the +# `target_family = "unix"` configuration, that only having windows targets in +# this list would mean the nix crate, as well as any of its exclusive +# dependencies not shared by any other crates, would be ignored, as the target +# list here is effectively saying which targets you are building for. +targets = [ + # The triple can be any string, but only the target triples built in to + # rustc (as of 1.40) can be checked against actual config expressions + #{ triple = "x86_64-unknown-linux-musl" }, + # You can also specify which target_features you promise are enabled for a + # particular target. target_features are currently not validated against + # the actual valid features supported by the target architecture. + #{ triple = "wasm32-unknown-unknown", features = ["atomics"] }, +] +# When creating the dependency graph used as the source of truth when checks are +# executed, this field can be used to prune crates from the graph, removing them +# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate +# is pruned from the graph, all of its dependencies will also be pruned unless +# they are connected to another crate in the graph that hasn't been pruned, +# so it should be used with care. The identifiers are [Package ID Specifications] +# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html) +#exclude = [] +# If true, metadata will be collected with `--all-features`. Note that this can't +# be toggled off if true, if you want to conditionally enable `--all-features` it +# is recommended to pass `--all-features` on the cmd line instead +all-features = false +# If true, metadata will be collected with `--no-default-features`. The same +# caveat with `all-features` applies +no-default-features = false +# If set, these feature will be enabled when collecting metadata. If `--features` +# is specified on the cmd line they will take precedence over this option. +#features = [] +# When outputting inclusion graphs in diagnostics that include features, this +# option can be used to specify the depth at which feature edges will be added. +# This option is included since the graphs can be quite large and the addition +# of features from the crate(s) to all of the graph roots can be far too verbose. +# This option can be overridden via `--feature-depth` on the cmd line +feature-depth = 1 + +# This section is considered when running `cargo deny check advisories` +# More documentation for the advisories section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html +[advisories] +# The path where the advisory database is cloned/fetched into +db-path = "~/.cargo/advisory-db" +# The url(s) of the advisory databases to use +db-urls = ["https://github.com/rustsec/advisory-db"] +# The lint level for security vulnerabilities +vulnerability = "warn" +# The lint level for unmaintained crates +unmaintained = "warn" +# The lint level for crates that have been yanked from their source registry +yanked = "warn" +# The lint level for crates with security notices. Note that as of +# 2019-12-17 there are no security notice advisories in +# https://github.com/rustsec/advisory-db +notice = "warn" +# A list of advisory IDs to ignore. Note that ignored advisories will still +# output a note when they are encountered. +ignore = [ + #"RUSTSEC-0000-0000", +] +# Threshold for security vulnerabilities, any vulnerability with a CVSS score +# lower than the range specified will be ignored. Note that ignored advisories +# will still output a note when they are encountered. +# * None - CVSS Score 0.0 +# * Low - CVSS Score 0.1 - 3.9 +# * Medium - CVSS Score 4.0 - 6.9 +# * High - CVSS Score 7.0 - 8.9 +# * Critical - CVSS Score 9.0 - 10.0 +#severity-threshold = + +# If this is true, then cargo deny will use the git executable to fetch advisory database. +# If this is false, then it uses a built-in git library. +# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support. +# See Git Authentication for more information about setting up git authentication. +#git-fetch-with-cli = true + +# This section is considered when running `cargo deny check licenses` +# More documentation for the licenses section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html +[licenses] +# The lint level for crates which do not have a detectable license +unlicensed = "warn" +# List of explicitly allowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +allow = [ + "MIT", + "ISC", + "Unlicense", + "BSD-3-Clause", + "Apache-2.0", + "Apache-2.0 WITH LLVM-exception", + "BSL-1.0", + "Unicode-DFS-2016" +] +# List of explicitly disallowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +deny = [ + #"Nokia", +] +# Lint level for licenses considered copyleft +copyleft = "warn" +# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses +# * both - The license will be approved if it is both OSI-approved *AND* FSF +# * either - The license will be approved if it is either OSI-approved *OR* FSF +# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF +# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved +# * neither - This predicate is ignored and the default lint level is used +allow-osi-fsf-free = "neither" +# Lint level used when no other predicates are matched +# 1. License isn't in the allow or deny lists +# 2. License isn't copyleft +# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither" +default = "deny" +# The confidence threshold for detecting a license from license text. +# The higher the value, the more closely the license text must be to the +# canonical license text of a valid SPDX license file. +# [possible values: any between 0.0 and 1.0]. +confidence-threshold = 0.8 +# Allow 1 or more licenses on a per-crate basis, so that particular licenses +# aren't accepted for every possible crate as with the normal allow list +exceptions = [ + # Each entry is the crate and version constraint, and its specific allow + # list + #{ allow = ["Zlib"], name = "adler32", version = "*" }, +] + +# Some crates don't have (easily) machine readable licensing information, +# adding a clarification entry for it allows you to manually specify the +# licensing information +#[[licenses.clarify]] +# The name of the crate the clarification applies to +#name = "ring" +# The optional version constraint for the crate +#version = "*" +# The SPDX expression for the license requirements of the crate +#expression = "MIT AND ISC AND OpenSSL" +# One or more files in the crate's source used as the "source of truth" for +# the license expression. If the contents match, the clarification will be used +# when running the license check, otherwise the clarification will be ignored +# and the crate will be checked normally, which may produce warnings or errors +# depending on the rest of your configuration +#license-files = [ +# Each entry is a crate relative path, and the (opaque) hash of its contents +#{ path = "LICENSE", hash = 0xbd0eed23 } +#] + +[licenses.private] +# If true, ignores workspace crates that aren't published, or are only +# published to private registries. +# To see how to mark a crate as unpublished (to the official registry), +# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field. +ignore = false +# One or more private registries that you might publish crates to, if a crate +# is only published to private registries, and ignore is true, the crate will +# not have its license(s) checked +registries = [ + #"https://sekretz.com/registry +] + +# This section is considered when running `cargo deny check bans`. +# More documentation about the 'bans' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html +[bans] +# Lint level for when multiple versions of the same crate are detected +multiple-versions = "warn" +# Lint level for when a crate version requirement is `*` +wildcards = "allow" +# The graph highlighting used when creating dotgraphs for crates +# with multiple versions +# * lowest-version - The path to the lowest versioned duplicate is highlighted +# * simplest-path - The path to the version with the fewest edges is highlighted +# * all - Both lowest-version and simplest-path are used +highlight = "all" +# The default lint level for `default` features for crates that are members of +# the workspace that is being checked. This can be overriden by allowing/denying +# `default` on a crate-by-crate basis if desired. +workspace-default-features = "allow" +# The default lint level for `default` features for external crates that are not +# members of the workspace. This can be overriden by allowing/denying `default` +# on a crate-by-crate basis if desired. +external-default-features = "allow" +# List of crates that are allowed. Use with care! +allow = [ + #{ name = "ansi_term", version = "=0.11.0" }, +] +# List of crates to deny +deny = [ + # Each entry the name of a crate and a version range. If version is + # not specified, all versions will be matched. + #{ name = "ansi_term", version = "=0.11.0" }, + # + # Wrapper crates can optionally be specified to allow the crate when it + # is a direct dependency of the otherwise banned crate + #{ name = "ansi_term", version = "=0.11.0", wrappers = [] }, +] + +# List of features to allow/deny +# Each entry the name of a crate and a version range. If version is +# not specified, all versions will be matched. +#[[bans.features]] +#name = "reqwest" +# Features to not allow +#deny = ["json"] +# Features to allow +#allow = [ +# "rustls", +# "__rustls", +# "__tls", +# "hyper-rustls", +# "rustls", +# "rustls-pemfile", +# "rustls-tls-webpki-roots", +# "tokio-rustls", +# "webpki-roots", +#] +# If true, the allowed features must exactly match the enabled feature set. If +# this is set there is no point setting `deny` +#exact = true + +# Certain crates/versions that will be skipped when doing duplicate detection. +skip = [ + #{ name = "ansi_term", version = "=0.11.0" }, +] +# Similarly to `skip` allows you to skip certain crates during duplicate +# detection. Unlike skip, it also includes the entire tree of transitive +# dependencies starting at the specified crate, up to a certain depth, which is +# by default infinite. +skip-tree = [ + #{ name = "ansi_term", version = "=0.11.0", depth = 20 }, +] + +# This section is considered when running `cargo deny check sources`. +# More documentation about the 'sources' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html +[sources] +# Lint level for what to happen when a crate from a crate registry that is not +# in the allow list is encountered +unknown-registry = "warn" +# Lint level for what to happen when a crate from a git repository that is not +# in the allow list is encountered +unknown-git = "warn" +# List of URLs for allowed crate registries. Defaults to the crates.io index +# if not specified. If it is specified but empty, no registries are allowed. +allow-registry = ["https://github.com/rust-lang/crates.io-index"] +# List of URLs for allowed Git repositories +allow-git = [] + +[sources.allow-org] +# 1 or more github.com organizations to allow git sources for +github = [""] +# 1 or more gitlab.com organizations to allow git sources for +gitlab = [""] +# 1 or more bitbucket.org organizations to allow git sources for +bitbucket = [""] diff --git a/runc/src/common.rs b/runc/src/common.rs index e876a895..fa1011f7 100644 --- a/runc/src/common.rs +++ b/runc/src/common.rs @@ -1,17 +1,17 @@ /* - Copyright The containerd Authors. +Copyright 2022 The Kuasar Authors. - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 +http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. */ use std::{io::IoSliceMut, ops::Deref, os::unix::io::RawFd, path::Path, sync::Arc}; diff --git a/runc/src/main.rs b/runc/src/main.rs index d53d5018..60299efa 100644 --- a/runc/src/main.rs +++ b/runc/src/main.rs @@ -1,3 +1,19 @@ +/* +Copyright 2022 The Kuasar Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + use std::ffi::CString; use std::os::fd::RawFd; use std::process::exit; @@ -38,7 +54,7 @@ fn main() { let os_args: Vec<_> = std::env::args_os().collect(); // TODO avoid parse args multiple times let flags = containerd_sandbox::args::parse(&os_args[1..]).unwrap(); - let task_socket = format!("{}/task-{}.sock", flags.dir, Uuid::new_v4().to_string()); + let task_socket = format!("{}/task-{}.sock", flags.dir, Uuid::new_v4()); fork_task_server(&task_socket, &flags.dir).unwrap(); let runtime = tokio::runtime::Runtime::new().unwrap(); runtime.block_on(async move { @@ -66,7 +82,7 @@ fn fork_sandbox_parent() -> Result { close(reqw).unwrap_or_default(); close(respr).unwrap_or_default(); prctl::set_child_subreaper(true).unwrap(); - let comm = format!("[sandbox-parent]"); + let comm = "[sandbox-parent]"; let comm_cstr = CString::new(comm).unwrap(); let addr = comm_cstr.as_ptr(); set_process_comm(addr as u64, comm_cstr.as_bytes_with_nul().len() as u64); @@ -82,8 +98,8 @@ fn fork_sandbox_parent() -> Result { let buffer = read_count(reqr, 512).unwrap(); let id = String::from_utf8_lossy(&buffer[0..64]).to_string(); let mut zero_index = 64; - for i in 64..512 { - if buffer[i] == 0 { + for (i, &b) in buffer.iter().enumerate().take(512).skip(64) { + if b == 0 { zero_index = i; break; } @@ -151,7 +167,7 @@ fn fork_sandbox(id: &str, netns: &str) -> Result { let r = read_count(r, 4)?; resp[..].copy_from_slice(r.as_slice()); let pid = i32::from_le_bytes(resp); - return Ok(pid); + Ok(pid) } ForkResult::Child => { close(r).unwrap_or_default(); @@ -170,7 +186,7 @@ fn fork_sandbox(id: &str, netns: &str) -> Result { set_process_comm(addr as u64, comm_cstr.as_bytes_with_nul().len() as u64); if !netns.is_empty() { let netns_fd = - nix::fcntl::open(&*netns, OFlag::O_CLOEXEC, Mode::empty()).unwrap(); + nix::fcntl::open(netns, OFlag::O_CLOEXEC, Mode::empty()).unwrap(); setns(netns_fd, CloneFlags::CLONE_NEWNET).unwrap(); } loop { @@ -183,7 +199,7 @@ fn fork_sandbox(id: &str, netns: &str) -> Result { } fn set_process_comm(addr: u64, len: u64) { - if let Err(_) = prctl::set_mm(PrctlMM::PR_SET_MM_ARG_START, addr) { + if prctl::set_mm(PrctlMM::PR_SET_MM_ARG_START, addr).is_err() { prctl::set_mm(PrctlMM::PR_SET_MM_ARG_END, addr + len).unwrap(); prctl::set_mm(PrctlMM::PR_SET_MM_ARG_START, addr).unwrap() } else { diff --git a/runc/src/runc.rs b/runc/src/runc.rs index ebdc9d1a..3b55f1fd 100644 --- a/runc/src/runc.rs +++ b/runc/src/runc.rs @@ -219,7 +219,7 @@ impl RuncFactory { if let Some(s) = socket { s.clean().await; } - let runtime_e = runtime_error(e, &*bundle).await; + let runtime_e = runtime_error(e, bundle).await; return Err(runtime_e); } copy_io_or_console(init, socket, pio, init.lifecycle.exit_signal.clone()).await?; @@ -474,7 +474,7 @@ impl ProcessLifecycle for RuncExecLifecycle { } else { // TODO this is kill from nix crate, it is os specific, maybe have annotated with target os kill( - Pid::from_raw(p.pid as i32), + Pid::from_raw(p.pid), nix::sys::signal::Signal::try_from(signal as i32).unwrap(), ) .map_err(Into::into) diff --git a/runc/src/sandbox.rs b/runc/src/sandbox.rs index ba66733c..b4435bb0 100644 --- a/runc/src/sandbox.rs +++ b/runc/src/sandbox.rs @@ -1,3 +1,19 @@ +/* +Copyright 2022 The Kuasar Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + use std::collections::HashMap; use std::io::Write; use std::os::fd::RawFd; @@ -94,11 +110,11 @@ impl Drop for SandboxParent { impl RuncSandboxer { pub async fn new(sandbox_parent: SandboxParent, task_address: &str) -> Result { - return Ok(Self { + Ok(Self { task_address: task_address.to_string(), sandboxes: Default::default(), sandbox_parent: Arc::new(Mutex::new(sandbox_parent)), - }); + }) } pub async fn recover(&self, dir: &str) -> Result<()> { @@ -161,13 +177,13 @@ impl Sandboxer for RuncSandboxer { let mut sandbox_parent = self.sandbox_parent.lock().await; let sandbox_pid = sandbox_parent.fork_sandbox_process(id, &sandbox.data.netns)?; sandbox.prepare_sandbox_ns(sandbox_pid).await.map_err(|e| { - kill(Pid::from_raw(sandbox_pid as i32), Signal::SIGKILL).unwrap_or_default(); + kill(Pid::from_raw(sandbox_pid), Signal::SIGKILL).unwrap_or_default(); e })?; sandbox.data.task_address = self.task_address.clone(); sandbox.dump().await.map_err(|e| { - kill(Pid::from_raw(sandbox_pid as i32), Signal::SIGKILL).unwrap_or_default(); + kill(Pid::from_raw(sandbox_pid), Signal::SIGKILL).unwrap_or_default(); e })?; Ok(()) @@ -290,7 +306,7 @@ impl RuncSandbox { ) .map_err(|e| anyhow!("failed to mount sandbox network ns, {}", e))?; - kill(Pid::from_raw(sandbox_pid as i32), Signal::SIGKILL).unwrap_or_default(); + kill(Pid::from_raw(sandbox_pid), Signal::SIGKILL).unwrap_or_default(); self.status = SandboxStatus::Running(0); } else { self.status = SandboxStatus::Running(sandbox_pid as u32); @@ -315,7 +331,7 @@ impl RuncSandbox { return true; } } - return false; + false } } diff --git a/runc/src/task.rs b/runc/src/task.rs index 85acbc27..7462b6c7 100644 --- a/runc/src/task.rs +++ b/runc/src/task.rs @@ -1,3 +1,19 @@ +/* +Copyright 2022 The Kuasar Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + use std::os::fd::{AsRawFd, RawFd}; use std::os::unix::net::UnixListener; use std::process::exit; @@ -34,7 +50,7 @@ pub fn fork_task_server(task_socket: &str, sandbox_parent_dir: &str) -> Result<( ForkResult::Parent { child: _ } => { close(pipe_r).unwrap_or_default(); drop(task_listener); - return Ok(()); + Ok(()) } ForkResult::Child => { close(pipe_w).unwrap_or_default();