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

synapse/tests/test_lib_stormlib_random.py

@@ -20,3 +20,96 @@ class TestLibStormRandom(s_test.SynTest):
 
             with self.raises(s_exc.BadArg):
                 await core.callStorm('return($lib.random.int(maxval=0, minval=1))')
+
+    async def test_stormlib_random_generator(self):
+        async with self.getTestCore() as core:
+
+            # Seedless generators
+            q = '''$r=$lib.random.generator()
+            return(($r.int(10), $r.int(10), $r.int(10)))
+            '''
+            valu = await core.callStorm(q)
+            for v in valu:
+                self.true(v >= 0 and v <= 10)
+
+            # There is no seed on the generator
+            q = '''$r=$lib.random.generator() return ( $r.seed )'''
+            valu = await core.callStorm(q)
+            self.none(valu)
+
+            # Generators can be made and seeds set
+            q = '''$r=$lib.random.generator() $r.seed=myCoolTestSeed
+            return ( (($r.int(10), $r.int(10), $r.int(10)), $r.seed) )'''
+            valu = await core.callStorm(q)
+            self.eq(valu, ((5, 9, 1), 'myCoolTestSeed'))
+
+            # Setting a seed resets the generator
+            q = '''$r=$lib.random.generator(seed=myCoolTestSeed) $ret=()
+            $ret.append($r.int(10)) $ret.append($r.int(10)) $ret.append($r.int(10))
+            $r.seed=myCoolTestSeed
+            $ret.append($r.int(10)) $ret.append($r.int(10)) $ret.append($r.int(10))
+            return ($ret)'''
+            valu = await core.callStorm(q)
+            self.eq(valu, (5, 9, 1, 5, 9, 1))
+
+            # Clearing the seed makes the generator random.
+            q = '''$r=$lib.random.generator(seed=myCoolTestSeed) $ret=()
+            $ret.append($r.int(10)) $ret.append($r.int(10)) $ret.append($r.int(10))
+            $r.seed=(null)
+            $ret.append($r.int(10)) $ret.append($r.int(10)) $ret.append($r.int(10))
+            return ($ret)'''
+            valu = await core.callStorm(q)
+            self.len(6, valu)
+            self.eq(valu[:3], (5, 9, 1))
+            self.ne(valu[3:], (5, 9, 1))
+            for v in valu[3:]:
+                self.true(v >= 0 and v <= 10)
+
+            # Seeded generators are consistent
+            q = '''$r=$lib.random.generator(seed=myCoolTestSeed)
+            return(($r.int(10), $r.int(10), $r.int(10)))
+            '''
+            valu = await core.callStorm(q)
+            self.eq(valu, (5, 9, 1))
+
+            new_valu = await core.callStorm(q)
+            self.eq(valu, new_valu)
+
+            q = '''$r=$lib.random.generator(seed=myCoolTestSeed)
+            $r2 = $lib.random.generator(seed=$r.seed)
+            return(($r.int(10), $r2.int(10)))
+            '''
+            valu = await core.callStorm(q)
+            self.eq(valu, (5, 5))
+
+            q = '''return($lib.vars.type($lib.random.generator(x)))'''
+            valu = await core.callStorm(q)
+            self.eq(valu, 'random')
+
+            # Seeds are stringified
+            q = '''$r=$lib.random.generator(seed=1234567890)
+            $r2 = $lib.random.generator(seed=(1234567890))
+            return(($r.int(10), $r2.int(10), $r.seed, $r2.seed))
+            '''
+            valu = await core.callStorm(q)
+            self.eq(valu, (5, 5, '1234567890', '1234567890'))
+
+            # Empty string value is still a str
+            q = '''$r=$lib.random.generator(seed='') return ($r.int(10))'''
+            valu = await core.callStorm(q)
+            self.eq(valu, 7)
+
+            # Sad path
+            with self.raises(s_exc.BadArg):
+                await core.callStorm('$r=$lib.random.generator(seed="") return($r.int(maxval=0, minval=1))')
+
+            # Printing objects
+            msgs = await core.stormlist('$lib.print($lib.random.generator())')
+            self.stormIsInPrint('random', msgs)
+            self.stormNotInPrint('seed=', msgs)
+
+            msgs = await core.stormlist('$lib.print($lib.random.generator(seed=""))')
+            self.stormIsInPrint('random seed=', msgs)
+
+            msgs = await core.stormlist('$lib.print($lib.random.generator(seed=haha))')
+            self.stormIsInPrint('random seed=haha', msgs)

