qapi/authz.json

   1 # -*- Mode: Python -*-
   2 # vim: filetype=python
   3
   4 ##
   5 # = User authorization
   6 ##
   7
   8 ##
   9 # @QAuthZListPolicy:
  10 #
  11 # The authorization policy result
  12 #
  13 # @deny: deny access
  14 # @allow: allow access
  15 #
  16 # Since: 4.0
  17 ##
  18 { 'enum': 'QAuthZListPolicy',
  19   'prefix': 'QAUTHZ_LIST_POLICY',
  20   'data': ['deny', 'allow']}
  21
  22 ##
  23 # @QAuthZListFormat:
  24 #
  25 # The authorization policy match format
  26 #
  27 # @exact: an exact string match
  28 # @glob: string with ? and * shell wildcard support
  29 #
  30 # Since: 4.0
  31 ##
  32 { 'enum': 'QAuthZListFormat',
  33   'prefix': 'QAUTHZ_LIST_FORMAT',
  34   'data': ['exact', 'glob']}
  35
  36 ##
  37 # @QAuthZListRule:
  38 #
  39 # A single authorization rule.
  40 #
  41 # @match: a string or glob to match against a user identity
  42 # @policy: the result to return if @match evaluates to true
  43 # @format: the format of the @match rule (default 'exact')
  44 #
  45 # Since: 4.0
  46 ##
  47 { 'struct': 'QAuthZListRule',
  48   'data': {'match': 'str',
  49            'policy': 'QAuthZListPolicy',
  50            '*format': 'QAuthZListFormat'}}
  51
  52 ##
  53 # @QAuthZListRuleListHack:
  54 #
  55 # Not exposed via QMP; hack to generate QAuthZListRuleList
  56 # for use internally by the code.
  57 #
  58 # Since: 4.0
  59 ##
  60 { 'struct': 'QAuthZListRuleListHack',
  61   'data': { 'unused': ['QAuthZListRule'] } }