synapse 2.220.0__py311-none-any.whl → 2.222.0__py311-none-any.whl

synapse/lib/stormlib/aha.py

@@ -50,7 +50,7 @@ class AhaLib(s_stormtypes.Lib):
                               'desc': 'The AHA service information dictionary, or ``(null))``.', }}},
         {'name': 'list', 'desc': 'Enumerate all of the AHA services.',
          'type': {'type': 'function', '_funcname': '_methAhaList', 'args': (),
-                  'returns': {'name': 'Yields', 'type': 'list',
+                  'returns': {'name': 'yields', 'type': 'list',
                               'desc': 'The AHA service dictionaries.', }}},
         {'name': 'callPeerApi', 'desc': '''Call an API on all peers (leader and mirrors) of an AHA service and yield the responses from each.
 
@@ -91,7 +91,7 @@ class AhaLib(s_stormtypes.Lib):
                         '''},
                   ),
                   'returns': {'name': 'yields', 'type': 'list',
-                             'desc': 'Yields the results of the API calls as tuples of (svcname, (ok, info)).', }}},
+                              'desc': 'Yields the results of the API calls as tuples of (svcname, (ok, info)).', }}},
         {'name': 'callPeerGenr', 'desc': '''Call a generator API on all peers (leader and mirrors) of an AHA service and yield the responses from each.
 
         Examples:
@@ -124,7 +124,7 @@ class AhaLib(s_stormtypes.Lib):
                        '''},
                   ),
                   'returns': {'name': 'yields', 'type': 'list',
-                             'desc': 'Yields the results of the API calls as tuples containing (svcname, (ok, info)).', }}}
+                              'desc': 'Yields the results of the API calls as tuples containing (svcname, (ok, info)).', }}}
 
     )
     _storm_lib_path = ('aha',)

synapse/lib/stormlib/auth.py

