diff --git a/.pyup.yml b/.pyup.yml index bf4a8da..96c5f1b 100644 --- a/.pyup.yml +++ b/.pyup.yml @@ -4,5 +4,5 @@ schedule: "every month" update: "all" assignees: - - mBouamama + - tyki6 label_prs: update diff --git a/README.md b/README.md index 6641ae5..b837914 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,26 @@ # rawsec_cli -[![mBouamama](https://github.com/mBouamama/rawsec_cli/workflows/Unit%20Test/badge.svg)](https://github.com/mBouamama/rawsec_cli) + +[![tyki6](https://github.com/tyki6/rawsec_cli/workflows/Unit%20Test/badge.svg)](https://github.com/tyki6/rawsec_cli) [![PyPI](https://img.shields.io/pypi/v/rawsec-cli)](https://pypi.org/project/rawsec-cli/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rawsec-cli)](https://pypi.org/project/rawsec-cli/) [![PyPI - Download](https://pepy.tech/badge/rawsec-cli)](https://pepy.tech/project/rawsec-cli) -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mBouamama/rawsec_cli)](https://github.com/mBouamama/rawsec_cli/releases) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tyki6/rawsec_cli)](https://github.com/tyki6/rawsec_cli/releases) [![Documentation Status](https://readthedocs.org/projects/rawsec_cli/badge/?version=latest)](https://rawsec_cli.readthedocs.io/en/latest/?badge=latest) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/mBouamama/rawsec_cli) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/tyki6/rawsec_cli) [![docstr_coverage](./img/docstr_coverage_badge.svg)](https://github.com/HunterMcGushion/docstr_coverage.git) -[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/mBouamama/rawsec_cli/main.svg)](https://results.pre-commit.ci/latest/github/mBouamama/rawsec_cli/main) -[![codecov](https://codecov.io/gh/mBouamama/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z)](https://codecov.io/gh/mBouamama/rawsec_cli) -[![Updates](https://pyup.io/repos/github/mBouamama/rawsec_cli/shield.svg)](https://pyup.io/repos/github/mBouamama/rawsec_cli/) -[![Known Vulnerabilities](https://snyk.io/test/github/mBouamama/rawsec_cli/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/mBouamama/rawsec_cli?targetFile=requirements.txt) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/tyki6/rawsec_cli/main.svg)](https://results.pre-commit.ci/latest/github/tyki6/rawsec_cli/main) +[![codecov](https://codecov.io/gh/tyki6/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z)](https://codecov.io/gh/tyki6/rawsec_cli) +[![Updates](https://pyup.io/repos/github/tyki6/rawsec_cli/shield.svg)](https://pyup.io/repos/github/tyki6/rawsec_cli/) +[![Known Vulnerabilities](https://snyk.io/test/github/tyki6/rawsec_cli/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/tyki6/rawsec_cli?targetFile=requirements.txt) [![Rawsec's CyberSecurity Inventory](https://inventory.raw.pm/img/badges/Rawsec-inventoried-FF5050_flat.svg)](https://inventory.raw.pm/tools.html#rawsec_cli) # Introduction [Rawsec's Cybersecurity](https://inventory.raw.pm/overview.html) Inventory is an inventory with 4 category(Tools, Resources, Ctf Platforms, OS). This cli can search a project,list all projects by category, you can filter your research with option --help for more information. + # Table of Contents + - [Features](#features) - [RoadMap](#roadmap) - [Installation](#installation) @@ -46,20 +49,20 @@ This cli can search a project,list all projects by category, you can filter your To install rawsec-cli, simply use pip: -``` +```bash pip install rawsec-cli ``` To run rawsec-cli from a docker image, run: -``` -docker run -it docker.pkg.github.com/mbouamama/rawsec_cli/rawsec-cli:latest rawsec-cli --help +```bash +docker run -it docker.pkg.github.com/tyki6/rawsec_cli/rawsec-cli:latest rawsec-cli --help ``` To install rawsec-cli, on git: -``` -git clone https://github.com/mBouamama/rawsec_cli.git +```bash +git clone https://github.com/tyki6/rawsec_cli.git cd ./rawsec_cli pip install -r requirements.txt python setup.py install @@ -67,7 +70,7 @@ python setup.py install To install rawsec-cli on BlackArch: -``` +```bash pacman -S rawsec-cli ``` @@ -84,13 +87,13 @@ If your research containing only 1 Result, rawsec will open a new brower tab red You can search by key word, you will see all projects with jwt in their description or name: -``` +```bash rawsec-cli search jwt ``` You can search a project, if the Search containing 1 result you will see result in console, and a tab is opened on your browser with redirect to website if informed or source: -``` +```bash rawsec-cli search myjwt ``` @@ -117,20 +120,24 @@ You can list all tools by tool's category. ``` Category available: + adversary_simulation binary_exploitation bug_bounty cloud code_analysis - collaboration_report + collaboration_and_report configuration_audit cracking + crisis_management cryptography + defensive digital_forensics - honeypot_decoy + hardware + honeypot_and_decoy incident_response intentionally_vulnerable_applications networking - osint + osint_and_reconnaissance other plugins red_teaming @@ -147,13 +154,13 @@ Category available: List all tools: -``` +```bash rawsec-cli list tools ``` List all [binary exploitation tools](#toolss-category): - ``` +```bash rawsec-cli list tools binary_exploitation ``` @@ -165,11 +172,11 @@ You can list all tools by Resources's category. ``` Category available: - bug_bounty_and_disclosure_platforms + bug_bounty_pentest_and_disclosure_platforms challenges_platforms cve events - information + information_news_blog knowledge_and_tools national_security_agencies_and_services non_english @@ -182,13 +189,13 @@ Category available: List all resources: -``` +```bash rawsec-cli list resources ``` List all [events resources](#resourcess-category): - ``` +```bash rawsec-cli list resources events ``` @@ -209,12 +216,13 @@ Category available: List all ctf: -``` +```bash rawsec-cli list ctf ``` List all [attack_defense ctf](#ctfs-category): -``` + +```bash rawsec-cli list ctf attack_defense ``` @@ -235,23 +243,27 @@ Category available: List all os: -``` +```bash rawsec-cli list os ``` List all [maintained os](#oss-category): -``` + +```bash rawsec-cli list os maintained ``` ## Options + ## rawsec-cli + | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| | -V, --version | None | show version. | | -h, --help | None | Show help message and exit. | ## search + | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| | -l, --lang | language | Filter by Language | @@ -265,7 +277,9 @@ rawsec-cli list os maintained | -h, --help | None | Show search help message and exit. | ## list + ### tools + | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| | -l, --lang | language | Filter by Language | @@ -279,6 +293,7 @@ rawsec-cli list os maintained | -h, --help | None | Show list tools help message and exit. | ### resources + | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| | -p, --paid | None | Filter by Price, when price is equal to paid | @@ -288,6 +303,7 @@ rawsec-cli list os maintained | -h, --help | None | Show list resources help message and exit. | ### ctf + | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| | -l, --lang | language | Filter by Language | @@ -298,6 +314,7 @@ rawsec-cli list os maintained | -h, --help | None | Show list ctf help message and exit. | ### os + | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| | -b, --base | Text | Filter by base(ex: Linux) | @@ -307,11 +324,11 @@ rawsec-cli list os maintained # Download -Check github releases. Latest is available at https://github.com/mBouamama/rawsec_cli/releases/latest +Check github releases. Latest is available at https://github.com/tyki6/rawsec_cli/releases/latest # Thanks -See [THANKS.md](https://github.com/mBouamama/rawsec_cli/blob/master/THANKS.md). +See [THANKS.md](https://github.com/tyki6/rawsec_cli/blob/master/THANKS.md). # Contribute @@ -327,4 +344,4 @@ I will check as Soon as Possible. The log's become rather long. It moved to its own file. -See [CHANGES](https://github.com/mBouamama/rawsec_cli/blob/master/CHANGELOG.md). +See [CHANGES](https://github.com/tyki6/rawsec_cli/blob/master/CHANGELOG.md). diff --git a/docs/source/changelog.md b/docs/source/changelog.md index fc655a3..e1cb2be 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -1,19 +1,30 @@ # Changelog + All notable changes to this project will be documented in this file. + ## [1.2.0] - 05-07-2021 + ### Changed + - architecture change #203 - new package + ### Added + - better output - color output - list output + ## [1.1.1] - 19-12-2020 + ### Changed + - docker img ## [1.1.0] - 19-12-2020 + ### Added + - Output format: json, csv, txt - output format option - output-file option @@ -21,7 +32,9 @@ All notable changes to this project will be documented in this file. - category list - pull_request templates - new table display + ### Changed + - CI/CD - CODE_OF_CONDUCT - codecov conf @@ -31,7 +44,9 @@ All notable changes to this project will be documented in this file. - api doc ## [1.0.0] - 08-12-2020 + ### Added + - search - list - documentation diff --git a/docs/source/index.rst b/docs/source/index.rst index 4801620..ad1f2c3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,8 +5,8 @@ Rawsec Cli ================================= -.. image:: https://github.com/mBouamama/rawsec_cli/workflows/Unit%20Test/badge.svg - :target: https://github.com/mBouamama/rawsec_cli +.. image:: https://github.com/tyki6/rawsec_cli/workflows/Unit%20Test/badge.svg + :target: https://github.com/tyki6/rawsec_cli .. image:: https://img.shields.io/pypi/v/rawsec-cli :target: https://pypi.org/project/rawsec-cli/ @@ -14,27 +14,27 @@ Rawsec Cli .. image:: https://img.shields.io/pypi/pyversions/rawsec-cli.svg :target: https://pypi.org/project/rawsec-cli/ -.. image:: https://results.pre-commit.ci/badge/github/mBouamama/rawsec_cli/main.svg - :target: https://results.pre-commit.ci/latest/github/mBouamama/rawsec_cli/main +.. image:: https://results.pre-commit.ci/badge/github/tyki6/rawsec_cli/main.svg + :target: https://results.pre-commit.ci/latest/github/tyki6/rawsec_cli/main :alt: pre-commit.ci status .. image:: https://pepy.tech/badge/rawsec-cli :target: https://pepy.tech/project/rawsec-cli -.. image:: https://pyup.io/repos/github/mBouamama/rawsec_cli/shield.svg - :target: https://pyup.io/repos/github/mBouamama/rawsec_cli/ +.. image:: https://pyup.io/repos/github/tyki6/rawsec_cli/shield.svg + :target: https://pyup.io/repos/github/tyki6/rawsec_cli/ .. image:: https://img.shields.io/pypi/l/rawsec-cli.svg :target: https://pypi.org/project/rawsec-cli/ -.. image:: https://codecov.io/gh/mBouamama/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z - :target: https://codecov.io/gh/mBouamama/rawsec_cli +.. image:: https://codecov.io/gh/tyki6/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z + :target: https://codecov.io/gh/tyki6/rawsec_cli .. image:: /../../img/docstr_coverage_badge.svg :target: https://github.com/HunterMcGushion/docstr_coverage.git -.. image:: https://snyk.io/test/github/mBouamama/rawsec_cli/badge.svg?targetFile=requirements.txt - :target: https://snyk.io/test/github/mBouamama/rawsec_cli?targetFile=requirements.txt +.. image:: https://snyk.io/test/github/tyki6/rawsec_cli/badge.svg?targetFile=requirements.txt + :target: https://snyk.io/test/github/tyki6/rawsec_cli?targetFile=requirements.txt .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black @@ -49,8 +49,8 @@ This cli can search a project,list all projects by category, you can filter your Getting help -------- -If the Documentation doesn’t answer your question, you can discuss rawsec-cli or get help using it on `Rawsec-cli's repository discussion `_. -Bug reports are gladly accepted at the `GitHub issue tracker `_. GitHub also hosts the `code repository `_. +If the Documentation doesn’t answer your question, you can discuss rawsec-cli or get help using it on `Rawsec-cli's repository discussion `_. +Bug reports are gladly accepted at the `GitHub issue tracker `_. GitHub also hosts the `code repository `_. More information diff --git a/docs/source/installation.md b/docs/source/installation.md index be47797..72ff8b2 100644 --- a/docs/source/installation.md +++ b/docs/source/installation.md @@ -1,16 +1,21 @@ # Installation -To install rawsec, simply use pip: -``` + +To install rawsec-cli, simply use pip: + +```bash pip install rawsec-cli ``` -To run rawsec from a docker image, run: -``` -docker run -it docker.pkg.github.com/mbouamama/rawsec_cli/rawsec-cli:latest rawsec-cli --help -``` -To install rawsec, on git: +To run rawsec-cli from a docker image, run: + +```bash +docker run -it docker.pkg.github.com/tyki6/rawsec_cli/rawsec-cli:latest rawsec-cli --help ``` -git clone https://github.com/mBouamama/rawsec_cli.git + +To install rawsec-cli, on git: + +```bash +git clone https://github.com/tyki6/rawsec_cli.git cd ./rawsec_cli pip install -r requirements.txt python setup.py install @@ -18,7 +23,7 @@ python setup.py install To install rawsec-cli on BlackArch: -``` +```bash pacman -S rawsec-cli ``` diff --git a/docs/source/options.md b/docs/source/options.md index a874e8e..cb66baf 100644 --- a/docs/source/options.md +++ b/docs/source/options.md @@ -1,16 +1,17 @@ ## Options -## Rawsec-cli + +## rawsec-cli | command | type | description | -| ------------------ |: -------------:| --------------------------------------------------------:| +| ------------------ | -------------- | ---------------------------------------------------------| | -V, --version | None | show version. | | -h, --help | None | Show help message and exit. | -## Search +## search | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| -| -l, --lang | None | Filter by Language | +| -l, --lang | language | Filter by Language | | -p, --paid | None | Filter by Price, when price is equal to paid | | -f, --free | None | Filter by Price, when price is equal to free | | -on, --online | None | Filter by Online, when online is equal to true | @@ -20,12 +21,13 @@ | -of, --output-file | file path | Output file name if you want. | | -h, --help | None | Show search help message and exit. | -## List -### Tools +## list + +### tools | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| -| -l, --lang | None | Filter by Language | +| -l, --lang | language | Filter by Language | | -p, --paid | None | Filter by Price, when price is equal to paid | | -f, --free | None | Filter by Price, when price is equal to free | | -on, --online | None | Filter by Online, when online is equal to true | @@ -35,7 +37,7 @@ | -of, --output-file | file path | Output file name if you want. | | -h, --help | None | Show list tools help message and exit. | -### Resources +### resources | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| @@ -45,18 +47,18 @@ | -of, --output-file | file path | Output file name if you want. | | -h, --help | None | Show list resources help message and exit. | -### Ctf +### ctf | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| -| -l, --lang | None | Filter by Language | +| -l, --lang | language | Filter by Language | | -p, --paid | None | Filter by Price, when price is equal to paid | | -f, --free | None | Filter by Price, when price is equal to free | | -o, --output | list, json,csv,table | Output format | | -of, --output-file | file path | Output file name if you want. | | -h, --help | None | Show list ctf help message and exit. | -### Os +### os | command | type | description | | ------------------ | -------------- | ---------------------------------------------------------| diff --git a/docs/source/usage.md b/docs/source/usage.md index 51880f8..04cde10 100644 --- a/docs/source/usage.md +++ b/docs/source/usage.md @@ -1,20 +1,30 @@ # Usage + ## Search + Search command can be used for searching Tools, Resources, Ctf Platforms, OS. All projects will be displayed on a tab . If your research containing only 1 Result, rawsec will open a new brower tab redirect to source project or website if exist. -### Examples + +### Examples: + You can search by key word, you will see all projects with jwt in their description or name: -``` + +```bash rawsec-cli search jwt ``` You can search a project, if the Search containing 1 result you will see result in console, and a tab is opened on your browser with redirect to website if informed or source: -``` + +```bash rawsec-cli search myjwt ``` + ## List + You can list all projects by category. + ### Category List + ``` rawsec-cli list output: @@ -23,26 +33,33 @@ output: resources tools ``` + ### Tools + You can list all tools by tool's category. #### Tools's Category + ``` Category available: + adversary_simulation binary_exploitation bug_bounty cloud code_analysis - collaboration_report + collaboration_and_report configuration_audit cracking + crisis_management cryptography + defensive digital_forensics - honeypot_decoy + hardware + honeypot_and_decoy incident_response intentionally_vulnerable_applications networking - osint + osint_and_reconnaissance other plugins red_teaming @@ -53,29 +70,35 @@ Category available: vulnerability_assessment web_application_exploitation wireless - ``` -#### Examples + +#### Examples: + List all tools: -``` + +```bash rawsec-cli list tools ``` List all [binary exploitation tools](#toolss-category): - ``` + +```bash rawsec-cli list tools binary_exploitation ``` + ### Resources + You can list all tools by Resources's category. #### Resources's Category + ``` Category available: - bug_bounty_and_disclosure_platforms + bug_bounty_pentest_and_disclosure_platforms challenges_platforms cve events - information + information_news_blog knowledge_and_tools national_security_agencies_and_services non_english @@ -83,53 +106,71 @@ Category available: tutorials writeups_collections_and_challenges_source ``` -#### Examples + +#### Examples: + List all resources: -``` + +```bash rawsec-cli list resources ``` List all [events resources](#resourcess-category): - ``` + +```bash rawsec-cli list resources events ``` + ### CTF + You can list all ctf by ctf's category. #### CTF's Category + ``` Category available: attack_defense hybrid jeopardy ``` -#### Examples + +#### Examples: + List all ctf: -``` + +```bash rawsec-cli list ctf ``` List all [attack_defense ctf](#ctfs-category): - ``` + +```bash rawsec-cli list ctf attack_defense ``` + ### OS + You can list all tools by OS's category. #### OS's Category + ``` Category available: maintained no_more_maintained project_transferred ``` -#### Examples + +#### Examples: + List all os: -``` + +```bash rawsec-cli list os ``` List all [maintained os](#oss-category): - ``` + +```bash rawsec-cli list os maintained ``` diff --git a/setup.py b/setup.py index 2ba330b..5100247 100644 --- a/setup.py +++ b/setup.py @@ -43,12 +43,12 @@ setuptools.setup( name="rawsec-cli", version=version, - author="mBouamama", + author="tyki6", author_email="matthieubouamama@gmail.com", description="Cli for searching tools & resources on rawsec's CyberSecrity Inventory", long_description=long_description, long_description_content_type="text/markdown", - url="https://github.com/mBouamama/rawsec_cli", + url="https://github.com/tyki6/rawsec_cli", install_requires=install_requires, entry_points={"console_scripts": ["rawsec-cli = rawsec_cli.cli.cli:cli"]}, extras_require={"dev": dev_requires, "docs": docs_requires}, diff --git a/tests/cli/command/test_list_command.py b/tests/cli/command/test_list_command.py index 049ac92..c00c86a 100644 --- a/tests/cli/command/test_list_command.py +++ b/tests/cli/command/test_list_command.py @@ -130,7 +130,7 @@ def test_list_os(): assert result.exit_code == 0 -# https://github.com/mBouamama/rawsec_cli/issues/17 +# https://github.com/tyki6/rawsec_cli/issues/17 def test_list_os_project_transferred(): """test searchOs function when category is project_transferred""" result = CliRunner().invoke(