Metadata-Version: 2.1
Name: ismyk8ssecure
Version: 0.0.2
Summary: Checks for vulnerabilities in a running k8s cluster
Home-page: https://github.com/ismyk8ssecure/ismyk8ssecure
Author: Shivam Sandbhor
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/ismyk8ssecure/ismyk8ssecure/issues
Description: <p align="center">
          <img src="https://github.com/ismyk8ssecure/ismyk8ssecure/raw/main/docs/static/logo.png" alt="ismyk8ssecure" title="ismyk8ssecure"/>
        </p>
        
        <div align="center">
          <img src="https://img.shields.io/github/license/ismyk8ssecure/ismyk8ssecure.svg" alt="apache2-license"/>
          <img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python3.8" />
        </div>
        
        <div align="center">
          <b>ismyk8ssecure</b> is a FOSS tool to check whether your K8s cluster contains previously reported vulnerabilities.
        </div>
        
        ---
        
        <p align="center">
        <img src="https://github.com/ismyk8ssecure/ismyk8ssecure/raw/main/docs/static/demo.gif" alt="ismyk8ssecure_demo_gif" title="ismyk8ssecure" />
        </p>
        
        
        ## Get Started in 60 seconds !
        
        Make sure you meet the following prerequisites
        
        ### Prerequisites:
        
        - **kubectl is configured** to connect to cluster.
        - Optional, but highly recommended: make sure you are in a **python venv**.
        
        Simply run the following commands, and run your first scan.
        
        ```console
        pip install ismyk8ssecure
        ismyk8ssecure 
        ```
        
        ## How It Works:
        
        This tool consists of 3 components:
        
        ### Advisories:
        
        These are yaml files with following schema:
        
        ```yaml
        vulnerability_id:
        vulnerability_description:
        vulnerable_components:
          - component_name:
            vulnerable_versions: [] # These are computed from `vulnerable_version_ranges`
            vulnerable_version_ranges: [] # These are manually filled
        references: []
        last_updated_at:
        created_at:
        ```
        
        Advisories can be found in the `advisories` directory in this repo.
        
        ### Version Detectors:
        
        These are functions which detects the version of a particular k8s component. See examples in TODO. 
        
        ### Vulnerability Detectors:
        
        These are functions defined per (vulnerability, k8s component) pair. They are called depending upon the results of above 2 components. They verify whether the corresponding "vulnerability" is present in the detected "k8s component". 
        
        
        ## Roadmap:
        
        - [ ] Convert most of the kubernetes security advisories into machine readable format.
        
        - [ ] Implement fine tuned vulnerability detectors and eventually become a **smart npm audit**.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
