Merge pull request #64 from ryran/new-search-by-product

implement #63: add --q-product option to search by product_name
RedHatOfficial · Jan 5, 2017 · 8e83d11 · 8e83d11
2 parents b2636fc + c516993
commit 8e83d11
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -185,8 +185,9 @@ sys	0m0.055s
 ```
 $ rhsecapi -h
 usage: rhsecapi [--q-before YYYY-MM-DD] [--q-after YYYY-MM-DD] [--q-bug BZID]
-                [--q-advisory RHSA] [--q-severity IMPACT] [--q-package PKG]
-                [--q-cwe CWEID] [--q-cvss SCORE] [--q-cvss3 SCORE] [--q-empty]
+                [--q-advisory RHSA] [--q-severity IMPACT]
+                [--q-product PRODUCT] [--q-package PKG] [--q-cwe CWEID]
+                [--q-cvss SCORE] [--q-cvss3 SCORE] [--q-empty]
                 [--q-pagesize PAGESZ] [--q-pagenum PAGENUM] [--q-raw RAWQUERY]
                 [-i YYYY-?-NNNN] [-x] [-0] [-f FIELDS | -a | -m] [-p PRODUCT]
                 [-j] [-u] [-w [WIDTH]] [-c] [-l {debug,info,notice,warning}]
@@ -196,20 +197,21 @@ usage: rhsecapi [--q-before YYYY-MM-DD] [--q-after YYYY-MM-DD] [--q-bug BZID]
 Run rhsecapi --help for full help page
 
 VERSION:
-  rhsecapi v1.0.0_rc8 last mod 2016/12/01
+  rhsecapi v1.0.0_rc10 last mod 2017/01/05
   See <http://github.com/ryran/rhsecapi> to report bugs or RFEs
 ```
 
 ## BASH intelligent tab-completion
 
 ```
 $ rhsecapi --[TabTab]
---all-fields    --iava          --product       --q-cvss3       --q-raw
---count         --json          --q-advisory    --q-cwe         --q-severity
---dryrun        --loglevel      --q-after       --q-empty       --stdin
---extract-cves  --most-fields   --q-before      --q-package     --threads
---fields        --pastebin      --q-bug         --q-pagenum     --urls
---help          --pexpire       --q-cvss        --q-pagesize    --wrap
+--all-fields    --json          --q-after       --q-package     --threads
+--count         --loglevel      --q-before      --q-pagenum     --urls
+--dryrun        --most-fields   --q-bug         --q-pagesize    --wrap
+--extract-cves  --pastebin      --q-cvss        --q-product     
+--fields        --pexpire       --q-cvss3       --q-raw         
+--help          --product       --q-cwe         --q-severity    
+--iava          --q-advisory    --q-empty       --stdin         
 ```
 
 ## Field display
@@ -297,10 +299,10 @@ CVE-2016-8734     2016-11-29  1397403   moderate   3.5    4.4     0      0
 (output truncated for brevity of this README)
 ```
 
-Customize how many results to see and print; add URLs.
+Customize how many results to see and print; add URLs. The `--q-empty` switch is no longer needed here since there are other `--q-xxx` options present.
 
 ```
-$ rhsecapi --loglevel info --q-empty --q-pagesize 4 --q-pagenum 3 --urls 
+$ rhsecapi --loglevel info --q-pagesize 4 --q-pagenum 3 --urls 
 [INFO   ] rhsda: Getting https://access.redhat.com/labs/securitydataapi/cve.json?per_page=4&page=3
 [NOTICE ] rhsda: 4 CVEs found with search query
 
@@ -353,9 +355,9 @@ Other possibilities:
 
 ```
 $ rhsecapi --q-[TabTab]
---q-advisory  --q-bug       --q-cwe       --q-pagenum   --q-severity
---q-after     --q-cvss      --q-empty     --q-pagesize  
---q-before    --q-cvss3     --q-package   --q-raw       
+--q-advisory  --q-bug       --q-cwe       --q-pagenum   --q-raw       
+--q-after     --q-cvss      --q-empty     --q-pagesize  --q-severity  
+--q-before    --q-cvss3     --q-package   --q-product   
 ```
 
 Narrowing it down ...
