scanoss 1.18.1__tar.gz → 1.19.0__tar.gz

{scanoss-1.18.1/src/scanoss.egg-info → scanoss-1.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scanoss
-Version: 1.18.1
+Version: 1.19.0
 Summary: Simple Python library to leverage the SCANOSS APIs
 Home-page: https://scanoss.com
 Author: SCANOSS
@@ -27,6 +27,8 @@ Requires-Dist: pyOpenSSL
 Requires-Dist: google-api-core
 Requires-Dist: importlib_resources
 Requires-Dist: packageurl-python
+Requires-Dist: pathspec
+Requires-Dist: jsonschema
 Provides-Extra: fast-winnowing
 Requires-Dist: scanoss_winnowing>=0.5.0; extra == "fast-winnowing"
 

{scanoss-1.18.1 → scanoss-1.19.0}/setup.cfg

@@ -36,6 +36,8 @@ install_requires =
 	google-api-core
 	importlib_resources
 	packageurl-python
+	pathspec
+	jsonschema
 
 [options.extras_require]
 fast_winnowing = 

{scanoss-1.18.1 → scanoss-1.19.0}/src/scanoss/__init__.py

@@ -22,4 +22,4 @@
    THE SOFTWARE.
 """
 
-__version__ = "1.18.1"
+__version__ = "1.19.0"

{scanoss-1.18.1 → scanoss-1.19.0}/src/scanoss/cli.py

@@ -30,7 +30,7 @@ import pypac
 from .inspection.copyleft import Copyleft
 from .inspection.undeclared_component import UndeclaredComponent
 from .threadeddependencies import SCOPE
-from .scanoss_settings import ScanossSettings
+from .scanoss_settings import ScanossSettings, ScanossSettingsError
 from .scancodedeps import ScancodeDeps
 from .scanner import Scanner
 from .scantype import ScanType
@@ -42,6 +42,7 @@ from .components import Components
 from . import __version__
 from .scanner import FAST_WINNOWING
 from .results import Results
+from .utils.file import validate_json_file
 
 
 def print_stderr(*args, **kwargs):
@@ -109,11 +110,14 @@ def setup_args() -> None:
     p_scan.add_argument('--dep-scope-inc', '-dsi', type=str,help='Include dependencies with declared scopes')
     p_scan.add_argument('--dep-scope-exc', '-dse', type=str, help='Exclude dependencies with declared scopes')
     p_scan.add_argument(
-        '--settings',
+        '--settings', '-st',
         type=str,
         help='Settings file to use for scanning (optional - default scanoss.json)',
     )
-
+    p_scan.add_argument(
+        '--skip-settings-file', '-stf', action='store_true',
+        help='Skip default settings file (scanoss.json) if it exists',
+    )
 
     # Sub-command: fingerprint
     p_wfp = subparsers.add_parser('fingerprint', aliases=['fp', 'wfp'],
@@ -125,6 +129,15 @@ def setup_args() -> None:
     p_wfp.add_argument('--stdin', '-s', metavar='STDIN-FILENAME',  type=str,
                        help='Fingerprint the file contents supplied via STDIN (optional)')
     p_wfp.add_argument('--output', '-o', type=str, help='Output result file name (optional - default stdout).')
+    p_wfp.add_argument(
+        '--settings', '-st',
+        type=str,
+        help='Settings file to use for fingerprinting (optional - default scanoss.json)',
+    )
+    p_wfp.add_argument(
+        '--skip-settings-file', '-stf', action='store_true',
+        help='Skip default settings file (scanoss.json) if it exists',
+    )
 
     # Sub-command: dependency
     p_dep = subparsers.add_parser('dependencies', aliases=['dp', 'dep'],
@@ -460,13 +473,24 @@ def wfp(parser, args):
     if args.output:
         scan_output = args.output
         open(scan_output, 'w').close()
+        
+    # Load scan settings
+    scan_settings = None
+    if not args.skip_settings_file:
+        scan_settings = ScanossSettings(debug=args.debug, trace=args.trace, quiet=args.quiet)
+        try:
+            scan_settings.load_json_file(args.settings)
+        except ScanossSettingsError as e:
+            print_stderr(f'Error: {e}')
+            exit(1)
 
     scan_options = 0 if args.skip_snippets else ScanType.SCAN_SNIPPETS.value  # Skip snippet generation or not
     scanner = Scanner(debug=args.debug, trace=args.trace, quiet=args.quiet, obfuscate=args.obfuscate,
                       scan_options=scan_options, all_extensions=args.all_extensions,
                       all_folders=args.all_folders, hidden_files_folders=args.all_hidden, hpsm=args.hpsm,
                       skip_size=args.skip_size, skip_extensions=args.skip_extension, skip_folders=args.skip_folder,
-                      skip_md5_ids=args.skip_md5, strip_hpsm_ids=args.strip_hpsm, strip_snippet_ids=args.strip_snippet
+                      skip_md5_ids=args.skip_md5, strip_hpsm_ids=args.strip_hpsm, strip_snippet_ids=args.strip_snippet,
+                      scan_settings=scan_settings
                       )
     if args.stdin:
         contents = sys.stdin.buffer.read()
@@ -529,13 +553,7 @@ def scan(parser, args):
         args: Namespace
             Parsed arguments
     """
-    if (
-        not args.scan_dir
-        and not args.wfp
-        and not args.stdin
-        and not args.dep
-        and not args.files
-    ):
+    if not args.scan_dir and not args.wfp and not args.stdin and not args.dep and not args.files:
         print_stderr(
             'Please specify a file/folder, files (--files), fingerprint (--wfp), dependency (--dep), or STDIN (--stdin)'
         )
@@ -545,54 +563,36 @@ def scan(parser, args):
         print_stderr('Please specify one of --proxy or --pac, not both')
         parser.parse_args([args.subparser, '-h'])
         exit(1)
-
     if args.identify and args.settings:
-        print_stderr(f'ERROR: Cannot specify both --identify and --settings options.')
+        print_stderr('ERROR: Cannot specify both --identify and --settings options.')
         exit(1)
-
-    def is_valid_file(file_path: str) -> bool:
-        if not os.path.exists(file_path) or not os.path.isfile(file_path):
-            print_stderr(f'Specified file does not exist or is not a file: {file_path}')
-            return False
-        if not Scanner.valid_json_file(file_path):
-            return False
-        return True
-
-    scan_settings = ScanossSettings(
-        debug=args.debug, trace=args.trace, quiet=args.quiet
-    )
-
-    if args.identify:
-        if not is_valid_file(args.identify) or args.ignore:
-            exit(1)
-        scan_settings.load_json_file(args.identify).set_file_type(
-            'legacy'
-        ).set_scan_type('identify')
-    elif args.ignore:
-        if not is_valid_file(args.ignore):
-            exit(1)
-        scan_settings.load_json_file(args.ignore).set_file_type('legacy').set_scan_type(
-            'blacklist'
-        )
-    elif args.settings:
-        if not is_valid_file(args.settings):
+    if args.settings and args.skip_settings_file:
+        print_stderr('ERROR: Cannot specify both --settings and --skip-file-settings options.')
+        exit(1)
+    # Figure out which settings (if any) to load before processing
+    scan_settings = None
+    if not args.skip_settings_file:
+        scan_settings = ScanossSettings(debug=args.debug, trace=args.trace, quiet=args.quiet)
+        try:
+            if args.identify:
+                scan_settings.load_json_file(args.identify).set_file_type('legacy').set_scan_type('identify')
+            elif args.ignore:
+                scan_settings.load_json_file(args.ignore).set_file_type('legacy').set_scan_type('blacklist')
+            else:
+                scan_settings.load_json_file(args.settings).set_file_type('new').set_scan_type('identify')
+        except ScanossSettingsError as e:
+            print_stderr(f'Error: {e}')
             exit(1)
-        scan_settings.load_json_file(args.settings).set_file_type('new').set_scan_type(
-            'identify'
-        )
-
     if args.dep:
         if not os.path.exists(args.dep) or not os.path.isfile(args.dep):
-            print_stderr(
-                f'Specified --dep file does not exist or is not a file: {args.dep}'
-            )
+            print_stderr(f'Specified --dep file does not exist or is not a file: {args.dep}')
             exit(1)
-        if not Scanner.valid_json_file(args.dep):  # Make sure it's a valid JSON file
+        result = validate_json_file(args.dep)
+        if not result.is_valid:
+            print_stderr(f'Error: Dependency file is not valid: {result.error}')
             exit(1)
     if args.strip_hpsm and not args.hpsm and not args.quiet:
-        print_stderr(
-            f'Warning: --strip-hpsm option supplied without enabling HPSM (--hpsm). Ignoring.'
-        )
+        print_stderr('Warning: --strip-hpsm option supplied without enabling HPSM (--hpsm). Ignoring.')
 
     scan_output: str = None
     if args.output:
@@ -601,6 +601,8 @@ def scan(parser, args):
     output_format = args.format if args.format else 'plain'
     flags = args.flags if args.flags else None
     if args.debug and not args.quiet:
+        if args.skip_settings_file:
+            print_stderr('Skipping Settings file...')
         if args.all_extensions:
             print_stderr("Scanning all file extensions/types...")
         if args.all_folders:
@@ -631,17 +633,11 @@ def scan(parser, args):
             print_stderr(f'Using flags {flags}...')
     elif not args.quiet:
         if args.timeout < 5:
-            print_stderr(
-                f'POST timeout (--timeout) too small: {args.timeout}. Reverting to default.'
-            )
+            print_stderr(f'POST timeout (--timeout) too small: {args.timeout}. Reverting to default.')
         if args.retry < 0:
-            print_stderr(
-                f'POST retry (--retry) too small: {args.retry}. Reverting to default.'
-            )
+            print_stderr(f'POST retry (--retry) too small: {args.retry}. Reverting to default.')
 
-    if not os.access(
-        os.getcwd(), os.W_OK
-    ):  # Make sure the current directory is writable. If not disable saving WFP
+    if not os.access(os.getcwd(), os.W_OK):  # Make sure the current directory is writable. If not disable saving WFP
         print_stderr(f'Warning: Current directory is not writable: {os.getcwd()}')
         args.no_wfp_output = True
     if args.ca_cert and not os.path.exists(args.ca_cert):
@@ -651,11 +647,8 @@ def scan(parser, args):
     scan_options = get_scan_options(args)  # Figure out what scanning options we have
 
     scanner = Scanner(
-        debug=args.debug,
-        trace=args.trace,
-        quiet=args.quiet,
-        api_key=args.key,
-        url=args.apiurl,
+        debug=args.debug, trace=args.trace, quiet=args.quiet,
+        api_key=args.key, url=args.apiurl,
         scan_output=scan_output,
         output_format=output_format,
         flags=flags,
@@ -684,19 +677,14 @@ def scan(parser, args):
         skip_md5_ids=args.skip_md5,
         strip_hpsm_ids=args.strip_hpsm,
         strip_snippet_ids=args.strip_snippet,
-        scan_settings=scan_settings
+        scan_settings=scan_settings,
     )
-
     if args.wfp:
         if not scanner.is_file_or_snippet_scan():
-            print_stderr(
-                f'Error: Cannot specify WFP scanning if file/snippet options are disabled ({scan_options})'
-            )
+            print_stderr(f'Error: Cannot specify WFP scanning if file/snippet options are disabled ({scan_options})')
             exit(1)
         if scanner.is_dependency_scan() and not args.dep:
-            print_stderr(
-                f'Error: Cannot specify WFP & Dependency scanning without a dependency file (--dep)'
-            )
+            print_stderr(f'Error: Cannot specify WFP & Dependency scanning without a dependency file (--dep)')
             exit(1)
         scanner.scan_wfp_with_options(args.wfp, args.dep)
     elif args.stdin:
@@ -710,9 +698,7 @@ def scan(parser, args):
             exit(1)
     elif args.scan_dir:
         if not os.path.exists(args.scan_dir):
-            print_stderr(
-                f'Error: File or folder specified does not exist: {args.scan_dir}.'
-            )
+            print_stderr(f'Error: File or folder specified does not exist: {args.scan_dir}.')
             exit(1)
         if os.path.isdir(args.scan_dir):
             if not scanner.scan_folder_with_options(args.scan_dir, args.dep, scanner.winnowing.file_map,
@@ -723,9 +709,7 @@ def scan(parser, args):
                                                   args.dep_scope, args.dep_scope_inc, args.dep_scope_exc):
                 exit(1)
         else:
-            print_stderr(
-                f'Error: Path specified is neither a file or a folder: {args.scan_dir}.'
-            )
+            print_stderr(f'Error: Path specified is neither a file or a folder: {args.scan_dir}.')
             exit(1)
     elif args.dep:
         if not args.dependencies_only:

scanoss-1.19.0/src/scanoss/data/build_date.txt

@@ -0,0 +1 @@
+date: 20241220152032, utime: 1734708032

scanoss-1.19.0/src/scanoss/data/scanoss-settings-schema.json

@@ -0,0 +1,254 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "Scanoss Settings",
+  "type": "object",
+  "properties": {
+    "self": {
+      "type": "object",
+      "description": "Description of the project under analysis",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the project"
+        },
+        "license": {
+          "type": "string",
+          "description": "License of the project"
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the project"
+        }
+      }
+    },
+    "settings": {
+      "type": "object",
+      "description": "Scan settings and other configurations",
+      "properties": {
+        "skip": {
+          "type": "object",
+          "description": "Set of rules to skip files from fingerprinting and scanning",
+          "properties": {
+            "patterns": {
+              "type": "object",
+              "properties": {
+                "scanning": {
+                  "type": "array",
+                  "description": "List of glob patterns to skip files from scanning",
+                  "items": {
+                    "type": "string",
+                    "examples": [
+                      "path/to/folder",
+                      "path/to/folder/**",
+                      "path/to/folder/**/*",
+                      "path/to/file.c",
+                      "path/to/another/file.py",
+                      "**/*.ts",
+                      "**/*.json"
+                    ]
+                  },
+                  "uniqueItems": true
+                },
+                "fingerprinting": {
+                  "type": "array",
+                  "description": "List of glob patterns to skip files from fingerprinting",
+                  "items": {
+                    "type": "string",
+                    "examples": [
+                      "path/to/folder",
+                      "path/to/folder/**",
+                      "path/to/folder/**/*",
+                      "path/to/file.c",
+                      "path/to/another/file.py",
+                      "**/*.ts",
+                      "**/*.json"
+                    ]
+                  },
+                  "uniqueItems": true
+                }
+              }
+            },
+            "sizes": {
+              "type": "object",
+              "description": "Set of rules to skip files based on their size.",
+              "properties": {
+                "scanning": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "patterns": {
+                        "type": "array",
+                        "description": "List of glob patterns to apply the min/max size rule",
+                        "items": {
+                          "type": "string",
+                          "examples": [
+                            "path/to/folder",
+                            "path/to/folder/**",
+                            "path/to/folder/**/*",
+                            "path/to/file.c",
+                            "path/to/another/file.py",
+                            "**/*.ts",
+                            "**/*.json"
+                          ]
+                        }
+                      },
+                      "min": {
+                        "type": "integer",
+                        "description": "Minimum size of the file in bytes"
+                      },
+                      "max": {
+                        "type": "integer",
+                        "description": "Maximum size of the file in bytes"
+                      }
+                    }
+                  }
+                },
+                "fingerprinting": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "patterns": {
+                        "type": "array",
+                        "description": "List of glob patterns to apply the min/max size rule",
+                        "items": {
+                          "type": "string"
+                        },
+                        "examples": [
+                          "path/to/folder",
+                          "path/to/folder/**",
+                          "path/to/folder/**/*",
+                          "path/to/file.c",
+                          "path/to/another/file.py",
+                          "**/*.ts",
+                          "**/*.json"
+                        ]
+                      },
+                      "min": {
+                        "type": "integer",
+                        "description": "Minimum size of the file in bytes"
+                      },
+                      "max": {
+                        "type": "integer",
+                        "description": "Maximum size of the file in bytes"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "bom": {
+      "type": "object",
+      "description": "BOM Rules: Set of rules that will be used to modify the BOM before and after the scan is completed",
+      "properties": {
+        "include": {
+          "type": "array",
+          "description": "Set of rules to be added as context when scanning. This list will be sent as payload to the API.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "File path",
+                "examples": ["/path/to/file", "/path/to/another/file"],
+                "items": {
+                  "type": "string"
+                },
+                "uniqueItems": true
+              },
+              "purl": {
+                "type": "string",
+                "description": "Package URL to be used to match the component",
+                "examples": [
+                  "pkg:npm/vue@2.6.12",
+                  "pkg:golang/github.com/golang/go@1.17.3"
+                ]
+              },
+              "comment": {
+                "type": "string",
+                "description": "Additional notes or comments"
+              }
+            },
+            "uniqueItems": true,
+            "required": ["purl"]
+          }
+        },
+        "remove": {
+          "type": "array",
+          "description": "Set of rules that will remove files from the results file after the scan is completed.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "File path",
+                "examples": ["/path/to/file", "/path/to/another/file"]
+              },
+              "purl": {
+                "type": "string",
+                "description": "Package URL",
+                "examples": [
+                  "pkg:npm/vue@2.6.12",
+                  "pkg:golang/github.com/golang/go@1.17.3"
+                ]
+              },
+              "comment": {
+                "type": "string",
+                "description": "Additional notes or comments"
+              }
+            },
+            "uniqueItems": true,
+            "required": ["purl"]
+          }
+        },
+        "replace": {
+          "type": "array",
+          "description": "Set of rules that will replace components with the specified one after the scan is completed.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "File path",
+                "examples": ["/path/to/file", "/path/to/another/file"]
+              },
+              "purl": {
+                "type": "string",
+                "description": "Package URL to replace",
+                "examples": [
+                  "pkg:npm/vue@2.6.12",
+                  "pkg:golang/github.com/golang/go@1.17.3"
+                ]
+              },
+              "comment": {
+                "type": "string",
+                "description": "Additional notes or comments"
+              },
+              "license": {
+                "type": "string",
+                "description": "License of the component. Should be a valid SPDX license expression",
+                "examples": ["MIT", "Apache-2.0"]
+              },
+              "replace_with": {
+                "type": "string",
+                "description": "Package URL to replace with",
+                "examples": [
+                  "pkg:npm/vue@2.6.12",
+                  "pkg:golang/github.com/golang/go@1.17.3"
+                ]
+              }
+            },
+            "uniqueItems": true,
+            "required": ["purl", "replace_with"]
+          }
+        }
+      }
+    }
+  }
+}
+