synapse 2.224.0__py311-none-any.whl → 2.225.0__py311-none-any.whl

synapse/tests/{test_tools_easycert.py → test_tools_utils_easycert.py}

@@ -5,31 +5,31 @@ import os
 import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.tests.utils as s_t_utils
-import synapse.tools.easycert as s_easycert
+import synapse.tools.utils.easycert as s_easycert
 
 
 class TestEasyCert(s_t_utils.SynTest):
 
-    def make_testca(self, path):
+    async def make_testca(self, path):
         '''
         Helper for making a testca named "testca"
         '''
         outp = self.getTestOutp()
         argv = ['--ca', '--certdir', path, 'testca']
-        self.eq(s_easycert.main(argv, outp=outp), 0)
+        self.eq(await s_easycert.main(argv, outp=outp), 0)
         self.true(outp.expect('key saved'))
         self.true(outp.expect('testca.key'))
         self.true(outp.expect('cert saved'))
         self.true(outp.expect('testca.crt'))
 
-    def test_easycert_user_p12(self):
+    async def test_easycert_user_p12(self):
         with self.getTestDir() as path:
 
-            self.make_testca(path)
+            await self.make_testca(path)
 
             outp = self.getTestOutp()
             argv = ['--certdir', path, '--signas', 'testca', 'user@test.com']
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('key saved'))
             self.true(outp.expect('user@test.com.key'))
             self.true(outp.expect('cert saved'))
@@ -37,42 +37,42 @@ class TestEasyCert(s_t_utils.SynTest):
 
             outp = self.getTestOutp()
             argv = ['--certdir', path, '--p12', 'user@test.com']
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('client cert saved'))
             self.true(outp.expect('user@test.com.p12'))
 
-    def test_easycert_user_sign(self):
+    async def test_easycert_user_sign(self):
         with self.getTestDir() as path:
 
-            self.make_testca(path)
+            await self.make_testca(path)
 
             outp = self.getTestOutp()
             argv = ['--certdir', path, '--signas', 'testca', 'user@test.com']
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('key saved'))
             self.true(outp.expect('user@test.com.key'))
             self.true(outp.expect('cert saved'))
             self.true(outp.expect('user@test.com.crt'))
 
-    def test_easycert_server_sign(self):
+    async def test_easycert_server_sign(self):
         with self.getTestDir() as path:
 
-            self.make_testca(path)
+            await self.make_testca(path)
 
             outp = self.getTestOutp()
             argv = ['--certdir', path, '--signas', 'testca', '--server', 'test.vertex.link']
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('key saved'))
             self.true(outp.expect('test.vertex.link.key'))
             self.true(outp.expect('cert saved'))
             self.true(outp.expect('test.vertex.link.crt'))
 
-    def test_easycert_csr(self):
+    async def test_easycert_csr(self):
         with self.getTestDir() as path:
 
             outp = self.getTestOutp()
             argv = ['--csr', '--certdir', path, 'user@test.com']
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('key saved'))
             self.true(outp.expect('user@test.com.key'))
             self.true(outp.expect('csr saved'))
@@ -81,7 +81,7 @@ class TestEasyCert(s_t_utils.SynTest):
             # Generate a server CSR
             outp = self.getTestOutp()
             argv = ['--csr', '--certdir', path, 'wwww.vertex.link', '--server']
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('key saved'))
             self.true(outp.expect('www.vertex.link.key'))
             self.true(outp.expect('csr saved'))
@@ -89,22 +89,23 @@ class TestEasyCert(s_t_utils.SynTest):
 
             outp = self.getTestOutp()
             argv = ['--csr', '--certdir', path, 'intermed', '--ca']
-            self.raises(NotImplementedError, s_easycert.main, argv, outp=outp)
+            with self.raises(NotImplementedError):
+                await s_easycert.main(argv, outp=outp)
 
             # Ensure that duplicate files won't be overwritten
             outp = self.getTestOutp()
             argv = ['--csr', '--certdir', path, 'user@test.com']
-            self.eq(s_easycert.main(argv, outp=outp), 1)
+            self.eq(await s_easycert.main(argv, outp=outp), 1)
             self.true(outp.expect('file exists:'))
             self.true(outp.expect('user@test.com.key'))
 
