From e9513437fdeb96a8ccdc59162264a3fef445680b Mon Sep 17 00:00:00 2001 From: Brad Geesaman Date: Fri, 13 Mar 2020 10:50:37 -0400 Subject: [PATCH] initial --- .gitignore | 2 + LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++++ Makefile | 37 +++++++++ controls/k8s.rb | 151 ++++++++++++++++++++++++++++++++++++ inspec.yml | 28 +++++++ 5 files changed, 420 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 controls/k8s.rb create mode 100644 inspec.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..eb0cea4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +**/.tmp +inspec.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d576670 --- /dev/null +++ b/Makefile @@ -0,0 +1,37 @@ +# Copyright 2020 Darkbit.io +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +SHELL := /usr/bin/env bash + +IMAGENAME=mkit +IMAGEREPO=darkbitio/$(IMAGENAME) +WORKDIR=/share + +DOCKERBUILD=docker build -t $(IMAGEREPO):latest . +COMMAND=docker run --rm -it -v `pwd`:$(WORKDIR) -v $(HOME)/.kube:/root/.kube:ro +IMAGEPATH=$(IMAGEREPO):latest +INSPECRUN=$(COMMAND) $(IMAGEPATH) exec . -t k8s:// | ./lib/inspec-results-to-findings.rb +DEBUGSHELL=$(COMMAND) --entrypoint /bin/bash $(IMAGEPATH) + +build: + @echo "Building $(IMAGEREPO):latest" + @$(DOCKERBUILD) +run: + @echo "Running in $(IMAGEREPO):latest: inspec exec . -t k8s://" + @$(INSPECRUN) +shell: + @echo "Running a shell inside the container" + @$(DEBUGSHELL) + +.PHONY: build run shell diff --git a/controls/k8s.rb b/controls/k8s.rb new file mode 100644 index 0000000..d2ab13c --- /dev/null +++ b/controls/k8s.rb @@ -0,0 +1,151 @@ +# Copyright 2020 Darkbit.io +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +title "Kubernetes Basics" + +kversion = k8sversion() + +control "k8s-1" do + impact 1.0 + title "Ensure pods only run in desired namespaces" + desc "" + + describe "default namespace pods" do + subject { k8sobjects(api: 'v1', type: 'pods', namespace: 'default').items } + its('length') { should cmp 0 } + end + describe "kube-public namespace pods" do + subject { k8sobjects(api: 'v1', type: 'pods', namespace: 'kube-public').items } + its('length') { should cmp 0 } + end + describe "kube-node-lease namespace pods" do + subject { k8sobjects(api: 'v1', type: 'pods', namespace: 'kube-node-lease').items } + its('length') { should cmp 0 } + end +end + +control "k8s-2" do + impact 1.0 + title "Ensure Dashboard is not running" + desc "Ensure Dashboard is not running" + + describe "Dashboard pods" do + subject { k8sobjects(api: 'v1', type: 'pods', labelSelector: 'k8s-app=kubernetes-dashboard').items } + its('length') { should cmp 0 } + end +end + +control "k8s-3" do + impact 1.0 + title "Ensure Tiller is not running" + desc "Ensure Tiller is not running" + + k8sobjects(api: 'v1', type: 'namespaces').items.each do |ns| + describe "#{ns.name}/tiller-deploy deployment" do + subject { k8sobject(api: 'extensions/v1beta1', type: 'deployments', namespace: ns.name, name: "tiller-deploy") } + it { should_not exist } + end + end +end + +control "k8s-4" do + impact 1.0 + title "No pods with latest container tag" + desc "" + + k8sobjects(api: 'v1', type: 'pods').items.each do |pod| + describe "#{pod.namespace}/#{pod.name} pod" do + subject { k8sobject(api: 'v1', type: 'pods', namespace: pod.namespace, name: pod.name) } + it { should_not have_latest_container_tag } + end + end +end + +control "k8s-5" do + impact 1.0 + title "Validate NetworkPolicy enforcement is installed" + desc "Ensure Calico is installed on EKS/GKE or Azure CNI is installed on AKS" + + calico = k8sobjects(api: 'apps/v1', type: 'daemonsets', namespace: 'kube-system', labelSelector: 'k8s-app=calico-node').items + azure = k8sobjects(api: 'apps/v1', type: 'daemonsets', namespace: 'kube-system', labelSelector: 'component=azure-cni-networkmonitor').items + describe.one do + describe "NetworkPolicy Daemonset installed" do + subject { calico } + its('count') { should be > 0 } + end + describe "NetworkPolicy Daemonset installed" do + subject { azure } + its('count') { should be > 0 } + end + end +end + +control "k8s-6" do + impact 1.0 + title "Validate PodSpec enforcement is installed" + desc "Ensure OPA/Gatekeeper, K-rail, or PSP is installed" + + gatekeeper = k8sobjects(api: 'extensions/v1beta1', type: 'deployments', labelSelector: 'control-plane=controller-manager').items + krail = k8sobjects(api: 'extensions/v1beta1', type: 'deployments', labelSelector: 'name=k-rail').items + describe.one do + describe "OPA/Gatekeeper installed" do + subject { gatekeeper } + its('count') { should be > 0 } + end + describe "K-rail installed" do + subject { krail } + its('count') { should be > 0 } + end + end +end + +#control "k8s-100" do +# impact 1.0 +# title "Validate ResourceQuotas" +# desc "" +# +# k8sobjects(api: 'v1', type: 'namespaces').items.each do |ns| +# next if ns.name == "kube-node-lease" || ns.name == "kube-public" +# describe "#{ns.name} namespace resourcequotas" do +# subject { k8sobjects(api: 'v1', type: 'resourcequotas', namespace: ns.name).items } +# its('count') { should be > 0 } +# end +# k8sobjects(api: 'v1', type: 'resourcequotas', namespace: ns.name).items.each do |rq| +# describe "#{rq.namespace}/#{rq.name} resourcequota" do +# subject { k8sobject(api: 'v1', type: 'resourcequotas', namespace: rq.namespace, name: rq.name) } +# it { should exist } +# end +# end +# end +#end +# +#control "k8s-101" do +# impact 1.0 +# title "Validate LimitRange" +# desc "" +# +# k8sobjects(api: 'v1', type: 'namespaces').items.each do |ns| +# next if ns.name == "kube-node-lease" || ns.name == "kube-public" +# describe "#{ns.name} namespace limitranges" do +# subject { k8sobjects(api: 'v1', type: 'limitranges', namespace: ns.name).items } +# its('count') { should be > 0 } +# end +# k8sobjects(api: 'v1', type: 'limitranges', namespace: ns.name).items.each do |lr| +# describe "#{lr.namespace}/#{lr.name} limitranges" do +# subject { k8sobject(api: 'v1', type: 'limitranges', namespace: lr.namespace, name: lr.name) } +# it { should exist } +# end +# end +# end +#end diff --git a/inspec.yml b/inspec.yml new file mode 100644 index 0000000..02fa148 --- /dev/null +++ b/inspec.yml @@ -0,0 +1,28 @@ +# Copyright 2020 Darkbit.io +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: inspec-profile-k8s +title: "Inspec K8s Profile" +maintainer: info@darkbit.io +copyright: Darkbit.io +copyright_email: info@darkbit.io +license: Apache-2.0 +summary: "Assesses key areas of K8s Clusters" +version: "0.1.0" +supports: + - platform: k8s +depends: +- name: inspec-k8s + git: https://github.com/bgeesaman/inspec-k8s + tag: "0.1.3"