syncable-cli 0.37.1

A Rust-based CLI that analyzes code repositories and generates Infrastructure as Code configurations
Documentation
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
//! RBAC-related check templates.

use crate::analyzer::kubelint::context::K8sObject;
use crate::analyzer::kubelint::context::Object;
use crate::analyzer::kubelint::templates::{CheckFunc, ParameterDesc, Template, TemplateError};
use crate::analyzer::kubelint::types::{Diagnostic, ObjectKindsDesc};

/// Template for detecting cluster-admin role bindings.
pub struct ClusterAdminRoleBindingTemplate;

impl Template for ClusterAdminRoleBindingTemplate {
    fn key(&self) -> &str {
        "cluster-admin-role-binding"
    }

    fn human_name(&self) -> &str {
        "Cluster Admin Role Binding"
    }

    fn description(&self) -> &str {
        "Detects bindings to the cluster-admin ClusterRole"
    }

    fn supported_object_kinds(&self) -> ObjectKindsDesc {
        ObjectKindsDesc::new(&["ClusterRoleBinding", "RoleBinding"])
    }

    fn parameters(&self) -> Vec<ParameterDesc> {
        Vec::new()
    }

    fn instantiate(
        &self,
        _params: &serde_yaml::Value,
    ) -> Result<Box<dyn CheckFunc>, TemplateError> {
        Ok(Box::new(ClusterAdminRoleBindingCheck))
    }
}

struct ClusterAdminRoleBindingCheck;

impl CheckFunc for ClusterAdminRoleBindingCheck {
    fn check(&self, object: &Object) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        let role_ref = match &object.k8s_object {
            K8sObject::ClusterRoleBinding(crb) => Some(&crb.role_ref),
            K8sObject::RoleBinding(rb) => Some(&rb.role_ref),
            _ => None,
        };

        if let Some(role_ref) = role_ref
            && role_ref.kind == "ClusterRole"
            && role_ref.name == "cluster-admin"
        {
            diagnostics.push(Diagnostic {
                message: "Binding grants cluster-admin privileges".to_string(),
                remediation: Some(
                    "Avoid binding to cluster-admin. Create a more restrictive ClusterRole \
                         with only the required permissions."
                        .to_string(),
                ),
            });
        }

        diagnostics
    }
}

/// Template for detecting wildcard rules in RBAC.
pub struct WildcardInRulesTemplate;

impl Template for WildcardInRulesTemplate {
    fn key(&self) -> &str {
        "wildcard-in-rules"
    }

    fn human_name(&self) -> &str {
        "Wildcard in RBAC Rules"
    }

    fn description(&self) -> &str {
        "Detects use of wildcards (*) in RBAC rules"
    }

    fn supported_object_kinds(&self) -> ObjectKindsDesc {
        ObjectKindsDesc::new(&["Role", "ClusterRole"])
    }

    fn parameters(&self) -> Vec<ParameterDesc> {
        Vec::new()
    }

    fn instantiate(
        &self,
        _params: &serde_yaml::Value,
    ) -> Result<Box<dyn CheckFunc>, TemplateError> {
        Ok(Box::new(WildcardInRulesCheck))
    }
}

struct WildcardInRulesCheck;

impl CheckFunc for WildcardInRulesCheck {
    fn check(&self, object: &Object) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        let rules = match &object.k8s_object {
            K8sObject::Role(r) => Some(&r.rules),
            K8sObject::ClusterRole(cr) => Some(&cr.rules),
            _ => None,
        };

        if let Some(rules) = rules {
            for rule in rules {
                // Check for wildcard in verbs
                if rule.verbs.iter().any(|v| v == "*") {
                    diagnostics.push(Diagnostic {
                        message: "Rule uses wildcard (*) in verbs".to_string(),
                        remediation: Some(
                            "Explicitly list the required verbs instead of using wildcard."
                                .to_string(),
                        ),
                    });
                }

                // Check for wildcard in resources
                if rule.resources.iter().any(|r| r == "*") {
                    diagnostics.push(Diagnostic {
                        message: "Rule uses wildcard (*) in resources".to_string(),
                        remediation: Some(
                            "Explicitly list the required resources instead of using wildcard."
                                .to_string(),
                        ),
                    });
                }

                // Check for wildcard in apiGroups
                if rule.api_groups.iter().any(|g| g == "*") {
                    diagnostics.push(Diagnostic {
                        message: "Rule uses wildcard (*) in apiGroups".to_string(),
                        remediation: Some(
                            "Explicitly list the required API groups instead of using wildcard."
                                .to_string(),
                        ),
                    });
                }
            }
        }

        diagnostics
    }
}

/// Template for detecting access to secrets.
pub struct AccessToSecretsTemplate;

impl Template for AccessToSecretsTemplate {
    fn key(&self) -> &str {
        "access-to-secrets"
    }

    fn human_name(&self) -> &str {
        "Access to Secrets"
    }

    fn description(&self) -> &str {
        "Detects RBAC rules that grant access to secrets"
    }

    fn supported_object_kinds(&self) -> ObjectKindsDesc {
        ObjectKindsDesc::new(&["Role", "ClusterRole"])
    }

    fn parameters(&self) -> Vec<ParameterDesc> {
        Vec::new()
    }

    fn instantiate(
        &self,
        _params: &serde_yaml::Value,
    ) -> Result<Box<dyn CheckFunc>, TemplateError> {
        Ok(Box::new(AccessToSecretsCheck))
    }
}

struct AccessToSecretsCheck;

