CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

21.10.0 (unreleased)

Added

• Add method to validate port lists. #393 #395

Changed

• Use better defaults for file paths and permissions #429
• Downgrade required version for psutil to 5.5.1 #453

Deprecated

Removed

Fixed

• Fix resume scan. #464
• Fix get_status. Backport #471.#472

[21.4.3] - 2021-08-04

Changed

• Set Log Timestamp to UTC. #394
• Stopping scan. #432

Deprecated

Fixed

Removed

• Remove dry run from ospd. #402

21.4.0 (unreleased)

Added

• Add target option for supplying dedicated port list for alive detection (Boreas only) via OSP. #323
• Add target option for supplying alive test methods via separate elements. #329

Changed

• Use better defaults for file paths and permissions #429

Removed

• Remove python3.5 support and deprecated methods. #316

[20.8.3] (Unreleased)

Added

Changed

Deprecated

Removed

Fixed

• Do not start all queued scans simultaneously once available memory is enough. #401
• Remove the pid file if there is no process for the pid or the process name does not match. #405
• Fix regex of gvmcg titles for get_performance command. #413

20.8.2 (2021-02-01)

Added

• Allow the scanner to update total count of hosts. #332
• Add more debug logging. #352
• Set end_time for interrupted scans. #353
• Add method to get a single host scan progress. #363

Fixed

• Fix OSP version. #326
• Use empty string instead of None for credential. #335
• Fix target_to_ipv4_short(). #338
• Fix malformed target. #341
• Initialize end_time with create_scan. #354
• Fix get_count_total(). Accept -1 value set by the server. #355
• Fix get_count_total(). Consider 0 value set by the server. #366
• Remove exclude hosts which do not belong to the target for the scan progress calculation. #377 #380

20.8.1 (2020-08-12)

Fixed

• Fix deploy and upload to pypi. #312
• Fix metadata for Python wheel distributable #313

20.8.0 (2020-08-11)

Added

• Add solution method to solution of vt object. #166
• Add wait_for_children(). #167
• Extend osp to accept target options. #194
• Accept reverse_lookup_only and reverse_lookup_unify target's options. #195
• Add 'total' and 'sent' attributes to element for <get_vts> cmd response. #206
• Add new get_memory_usage command. #207
• Add lock-file-dir configuration option. #218
• Add details attribute to get_vts command. #222
• Add pontos as dev dependency for managing the version information in ospd #254
• Add more info about scan progress with progress attribute in get_scans cmd. #266
• Add support for scan queuing #278 #279 #281
• Extend results with optional argument URI #282
• Add new scan status INTERRUPTED. #288 #289
• Extend get_vts with attribute version_only and return the version #291
• Allow to set all openvas parameters which are not strict openvas only parameters via osp. #301

Changes

• Modify init() method and use new syntax for super(). #186
• Create data manager and spawn new process to keep the vts dictionary. #191
• Update daemon start sequence. Run daemon.check before daemon.init now. #197
• Improve get_vts cmd response, sending the vts piece by piece.#201
• Start the server before initialize to respond to the client.#209
• Use an iterator to get the vts when get_vts cmd is called. #216
• Update license to AGPL-3.0+ #241
• Replaced pipenv with poetry for dependency management. poetry install works a bit different then pipenv install. It installs dev packages by default and also ospd in editable mode. This means after running poetry install ospd will directly be importable in the virtual python environment. #252
• Progress bar calculation does not take in account the dead hosts. #266
• Show progress as integer for get_scans. #269
• Make scan_id attribute mandatory for get_scans. #270
• Ignore subsequent SIGINT once inside exit_cleanup(). #273
• Simplify start_scan() #275
• Make ospd-openvas to shut down gracefully #302 #307
• Do not add all params which are in the OSPD_PARAMS dict to the params which are set as scan preferences. #305

Fixed

• Fix stop scan. Wait for the scan process to be stopped before delete it from the process table. #204
• Fix get_scanner_details(). #210
• Fix thread lib leak using daemon mode for python 3.7. #272
• Fix scan progress in which all hosts are dead or excluded. #295
• Stop all running scans before exiting #303
• Fix start of parallel queued task. #304
• Strip trailing commas from the target list. #306

Removed

• Remove support for resume task. #266

2.0.1

Added

• Add clean_forgotten_scans(). #171
• Extend OSP with finished_hosts to improve resume task. #177

Changed

• Set loglevel to debug for some message. #159
• Improve error handling when stop a scan. #163
• Check the existence and status of an scan_id. #179

Fixed

• Fix set permission in unix socket. #157
• Fix VT filter. #165
• Remove from exclude_host list the hosts passed as finished too. #183

[2.0.0] (2019-10-11)

Added

• Add OSP command get_vts and the vts dictionary. #12 #60 #72 #73 #93
• Add optional custom elements for VT information. #15
• Allow clients to choose TLS versions > 1.0. #18
• Add element "vts" to parameters for starting scans. #19 #26
• Add dummy stop_scan method to be implemented in the wrapper. #24 #53 #129
• Extend OSP command get_vts with vt_params. #28
• Add vt_selection to start_scan command. #31 #58 #105
• Add support for multi-target task adding targets with their own port list, credentials and host list to start_scan command. #34 #38 #39 #41) #127 #134
• Add support for parallel scans. #42 #142
• Add functions for port manipulation. #44
• Add as subelement of in <start_scan>. #45
• Add pop_results attribute to <get_scans>. #46
• Add methods to set and get the vts feed version. #79
• Add cvss module. #88
• Add filter option to OSP get_vts command. #94
• Allows to set the logging domain from the wrapper. #97
• Add option for logging into a specified log file. #98
• Add option for logging into a specified log file. #98
• Add scans status to improve the progress and add support to resume tasks. #100 #101 #102 #103
• Add support for exclude hosts. #107
• Add hostname attribute to results. #108
• Add the --niceness option. #109
• Add support for configuration file. #122
• Add option to set unix socket mode permission. #123
• Add pid file creation to avoid having two daemons. #126 #128
• Add OSP <get_performance> command. #131 #137
• Add method to check if a target finished cleanly or crashed. #133
• Add the --stream-timeout option to configure the socket timeout. #136
• Add support to handle multiple requests simultaneously. #136, #139

Changed

• Improve documentation.
• Improve Unittest.
• Send the response data in block of given length instead of sending all at once. #35
• Makes the socket a non-blocking socket. #78
• Refactor misc. #111
• Refactor error module. #95 #112
• Refactor ospd connection handling. #114
• Use ordered dictionary to maintain the results order. #119
• Refactor ospd. #120
• Set default unix socket path to /var/run/ospd/ospd.sock and default pid file path to /var/run/ospd.pid. #140
• Do not add a host detail result with the host status. #145
• Do not log the received command. #151

Fixed

• Fix scan progress. #47
• Documentation has been improved.
• Improve connection handling. #80
• Fix target_to_ipv4_short(). #99
• Handle write error if the client disconnects abruptly. #135
• Improve error handling when sending data. #147
• Fix classifier in setup.py. #154

[1.3] (2018-06-05)

Added

• Support for unix sockets has been added.

Removed

• OSP has been renamed to Open Scanner Protocol.

Changed

• Support Python 3 only.
• Documentation has been updated.