@@ -83,7 +83,7 @@ stormcmds = (
             ('--email', {'type': 'str', 'help': 'The email address to set for the user.'}),
             ('--passwd', {'type': 'str', 'help': 'The new password for the user. This is best passed into the runtime as a variable.'}),
             ('--admin', {'type': 'bool', 'help': 'True to make the user and admin, false to remove their remove their admin status.'}),
-            ('--gate', {'type': 'str', 'help': 'The auth gate iden to grant or revoke admin status on. Use in conjunction with `--admin <bool>`.'}),
+            ('--gate', {'type': 'str', 'help': 'The auth gate iden to grant or revoke admin status on. Use in conjunction with `--admin <boolean>`.'}),
             ('--locked', {'type': 'bool', 'help': 'True to lock the user, false to unlock them.'}),
         ),
         'storm': '''
@@ -681,34 +681,34 @@ class UserJson(s_stormtypes.Prim):
         {'name': 'get', 'desc': 'Return a stored JSON object or object property for the user.',
          'type': {'type': 'function', '_funcname': 'get',
                    'args': (
-                        {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path parts.'},
-                        {'name': 'prop', 'type': 'str|list', 'desc': 'A property name or list of name parts.', 'default': None},
+                        {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path parts.'},
+                        {'name': 'prop', 'type': ['str', 'list'], 'desc': 'A property name or list of name parts.', 'default': None},
                     ),
                     'returns': {'type': 'prim', 'desc': 'The previously stored value or ``(null)``.'}}},
 
         {'name': 'set', 'desc': 'Set a JSON object or object property for the user.',
          'type': {'type': 'function', '_funcname': 'set',
                   'args': (
-                       {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path elements.'},
+                       {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path elements.'},
                        {'name': 'valu', 'type': 'prim', 'desc': 'The value to set as the JSON object or object property.'},
-                       {'name': 'prop', 'type': 'str|list', 'desc': 'A property name or list of name parts.', 'default': None},
+                       {'name': 'prop', 'type': ['str', 'list'], 'desc': 'A property name or list of name parts.', 'default': None},
                    ),
                    'returns': {'type': 'boolean', 'desc': 'True if the set operation was successful.'}}},
 
         {'name': 'del', 'desc': 'Delete a stored JSON object or object property for the user.',
          'type': {'type': 'function', '_funcname': '_del',
                   'args': (
-                       {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path parts.'},
-                       {'name': 'prop', 'type': 'str|list', 'desc': 'A property name or list of name parts.', 'default': None},
+                       {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path parts.'},
+                       {'name': 'prop', 'type': ['str', 'list'], 'desc': 'A property name or list of name parts.', 'default': None},
                    ),
                    'returns': {'type': 'boolean', 'desc': 'True if the del operation was successful.'}}},
 
         {'name': 'iter', 'desc': 'Yield (<path>, <valu>) tuples for the users JSON objects.',
          'type': {'type': 'function', '_funcname': 'iter',
                   'args': (
-                       {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path parts.', 'default': None},
+                       {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path parts.', 'default': None},
                    ),
-                   'returns': {'name': 'Yields', 'type': 'list', 'desc': '(<path>, <item>) tuples.'}}},
+                   'returns': {'name': 'yields', 'type': 'list', 'desc': '(<path>, <item>) tuples.'}}},
     )
 
     def __init__(self, runt, valu):
@@ -1046,7 +1046,7 @@ class User(s_stormtypes.Prim):
                   'args': (
                       {'name': 'name', 'type': 'str',
                        'desc': 'The name of the API key.'},
-                      {'name': 'duration', 'type': 'integer', 'default': None,
+                      {'name': 'duration', 'type': 'int', 'default': None,
                        'desc': 'Duration of time for the API key to be valid, in milliseconds.'},
                   ),
                   'returns': {'type': 'list',
@@ -1569,7 +1569,7 @@ class LibAuth(s_stormtypes.Lib):
                   'args': (
                       {'name': 'text', 'type': 'str', 'desc': 'The string to process.', },
                   ),
-                  'returns': {'type': 'list', 'desc': 'A tuple containing a bool and a list of permission parts.', }}},
+                  'returns': {'type': 'list', 'desc': 'A tuple containing a boolean and a list of permission parts.', }}},
         {'name': 'textFromRule', 'desc': 'Return a text string from a rule tuple.',
          'type': {'type': 'function', '_funcname': 'textFromRule',
                   'args': (

synapse/lib/stormlib/cell.py

@@ -160,7 +160,7 @@ class CellLib(s_stormtypes.Lib):
          ''',
          'type': {'type': 'function', '_funcname': '_trimNexsLog',
                   'args': (
-                      {'name': 'consumers', 'type': 'array', 'default': None,
+                      {'name': 'consumers', 'type': 'list', 'default': None,
                        'desc': 'List of Telepath URLs for consumers of the Nexus log.'},
                       {'name': 'timeout', 'type': 'int', 'default': 30,
                        'desc': 'Time (in seconds) to wait for consumers to catch-up before culling.'}

synapse/lib/stormlib/cortex.py

@@ -1029,7 +1029,7 @@ class HttpReq(s_stormtypes.StormType):
             if not isinstance(body, bytes):
                 body = await s_stormtypes.toprim(body)
                 body = s_json.dumps(body)
-                headers['Content-Type'] = 'application/json; charset=utf8"'
+                headers['Content-Type'] = 'application/json; charset=utf8'
                 headers['Content-Length'] = len(body)
 
         await self._methSendCode(code)
@@ -1083,13 +1083,13 @@ class CortexHttpApi(s_stormtypes.Lib):
         ''',
          'type': {'type': 'function', '_funcname': 'addHttpApi',
                   'args': (
-                      {'name': 'path', 'type': 'string',
+                      {'name': 'path', 'type': 'str',
                        'desc': 'The extended HTTP API path.'},
-                      {'name': 'name', 'type': 'string',
+                      {'name': 'name', 'type': 'str',
                        'desc': 'Friendly name for the Extended HTTP API.', 'default': ''},
-                      {'name': 'desc', 'type': 'string',
+                      {'name': 'desc', 'type': 'str',
                        'desc': 'Description for the Extended HTTP API.', 'default': ''},
-                      {'name': 'runas', 'type': 'string',
+                      {'name': 'runas', 'type': 'str',
                        'desc': 'Run the storm query as the API "owner" or as the authenticated "user".',
                        'default': 'owner'},
                       {'name': 'authenticated', 'type': 'boolean',
@@ -1103,14 +1103,14 @@ class CortexHttpApi(s_stormtypes.Lib):
         {'name': 'del', 'desc': 'Delete an Extended HTTP API endpoint.',
          'type': {'type': 'function', '_funcname': 'delHttpApi',
                   'args': (
-                      {'name': 'iden', 'type': 'string',
+                      {'name': 'iden', 'type': 'str',
                        'desc': 'The iden of the API to delete.'},
                   ),
                   'returns': {'type': 'null'}}},
         {'name': 'get', 'desc': 'Get an Extended ``http:api`` object.',
          'type': {'type': 'function', '_funcname': 'getHttpApi',
                   'args': (
-                      {'name': 'iden', 'type': 'string',
+                      {'name': 'iden', 'type': 'str',
                        'desc': 'The iden of the API to retrieve.'},
                   ),
                   'returns': {'type': 'http:api', 'desc': 'The ``http:api`` object.'}}},
@@ -1123,17 +1123,17 @@ class CortexHttpApi(s_stormtypes.Lib):
         ''',
          'type': {'type': 'function', '_funcname': 'getHttpApiByPath',
                   'args': (
-                      {'name': 'path', 'type': 'string',
+                      {'name': 'path', 'type': 'str',
                        'desc': 'Path to use to retrieve an object.'},
                   ),
                   'returns': {'type': ['http:api', 'null'], 'desc': 'The ``http:api`` object or ``(null)`` if there is no match.'}}},
         {'name': 'list', 'desc': 'Get all the Extended HTTP APIs on the Cortex',
          'type': {'type': 'function', '_funcname': 'listHttpApis', 'args': (),
-                 'returns': {'type': 'list', 'desc': 'A list of ``http:api`` objects'}}},
+                  'returns': {'type': 'list', 'desc': 'A list of ``http:api`` objects'}}},
         {'name': 'index', 'desc': 'Set the index for a given Extended HTTP API.',
          'type': {'type': 'function', '_funcname': 'setHttpApiIndx',
                   'args': (
-                      {'name': 'iden', 'type': 'string',
+                      {'name': 'iden', 'type': 'str',
                        'desc': 'The iden of the API to modify.'},
                       {'name': 'index', 'type': 'int', 'default': 0,
                        'desc': 'The new index of the API. Uses zero based indexing.'},

synapse/lib/stormlib/env.py

@@ -1,7 +1,6 @@
 import os
 
 import synapse.exc as s_exc
-import synapse.common as s_common
 import synapse.lib.stormtypes as s_stormtypes
 
 @s_stormtypes.registry.registerLib
@@ -21,10 +20,10 @@ class LibEnv(s_stormtypes.Lib):
             'type': 'function', '_funcname': '_libEnvGet',
             'args': (
                 {'name': 'name', 'type': 'str', 'desc': 'The name of the environment variable.', },
-                {'name': 'default', 'type': 'obj', 'default': None,
-                    'desc': 'The value to return if the environment variable is not set.', },
+                {'name': 'default', 'type': 'prim', 'default': None,
+                    'desc': 'The value to return if the environment variable is not set. Non-string values will be converted into their string forms.', },
             ),
-         'returns': {'type': 'str', 'desc': 'The environment variable string.'},
+            'returns': {'type': ['str', 'null'], 'desc': 'The environment variable string.'},
          },
         },
     )
@@ -47,4 +46,4 @@ class LibEnv(s_stormtypes.Lib):
             mesg = f'Environment variable must start with SYN_STORM_ENV_ : {name}'
             raise s_exc.BadArg(mesg=mesg)
 
-        return os.getenv(name, default=default)
+        return os.getenv(name, default=await s_stormtypes.tostr(default, noneok=True))

synapse/lib/stormlib/ethereum.py

@@ -13,7 +13,7 @@ class EthereumLib(s_stormtypes.Lib):
                       {'name': 'addr', 'type': 'str', 'desc': 'The Ethereum address to be converted.'},
                   ),
                   'returns': {'type': 'list',
-                              'desc': 'A list of (<bool>, <addr>) for status and checksummed address.', },
+                              'desc': 'A list of (<boolean>, <addr>) for status and checksummed address.', },
         }},
     )
 