-            self.make_testca(path)
+            await self.make_testca(path)
 
             # Sign the user csr
             outp = self.getTestOutp()
             csrpath = os.path.join(path, 'users', 'user@test.com.csr')
             argv = ['--certdir', path, '--signas', 'testca', '--sign-csr', csrpath, ]
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('cert saved:'))
             self.true(outp.expect('user@test.com.crt'))
 
@@ -112,23 +113,23 @@ class TestEasyCert(s_t_utils.SynTest):
             outp = self.getTestOutp()
             csrpath = os.path.join(path, 'hosts', 'wwww.vertex.link.csr')
             argv = ['--certdir', path, '--signas', 'testca', '--sign-csr', csrpath, '--server']
-            self.eq(s_easycert.main(argv, outp=outp), 0)
+            self.eq(await s_easycert.main(argv, outp=outp), 0)
             self.true(outp.expect('cert saved:'))
             self.true(outp.expect('www.vertex.link.crt'))
 
             # test nonexistent csr
             outp = self.getTestOutp()
             argv = ['--certdir', path, '--signas', 'testca', '--sign-csr', 'lololol', ]
-            self.eq(s_easycert.main(argv, outp=outp), 1)
+            self.eq(await s_easycert.main(argv, outp=outp), 1)
             self.true(outp.expect('csr not found: lololol'))
 
             # Test bad input
             outp = self.getTestOutp()
             argv = ['--certdir', path, '--sign-csr', 'lololol', ]
-            self.eq(s_easycert.main(argv, outp=outp), 1)
+            self.eq(await s_easycert.main(argv, outp=outp), 1)
             self.true(outp.expect('--sign-csr requires --signas'))
 
-    def test_easycert_importfile(self):
+    async def test_easycert_importfile(self):
         with self.getTestDir() as tstpath:
 
             outp = self.getTestOutp()
@@ -137,7 +138,7 @@ class TestEasyCert(s_t_utils.SynTest):
             ftype = 'cas'
             argv = ['--importfile', ftype, '--certdir', tstpath, srcpath]
             with s_common.genfile(srcpath) as fd:
-                self.eq(s_easycert.main(argv, outp=outp), 0)
+                self.eq(await s_easycert.main(argv, outp=outp), 0)
 
             outp = self.getTestOutp()
             fname = 'pennywise@vertex.link.crt'
@@ -145,69 +146,70 @@ class TestEasyCert(s_t_utils.SynTest):
             ftype = 'cas'
             argv = ['--importfile', ftype, '--certdir', tstpath, srcpath]
             with s_common.genfile(srcpath) as fd:
-                self.eq(s_easycert.main(argv, outp=outp), 0)
+                self.eq(await s_easycert.main(argv, outp=outp), 0)
 
             outp = self.getTestOutp()
             argv = ['--importfile', 'cas', '--certdir', tstpath, 'nope']
-            self.raises(s_exc.NoSuchFile, s_easycert.main, argv, outp=outp)
+            with self.raises(s_exc.NoSuchFile):
+                await s_easycert.main(argv, outp=outp)
 
-    def test_easycert_code(self):
+    async def test_easycert_code(self):
         with self.getTestDir() as dirn:
             outp = self.getTestOutp()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--ca', 'woot'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--ca', 'woot'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--code', 'wootpipe', '--signas', 'woot'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--code', 'wootpipe', '--signas', 'woot'), outp=outp))
             outp.expect('code/wootpipe.crt')
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--code', 'selfpipe'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--code', 'selfpipe'), outp=outp))
             outp.expect('code/selfpipe.crt')
 