synapse/tests/test_lib_stormwhois.py

@@ -84,8 +84,8 @@ class StormWhoisTest(s_test.SynTest):
             '''
             opts = {'vars': {'props': props}}
             mesgs = await core.stormlist(stormcmd, opts=opts)
-            warn = [m[1]['mesg'] for m in mesgs if m[0] == 'warn']
-            self.isin('Insufficient guid vals identified, using random guid:', warn[0])
+            self.stormIsInWarn('$lib.inet.whois.guid() is deprecated', mesgs)
+            self.stormIsInWarn('Insufficient guid vals identified, using random guid:', mesgs)
             self.len(1, await core.nodes(f'inet:whois:ipquery:fqdn={props["fqdn"]}'))
 
             props = {
@@ -97,8 +97,8 @@ class StormWhoisTest(s_test.SynTest):
             '''
             opts = {'vars': {'props': props}}
             mesgs = await core.stormlist(stormcmd, opts=opts)
-            warn = [m[1]['mesg'] for m in mesgs if m[0] == 'warn']
-            self.isin('Insufficient guid vals identified, using random guid:', warn[0])
+            self.stormIsInWarn('$lib.inet.whois.guid() is deprecated', mesgs)
+            self.stormIsInWarn('Insufficient guid vals identified, using random guid:', mesgs)
             self.len(1, await core.nodes(f'inet:whois:ipcontact:asn={props["asn"]}'))
 
             # Failure cases

synapse/tests/test_model_infotech.py

@@ -1547,6 +1547,45 @@ class InfotechModelTest(s_t_utils.SynTest):
                 self.nn(node.get('reg'))
                 self.eq(node.get('sandbox:file'), sandfile)
 
+        async with self.getTestCore() as core:
+            forms = [
+                'it:fs:file',
+                'it:exec:file:add',
+                'it:exec:file:del',
+                'it:exec:file:read',
+                'it:exec:file:write',
+            ]
+
+            for form in forms:
+                opts = {'vars': {'form': form}}
+                nodes = await core.nodes('[ *$form=($form, calc) :path="c:/windows/system32/calc.exe" ]', opts=opts)
+                self.len(1, nodes)
+                self.eq(nodes[0].get('path'), 'c:/windows/system32/calc.exe')
+                self.eq(nodes[0].get('path:base'), 'calc.exe')
+                self.eq(nodes[0].get('path:dir'), 'c:/windows/system32')
+                self.eq(nodes[0].get('path:ext'), 'exe')
+
+                nodes = await core.nodes('*$form=($form, calc) [ :path="c:/users/blackout/script.ps1" ]', opts=opts)
+                self.len(1, nodes)
+                self.eq(nodes[0].get('path'), 'c:/users/blackout/script.ps1')
+                self.eq(nodes[0].get('path:base'), 'script.ps1')
+                self.eq(nodes[0].get('path:dir'), 'c:/users/blackout')
+                self.eq(nodes[0].get('path:ext'), 'ps1')
+
+                nodes = await core.nodes('*$form=($form, calc) [ -:path:base -:path:dir -:path:ext ]', opts=opts)
+                self.len(1, nodes)
+                self.eq(nodes[0].get('path'), 'c:/users/blackout/script.ps1')
+                self.none(nodes[0].get('path:base'))
+                self.none(nodes[0].get('path:dir'))
+                self.none(nodes[0].get('path:ext'))
+
+                nodes = await core.nodes('*$form=($form, calc) [ :path="c:/users/admin/superscript.bat" ]', opts=opts)
+                self.len(1, nodes)
+                self.eq(nodes[0].get('path'), 'c:/users/admin/superscript.bat')
+                self.eq(nodes[0].get('path:base'), 'superscript.bat')
+                self.eq(nodes[0].get('path:dir'), 'c:/users/admin')
+                self.eq(nodes[0].get('path:ext'), 'bat')
+
     async def test_it_app_yara(self):
 
         async with self.getTestCore() as core:
