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

synapse/tests/test_model_orgs.py

@@ -701,6 +701,47 @@ class OuModelTest(s_t_utils.SynTest):
             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 '))
 
+            visi = await core.auth.addUser('visi')
+
+            nodes = await core.nodes('''
+                [ ou:enacted=*
+                    :id=V-99
+                    :project={[ proj:project=* ]}
+                    :status=10
+                    :priority=highest
+                    :created=20241018
+                    :updated=20241018
+                    :due=20241018
+                    :completed=20241018
+                    :creator=root
+                    :assignee=visi
+                    :scope=(ou:team, *)
+                    :ext:creator={[ ps:contact=* :name=root ]}
+                    :ext:assignee={[ ps:contact=* :name=visi ]}
+                ]
+            ''')
+            self.len(1, nodes)
+            self.eq('V-99', nodes[0].get('id'))
+            self.eq(10, nodes[0].get('status'))
+            self.eq(50, nodes[0].get('priority'))
+
+            self.eq(1729209600000, nodes[0].get('due'))
+            self.eq(1729209600000, nodes[0].get('created'))
+            self.eq(1729209600000, nodes[0].get('updated'))
+            self.eq(1729209600000, nodes[0].get('completed'))
+
+            self.eq(visi.iden, nodes[0].get('assignee'))
+            self.eq(core.auth.rootuser.iden, nodes[0].get('creator'))
+
+            self.nn(nodes[0].get('scope'))
+            self.nn(nodes[0].get('ext:creator'))
+            self.nn(nodes[0].get('ext:assignee'))
+
+            self.len(1, await core.nodes('ou:enacted -> proj:project'))
+            self.len(1, await core.nodes('ou:enacted :scope -> ou:team'))
+            self.len(1, await core.nodes('ou:enacted :ext:creator -> ps:contact +:name=root'))
+            self.len(1, await core.nodes('ou:enacted :ext:assignee -> ps:contact +:name=visi'))
+
     async def test_ou_code_prefixes(self):
         guid0 = s_common.guid()
         guid1 = s_common.guid()

synapse/tests/test_model_risk.py

@@ -577,6 +577,7 @@ class RiskModelTest(s_t_utils.SynTest):
                     :techniques=(*,)
                     :tag=cno.mal.cobaltstrike
                     :mitre:attack:software=S0001
+                    :id=" AAAbbb123  "
 
                     :sophistication=high
                     :availability=public
@@ -593,6 +594,7 @@ class RiskModelTest(s_t_utils.SynTest):
             self.eq(1643673600000, nodes[0].get('reporter:discovered'))
             self.eq(1675209600000, nodes[0].get('reporter:published'))
             self.eq('S0001', nodes[0].get('mitre:attack:software'))
+            self.eq('AAAbbb123', nodes[0].get('id'))
 
             self.eq('cobaltstrike', nodes[0].get('soft:name'))
             self.eq(('beacon',), nodes[0].get('soft:names'))

synapse/tests/test_model_syn.py

@@ -1,5 +1,7 @@
 import synapse.exc as s_exc
+import synapse.common as s_common
 import synapse.cortex as s_cortex
+import synapse.datamodel as s_datamodel
 
 import synapse.lib.stormsvc as s_stormsvc
 
@@ -46,6 +48,47 @@ class TestService(s_stormsvc.StormSvc):
 
 class SynModelTest(s_t_utils.SynTest):
 
