Skip to content

Commit 7299ddb

Browse files
committed
fix(providers): harden token grant handling
1 parent 743dfa9 commit 7299ddb

17 files changed

Lines changed: 809 additions & 49 deletions

File tree

‎Cargo.lock‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎architecture/sandbox.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ override template values so sandbox images cannot spoof identity, callback, or
7171
relay settings.
7272

7373
Supervisor bootstrap identity is not inherited by agent child processes. When
74-
provider token grants mount a SPIFFE Workload API socket, children also enter a
75-
private mount namespace where the socket directory is hidden before privilege
76-
drop.
74+
provider token grants mount a SPIFFE Workload API socket, the socket path must
75+
live under a dedicated directory. Children also enter a private mount namespace
76+
where that socket directory is hidden before privilege drop.
7777

7878
Credential placeholders in proxied HTTP requests can be resolved by the proxy
7979
when policy allows the target endpoint. Secrets must not be logged in OCSF or

‎crates/openshell-driver-kubernetes/src/config.rs‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
use openshell_core::config::DEFAULT_SUPERVISOR_IMAGE;
55
use serde::{Deserialize, Deserializer, Serialize};
6+
use std::path::Path;
67
use std::str::FromStr;
78

89
/// Default Kubernetes namespace for sandbox resources.
@@ -143,6 +144,18 @@ where
143144
}
144145
}
145146

147+
fn deserialize_provider_spiffe_workload_api_socket_path<'de, D>(
148+
deserializer: D,
149+
) -> Result<String, D::Error>
150+
where
151+
D: Deserializer<'de>,
152+
{
153+
let value = String::deserialize(deserializer)?;
154+
validate_provider_spiffe_workload_api_socket_path_value(&value)
155+
.map_err(serde::de::Error::custom)?;
156+
Ok(value)
157+
}
158+
146159
#[derive(Debug, Clone, Serialize, Deserialize)]
147160
#[serde(default, deny_unknown_fields)]
148161
pub struct KubernetesComputeConfig {
@@ -193,6 +206,10 @@ pub struct KubernetesComputeConfig {
193206
/// SPIFFE Workload API socket path mounted into sandbox pods for dynamic
194207
/// provider token grants. Empty disables provider token-grant SPIFFE
195208
/// material.
209+
#[serde(
210+
default,
211+
deserialize_with = "deserialize_provider_spiffe_workload_api_socket_path"
212+
)]
196213
pub provider_spiffe_workload_api_socket_path: String,
197214
}
198215

@@ -254,6 +271,44 @@ impl KubernetesComputeConfig {
254271
.trim()
255272
.is_empty()
256273
}
274+
275+
pub fn validate_provider_spiffe_workload_api_socket_path(&self) -> Result<(), String> {
276+
validate_provider_spiffe_workload_api_socket_path_value(
277+
&self.provider_spiffe_workload_api_socket_path,
278+
)
279+
}
280+
}
281+
282+
fn validate_provider_spiffe_workload_api_socket_path_value(
283+
socket_path: &str,
284+
) -> Result<(), String> {
285+
let trimmed = socket_path.trim();
286+
if trimmed.is_empty() {
287+
return Ok(());
288+
}
289+
if trimmed != socket_path {
290+
return Err(
291+
"provider_spiffe_workload_api_socket_path must not contain leading or trailing whitespace"
292+
.to_string(),
293+
);
294+
}
295+
let path = Path::new(socket_path);
296+
if !path.is_absolute() {
297+
return Err(
298+
"provider_spiffe_workload_api_socket_path must be an absolute UNIX socket path"
299+
.to_string(),
300+
);
301+
}
302+
let parent = path.parent().ok_or_else(|| {
303+
"provider_spiffe_workload_api_socket_path must include a parent directory".to_string()
304+
})?;
305+
if parent == Path::new("/") {
306+
return Err(
307+
"provider_spiffe_workload_api_socket_path must live below a dedicated directory"
308+
.to_string(),
309+
);
310+
}
311+
Ok(())
257312
}
258313

259314
#[cfg(test)]
@@ -358,6 +413,35 @@ mod tests {
358413
assert_eq!(cfg.app_armor_profile, None);
359414
}
360415

