Synapse

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

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>`_)

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

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>`_)

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

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

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>`_)

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

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>`_)

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

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

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>`_)

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

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>`_)