synapse 2.185.0__tar.gz → 2.186.0__tar.gz

{synapse-2.185.0/synapse.egg-info → synapse-2.186.0}/PKG-INFO

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

{synapse-2.185.0 → synapse-2.186.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'synapse'
-version = '2.185.0'
+version = '2.186.0'
 authors = [
     { name = 'The Vertex Project LLC', email = 'root@vertex.link'},
 ]

{synapse-2.185.0 → synapse-2.186.0}/synapse/cortex.py

@@ -2056,9 +2056,10 @@ class Cortex(s_oauth.OAuthMixin, s_cell.Cell):  # type: ignore
                     continue
 
                 if not regex.fullmatch(regx[i], parts[i]):
-                    return False
+                    mesg = f'Tag part ({parts[i]}) of tag ({tagname}) does not match the tag model regex: [{regx[i]}]'
+                    return (False, mesg)
 
-        return True
+        return (True, None)
 
     async def getTagPrune(self, tagname):
         return self.tagprune.get(tagname)

{synapse-2.185.0 → synapse-2.186.0}/synapse/exc.py

@@ -141,6 +141,8 @@ class BadTag(SynErr): pass
 class BadTime(SynErr): pass
 class BadUrl(SynErr): pass
 
+class TypeMismatch(SynErr): pass
+
 class CantDelCmd(SynErr): pass
 class CantDelNode(SynErr): pass
 class CantDelForm(SynErr): pass

{synapse-2.185.0 → synapse-2.186.0}/synapse/lib/ast.py

@@ -4579,7 +4579,7 @@ class EditTagAdd(Edit):
         else:
             oper_offset = 0
 
-        excignore = (s_exc.BadTypeValu, s_exc.BadTag) if oper_offset == 1 else ()
+        excignore = (s_exc.BadTypeValu,) if oper_offset == 1 else ()
 
         hasval = len(self.kids) > 2 + oper_offset
 

{synapse-2.185.0 → synapse-2.186.0}/synapse/lib/cell.py

@@ -35,6 +35,7 @@ import synapse.lib.boss as s_boss
 import synapse.lib.coro as s_coro
 import synapse.lib.hive as s_hive
 import synapse.lib.link as s_link
+import synapse.lib.task as s_task
 import synapse.lib.cache as s_cache
 import synapse.lib.const as s_const
 import synapse.lib.drive as s_drive
@@ -206,6 +207,14 @@ class CellApi(s_base.Base):
     async def initCellApi(self):
         pass
 
+    @adminapi(log=True)
+    async def freeze(self, timeout=30):
+        return await self.cell.freeze(timeout=timeout)
+
+    @adminapi(log=True)
+    async def resume(self):
+        return await self.cell.resume()
+
     async def allowed(self, perm, default=None):
         '''
         Check if the user has the requested permission.
@@ -1102,6 +1111,7 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
         self.auth = None
         self.cellparent = parent
         self.sessions = {}
+        self.paused = False
         self.isactive = False
         self.activebase = None
         self.inaugural = False
@@ -1767,8 +1777,11 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
 
         return await self.drive.addItemInfo(info, path=path, reldir=reldir)
 
-    async def getDriveInfo(self, iden):
-        return self.drive.getItemInfo(iden)
+    async def getDriveInfo(self, iden, typename=None):
+        return self.drive.getItemInfo(iden, typename=typename)
+
+    def reqDriveInfo(self, iden, typename=None):
+        return self.drive.reqItemInfo(iden, typename=typename)
 
     async def getDrivePath(self, path, reldir=s_drive.rootdir):
         '''
@@ -4461,6 +4474,7 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
                 'run': await self.getCellRunId(),
                 'type': self.getCellType(),
                 'iden': self.getCellIden(),
+                'paused': self.paused,
                 'active': self.isactive,
                 'started': self.startms,
                 'ready': self.nexsroot.ready.is_set(),
@@ -4932,3 +4946,52 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
 
         key = tuple(sorted(opts.items()))
         return self._sslctx_cache.get(key)
+
+    async def freeze(self, timeout=30):
+
+        if self.paused:
+            mesg = 'The service is already frozen.'
+            raise s_exc.BadState(mesg=mesg)
+
+        logger.warning(f'Freezing service for volume snapshot.')
+
+        logger.warning('...acquiring nexus lock to prevent edits.')
+
+        try:
+            await asyncio.wait_for(self.nexslock.acquire(), timeout=timeout)
+
+        except asyncio.TimeoutError:
+            logger.warning('...nexus lock acquire timed out!')
+            logger.warning('Aborting freeze and resuming normal operation.')
+
+            mesg = 'Nexus lock acquire timed out.'
+            raise s_exc.TimeOut(mesg=mesg)
+
+        self.paused = True
+
+        try:
+
+            logger.warning('...committing pending transactions.')
+            await self.slab.syncLoopOnce()
+
+            logger.warning('...flushing dirty buffers to disk.')
+            await s_task.executor(os.sync)
+
+            logger.warning('...done!')
+
+        except Exception:
+            self.paused = False
+            self.nexslock.release()
+            logger.exception('Failed to freeze. Resuming normal operation.')
+            raise
+
+    async def resume(self):
+
+        if not self.paused:
+            mesg = 'The service is not frozen.'
+            raise s_exc.BadState(mesg=mesg)
+
+        logger.warning('Resuming normal operations from a freeze.')
+
+        self.paused = False
+        self.nexslock.release()

{synapse-2.185.0 → synapse-2.186.0}/synapse/lib/drive.py

@@ -22,6 +22,7 @@ LKEY_INFO = b'\x02' # <bidn> = <info>
 LKEY_DATA = b'\x03' # <bidn> <vers> = <data>
 LKEY_VERS = b'\x04' # <bidn> <vers> = <versinfo>
 LKEY_INFO_BYTYPE = b'\x05' # <type> 00 <bidn> = 01
+LKEY_TYPE_VERS = b'\x06' # <type> = <uint64>
 
 rootdir = '00000000000000000000000000000000'
 
@@ -60,24 +61,36 @@ class Drive(s_base.Base):
 
         return [reqValidName(p.strip().lower()) for p in path]
 
-    def getItemInfo(self, iden):
-        return self._getItemInfo(s_common.uhex(iden))
+    def _reqInfoType(self, info, typename):
+        infotype = info.get('type')
+        if infotype != typename:
+            mesg = f'Drive item has the wrong type. Expected: {typename} got {infotype}.'
+            raise s_exc.TypeMismatch(mesg=mesg, expected=typename, got=infotype)
+
+    def getItemInfo(self, iden, typename=None):
+        info = self._getItemInfo(s_common.uhex(iden))
+        if typename is not None:
+            self._reqInfoType(info, typename)
+        return info
 
     def _getItemInfo(self, bidn):
         byts = self.slab.get(LKEY_INFO + bidn, db=self.dbname)
         if byts is not None:
             return s_msgpack.un(byts)
 
-    def reqItemInfo(self, iden):
-        return self._reqItemInfo(s_common.uhex(iden))
+    def reqItemInfo(self, iden, typename=None):
+        return self._reqItemInfo(s_common.uhex(iden), typename=typename)
 
-    def _reqItemInfo(self, bidn):
+    def _reqItemInfo(self, bidn, typename=None):
         info = self._getItemInfo(bidn)
-        if info is not None:
-            return info
+        if info is None:
+            mesg = f'No drive item with ID {s_common.ehex(bidn)}.'
+            raise s_exc.NoSuchIden(mesg=mesg)
 
-        mesg = f'No drive item with ID {s_common.ehex(bidn)}.'
-        raise s_exc.NoSuchIden(mesg=mesg)
+        if typename is not None:
+            self._reqInfoType(info, typename)
+
+        return info
 
     async def setItemPath(self, iden, path):
         '''
@@ -494,10 +507,27 @@ class Drive(s_base.Base):
         if byts is not None:
             return s_msgpack.un(byts)
 
-    async def setTypeSchema(self, typename, schema, callback=None):
+    def getTypeSchemaVersion(self, typename):
+        verskey = LKEY_TYPE_VERS + typename.encode()
+        byts = self.slab.get(verskey, db=self.dbname)
+        if byts is not None:
+            return s_msgpack.un(byts)
+
+    async def setTypeSchema(self, typename, schema, callback=None, vers=None):
 
         reqValidName(typename)
 
+        if vers is not None:
+            vers = int(vers)
+            curv = self.getTypeSchemaVersion(typename)
+            if curv is not None:
+                if vers == curv:
+                    return False
+
+                if vers < curv:
+                    mesg = f'Cannot downgrade drive schema version for type {typename}.'
+                    raise s_exc.BadVersion(mesg=mesg)
+
         vtor = s_config.getJsValidator(schema)
 
         self.validators[typename] = vtor
@@ -506,6 +536,10 @@ class Drive(s_base.Base):
 
         self.slab.put(lkey, s_msgpack.en(schema), db=self.dbname)
 
+        if vers is not None:
+            verskey = LKEY_TYPE_VERS + typename.encode()
+            self.slab.put(verskey, s_msgpack.en(vers), db=self.dbname)
+
         if callback is not None:
             async for info in self.getItemsByType(typename):
                 bidn = s_common.uhex(info.get('iden'))
@@ -516,6 +550,7 @@ class Drive(s_base.Base):
                     vtor(data)
                     self.slab.put(LKEY_DATA + bidn + versindx, s_msgpack.en(data), db=self.dbname)
                     await asyncio.sleep(0)
+        return True
 
     async def getItemsByType(self, typename):
         tkey = typename.encode() + b'\x00'

{synapse-2.185.0 → synapse-2.186.0}/synapse/lib/snap.py

@@ -1559,12 +1559,6 @@ class Snap(s_base.Base):
         return await self.tagnorms.aget(tagname)
 
     async def _getTagNorm(self, tagname):
-
-        if not self.core.isTagValid(tagname):
-            mesg = f'The tag ({tagname}) does not meet the regex for the tree.'
-            await self._raiseOnStrict(s_exc.BadTag, mesg)
-            return None
-
         try:
             return self.core.model.type('syn:tag').norm(tagname)
         except s_exc.BadTypeValu as e:

{synapse-2.185.0 → synapse-2.186.0}/synapse/lib/types.py

@@ -1903,6 +1903,12 @@ class Tag(Str):
             mesg = f'Tag does not match tagre: [{s_grammar.tagre.pattern}]'
             raise s_exc.BadTypeValu(valu=norm, name=self.name, mesg=mesg)
 
+        core = self.modl.core
+        if core is not None:
+            (ok, mesg) = core.isTagValid(norm)
+            if not ok:
+                raise s_exc.BadTypeValu(valu=norm, name=self.name, mesg=mesg)
+
         return norm, {'subs': subs, 'toks': toks}
 
     def _normPyStr(self, text):

{synapse-2.185.0 → synapse-2.186.0}/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, 185, 0)
+version = (2, 186, 0)
 verstring = '.'.join([str(x) for x in version])
-commit = 'c2ef0eded02f8ac5f34704a117947f44095f41f4'
+commit = 'ffa4abc52513d4b8ac592496322227eed9e07dc5'

{synapse-2.185.0 → synapse-2.186.0}/synapse/models/risk.py

@@ -351,6 +351,9 @@ class RiskModule(s_module.CoreModule):
                     ('mitre:attack:software', ('it:mitre:attack:software', {}), {
                         'doc': 'A mapping to a MITRE ATT&CK software if applicable.'}),
 
+                    ('id', ('str', {'strip': True}), {
+                        'doc': 'An ID for the tool.'}),
+
                 )),
                 ('risk:mitigation:type:taxonomy', {}, ()),
                 ('risk:mitigation', {}, (

{synapse-2.185.0 → synapse-2.186.0}/synapse/tests/test_cortex.py

@@ -7202,16 +7202,16 @@ class CortexBasicTest(s_t_utils.SynTest):
 
             nodes = await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.2021.12345 ]')
 
-            with self.raises(s_exc.BadTag):
+            with self.raises(s_exc.BadTypeValu):
                 await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.foo ]')
 
-            with self.raises(s_exc.BadTag):
+            with self.raises(s_exc.BadTypeValu):
                 await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.2021.hehe ]')
 
-            with self.raises(s_exc.BadTag):
+            with self.raises(s_exc.BadTypeValu):
                 await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.2021.123456 ]')
 
-            with self.raises(s_exc.BadTag):
+            with self.raises(s_exc.BadTypeValu):
                 await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.12345 ]')
 
             nodes = await core.nodes('[ test:str=beep +?#cno.cve.12345 ]')
@@ -7229,9 +7229,14 @@ class CortexBasicTest(s_t_utils.SynTest):
             await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.2021.hehe ]')
 
             await core.setTagModel('cno.cve', 'regex', (None, None, '[0-9]{4}', '[0-9]{5}'))
-            with self.raises(s_exc.BadTag):
+            with self.raises(s_exc.BadTypeValu):
                 await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.2021.haha ]')
 
+            self.eq((False, None), await core.callStorm('return($lib.trycast(syn:tag, cno.cve.2021.haha))'))
+
+            with self.raises(s_exc.BadTypeValu):
+                await core.callStorm('return($lib.cast(syn:tag, cno.cve.2021.haha))')
+
             self.none(await core.callStorm('$lib.model.tags.del(cno.cve)'))
             self.none(await core.callStorm('return($lib.model.tags.get(cno.cve))'))
 

{synapse-2.185.0 → synapse-2.186.0}/synapse/tests/test_lib_base.py

@@ -378,7 +378,7 @@ class BaseTest(s_t_utils.SynTest):
         proc = ctx.Process(target=block_processing, args=(evt1,))
         proc.start()
 
-        self.true(evt1.wait(timeout=10))
+        self.true(evt1.wait(timeout=30))
         os.kill(proc.pid, signal.SIGTERM)
         proc.join(timeout=10)
         self.eq(proc.exitcode, 137)
@@ -396,7 +396,7 @@ class BaseTest(s_t_utils.SynTest):
         proc = ctx.Process(target=block_processing, args=(evt1,))
         proc.start()
 
-        self.true(evt1.wait(timeout=10))
+        self.true(evt1.wait(timeout=30))
         os.kill(proc.pid, signal.SIGINT)
 
         proc.join(timeout=10)

{synapse-2.185.0 → synapse-2.186.0}/synapse/tests/test_lib_cell.py

@@ -208,7 +208,12 @@ class CellTest(s_t_utils.SynTest):
 
             # TODO how to handle iden match with additional property mismatch
 
-            await cell.drive.setTypeSchema('woot', testDataSchema_v0)
+            self.true(await cell.drive.setTypeSchema('woot', testDataSchema_v0, vers=0))
+            self.true(await cell.drive.setTypeSchema('woot', testDataSchema_v0, vers=1))
+            self.false(await cell.drive.setTypeSchema('woot', testDataSchema_v0, vers=1))
+
+            with self.raises(s_exc.BadVersion):
+                await cell.drive.setTypeSchema('woot', testDataSchema_v0, vers=0)
 
             info = {'name': 'win32k.sys', 'type': 'woot'}
             info = await cell.addDriveItem(info, reldir=rootdir)
@@ -284,6 +289,12 @@ class CellTest(s_t_utils.SynTest):
             versinfo, data = await cell.getDriveData(iden, vers=(1, 1, 0))
             self.eq('woot', data.get('woot'))
 
+            with self.raises(s_exc.NoSuchIden):
+                await cell.reqDriveInfo('d7d6107b200e2c039540fc627bc5537d')
+
+            with self.raises(s_exc.TypeMismatch):
+                await cell.getDriveInfo(iden, typename='newp')
+
             self.nn(await cell.getDriveInfo(iden))
             self.len(2, [vers async for vers in cell.getDriveDataVersions(iden)])
 
@@ -1899,7 +1910,7 @@ class CellTest(s_t_utils.SynTest):
             proc = ctx.Process(target=lock_target, args=(dirn, evt1,))
             proc.start()
 
-            self.true(evt1.wait(timeout=10))
+            self.true(evt1.wait(timeout=30))
 
             with self.raises(s_exc.FatalErr) as cm:
                 async with await s_cell.Cell.anit(dirn) as cell:
@@ -2600,7 +2611,7 @@ class CellTest(s_t_utils.SynTest):
             proc = ctx.Process(target=reload_target, args=(dirn, evt1, evt2))
             proc.start()
 
-            self.true(evt1.wait(timeout=10))
+            self.true(evt1.wait(timeout=30))
 
             async with await s_telepath.openurl(f'cell://{dirn}') as prox:
                 cnfo = await prox.getCellInfo()
@@ -3016,7 +3027,7 @@ class CellTest(s_t_utils.SynTest):
                 self.eq(users, s_t_utils.deguidify(json.dumps(await core.callStorm('return($lib.auth.users.list())'))))
                 self.eq(gates, s_t_utils.deguidify(json.dumps(await core.callStorm('return($lib.auth.gates.list())'))))
 
-                with self.raises(s_exc.BadTag):
+                with self.raises(s_exc.BadTypeValu):
                     await core.nodes('[ it:dev:str=foo +#test.newp ]')
 
         stream.seek(0)

{synapse-2.185.0 → synapse-2.186.0}/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-2.186.0/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-2.185.0 → synapse-2.186.0}/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-2.185.0 → synapse-2.186.0}/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-2.185.0 → synapse-2.186.0}/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-2.185.0 → synapse-2.186.0}/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-2.185.0 → synapse-2.186.0}/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-2.185.0 → synapse-2.186.0}/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-2.185.0 → synapse-2.186.0}/synapse/tools/promote.py

@@ -18,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)

synapse-2.186.0/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.185.0 → synapse-2.186.0/synapse.egg-info}/PKG-INFO

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