@@ -526,8 +528,9 @@ CVE-2016-4979 (https://access.redhat.com/security/cve/CVE-2016-4979)
 ```
 $ rhsecapi --help
 usage: rhsecapi [--q-before YYYY-MM-DD] [--q-after YYYY-MM-DD] [--q-bug BZID]
-                [--q-advisory RHSA] [--q-severity IMPACT] [--q-package PKG]
-                [--q-cwe CWEID] [--q-cvss SCORE] [--q-cvss3 SCORE] [--q-empty]
+                [--q-advisory RHSA] [--q-severity IMPACT]
+                [--q-product PRODUCT] [--q-package PKG] [--q-cwe CWEID]
+                [--q-cvss SCORE] [--q-cvss3 SCORE] [--q-empty]
                 [--q-pagesize PAGESZ] [--q-pagenum PAGENUM] [--q-raw RAWQUERY]
                 [-i YYYY-?-NNNN] [-x] [-0] [-f FIELDS | -a | -m] [-p PRODUCT]
                 [-j] [-u] [-w [WIDTH]] [-c] [-l {debug,info,notice,warning}]
@@ -548,6 +551,12 @@ FIND CVES BY ATTRIBUTE:
                         more, e.g.: 'RHSA-2016:0614,RHSA-2016:0610')
   --q-severity IMPACT   Narrow down results by severity rating (specify one of
                         'low', 'moderate', 'important', or 'critical')
+  --q-product PRODUCT   Narrow down results by product name via case-
+                        insensitive regex (e.g.: 'linux 7' or openstack
+                        platform [89]'); the API checks this against the
+                        'FIXED_RELEASES' field so will only match CVEs where
+                        PRODUCT matches the 'product_name' of some released
+                        errata
   --q-package PKG       Narrow down results by package name (e.g.: 'samba' or
                         'thunderbird')
   --q-cwe CWEID         Narrow down results by CWE ID (specify one or more,
@@ -647,7 +656,7 @@ GENERAL OPTIONS:
   --help                Show this help message and exit
 
 VERSION:
-  rhsecapi v1.0.0_rc8 last mod 2016/12/01
+  rhsecapi v1.0.0_rc10 last mod 2017/01/05
   See <http://github.com/ryran/rhsecapi> to report bugs or RFEs
 ```
 
@@ -712,12 +721,13 @@ NAME
     rhsda
 
 FILE
-    /g/dev-rhsecapi/rhsda.py
+    /usr/share/rhsecapi/rhsda.py
 
 DESCRIPTION
     # -*- coding: utf-8 -*-
     #-------------------------------------------------------------------------------
-    # Copyright 2016 Ryan Sawhill Aroha <rsaw@redhat.com> and rhsecapi contributors
+    # Copyright 2016, 2017
+    #  Ryan Sawhill Aroha <rsaw@redhat.com> and rhsecapi contributors
     #
     #    This program is free software: you can redistribute it and/or modify
     #    it under the terms of the GNU General Public License as published by
@@ -752,7 +762,7 @@ CLASSES
      |      Setting to "json" returns list object containing original JSON.
      |      Setting to "jsonpretty" returns str object containing prettified JSON.
      |  
-     |  find_cves(self, params=None, outFormat='json', before=None, after=None, bug=None, advisory=None, severity=None, package=None, cwe=None, cvss_score=None, cvss3_score=None, page=None, per_page=None)
+     |  find_cves(self, params=None, outFormat='json', before=None, after=None, bug=None, advisory=None, severity=None, product=None, package=None, cwe=None, cvss_score=None, cvss3_score=None, page=None, per_page=None)
      |      Find CVEs by recent or attributes.
      |      
      |      Provides an index to recent CVEs when no parameters are passed.

diff --git a/rhsda.py b/rhsda.py
@@ -1,7 +1,8 @@
 #!/usr/bin/python2
 # -*- coding: utf-8 -*-
 #-------------------------------------------------------------------------------
-# Copyright 2016 Ryan Sawhill Aroha <rsaw@redhat.com> and rhsecapi contributors
+# Copyright 2016, 2017
+#  Ryan Sawhill Aroha <rsaw@redhat.com> and rhsecapi contributors
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -266,7 +267,7 @@ def find_cvrfs(self, params=None, outFormat='json',
 
     def find_cves(self, params=None, outFormat='json',
                   before=None, after=None, bug=None, advisory=None, severity=None,
-                  package=None, cwe=None, cvss_score=None, cvss3_score=None,
+                  product=None, package=None, cwe=None, cvss_score=None, cvss3_score=None,
                   page=None, per_page=None):
         """Find CVEs by recent or attributes.
 
@@ -285,6 +286,7 @@ def find_cves(self, params=None, outFormat='json',
                 'bug': bug,
                 'advisory': advisory,
                 'severity': severity,
+                'product': product,
                 'package': package,
                 'cwe': cwe,
                 'cvss_score': cvss_score,

diff --git a/rhsecapi.py b/rhsecapi.py
@@ -2,7 +2,8 @@
 # -*- coding: utf-8 -*-
 # PYTHON_ARGCOMPLETE_OK
 #-------------------------------------------------------------------------------
-# Copyright 2016 Ryan Sawhill Aroha <rsaw@redhat.com> and rhsecapi contributors
+# Copyright 2016, 2017
+#  Ryan Sawhill Aroha <rsaw@redhat.com> and rhsecapi contributors
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -45,8 +46,8 @@
 # Globals
 prog = 'rhsecapi'
 vers = {}
-vers['version'] = '1.0.0_rc9'
-vers['date'] = '2016/12/01'
+vers['version'] = '1.0.0_rc10'
+vers['date'] = '2017/01/05'
 
 
 # Logging
@@ -176,6 +177,9 @@ def parse_args():
     g_listByAttr.add_argument(
         '--q-severity', metavar="IMPACT", choices=['low', 'moderate', 'important', 'critical'],
         help="Narrow down results by severity rating (specify one of 'low', 'moderate', 'important', or 'critical')")
+    g_listByAttr.add_argument(
+        '--q-product', metavar="PRODUCT",
+        help="Narrow down results by product name via case-insensitive regex (e.g.: 'linux 7' or openstack platform [89]'); the API checks this against the 'FIXED_RELEASES' field so will only match CVEs where PRODUCT matches the 'product_name' of some released errata")
     g_listByAttr.add_argument(
         '--q-package', metavar="PKG",
         help="Narrow down results by package name (e.g.: 'samba' or 'thunderbird')")
@@ -291,6 +295,7 @@ def parse_args():
         'bug': o.q_bug,
         'advisory': o.q_advisory,
         'severity': o.q_severity,
+        'product': o.q_product,
         'package': o.q_package,
         'cwe': o.q_cwe,
         'cvss_score': o.q_cvss,