1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
use anyhow::anyhow;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use std::collections::{HashMap, HashSet};
cfg_if::cfg_if! {
if #[cfg(feature = "cluster-context")] {
use k8s_openapi::api::apps::v1::{DaemonSet, Deployment, ReplicaSet, StatefulSet};
use k8s_openapi::api::batch::v1::{CronJob, Job};
use k8s_openapi::api::core::v1::{Pod, PodSpec, ReplicationController};
use k8s_openapi::Resource;
}
}
/// ValidationRequest holds the data provided to the policy at evaluation time
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct ValidationRequest<T: Default> {
/// The policy settings
pub settings: T,
/// Kubernetes' [AdmissionReview](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/) request
pub request: KubernetesAdmissionRequest,
}
/// Kubernetes' [AdmissionReview](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/)
/// request.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct KubernetesAdmissionRequest {
/// UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are
/// otherwise identical (parallel requests, requests when earlier requests did not modify etc)
/// The UID is meant to track the round trip (request/response) between the KAS and the WebHook, not the user request.
/// It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.
pub uid: String,
/// Kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)
pub kind: GroupVersionKind,
/// Resource is the fully-qualified resource being requested (for example, v1.pods)
pub resource: GroupVersionResource,
/// SubResource is the subresource being requested, if any (for example, "status" or "scale")
#[serde(alias = "subResource")]
pub sub_resource: String,
/// RequestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale).
/// If this is specified and differs from the value in "kind", an equivalent match and conversion was performed.
///
/// For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
/// `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]` and `matchPolicy: Equivalent`,
/// an API request to apps/v1beta1 deployments would be converted and sent to the webhook
/// with `kind: {group:"apps", version:"v1", kind:"Deployment"}` (matching the rule the webhook registered for),
/// and `requestKind: {group:"apps", version:"v1beta1", kind:"Deployment"}` (indicating the kind of the original API request).
///
/// See documentation for the "matchPolicy" field in the webhook configuration type for more details.
#[serde(alias = "requestKind")]
pub request_kind: GroupVersionKind,
/// RequestResource is the fully-qualified resource of the original API request (for example, v1.pods).
/// If this is specified and differs from the value in "resource", an equivalent match and conversion was performed.
///
/// For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
/// `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]` and `matchPolicy: Equivalent`,
/// an API request to apps/v1beta1 deployments would be converted and sent to the webhook
/// with `resource: {group:"apps", version:"v1", resource:"deployments"}` (matching the resource the webhook registered for),
/// and `requestResource: {group:"apps", version:"v1beta1", resource:"deployments"}` (indicating the resource of the original API request).
///
/// See documentation for the "matchPolicy" field in the webhook configuration type.
#[serde(alias = "requestResource")]
pub request_resource: GroupVersionKind,
/// RequestSubResource is the name of the subresource of the original API request, if any (for example, "status" or "scale")
/// If this is specified and differs from the value in "subResource", an equivalent match and conversion was performed.
/// See documentation for the "matchPolicy" field in the webhook configuration type.
#[serde(alias = "requestSubResource")]
pub request_sub_resource: String,
/// Name is the name of the object as presented in the request. On a CREATE operation, the client may omit name and
/// rely on the server to generate the name. If that is the case, this field will contain an empty string.
pub name: String,
/// Namespace is the namespace associated with the request (if any).
pub namespace: String,
/// Operation is the operation being performed. This may be different than the operation
/// requested. e.g. a patch can result in either a CREATE or UPDATE Operation.
pub operation: String,
/// UserInfo is information about the requesting user
#[serde(alias = "userInfo")]
pub user_info: UserInfo,
/// Object is the object from the incoming request.
pub object: serde_json::Value,
/// OldObject is the existing object. Only populated for DELETE and UPDATE requests.
#[serde(alias = "oldObject")]
pub old_object: serde_json::Value,
/// DryRun indicates that modifications will definitely not be persisted for this request.
/// Defaults to false.
#[serde(alias = "dryRun", default)]
pub dry_run: bool,
/// Options is the operation option structure of the operation being performed.
/// e.g. `meta.k8s.io/v1.DeleteOptions` or `meta.k8s.io/v1.CreateOptions`. This may be
/// different than the options the caller provided. e.g. for a patch request the performed
/// Operation might be a CREATE, in which case the Options will a
/// `meta.k8s.io/v1.CreateOptions` even though the caller provided `meta.k8s.io/v1.PatchOptions`.
pub options: HashMap<String, serde_json::Value>,
}
/// GroupVersionKind unambiguously identifies a kind
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct GroupVersionKind {
pub group: String,
pub version: String,
pub kind: String,
}
/// GroupVersionResource unambiguously identifies a resource
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct GroupVersionResource {
pub group: String,
pub version: String,
pub kind: String,
}
/// UserInfo holds information about the user who made the request
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(default)]
pub struct UserInfo {
/// The name that uniquely identifies this user among all active users.
pub username: String,
/// A unique value that identifies this user across time. If this user is
/// deleted and another user by the same name is added, they will have
/// different UIDs.
pub uid: String,
/// The names of groups this user is a part of.
pub groups: HashSet<String>,
/// Any additional information provided by the authenticator.
pub extra: HashMap<String, serde_json::Value>,
}
impl<T> ValidationRequest<T>
where
T: Default + DeserializeOwned,
{
/// Crates a new `ValidationRequest` starting from the payload provided
/// to the policy at invocation time.
pub fn new(payload: &[u8]) -> anyhow::Result<Self> {
serde_json::from_slice::<ValidationRequest<T>>(payload).map_err(|e| {
anyhow!(
"Error decoding validation payload {}: {:?}",
String::from_utf8_lossy(payload),
e
)
})
}
#[cfg(feature = "cluster-context")]
/// Extract PodSpec from high level objects. This method can be used to evaluate high level objects instead of just Pods.
/// For example, it can be used to reject Deployments or StatefulSets that violate a policy instead of the Pods created by them.
/// Objects supported are: Deployment, ReplicaSet, StatefulSet, DaemonSet, ReplicationController, Job, CronJob, Pod
/// It returns an error if the object is not one of those. If it is a supported object it returns the PodSpec if present, otherwise returns None.
pub fn extract_pod_spec_from_object(&self) -> anyhow::Result<Option<PodSpec>> {
match self.request.kind.kind.as_str() {
Deployment::KIND => {
let deployment = serde_json::from_value::<Deployment>(self.request.object.clone())?;
Ok(deployment.spec.and_then(|spec| spec.template.spec))
},
ReplicaSet::KIND => {
let replicaset = serde_json::from_value::<ReplicaSet>(self.request.object.clone())?;
Ok(replicaset.spec.and_then(|spec| spec.template.and_then(|template| template.spec)))
},
StatefulSet::KIND => {
let statefulset = serde_json::from_value::<StatefulSet>(self.request.object.clone())?;
Ok(statefulset.spec.and_then(|spec| spec.template.spec))
},
DaemonSet::KIND => {
let daemonset = serde_json::from_value::<DaemonSet>(self.request.object.clone())?;
Ok(daemonset.spec.and_then(|spec| spec.template.spec))
},
ReplicationController::KIND => {
let replication_controller = serde_json::from_value::<ReplicationController>(self.request.object.clone())?;
Ok(replication_controller.spec.and_then(|spec| spec.template.and_then(|template| template.spec)))
},
CronJob::KIND => {
let cronjob = serde_json::from_value::<CronJob>(self.request.object.clone())?;
Ok(cronjob.spec.and_then(|spec| spec.job_template.spec.and_then(|spec| spec.template.spec)))
},
Job::KIND => {
let job = serde_json::from_value::<Job>(self.request.object.clone())?;
Ok(job.spec.and_then(|spec| spec.template.spec))
},
Pod::KIND => {
let pod = serde_json::from_value::<Pod>(self.request.object.clone())?;
Ok(pod.spec)
},
_ => {
Err(anyhow!("Object should be one of these kinds: Deployment, ReplicaSet, StatefulSet, DaemonSet, ReplicationController, Job, CronJob, Pod"))
}
}
}
}
#[cfg(test)]
#[cfg(feature = "cluster-context")]
mod tests {
use super::*;
use k8s_openapi::api::apps::v1::{
DaemonSetSpec, DeploymentSpec, ReplicaSetSpec, StatefulSetSpec,
};
use k8s_openapi::api::batch::v1::{CronJobSpec, JobSpec, JobTemplateSpec};
use k8s_openapi::api::core::v1::{ConfigMap, PodTemplateSpec};
use serde::Serialize;
#[test]
fn test_extract_pod_spec_from_deployment() {
let pod_spec = PodSpec {
..Default::default()
};
let deployment = Deployment {
spec: Some(DeploymentSpec {
template: PodTemplateSpec {
spec: Some(pod_spec.clone()),
..Default::default()
},
..Default::default()
}),
..Default::default()
};
let validation_request = create_validation_request(deployment, "Deployment");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
Some(pod_spec)
)
}
#[test]
fn test_extract_pod_spec_from_deployment_without_pod_spec() {
let deployment = Deployment {
spec: Some(DeploymentSpec {
template: PodTemplateSpec {
spec: None,
..Default::default()
},
..Default::default()
}),
..Default::default()
};
let validation_request = create_validation_request(deployment, "Deployment");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
None
)
}
#[test]
fn test_extract_pod_spec_from_deployment_without_deployment_spec() {
let deployment = Deployment {
spec: None,
..Default::default()
};
let validation_request = create_validation_request(deployment, "Deployment");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
None
)
}
#[test]
fn test_extract_pod_spec_from_replicaset() {
let pod_spec = PodSpec {
..Default::default()
};
let replicaset = ReplicaSet {
spec: Some(ReplicaSetSpec {
template: Some(PodTemplateSpec {
spec: Some(pod_spec.clone()),
..Default::default()
}),
..Default::default()
}),
..Default::default()
};
let validation_request = create_validation_request(replicaset, "ReplicaSet");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
Some(pod_spec)
)
}
#[test]
fn test_extract_pod_spec_from_cronjob() {
let pod_spec = PodSpec {
..Default::default()
};
let cronjob = CronJob {
spec: Some(CronJobSpec {
job_template: JobTemplateSpec {
spec: Some(JobSpec {
template: PodTemplateSpec {
spec: Some(pod_spec.clone()),
..Default::default()
},
..Default::default()
}),
..Default::default()
},
..Default::default()
}),
..Default::default()
};
let validation_request = create_validation_request(cronjob, "CronJob");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
Some(pod_spec)
)
}
#[test]
fn test_extract_pod_spec_from_job() {
let pod_spec = PodSpec {
..Default::default()
};
let job = Job {
spec: Some(JobSpec {
template: PodTemplateSpec {
spec: Some(pod_spec.clone()),
..Default::default()
},
..Default::default()
}),
..Default::default()
};
let validation_request = create_validation_request(job, "Job");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
Some(pod_spec)
)
}
#[test]
fn test_extract_pod_spec_from_pod() {
let pod_spec = PodSpec {
..Default::default()
};
let pod = Pod {
spec: Some(pod_spec.clone()),
..Default::default()
};
let validation_request = create_validation_request(pod, "Pod");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
Some(pod_spec)
)
}
#[test]
fn test_extract_pod_spec_from_object_statefulset() {
let pod_spec = PodSpec {
..Default::default()
};
let statefulset = StatefulSet {
spec: Some(StatefulSetSpec {
template: PodTemplateSpec {
spec: Some(pod_spec.clone()),
..Default::default()
},
..Default::default()
}),
..Default::default()
};
let validation_request = create_validation_request(statefulset, "StatefulSet");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
Some(pod_spec)
)
}
#[test]
fn test_extract_pod_spec_from_object_daemonset() {
let pod_spec = PodSpec {
..Default::default()
};
let daemonset = DaemonSet {
spec: Some(DaemonSetSpec {
template: PodTemplateSpec {
spec: Some(pod_spec.clone()),
..Default::default()
},
..Default::default()
}),
..Default::default()
};
let validation_request = create_validation_request(daemonset, "DaemonSet");
assert_eq!(
validation_request.extract_pod_spec_from_object().unwrap(),
Some(pod_spec)
)
}
#[test]
fn test_extract_pod_spec_from_object_not_supported() {
let configmap = ConfigMap {
..Default::default()
};
let validation_request = create_validation_request(configmap, "ConfigMap");
assert!(validation_request.extract_pod_spec_from_object().is_err())
}
#[test]
fn test_extract_pod_spec_from_object_invalid() {
let validation_request = create_validation_request("invalid", "Pod");
assert!(validation_request.extract_pod_spec_from_object().is_err())
}
fn create_validation_request<T: Serialize>(object: T, kind: &str) -> ValidationRequest<()> {
let value = serde_json::to_value(object).unwrap();
ValidationRequest {
settings: (),
request: KubernetesAdmissionRequest {
kind: GroupVersionKind {
kind: kind.to_string(),
..Default::default()
},
object: value,
..Default::default()
},
}
}
}