gsa-7.0.3/000077500000000000000000000000001325671355500123075ustar00rootroot00000000000000gsa-7.0.3/.circleci/000077500000000000000000000000001325671355500141425ustar00rootroot00000000000000gsa-7.0.3/.circleci/config.yml000066400000000000000000000013021325671355500161260ustar00rootroot00000000000000version: 2 jobs: build: docker: - image: wiegandm/gsa-7.0-debian-jessie steps: - run: working_directory: ~/gvm-libs name: Checkout openvas-libraries-9.0 command: git clone --depth 1 https://github.com/greenbone/gvm-libs.git -b openvas-libraries-9.0 - run: working_directory: ~/gvm-libs name: Configure and compile openvas-libraries-9.0 command: pushd gvm-libs && mkdir build && cd build/ && cmake -DCMAKE_BUILD_TYPE=Release .. && make install && popd - checkout - run: name: Configure and Compile command: mkdir build && cd build/ && cmake -DCMAKE_BUILD_TYPE=Release .. && make install gsa-7.0.3/CHANGES000066400000000000000000002173601325671355500133130ustar00rootroot00000000000000SUMMARY OF RELEASE CHANGES FOR GSA ================================== For detailed code changes, please visit https://github.com/greenbone/gsa/commits/gsa-7.0 or get the entire source code repository and view log history: $ git clone https://github.com/greenbone/gsa.git $ cd gsa && git checkout gsa-7.0 && git log gsa 7.0.3 (2018-03-28) This is the third maintenance release of the Greenbone Security Assistant (GSA) 7.0 module for the Open Vulnerability Assessment System release 9 (OpenVAS-9). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. Many thanks to everyone who has contributed to this release: Timo Pollmeier, Matthew Mundell, Hani Behabiles, Bjoern Ricks, Michael Wiegand. Main changes compared to 7.0.2: * An issue which caused saving a scan config to fail under certain circumstances has been addressed. * An issue which caused the users language setting to be reset under certain circumstances has been addressed. * A log message is now written for every successful login. * A number of minor interface issues have been addressed. * The limit on the target host input field has been removed. * Support for responding to a request for 'robots.txt' has been added. * An issue which caused performance problems when deleting overrides has been addressed. * An issue which caused the refresh function to interrupt the access to any gsa menu has been addressed. * An option to resume uncompleted scheduled tasks has been added. * SMB alerts have been added. * Cancelling the loading of a page, dialog, dashboard etc. in GSA can now also cancel the corresponding request to manger, improving performance. * An issue which caused an internal error getting performance info of an unconnected slave has been addressed. * German translations have been updated. * Arabic translations have been updated. * French translations have been updated. * Chinese translations have been updated. * An issue which caused problems where pages reverted to a built in filter has been addressed. * The group selection for users now only shows groups which the current user has permission to add users to. * The HTTP header "Host" now has to be validated against a list of IP addresses and hostnames, which includes localhost and local interface addresses by default. * The new TippingPoint alert method has been added. * Status details to certain error dialogs have been added. * New error message for invalid Host header has been added. * Date pickers in the schedule dialogs now allow setting dates in the past. * Documentation and help have been updated. * An issue with file upload form elements has been fixed. * The performance of the result details has been improved by requesting manager to skip counting the results. gsa 7.0.2 (2017-03-07) This is the second maintenance release of the Greenbone Security Assistant (GSA) 7.0 module for the Open Vulnerability Assessment System release 9 (OpenVAS-9). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release includes just a few smaller improvements. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Timo Pollmeier, Björn Ricks and Michael Wiegand. Main changes compared to 7.0.1: * Improved cookie handling for modern browsers. * Reworked selection dialog for performance graphs. * Updated translations for arabic and portuguese. * Allow multiple --listen for the gsad command line. gsa 7.0.1 (2016-12-27) This is the first maintenance release of the Greenbone Security Assistant (GSA) 7.0 module for the Open Vulnerability Assessment System release 9 (OpenVAS-9). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release includes a number of small changes from the OpenVAS development branch. For a comprehensive list of changes please refer to the list below. Many thanks to everyone who has contributed to this release: Matthew Mundell, Timo Pollmeier, Björn Ricks, Jan-Oliver Wagner and Michael Wiegand. Main changes compared to 7.0.0: * Invalid schedule IDs are now ignored in the tasks gantt chart. * Compatibility with Microsoft Internet Explorer 11 has been greatly improved. * Objects for which the user does not have the necessary permission or for which no instance exists are now properly hidden in the Task Wizard and on the System Reports page. * A potential NULL-pointer use found by static code analysis has been addressed. * Deleting a user no longer leads to a blank page. * Documentation and help have been updated. gsa 7.0.0 (2016-11-09) This is the first release of the Greenbone Security Assistant (GSA) 7.0 module for the Open Vulnerability Assessment System release 9 (OpenVAS-9). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. GSA 7.0 introduces an entirely new layout and style of the user interface. This includes a new dashboard feature as well as numerous new charts. The new GSA also introduces the explicit asset management for hosts and operating systems. Many thanks to everyone who has contributed to this release: Benoît Allard, Hani Benhabiles, Björn Ricks, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes compared to the 6.0 series: * Comprehensively updated user interface with new style and workflows, dialogs and various comfort functions using JS technology. * Introduced configurable dashboards. * Several new charts, from schedule gantt to host network topology. * Explicit asset management for hosts and operating systems. * Built-in CVE Scanner for immediate offline evaluation of assets. * Increased several build dependencies. Main changes compared to 6.1+beta4: * Comprehensive rework of the charts. * Comprehensive rework of the dialogs. * Send filter when creating assets from a report, so that the overrides and min QOD settings are used. * Scanner OMP Slave replaces the Slaves type and require valid TLS certificate. * Reworked I18N support and added first parts of Portuguese, French, Turkish and Arabic. * Changed performance overview to use from-to ranges. * Add "Most vulnerable Operating Systems" chart. * Add alert method SNMP. * Added a global dashboard. * Combine individual feed management pages into a single one. * SCP and verinice credentials now credentials objects. * Added dashboards to more sections. * Add Default CA Cert setting. * Replaced png graphics by svg graphics. * Add support for connecting to Manager over a UNIX socket. * Add command line options --munix-socket and --unix-socket. * Add command line options --http-sts and --http-sts-max-age. * Increase limit of maximum connections per IP. * Increase dependency for gnutls from 2.8 to 3.2.15. * Increase dependency for glib from 2.16 to 2.32. * Increase required cmake version from 2.6 to 2.8. * Numerous minor fixes and improvements. * Some improvements for the logging. * Fixes for UTF-8. * Reduced memory consumption and fixed memory leaks. gsa 6.1+beta4 (2016-04-15) This is the fourth beta release of the upcoming version 6.1 of the Greenbone Security Assistant (GSA). It will be part of the upcoming OpenVAS-9 release. This module is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release addresses an issue which caused the tar ball of gsa 6.1+beta3 to be missing a file, making it impossible to build from the release tar ball. It also improves memory handling during XSL transformations. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner and Michael Wiegand. Main changes since 6.1+beta3: * Update list of files to be ignored for tar balls to avoid accidentally excluding necessary files. * Reduce memory usage during XSL transformations. gsa 6.1+beta3 (2016-04-14) This is the third beta release of the upcoming version 6.1 of the Greenbone Security Assistant (GSA). It will be part of the upcoming OpenVAS-9 release. This module is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release comprehensively updates the user interface style and workflows, using JS technologies for dialogs, widgets and various other elements. Many thanks to everyone who has contributed to this release: Benoît Allard, Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 6.1+beta2: * Replace login and password in slaves with credential and show slaves using a credential on the credential details page. * Replace the Certificate and Private Key in Scanners with a Credential. * Add new alert method 'SCP'. * Split the autogenerate option into "Autogenerate password" and * Add new SNMP credential type. Simplify use of "New Credential" dialog * Add SNMP credentials to targets. * Add new client certificate credential type "Autogenerate SSH key pair". * Add alert conditions for triggering alerts according to result counts matched by a filter. * Add alert event for any SecInfo type. * Add alert method "Send", for sending the report to a TCP listener. * Introduce a icon toolbar for overview and details pages. * Turn Filter section into a toolbar-like compact element. * New, more dynamic method for creating dashboards / chart boxes which makes their size adapt to the screen width, and which also allows editing of dashboards like rearranging, removing and adding of new components and resizing the row heights. * Add task preference for auto deleting reports. * Added links inside charts to respective filters or resources. * Use the new filter syntax for report results in the filter box. * Introduce a new info dialog. * Turned several edit/new pages into dialogs. * Add syncing of OSP scan configs. * Apply PRG pattern across entire GUI. * Reworked login page. * Add --unix-socket option. * Add Radius support for authentication. * Introduce new style for help pages, compatible with the new style of the overview pages. * Get tags working for Assets. * Various code improvements. gsa 6.1+beta2 (2015-10-21) This is the second beta release of the upcoming version 6.1 of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release comprehensively updates the user interface style and workflows, using JS technologies for dialogs, widgets and various other aspects. Also a explicit Asset Management was added for hosts and operating systems. Several new charts were introduced and a considerable number of other new features. Many thanks to everyone who has contributed to this release: Benoît Allard, Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner, Michael Wiegand and Winland Q. Yang Main changes since 6.1+beta1: * New: Hosts and Operating Systems for Asset Management. The previous Hosts menu item is renamed to "Hosts (classic). * New style of the header. * Add new popup dialogs for any "new" and "edit" dialog. * Use of the full width of the browser window. * New layout and interaction scheme of resource list views. * Add jQuery on all pages except the login page. * Add subject and message input for email alerts and allow the use of various variables in the message text. * Various extensions to support OSP 1.0 and first 1.1 features. * Add charts to reports section. * Split any dual form pages into separate ones for using the popup dialogs (for example new/upload combinations). * Add an upload icon to the Reports page header. * New: Credentials type. * Add options to have a user inherit resources from a user being deleted. * Add alert method "Start Task". * Add further charts to tasks section, among this the new gantt chart. * Add charts to Results, among this the new word cloud chart. * Add option to move a Task to a new slave on the details and edit pages. * Add a datepicker to support the date entry for new schedules. * Support IPv6 redirection case. * Add content security headers. * Update of Chinese translation. * Add separate style sheet for login dialog. * Changed handling of translation strings to allow for standard po file management. gsa 6.1+beta1 (2015-07-17) This is the first beta version of the upcoming 6.1 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release -- in combination with the OpenVAS Manager 6.1+beta1 release -- adds support for CVE scanning. It also contains a number of internal improvements and minor bugfixes. Many thanks to everyone who has contributed to this release: Benoît Allard, Hani Benhabiles, Sven Haardiek, Ilmar Habibulin, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 6.0 series: * Support for CVE scanning has been added. * Internal improvements and various minor bugfixes. * Updated documentation. gsa 6.0.1 (2015-04-01) This is the first maintenance release of the Greenbone Security Assistant (GSA) 6.0 module for the Open Vulnerability Assessment System release 8 (OpenVAS-8). This release addresses, apart from various fixes all over the GUI, especially the usability improvement for powerfilters, making the less crowded with standard filter elements. Many thanks to everyone who contributed to this release: Hani Benhabiles, Matthew Mundell, Timo Pollmeier and Michael Wiegand. Main changes compared to 6.0.0: * Moved standard keywords away from the powerfilter string to make the text entry less crowded. The elements are still visible below the entry field and can be specified in the powerfilter in case these should be changed. * Allow access to the Create Permissions page even if the user has limited subject access. * Changed connection timeout to allow for very large report downloads. * Improvements to the package configure and build system. * Various improvements to the online help. * Various minor bugfixes. gsa 6.0.0 (2015-03-17) This is the first release of the Greenbone Security Assistant (GSA) 6.0 module for the Open Vulnerability Assessment System release 8 (OpenVAS-8). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. GSA 6.0 implements all of the new features of the protocol OMP 6.0. This includes scanner management, new user roles and Quality of Detection (QoD) information. The new GSA also introduces support for charts and dashboards as well as bulk actions and contains a number of other new features and improvements. Please see the comprehensive list below for more details. Many thanks to everyone who has contributed to this release: Michal Ambroz, Benoît Allard, Hani Benhabiles, Matthew Mundell, Timo Pollmeier and Michael Wiegand. Main changes compared to the 5.0 series: * Support for configuring OTP and OSP based scanners has been added. The classic OpenVAS Scanner is pre-configured. * Support for displaying charts has been added. * A "SecInfo" dashboard showing 4 charts that can be individually be configured regarding type, object type and filter has been added * A scan configuration editor for the OSP based scanner type "ovaldi" has been added. * Support for the SecInfo object type "CERT-Bund" has been added. * Support for guest user logins has been added. * Support for new "Super Admin" role in Manager has been added. * Support for displaying the "Solution Type" of an NVT has been added. * A "Results" section has been added in the "Scan Management" menu. * Support for modifying the file name format of exported resource lists, resource details and reports has been added. * Support for bulk actions has been added. * A "Modify Task" wizard has been added. * New super permissions for group administration have been added. * Support for editing user names has been added. * Support for handling Quality of Detection (QoD) information has been added. * Support for displaying the success or failure of SSH, SMB and ESXi authentication has been added. * Support for editing of task schedule periods has been added. * A "Backend operation" line is now included in the page footer. This is the time taken to get from the start of the page handler to the start of the XSL transform. * GSA will now use libxslt by default for XSLT processing instead of spawning an external 'xsltproc' process. * Users are now allowed to have multiple simultaneous sessions, as long as the sessions are on different browsers. * Support for adding ESXi credentials to targets has been added. * The public key requirement has been removed from the Credentials creation. * The target locator feature has been removed as this is not being fully supported by the back end anyway. * Support for mixing objects owned by different users has been extended. * The ITS (IT-Schwachstellenampel) face has been updated. * Setting the user timezone is now easier. * Permission handling has been improved. * Powerfilter configuration has been simplified. * Signal handling has been improved. * The auto refresh feature has been improved. * The handling of user groups when dropping privileges has been improved. * Library checks during package configuration have been improved and are now more comprehensive and consistent. * Handling of linker and compiler flags during package configuration has been improved and simplified. * Documentation has been updated. * Numerous small improvements and bugfixes. Main changes compared to 6.0+beta6: * Support for connection timeouts and limits for concurrent connections per IP has been added. * Powerfilter configuration has been simplified. * Support for setting scanner keys and certificates has been added. * Signal handling has been improved. * Documentation has been updated. gsa 6.0+beta6 (2015-02-11) This is the sixth beta version of the upcoming 6.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for displaying OSP scanner details, Quality of Detection (QoD) information and authentication success or failure. It also adds support for editing task schedule periods and improves the display of solution type information and contains a number of other bug fixes and improvements. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 6.0+beta5: * Support for displaying OSP scanner details has been added. * Support for handling Quality of Detection (QoD) information has been added. * Support for displaying the success or failure of SSH, SMB and ESXi authentication has been added. * Support for editing of task schedule periods has been added. * Support for displaying solution types has been improved. * An issue which could cause the GSA session to be terminated prematurely under certain circumstances has been fixed. * An issue which prevented users with the "Super Admin" role from seeing notes and overrides created by other users has been fixed. * An issue which prevented users with the "Super Admin" role from cloning certain objects has been fixed. * Handling of errors caused by incorrect database entries has been improved. * MIME types for forms are now consistent. * Error messages for alerts with missing RFPs have been made more consistent. * Library checks during package configuration have been improved and are now more comprehensive and consistent. * Handling of linker and compiler flags during package configuration has been improved and simplified. * Documentation has been updated. gsa 6.0+beta5 (2015-01-12) This is the fifth beta version of the upcoming 6.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for sharing slaves, bulk actions and a "Modify Task" wizard as well as support for improved group administration and editing user names. It also improves support for OSP scanners and default resource selection in wizards and addresses a number of smaller issues. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 6.0+beta4: * Support for sharing slaves has been added. * Support for bulk actions has been added. * A "Modify Task" wizard has been added. * New super permissions for group administration have been added. * Support for editing user names has been added. * Support for OSP scanners has been improved. * Improved support for default resource selection in wizards. * Support for "Super Admin" role has been improved. * Ensured auto refresh refreshes the correct page. * Handling of solution type information has been improved and made more accessible. * Documentation has been updated. * Numerous small improvements and bugfixes. gsa 6.0+beta4 (2014-11-21) This is the fourth beta version of the upcoming 6.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for the new "Super Admin" role and for displaying NVT solution types and contains a number of smaller improvements. Many thanks to everyone who has contributed to this release: Michael Ambroz, Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 6.0+beta3: * Support for new "Super Admin" role in Manager has been added. * Support for displaying the "Solution Type" of an NVT has been added. * Setting the user timezone is now easier. * Permission handling has been improved. * Handling of the guest token when requesting charts has been improved. * Support for modifying the file name format of exported resource lists, resource details and reports has been added. * The handling of user groups when dropping privileges has been improved. * The build process has been adjusted for changes in OpenVAS Libraries. * GSA is now only linked against libgthread in environments where this is required, i.e. when building with GLib =< 2.30. * Documentation has been updated. * Numerous small improvements and bugfixes. gsa 6.0+beta3 (2014-10-14) This is the third beta version of the upcoming 6.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release makes multiple improvements to various charts, such as adding support for line charts, adding charts to the tasks page and adding support for exporting data as an HTML table. It also changes the default behaviour for XSLT processing from spawning an external process to using libxslt and restores compatibility with older GLib versions. Many thanks to everyone who has contributed to this release: Benoît Allard, Hani Benhabiles, Matthew Mundell, Timo Pollmeier and Michael Wiegand. Main changes since 6.0+beta2: * Support for line charts has been added. * The charts request parameter is now processed for all HTTP GET requests. * Charts have been added to the tasks page. * Support for exporting data as an HTML table has been added to charts. * Numerous cleanups and consolidations for various charts. * GSA will now use libxslt by default for XSLT processing instead of spawning an external 'xsltproc' process. * Compatibility with older GLib versions (2.30 and before) has been restored. * Documentation has been updated. gsa 6.0+beta2 (2014-09-23) This is the second beta version of the upcoming 6.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release introduces support for guest user logins and extends support for multiple scanners. It also allows multiple simultaneous sessions per user and contains a number of other improvements to the user interface. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Michael Meyer, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 6.0+beta1: * Support for guest user logins has been added. * Support for multiple scanners has been improved further. * Users are now allowed to have multiple simultaneous sessions, as long as the sessions are on different browsers. * Support for displaying a "Affected Software/OS" section in the results has been added. * The 'clone' action is now available directly from the details pages. * Support for "NVTs by family" bubble charts has been added. * Selections in drop-down menus are now automatically submitted if JavaScript is available. * Support for adding ESXi credentials to targets has been added. * GPLv2+ licence notices now contain the exact wording suggested by the Free Software Foundation. * Documentation has been updated. * Numerous small improvements and bugfixes. gsa 6.0+beta1 (2014-08-23) This is the first beta version of the upcoming 6.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release -- in combination with the OpenVAS Manager 6.0+beta1 release -- enables a number of new features like the multi-scanner support, the first charts in SecInfo, the new Cert-BUND in SecInfo and the new results section under Scan Management. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner. Main changes since 5.0 series: * New: Configure menu "Scanners" for OTP and OSP based scanners. The classic OpenVAS Scanner is pre-configured. * New: For Task objects there is now a scanner selection. Scanner-specific settings are grouped with the respective scanner type. Apart from the classic OpenVAS Scanner now a OSP-based OVAL Scanner "ovaldi" is an optional scanner type. * New: Scan Configuration editor for OSP-based scanner type "ovaldi". * New: Chart types "bar-chart" and "donut", based on the d3 library, for each of the SecInfo object types. These are used for showing severity and severity classes. * New: SecInfo dashboard showing 4 charts that can be indivually be configured regarding type, object type and filter. * New: SecInfo object type "CERT-Bund", a german CERT. * New: "Results" section in menu "Scan Management". * Added "Backend operation" in the page footer. This is the time taken to get from the start of the page handler to the start of the XSL transform. * Added warning if login password does not comply with password policy. * Remove public key requirement from Credentials creation. * Removed target locator feature as this is not being fully supported by the backend anyway. * Removed any remains of handling Pause status of tasks. * ITS (IT-Schwachstellenampel, now at 1.1): * Added settings page and password warning. * Various small fixes and improvements. gsa 5.0.0 (2014-04-23) This is the first release of the Greenbone Security Assistant (GSA) 5.0 module for the Open Vulnerability Assessment System release 7 (OpenVAS-7). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. GSA 5.0 implements all of the new features of the protocol OMP 5.0. This includes the Groups, Roles and Permissions management and Tags. Further major changes are the new results browser, multi-language support and the switch from "threat" to "severity" concept. For a complete list of changes, please refer to the list below. Many thanks to everyone who has contributed to this release: Benoît Allard, Hani Benhabiles, Michael Meyer, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 4.0.x: * New: CVSS Score calculator. * New: User, group, role and permission management. * New: Tags and tag management. * New: Internationalization support. * New: Support for app icons. * New: Support for displaying gathered SSL certificates. * New: Support for Alterable Tasks. * New: Setting of the Source Interface for Tasks. * New: Alive Test for Tasks. * Changed: The default result filter now includes "low" and "log" messages as well. * Changed: GSA now requires the user's existing password when changing passwords. * The concept of "Threat" is replaced by "Severity". * Improved: Display of prognostic results. * The interface has been simplified, improved and made more consistent in a number of places. * Support for the alternative face "IT-Schwachstellenampel" has been added. * The required minimum GnuTLS version has increased to 2.8. * The required minimum libmicrohttpd version has increased to 0.9.0. * Added support for setting the priorities for cipher suites when using HTTPS. * Add --drop option to drop privileges once the chroot is established. Attention: This action was previously part of the --chroot parameter, if required, this now needs to be explicitely set. * Add --face to support switching between different layouts. * Code cleanup. And additionally changes compared to last release candidate 5.0+beta13: * Added permission-style check for Trashcan menu item. * Improved package configuration. * Various bug-fixes, cleanups and improvements, especially for consistency. gsa 5.0+beta13 (2014-04-10) This is the thirteenth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available through a web browser. This release adds support for an alternative GSA face called "IT-Schwachstellenampel" ("IT vulnerability traffic light") and improves support for role editing. It also improves the handling of signals and libmicrohttpd error messages. Many thanks to everyone who has contributed to this release: Benoît Allard, Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 5.0+beta12: * Signal handling has been improved. * Logging of libmicrohttpd error messages has been improved. * Support for role editing has been added. * The display of permissions for tasks has been improved. * The i18n documentation has been updated and improved. * Support for the alternative face "IT-Schwachstellenampel" has been added. gsa 5.0+beta12 (2014-03-28) This is the twelfth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available through a web browser. This release adds a delete possibility to the role editor, and fix an issue with redirect locations. Many thanks to everyone who has contributed to this release: Matthew Mundell and Hani Benhabiles. Main changes since 5.0+beta10: * Complete deleting of roles. * Use the Host header from the client request to determine the Location response header value. Drop back to relative if not provided. * Code cleanup. gsa 5.0+beta11 (2014-03-26) This is the eleventh beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available through a web browser. This release adds a new role editor, extends the German translation as well as makes the interface more consistent with the commands available to the user. Many thanks to everyone who has contributed to this release: Matthew Mundell, Timo Pollmeier and Hani Benhabiles. Main changes since 5.0+beta10: * Adjust tags pages to new OMP syntax that uses "resource" instead of "attach" and "orphan" instead of "orphaned". Add markers for orphaned tags and resources in trash. Make tags trash more consistent with normal table. * Add creating of roles, and basis for deleting and editing roles. * Improvement to the wizard * Switch filters associated with alerts from "report" to "result". * More translations to German language. * Code cleanup. gsa 5.0+beta10 (2014-03-18) this is the tenth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available through a web browser. This release extends the German translation as well as makes the interface more consistent with the commands available to the user. Many thanks to everyone who has contributed to this release: Benoît Allard, Timo Pollmeier and Matthew Mundell. Main changes since 5.0+beta9: * Add Slave and Network Source Interface fields to the report summary. * More translations to German language. * Code cleanup. gsa 5.0+beta9 (2014-03-12) This is the ninth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available in a web browser. This release now preserves the user's input upon errors during Setting editing, and extends the German translation. Many thanks to everyone who has contributed to this release: Timo Pollmeier and Matthew Mundell. Main changes since 5.0+beta8: * Preserve user's input after error on `Edit My Settings`. * More translations to German language. * Code cleanup. gsa 5.0+beta8 (2014-03-06) This is the eighth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available in a web browser. This release now requires the user's existing password when changing passwords and expects NVT information to be in the new style. It also makes the interface more consistent with the commands available to the user and extends the German translation. Many thanks to everyone who has contributed to this release: Matthew Mundell, Hani Benhabiles and Timo Pollmeier. Main changes since 5.0+beta7: * Make interface more consistent with available commands. * More translations to German language. * NVT information is now expected to be in the new style. * GSA now requires the user's existing password when changing passwords. * Code cleanup. gsa 5.0+beta7 (2014-02-27) This is the seventh beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds numerous improvements to the user interface. Many thanks to everyone who has contributed to this release: Matthew Mundell, Hani Benhabiles and Timo Pollmeier. Main changes since 5.0+beta6: * Show or hide dialog elements according to the availability of commands. * Prevent targets currently used for being modified. * More translations to German language. * Improved i18n implementation. * Code cleanup and various small bug-fixes. gsa 5.0+beta6 (2014-02-16) This is the sixth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds the setting for user interface language and Alive Test to Target management. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner, Timo Pollmeier and Benoît Allard. Main changes since 5.0+beta5: * Add Alive Test to Create Target, Modify Target and Target Details. * Add setting User Interface Language. * More translations to German language. * Improved i18n implementation. * Code cleanup and various small bug-fixes. gsa 5.0+beta5 (2014-01-28) This is the fifth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is a web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds internationalization support to the GSA, support for different 'faces' via the new --face parameter as well as numerous improvements to the user interface. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner, Timo Pollmeier and Benoît Allard. Main changes since 5.0+beta4: * Add --face to support switching between different layouts. * Add internationalization support (english and german included, new translations in the form of contributions are welcome). * The interface has been simplified, improved and made more consistent in a number of places. * Code cleanup. gsa 5.0+beta4 (2014-01-13) This is the fourth beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds a new --drop parameter to instruct the GSA to drop its privileges once the chroot has been established, as well as numerous improvements to the user interface. Many thanks to everyone who has contributed to this release: Matthew Mundell, Timo Pollmeier and Hani Benhabiles. Main changes since 5.0+beta3: * Add --drop option to drop privileges once the chroot is established. Attention: This action was previously part of the --chroot parameter, if required, this now needs to be explicitely set. * The interface has been simplified, improved and made more consistent in a number of places. * Code cleanup. gsa 5.0+beta3 (2013-11-22) This is the third beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for Alterable Tasks and Source Interface access control. It changes the default result filter to include "low" and "log" messages as well and adds support for selecting the cipher suite to be used for the HTTPS connection, as well as numerous improvements to the user interface. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Michael Meyer, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 5.0+beta2: * Support for Alterable Tasks has been added. * Support for setting of the Source Interface has been added. * Support for the new "Severity" concept has been added in more places. * The default result filter now includes "low" and "log" messages as well. * Add support for setting the priorities for cipher suites when using HTTPS. * The required minimum libmicrohttpd version has increased to 0.9.0. * The interface has been simplified, improved and made more consistent in a number of places. * Code cleanup. gsa 5.0+beta2 (2013-09-30) This is the second beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release fixes an issue with XSL transformations and another one causing issues after changing the password of the user currently logged in. It also enables a number of new features added to OpenVAS Manager since the last GSA release and contains a number of improvements to the user interface. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Matthew Mundell, Timo Pollmeier and Jan-Oliver Wagner. Main changes since 5.0+beta1: * Support for the new "Severity" concept has been added in a number of places. * An issue which caused segmentation faults when errors in XSL transformations were encountered has been fixed. * The interface has been simplified, improved and made more consistent in a number of places. * An issue which caused permission issues after changing passwords has been fixed. * Support for debug parameter has been added. * Parameter handling has been improved. * Code cleanup. gsa 5.0+beta1 (2013-07-01) This is the first beta version of the upcoming 5.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release -- in combination with the OpenVAS Manager 5.0+beta1 release -- enables a number of new features like improved results display, support for advanced user and permission management and internationalization. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner and Michael Wiegand. Main changes since 4.0 series: * The display of prognostic results has been improved. * Support for user, group, role and permission management has been added. * The user interface has been updated to match new and changed functionality in OpenVAS Manager. * The results display has been updated to support new style NVTs. * The required minimum GnuTLS version has increased to 2.8. * The required minimum OpenVAS Libraries version has increased to 7.0.0. * A CVSS Score calculator has been added. * Tag management and support for tags in a number of places has been added. * Internationalization support has been added. * The handling of bad or missing tokens has been improved. * Support for app icons has been added. * Support for displaying the network topology natively has been added. * Support for displaying gathered SSL certificates has been added. * Code cleanup. gsa 4.0+beta5 (2013-02-22) This is the fifth beta version of the upcoming 4.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for new features in OpenVAS Manager 4.0+beta5 like the improved Powerfilters, easy access to CVE, OVAL and DFN-CERT data and various improvements to the interface. Many thanks to everyone who has contributed to this release: Hani Benhabiles, Henri Doreau, Andre Heinecke, Werner Koch, Matthew Mundell, Timo Pollmeier, Jan-Oliver Wagner, Michael Wiegand and Felix Wolfsteller. Main changes since 4.0+beta4: * Support for browsing the CVE database has been added. * Support for accessing OVAL and DFN-CERT data has been added. * Powerfilters have been improved and are now available in more places. * SCAP synchronization can now be triggered from the web interface. * Date selection for schedules has been improved. * The documentation available through the Help menu has been updated and extended. * Exporting and editing is now supported for more objects. gsa 4.0+beta4 (2012-11-05) This is the fourth beta version of the upcoming 4.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for new features in OpenVAS Manager 4.0+beta4 like the automatic filtering of false positives, multiple alerts and a wizard for new users. Many thanks to everyone who has contributed to this release: Andre Heinecke, Matthew Mundell, Jan-Oliver Wagner and Michael Wiegand. Main changes since 4.0+beta3: * Support for Auto-FP feature and trusted vendor updates has been added. * Support for multiple alerts per task has been added. * Support for a wizard for new users has been added. * Support for filter management has been added. * Help texts have been improved. * Powerfilters are now available in more places. * CPE Management has been improved. gsa 4.0+beta3 (2012-05-04) This is the third beta version of the upcoming 4.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for new features in OpenVAS Manager 4.0+beta3 and includes several small UI fixes. Many thanks to everyone who has contributed to this release: Matthew Mundell, Michael Wiegand and Felix Wolfsteller. Main changes since 4.0+beta3: * Support for OMP capabilities has been added. * Several small inconsistencies in the user interfaces have been addressed. gsa 4.0+beta2 (2012-04-25) This is the second beta version of the upcoming 4.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release fixes a compatibility issue with Firefox 3.5, includes updates to the CMake infrastructure and adds support for new features in OpenVAS Manager 4.0+beta2. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner and Michael Wiegand. Main changes since 4.0+beta2: * The CMake infrastructure has been cleaned up to ensure that compilation with modern gccs works. * A compatibility issue with Firefox 3.5 has been resolved. * Support for new features in OpenVAS Manager 4.0+beta2 has been added. gsa 4.0+beta1 (2012-04-16) This is the first beta version of the upcoming 4.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release -- in combination with the OpenVAS Manager 4.0+beta1 release -- introduces the renaming of "Escalator" to "Alert" and an improved handling of the Targets list. Many thanks to everyone who has contributed to this release: Matthew Mundell. Main changes since 3.0 series: * Renamed "Escalator" to "Alert". * Added keyword filter, pagination, export and edit to Targets. * "New Target" now a page of its own. * Updated Target details page slightly. * Split and updated help pages for targets into multiple pages, each linked by corresponding dialogs. gsa 3.0.0 (2012-03-26) This is the first release of the Greenbone Security Assistant (GSA) 3.0 module for the Open Vulnerability Assessment System release 5 (OpenVAS-5). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. GSA 3.0 implements all of the new features of the protocol OMP 3.0. This includes Asset Management, Port Lists, SecInfo Management with SCAP data, delta reports and prognostic reports. Many thanks to everyone who has contributed to this release: Henri Doreau, Stephan Kleine, Matthew Mundell, Michael Wiegand and Jan-Oliver Wagner. Main changes since 2.0.x: * New: Configure object Port Lists. * New: References info box in results view. * New: Product detection info box in results view. * New: Allow target list upload from file. * New: Support for note/overrrides lifetimes. * New: Support for empty passwords has been added. * New: Support for changing user passwords. * New: Asset Management. * New: Exporting notes and overrides. * New: Prognostic scans. * New: Task observers. * New: SecInfo Database with SCAP data CVE and CPE. * New: Individual user settings, starting with time zone. * New: Delta reports. * New: Display single result details. * Changed: The max_host and max_checks scan performance parameters have been moved from scan configs to tasks. * New: Indicators for detected operating systems. * New: Uploading additional reports to a container task. * New: Displaying the hostname in the result. * Changed: Limitations on passwords allowed for LSC credentials have been reduced further. * New: Trashcan. It is now possible to place objects in a trashcan instead of deleting them directly. * New: Number of results per page adjustable. * The GSA no longer terminates upon receiving a SIGHUP signal to better match expected behavior. * The login behaviour has been improved. * Support for listing NVTs addressing a certain CVE has been added. * Support for listing CVEs affecting a certain CPE has been added. * An issue which caused uploaded PKCS #12 certificates to be incorrectly truncated has been fixed. * The internal handling of request parameters has been improved. * The user interface design has been updated. * Support for improved handling of ISO timestamps has been added. * A bug which caused valid hostnames to be rejected in the LDAP host field has been fixed. * GET and POST requests are now used consistently throughout the GSA. * A number of inconsistencies in the interface have been addressed. * A number of compiler warnings discovered by Stephan Kleine have been addressed. And additionally changes compared to last release candidate 3.0+rc1: * New: Per-user LDAP authentication configurable. * Allow to create notes/overrides for observed tasks. * Allows ',' as separator for observer lists. gsa 3.0+rc1 (2012-03-15) This is the first release candidate of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds the Port Lists feature and report download for delta reports and prognostic reports. Many thanks to everyone who has contributed to this release: Henri Doreau, Matthew Mundell and Felix Wolfsteller. Main changes since 3.0+beta8: * New feature Port Lists. * New references info box in results view. * New product detection info box in results view. * Allow target list upload from file. * Various bug fixes. gsa 3.0+beta8 (2011-12-02) This is the eigth beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for note lifetimes and empty passwords and improves input validation and the navigation when viewing delta reports. Many thanks to everyone who has contributed to this release: Matthew Mundell and Michael Wiegand. Main changes since 3.0+beta7: * The navigation when viewing delta reports had been improved. * Support for note lifetimes has been added. * Support for empty passwords has been added. * Input validation has been improved. gsa 3.0+beta7 (2011-11-23) This is the seventh beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release add support for improved handling of ISO timestamps and fixes visual inconsistencies in asset management and override information display. Many thanks to everyone who has contributed to this release: Matthew Mundell and Michael Wiegand. Main changes since 3.0+beta6: * Support for improved handling of ISO timestamps has been added. * A number of visual inconsistencies in the asset management have been addressed. * A bug with cause override information to be displayed even when no overrides were applied has been fixed. gsa 3.0+beta6 (2011-11-16) This is the sixth beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for changing the user password through GSA, improves the display of SCAP data and adds support for exporting notes and overrides and for override lifetimes. It also fixes a bug which cause sessions to expire prematurely and a bug in the hostname validation for LDAP hosts. Many thanks to everyone who has contributed to this release: Henri Doreau, Matthew Mundell, Michael Wiegand and Jan-Oliver Wagner. Main changes since 3.0+beta5: * Support for changing user passwords has been added. * Support for listing NVTs addressing a certain CVE has been added. * Support for listing CVEs affecting a certain CPE has been added. * Support for exporting notes and overrides has been added. * A bug which caused sessions to expire prematurely with some browsers has been fixed. * Support for displaying the SCAP update timestamp has been added. * Support for override lifetimes has been added. * A bug which caused valid hostnames to be rejected in the LDAP host field has been fixed. gsa 3.0+beta5 (2011-10-11) This is the fifth beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release adds support for a number of new features, including asset management, displaying SCAP data, prognostic scans, task observers and individual settings for users. It also features a redesigned user interface and improved internal handling of request parameters. Many thanks to everyone who has contributed to this release: Henri Doreau, Matthew Mundell, Michael Wiegand and Jan-Oliver Wagner. Main changes since 3.0+beta4: * Support for asset management has been added. * The internal handling of request parameters has been improved. * The user interface design has been updated. * Support for prognostic scans has been added. * Support for task observers has been added. * Support for displaying SCAP data has been added. * Support for individual user settings has been added. * Support for individual time zones for users has been added. gsa 3.0+beta4 (2011-07-21) This is the fourth beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release addresses a number of minor issues which were discovered after the release of GSA 3.0+beta3 and improves the display of delta report and individual result details. For details, please refer to the list of changes below. Many thanks to everyone who has contributed to this release: Henri Doreau, Matthew Mundell, Michael Wiegand and Jan-Oliver Wagner. Main changes since 3.0+beta3: * A number of inconsistencies in the interface have been addressed. * Support for displaying delta reports has been improved. * Support for viewing individual result details has been improved. * The max_host and max_checks scan performance parameters have been moved from scan configs to tasks. gsa 3.0+beta3 (2011-06-24) This is the third beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release addresses a number of minor issues which were discovered after the release of GSA 3.0+beta2 and introduces a number of new features. For details, please refer to the list of changes below. Many thanks to everyone who has contributed to this release: Henri Doreau, Stephan Kleine, Matthew Mundell, Michael Wiegand and Jan-Oliver Wagner. Main changes since 3.0+beta2: * Support for displaying delta reports has been added. * Support for showing detected operating systems has been improved. * Support for uploading additional reports to a container task has been added. * A number of compiler warnings discovered by Stephan Kleine have been addressed. * An issue which caused uploaded PKCS #12 certificates to be incorrectly truncated has been fixed. * The display of command results has been improved. * Support for displaying the hostname in the result has been added. * Support for viewing individual result details has been added. gsa 3.0+beta2 (2011-05-19) This is the second beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release addresses a number of minor issues which were discovered after the release of GSA 3.0+beta1. For details, please refer to the list of changes below. Many thanks to everyone who has contributed to this release: Matthew Mundell, Michael Wiegand and Jan-Oliver Wagner. Main changes since 3.0+beta1: * Limitations on passwords allowed for LSC credentials have been reduced further. * GET and POST requests are now used consistently throughout the GSA. * The GSA no longer terminates upon receiving a SIGHUP signal to better match expected behavior. gsa 3.0+beta1 (2011-05-05) This is the first beta version of the upcoming 3.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release -- in combination with the OpenVAS Manager 3.0+beta1 release -- introduces a number of new features. For details, please refer to the list of changes below. Many thanks to everyone who has contributed to this release: Henri Doreau, Matthew Mundell, Michael Wiegand and Jan-Oliver Wagner. Main changes since 2.0 series: * New feature: Trashcan. It is now possible to place objects in a trashcan instead of deleting them directly. * The login behaviour has been improved. * Support for Host Details reported by OpenVAS Scanner has been added. * Support for container task (imported reports) has been added. * Support for specifying an SSH port for Local Security Checks has been added. * Support for escalating result to a Sourcefire Defense Center has been added. * Support for using an SSH key pair for SSH authentication has been added. * Support for setting the number of results displayed on one page has been added. gsa 2.0.1 (2011-03-02) This is the first maintenance release of the Greenbone Security Assistant (GSA) 2.0 module for the Open Vulnerability Assessment System release 4 (OpenVAS-4). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. This release fixes three memory and resource leaks discovered after the release of GSA 2.0.0. It also switches XSL transformations to a separate process, which protects the GSA from threading and memory errors in libxslt and libxml. Many thanks to everyone who has contributed to this release: Matthew Mundell, Pavel Sejnoha, Michael Wiegand and Felix Wolfsteller. Main changes since 2.0.0: * Two memory leaks discovered by Pavel Sejnoha and one resource leak discovered by Felix Wolfsteller have been closed. * GSA now does XSL transformation in a separate process by default. gsa 2.0.0 (2011-02-21) This is the first release of the Greenbone Security Assistant (GSA) 2.0 module for the Open Vulnerability Assessment System release 4 (OpenVAS-4). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. GSA 2.0 implements all of the new features of the protocol OMP 2.0. This includes the plugin based report format framework, the master-slave mode and many other changes and improvements. It also brings several improvements to existing features, like credential management, session management and an improved build environment. Many thanks to everyone who has contributed to this release: Stephan Kleine, Matthew Mundell, Jan-Oliver Wagner, Michael Wiegand and Felix Wolfsteller. Main changes since 1.0.x: * Support for report format plugin framework has been added. * Support for master-slave mode has been added. * Support for editing credentials has been added. * Support for agent verification has been added. * Input validation for user names and passwords has been improved. * Support for Microsoft Internet Explorer has been improved. * The usability and layout of the web interface has been improved. * GSA now builds with libmicrohttpd 0.9.2 and above. * Target credentials for SMB and SSH are now separated. * The user interface for displaying filtered reports and for report downloads has been improved. * Hardening flags are now enabled during compile time to increase code quality. * Support for setting the port range for a target has been added. * If no port is specified, GSA will now attempt to listen on the appropriate privileged port (80 or 443) and fall back to listening on its default port (9392) if those are unavailable. * GSA now uses pkg-config to find required libraries. * The HTTP Basic Auth based session management has been replace with a token based session management. * A JavaScript indicator has been added. * Support for fallback system reports has been added. * The "About" page has been reworked. * Cookie based session identification has been added. Main changes since 2.0+rc5: * The JavaScript indicator has been improved. * GSA now checks for required libxml threading support. gsa 2.0+rc5 (2011-02-18) This is the fifth release candidate for the upcoming 2.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. Release 2.0 is part of OpenVAS 4, the next generation of the Open Vulnerability Assessment System. This release fixes an issue which caused some actions in the GSA to fail due to an error in the cookie base session identification and improves the handling of relogins after expired sessions. Many thanks to everyone who has contributed to this release: Matthew Mundell. Main changes since 2.0+rc4: * The cookie base session identification has been improved. * An issue with parsing the session cookie has been fixed. * The handling of POST requests after a relogin has been improved. gsa 2.0+rc4 (2011-02-17) This is the fourth release candidate for the upcoming 2.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. Release 2.0 is part of OpenVAS 4, the next generation of the Open Vulnerability Assessment System. This release features a new cookie based session identification infrastructure, several improvements to user interface, documentation and build environment and adds support for fallback system reports. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner and Michael Wiegand. Main changes since 2.0+rc3: * The documentation and the build environment have been updated. * The scan config overview now shows the number of selected NVT through family selection as well. * A JavaScript indicator has been added. * Support for fallback system reports has been added. * An issue which caused logins to fail under certain circumstances due to overly strict input validation has been fixed. * The "About" page has been reworked. * Cookie base session identification has been added. gsa 2.0+rc3 (2011-02-04) This is the third release candidate for the upcoming 2.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. Release 2.0 is part of OpenVAS 4, the next generation of the Open Vulnerability Assessment System. This release features a complete replacement of the HTTP Basic Auth based session management with a token based session management. It also contains improved documentation and improvements to the build environment. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner and Michael Wiegand. Main changes since 2.0+rc2: * A notice is added to the log if binding to the default port failed and the fallback port was used. * GSA now uses pkg-config to find required libraries. * The HTTP Basic Auth based session management has been replace with a token based session management. * GSA now provides a manual page for the gsad binary. gsa 2.0+rc2 (2011-01-21) This is the second release candidate for the upcoming 2.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. Release 2.0 is part of OpenVAS 4, the next generation of the Open Vulnerability Assessment System. This release extends the range of valid characters for LSC credential passwords, improves the behavior if no port is specified and makes the output of --version compliant with the GNU Coding Standards. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner and Michael Wiegand. Main changes since 2.0+rc1: * The output of --version now complies with the GNU Coding Standards. * The range of valid characters for LSC credential passwords has been extended further. * If no port is specified, GSA will now attempt to listen on the appropriate privileged port (80 or 443) and fall back to listening on its default port (9392) if those are unavailable. gsa 2.0+rc1 (2010-12-21) This is the first release candidate for the upcoming 2.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. Release 2.0 is part of OpenVAS 4, the next generation of the Open Vulnerability Assessment System. This release adds support for separate SMB and SSH credentials and for setting per-target port ranges. It improves the user interface for displaying filtered reports and for report downloads. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner and Michael Wiegand. Main changes since 2.0+beta1: * Error handling for reports has been improved. * A bug which cause credential comments to be ignored when creating new LSC credentials has been fixed. * Target credentials for SMB and SSH are now separated. * The user interface for displaying filtered reports and for report downloads has been improved. * Hardening flags are now enabled during compile time to increase code quality. * Support for setting the port range for a target has been added. gsa 2.0+beta1 (2010-11-19) This is the first beta version of the upcoming 2.0 release of the Greenbone Security Assistant (GSA). It is the web client that makes the full feature set of OpenVAS Manager available in a web browser. Release 2.0 is part of OpenVAS 4, the next generation of the Open Vulnerability Assessment System. GSA 2.0 implements all of the new features of the protocol OMP 2.0. This include the plugin based report format framework, the master-slave mode and many other changes and improvements. Many thanks to everyone who has contributed to this release: Stephan Kleine, Matthew Mundell, Jan-Oliver Wagner, Michael Wiegand and Felix Wolfsteller. Central new features of Greenbone Security Assistant 2.0: * Support for report format plugin framework has been added. * Support for master-slave mode has been added. * Support for editing credentials has been added. * Support for agent verification has been added. * Input validation for user names and passwords has been improved. * Support for Microsoft Internet Explorer has been improved. * The usability and layout of the web interface has been improved. * GSA now builds with libmicrohttpd 0.9.2 and above. gsa 1.0.0 (2010-08-02) This is the 1.0.0 release of GSA (Greenbone Security Assistant), an OMP web client for the Open Vulnerability Assessment System (OpenVAS). GSA 1.0 represents almost 2 years of intensive work. The mission of GSA is to be a web client to the OpenVAS Manager 1.0 via the OpenVAS Management Protocol (OMP). GSA offers a complete implementation of OMP in order to access all features to organize and manage OpenVAS vulnerability scans. Additionally, GSA optionally acts as a client for the upcoming openvas-administrator using the OpenVAS Administration Protocol (OAP) which allows e.g. management of scan users. Central features of Greenbone Security Assistant are: * Full OMP 1.0 client. The XML-based OMP responses are transformed into web pages via XSLT. * No additional web-server required. The GSA daemon (gsad) uses microhttpd to implement a HTTP service on its own. * Plain HTML. Neither cookies, JavaScript nor other dynamic elements are used. GSA works stateless and uses HTTP Basic Auth. Greenbone Security Assistant is Free Software (Open Source), licensed under GNU General Public License Version 2 or any later version. The OpenVAS development team offers support for any efforts to create binary packages for the various Linux distributions in order have this new server readily available for users as soon as possible. Please use our openvas-distro mailing list for this purpose. Many thanks to everyone who has contributed to this release since 1.0.0.rc1: Matthew Mundell, Michael Wiegand. Main changes since 1.0.0.rc1: * A bug which caused NVT preferences to be saved incorrectly under certain circumstances has been fixed. gsa 1.0.0.rc1 (2010-07-16) This is the first release candidate of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner, Michael Wiegand and Felix Wolfsteller. Main changes since 1.0.0-beta6: * Support for LDAP and ADS has been added. * A number of changes have been made to stay compatible with the updated OMP specification. * Initial support for fetching targets from external sources has been added. * Support for threat overrides has been added. * Support for Syslog and SNMP escalators has been added. * Support for agents has been improved. gsa 1.0.0-beta7 (2010-05-28) This is the seventh beta release of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Hartmut Goebel, Matthew Mundell, Jan-Oliver Wagner, Michael Wiegand and Felix Wolfsteller. Main changes since 1.0.0-beta6: * An issue which caused empty charts in the performance monitor has been fixed. * An issue which caused a new task created with both an escalator and a schedule to lose the schedule has been fixed. * Support for Internet Explorer 6 clients has been improved. * Support for using the "Threat Level Change" escalator condition has been added. * The handling of uploaded preference files has been improved. * The handling of requests for nonexistent pages has been improved. * Support for pausing of tasks has been added. * Support for displaying CVSS scores and Risk Factor values has been added. * The handling of errors during XSL transformation has been improved. * The scan start time and end time for individual host are now displayed in the report. * Support for excluding hosts without results from the report has been added. * Support for filtering results based on CVSS scores has been fixed. gsa 1.0.0-beta6 (2010-04-15) This is the sixth beta release of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Stephan Kleine, Matthew Mundell, Mareike Piechowiak, Karl-Heinz Ruskowski, Jan-Oliver Wagner and Michael Wiegand. Main changes since 1.0.0-beta5: * Support for ITG and CPE reports has been improved. * Support for resuming stopped tasks has been added. * Support for task scheduling has been added. * Initial support for editing tasks has been added. * Support for displaying the version of an installed feed has been added. * A number of build issues have been fixed. * The documentation available via the "?" icon has been updated. * The gsad binary is now installed to /usr/sbin instead of /usr/bin. gsa 1.0.0-beta5 (2010-03-04) This is the fifth beta release of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner, Michael Wiegand and Felix Wolfsteller. Main changes since 1.0.0-beta4: * Support for notes has been added. * Support for ITG and CPE reports has been added. * Improved HTTP conformity. * Significant speed-up. * Various cosmetic changes of the html pages as well as of some report types. gsa 1.0.0-beta4 (2010-02-05) This is the fourth beta release of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner, Michael Wiegand and Felix Wolfsteller. Main changes since 1.0.0-beta3: * Improved HTTP conformity. * Improved Feed synchronization support. * Improved line wrapping in reports. * A bug in the report pagination has been fixed. gsa 1.0.0-beta3 (2010-01-27) This is the third beta release of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Matthew Mundell and Felix Wolfsteller. Main changes since 1.0.0-beta2: * Improved HTTP conformity. * Fixed resource leak. * Improved input checking. * Add option to run in chroot. gsa 1.0.0-beta2 (2010-01-27) This is the second beta release of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner and Felix Wolfsteller. Main changes since 1.0.0-beta1: * Integrated online help extended. * Improved handling of feed management. * Added support for administrator feature to edit scanner settings. * Added support for administrator feature to edit user details (password, IP-based access rules). * Allow "\" as part of a credential login name. * Remain on the task page after deleting the task's last report. * Improved handling of XML/HTML report exports. * Added command line option "--listen", "--alisten", "--mlisten". gsa 1.0.0-beta1 (2010-01-12) This is the first beta release of the optional gsa module for the Open Vulnerability Assessment System (OpenVAS) leading up to the upcoming gsa 1.0. Many thanks to everyone who has contributed to this release: Matthew Mundell, Jan-Oliver Wagner, Felix Wolfsteller and Michael Wiegand. gsa-7.0.3/CMakeLists.txt000066400000000000000000000633261325671355500150610ustar00rootroot00000000000000# Greenbone Security Assistant # $Id$ # Description: Top-level cmake control for greenbone-security-assistant # # Authors: # Matthew Mundell # Michael Wiegand # # Copyright: # Copyright (C) 2009-2016 Greenbone Networks GmbH # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. message ("-- Configuring greenbone-security-assistant...") project (greenbone-security-assistant C) cmake_minimum_required (VERSION 2.8) if (POLICY CMP0005) cmake_policy (SET CMP0005 OLD) endif (POLICY CMP0005) SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake) # Needed for 'pkg_check_modules' function include (FindPkgConfig) if (NOT PKG_CONFIG_FOUND) message(FATAL_ERROR "pkg-config executable not found. Aborting.") endif (NOT PKG_CONFIG_FOUND) if (NOT CMAKE_BUILD_TYPE) set (CMAKE_BUILD_TYPE Debug) endif (NOT CMAKE_BUILD_TYPE) if (NOT SERVE_STATIC_ASSETS EQUAL 0) set (SERVE_STATIC_ASSETS 1) endif (NOT SERVE_STATIC_ASSETS EQUAL 0) ## Check existence required tools SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake) set (MANDATORY_TOOL_MISSING FALSE) if (NOT USE_LIBXSLT EQUAL 0) set (USE_LIBXSLT 1) endif (NOT USE_LIBXSLT EQUAL 0) find_program (PATH_TO_XSLTPROC xsltproc DOC "xsltproc command line " "xslt processor.") if (NOT USE_LIBXSLT AND NOT PATH_TO_XSLTPROC) set (MANDATORY_TOOL_MISSING TRUE) endif (NOT USE_LIBXSLT AND NOT PATH_TO_XSLTPROC) if (MANDATORY_TOOL_MISSING) if (NOT USE_LIBXSLT AND NOT PATH_TO_XSLTPROC) message ("The xsltproc tool or libxslt is required.") endif (NOT USE_LIBXSLT AND NOT PATH_TO_XSLTPROC) message (FATAL_ERROR "One or more tools or libraries could not be found on " "your system. Please check the logs above.") endif (MANDATORY_TOOL_MISSING) # TODO: Check for (optional) rats, flawfinder, splint, doxygen. ## Check for existance of required libraries pkg_check_modules (LIBMICROHTTPD REQUIRED libmicrohttpd>=0.9.0) pkg_check_modules (LIBXML REQUIRED libxml-2.0) pkg_check_modules (GLIB REQUIRED glib-2.0>=2.32) pkg_check_modules (LIBEXSLT REQUIRED libexslt) pkg_check_modules (LIBOPENVAS_OMP REQUIRED libopenvas_omp>=9.0.0) pkg_check_modules (LIBOPENVAS_BASE REQUIRED libopenvas_base>=9.0.0) pkg_check_modules (LIBOPENVAS_MISC REQUIRED libopenvas_misc>=9.0.0) pkg_check_modules (LIBXSLT REQUIRED libxslt) pkg_check_modules (GNUTLS REQUIRED gnutls>=3.2.15) message (STATUS "Looking for libgcrypt...") find_library (LIBGCRYPT gcrypt) if (NOT LIBGCRYPT) message (SEND_ERROR "The libgcrypt library is required.") else (NOT LIBGCRYPT) message (STATUS "Looking for libgcrypt... ${LIBGCRYPT}") execute_process (COMMAND libgcrypt-config --libs OUTPUT_VARIABLE LIBGCRYPT_LDFLAGS OUTPUT_STRIP_TRAILING_WHITESPACE) execute_process (COMMAND libgcrypt-config --cflags OUTPUT_VARIABLE LIBGCRYPT_CFLAGS OUTPUT_STRIP_TRAILING_WHITESPACE) endif (NOT LIBGCRYPT) if (NOT LIBMICROHTTPD_FOUND OR NOT LIBXML_FOUND OR NOT GLIB_FOUND OR (GTHREAD_REQUIRED AND NOT GTHREAD_FOUND) OR NOT LIBEXSLT_FOUND OR NOT LIBOPENVAS_OMP_FOUND OR NOT LIBOPENVAS_BASE_FOUND OR NOT LIBOPENVAS_MISC_FOUND OR NOT LIBXSLT_FOUND OR NOT GNUTLS_FOUND OR NOT LIBGCRYPT) message (FATAL_ERROR "One or more required libraries was not found " "(see message above), please install the missing " "libraries and run cmake again.") endif (NOT LIBMICROHTTPD_FOUND OR NOT LIBXML_FOUND OR NOT GLIB_FOUND OR (GTHREAD_REQUIRED AND NOT GTHREAD_FOUND) OR NOT LIBEXSLT_FOUND OR NOT LIBOPENVAS_OMP_FOUND OR NOT LIBOPENVAS_BASE_FOUND OR NOT LIBOPENVAS_MISC_FOUND OR NOT LIBXSLT_FOUND OR NOT GNUTLS_FOUND OR NOT LIBGCRYPT) ## Retrieve git revision (at configure time) include (GetGit) if (NOT CMAKE_BUILD_TYPE MATCHES "Release") if (EXISTS "${CMAKE_SOURCE_DIR}/.git/") if (GIT_EXECUTABLE) Git_GET_REVISION(. ProjectRevision) set (GIT_REVISION "~git-${ProjectRevision}") endif (GIT_EXECUTABLE) endif (EXISTS "${CMAKE_SOURCE_DIR}/.git/") endif (NOT CMAKE_BUILD_TYPE MATCHES "Release") ## Project version # The following three variables should be set through the project command once # we require CMake >= 3.0 set (PROJECT_VERSION_MAJOR 7) set (PROJECT_VERSION_MINOR 0) set (PROJECT_VERSION_PATCH 3) # Set beta version if this is a beta release series, # unset if this is a stable release series. #set (PROJECT_BETA_RELEASE 1) if (GIT_REVISION) set (PROJECT_VERSION_GIT "${GIT_REVISION}") else (GIT_REVISION) set (PROJECT_VERSION_GIT "~git") endif (GIT_REVISION) # If PROJECT_BETA_RELEASE is set, the version string will be set to: # "major.minor+beta${PROJECT_BETA_RELEASE}" # If PROJECT_BETA_RELEASE is NOT set, the version string will be set to: # "major.minor.patch" if (PROJECT_BETA_RELEASE) set (PROJECT_VERSION_SUFFIX "+beta${PROJECT_BETA_RELEASE}") else (PROJECT_BETA_RELEASE) set (PROJECT_VERSION_SUFFIX ".${PROJECT_VERSION_PATCH}") endif (PROJECT_BETA_RELEASE) set (PROJECT_VERSION_STRING "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}${PROJECT_VERSION_SUFFIX}") ## CPack configuration set (CPACK_CMAKE_GENERATOR "Unix Makefiles") set (CPACK_GENERATOR "TGZ") set (CPACK_INSTALL_CMAKE_PROJECTS ".;greenbone-security-assistant;ALL;/") set (CPACK_MODULE_PATH "") set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/COPYING") set (CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README") set (CPACK_RESOURCE_FILE_WELCOME "${CMAKE_SOURCE_DIR}/README") set (CPACK_SOURCE_GENERATOR "TGZ") set (CPACK_SOURCE_TOPLEVEL_TAG "") set (CPACK_SYSTEM_NAME "") set (CPACK_TOPLEVEL_TAG "") set (CPACK_PACKAGE_VERSION "${PROJECT_VERSION_STRING}${PROJECT_VERSION_GIT}") set (CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${CPACK_PACKAGE_VERSION}") set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${CPACK_PACKAGE_VERSION}") set (CPACK_PACKAGE_VENDOR "The OpenVAS Project") set (CPACK_SOURCE_IGNORE_FILES "${CMAKE_BINARY_DIR}" "/.git/" "swp$" ) include (CPack) ## Variables if (NOT SYSCONFDIR) set (SYSCONFDIR "${CMAKE_INSTALL_PREFIX}/etc") endif (NOT SYSCONFDIR) if (NOT EXEC_PREFIX) set (EXEC_PREFIX "${CMAKE_INSTALL_PREFIX}") endif (NOT EXEC_PREFIX) if (NOT BINDIR) set (BINDIR "${EXEC_PREFIX}/bin") endif (NOT BINDIR) if (NOT SBINDIR) set (SBINDIR "${EXEC_PREFIX}/sbin") endif (NOT SBINDIR) if (NOT LIBDIR) set (LIBDIR "${EXEC_PREFIX}/lib") endif (NOT LIBDIR) if (NOT LOCALSTATEDIR) set (LOCALSTATEDIR "${CMAKE_INSTALL_PREFIX}/var") endif (NOT LOCALSTATEDIR) if (NOT INCLUDEDIR) set (INCLUDEDIR "${CMAKE_INSTALL_PREFIX}/include") endif (NOT INCLUDEDIR) if (NOT DATADIR) set (DATADIR "${CMAKE_INSTALL_PREFIX}/share") endif (NOT DATADIR) if (NOT GSAD_PID_DIR) set (GSAD_PID_DIR "${LOCALSTATEDIR}/run") endif (NOT GSAD_PID_DIR) set (OPENVAS_STATE_DIR "${LOCALSTATEDIR}/lib/openvas") set (OPENVAS_LOG_DIR "${LOCALSTATEDIR}/log/openvas") set (GSA_DATA_DIR "${DATADIR}/openvas/gsa") set (GSA_LOCALE_SUBDIR "locale") set (GSA_LOCALE_DIR "${GSA_DATA_DIR}/${GSA_LOCALE_SUBDIR}") set (GSA_CHROOT_LOCALE_DIR "/${GSA_LOCALE_SUBDIR}") # TODO: Eventually use own certificates set (OPENVAS_SERVER_CERTIFICATE "${OPENVAS_STATE_DIR}/CA/servercert.pem") set (OPENVAS_SERVER_KEY "${OPENVAS_STATE_DIR}/private/CA/serverkey.pem") set (OPENVAS_CA_CERTIFICATE "${OPENVAS_STATE_DIR}/CA/cacert.pem") # TODO: Eventually have all configurations collected here: set (GSA_CONFIG_DIR "${SYSCONFDIR}/openvas/") set (GSA_CONFIG_FILE "${SYSCONFDIR}/openvas/gsa.conf") if (NOT OPENVAS_RUN_DIR) set (OPENVAS_RUN_DIR "${LOCALSTATEDIR}/run") endif (NOT OPENVAS_RUN_DIR) message ("-- Install prefix: ${CMAKE_INSTALL_PREFIX}") ## Files generated on installation add_custom_target (cpe-icon-dict ALL COMMENT "Generating CPE icon dictionary" COMMAND sh "${CMAKE_SOURCE_DIR}/tools/generate-cpe-icon-dict.sh" --src_path "${CMAKE_SOURCE_DIR}/src/html/classic/img/cpe" > ${CMAKE_CURRENT_BINARY_DIR}/cpe-icons.xml WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tools) add_custom_target (zone-dict ALL COMMENT "Generating timezone dictionary" COMMAND sh "${CMAKE_SOURCE_DIR}/tools/generate-zone-dict.sh" > ${CMAKE_CURRENT_BINARY_DIR}/zones.xml WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tools) ## Version set (GSAD_VERSION "${PROJECT_VERSION_STRING}") # Configure Doxyfile with version number configure_file (doc/Doxyfile.in doc/Doxyfile) configure_file (doc/Doxyfile_full.in doc/Doxyfile_full) configure_file (VERSION.in VERSION) configure_file (src/gsad_log_conf.cmake_in src/gsad_log.conf) ## Install install (FILES src/html/classic/gsad.xsl src/html/classic/graphics.xsl src/html/classic/help.xsl src/html/classic/omp.xsl src/html/classic/omp-doc.xsl src/html/classic/rnc.xsl src/html/classic/robots.txt src/html/classic/os.xml src/html/classic/wizard.xsl DESTINATION ${GSA_DATA_DIR}/classic) install (FILES src/html/classic/css/gsa-login.css src/html/classic/css/gsa-style.css src/html/classic/css/gsa-base.css src/html/classic/css/jquery-ui.structure.min.css src/html/classic/css/jquery-ui.theme.min.css src/html/classic/css/select2.min.css DESTINATION ${GSA_DATA_DIR}/classic/css) install (FILES src/html/classic/css/images/ui-bg_diagonals-thick_18_aa0000_40x40.png src/html/classic/css/images/ui-bg_diagonals-thick_30_666666_40x40.png src/html/classic/css/images/ui-bg_flat_10_000000_40x100.png src/html/classic/css/images/ui-bg_glass_65_ffffff_1x400.png src/html/classic/css/images/ui-bg_highlight-hard_35_66c430_1x100.png src/html/classic/css/images/ui-bg_highlight-soft_100_519032_1x100.png src/html/classic/css/images/ui-bg_highlight-soft_100_87d050_1x100.png src/html/classic/css/images/ui-bg_highlight-soft_100_eeeeee_1x100.png src/html/classic/css/images/ui-bg_highlight-soft_75_fdc300_1x100.png src/html/classic/css/images/ui-icons_222222_256x240.png src/html/classic/css/images/ui-icons_519032_256x240.png src/html/classic/css/images/ui-icons_87d050_256x240.png src/html/classic/css/images/ui-icons_aa0000_256x240.png src/html/classic/css/images/ui-icons_fdc300_256x240.png src/html/classic/css/images/ui-icons_ffffff_256x240.png DESTINATION ${GSA_DATA_DIR}/classic/css/images) install (FILES src/html/classic/js/lib/d3.tip.js src/html/classic/js/lib/d3.layout.cloud.js src/html/classic/js/lib/moment.js src/html/classic/js/lib/moment-timezone-with-data.js src/html/classic/js/gsa_bar_chart.js src/html/classic/js/gsa_bubble_chart.js src/html/classic/js/gsa_chart_helpers.js src/html/classic/js/gsa_graphics_base.js src/html/classic/js/gsa_cloud_chart.js src/html/classic/js/gsa_dashboard.js src/html/classic/js/gsa_donut_chart.js src/html/classic/js/gsa_gantt_chart.js src/html/classic/js/gsa_h_bar_chart.js src/html/classic/js/gsa_line_chart.js src/html/classic/js/gsa_topology_chart.js src/html/classic/js/gsa_polyfill.js src/html/classic/js/greenbone.js src/html/classic/js/greenbone-ui.js DESTINATION ${GSA_DATA_DIR}/classic/js) if (CMAKE_BUILD_TYPE MATCHES "Release") install (FILES src/html/classic/js/lib/min/d3.v3.js src/html/classic/js/lib/min/jquery-2.1.4.js src/html/classic/js/lib/min/jquery-ui.js src/html/classic/js/lib/min/select2.js src/html/classic/js/lib/min/i18next-2.3.4.js src/html/classic/js/lib/min/i18next-xhr-0.5.3.js src/html/classic/js/lib/min/i18next-languagedetector-0.2.2.js src/html/classic/js/lib/min/xml2json.js DESTINATION ${GSA_DATA_DIR}/classic/js) else (CMAKE_BUILD_TYPE MATCHES "Release") install (FILES src/html/classic/js/lib/d3.v3.js src/html/classic/js/lib/jquery-2.1.4.js src/html/classic/js/lib/jquery-ui.js src/html/classic/js/lib/select2.js src/html/classic/js/lib/i18next-2.3.4.js src/html/classic/js/lib/i18next-xhr-0.5.3.js src/html/classic/js/lib/i18next-languagedetector-0.2.2.js src/html/classic/js/lib/xml2json.js DESTINATION ${GSA_DATA_DIR}/classic/js) endif (CMAKE_BUILD_TYPE MATCHES "Release") install (FILES src/html/classic/css/gsa-login.css DESTINATION ${GSA_DATA_DIR}/classic/login) install (FILES src/html/classic/img/gsa_splash.svg DESTINATION ${GSA_DATA_DIR}/classic/login/img) install (FILES src/html/classic/help_de.xsl src/html/classic/help_ru.xsl src/html/classic/help_zh_CN.xsl DESTINATION ${GSA_DATA_DIR}/classic) install (FILES src/html/classic/img/style/window_dec_a.png src/html/classic/img/style/window_dec_b.png src/html/classic/img/style/window_dec_c.png DESTINATION ${GSA_DATA_DIR}/classic/login/img/style) install (FILES src/html/classic/img/agent.svg src/html/classic/img/add_to_assets.svg src/html/classic/img/calendar.svg src/html/classic/img/descending.svg src/html/classic/img/key.svg src/html/classic/img/start_inactive.svg src/html/classic/img/alert_sign.svg src/html/classic/img/details.svg src/html/classic/img/details_inactive.svg src/html/classic/img/list_inactive.svg src/html/classic/img/start.svg src/html/classic/img/ascending_inactive.svg src/html/classic/img/download.svg src/html/classic/img/list.svg src/html/classic/img/stop_inactive.svg src/html/classic/img/ascending.svg src/html/classic/img/edit_inactive.svg src/html/classic/img/stop.svg src/html/classic/img/edit.svg src/html/classic/img/exe.svg src/html/classic/img/trend_down.svg src/html/classic/img/refresh.svg src/html/classic/img/trend_less.svg src/html/classic/img/deb.svg src/html/classic/img/resume_inactive.svg src/html/classic/img/trend_more.svg src/html/classic/img/delete_inactive.svg src/html/classic/img/help.svg src/html/classic/img/new_note.svg src/html/classic/img/resume.svg src/html/classic/img/trend_nochange.svg src/html/classic/img/delete_note.svg src/html/classic/img/new.svg src/html/classic/img/rpm.svg src/html/classic/img/trend_up.svg src/html/classic/img/delete.svg src/html/classic/img/scheduled_inactive.svg src/html/classic/img/descending_inactive.svg src/html/classic/img/note.svg src/html/classic/img/scheduled.svg src/html/classic/img/override.svg src/html/classic/img/new_override.svg src/html/classic/img/trashcan.svg src/html/classic/img/trashcan_inactive.svg src/html/classic/img/indicator_js.svg src/html/classic/img/restore.svg src/html/classic/img/restore_inactive.svg src/html/classic/img/delta.svg src/html/classic/img/delta_inactive.svg src/html/classic/img/delta_second.svg src/html/classic/img/indicator_operation_ok.svg src/html/classic/img/indicator_operation_failed.svg src/html/classic/img/provide_view.svg src/html/classic/img/view_other.svg src/html/classic/img/sensor.svg src/html/classic/img/wizard.svg src/html/classic/img/upload.svg src/html/classic/img/clone.svg src/html/classic/img/clone_inactive.svg src/html/classic/img/next.svg src/html/classic/img/next_inactive.svg src/html/classic/img/previous.svg src/html/classic/img/previous_inactive.svg src/html/classic/img/verify.svg src/html/classic/img/verify_inactive.svg src/html/classic/img/tag.svg src/html/classic/img/fold.svg src/html/classic/img/unfold.svg src/html/classic/img/enable.svg src/html/classic/img/disable.svg src/html/classic/img/overrides_disabled.svg src/html/classic/img/overrides_enabled.svg src/html/classic/img/alterable.svg src/html/classic/img/first.svg src/html/classic/img/first_inactive.svg src/html/classic/img/last.svg src/html/classic/img/last_inactive.svg src/html/classic/img/feedback.svg src/html/classic/img/remove_from_assets.svg src/html/classic/img/st_workaround.svg src/html/classic/img/solution_type.svg src/html/classic/img/st_vendorfix.svg src/html/classic/img/st_willnotfix.svg src/html/classic/img/st_nonavailable.svg src/html/classic/img/st_mitigate.svg src/html/classic/img/pause.svg src/html/classic/img/cvss_calculator.svg src/html/classic/img/dashboard.svg src/html/classic/img/my_setting.svg src/html/classic/img/performance.svg src/html/classic/img/port_list.svg src/html/classic/img/alert.svg src/html/classic/img/report_format.svg src/html/classic/img/credential.svg src/html/classic/img/permission.svg src/html/classic/img/scanner.svg src/html/classic/img/config.svg src/html/classic/img/allinfo.svg src/html/classic/img/nvt.svg src/html/classic/img/report.svg src/html/classic/img/agent.svg src/html/classic/img/asset.svg src/html/classic/img/os.svg src/html/classic/img/host.svg src/html/classic/img/feed.svg src/html/classic/img/cpe.svg src/html/classic/img/cve.svg src/html/classic/img/ovaldef.svg src/html/classic/img/cert_bund_adv.svg src/html/classic/img/dfn_cert_adv.svg src/html/classic/img/result.svg src/html/classic/img/scan.svg src/html/classic/img/schedule.svg src/html/classic/img/target.svg src/html/classic/img/task.svg src/html/classic/img/tag.svg src/html/classic/img/trashcan.svg src/html/classic/img/user.svg src/html/classic/img/vul_report.svg src/html/classic/img/group.svg src/html/classic/img/role.svg src/html/classic/img/filter.svg src/html/classic/img/note.svg src/html/classic/img/override.svg src/html/classic/img/slave.svg src/html/classic/img/greenbone.svg src/html/classic/img/wizard.svg src/html/classic/img/ldap.svg src/html/classic/img/radius.svg src/html/classic/img/gsa.svg src/html/classic/img/enchantress.svg src/html/classic/img/bullet.svg src/html/classic/img/bullet2.svg src/html/classic/img/gsa_splash.svg src/html/classic/img/prognosis.svg src/html/classic/img/prognosis_inactive.svg DESTINATION ${GSA_DATA_DIR}/classic/img) install (FILES src/html/classic/img/login-label.png src/html/classic/img/p_bar_done.png src/html/classic/img/p_bar_error.png src/html/classic/img/p_bar_new.png src/html/classic/img/p_bar.png src/html/classic/img/p_bar_request.png src/html/classic/img/p_bar_gray.png src/html/classic/img/p_bar_bg.png DESTINATION ${GSA_DATA_DIR}/classic/img) install (FILES src/html/classic/img/loading.gif src/html/classic/img/favicon.gif DESTINATION ${GSA_DATA_DIR}/classic/img) install (FILES src/html/classic/img/style/window_dec_a.png src/html/classic/img/style/window_dec_b.png src/html/classic/img/style/window_dec_c.png src/html/classic/img/style/window_dec_a_error.png src/html/classic/img/style/window_dec_b_error.png src/html/classic/img/style/window_dec_c_error.png src/html/classic/img/style/menu_pointy.png src/html/classic/img/style/dropdown_arrow.png src/html/classic/img/style/dropdown_arrow_black.png src/html/classic/img/style/dropdown_arrow_green.png DESTINATION ${GSA_DATA_DIR}/classic/img/style) install (FILES src/html/classic/img/os_aix.svg src/html/classic/img/os_apple.svg src/html/classic/img/os_arubanetworks.svg src/html/classic/img/os_centos.svg src/html/classic/img/os_checkpoint.svg src/html/classic/img/os_cisco.svg src/html/classic/img/os_conflict.svg src/html/classic/img/os_cyclades.svg src/html/classic/img/os_debian.svg src/html/classic/img/os_fedora.svg src/html/classic/img/os_fortinet.svg src/html/classic/img/os_freebsd.svg src/html/classic/img/os_gentoo.svg src/html/classic/img/os_gos.svg src/html/classic/img/os_junos.svg src/html/classic/img/os_hp.svg src/html/classic/img/os_huawai.svg src/html/classic/img/os_ipfire.svg src/html/classic/img/os_linux.svg src/html/classic/img/os_mandriva.svg src/html/classic/img/os_mcafee.svg src/html/classic/img/os_netbsd.svg src/html/classic/img/os_netgear.svg src/html/classic/img/os_novell.svg src/html/classic/img/os_openbsd.svg src/html/classic/img/os_paloalto.svg src/html/classic/img/os_redhat.svg src/html/classic/img/os_ruggedcom.svg src/html/classic/img/os_slackware.svg src/html/classic/img/os_sourcefire.svg src/html/classic/img/os_sun.svg src/html/classic/img/os_suse.svg src/html/classic/img/os_synology.svg src/html/classic/img/os_trustix.svg src/html/classic/img/os_ubuntu.svg src/html/classic/img/os_ucs.svg src/html/classic/img/os_unknown.svg src/html/classic/img/os_vmware.svg src/html/classic/img/os_windows.svg DESTINATION ${GSA_DATA_DIR}/classic/img) install (FILES src/html/classic/img/cpe/other.svg src/html/classic/img/cpe/a:apache:http_server.svg src/html/classic/img/cpe/a:drupal:drupal.svg src/html/classic/img/cpe/a:google.svg src/html/classic/img/cpe/a:gnu.svg src/html/classic/img/cpe/a:mysql:mysql.svg src/html/classic/img/cpe/a:openbsd:openssh.svg src/html/classic/img/cpe/a:otrs:otrs.svg src/html/classic/img/cpe/a:php:php.svg src/html/classic/img/cpe/a:postgresql:postgresql.svg src/html/classic/img/cpe/a:snort:snort.svg src/html/classic/img/cpe/a:sourcefire.svg src/html/classic/img/cpe/a:typo3:typo3.svg src/html/classic/img/cpe/a:wordpress:wordpress.svg DESTINATION ${GSA_DATA_DIR}/classic/img/cpe) install (FILES src/html/classic/img/charts/severity-bar-chart.png DESTINATION ${GSA_DATA_DIR}/classic/img/charts) install (FILES ${CMAKE_SOURCE_DIR}/src/language_names.tsv DESTINATION ${GSA_DATA_DIR}) install (FILES ${CMAKE_BINARY_DIR}/src/gsad_log.conf DESTINATION ${GSA_CONFIG_DIR}) install (FILES ${CMAKE_CURRENT_BINARY_DIR}/cpe-icons.xml DESTINATION ${GSA_DATA_DIR}/classic) install (FILES ${CMAKE_CURRENT_BINARY_DIR}/zones.xml DESTINATION ${GSA_DATA_DIR}/classic) ## Program set (HARDENING_FLAGS "-Wformat -Wformat-security -O2 -D_FORTIFY_SOURCE=2 -fstack-protector") set (LINKER_HARDENING_FLAGS "-Wl,-z,relro -Wl,-z,now") set (CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -Werror") set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${HARDENING_FLAGS} -Wall") add_subdirectory (src) ## Documentation add_subdirectory (doc) ## Additional faces if (INSTALL_FACE_ITS MATCHES "yes") message ("-- Additional face 'its' will be installed.") add_subdirectory (src/html/its) endif (INSTALL_FACE_ITS MATCHES "yes") ## End gsa-7.0.3/COPYING000066400000000000000000000070451325671355500133500ustar00rootroot00000000000000License information about Greenbone Security Assistant ------------------------------------------------------ The effective license of the module as a whole is the GNU General Public License Version 2 or any later version (GNU GPLv2+). Most files, are licensed under GNU General Public License Version 2 or any later version (GNU GPLv2+). Some files have a different, but compatible licenses (BSD 3-clause and MIT). GPLv2: See file COPYING.GPL BSD-3: See file COPYING.BSD3 MIT: See file COPYING.MIT These are the files that are not licensed GPLv2+, any others are licensed under GPLv2+: src/html/classic/js/lib/d3.v3.js, src/html/classic/js/lib/min/d3.v3.js: License: BSD-3 Copyright: Michael Bostock Origin: http://d3js.org/ src/html/classic/js/lib/d3.layout.cloud.js: License: BSD-3 Copyright: Jason Davies Origin: https://github.com/jasondavies/d3-cloud src/html/classic/js/lib/d3.tip.js: License: MIT Copyright: Justin Palmer Origin: https://github.com/Caged/d3-tip src/html/classic/js/lib/jquery-2.1.4.js, src/html/classic/js/lib/min/jquery-2.1.4.js, src/html/classic/js/lib/min/jquery-2.1.4.js.map: License: MIT Copyright: jQuery Foundation, Inc. and other contributors Origin: http://jquery.com/download/ src/html/classic/css/jquery-ui.structure.css, src/html/classic/css/jquery-ui.structure.min.css, src/html/classic/css/jquery-ui.theme.css, src/html/classic/css/jquery-ui.theme.min.css, src/html/classic/css/images/ui-bg_diagonals-thick_18_aa0000_40x40.png, src/html/classic/css/images/ui-bg_diagonals-thick_30_666666_40x40.png, src/html/classic/css/images/ui-bg_flat_10_000000_40x100.png, src/html/classic/css/images/ui-bg_glass_65_ffffff_1x400.png, src/html/classic/css/images/ui-bg_highlight-hard_35_66c430_1x100.png, src/html/classic/css/images/ui-bg_highlight-soft_100_519032_1x100.png, src/html/classic/css/images/ui-bg_highlight-soft_100_87d050_1x100.png, src/html/classic/css/images/ui-bg_highlight-soft_100_eeeeee_1x100.png, src/html/classic/css/images/ui-bg_highlight-soft_75_fdc300_1x100.png, src/html/classic/css/images/ui-icons_222222_256x240.png, src/html/classic/css/images/ui-icons_519032_256x240.png, src/html/classic/css/images/ui-icons_87d050_256x240.png, src/html/classic/css/images/ui-icons_aa0000_256x240.png, src/html/classic/css/images/ui-icons_fdc300_256x240.png, src/html/classic/css/images/ui-icons_ffffff_256x240.png, src/html/classic/js/lib/jquery-ui.js, src/html/classic/js/lib/min/jquery-ui.js: License: MIT Copyright: jQuery Foundation, Inc. and other contributors Origin: http://jqueryui.com/download/ src/html/classic/css/select2.css, src/html/classic/css/select2.min.css, src/html/classic/js/lib/select2.js, src/html/classic/js/lib/min/select2.js: License: MIT Copyright: Kevin Brown, Igor Vaynberg, and Select2 contributors Origin: https://github.com/select2/select2/releases src/html/classic/js/lib/i18next-2.3.4.js src/html/classic/js/lib/min/i18next-2.3.4.js src/html/classic/js/lib/i18next-languagedetector-0.2.2.js src/html/classic/js/lib/min/i18next-languagedetector-0.2.2.js src/html/classic/js/lib/i18next-xhr-0.5.3.js src/html/classic/js/lib/min/i18next-xhr-0.5.3.js Licence: MIT Copyright: Copyright (c) 2015 i18next Origin: https://github.com/i18next/i18next String function polyfills in src/html/classic/js/gsa_polyfill License: MIT Copyright: Copyright Mathias Bynens Origin: https://github.com/mathiasbynens/String.prototype.endsWith https://github.com/mathiasbynens/String.prototype.includes https://github.com/mathiasbynens/String.prototype.startsWith gsa-7.0.3/COPYING.BSD3000066400000000000000000000026241325671355500140400ustar00rootroot00000000000000Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. gsa-7.0.3/COPYING.GPL000066400000000000000000000431221325671355500137650ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. gsa-7.0.3/COPYING.MIT000066400000000000000000000017771325671355500140060ustar00rootroot00000000000000Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. gsa-7.0.3/FindPythonModule.cmake000066400000000000000000000022461325671355500165450ustar00rootroot00000000000000# From: https://cmake.org/pipermail/cmake/2011-January/041666.html # # Use it like that: find_python_module(PyQt4 REQUIRED) function(find_python_module module) string(TOUPPER ${module} module_upper) if(NOT PY_${module_upper}) if(ARGC GREATER 1 AND ARGV1 STREQUAL "REQUIRED") set(${module}_FIND_REQUIRED TRUE) endif() # A module's location is usually a directory, but for binary modules # it's a .so file. execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" "import re, ${module}; print re.compile('/__init__.py.*').sub('',${module}.__file__)" RESULT_VARIABLE _${module}_status OUTPUT_VARIABLE _${module}_location ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE) if(NOT _${module}_status) set(PY_${module_upper} ${_${module}_location} CACHE STRING "Location of Python module ${module}") endif(NOT _${module}_status) endif(NOT PY_${module_upper}) find_package_handle_standard_args(PY_${module} DEFAULT_MSG PY_${module_upper}) set(PY_${module_upper}_FOUND ${PY_${module_upper}_FOUND} PARENT_SCOPE) endfunction(find_python_module) gsa-7.0.3/INSTALL000066400000000000000000000123441325671355500133440ustar00rootroot00000000000000INSTALLATION INSTRUCTIONS FOR GREENBONE SECURITY ASSISTANT ========================================================== Please note: The reference system used by most of the developers is Debian GNU/Linux 'Jessie' 8. The build might fail on any other system. Also it is necessary to install dependent development packages. Prerequisites for Greenbone Security Assistant ---------------------------------------------- See at the end of this section how to easily install these prerequisites on some supported platforms. Prerequisites: * libopenvas_omp, libopenvas_base, libopenvas_misc >= 9.0.0 * gnutls >= 3.2.15 * libgcrypt * cmake >= 2.8 * glib-2.0 >= 2.32 * libxml * libxslt * libmicrohttpd >= 0.9.0 * libexslt * pkg-config * xsltproc Prerequisites for using translations: * gettext (when building from source) * an installed English UTF-8 locale (e.g. "en_US.UTF8", "en_GB.UTF8") (See "Setting up translations") Prerequisites for building documentation: * Doxygen * xmltoman (optional, for building man page) Prerequisites to work on the translations from C and XSLT based sources and also to build the JavaScript translations: * python-polib Install prerequisites on Debian GNU/Linux: # apt-get install libmicrohttpd-dev libxml2-dev libxslt1-dev Compiling Greenbone Security Assistant -------------------------------------- If you have installed required libraries to a non-standard location, remember to set the PKG_CONFIG_PATH environment variable to the location of you pkg-config files before configuring: $ export PKG_CONFIG_PATH=/your/location/lib/pkgconfig:$PKG_CONFIG_PATH Create a build directory and change into it with $ mkdir build $ cd build Then configure the build with $ cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/installation .. or (if you want to use the default installation path /usr/local) $ cmake .. This only needs to be done once. Note: It is assumed that the other OpenVAS components are installed to the same path. If not, you need to set some paths separately, see below for details. Thereafter, the following commands are useful. $ make # build the Greenbone Security Assistant $ make doc # build the documentation $ make doc-full # build more developer-oriented documentation $ make install # install the build $ make rebuild_cache # rebuild the cmake cache In case you have installed the Greenbone Security Assistant into a path different from the other OpenVAS modules, you might need to set some paths explicitly before running cmake. The certificate and key locations in OPENVAS_SERVER_CERTIFICATE, OPENVAS_SERVER_KEY and OPENVAS_CA_CERTIFICATE in the top level CMakeLists.txt may need modifying. Logging Configuration --------------------- By default GSA writes logs to the file /var/log/openvas/gsad.log Logging is configured entirely by the file /etc/openvas/gsad_log.conf The configuration is divided into domains like this one [gsad main] prepend=%t %p prepend_time_format=%Y-%m-%d %Hh%M.%S %Z file=/var/log/openvas/gsad.log level=128 The "level" field controls the amount of logging that is written. The value of "level" can be 4 Errors. 8 Critical situation. 16 Warnings. 32 Messages. 64 Information. 128 Debug. (Lots of output.) Enabling any level includes all the levels above it. So enabling Information will include Warnings, Critical situations and Errors. To get absolutely all logging, set the level to 128 for all domains in the configuration file. Setting up translations ----------------------- To build the translation .mo files, you need to have the gettext tools like msgfmt installed. Once the .mo files are built, the tools are no longer needed. (For more information on the creation of translation files, see i18n-howto.txt in the GSA source documentation.) To use the translations you need to have an English locale with UTF-8 encoding installed, for example "en_US.UTF8" or "en_GB.UTF8". The name of this locale then has to be assigned to an environment variable recognized by the libc function "setlocale" like LANG, LC_MESSAGES or LC_ALL. If these environment variables are all unset, set to "C" or an equivalent like "POSIX" or invalid, translations will be disabled. Static code analysis with the Clang Static Analyzer --------------------------------------------------- If you want to use the Clang Static Analyzer (http://clang-analyzer.llvm.org/) to do a static code analysis, you can do so by adding the following parameter when configuring the build: -DCMAKE_C_COMPILER=/usr/share/clang/scan-build/ccc-analyzer Note that the example above uses the default location of ccc-analyzer in Debian GNU/Linux and may be different in other environments. To have the analysis results aggregated into a set of HTML files, use the following command: $ scan-build make The tool will provide a hint on how to launch a web browser with the results. It is recommended to do this analysis in a separate, empty build directory and to empty the build directory before "scan-build" call. Specifying Diffie-Hellman parameters file --------------------------------------------------- For --dh-params' value to take effect, LibmicroHTTPD version 0.9.35 or higher is required. gsa-7.0.3/README000066400000000000000000000022551325671355500131730ustar00rootroot00000000000000About Greenbone Security Assistant ---------------------------------- The Greenbone Security Assistant is the web interface developed for the Greenbone Security Manager appliances. It connects to the OpenVAS Manager to provide for a full-featured user interface for vulnerability management. Greenbone Security Assistant is licensed under GNU General Public License Version 2 or any later version. Please see file COPYING for details. Copyright (C) by Greenbone Networks GmbH (see http://www.greenbone.net). Greenbone Security Assistant integrates helper libraries. Respective copyright and license details are provided in file COPYING. Howto use --------- Starting Greenbone Security Assistant: In case everything was installed using the defaults, then starting the daemon of the Greenbone Security Assistant can be done with this simple command: gsad The daemon will then listen on port 443, in other words the web interface is available in your network under "https://". If port 443 was not available, gsad tries to serve at port 9392 as a fallback ("https://:9392"). To see all available command line options of gsad enter this command: gsad --help gsa-7.0.3/VERSION.in000066400000000000000000000000271325671355500137630ustar00rootroot00000000000000@CPACK_PACKAGE_VERSION@gsa-7.0.3/cmake/000077500000000000000000000000001325671355500133675ustar00rootroot00000000000000gsa-7.0.3/cmake/GetGit.cmake000066400000000000000000000036301325671355500155560ustar00rootroot00000000000000# getgit.cmake # This script attempts to determine the Git commit ID and writes or updates # a "gitrevision.h" file if successful. # # Authors: # Juan Jose Nicola # # Copyright: # Copyright (C) 2018 Greenbone Networks GmbH # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. find_package (Git) macro (Git_GET_REVISION dir variable) execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD WORKING_DIRECTORY ${dir} OUTPUT_VARIABLE GIT_BRANCH OUTPUT_STRIP_TRAILING_WHITESPACE) execute_process(COMMAND ${GIT_EXECUTABLE} log -1 --format=%h WORKING_DIRECTORY ${dir} OUTPUT_VARIABLE GIT_COMMIT_HASH OUTPUT_STRIP_TRAILING_WHITESPACE) set (${variable} "${GIT_COMMIT_HASH}-${GIT_BRANCH}") endmacro (Git_GET_REVISION) if (EXISTS "${SOURCE_DIR}/.git/") if (GIT_FOUND) Git_GET_REVISION (${SOURCE_DIR} GIT_REVISION) endif (GIT_FOUND) endif (EXISTS "${SOURCE_DIR}/.git/") if (GIT_REVISION) file (WRITE gitrevision.h.in "#define GSAD_GIT_REVISION \"${GIT_REVISION}\"\n") execute_process (COMMAND ${CMAKE_COMMAND} -E copy_if_different gitrevision.h.in gitrevision.h) file (REMOVE gitrevision.h.in) endif (GIT_REVISION)gsa-7.0.3/doc/000077500000000000000000000000001325671355500130545ustar00rootroot00000000000000gsa-7.0.3/doc/CMakeLists.txt000066400000000000000000000074561325671355500156300ustar00rootroot00000000000000# OpenVAS # $Id$ # Description: CMakefile for the Greenbone Security Manager documentation # # Authors: # Matthew Mundell # # Copyright: # Copyright (C) 2009 Greenbone Networks GmbH # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. ## build set_directory_properties (PROPERTIES CLEAN_NO_CUSTOM true) set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ".built-html;.built-html_full") include (FindDoxygen) if (NOT DOXYGEN_EXECUTABLE) message (STATUS "WARNING: Doxygen is required to build the HTML docs.") else (NOT DOXYGEN_EXECUTABLE) add_custom_target (doc COMMENT "Building documentation..." DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/.built-html) add_custom_command (OUTPUT .built-html COMMAND sh ARGS -c \"${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile && touch ${CMAKE_CURRENT_BINARY_DIR}/.built-html\;\" DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) add_custom_target (doc-full COMMENT "Building documentation..." DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_full ${CMAKE_CURRENT_BINARY_DIR}/.built-html_full) add_custom_command (OUTPUT .built-html_full COMMAND sh ARGS -c \"${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_full && touch ${CMAKE_CURRENT_BINARY_DIR}/.built-html_full\;\" DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_full) endif (NOT DOXYGEN_EXECUTABLE) ## Find xml2man message (STATUS "Looking for xmltoman...") find_program (XMLTOMAN_EXECUTABLE xmltoman PATHS /bin /usr/bin /usr/local/bin/ DOC "xmltoman location") message (STATUS "Looking for xmltoman... ${XMLTOMAN_EXECUTABLE}") find_program (XMLMANTOHTML_EXECUTABLE xmlmantohtml PATHS /bin /usr/bin /usr/local/bin/ DOC "xmlmantohtml location") message (STATUS "Looking for xmlmantohtml... ${XMLMANTOHTML_EXECUTABLE}") # FIX find_program seems to follow symlink if (XMLMANTOHTML_EXECUTABLE) set (XMLMANTOHTML_EXECUTABLE xmlmantohtml) endif (XMLMANTOHTML_EXECUTABLE) if (XMLTOMAN_EXECUTABLE) add_custom_target (man COMMENT "Building manual page..." DEPENDS gsad.8) add_custom_command (OUTPUT gsad.8 COMMAND sh ARGS -c \"${XMLTOMAN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/gsad.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/gsad.8\;\" DEPENDS gsad.8.xml) else (XMLTOMAN_EXECUTABLE) message (STATUS "WARNING: xmltoman is required to generate manpage.") add_custom_command (OUTPUT gsad.8 COMMAND echo "[Error: xmltoman required to see manpage here]" > ${CMAKE_CURRENT_BINARY_DIR}/gsad.8) endif (XMLTOMAN_EXECUTABLE) if (XMLMANTOHTML_EXECUTABLE) add_custom_target (man-html COMMENT "Building manual page HTML..." DEPENDS gsad.html) add_custom_command (OUTPUT gsad.html COMMAND sh ARGS -c \"${XMLMANTOHTML_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/gsad.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/gsad.html\;\" DEPENDS gsad.8.xml) else (XMLMANTOHTML_EXECUTABLE) message (STATUS "WARNING: xmlmantohtml is required for manpage in HTML docs.") add_custom_command (OUTPUT gsad.html COMMAND echo "[Error: xmlmantohtml required to see manpage here]" > gsad.html) endif (XMLMANTOHTML_EXECUTABLE) ## Install install (FILES gsad.8 DESTINATION ${DATADIR}/man/man8 ) gsa-7.0.3/doc/Doxyfile.in000066400000000000000000003107671325671355500152050ustar00rootroot00000000000000# Doxyfile 1.8.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = "Greenbone Security Assistant" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = @CPACK_PACKAGE_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify an logo or icon that is included in # the documentation. The maximum height of the logo should not exceed 55 pixels # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/doc/generated # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a # new page for each member. If set to NO, the documentation of a member will be # part of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 2 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = "TODO=\todo" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by by putting a % sign in front of the word # or globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined # locally in source files will be included in the documentation. If set to NO # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When set to YES local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO these classes will be included in the various overviews. This option has # no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the # todo list. This list is created by putting \todo commands in the # documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the # test list. This list is created by putting \test commands in the # documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES the list # will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO doxygen will only warn about wrong or incomplete parameter # documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. # Note: If this tag is empty the current directory is searched. INPUT = @CMAKE_SOURCE_DIR@/src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank the # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = @CMAKE_SOURCE_DIR@ \ @CMAKE_SOURCE_DIR@/doc # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER ) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES, then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # compiled with the --with-libclang option. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefor more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra stylesheet files is of importance (e.g. the last # stylesheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the stylesheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to NO can help when comparing the output of multiple runs. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler ( hhc.exe). If non-empty # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated ( # YES) or that it should be included in the master .chm file ( NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated ( # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using prerendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /