[](https://www.github.com/OsmanKandemir/docf-sec-check)
[](https://github.com/OsmanKandemir/docf-sec-check)
[](https://www.python.org)
[](https://github.com/OsmanKandemir/docf-sec-check/blob/main/LICENSE)
[](https://www.docker.com)
[](https://www.python.org)
# DocF-Sec-Check
## Description
DockF-Sec-Check helps to make you Dockerfile commands more secure.
## ScreenShot
## 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😊
Raw data
{
"_id": null,
"home_page": "https://github.com/OsmanKandemir/docf-sec-check",
"name": "docfseccheck",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "python, dockerfile, docker, security-tools",
"author": "OsmanKandemir",
"author_email": "osmankandemir00@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f3/e0/aefb9013f9b3940b3af611a14a4f9d0f72673155dcc7b53f89cd210683f1/docfseccheck-1.0.tar.gz",
"platform": null,
"description": "\n\n[](https://www.github.com/OsmanKandemir/docf-sec-check)\n[](https://github.com/OsmanKandemir/docf-sec-check)\n[](https://www.python.org)\n[](https://github.com/OsmanKandemir/docf-sec-check/blob/main/LICENSE)\n[](https://www.docker.com)\n[](https://www.python.org)\n\n# DocF-Sec-Check\n\n## Description\n\nDockF-Sec-Check helps to make you Dockerfile commands more secure.\n\n\n## ScreenShot\n\n\n\n## Done\n\n- [x] First level security notification in Dockerfile.\n\n## TODO List\n- [ ] Detecting the Dockerfile correctly.\n- [ ] Two level security notification in Dockerfile.\n- [ ] Security noticification in Docker images.\n- [ ] *********** (Private Repository)\n\n## Installation\n\n### From Source Code\n\nYou can use virtualenv for package dependencies before installation.\n\n```\ngit clone https://github.com/OsmanKandemir/docf-sec-check.git\ncd docf-sec-check\npython setup.py build\npython setup.py install\n```\n\n### From Pypi\n\nThe script is [available on PyPI](https://pypi.org/project/docfseccheck/). To install with pip:\n```\npip install docfseccheck\n```\n\n### From Dockerfile\n\nYou 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.\n\n```\ndocker build -t docfseccheck .\ndocker run -v <YOUR-LOCAL-PATH>/Dockerfile:/docf-sec-check/Dockerfile docfseccheck -f /docf-sec-check/Dockerfile\n\n```\n\n### From DockerHub\n\n```\ndocker pull osmankandemir/docfseccheck:v1.0\ndocker run -v <YOUR-LOCAL-PATH>/Dockerfile:/docf-sec-check/Dockerfile osmankandemir/docfseccheck:v1.0 -f /docf-sec-check/Dockerfile\n\n\n```\n\n## Usage\n\n\n```\n-f DOCKERFILE [DOCKERFILE], --file DOCKERFILE [DOCKERFILE] Dockerfile path. --file Dockerfile\n \n```\n\n#### Function Usage\n\n```\nfrom docfchecker import DocFChecker\n\n#Dockerfile is your file PATH.\n\nDocFChecker([\"Dockerfile\"]) \n\n```\n\n\n## Development and Contribution\n\n#### See; [CONTRIBUTING.md](CONTRIBUTING.md)\n\n\n## License\n\nCopyright (c) 2024 Osman Kandemir \\\nLicensed under the GPL-3.0 License.\n\n## Donations\n\nIf 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.\n\nOr\n\nSponsor me : https://github.com/sponsors/OsmanKandemir \ud83d\ude0a\n\n<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>\n\nYour support will be much appreciated\ud83d\ude0a\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "DockF-Sec-Check helps to make your Dockerfile commands more secure.",
"version": "1.0",
"project_urls": {
"Homepage": "https://github.com/OsmanKandemir/docf-sec-check"
},
"split_keywords": [
"python",
" dockerfile",
" docker",
" security-tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "693cefa71dbe14e30a986e7359b32ae541957086b96a636e30401631e74838a0",
"md5": "a353399fcdf13769cc938a9127ae8b19",
"sha256": "3fc84fbec1899d18aa3b590a3b948cc52cedaf10199ce55ac4b616d9a5c4e8f5"
},
"downloads": -1,
"filename": "docfseccheck-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a353399fcdf13769cc938a9127ae8b19",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14805,
"upload_time": "2024-06-23T12:26:09",
"upload_time_iso_8601": "2024-06-23T12:26:09.312797Z",
"url": "https://files.pythonhosted.org/packages/69/3c/efa71dbe14e30a986e7359b32ae541957086b96a636e30401631e74838a0/docfseccheck-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f3e0aefb9013f9b3940b3af611a14a4f9d0f72673155dcc7b53f89cd210683f1",
"md5": "63d99a92dc6a14098700bcb99f8614e9",
"sha256": "bce8bf5dd5776b541bbeb6703b09977dc8ec25c05a4fac09a0d03f9ba1642fb2"
},
"downloads": -1,
"filename": "docfseccheck-1.0.tar.gz",
"has_sig": false,
"md5_digest": "63d99a92dc6a14098700bcb99f8614e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14986,
"upload_time": "2024-06-23T12:26:11",
"upload_time_iso_8601": "2024-06-23T12:26:11.336205Z",
"url": "https://files.pythonhosted.org/packages/f3/e0/aefb9013f9b3940b3af611a14a4f9d0f72673155dcc7b53f89cd210683f1/docfseccheck-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-23 12:26:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OsmanKandemir",
"github_project": "docf-sec-check",
"github_not_found": true,
"lcname": "docfseccheck"
}
JSON
