secator 0.3.6__tar.gz → 0.4.0__tar.gz

{secator-0.3.6 → secator-0.4.0}/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## [0.4.0](https://github.com/freelabz/secator/compare/v0.3.6...v0.4.0) (2024-04-27)
+
+
+### Features
+
+* `nuclei` - add "meta" items to extra_data ([#329](https://github.com/freelabz/secator/issues/329)) ([d986e01](https://github.com/freelabz/secator/commit/d986e01ed10bfd58c57565e24f053cf4ffb165b5))
+* add offline mode ([#314](https://github.com/freelabz/secator/issues/314)) ([6b55e99](https://github.com/freelabz/secator/commit/6b55e99a9e60a102afaf71a49148a8aec1b2e3dc))
+* add secator configuration loader ([#313](https://github.com/freelabz/secator/issues/313)) ([9b9ab7b](https://github.com/freelabz/secator/commit/9b9ab7b1c394bd77c986fcb755d19d1b887228cf))
+
+
+### Bug Fixes
+
+* add alias for config command and reload help screenshot ([#324](https://github.com/freelabz/secator/issues/324)) ([3dbc9ad](https://github.com/freelabz/secator/commit/3dbc9adf7a3b12dbf5bdcaa2224297d58b1e2fd8))
+* add nmap --top-ports option ([#339](https://github.com/freelabz/secator/issues/339)) ([6352be7](https://github.com/freelabz/secator/commit/6352be7350890c38e521d98b89e7e634ed8c8684))
+* add redis addon missing warning on celery worker ([#310](https://github.com/freelabz/secator/issues/310)) ([c0afc3a](https://github.com/freelabz/secator/commit/c0afc3a068140f9811845c05c8d3763d932407de))
+* better vuln detection ([#349](https://github.com/freelabz/secator/issues/349)) ([150b603](https://github.com/freelabz/secator/commit/150b6030e6702f599b8a67ba53bef4c2e675e90a))
+* **config:** broken list values with 0 or 1 element ([#364](https://github.com/freelabz/secator/issues/364)) ([7ef7a5e](https://github.com/freelabz/secator/commit/7ef7a5e27604df53868d2b670439a0a7150e8af1))
+* **docker:** pull remote DockerHub images in Compose ([#363](https://github.com/freelabz/secator/issues/363)) ([dce6d8a](https://github.com/freelabz/secator/commit/dce6d8a5d722aa85c1fc2592f44738b6bfe79b04))
+* grype integration test ([#327](https://github.com/freelabz/secator/issues/327)) ([33ddb84](https://github.com/freelabz/secator/commit/33ddb84836965c4bff6fd442c317de240e54ec3f))
+* minor config tweaks ([#360](https://github.com/freelabz/secator/issues/360)) ([4631024](https://github.com/freelabz/secator/commit/46310245afe0b0d04a6b333175f28ffeab1659bb))
+* next steps highlight ([#326](https://github.com/freelabz/secator/issues/326)) ([528c715](https://github.com/freelabz/secator/commit/528c715e4f20bceb9dbae85e99b707243d556aea))
+* proper local file naming for sudo_killer.zip ([#330](https://github.com/freelabz/secator/issues/330)) ([f7e563f](https://github.com/freelabz/secator/commit/f7e563f3a4a20fd38f7167e2bd682ddb3eea6224))
+* query CVEs without CPE match ([#321](https://github.com/freelabz/secator/issues/321)) ([d02e09c](https://github.com/freelabz/secator/commit/d02e09cc379afa85df25227f6c0bab4496031d78))
+* switch payload sudo_killer to zip ([#318](https://github.com/freelabz/secator/issues/318)) ([2a92dc8](https://github.com/freelabz/secator/commit/2a92dc8d4a71cce71a85bb77747b8af2d5aed6c4))
+* task description in remote mode ([#344](https://github.com/freelabz/secator/issues/344)) ([1140611](https://github.com/freelabz/secator/commit/1140611a1129c19bd306db33396ea3fa1bc88f25))
+* truncated pickle error ([#334](https://github.com/freelabz/secator/issues/334)) ([663af17](https://github.com/freelabz/secator/commit/663af1777d07c7628a220ee627aece9fc83e6095))
+
+
+### Documentation
+
+* add VHS demo ([#293](https://github.com/freelabz/secator/issues/293)) ([70454a6](https://github.com/freelabz/secator/commit/70454a60053ef6ce3002565c07ede7b00b14e335))
+* update README.md ([a0a19fb](https://github.com/freelabz/secator/commit/a0a19fb24cd297e98cb8716e691ed6fcf11475c6))
+* update README.md ([341f5b8](https://github.com/freelabz/secator/commit/341f5b8cd049fd8e33ebfb525de0377d0a659df2))
+* Update README.md ([98c986c](https://github.com/freelabz/secator/commit/98c986c644bbe62434c0a2fe72fe9eea606c2e8d))
+
 ## [0.3.6](https://github.com/freelabz/secator/compare/v0.3.5...v0.3.6) (2024-04-17)
 
 

{secator-0.3.6 → secator-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: secator
-Version: 0.3.6
+Version: 0.4.0
 Summary: The pentester's swiss knife.
 Project-URL: Homepage, https://github.com/freelabz/secator
 Project-URL: Issues, https://github.com/freelabz/secator/issues
@@ -29,11 +29,13 @@ Requires-Dist: humanize<5
 Requires-Dist: ifaddr<1
 Requires-Dist: jinja2<4
 Requires-Dist: packaging<25
+Requires-Dist: pydantic<3
 Requires-Dist: python-dotenv<2
 Requires-Dist: pyyaml<7
 Requires-Dist: requests<3
 Requires-Dist: rich-click<1.7
 Requires-Dist: rich<14
+Requires-Dist: typing-extensions<5
 Requires-Dist: validators<1
 Requires-Dist: xmltodict<1
 Provides-Extra: build
@@ -90,7 +92,7 @@ and it is designed to improve productivity for pentesters and security researche
 
 # Features
 
-![](images/short_demo.gif)
+![](images/demo.gif)
 
 * **Curated list of commands**
 
@@ -177,14 +179,18 @@ wget -O - https://raw.githubusercontent.com/freelabz/secator/main/scripts/instal
 	<summary>Docker</summary>
 
 ```sh
-docker run -it --rm --net=host -v $HOME/.secator:/root/.secator freelabz/secator --help
+docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator --help
 ```
 
-The volume mount `-v` is necessary to save all `secator` reports to your host machine.
+The volume mount -v is necessary to save all secator reports to your host machine, and--net=host is recommended to grant full access to the host network.
 
-You can set up an alias to facilitate running `secator` from Docker:
+You can alias this command to run it easier:
 ```sh
-alias secator="docker run -it --rm --net=host -v $HOME/.secator:/root/.secator freelabz/secator"
+alias secator="docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator"
+```
+
+Now you can run secator like if it was installed on baremetal:
+```
 secator --help
 ```
 

{secator-0.3.6 → secator-0.4.0}/README.md

@@ -29,7 +29,7 @@ and it is designed to improve productivity for pentesters and security researche
 
 # Features
 
-![](images/short_demo.gif)
+![](images/demo.gif)
 
 * **Curated list of commands**
 
@@ -116,14 +116,18 @@ wget -O - https://raw.githubusercontent.com/freelabz/secator/main/scripts/instal
 	<summary>Docker</summary>
 
 ```sh
-docker run -it --rm --net=host -v $HOME/.secator:/root/.secator freelabz/secator --help
+docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator --help
 ```
 
-The volume mount `-v` is necessary to save all `secator` reports to your host machine.
+The volume mount -v is necessary to save all secator reports to your host machine, and--net=host is recommended to grant full access to the host network.
 
-You can set up an alias to facilitate running `secator` from Docker:
+You can alias this command to run it easier:
 ```sh
-alias secator="docker run -it --rm --net=host -v $HOME/.secator:/root/.secator freelabz/secator"
+alias secator="docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator"
+```
+
+Now you can run secator like if it was installed on baremetal:
+```
 secator --help
 ```
 

secator-0.4.0/images/demo.tap

@@ -0,0 +1,47 @@
+secator --help
+clear
+
+# Run tasks ...
+secator x katana http://testphp.vulnweb.com -rl 100 -timeout 10 -header Accept:text/html
+clear
+
+# ... with mutualized input options and output types !
+Up 3
+Left 72
+Backspace 6
+dirsearch # noenter
+
+Up 1
+Backspace 9
+cariddi # noenter
+
+Up 1
+Backspace 7
+feroxbuster # nowait
+Sleep 5s
+Ctrl+C
+Sleep 3s
+
+Up 1
+Left 72
+Backspace 11
+nmap # noenter
+Right 8
+Backspace 7
+Right 19
+Space 1
+-p 80,443 # noenter
+Right 45
+Backspace 25
+Sleep 2s
+Enter
+Wait
+Sleep 3s
+clear
+
+# Run workflows ...
+secator w host_recon --help
+
+Up 1
+Backspace 6
+localhost -rl 1000 -ss -p 6379,8080 -tid redis-info,exposed-redis,CVE-2021-44228

{secator-0.3.6 → secator-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "secator"
-version = "0.3.6"
+version = "0.4.0"
 authors = [{ name = "FreeLabz", email = "sales@freelabz.com" }]
 readme = "README.md"
 description = "The pentester's swiss knife."
@@ -42,9 +42,11 @@ dependencies = [
   "packaging < 25",
   "python-dotenv < 2",
   "pyyaml < 7",
+  "pydantic < 3",
   "requests < 3",
   "rich < 14",
   "rich-click < 1.7",
+  "typing_extensions < 5",
   "validators < 1",
   "xmltodict < 1"
 ]

{secator-0.3.6 → secator-0.4.0}/scripts/stories/STORY.md

@@ -60,9 +60,9 @@ secator z default mydomain.com --worker
 **Callbacks (library mode):**
 ```py
 from secator.runners import Workflow
-from secator.config import ConfigLoader
+from secator.template import TemplateLoader
 
-config = ConfigLoader(name='workflows/host_recon')
+config = TemplateLoader(name='workflows/host_recon')
 hooks = {
 	Task: {
 		'on_item': {

{secator-0.3.6 → secator-0.4.0}/secator/celery.py

@@ -9,12 +9,7 @@ from celery.result import AsyncResult, allow_join_result
 # from pyinstrument import Profiler  # TODO: make pyinstrument optional
 from rich.logging import RichHandler
 
-from secator.definitions import (CELERY_BROKER_CONNECTION_TIMEOUT,
-								 CELERY_BROKER_POOL_LIMIT, CELERY_BROKER_URL,
-								 CELERY_BROKER_VISIBILITY_TIMEOUT,
-								 CELERY_DATA_FOLDER,
-								 CELERY_OVERRIDE_DEFAULT_LOGGING,
-								 CELERY_RESULT_BACKEND, DEBUG)
+from secator.config import CONFIG
 from secator.rich import console
 from secator.runners import Scan, Task, Workflow
 from secator.runners._helpers import run_extractors
@@ -33,7 +28,7 @@ logging.basicConfig(
 	handlers=[rich_handler],
 	force=True)
 logging.getLogger('kombu').setLevel(logging.ERROR)
-logging.getLogger('celery').setLevel(logging.INFO if DEBUG > 6 else logging.WARNING)
+logging.getLogger('celery').setLevel(logging.INFO if CONFIG.debug.level > 6 else logging.WARNING)
 
 logger = logging.getLogger(__name__)
 
@@ -49,19 +44,19 @@ app.conf.update({
 	'worker_max_tasks_per_child': 10,
 
 	# Broker config
-	'broker_url': CELERY_BROKER_URL,
+	'broker_url': CONFIG.celery.broker_url,
 	'broker_transport_options': {
-		'data_folder_in': CELERY_DATA_FOLDER,
-		'data_folder_out': CELERY_DATA_FOLDER,
-		'control_folder': CELERY_DATA_FOLDER,
-		'visibility_timeout': CELERY_BROKER_VISIBILITY_TIMEOUT,
+		'data_folder_in': CONFIG.dirs.celery_data,
+		'data_folder_out': CONFIG.dirs.celery_data,
+		'control_folder': CONFIG.dirs.celery_data,
+		'visibility_timeout': CONFIG.celery.broker_visibility_timeout,
 	},
 	'broker_connection_retry_on_startup': True,
-	'broker_pool_limit': CELERY_BROKER_POOL_LIMIT,
-	'broker_connection_timeout': CELERY_BROKER_CONNECTION_TIMEOUT,
+	'broker_pool_limit': CONFIG.celery.broker_pool_limit,
+	'broker_connection_timeout': CONFIG.celery.broker_connection_timeout,
 
 	# Backend config
-	'result_backend': CELERY_RESULT_BACKEND,
+	'result_backend': CONFIG.celery.result_backend,
 	'result_extended': True,
 	'result_backend_thread_safe': True,
 	# 'result_backend_transport_options': {'master_name': 'mymaster'}, # for Redis HA backend
@@ -90,7 +85,7 @@ app.autodiscover_tasks(['secator.hooks.mongodb'], related_name=None)
 
 def maybe_override_logging():
 	def decorator(func):
-		if CELERY_OVERRIDE_DEFAULT_LOGGING:
+		if CONFIG.celery.override_default_logging:
 			return signals.setup_logging.connect(func)
 		else:
 			return func
@@ -151,7 +146,7 @@ def break_task(task_cls, task_opts, targets, results=[], chunk_size=1):
 
 @app.task(bind=True)
 def run_task(self, args=[], kwargs={}):
-	if DEBUG > 1:
+	if CONFIG.debug.level > 1:
 		logger.info(f'Received task with args {args} and kwargs {kwargs}')
 	if 'context' not in kwargs:
 		kwargs['context'] = {}
@@ -162,7 +157,7 @@ def run_task(self, args=[], kwargs={}):
 
 @app.task(bind=True)
 def run_workflow(self, args=[], kwargs={}):
-	if DEBUG > 1:
+	if CONFIG.debug.level > 1:
 		logger.info(f'Received workflow with args {args} and kwargs {kwargs}')
 	if 'context' not in kwargs:
 		kwargs['context'] = {}
@@ -173,7 +168,7 @@ def run_workflow(self, args=[], kwargs={}):
 
 @app.task(bind=True)
 def run_scan(self, args=[], kwargs={}):
-	if DEBUG > 1:
+	if CONFIG.debug.level > 1:
 		logger.info(f'Received scan with args {args} and kwargs {kwargs}')
 	if 'context' not in kwargs:
 		kwargs['context'] = {}