impl CheckFunc for AccessToSecretsCheck {
    fn check(&self, object: &Object) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        let rules = match &object.k8s_object {
            K8sObject::Role(r) => Some(&r.rules),
            K8sObject::ClusterRole(cr) => Some(&cr.rules),
            _ => None,
        };

        if let Some(rules) = rules {
            for rule in rules {
                // Check if rule grants access to secrets
                let grants_secret_access =
                    rule.resources.iter().any(|r| r == "secrets" || r == "*")
                        && rule
                            .api_groups
                            .iter()
                            .any(|g| g.is_empty() || g == "*" || g == "core");

                if grants_secret_access {
                    // Check for sensitive verbs
                    let sensitive_verbs = ["get", "list", "watch", "*"];
                    if rule
                        .verbs
                        .iter()
                        .any(|v| sensitive_verbs.contains(&v.as_str()))
                    {
                        diagnostics.push(Diagnostic {
                            message: "Rule grants read access to secrets".to_string(),
                            remediation: Some(
                                "Avoid granting broad access to secrets. Consider using \
                                 resourceNames to limit access to specific secrets."
                                    .to_string(),
                            ),
                        });
                    }
                }
            }
        }

        diagnostics
    }
}

/// Template for detecting access to create pods.
pub struct AccessToCreatePodsTemplate;

impl Template for AccessToCreatePodsTemplate {
    fn key(&self) -> &str {
        "access-to-create-pods"
    }

    fn human_name(&self) -> &str {
        "Access to Create Pods"
    }

    fn description(&self) -> &str {
        "Detects RBAC rules that grant permission to create pods"
    }

    fn supported_object_kinds(&self) -> ObjectKindsDesc {
        ObjectKindsDesc::new(&["Role", "ClusterRole"])
    }

    fn parameters(&self) -> Vec<ParameterDesc> {
        Vec::new()
    }

    fn instantiate(
        &self,
        _params: &serde_yaml::Value,
    ) -> Result<Box<dyn CheckFunc>, TemplateError> {
        Ok(Box::new(AccessToCreatePodsCheck))
    }
}

struct AccessToCreatePodsCheck;

impl CheckFunc for AccessToCreatePodsCheck {
    fn check(&self, object: &Object) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        let rules = match &object.k8s_object {
            K8sObject::Role(r) => Some(&r.rules),
            K8sObject::ClusterRole(cr) => Some(&cr.rules),
            _ => None,
        };

        if let Some(rules) = rules {
            for rule in rules {
                // Check if rule grants create access to pods
                let grants_pod_create = rule.resources.iter().any(|r| r == "pods" || r == "*")
                    && rule
                        .api_groups
                        .iter()
                        .any(|g| g.is_empty() || g == "*" || g == "core")
                    && rule.verbs.iter().any(|v| v == "create" || v == "*");

                if grants_pod_create {
                    diagnostics.push(Diagnostic {
                        message: "Rule grants permission to create pods".to_string(),
                        remediation: Some(
                            "Pod creation permission can be used for privilege escalation. \
                             Ensure this is intentional and the scope is limited."
                                .to_string(),
                        ),
                    });
                }
            }
        }

        diagnostics
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::analyzer::kubelint::parser::yaml::parse_yaml;

    #[test]
    fn test_cluster_admin_binding_detected() {
        let yaml = r#"
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: admin-binding
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: cluster-admin
subjects:
- kind: User
  name: admin
"#;
        let objects = parse_yaml(yaml).unwrap();
        let check = ClusterAdminRoleBindingCheck;
        let diagnostics = check.check(&objects[0]);
        assert_eq!(diagnostics.len(), 1);
        assert!(diagnostics[0].message.contains("cluster-admin"));
    }

    #[test]
    fn test_non_admin_binding_ok() {
        let yaml = r#"
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: viewer-binding
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: view
subjects:
- kind: User
  name: viewer
"#;
        let objects = parse_yaml(yaml).unwrap();
        let check = ClusterAdminRoleBindingCheck;
        let diagnostics = check.check(&objects[0]);
        assert!(diagnostics.is_empty());
    }

    #[test]
    fn test_wildcard_verbs_detected() {
        let yaml = r#"
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: wildcard-role
rules:
- apiGroups: [""]
  resources: ["pods"]
  verbs: ["*"]
"#;
        let objects = parse_yaml(yaml).unwrap();
        let check = WildcardInRulesCheck;
        let diagnostics = check.check(&objects[0]);
        assert_eq!(diagnostics.len(), 1);
        assert!(diagnostics[0].message.contains("verbs"));
    }

    #[test]
    fn test_access_to_secrets_detected() {
        let yaml = r#"
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: secret-reader
rules:
- apiGroups: [""]
  resources: ["secrets"]
  verbs: ["get", "list"]
"#;
        let objects = parse_yaml(yaml).unwrap();
        let check = AccessToSecretsCheck;
        let diagnostics = check.check(&objects[0]);
        assert_eq!(diagnostics.len(), 1);
        assert!(diagnostics[0].message.contains("secrets"));
    }

    #[test]
    fn test_pod_create_detected() {
        let yaml = r#"
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: pod-creator
  namespace: default
rules:
- apiGroups: [""]
  resources: ["pods"]
  verbs: ["create"]
"#;
        let objects = parse_yaml(yaml).unwrap();
        let check = AccessToCreatePodsCheck;
        let diagnostics = check.check(&objects[0]);
        assert_eq!(diagnostics.len(), 1);
        assert!(diagnostics[0].message.contains("create pods"));
    }
}