synapse 2.134.0__py311-none-any.whl → 2.136.0__py311-none-any.whl

synapse/lib/storm.lark

@@ -123,10 +123,10 @@ opervarlist: varlist "=" _valu
 
 // Pivots
 _formpivot: formpivot_pivottotags | formpivot_jointags | formpivot_pivotout | formpivot_
-formpivot_pivottotags: _RIGHTPIVOT (ALLTAGS | _tagmatch | _tagmatchwithspace)
-formpivot_jointags: _RIGHTJOIN (ALLTAGS | _tagmatch | _tagmatchwithspace)
+formpivot_pivottotags: _RIGHTPIVOT (ALLTAGS | tagmatch)
+formpivot_jointags: _RIGHTJOIN (ALLTAGS | tagmatch)
 // The special symbol that indicates to pivot to syn:tag nodes
-ALLTAGS.2: /#(?=\/[\/\*]|\s|$|\})/
+ALLTAGS.3: /#(?=\/[\/\*]|\s|$|\})/
 
 formpivot_pivotout:    _RIGHTPIVOT "*"
 formpivot_:            _RIGHTPIVOT ABSPROP
@@ -194,8 +194,6 @@ lifttagtag:(_HASH | _HASHSPACE) tagname [_cmpr _valu]
 liftbytag: (tagname | tagnamewithspace) [_cmpr _valu]
 liftbytagprop: (tagprop | tagpropwithspace) [_cmpr _valu]
 liftbyformtagprop: formtagprop [_cmpr _valu]
-tagname: _tagmatch
-tagnamewithspace: _tagmatchwithspace -> tagname
 tagprop: tagname _COLONNOSPACE (BASEPROP | _varvalu)
 tagpropwithspace: tagnamewithspace _COLONNOSPACE (BASEPROP | _varvalu) -> tagprop
 formtagprop: ((PROPS | UNIVNAME) | _DEREF _varvalu) tagname _COLONNOSPACE (BASEPROP | _varvalu)
@@ -228,16 +226,20 @@ EQNOSPACE: /(?<!\s)=(?!\s)/
 cmdrargs: _cmdrargv (EQNOSPACE? _cmdrargv)*
 _cmdrargv: baresubquery | DOUBLEQUOTEDSTRING | SINGLEQUOTEDSTRING | CMDRTOKN | CMDOPT (EQNOSPACE (CMDRTOKN | SINGLEQUOTEDSTRING | DOUBLEQUOTEDSTRING | baresubquery))?
 
-// A tag with either a variable reference or a tag name potentially with asterisks
-_tagmatch: _HASH (_varvalu | TAGMATCH)
+// A tag with either a variable reference or tag name segments without asterisks
+tagname: _HASH (_varvalu | _tagsegs)
+tagnamewithspace: _HASHSPACE (_varvalu | _tagsegs) -> tagname
 _HASH.2: /(?<!\s)#/
-
-_tagmatchwithspace: _HASHSPACE (_varvalu | TAGMATCH)
 _HASHSPACE.2: /(?<=\s)#/
+_tagsegs:  TAGSEGNOVAR ( "." (TAGSEGNOVAR | "$" varvalue))*
+TAGSEGNOVAR: /[\w]+/
 
 // A tag name with asterisks or $var as segment after the first segment
-TAGMATCH:  _TAGSEGNOVAR ( "." (_TAGSEGNOVAR | "$" VARTOKN))*
-_TAGSEGNOVAR: /[\w*]+/
+tagmatch: (_MATCHHASH | _MATCHHASHSPACE) (_varvalu | _wildtagsegs)
+_MATCHHASH.3: /(?<!\s)#/
+_MATCHHASHSPACE.3: /(?<=\s)#/
+_wildtagsegs:  WILDTAGSEGNOVAR ( "." (WILDTAGSEGNOVAR | "$" varvalue))*
+WILDTAGSEGNOVAR: /[\w*]+/
 
 // A comparison operator
 _cmpr: "*" BYNAME | CMPR | CMPROTHER | EQSPACE | EQNOSPACE | TRYSET | SETTAGOPER
@@ -260,9 +262,8 @@ _basevalu: _argvalu | baresubquery
 _valu: _basevalu | NONQUOTEWORD
 
 evalvalu: _valu
-exprdict: "{" ((_exprvalu | VARTOKN)  ":" (_exprvalu | VARTOKN) ("," (_exprvalu | VARTOKN) ":" (_exprvalu | VARTOKN))* ","? )? "}"
+exprdict: "{" ((_exprvalu | VARTOKN)  (":" | _EXPRCOLONNOSPACE) (_exprvalu | VARTOKN) ("," (_exprvalu | VARTOKN) (":" | _EXPRCOLONNOSPACE) (_exprvalu | VARTOKN))* ","? )? "}"
 exprlist: "[" ((_exprvalu | VARTOKN) ("," (_exprvalu | VARTOKN))* ","? )? "]"
