Package: qualysetl
Qualys API Best Practices SeriesExplore theQualys API Best Practices Series, for insightful guidance on maximizing the effectiveness of the Qualys API and QualysETL.
This series offers valuable tips, expert advice, and practical strategies to help you optimize your use of the Qualys platform for enhanced cybersecurity and compliance management.
Ideal for both new and experienced users, it offers key insights and showcases the practical use of QualysETL, enriching your understanding and skills in API interactions and data management.Discover QualysETL: Empowering Cybersecurity with Qualys DataQualysETL is a valuable tool in harnessing the power of Qualys data, enabling organizations to efficiently Measure, Communicate, and Eliminate Cyber Risk. This synergy fortifies businesses against the evolving landscape of digital threats.Innovative Data Management: QualysETL is an open-source Python application crafted to streamline the Extract, Transform, Load (ETL) process. It adeptly handles the distribution of Qualys data into various databases, offering convenient processing of CSV, JSON, and XML data formats.Centralized Data Management: QualysETL allows for the consolidation of all Qualys-generated data into a unified 'gold source' database. This central repository of data is instrumental in enhancing the overall security and compliance capabilities of an organization.Streamlined Data Processing: QualysETL takes the helm in executing API calls, thus systematically preparing Qualys data for organizational use. This level of automation and precision in data processing significantly reduces manual effort and resource allocation.Strengthened Security Posture: The combination of QualysETL and Qualys data equips organizations with the tools necessary to significantly improve their security and compliance frameworks. This collaborative effort is essential in mitigating the risks associated with cyberattacks and ensuring adherence to pertinent legal and regulatory requirements.Getting Started Made Simple: Integrating QualysETL into your organization's cybersecurity strategy is straightforward. For an easy setup, refer to theinstallation instructionsprovided in this guide.Schema - QualysETL Vulnerability Data Example.QualysETL: Transforming Cybersecurity with Success StoriesQualysETL has enhanced how customers manage their cybersecurity data. With its robust and automated pipeline, organizations efficiently funnel data into a variety of databases, enhancing security insights and decision-making. Key databases tested include:Azure CosmosDB PostgreSQLPostgreSQLAmazon RedShiftMicrosoft SQL ServerAzure SQL ServerSnowflakeMySQLSQLiteThe success stories of QualysETL are a testament to its versatility and the value it delivers:Enhanced Remediation and Reporting: Integrating Qualys data with corporate resources, customers have seen significant improvements in Remediation Reporting, Metrics, and Visualization, leading to more effective cybersecurity strategies.Advanced Data Analysis: Analysts leverage the rich data sets from Qualys for in-depth forensic examinations, gaining deeper insights into cybersecurity threats and vulnerabilities.Simplified Data Visualization: With QualysETL, simplifying and focusing data for tools like Tableau, PowerBI, or custom web applications has never been easier, enabling more intuitive and accessible cybersecurity analytics.Measurable Cyber Risk Reduction: Customers effectively Measure, Communicate, and Eliminate Cyber Risk, substantially De-Risking their business operations.QualysETL is not just limited to current functionalities. It already supports key Qualys Modules like:Vulnerability ManagementPolicy ComplianceCyberSecurity Asset ManagementWeb Application Scanning DataAnd with an eye on the future, the 2024 roadmap includes exciting additions such as Qualys Container Security and Qualys FIM, further expanding its capabilities and reinforcing its position as a valuable tool in cybersecurity data management.QualysETL Central Data BaseOnce customers have used QualysETL to gather data from various sources such as Qualys Vulnerability Data, Policy Compliance Data, CyberSecurity Asset Management Data, and Web Application Scanning data into a database, there are several critical activities they typically perform to enhance their security posture and compliance. These activities include:Data Analysis and Prioritization:Analyzing the collected data to identify and prioritize security vulnerabilities and compliance issues. This involves sorting through the vulnerabilities to determine which are most critical based on factors like severity, exploitability, and potential impact.Risk Assessment:Performing a comprehensive risk assessment using the data to understand the potential impact of identified vulnerabilities and non-compliance issues on the business.Remediation Planning:Developing remediation plans to address identified vulnerabilities and compliance gaps. This may involve patch management, configuration changes, or other corrective actions.Compliance Monitoring:Using policy compliance data to monitor adherence to internal policies and external regulatory requirements. This helps in ensuring ongoing compliance and identifying areas where policies may need to be adjusted.Asset Management:Leveraging CyberSecurity Asset Management data to maintain an up-to-date inventory of all hardware and software assets. This is crucial for effective vulnerability management and ensuring that all assets are accounted for in security planning.Trend Analysis and Reporting:Analyzing trends over time to identify recurring issues or vulnerabilities and generating reports for various stakeholders, including management, IT teams, and external regulators.Incident Response Planning:Utilizing the data to inform and improve incident response plans. By understanding where vulnerabilities exist and how they can be exploited, organizations can develop more effective response strategies.Security Policy Development and Adjustment:Refining and developing security policies based on the insights gained from the data. This might involve updating access controls, data protection strategies, or other security protocols.Training and Awareness Programs:Using insights from the data to inform security training and awareness programs. Understanding common vulnerabilities and compliance issues can help tailor training to address specific organizational needs.Integration with Other Security Tools:Integrating the database with other security tools and platforms for a more cohesive and automated security approach. This can include SIEM (Security Information and Event Management) systems, threat intelligence platforms, and automated remediation tools.Regular Audits and Assessments:Conducting regular audits and assessments to ensure that the security measures are effective and to identify areas for improvement.By effectively utilizing Qualys data, organizations can significantly enhance their security and compliance posture, reducing the likelihood of successful cyber attacks and ensuring adherence to relevant laws and regulations.Key Advantages of Using QualysETLEffortless Data Handling: QualysETL simplifies the process of Extracting, Transforming, Loading, and Distributing Qualys data with a single command, offering a no-code solution that streamlines data management.Versatile Data Preparation: The tool adeptly prepares data in various formats including XML, JSON, SQLite, and CSV. It ensures readiness for seamless integration into popular databases like MySQL, PostgreSQL, Snowflake, Amazon RedShift, and more.Real-Time Data Streaming: Features a streaming data option for the immediate ingestion of vulnerability reports or asset inventory updates, enabling timely updates to your downstream databases.User-Friendly and Quick Setup: QualysETL is designed for easy installation and use. Get it up and running in just 5 minutes on an Ubuntu 22.04 system, ensuring a smooth and swift start.Open Source Flexibility: Distributed under the Apache 2 license, QualysETL offers the benefits of open-source software, including transparency, community support, and the freedom to modify the tool to suit your specific needs.Qualys data Included in QualysETL:KnowledgeBase- QID DefinitionsHost List- Host InformationHost List Detection- Host Vulnerability InformationCyberSecurity Asset Inventory- Detailed Asset InventoryWeb Application Scanning- Web Applications and Web Application Vulnerability Findings.PCRS Policy Compliance- Policy, Host, and Host Posture Information.Release NotesNote: See the end of this document for history ofrelease notes0.8.85Added etld_config_settings.yaml option to exclude trurisk for edge case where VMDR is not enabled in customer subscription. Ex. Consulting Edition.host_list_payload_option_exclude_trurisk: Truehost_list_detection_payload_option_exclude_trurisk: True0.8.80Minor updates to documentation to highlight usage of QualysETL.Added option to etld_config_settings.yaml to manage edge case of non-utf8 data embedded in device information.When set to True, additional processing is added to replace non-utf8 data.xmltodict_parse_using_codec_to_replace_utf8_error: TrueDefault is xmltodict_parse_using_codec_to_replace_utf8_error: FalseMinor updates to first time install and upgrade instructions to add an error check to each, simplify code, and improve portability by calling out'$USER' instead of '$USERNAME'.Table of contentsExamples of UsageQuick StartInstallUninstallQualys API Best Practices SeriesWorkflow DiagramComponent DiagramBlueprintRoadmapTechnologiesETL ExamplesETL KnowledgeBaseETL Host ListETL Host List DetectionETL Asset InventoryETL Web_Application_ScanningETL Policy Compliance PCRSApplication Manager and DataHost List Detection SQLite DatabaseData FormatsLoggingApplication MonitoringSecuring Your Application in the Data CenterPassword VaultExample Run LogsUninstall and Install qetlqetl_setup_python_envqetl_manage_userqetl_manage_user Add Userqetl_manage_user ETL KnowledgeBaseReview ETL KnowledgeBase DataLicenseChangeLogRelease Notes LogUsage Information - qetl_manage_user1) Help Screen.Please enter -u [ your /opt/qetl/users/ user home directory path ]

    Note: /opt/qetl/users/newuser is the root directory for your qetl userhome directory,
    Example:
             qetl_manage_user -u /opt/qetl/users/[your_user_name]
 
    usage: qetl_manage_user [-h] [-u qetl_USER_HOME_DIR] [-e etl_[module] ] [-e validate_etl_[module] ] [-c] [-t] [-i] [-d] [-r] [-l]
    
    Command to Extract, Transform and Load Qualys data into various forms ( CSV, JSON, SQLITE3 DATABASE )
    
    optional arguments:
      -h, --help                show this help message and exit
      -u Home Directory Path,   --qetl_user_home_dir Home directory Path
                                   Example:
                                   - /opt/qetl/users/q_username
      -e etl_[module],          --execute_etl_[module] execute etl of module name. valid options are:
                                       -e etl_knowledgebase 
                                       -e etl_host_list 
                                       -e etl_host_list_detection
                                       -e etl_asset_inventory
                                       -e etl_was
                                       -e etl_pcrs
                                       -e etl_test_system ( for a small system test of all ETL Jobs )
      -e validate_etl_[module], --validate_etl_[module] [test last run of etl_[module]].  valid options are:
                                       -e validate_etl_knowledgebase
                                       -e validate_etl_host_list 
                                       -e validate_etl_host_list_detection
                                       -e validate_etl_asset_inventory
                                       -e validate_etl_was
                                       -e validate_etl_pcrs
                                       -e validate_etl_test_system 
      -d YYMMDDThh:mm:ssZ,      --datetime      YYYY-MM-DDThh:mm:ssZ UTC. Get All Data On or After Date. 
                                                Ex. 1970-01-01T00:00:00Z acts as flag to obtain all data.
      -c, --credentials        update qualys api user credentials: qualys username, password or api_fqdn_server
      -t, --test               test qualys credentials
      -i, --initialize_user    For automation, create a /opt/qetl/users/[userhome] directory 
                               without being prompted.
      -l, --logs               detailed logs sent to stdout for testing qualys credentials
      -v, --version            Help and QualysETL version information.
      -r, --report             brief report of the users directory structure.
      -p, --prompt-credentials prompt user for credentials, also accepts stdin with credentials piped to program.
      -m, --memory-credentials get credentials from environment: 
                               Example: q_username="your userid", q_password=your password, q_api_fqdn_server=api fqdn, q_gateway_fqdn_server=gateway api fqdn
      -s, --stdin-credentials  send credentials in json to stdin. 
                               Example:
                               {"q_username": "your userid", "q_password": "your password", "q_api_fqdn_server": "api fqdn", "q_gateway_fqdn_server": "gateway api fqdn"}
      
    Example: ETL Host List Detection
    
    qetl_manage_user -u [path] -e etl_host_list_detection -d 1970-01-01T00:00:00Z
    
     - qetl_manage_user will download all knowledgebase, host list and host list detection vulnerability data,
       transforming/loading it into sqlite and optionally the corresponding distribution directory.
     
     Inputs: 
       - KnowledgeBase API, Host List API, Host List Detection API.
       - ETL KnowledgeBase
         - /api/2.0/fo/knowledge_base/vuln/?action=list
       - ETL Host List
         - /api/2.0/fo/asset/host/?action=list
       - ETL Host List Detection - Stream of batches immediately ready for downstream database ingestion.
         - /api/2.0/fo/asset/host/vm/detection/?action=list
     Outputs:
       - XML, JSON, SQLITE, AND Distribution_Directory of CSV BATCH FILES PREPARED FOR DATABASE INGESTION.
         - host_list_detection_extract_dir - contains native xml and json transform of data from qualys, compressed in uniquely named batches.
         - host_list_detection_distribution_dir - contains transformed/prepared data ready for use in database loaders such as mysql.
         - host_list_detection_sqlite.db - sqlite database will contain multiple tables:
           - Q_Host_List                            - Host List Asset Data from Host List API.
           - Q_Host_List_Detection_Hosts            - Host List Asset Data from Host List Detection API. 
           - Q_Host_List_Detection_QIDS             - Host List Vulnerability Data from Host List Detection API. 
           - Q_KnowledgeBase_In_Host_List_Detection - KnowledgeBase QIDs found in Q_Host_List_Detection_QIDS. 
         
   etld_config_settings.yaml notes:
       1. To Enable CSV Distribution, add the following keys to etld_config_settings.yaml and toggle on/off them via True or False
            kb_distribution_csv_flag: True                    # populates qetl_home/data/knowledgebase_distribution_dir
            host_list_distribution_csv_flag: True             # populates qetl_home/data/host_list_distribution_dir
            host_list_detection_distribution_csv_flag: True   # populates qetl_home/data/host_list_detection_distribution_dir
            asset_inventory_distribution_csv_flag: True       # populates qetl_home/data/asset_inventory_distribution_dir
            was_distribution_csv_flag: True                   # populates qetl_home/data/was_distribution_dir
              
            These files are prepared for database load, tested with mysql.  No headers are present.  
            Contact your Qualys TAM and schedule a call with David Gregory if you need assistance with this option.2) ETL Host List Detectionqetl_manage_user -u [path] -e etl_host_list_detection -d 1970-01-01T00:00:00Z
    
     - qetl_manage_user will download all knowledgebase, host list and host list detection vulnerability data,
       transforming/loading it into sqlite and optionally the corresponding distribution directory.
     
     Inputs: 
       - KnowledgeBase API, Host List API, Host List Detection API.
       - ETL KnowledgeBase
         - /api/2.0/fo/knowledge_base/vuln/?action=list
       - ETL Host List
         - /api/2.0/fo/asset/host/?action=list
       - ETL Host List Detection - Stream of batches immediately ready for downstream database ingestion.
         - /api/2.0/fo/asset/host/vm/detection/?action=list
     Outputs:
       - XML, JSON, SQLITE, AND Distribution_Directory of CSV BATCH FILES PREPARED FOR DATABASE INGESTION.
         - host_list_detection_extract_dir - contains native xml and json transform of data from qualys, compressed in uniquely named batches.
         - host_list_detection_distribution_dir - contains transformed/prepared data ready for use in database loaders such as mysql.
         - host_list_detection_sqlite.db - sqlite database will contain multiple tables:
           - Q_Host_List                            - Host List Asset Data from Host List API.
           - Q_Host_List_Detection_Hosts            - Host List Asset Data from Host List Detection API. 
           - Q_Host_List_Detection_QIDS             - Host List Vulnerability Data from Host List Detection API. 
           - Q_KnowledgeBase_In_Host_List_Detection - KnowledgeBase QIDs found in Q_Host_List_Detection_QIDS.Schema etl_host_list_detection - Extract from host_list_detection_sqlite.db file.3) ETL Asset Inventory (GAV/CSAM API)qetl_manage_user -u [path] -e etl_asset_inventory -d 1970-01-01T00:00:00Z

     - qetl_manage_user will download all asset inventory data, transforming/loading them into sqlite.
         
     Inputs: 
       - Global Asset View/CyberSecurity Asset Management API V2.
       - ETL Asset Inventory - Stream of batches immediately ready for downstream database ingestion.
         - /rest/2.0/search/am/asset?assetLastUpdated=[date]
     Outputs:
       - JSON, SQLITE, AND Distribution_Directory of CSV BATCH FILES PREPARED FOR DATABASE INGESTION.
         - asset_inventory_extract_dir - contains json of data from qualys, compressed in uniquely named batches.
         - asset_inventory_distribution_dir - contains transformed/prepared data ready for use in database loaders such as mysql.
         - asset_inventory_sqlite.db - sqlite database will contain multiple tables:  
           *  Q_Asset_Inventory                  - Asset Inventory of Asset Last Updated -d 'DATE' to now 
           *  Q_Asset_Inventory_Software_Unique  - Unique List of Software
           *  Q_Asset_Inventory_Software_AssetId - Unique List of AssetId to SoftwareSchema etl_asset_inventory - Extract from asset_inventory_sqlite.db file.4) ETL Web Application Data (WAS API)Example: 
    
    qetl_manage_user -u [path] -e etl_was -d 1970-01-01T00:00:00Z
    
     Inputs:
       - Web Application Scanning API
         - /qps/rest/3.0/search/was/catalog
         - /qps/rest/3.0/search/was/webapp
         - /qps/rest/3.0/get/was/webapp/<id>
         - /qps/rest/3.0/search/was/finding
     Outputs:
       - was_extract_dir - contains json of data from qualys, compressed in uniquely named batches.
       - was_distribution_dir - contains transformed/prepared data ready for use in database loaders such as mysql.
       - was_sqlite.db - sqlite database will contain multiple tables:  
         *  Q_WAS_WebApp   - Web Applications and Web Application Details
         *  Q_WAS_Finding  - Web Application Findings (Vulnerabilities)
         *  Q_WAS_Catalog  - WAS Module CatalogSchema etl_was - Extract from was_sqlite.db file.5) ETL Policy Compliance through PCRSExample: 
    
    qetl_manage_user -u [path] -e etl_pcrs -d 1970-01-01T00:00:00Z ( Last Evaluated Date for Policy ).
   
     Inputs:
       - PCRS API
         - /pcrs/1.0/posture/policy/list 
         - /pcrs/1.0/posture/hostids
         - /pcrs/1.0/posture/postureInfo
     Outputs:
       - pcrs_extract_dir       - contains json of data from qualys, compressed in uniquely named batches.
       - pcrs_distribution_dir  - contains transformed/prepared data ready for use in database loaders such as mysql.
       - pcrs_sqlite.db         - sqlite database will contain multiple tables:  
         *  Q_PCRS_POLICY_LIST  - List of policies list with lastEvaluationDate=1970-01-01T00:00:00Z
         *  Q_PCRS_HOSTIDS      - List of hostids associated with each Active policy.
         *  Q_PCRS_POSTUREINFO  - Posture Information for each Host.
      
     Configuration:
       - Default:
         * Running qetl_manage_user -u [userpath] -e etl_pcrs -d [evaluation date] will result in 
           all data on or after evaluation date being pulled for all assets scanned 1 hour before evaluation date.  
         
       - /pcrs/1.0/posture/policy/list
         * qetl_manage_user -d [evaluation date]
         * etld_config_settings.yaml example:
            - pcrs_policy_list_payload_option: {'lastEvaluationDate': '2023-09-04T00:00:00Z'}
            ** See VM/PC API guide for details of parameters: https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf
                   
       - /pcrs/1.0/posture/hostids
         * qetl_manage_user -d [evaluation date] will result in lastEvaluationDate minus 1 hour = lastScanDate  
           unless overridden via etld_config_settings.yaml
         * etld_config_settings.yaml example:
            - pcrs_hostids_payload_option: {'lastScanDate': '2023-09-04T00:00:00Z'}
            ** See VM/PC API guide for details of parameters: https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf
            
       - /pcrs/1.0/posture/postureInfo
         * qetl_manage_user -d [evaluation date] will result in lastEvaluationDate minus 1 hour = lastScanDate  
           unless overridden via etld_config_settings.yaml
         * etld_config_settings.yaml examples:
            - pcrs_postureinfo_payload_option: {'lastScanDateFrom': '2023-09-10T00:00:00Z', 'lastScanDateTo': '2023-09-17T00:00:00Z', 'evidenceRequired': '0', 'statusChangedSince': '2023-09-02T00:00:00Z'}
            - pcrs_postureinfo_payload_option: {'evidenceRequired': '1'}
            - pcrs_postureinfo_payload_option: {'statusChangedSince': '2023-09-01T00:00:00Z'}
            ** See VM/PC API guide for details of parameters: https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf
            ** Optional normalized schema for PCRS, reducing space used by PostureInfo by ~50%.
            - pcrs_postureinfo_schema_normalization_flag: True 


       - etld_config_settings.yaml include/exclude policy examples:
         * Include only the following policy id's 
           pcrs_policy_id_include_list: ['123456', '334835'] 
         * Exclude the following policy ids.
           pcrs_policy_id_exclude_list: ['880900']Schema etl_pcrs - Extract from pcrs_sqlite.db file.Normalized Schema etl_pcrs - Extract from pcrs_sqlite.db file.With etld_config_settins.yaml, pcrs_postureinfo_schema_normalization_flag: True the following optimized schema will be produced by -e etl_pcrsQuick StartUbuntu 22.04 LTS latest is the primary OS to run QualysETL.Red Hat 9.x latest is an alternative OS that has been tested.Amazon Linux 2023 latest is an alternative OS that has been tested.Contact your TAM and David Gregory for details.Prerequisites Python Module on Ubuntu 22.041) Ubuntu 22.04 LTS
 2) Python 3.8.5 or Latest Stable Release
 3) On base 22.04 you'll need two additional packages.
    sudo apt-get install python3-venv  
    sudo apt install python3-pip
 4) Disk Space on Host.  
    - 100,000 hosts, expect ~400 Gigabytes for full copy of VM Data (Confirmed, Potential, Info Gathered)
    - KnowledgeBase - expect ~1 Gigabyte.
    - Host List - expect ~10 Gigabyte for 100K Hosts.
    - Host List Detection - expect ~300-400 Gigabytes for 100K Hosts.InstallationFirst Time Setup Activity on Ubuntu 22.04Login as "non-root" user that will run qualysetl.sudo root authorization required.Create your /opt/qetl application directoryupdate apt package cacheInstall python3-venvInstall python3-pipInstall sqlite3Install sqlite3 sql browserFirst Time Setup Instructions on Ubuntu 22.04#!/usr/bin/env bash# First Time Setup - Pre-create directory /opt/qetl# Login as user that will execute qetl_manage_usersudomkdir/opt/qetlsudochown$USER:$USER/opt/qetl
