Adding method for fetching latest pdf report with image digest (#116)

* Adding method for fetching latest pdf report with image digest + detail boolean flag for image id scan result

Author: haresh-suresh

examples/get_image_scan_result_by_id.py

@@ -10,27 +10,28 @@
 
 
 def usage():
-    print('usage: %s <sysdig-token> <image_id> <full_tag_name>' % sys.argv[0])
+    print('usage: %s <sysdig-token> <image_id> <full_tag_name> <detail>' % sys.argv[0])
     print('You can find your token at https://secure.sysdig.com/#/settings/user')
     sys.exit(1)
 
 
 #
 # Parse arguments
 #
-if len(sys.argv) != 4:
+if len(sys.argv) != 5:
     usage()
 
 sdc_token = sys.argv[1]
 image_id = sys.argv[2]
 full_tag_name = sys.argv[3]
+detail = sys.argv[4]
 
 #
 # Instantiate the SDC client
 #
 sdclient = SdScanningClient(sdc_token, 'https://secure.sysdig.com')
 
-ok, res = sdclient.get_image_scan_result_by_id(image_id, full_tag_name)
+ok, res = sdclient.get_image_scan_result_by_id(image_id, full_tag_name, detail)
 
 #
 # Return the result

examples/get_latest_pdf_report_by_digest.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+#
+# Get a specific policy
+#
+
+import os
+import sys
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+from sdcclient import SdScanningClient
+
+
+def usage():
+    print('usage: %s <sysdig-token> <image> <output_pdf>' % sys.argv[0])
+    print('You can find your token at https://secure.sysdig.com/#/settings/user')
+    sys.exit(1)
+
+#
+# Parse arguments
+#
+if len(sys.argv) != 5:
+    usage()
+
+sdc_token = sys.argv[1]
+image_digest = sys.argv[2]
+full_tag = sys.argv[3]
+pdf_path = sys.argv[4]
+
+#
+# Instantiate the SDC client
+#
+sdclient = SdScanningClient(sdc_token, 'https://secure.sysdig.com')
+
+ok, res = sdclient.get_latest_pdf_report_by_digest(image_digest, full_tag)
+
+#
+# Return the result
+#
+if ok:
+    with open(pdf_path, 'wb') as f:
+        f.write(res)
+    print("PDF %s saved" % pdf_path)
+else:
+    print(res)
+    sys.exit(1)

sdcclient/_scanning.py

@@ -307,6 +307,28 @@ def get_pdf_report(self, image, tag=None, date=None):
 
         return [True, res.content]
 
+    def get_latest_pdf_report_by_digest(self, image_digest, full_tag=None):
+        '''**Description**
+            Get the latest pdf report of one image digest
+
+        **Arguments**
+            - image_digest: Input image digest should be in the following formats: sha256:134dhgfd65765
+            - tag: Specify which FULLTAG is evaluated for a given Image Digest: docker.io/alpine:latest
+
+        **Success Return Value**
+            The pdf content
+        '''
+        url = "{base_url}/api/scanning/v1/images/{image_digest}/report?tag={tag}".format(
+            base_url=self.url,
+            image_digest=image_digest,
+            tag=full_tag)
+
+        res = requests.get(url, headers=self.hdrs, verify=self.ssl_verify)
+        if not self._checkResponse(res):
+            return [False, self.lasterr]
+
+        return [True, res.content]
+
     def import_image(self, infile, sync=False):
         '''**Description**
             Import an image archive
@@ -355,21 +377,23 @@ def get_anchore_users_account(self):
 
         return [True, res.json()]
 
-    def get_image_scan_result_by_id(self, image_id, full_tag_name):
+    def get_image_scan_result_by_id(self, image_id, full_tag_name, detail):
         '''**Description**
             Get the anchore image scan result for an image id.
 
         **Arguments**
             - image_id: Docker image id of the image whose scan result is to be fetched.
             - full_tag_name: The complete tag name of the image for e.g. docker.io/alpine:3.10.
+            - detail: Boolean to indicate whether full scan result API is needed.
 
         **Success Return Value**
             A JSON object containing pass/fail status of image scan policy.
         '''
-        url = "{base_url}/api/scanning/v1/anchore/images/by_id/{image_id}/check?tag={full_tag_name}&detail=false".format(
+        url = "{base_url}/api/scanning/v1/anchore/images/by_id/{image_id}/check?tag={full_tag_name}&detail={detail}".format(
                 base_url=self.url,
                 image_id=image_id,
-                full_tag_name=full_tag_name)
+                full_tag_name=full_tag_name,
+                detail=detail)
         res = requests.get(url, headers=self.hdrs, verify=self.ssl_verify)
         if not self._checkResponse(res):
             return [False, self.lasterr]