synapse 2.219.0__py311-none-any.whl → 2.221.0__py311-none-any.whl

synapse/lib/stormlib/model.py

@@ -896,7 +896,7 @@ class LibModelMigrations(s_stormtypes.Lib, MigrationEditorMixin):
         'type': {'type': 'function', '_funcname': '_riskHasVulnToVulnerable',
                  'args': (
                       {'name': 'n', 'type': 'node', 'desc': 'The risk:hasvuln node to migrate.'},
-                      {'name': 'nodata', 'type': 'bool', 'default': False,
+                      {'name': 'nodata', 'type': 'boolean', 'default': False,
                        'desc': 'Do not copy nodedata to the risk:vulnerable node.'},
                  ),
                  'returns': {'type': 'list', 'desc': 'A list of idens for the risk:vulnerable nodes.'}}},
@@ -912,7 +912,7 @@ class LibModelMigrations(s_stormtypes.Lib, MigrationEditorMixin):
         'type': {'type': 'function', '_funcname': '_storm_query',
                  'args': (
                       {'name': 'n', 'type': 'node', 'desc': 'The inet:ssl:cert node to migrate.'},
-                      {'name': 'nodata', 'type': 'bool', 'default': False,
+                      {'name': 'nodata', 'type': 'boolean', 'default': False,
                        'desc': 'Do not copy nodedata to the inet:tls:servercert node.'},
                  ),
                  'returns': {'type': 'node', 'desc': 'The newly created inet:tls:servercert node.'}}},
@@ -1067,7 +1067,7 @@ class LibModelMigrations_0_2_31(s_stormtypes.Lib):
         {'name': 'listNodes', 'desc': 'Yield queued nodes.',
          'type': {'type': 'function', '_funcname': '_methListNodes',
                   'args': (
-                      {'name': 'form', 'type': 'form', 'default': None,
+                      {'name': 'form', 'type': 'str', 'default': None,
                        'desc': 'Only yield entries matching the specified form.'},
                       {'name': 'source', 'type': 'str', 'default': None,
                        'desc': 'Only yield entries that were seen by the specified source.'},
@@ -1076,12 +1076,12 @@ class LibModelMigrations_0_2_31(s_stormtypes.Lib):
                       {'name': 'size', 'type': 'int', 'default': None,
                        'desc': 'Only yield up to this many entries.'},
                   ),
-                  'returns': {'name': 'Yields', 'type': 'list',
+                  'returns': {'name': 'yields', 'type': 'list',
                               'desc': 'A tuple of (offset, form, valu, sources) values for the specified node.', }}},
         {'name': 'printNode', 'desc': 'Print detailed queued node information.',
          'type': {'type': 'function', '_funcname': '_methPrintNode',
                   'args': (
-                      {'name': 'offset', 'type': 'into', 'desc': 'The offset of the queued node to print.'},
+                      {'name': 'offset', 'type': 'int', 'desc': 'The offset of the queued node to print.'},
                   ),
                   'returns': {'type': 'null'}}},
         {'name': 'repairNode', 'desc': 'Repair a queued node.',

synapse/lib/stormlib/notifications.py

@@ -21,7 +21,7 @@ class NotifyLib(s_stormtypes.Lib):
                     {'name': 'size', 'type': 'int', 'desc': 'The max number of notifications to yield.', 'default': None},
                 ),
                 'returns': {
-                    'name': 'Yields', 'type': 'list',
+                    'name': 'yields', 'type': 'list',
                     'desc': 'Yields (useriden, time, mesgtype, msgdata) tuples.'},
             },
         },

synapse/lib/stormlib/oauth.py

@@ -210,7 +210,7 @@ class OAuthV2Lib(s_stormtypes.Lib):
 
                     Add a new provider which uses a custom Storm callback to obtain the client_assertion data. These
                     callbacks are executed as the user who is performing the authorization_code workflow. The Storm
-                    callback must return data in a tuple of ``bool`` and a dictionary containing the assertion in the
+                    callback must return data in a tuple of ``boolean`` and a dictionary containing the assertion in the
                     key ``token``. Error messages should be in the key ``error``::
 
                         $iden = $lib.guid(callstormexample, provider, oauth)
@@ -335,7 +335,7 @@ class OAuthV2Lib(s_stormtypes.Lib):
                 'args': (
                     {'name': 'iden', 'type': 'str', 'desc': 'The provider iden.'},
                 ),