synapse/lib/stormlib/gen.py

@@ -140,7 +140,7 @@ class LibGen(s_stormtypes.Lib):
          'desc': 'Returns a file:bytes node by SHA256, adding the node if it does not exist.',
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (
-                      {'name': 'sha256', 'type': ['str', 'hash:sha256'], 'desc': 'The SHA256 fingerprint for the file:bytes node.'},
+                      {'name': 'sha256', 'type': 'str', 'desc': 'The SHA256 fingerprint for the file:bytes node.'},
                       {'name': 'try', 'type': 'boolean', 'default': False,
                        'desc': 'Type normalization will fail silently instead of raising an exception.'},
                   ),
@@ -149,7 +149,7 @@ class LibGen(s_stormtypes.Lib):
          'desc': 'Returns a crypto:x509:cert node by SHA256, adding the node if it does not exist.',
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (
-                      {'name': 'sha256', 'type': ['str', 'hash:sha256'], 'desc': 'The SHA256 fingerprint for the certificate.'},
+                      {'name': 'sha256', 'type': 'str', 'desc': 'The SHA256 fingerprint for the certificate.'},
                       {'name': 'try', 'type': 'boolean', 'default': False,
                        'desc': 'Type normalization will fail silently instead of raising an exception.'},
                   ),
@@ -159,7 +159,7 @@ class LibGen(s_stormtypes.Lib):
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (
                       {'name': 'server', 'type': ['str', 'inet:server'], 'desc': 'The server associated with the x509 certificate.'},
-                      {'name': 'sha256', 'type': ['str', 'hash:sha256'], 'desc': 'The SHA256 fingerprint for the certificate.'},
+                      {'name': 'sha256', 'type': 'str', 'desc': 'The SHA256 fingerprint for the certificate.'},
                       {'name': 'try', 'type': 'boolean', 'default': False,
                        'desc': 'Type normalization will fail silently instead of raising an exception.'},
                   ),