sudoaptupdate
sudoaptinstall-ypython3-venvpython3-pipsqlite3sqlitebrowserAlternative First Time Setup Activity on Red Hat 8.x or Red Hat 9.xLogin as "non-root" user that will run qualysetl.sudo root authorization required.Create your /opt/qetl application directoryInstall python3.9Update alternatives to point python3 at python3.9NOTE: sqlitebrowser is not part of Red Hat distribution.  You may want to install sqlitebrowser from a trusted source, or select another sqlite workbench.NOTE: On RedHat 9, sqlite3 is not included by default.  Please install sqlite3 on Red Hat 9.x.NOTE: On RedHat 9, Python3 is already at python3.9. As a result you will not need to reinstall.Alternative First Time Setup Instructions on Red Hat 8.x or Red Hat 9.xNOTE: On Red Hat 8 or 9, check to see if your distribution already has python3 version 3.9 or greater. "Ex. python3 --version".  If so, then you can skip reinstalling python and setting alternatives.#!/usr/bin/env bash# First Time Setup - Pre-create directory /opt/qetl# Login as user that will execute qetl_manage_usersudomkdir/opt/qetlsudochown$USER:$USER/opt/qetl
sudoyum-yinstallpython39
sudoalternatives--setpython3/usr/bin/python3.9Install or Upgrade QualysETL activity on Ubuntu or Red HatLogin as "non-root" user that will run qualysetl.deactivate to exit any current python virtual environment you may be in.Install/Upgrade qualysetl into your/home/$USER/.localpython directoryCreate qualysetl python virtual environment in /opt/qetl/qetl_venv,
installing all required modules in venvExecute qualysetl to see help screenInstall or Upgrade QualysETL Instructions on Ubuntu or Red Hat#!/usr/bin/env bash# Login as user that will execute qetl_manage_user# Install Application in Python Virtual Environment /opt/qetl/qetl_venv# Exit if in a Python virtual environment[-n"$VIRTUAL_ENV"]&&{echo"Please deactivate the virtual environment and rerun this script.";exit1;}python3-mpipinstall--upgradequalysetl
~/.local/bin/qetl_setup_python_venv/opt/qetlecho"Follow instructions output from qetl_setup_python_venv"Create your first qualysetl userTo setup your first user, you'll need your qualys api username, password and your api fqdn.Example transcript of setting up a new userqualysetl@ubuntu:~$source/opt/qetl/qetl_venv/bin/activate(qetl_venv)qualysetl@ubuntu:~$qetl_manage_user-u/opt/qetl/users/quays_dt4

qetl_user_home_dirdoesnotexist:/opt/qetl/users/quays_dt4/qetl_home
Createnewqetl_user_home_dir?/opt/qetl/users/quays_dt4/qetl_home(yesorno):yes

qetl_user_home_dircreated:/opt/qetl/users/quays_dt4/qetl_home

Currentusername:initialuserinconfig:/opt/qetl/users/quays_dt4/qetl_home/cred/.etld_cred.yaml
UpdateQualysusername?(yesorno):yes
EnternewQualysusername:quays_dt4
Currentapi_fqdn_server:qualysapi.qualys.com
Updateapi_fqdn_server?(yesorno):Enternewapi_fqdn_server:qualysapi.qualys.com
Updatepasswordforusername:quays_dt4
Updatepassword?(yesorno):yes
EnteryourQualyspassword:Youhaveupdatedyourcredentials.QualysUsername:quays_dt4Qualysapi_fqdn_server:qualysapi.qualys.com


Wouldyouliketotestlogin/logoutofQualys?(yesorno):yes

QualysLoginTestforquays_dt4atapi_fqdn_server:qualysapi.qualys.com

TestingQualysLoginforquays_dt4Succeededatqualysapi.qualys.comwithHTTPSReturnCode:200.

