├── Dockerfile ├── LICENSE ├── README.md ├── action.yml └── entrypoint.sh /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM sysdig/kube-psp-advisor:1.7.0 2 | ADD ./entrypoint.sh /entrypoint.sh 3 | RUN chmod u+x /entrypoint.sh 4 | ENTRYPOINT ["/entrypoint.sh"] 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kubernetes Security Config Watch 2 | 3 | This Git Action run security lint check against Kubernetes workloads in Git workflow (PR open, commit pushed etc.). 4 | 5 | ## Inputs 6 | 7 | ### `sourceDir` 8 | 9 | **Required** The source directory for k8s workload yaml. (master branch) 10 | 11 | ### `targetDir` 12 | 13 | **Required** The target directory for k8s workload yaml. (PR branch) 14 | 15 | ## Use Cases 16 | 0. Integrate the `k8s-security-lint` action into the git workflow. 17 | 1. Examine the following security attributes changes in k8s workload YAMLs in a PR: 18 | - `Privileged` 19 | - `HostPID` 20 | - `HostIPC` 21 | - `HostNetwork` 22 | - `Capabilities` 23 | - `ReadOnlyRootFileSystem` 24 | - `RunAsUser` (root/nonroot) 25 | - `RunAsGroup` (root/nonroot) 26 | - volume types 27 | 2. Define your own criteria based on the lint result, for example: 28 | - Send lint report to slack channel if `privileged` mode is set to true 29 | - Fail the check on the PR if some host level namespaces are enabled. (`hostNetwork` etc.) 30 | - Assign extra reviewers (security architect/engineer) to the PR. 31 | 32 | ## Example Usage in Git workflow 33 | ``` 34 | # checkout master branch 35 | - uses: actions/checkout@v2 36 | with: 37 | ref: master 38 | path: master 39 | # checkout PR branch 40 | - uses: actions/checkout@v2 41 | with: 42 | path: candidate 43 | ref: ${{ github.event.pull_request.head.sha }} 44 | # pass the yamls directory to k8s-privilege-check git action 45 | - name: Kubernetes Security Lint 46 | uses: sysdiglabs/k8s-security-lint@v1.0.0 47 | with: 48 | sourceDir: '/master/yamls' 49 | targetDir: '/candidate/yamls' 50 | # evaluate escalation report 51 | - name: Post Privilege Check 52 | run: | 53 | echo ${{ toJSON(steps.k8s_privilege_check.outputs.escalation_report) }} 54 | # slack 55 | # or other git action like adding another reviewer 56 | ``` 57 | 58 | 59 | ## Outputs 60 | 61 | ### `escalation_report` 62 | ``` 63 | { 64 | "total_source_workloads": 2, 65 | "total_target_workloads": 2, 66 | "total_source_images": 2, 67 | "total_target_images": 2, 68 | "escalation_count": 2, 69 | "reduction_count": 1, 70 | "escalations": [ 71 | { 72 | "name": "nginx", 73 | "kind": "Pod", 74 | "namespace": "default", 75 | "file": "nginx.yaml" 76 | }, 77 | { 78 | "name": "my-busybox", 79 | "kind": "Pod", 80 | "namespace": "psp-test", 81 | "file": "busy-box.yaml" 82 | } 83 | ], 84 | "reductions": [ 85 | { 86 | "name": "my-busybox", 87 | "kind": "Pod", 88 | "namespace": "psp-test", 89 | "file": "busy-box.yaml" 90 | } 91 | ], 92 | "new_privileged": { 93 | "status": "Escalated", 94 | "previous": "false", 95 | "current": "true", 96 | "workloads": [ 97 | { 98 | "name": "nginx", 99 | "kind": "Pod", 100 | "namespace": "default", 101 | "file": "nginx.yaml", 102 | "image": "kaizheh/nginx" 103 | } 104 | ], 105 | "workloads_count": 1 106 | }, 107 | "removed_privileged": { 108 | "status": "Reduced", 109 | "previous": "true", 110 | "current": "false", 111 | "workloads": [ 112 | { 113 | "name": "my-busybox", 114 | "kind": "Pod", 115 | "namespace": "psp-test", 116 | "file": "busy-box.yaml", 117 | "image": "busybox" 118 | } 119 | ], 120 | "workloads_count": 1 121 | }, 122 | "new_hostIPC": { 123 | "status": "Escalated", 124 | "previous": "false", 125 | "current": "true", 126 | "workloads": [ 127 | { 128 | "name": "my-busybox", 129 | "kind": "Pod", 130 | "namespace": "psp-test", 131 | "file": "busy-box.yaml" 132 | }, 133 | { 134 | "name": "nginx", 135 | "kind": "Pod", 136 | "namespace": "default", 137 | "file": "nginx.yaml" 138 | } 139 | ], 140 | "workloads_count": 2 141 | }, 142 | "removed_hostIPC": { 143 | "status": "Reduced", 144 | "previous": "true", 145 | "current": "false", 146 | "workloads": [], 147 | "workloads_count": 0 148 | }, 149 | "new_hostNetwork": { 150 | "status": "Escalated", 151 | "previous": "false", 152 | "current": "true", 153 | "workloads": [ 154 | { 155 | "name": "nginx", 156 | "kind": "Pod", 157 | "namespace": "default", 158 | "file": "nginx.yaml" 159 | } 160 | ], 161 | "workloads_count": 1 162 | }, 163 | "removed_hostNetwork": { 164 | "status": "Reduced", 165 | "previous": "true", 166 | "current": "false", 167 | "workloads": [ 168 | { 169 | "name": "my-busybox", 170 | "kind": "Pod", 171 | "namespace": "psp-test", 172 | "file": "busy-box.yaml" 173 | } 174 | ], 175 | "workloads_count": 1 176 | }, 177 | "new_hostPID": { 178 | "status": "Escalated", 179 | "previous": "false", 180 | "current": "true", 181 | "workloads": [ 182 | { 183 | "name": "nginx", 184 | "kind": "Pod", 185 | "namespace": "default", 186 | "file": "nginx.yaml" 187 | } 188 | ], 189 | "workloads_count": 1 190 | }, 191 | "removed_hostPID": { 192 | "status": "Reduced", 193 | "previous": "true", 194 | "current": "false", 195 | "workloads": [ 196 | { 197 | "name": "my-busybox", 198 | "kind": "Pod", 199 | "namespace": "psp-test", 200 | "file": "busy-box.yaml" 201 | } 202 | ], 203 | "workloads_count": 1 204 | }, 205 | "new_volume_types": { 206 | "hostPath": { 207 | "status": "Escalated", 208 | "previous": "", 209 | "current": "hostPath", 210 | "workloads": [ 211 | { 212 | "name": "nginx", 213 | "kind": "Pod", 214 | "namespace": "default", 215 | "file": "nginx.yaml" 216 | } 217 | ], 218 | "workloads_count": 1 219 | } 220 | }, 221 | "removed_volume_types": {}, 222 | "new_capabilities": {}, 223 | "reduced_capabilities": { 224 | "SYS_ADMIN": { 225 | "status": "Reduced", 226 | "previous": "SYS_ADMIN", 227 | "current": "", 228 | "workloads": [ 229 | { 230 | "name": "my-busybox", 231 | "kind": "Pod", 232 | "namespace": "psp-test", 233 | "file": "busy-box.yaml", 234 | "image": "busybox" 235 | } 236 | ], 237 | "workloads_count": 1 238 | }, 239 | "SYS_CHROOT": { 240 | "status": "Reduced", 241 | "previous": "SYS_CHROOT", 242 | "current": "", 243 | "workloads": [ 244 | { 245 | "name": "my-busybox", 246 | "kind": "Pod", 247 | "namespace": "psp-test", 248 | "file": "busy-box.yaml", 249 | "image": "busybox" 250 | } 251 | ], 252 | "workloads_count": 1 253 | } 254 | }, 255 | "new_run_user_as_root": { 256 | "status": "Escalated", 257 | "previous": "non-root", 258 | "current": "root", 259 | "workloads": [ 260 | { 261 | "name": "nginx", 262 | "kind": "Pod", 263 | "namespace": "default", 264 | "file": "nginx.yaml", 265 | "image": "kaizheh/nginx" 266 | } 267 | ], 268 | "workloads_count": 1 269 | }, 270 | "removed_run_user_as_root": { 271 | "status": "Reduced", 272 | "previous": "root", 273 | "current": "non-root", 274 | "workloads": [], 275 | "workloads_count": 0 276 | }, 277 | "new_run_group_as_root": { 278 | "status": "Escalated", 279 | "previous": "non-root", 280 | "current": "root", 281 | "workloads": [ 282 | { 283 | "name": "nginx", 284 | "kind": "Pod", 285 | "namespace": "default", 286 | "file": "nginx.yaml", 287 | "image": "kaizheh/nginx" 288 | } 289 | ], 290 | "workloads_count": 1 291 | }, 292 | "removed_run_group_as_root": { 293 | "status": "Reduced", 294 | "previous": "root", 295 | "current": "non-root", 296 | "workloads": [], 297 | "workloads_count": 0 298 | }, 299 | "new_read_only_root_fs": { 300 | "status": "Reduced", 301 | "previous": "false", 302 | "current": "true", 303 | "workloads": [ 304 | { 305 | "name": "my-busybox", 306 | "kind": "Pod", 307 | "namespace": "psp-test", 308 | "file": "busy-box.yaml", 309 | "image": "busybox" 310 | } 311 | ], 312 | "workloads_count": 1 313 | }, 314 | "removed_read_only_root_fs": { 315 | "status": "Escalated", 316 | "previous": "true", 317 | "current": "false", 318 | "workloads": [ 319 | { 320 | "name": "nginx", 321 | "kind": "Pod", 322 | "namespace": "default", 323 | "file": "nginx.yaml", 324 | "image": "kaizheh/nginx" 325 | } 326 | ], 327 | "workloads_count": 1 328 | } 329 | } 330 | ``` 331 | The above escalation report is generated in [PR](https://github.com/Kaizhe/k8s-workloads/pull/13) 332 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Kubernetes Security Config Watch' 2 | description: 'Run security privilege comparison against Kubernetes workloads when a PR is open.' 3 | inputs: 4 | sourceDir: 5 | description: 'Source directory of YAML files (master)' 6 | required: true 7 | default: '' 8 | targetDir: 9 | description: 'Target directory of YAML files (PR branch)' 10 | required: true 11 | default: '' 12 | outputs: 13 | escalation_report: 14 | description: 'Security Lint Report (in JSON format)' 15 | runs: 16 | using: 'docker' 17 | image: 'Dockerfile' 18 | args: 19 | - ${{ inputs.sourceDir }} 20 | - ${{ inputs.targetDir }} 21 | branding: 22 | icon: alert-circle 23 | color: blue 24 | 25 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -eu 4 | 5 | SRC=${1-""} 6 | TARGET=${2-""} 7 | 8 | if [ "$SRC" = "" ]; then 9 | echo "Source directory is empty" 10 | exit 1 11 | fi 12 | 13 | if [ "$TARGET" = "" ]; then 14 | echo "Target directory is empty" 15 | exit 1 16 | fi 17 | 18 | echo "Source Directory: $SRC" 19 | echo "Target Directory: $TARGET" 20 | 21 | /kube-psp-advisor compare --sourceDir "$SRC" --targetDir "$TARGET" 22 | 23 | report="$(/kube-psp-advisor compare --sourceDir "$SRC" --targetDir "$TARGET")" 24 | 25 | echo "::set-output name=escalation_report::${report}" 26 | --------------------------------------------------------------------------------