synapse/lib/stormlib/hex.py

@@ -29,7 +29,7 @@ class HexLib(s_stormtypes.Lib):
          'type': {'type': 'function', '_funcname': 'toint',
                   'args': (
                       {'name': 'valu', 'type': 'str', 'desc': 'The hex string to be converted.'},
-                      {'name': 'signed', 'type': 'bool', 'default': False,
+                      {'name': 'signed', 'type': 'boolean', 'default': False,
                        'desc': 'If true, convert to a signed integer.'},
                   ),
                   'returns': {'type': 'int', 'desc': 'The resulting integer.', }
@@ -39,7 +39,7 @@ class HexLib(s_stormtypes.Lib):
                   'args': (
                       {'name': 'valu', 'type': 'int', 'desc': 'The integer to be converted.'},
                       {'name': 'length', 'type': 'int', 'desc': 'The number of bytes to use to represent the integer.'},
-                      {'name': 'signed', 'type': 'bool', 'default': False,
+                      {'name': 'signed', 'type': 'boolean', 'default': False,
                        'desc': 'If true, convert as a signed value.'},
                   ),
                   'returns': {'type': 'str', 'desc': 'The resulting hex string.', }

synapse/lib/stormlib/imap.py

@@ -485,9 +485,9 @@ class ImapLib(s_stormtypes.Lib):
                      'desc': 'The IMAP server port.'},
                     {'type': 'int', 'name': 'timeout', 'default': 30,
                      'desc': 'The time to wait for all commands on the server to execute.'},
-                    {'type': 'bool', 'name': 'ssl', 'default': True,
+                    {'type': 'boolean', 'name': 'ssl', 'default': True,
                      'desc': 'Use SSL to connect to the IMAP server.'},
-                    {'type': 'bool', 'name': 'ssl_verify', 'default': True,
+                    {'type': 'boolean', 'name': 'ssl_verify', 'default': True,
                      'desc': 'Perform SSL/TLS verification.'},
                 ),
                 'returns': {

synapse/lib/stormlib/infosec.py

@@ -422,7 +422,7 @@ class MitreAttackFlowLib(s_stormtypes.Lib):
         {'name': 'norm', 'desc': 'Normalize a MITRE ATT&CK Flow diagram in JSON format.',
          'type': {'type': 'function', '_funcname': '_norm',
                   'args': (
-                      {'name': 'flow', 'type': 'data',
+                      {'name': 'flow', 'type': 'dict',
                        'desc': 'The MITRE ATT&CK Flow diagram in JSON format to normalize (flatten and sort).'},
                   ),
                   'returns': {'type': 'dict', 'desc': 'The normalized MITRE ATT&CK Flow diagram.', }
@@ -430,7 +430,7 @@ class MitreAttackFlowLib(s_stormtypes.Lib):
         {'name': 'ingest', 'desc': 'Ingest a MITRE ATT&CK Flow diagram in JSON format.',
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (
-                      {'name': 'flow', 'type': 'data', 'desc': 'The JSON data to ingest.'},
+                      {'name': 'flow', 'type': 'any', 'desc': 'The JSON data to ingest.'},
                   ),
                   'returns': {'type': ['node', 'null'], 'desc': 'The it:mitre:attack:flow node representing the ingested attack flow diagram.'}}},
 

synapse/lib/stormlib/iters.py

@@ -19,7 +19,7 @@ class LibIters(s_stormtypes.Lib):
             'type': {
                 'type': 'function', '_funcname': 'enum',
                 'args': (
-                    {'type': 'iter', 'name': 'genr', 'desc': 'An iterable or generator.'},
+                    {'type': 'list', 'name': 'genr', 'desc': 'An iterable or generator.'},
                 ),
                 'returns': {'name': 'yields', 'type': 'list',
                             'desc': 'Yields (<indx>, <item>) tuples.'},
@@ -30,7 +30,7 @@ class LibIters(s_stormtypes.Lib):
             'type': {
                 'type': 'function', '_funcname': '_zip',
                 'args': (
-                    {'name': '*args', 'type': 'iter', 'desc': 'Iterables or generators.', },
+                    {'name': '*args', 'type': 'list', 'desc': 'Iterables or generators.', },
                 ),
                 'returns': {'name': 'yields', 'type': 'list',
                             'desc': 'Yields tuples with an item from each iterable or generator.'},

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.'}}},