+    async def test_syn_userrole(self):
+
+        async with self.getTestCore() as core:
+
+            (ok, iden) = await core.callStorm('return($lib.trycast(syn:user, root))')
+            self.true(ok)
+            self.eq(iden, core.auth.rootuser.iden)
+
+            # coverage for iden taking precedence
+            (ok, iden) = await core.callStorm(f'return($lib.trycast(syn:user, {iden}))')
+            self.true(ok)
+            self.eq(iden, core.auth.rootuser.iden)
+
+            self.eq('root', await core.callStorm(f'return($lib.repr(syn:user, {iden}))'))
+
+            (ok, iden) = await core.callStorm('return($lib.trycast(syn:role, all))')
+            self.true(ok)
+            self.eq(iden, core.auth.allrole.iden)
+
+            # coverage for iden taking precedence
+            (ok, iden) = await core.callStorm(f'return($lib.trycast(syn:role, {iden}))')
+            self.true(ok)
+            self.eq(iden, core.auth.allrole.iden)
+
+            self.eq('all', await core.callStorm(f'return($lib.repr(syn:role, {iden}))'))
+
+            # coverage for DataModel without a cortex reference
+            iden = s_common.guid()
+
+            model = core.model
+            model.core = None
+
+            synuser = model.type('syn:user')
+            synrole = model.type('syn:user')
+
+            self.eq(iden, synuser.repr(iden))
+            self.eq(iden, synrole.repr(iden))
+
+            self.eq(iden, synuser.norm(iden)[0])
+            self.eq(iden, synrole.norm(iden)[0])
+
     async def test_syn_tag(self):
 
         async with self.getTestCore() as core:

synapse/tests/test_tools_promote.py

@@ -0,0 +1,67 @@
+import synapse.common as s_common
+
+import synapse.lib.base as s_base
+import synapse.lib.cell as s_cell
+
+import synapse.tools.promote as s_tools_promote
+
+import synapse.tests.utils as s_t_utils
+
+
+class PromoteToolTest(s_t_utils.SynTest):
+
+    async def test_tool_promote_simple(self):
+        async with self.getTestAha() as aha:
+            async with await s_base.Base.anit() as base:
+                with self.getTestDir() as dirn:
+                    dirn00 = s_common.genpath(dirn, '00.cell')
+                    dirn01 = s_common.genpath(dirn, '01.cell')
+
+                    cell00 = await base.enter_context(self.addSvcToAha(aha, '00.cell', s_cell.Cell, dirn=dirn00))
+                    cell01 = await base.enter_context(self.addSvcToAha(aha, '01.cell', s_cell.Cell, dirn=dirn01,
+                                                                       provinfo={'mirror': 'cell'}))
+                    self.true(cell00.isactive)
+                    self.false(cell01.isactive)
+                    await cell01.sync()
+
+                    outp = self.getTestOutp()
+                    argv = ['--svcurl', cell00.getLocalUrl()]
+                    ret = await s_tools_promote.main(argv, outp=outp)
+                    self.eq(1, ret)
+                    outp.expect('Failed to promote service')
+                    outp.expect('promote() called on non-mirror')
+
+                    outp.clear()
+                    argv = ['--svcurl', cell01.getLocalUrl()]
+                    ret = await s_tools_promote.main(argv, outp=outp)
+                    self.eq(0, ret)
+                    self.false(cell00.isactive)
+                    self.true(cell01.isactive)
+                    await cell00.sync()
+
+    async def test_tool_promote_schism(self):
+        # Create a mirror of mirrors and try promoting the end mirror.
+        async with self.getTestAha() as aha:
+            async with await s_base.Base.anit() as base:
+                with self.getTestDir() as dirn:
+                    dirn00 = s_common.genpath(dirn, '00.cell')
+                    dirn01 = s_common.genpath(dirn, '01.cell')
+                    dirn02 = s_common.genpath(dirn, '02.cell')
+
+                    cell00 = await base.enter_context(self.addSvcToAha(aha, '00.cell', s_cell.Cell, dirn=dirn00))
+                    cell01 = await base.enter_context(self.addSvcToAha(aha, '01.cell', s_cell.Cell, dirn=dirn01,
+                                                                       provinfo={'mirror': '00.cell'}))
+                    cell02 = await base.enter_context(self.addSvcToAha(aha, '02.cell', s_cell.Cell, dirn=dirn02,
+                                                                       provinfo={'mirror': '01.cell'}))
+                    self.true(cell00.isactive)
+                    self.false(cell01.isactive)
+                    self.false(cell02.isactive)
+                    await cell02.sync()
+
+                    outp = self.getTestOutp()
+                    argv = ['--svcurl', cell02.getLocalUrl()]
+                    ret = await s_tools_promote.main(argv, outp=outp)
+                    self.eq(1, ret)
+                    outp.expect('Failed to promote service')
+                    # Note: The following message may change when SYN-7659 is addressed
+                    outp.expect('ahaname=01.cell is not the current leader and cannot handoff leadership to aha://02.cell.synapse')