@@ -1636,8 +1675,12 @@ class InfotechModelTest(s_t_utils.SynTest):
             self.eq(1640995200000, nodes[0].get('updated'))
             self.nn(nodes[0].get('author'))
 
-            nodes = await core.nodes('[ it:app:snort:hit=$hit :rule=$rule :flow=$flow :src="tcp://[::ffff:0102:0304]:0" :dst="tcp://[::ffff:0505:0505]:80" :time=2015 :sensor=$host :version=1.2.3 ]', opts=opts)
+            nodes = await core.nodes('''[ it:app:snort:hit=$hit
+                :rule=$rule :flow=$flow :src="tcp://[::ffff:0102:0304]:0"
+                :dst="tcp://[::ffff:0505:0505]:80" :time=2015 :sensor=$host
+                :version=1.2.3 :dropped=true ]''', opts=opts)
             self.len(1, nodes)
+            self.true(nodes[0].get('dropped'))
             self.eq(rule, nodes[0].get('rule'))
             self.eq(flow, nodes[0].get('flow'))
             self.eq(host, nodes[0].get('sensor'))

synapse/tests/test_model_orgs.py

@@ -640,6 +640,7 @@ class OuModelTest(s_t_utils.SynTest):
 
             nodes = await core.nodes('''[ ou:requirement=50b757fafe4a839ec499023ebcffe7c0
                 :name="acquire pizza toppings"
+                :type=foo.bar
                 :text="The team must acquire ANSI standard pizza toppings."
                 :goal={[ ou:goal=* :name=pizza ]}
                 :issuer={[ ps:contact=* :name=visi ]}
@@ -657,6 +658,7 @@ class OuModelTest(s_t_utils.SynTest):
             self.eq('The team must acquire ANSI standard pizza toppings.', nodes[0].get('text'))
             self.eq(1, nodes[0].get('deps:min'))
             self.eq(50, nodes[0].get('priority'))
+            self.eq('foo.bar.', nodes[0].get('type'))
             self.eq(True, nodes[0].get('optional'))
             self.eq(1328140800000, nodes[0].get('issued'))
             self.eq((1672531200000, 9223372036854775807), nodes[0].get('period'))
@@ -665,6 +667,39 @@ class OuModelTest(s_t_utils.SynTest):
             self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 -> ou:goal +:name=pizza'))
             self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 :issuer -> ps:contact +:name=visi'))
             self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 :assignee -> ps:contact +:orgname=ledos'))
+            self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 -> ou:requirement:type:taxonomy'))
+
+            nodes = await core.nodes('''
+                [ ou:asset=*
+                    :id=V-31337
+                    :name="visi laptop"
+                    :type=host.laptop
+                    :priority=highest
+                    :priority:confidentiality=highest
+                    :priority:integrity=highest
+                    :priority:availability=highest
+                    :node = (it:host, *)
+                    :period=(2016, ?)
+                    :status=deployed
+                    :org={[ ou:org=* :name=vertex ]}
+                    :owner={[ ps:contact=* :name=foo ]}
+                    :operator={[ ps:contact=* :name=bar ]}
+                ]''')
+            self.len(1, nodes)
+            self.eq((1451606400000, 9223372036854775807), nodes[0].get('period'))
+            self.eq('visi laptop', nodes[0].get('name'))
+            self.eq('host.laptop.', nodes[0].get('type'))
+            self.eq('deployed.', nodes[0].get('status'))
+            self.eq(50, nodes[0].get('priority'))
+            self.eq(50, nodes[0].get('priority:confidentiality'))
+            self.eq(50, nodes[0].get('priority:integrity'))
+            self.eq(50, nodes[0].get('priority:availability'))
+
+            self.len(1, await core.nodes('ou:asset -> ou:asset:type:taxonomy'))
+            self.len(1, await core.nodes('ou:asset :node -> it:host'))
+            self.len(1, await core.nodes('ou:asset :org -> ou:org +:name=vertex'))
+            self.len(1, await core.nodes('ou:asset :owner -> ps:contact +:name=foo '))
+            self.len(1, await core.nodes('ou:asset :operator -> ps:contact +:name=bar '))
 
     async def test_ou_code_prefixes(self):
         guid0 = s_common.guid()
@@ -832,6 +867,7 @@ class OuModelTest(s_t_utils.SynTest):
                     :orgfqdn = wootwoot.com
                     :currency = USD
                     :costs = 200
+                    :budget = 300
                     :revenue = 500
                     :profit = 300
                     :valuation = 1000000000
@@ -850,6 +886,7 @@ class OuModelTest(s_t_utils.SynTest):
             self.eq(nodes[0].get('orgfqdn'), 'wootwoot.com')
             self.eq(nodes[0].get('currency'), 'usd')
             self.eq(nodes[0].get('costs'), '200')
+            self.eq(nodes[0].get('budget'), '300')
             self.eq(nodes[0].get('revenue'), '500')
             self.eq(nodes[0].get('profit'), '300')
             self.eq(nodes[0].get('valuation'), '1000000000')

synapse/tests/test_model_risk.py

@@ -542,6 +542,7 @@ class RiskModelTest(s_t_utils.SynTest):
                 risk:mitigation=*
                     :vuln=*
                     :name="  FooBar  "
+                    :type=foo.bar
                     :desc=BazFaz
                     :hardware=*
                     :software=*
@@ -552,11 +553,13 @@ class RiskModelTest(s_t_utils.SynTest):
             self.eq('foobar', nodes[0].props['name'])
             self.eq('BazFaz', nodes[0].props['desc'])
             self.eq('vertex', nodes[0].get('reporter:name'))
+            self.eq('foo.bar.', nodes[0].get('type'))
             self.nn(nodes[0].get('reporter'))
             self.len(1, await core.nodes('risk:mitigation -> risk:vuln'))
             self.len(1, await core.nodes('risk:mitigation -> it:prod:softver'))
             self.len(1, await core.nodes('risk:mitigation -> it:prod:hardware'))
             self.len(1, await core.nodes('risk:mitigation -> it:mitre:attack:mitigation'))
+            self.len(1, await core.nodes('risk:mitigation -> risk:mitigation:type:taxonomy'))
 
     async def test_model_risk_tool_software(self):
 

synapse/tests/test_tools_autodoc.py

@@ -191,6 +191,12 @@ class TestAutoDoc(s_t_utils.SynTest):
 
             self.isin('status()', s)
 
+            self.isin('newp()', s)
+            self.isin('.. warning::\n', s)
+            self.isin('``newp`` has been deprecated and will be removed in version v2.300.4.', s)
+            self.isin('Newp is no longer maintained. Use bar() instead.', s)
+            self.isin('Some nonexistent function', s)
+
             # coverage for no apidefs
             rst = s_l_autodoc.RstHelp()
             await s_autodoc.processStormModules(rst, 'foo', [])

synapse/tests/utils.py

@@ -157,6 +157,7 @@ class LibTst(s_stormtypes.Lib):
     '''
     _storm_locals = (
         {'name': 'beep',
+         'deprecated': {'eoldate': '8080-08-08'},
          'desc': '''
         Example storm func.
 
@@ -169,6 +170,7 @@ class LibTst(s_stormtypes.Lib):
                   'returns': {'type': 'str', 'desc': 'The beeped string.', }}},
         {'name': 'someargs',
          'desc': '''Example storm func with args.''',
+         'deprecated': {'eolvers': 'v3.0.0', 'mesg': 'This is a test library was deprecated from the day it was made.'},
          'type': {'type': 'function', '_funcname': 'someargs',
                   'args': (
                       {'name': 'valu', 'type': 'str', 'desc': 'The value to beep.', },
@@ -199,6 +201,32 @@ class LibTst(s_stormtypes.Lib):
         ret = f'A {valu} beep which {bar} the {faz}!'
         return ret
 
+class LibDepr(s_stormtypes.Lib):
+    '''
+    Deprecate me!
+    '''
+    _storm_locals = (
+        {'name': 'boop',
+         'desc': '''
+         An example storm function that's not deprecated on its own, but the entire library is.
+         ''',
+         'type': {'type': 'function', '_funcname': 'boop',
+                  'args': (
+                      {'name': 'valu', 'type': 'str', 'desc': 'What to boop.', },
+                  ),
+                  'returns': {'type': 'str', 'desc': 'The booped.', }}},
+    )
+    _storm_lib_path = ('depr',)
+    _storm_lib_deprecation = {'eolvers': 'v3.0.0'}
+
+    def addLibFuncs(self):  # pragma: no cover
+        self.locls.update({
+            'boop': self.boop,
+        })
+
+    async def boop(self, valu):  # pragma: no cover
+        return f'You have been booped, {valu}!'
+
 class TestType(s_types.Type):
 
     stortype = s_layer.STOR_TYPE_UTF8

synapse/tools/autodoc.py

@@ -617,7 +617,8 @@ async def processStormModules(rst, pkgname, modules):
 
             callsig = s_autodoc.genCallsig(apitype)
             rst.addHead(f'{apiname}{callsig}', lvl=4)
-
+            if depr := apidef.get('deprecated'):
+                rst.addLines(*s_autodoc.genDeprecationWarning(apiname, depr, True))
             rst.addLines(*s_autodoc.prepareRstLines(apidesc))
             rst.addLines(*s_autodoc.getArgLines(apitype))
             rst.addLines(*s_autodoc.getReturnLines(apitype))

synapse/tools/changelog.py

@@ -222,13 +222,25 @@ class ModelDiffer:
                     deprecated_props_noiface[prop] = cpinfo
                     continue
 
+                okeys = set(opinfo.keys())
+                nkeys = set(cpinfo.keys())
+
+                if nkeys - okeys:
+                    # We've added a key to the prop def.
+                    raise s_exc.NoSuchImpl(mesg='Have not implemented support for a prop def having a key added')
+
+                if okeys - nkeys:
+                    # We've removed a key from the prop def.
+                    updated_props[prop] = {'type': 'delkey', 'keys': list(okeys - nkeys)}
+                    continue
+
                 # Check if type change happened, we'll want to document that.
                 ctyp = cpinfo.get('type')
                 otyp = opinfo.get('type')
                 if ctyp == otyp:
                     continue
 
-                updated_props[prop] = {'new_type': ctyp, 'old_type': otyp}
+                updated_props[prop] = {'type': 'type_change', 'new_type': ctyp, 'old_type': otyp}
                 is_ifaceprop = False
                 for iface in self.cur_type2iface[form]:
                     upt_iface = self.changes.get('interfaces').get('updated_interfaces', {}).get(iface)
@@ -237,7 +249,7 @@ class ModelDiffer:
                         break
                 if is_ifaceprop:
                     continue
-                updated_props_noiface[prop] = {'new_type': ctyp, 'old_type': otyp}
+                updated_props_noiface[prop] = {'type': 'type_change', 'new_type': ctyp, 'old_type': otyp}
 
             if updated_props:
                 updated_forms[form]['updated_properties'] = updated_props
@@ -317,13 +329,25 @@ class ModelDiffer:
                     deprecated_props[prop] = cpinfo
                     continue
 
+                okeys = set(opinfo.keys())
+                nkeys = set(cpinfo.keys())
+
+                if nkeys - okeys:
+                    # We've added a key to the prop def.
+                    raise s_exc.NoSuchImpl(mesg='Have not implemented support for a prop def having a key added')
+
+                if okeys - nkeys:
+                    # We've removed a key from the prop def.
+                    updated_props[prop] = {'type': 'delkey', 'keys': list(okeys - nkeys)}
+                    continue
+
                 # Check if type change happened, we'll want to document that.
                 ctyp = cpinfo.get('type')
                 otyp = opinfo.get('type')
                 if ctyp == otyp:
                     continue
 
-                updated_props[prop] = {'new_type': ctyp, 'old_type': otyp}
+                updated_props[prop] = {'type': 'type_change', 'new_type': ctyp, 'old_type': otyp}
             if updated_props:
                 updated_interfaces[iface]['updated_properties'] = updated_props
 
@@ -569,8 +593,14 @@ def _gen_model_rst(version, model_ref, changes, current_model, outp: s_output.Ou
                         lines.append('\n')
                 elif key == 'updated_properties':
                     for prop, pnfo in sorted(valu.items(), key=lambda x: x[0]):
-                        mesg = f'The property ``{prop}`` has been modified from {pnfo.get("old_type")}' \
-                               f' to {pnfo.get("new_type")}.'
+                        ptyp = pnfo.get('type')
+                        if ptyp == 'type_change':
+                            mesg = f'The property ``{prop}`` has been modified from {pnfo.get("old_type")}' \
+                                   f' to {pnfo.get("new_type")}.'
+                        elif ptyp == 'delkey':
+                            mesg = f'The property ``{prop}`` had the ``{pnfo.get("keys")}`` keys removed from its definition.'
+                        else:
+                            raise s_exc.NoSuchImpl(mesg=f'pnfo.type={ptyp} not supported.')
                         lines.extend(textwrap.wrap(mesg, initial_indent='  ', subsequent_indent='  ',
                                                    width=width))
                         lines.append('\n')
@@ -621,11 +651,17 @@ def _gen_model_rst(version, model_ref, changes, current_model, outp: s_output.Ou
             rst.addLines(f'``{form}``')
             upd_form_props = list(info.get('updated_properties').items())
             if len(upd_form_props) > 1:
-                rst.addLines('  The form had the following updated properties:', '\n')
+                rst.addLines('  The form had the following properties updated:', '\n')
                 upd_form_props.sort(key=lambda x: x[0])
                 for prop, pnfo in upd_form_props:
-                    mesg = f'The property ``{prop}`` has been modified from {pnfo.get("old_type")}' \
-                           f' to {pnfo.get("new_type")}.'
+                    ptyp = pnfo.get('type')
+                    if ptyp == 'type_change':
+                        mesg = f'The property ``{prop}`` has been modified from {pnfo.get("old_type")}' \
+                               f' to {pnfo.get("new_type")}.'
+                    elif ptyp == 'delkey':
+                        mesg = f'The property ``{prop}`` had the ``{pnfo.get("keys")}`` keys removed from its definition.'
+                    else:
+                        raise s_exc.NoSuchImpl(mesg=f'pnfo.type={ptyp} not supported.')
                     lines = [
                         *textwrap.wrap(mesg, initial_indent='    ', subsequent_indent='    ',
                                        width=width),
@@ -635,8 +671,15 @@ def _gen_model_rst(version, model_ref, changes, current_model, outp: s_output.Ou
 
             else:
                 prop, pnfo = upd_form_props[0]
-                mesg = f'The property ``{prop}`` has been modified from {pnfo.get("old_type")}' \
-                       f' to {pnfo.get("new_type")}.'
+                ptyp = pnfo.get('type')
+                if ptyp == 'type_change':
+                    mesg = f'The property ``{prop}`` has been modified from {pnfo.get("old_type")}' \
+                           f' to {pnfo.get("new_type")}.'
+                elif ptyp == 'delkey':
+                    mesg = f'The property ``{prop}`` had the ``{pnfo.get("keys")}`` keys removed from its definition.'
+                else:
+                    raise s_exc.NoSuchImpl(mesg=f'pnfo.type={ptyp} not supported.')
+
                 lines = [
                     '  The form had the following property updated:',
                     '\n',

{synapse-2.182.0.dist-info → synapse-2.184.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synapse
-Version: 2.182.0
+Version: 2.184.0
 Summary: Synapse Intelligence Analysis Framework
 Author-email: The Vertex Project LLC <root@vertex.link>
 License: Apache License 2.0