Configuration of Config.json

  1. Navigate to your Jira Connector Docker volume > Open '_data' > 'config'.
  2. Select config.json.template > Rename the template file to config.json.
  3. Open the renamed config.json file via a text editor and provide the following inputs:
    1. Provide your Qualys credentials. The URL should be the Qualys API URL for your platform. Refer to Platform Identification to know more. Do not end the URL with '/'
    2. Specify whether the Jira is hosted “onCloud” or “onPremise.”
    3. Provide your Jira credentials.
    4. Provide proxy network information, if required.

      Upon updating and saving the config.json files, the Qualys, Jira, and proxy passwords are encrypted and replaced with a static text.

    5. Set the parameters as specified in the Profile Parameter section.

Profile Parameters

Parameter

Descriptions

active

Set this parameter to true or false to allow/disallow creating tickets for that profile.

frequencyInMinutes

Set the interval (in minutes) for Qualys client service to make periodic API calls to fetch data from the Qualys platform.

filter

You can set filters to fetch specific data from the Qualys platform. For Host Detection, the filters must be provided in a URL-encoded format. For WAS, the filters must be provided using escape for double For example "{\"ServiceRequest\":{\"preferences\":{\"verbose\":\"true\"} ,\"filters\":{\"Criteria\":[{\"field\":\"qid\",\"operator\" :\"NOT EQUALS\",\"value\":\"0\"}]}}}" quotes.

 

For Host Detection, default filters are
action=list&status=New,Active, Re-Opened,
Fixed&output_format=XML&vm_processed_after= &vm_process
ed_before= 
>and these should not be re-entered in the config file.

projectKey

Set the project key from your Jira instance under which the tickets are to be created.

ticketingScheme

You can choose between inputs 1-8 for this parameter. Each number denotes the respective ticketing schemes. Refer to Understanding Ticketing Schemes to get a better understanding of ticketing schemes.

We do not create tickets for Knowledgebase. We only use the knowledgebase data to fetch a few fields for detection tickets such as diagnosis or solution.

batchSize

This parameter is only applicable for KnowledgeBase. Define the batch of QIDs to be fetched by KnowledgeBase APIs in a call. The default value is 500.

hostAssetApiFilter

This parameter is only applicable for Host Detection. Define filters for Host List values such as show_trurisk and truncation_limit. truncation_limit can only be set with this parameter. If set using the ‘filter’ parameter, the input is ignored.

numberOfThreadsForJiraClient (for ver 1.3.1 and below)

This parameter is not applicablle with version 1.3.2.

This parameter enables the Jira Client to run in multi-threading mode. Specify the number of threads to run the Jira Client on. The default value is 2, and you can set the value up to 10.

numberOfConcurrentTask

This parameter enables the Jira Client to run in multi-threading mode for each profile. Speed up the ticketing process by specifying the number of threads on which to run the Jira Client. Each profile can have its own value. The default value is 2 for each profile, and you can set the value up to 5.

JiraTicketAction

This parameter is only applicable to CS Images. Select the action for the Jira Client to perform when a new vulnerable image is discovered. The create action closes the existing ticket and creates a new ticket for every discovery. The update action updates an existing ticket.

logLevel

Set the log levels (TRACE, DEBUG, INFO, WARN, ERROR) to determine what information should be logged for each profile. For example, set it to 'Error' to log all the errors occurring exclusively under this ticketing scheme profile.

 The type of logs you receive for each log level:    

  • TRACE -> TRACE, DEBUG, INFO, WARN, ERROR
  • DEBUG -> DEBUG, INFO, WARN, ERROR
  • INFO -> INFO, WARN, ERROR
  • WARN -> WARN, ERROR
  • ERROR -> ERROR

The default level is 'Info'.

createTicketsOnlyForRunningContainer

This parameter lets you prioritize security concerns by concentrating on running containers, which pose a greater threat than dormant images. If an image has no connection to any running container, the Jira connector skips generating a ticket for that image.   

Set this parameter to true on a CS-Image profile to only create tickets for running containers. The default value is false.

numberOfRetriesForJiraApiCall

This parameter determines the number of times the Jira client should retry connection when in a 429 error state. The default retry count is 3.

numberOfRetriesForQualysApiCall

This parameter determines the number of times the Qualys client should retry connection when the Jira Connector reaches the API rate limit. The default retry count is 3.

connectionRequestTimeOut

This parameter is only in use till Jira Connector version 1.3.1.1.

The timeout parameter allows the Jira client to exit from waiting for a response indefinitely during a 429 error state. Provide the value in minutes. The default value is 5 minutes.

responseTimeout

The timeout parameter allows the Qualys Client and Jira Client to exit waiting for a response indefinitely during a 429 error state. Provide the value in minutes. The default value is 5 minutes.

frequencyToProcessOutputFiles

This parameter defines how frequently the Jira connector must scan output files to create or update tickets. Provide the value in minutes. The default value is 5 minutes.