Synapse

=====================

Model Changes
-------------
- Update to the ``it`` model.
(`3361 <https://github.com/vertexproject/synapse/pull/3361>`_)
- See :ref:`userguide_model_v2_151_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add a new Storm library ``$lib.infosec.mitre.attack.flow``. This can be used
to normalize and create ``it:mitre:attack:flow`` nodes from MITRE ATT&CK
Flow Diagrams.
(`3361 <https://github.com/vertexproject/synapse/pull/3361>`_)
(`3372 <https://github.com/vertexproject/synapse/pull/3372>`_)
- Update the Storm ``note.add`` command to set the ``meta:note:created``
property on the note.
(`3569 <https://github.com/vertexproject/synapse/pull/3569>`_)
- Add the Axon HTTP APIs to the Cortex. These API endpoints use the Axon that
the Cortex is configured to use.
(`3550 <https://github.com/vertexproject/synapse/pull/3550>`_)
- Allow user defined functions in Storm to execute in a ``readonly`` Storm
runtime.
(`3552 <https://github.com/vertexproject/synapse/pull/3552>`_)
- Clarify the Nexus ``IsReadOnly`` exception to include the common cause for
the error, which is normally insufficent space on disk.
(`3359 <https://github.com/vertexproject/synapse/pull/3359>`_)
- Add a ``SYN_LOG_DATEFORMAT`` environment variable to allow specifying custom
timestamp formats for Synapse services.
(`3362 <https://github.com/vertexproject/synapse/pull/3362>`_)
- Add a ``status`` attribute to structured log events for user and role
related log events. This attribute indicates if the event was a ``CREATE``,
``DELETE``, or ``MODIFY`` operation.
(`3363 <https://github.com/vertexproject/synapse/pull/3363>`_)
- Update ``Cell.getLogExtra()`` to prefer using the ``user`` key from the task
scope before using the ``sess`` key from the task scope. Cortex APIs which
execute Storm queries now set the ``user`` scope to the user the query is
running as. This increases the accuracy of log events caused by Storm
queries when the ``user`` is specified in the ``opts``.
(`3356 <https://github.com/vertexproject/synapse/pull/3356>`_)
- Update Storm setitem AST operator to check the readonly flag on functions
when operating in a ``readonly`` Storm runtime.
(`3364 <https://github.com/vertexproject/synapse/pull/3364>`_)
- Update the minimum required version of the ``fastjsonschema`` library.
(`3358 <https://github.com/vertexproject/synapse/pull/3358>`_)
- Update tests and remove the use of deprecated functions for improved
Python 3.12 compatibility.
(`3355 <https://github.com/vertexproject/synapse/pull/3355>`_)
(`3567 <https://github.com/vertexproject/synapse/pull/3567>`_)

Bugfixes
--------
- Fixed a bug when parenting a View to another View where the bottom view has
more than one layer in it omitted non-write layers. The set of layers is now
properly computed.
(`3354 <https://github.com/vertexproject/synapse/pull/3354>`_)

Improved Documentation
----------------------
- Update the list of Cortex permissions in the Admin Guide.
(`3331 <https://github.com/vertexproject/synapse/pull/3331>`_)
- The Form documentation has been updated to project the secondary properties
and associated light edges as tables.
(`3348 <https://github.com/vertexproject/synapse/pull/3348>`_)

=====================

Model Changes
-------------
- Updates to the ``inet`` model.
(`3347 <https://github.com/vertexproject/synapse/pull/3347>`_)
- See :ref:`userguide_model_v2_150_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Allow Storm trigger APIs to reference triggers from other views.
(`3342 <https://github.com/vertexproject/synapse/pull/3342>`_)
- Update the ``synapse.lib.scrape`` and associated APIs to capture
additional data:
(`3223 <https://github.com/vertexproject/synapse/pull/3223>`_)
(`3347 <https://github.com/vertexproject/synapse/pull/3347>`_)

``it:sec:cpe``
CPE 2.3 strings are now identified.

``inet:url``
UNC based paths are now identified.

- Update the ``synapse.lib.scrape`` and associated APIs to use subprocesses
when scraping large volumes of text.
(`3344 <https://github.com/vertexproject/synapse/pull/3344>`_)
- Add additional logging for HTTP API endpoints when a request has invalid
login information.
(`3345 <https://github.com/vertexproject/synapse/pull/3345>`_)
- The CryoTank service has had permissions added to it.
(`3328 <https://github.com/vertexproject/synapse/pull/3328>`_)

Bugfixes
--------
- Stormtypes ``stor`` functions were not previously checked during
``readonly`` runtime execution. These are now validated and ``stor``
functions which would result in changing data in the Cortex will now
raise an exception when used with a ``readonly`` Storm runtime.
(`3349 <https://github.com/vertexproject/synapse/pull/3349>`_)

Improved Documentation
----------------------
- Update the list of Cortex permissions in the Admin Guide.
(`3331 <https://github.com/vertexproject/synapse/pull/3331>`_)
- The Form documentation has been updated to project the secondary properties
and associated light edges as tables.
(`3348 <https://github.com/vertexproject/synapse/pull/3348>`_)

=====================

