Repository navigation
Expand file tree
/
Copy pathconfig.py
More file actions
1233 lines (1167 loc) · 47.3 KB
/
Copy pathconfig.py
File metadata and controls
1233 lines (1167 loc) · 47.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import argparse
import json
import logging
import os
import tomllib
from dataclasses import asdict, dataclass, field
from typing import List, Optional
from socketdev import INTEGRATION_TYPES, IntegrationType
from socketsecurity import __version__
def get_plugin_config_from_env(prefix: str) -> dict:
config_str = os.getenv(f"{prefix}_CONFIG_JSON", "{}")
try:
return json.loads(config_str)
except json.JSONDecodeError:
return {}
# commit_message rides in the query string of POST /v0/orgs/{org}/full-scans, so an
# oversized message overflows the edge proxy's request line limit before the API ever
# sees it. The API itself has no length validation on the field; the rejection comes
# from the proxy, which reports 413, 414 or 431 depending on which limit it checks. 200
# chars is a conservative ceiling given URL encoding can 2-3x the raw character count.
MAX_COMMIT_MESSAGE_LENGTH = 200
COMMIT_MESSAGE_TRUNCATION_MARKER = "..."
def truncate_commit_message(commit_message: Optional[str]) -> Optional[str]:
"""Cap commit_message to a length the full-scan request line can carry."""
if commit_message and len(commit_message) > MAX_COMMIT_MESSAGE_LENGTH:
# INFO, not DEBUG: the scan keeps the truncated value, so for a CI job that does
# not pass --enable-debug this line is the only explanation of why the message in
# the dashboard is clipped.
logging.info(
f"commit_message truncated from {len(commit_message)} to "
f"{MAX_COMMIT_MESSAGE_LENGTH} characters to stay within API request size limits"
)
keep = MAX_COMMIT_MESSAGE_LENGTH - len(COMMIT_MESSAGE_TRUNCATION_MARKER)
return commit_message[:keep] + COMMIT_MESSAGE_TRUNCATION_MARKER
return commit_message
def load_cli_config_file(config_path: str) -> dict:
"""
Load CLI defaults from a JSON or TOML file.
Supported structures:
- Flat keys: {"sarif_scope": "full", "reach": true}
- Namespaced keys:
- JSON: {"socketcli": {...}}
- TOML: [socketcli]
"""
if not config_path:
return {}
try:
with open(config_path, "rb") as f:
if config_path.lower().endswith(".json"):
data = json.loads(f.read().decode("utf-8"))
elif config_path.lower().endswith(".toml"):
data = tomllib.load(f)
else:
logging.error("--config must be a .json or .toml file")
exit(1)
except FileNotFoundError:
logging.error(f"Config file not found: {config_path}")
exit(1)
except (json.JSONDecodeError, tomllib.TOMLDecodeError) as e:
logging.error(f"Invalid config file format: {e}")
exit(1)
if not isinstance(data, dict):
logging.error("Config file must contain a top-level object/table")
exit(1)
scoped = data.get("socketcli")
if isinstance(scoped, dict):
return scoped
return data
def normalize_exclude_paths(value) -> Optional[List[str]]:
"""Normalize a --exclude-paths value into a clean list of patterns.
Accepts a comma-separated string (CLI) or a list/tuple (e.g. a JSON/TOML --config file
value), so config-file-supplied patterns flow through the same validation as CLI ones.
"""
if not value:
return None
if isinstance(value, str):
items = value.split(",")
elif isinstance(value, (list, tuple)):
items = value
else:
return None
cleaned = [str(p).strip() for p in items if str(p).strip()]
return cleaned or None
def validate_exclude_paths(patterns: List[str]) -> None:
"""Validate --exclude-paths patterns (mirrors Node's assertValidExcludePaths).
Patterns are scan-root-relative globs. Reject the cases coana's --exclude-dirs / fast-glob
cannot honor: negation, absolute paths, ``..`` traversal, and degenerate match-everything.
Exits with code 1 on the first invalid pattern.
"""
# Degenerate match-everything forms, compared against the trailing-slash-stripped pattern
# (so "**/" reduces to "**" and is rejected, matching Node's stripTrailingSlash + check).
degenerate = {"", ".", "**", "./**", "/**"}
for p in patterns:
norm = (p or "").strip().replace("\\", "/")
if norm.startswith("!"):
logging.error(f"--exclude-paths: negation patterns are not supported: {p!r}")
exit(1)
if norm.startswith("/"):
logging.error(f"--exclude-paths: patterns must be scan-root relative (no leading '/'): {p!r}")
exit(1)
if norm == ".." or norm.startswith("../") or "/../" in norm or norm.endswith("/.."):
logging.error(f"--exclude-paths: '..' path traversal is not allowed: {p!r}")
exit(1)
if norm.rstrip("/") in degenerate:
logging.error(f"--exclude-paths: pattern would exclude everything: {p!r}")
exit(1)
@dataclass
class PluginConfig:
enabled: bool = False
levels: List[str] = None
config: Optional[dict] = None
@dataclass
class CliConfig:
api_token: str
repo: Optional[str]
branch: str = ""
committers: Optional[List[str]] = None
pr_number: str = "0"
pr_number_explicit: bool = False
commit_message: Optional[str] = None
default_branch: bool = False
target_path: str = "./"
scm: str = "api"
sbom_file: Optional[str] = None
commit_sha: str = ""
base_scan_id: Optional[str] = None
base_commit_sha: Optional[str] = None
generate_license: bool = False
enable_debug: bool = False
allow_unverified: bool = False
enable_json: bool = False
json_file: Optional[str] = None
enable_sarif: bool = False
sarif_file: Optional[str] = None
sarif_scope: str = "diff"
sarif_grouping: str = "instance"
sarif_reachability: str = "all"
enable_gitlab_security: bool = False
gitlab_security_file: Optional[str] = None
summary_file: Optional[str] = None
report_link_file: Optional[str] = None
disable_overview: bool = False
disable_security_issue: bool = False
files: str = None
ignore_commit_files: bool = False
disable_blocking: bool = False
disable_ignore: bool = False
ignore_authorization: str = "enforce"
# Tri-state log-upload preference: True = --upload-logs, False = --no-upload-logs,
# None = neither (server-side override decides).
upload_logs: Optional[bool] = None
strict_blocking: bool = False
integration_type: IntegrationType = "api"
integration_org_slug: Optional[str] = None
pending_head: bool = False
enable_diff: bool = False
timeout: Optional[int] = 1200
exit_code_on_api_error: int = 3
exclude_license_details: bool = False
include_module_folders: bool = False
repo_is_public: bool = False
excluded_ecosystems: list[str] = field(default_factory=lambda: [])
exclude_paths: Optional[List[str]] = None
included_dirs: List[str] = field(default_factory=lambda: [])
version: str = __version__
jira_plugin: PluginConfig = field(default_factory=PluginConfig)
slack_plugin: PluginConfig = field(default_factory=PluginConfig)
slack_webhook: Optional[str] = None
license_file_name: str = "license_output.json"
save_submitted_files_list: Optional[str] = None
save_manifest_tar: Optional[str] = None
sub_paths: List[str] = field(default_factory=list)
workspace_name: Optional[str] = None
workspace: Optional[str] = None
# Reachability Flags
reach: bool = False
reach_version: Optional[str] = None
reach_analysis_memory_limit: Optional[str] = None
reach_analysis_timeout: Optional[str] = None
reach_disable_analytics: bool = False
reach_disable_analysis_splitting: bool = False # Deprecated, kept for backwards compatibility
reach_enable_analysis_splitting: bool = False
reach_detailed_analysis_log_file: bool = False
reach_lazy_mode: bool = False # Deprecated, kept for backwards compatibility
reach_ecosystems: Optional[List[str]] = None
reach_exclude_paths: Optional[List[str]] = None
reach_skip_cache: bool = False
reach_min_severity: Optional[str] = None
reach_output_file: Optional[str] = None
reach_concurrency: Optional[int] = None
reach_additional_params: Optional[List[str]] = None
only_facts_file: bool = False
reach_use_only_pregenerated_sboms: bool = False
reach_continue_on_analysis_errors: bool = False
reach_continue_on_install_errors: bool = False
reach_continue_on_missing_lock_files: bool = False
reach_continue_on_no_source_files: bool = False
reach_debug: bool = False
reach_disable_external_tool_checks: bool = False
max_purl_batch_size: int = 5000
enable_commit_status: bool = False
legal: bool = False
legal_format: str = "socket"
config_file: Optional[str] = None
def __post_init__(self):
# Capped on construction so that every source of commit_message -- the
# --commit-message flag, a config file, the git backfill in socketcli -- lands
# under the limit.
self.commit_message = truncate_commit_message(self.commit_message)
@classmethod
def from_args(cls, args_list: Optional[List[str]] = None) -> 'CliConfig':
parser = create_argument_parser()
pre_parser = argparse.ArgumentParser(add_help=False)
pre_parser.add_argument("--config", dest="config_file", default=None)
pre_args, _ = pre_parser.parse_known_args(args_list)
if pre_args.config_file:
config_defaults = load_cli_config_file(pre_args.config_file)
valid_dests = {action.dest for action in parser._actions if action.dest != "help"}
normalized_defaults = {}
for key, value in config_defaults.items():
dest = str(key).replace("-", "_")
if dest in valid_dests:
normalized_defaults[dest] = value
parser.set_defaults(**normalized_defaults)
args = parser.parse_args(args_list)
integration_explicit = hasattr(args, "integration")
pr_number_explicit = hasattr(args, "pr_number")
integration_type = getattr(args, "integration", "api")
pr_number = getattr(args, "pr_number", "0")
if (
not integration_explicit and
integration_type == "api" and
args.scm in ("github", "gitlab")
):
integration_type = args.scm
if args.reach_exclude_paths:
logging.warning(
"--reach-exclude-paths is deprecated; use --exclude-paths instead. "
"It is still honored and unioned with --exclude-paths."
)
# Get API token from env or args (check multiple env var names)
api_token = (
os.getenv("SOCKET_SECURITY_API_KEY") or
os.getenv("SOCKET_SECURITY_API_TOKEN") or
os.getenv("SOCKET_API_KEY") or
os.getenv("SOCKET_API_TOKEN") or
args.api_token
)
# --sarif-file implies --enable-sarif
if args.sarif_file:
args.enable_sarif = True
# Strip quotes from commit message if present
commit_message = args.commit_message
if commit_message and commit_message.startswith('"') and commit_message.endswith('"'):
commit_message = commit_message[1:-1]
config_args = {
'api_token': api_token,
'repo': args.repo,
'branch': args.branch,
'committers': args.committers,
'pr_number': pr_number,
'pr_number_explicit': pr_number_explicit,
'commit_message': commit_message,
'default_branch': args.default_branch,
'target_path': os.path.expanduser(args.target_path),
'scm': args.scm,
'sbom_file': args.sbom_file,
'commit_sha': args.commit_sha,
'base_scan_id': args.base_scan_id,
'base_commit_sha': args.base_commit_sha,
'generate_license': args.generate_license,
'enable_debug': args.enable_debug,
'enable_diff': args.enable_diff,
'allow_unverified': args.allow_unverified,
'enable_json': args.enable_json,
'json_file': args.json_file,
'enable_sarif': args.enable_sarif,
'sarif_file': args.sarif_file,
'sarif_scope': args.sarif_scope,
'sarif_grouping': args.sarif_grouping,
'sarif_reachability': args.sarif_reachability,
'enable_gitlab_security': args.enable_gitlab_security,
'gitlab_security_file': args.gitlab_security_file,
'summary_file': args.summary_file,
'report_link_file': args.report_link_file,
'disable_overview': args.disable_overview,
'disable_security_issue': args.disable_security_issue,
'files': args.files,
'ignore_commit_files': args.ignore_commit_files,
'disable_blocking': args.disable_blocking,
'disable_ignore': args.disable_ignore,
'ignore_authorization': args.ignore_authorization,
'upload_logs': args.upload_logs,
'strict_blocking': args.strict_blocking,
'integration_type': integration_type,
'pending_head': args.pending_head,
'timeout': args.timeout,
'exit_code_on_api_error': args.exit_code_on_api_error,
'exclude_license_details': args.exclude_license_details,
'include_module_folders': args.include_module_folders,
'repo_is_public': args.repo_is_public,
"excluded_ecosystems": args.excluded_ecosystems,
'license_file_name': args.license_file_name,
'save_submitted_files_list': args.save_submitted_files_list,
'save_manifest_tar': args.save_manifest_tar,
'sub_paths': args.sub_paths or [],
'workspace_name': args.workspace_name,
'workspace': args.workspace,
'slack_webhook': args.slack_webhook,
'reach': args.reach,
'reach_version': args.reach_version,
'reach_analysis_timeout': args.reach_analysis_timeout,
'reach_analysis_memory_limit': args.reach_analysis_memory_limit,
'reach_disable_analytics': args.reach_disable_analytics,
'reach_disable_analysis_splitting': args.reach_disable_analysis_splitting,
'reach_enable_analysis_splitting': args.reach_enable_analysis_splitting,
'reach_detailed_analysis_log_file': args.reach_detailed_analysis_log_file,
'reach_lazy_mode': args.reach_lazy_mode,
'reach_ecosystems': args.reach_ecosystems.split(',') if args.reach_ecosystems else None,
'reach_exclude_paths': args.reach_exclude_paths.split(',') if args.reach_exclude_paths else None,
'exclude_paths': normalize_exclude_paths(args.exclude_paths),
'included_dirs': normalize_exclude_paths(args.include_dirs) or [],
'reach_skip_cache': args.reach_skip_cache,
'reach_min_severity': args.reach_min_severity,
'reach_output_file': args.reach_output_file,
'reach_concurrency': args.reach_concurrency,
'reach_additional_params': args.reach_additional_params,
'only_facts_file': args.only_facts_file,
'reach_use_only_pregenerated_sboms': args.reach_use_only_pregenerated_sboms,
'reach_continue_on_analysis_errors': args.reach_continue_on_analysis_errors,
'reach_continue_on_install_errors': args.reach_continue_on_install_errors,
'reach_continue_on_missing_lock_files': args.reach_continue_on_missing_lock_files,
'reach_continue_on_no_source_files': args.reach_continue_on_no_source_files,
'reach_debug': args.reach_debug,
'reach_disable_external_tool_checks': args.reach_disable_external_tool_checks,
'max_purl_batch_size': args.max_purl_batch_size,
'enable_commit_status': args.enable_commit_status,
'legal': args.legal or args.legal_format == "fossa",
'legal_format': args.legal_format,
'config_file': args.config_file,
'version': __version__
}
if config_args['legal']:
config_args['generate_license'] = True
if not config_args['json_file']:
config_args['json_file'] = "socket-report.json"
if not config_args['summary_file']:
config_args['summary_file'] = "socket-summary.txt"
if not config_args['report_link_file']:
config_args['report_link_file'] = "socket-report-link.txt"
if not config_args['sbom_file']:
config_args['sbom_file'] = "socket-sbom.json"
if config_args['license_file_name'] == "license_output.json":
config_args['license_file_name'] = "socket-license.json"
if config_args['legal_format'] == "fossa":
if not args.json_file:
config_args['json_file'] = "fossa-analyze.json"
if not args.summary_file:
config_args['summary_file'] = "fossa-test.txt"
if not args.report_link_file:
config_args['report_link_file'] = "fossa-link.txt"
if not args.license_file_name:
# argparse always provides a default, so this branch is defensive only
config_args['license_file_name'] = "fossa-sbom.json"
elif args.license_file_name == "license_output.json":
config_args['license_file_name'] = "fossa-sbom.json"
if not args.sbom_file:
# FOSSA's "SBOM" artifact is the attribution payload; suppress the extra Socket-only SBOM file by default.
config_args['sbom_file'] = None
excluded_ecosystems = config_args["excluded_ecosystems"]
if isinstance(excluded_ecosystems, list):
config_args["excluded_ecosystems"] = excluded_ecosystems
elif isinstance(excluded_ecosystems, str):
try:
config_args["excluded_ecosystems"] = json.loads(excluded_ecosystems.replace("'", '"'))
except json.JSONDecodeError:
logging.error(f"Unable to parse excluded_ecosystems: {excluded_ecosystems}")
exit(1)
else:
logging.error(f"Unable to parse excluded_ecosystems: {excluded_ecosystems}")
exit(1)
# Build Slack plugin config, merging CLI arg with env config
slack_config = get_plugin_config_from_env("SOCKET_SLACK")
if args.slack_webhook:
slack_config["url"] = args.slack_webhook
config_args.update({
"jira_plugin": PluginConfig(
enabled=os.getenv("SOCKET_JIRA_ENABLED", "false").lower() == "true",
levels=os.getenv("SOCKET_JIRA_LEVELS", "block,warn").split(","),
config=get_plugin_config_from_env("SOCKET_JIRA")
),
"slack_plugin": PluginConfig(
enabled=bool(slack_config) or bool(args.slack_webhook),
levels=os.getenv("SOCKET_SLACK_LEVELS", "block,warn").split(","),
config=slack_config
)
})
if args.owner:
config_args['integration_org_slug'] = args.owner
# Validate that sub_paths and workspace_name are used together
if args.sub_paths and not args.workspace_name:
logging.error("--sub-path requires --workspace-name to be specified")
exit(1)
if args.workspace_name and not args.sub_paths:
logging.error("--workspace-name requires --sub-path to be specified")
exit(1)
# argparse only enforces the mutually exclusive group for real CLI args;
# this also catches both values arriving via a --config file.
if args.base_scan_id and args.base_commit_sha:
logging.error("--base-scan-id and --base-commit-sha are mutually exclusive")
exit(1)
if args.sarif_scope == "full" and not args.reach:
logging.error("--sarif-scope full requires --reach to be specified")
exit(1)
if args.sarif_reachability != "all" and not args.reach:
logging.error("--sarif-reachability requires --reach to be specified")
exit(1)
if args.sarif_grouping == "alert" and args.sarif_scope != "full":
logging.error("--sarif-grouping alert currently requires --sarif-scope full")
exit(1)
if args.sarif_reachability in ("potentially", "reachable-or-potentially") and args.sarif_scope != "full":
logging.error("--sarif-reachability potentially/reachable-or-potentially requires --sarif-scope full")
exit(1)
# Validate --exclude-paths patterns up front (mirrors Node's assertValidExcludePaths).
if config_args.get("exclude_paths"):
validate_exclude_paths(config_args["exclude_paths"])
# Validate that only_facts_file requires reach
if args.only_facts_file and not args.reach:
logging.error("--only-facts-file requires --reach to be specified")
exit(1)
# Validate that reach_use_only_pregenerated_sboms requires reach
if args.reach_use_only_pregenerated_sboms and not args.reach:
logging.error("--reach-use-only-pregenerated-sboms requires --reach to be specified")
exit(1)
# Validate reach_concurrency is >= 1 if provided
if args.reach_concurrency is not None and args.reach_concurrency < 1:
logging.error("--reach-concurrency must be >= 1")
exit(1)
# Validate max_purl_batch_size is within allowed range
if args.max_purl_batch_size < 1 or args.max_purl_batch_size > 9999:
logging.error("--max-purl-batch-size must be between 1 and 9999")
exit(1)
return cls(**config_args)
def to_dict(self) -> dict:
return asdict(self)
def create_argument_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser(
prog="socketcli",
description="The Socket Security CLI will get the head scan for the provided repo from Socket, create a new one, and then report any alerts introduced by the changes. Any new alerts will cause the CLI to exit with a non-Zero exit code (1 for error alerts, 5 for warnings)."
)
# Authentication
auth_group = parser.add_argument_group('Authentication')
auth_group.add_argument(
"--config",
dest="config_file",
metavar="<path>",
help="Path to JSON/TOML file with default CLI options. CLI flags take precedence."
)
auth_group.add_argument(
"--api-token",
dest="api_token",
metavar="<token>",
help="Socket Security API token (can also be set via SOCKET_SECURITY_API_TOKEN env var)",
required=False
)
auth_group.add_argument(
"--api_token",
dest="api_token",
help=argparse.SUPPRESS
)
# Repository info
repo_group = parser.add_argument_group('Repository')
repo_group.add_argument(
"--repo",
metavar="<owner/repo>",
help="Repository name in owner/repo format",
required=False
)
repo_group.add_argument(
"--workspace",
metavar="<string>",
help="The workspace in the Socket Organization that the repository is in to associate with the full scan.",
required=False
)
repo_group.add_argument(
"--repo-is-public",
dest="repo_is_public",
action="store_true",
help="If set it will flag a new repository creation as public. Defaults to false."
)
repo_group.add_argument(
"--branch",
metavar="<name>",
help="Branch name",
default=""
)
integration_group = parser.add_argument_group('Integration')
integration_group.add_argument(
"--integration",
choices=INTEGRATION_TYPES,
metavar="<type>",
help=(
"Integration type of api, github, gitlab, azure, or bitbucket. "
"Defaults to api; --scm github/gitlab implies the matching integration "
"when this option is omitted"
),
default=argparse.SUPPRESS
)
integration_group.add_argument(
"--owner",
metavar="<name>",
help="Name of the integration owner, defaults to the socket organization slug",
required=False
)
# Pull Request and Commit info
pr_group = parser.add_argument_group('Pull Request and Commit')
pr_group.add_argument(
"--pr-number",
dest="pr_number",
metavar="<number>",
help=(
"Pull request number. Auto-detected in supported CI environments when omitted; "
"pass 0 explicitly to disable detection"
),
default=argparse.SUPPRESS
)
pr_group.add_argument(
"--pr_number",
dest="pr_number",
help=argparse.SUPPRESS,
default=argparse.SUPPRESS
)
pr_group.add_argument(
"--commit-message",
dest="commit_message",
metavar="<message>",
help="Commit message"
)
pr_group.add_argument(
"--commit_message",
dest="commit_message",
help=argparse.SUPPRESS
)
pr_group.add_argument(
"--commit-sha",
dest="commit_sha",
metavar="<sha>",
default="",
help="Commit SHA"
)
pr_group.add_argument(
"--commit_sha",
dest="commit_sha",
help=argparse.SUPPRESS
)
pr_group.add_argument(
"--committers",
metavar="<name>",
help="Committer for the commit (comma separated)",
nargs="*"
)
base_scan_group = pr_group.add_mutually_exclusive_group()
base_scan_group.add_argument(
"--base-scan-id",
dest="base_scan_id",
metavar="<id>",
default=None,
help="Full scan ID to diff the new scan against, overriding the repository's "
"head scan as the baseline. Mutually exclusive with --base-commit-sha."
)
base_scan_group.add_argument(
"--base-commit-sha",
dest="base_commit_sha",
metavar="<sha>",
default=None,
help="Commit SHA to diff the new scan against, overriding the repository's head "
"scan as the baseline. The CLI uses the most recent matching full scan, or "
"the nearest scanned first-parent ancestor within 100 local commits when "
"the commit itself was not scanned. Also sets the range changed-file "
"detection reads, so a manifest changed anywhere between this commit and "
"HEAD is seen. Mutually exclusive with --base-scan-id."
)
# Path and File options
path_group = parser.add_argument_group('Path and File')
path_group.add_argument(
"--target-path",
dest="target_path",
metavar="<path>",
default="./",
help="Target path for analysis"
)
path_group.add_argument(
"--target_path",
dest="target_path",
help=argparse.SUPPRESS
)
path_group.add_argument(
"--sbom-file",
dest="sbom_file",
metavar="<path>",
help="SBOM file path"
)
path_group.add_argument(
"--sbom_file",
dest="sbom_file",
help=argparse.SUPPRESS
)
path_group.add_argument(
"--license-file-name",
dest="license_file_name",
default="license_output.json",
metavar="<string>",
help="SBOM file path"
)
path_group.add_argument(
"--save-submitted-files-list",
dest="save_submitted_files_list",
metavar="<path>",
help="Save list of submitted file names to JSON file for debugging purposes"
)
path_group.add_argument(
"--save-manifest-tar",
dest="save_manifest_tar",
metavar="<path>",
help="Save all manifest files to a compressed tar.gz archive with original directory structure"
)
path_group.add_argument(
"--files",
metavar="<json>",
default="[]",
help="Files to analyze (JSON array string)"
)
path_group.add_argument(
"--sub-path",
dest="sub_paths",
metavar="<path>",
action="append",
help="Sub-path within target-path for manifest file scanning (can be specified multiple times). All sub-paths will be combined into a single workspace scan while preserving git context from target-path"
)
path_group.add_argument(
"--workspace-name",
dest="workspace_name",
metavar="<name>",
help="Workspace name suffix to append to repository name (repo-name-workspace_name)"
)
path_group.add_argument(
"--excluded-ecosystems",
default="[]",
dest="excluded_ecosystems",
help="List of ecosystems to exclude from analysis (JSON array string)"
)
path_group.add_argument(
"--exclude-paths",
dest="exclude_paths",
metavar="<list>",
help="Comma-separated paths/globs to exclude from BOTH manifest discovery and "
"reachability analysis (e.g. 'tests/**,packages/legacy,*.spec.ts'). "
"Supersedes --reach-exclude-paths."
)
path_group.add_argument(
"--include-dirs",
dest="include_dirs",
metavar="<list>",
help="Comma-separated directory names that are excluded from manifest discovery by "
"default but should be scanned (e.g. 'build,dist'). Names are matched against any "
"path segment, mirroring the default exclude list. Defaults excluded: "
"node_modules, bower_components, jspm_packages, __pycache__, .venv, venv, build, "
"dist, .tox, .mypy_cache, .pytest_cache, *.egg-info, vendor."
)
# Branch and Scan Configuration
config_group = parser.add_argument_group('Branch and Scan Configuration')
config_group.add_argument(
"--default-branch",
dest="default_branch",
action="store_true",
help="Make this branch the default branch"
)
config_group.add_argument(
"--default_branch",
dest="default_branch",
action="store_true",
help=argparse.SUPPRESS
)
config_group.add_argument(
"--pending-head",
dest="pending_head",
action="store_true",
help="If true, the new scan will be set as the branch's head scan"
)
config_group.add_argument(
"--ignore-authorization",
dest="ignore_authorization",
choices=["enforce", "strict", "off"],
default="enforce",
help=(
"Who may suppress alerts with @SocketSecurity ignore comments. "
"'enforce' (default) requires write access, and honors the command with "
"a warning when the provider cannot report the commenter's access. "
"'strict' rejects the command in that case instead. "
"'off' honors a command from any commenter."
)
)
config_group.add_argument(
"--pending_head",
dest="pending_head",
action="store_true",
help=argparse.SUPPRESS
)
# Output Configuration
output_group = parser.add_argument_group('Output Configuration')
output_group.add_argument(
"--generate-license",
dest="generate_license",
action="store_true",
help="Generate license information"
)
output_group.add_argument(
"--generate_license",
dest="generate_license",
action="store_true",
help=argparse.SUPPRESS
)
output_group.add_argument(
"--enable-debug",
dest="enable_debug",
action="store_true",
help="Enable debug logging"
)
output_group.add_argument(
"--enable_debug",
dest="enable_debug",
action="store_true",
help=argparse.SUPPRESS
)
output_group.add_argument(
"--enable-json",
dest="enable_json",
action="store_true",
help="Output in JSON format"
)
output_group.add_argument(
"--json-file",
dest="json_file",
metavar="<path>",
help="Output file path for JSON report"
)
output_group.add_argument(
"--enable-sarif",
dest="enable_sarif",
action="store_true",
help="Enable SARIF output of results instead of table or JSON format"
)
output_group.add_argument(
"--sarif-file",
dest="sarif_file",
metavar="<path>",
default=None,
help="Output file path for SARIF report (implies --enable-sarif)"
)
output_group.add_argument(
"--sarif-scope",
dest="sarif_scope",
choices=["diff", "full"],
default="diff",
help="Scope SARIF output to diff alerts (default) or full reachability facts data (requires --reach)"
)
output_group.add_argument(
"--sarif-grouping",
dest="sarif_grouping",
choices=["instance", "alert"],
default="instance",
help="SARIF result grouping mode: instance (default) or alert (full scope only)"
)
output_group.add_argument(
"--sarif-reachability",
dest="sarif_reachability",
choices=["all", "reachable", "potentially", "reachable-or-potentially"],
default="all",
help="Reachability filter for SARIF output (requires --reach when not 'all')"
)
output_group.add_argument(
"--enable-gitlab-security",
dest="enable_gitlab_security",
action="store_true",
help="Enable GitLab Security Dashboard output format (Dependency Scanning report)"
)
output_group.add_argument(
"--gitlab-security-file",
dest="gitlab_security_file",
metavar="<path>",
default="gl-dependency-scanning-report.json",
help="Output file path for GitLab Security report (default: gl-dependency-scanning-report.json)"
)
output_group.add_argument(
"--summary-file",
dest="summary_file",
metavar="<path>",
help="Output file path for a plain-text summary report"
)
output_group.add_argument(
"--report-link-file",
dest="report_link_file",
metavar="<path>",
help="Output file path for the Socket report link"
)
output_group.add_argument(
"--disable-overview",
dest="disable_overview",
action="store_true",
help="Disable overview output"
)
output_group.add_argument(
"--disable_overview",
dest="disable_overview",
action="store_true",
help=argparse.SUPPRESS
)
output_group.add_argument(
"--exclude-license-details",
dest="exclude_license_details",
action="store_true",
help=(
"Exclude license details from the dashboard report URL. "
"As of 2.4.0 the internal diff request always omits license details "
"(they were unused there and bloated large-repo responses), so this "
"flag now only affects the report link, not diff performance."
)
)
output_group.add_argument(
"--max-purl-batch-size",
dest="max_purl_batch_size",
type=int,
default=5000,
help="Maximum batch size for PURL endpoint calls when generating license info (default: 5000, min: 1, max: 9999)"
)
output_group.add_argument(
"--disable-security-issue",
dest="disable_security_issue",
action="store_true",
help="Disable security issue checks"
)
output_group.add_argument(
"--disable_security_issue",
dest="disable_security_issue",
action="store_true",
help=argparse.SUPPRESS
)
output_group.add_argument(
"--enable-commit-status",
dest="enable_commit_status",
action="store_true",
help="Report scan result as a commit status on GitLab (requires GitLab SCM)"
)
output_group.add_argument(
"--enable_commit_status",
dest="enable_commit_status",
action="store_true",
help=argparse.SUPPRESS
)
# Plugin Configuration
plugin_group = parser.add_argument_group('Plugin Configuration')
plugin_group.add_argument(
"--slack-webhook",
dest="slack_webhook",
metavar="<url>",
help="Slack webhook URL for notifications (automatically enables Slack plugin)"
)
# Advanced Configuration
advanced_group = parser.add_argument_group('Advanced Configuration')
advanced_group.add_argument(
"--ignore-commit-files",
dest="ignore_commit_files",
action="store_true",
help="Compare against the baseline regardless of which files changed, scanning every manifest in the target path"
)
advanced_group.add_argument(
"--ignore_commit_files",
dest="ignore_commit_files",
action="store_true",
help=argparse.SUPPRESS
)
advanced_group.add_argument(
"--disable-blocking",
dest="disable_blocking",
action="store_true",
help=(
"Non-blocking CI mode: always exit 0, even when blocking alerts are present "
"(including with --strict-blocking), on uncaught errors, or on Socket API failures. "
"Findings and errors are still logged. Overrides --strict-blocking."
),
)
advanced_group.add_argument(
"--disable_blocking",
dest="disable_blocking",
action="store_true",
help=argparse.SUPPRESS
)
advanced_group.add_argument(
"--disable-ignore",
dest="disable_ignore",
action="store_true",
help="Disable support for @SocketSecurity ignore commands in PR comments. "
"Alerts cannot be suppressed via comments when this flag is set."
)
advanced_group.add_argument(
"--disable_ignore",
dest="disable_ignore",
action="store_true",
help=argparse.SUPPRESS
)
log_upload_group = advanced_group.add_mutually_exclusive_group()
log_upload_group.add_argument(
"--upload-logs",
dest="upload_logs",
action="store_const",
const=True,
help="Upload the CLI's log output to the Socket backend for this run. "
"When set, the CLI registers the run with share_logs=true and streams "
"its log records in 5s batches. Default off. Mutually exclusive with "
"--no-upload-logs."
)
log_upload_group.add_argument(
"--no-upload-logs",
dest="upload_logs",
action="store_const",
const=False,
help="Explicitly opt out of uploading CLI logs to the Socket backend, even "
"when an org-level override would otherwise enable it. Mutually "
"exclusive with --upload-logs."
)
advanced_group.add_argument(
"--strict-blocking",
dest="strict_blocking",
action="store_true",
help="Fail on ANY security policy violations (blocking severity), not just new ones. Only works in diff mode."
)
advanced_group.add_argument(