-    def test_easycert_revokeas(self):
+    async def test_easycert_revokeas(self):
 
         with self.getTestDir() as dirn:
             outp = self.getTestOutp()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--ca', 'woot'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--ca', 'woot'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--ca', 'inner', '--signas', 'woot'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--ca', 'inner', '--signas', 'woot'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--crl', 'woot'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--crl', 'woot'), outp=outp))
             outp.expect('CRL saved:')
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--signas', 'woot', 'newp@newp.newp'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--signas', 'woot', 'newp@newp.newp'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--signas', 'woot', '--code', 'testpipe'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--signas', 'woot', '--code', 'testpipe'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--signas', 'woot', '--server', 'newp.newp'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--signas', 'woot', '--server', 'newp.newp'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', 'newp@newp.newp'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', 'newp@newp.newp'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', '--server', 'newp.newp'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', '--server', 'newp.newp'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', '--ca', 'inner'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', '--ca', 'inner'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', '--code', 'testpipe'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', '--code', 'testpipe'), outp=outp))
 
             outp.clear()
-            self.eq(1, s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', 'noexist'), outp=outp))
+            self.eq(1, await s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', 'noexist'), outp=outp))
             outp.expect('Certificate not found: noexist')
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--ca', 'dude'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--ca', 'dude'), outp=outp))
 
             outp.clear()
-            self.eq(0, s_easycert.main(('--certdir', dirn, '--signas', 'dude', 'giggle@dude.dude'), outp=outp))
+            self.eq(0, await s_easycert.main(('--certdir', dirn, '--signas', 'dude', 'giggle@dude.dude'), outp=outp))
 
             outp.clear()
