Add missing and fix spelling of existing ones. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- src/remote/remote_protocol.x | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/remote/remote_protocol.x b/src/remote/remote_protocol.x index c34d6f189d..5d86a51116 100644 --- a/src/remote/remote_protocol.x +++ b/src/remote/remote_protocol.x @@ -3974,8 +3974,9 @@ enum remote_procedure { * Declare the access control requirements for the API. May be repeated * multiple times, if multiple rules are required. * - * <object> is one of 'connect', 'domain', 'network', 'storagepool', - * 'interface', 'nodedev', 'secret'. + * <object> is one of 'connect', 'domain', 'interface', 'network', + * 'network_port', 'node_device', 'nwfilter', + * 'nwfilter_binding', 'secret', 'storage_pool', 'storage_vol' * <permission> is one of the permissions in access/viraccessperm.h * <flagname> indicates the rule only applies if the named flag * is set in the API call -- 2.39.2

As an additional step before processing the API parse the protocol file and extract all ACL definitions. This way we can distribute them for any user of the libvirt API XML files. We will be also able to avoid another call to gendispatch, which generates all this data into a standalone XML. The remote procedure to API name is inspired by what rpcgen does. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/meson.build | 3 + scripts/apibuild.py | 134 +++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 135 insertions(+), 2 deletions(-) diff --git a/docs/meson.build b/docs/meson.build index 89ac93a958..864abf0ba5 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -160,6 +160,9 @@ docs_api_generated = custom_target( libvirt_lxc_sources, admin_sources, util_public_sources, + meson.project_source_root() / 'src' / 'remote' / 'remote_protocol.x', + meson.project_source_root() / 'src' / 'remote' / 'qemu_protocol.x', + meson.project_source_root() / 'src' / 'remote' / 'lxc_protocol.x', ], ) diff --git a/scripts/apibuild.py b/scripts/apibuild.py index cced9a5551..f532dbe834 100755 --- a/scripts/apibuild.py +++ b/scripts/apibuild.py @@ -2588,6 +2588,125 @@ class docBuilder: sys.exit(3) +def remoteProcToAPI(remotename: str) -> (str): + components = remotename.split('_') + fixednames = [] + + if components[1] != "PROC": + raise Exception("Malformed remote function name '%s'" % remotename) + + if components[0] == 'REMOTE': + driver = '' + elif components[0] == 'QEMU': + driver = 'Qemu' + elif components[0] == 'LXC': + driver = 'Lxc' + else: + raise Exception("Unknown remote protocol '%s'" % components[0]) + + for comp in components[2:]: + if comp == '': + raise Exception("Invalid empty component in remote procedure name '%s'" % remotename) + + fixedname = comp[0].upper() + comp[1:].lower() + + fixedname = re.sub('Nwfilter', 'NWFilter', fixedname) + fixedname = re.sub('Xml$', 'XML', fixedname) + fixedname = re.sub('Xml2$', 'XML2', fixedname) + fixedname = re.sub('Uri$', 'URI', fixedname) + fixedname = re.sub('Uuid$', 'UUID', fixedname) + fixedname = re.sub('Id$', 'ID', fixedname) + fixedname = re.sub('Mac$', 'MAC', fixedname) + fixedname = re.sub('Cpu$', 'CPU', fixedname) + fixedname = re.sub('Os$', 'OS', fixedname) + fixedname = re.sub('Nmi$', 'NMI', fixedname) + fixedname = re.sub('Pm', 'PM', fixedname) + fixedname = re.sub('Fstrim$', 'FSTrim', fixedname) + fixedname = re.sub('Fsfreeze$', 'FSFreeze', fixedname) + fixedname = re.sub('Fsthaw$', 'FSThaw', fixedname) + fixedname = re.sub('Fsinfo$', 'FSInfo', fixedname) + fixedname = re.sub('Iothread$', 'IOThread', fixedname) + fixedname = re.sub('Scsi', 'SCSI', fixedname) + fixedname = re.sub('Wwn$', 'WWN', fixedname) + fixedname = re.sub('Dhcp$', 'DHCP', fixedname) + + fixednames.append(fixedname) + + apiname = "vir" + fixednames[0] + + # In case of remote procedures for qemu/lxc private APIs we need to add + # the name of the driver in the middle of the string after the object name. + # For a special case of event callbacks the 'object' name is actually two + # words: virConenctDomainQemuEvent ... + if fixednames[1] == 'Domain': + apiname += 'Domain' + fixednames.pop(1) + + apiname += driver + + for name in fixednames[1:]: + apiname = apiname + name + + return apiname + + +def remoteProtocolGetAcls(protocolfilename: str) -> {}: + apiacls = {} + + with open(protocolfilename) as proto: + in_procedures = False + acls = [] + aclfilters = [] + + while True: + line = proto.readline() + if not line: + break + + if not in_procedures: + if re.match('^enum [a-z]+_procedure {$', line): + in_procedures = True + + continue + + if line == '};\n': + break + + acl_match = re.search(r"\* @acl: ([^\s]+)", line) + + if acl_match: + acls.append(acl_match.group(1)) + continue + + aclfilter_match = re.search(r"\* @aclfilter: ([^\s]+)", line) + + if aclfilter_match: + aclfilters.append(aclfilter_match.group(1)) + continue + + remote_proc_match = re.search(r"^\s+([A-Z_0-9]+) ", line) + + if remote_proc_match: + proc = remote_proc_match.group(1) + apiname = remoteProcToAPI(proc) + + if len(acls) == 0: + raise Exception("No ACLs for procedure %s(%s)" % proc, apiname) + + if 'none' in acls: + if len(acls) > 1: + raise Exception("Procedure %s(%s) has 'none' ACL followed by other ACLs" % proc, apiname) + + acls = [] + + apiacls[apiname] = (acls, aclfilters) + acls = [] + aclfilters = [] + continue + + return apiacls + + class app: def warning(self, msg): global warnings @@ -2595,16 +2714,27 @@ class app: print(msg) def rebuild(self, name, srcdir, builddir): + apiacl = None + syms = { "libvirt": srcdir + "/../src/libvirt_public.syms", "libvirt-qemu": srcdir + "/../src/libvirt_qemu.syms", "libvirt-lxc": srcdir + "/../src/libvirt_lxc.syms", "libvirt-admin": srcdir + "/../src/admin/libvirt_admin_public.syms", } - if name not in syms: + protocols = { + "libvirt": srcdir + "/../src/remote/remote_protocol.x", + "libvirt-qemu": srcdir + "/../src/remote/qemu_protocol.x", + "libvirt-lxc": srcdir + "/../src/remote/lxc_protocol.x", + "libvirt-admin": None, + } + if name not in syms or name not in protocols: self.warning("rebuild() failed, unknown module %s" % name) return None + if protocols[name]: + apiacl = remoteProtocolGetAcls(protocols[name]) + builder = None if glob.glob(srcdir + "/../src/libvirt.c") != []: if not quiet: @@ -2614,7 +2744,7 @@ class app: srcdir + "/../src/util", srcdir + "/../include/libvirt", builddir + "/../include/libvirt"] - builder = docBuilder(name, syms[name], builddir, dirs, []) + builder = docBuilder(name, syms[name], builddir, dirs, [], apiacl) else: self.warning("rebuild() failed, unable to guess the module") return None -- 2.39.2