-                'returns': {'type': 'list', 'desc': 'List of (<bool>, <token/mesg>) for status and data.'},
+                'returns': {'type': 'list', 'desc': 'List of (<boolean>, <token/mesg>) for status and data.'},
             },
         },
         {

synapse/lib/stormlib/project.py

@@ -659,12 +659,12 @@ class ProjectSprints(s_stormtypes.Prim):
                   'args': (
                       {'name': 'name', 'type': 'str', 'desc': 'The name (or iden) of the ProjectSprint to get.'},
                   ),
-                  'returns': {'type': 'proj:sprint', 'desc': 'The `proj:sprint` object', }}},
+                  'returns': {'type': 'proj:sprint', 'desc': 'The `proj:sprint` object.', }}},
         {'name': 'add', 'desc': 'Add a sprint.',
          'type': {'type': 'function', '_funcname': '_addProjSprint',
                   'args': (
                       {'name': 'name', 'type': 'str', 'desc': 'The name for the new ProjectSprint.'},
-                      {'name': 'period', 'type': 'ival', 'desc': 'The time interval the ProjectSprint runs for',
+                      {'name': 'period', 'type': 'list', 'desc': 'The time interval the ProjectSprint runs for.',
                        'default': None},
                   ),
                   'returns': {'type': 'proj:sprint', 'desc': 'The newly created `proj:sprint` object', }}},
@@ -673,7 +673,7 @@ class ProjectSprints(s_stormtypes.Prim):
                   'args': (
                       {'name': 'name', 'type': 'str', 'desc': 'The name of the Sprint to delete.'},
                   ),
-                  'returns': {'type': 'boolean', 'desc': 'True if the ProjectSprint can be found and deleted, otherwise False', }}}
+                  'returns': {'type': 'boolean', 'desc': 'True if the ProjectSprint can be found and deleted, otherwise False.', }}}
     )
 
     _storm_typename = 'proj:sprints'

synapse/lib/stormlib/scrape.py

@@ -59,6 +59,7 @@ class LibScrape(s_stormtypes.Lib):
         genMatches is a generic helper function for constructing scrape interfaces using pure Storm.
 
         It accepts the text, a regex pattern, and produce results that can easily be used to create
+        nodes.
 
         Notes:
             The pattern must have a named regular expression match for the key ``valu`` using the
@@ -91,7 +92,7 @@ class LibScrape(s_stormtypes.Lib):
                        'desc': 'Regex flags to use (defaults to IGNORECASE).'},
                   ),
                   'returns': {'name': 'yields', 'type': 'list',
-                              'desc': ''}}}
+                              'desc': 'Yields a list of (value, info) tuples scraped from the text.'}}}
     )
     _storm_lib_path = ('scrape', )
 

synapse/lib/stormlib/smtp.py

@@ -90,13 +90,13 @@ class SmtpMessage(s_stormtypes.StormType):
                         'desc': 'The user name to use authenticating to the SMTP server.'},
                     {'name': 'passwd', 'type': 'str', 'default': None,
                         'desc': 'The password to use authenticating to the SMTP server.'},
-                    {'name': 'usetls', 'type': 'bool', 'default': False,
+                    {'name': 'usetls', 'type': 'boolean', 'default': False,
                         'desc': 'Initiate a TLS connection to the SMTP server.'},
-                    {'name': 'starttls', 'type': 'bool', 'default': False,
+                    {'name': 'starttls', 'type': 'boolean', 'default': False,
                         'desc': 'Use the STARTTLS directive with the SMTP server.'},
                     {'name': 'timeout', 'type': 'int', 'default': 60,
                         'desc': 'The timeout (in seconds) to wait for message delivery.'},
-                    {'type': 'bool', 'name': 'ssl_verify', 'default': True,
+                    {'type': 'boolean', 'name': 'ssl_verify', 'default': True,
                      'desc': 'Perform SSL/TLS verification.'},
                   ),
                   'returns': {'type': 'list', 'desc': 'An ($ok, $valu) tuple.'}}},

synapse/lib/stormlib/stats.py

@@ -190,9 +190,9 @@ class StatTally(s_stormtypes.Prim):
          'type': {'type': 'function', '_funcname': 'sorted',
                   'args': (
                       {'name': 'byname', 'desc': 'Sort by counter name instead of value.',
-                       'type': 'bool', 'default': False},
+                       'type': 'boolean', 'default': False},
                       {'name': 'reverse', 'desc': 'Sort in descending order instead of ascending order.',
-                       'type': 'bool', 'default': False},
+                       'type': 'boolean', 'default': False},
                   ),
                   'returns': {'type': 'list',
                               'desc': 'List of (counter, value) tuples in sorted order.'}}},

