boman-cli 2.5.11__tar.gz → 2.5.13__tar.gz

{boman_cli-2.5.11 → boman_cli-2.5.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boman-cli
-Version: 2.5.11
+Version: 2.5.13
 Summary: CLI tool of boman.ai
 Home-page: https://boman.ai
 Author: Sumeru Software Solutions Pvt. Ltd.

{boman_cli-2.5.11 → boman_cli-2.5.13}/boman_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boman-cli
-Version: 2.5.11
+Version: 2.5.13
 Summary: CLI tool of boman.ai
 Home-page: https://boman.ai
 Author: Sumeru Software Solutions Pvt. Ltd.

{boman_cli-2.5.11 → boman_cli-2.5.13}/bomancli/Config.py

@@ -121,7 +121,7 @@ class Config:
 
     log_level = "INFO"
 
-    version = 'v2.5.11'
+    version = 'v2.5.13'
 
     boman_config_file = 'boman.yaml'
     
@@ -167,8 +167,7 @@ class Config:
     sbom_scan_status=None
     sbom_target=None
     sbom_output_file=None
-    set_cache_dir = False
-    cache_dir = " --cache-dir /tmp/.trivycache"
+    
     #IAC scanning
     iac_scan_present=None
     iac_scan_build_dir=None
@@ -229,4 +228,11 @@ class Config:
 
     cloc_total_data = None
 
-    hssc_output_file = 'boman-hssc.csv'
+    hssc_output_file = 'boman-hssc.csv'
+    
+    # common for trivy container and sbom scan
+    set_cache_dir = False
+    cache_dir = " --cache-dir /tmp/.trivycache"
+    
+    #common settings for all scans 
+    docker_timeout = 600

{boman_cli-2.5.11 → boman_cli-2.5.13}/bomancli/main.py

@@ -186,7 +186,7 @@ def runImage(data=None,type=None):
 
                     Config.build_dir = Config.sast_build_dir
                     container_output = docker.containers.run(docker_image, command_line, volumes={Config.sast_build_dir: {
-                                    'bind': data['bind']}}, user=userid,detach=detach,environment=env_var, remove=True)
+                                    'bind': data['bind']}}, user=userid,detach=detach,environment=env_var, remove=True,timeout=Config.docker_timeout)
                     logging.info('SAST Docker: SUCCESS !!!. Message: %s Scan Completed',tool_name)
 
                 else:    
@@ -194,7 +194,7 @@ def runImage(data=None,type=None):
                     logging.info('SAST Docker: Preparing %s scan for non jenkins env with %s user ', tool_name ,userid)
                     Config.build_dir = Config.sast_build_dir
                     container_output = docker.containers.run(docker_image, command_line, volumes={Config.sast_build_dir: {
-                                'bind': data['bind']}},user=userid,detach=detach,environment=env_var)          
+                                'bind': data['bind']}},user=userid,detach=detach,environment=env_var,remove=True,timeout=Config.docker_timeout)          
                     logging.info('SAST Docker: SUCCESS !!!. Message: %s Scan Completed',tool_name)
 
             except errors.ContainerError as exc:
@@ -368,7 +368,7 @@ def runImage(data=None,type=None):
             try:
                 Config.build_dir = Config.sast_build_dir
                 container= docker.containers.run(docker_image, command_line, volumes={Config.sast_build_dir: {
-                    'bind': data['bind'], 'mode': 'rw'}},user=userid,detach=detach, remove=True)
+                    'bind': data['bind'], 'mode': 'rw'}},user=userid,detach=detach, remove=True,timeout=Config.docker_timeout)
 
                 #print(output_file,toolname,tool_id,scan_details_id)
                 logging.info('[SUCCESS]: %s Scan Completed',tool_name)
