Metadata-Version: 2.1
Name: policytester
Version: 0.1.3
Summary: Test kubernetes network policies
Author-email: Erik Brakkee <erik@brakkee.org>
License: 
                                         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.
        
Project-URL: Homepage, https://github.com/ErikEngerd/policytester
Project-URL: source, https://github.com/ErikEngerd/policytester.git
Project-URL: documentation, https://github.com/ErikEngerd/policytester#readme
Keywords: kubernetes,network,policy,network policy
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Networking :: Firewalls
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE



# Kubernetes Network Policy Tester

Network security is often overlooked in Kubernetes. Without network policies 
kubernetes deployments are basically identical to a traditional infrastructure 
without firewalls. Network policies in Kubernetes
can provide the required network segmentation, see
[the introduction post](https://brakkee.org/site/index.php/2022/07/23/securing-network-communication-on-kubernetes-using-network-policies/).

However, network policies must be verified since it is easy to make a mistake in configuration. 
This is 
where the policy tester comes in. The tool is written in python and uses existing pods 
running in a kubernetes cluster to verify network commmunication. It does this by 
attaching an ephemeral container to an existing pod so it can verify communications from
this pod to other pods and the internet. Ephemeral contains are a beta feature since 
kubernetes 1.23 which allows to add new containers to existing pods. The main purpose of 
this is for debugging (testing), so these containers are sometimes also called debug
containers. 

This approach allows to test network communication 
within the cluster and also from within the cluster to the internet. The advantage of 
using ephemeral containers is that it uses existing pods, so the testing environment is 
identical to the actual environmnet, since no separate test pods are created. Therefore,
the tests are representative of the actual situation. The only thing that cannot be tested
are rules from traffic coming in from outside the cluster to the cluster.

## Installation 

```angular2html
pip install policytester
```

## Usage

```angular2html
# prepare pods by adding debug containers to them
policytester prepare tests.yaml

# execute tests for pods
policytester execute tests.yaml

# delete pods that got debug containers attached in any previous prepare steps.
policytester cleanup tests.yaml
```

The separation of prepare, execute, and cleanup allows for tests toe be rerun without
having to wait for instrumentation of pods. 

The current version of the policy tester uses the default kubectl context to connect to.
Future versions of the tool can provide ways to explicitly define a connection to a 
cluster. 

## Example


### Verify that a httpd pod can reach the nexus pod 

### Verify that a pod can reach the java maven repository but (most likely) not any other hosts 

```angular2html

pods:
  - name: httpd-wamblee-org
    namespace: exposure
    podname: httpd-wamblee-org
    
addresses:
  - name: internet
    hosts:
      - github.com
      - google.com
  - name: maven-repo
    hosts:
      - repo1.maven.org

connections:
  - name: internet
    addresses:
      - internet
    ports:
      - port: 80
      - port: 443
  - name: maven-repo
    addresses:
      - maven-repo
    ports:
      - port: 80
      - port: 443

rules:
  - name: internet-access
    from: 
      - httpd-wamblee-org
    allowed:
      - maven-repo
    denied:
      - internet
```

A more complete example is [here](policytests.yaml).

## Structure of the input file 

The example shows the structure of an input file. First, we need to define the pods
that we will use. This is done by the following attributes:
* *name*: a symbolic name of the pod by which it can be referred to in the connections section, 
  or as pod in the `from` part of a rule. 
* *namespace*: the namespace of the pod
* *podname*: the string that the actual pod name must start with. For instance for deployments,
  pod names are composed of the deployment name followed by a unique id. 

At this moment no other ways of identifying a pod are possible. Future 
versions of the tool could support podSelectors in the same syntax as kubernetes does
in for instance deployment yaml files. Based on a pod identification, a single pod that
matches the specification is chosen. This is to avoid a combinatoric explosion of tests. 

Next, addresses must be defined. Each address has the following fields: 
* *name*: a symbolic name of the address by which it can be referred to in the
  connections section. 
* *hosts*: A list of host names or IP adddresses

Addresses are simply fixed IP addresses or hostnames.
They are an alternative to a pod address which is simply the cluster IP of a pod. 
The difference between a pod and address is that a pod can not only be used as the 
target (server side) of a network check but also as the client part from which a connection
to a server is established. The names of addresses and pods may not conflict. 
In the example above, the `internet` 
address is used which refers to an address, but this could also have been the `name` of 
a pod defined in the pods section. 

The next section defines the connections that can be tested as a combination of pod/address
in the addresses field, and ports:
* *name*: a symbolic name of the connection by which it can be referenced in the 
  rules section of by other connection objects. 
* *addresses*: A list of names of pods or addresses
* *ports*: A list of ports that must be tested. Each port is defined by its `port` which 
  defines the numeric port and by an optional `type` (UDP or TCP) which by default is 
  TCP. 

Finally, the rules section describes from which source pods, the
connections are allowed or denied. In the example above, we specify that the 
`httpd-wamblee-org` pod can connect to the maven repo at ports 80 and 443, but that 
it cannot connect to github.com and google.com: 
* *name*: the name of the rule
* *from*: pod references. Because of pod groups (see later) 
  this can resolve to more than one pod
* *allowed*: A list of connections that are allowed.
* *denied*: A list of connections that are denied. 


### Pod groups

Since it is annoying to repeat the same rules, it is possible to define
groups of pods in the pods section. These pod groups may be referenced just like
any other pod or address using its `name`.

```angular2html
pods:
  - name: httpd-wamblee-org
    namespace: exposure
    podname: httpd-wamblee-org
  - name: httpd-brakkee-org
    namespace: exposure
    podname: httpd-brakkee-org
  # pod group
  - name: all-exposure-pods
    pods:
      - httpd-wamblee-org # refers to earlier pod name
      - httpd-brakkee-org # same...
```

### Address groups

Similar to pod groups address groups can be defined. 

```angular2html
addresses:
  - name: internet
    hosts:
      - github.com
      - google.com 
  - name: dns
    hosts:
      - 192.168.178.1
      - 8.8.8.8
  # address group
  - name: alladdresses
    addresses:
      - internet
      - dns
```

### Protocols

The default protocl is TCP, but UDP may also be specified using the `type` field. 
TCP may also be explicitly specified in this way but it is default. Note however, that 
UDP tests are unreliable. This is because of the nature of UDP. To work around this, a 
future version of this tool could use protocol specific tests for UDP based protocols. 

```angular2html
connections
  - name: dns
    addresses:
    - dns
    ports:
      - port: 53
        type: TCP
      - port: 53
        type: UDP
```

## Test output

The test will output a `junit.xml` file which is suitable for continuous integration.
The test will also show on screen output.

## Under the hood

### Prepare

In the prepare step, the policy tester examines all rules and identifies the pod
specifications that are referenced in the `from` parts of the rules. From each 
pod specification, the pods that match the specification are looked up. If one of 
the pods that is found already contains a debug contqiner than that pod is used. 
Otherwise, the debug container is added to one of these pods, so-called instrumenting
the pod for test. The policy tester only uses
this single pod for testing even when more than one eligble pod was found. 
This is to avoid a combinatoric explosion in testing, and 
also assumes that the network policies are such that it equally effects all pods in 
for the same pod specification. 

Each pod is given a specific label to identify it 
as a pod to which a debug container is added. The label is set before the debug container
is added to make sure we can never have pods with debug containers but without a label. 
This label is used in the cleanup phase to delete pods. 

### Execute

In the execute phase all rules are processed. This means that all source pods 
mentioned in the `from` part of the rule are looked up and for each target connection
in the `allowed` and `denied` sections a command is run in the ephemeral container
that verifies network access. This can be a `netcat` or `nmap` command. 

### Cleanup

In the cleanup phase, the policy tester simply deletes the pods with debug containers 
using the label that was added. 

## Caveats

* incoming network connections cannot be tested by this tool
* UDP tests are, for obvious reasons, not really possible in a generic way. Even though
  policytester supports it, these tests are unreliabnle
* the cleanup phase simply deletes instrumented pods. Your setup must be able to handle
  this. Use this tool on a staging production-like environmnet or use with greatest
  care on a production system. In particular, downtime can occur if you are testing 
  network access from deployments and replicasets with replica count 1. 