synapse/tests/test_tools_snapshot.py

@@ -0,0 +1,47 @@
+from unittest import mock
+
+import synapse.lib.output as s_output
+import synapse.tools.snapshot as s_tools_snapshot
+
+import synapse.tests.utils as s_t_utils
+
+class PromoteToolTest(s_t_utils.SynTest):
+
+    async def test_tool_snapshot(self):
+
+        async with self.getTestCore() as core:
+
+            lurl = core.getLocalUrl()
+
+            self.eq(0, await s_tools_snapshot.main(('freeze', '--svcurl', lurl)))
+            self.true(core.paused)
+
+            outp = s_output.OutPutStr()
+            self.eq(1, await s_tools_snapshot.main(('freeze', '--svcurl', lurl), outp=outp))
+            self.isin('ERROR BadState', str(outp))
+
+            self.eq(0, await s_tools_snapshot.main(('resume', '--svcurl', lurl)))
+            self.false(core.paused)
+
+            outp = s_output.OutPutStr()
+            self.eq(1, await s_tools_snapshot.main(('resume', '--svcurl', lurl), outp=outp))
+            self.isin('ERROR BadState', str(outp))
+
+            outp = s_output.OutPutStr()
+            async with core.nexslock:
+                argv = ('freeze', '--svcurl', lurl, '--timeout', '1')
+                self.eq(1, await s_tools_snapshot.main(argv, outp=outp))
+                self.isin('ERROR TimeOut', str(outp))
+
+            def boom():
+                raise Exception('boom')
+
+            outp = s_output.OutPutStr()
+            with mock.patch('os.sync', boom):
+                self.eq(1, await s_tools_snapshot.main(('freeze', '--svcurl', lurl), outp=outp))
+                self.false(core.paused)
+                self.isin('ERROR SynErr: boom', str(outp))
+
+            outp = s_output.OutPutStr()
+            self.eq(1, await s_tools_snapshot.main(('freeze', '--svcurl', 'newp://newp'), outp=outp))
+            self.isin('ERROR BadUrl', str(outp))

synapse/tools/aha/clone.py

@@ -18,7 +18,9 @@ Examples:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.aha.clone', description=descr)
+    pars = argparse.ArgumentParser(prog='synapse.tools.aha.clone', description=descr,
+                        formatter_class=argparse.RawDescriptionHelpFormatter)
+
     pars.add_argument('dnsname', help='The DNS name of the new AHA server.')
     pars.add_argument('--port', type=int, default=27492, help='The port that the new AHA server should listen on.')
     pars.add_argument('--url', default='cell:///vertex/storage', help='The telepath URL to connect to the AHA service.')

synapse/tools/aha/easycert.py

@@ -51,7 +51,7 @@ async def _main(argv, outp):
 
 def getArgParser():
     desc = 'CLI tool to generate simple x509 certificates from an Aha server.'
-    pars = argparse.ArgumentParser(prog='aha.easycert', description=desc)
+    pars = argparse.ArgumentParser(prog='synapse.tools.aha.easycert', description=desc)
 
     pars.add_argument('-a', '--aha', required=True,  # type=str,
                       help='Aha server to connect too.')

synapse/tools/aha/enroll.py

