| Name | Qualys-IaC-Security JSON |
| Version |
1.0.6
JSON |
| download |
| home_page | |
| Summary | Command line interface to scan Infrastructure-as-Code templates using Qualys IaC. |
| upload_time | 2023-10-20 10:24:08 |
| maintainer | |
| docs_url | None |
| author | qualys |
| requires_python | >=3 |
| license | MIT |
| keywords |
qiac
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Qualys-IaC-Security
The `qiac` is a command line interface to scan Infrastructure-as-Code templates using Qualys CloudView (Cloud Security Assessment).
## Description
The Qualys IaC app provides a quick yet reliable way to assess your Infrastructure-as-a-Code templates and uncover potential vulnerable situations. The `qiac` provides you an interface to interact with Qualys IaC module in a simple way.
This command line interface (CLI) provides following commands.
|Command Name | Feature | Description | Since Version |
| --------- | ------- | ----------- | ------------- |
| scan | Launch an IaC scan | You can scan one or more templates in a single command. This runs a job on Qualys cloud platform. | 1.0.0b2 |
| listscans | Get list of all IaC scans | Once you launch a scan, you can view list of all scans or a specific scan. | 1.0.0b2 |
| getresult | Get the IaC scan result | Once a scan is completed, you can download the scan result for your review. | 1.0.0b2 |
| config | Configure IaC CLI | You can configure user's credentials using this command. | 1.0.0b3 |
## Installation
### Prerequisite
You need to fulfill the following requirements to use this CLI tool.
- Python 3
- If your environment uses Windows OS and Python version 3.10 or greater, then you must have Microsoft Visual C++ version 14.0 or greater version installed.
- A valid Qualys subscription with access to
- CloudView (Cloud Security Assessment)
- The Qualys API
### Command to install
You can install the `qiac` CLI from PyPI. Run the following command to install.
```console
pip install Qualys-IaC-Security
```
## How to use
### See the supported options
You can use the `--help` option to get a list of supported options and their explanation.
```console
Usage: qiac [OPTIONS] COMMAND [ARGS]...
Options:
-v, --version Show the version and exit.
-h, --help Show this message and exit.
Commands:
config Configure IaC CLI credentials.
getresult Gets the scan result.
listscans List all the scans.
scan Triggers/Launches the IaC scan.
```
### Configure IaC CLI (optional command)
Use this command to configure user's credentials. This command is optional and should be used only when a user would like to store Qualys credentials in flat file for subsequent uses. Once this file is correctly configured, the user need not provide the Qualys platform, username, and password details for every CLI command. The authentication details are picked from the configuration file.
Below command collects Qualys credentials from user and stores those to user's home directory (.qiac.yaml)
```console
qiac config -a <Qualys Platform> -u <Qualys username> -p <Qualys password>
```
* The parameters: platform, username, and password are mandatory for this command.
<br/>config_file (optional): name or path of the config file.
<br/>Name: if the name is provided, then a config file with the specified name is created.
<br/>Path: if the path is provided, then the config file is created at the specified path with the default name. The default name is *.qiac.yaml*.
* This command saves the config file on the user's home directory with the name .qiac.yaml. If a user doesn't want to save the config file in the home directory, the user can use the config_file option to provide the config file path. The config_file option saves the file at the specified path.
### A user can use the config file using below ways:
1. Use Config file from user's home.
```console
qiac <commands|params>
```
2. User Config file from user's custom directory.
```console
qiac <commands|params> -c <location of config file>
```
Commands could be **scan, getresults, listscans**.
**Note:** If the user does not provide credentials in command options, then CLI checks for the config file in the current directory. If the config file is not present in the current directory, then CLI checks the user's home directory.
### Launch a scan
You can scan one or more file(s) using the following command.
```console
qiac scan -a <Qualys Platform> -u <your Qualys username> -n <name of the scan> -d <path1 to a file or directory> -d <path2 to a file or directory> -d <path3 to a file or directory>...
```
* The CLI prompts for your Qualys password, only if password is not provided in command.
* When you provide a path to a directory for `-d` option, the CLI will ZIP the contents and then upload the ZIP to the Qualys Cloud Platform.
* On successful launch of the scan, the CLI output provides a Scan Id and show results in a tabular format.
**Note:** To scan the template(s), this CLI uploads your file(s) to the Qualys Cloud Platform.
### Get the list of all scans
You can get list of scans using the following command. If you want to get the scan details for a specific scan, provide the IaC scan Id obtained from the launch scan output.
```console
qiac listscans -a <Qualys Platform> -u <your Qualys username> -i <Scan Id>
```
* This will fetch list of all IaC scan and its details and print it in tabular format on the terminal.
### Get the scan result
Once you see that the scan status is FINISHED or ERROR, you can use the following command to get the IaC scan result.
```console
qiac getresult -a <Qualys Platform> -u <your Qualys username> -i <Scan Id>
```
* This will download the scan result and print it in tabular format on the terminal.
## Documentation
For more information you can refer **Secure Infrastructure as Code** section in this user guide: https://www.qualys.com/docs/qualys-cloud-view-user-guide.pdf
## Support
If you have any questions, please contact Qualys Support team at <support@qualys.com>
Raw data
{
"_id": null,
"home_page": "",
"name": "Qualys-IaC-Security",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "qiac",
"author": "qualys",
"author_email": "plugins@qualys.com",
"download_url": "",
"platform": null,
"description": "# Qualys-IaC-Security\r\nThe `qiac` is a command line interface to scan Infrastructure-as-Code templates using Qualys CloudView (Cloud Security Assessment).\r\n\r\n## Description\r\nThe Qualys IaC app provides a quick yet reliable way to assess your Infrastructure-as-a-Code templates and uncover potential vulnerable situations. The `qiac` provides you an interface to interact with Qualys IaC module in a simple way.\r\n\r\nThis command line interface (CLI) provides following commands.\r\n\r\n|Command Name | Feature | Description | Since Version |\r\n| --------- | ------- | ----------- | ------------- |\r\n| scan | Launch an IaC scan | You can scan one or more templates in a single command. This runs a job on Qualys cloud platform. | 1.0.0b2 |\r\n| listscans | Get list of all IaC scans | Once you launch a scan, you can view list of all scans or a specific scan. | 1.0.0b2 |\r\n| getresult | Get the IaC scan result | Once a scan is completed, you can download the scan result for your review. | 1.0.0b2 |\r\n| config | Configure IaC CLI | You can configure user's credentials using this command. | 1.0.0b3 |\r\n\r\n\r\n## Installation\r\n\r\n### Prerequisite\r\nYou need to fulfill the following requirements to use this CLI tool.\r\n\r\n- Python 3\r\n- If your environment uses Windows OS and Python version 3.10 or greater, then you must have Microsoft Visual C++ version 14.0 or greater version installed.\r\n- A valid Qualys subscription with access to \r\n - CloudView (Cloud Security Assessment)\r\n - The Qualys API\r\n\r\n### Command to install\r\nYou can install the `qiac` CLI from PyPI. Run the following command to install. \r\n\r\n```console\r\npip install Qualys-IaC-Security\r\n```\r\n\r\n## How to use\r\n\r\n### See the supported options\r\n\r\nYou can use the `--help` option to get a list of supported options and their explanation. \r\n\r\n```console\r\nUsage: qiac [OPTIONS] COMMAND [ARGS]...\r\n\r\nOptions:\r\n -v, --version Show the version and exit.\r\n -h, --help Show this message and exit.\r\n\r\nCommands:\r\n config Configure IaC CLI credentials.\r\n getresult Gets the scan result.\r\n listscans List all the scans.\r\n scan Triggers/Launches the IaC scan.\r\n```\r\n\r\n### Configure IaC CLI (optional command)\r\n\r\nUse this command to configure user's credentials. This command is optional and should be used only when a user would like to store Qualys credentials in flat file for subsequent uses. Once this file is correctly configured, the user need not provide the Qualys platform, username, and password details for every CLI command. The authentication details are picked from the configuration file.\r\nBelow command collects Qualys credentials from user and stores those to user's home directory (.qiac.yaml)\r\n\r\n```console\r\nqiac config -a <Qualys Platform> -u <Qualys username> -p <Qualys password>\r\n```\r\n\r\n* The parameters: platform, username, and password are mandatory for this command.\r\n <br/>config_file (optional): name or path of the config file.\r\n <br/>Name: if the name is provided, then a config file with the specified name is created.\r\n <br/>Path: if the path is provided, then the config file is created at the specified path with the default name. The default name is *.qiac.yaml*.\r\n* This command saves the config file on the user's home directory with the name .qiac.yaml. If a user doesn't want to save the config file in the home directory, the user can use the config_file option to provide the config file path. The config_file option saves the file at the specified path.\r\n\r\n\r\n### A user can use the config file using below ways:\r\n\r\n1. Use Config file from user's home.\r\n```console\r\nqiac <commands|params>\r\n```\r\n\r\n2. User Config file from user's custom directory.\r\n```console\r\nqiac <commands|params> -c <location of config file>\r\n```\r\n\r\nCommands could be **scan, getresults, listscans**.\r\n\r\n**Note:** If the user does not provide credentials in command options, then CLI checks for the config file in the current directory. If the config file is not present in the current directory, then CLI checks the user's home directory.\r\n\r\n\r\n### Launch a scan\r\n\r\nYou can scan one or more file(s) using the following command.\r\n\r\n```console\r\nqiac scan -a <Qualys Platform> -u <your Qualys username> -n <name of the scan> -d <path1 to a file or directory> -d <path2 to a file or directory> -d <path3 to a file or directory>...\r\n```\r\n \r\n* The CLI prompts for your Qualys password, only if password is not provided in command.\r\n* When you provide a path to a directory for `-d` option, the CLI will ZIP the contents and then upload the ZIP to the Qualys Cloud Platform. \r\n* On successful launch of the scan, the CLI output provides a Scan Id and show results in a tabular format.\r\n\r\n**Note:** To scan the template(s), this CLI uploads your file(s) to the Qualys Cloud Platform.\r\n\r\n### Get the list of all scans\r\n\r\nYou can get list of scans using the following command. If you want to get the scan details for a specific scan, provide the IaC scan Id obtained from the launch scan output. \r\n\r\n```console\r\nqiac listscans -a <Qualys Platform> -u <your Qualys username> -i <Scan Id>\r\n```\r\n\r\n* This will fetch list of all IaC scan and its details and print it in tabular format on the terminal.\r\n\r\n\r\n### Get the scan result\r\n\r\nOnce you see that the scan status is FINISHED or ERROR, you can use the following command to get the IaC scan result. \r\n\r\n```console\r\nqiac getresult -a <Qualys Platform> -u <your Qualys username> -i <Scan Id>\r\n```\r\n\r\n* This will download the scan result and print it in tabular format on the terminal.\r\n\r\n\r\n## Documentation\r\n\r\nFor more information you can refer **Secure Infrastructure as Code** section in this user guide: https://www.qualys.com/docs/qualys-cloud-view-user-guide.pdf\r\n\r\n## Support\r\n\r\nIf you have any questions, please contact Qualys Support team at <support@qualys.com>\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line interface to scan Infrastructure-as-Code templates using Qualys IaC.",
"version": "1.0.6",
"project_urls": null,
"split_keywords": [
"qiac"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d13f7f9f0a6442b5bea3218878228557483036596adc26259289e7b2364927a",
"md5": "cb4fde007df3b6e4199de0584fe6add2",
"sha256": "4202143b00cc06c0964ba09f0afceedc4333fb3827bc5a0cf6e19bf8b6e3a3f6"
},
"downloads": -1,
"filename": "Qualys_IaC_Security-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb4fde007df3b6e4199de0584fe6add2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 13936,
"upload_time": "2023-10-20T10:24:08",
"upload_time_iso_8601": "2023-10-20T10:24:08.883962Z",
"url": "https://files.pythonhosted.org/packages/9d/13/f7f9f0a6442b5bea3218878228557483036596adc26259289e7b2364927a/Qualys_IaC_Security-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-20 10:24:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "qualys-iac-security"
}
