synapse 2.214.0__py311-none-any.whl → 2.216.0__py311-none-any.whl

synapse/tools/csvtool.py

@@ -1,7 +1,4 @@
 import csv
-import sys
-import asyncio
-import contextlib
 
 import synapse.exc as s_exc
 import synapse.cortex as s_cortex
@@ -16,6 +13,44 @@ import synapse.lib.output as s_output
 import synapse.lib.version as s_version
 
 reqver = '>=0.2.0,<3.0.0'
+desc = '''Command line tool for ingesting csv files into a cortex
+
+The storm file is run with the CSV rows specified in the variable "rows" so most
+storm files will use a variable based for loop to create edit nodes.  For example:
+
+for ($fqdn, $ipv4, $tag) in $rows {
+
+    [ inet:dns:a=($fqdn, $ipv4) +#$tag ]
+
+}
+
+More advanced uses may include switch cases to provide different logic based on
+a column value.
+
+for ($type, $valu, $info) in $rows {
+
+    switch $type {
+
+        fqdn: {
+            [ inet:fqdn=$valu ]
+        }
+
+        "person name": {
+            [ ps:name=$valu ]
+        }
+
+        *: {
+            // default case...
+        }
+
+    }
+
+    switch $info {
+        "known malware": { [+#cno.mal] }
+    }
+
+}
+'''
 
 async def runCsvExport(opts, outp, text, stormopts):
     if not opts.cortex:
@@ -174,46 +209,7 @@ async def main(argv, outp=s_output.stdout):
             return await runCsvImport(opts, outp, text, stormopts)
 
 def makeargparser(outp):
-    desc = '''
-    Command line tool for ingesting csv files into a cortex
-
-    The storm file is run with the CSV rows specified in the variable "rows" so most
-    storm files will use a variable based for loop to create edit nodes.  For example:
-
-    for ($fqdn, $ipv4, $tag) in $rows {
-
-        [ inet:dns:a=($fqdn, $ipv4) +#$tag ]
-
-    }
-
-    More advanced uses may include switch cases to provide different logic based on
-    a column value.
-
-    for ($type, $valu, $info) in $rows {
-
-        switch $type {
-
-            fqdn: {
-                [ inet:fqdn=$valu ]
-            }
-
-            "person name": {
-                [ ps:name=$valu ]
-            }
-
-            *: {
-                // default case...
-            }
-
-        }
-
-        switch $info {
-            "known malware": { [+#cno.mal] }
-        }
-
-    }
-    '''
-    pars = s_cmd.Parser('synapse.tools.csvtool', description=desc, outp=outp)
+    pars = s_cmd.Parser(prog='synapse.tools.csvtool', description=desc, outp=outp)
     pars.add_argument('--logfile', help='Set a log file to get JSON lines from the server events.')
     pars.add_argument('--csv-header', default=False, action='store_true',
                       help='Skip the first line from each CSV file.')
@@ -235,10 +231,5 @@ def makeargparser(outp):
     pars.add_argument('csvfiles', nargs='+', help='CSV files to load.')
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/demote.py

@@ -1,7 +1,3 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.exc as s_exc
 
 import synapse.telepath as s_telepath
@@ -19,8 +15,7 @@ Example:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.demote', description=descr,
-                        formatter_class=argparse.RawDescriptionHelpFormatter)
+    pars = s_cmd.Parser(prog='synapse.tools.demote', outp=outp, description=descr)
 
     pars.add_argument('--url', default='cell:///vertex/storage',
                       help='The telepath URL of the Synapse service.')

synapse/tools/docker/validate.py

@@ -1,4 +1,3 @@
-import os
 import re
 import sys
 import base64

synapse/tools/easycert.py

@@ -1,9 +1,7 @@
-
-import sys
 import argparse
 
-
 import synapse.exc as s_exc
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 import synapse.lib.certdir as s_certdir
 
@@ -11,10 +9,7 @@ descr = '''
 Command line tool to generate simple x509 certs
 '''
 