Model Changes
-------------
- Updates to the ``it``, ``meta``, and ``ou`` models.
(`3338 <https://github.com/vertexproject/synapse/pull/3338>`_)
- See :ref:`userguide_model_v2_149_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add best-effort support to scrape APIs to identify Windows and Linux file
paths.
(`3343 <https://github.com/vertexproject/synapse/pull/3343>`_)
- Update the Storm ``view.add`` command to add a ``--worldreadable`` flag to
create a view which is readable by the ``all`` role. The ``$lib.view.add()``
Storm API now also accepts an optional ``worldreadable`` argument as well.
(`3333 <https://github.com/vertexproject/synapse/pull/3333>`_)
- Update the Storm ``note.add`` command to add a ``--yield`` flag which yields
the newly created note.
(`3337 <https://github.com/vertexproject/synapse/pull/3337>`_)
- Add Storm commands ``gen.ou.id.number`` and ``gen.ou.id.type`` to help
generate ``ou:id:number`` and ``ou:id:type`` nodes.
(`3339 <https://github.com/vertexproject/synapse/pull/3339>`_)
- Support dynamically setting a Layer to ``readonly`` using the Storm
``$layer.set()`` API.
(`3332 <https://github.com/vertexproject/synapse/pull/3332>`_)
- Update the Storm command ``help`` to display information about Storm types,
Storm Libraries and functions.
(`3335 <https://github.com/vertexproject/synapse/pull/3335>`_)

Bugfixes
--------
- Ensure that the Cell ``tmp`` directory is on the same volume as the Cell
storage directory prior to attempting to run the onboot optimization
process. If the volumes are different this now issues a warning message and
skips the optimization process.
(`3336 <https://github.com/vertexproject/synapse/pull/3336>`_)
- Protect the Cortex Cron scheduling loop from errors that could happen when
starting an agenda item.
(`3340 <https://github.com/vertexproject/synapse/pull/3340>`_)

=====================

Features and Enhancements
-------------------------
- Add a ``$lib.jsonstor.cachedel()`` API to allow for the removal of data
created by ``$lib.jsonstor.cacheget()``.
(`3322 <https://github.com/vertexproject/synapse/pull/3322>`_)

Bugfixes
--------
- Ensure the base Cell ``fini()``'s the Aha client that it creates. This fixes
a unit test performance issue.
(`3324 <https://github.com/vertexproject/synapse/pull/3324>`_)

Deprecations
------------
- Mark the following Cryotank related API arguments and functions as
deprecated. These APIs are related to server-side offset tracking for
callers. Code which relies on these should be updated to do local offset
tracking. These APIs and arguments will be removed in v2.150.0.
(`3326 <https://github.com/vertexproject/synapse/pull/3326>`_)

- ``CryoApi.puts(seqn=...)`` argument.
- ``CryoApi.rows(seqn=...)`` argument.
- ``CryoApi.slice(iden=...)`` argument.
- ``CryoApi.offset()`` function.
- ``CryoTank.getOffset()`` function.
- ``CryoTank.setOffset()`` function.
- ``CryoTank.puts(seqn=...)`` argument.
- ``CryoTank.rows(seqn=...)`` argument.
- ``CryoTank.slice(iden=...)`` argument.
- ``TankAPI.offset()`` function.
- ``TankApi.puts(seqn=...)`` argument.
- ``TankAPI.slice(iden=...)`` argument.

=====================

Features and Enhancements
-------------------------
- Add ``wait`` and ``timeout`` arguments to Cryotank ``slice()`` APIs.
(`3320 <https://github.com/vertexproject/synapse/pull/3320>`_)
- Add a ``charset`` parameter to the Storm ``inet:imap:server.search()`` API.
This can be used to specify the ``CHARSET`` value when crafting a search
query.
(`3318 <https://github.com/vertexproject/synapse/pull/3318>`_)

Bugfixes
--------
- Vendor the ``asyncio.timeouts.Timeout`` class from Python 3.11.3 to ensure
correct task cancellation behavior is available for
``synapse.common.wait_for()``.
(`3321 <https://github.com/vertexproject/synapse/pull/3321>`_)

=====================

Features and Enhancements
-------------------------
- Update Storm ``graph`` projection to only include edges between nodes in the
result set and include a `"reverse": true` in the edge info when embedding
an edge on its target node once it is yielded.
(`3305 <https://github.com/vertexproject/synapse/pull/3305>`_)
- Map the Nexus LMDB slab with ``map_async=True`` by default.
(`3314 <https://github.com/vertexproject/synapse/pull/3314>`_)
- Mark the Storm ``macro.exec`` as a ``readonly`` safe command. Mark the
Storm APIs ``$lib.macro.list()`` and ``$lib.macro.get()`` as ``readonly``
safe. Mark the ``str`` APIs as ``readonly`` safe.
(`3316 <https://github.com/vertexproject/synapse/pull/3316>`_)

Bugfixes
--------
- Fix an issue where Layer data migrations failed when a layer was marked
as ``readonly``.
(`3313 <https://github.com/vertexproject/synapse/pull/3313>`_)
- Fix an issue where utility functions for packed nodes in
``synapse.lib.node`` did not handle nodes from HTTP API endpoints.
(`3315 <https://github.com/vertexproject/synapse/pull/3315>`_)