-
 // Just like _valu, but doesn't allow valu lists or unquoted strings or queries
 _exprvalu: NUMBER | HEXNUMBER | BOOL | exprlist | exprdict | _exprvarvalu | exprrelpropvalu
     | exprunivpropvalu | exprtagvalu | exprtagpropvalu | TRIPLEQUOTEDSTRING | DOUBLEQUOTEDSTRING
@@ -286,18 +287,17 @@ EXPRUNIVNAME.2: /(?<=^|[\s\|\{\(\[+=-])\.[a-z_][a-z0-9_]*([:.][a-z0-9_]+)*/
 
 exprtagvalu: exprtagname -> tagvalu
     | exprtagnamewithspace -> tagvalu
-exprtagname: _exprtagmatch -> tagname
-_exprtagmatch: _EXPRHASH (_varvalu | TAGMATCH)
-_EXPRHASH.2: /(?<!\s)#/
 
-exprtagnamewithspace: _exprtagmatchwithspace -> tagname
-_exprtagmatchwithspace: _EXPRHASHSPACE (_varvalu | TAGMATCH)
-_EXPRHASHSPACE.2: /(?<=\s)#/
+exprtagname: _HASH (_exprvarvalu | _exprtagsegs) -> tagname
+exprtagnamewithspace: _HASHSPACE (_exprvarvalu | _exprtagsegs) -> tagname
+_exprtagsegs:  EXPRTAGSEGNOVAR ( "." (EXPRTAGSEGNOVAR | "$" exprvarvalue))*
+EXPRTAGSEGNOVAR: /[\w]+/
 
 exprtagpropvalu: exprtagprop -> tagpropvalu
     | exprtagpropwithspace -> tagpropvalu
-exprtagprop: exprtagname _COLONNOSPACE (BASEPROP | _exprvarvalu) -> tagprop
-exprtagpropwithspace: exprtagnamewithspace _COLONNOSPACE (BASEPROP | _exprvarvalu) -> tagprop
+exprtagprop: exprtagname _EXPRCOLONNOSPACE (BASEPROP | _exprvarvalu) -> tagprop
+exprtagpropwithspace: exprtagnamewithspace _EXPRCOLONNOSPACE (BASEPROP | _exprvarvalu) -> tagprop
+_EXPRCOLONNOSPACE.2: /(?<!\s):/
 
 _exprvarvalu: "$" _exprvarvaluatom
 _exprvarvaluatom: exprvarvalue | exprvarderef | exprfunccall
@@ -372,11 +372,11 @@ relpropvalue:   relprop | univprop
 abspropcond:  ABSPROPNOUNIV _cmpr _valu
 hasabspropcond: ABSPROPNOUNIV
 
-tagpropcond:  (tagprop | tagpropwithspace) _cmpr _valu
-hastagpropcond: (tagprop | tagpropwithspace)
+tagpropcond: tagmatch _COLONNOSPACE (BASEPROP | _varvalu)  _cmpr _valu
+hastagpropcond: tagmatch _COLONNOSPACE (BASEPROP | _varvalu)
 
-tagvalucond:  (_tagmatch | _tagmatchwithspace) _cmpr _valu
-tagcond: (_tagmatch | _tagmatchwithspace)
+tagvalucond: tagmatch _cmpr _valu
+tagcond: tagmatch
 
 condsubq: "{" query "}" [ _cmpr _valu]
 arraycond: relprop _ARRAYCONDSTART _safe_cmpr _valu "]"

synapse/lib/storm.py

@@ -180,6 +180,7 @@ permdef_schema = {
         'perm': {'type': 'array', 'items': {'type': 'string'}},
         'desc': {'type': 'string'},
         'gate': {'type': 'string'},
+        'ex': {'type': 'string'},  # Example string
         'workflowconfig': {'type': 'boolean'},
         'default': {'type': 'boolean', 'default': False},
     },
@@ -4194,7 +4195,7 @@ class DelNodeCmd(Cmd):
         delbytes = await s_stormtypes.tobool(self.opts.delbytes)
 
         if force:
-            if runt.user is not None and not runt.user.isAdmin():
+            if runt.user is not None and not runt.isAdmin():
                 mesg = '--force requires admin privs.'
                 raise s_exc.AuthDeny(mesg=mesg, user=self.runt.user.iden, username=self.runt.user.name)
 
@@ -5765,7 +5766,8 @@ class RunAsCmd(Cmd):
         return pars
 
     async def execStormCmd(self, runt, genr):
-        if not runt.user.isAdmin():
+
+        if not runt.isAdmin():
             mesg = 'The runas command requires admin privileges.'
             raise s_exc.AuthDeny(mesg=mesg, user=self.runt.user.iden, username=self.runt.user.name)
 

synapse/lib/storm_format.py

@@ -39,6 +39,7 @@ TerminalPygMap = {
     'EXPRNEG': p_t.Operator,
     'EXPRPLUS': p_t.Operator,
     'EXPRPOW': p_t.Operator,
+    'EXPRTAGSEGNOVAR': p_t.Name,
     'EXPRTIMES': p_t.Operator,
     'FOR': p_t.Keyword,
     'FORMATSTRING': p_t.Literal.String,
@@ -67,7 +68,7 @@ TerminalPygMap = {
     'SETTAGOPER': p_t.Operator,
     'SINGLEQUOTEDSTRING': p_t.Literal.String,
     'SWITCH': p_t.Keyword,
-    'TAGMATCH': p_t.Name,
+    'TAGSEGNOVAR': p_t.Name,
     'TRIPLEQUOTEDSTRING': p_t.Literal.String,
     'TRYSET': p_t.Operator,
     'TRYSETMINUS': p_t.Operator,
@@ -80,6 +81,7 @@ TerminalPygMap = {
     'WHILE': p_t.Keyword,
     'WHITETOKN': p_t.Literal.String,
     'WILDCARD': p_t.Name,
+    'WILDTAGSEGNOVAR': p_t.Name,
     'YIELD': p_t.Keyword,
     '_ARRAYCONDSTART': p_t.Punctuation,
     '_COLONDOLLAR': p_t.Punctuation,
@@ -94,20 +96,20 @@ TerminalPygMap = {
     '_ELSE': p_t.Keyword,
     '_EMBEDQUERYSTART': p_t.Punctuation,
     '_EMIT': p_t.Keyword,
+    '_EXPRCOLONNOSPACE': p_t.Punctuation,
     '_FINI': p_t.Keyword,
     '_HASH': p_t.Punctuation,
-    '_EXPRHASH': p_t.Punctuation,
     '_HASHSPACE': p_t.Punctuation,
-    '_EXPRHASHSPACE': p_t.Punctuation,
     '_INIT': p_t.Keyword,
     '_LEFTJOIN': p_t.Punctuation,
     '_LEFTPIVOT': p_t.Punctuation,
     '_LPARNOSPACE': p_t.Punctuation,
+    '_MATCHHASH': p_t.Punctuation,
+    '_MATCHHASHSPACE': p_t.Punctuation,
     '_RETURN': p_t.Keyword,
     '_RIGHTJOIN': p_t.Punctuation,
     '_RIGHTPIVOT': p_t.Punctuation,
     '_STOP': p_t.Keyword,
-    '_TAGSEGNOVAR': p_t.Name,
     '_WALKNPIVON1': p_t.Punctuation,
     '_WALKNPIVON2': p_t.Punctuation,
     '$END': p_t.Punctuation,

synapse/lib/stormlib/auth.py

@@ -203,7 +203,7 @@ stormcmds = (
                 auth.user.addrule visi "!foo.bar.baz"
 
                 // add an allow rule to the user "visi" for permission "baz" at the first index.
-                auth.user.addrule visi baz --indx 0
+                auth.user.addrule visi baz --index 0
         ''',
         'cmdargs': (
             ('name', {'type': 'str', 'help': 'The name of the user.'}),
@@ -275,7 +275,7 @@ stormcmds = (
                 auth.role.addrule ninjas "!foo.bar.baz"
 
                 // add an allow rule to the role "ninjas" for permission "baz" at the first index.
-                auth.role.addrule ninjas baz --indx 0
+                auth.role.addrule ninjas baz --index 0
         ''',
         'cmdargs': (
             ('name', {'type': 'str', 'help': 'The name of the role.'}),
@@ -343,10 +343,14 @@ stormcmds = (
                 // Grant the role "ninjas" to the user "visi"
                 auth.user.grant visi ninjas
 
+                // Grant the role "ninjas" to the user "visi" at the first index.
+                auth.user.grant visi ninjas --index 0
+
         ''',
         'cmdargs': (
             ('username', {'type': 'str', 'help': 'The name of the user.'}),
             ('rolename', {'type': 'str', 'help': 'The name of the role.'}),
+            ('--index', {'type': 'int', 'help': 'Specify the role location as a 0 based index.', 'default': None}),
         ),
         'storm': '''
             $user = $lib.auth.users.byname($cmdopts.username)
@@ -356,7 +360,7 @@ stormcmds = (
             if (not $role) { $lib.exit(`No role named: {$cmdopts.rolename}`) }
 
             $lib.print(`Granting role {$role.name} to user {$user.name}.`)
-            $user.grant($role.iden)
+            $user.grant($role.iden, indx=$cmdopts.index)
         ''',
     },
     {
@@ -555,4 +559,22 @@ stormcmds = (
             }
         '''
     },
+    {
+        'name': 'auth.perms.list',
+        'descr': 'Display a list of the current permissions defined within the Cortex.',
+        'cmdargs': (),
+        'storm': '''
+
+            for $pdef in $lib.auth.getPermDefs() {
+                $perm = $lib.str.join(".", $pdef.perm)
+
+                $lib.print($perm)
+                $lib.print(`    {$pdef.desc}`)
+                $lib.print(`    gate: {$pdef.gate}`)
+                $lib.print(`    default: {$pdef.default}`)
+                if $pdef.ex { $lib.print(`    example: {$pdef.ex}`) }
+                $lib.print('')
+            }
+        '''
+    },
 )

synapse/lib/stormlib/compression.py

@@ -0,0 +1,176 @@
+import bz2
+import gzip
+import zlib
+
+import synapse.exc as s_exc
+import synapse.common as s_common
+
+import synapse.lib.stormtypes as s_stormtypes
+
+@s_stormtypes.registry.registerLib
+class Bzip2Lib(s_stormtypes.Lib):
+    '''
+    A Storm library which implements helpers for bzip2 compression.
+    '''
+    _storm_locals = (
+        {'name': 'en', 'desc': '''
+            Compress bytes using bzip2 and return them.
+
+            Example:
+                Compress bytes with bzip2::
+
+                    $foo = $lib.compression.bzip2.en($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'en',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be compressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'The bzip2 compressed bytes.'}}},
+        {'name': 'un', 'desc': '''
+            Decompress bytes using bzip2 and return them.
+
+            Example:
+                Decompress bytes with bzip2::
+
+                $foo = $lib.compression.bzip2.un($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'un',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be decompressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'Decompressed bytes.'}}},
+    )
+
+    _storm_lib_path = ('compression', 'bzip2')
+
+    def getObjLocals(self):
+        return {
+            'en': self.en,
+            'un': self.un,
+        }
+
+    async def en(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return bz2.compress(valu)
+        except Exception as e:
+            mesg = f'Error during bzip2 compression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+    async def un(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return bz2.decompress(valu)
+        except Exception as e:
+            mesg = f'Error during bzip2 decompression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+@s_stormtypes.registry.registerLib
+class GzipLib(s_stormtypes.Lib):
+    '''
+    A Storm library which implements helpers for gzip compression.
+    '''
+    _storm_locals = (
+        {'name': 'en', 'desc': '''
+            Compress bytes using gzip and return them.
+
+            Example:
+                Compress bytes with gzip::
+
+                    $foo = $lib.compression.gzip.en($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'en',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be compressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'The gzip compressed bytes.'}}},
+        {'name': 'un', 'desc': '''
+            Decompress bytes using gzip and return them.
+
+            Example:
+                Decompress bytes with gzip::
+
+                $foo = $lib.compression.gzip.un($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'un',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be decompressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'Decompressed bytes.'}}},
+    )
+
+    _storm_lib_path = ('compression', 'gzip')
+
+    def getObjLocals(self):
+        return {
+            'en': self.en,
+            'un': self.un,
+        }
+
+    async def en(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return gzip.compress(valu)
+        except Exception as e:
+            mesg = f'Error during gzip compression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+    async def un(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return gzip.decompress(valu)
+        except Exception as e:
+            mesg = f'Error during gzip decompression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+@s_stormtypes.registry.registerLib
+class ZlibLib(s_stormtypes.Lib):
+    '''
+    A Storm library which implements helpers for zlib compression.
+    '''
+    _storm_locals = (
+        {'name': 'en', 'desc': '''
+            Compress bytes using zlib and return them.
+
+            Example:
+                Compress bytes with zlib::
+
+                    $foo = $lib.compression.zlib.en($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'en',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be compressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'The zlib compressed bytes.'}}},
+        {'name': 'un', 'desc': '''
+            Decompress bytes using zlib and return them.
+
+            Example:
+                Decompress bytes with zlib::
+
+                $foo = $lib.compression.zlib.un($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'un',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be decompressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'Decompressed bytes.'}}},
+    )
+
+    _storm_lib_path = ('compression', 'zlib')
+
+    def getObjLocals(self):
+        return {
+            'en': self.en,
+            'un': self.un,
+        }
+
+    async def en(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return zlib.compress(valu)
+        except Exception as e:
+            mesg = f'Error during zlib compression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+    async def un(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return zlib.decompress(valu)
+        except Exception as e:
+            mesg = f'Error during zlib decompression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None

synapse/lib/stormlib/graph.py

@@ -88,6 +88,8 @@ class GraphLib(s_stormtypes.Lib):
             Add a graph projection to the Cortex.
 
             Example:
+                Add a graph projection named "Test Projection"::
+
                     $rules = ({
                         "name": "Test Projection",
                         "desc": "My test projection",