416+
#[test]
417+
fn serde_accepts_absolute_provider_spiffe_socket_path() {
418+
let json = serde_json::json!({
419+
"provider_spiffe_workload_api_socket_path": "/spiffe-workload-api/spire-agent.sock"
420+
});
421+
let cfg: KubernetesComputeConfig = serde_json::from_value(json).unwrap();
422+
cfg.validate_provider_spiffe_workload_api_socket_path()
423+
.unwrap();
424+
}
425+
426+
#[test]
427+
fn serde_rejects_invalid_provider_spiffe_socket_path() {
428+
for socket_path in [
429+
"spiffe-workload-api/spire-agent.sock",
430+
"/spire-agent.sock",
431+
" /spiffe-workload-api/spire-agent.sock",
432+
] {
433+
let json = serde_json::json!({
434+
"provider_spiffe_workload_api_socket_path": socket_path
435+
});
436+
let err = serde_json::from_value::<KubernetesComputeConfig>(json).unwrap_err();
437+
assert!(
438+
err.to_string()
439+
.contains("provider_spiffe_workload_api_socket_path"),
440+
"unexpected error for {socket_path}: {err}"
441+
);
442+
}
443+
}
444+
361445
#[test]
362446
fn serde_rejects_invalid_app_armor_profile() {
363447
let json = serde_json::json!({

‎crates/openshell-driver-kubernetes/src/driver.rs‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -175,25 +175,30 @@ impl std::fmt::Debug for KubernetesComputeDriver {
175175
}
176176

177177
impl KubernetesComputeDriver {
178-
pub async fn new(config: KubernetesComputeConfig) -> Result<Self, KubeError> {
178+
pub async fn new(config: KubernetesComputeConfig) -> Result<Self, KubernetesDriverError> {
179+
config
180+
.validate_provider_spiffe_workload_api_socket_path()
181+
.map_err(KubernetesDriverError::Precondition)?;
179182
let base_config = match kube::Config::incluster() {
180183
Ok(c) => c,
181184
Err(_) => kube::Config::infer()
182185
.await
183-
.map_err(kube::Error::InferConfig)?,
186+
.map_err(kube::Error::InferConfig)
187+
.map_err(KubernetesDriverError::from_kube)?,
184188
};
185189

186190
let mut kube_config = base_config.clone();
187191
kube_config.connect_timeout = Some(Duration::from_secs(10));
188192
kube_config.read_timeout = Some(Duration::from_secs(30));
189193
kube_config.write_timeout = Some(Duration::from_secs(30));
190-
let client = Client::try_from(kube_config)?;
194+
let client = Client::try_from(kube_config).map_err(KubernetesDriverError::from_kube)?;
191195

192196
let mut watch_kube_config = base_config;
193197
watch_kube_config.connect_timeout = Some(Duration::from_secs(10));
194198
watch_kube_config.read_timeout = None;
195199
watch_kube_config.write_timeout = Some(Duration::from_secs(30));
196-
let watch_client = Client::try_from(watch_kube_config)?;
200+
let watch_client =
201+
Client::try_from(watch_kube_config).map_err(KubernetesDriverError::from_kube)?;
197202

198203
Ok(Self {
199204
client,
@@ -1767,8 +1772,8 @@ fn spiffe_socket_mount_path(socket_path: &str) -> String {
17671772
std::path::Path::new(socket_path)
17681773
.parent()
17691774
.and_then(std::path::Path::to_str)
1770-
.filter(|path| !path.is_empty())
1771-
.unwrap_or("/spiffe-workload-api")
1775+
.filter(|path| !path.is_empty() && *path != "/")
1776+
.expect("provider SPIFFE socket path should be validated before pod rendering")
17721777
.to_string()
17731778
}
17741779

‎crates/openshell-providers/Cargo.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ license.workspace = true
1111
repository.workspace = true
1212

1313
[dependencies]
14+
glob = { workspace = true }
1415
openshell-core = { path = "../openshell-core" }
1516
serde = { workspace = true }
1617
serde_json = { workspace = true }

0 commit comments

Comments
 (0)