santosomar/openvulnquery repository overview

⁠Introduction to the The Cisco PSIRT openVuln API

The Cisco PSIRT openVuln API is a RESTful API that allows customers to obtain Cisco security vulnerability information in different machine-consumable formats. It supports industrywide security standards such as the OASIS Common Security Advisory Framework (CSAF) Common Vulnerability Reporting Framework (CVRF), Common Vulnerability and Exposure (CVE) identifiers, Common Weakness Enumerator (CWE), and the Common Vulnerability Scoring System (CVSS).

This API allows technical staff and programmers to build tools that help them do their job more effectively. In this case, it enables them to easily keep up with security vulnerability information specific to their network. That frees up more time for them to manage their network and deploy new capabilities in their infrastructure.

The API also allows Cisco customers and partners to leverage machine readable data to keep-up with Cisco security advisories. It further simplifies the evaluation process and reduces the time between when a vulnerability is announced and the fix is actually implemented.

For more information about the openVuln API and how to access it visit: https://developer.cisco.com/psirt⁠

⁠Config File

Obtain client ID and Secret:

1. Visit https://apiconsole.cisco.com/⁠
2. Sign In
3. Select My Applications Tab
4. Register a New Application by: Entering Application Name

• Under "OAuth2.0 Credentials" check "Client Credentials"
• Under "Select APIs" choose Cisco PSIRT openVuln API
• Agree to the terms and service and click Register

Note the value of "Client ID" (a string like e.g. 'abc12abcd13abcdefabcde1a')
Note the value of "Client Secret" (a string like e.g. '1a2abcDEfaBcDefAbcDeFA3b')

Provide the credentials to the application at runtime via two preferred alternative ways:

Either export two matching environment variables (below the syntax for bash and assuming the values are as in steps 6. and 7.):

Or create a valid JSON file (e.g. credentials.json) with these personal credentials similar to the below given (assuming the values are as in steps 6. and 7.):

   {
       "CLIENT_ID": "abc12abcd13abcdefabcde1a",
       "CLIENT_SECRET": "1a2abcDEfaBcDefAbcDeFA3b"
   }

Do not distribute the credentials file resulting from previous step

For additional information about the openVulnQuery client go to: https://github.com/CiscoPSIRT/openVulnAPI/tree/master/openVulnQuery⁠