Since we now build it into the libvirt-api.xml or equivalents we don't need the extra XML files. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/html/meson.build | 32 +------------------------------- src/access/meson.build | 16 ---------------- 2 files changed, 1 insertion(+), 47 deletions(-) diff --git a/docs/html/meson.build b/docs/html/meson.build index 4e818f9142..b18a8ccb5f 100644 --- a/docs/html/meson.build +++ b/docs/html/meson.build @@ -27,14 +27,12 @@ index_api_gen = custom_target( command: [ xsltproc_prog, '--nonet', '-o', docs_builddir, '--stringparam', 'builddir', meson.project_build_root(), - '--stringparam', 'aclxmlpath', docs_acl_xml.full_path(), '--stringparam', 'timestamp', docs_timestamp, '--stringparam', 'indexfile', 'index.html', '@INPUT@', ], install: true, install_dir: docs_html_dir / 'html', - depends: docs_acl_xml, depend_files: [ page_xsl, ], @@ -43,7 +41,7 @@ index_api_gen = custom_target( docs_html_gen += index_api_gen.to_list() docs_html_dep += index_api_gen -foreach name : [ 'lxc', 'qemu' ] +foreach name : [ 'admin', 'lxc', 'qemu' ] index_api_gen = custom_target( &#39;index-@0(a)-api&#39;.format(name), input: [ @@ -56,13 +54,11 @@ foreach name : [ 'lxc', 'qemu' ] command: [ xsltproc_prog, '--nonet', '-o', docs_builddir, '--stringparam', 'builddir', meson.project_build_root(), - '--stringparam', 'aclxmlpath', get_variable(&#39;docs_acl_@0(a)_xml&#39;.format(name)).full_path(), '--stringparam', 'timestamp', docs_timestamp, '@INPUT@', ], install: true, install_dir: docs_html_dir / 'html', - depends: get_variable(&#39;docs_acl_@0(a)_xml&#39;.format(name)), depend_files: [ page_xsl, ], @@ -72,32 +68,6 @@ foreach name : [ 'lxc', 'qemu' ] docs_html_dep += index_api_gen endforeach -index_api_gen = custom_target( - 'index-admin-api'.format(name), - input: [ - newapi_xsl, - docs_admin_api_xml, - ], - output: [ - 'libvirt-libvirt-admin.html' - ], - command: [ - xsltproc_prog, '--nonet', '-o', docs_builddir, - '--stringparam', 'builddir', meson.project_build_root(), - '--stringparam', 'aclxmlpath', '', - '--stringparam', 'timestamp', docs_timestamp, - '@INPUT@', - ], - install: true, - install_dir: docs_html_dir / 'html', - depend_files: [ - page_xsl, - ], - ) - -docs_html_gen += index_api_gen.to_list() -docs_html_dep += index_api_gen - docs_html_paths = [] install_web_deps += docs_html_dep diff --git a/src/access/meson.build b/src/access/meson.build index 0b12581dc1..07c703e8b5 100644 --- a/src/access/meson.build +++ b/src/access/meson.build @@ -23,12 +23,10 @@ foreach name : [ 'remote', 'qemu', 'lxc' ] header_file = 'viraccessapicheck.h' source_file = 'viraccessapicheck.c' syms_file = 'libvirt_access.syms' - xml_file = 'libvirt_access.xml' else header_file = 'viraccessapicheck@0@.h'.format(name) source_file = 'viraccessapicheck@0@.c'.format(name) syms_file = 'libvirt_access_@0@.syms'.format(name) - xml_file = 'libvirt_access_@0@.xml'.format(name) endif protocol_file = remote_path / &#39;@0(a)_protocol.x&#39;.format(name) @@ -62,22 +60,8 @@ foreach name : [ 'remote', 'qemu', 'lxc' ] gendispatch_prog, '--mode=aclsym', name, name.to_upper(), '@INPUT@', ] ) - - access_gen_xml += custom_target( - xml_file, - input: protocol_file, - output: xml_file, - capture: true, - command: [ - gendispatch_prog, '--mode=aclapi', name, name.to_upper(), '@INPUT@', - ], - ) endforeach -docs_acl_xml = access_gen_xml[0] -docs_acl_qemu_xml = access_gen_xml[1] -docs_acl_lxc_xml = access_gen_xml[2] - if conf.has('WITH_POLKIT') access_sources += access_polkit_sources -- 2.39.2