synapse/lib/stormlib/stix.py

@@ -645,7 +645,7 @@ class LibStix(s_stormtypes.Lib):
                 'args': (
                     {'type': 'dict', 'name': 'bundle', 'desc': 'The STIX bundle to lift nodes from.'},
                 ),
-                'returns': {'name': 'Yields', 'type': 'node', 'desc': 'Yields nodes'}
+                'returns': {'name': 'yields', 'type': 'node', 'desc': 'Yields nodes.'}
             }
         },
     )
@@ -856,7 +856,7 @@ class LibStixImport(s_stormtypes.Lib):
                     {'type': 'dict', 'name': 'bundle', 'desc': 'The STIX bundle to ingest.'},
                     {'type': 'dict', 'name': 'config', 'default': None, 'desc': 'An optional STIX ingest configuration.'},
                 ),
-                'returns': {'name': 'Yields', 'type': 'node', 'desc': 'Yields nodes'}
+                'returns': {'name': 'yields', 'type': 'node', 'desc': 'Yields nodes.'}
             },
         },
     )

synapse/lib/stormlib/utils.py

@@ -1,3 +1,5 @@
+import synapse.common as s_common
+
 import synapse.lib.stormtypes as s_stormtypes
 
 @s_stormtypes.registry.registerLib
@@ -6,6 +8,17 @@ class LibUtils(s_stormtypes.Lib):
     A Storm library for working with utility functions.
     '''
     _storm_locals = (
+        {'name': 'buid',
+         'desc': '''
+            Calculate a buid from the provided valu.
+         ''',
+         'type': {'type': 'function', '_funcname': '_buid',
+                  'args': (
+                      {'name': 'valu', 'type': 'any',
+                       'desc': 'The value to calculate the buid from.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'The calculated buid.'},
+        }},
         {'name': 'todo',
          'desc': '''
             Create a todo tuple of (name, args, kwargs).
@@ -26,9 +39,15 @@ class LibUtils(s_stormtypes.Lib):
 
     def getObjLocals(self):
         return {
+            'buid': self._buid,
             'todo': self._todo,
         }
 
+    @s_stormtypes.stormfunc(readonly=True)
+    async def _buid(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        return s_common.buid(valu)
+
     @s_stormtypes.stormfunc(readonly=True)
     async def _todo(self, _todoname, *args, **kwargs):
         _todoname = await s_stormtypes.tostr(_todoname)

synapse/lib/stormlib/vault.py

@@ -365,7 +365,7 @@ class LibVault(s_stormtypes.Lib):
         {'name': 'list', 'desc': 'List vaults accessible to the current user.',
          'type': {'type': 'function', '_funcname': '_listVaults',
                   'args': (),
-                  'returns': {'type': 'list', 'desc': 'Yields vaults.'}}},
+                  'returns': {'name': 'yields', 'type': 'list', 'desc': 'Yields vaults.'}}},
         {'name': 'print', 'desc': 'Print the details of the specified vault.',
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (

synapse/lib/stormlib/xml.py

@@ -20,8 +20,8 @@ class XmlElement(s_stormtypes.Prim):
          'type': {'type': 'function', '_funcname': 'find',
                   'args': (
                       {'name': 'name', 'type': 'str', 'desc': 'The name of the XML tag.'},
-                      {'name': 'nested', 'type': 'bool', 'default': True,
-                        'desc': 'Set to ``(false)`` to only find direct children.'},
+                      {'name': 'nested', 'type': 'boolean', 'default': True,
+                       'desc': 'Set to ``(false)`` to only find direct children.'},
                   ),
                   'returns': {'type': 'generator', 'desc': 'A generator which yields xml:elements.'}}},
 

synapse/lib/stormlib/yaml.py

@@ -15,7 +15,7 @@ class LibYaml(s_stormtypes.Lib):
         {'name': 'save', 'desc': 'Encode data as a YAML string.',
          'type': {'type': 'function', '_funcname': 'save',
                   'args': (
-                      {'name': 'valu', 'type': 'object', 'desc': 'The object to encode.'},
+                      {'name': 'valu', 'type': 'prim', 'desc': 'The object to encode.'},
                       {'name': 'sort_keys', 'type': 'boolean', 'desc': 'Sort object keys.', 'default': True},
                   ),
                   'returns': {'type': 'str', 'desc': 'A YAML string.'}}},