Metadata-Version: 2.1
Name: docfseccheck
Version: 1.0
Summary: DockF-Sec-Check helps to make your Dockerfile commands more secure.
Home-page: https://github.com/OsmanKandemir/docf-sec-check
Author: OsmanKandemir
Author-email: osmankandemir00@gmail.com
License: GPL-3.0
Keywords: python,dockerfile,docker,security-tools
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Topic :: Security
Classifier: Typing :: Typed
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Intended Audience :: System Administrators
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3 ==1.26.14

![Logo](logo.png)

[![DocF-Sec-Check](https://img.shields.io/badge/DocFSecCheck-red)](https://www.github.com/OsmanKandemir/docf-sec-check)
[![Version](https://img.shields.io/badge/version-1.0-blue.svg)](https://github.com/OsmanKandemir/docf-sec-check)
[![Pip Version](https://img.shields.io/badge/pypi-23.0.1-green)](https://www.python.org)
[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/OsmanKandemir/docf-sec-check/blob/main/LICENSE)
[![Docker](https://img.shields.io/badge/docker-build-important.svg?logo=Docker)](https://www.docker.com)
[![Python Version](https://img.shields.io/badge/python-3.11-green)](https://www.python.org)

# DocF-Sec-Check

## Description

DockF-Sec-Check helps to make you Dockerfile commands more secure.


## ScreenShot

![](screen.png)

## Done

- [x] First level security notification in Dockerfile.

## TODO List
- [ ] Detecting the Dockerfile correctly.
- [ ] Two level security notification in Dockerfile.
- [ ] Security noticification in Docker images.
- [ ] *********** (Private Repository)

## Installation

### From Source Code

You can use virtualenv for package dependencies before installation.

```
git clone https://github.com/OsmanKandemir/docf-sec-check.git
cd docf-sec-check
python setup.py build
python setup.py install
```

### From Pypi

The script is [available on PyPI](https://pypi.org/project/docfseccheck/). To install with pip:
```
pip install docfseccheck
```

### From Dockerfile

You can run this application on a container after build a Dockerfile. You need to specify a path (YOUR-LOCAL-PATH) to scan the Dockerfile in your local.

```
docker build -t docfseccheck .
docker run -v <YOUR-LOCAL-PATH>/Dockerfile:/docf-sec-check/Dockerfile docfseccheck -f /docf-sec-check/Dockerfile

```

### From DockerHub

```
docker pull osmankandemir/docfseccheck:v1.0
docker run -v <YOUR-LOCAL-PATH>/Dockerfile:/docf-sec-check/Dockerfile osmankandemir/docfseccheck:v1.0 -f /docf-sec-check/Dockerfile


```

## Usage


```
-f DOCKERFILE [DOCKERFILE], --file DOCKERFILE [DOCKERFILE] Dockerfile path. --file Dockerfile
 
```

#### Function Usage

```
from docfchecker import DocFChecker

#Dockerfile is your file PATH.

DocFChecker(["Dockerfile"]) 

```


## Development and Contribution

#### See; [CONTRIBUTING.md](CONTRIBUTING.md)


## License

Copyright (c) 2024 Osman Kandemir \
Licensed under the GPL-3.0 License.

## Donations

If you like DocF-Sec-Check and would like to show support, you can use **Buy A Coffee** or **Github Sponsors** feature for the developer using the button below.

Or

Sponsor me : https://github.com/sponsors/OsmanKandemir 😊

<a href="https://www.buymeacoffee.com/OsmanKandemir" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

Your support will be much appreciated😊


