├── LICENSE ├── README.md └── kube-owasp-zap ├── Chart.yaml ├── README.md ├── templates ├── NOTES.txt ├── _helpers.tpl └── job.yaml └── values.yaml /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 | # kube-owasp-zap 2 | 3 | ## Introduction 4 | 5 | kube-owasp-zap is an owasp-zap solution for Kubernetes. It allows you to perform a vulnerability analysis on a host using Kubernetes as the platform. It creates a Job that deploys a pod that will scan the host for any vulnerabilities. 6 | 7 | ## Setup 8 | 9 | The following shows how to perform an owasp-zap scan using Kubernetes. There are two ways to deploy. Either use this Github project (Option A) or use a Helm repository (Option B) which is a little easier. 10 | 11 | This project runs the owasp-zap tool as a Kubernetes job. Each job needs to have a unique name. That's why the name is uniquified using a timestamp. 12 | 13 | Kubernetes jobs are not automatically reaped so that you can still see their logs when they are complete. It this case, that is good because the result of the owasp-zap scan are in the logs. 14 | 15 | ### Prequisite 16 | 17 | * Create a namespace. 18 | 19 | ```bash 20 | kubectl apply -f -< helm install "vuln-scan-$(date '+%Y-%m-%d-%H-%M-%S')-job" ./kube-owasp-zap \ 42 | --namespace owasp-zap \ 43 | --set zapcli.debug.enabled=true \ 44 | --set zapcli.spider.enabled=false \ 45 | --set zapcli.recursive.enabled=false \ 46 | --set zapcli.targetHost=$URL_TO_SCAN 47 | ``` 48 | 49 | ### Option B - Using Using Helm 50 | 51 | * Add the Helm repository. Then install the chart. 52 | 53 | ```bash 54 | > helm repo add simplyzee https://charts.simplyzee.dev 55 | 56 | > helm install "vuln-scan-$(date '+%Y-%m-%d-%H-%M-%S')-job" implyzee/kube-owasp-zap \ 57 | --namespace owasp-zap \ 58 | --set zapcli.debug.enabled=true \ 59 | --set zapcli.spider.enabled=false \ 60 | --set zapcli.recursive.enabled=false \ 61 | --set zapcli.targetHost=$URL_TO_SCAN 62 | ``` 63 | 64 | This will deploy a Job that will deploy a pod on the Kubernetes platform that will perform the vulnerability scan. 65 | 66 | ## Example of Job Output 67 | 68 | * Use the following command to view the list of jobs. Since the job names have a timestamp, we can use `sort` to force newer jobs to the end of the list. 69 | 70 | ```bash 71 | > kubectl get jobs --namespace owasp-zap | grep -v "COMPLETIONS" | sort 72 | vuln-scan-2020-03-20-11-10-17-job-kube-owasp-zap 1/1 22s 6m53s 73 | vuln-scan-2020-03-20-10-46-14-job-kube-owasp-zap 1/1 33s 30m 74 | ``` 75 | 76 | * Use the following command to view the logs of a job. 77 | 78 | ```bash 79 | > kubectl logs jobs/vuln-scan-2020-03-20-11-10-17-job-kube-owasp-zap --namespace owasp-zap 80 | [INFO] Starting ZAP daemon 81 | [DEBUG] Starting ZAP process with command: /zap/zap.sh -daemon -port 8080 -config api.disablekey=true. 82 | [DEBUG] Logging to /zap/zap.log 83 | [DEBUG] ZAP started successfully. 84 | [INFO] Running a quick scan for http://nodegoat.herokuapp.com 85 | [DEBUG] Disabling all current scanners 86 | [DEBUG] Enabling scanners with IDs 40012,40014,40016,40017,40018 87 | [DEBUG] Scanning target https://www.ibm.com... 88 | [DEBUG] Started scan with ID 0... 89 | [DEBUG] Scan progress %: 0 90 | [DEBUG] Scan #0 completed 91 | [INFO] Issues found: 0 92 | [INFO] Shutting down ZAP daemon 93 | [DEBUG] Shutting down ZAP. 94 | [DEBUG] ZAP shutdown successfully. 95 | ``` 96 | 97 | ## Roadmap 98 | 99 | Still a lot of work around platform improvements with Kubernetes but it utilises the Kubernetes platform well to scan sites from a vulnerability analysis perspective. 100 | 101 | Ideas to implement: 102 | * Easier way of viewing scanning analysis 103 | * Zap CLI to be more configurable as a tool on the k8s platform 104 | 105 | ## Contributing 106 | 107 | Please raise an issue or pull request if you have any issues, questions or features. 108 | -------------------------------------------------------------------------------- /kube-owasp-zap/Chart.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | appVersion: 2.8.0 3 | description: A Helm chart for owasp-zap 4 | name: kube-owasp-zap 5 | version: 0.1.0 6 | keywords: 7 | - rclone 8 | home: https://github.com/zaproxy/zaproxy 9 | icon: https://banner2.kisspng.com/20180502/ozq/kisspng-owasp-zap-vulnerability-penetration-test-proxy-ser-web-application-5aea65947a30d0.0276627015253108685005.jpg 10 | sources: 11 | - https://github.com/zee-ahmed/kube-owasp-zap 12 | - https://hub.docker.com/r/owasp/zap2docker-stable/ 13 | maintainers: 14 | - name: zee-ahmed 15 | -------------------------------------------------------------------------------- /kube-owasp-zap/README.md: -------------------------------------------------------------------------------- 1 | # kube-owasp-zap helm chart 2 | 3 | ## Configuration 4 | 5 | The following tables lists the configurable parameters of the kube-owasp-zap chart and their default values. 6 | 7 | | Parameter | Description | Default | 8 | |----------------------------|-------------------------------------|---------------------------------------------------------| 9 | | `zapcli.image.repository` | Zap CLI image repository | `owasp/zap2docker-stable` | 10 | | `zapcli.image.tag` | Zap CLI image tag | `2.8.0` | 11 | | `zapcli.image.pullPolicy` | Image pull policy | `IfNotPresent` | 12 | | `zapcli.debug.enabled` | Enable verbose mode | `false` | 13 | | `zapcli.scanTypes` | Vulnerability scan type | `xss, sqli` | 14 | | `zapcli.spider.enabled` | Enable spider | `true` | 15 | | `zapcli.recursive.enabled` | Enable recursive scanning | `true` | 16 | | `zapcli.targetHost` | URL to scan | `http://nodegoat.herokuapp.com/` | 17 | 18 | 19 | Read through the [values.yaml](https://github.com/zee-ahmed/kube-owasp-zap/blob/master/kube-owasp-zap/values.yaml) file. It has several commented out suggested values. 20 | -------------------------------------------------------------------------------- /kube-owasp-zap/templates/NOTES.txt: -------------------------------------------------------------------------------- 1 | View Scan Jobs: kubectl get job --namespace {{ .Release.Namespace }} 2 | View Scan Pods: kubectl get pods --namespace {{ .Release.Namespace }} 3 | -------------------------------------------------------------------------------- /kube-owasp-zap/templates/_helpers.tpl: -------------------------------------------------------------------------------- 1 | {{/* vim: set filetype=mustache: */}} 2 | {{/* 3 | Expand the name of the chart. 4 | */}} 5 | {{- define "kube-owasp.name" -}} 6 | {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} 7 | {{- end -}} 8 | 9 | {{/* 10 | Create a default fully qualified app name. 11 | We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). 12 | If release name contains chart name it will be used as a full name. 13 | */}} 14 | {{- define "kube-owasp.fullname" -}} 15 | {{- if .Values.fullnameOverride -}} 16 | {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} 17 | {{- else -}} 18 | {{- $name := default .Chart.Name .Values.nameOverride -}} 19 | {{- if contains $name .Release.Name -}} 20 | {{- .Release.Name | trunc 63 | trimSuffix "-" -}} 21 | {{- else -}} 22 | {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} 23 | {{- end -}} 24 | {{- end -}} 25 | {{- end -}} 26 | 27 | {{/* 28 | Create chart name and version as used by the chart label. 29 | */}} 30 | {{- define "kube-owasp.chart" -}} 31 | {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} 32 | {{- end -}} 33 | 34 | /* 35 | Helpers 36 | - joinListWithComma 37 | */ 38 | {{- define "helm-toolkit.utils.joinListWithComma" -}} 39 | {{- $local := dict "first" true -}} 40 | {{- range $k, $v := . -}}{{- if not $local.first -}},{{- end -}}{{- $v -}}{{- $_ := set $local "first" false -}}{{- end -}} 41 | {{- end -}} 42 | -------------------------------------------------------------------------------- /kube-owasp-zap/templates/job.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: batch/v1 2 | kind: Job 3 | metadata: 4 | name: {{ include "kube-owasp.fullname" . }} 5 | labels: 6 | app.kubernetes.io/name: {{ include "kube-owasp.name" . }} 7 | helm.sh/chart: {{ include "kube-owasp.chart" . }} 8 | app.kubernetes.io/instance: {{ .Release.Name }} 9 | app.kubernetes.io/managed-by: {{ .Release.Service }} 10 | spec: 11 | backoffLimit: 0 12 | template: 13 | metadata: 14 | labels: 15 | app.kubernetes.io/name: {{ include "kube-owasp.name" . }} 16 | app.kubernetes.io/instance: {{ .Release.Name }} 17 | spec: 18 | {{- with .Values.imagePullSecrets }} 19 | imagePullSecrets: 20 | {{- toYaml . | nindent 8 }} 21 | {{- end }} 22 | containers: 23 | - name: {{ .Chart.Name }} 24 | image: "{{ .Values.zapcli.image.repository }}:{{ .Values.zapcli.image.tag }}" 25 | resources: 26 | {{- toYaml .Values.resources | nindent 12 }} 27 | imagePullPolicy: {{ .Values.zapcli.image.pullPolicy }} 28 | args: 29 | - zap-cli 30 | {{- if .Values.zapcli.debug.enabled }} 31 | - "--verbose" 32 | {{- end }} 33 | - quick-scan 34 | - --self-contained 35 | - --start-options 36 | - '-config api.disablekey=true' 37 | - "-s {{ include "helm-toolkit.utils.joinListWithComma" .Values.zapcli.scanTypes }}" 38 | {{- if .Values.zapcli.spider.enabled }} 39 | - --spider 40 | {{- end }} 41 | {{- if .Values.zapcli.recursive.enabled }} 42 | - -r 43 | {{- end }} 44 | - "{{ .Values.zapcli.targetHost }}" 45 | restartPolicy: Never 46 | -------------------------------------------------------------------------------- /kube-owasp-zap/values.yaml: -------------------------------------------------------------------------------- 1 | # Default values for kube-owasp. 2 | # This is a YAML-formatted file. 3 | # Declare variables to be passed into your templates. 4 | imagePullSecrets: 5 | - name: hofcicd-regcred 6 | 7 | resources: {} 8 | # We usually recommend not to specify default resources and to leave this as a conscious 9 | # choice for the user. This also increases chances charts run on environments with little 10 | # resources, such as Minikube. If you do want to specify resources, uncomment the following 11 | # lines, adjust them as necessary, and remove the curly braces after 'resources:'. 12 | # limits: 13 | # cpu: 1 14 | # memory: 2048Mi 15 | # requests: 16 | # cpu: 300m 17 | # memory: 512Mi 18 | 19 | zapcli: 20 | image: 21 | repository: owasp/zap2docker-stable 22 | tag: 2.8.0 23 | pullPolicy: IfNotPresent 24 | 25 | # Verbose information about a scan. 26 | debug: 27 | enabled: false 28 | 29 | # What type of scans should owasp zap do? 30 | # - all 31 | # - sqli 32 | # - xss 33 | # - xss_reflected 34 | # - xss_persistent 35 | scanTypes: 36 | - xss 37 | - sqli 38 | 39 | # Activates a spider against the host to scan through for vulnerabilities across it's sitemap 40 | spider: 41 | enabled: true 42 | 43 | # Should the scan be recursive 44 | recursive: 45 | enabled: true 46 | 47 | # The target host for owasp-zap to scan 48 | targetHost: http://nodegoat.herokuapp.com/ 49 | --------------------------------------------------------------------------------