synapse 2.182.0__py311-none-any.whl → 2.184.0__py311-none-any.whl

synapse/cortex.py

@@ -1453,6 +1453,11 @@ class Cortex(s_oauth.OAuthMixin, s_cell.Cell):  # type: ignore
             {'perm': ('storm', 'macro', 'edit'), 'gate': 'cortex',
              'desc': 'Controls access to edit a storm macro.'},
 
+            {'perm': ('task', 'get'), 'gate': 'cortex',
+             'desc': 'Controls access to view other users tasks.'},
+            {'perm': ('task', 'del'), 'gate': 'cortex',
+             'desc': 'Controls access to terminate other users tasks.'},
+
             {'perm': ('view',), 'gate': 'cortex',
              'desc': 'Controls all view permissions.'},
             {'perm': ('view', 'add'), 'gate': 'cortex',

synapse/datamodel.py

@@ -987,7 +987,17 @@ class Model:
         if form is None:
             return
 
-        formprops = [p for p in form.props.values() if p.univ is None]
+        ifaceprops = set()
+        for iface in form.ifaces.values():
+            for prop in iface.get('props', ()):
+                ifaceprops.add(prop[0])
+
+        formprops = []
+        for propname, prop in form.props.items():
+            if prop.univ is not None or propname in ifaceprops:
+                continue
+            formprops.append(prop)
+
         if formprops:
             propnames = ', '.join(prop.name for prop in formprops)
             mesg = f'Form has extended properties: {propnames}'
@@ -996,8 +1006,8 @@ class Model:
         if isinstance(form.type, s_types.Array):
             self.arraysbytype[form.type.arraytype.name].pop(form.name, None)
 
-        for ifname in form.ifaces.keys():
-            self.formsbyiface[ifname].remove(formname)
+        for ifname in form.type.info.get('interfaces', ()):
+            self._delFormIface(form, ifname)
 
         self.forms.pop(formname, None)
         self.props.pop(formname, None)
@@ -1108,6 +1118,34 @@ class Model:
             for ifname in ifaces:
                 self._addFormIface(form, ifname, subifaces=subifaces)
 
+    def _delFormIface(self, form, name, subifaces=None):
+
+        if (iface := self.ifaces.get(name)) is None:
+            return
+
+        for propname, typedef, propinfo in iface.get('props', ()):
+            fullprop = f'{form.name}:{propname}'
+            self.delFormProp(form.name, propname)
+            self.ifaceprops[f'{name}:{propname}'].remove(fullprop)
+
+            if subifaces is not None:
+                for subi in subifaces:
+                    self.ifaceprops[f'{subi}:{propname}'].remove(fullprop)
+
+        form.ifaces.pop(name, None)
+        self.formsbyiface[name].remove(form.name)
+
+        if (ifaces := iface.get('interfaces')) is not None:
+            if subifaces is None:
+                subifaces = []
+            else:
+                subifaces = list(subifaces)
+
+            subifaces.append(name)
+
+            for ifname in ifaces:
+                self._delFormIface(form, ifname, subifaces=subifaces)
+
     def delTagProp(self, name):
         return self.tagprops.pop(name)
 

synapse/lib/ast.py

@@ -1302,8 +1302,9 @@ class VarListSetOper(Oper):
         names = self.kids[0].value()
         vkid = self.kids[1]
 
+        anynodes = False
         async for node, path in genr:
-
+            anynodes = True
             item = await vkid.compute(runt, path)
             item = [i async for i in s_stormtypes.toiter(item)]
 
@@ -1318,7 +1319,7 @@ class VarListSetOper(Oper):
 
             yield node, path
 
-        if vkid.isRuntSafe(runt):
+        if not anynodes and vkid.isRuntSafe(runt):
 
             item = await vkid.compute(runt, None)
             item = [i async for i in s_stormtypes.toiter(item)]
@@ -4517,7 +4518,7 @@ class EditTagAdd(Edit):
         else:
             oper_offset = 0
 
-        excignore = (s_exc.BadTypeValu,) if oper_offset == 1 else ()
+        excignore = (s_exc.BadTypeValu, s_exc.BadTag) if oper_offset == 1 else ()
 
         hasval = len(self.kids) > 2 + oper_offset
 

synapse/lib/autodoc.py

@@ -28,6 +28,7 @@ stormtype_doc_schema = {
                          'description': 'For a function argument, the name of the argument.'},
                 'desc': {'type': 'string',
                          'description': 'For a function argument or return value, the description of the value.'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
                 'type': {'$ref': '#/definitions/stormType'},
                 'args': {
                     'type': 'array',
@@ -46,7 +47,28 @@ stormtype_doc_schema = {
                            'documentation for.',
             'additionalProperties': False,
         },
-
+        'deprecatedItem': {
+            'type': 'object',
+            'properties': {
+                'eolvers': {'type': 'string', 'minLength': 1,
+                            'description': "The version which will not longer support the item."},
+                'eoldate': {'type': 'string', 'minLength': 1,
+                            'description': 'Optional string indicating Synapse releases after this date may no longer support the item.'},
+                'mesg': {'type': ['string', 'null'], 'default': None,
+                         'description': 'Optional message to include in the warning text.'}
+            },
+            'oneOf': [
+                {
+                    'required': ['eolvers'],
+                    'not': {'required': ['eoldate']}
+                },
+                {
+                    'required': ['eoldate'],
+                    'not': {'required': ['eolvers']}
+                }
+            ],
+            'additionalProperties': False,
+        },
         'stormtypeDoc': {
             'type': 'object',
             'properties': {
@@ -54,6 +76,7 @@ stormtype_doc_schema = {
                          'description': 'The name of the object.'},
                 'desc': {'type': 'string',
                          'description': 'The docstring of the object.'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
                 'type': {'$ref': '#/definitions/stormType'}
             },
             'additionalProperties': False,
@@ -186,6 +209,34 @@ def getArgLines(rtype):
 
     return lines
 
+def genDeprecationWarning(name, depr, runt=False):
+    assert name is not None
+    assert depr is not None
+    lines = []
+    if runt:
+        lines.append('.. warning::')
+    else:
+        lines.append('Warning:')
+
+    mesg = depr.get('mesg')
+    date = depr.get('eoldate')
+    vers = depr.get('eolvers')
+
+    ws = ''
+    if runt:
+        ws = '   '
+
+    if date:
+        lines.append(f'{ws}``{name}`` has been deprecated and will be removed on or after {date}.')
+    else:
+        lines.append(f'{ws}``{name}`` has been deprecated and will be removed in version {vers}.')
+    if mesg:
+        lines.append(f'{ws}{mesg}')
+
+    lines.append('\n')
+
+    return lines
+
 def runtimeGetArgLines(rtype):
     lines = []
     args = rtype.get('args', ())
@@ -413,6 +464,7 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
 
         locls = info.get('locals', ())
         locls = sorted(locls, key=lambda x: x.get('name'))
+        libdepr = info.get('deprecated')
 
         for locl in locls:
 
@@ -424,6 +476,11 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
             assert rtype is not None
 
             link = f'.. _{linkprefix}-{loclname.replace(":", ".").replace(".", "-")}:'
+            lines = []
+            if depr := locl.get('deprecated'):
+                lines.extend(genDeprecationWarning(f'${loclname}', depr, True))
+            elif libdepr is not None:
+                lines.extend(genDeprecationWarning(f'${loclname}', libdepr, True))
 
             if isinstance(rtype, dict):
                 rname = rtype.get('type')
@@ -445,7 +502,7 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
                 if rname == 'stor' or 'stor' in rname:
                     isstor = True
 
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
                 arglines = getArgLines(rtype)
                 lines.extend(arglines)
 
@@ -461,7 +518,7 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
 
             else:
                 header = name
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
 
                 retlines = getReturnLines(rtype, known_types=known_types, types_prefix=types_prefix,
                                           suffix=types_suffix)
@@ -472,6 +529,7 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
                 header = f'${header}'
 
             page.addHead(header, lvl=lvl + 1, link=link)
+
             page.addLines(*lines)
 
 def runtimeDocStormTypes(page, docinfo, islib=False, lvl=1,
@@ -521,6 +579,7 @@ def runtimeDocStormTypes(page, docinfo, islib=False, lvl=1,
 
         page.addLines(*preamble)
 
+        libdepr = info.get('deprecated')
         locls = info.get('locals', ())
         locls = sorted(locls, key=lambda x: x.get('name'))
 
@@ -568,13 +627,20 @@ def runtimeDocStormTypes(page, docinfo, islib=False, lvl=1,
             assert desc is not None
             assert rtype is not None
 
+            lines = []
+            if not oneline:
+                if (depr := locl.get('deprecated')):
+                    lines.extend(genDeprecationWarning(f'${loclname}', depr))
+                elif libdepr is not None:
+                    lines.extend(genDeprecationWarning(f'${loclname}', libdepr))
+
             if isinstance(rtype, dict):
                 rname = rtype.get('type')
 
                 if isinstance(rname, dict):
                     raise AssertionError(f'rname as dict not supported loclname={loclname} rname={rname}')
 
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
                 arglines = runtimeGetArgLines(rtype)
                 lines.extend(arglines)
 
@@ -588,7 +654,7 @@ def runtimeDocStormTypes(page, docinfo, islib=False, lvl=1,
 
             else:
                 header = name
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
 
                 retlines = runtimeGetReturnLines(rtype)
                 lines.extend(retlines)

synapse/lib/cell.py

@@ -3560,7 +3560,7 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
         item.setdefault('permissions', {})
         item['permissions'].setdefault('users', {})
         item['permissions'].setdefault('roles', {})
-        item['permissions']['default'] = default
+        item['permissions'].setdefault('default', default)
 
     async def getTeleApi(self, link, mesg, path):
 

synapse/lib/storm.py

@@ -342,6 +342,7 @@ reqValidPkgdef = s_config.getJsValidator({
             'properties': {
                 'name': {'type': 'string'},
                 'desc': {'type': 'string'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
                 'type': {
                     'type': 'object',
                     'properties': {
@@ -395,6 +396,28 @@ reqValidPkgdef = s_config.getJsValidator({
             'additionalProperties': False,
             'required': ['name', 'desc', 'type']
         },
+        'deprecatedItem': {
+            'type': 'object',
+            'properties': {
+                'eolvers': {'type': 'string', 'minLength': 1,
+                            'description': "The version which will not longer support the item."},
+                'eoldate': {'type': 'string', 'minLength': 1,
+                            'description': 'Optional string indicating Synapse releases after this date may no longer support the item.'},
+                'mesg': {'type': ['string', 'null'], 'default': None,
+                         'description': 'Optional message to include in the warning text.'}
+            },
+            'oneOf': [
+                {
+                    'required': ['eolvers'],
+                    'not': {'required': ['eoldate']}
+                },
+                {
+                    'required': ['eoldate'],
+                    'not': {'required': ['eolvers']}
+                }
+            ],
+            'additionalProperties': False,
+        },
         'apitype': {
             'type': 'string',
         },

synapse/lib/stormlib/cortex.py

@@ -715,6 +715,7 @@ class HttpPermsList(s_stormtypes.List):
                   ),
                   'returns': {'type': 'any', 'desc': 'The permission present in the list at the index position.', }}},
         {'name': 'length', 'desc': 'Get the length of the list. This is deprecated; please use ``.size()`` instead.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': '_methListLength',
                   'returns': {'type': 'int', 'desc': 'The size of the list.', }}},
         {'name': 'append', 'desc': 'Append a permission to the list.',

synapse/lib/stormlib/graph.py

@@ -157,6 +157,15 @@ class GraphLib(s_stormtypes.Lib):
                   ),
                   'returns': {'type': 'null', }}},
 
+        {'name': 'revoke', 'desc': 'Revoke permissions granted to users/roles on a graph projection.',
+         'type': {'type': 'function', '_funcname': '_methGraphRevoke',
+                  'args': (
+                      {'name': 'gden', 'type': 'str', 'desc': 'Iden of the graph projection to modify.'},
+                      {'name': 'scope', 'type': 'str', 'desc': 'The scope, either "users" or "roles".'},
+                      {'name': 'iden', 'type': 'str', 'desc': 'The user/role iden depending on scope.'},
+                  ),
+                  'returns': {'type': 'null'}}},
+
         {'name': 'activate', 'desc': 'Set the graph projection to use for the top level Storm Runtime.',
          'type': {'type': 'function', '_funcname': '_methGraphActivate',
                   'args': (
@@ -174,6 +183,7 @@ class GraphLib(s_stormtypes.Lib):
             'mod': self._methGraphMod,
             'list': self._methGraphList,
             'grant': self._methGraphGrant,
+            'revoke': self._methGraphRevoke,
             'activate': self._methGraphActivate,
         }
 
@@ -219,6 +229,13 @@ class GraphLib(s_stormtypes.Lib):
 
         await self.runt.snap.core.setStormGraphPerm(gden, scope, iden, level, user=self.runt.user)
 
+    async def _methGraphRevoke(self, gden, scope, iden):
+        gden = await s_stormtypes.tostr(gden)
+        scope = await s_stormtypes.tostr(scope)
+        iden = await s_stormtypes.tostr(iden)
+
+        await self.runt.snap.core.setStormGraphPerm(gden, scope, iden, None, user=self.runt.user)
+
     async def _methGraphActivate(self, iden):
         gdef = await self._methGraphGet(iden)
         self.runt.setGraph(gdef)

synapse/lib/stormlib/infosec.py

@@ -537,6 +537,7 @@ class CvssLib(s_stormtypes.Lib):
                   'returns': {'type': 'dict', 'desc': 'A dictionary containing the computed score and subscores.', }
         }},
         {'name': 'vectToProps', 'desc': 'Parse a CVSS v3.1 vector and return a dictionary of risk:vuln props.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': 'vectToProps',
                   'args': (
                       {'name': 'text', 'type': 'str', 'desc': 'A CVSS vector string.'},
@@ -544,6 +545,7 @@ class CvssLib(s_stormtypes.Lib):
                   'returns': {'type': 'dict', 'desc': 'A dictionary of risk:vuln secondary props.', }
         }},
         {'name': 'saveVectToNode', 'desc': 'Parse a CVSS v3.1 vector and record properties on a risk:vuln node.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': 'saveVectToNode',
                   'args': (
                       {'name': 'node', 'type': 'node',

synapse/lib/stormlib/model.py

@@ -543,7 +543,7 @@ class ModelType(s_stormtypes.Prim):
 @s_stormtypes.registry.registerLib
 class LibModelEdge(s_stormtypes.Lib):
     '''
-    A Storm Library for interacting with light edges and manipulating their key-value attributes.
+    A Storm Library for interacting with light edges and manipulating their key-value attributes. This Library is deprecated.
     '''
     _storm_locals = (
         {'name': 'get', 'desc': 'Get the key-value data for a given Edge verb.',
@@ -588,6 +588,7 @@ class LibModelEdge(s_stormtypes.Lib):
     hivepath = ('cortex', 'model', 'edges')
 
     _storm_lib_path = ('model', 'edge')
+    _storm_lib_deprecation = {'eolvers': 'v3.0.0'}
 
     def __init__(self, runt, name=()):
         s_stormtypes.Lib.__init__(self, runt, name)

synapse/lib/stormlib/random.py

@@ -1,10 +1,77 @@
 import random
 
 import synapse.exc as s_exc
+import synapse.common as s_common
+
 import synapse.lib.stormtypes as s_stormtypes
 
+from typing import Optional
+
 randinst = random.SystemRandom()
 
+
+@s_stormtypes.registry.registerType
+class Random(s_stormtypes.StormType):
+    '''
+    A random number generator.
+    '''
+    _storm_typename = 'random'
+    _storm_locals = (
+        {'name': 'int', 'desc': 'Generate a random integer.',
+         'type': {'type': 'function', '_funcname': '_methInt',
+                  'args': (
+                      {'name': 'maxval', 'type': 'int', 'desc': 'The maximum random value.'},
+                      {'name': 'minval', 'type': 'int', 'desc': 'The minimum random value.', 'default': 0},
+                  ),
+                  'returns': {'type': 'int', 'desc': 'A random integer in the range min-max inclusive.'}}},
+        {'name': 'seed', 'desc': 'The seed used for the generator. Setting this value resets the generator state.',
+         'type': {'type': ['gtor', 'stor'], '_storfunc': '_storSeed', '_gtorfunc': '_gtorSeed',
+                  'returns': {'type': ['str', 'null']}}},
+    )
+    _ismutable = False
+
+    def __init__(self, runt, seed: Optional[str] =None):
+        s_stormtypes.StormType.__init__(self)
+        self.runt = runt
+        self._seed = seed
+        self.robj = random.Random()
+        if seed is not None:
+            self.robj.seed(self._seed, version=2)
+        self.locls.update(self.getObjLocals())
+        self.gtors.update({
+            'seed': self._gtorSeed,
+        })
+        self.stors.update({
+            'seed': self._storSeed,
+        })
+
+    async def stormrepr(self):
+        ret = f'{self._storm_typename}'
+        if self._seed is not None:
+            ret = f'{ret} seed={s_common.trimText(self._seed, n=40)}'
+        return ret
+
+    def getObjLocals(self):
+        return {
+            'int': self._methInt,
+        }
+
+    async def _gtorSeed(self):
+        return self._seed
+
+    async def _storSeed(self, seed):
+        self._seed = await s_stormtypes.tostr(seed, noneok=True)
+        self.robj.seed(self._seed)
+
+    @s_stormtypes.stormfunc(readonly=True)
+    async def _methInt(self, maxval, minval=0):
+        maxval = await s_stormtypes.toint(maxval)
+        minval = await s_stormtypes.toint(minval)
+        if minval > maxval:
+            raise s_exc.BadArg(mesg=f'Minval must be less than or equal to maxval, minval={minval}, maxval={maxval}',
+                               minval=minval, maxval=maxval)
+        return self.robj.randint(minval, maxval)
+
 @s_stormtypes.registry.registerLib
 class LibRandom(s_stormtypes.Lib):
     '''
@@ -12,22 +79,36 @@ class LibRandom(s_stormtypes.Lib):
     '''
     _storm_locals = (
         {'name': 'int', 'desc': 'Generate a random integer.',
-         'type': {'type': 'function', '_funcname': '_int',
+         'type': {'type': 'function', '_funcname': '_methInt',
                   'args': (
                       {'name': 'maxval', 'type': 'int', 'desc': 'The maximum random value.'},
                       {'name': 'minval', 'type': 'int', 'desc': 'The minimum random value.', 'default': 0},
                   ),
                   'returns': {'type': 'int', 'desc': 'A random integer in the range min-max inclusive.'}}},
+        {'name': 'generator', 'desc': 'Make a random generator with a given seed.',
+         'type': {'type': 'function', '_funcname': '_methGenerator',
+                  'args': (
+                      {'name': 'seed', 'type': 'str', 'default': None,
+                       'desc': 'The seed value used for the random generator.'},
+                  ),
+                  'returns': {'type': 'random', 'desc': 'The random generator object.'}}
+        }
     )
     _storm_lib_path = ('random',)
 
     def getObjLocals(self):
         return {
-            'int': self._int,
+            'int': self._methInt,
+            'generator': self._methGenerator,
         }
 
     @s_stormtypes.stormfunc(readonly=True)
-    async def _int(self, maxval, minval=0):
+    async def _methGenerator(self, seed=None):
+        seed = await s_stormtypes.tostr(seed, noneok=True)
+        return Random(self.runt, seed=seed)
+
+    @s_stormtypes.stormfunc(readonly=True)
+    async def _methInt(self, maxval, minval=0):
         maxval = await s_stormtypes.toint(maxval)
         minval = await s_stormtypes.toint(minval)
         if minval > maxval:

synapse/lib/stormtypes.py

@@ -277,6 +277,7 @@ class StormTypesRegistry:
                 'desc': getDoc(slib, sname),
                 'locals': locs,
                 'path': ('lib',) + slib._storm_lib_path,
+                'deprecated': slib._storm_lib_deprecation,
             }
             for info in sorted(slib._storm_locals, key=lambda x: x.get('name')):
                 info = s_msgpack.deepcopy(info)
@@ -509,6 +510,7 @@ class Lib(StormType):
     _storm_query = None
     _storm_typename = 'lib'
     _storm_lib_perms = ()
+    _storm_lib_deprecation = None
 
     def __init__(self, runt, name=()):
         StormType.__init__(self)
@@ -2659,6 +2661,7 @@ class LibBytes(Lib):
                   'returns': {'type': 'list', 'desc': 'A tuple of the file size and sha256 value.', }}},
     )
     _storm_lib_path = ('bytes',)
+    _storm_lib_deprecation = {'eolvers': 'v3.0.0', 'mesg': 'Use the corresponding ``$lib.axon`` function.'}
 
     def getObjLocals(self):
         return {
@@ -5005,6 +5008,7 @@ class List(Prim):
                   ),
                   'returns': {'type': 'any', 'desc': 'The item present in the list at the index position.', }}},
         {'name': 'length', 'desc': 'Get the length of the list. This is deprecated; please use ``.size()`` instead.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': '_methListLength',
                   'returns': {'type': 'int', 'desc': 'The size of the list.', }}},
         {'name': 'append', 'desc': 'Append a value to the list.',

synapse/lib/stormwhois.py

@@ -16,6 +16,7 @@ class LibWhois(s_stormtypes.Lib):
 
         Raises:
             StormRuntimeError: If form is not supported in this method.''',
+         'deprecated': {'eolvers': 'v3.0.0', 'mesg': 'Please use the GUID constructor syntax.'},
          'type': {'type': 'function', '_funcname': '_whoisGuid',
                   'args': (
                       {'name': 'props', 'type': 'dict', 'desc': 'Dictionary of properties used to create the form.', },
@@ -31,6 +32,8 @@ class LibWhois(s_stormtypes.Lib):
          }
 
     async def _whoisGuid(self, props, form):
+        s_common.deprecated('$lib.inet.whois.guid()', curv='2.183.0')
+        await self.runt.snap.warnonce('$lib.inet.whois.guid() is deprecated. Use the GUID constructor syntax.')
         form = await s_stormtypes.tostr(form)
         props = await s_stormtypes.toprim(props)
         if form == 'iprec':

synapse/lib/version.py

@@ -223,6 +223,6 @@ def reqVersion(valu, reqver,
 ##############################################################################
 # The following are touched during the release process by bumpversion.
 # Do not modify these directly.
-version = (2, 182, 0)
+version = (2, 184, 0)
 verstring = '.'.join([str(x) for x in version])
-commit = '72e535c8c22073fd1b7428121849de4b9fb034ae'
+commit = '05940dce070d26f83bb7e4070f1d44d051804e3b'