-            self.eq(1, s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', 'giggle@dude.dude'), outp=outp))
+            self.eq(1, await s_easycert.main(('--certdir', dirn, '--revokeas', 'woot', 'giggle@dude.dude'), outp=outp))
             outp.expect('Failed to validate that certificate was signed by woot')

synapse/tests/{test_tools_guid.py → test_tools_utils_guid.py}

@@ -1,12 +1,12 @@
 import synapse.common as s_common
 
 import synapse.tests.utils as s_t_utils
-import synapse.tools.guid as s_guid
+import synapse.tools.utils.guid as s_guid
 
 class TestGuid(s_t_utils.SynTest):
 
-    def test_tools_guid(self):
+    async def test_tools_guid(self):
         argv = []
         outp = self.getTestOutp()
-        s_guid.main(argv, outp=outp)
+        await s_guid.main(argv, outp=outp)
         self.true(s_common.isguid(str(outp)))

synapse/tests/{test_tools_json2mpk.py → test_tools_utils_json2mpk.py}

@@ -1,12 +1,12 @@
 import os
 
-import synapse.tools.json2mpk as s_json2mpk
+import synapse.tools.utils.json2mpk as s_json2mpk
 
 import synapse.tests.utils as s_t_utils
 
 class Json2MpkTest(s_t_utils.SynTest):
 
-    def test_tools_json2mpk(self):
+    async def test_tools_json2mpk(self):
 
         with self.getTestDir() as ndir:
 
@@ -25,7 +25,7 @@ class Json2MpkTest(s_t_utils.SynTest):
 
             args = ['--rm', path, fake, html]
 
-            s_json2mpk.main(args, outp=outp)
+            await s_json2mpk.main(args, outp=outp)
 
             with open(newp, 'rb') as fd:
                 self.eq(fd.read(), b'\x81\xa3foo\n\x81\xa3bar\x14')

synapse/tests/{test_tools_rstorm.py → test_tools_utils_rstorm.py}

@@ -2,7 +2,7 @@ import synapse.exc as s_exc
 
 import synapse.common as s_common
 
-import synapse.tools.rstorm as s_rstorm
+import synapse.tools.utils.rstorm as s_rstorm
 
 import synapse.tests.utils as s_test
 import synapse.tests.test_lib_rstorm as s_test_rstorm
@@ -26,6 +26,11 @@ class RStormToolTest(s_test.SynTest):
 
             self.eq(text, s_test_rstorm.rst_out)
 
+            outp = self.getTestOutp()
+            await s_rstorm.main((path,), outp=outp)
+            text = ''.join(outp.mesgs)
+            self.eq(text, s_test_rstorm.rst_out)
+
             # debug output
             path = s_common.genpath(dirn, 'test2.rst')
             with s_common.genfile(path) as fd:

synapse/tests/utils.py

@@ -76,7 +76,7 @@ import synapse.lib.thishost as s_thishost
 import synapse.lib.structlog as s_structlog
 import synapse.lib.stormtypes as s_stormtypes
 
-import synapse.tools.genpkg as s_genpkg
+import synapse.tools.storm.pkg.gen as s_genpkg
 
 logger = logging.getLogger(__name__)
 
@@ -906,6 +906,8 @@ class HttpReflector(s_httpapi.Handler):
         self.sendRestRetn(resp)
 
     async def post(self):
+        self.set_header('Giant', 'x' * 64_000)
+
         resp = {}
         params = self._decode_params()
         if params:

synapse/tools/apikey.py

@@ -1,90 +1,11 @@
-import synapse.exc as s_exc
-import synapse.telepath as s_telepath
+import synapse.common as s_common
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.time as s_time
-import synapse.lib.output as s_output
 
-descr = '''
-Add, list, or delete user API keys from a Synapse service.
-'''
+from synapse.tools.service.apikey import main
 
-def printkey(outp, info, apikey=None):
-    iden = info.get('iden')
-    name = info.get('name')
-    created = info.get('created')
-    updated = info.get('updated')
-    expires = info.get('expires')
-
-    outp.printf(f'Iden: {iden}')
-    if apikey:
-        outp.printf(f'  API Key: {apikey}')
-    outp.printf(f'  Name: {name}')
-    outp.printf(f'  Created: {s_time.repr(created)}')
-    outp.printf(f'  Updated: {s_time.repr(updated)}')
-    if expires:
-        outp.printf(f'  Expires: {s_time.repr(expires)}')
-
-    outp.printf('')
-
-async def main(argv, outp=s_output.stdout):
-
-    pars = s_cmd.Parser(prog='synapse.tools.apikey', outp=outp, description=descr)
-    pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
-
-    subpars = pars.add_subparsers(dest='action', required=True)
-
-    addp = subpars.add_parser('add', help='Add a user API key.')
-    addp.add_argument('-d', '--duration', type=int, help='The duration of the API key in seconds.')
-    addp.add_argument('-u', '--username', type=str, help='The username to add an API key to (restricted to admins).')
-    addp.add_argument('name', help='The name of the API key to add.')
-
-    listp = subpars.add_parser('list', help='List user API keys.')
-    listp.add_argument('-u', '--username', type=str, help='The username to list API keys for (restricted to admins).')
-
-    delp = subpars.add_parser('del', help='Delete a user API key.')
-    delp.add_argument('iden', help='The iden of the API key to delete.')
-
-    opts = pars.parse_args(argv)
-
-    async with s_telepath.withTeleEnv():
-
-        async with await s_telepath.openurl(opts.svcurl) as cell:
-
-            try:
-                useriden = None
-                if opts.action in ('add', 'list') and opts.username:
-                    user = await cell.getUserInfo(opts.username)
-                    useriden = user.get('iden')
-
-                if opts.action == 'add':
-                    if (duration := opts.duration) is not None:
-                        # Convert from seconds to milliseconds
-                        duration *= 1000
-
-                    apikey, info = await cell.addUserApiKey(opts.name, duration=duration, useriden=useriden)
-                    outp.printf(f'Successfully added API key with name={opts.name}.')
-                    printkey(outp, info, apikey)
-
-                elif opts.action == 'del':
-                    await cell.delUserApiKey(opts.iden)
-                    outp.printf(f'Successfully deleted API key with iden={opts.iden}.')
-
-                elif opts.action == 'list':
-                    apikeys = await cell.listUserApiKeys(useriden=useriden)
-                    if not apikeys:
-                        outp.printf('No API keys found.')
-                        return 0
-
-                    for info in apikeys:
-                        printkey(outp, info)
-
-            except s_exc.SynErr as exc:
-                mesg = exc.get('mesg')
-                outp.printf(f'ERROR: {exc.__class__.__name__}: {mesg}')
-                return 1
-
-    return 0
+s_common.deprecated('synapse.tools.apikey is deprecated. Please use synapse.tools.service.apikey instead.',
+                    curv='v2.225.0')
 
 if __name__ == '__main__':  # pragma: no cover
     s_cmd.exitmain(main)