@@ -21,7 +21,9 @@ Examples:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='provision', description=descr)
+    pars = argparse.ArgumentParser(prog='synapse.tools.aha.enroll', description=descr,
+                        formatter_class=argparse.RawDescriptionHelpFormatter)
+
     pars.add_argument('onceurl', help='The one-time use AHA user enrollment URL.')
     opts = pars.parse_args(argv)
 

synapse/tools/aha/provision/service.py

@@ -23,7 +23,9 @@ Examples:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.aha.provision.service', description=descr)
+    pars = argparse.ArgumentParser(prog='synapse.tools.aha.provision.service', description=descr,
+                        formatter_class=argparse.RawDescriptionHelpFormatter)
+
     pars.add_argument('--url', default='cell:///vertex/storage', help='The telepath URL to connect to the AHA service.')
     pars.add_argument('--user', help='Provision the new service with the username.')
     pars.add_argument('--cellyaml', help='Specify the path to a YAML file containing config options for the service.')

synapse/tools/aha/provision/user.py

@@ -22,7 +22,9 @@ Examples:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.aha.provision.user', description=descr)
+    pars = argparse.ArgumentParser(prog='synapse.tools.aha.provision.user', description=descr,
+                        formatter_class=argparse.RawDescriptionHelpFormatter)
+
     pars.add_argument('--url', default='cell:///vertex/storage', help='The telepath URL to connect to the AHA service.')
     pars.add_argument('--again', default=False, action='store_true', help='Generate a new enroll URL for an existing user.')
     pars.add_argument('--only-url', help='Only output the URL upon successful execution',

synapse/tools/livebackup.py

@@ -20,7 +20,9 @@ Examples:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='livebackup', description=descr)
+    pars = argparse.ArgumentParser(prog='synapse.tools.livebackup', description=descr,
+                        formatter_class=argparse.RawDescriptionHelpFormatter)
+
     pars.add_argument('--url', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
     pars.add_argument('--name', default=None, help='Specify a name for the backup.  Defaults to an automatically generated timestamp.')
 

synapse/tools/promote.py

@@ -2,9 +2,12 @@ import sys
 import asyncio
 import argparse
 
+import synapse.exc as s_exc
+
 import synapse.telepath as s_telepath
 
 import synapse.lib.output as s_output
+import synapse.lib.urlhelp as s_urlhelp
 
 descr = '''
 Promote a mirror to the leader.
@@ -15,9 +18,15 @@ Example (being run from a Cortex mirror docker container):
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='provision', description=descr)
-    pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
-    pars.add_argument('--failure', default=False, action='store_true', help='Promotion is due to leader being offline. Graceful handoff is not possible.')
+    pars = argparse.ArgumentParser(prog='synapse.tools.promote', description=descr,
+                        formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    pars.add_argument('--svcurl', default='cell:///vertex/storage',
+                      help='The telepath URL of the Synapse service.')
+
+    pars.add_argument('--failure', default=False, action='store_true',
+                      help='Promotion is due to leader being offline. Graceful handoff is not possible.')
+
     # TODO pars.add_argument('--timeout', type=float, default=30.0, help='The maximum timeout to wait for the mirror to catch up.')
 
     opts = pars.parse_args(argv)
@@ -29,7 +38,17 @@ async def main(argv, outp=s_output.stdout):
             graceful = not opts.failure
 
             outp.printf(f'Promoting to leader: {opts.svcurl}')
-            await cell.promote(graceful=graceful)
+            try:
+                await cell.promote(graceful=graceful)
+            except s_exc.BadState as e:
+                mesg = f'Failed to promote service to being a leader; {e.get("mesg")}'
+                outp.printf(mesg)
+                return 1
+            except s_exc.SynErr as e:
+                outp.printf(f'Failed to promote service {s_urlhelp.sanitizeUrl(opts.svcurl)}: {e}')
+                return 1
+
+    return 0
 
 if __name__ == '__main__':  # pragma: no cover
     sys.exit(asyncio.run(main(sys.argv[1:])))

synapse/tools/snapshot.py

@@ -0,0 +1,69 @@
+import sys
+import asyncio
+import logging
+import argparse
+
+import synapse.exc as s_exc
+import synapse.telepath as s_telepath
+
+import synapse.lib.output as s_output
+
+logger = logging.getLogger(__name__)
+
+desc = '''
+Command line tool to freeze/resume service operations to allow
+system admins to generate a transactionally consistent volume
+snapshot using 3rd party tools.
+
+The use pattern should be::
+
+    python -m synapse.tools.snapshot freeze
+
+    <generate volume snapshot using 3rd party tools>
+
+    python -m synapse.tools.snapshot resume
+
+The tool will set the process exit code to 0 on success.
+'''
+
+async def main(argv, outp=s_output.stdout):
+
+    pars = argparse.ArgumentParser('synapse.tools.snapshot',
+                        description=desc,
+                        formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    subs = pars.add_subparsers(required=True, title='commands', dest='cmd')
+
+    freeze = subs.add_parser('freeze', help='Suspend edits and sync changes to disk.')
+    freeze.add_argument('--timeout', type=int, default=120,
+                        help='Maximum time to wait for the nexus lock.')
+
+    freeze.add_argument('--svcurl', default='cell:///vertex/storage',
+                        help='The telepath URL of the Synapse service.')
+
+    resume = subs.add_parser('resume', help='Resume edits and continue normal operation.')
+    resume.add_argument('--svcurl', default='cell:///vertex/storage',
+                        help='The telepath URL of the Synapse service.')
+
+    opts = pars.parse_args(argv)
+
+    try:
+        async with s_telepath.withTeleEnv():
+
+            async with await s_telepath.openurl(opts.svcurl) as proxy:
+
+                if opts.cmd == 'freeze':
+                    await proxy.freeze(timeout=opts.timeout)
+                    return 0
+
+                if opts.cmd == 'resume':
+                    await proxy.resume()
+                    return 0
+
+    except s_exc.SynErr as e:
+        mesg = e.errinfo.get('mesg')
+        outp.printf(f'ERROR {e.__class__.__name__}: {mesg}')
+        return 1
+
+if __name__ == '__main__':  # pragma: no cover
+    sys.exit(asyncio.run(main(sys.argv[1:])))

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synapse
-Version: 2.184.0
+Version: 2.186.0
 Summary: Synapse Intelligence Analysis Framework
 Author-email: The Vertex Project LLC <root@vertex.link>
 License: Apache License 2.0
@@ -59,15 +59,10 @@ Requires-Dist: bump2version<1.1.0,>=1.0.1; extra == "dev"
 Requires-Dist: pytest-xdist<4.0.0,>=3.0.2; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.0.0; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: nbconvert<8.0.0,>=7.3.1; extra == "docs"
-Requires-Dist: jupyter-client<=8.2.0; extra == "docs"
-Requires-Dist: jupyter<2.0.0,>=1.0.0; extra == "docs"
-Requires-Dist: hide-code<0.8.0,>=0.7.0; extra == "docs"
-Requires-Dist: nbstripout<1.0.0,>=0.3.3; extra == "docs"
-Requires-Dist: sphinx<7.0.0,>=6.2.0; extra == "docs"
-Requires-Dist: sphinx-rtd-theme<2.0.0,>=1.0.0; extra == "docs"
-Requires-Dist: sphinx-notfound-page==0.8.3; extra == "docs"
-Requires-Dist: jinja2<3.1.0; extra == "docs"
+Requires-Dist: sphinx<9.0.0,>=8.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme<4.0.0,>=3.0.0; extra == "docs"
+Requires-Dist: sphinx-notfound-page<2.0.0,>=1.0.4; extra == "docs"
+Requires-Dist: jinja2<4.0.0,>=3.1.4; extra == "docs"
 
 Synapse
 =======