forked from vertexproject/synapse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CHANGELOG.rst
7825 lines (6549 loc) · 323 KB
/
CHANGELOG.rst
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
.. vim: set textwidth=79
*****************
Synapse Changelog
*****************
v2.142.0 - 2023-07-19
=====================
Automatic Migrations
--------------------
- Renormalize the ``risk:vuln:cvss:v2`` and ``risk:vuln:cvss:v3`` properties.
(`#3224 <https://github.com/vertexproject/synapse/pull/3224>`_)
- Migrate the ``risk:vuln:name`` type from a ``str`` to a ``risk:vulnname``
form.
(`#3227 <https://github.com/vertexproject/synapse/pull/3227>`_)
- See :ref:`datamigration` for more information about automatic migrations.
Model Changes
-------------
- Update to the ``it``, ``org``, and ``risk`` models.
(`#3224 <https://github.com/vertexproject/synapse/pull/3224>`_)
(`#3227 <https://github.com/vertexproject/synapse/pull/3227>`_)
(`#3237 <https://github.com/vertexproject/synapse/pull/3237>`_)
New Forms
---------
``risk:vulnname``
Add a form to capture vulnerability name such as log4j or rowhammer.
Updated Types
-------------
``hex``
The ``hex`` base type now accepts a ``zeropad`` option that can be used
to zero-extend a hex string during normalization.
``cvss:v2``
The type now accepts and normalizes unordered CVSS vectors.
``cvss:v3``
The type now accepts and normalizes unordered CVSS vectors.
New Properties
--------------
``it:sec:c2:config``
The form had the following properties added to it:
``decoys``
An array of URLs used as decoy connections to obfuscate the C2 servers.
``ou:technique``
The form had the following properties added to it:
``reporter``
The organization reporting on the technique.
``reporter:name``
The name of the organization reporting on the technique.
``risk:vuln``
The form had the following properties added to it:
``names``
An array of alternate names for the vulnerability.
Features and Enhancements
-------------------------
- Always convert dictionary keys to their primitive values when working with
dictionary objects in Storm. Dictionary objects can no longer have keys
set which are mutable objects, such as Nodes.
(`#3233 <https://github.com/vertexproject/synapse/pull/3233>`_)
- Add support for octal constants, such as ``0o755``, in Storm expressions.
(`#3231 <https://github.com/vertexproject/synapse/pull/3231>`_)
- Add additional events to the Behold API message stream for the addition
and removal of extended model elements.
(`#3228 <https://github.com/vertexproject/synapse/pull/3228>`_)
- Update the ``$lib.dmon.add()`` variable capture to record variables
from embedded query objects.
(`#3230 <https://github.com/vertexproject/synapse/pull/3230>`_)
- Add a ``.title()`` method on Storm strings to get title case formatted
strings.
(`#3242 <https://github.com/vertexproject/synapse/pull/3242>`_)
- Add a general purpose process pool using forked workers in order to speed
up certain processing operations. This includes the Storm operations for
JSONSchema parsing, HTML parsing, STIX validation, and XML parsing.
(`#3033 <https://github.com/vertexproject/synapse/pull/3033>`_)
(`#3229 <https://github.com/vertexproject/synapse/pull/3229>`_)
- Add a new Cell configuration option, ``max:users``. This can be set to limit
the maximum number of non-``root`` users on Cell.
(`#3244 <https://github.com/vertexproject/synapse/pull/3244>`_)
- Add an ``/api/v1/aha/services`` HTTP API to the Aha service. This
can be used to get a list of the services registered with Aha.
(`#3238 <https://github.com/vertexproject/synapse/pull/3238>`_)
- Add support for Cosign signatures of tagged Synapse containers. See
additional information at :ref:`dev_docker_verification`.
(`#3196 <https://github.com/vertexproject/synapse/pull/3196>`_)
- Adjust internal names for Storm objects.
(`#3229 <https://github.com/vertexproject/synapse/pull/3229>`_)
Bugfixes
--------
- Fix a bug in the scrape for ``inet:ipv4`` where IP addresses were found
when there was leading or trailing numbers around the IP addresses.
(`#3234 <https://github.com/vertexproject/synapse/pull/3234>`_)
- Fix a bug where ``$lib.model.ext.delForm()`` did not check for extended
property definitions before deletion. Extended properties on a custom form
must be deleted prior to deleting the form.
(`#3223 <https://github.com/vertexproject/synapse/pull/3223>`_)
- Always remove the ``mirror`` configuration option from ``cell.yaml`` file
when provisioning a service via Aha. The previous behavior prevented the
correct restoration of a service from a backup which was previously
provisioned as a mirror and is being restored as a leader.
(`#3240 <https://github.com/vertexproject/synapse/pull/3240>`_)
- Add additional type checking when adding extended model forms and properties
to the Cortex. Previously invalid types could raise an ``AttributeError``.
(`#3243 <https://github.com/vertexproject/synapse/pull/3243>`_)
Improved Documentation
----------------------
- Update the Storm lift reference to add an example of lifting nodes by the
universal ``.created`` property.
(`#3245 <https://github.com/vertexproject/synapse/pull/3245>`_)
v2.141.0 - 2023-07-07
=====================
Model Changes
-------------
- Update to the ``it`` and ``lang`` models.
(`#3219 <https://github.com/vertexproject/synapse/pull/3219>`_)
New Properties
--------------
``it:host``
The form had the following properties added to it:
``keyboard:language``
The primary keyboard input language configured on the host.
``keyboard:layout``
The primary keyboard layout configured on the host.
``lang:language``
The form had the following property added to it:
``code``
The language code for this language.
Features and Enhancements
-------------------------
- Update ``$lib.infosec.cvss.vectToScore()`` to include a normalized
CVSS vector in the output.
(`#3211 <https://github.com/vertexproject/synapse/pull/3211>`_)
- Optimize the addition and removal of lightweight edges when operating
on N1 edges in Storm.
(`#3214 <https://github.com/vertexproject/synapse/pull/3214>`_)
- Added ``$lib.gen.langByCode``.
(`#3219 <https://github.com/vertexproject/synapse/pull/3219>`_)
Bugfixes
--------
- Fix bug with regular expression comparisons for some types.
(`#3213 <https://github.com/vertexproject/synapse/pull/3213>`_)
- Fix a ``TypeError`` being raised when passing a heavy Number object to
``$lib.math.number()``.
(`#3215 <https://github.com/vertexproject/synapse/pull/3215>`_)
- Fix an issue with the Cell backup space checks. They now properly calculate
the amount of free space when the Cell backup directory is configured
on a separate volume from the Cell storage directory.
(`#3216 <https://github.com/vertexproject/synapse/pull/3216>`_)
- Prevent the ``yield`` operator from directly emitting nodes into the Storm
pipeline if those node objects came from a different view. Nodes previously
lifted in this manner must be lifted by calling the ``iden()`` function on
the object to ensure the node being lifted into the pipeline reflects the
current view.
(`#3218 <https://github.com/vertexproject/synapse/pull/3218>`_)
- Always remove the ``mirror`` configuration option from ``cell.mods.yaml``
when provisioning a service via Aha. The previous behavior prevented the
correct restoration of a service from a backup which had been changed from
being a leader to being a mirror.
(`#3220 <https://github.com/vertexproject/synapse/pull/3220>`_)
v2.140.1 - 2023-06-30
=====================
Bugfixes
--------
- Fix a typo which prevented the Synapse package for ``v2.140.0`` from being
published on PyPI.
(`#3212 <https://github.com/vertexproject/synapse/pull/3212>`_)
v2.140.0 - 2023-06-30
=====================
Announcement
------------
Synapse now only supports Python 3.11+.
Model Changes
-------------
- Update to the ``inet``, ``file``, and ``org`` models.
(`#3192 <https://github.com/vertexproject/synapse/pull/3192>`_)
(`#3202 <https://github.com/vertexproject/synapse/pull/3202>`_)
(`#3207 <https://github.com/vertexproject/synapse/pull/3207>`_)
New Types
---------
``file:archive:entry``
Add a type to capture an archive entry representing a file and metadata
from within a parent archive file.
Updated Types
-------------
``time``
Time values with precision beyond milliseconds are now truncated to
millsecond values.
``hex``
Hex types now have whitespace and colon ( ``:`` ) characters stripped
from them when lifting and normalizing them.
``inet:ipv6``
Add comparators for ``>=``, ``>``, ``<=``, ``<`` operations when lifting
and filtering IPV6 values.
``ou:naics``
Update the type to allow recording NIACS sector and subsector prefixes.
Features and Enhancements
-------------------------
- Synapse now only supports Python 3.11+. The library will now fail to import
on earlier Python interpeters, and the published modules on PyPI will no
longer install on Python versions < 3.11.
(`#3156 <https://github.com/vertexproject/synapse/pull/3156>`_)
- Replace ``setup.py`` with a ``pyproject.toml`` file.
(`#3156 <https://github.com/vertexproject/synapse/pull/3156>`_)
(`#3195 <https://github.com/vertexproject/synapse/pull/3195>`_)
- Usages of ``hashlib.md5()`` and ``hashlib.sha1()`` have been updated to add
the ``usedforsecurity=False`` argument.
(`#3163 <https://github.com/vertexproject/synapse/pull/3163>`_)
- The Storm ``diff`` command is now marked as safe for ``readonly`` execution.
(`#3207 <https://github.com/vertexproject/synapse/pull/3207>`_)
- Add a ``svc:set`` event to the Behold API message stream. This event is
fired when a Cortex connects to a Storm Service.
(`#3205 <https://github.com/vertexproject/synapse/pull/3205>`_)
Bugfixes
--------
- Catch ``ZeroDivisionError`` and ``decimal.InvalidOperation`` errors in Storm
expressions and raise a ``StormRuntimeError``.
(`#3203 <https://github.com/vertexproject/synapse/pull/3203>`_)
- Fix a bug where ``synapse.lib.platforms.linux.getTotalMemory()`` did not
return the correct value in a process running in cgroupsv1 without a
maximum memory limit set.
(`#3198 <https://github.com/vertexproject/synapse/pull/3198>`_)
- Fix a bug where a Cron job could be created with an invalid Storm query.
Cron jobs now have their queries parsed as part of creation to ensure that
they are valid Storm. ``$lib.cron`` APIs now accept heavy Storm query
objects as query inputs.
(`#3201 <https://github.com/vertexproject/synapse/pull/3201>`_)
(`#3207 <https://github.com/vertexproject/synapse/pull/3207>`_)
- Field data sent via Storm ``$lib.inet.http`` APIs that uses a multipart
upload without a valid ``name`` field now raises a ``BadArg`` error.
Previously this would result in a Python ``TypeError``.
(`#3199 <https://github.com/vertexproject/synapse/pull/3199>`_)
(`#3206 <https://github.com/vertexproject/synapse/pull/3206>`_)
Deprecations
------------
- Remove the deprecated ``synapse.common.lockfile()`` function.
(`#3191 <https://github.com/vertexproject/synapse/issue/3191>`_)
v2.139.0 - 2023-06-16
=====================
Announcement
------------
Due to the introduction of several powerful new APIs and performance
improvements, Synapse will be updating to *only* support Python >=3.11.
Our current plan is to drop support for Python <=3.10 in ~4 weeks on
2023-06-19. The next release after 2023-06-19 will include changes that
are not backward compatible to earlier versions of Python.
If you currently deploy Synapse Open-Source or Synapse Enterprise via
the standard docker containers, you will be unaffected. If you install
Synapse via PyPI, you will need to ensure that your environment is
updated to Python 3.11+.
Model Changes
-------------
- Update ``it:sec:cpe`` normalization to extend truncated CPE2.3 strings.
(`#3186 <https://github.com/vertexproject/synapse/pull/3186>`_)
Features and Enhancements
-------------------------
- The ``str`` type now accepts ``float`` values to normalize.
(`#3174 <https://github.com/vertexproject/synapse/pull/3174>`_)
Bugfixes
--------
- Fix an issue where the ``file:bytes:sha256`` property set handler could fail
during data merging.
(`#3180 <https://github.com/vertexproject/synapse/pull/3180>`_)
- Fix an issue where iterating light edges on nodes could result in degraded
Cortex performance.
(`#3186 <https://github.com/vertexproject/synapse/pull/3186>`_)
Improved Documentation
----------------------
- Update the Cortex admin guide to include additional examples for setting up
user and role permissions.
(`#3187 <https://github.com/vertexproject/synapse/pull/3187>`_)
v2.138.0 - 2023-06-13
=====================
Features and Enhancements
-------------------------
- Add ``it:sec:cwe`` to the list of types identified with scrape APIs.
(`#3182 <https://github.com/vertexproject/synapse/pull/3182>`_)
- Update the calculations done by ``$lib.infosec.cvss.vectToScore()`` to more
closely emulate the NVD CVSS calculator.
(`#3181 <https://github.com/vertexproject/synapse/pull/3181>`_)
Bugfixes
--------
- Fix an issue with ``synapse.tools.storm`` where the ``!export`` command did
not use the view specified when starting the tool.
(`#3184 <https://github.com/vertexproject/synapse/pull/3184>`_)
- The ``synapse.common.getSslCtx()`` API now only attempts to load files in
the target directory. This avoids confusing errors that may be logged when
the target directory contains sub directories.
(`#3179 <https://github.com/vertexproject/synapse/pull/3179>`_)
- Fix an edge case in ``$lib.infosec.cvss.vectToScore()`` when calculating
CVSS v2 scores.
(`#3181 <https://github.com/vertexproject/synapse/pull/3181>`_)
Deprecations
------------
- Mark the Python function ``synapse.common.lockfile()`` as deprecated. It
will be removed in ``v2.140.0``.
(`#3183 <https://github.com/vertexproject/synapse/issue/3183>`_)
v2.137.0 - 2023-06-09
=====================
Automatic Migrations
--------------------
- Migrate any ``inet:url`` nodes with ``:user`` and ``:passwd`` properties
which may have been URL encoded. These values are now decoded.
(`#3169 <https://github.com/vertexproject/synapse/pull/3169>`_)
- Migrate the storage type for the ``file:bytes:mime:pe:imphash`` property.
(`#3173 <https://github.com/vertexproject/synapse/pull/3173>`_)
- See :ref:`datamigration` for more information about automatic migrations.
Model Changes
-------------
- Updates to the ``geospace``, ``inet``, ``infotech``, ``org``, ``risk``,
and ``transport`` models.
(`#3169 <https://github.com/vertexproject/synapse/pull/3169>`_)
New Types
---------
``it:mitre:attack:matrix``
Add a type to capture the enumeration of MITRE ATT&CK matrix values.
New Forms
---------
``inet:egress``
Add a form to capture a host using a specific network egress client
address.
``it:prod:softreg``
Add a form to capture a registry entry is created by a specific software
version.
``transport:land:vehicle``
Add a form to capture an individual vehicle.
``transport:land:registration``
Add a form to capture the registration issued to a contact for a land
vehicle.
``transport:land:license``
Add a form to capture the license to operate a land vehicle issued to a
contact.
New Properties
--------------
``inet:http:request``
The form had the following property added to it:
``referer``
The referer URL parsed from the "Referer:" header in the request.
``inet:search:query``
The form had the following property added to it:
``request``
The HTTP request used to issue the query.
``it:mitre:attack:tactic``
The form had the following property added to it:
``matrix``
The ATT&CK matrix which defines the tactic.
``it:mitre:attack:technique``
The form had the following property added to it:
``matrix``
The ATT&CK matrix which defines the technique.
``it:mitre:attack:mitigation``
The form had the following property added to it:
``matrix``
The ATT&CK matrix which defines the mitigation.
``it:app:snort:rule``
The form had the following property added to it:
``engine``
The snort engine ID which can parse and evaluate the rule text.
``it:app:yara:rule``
The form had the following properties added to it:
``ext:id``
The YARA rule ID from an external system.
``url``
A URL which documents the YARA rule.
``ou:campaign``
The form had the following property added to it:
``tag``
The tag used to annotate nodes that are associated with the campaign.
``ou:org``
The form had the following properties added to it:
``country``
The organization's country of origin.
``country:code``
The 2 digit ISO 3166 country code for the organization's country of
origin.
``risk:threat``
The form had the following properties added to it:
``country``
The reporting organization's assessed country of origin of the threat
cluster.
``country:code``
The 2 digit ISO 3166 country code for the threat cluster's assessed
country of origin.
``risk:compromise``
The form had the following property added to it:
``vector``
The attack assessed to be the initial compromise vector.
Light Edges
-----------
``detects``
When used with a ``meta:rule`` node, the edge indicates the rule was
designed to detect instances of the target node.
When used with an ``it:app:snort:rule`` node, the edge indicates the rule
was designed to detect instances of the target node.
When used with an ``it:app:yara:rule`` node, the edge indicates the rule
was designed to detect instances of the target node.
``contains``
When used between two ``geo:place`` nodes, the edge indicates the source
place completely contains the target place.
Deprecated Properties
---------------------
``geo:place``
The form had the following property marked as deprecated:
* ``parent``
Features and Enhancements
-------------------------
- Add a modulo arithmetic operator ( ``%`` ) to Storm expression parsing.
(`#3168 <https://github.com/vertexproject/synapse/pull/3168>`_)
- Add ``$lib.auth.easyperm`` Storm library for interacting with objects that
use a simplified permissions model.
(`#3167 <https://github.com/vertexproject/synapse/pull/3167>`_)
- Add ``.vars`` attribute to the Storm ``auth:user`` object. This can
be used to access user variables.
(`#3167 <https://github.com/vertexproject/synapse/pull/3167>`_)
- Add ``$lib.infosec.cvss.vectToScore()`` to calculate CVSS scores.
(`#3171 <https://github.com/vertexproject/synapse/pull/3171>`_)
- The Storm ``delnode`` command node now requires the use of ``--force`` to
delete a node which has lightweight edges pointing to it.
(`#3176 <https://github.com/vertexproject/synapse/pull/3176>`_)
- The STIX export configuration may now include a ``synapse_extension`` value
set to ``$lib.false`` to disable the Synapse STIX extension data from being
added to objects in the bundle.
(`#3177 <https://github.com/vertexproject/synapse/pull/3177>`_)
- Remove whitespace stripping from Storm queries prior to parsing them. This
allows any error highlighting information to accurately reflect the query
submitted to the Cortex.
(`#3175 <https://github.com/vertexproject/synapse/pull/3175>`_)
Bugfixes
--------
- Fix an issue where raising an integer value to a fractional power
in Storm was not handled correctly.
(`#3170 <https://github.com/vertexproject/synapse/pull/3170>`_)
- Handle a SyntaxError that may occur during Storm parsing due to a change
in CPython 3.11.4.
(`#3170 <https://github.com/vertexproject/synapse/pull/3170>`_)
- The ``inet:url`` type now URL decodes the ``user`` and ``passwd``
properties when normalizing them. Thank you ``captainGeech42`` for the
bug report.
(`#2568 <https://github.com/vertexproject/synapse/issue/2568>`_)
(`#3169 <https://github.com/vertexproject/synapse/pull/3169>`_)
- The URL parser in ``synapse.lib.urlhelp`` now URL decodes the ``user``
and ``passwd`` values when parsing URLs.
(`#3178 <https://github.com/vertexproject/synapse/issue/3178>`_)
Deprecations
------------
- Mark the Storm functions ``$lib.infosec.cvss.saveVectToNode()`` and
``$lib.infosec.cvss.vectToProps()`` as deprecated.
(`#3178 <https://github.com/vertexproject/synapse/issue/3178>`_)
v2.136.0 - 2023-06-02
=====================
Model Changes
-------------
- Boolean values in the Synapse model now have lowercase ``true`` and
``false`` repr values.
(`#3159 <https://github.com/vertexproject/synapse/pull/3159>`_)
- The trailing ``.`` on the taxonomy repr has been removed.
(`#3159 <https://github.com/vertexproject/synapse/pull/3159>`_)
Features and Enhancements
-------------------------
- Normalize tag names when performing lift and filter operations.
(`#3094 <https://github.com/vertexproject/synapse/pull/3094>`_)
- Add ``$lib.compression.bzip2``, ``$lib.compression.gzip``, and
``$lib.compression.zlib`` Storm libraries to assist with compressing
and decompressing bytes.
(`#3155 <https://github.com/vertexproject/synapse/pull/3155>`_)
(`#3162 <https://github.com/vertexproject/synapse/pull/3162>`_)
- Add a new Cell configuration option, ``https:parse:proxy:remoteip``. When
this is set to ``true``, the Cell HTTPS server will parse
``X-Forwarded-For`` and ``X-Real-IP`` headers to determine the remote IP
of an request.
(`#3160 <https://github.com/vertexproject/synapse/pull/3160>`_)
- Update the allowed versions of the ``fastjsonschema`` and ``pycryptodome``
libraries. Update the required version of the ``vcrpy`` library to account
for changes in ``urllib3``. Remove the pinned requirement for the
``requests`` library.
(`#3164 <https://github.com/vertexproject/synapse/pull/3164>`_)
Bugfixes
--------
- Prevent zero length tag lift operations.
(`#3094 <https://github.com/vertexproject/synapse/pull/3094>`_)
- Fix an issue where tag properties with the type ``ival``, or ``time``
types with ``ismin`` or ``ismax`` options set, were not properly merged
when being set.
(`#3161 <https://github.com/vertexproject/synapse/pull/3161>`_)
- Fix a missing ``mesg`` value on ``NoSuchForm`` exception raised by
the ``layer`` ``liftByTag()`` API.
(`#3165 <https://github.com/vertexproject/synapse/pull/3165>`_)
v2.135.0 - 2023-05-24
=====================
Features and Enhancements
-------------------------
- Add a ``--index`` option to the Storm ``auth.user.grant`` command.
(`#3150 <https://github.com/vertexproject/synapse/pull/3150>`_)
- Add additional type handling in the Storm view and layer ``set()`` APIs.
(`#3147 <https://github.com/vertexproject/synapse/pull/3147>`_)
- Add a new Storm command, ``auth.perms.list``, to list all of the permissions
registered with the Cortex.
(`#3135 <https://github.com/vertexproject/synapse/pull/3135>`_)
(`#3154 <https://github.com/vertexproject/synapse/pull/3154>`_)
Bugfixes
--------
- Fix an issue where attempting a tag lift with a variable containing
a zero-length string would raise an MDB error.
(`#3094 <https://github.com/vertexproject/synapse/pull/3094>`_)
- Fix an issue in the Axon ``csvrows()`` and ``readlines()`` APIs
where certain exceptions would not be raised.
(`#3141 <https://github.com/vertexproject/synapse/pull/3141>`_)
- Fix an issue with the Storm ``runas`` command which prevented it being used
with a privileged Storm runtime.
(`#3147 <https://github.com/vertexproject/synapse/pull/3147>`_)
- Fix support for Storm list objects in ``$lib.max()`` and ``$lib.min()``.
(`#3153 <https://github.com/vertexproject/synapse/pull/3153>`_)
Improved Documentation
----------------------
- Update the Cortex admin guide to include the output of the
``auth.perms.list`` command.
(`#3135 <https://github.com/vertexproject/synapse/pull/3135>`_)
v2.134.0 - 2023-05-17
=====================
Model Changes
-------------
- Updates to the ``risk`` model.
(`#3137 <https://github.com/vertexproject/synapse/pull/3137>`_)
Light Edges
-----------
``addresses``
When used with a ``risk:mitigation`` and a ``ou:technique`` node, the
edge indicates the mitigation addresses the technique.
Features and Enhancements
-------------------------
- Add a ``--forms`` option to the Storm ``scrape`` command. This can be used
to limit the forms that are made from scraping the input text. The
``scrape`` command now uses the View scrape interface to generate its
matches, which may include scrape functionality added via power-ups.
The ``scrape`` command no longer produces warning messages when matched
text is not valid for making nodes.
(`#3127 <https://github.com/vertexproject/synapse/pull/3127>`_)
- Add a ``revs`` definition to the STIX export configuration, to allow for
adding in reverse relationships.
(`#3137 <https://github.com/vertexproject/synapse/pull/3137>`_)
- Add a ``--delbytes`` option to the Storm ``delnode`` command. This can be
used to delete the bytes from an Axon when deleting a ``file:bytes`` node.
(`#3140 <https://github.com/vertexproject/synapse/pull/3140>`_)
- Add support for printing nice versions of the Storm ``model:form``,
``model:property``, ``model:tagprop``, and ``model:type``
objects.
(`#3134 <https://github.com/vertexproject/synapse/pull/3134>`_)
(`#3139 <https://github.com/vertexproject/synapse/pull/3139>`_)
Bugfixes
--------
- Fix an exception that was raised when setting the parent of a View.
(`#3131 <https://github.com/vertexproject/synapse/pull/3131>`_)
(`#3132 <https://github.com/vertexproject/synapse/pull/3132>`_)
- Fix an issue with the text scrape regular expressions misidentifying the
``ftp://`` scheme.
(`#3127 <https://github.com/vertexproject/synapse/pull/3127>`_)
- Correctly handle ``readonly`` properties in the Storm ``copyto`` command.
(`#3142 <https://github.com/vertexproject/synapse/pull/3142>`_)
- Fix an issue were partial service backups were not able to be removed.
(`#3143 <https://github.com/vertexproject/synapse/pull/3143>`_)
(`#3145 <https://github.com/vertexproject/synapse/pull/3145>`_)
v2.133.1 - 2023-05-09
=====================
Bugfixes
--------
- Fix an issue where the Storm query hashing added in ``v2.133.0`` did not
account for handling erroneous surrogate pairs in query text.
(`#3130 <https://github.com/vertexproject/synapse/pull/3130>`_)
Improved Documentation
----------------------
- Update the Storm API Guide to include the ``hash`` key in the ``init``
message.
(`#3130 <https://github.com/vertexproject/synapse/pull/3130>`_)
v2.133.0 - 2023-05-08
=====================
Model Changes
-------------
- Updates to the ``risk`` model.
(`#3123 <https://github.com/vertexproject/synapse/pull/3123>`_)
New Properties
--------------
``risk:vuln``
The ``risk:vuln`` form had the following properties added to it:
``cvss:v2``
The CVSS v2 vector for the vulnerability.
``cvss:v2_0:score``
The CVSS v2.0 overall score for the vulnerability.
``cvss:v2_0:score:base``
The CVSS v2.0 base score for the vulnerability.
``cvss:v2_0:score:temporal``
The CVSS v2.0 temporal score for the vulnerability.
``cvss:v2_0:score:environmental``
The CVSS v2.0 environmental score for the vulnerability.
``cvss:v3``
The CVSS v3 vector for the vulnerability.
``cvss:v3_0:score``
The CVSS v3.0 overall score for the vulnerability.
``cvss:v3_0:score:base``
The CVSS v3.0 base score for the vulnerability.
``cvss:v3_0:scare:temporal``
The CVSS v3.0 temporal score for the vulnerability.
``cvss:v3_0:score:environmental``
The CVSS v3.0 environmental score for the vulnerability.
``cvss:v3_1:score``
The CVSS v3.1 overall score for the vulnerability.
``cvss:v3_1:score:base``
The CVSS v3.1 base score for the vulnerability.
``cvss:v3_1:scare:temporal``
The CVSS v3.1 temporal score for the vulnerability.
``cvss:v3_1:score:environmental``
The CVSS v3.1 environmental score for the vulnerability.
Deprecated Properties
---------------------
``risk:vuln``
The ``risk:vuln`` form had the following properties marked as deprecated:
* ``cvss:av``
* ``cvss:ac``
* ``cvss:pr``
* ``cvss:ui``
* ``cvss:s``
* ``cvss:c``
* ``cvss:i``
* ``cvss:a``
* ``cvss:e``
* ``cvss:rl``
* ``cvss:rc``
* ``cvss:mav``
* ``cvss:mac``
* ``cvss:mpr``
* ``cvss:mui``
* ``cvss:ms``
* ``cvss:mc``
* ``cvss:mi``
* ``cvss:ma``
* ``cvss:cr``
* ``cvss:ir``
* ``cvss:ar``
* ``cvss:score``
* ``cvss:score:temporal``
* ``cvss:score:environmental``
Features and Enhancements
-------------------------
- Update the base Synapse images to use Debian bookworm and use Python 3.11
as the Python runtime. For users which build custom images from our
published images, see additional information at
:ref:`dev_docker_working_with_images` for changes which may affect you.
(`#3025 <https://github.com/vertexproject/synapse/pull/3025>`_)
- Add a ``highlight`` parameter to BadSyntaxError and some exceptions raised
during the execution of a Storm block. This contains detailed information
about where an error occurred in the Storm code.
(`#3063 <https://github.com/vertexproject/synapse/pull/3063>`_)
- Allow callers to specify an ``iden`` value when creating a Storm Dmon or a
trigger.
(`#3121 <https://github.com/vertexproject/synapse/pull/3121>`_)
- Add support for STIX export configs to specify pivots to include additional
nodes.
(`#3122 <https://github.com/vertexproject/synapse/pull/3122>`_)
- The Storm ``auth.user.addrule`` and ``auth.role.addrule`` now have an
optional ``--index`` argument that allows specifying the rule location
as a 0-based index value.
(`#3124 <https://github.com/vertexproject/synapse/pull/3124>`_)
- The Storm ``auth.user.show`` command now shows the user's ``admin`` status
on authgates.
(`#3124 <https://github.com/vertexproject/synapse/pull/3124>`_)
- Add a ``--only-url`` flag to the ``synapse.tools.aha.provision.service`` and
``synapse.tools.aha.provision.user`` CLI tools. When set, the tool only
prints the URL to stdout.
(`#3125 <https://github.com/vertexproject/synapse/pull/3125>`_)
- Add additional layer validation in the View schema.
(`#3128 <https://github.com/vertexproject/synapse/pull/3128>`_)
- Update the allowed version of the ``cryptography``, ``coverage``,
``idna``, ``pycryptodome``, ``python-bitcoin``, and ``vcrpy`` libraries.
(`#3025 <https://github.com/vertexproject/synapse/pull/3025>`_)
Bugfixes
--------
- Ensure the CLI tools ``synapse.tools.cellauth``, ``synapse.tools.csvtool``,
and ``synapse.tools.easycert`` now return ``1`` on an execution failure. In
some cases they previously returned ``-1``.
(`#3118 <https://github.com/vertexproject/synapse/pull/3118>`_)
v2.132.0 - 2023-05-02
=====================
Features and Enhancements
-------------------------
- Update the minimum required version of the ``fastjsonschema``, ``lark``,
and ``pytz`` libraries. Update the allowed version of the ``packaging`` and
``scalecodec`` libraries.
(`#3118 <https://github.com/vertexproject/synapse/pull/3118>`_)
Bugfixes
--------
- Cap the maximum version of the ``requests`` library until downstream use of
that library has been updated to account for changes in ``urllib3``.
(`#3119 <https://github.com/vertexproject/synapse/pull/3119>`_)
- Properly add parent scope vars to ``background`` command context.
(`#3120 <https://github.com/vertexproject/synapse/pull/3120>`_)
v2.131.0 - 2023-05-02
=====================
Automatic Migrations
--------------------
- Migrate the ``ou:campaign:name`` property from a ``str`` to an
``ou:campname`` type and create the ``ou:campname`` nodes as needed.
(`#3082 <https://github.com/vertexproject/synapse/pull/3082>`_)
- Migrate the ``risk:vuln:type`` property from a ``str`` to a
``risk:vuln:type:taxonomy`` type and create the ``risk:vuln:type:taxonomy``
nodes as needed.
(`#3082 <https://github.com/vertexproject/synapse/pull/3082>`_)
- See :ref:`datamigration` for more information about automatic migrations.
Features and Enhancements
-------------------------
- Updates to the ``dns``, ``inet``, ``it``, ``org``, ``ps``, and ``risk``
models.
(`#3082 <https://github.com/vertexproject/synapse/pull/3082>`_)
(`#3108 <https://github.com/vertexproject/synapse/pull/3108>`_)
(`#3113 <https://github.com/vertexproject/synapse/pull/3113>`_)
``inet:dns:answer``
Add a ``mx:priority`` property to record the priority of the MX response.
``inet:dns:dynreg``
Add a form to record the registration of a domain with a dynamic DNS
provider.
``inet:proto``
Add a form to record a network protocol name.
``inet:web:attachment``
Add a form to record the instance of a file being sent to a web service
by an account.
``inet:web:file``
Deprecate the ``client``, ``client:ipv4``, and ``client:ipv6`` properties
in favor of using ``inet:web:attachment``.
``inet:web:logon``
Remove incorrect ``readonly`` markings for properties.
``it:app:snort:rule``
Add an ``id`` property to record the snort rule id.
Add an ``author`` property to record contact information for the rule
author.
Add ``created`` and ``updated`` properties to track when the rule was
created and last updated.
Add an ``enabled`` property to record if the rule should be used for
snort evaluation engines.
Add a ``family`` property to record the software family the rule is
designed to detect.
``it:prod:softid``
Add a form to record an identifier issued to a given host by a specific
software application.
``ou:campname``
Add a form to record the name of campaigns.
``ou:campaign``
Change the ``name`` and ``names`` secondary properties from ``str`` to
``ou:campname`` types.
``ps:contact``
Add a ``place:name`` to record the name of the place associated with the
contact.
``risk:threat``
Add an ``active`` property to record the interval of time when the threat
cluster is assessed to have been active.
Add a ``reporter:published`` property to record the time that a reporting
organization first publicly disclosed the threat cluster.
``risk:tool:software``
Add a ``used`` property to record the interval when the tool is assessed
to have been deployed.
Add a ``reporter:discovered`` property to record the time that a reporting
organization first discovered the tool.
Add a ``reporter:published`` property to record the time that a reporting
organization first publicly disclosed the tool.
``risk:vuln:soft:range``
Add a form to record a contiguous range of software versions which
contain a vulnerability.
``risk:vuln``
Change the ``type`` property from a ``str`` to a
``risk:vuln:type:taxonomy``.
``risk:vuln:type:taxonomy``
Add a form to record a taxonomy of vulnerability types.
- Add a new Storm command, ``auth.user.allowed`` that can be used to check
if a user is allowed to use a given permission and why.
(`#3114 <https://github.com/vertexproject/synapse/pull/3114>`_)
- Add a new Storm command, ``gen.ou.campaign``, to assist with generating or
creating ``ou:campaign`` nodes.
(`#3082 <https://github.com/vertexproject/synapse/pull/3082>`_)
- Add a boolean ``default`` key to the permissions schema definition. This
allows a Storm package permission to note what its default value is.
(`#3099 <https://github.com/vertexproject/synapse/pull/3099>`_)
- Data model migrations which fail to normalize existing secondary values into
their new types now store those values in Node data on the affected nodes
and remove those bad properties from the affected nodes.
(`#3117 <https://github.com/vertexproject/synapse/pull/3117>`_)
Bugfixes
--------
- Fix an issue with the search functionality in our documentation missing
the required jQuery library.
(`#3111 <https://github.com/vertexproject/synapse/pull/3111>`_)
- Unique nodes when performing multi-layer lifts on secondary properties
without a value.
(`#3110 <https://github.com/vertexproject/synapse/pull/3110>`_)
Improved Documentation
----------------------
- Add a section about managing data model deprecations to the Synapse
Admin guide.
(`#3102 <https://github.com/vertexproject/synapse/pull/3102>`_)
Deprecations
------------
- Remove the deprecated ``synapse.lib.httpapi.HandlerBase.user()`` and
``synapse.lib.httpapi.HandlerBase.getUserBody()`` functions. Remove the
deprecated ``synapse.axon.AxonFileHandler.axon()`` function.
(`#3115 <https://github.com/vertexproject/synapse/pull/3115>`_)
v2.130.2 - 2023-04-26
=====================
Bugfixes
--------
- Fix an issue where the ``proxy`` argument was not being passed to the Axon
when attempting to post a file via Storm with the ``$lib.inet.http.post()``
API.
(`#3109 <https://github.com/vertexproject/synapse/pull/3109>`_)
- Fix an issue where adding a readonly layer that does not already exist
would raise an error.
(`#3106 <https://github.com/vertexproject/synapse/pull/3106>`_)
v2.130.1 - 2023-04-25
=====================
Bugfixes
--------
- Fix a race condition in a Telepath unit test which was happening
during CI testing.
(`#3104 <https://github.com/vertexproject/synapse/pull/3104>`_)
v2.130.0 - 2023-04-25
=====================
Features and Enhancements
-------------------------
- Updates to the ``infotech`` model.
(`#3095 <https://github.com/vertexproject/synapse/pull/3095>`_)
``it:host``
Add an ``ext:id`` property for recording an external identifier for
a host.
- Add support for deleting node properties by assigning ``$lib.undef`` to
the property to be removed through ``$node.props``.
(`#3098 <https://github.com/vertexproject/synapse/pull/3098>`_)
- The ``Cell.ahaclient`` is longer cached in the
``synapse.telepath.aha_clients`` dictionary. This isolates the Cell
connection to Aha from other clients.
(`#3008 <https://github.com/vertexproject/synapse/pull/3008>`_)
- When the Cell mirror loop exits, it now reports the current ``ready`` status