Thankyou,exiting.(qetl_venv)qualysetl@ubuntu:~$Execute your first ETL.Your initial configuration limits the total hosts downloaded to 1000 hosts vm_processed_after
utc.now - 1 day.  The initial configuration will only consume up to 2 connections.
You can test this to ensure you are able to download data before moving on to more data.Command - qetl_manage_user -u /opt/qetl/users/quays_dt4 -e etl_host_list_detectionOuputs:Full Knowledgebase on first run.Host List vm_processed_after utc.now - 1 day limited to 1000 hosts for testing.Host List Detection driven by scope of Host List.Transcript of command execution.qetl_manage_user-u/opt/qetl/users/quays_dt4-eetl_host_list_detection
Startingetl_host_list_detection.Forprogresssee:/opt/qetl/users/quays_dt4/qetl_home/log/host_list_detection.log
Endingetl_host_list_detection.Forresultssee:/opt/qetl/users/quays_dt4/qetl_home/log/host_list_detection.log
sqlitebrowser/opt/qetl/users/quays_dt4/qetl_home/data/host_list_detection_sqlite.dbSQLite Browser displaying Knowledgebase, Host List, and Host List Detection. Note that the knowledgebase in this database
only includes qids found in host list detection.  To see the full knowledgebase, open kb_sqlite.db.  Q_Host_List_Detection is a view of Q_Host_List ( PREFIX HL_ ), Q_Host_List_Detection_Hosts ( PREFIX HLDH_ ), Q_Host_List_Detectino_QIDS ( PREFIX HLDQ_ ).UninstallUninstall qualysetl activity on Ubuntu 22.04.deactivate to exit any current python virtual environment you may be in.optionally remove application/data:python virtual environment: /opt/qetl/qetl_venvqualysetl data directory: /opt/qetl/userspython3-venvpython3-pipsqlite3sqlitebroswer#!/usr/bin/env bashdeactivate# If you are in a python virtual environmentpython3-mpipuninstallqualysetl# Optionally remove python virtual env, pip, sqlite3, sqlitebrowser and users application data.# cd /opt/qetl/# rm -ir qetl_venv  # Optionally remove qetl_venv# rm -ir users      # Optionally remove users directory with data# sudo apt remove -y python3-venv python3-pip sqlite3 sqlitebrowserUninstall qualysetl activity on Red Hat 8.xdeactivate to exit any current python virtual environment you may be in.optionally remove application/data:python virtual environment: /opt/qetl/qetl_venvqualysetl data directory: /opt/qetl/users#!/usr/bin/env bashdeactivate# If you are in a python virtual environmentpython3-mpipuninstallqualysetl# Optionally remove python virtual env and user data# cd /opt/qetl/# rm -ir qetl_venv  # Optionally remove qetl_venv# rm -ir users      # Optionally remove users directory with dataJump toETL Examplesto transform Qualys data into CSV, JSON and SQLite Databases.Qualys API Best Practices SeriesThe example code from theQualys API Best Practices Seriesis being hosted here to help customers with an example blueprint to automate transformation
of data into their corporate data systems, further enhancing the visibility of outlier systems
that are vulnerable.This example code has been enhanced with some exception processing, logging, and a single point of execution
creating an operational context within which to test/develop the code so customers can build automation
into their remediation program.Workflow DiagramThe workflow depicts the flow of etl for host list detection.  The key output is the sqlite database that is ready for distributionqetl_manage_user -u [userdir] -e etl_host_list_detection -d [datetime] - Resulting sqlite database ready for distribution.Component DiagramThe component diagram depicts major system interoperability components that deliver data into the enterprise.ComponentColorPurposeExecution EnvironmentBlueHost and Cloud where this application operatesApplicationGreyApplication context to identify Local Docker, Python Application, Host and/or FilesystemsInputOrangeQualys data consumed by applicationExecutionGreenExecution ETL of Qualys data through various methods.  (The Python Execution Environment on Docker or Traditional Host)DataYellowHost Data Folders that separate Application, and Subscription Data Users along with distribution pipelines representing the distribution of data to external sources, Cloud, Client, OtherFutureBlackTBD Future State Components such as GraphQL Server.BlueprintCustomer have many options for Qualys API integration today.  Some customers realize they need to develop their own
internal code to transform complex data, create custom metrics, create custom reports or ensure data is more accessible within their organizations for metrics and custom reporting.As a result, Qualys decided on creating the API Best Practices Series to jumpstart clients with a blueprint of example code
to help them automate delivery of complex data into their enterprise.The overarching goal is to simplify our customers security stack and help them significantly reduce cost and
complexity.Key Goals and Solutions of this series are:GoalSolutionAutomate Vulnerability Data accessibility, transformation of complex data for analysisJSON, CSV, SQLite Database Formats of Qualys data readily accessible to Analytical BI Tools for on-demand analysis or for downstream loading into Enterprise Data Storage.A single query interface to Qualys dataTBD Future GraphQL Server interface to data.Automate Capturing Vulnerability Data into corporate processesBlueprint of example code customers can customize to enhance their internal automation "API-First" strategy.Automate Distribution of Vulnerability Data to Cloud ProvidersOptional Distribution methods into cloud systems such as Amazon S3 BucketAutomate Application Enhancements and DeliveryDocker application instance for reliable CI/CD delivery of enhancements, as well as traditional host execution on Linux Platforms.Provide Execution Flexibility, Work Load Management, Password SecurityBlueprint for enterprise jobstream execution (Ex. Autosys), password vaults (Ex. Hashicorp), or simple command line execution from a Virtual Machine instance of Ubuntu running on a laptop.Provide Continous Vulnerability Data PipelineBlueprint for data transformation pipeline from Qualys to Enterprise Data Stores in various formats ( JSON, CSV, SQLite Database )RoadmapCapability                    | Target    | Description
----------                    | ------    | -----------
KnowledgeBase                 | June 2021 | Automate download and transform of KnowledgeBase into CSV, JSON and SQLite Database
Host List                     | June 2021 | Automate download and transform of Host List into CSV, JSON and SQLite Database
Host List Detection           | June 2021 | Automate download and transform of Host List Detection into CSV, JSON and SQLite Database
Python Virtual Env            | June 2021 | Encapsulate qetl Application into Python Virtual Environment at installation.
Asset Inventory(CSAM)         | Oct 2021  | Automate download and transform of GAV/CSAM V2 API into CSV, JSON and SQLite Database
Performance Enhancements      | Jan 2022  | Begin 0.7.x series with performance enhancements.  See change log for details.
Asset Inventory(CSAM)         | Aug 2022  | CSAM API Blog, Video, documentation updates for CSAM, additional edge cases for Qualys Maintenance Windows.
Host List ARS                 | Aug 2022  | Host List Asset Risk Score Added to QualysETL.
Host List Detection QDS       | Aug 2022  | Host List Detection Qualys Detection Score Added to QualysETL.
Web Application Scanning(WAS) | Dec 2022  | Begin 0.8.x series, including WAS Module and Distribution Option, data prepared for database loader.
Database Injection            | Aug 2023  | Methods to inject schema/data from QualysETL into your downstream databases. Ex. Azure Cosmos DB (PostgreSQL), Amazon RedShift, PostgreSQL Open Source, MySql Open Source, SnowFlake, Microsoft SQL Server.  Contact your Qualys TAM to schedule a call with David Gregory if you wish to use this feature. 
Visualization Use Case        | Aug 2023  | Use QualysETL to build your downstream databases for use with PowerBI, Tableau, Etc. Contact your Qualys TAM to schedule a call with David Gregory if you wish to use this feature. 
QWEB 10.23 Updates            | Aug 2023  | Delivered additional fields for Host List and Host List Detection. For details see:  See [QWEB 10.23 release notification for details](https://www.qualys.com/docs/release-notes/qualys-cloud-platform-10.23-api-release-notes.pdf) 
Web Application Scanning(WAS) | Aug 2023  | Updated timing in WAS for long running jobs.
Docker Image                  | Aug 2023  | Contact your TAM to schedule a call with David Gregory.  Encapsulate Python Application into distributable docker image for ease os operation and upgrade.
Policy Compliance             | Oct 2023  | PCRS Delivered (multi-threaded). Automate download and transform of Policies, Hosts and Posture Information for your hosts. 
WAS Blog                      | Oct 2023  | Blog for WAS Module. 
Policy Compliance Blog        | Oct 2023  | Blog for Policy Compliance Module. 
Container Security            | Mar 2024  | Container Security Image and Container Vulnerability Data.
Other Modules                 | 2024      | FIM and other modules targeted for 2024 TBD.TechnologiesProject tested with:Ubuntu version: 22.04Redhat version: 8.x/9.x latestSQLite3 version: 3.31.1Python version: 3.8.5Qualys API: latestExamples of UsageCreate XML, JSON, CSV and SQLite3 Database Formats of Qualys data.ETL ConfigurationConfiguration file: /opt/qetl/users/[quser]/qetl_home/config/etld_config_settings.yamlEnsure you set these configurations:host_list_detection_concurrency_limit: 2Set this to appropriate qualys concurrency limit value after
reviewing theQualys Limits Guidehttps://www.qualys.com/docs/qualys-api-limits.pdfwith your TAM for Questions.(qetl_venv)qualysetl@ubuntu:~/.local/bin$more/opt/qetl/users/qualysetl/qetl_home/config/etld_config_settings.yaml## This file is generated by qetl_manage_user only on first invocation.# File generated by qetl_manage_user on: 2023-08-09 07:33:00## YAML File of available configuration options for Qualys API Calls and future options.# Ensure you set these configurations:##     1) host_list_detection_concurrency_limit: 2#         - Set this to appropriate qualys concurrency limit value after reviewing the#           [Qualys Limits Guide] https://www.qualys.com/docs/qualys-api-limits.pdf with your TAM for Questions.#           Note: if you exceed the endpoints concurrency limit,#                 the application will reset the concurrency limit to X-ConcurrencyLimit-Limit - 1## kb_last_modified_after: 'default'                  # Leave at default.  Knowledgebase is auto-incremental#                                                      to full knowledgebase.# kb_export_dir: 'default'                           # Leave at default until future use is developed.# kb_payload_option: 'default'                       # Leave at default until future use is developed.# kb_distribution_csv_flag: True                     # True/False Populates qetl_home/data/knowledgebase_distribution_dir## host_list_vm_processed_after: 'default'            # Leave at default until future use is developed.# host_list_payload_option: 'default'                # Leave at default until future use is developed.# host_list_export_dir: 'default'                    # Leave at default until future use is developed.# host_list_distribution_csv_flag: True              # True/False Populates qetl_home/data/host_list_distribution_dir## host_list_detection_payload_option: 'default'      # Leave at default until future use is developed.# host_list_detection_export_dir: 'default'          # Leave at default until future use is developed.# host_list_detection_vm_processed_after: 'default'  # Leave at default until future use is developed.# host_list_detection_concurrency_limit: 2           # Reset based on your subscription api concurrency limits# host_list_detection_multi_proc_batch_size: 500     # Leave at 500# host_list_detection_distribution_csv_flag: True    # True/False Populates qetl_home/data/host_list_detection_distribution_dir## asset_inventory_payload_option: 'default'          # Leave at 'default' until future use is developed.# asset_inventory_export_dir: 'default'              # Leave at 'default' until future use is developed.# asset_inventory_asset_last_updated: 'default'      # Leave at 'default' until future use is developed.# asset_inventory_distribution_csv_flag: True        # True/False Populates qetl_home/data/asset_inventory_distribution_dir## requests_module_tls_verify_status: True            # Recommend leaving at True to protect application against#                                                      man-in-middle attacks. False will set Python3 requests module#                                                      verify option to False and requests will accept any TLS#                                                      certificate presented by the server, and will ignore hostname#                                                      mismatches and/or expired certificates, which will make your#                                                      application vulnerable to man-in-the-middle (MitM) attacks#                                                      This option is useful for development testing only when you#                                                      are behind a reverse proxy, ex. Data Loss Prevention solution,#                                                      and you haven't installed the trusted certificates yet.# was_distribution_csv_flag: True                    # True/False Populates qetl_home/data/was_distribution_dirrequests_module_tls_verify_status:True

kb_last_modified_after:'default'kb_export_dir:'default'kb_payload_option:'default'kb_distribution_csv_flag:True

host_list_vm_processed_after:'default'host_list_export_dir:'default'host_list_distribution_csv_flag:True

host_list_detection_payload_option:'default'host_list_detection_export_dir:'default'host_list_detection_vm_processed_after:'default'host_list_detection_concurrency_limit:8host_list_detection_multi_proc_batch_size:500host_list_detection_distribution_csv_flag:True

asset_inventory_payload_option:'default'asset_inventory_export_dir:'default'asset_inventory_asset_last_updated:'default'asset_inventory_distribution_csv_flag:True

was_distribution_csv_flag:TrueETL ExamplesETL KnowledgeBaseKnowledgeBase ETL - Incremental Update to Knowledgebase.  CSV, JSON, SQLite are full knowledgebase.  XML is incremental.note the knowledgebase will rebuild itself every 30-90 days to ensure gdbm is reorganized.qetl_manage_user-u/opt/qetl/users/quser-eetl_knowledgebaseETL Host ListHost List ETL - Download Host List based on dateif no date is used, Host List will auto increment from last run
( max LAST_VULN_SCAN_DATETIME ) or if no sqlite database exists
it download start incremental pull from utc minus 1 day.qetl_manage_user-u/opt/qetl/users/quser-eetl_host_list-d[YYYY-MM-DDThh:mm:ssZ]SeeApplication Manager and Datafor location of your qetl_home directory.ETL Host List DetectionHost List Detection ETL - Includes KnowledgeBase and Host List so do not run ETL Host List or ETL KnowledgeBase while Host List Detection ETL is runnning..if no date is used, The Host List Driver will auto increment from last run
( max LAST_VULN_SCAN_DATETIME ) or if no sqlite database exists
it download start incremental pull from utc minus 1 day.qetl_manage_user-u/opt/qetl/users/quser-eetl_host_list_detection-d[YYYY-MM-DDThh:mm:ssZ]ETL Asset InventoryAsset Inventory (GAV/CSAM API) ETL - Includes CyberSecurity Asset Inventory API (CSAM) or its subset Global Asset View API (GAV).if no date is used, The Asset Inventory will be pulled from UTC - one day.qetl_manage_user-u/opt/qetl/users/quser-eetl_asset_inventory-d[YYYY-MM-DDThh:mm:ssZ]ETL Web Application Scanning DataWeb Application Scanning (WAS API) ETL - Includes Web Applications, Web Application Findings and the Web Application Catalog.qetl_manage_user-u/opt/qetl/users/quser-eetl_was-d[YYYY-MM-DDThh:mm:ssZ]ETL Policy Compliance PCRSPolicy Compliance (PCRS API) ETL - Includes Policy, Host, and Posture Information for your host assets.qetl_manage_user-u/opt/qetl/users/quser-eetl_pcrs-d[YYYY-MM-DDThh:mm:ssZ]ETL Test SystemTest System ETL - Small system test to validate modules are all working.log/test_system.log will contain all results.Executes Programs:etl_knowledgebase - updates knowledgebase up to date.etl_host_list ( 75 hosts )etl_host_list_detection ( 75 hosts )etl_asset_inventory ( 900 hosts )etl_was ( subset of applications )etl_pcrs ( subset of applications )qetl_manage_user-u/opt/qetl/users/quser-eetl_test_systemApplication Manager and Dataqetl_manage_user applicationqetl_manage_user is your entry point to manage ETL of Qualys data.Host List Detection SQLite Databaseqetl_manage_user -u [userdir] -e etl_host_list_detection -d [datetime] - Resulting sqlite database ready for distribution.EnvironmentPython virtual environmentManaged by qetl_manage_userExample options for qetl Home Directories:Prod: /opt/qetl/users/[user_name]/qetl_homeTest: /usr/local/test/opt/qetl/users/[user_name]/qetl_homeDev:  $HOME/opt/qetl/users/[user_name]/qetl_homeApplication DirectoriesPathDescriptionopt/qetl/users/Directory of All Usersopt/qetl/users/[user]/qetl_homeParent directory path for a user[user]/qetl_homeUser Home Directoryqetl_home/binUser bin directory for customer to host scripts they create.qetl_home/credCredentials Directoryqetl_home/cred/.etld_lib_credentials.yamlCredentials file in yaml format.qetl_home/cred/.qualys_cookieCookie file used for Qualys session management.qetl_home/configApplication Options Configuration Directoryqetl_home/config/etld_lib_config_settings.yamlApplication Optionsqetl_home/logLogs - Directory of all run logsqetl_home/log/kb.logLOG KnowledgeBase Run Logsqetl_home/log/host_list.logLOG - Host List Run Logsqetl_home/log/host_list_detection.logLOG - Host List Detection Run Logsqetl_home/log/asset_inventory.logLOG - GAV/CSAM Asset Inventory Run Logsqetl_home/log/was.logLOG - Web Application Scanning(WAS) Run Logsqetl_home/log/pcrs.logLOG - PCRS API Run Logsqetl_home/dataApplication Data - Directory containing all csv, xml, json, sqlite database data.qetl_home/data/kb_sqlite.dbDatabase - Cumulative Knowledgebase SQLite Databaseqetl_home/data/host_list_sqlite.dbDatabase - vm_last_processed Host List SQLite Databaseqetl_home/data/host_list_detection_sqlite.dbDatabase - vm_last_processed Host List Detection SQLite Databaseqetl_home/data/asset_inventory_sqlite.dbDatabase -lastScanDate Asset Inventory SQLite Databaseqetl_home/data/was_sqlite.dbDatabase - WebApp lastScan.date SQLite Databaseqetl_home/data/pcrs_sqlite.dbDatabase - PCRS SQLite Databaseqetl_home/data/knowledgebase_extract_dirExtract - latest *.json.gz, *.xml.gz filesqetl_home/data/host_list_extract_dirExtract - latest *.json.gz, *.xml.gz filesqetl_home/data/host_list_detection_extract_dirExtract - vm_last_processed Host List Detection XML Data Dirqetl_home/data/asset_inventory_extract_dirExtract - Asset Inventory Extracts of last scan date of asset in JSON Format.qetl_home/data/was_extract_dirExtract - Web Application Scanning (WAS) JSON Data Dirqetl_home/data/pcrs_extract_dirExtract - PCRS JSON Data Dirqetl_home/data/knowledgebase_distribution_dirDistribution - latest *.csv.gz files if option set in etld_config.settings.yamlqetl_home/data/host_list_distribution_dirDistribution - latest *.csv.gz files if option set in etld_config.settings.yamlqetl_home/data/host_list_detection_distribution_dirDistribution - latest *.csv.gz files if option set in etld_config.settings.yamlqetl_home/data/asset_inventory_distribution_dirDistribution - latest *.csv.gz files if option set in etld_config.settings.yamlqetl_home/data/was_distribution_dirDistribution - latest *.csv.gz files if option set in etld_config.settings.yamlqetl_home/data/pcrs_distribution_dirDistribution - latest *.csv.gz files if option set in etld_config.settings.yamlData FormatsData Formats created in qetl_home/data:FormatDescriptionJSONJava Script Object Notationuseful for transfer of data between systemsCSVComma Separated Valuesuseful for transfer of data between systemsFormatted to help import data into various BI or Database Tools:  Excel, Apache Open Office, Libre Office, Tableau, Microsoft PowerBI, SQL Database LoaderXMLExtensible Markup Languageuseful for transfer of data between systemsSQLite DatabaseSQLite Database: SQLite Database populated with Qualys data, Useful as a self-contained SQL Database of Qualys data for Analysis, Useful as an intermediary transformation into your overall Enterprise ETL Process, SQLite is an in-process library that implements a self-contained, serverless, zero-configuration, transactional SQL database engineLoggingLogging fields are pipe delimited with some formatting for raw readability.  You can easily import this data into excel,
a database for analysis or link this data to a monitoring system.FormatDescriptionYYYY-MM-DD hh:mm:ss,msUTC Date and Time.  UTC is used to match internal date and time within Qualys data.Logging LevelINFO, ERROR, WARNING, etc.  Logging levels can be used for troubleshooting or remote monitoring for ERROR/WARNING log entries.Module Name: YYYYMMDDHHMMSSTop Level qetl Application Module Name that is executing, along with date to uniquely identify all log entries associated with that job.User NameOperating System User executing this application.Function Nameqetl Application Function Executing.Messageqetl Application Messages describing actions, providing data.SeeApplication Directoriesfor details of each log file.cdqetl_home/log
head-3kb.log(qetl_venv)qualysetl@ubuntu:/opt/qetl/qetl_venv/bin$cat/opt/qetl/users/qualys_user/qetl_home/log/kb.log|nl12021-05-2801:26:03,836|INFO|etl_knowledgebase:20210528012603|dgregory|setup_logging_stdout|LOGGINGSUCCESSFULLYSETUPFORSTREAMING22021-05-2801:26:03,836|INFO|etl_knowledgebase:20210528012603|dgregory|setup_logging_stdout|PROGRAM:['/home/dgregory/opt/qetl/qetl_venv/bin/qetl_manage_user','-u','/opt/qetl/users/qualys_user','-e','etl_knowledgebase']32021-05-2801:26:03,897|INFO|etl_knowledgebase:20210528012603|dgregory|check_python_version|Pythonversionfoundis:['3.8.5 (default, Jan 27 2021, 15:41:15) ','[GCC 9.3.0]']42021-05-2801:26:03,897|INFO|etl_knowledgebase:20210528012603|dgregory|get_sqlite_version|SQLiteversionfoundis:3.31.1.52021-05-2801:26:03,898|INFO|etl_knowledgebase:20210528012603|dgregory|set_qetl_code_dir|parentqetlcodedir-/home/dgregory/opt/qetl/qetl_venv/lib/python3.8/site-packagesApplication MonitoringTo monitor the application for issues, the logging format includes a logging level.Monitoring for ERROR will help identify issues and tend to the overall health of the applicaiton operation.Securing Your Application in the Data CenterFollow your corporate procedures for securing your application.  A key recommendation is to use a password vault
or remote invocation method that passes the credentials at run time so the password isn't stored on the system.Password VaultQualysETL provides options to inject credentials at runtime via qetl_manage_user, so your credentials are not stored on disk.qetl_manage_user options to inject credentials at runtime are:-p, --prompt-credentials prompt user for credentials, also accepts stdin with credentials piped to program.-m, --memory-credentials get credentials from environment: q_username, q_password, q_api_fqdn_server-s, --stdin-credentials  send credentials in json to stdin.
Example:
{"q_username": "your userid", "q_password": "your password", "q_api_fqdn_server": "api fqdn", "q_gateway_fqdn_server": "gateway api fqdn"}Qualys recommends customers move to a password vault of their choosing to operate this applications credentials.
By creating functions to obtain credentials from your corporations password vault, you can improve
the security of your application by separating the password from the machine, injecting the credentials at runtime.One way customers can do this is through a work load management solution, where the external work load management
system ( Ex. Autosys ) schedules jobs injecting the required credentials to QualysETL application at runtime.  This eliminates
the need to store credentials locally on your system.If you are unfamiliar with password vaults, here is one example from Hashicorp.Hashicorp Products VaultHashicorp Getting StartedExample Run LogsUninstall Run LogMake sure you are not in your Python Virtual Environment when running uninstall.Notice the command prompt does not include (qetl_env).  That means you have deactivated the Python3 Virtual Environment(qetl_venv)qualysetl@ubuntu:~$deactivate

qualysetl@ubuntu:~/.local/bin$python3-mpipuninstallqualysetl
Foundexistinginstallation:qualysetl0.6.30
Uninstallingqualysetl-0.6.30:Wouldremove:/home/dgregory/.local/bin/qetl_setup_python_venv/home/dgregory/.local/lib/python3.8/site-packages/qualys_etl/*/home/dgregory/.local/lib/python3.8/site-packages/qualysetl-0.6.30.dist-info/*
Proceed(y/n)?ySuccessfullyuninstalledqualysetl-0.6.30
qualysetl@ubuntu:~/.local/bin$Install Run LogMake sure you are not in your Python Virtual Environment when installing this software.Notice the command prompt does not include (qetl_env).(qetl_env)qualysetl@ubuntu:~$deactivate
qualysetl@ubuntu:~$python3-mpipinstallqualysetl
CollectingqualysetlDownloadingqualysetl-0.6.30-py3-none-any.whl(79kB)|████████████████████████████████|79kB1.8MB/sInstallingcollectedpackages:qualysetl
Successfullyinstalledqualysetl-0.6.30
qualysetl@ubuntu:~$qetl_setup_python_env Run Logqualysetl@ubuntu:~/.local/bin$./qetl_setup_python_venv/opt/qetl
Startqetl_setup_python_venv-FriJan2107:07:22PST20221)test_os_for_required_commands2)test_for_pip_connectivity3)prepare_opt_qetl_env_dirsusage:qetl_setup_python_venv[/opt/qetl][test|prod][versionnumber]qetl_setup_python_venv[-h]forhelpdescription:Createapython3virtualenvironmentandinstallthequalysetlapplicationintothatenvironmentforusage.Thisisolatesthequalysetlapplicationdependenciestothepython3virtualenvironment.Seehttps://pypi.org/project/qualysetl/forfirsttimesetupandinstallationinstructions.options:qetl_setup_python_venv[/opt/qetl][test|prod][versionnumber]1)[/opt/qetl]-rootdirectorywhereapplicationanddatawillbestored.-Youmustberoottocreatethisdirectory.-Seehttps://pypi.org/project/qualysetl/forfirsttimesetup/installationinstructions.2)[test|prod]-obtainQualysETLfromtestorprodpypiinstance.3)[versionnumber]-obtainversionnumberofqualysetl.examples:1)qetl_setup_python_venv/opt/qetl-Ensureyouhave/opt/qetldirectorycreatedbeforerunningthisprogram.-CreatesQualysETLEnvironment.Seedirectoryinformationbelow.2)qetl_setup_python_venv/opt/qetlprod0.6.131-willinstallversion0.6.131ofqualysetlfrompypi.orgintoyour/opt/qetl/qetl_venvdirectory.3)qetl_setup_python_venv/opt/qetltest0.6.131-willinstallversion0.6.131ofqualysetlfromtest.pypi.orgintoyour/opt/qetl/qetl_venvdirectory.directoryinformation:/opt/qetl-rootdirectoryforApplicationandData/opt/qetl/qetl_venv-applicationdirectoryforQualysETLPythonVirtualEnvironment/opt/qetl/users-datadirectorycontainingresultsofQualysETLexecution.files:Seehttps://dg-cafe.github.io/qualysetl/#application-manager-and-datacontainernotes:1)Forcontainerdeployment,exdocker,applicationanddataareseparatedforcontainerdeployment.ContainerApplication-/opt/qetl/qetl_venvshouldinstalledintothecontainerimage.PersistentData-/opt/qetl/usersshouldbemappedtotheunderlyinghostsystemforpersistentstorageofapplicationdata.


CreateqetlPythonEnvironment?/opt/qetl/qetl_venvprod:latest
Doyouwanttocreateyourpython3virtualenvironmentforqetl?(yesorno)yes

ok,creatingpython3virtual/opt/qetl/qetl_venv4)create_qetl_python_venv-willrunforabout1-2minutes1PackageVersion2------------------------3boto31.17.974botocore1.20.975certifi2021.5.306chardet4.0.07idna2.108jmespath0.10.09oschmod0.3.1210pip20.0.211pkg-resources0.0.012python-dateutil2.8.113PyYAML5.4.114qualysetl0.6.3515requests2.25.116s3transfer0.4.217setuptools57.0.018six1.16.019urllib31.26.520wheel0.36.221xmltodict0.12.01Name:qualysetl2Version:0.6.353Summary:QualysAPIBestPracticesSeries-ETLBlueprintExampleCodewithinPythonVirtualEnvironment4Home-page:https://dg-cafe.github.io/qualysetl/5Author:DavidGregory6Author-email:dgregory@qualys.com,dave@davidgregory.com7License:Apache8Location:/opt/qetl/qetl_venv/lib/python3.8/site-packages9Requires:10Required-by:Success!Yourpythonvirtualenvironmentforqetlis:/opt/qetl/qetl_venvYourpython3venvseparatesyourbasepythoninstallationfromtheqetlpythonrequirementsandisyourentrytoexecutingtheqetl_manage_userapplication.Yourbaseqetlinstallationhasmovedtoyourpythonvirtualenvironment:/opt/qetl/qetl_venv!!!savethesecommandsastheyareyourentrytoruntheqetlapplication1)source/opt/qetl/qetl_venv/bin/activate2)/opt/qetl/qetl_venv/bin/qetl_manage_user(Yourentrypointtooperatingqualysetl)Nextsteps:Enteryourpython3virtualenvironmentandbegintestingqualysconnectivity.1)source/opt/qetl/qetl_venv/bin/activate2)/opt/qetl/qetl_venv/bin/qetl_manage_user

Endqetl_setup_python_venv-Thu17Jun202108:40:04PMPDT
qualysetl@ubuntu:~/.local/bin$qetl_manage_userYou can execute qetl_manage_user to see options available.  To operate the qetl_manage_user
application you'll first enter the python3 virtual environment, then execute qetl_manage_user.(qetl_venv)qualysetl@ubuntu:~/.local/bin$qetl_manage_userusage:qetl_manage_user[-h][-uqetl_USER_HOME_DIR][-eetl_[module]][-evalidate_etl_[module]][-c][-t][-i][-d][-r][-l]CommandtoExtract,TransformandLoadQualysdataintovariousforms(CSV,JSON,SQLITE3DATABASE)optionalarguments:-h,--helpshowthishelpmessageandexit-uHomeDirectoryPath,--qetl_user_home_dirHomedirectoryPathExample:-/opt/qetl/users/q_username-eetl_[module],--execute_etl_[module]executeetlofmodulename.validoptionsare:-eetl_knowledgebase-eetl_host_list-eetl_host_list_detection-eetl_asset_inventory-eetl_was-eetl_pcrs-eetl_test_system(forasmallsystemtestofallETLJobs)-evalidate_etl_[module],--validate_etl_[module][testlastrunofetl_[module]].validoptionsare:-evalidate_etl_knowledgebase-evalidate_etl_host_list-evalidate_etl_host_list_detection-evalidate_etl_asset_inventory-evalidate_etl_was-evalidate_etl_pcrs-evalidate_etl_test_system-dYYMMDDThh:mm:ssZ,--datetimeYYYY-MM-DDThh:mm:ssZUTC.GetAllDataOnorAfterDate.Ex.1970-01-01T00:00:00Zactsasflagtoobtainalldata.-c,--credentialsupdatequalysapiusercredentials:qualysusername,passwordorapi_fqdn_server-t,--testtestqualyscredentials-i,--initialize_userForautomation,createa/opt/qetl/users/[userhome]directorywithoutbeingprompted.-l,--logsdetailedlogssenttostdoutfortestingqualyscredentials-v,--versionHelpandQualysETLversioninformation.-r,--reportbriefreportoftheusersdirectorystructure.-p,--prompt-credentialspromptuserforcredentials,alsoacceptsstdinwithcredentialspipedtoprogram.-m,--memory-credentialsgetcredentialsfromenvironment:Example:q_username="your userid",q_password=yourpassword,q_api_fqdn_server=apifqdn,q_gateway_fqdn_server=gatewayapifqdn-s,--stdin-credentialssendcredentialsinjsontostdin.Example:{"q_username":"your userid","q_password":"your password","q_api_fqdn_server":"api fqdn","q_gateway_fqdn_server":"gateway api fqdn"}etld_config_settings.yamlnotes:1.ToEnableCSVDistribution,addthefollowingkeystoetld_config_settings.yamlandtoggleon/offthemviaTrueorFalsekb_distribution_csv_flag:True# populates qetl_home/data/knowledgebase_distribution_dirhost_list_distribution_csv_flag:True# populates qetl_home/data/host_list_distribution_dirhost_list_detection_distribution_csv_flag:True# populates qetl_home/data/host_list_detection_distribution_dirasset_inventory_distribution_csv_flag:True# populates qetl_home/data/asset_inventory_distribution_dirwas_distribution_csv_flag:True# populates qetl_home/data/was_distribution_dirThesefilesarepreparedfordatabaseload,testedwithmysql.Noheadersarepresent.ContactyourQualysTAMandscheduleacallwithDavidGregoryifyouneedassistancewiththisoption.qetl_manage_user Add UserTo add a new user, execute qetl_manage_user -u [opt/users/your_new_user].  See example run log below.qualysetl@ubuntu:~$source/opt/qetl/qetl_venv/bin/activate(qetl_venv)qualysetl@ubuntu:~$qetl_manage_userPleaseenter-u[your/opt/qetl/users/userhomedirectorypath]Note:/opt/qetl/users/newuseristherootdirectoryforyourqetluserhomedirectory,enteranewpathincludingtheopt/qetl/users/newuserinthepathyouhaveauthorizationtowriteto.theprefixtoyouruserdirectoryopt/qetl/usersisrequired.Example:1)/opt/qetl/users/newuserusage:qetl_manage_user[-h][-uQETL_USER_HOME_DIR][-eEXECUTE_ETL_MODULE][-dDATETIME][-c][-t][-l][-p][-s][-m][-r]CommandtoExtract,TransformandLoadQualysdataintovariousforms(CSV,JSON,SQLITE3DATABASE)optionalarguments:-h,--helpshowthishelpmessageandexit-uQETL_USER_HOME_DIR,--qetl_user_home_dirQETL_USER_HOME_DIRPleaseenter-uoption-eEXECUTE_ETL_MODULE,--execute_etl_moduleEXECUTE_ETL_MODULEExecuteetl_knowledgebase,etl_host_list,etl_host_list_detection,etl_asset_inventory,etl_was,etl_pcrs,etl_test_system-dDATETIME,--datetimeDATETIMEYYYY-MM-DDThh:mm:ssZUTC.GetAllDataOnorAfterDate.Ex.1970-01-01T00:00:00Zactsasflagtoobtainalldata.-c,--credentialsupdatequalysapiusercredentialsstoredondisk:qualysusername,passwordorapi_fqdn_server-t,--testtestqualyscredentials-l,--logsdetailedlogssenttostdoutfortestqualyscredentials-p,--prompt_credentialspromptuserforcredentials-s,--stdin_credentialsreadstdincredentialsjson{"q_username":"your userid","q_password":"your password","q_api_fqdn_server":"api fqdn","q_gateway_fqdn_server":"gateway api fqdn"}-m,--memory_credentialsGetcredentialsfromenvironmentvariablesinmemory:q_username,q_password,q_api_fqdn_server,andoptionallyaddq_gateway_fqdn_server.Ex.exportq_username=myuser-r,--reportBriefreportoftheusersdirectorystructure.(qetl_venv)qualysetl@ubuntu:~$qetl_manage_user-u/opt/qetl/users/qqusr_dt4

qetl_user_home_dirdoesnotexist:/opt/qetl/users/qqusr_dt4/qetl_home
Createnewqetl_user_home_dir?/opt/qetl/users/qqusr_dt4/qetl_home(yesorno):yes

qetl_user_home_dircreated:/opt/qetl/users/qqusr_dt4/qetl_home


Currentusername:initialuserinconfig:/opt/qetl/users/qqusr_dt4/qetl_home/cred/.etld_cred.yaml
UpdateQualysusername?(yesorno):yes
EnternewQualysusername:qqusr_dt4
Currentapi_fqdn_server:qualysapi.qualys.com
Updateapi_fqdn_server?(yesorno):no
Updatepasswordforusername:qqusr_dt4
Updatepassword?(yesorno):yes
EnteryourQualyspassword:
Youhaveupdatedyourcredentials.QualysUsername:qqusr_dt4Qualysapi_fqdn_server:qualysapi.qualys.com


Wouldyouliketotestlogin/logoutofQualys?(yesorno):yes

QualysLoginTestforqqusr_dt4atapi_fqdn_server:qualysapi.qualys.com

TestingQualysLoginforqqusr_dt4Succeededatqualysapi.qualys.comwithHTTPSReturnCode:200.

Thankyou,exiting.(qetl_venv)qualysetl@ubuntu:~/opt/qetl/qetl_venv/bin$qetl_manage_user ETL KnowledgeBase(qetl_venv)qualysetl@ubuntu:~/opt/qetl/qetl_venv/bin$qetl_manage_user-u/opt/qetl/users/qualys_user-eetl_knowledgebase
Startingetl_knowledgebase.Forprogressseeyour/opt/qetl/users/qualys_user/qetl_homelogdirectory
Endetl_knowledgebase.Forprogressseeyour/opt/qetl/users/qualys_user/qetl_homelogdirectory(qetl_venv)qualysetl@ubuntu:~/opt/qetl/qetl_venv/bin$cat/opt/qetl/users/qualys_user/qetl_home/log/kb.log|nl12021-05-2801:26:03,836|INFO|etl_knowledgebase:20210528012603|dgregory|setup_logging_stdout|LOGGINGSUCCESSFULLYSETUPFORSTREAMING22021-05-2801:26:03,836|INFO|etl_knowledgebase:20210528012603|dgregory|setup_logging_stdout|PROGRAM:['/home/dgregory/opt/qetl/qetl_venv/bin/qetl_manage_user','-u','/opt/qetl/users/qualys_user','-e','etl_knowledgebase: 20210528012603']32021-05-2801:26:03,897|INFO|etl_knowledgebase:20210528012603|dgregory|check_python_version|Pythonversionfoundis:['3.8.5 (default, Jan 27 2021, 15:41:15) ','[GCC 9.3.0]']42021-05-2801:26:03,897|INFO|etl_knowledgebase:20210528012603|dgregory|get_sqlite_version|SQLiteversionfoundis:3.31.1.52021-05-2801:26:03,898|INFO|etl_knowledgebase:20210528012603|dgregory|set_qetl_code_dir|parentqetlcodedir-/home/dgregory/opt/qetl/qetl_venv/lib/python3.8/site-packages62021-05-2801:26:03,898|INFO|etl_knowledgebase:20210528012603|dgregory|set_qetl_code_dir|childqetlcodedir-/home/dgregory/opt/qetl/qetl_venv/lib/python3.8/site-packages/qualys_etl72021-05-2801:26:03,898|INFO|etl_knowledgebase:20210528012603|dgregory|set_qetl_code_dir|etld_lib-/home/dgregory/opt/qetl/qetl_venv/lib/python3.8/site-packages/qualys_etl/etld_lib82021-05-2801:26:03,898|INFO|etl_knowledgebase:20210528012603|dgregory|set_qetl_code_dir|etld_templates-/home/dgregory/opt/qetl/qetl_venv/lib/python3.8/site-packages/qualys_etl/etld_templates92021-05-2801:26:03,898|INFO|etl_knowledgebase:20210528012603|dgregory|set_qetl_code_dir|etld_knowledgebase-/home/dgregory/opt/qetl/qetl_venv/lib/python3.8/site-packages/qualys_etl/etld_knowledgebase102021-05-2801:26:03,898|INFO|etl_knowledgebase:20210528012603|dgregory|set_qetl_code_dir|etld_host_list-/home/dgregory/opt/qetl/qetl_venv/lib/python3.8/site-packages/qualys_etl/etld_host_list112021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|parentuserappdir-/opt/qetl/users/qualys_user122021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|userhomedirectory-/opt/qetl/users/qualys_user/qetl_home132021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|qetl_user_root_dir-Userrootdir-/opt/qetl/users142021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|qetl_user_home_dir-qualysuser-/opt/qetl/users/qualys_user/qetl_home152021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|qetl_user_data_dir-xml,json,csv,sqlite-/opt/qetl/users/qualys_user/qetl_home/data162021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|qetl_user_log_dir-logfiles-/opt/qetl/users/qualys_user/qetl_home/log172021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|qetl_user_config_dir-yamlconfiguration-/opt/qetl/users/qualys_user/qetl_home/config182021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|qetl_user_cred_dir-yamlcredentials-/opt/qetl/users/qualys_user/qetl_home/cred192021-05-2801:26:03,900|INFO|etl_knowledgebase:20210528012603|dgregory|setup_user_home_directories|qetl_user_bin_dir-etlscripts-/opt/qetl/users/qualys_user/qetl_home/bin202021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|load_etld_lib_config_settings_yaml|etld_config_settings.yaml-kb_last_modified_after:default212021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|load_etld_lib_config_settings_yaml|etld_config_settings.yaml-kb_export_dir:default222021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|load_etld_lib_config_settings_yaml|etld_config_settings.yaml-host_list_vm_processed_after:default232021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|load_etld_lib_config_settings_yaml|etld_config_settings.yaml-host_list_payload_option:notags242021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|setup_kb_vars|knowledgeBaseconfig-/opt/qetl/users/qualys_user/qetl_home/config/etld_config_settings.yaml252021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|setup_kb_vars|kb_export_dirisdirectfromyaml262021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|setup_kb_vars|kb_last_modified_afterutc.nowminus7days-2021-05-21T00:00:00Z272021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|setup_host_list_vars|hostlistconfig-/opt/qetl/users/qualys_user/qetl_home/config/etld_config_settings.yaml282021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|setup_host_list_vars|host_list_vm_processed_afterutc.nowminus7days-2021-05-27T00:00:00Z292021-05-2801:26:03,902|INFO|etl_knowledgebase:20210528012603|dgregory|setup_host_list_vars|host_list_payload_optionyaml-notags302021-05-2801:26:03,906|INFO|etl_knowledgebase:20210528012603|dgregory|spawn_etl_in_background|JobPID247944kb_etl_workflowjobrunninginbackground.312021-05-2801:26:03,907|INFO|etl_knowledgebase:20210528012603|dgregory|kb_start_wrapper|__start__kb_etl_workflow['/home/dgregory/opt/qetl/qetl_venv/bin/qetl_manage_user','-u','/opt/qetl/users/qualys_user','-e','etl_knowledgebase: 20210528012603']322021-05-2801:26:03,907|INFO|etl_knowledgebase:20210528012603|dgregory|kb_start_wrapper|datadirectory:/opt/qetl/users/qualys_user/qetl_home/data332021-05-2801:26:03,907|INFO|etl_knowledgebase:20210528012603|dgregory|kb_start_wrapper|configfile:/opt/qetl/users/qualys_user/qetl_home/config/etld_config_settings.yaml342021-05-2801:26:03,907|INFO|etl_knowledgebase:20210528012603|dgregory|kb_start_wrapper|credyamlfile:/opt/qetl/users/qualys_user/qetl_home/cred/.etld_cred.yaml352021-05-2801:26:03,907|INFO|etl_knowledgebase:20210528012603|dgregory|kb_start_wrapper|cookiefile:/opt/qetl/users/qualys_user/qetl_home/cred/.etld_cookie362021-05-2801:26:03,907|INFO|etl_knowledgebase:20210528012603|dgregory|kb_extract_wrapper|startknowledgebase_extractxmlfromqualyswithkb_last_modified_after=2021-05-21T00:00:00Z372021-05-2801:26:03,907|INFO|etl_knowledgebase:20210528012603|dgregory|knowledgebase_extract|start382021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|get_cred|Foundyoursubscriptioncredentialsfile:/opt/qetl/users/qualys_user/qetl_home/cred/.etld_cred.yaml392021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|get_cred|username:quays93402021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|get_cred|api_fqdn_server:qualysapi.qg2.apps.qualys.com412021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|get_cred|**Warning:EnsureCredentialFilepermissionsarecorrectforyourcompany.422021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|get_cred|**Warning:CredentialsFile:/opt/qetl/users/qualys_user/qetl_home/cred/.etld_cred.yaml432021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|get_cred|**Permissionsare:-rw-------for/opt/qetl/users/qualys_user/qetl_home/cred/.etld_cred.yaml442021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|knowledgebase_extract|apicall-https://qualysapi.qg2.apps.qualys.com/api/2.0/fo/knowledge_base/vuln/452021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|knowledgebase_extract|apioptions-{'action':'list','details':'All','show_disabled_flag':'1','show_qid_change_log':'1','show_supported_modules_info':'1','show_pci_reasons':'1','last_modified_after':'2021-05-21T00:00:00Z'}462021-05-2801:26:03,909|INFO|etl_knowledgebase:20210528012603|dgregory|knowledgebase_extract|cookie-False472021-05-2801:26:05,717|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|inputfile-https://qualysapi.qg2.apps.qualys.com/api/2.0/fo/knowledge_base/vuln/size:changetime:482021-05-2801:26:05,718|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|outputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb.xmlsize:728.51kilobyteschangetime:2021-05-2721:26:05localtimezone492021-05-2801:26:05,718|INFO|etl_knowledgebase:20210528012603|dgregory|knowledgebase_extract|end502021-05-2801:26:05,718|INFO|etl_knowledgebase:20210528012603|dgregory|kb_extract_wrapper|endknowledgebase_extractxmlfromqualys512021-05-2801:26:05,719|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_shelve_wrapper|startkb_shelvexmltoshelve522021-05-2801:26:05,719|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_shelve_wrapper|inputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb.xml532021-05-2801:26:05,719|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_shelve_wrapper|outputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve542021-05-2801:26:05,719|INFO|etl_knowledgebase:20210528012603|dgregory|kb_shelve|start552021-05-2801:26:05,744|INFO|etl_knowledgebase:20210528012603|dgregory|log_dbm_info|dbmetl_workflow_validation_type-dbm.gnu-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve562021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|kb_shelve|countqualysqidaddedtoshelve:137for/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve572021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|inputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb.xmlsize:728.51kilobyteschangetime:2021-05-2721:26:05localtimezone582021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|log_dbm_info|dbmetl_workflow_validation_type-dbm.gnu-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve592021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|outputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelvesize:632.00kilobyteschangetime:2021-05-2721:26:05localtimezone602021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|kb_shelve|end612021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_shelve_wrapper|endkb_shelvexmltoshelve622021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_json_wrapper|startkb_load_jsontransformShelvetoJSON632021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_json_wrapper|inputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve642021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_json_wrapper|outputFile:/opt/qetl/users/qualys_user/qetl_home/data/kb.json652021-05-2801:26:05,815|INFO|etl_knowledgebase:20210528012603|dgregory|kb_load_json|start662021-05-2801:26:05,840|INFO|etl_knowledgebase:20210528012603|dgregory|kb_load_json|countqidloadedtojson:137672021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|inputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelvesize:632.00kilobyteschangetime:2021-05-2721:26:05localtimezone682021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|log_dbm_info|dbmetl_workflow_validation_type-dbm.gnu-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve692021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|outputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb.jsonsize:645.81kilobyteschangetime:2021-05-2721:26:05localtimezone702021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|kb_load_json|end712021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_json_wrapper|endkb_load_jsontransformShelvetoJSON722021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_csv_wrapper|startkb_load_csv-shelvetocsv732021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_csv_wrapper|inputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve742021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_csv_wrapper|outputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb.csv752021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_csv_wrapper|outputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb_cve_qid_map.csvcve->qidmapincsvformat762021-05-2801:26:05,841|INFO|etl_knowledgebase:20210528012603|dgregory|kb_create_csv_from_shelve|start772021-05-2801:26:05,864|INFO|etl_knowledgebase:20210528012603|dgregory|kb_create_csv_from_shelve|countrowswrittentocsv:137782021-05-2801:26:05,864|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|inputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelvesize:632.00kilobyteschangetime:2021-05-2721:26:05localtimezone792021-05-2801:26:05,864|INFO|etl_knowledgebase:20210528012603|dgregory|log_dbm_info|dbmetl_workflow_validation_type-dbm.gnu-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve802021-05-2801:26:05,864|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|outputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb.csvsize:387.65kilobyteschangetime:2021-05-2721:26:05localtimezone812021-05-2801:26:05,864|INFO|etl_knowledgebase:20210528012603|dgregory|kb_create_csv_from_shelve|end822021-05-2801:26:05,867|INFO|etl_knowledgebase:20210528012603|dgregory|kb_create_cve_qid_shelve|countrowswrittentocvetoqidshelve:334832021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|inputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelvesize:632.00kilobyteschangetime:2021-05-2721:26:05localtimezone842021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|log_dbm_info|dbmetl_workflow_validation_type-dbm.gnu-/opt/qetl/users/qualys_user/qetl_home/data/kb_shelve852021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|outputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb_cve_qid_map_shelvesize:44.00kilobyteschangetime:2021-05-2721:26:05localtimezone862021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_csv_wrapper|endkb_load_csv-shelvetocsv872021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_cve_qid_csv_wrapper|startkb_load_cve_qid_csvtransformShelvetoCSV882021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_cve_qid_csv_wrapper|inputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb_cve_qid_map_shelve892021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_cve_qid_csv_wrapper|outputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb_cve_qid_map.csv902021-05-2801:26:05,868|INFO|etl_knowledgebase:20210528012603|dgregory|kb_cve_qid_csv_report|Start912021-05-2801:26:05,869|INFO|etl_knowledgebase:20210528012603|dgregory|kb_cve_qid_csv_report|CountofCVErowswritten:334922021-05-2801:26:05,869|INFO|etl_knowledgebase:20210528012603|dgregory|kb_cve_qid_csv_report|End932021-05-2801:26:05,869|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_cve_qid_csv_wrapper|endkb_load_cve_qid_csvtransformShelvetoCSV942021-05-2801:26:05,869|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_sqlite_wrapper|startkb_load_sqlitetransformShelvetoSqlite3DB952021-05-2801:26:05,869|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_sqlite_wrapper|inputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb.csv962021-05-2801:26:05,869|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_sqlite_wrapper|outputfile:/opt/qetl/users/qualys_user/qetl_home/data/kb_load_sqlite.db972021-05-2801:26:05,869|INFO|etl_knowledgebase:20210528012603|dgregory|kb_load_sqlite|start982021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|bulk_insert_csv_file|Countrowsaddedtotable:137992021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|inputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb.csvsize:387.65kilobyteschangetime:2021-05-2721:26:05localtimezone1002021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|log_file_info|outputfile-/opt/qetl/users/qualys_user/qetl_home/data/kb_load_sqlite.dbsize:520.00kilobyteschangetime:2021-05-2721:26:05localtimezone1012021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|kb_load_sqlite|end1022021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|kb_to_sqlite_wrapper|endkb_load_sqlitetransformShelvetoSqlite3DB1032021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|kb_distribution_wrapper|startkb_distribution1042021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|kb_dist|start1052021-05-2801:26:05,884|INFO|etl_knowledgebase:20210528012603|dgregory|copy_results_to_external_target|noactionstaken.etld_config_settings.yamlkb_export_dirsetto:default1062021-05-2801:26:05,885|INFO|etl_knowledgebase:20210528012603|dgregory|kb_dist|end1072021-05-2801:26:05,885|INFO|etl_knowledgebase:20210528012603|dgregory|kb_distribution_wrapper|endkb_distribution1082021-05-2801:26:05,885|INFO|etl_knowledgebase:20210528012603|dgregory|kb_end_wrapper|runtimeforkb_etl_workflowinseconds:1.97808016699855221092021-05-2801:26:05,885|INFO|etl_knowledgebase:20210528012603|dgregory|kb_end_wrapper|__end__kb_etl_workflow['/home/dgregory/opt/qetl/qetl_venv/bin/qetl_manage_user','-u','/opt/qetl/users/qualys_user','-e','etl_knowledgebase: 20210528012603']Review ETL KnowledgeBase Data(qetl_venv)qualysetl@ubuntu:/opt/qetl/users/qualys_user/qetl_home/data$cd/opt/qetl/users/qualys_user/qetl_home/data/(qetl_venv)qualysetl@ubuntu:/opt/qetl/users/qualys_user/qetl_home/data$lskb_sqlite.dbknowledgebase_extract_dir1kb_sqlite.db2kb_utc_run_datetime_2022-01-13T07:29:49Z_utc_last_modified_after_2021-12-14T00:00:00Z_batch_000001.json.gz3kb_utc_run_datetime_2022-01-13T07:29:49Z_utc_last_modified_after_2021-12-14T00:00:00Z_batch_000001.xml.gzLicenseApache LicenseCopyright 2021  David Gregory and Qualys Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.ChangeLogBeginning with 0.6.98 a change log will be maintained here.Version | Date of Change      | Description of Changes
------- | --------------      | ----------------------
0.6.98  | 2021-08-06 10:00 ET | minor update to order of python virtual env package install. Install Script: qetl_setup_python_venv
0.6.99  | 2021-08-06 11:30 ET | minor update, added module chardet.
0.6.100 | 2021-08-10 12:00 ET | minor documentation update.
0.6.101 | 2021-08-11 12:00 ET | minor update to asset_inventory gateway selection.
0.6.102 | 2021-08-13 12:00 ET | minor update to documentation.
0.6.103 | 2021-08-26 18:00 ET | minor update to allow host list detection to continue to run for up to 1 day.
0.6.104 | 2021-08-27 18:00 ET | update to address encoding error in complex data.
0.6.105 | 2021-09-09 12:00 ET | updated roadmap, and updated retry after receiving 409 (concurrency) or 202 (duplicate operation), sleep 2 min and retry.
0.6.106 | 2021-09-29 12:00 ET | Minor update to allow sqlite 3.26.
0.6.107 | 2021-09-29 20:00 ET | Minor update to adding ability to show tags in Host List.  If host_list_show_tags: '1' is added to etld_config_settings.yaml, then the host list will include qualys tags.
0.6.108 | 2021-10-01 20:00 ET | Updated documentation to include Red Hat 8.4 instructions.
0.6.109 | 2021-10-02 12:00 ET | Updated documentation to include Asset Inventory (GAV/CSAM V2) API.
0.6.112 | 2021-11-07 12:00 ET | Updated etl_asset_inventory to include new fields: criticality, businessInformation, assignedLocation, businessAppListData.  Updated retry and program max run time sanity checks.  Updated Asset Inventory Logging to include count of assets prior to executing download. Updated Host List to include cloud meta data. 
0.6.113 | 2021-11-16 12:00 ET | Updated file change sanity check to 20 min of inactivity.
0.6.117 | 2021-11-18 06:00 ET | Updated http wait time from 30 sec to 5 min. Added counters to asset inventory csv logging. Reverse Sort to add newest assets to shelve in asset_inventory_shelve without overwriting dups.
0.6.118 | 2021-11-18 06:00 ET | Updated performance reading shelve database in asset inventory process. Tested 1.5 Million hosts successfully.
0.6.119 | 2021-11-24 06:00 ET | Updated asset inventory features to include presenting JSON in csv cells instead of indexed list, as well as feature to not truncate data.  To enable these feature, edit your etld_config_settings.yaml to include 'asset_inventory_present_csv_cell_as_json: True' and edit your etld_config_settings.yaml to include: asset_inventory_csv_truncate_cell_limit: False
0.6.123 | 2021-12-01 19:00 ET | Part 1) Updated asset inventory features to include tables Q_Asset_Inventory_Software_Assetid (Asset ID to Software) and Q_Asset_Inventory_Software_Unique ( unique list of software and lifecycle info found in asset inventory ).  These tables are useful to create views of unique software, unique software -> server.
0.6.123 | 2021-12-01 19:00 ET | Part 2) Updated qetl_manage_user credential handling to support -p prompt for cred, -s accept json creds from stdin, -m accept creds exported to environment. 
0.6.124 | 2021-12-02 09:00 ET | Minor update to improve exception handling in extract 
0.6.126 | 2021-12-04 19:00 ET | Minor update to help and version options for qetl_manage_user 
0.6.130 | 2021-12-09 12:00 ET | Part 1) Added feature present JSON in csv cells to etl_knowledgebase, etl_host_list, etl_host_list_detection, etl_asset_inventory. To enable these feature, edit your etld_config_settings.yaml to include 'kb_present_csv_cell_as_json: True', 'host_list_present_csv_cell_as_json: True' 'host_list_detection_present_csv_cell_as_json: True', 'asset_inventory_present_csv_cell_as_json: True' 
0.6.130 | 2021-12-09 12:00 ET | Part 2) Added feature "no truncation" if truncate cell limit is 0 in etl_knowledgebase, etl_host_list, etl_host_list_detection, etl_asset_inventory. To enable this feature, edit your etld_config_settings.yaml to update: 'asset_inventory_csv_truncate_cell_limit: 0' 'kb_csv_truncate_cell_limit: 0' 'host_list_csv_truncate_cell_limit: 0' 'host_list_detection_csv_truncate_cell_limit: 0'.  
0.6.130 | 2021-12-09 12:00 ET | Part 3) Added feature to allow customers in development to set Python3 requests verify=False.  This setting is not recommended as it can result in a man-in-the-middle (MitM) attack.  To enable Python3 requests verify=False, edit your etld_config_settings.yaml and add the setting 'requests_module_tls_verify_status: False'.  Default is True. When set to False logging will include warning messages about insecurity of the setting.  We recommend repairing certificate chain instead of setting this option to False.  Defaults to True, requiring requests to verify the TLS certificate at the remote end. If verify is set to False, requests will accept any TLS certificate presented by the server, and will ignore hostname mismatches and/or expired certificates, which will make your application vulnerable to man-in-the-middle (MitM) attacks. Only set this to False for testing. 
0.6.130 | 2021-12-09 12:00 ET | Part 4) Minor updates to improve progress counters in logging, minor update to asset inventory logging to include batch number. 
0.6.131 | 2021-12-09 13:00 ET | Minor updates to formatting of ReadMe.
0.7.6 | 2022-01-12 16:00 ET | Begin 0.7.x series to include major update in performance and updates to db schemas.  See below for changes.  Please test before replacing 0.6.x series.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  1) All extract data is loaded into their respective extract directories.  knowledgebase_extract_dir, host_list_extract_dir, host_list_detection_extract_dir, asset_inventory_extract_dir.  All files are gzip compressed.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  2) CSV Files are no longer auto generated.  use sqlite3 -csv -header sqlite_file.db "select * from TABLE_NAME" > OUTPUTFILE.csv to generate your csv files post process.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  3) All xml files are converted to json files in their respective extract directories.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  4) host_list_detection_sqlite.db schema has been updated.  Please review tables to create the views of data you require.  Q_Host_List_Detection is now a view of Q_Host_List, Q_Host_List_Detection_HOSTS, and Q_Host_List_Detection_QIDS.  Each field in view Q_Host_List_Detection is prefixed with the source of their data ( HL_ = Q_Host_List, HLDH_ = Q_Host_List_Detection_Hosts, HLDQ_ = Q_Host_List_Detection_QIDS. host_list_detection_sqlite.db can be used to update a central database of all historical data post process. 
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  5) host_list_sqlite.db schema has been updated.  Please review tables to create the views of data you require.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  6) kb_load_sqlite.db has been renamed kb_sqlite.db
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  7) kb_sqlite.db schema has been updated.  Please review tables to create the views of data you require.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  8) asset_inventory_sqlite.db schema has been updated.  Please review tables to create the views of data you require.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series:  9) -e etl_test_system will execute a sampling of all etl programs with the resulting log in log/test_system.log.  ERRORS in this log indicate an unhealthy system.
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series: 10) There is no csv cell truncation as all csv cells with nested data are now json objects instead of flat lists. 
0.7.6 | 2022-01-12 16:00 ET | changes to 0.7.x series: 11) A new CVE view of knowledgebase is available Q_KnowledgeBase_CVE_LIST.
0.7.7 | 2022-01-13 10:00 ET | Minor updates to test_system to get 75 hosts.
0.7.8 | 2022-01-13 15:00 ET | Minor updates to documenation prior to pypi.org launch.
0.7.9 | 2022-01-14 15:00 ET | Minor updates to documenation.
0.7.10 | 2022-01-15 02:00 ET | Update to asset inventory workflow to optimize data load.
0.7.11 | 2022-01-15 14:00 ET | Q_Knowledgebase_CVE_LIST view bug fix.
0.7.13 | 2022-01-20 19:00 ET | Update to allow for test or prod install of specific qualysetl version.  Also, improvements in exception processing across modules and preliminary work on WAS.
0.7.14 | 2022-01-21 09:00 ET | Updated etl_asset_inventory to ensure gzip compression is default.  Update documentation from Red Hat 8.4 to Red Hat 8.5 which is the current 8.x series of Red Hat.
0.7.15 | 2022-01-21 09:00 ET | Updated help documentation for qetl_setup_python_venv.
0.7.16 | 2022-02-09 15:00 ET | Updated etl_asset_inventory for GAV only customer processing.
0.7.17 | 2022-03-25 12:00 ET | Updated etl_asset_inventory enhancements to retry exception processing for malformed json and http error codes.
0.7.18 | 2022-03-25 12:00 ET | Updated Roadmap
0.7.19 | 2022-03-26 12:00 ET | Updated retry limits for etl_asset_inventory.
0.7.20 | 2022-03-27 15:00 ET | Updated etl_asset_inventory auth token refresh.
0.7.40 | 2022-08-02 18:00 ET | Updated etl_asset_inventory auth token refresh for edge case during maintenance window (http 503). Also, updated Road Map.
0.7.40 | 2022-08-02 18:00 ET | Updated http_conn_timeout default for all modules to address long running queries.
0.7.40 | 2022-08-02 18:00 ET | Updated Host List to include ASSET_RISK_SCORE, ASSET_CRITICALITY_SCORE, ARS_FACTORS.  Edit etld_config_settings.yaml to include: host_list_payload_option: {'show_ars': '1', 'show_ars_factors': '1'} to enable capturing data.  Your subscription must have ARS enabled.  Contact your TAM and dgregory@qualys.com if this option does not work for you.
0.7.40 | 2022-08-02 18:00 ET | Updated Host List Detection to include QDS, QDS_FACTORS  Edit etld_config_settings.yaml to include: host_list_detection_payload_option: {'show_qds': '1', 'show_qds_factors': '1'} to enable capturing data.  Your subscription must have ARS enabled.  Contact your TAM and dgregory@qualys.com if this option does not work for you.
0.7.41 | 2022-08-30 18:00 ET | Updated Host List Detection to enable host_list_detection_multi_proc_batch_size for values less than 2000 hosts.
0.7.42 | 2022-08-31 06:00 ET | Updated ulimit for open files to accomdate multiprocessing pipes in host list detection for large jobs.
0.7.44 | 2022-08-31 11:00 ET | Updated to ensure root user cannot install or execute qualysetl 
0.7.45 | 2022-08-31 21:00 ET | Documention Updates - Asset Inventory Schema Image along with removing old comments from etld_config_settings.yaml template.
0.7.46 | 2022-09-01 16:00 ET | Add ram, disk, swap, cpu info to logging at beginning of job.  
0.7.47 | 2022-09-02 09:00 ET | Add SYS stat for ram, disk, swap, cpu to logging throughout job run.  
0.7.48 | 2022-09-18 09:00 ET | GAV/CSAM Fields added to SQL Database - domainRole,riskScore,passiveSensor,domain,subdomain,whois,isp,asn.  
0.7.48 | 2022-09-18 09:00 ET | GAV/CSAM Documentation of Schema updated with additional fields added to SQL Database:  domainRole,riskScore,passiveSensor,domain,subdomain,whois,isp,asn
0.7.48 | 2022-09-18 09:00 ET | Host List Detection Documentation of Schema updated with additional fields added to SQL Database - Q_Host_List: ASSET_RISK_SCORE, ASSET_CRITICALITY_SCORE, ARS_FACTORS
0.7.48 | 2022-09-18 09:00 ET | Host List Detection Documentation of Schema updated with additional fields added to SQL Database - Q_Host_List_Detection_QIDS: QDS, QDS_FACTORS
0.7.49 | 2022-09-19 03:00 ET | Documentation Update minor.
0.7.50 | 2022-09-19 04:00 ET | Documentation Update minor.
0.7.51 | 2022-10-05 15:00 ET | Added update to counters in logs, added retest if gateway 401 encountered.
0.7.56 | 2022-11-04 05:00 ET | Added -e etl_was to qetl_manage_user options to extract WAS Applications, Findings and Catalog.
0.7.56 | 2022-11-04 05:00 ET | Updated STATUS_TABLE for all modules. STATUS_COUNT renamed LAST_BATCH_PROCESSED, STATUS_DETAILS json updated to include details of which etl workflow updated the table along with workflow log timestamp to correlate the logs with the database update.
0.7.56 | 2022-11-04 05:00 ET | Updated base64 routine to correct error when processing complex passwords.
0.8.00 | 2022-12-05 05:00 ET | Major update, be sure to test before going to production.
0.8.00 | 2022-12-05 05:00 ET | Updates:  1) qetl_manage_user -e etl_was has been added to provide you with Web Application Scanning data including WebApps, Findings and Catalog.
0.8.00 | 2022-12-05 05:00 ET | Updates:  2) qetl_manage_user -e validate_etl_[etl name] will scan etl_[etl_name] log for errors and report success or fail.
0.8.00 | 2022-12-05 05:00 ET | Updates:         - Example: qetl_manage_user -u /opt/qetl/users/youruser -e validate_etl_host_list_detection
0.8.00 | 2022-12-05 05:00 ET | Updates:         - Example: qetl_manage_user -u /opt/qetl/users/youruser -e validate_etl_asset_inventory
0.8.00 | 2022-12-05 05:00 ET | Updates:         - Example: qetl_manage_user -u /opt/qetl/users/youruser -e validate_etl_was
0.8.00 | 2022-12-05 05:00 ET | Updates:  3) qetl_manage_user -i -u /opt/qetl/users/[your new qetl user] will automatically initialize user directory without prompting.  This is useful when automating run of QualysETL on new systems/docker images as no prompts are provided.
0.8.00 | 2022-12-05 05:00 ET | Updates:         - Example: qetl_manage_user -i -u /opt/qetl/users/testuser will automatically create the -u directory structure without prompting.  
0.8.00 | 2022-12-05 05:00 ET | Updates:  4) distribution - when enabled, all tables from ETL are prepared for database load.
0.8.00 | 2022-12-05 05:00 ET | Updates:         Edit etld_config_settings.yaml adding the following keys:
0.8.00 | 2022-12-05 05:00 ET | Updates:         - kb_distribution_csv_flag: True
0.8.00 | 2022-12-05 05:00 ET | Updates:         - host_list_distribution_csv_flag: True
0.8.00 | 2022-12-05 05:00 ET | Updates:         - host_list_detection_distribution_csv_flag: True
0.8.00 | 2022-12-05 05:00 ET | Updates:         - asset_inventory_distribution_csv_flag: True
0.8.00 | 2022-12-05 05:00 ET | Updates:         - was_distribution_csv_flag: True
0.8.00 | 2022-12-05 05:00 ET | Updates:         Tested with the following MySQL options:
0.8.00 | 2022-12-05 05:00 ET | Updates:         -     Bash Script Example: 
0.8.00 | 2022-12-05 05:00 ET | Updates:         -         export TABLE_NAME=QETL.Q_KnowledgeBase
0.8.00 | 2022-12-05 05:00 ET | Updates:         -         zcat [Q_KnowledgeBase.*.csv.gz] | mysql -v -e "LOAD DATA LOCAL INFILE '/dev/stdin' INTO TABLE ${TABLE_NAME} CHARACTER SET UTF8 FIELDS TERMINATED BY ',' ESCAPED BY '\\\\' LINES TERMINATED BY '\\n';COMMIT;"
0.8.00 | 2022-12-05 05:00 ET | Updates:     The default max_size for each field in distribution is 1000000 characters. To adjust this to meet your database field limits, edit etld_config_settings.yaml and add the following key/value pairs for each etl you want to customize max_field size for in distribution files.
0.8.00 | 2022-12-05 05:00 ET | Updates:         - kb_distribution_csv_max_field_size: 2000000 
0.8.00 | 2022-12-05 05:00 ET | Updates:         - host_list_distribution_csv_max_field_size: 2000000
0.8.00 | 2022-12-05 05:00 ET | Updates:         - host_list_detection_distribution_csv_max_field_size: 2000000
0.8.00 | 2022-12-05 05:00 ET | Updates:         - asset_inventory_distribution_csv_max_field_size: 2000000
0.8.00 | 2022-12-05 05:00 ET | Updates:         - was_distribution_csv_max_field_size: 2000000
0.8.00 | 2022-12-05 05:00 ET | Updates:     For long running jobs etl_host_list_detection and etl_asset_inventory, these both generate distribution files through multiprocessing, so files are prepared for downstream ingestion as they are read from Qualys.
0.8.00 | 2022-12-05 05:00 ET | Updates:          - Use this feature to immediately begin streaming Qualys data to your downstream system by inserting distribution files into your downstream system as each batch is created.
0.8.00 | 2022-12-05 05:00 ET | Updates:          - Each distribution file is the product of integrity testing and load to SQLite prior exporting to distribution batch file for downstream processing..
0.8.00 | 2022-12-05 05:00 ET | Updates:  5) BATCH_DATE, BATCH_NUMBER added to Q_Asset_Inventory for tracability back to original batch json data used for loading table
0.8.00 | 2022-12-05 05:00 ET | Updates:  6) BATCH_NUMBER should always be stored as a text field.
0.8.00 | 2022-12-05 05:00 ET | Updates:  7) Removed Q_Host_List_Detection view.  Table Views can be injected into database post process to meet customer requirements.
0.8.01 | 2022-12-06 05:00 ET | Minor Documentation Updates.
0.8.02 | 2022-12-06 05:00 ET | Minor Documentation Updates.
0.8.05 | 2022-12-06 05:00 ET | Updated to allow for csv quoting and dialect customization.  The following are defaults that can be adjusted in etld_config_settings.yaml.
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_quoting = 'csv.QUOTE_NONE'
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_dialect_delimiter = '\t'
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_dialect_doublequote = False
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_dialect_escapechar = '\'
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_dialect_lineterminator = '\n'
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_dialect_quotechar = None
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_dialect_skipinitialspace = False
0.8.05 | 2022-12-09 05:00 ET |     csv_distribution_python_csv_dialect_strict = False
0.8.05 | 2022-12-09 05:00 ET |   The csv_distribution_python options above are tested with mysql load options in bash shell:
0.8.05 | 2022-12-09 05:00 ET |     zcat [table file].csv.gz | mysql $PORT_OPT -v -e "LOAD DATA LOCAL INFILE '/dev/stdin' INTO TABLE ${TABLE_NAME} CHARACTER SET UTF8 FIELDS TERMINATED BY '\\t' ESCAPED BY '\\\\' LINES TERMINATED BY '\\n';"
0.8.05 | 2022-12-09 05:00 ET |   SEE Log for options that are selected for your csv_distribution run to validate the options meet your needs.
0.8.10 | 2022-12-16 09:00 ET | Internal enhancements to authentication, replacing etld_lib_credentials with etld_lib_authentication_objects.
0.8.10 | 2022-12-16 09:00 ET | Added etld_config_settings.yaml option was_catalog_start_greater_than_last_id=[ID NUM], resulting in pulling only catalog entries greater_than_last_id entered.
0.8.10 | 2022-12-16 09:00 ET | Added transform to asset inventory table, from sensor json, new table fields: "sensor_lastPcScanDateAgent", "sensor_lastPcScanDateScanner", "sensor_lastVmScanDateAgent", "sensor_lastVmScanDateScanner" added to SQLite Schema.
0.8.11 | 2022-12-20 14:00 ET | Updated first time setup of user to allow for updating user/password from template.
0.8.14 | 2023-01-23 09:00 ET | Updated WAS to iterate / include over 1000 findings in a web application.
0.8.20 | 2023-08-08 23:00 ET | Added experimental support for Host List Detection ASSET_CVE field.  Contact your Technical Account Manager and David Gregory to enable ASSET_CVE.  See [QWEB 10.23 release notification for details](https://www.qualys.com/docs/release-notes/qualys-cloud-platform-10.23-api-release-notes.pdf) 
0.8.20 | 2023-08-08 23:00 ET | Added Database Injection - Methods to inject schema/data from QualysETL into your downstream databases. Ex. Azure Cosmos DB (PostgreSQL), Amazon RedShift, PostgreSQL Open Source, MySql Open Source, SnowFlake, Microsoft SQL Server.  Contact your Qualys TAM to schedule a call with David Gregory if you wish to use this feature. 
0.8.20 | 2023-08-08 23:00 ET | Visualization Use Case -  Use QualysETL to build your downstream databases for use with PowerBI, Tableau, Etc. Contact your Qualys TAM to schedule a call with David Gregory if you wish to use this feature. 
0.8.20 | 2023-08-08 23:00 ET | QWEB 10.23 Updates - Delivered additional fields for Host List and Host List Detection. For details see:  See [QWEB 10.23 release notification for details](https://www.qualys.com/docs/release-notes/qualys-cloud-platform-10.23-api-release-notes.pdf) 
0.8.20 | 2023-08-08 23:00 ET | Web Application Scanning(WAS) - Updated timing in WAS for long running jobs.
0.8.20 | 2023-08-08 23:00 ET | Docker Image Testing - Contact your TAM to schedule a call with David Gregory.  Encapsulate Python Application into distributable docker image for ease os operation and upgrade.
0.8.21 | 2023-08-09 11:00 ET | Minor updates to images depicting host list detection schema and web application scanning schema.
0.8.30 | 2023-10-06 11:00 ET | Added Policy Compliance PCRS -e etl_pcrs to QualysETL.
0.8.30 | 2023-10-06 11:00 ET | Added fields to CSAM -e etl_asset_inventory: easmTags, hostingCategory1, customAttributes, organizationName
0.8.40 | 2023-10-07 18:00 ET | PCRS - Added Performance Improvements Added to reduce memory usage and improve multiprocessing.
0.8.50 | 2023-10-09 18:00 ET | PCRS - Optional Normalized Schema added for PCRS PostureInfo Table, ~50% reduction in space required for PostureInfo.
0.8.52 | 2023-10-22 18:00 ET | Updated Platform Identification, Added type to Q_WAS_FINDING table in -e etl_was, Default to Normalization for PCRS, and minor doco updates. 
0.8.76 | 2023-11-30 10:00 ET | Minor update to ensure systems have swap space before executing qualysetl.  Updated csv distribution format. 
0.8.80 | 2024-01-26 15:00 ET | Minor updates to documentation, addressed edgecase to fix non-utf8 data.
0.8.85 | 2024-01-29 10:00 ET | Added option to exclude trurisk for edge case where VMDR is not enabled in customer subscription. Ex. Consulting EditionRelease Notes Log0.8.76 Updates to distribution_dir and edge case no swap spaceEdge case: Abort if swap size is zero and ask user to add swap space (recommend 4GB - 8GB swap).Improved edge case exception processing for out of memory on small memory systems.Default csv distribution update:default output format improved for database loader processing:New: {'quoting': csv.QUOTE_ALL, 'delimiter': ',', 'doublequote': True, 'escapechar': None, 'lineterminator': '\r\n', 'quotechar': '"', 'skipinitialspace': False, 'strict': False}Example:psql -c "\COPY ${SCHEMA_NAME}.${TABLE_NAME} FROM STDIN WITH (FORMAT csv, DELIMITER ',', QUOTE '\"', ENCODING 'UTF8')"Old:{'quoting': csv.QUOTE_NONE, 'delimiter': '\t', 'doublequote': False, 'escapechar': '\\', 'lineterminator': '\n', 'quotechar': None, 'skipinitialspace': False, 'strict': False}Note that csv distribution output should only be used if downstream application is developed to handle new fields over time.To Maintain a data contract, use the explicit ordered field names in a sqlite3 select statement to maintain data contract with downstream systems.Created Release Notes Log section at tail end of this document to hold historical release notes.0.8.52 includes the following updates.  See Changelog for additional details.Updated PCRS - Default to Normalized Schema Option.  Use etld_config_settings.yaml if you do not want to normalize the schema.Updated Platform Identification to recognize additional PODsMinor documentation updates.Updated -e etl_was to include type in q_was_finding table.0.8.50 includes the following updates.  See Changelog for additional details.0.8.50:Optional Normalized Schema for PCRS PostureInfo Table, ~50% reduction in space required for PostureInfo.To normalize PCRS PostureInfo add the following option to your etld_config_settings.yaml file.pcrs_postureinfo_schema_normalization_flag: TrueThe schema will change to an optimized schema reducing space required by ~50%.A new table will be created where policyid, controlid, technology id are key to obtaining details of control.Q_PCRS_PostureInfo table has the following fields removed and placed in new table Q_PCRS_PostureInfo_Controls for normalization.policyTitle,controlStatement,rationale,remediation,controlReference,technology,criticalitySee PCRS Schemas below in documenation for more details.Performance Improvements to reduce memory and speed up multiprocessing to download data faster.Added Policy Compliance PCRS to QualysETL including the Policy List, Host Ids associated with each Policy and Posture Info.The 0.8.x >= 0.8.30 series supports Policy Compliance (PCRS), Vulnerability Management (VMDR), GAV/CSAM V2 and Web Application Scanning (WAS) Data.Added easmTags, hostingCategory1, customAttributes, organizationName to etl_asset_inventory (CSAM)https://notifications.qualys.com/api/2023/03/20/qualys-cloud-platform-2-15-csam-api-notification-10.8.21 includes the following updates.  See Changelog for additional details.Added QualysETL Automation for injecting schema/data into downstream databases for metrics, analysis and visualization in PowerBI, Tableau, etc. Databases Tested include Azure CosmosDB (PostgreSQL), PostgreSQL Open Source, Amazon Redshift, Snowflake, Mysql, Microsoft SQL Server.Added Docker Beta to run QualysETL in a containerAdded QWEB 10.23 Updates - SeeQWEB 10.23 release notification for detailsTested on Ubuntu 22.04 and Red Hat 9.x as they are the latest supported platforms.The 0.8.x series supports VM, CSAM and WAS Data.Next on the roadmap is Policy Compliance (PCRS) for Nov, 2023.Please see the accompanying videos for additional guidancePart 3 - Host List Detection.Qualys API Best Practices SeriesPart 4 - CyberSecurity Asset Management.Qualys API Best Practices SeriesThe latest schema snapshots are in this document for reference.  To obtain the latest schema from QualysETL, please use the SQLite Database output from QualysETL.SeePython Package Index for Qualys ETLfor latest version of qualysetl.SeeRoadmapfor additional details on what's coming next.SeeQuick Startto get started now.