@@ -396,7 +396,7 @@ def runImage(data=None,type=None):
                 Config.build_dir = Config.sast_build_dir
                 logging.info('DAST Docker: Command for running the scan %s',command_line)
                 container= docker.containers.run(docker_image, command_line, volumes={Config.sast_build_dir: {
-                   'bind': data['bind'], 'mode': 'rw'}},user=userid,detach=detach, remove=True)
+                   'bind': data['bind'], 'mode': 'rw'}},user=userid,detach=detach, remove=True,timeout=Config.docker_timeout)
 
                 #print(output_file,toolname,tool_id,scan_details_id)
                 logging.info('DAST Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
@@ -445,14 +445,14 @@ def runImage(data=None,type=None):
                     Config.build_dir = Config.sca_build_dir
                     command_line = "% s" % command_line.format(target = './'+target)
                     container_output = docker.containers.run(docker_image, command_line, volumes={Config.sca_build_dir: {
-                            'bind': data['bind']}}, user=uid, remove=True)
+                            'bind': data['bind']}}, user=uid, remove=True,timeout=Config.docker_timeout)
                     logging.info('SCA Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
                 else:
                     target = Utils.remove_leading_slash(Config.sca_target)
                     Config.build_dir = Config.sca_build_dir
                     command_line = "% s" % command_line.format(target ='/src/'+target)
                     container_output = docker.containers.run(docker_image, command_line, volumes={Config.sca_build_dir: {
-                            'bind': data['bind']}}, user=uid, remove=True)
+                            'bind': data['bind']}}, user=uid, remove=True,timeout=Config.docker_timeout)
                     logging.info('SCA Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
             else:
                 if Config.sca_ignore:
@@ -463,7 +463,7 @@ def runImage(data=None,type=None):
                         logging.info('SCA Docker:  Command ==> %s',command_line)
                 Config.build_dir = Config.sca_build_dir
                 container_output = docker.containers.run(docker_image, command_line, volumes={Config.sca_build_dir: {
-                        'bind': data['bind']}}, user=uid, remove=True)
+                        'bind': data['bind']}}, user=uid, remove=True,timeout=Config.docker_timeout)
                 logging.info('SCA Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)           
             Config.sca_message ='SCA scan completed'
             Config.sca_scan_status ='Completed'
@@ -511,11 +511,15 @@ def runImage(data=None,type=None):
                 command_line = "% s" % command_line.format(target = os.path.join('/src',Utils.remove_leading_slash(Config.con_scan_target)))
             else:
                 command_line = "% s" % command_line.format(target = Config.con_scan_target)
+                
+            if Config.set_cache_dir:
+                command_line = command_line + Config.cache_dir
+                logging.info('Container scan Docker: Cache directory is set for the scan, updated command is %s',command_line[-20:])
             
-            logging.info(f"CS Docker: command ==> {command_line}")    
+            logging.info(f"CS Docker: command ==> {command_line[-20:]}")   
             Config.build_dir = Config.con_scan_build_dir
             container_output = docker.containers.run(docker_image, command_line, volumes={Config.con_scan_build_dir: {
-                        'bind': data['bind']}}, user=uid, remove=True)
+                        'bind': data['bind']}}, user=uid, remove=True,timeout=Config.docker_timeout)
             logging.info('CS Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
             Config.con_scan_message ='Container Scan completed'
             Config.con_scan_status ='Completed'
@@ -554,7 +558,6 @@ def runImage(data=None,type=None):
         
         try:
             Config.build_dir = Config.sbom_build_dir = os.getcwd()+'/'
-            command_line = "--format cyclonedx --output /src/boman_trivy_sbom_scan.json --scanners vuln fs /{target}"
             command_line = "% s" % command_line.format(target = 'src/')
             #added upon jenkins sbom issue - GM
             if Config.set_cache_dir:
@@ -562,7 +565,7 @@ def runImage(data=None,type=None):
                 logging.info('SBOM Docker: Cache directory is set for the scan, updated command is %s',command_line[-20:])
             logging.info(f"SBOM Docker: command ==> {command_line[-20:]}")
             container_output = docker.containers.run(docker_image, command_line, volumes={Config.sbom_build_dir: {
-                        'bind': data['bind']}}, user=uid, remove=True)
+                        'bind': data['bind']}}, user=uid, remove=True,timeout=Config.docker_timeout)
             logging.info('SBOM Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
             Config.sbom_message ='SBOM scan completed'
             Config.sbom_scan_status ='Completed'
@@ -655,7 +658,7 @@ def runImage(data=None,type=None):
             command_line = "% s" % command_line.format(target = os.path.join('/src',Utils.remove_leading_slash(Config.iac_scan_target)))   
             Config.build_dir = Config.iac_scan_build_dir
             container_output = docker.containers.run(docker_image, command_line, volumes={Config.iac_scan_build_dir: {
-                        'bind': data['bind']}}, user=uid, remove=True)
+                        'bind': data['bind']}}, user=uid, remove=True,timeout=Config.docker_timeout)
             logging.info('IaC Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
             Config.iac_scan_message ='IaC Scan completed'
             Config.iac_scan_status ='Completed'
@@ -693,66 +696,66 @@ def runImage(data=None,type=None):
             msg = 'Error recorded while uploading the report'
             Utils.logError(msg,str(e))
             
-    if type == 'reachability' and Config.sbom_scan_status.lower() != "failed":
-        Utils.checkImageAlreadyExsist(docker_image)
-        logging.info('Running %s',tool_name)
+    # if type == 'reachability' and Config.sbom_scan_status.lower() != "failed":
+    #     Utils.checkImageAlreadyExsist(docker_image)
+    #     logging.info('Running %s',tool_name)
         
-        try:
-            workspace = os.getcwd()
-
-            tmp_dir = os.path.join(workspace, ".ci_tmp")
-            home_dir = os.path.join(workspace, ".ci_home")
-
-            os.makedirs(tmp_dir, exist_ok=True)
-            os.makedirs(home_dir, exist_ok=True)
-
-            command_line = "% s" % command_line.format(lang = Config.reachability_language)   
-            #command_line ="atom reachables -l python -o /app/app.atom -s /app/reachables.slices.json /app"
-            Config.build_dir = Config.reachability_build_dir = Config.sca_build_dir
-            container_output = docker.containers.run(docker_image, command_line, volumes={
-            tmp_dir: {'bind': '/tmp', 'mode': 'rw'},
-            home_dir: {'bind': '/home/container', 'mode': 'rw'},
-            Config.reachability_build_dir: {'bind': data['bind'], 'mode': 'rw'}
-            }, user=uid, remove=True)
-            logging.info('Reachability Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
-            reachables = Utils.reachability_analysis(f'{Config.sbom_build_dir}/{Config.sbom_output_file}',f'{Config.sca_build_dir}/{output_file}')
-            Config.reachability_message ='Reachability Completed'
-            Config.reachability_status ='Completed'
-        except errors.ContainerError as exc:
-            logging.error('Reachability Docker: Failed!!! Message: Some Error recorded while scanning %s',str(exc))
-            msg='\n The following error has been recorded while scanning Reachability'
-            Config.reachability_status ='Failed'
-            Config.reachability_errors =f'{str(exc)}]'
-            Utils.logError(msg,str(exc))
-            reachables = None
+    #     try:
+    #         workspace = os.getcwd()
+
+    #         tmp_dir = os.path.join(workspace, ".ci_tmp")
+    #         home_dir = os.path.join(workspace, ".ci_home")
+
+    #         os.makedirs(tmp_dir, exist_ok=True)
+    #         os.makedirs(home_dir, exist_ok=True)
+
+    #         command_line = "% s" % command_line.format(lang = Config.reachability_language)   
+    #         #command_line ="atom reachables -l python -o /app/app.atom -s /app/reachables.slices.json /app"
+    #         Config.build_dir = Config.reachability_build_dir = Config.sca_build_dir
+    #         container_output = docker.containers.run(docker_image, command_line, volumes={
+    #         tmp_dir: {'bind': '/tmp', 'mode': 'rw'},
+    #         home_dir: {'bind': '/home/container', 'mode': 'rw'},
+    #         Config.reachability_build_dir: {'bind': data['bind'], 'mode': 'rw'}
+    #         }, user=uid, remove=True)
+    #         logging.info('Reachability Docker: SUCCESS!!! Message: %s Scan Completed',tool_name)
+    #         reachables = Utils.reachability_analysis(f'{Config.sbom_build_dir}/{Config.sbom_output_file}',f'{Config.sca_build_dir}/{output_file}')
+    #         Config.reachability_message ='Reachability Completed'
+    #         Config.reachability_status ='Completed'
+    #     except errors.ContainerError as exc:
+    #         logging.error('Reachability Docker: Failed!!! Message: Some Error recorded while scanning %s',str(exc))
+    #         msg='\n The following error has been recorded while scanning Reachability'
+    #         Config.reachability_status ='Failed'
+    #         Config.reachability_errors =f'{str(exc)}]'
+    #         Utils.logError(msg,str(exc))
+    #         reachables = None
         
-        try:
-            if will_generate_output == 1 and reachables is not None:
-                logging.info('Reachability: Uploading %s to the server',output_file)
-                output_reachability = {
-                    'output_file': output_file,
-                    'output': reachables
-                }
-                if uploadReport(output_reachability,tool_name,tool_id,scan_details_id,'reachability'):
-                    Config.reachability_status ='Completed'
-                    Config.reachability_upload_status = 'Completed'
-                    Config.reachability_message ='Scan Completed'
-                else:
-                    Config.reachability_status ='Failed'
-                    Config.reachability_upload_status = 'Failed'
-                    Config.reachability_message ='Error occured while uploading the report, Please check the cli logs'
-            else:
-                logging.error('reachability: Failed!!! Message: Cant upload files to the server',tool_name)
-                Config.reachability_message ='Cant upload files to the server for reachability, Please check your directory If output file is present.'
-
-        except EnvironmentError as e:
-            logging.error('reachability: Failed!!! Message: Error recorded while uploading the report %s',str(e))
-            Config.reachability_message ='Error recorded while uploading the report of reachability, Please check your directory If output file is present.'           ## need to change logic here -- MM
-            msg = 'Error recorded while uploading the report'
-            Utils.logError(msg,str(e))
-    elif type == "reachability":
-        Config.reachability_status ='Failed'
-        Config.reachability_message ='Reachability: SBOM scan failed. Reachability analysis requires sbom file'      
+    #     try:
+    #         if will_generate_output == 1 and reachables is not None:
+    #             logging.info('Reachability: Uploading %s to the server',output_file)
+    #             output_reachability = {
+    #                 'output_file': output_file,
+    #                 'output': reachables
+    #             }
+    #             if uploadReport(output_reachability,tool_name,tool_id,scan_details_id,'reachability'):
+    #                 Config.reachability_status ='Completed'
+    #                 Config.reachability_upload_status = 'Completed'
+    #                 Config.reachability_message ='Scan Completed'
+    #             else:
+    #                 Config.reachability_status ='Failed'
+    #                 Config.reachability_upload_status = 'Failed'
+    #                 Config.reachability_message ='Error occured while uploading the report, Please check the cli logs'
+    #         else:
+    #             logging.error('reachability: Failed!!! Message: Cant upload files to the server',tool_name)
+    #             Config.reachability_message ='Cant upload files to the server for reachability, Please check your directory If output file is present.'
+
+    #     except EnvironmentError as e:
+    #         logging.error('reachability: Failed!!! Message: Error recorded while uploading the report %s',str(e))
+    #         Config.reachability_message ='Error recorded while uploading the report of reachability, Please check your directory If output file is present.'           ## need to change logic here -- MM
+    #         msg = 'Error recorded while uploading the report'
+    #         Utils.logError(msg,str(e))
+    # elif type == "reachability":
+    #     Config.reachability_status ='Failed'
+    #     Config.reachability_message ='Reachability: SBOM scan failed. Reachability analysis requires sbom file'      
         
 
 #### function to upload the test report to the server with other data -- MM ------------------------------------
@@ -1261,6 +1264,7 @@ def default():
     parser.add_argument('-pot','--pollTime',default=60,help="Polling Time. Min : 30s, Max: 5min, Default : 1min. Format: input the time in seconds eg: 1min => 60 ")
     parser.add_argument('-pof','--pollFrequency',default=10,help="Polling Frequency. Min : 5s, Max: 1min, Default : 10s. Format: input the time in seconds eg: 1min => 60 ")
     parser.add_argument('-std','--setCacheDir',default=False,help="Set the cache directory for the scan. Set true if you use jenkins cicd")
+    parser.add_argument('-dto','--dockerTimeout',default=600,min=300,max=1800,help="Set the timeout for the docker scan in seconds. Default is 600s (10min). Min is 300s (5min) and Max is 1800s (30min). Format: input the time in seconds eg: 10min => 600 ")
     args = parser.parse_args()
 
     # if len(sys.args) == 1:
@@ -1387,7 +1391,12 @@ def default():
         logging.info(f"Configuring polling frequency to {Config.polling_frequency}s")
     else:
         logging.info(f"Resorting to default polling frequency {Config.polling_frequency}s")
-            
+        
+    if (args.dockerTimeout >=300) and (args.dockerTimeout <=1800):
+        Config.docker_timeout =  args.dockerTimeout
+        logging.info(f"docker timeout configured: {Config.docker_timeout}s")
+    else
+        logging.info(f"Resoting to default docker timeout: {Config.docker_timeout}s")  
     
     if args.failBuild != "pass":
         Config.fail_build = True

{boman_cli-2.5.11 → boman_cli-2.5.13}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 environment = prod
-version = 2.5.11
+version = 2.5.13
 name = boman-cli
 saas_base_url = https://dashboard.boman.ai/