-def main(argv, outp=None):
-
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
+def main(argv, outp=s_output.stdout):
 
     pars = argparse.ArgumentParser(prog='easycert', description=descr)
     pars.add_argument('--certdir', default='~/.syn/certs', help='Directory for certs/keys')
@@ -138,4 +133,4 @@ def main(argv, outp=None):
         return 1
 
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(main(sys.argv[1:]))
+    s_cmd.exitmain(main)

synapse/tools/feed.py

@@ -1,17 +1,14 @@
 import os
-import sys
 import time
-import asyncio
 import logging
-import argparse
 
 import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.cortex as s_cortex
 import synapse.telepath as s_telepath
 
+import synapse.lib.cmd as s_cmd
 import synapse.lib.cmdr as s_cmdr
-import synapse.lib.coro as s_coro
 import synapse.lib.json as s_json
 import synapse.lib.output as s_output
 import synapse.lib.msgpack as s_msgpack
@@ -79,12 +76,9 @@ async def addFeedData(core, outp, feedformat, debug=False, *paths, chunksize=100
     if debug:
         await s_cmdr.runItemCmdr(core, outp, True)
 
-async def main(argv, outp=None):
+async def main(argv, outp=s_output.stdout):
 
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
-    pars = makeargparser()
+    pars = getArgParser(outp)
     opts = pars.parse_args(argv)
 
     if opts.offset:
@@ -124,9 +118,9 @@ async def main(argv, outp=None):
 
     return 0
 
-def makeargparser():
+def getArgParser(outp):
     desc = 'Command line tool for ingesting data into a cortex'
-    pars = argparse.ArgumentParser('synapse.tools.feed', description=desc)
+    pars = s_cmd.Parser(prog='synapse.tools.feed', outp=outp, description=desc)
 
     muxp = pars.add_mutually_exclusive_group(required=True)
     muxp.add_argument('--cortex', '-c', type=str,
@@ -150,11 +144,6 @@ def makeargparser():
 
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    s_common.setlogging(logger, 'DEBUG')
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_common.setlogging(logger, 'DEBUG')
+    s_cmd.exitmain(main)

synapse/tools/genpkg.py

@@ -1,10 +1,7 @@
 import io
 import os
-import sys
 import base64
-import asyncio
 import logging
-import argparse
 
 import regex
 
@@ -12,7 +9,7 @@ import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.json as s_json
 import synapse.lib.output as s_output
 import synapse.lib.certdir as s_certdir
@@ -238,12 +235,11 @@ def loadPkgProto(path, opticdir=None, no_docs=False, readonly=False):
     return pkgdef
 
 
-prog = 'synapse.tools.genpkg'
 desc = 'A tool for generating/pushing storm packages from YAML prototypes.'
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser()
+    pars = s_cmd.Parser(prog='synapse.tools.genpkg', outp=outp, description=desc)
     pars.add_argument('--push', metavar='<url>', help='A telepath URL of a Cortex or PkgRepo.')
     pars.add_argument('--push-verify', default=False, action='store_true',
                       help='Tell the Cortex to verify the package signature.')
@@ -306,10 +302,5 @@ async def main(argv, outp=s_output.stdout):
 
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/guid.py

@@ -1,12 +1,10 @@
+import sys
+
 import synapse.common as s_common
 import synapse.lib.output as s_output
 
-def main(argv, outp=None):
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
+def main(argv, outp=s_output.stdout):
     outp.printf(s_common.guid())
 
 if __name__ == '__main__':  # pragma: no cover
-    import sys
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

synapse/tools/healthcheck.py

@@ -1,4 +1,3 @@
-import sys
 import socket
 import asyncio
 
@@ -7,7 +6,6 @@ import synapse.common as s_common
 import synapse.telepath as s_telepath
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.coro as s_coro
 import synapse.lib.json as s_json
 import synapse.lib.output as s_output
 import synapse.lib.health as s_health
@@ -30,7 +28,7 @@ def format_component(e, mesg: str) -> dict:
     return d
 
 async def main(argv, outp=s_output.stdout):
-    pars = makeargparser()
+    pars = getArgParser(outp)
     try:
         opts = pars.parse_args(argv)
     except s_exc.ParserExit as e:  # pragma: no cover
@@ -96,21 +94,16 @@ async def main(argv, outp=s_output.stdout):
     outp.printf(serialize(ret))
     return retval
 
-def makeargparser():
+def getArgParser(outp):
     desc = '''
     synapse healthcheck tool
     '''
-    pars = s_cmd.Parser('healthcheck', description=desc)
+    pars = s_cmd.Parser(prog='synapse.tools.healthcheck', outp=outp, description=desc)
     pars.add_argument('--cell', '-c', required=True, type=str,
                       help='Telepath path to the cell to check.')
     pars.add_argument('--timeout', '-t', default=10, type=float,
                       help='Connection and call timeout')
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/json2mpk.py

@@ -12,11 +12,7 @@ def getArgParser():
     pars.add_argument('paths', nargs='+', help='json files or directories full of json files')
     return pars
 
-def main(argv, outp=None):
-
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
+def main(argv, outp=s_output.stdout):
     pars = getArgParser()
     opts = pars.parse_args(argv)
 

synapse/tools/livebackup.py

@@ -1,10 +1,6 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
 descr = '''
@@ -19,8 +15,7 @@ Examples:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.livebackup', description=descr,
-                        formatter_class=argparse.RawDescriptionHelpFormatter)
+    pars = s_cmd.Parser(prog='synapse.tools.livebackup', outp=outp, description=descr)
 
     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.')
@@ -35,10 +30,5 @@ async def main(argv, outp=s_output.stdout):
             outp.printf(f'...backup created: {name}')
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/modrole.py

@@ -1,11 +1,7 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
 descr = '''
@@ -30,7 +26,7 @@ def printrole(role, outp):
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='modrole', description=descr)
+    pars = s_cmd.Parser(prog='synapse.tools.modrole', outp=outp, description=descr)
     pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
     pars.add_argument('--add', default=False, action='store_true', help='Add the role if they do not already exist.')
     pars.add_argument('--del', dest='delete', default=False, action='store_true', help='Delete the role if it exists.')
@@ -116,10 +112,5 @@ async def main(argv, outp=s_output.stdout):
                     await cell.addRoleRule(roleiden, (False, perm), indx=0, gateiden=opts.gate)
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/moduser.py

@@ -1,11 +1,7 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
 descr = '''
@@ -41,7 +37,7 @@ def printuser(user, outp):
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='moduser', description=descr)
+    pars = s_cmd.Parser(prog='synapse.tools.moduser', outp=outp, description=descr)
     pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
     pars.add_argument('--add', default=False, action='store_true', help='Add the user if they do not already exist.')
     pars.add_argument('--del', dest='delete', default=False, action='store_true', help='Delete the user if they exist.')
@@ -187,10 +183,5 @@ async def main(argv, outp=s_output.stdout):
                     await cell.addUserRule(useriden, (False, perm), indx=0, gateiden=opts.gate)
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/pkgs/gendocs.py

@@ -28,7 +28,7 @@ def hasPandoc():
         return True
     return False
 
-async def buildPkgDocs(outp: s_output.OutPut, pkgpath: str, rst_only: bool =False):
+async def buildPkgDocs(outp, pkgpath: str, rst_only: bool =False):
 
     logger.info(f'Building pkg for {pkgpath}')
     pkgdef = s_common.yamlload(pkgpath)

synapse/tools/promote.py

@@ -1,12 +1,8 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.exc as s_exc
 
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 import synapse.lib.urlhelp as s_urlhelp
 
@@ -19,8 +15,7 @@ Example (being run from a Cortex mirror docker container):
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.promote', description=descr,
-                        formatter_class=argparse.RawDescriptionHelpFormatter)
+    pars = s_cmd.Parser(prog='synapse.tools.promote', outp=outp, description=descr)
 
     pars.add_argument('--svcurl', default='cell:///vertex/storage',
                       help='The telepath URL of the Synapse service.')
@@ -49,10 +44,5 @@ async def main(argv, outp=s_output.stdout):
 
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/pullfile.py

@@ -1,23 +1,16 @@
-import sys
-import asyncio
 import pathlib
-import argparse
 
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
 
-async def main(argv, outp=None):
-
-    pars = setup()
+async def main(argv, outp=s_output.stdout):
+    pars = getArgParser(outp)
     opts = pars.parse_args(argv)
 
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
     if opts.output is None:
         opts.output = '.'
 
@@ -55,9 +48,9 @@ async def main(argv, outp=None):
     return 0
 
 
-def setup():
+def getArgParser(outp):
     desc = 'Fetches file from the given axon'
-    pars = argparse.ArgumentParser('synapse.tools.pullfile', description=desc)
+    pars = s_cmd.Parser(prog='synapse.tools.pullfile', outp=outp, description=desc)
     pars.add_argument('-a', '--axon', type=str, dest='axon', required=True,
                       help='URL to the axon blob store')
     pars.add_argument('-o', '--output', type=str, dest='output',
@@ -67,10 +60,5 @@ def setup():
 
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/pushfile.py

@@ -1,27 +1,20 @@
 import os
-import sys
 import glob
-import asyncio
 import logging
-import argparse
 
 import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 import synapse.lib.hashset as s_hashset
 
 logger = logging.getLogger(__name__)
 
 
-async def main(argv, outp=None):
-
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
-    pars = makeargparser()
+async def main(argv, outp=s_output.stdout):
+    pars = getArgParser(outp)
     opts = pars.parse_args(argv)
 
     async with s_telepath.withTeleEnv():
@@ -111,10 +104,10 @@ async def main(argv, outp=None):
 
     return 0
 
-def makeargparser():
+def getArgParser(outp):
     desc = 'Command line tool for uploading files to an Axon and making ' \
            'file:bytes in a Cortex.'
-    pars = argparse.ArgumentParser('synapse.tools.pushfile', description=desc)
+    pars = s_cmd.Parser(prog='synapse.tools.pushfile', outp=outp, description=desc)
     pars.add_argument('-a', '--axon', required=True, type=str, dest='axon',
                    help='URL for a target Axon to store files at.')
     pars.add_argument('-c', '--cortex', default=None, type=str, dest='cortex',
@@ -125,10 +118,5 @@ def makeargparser():
     pars.add_argument('-t', '--tags', help='comma separated list of tags to add to the nodes')
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/reload.py

@@ -1,10 +1,6 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 import synapse.lib.urlhelp as s_urlhelp
 
@@ -14,7 +10,7 @@ List or execute reload subsystems on a Synapse service.
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = getArgParser()
+    pars = getArgParser(outp)
     opts = pars.parse_args(argv)
 
     async with s_telepath.withTeleEnv():
@@ -55,8 +51,8 @@ async def main(argv, outp=s_output.stdout):
                         outp.printf(f'{name.ljust(40)}{result.ljust(10)}{mesg}')
     return 0
 
-def getArgParser():
-    pars = argparse.ArgumentParser(prog='reload', description=descr)
+def getArgParser(outp):
+    pars = s_cmd.Parser(prog='synapse.tools.reload', outp=outp, description=descr)
     pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
 
     subpars = pars.add_subparsers(required=True,
@@ -68,10 +64,5 @@ def getArgParser():
 
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/rstorm.py

@@ -1,11 +1,8 @@
-import sys
-import asyncio
 import logging
-import argparse
 
 import synapse.common as s_common
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 import synapse.lib.rstorm as s_rstorm
 
@@ -16,7 +13,7 @@ descr = 'An RST pre-processor that allows you to embed storm directives.'
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog=prog, description=descr)
+    pars = s_cmd.Parser(prog=prog, outp=outp, description=descr)
     pars.add_argument('rstfile', help='Input RST file with storm directives.')
     pars.add_argument('--save', help='Output file to save (default: stdout)')
 
@@ -33,11 +30,6 @@ async def main(argv, outp=s_output.stdout):
         for line in lines:
             outp.printf(line, addnl=False)
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
+if __name__ == '__main__':  # pragma: no cover
     s_common.setlogging(logger)
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
-if __name__ == '__main__':
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)