Add a standard authorization framework
Subsystems (2)
v8 cover Add a standard authorization framework
An update to
v2: https://lists.gnu.org/archive/html/qemu-devel/2018-06/msg04469.html
v3: https://lists.gnu.org/archive/html/qemu-devel/2018-06/msg05660.html
v4: https://lists.gnu.org/archive/html/qemu-devel/2018-08/msg02961.html
v5: https://lists.gnu.org/archive/html/qemu-devel/2018-10/msg01613.html
v6: https://lists.gnu.org/archive/html/qemu-devel/2018-10/msg04435.html
v7: https://lists.gnu.org/archive/html/qemu-devel/2018-11/msg06616.html
The current network services now support encryption via TLS and in some cases support authentication via SASL. In cases where SASL is not available, x509 client certificates can be used as a crude authorization scheme, but using a sub-CA and controlling who you give certs to. In general this is not very flexible though, so this series introduces a new standard authorization framework.
It comes with four initial authorization mechanisms
- Simple - an exact username match. This is useful when there is exactly one user that is known to connect. For example when live migrating from one QEMU to another with TLS, libvirt would use the simple scheme to whitelist the TLS cert of the source QEMU.
- List - an full access control list, with optional regex matching. This is more flexible and is used to provide 100% backcompat with the existing HMP ACL commands. The caveat is that we can't create these via the CLI -object arg yet.
- ListFile - the same as List, but with the rules stored in JSON format in an external file. This avoids the -object limitation while also allowing the admin to change list entries on the file. QEMU uses inotify to notice these changes and auto-reload the file contents. This is likely a good default choice for most network services, if the "simple" mechanism isn't sufficient.
- PAM - delegate the username lookup to a PAM module, which opens the door to many options including things like SQL/LDAP lookups.
A later series that follows will integrate this framework into the VNC, NBD, migration, and character device servers.
Changed in v7:
- Fix missing case QFILE_MONITOR_EVENT_ATTRIBUTES in mtp dev
- Remove obsolete CONFIG_FNMATCH in monitor code
- Remove obsolete fnmatch probe in configure
- Fix QMP monitor example docs (Philippe)
Changed in v6:
- Change file monitor object to allow multiple instances instead of being a singleton
- Use stubs when inotify is not available
- Use GArray for managing watches
- Report errno when failing to read from inotify
- Check for closed inotify FD before reading
- Monitor file attribute changes to detect chmod/chown/etc
- Unregister event loop FD handler when watches are removed
- Fix mutex unlock call when removing watches
- Remove file monitor watch when free'ing MTP object
- Rename MTP watchfd field to watchid
- Free file monitor when deleting MTP device
- Use error_report instead of fprintf for MTP errors
- Use GPattern instead of fnmatch
- Use enum _str() helper functions
- Add unit/functional test for inotify file monitor
- Add unit test for simple authz impl
- Add unit test for list file authz impl
- Add unit test for PAM authz impl
Changed in v6:
- Fix consistency of object variable names
- Fix command line example quoting
- Use 'false' not '0' for bool return values
- Remove empty 'complete' methods
- Fix leak of rules in finalizer
- Fix missing {} around conditional
- Refactor rule refresh to use goto & invert conditional
Changed in v5:
- Rebase to latest git master
Changed in v4:
- Rebase to latest git master
Changed in v3:
- Added docs for object types in qemu-options.hx
- Added example CLI syntax in header files
- Improved commit messages
Changed in v2:
- Switch to a global shared instance of the file monitor so only a single inotify file descriptor is required
- Require all watches to be registered against directories. File watches are useless in Linux, since they are tied to inodes, and so stop working when editors save by doing a tmpfile + rename dance.
- Change auth list impl to use a directory based watch instead of filename
- Put MTP const-ness fixes in separate patch
- Split QOM change off into separate patch
- Fix conditionals on Win32 build
Daniel P. Berrangé (11):
util: add helper APIs for dealing with inotify in portable manner
qom: don't require user creatable objects to be registered hw/usb: don't set IN_ISDIR for inotify watch in MTP driver hw/usb: fix const-ness for string params in MTP driver hw/usb: switch MTP to use new inotify APIs
authz: add QAuthZ object as an authorization base class
authz: add QAuthZSimple object type for easy whitelist auth checks
authz: add QAuthZList object type for an access control list
authz: add QAuthZListFile object type for a file access control list
authz: add QAuthZPAM object type for authorizing using PAM
authz: delete existing ACL implementation
MAINTAINERS | 15 + Makefile | 10 +- Makefile.objs | 10 +- Makefile.target | 2 + authz/Makefile.objs | 7 + authz/base.c | 82 ++++ authz/list.c | 271 +++++++++++++ authz/listfile.c | 283 ++++++++++++++ authz/pamacct.c | 149 +++++++ authz/simple.c | 115 ++++++ authz/trace-events | 18 + configure | 54 ++- crypto/tlssession.c | 35 +- crypto/trace-events | 2 +- hw/usb/dev-mtp.c | 281 ++++++-------- hw/usb/trace-events | 2 +- include/authz/base.h | 112 ++++++ include/authz/list.h | 106 +++++ include/authz/listfile.h | 111 ++++++ include/authz/pamacct.h | 100 +++++ include/authz/simple.h | 84 ++++ include/qemu/acl.h | 66 ---- include/qemu/filemonitor.h | 128 ++++++ monitor.c | 179 ++++++--- qapi/authz.json | 58 +++ qapi/qapi-schema.json | 1 + qemu-options.hx | 105 +++++ qom/object.c | 12 +- qom/object_interfaces.c | 16 +- tests/Makefile.include | 16 +- tests/test-authz-list.c | 159 ++++++++ tests/test-authz-listfile.c | 195 ++++++++++ tests/test-authz-pam.c | 124 ++++++ tests/test-authz-simple.c | 50 +++ tests/test-crypto-tlssession.c | 15 +- tests/test-io-channel-tls.c | 16 +- tests/test-util-filemonitor.c | 685 +++++++++++++++++++++++++++++++++ ui/vnc-auth-sasl.c | 23 +- ui/vnc-auth-sasl.h | 5 +- ui/vnc-auth-vencrypt.c | 2 +- ui/vnc-ws.c | 2 +- ui/vnc.c | 37 +- ui/vnc.h | 4 +- util/Makefile.objs | 4 +- util/acl.c | 179 --------- util/filemonitor-inotify.c | 338 ++++++++++++++++ util/filemonitor-stub.c | 59 +++ util/trace-events | 9 + 48 files changed, 3773 insertions(+), 563 deletions(-) create mode 100644 authz/Makefile.objs create mode 100644 authz/base.c create mode 100644 authz/list.c create mode 100644 authz/listfile.c create mode 100644 authz/pamacct.c create mode 100644 authz/simple.c create mode 100644 authz/trace-events create mode 100644 include/authz/base.h create mode 100644 include/authz/list.h create mode 100644 include/authz/listfile.h create mode 100644 include/authz/pamacct.h create mode 100644 include/authz/simple.h delete mode 100644 include/qemu/acl.h create mode 100644 include/qemu/filemonitor.h create mode 100644 qapi/authz.json create mode 100644 tests/test-authz-list.c create mode 100644 tests/test-authz-listfile.c create mode 100644 tests/test-authz-pam.c create mode 100644 tests/test-authz-simple.c create mode 100644 tests/test-util-filemonitor.c delete mode 100644 util/acl.c create mode 100644 util/filemonitor-inotify.c create mode 100644 util/filemonitor-stub.c
Signature · 1 line
2.20.1
PATCH v8 1/11 util: add helper APIs for dealing with inotify in portable manner
The inotify userspace API for reading events is quite horrible, so it is useful to wrap it in a more friendly API to avoid duplicating code across many users in QEMU. Wrapping it also allows introduction of a platform portability layer, so that we can add impls for non-Linux based equivalents in future.
--- MAINTAINERS | 7 + Makefile.objs | 2 +- include/qemu/filemonitor.h | 128 +++++++ tests/Makefile.include | 3 + tests/test-util-filemonitor.c | 685 ++++++++++++++++++++++++++++++++++ util/Makefile.objs | 3 + util/filemonitor-inotify.c | 338 +++++++++++++++++ util/filemonitor-stub.c | 59 +++ util/trace-events | 9 + 9 files changed, 1233 insertions(+), 1 deletion(-) create mode 100644 include/qemu/filemonitor.h create mode 100644 tests/test-util-filemonitor.c create mode 100644 util/filemonitor-inotify.c create mode 100644 util/filemonitor-stub.c
MAINTAINERS +7 -0
@@ -2080,6 +2080,13 @@ F: include/qemu/sockets.h F: util/qemu-sockets.c F: qapi/sockets.json +File monitor +M: Daniel P. Berrange <[email protected]> +S: Odd fixes +F: util/filemonitor*.c +F: include/qemu/filemonitor.h +F: tests/test-util-filemonitor.c + Throttling infrastructure M: Alberto Garcia <[email protected]> S: Supported
Makefile.objs +1 -1
@@ -4,7 +4,7 @@ QAPI_MODULES += ui ####################################################################### # Common libraries for tools and emulators -stub-obj-y = stubs/ crypto/ +stub-obj-y = stubs/ util/ crypto/ util-obj-y = util/ qobject/ qapi/ util-obj-y += qapi/qapi-builtin-types.o util-obj-y += qapi/qapi-types.o
include/qemu/filemonitor.h new file +128 -0
128 lines not on this page · raw message
tests/Makefile.include +3 -0
@@ -114,6 +114,7 @@ ifneq (,$(findstring qemu-ga,$(TOOLS))) check-unit-$(land,$(CONFIG_LINUX),$(CONFIG_VIRTIO_SERIAL)) += tests/test-qga$(EXESUF) endif check-unit-y += tests/test-timed-average$(EXESUF) +check-unit-$(CONFIG_INOTIFY1) += tests/test-util-filemonitor$(EXESUF) check-unit-y += tests/test-util-sockets$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF)
@@ -657,6 +658,8 @@ tests/test-crypto-tlssession$(EXESUF): tests/test-crypto-tlssession.o \ tests/crypto-tls-x509-helpers.o tests/pkix_asn1_tab.o \ tests/crypto-tls-psk-helpers.o \ $(test-crypto-obj-y) +tests/test-util-filemonitor$(EXESUF): tests/test-util-filemonitor.o \ + $(test-util-obj-y) tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/socket-helpers.o $(test-util-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y)
tests/test-util-filemonitor.c new file +685 -0
685 lines not on this page · raw message
util/Makefile.objs +3 -0
@@ -50,5 +50,8 @@ util-obj-y += range.o util-obj-y += stats64.o util-obj-y += systemd.o util-obj-y += iova-tree.o +util-obj-$(CONFIG_INOTIFY1) += filemonitor-inotify.o util-obj-$(CONFIG_LINUX) += vfio-helpers.o util-obj-$(CONFIG_OPENGL) += drm.o + +stub-obj-y += filemonitor-stub.o
util/filemonitor-inotify.c new file +338 -0
338 lines not on this page · raw message
util/filemonitor-stub.c new file +59 -0
59 lines not on this page · raw message
util/trace-events +9 -0
@@ -21,6 +21,15 @@ buffer_move_empty(const char *buf, size_t len, const char *from) "%s: %zd bytes buffer_move(const char *buf, size_t len, const char *from) "%s: %zd bytes from %s" buffer_free(const char *buf, size_t len) "%s: capacity %zd" +# util/filemonitor.c +qemu_file_monitor_add_watch(void *mon, const char *dirpath, const char *filename, void *cb, void *opaque, int id) "File monitor %p add watch dir='%s' file='%s' cb=%p opaque=%p id=%u" +qemu_file_monitor_remove_watch(void *mon, const char *dirpath, int id) "File monitor %p remove watch dir='%s' id=%u" +qemu_file_monitor_new(void *mon, int fd) "File monitor %p created fd=%d" +qemu_file_monitor_enable_watch(void *mon, const char *dirpath, int id) "File monitor %p enable watch dir='%s' id=%u" +qemu_file_monitor_disable_watch(void *mon, const char *dirpath, int id) "Fle monitor %p disable watch dir='%s' id=%u" +qemu_file_monitor_event(void *mon, const char *dirpath, const char *filename, int mask, unsigned int id) "File monitor %p event dir='%s' file='%s' mask=0x%x id=%u" +qemu_file_monitor_dispatch(void *mon, const char *dirpath, const char *filename, int ev, void *cb, void *opaque, unsigned int id) "File monitor %p dispatch dir='%s' file='%s' ev=%d cb=%p opaque=%p id=%u" + # util/qemu-coroutine.c qemu_aio_coroutine_enter(void *ctx, void *from, void *to, void *opaque) "ctx %p from %p to %p opaque %p" qemu_coroutine_yield(void *from, void *to) "from %p to %p"
Signature · 1 line
2.20.1
Re: [Qemu-devel] [PATCH v8 01/11] util: add helper APIs for dealing with inotify in portable manner
Quoted 6 lines · Daniel P. Berrangé
The inotify userspace API for reading events is quite horrible, so it is useful to wrap it in a more friendly API to avoid duplicating code across many users in QEMU. Wrapping it also allows introduction of a platform portability layer, so that we can add impls for non-Linux based equivalents in future.
Hi; Coverity has suddenly decided to complain about this 3-year-old code (in CID 1469132). It reports an "untrusted loop bound" because in the 'loop over events in the buffer' we use the data we just read from the filedescriptor (specifically ev->len) as part of the calculation of our loop termination condition.
Is there actually anything to change here, or is this a false positive because we actually trust the data we're getting on this fd?
(More generally there are a handful of "untrusted loop bound" and "untrusted value as argument" issues outstanding in the Coverity UI, so some opinions on whether they're valid or not would be useful.)
Quoted 85 lines
util/filemonitor-inotify.c new file +85
-0+static void qemu_file_monitor_watch (void *arg) +{ +QFileMonitor *mon = arg; + char buf[4096] + __attribute__ ((aligned(__alignof__(struct inotify_event)))); +int used =0 ; +int len; + +qemu_mutex_lock (&mon->lock); + +if (mon->fd ==-1 ) { +qemu_mutex_unlock (&mon->lock); +return ; + } + + len =read (mon->fd, buf,sizeof (buf)); + +if (len <0 ) { +if (errno !=EAGAIN ) { +error_report ("Failure monitoring inotify FD '%s'," +"disabling events" ,strerror (errno)); + goto cleanup; + } + +/* no more events right now */ + goto cleanup; + } + +/* Loop over all events in the buffer */ +while (used < len) { +struct inotify_event *ev = + (struct inotify_event *)(buf + used); +const char *name = ev->len ? ev->name :"" ; +QFileMonitorDir *dir =g_hash_table_lookup (mon->idmap, +GINT_TO_POINTER (ev->wd)); +uint32_t iev = ev->mask & + (IN_CREATE |IN_MODIFY |IN_DELETE |IN_IGNORED | +IN_MOVED_TO |IN_MOVED_FROM |IN_ATTRIB ); +int qev; +gsize i; + + used +=sizeof (struct inotify_event ) + ev->len; + +if (!dir) { +continue ; + } + +/* +* During a rename operation, the old name gets +* IN_MOVED_FROM and the new name gets IN_MOVED_TO. +* To simplify life for callers, we turn these into +* DELETED and CREATED events +*/ +switch (iev) { +case IN_CREATE : +case IN_MOVED_TO : + qev =QFILE_MONITOR_EVENT_CREATED ; +break ; +case IN_MODIFY : + qev =QFILE_MONITOR_EVENT_MODIFIED ; +break ; +case IN_DELETE : +case IN_MOVED_FROM : + qev =QFILE_MONITOR_EVENT_DELETED ; +break ; +case IN_ATTRIB : + qev =QFILE_MONITOR_EVENT_ATTRIBUTES ; +break ; +case IN_IGNORED : + qev =QFILE_MONITOR_EVENT_IGNORED ; +break ; +default : +g_assert_not_reached (); + } + +trace_qemu_file_monitor_event (mon, dir->path, name, ev->mask, dir->id); +for (i =0 ; i < dir->watches->len; i++) { +QFileMonitorWatch *watch = &g_array_index (dir->watches, + QFileMonitorWatch, + i); + +if (watch->filename ==NULL || + (name &&g_str_equal (watch->filename, name))) { + trace_qemu_file_monitor_dispatch(mon, dir->path, name, + qev, watch->cb,
util/filemonitor-inotify.c line 149
Quoted 10 lines
util/filemonitor-inotify.c new file +10
-0+ watch->opaque, watch->id); + watch->cb (watch->id, qev, name, watch->opaque); + } + } + } + + cleanup: +qemu_mutex_unlock (&mon->lock); +} +
thanks
-- PMM
Re: [Qemu-devel] [PATCH v8 01/11] util: add helper APIs for dealing with inotify in portable manner
Quoted 8 lines · Peter Maydell
Quoted 6 lines · Daniel P. Berrangé
The inotify userspace API for reading events is quite horrible, so it is useful to wrap it in a more friendly API to avoid duplicating code across many users in QEMU. Wrapping it also allows introduction of a platform portability layer, so that we can add impls for non-Linux based equivalents in future.
Quoted 8 lines
Hi; Coverity has suddenly decided to complain about this 3-year-old code (in CID 1469132). It reports an "untrusted loop bound" because in the 'loop over events in the buffer' we use the data we just read from the filedescriptor (specifically
ev->len) as part of the calculation of our loop termination condition.Is there actually anything to change here, or is this a false positive because we actually trust the data we're getting on this fd?
I think its false positive. The inotify API between kernel and userspace requires that you work in this manner. The data on this FD is strictly emitted by the kernel, not any untrusted application, so I don't think there's a risk here.
Regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
PATCH v8 2/11 qom: don't require user creatable objects to be registered
In reply to Daniel P. BerrangéWhen an object is in turn owned by another user object, it is not desirable to expose this in the QOM object hierarchy. It is just an internal implementation detail, we should be free to change without exposure to apps managing QEMU.
--- qom/object.c | 12 ++++++++---- qom/object_interfaces.c | 16 ++++++++++------ 2 files changed, 18 insertions(+), 10 deletions(-)
qom/object.c +8 -4
@@ -646,16 +646,20 @@ Object *object_new_with_propv(const char *typename, goto error; } -object_property_add_child (parent, id, obj, &local_err); -if (local_err) { - goto error; +if (id !=NULL ) { +object_property_add_child (parent, id, obj, &local_err); +if (local_err) { + goto error; + } } uc = (UserCreatable *)object_dynamic_cast (obj,TYPE_USER_CREATABLE );if (uc) {user_creatable_complete (uc, &local_err);if (local_err) { -object_unparent (obj); +if (id !=NULL ) { +object_unparent (obj); + } goto error; } }
qom/object_interfaces.c +10 -6
@@ -75,16 +75,20 @@ Object *user_creatable_add_type(const char *type, const char *id, goto out; } -object_property_add_child (object_get_objects_root (), - id, obj, &local_err); -if (local_err) { - goto out; +if (id !=NULL ) { +object_property_add_child (object_get_objects_root (), + id, obj, &local_err); +if (local_err) { + goto out; + } }user_creatable_complete (USER_CREATABLE (obj), &local_err);if (local_err) { -object_property_del (object_get_objects_root (), - id, &error_abort); +if (id !=NULL ) { +object_property_del (object_get_objects_root (), + id, &error_abort); + } goto out; } out:
Signature · 1 line
2.20.1
PATCH v8 3/11 hw/usb: don't set IN_ISDIR for inotify watch in MTP driver
In reply to Daniel P. BerrangéIN_ISDIR is not a bit that one can request when registering a watch with inotify_add_watch. Rather it is a bit that is set automatically when reading events from the kernel.
--- hw/usb/dev-mtp.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
hw/usb/dev-mtp.c +1 -2
@@ -653,8 +653,7 @@ static void usb_mtp_inotify_cleanup(MTPState *s)static int usb_mtp_add_watch (int inotifyfd,char *path) { -uint32_t mask =IN_CREATE |IN_DELETE |IN_MODIFY | -IN_ISDIR ; +uint32_t mask =IN_CREATE |IN_DELETE |IN_MODIFY ;return inotify_add_watch (inotifyfd, path, mask); }
Signature · 1 line
2.20.1
PATCH v8 4/11 hw/usb: fix const-ness for string params in MTP driver
In reply to Daniel P. BerrangéVarious functions accepting 'char *' string parameters were missing 'const' qualifiers.
--- hw/usb/dev-mtp.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
hw/usb/dev-mtp.c +4 -4
@@ -383,7 +383,7 @@ static const USBDesc desc = {/* ----------------------------------------------------------------------- */ static MTPObject *usb_mtp_object_alloc (MTPState *s,uint32_t handle, -MTPObject *parent,char *name) +MTPObject *parent,const char *name) {MTPObject *o =g_new0 (MTPObject,1 );
@@ -465,7 +465,7 @@ static MTPObject *usb_mtp_object_lookup(MTPState *s, uint32_t handle) }static MTPObject *usb_mtp_add_child (MTPState *s,MTPObject *o, -char *name) +const char *name) {MTPObject *child =usb_mtp_object_alloc (s, s->next_handle++, o, name);
@@ -484,7 +484,7 @@ static MTPObject *usb_mtp_add_child(MTPState *s, MTPObject *o, }static MTPObject *usb_mtp_object_lookup_name (MTPObject *parent, -char *name,int len) +const char *name,int len) {MTPObject *iter;
@@ -651,7 +651,7 @@ static void usb_mtp_inotify_cleanup(MTPState *s) } } -static int usb_mtp_add_watch (int inotifyfd,char *path) +static int usb_mtp_add_watch (int inotifyfd,const char *path) {uint32_t mask =IN_CREATE |IN_DELETE |IN_MODIFY ;
Signature · 1 line
2.20.1
PATCH v8 5/11 hw/usb: switch MTP to use new inotify APIs
In reply to Daniel P. BerrangéThe internal inotify APIs allow a lot of conditional statements to be cleared out, and provide a simpler callback for handling events.
--- hw/usb/dev-mtp.c | 274 ++++++++++++++++++-------------------------- hw/usb/trace-events | 2 +- 2 files changed, 111 insertions(+), 165 deletions(-)
hw/usb/dev-mtp.c +110 -164
@@ -11,17 +11,16 @@#include "qemu/osdep.h" #include "qapi/error.h" +#include "qemu/error-report.h" #include <wchar.h> #include <dirent.h> #include <sys/statvfs.h> -#ifdef CONFIG_INOTIFY1 -#include <sys/inotify.h> -#include "qemu/main-loop.h" -#endif +#include "qemu-common.h" #include "qemu/iov.h" +#include "qemu/filemonitor.h" #include "trace.h" #include "hw/usb.h" #include "desc.h"
@@ -132,7 +131,6 @@ enum { EP_EVENT, }; -#ifdef CONFIG_INOTIFY1 typedef struct MTPMonEntry MTPMonEntry ;struct MTPMonEntry {
@@ -141,7 +139,6 @@ struct MTPMonEntry {QTAILQ_ENTRY (MTPMonEntry) next; }; -#endif struct MTPControl {uint16_t code;
@@ -172,10 +169,8 @@ struct MTPObject {char *name;char *path;struct stat stat; -#ifdef CONFIG_INOTIFY1 -/* inotify watch cookie */ -int watchfd; -#endif +/* file monitor watch id */ +int watchid;MTPObject *parent;uint32_t nchildren; QLIST_HEAD(, MTPObject) children;
@@ -198,11 +193,8 @@ struct MTPState {bool readonly; QTAILQ_HEAD(, MTPObject) objects; -#ifdef CONFIG_INOTIFY1 -/* inotify descriptor */ -int inotifyfd; +QFileMonitor *file_monitor; QTAILQ_HEAD(, MTPMonEntry) events; -#endif /* Responder is expecting a write operation */ bool write_pending;struct {
@@ -391,6 +383,7 @@ static MTPObject *usb_mtp_object_alloc(MTPState *s, uint32_t handle, goto ignore; } + o->watchid =-1 ; o->handle = handle; o->parent = parent; o->name =g_strdup (name);
@@ -437,6 +430,10 @@ static void usb_mtp_object_free(MTPState *s, MTPObject *o)trace_usb_mtp_object_free (s->dev.addr, o->handle, o->path); +if (o->watchid !=-1 && s->file_monitor) { +qemu_file_monitor_remove_watch (s->file_monitor, o->path, o->watchid); + } +QTAILQ_REMOVE (&s->objects, o, next);if (o->parent) {QLIST_REMOVE (o, list);
@@ -488,6 +485,10 @@ static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent, {MTPObject *iter; +if (len ==-1 ) { + len =strlen (name); + } + QLIST_FOREACH(iter, &parent->children, list) {if (strncmp (iter->name, name, len) ==0 ) {return iter;
@@ -497,13 +498,12 @@ static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent,return NULL ; } -#ifdef CONFIG_INOTIFY1 -static MTPObject *usb_mtp_object_lookup_wd (MTPState *s,int wd) +static MTPObject *usb_mtp_object_lookup_id (MTPState *s,int id) {MTPObject *iter; QTAILQ_FOREACH(iter, &s->objects, next) { -if (iter->watchfd == wd) { +if (iter->watchid == id) {return iter; } }
@@ -511,159 +511,103 @@ static MTPObject *usb_mtp_object_lookup_wd(MTPState *s, int wd)return NULL ; } -static void inotify_watchfn (void *arg) +static void file_monitor_event (int id, +QFileMonitorEvent ev, +const char *name, +void *opaque) { -MTPState *s = arg; -ssize_t bytes; -/* From the man page: atleast one event can be read */ -int pos; -char buf[sizeof (struct inotify_event ) +NAME_MAX +1 ]; - -for (;;) { - bytes =read (s->inotifyfd, buf,sizeof (buf)); - pos =0 ; - -if (bytes <=0 ) { -/* Better luck next time */ +MTPState *s = opaque; +MTPObject *parent =usb_mtp_object_lookup_id (s, id); +MTPMonEntry *entry =NULL ; +MTPObject *o; + +if (!parent) { +return ; + } + +switch (ev) { +case QFILE_MONITOR_EVENT_CREATED : +if (usb_mtp_object_lookup_name (parent, name,-1 )) { +/* Duplicate create event */ return ; } + entry =g_new0 (MTPMonEntry,1 ); + entry->handle = s->next_handle; + entry->event =EVT_OBJ_ADDED ; + o =usb_mtp_add_child (s, parent, name); +if (!o) { +g_free (entry); +return ; + } +trace_usb_mtp_file_monitor_event (s->dev.addr, name,"Obj Added" ); +break ; +case QFILE_MONITOR_EVENT_DELETED :/* -* TODO: Ignore initiator initiated events. -* For now we are good because the store is RO +* The kernel issues a IN_IGNORED event +* when a dir containing a watchpoint is +* deleted, so we don't have to delete the +* watchpoint */ -while (bytes >0 ) { -char *p = buf + pos; -struct inotify_event *event = (struct inotify_event *)p; -int watchfd =0 ; -uint32_t mask = event->mask & (IN_CREATE |IN_DELETE | -IN_MODIFY |IN_IGNORED ); -MTPObject *parent =usb_mtp_object_lookup_wd (s, event->wd); -MTPMonEntry *entry =NULL ; -MTPObject *o; - - pos = pos +sizeof (struct inotify_event ) + event->len; - bytes = bytes - pos; - -if (!parent) { -continue ; - } - -switch (mask) { -case IN_CREATE : -if (usb_mtp_object_lookup_name - (parent, event->name, event->len)) { -/* Duplicate create event */ -continue ; - } - entry =g_new0 (MTPMonEntry,1 ); - entry->handle = s->next_handle; - entry->event =EVT_OBJ_ADDED ; - o =usb_mtp_add_child (s, parent, event->name); -if (!o) { -g_free (entry); -continue ; - } - o->watchfd = watchfd; -trace_usb_mtp_inotify_event (s->dev.addr, event->name, - event->mask,"Obj Added" ); -break ; - -case IN_DELETE : -/* -* The kernel issues a IN_IGNORED event -* when a dir containing a watchpoint is -* deleted, so we don't have to delete the -* watchpoint -*/ - o =usb_mtp_object_lookup_name (parent, event->name, event->len); -if (!o) { -continue ; - } - entry =g_new0 (MTPMonEntry,1 ); - entry->handle = o->handle; - entry->event =EVT_OBJ_REMOVED ; -trace_usb_mtp_inotify_event (s->dev.addr, o->path, - event->mask,"Obj Deleted" ); -usb_mtp_object_free (s, o); -break ; - -case IN_MODIFY : - o =usb_mtp_object_lookup_name (parent, event->name, event->len); -if (!o) { -continue ; - } - entry =g_new0 (MTPMonEntry,1 ); - entry->handle = o->handle; - entry->event =EVT_OBJ_INFO_CHANGED ; -trace_usb_mtp_inotify_event (s->dev.addr, o->path, - event->mask,"Obj Modified" ); -break ; - -case IN_IGNORED : -trace_usb_mtp_inotify_event (s->dev.addr, parent->path, - event->mask,"Obj parent dir ignored" ); -break ; - -default : -fprintf (stderr,"usb-mtp: failed to parse inotify event\n" ); -continue ; - } - -if (entry) { -QTAILQ_INSERT_HEAD (&s->events, entry, next); - } + o =usb_mtp_object_lookup_name (parent, name,-1 ); +if (!o) { +return ; } - } -} + entry =g_new0 (MTPMonEntry,1 ); + entry->handle = o->handle; + entry->event =EVT_OBJ_REMOVED ; +trace_usb_mtp_file_monitor_event (s->dev.addr, o->path,"Obj Deleted" ); +usb_mtp_object_free (s, o); +break ; -static int usb_mtp_inotify_init (MTPState *s) -{ -int fd; +case QFILE_MONITOR_EVENT_MODIFIED : + o =usb_mtp_object_lookup_name (parent, name,-1 ); +if (!o) { +return ; + } + entry =g_new0 (MTPMonEntry,1 ); + entry->handle = o->handle; + entry->event =EVT_OBJ_INFO_CHANGED ; +trace_usb_mtp_file_monitor_event (s->dev.addr, o->path,"Obj Modified" ); +break ; - fd =inotify_init1 (IN_NONBLOCK ); -if (fd ==-1 ) { -return 1 ; - } +case QFILE_MONITOR_EVENT_IGNORED : +trace_usb_mtp_file_monitor_event (s->dev.addr, parent->path, +"Obj parent dir ignored" ); +break ; -QTAILQ_INIT (&s->events); - s->inotifyfd = fd; +case QFILE_MONITOR_EVENT_ATTRIBUTES : +break ; -qemu_set_fd_handler (fd, inotify_watchfn,NULL , s); +default : +g_assert_not_reached (); + } -return 0 ; +if (entry) { +QTAILQ_INSERT_HEAD (&s->events, entry, next); + } } -static void usb_mtp_inotify_cleanup (MTPState *s) +static void usb_mtp_file_monitor_cleanup (MTPState *s) {MTPMonEntry *e, *p; -if (!s->inotifyfd) { -return ; - } - -qemu_set_fd_handler (s->inotifyfd,NULL ,NULL , s); -close (s->inotifyfd); - QTAILQ_FOREACH_SAFE(e, &s->events, next, p) {QTAILQ_REMOVE (&s->events, e, next);g_free (e); } -} -static int usb_mtp_add_watch (int inotifyfd,const char *path) -{ -uint32_t mask =IN_CREATE |IN_DELETE |IN_MODIFY ; - -return inotify_add_watch (inotifyfd, path, mask); +qemu_file_monitor_free (s->file_monitor); + s->file_monitor =NULL ; } -#endif +static void usb_mtp_object_readdir (MTPState *s,MTPObject *o) {struct dirent *entry;DIR *dir;int fd; +Error *err =NULL ;if (o->have_children) {return ;
@@ -679,16 +623,21 @@ static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)close (fd);return ; } -#ifdef CONFIG_INOTIFY1 -int watchfd =usb_mtp_add_watch (s->inotifyfd, o->path); -if (watchfd ==-1 ) { -fprintf (stderr,"usb-mtp: failed to add watch for %s\n" , o->path); - }else { -trace_usb_mtp_inotify_event (s->dev.addr, o->path, -0 ,"Watch Added" ); - o->watchfd = watchfd; + +if (s->file_monitor) { +int id =qemu_file_monitor_add_watch (s->file_monitor, o->path,NULL , + file_monitor_event, s, &err); +if (id ==-1 ) { +error_report ("usb-mtp: failed to add watch for %s: %s" , o->path, +error_get_pretty (err)); +error_free (err); + }else { +trace_usb_mtp_file_monitor_event (s->dev.addr, o->path, +"Watch Added" ); + o->watchid = id; + } } -#endif +while ((entry =readdir (dir)) !=NULL ) {usb_mtp_add_child (s, o, entry->d_name); }
@@ -1196,13 +1145,11 @@ enum {/* Assumes that children, if any, have been already freed */ static void usb_mtp_object_free_one (MTPState *s,MTPObject *o) { -#ifndef CONFIG_INOTIFY1 assert (o->nchildren ==0 );QTAILQ_REMOVE (&s->objects, o, next);g_free (o->name);g_free (o->path);g_free (o); -#endif }static int usb_mtp_deletefn (MTPState *s,MTPObject *o,uint32_t trans)
@@ -1301,6 +1248,7 @@ static void usb_mtp_command(MTPState *s, MTPControl *c)MTPData *data_in =NULL ;MTPObject *o =NULL ;uint32_t nres =0 , res0 =0 ; +Error *err =NULL ;/* sanity checks */ if (c->code >=CMD_CLOSE_SESSION && s->session ==0 ) {
@@ -1328,19 +1276,21 @@ static void usb_mtp_command(MTPState *s, MTPControl *c)trace_usb_mtp_op_open_session (s->dev.addr); s->session = c->argv[0 ];usb_mtp_object_alloc (s, s->next_handle++,NULL , s->root); -#ifdef CONFIG_INOTIFY1 -if (usb_mtp_inotify_init (s)) { -fprintf (stderr,"usb-mtp: file monitoring init failed\n" ); + + s->file_monitor =qemu_file_monitor_new (&err); +if (err) { +error_report ("usb-mtp: file monitoring init failed: %s" , +error_get_pretty (err)); +error_free (err); + }else { +QTAILQ_INIT (&s->events); } -#endif break ;case CMD_CLOSE_SESSION :trace_usb_mtp_op_close_session (s->dev.addr); s->session =0 ; s->next_handle =0 ; -#ifdef CONFIG_INOTIFY1 -usb_mtp_inotify_cleanup (s); -#endif +usb_mtp_file_monitor_cleanup (s);usb_mtp_object_free (s,QTAILQ_FIRST (&s->objects));assert (QTAILQ_EMPTY (&s->objects));break ;
@@ -1553,9 +1503,7 @@ static void usb_mtp_handle_reset(USBDevice *dev)trace_usb_mtp_reset (s->dev.addr); -#ifdef CONFIG_INOTIFY1 -usb_mtp_inotify_cleanup (s); -#endif +usb_mtp_file_monitor_cleanup (s);usb_mtp_object_free (s,QTAILQ_FIRST (&s->objects)); s->session =0 ;usb_mtp_data_free (s->data_in);
@@ -2026,7 +1974,6 @@ static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p) }break ;case EP_EVENT : -#ifdef CONFIG_INOTIFY1 if (!QTAILQ_EMPTY (&s->events)) {struct MTPMonEntry *e =QTAILQ_LAST (&s->events);uint32_t handle;
@@ -2050,7 +1997,6 @@ static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p)g_free (e);return ; } -#endif p->status =USB_RET_NAK ;return ;default :
hw/usb/trace-events +1 -1
@@ -237,7 +237,7 @@ usb_mtp_op_unknown(int dev, uint32_t code) "dev %d, command code 0x%x" usb_mtp_object_alloc(int dev, uint32_t handle, const char *path) "dev %d, handle 0x%x, path %s" usb_mtp_object_free(int dev, uint32_t handle, const char *path) "dev %d, handle 0x%x, path %s" usb_mtp_add_child(int dev, uint32_t handle, const char *path) "dev %d, handle 0x%x, path %s" -usb_mtp_inotify_event(int dev, const char *path, uint32_t mask, const char *s) "dev %d, path %s mask 0x%x event %s" +usb_mtp_file_monitor_event(int dev, const char *path, const char *s) "dev %d, path %s event %s" # hw/usb/host-libusb.c usb_host_open_started(int bus, int addr) "dev %d:%d"
Signature · 1 line
2.20.1
Re: [Qemu-devel] [PATCH v8 05/11] hw/usb: switch MTP to use new inotify APIs
Hi
Quoted 5 lines · Daniel P. Berrangé
The internal inotify APIs allow a lot of conditional statements to be cleared out, and provide a simpler callback for handling events.
Signed-off-by Daniel P. Berrangé <[email protected]>
Quoted 471 lines
--- hw/usb/dev-mtp.c | 274 ++++++++++++++++++-------------------------- hw/usb/trace-events | 2 +- 2 files changed, 111 insertions(+), 165 deletions(-)hw/usb/dev-mtp.c +110
-164@@ -11,17 +11,16 @@#include "qemu/osdep.h" #include "qapi/error.h" +#include "qemu/error-report.h" #include <wchar.h> #include <dirent.h> #include <sys/statvfs.h> -#ifdef CONFIG_INOTIFY1 -#include <sys/inotify.h> -#include "qemu/main-loop.h" -#endif +#include "qemu-common.h" #include "qemu/iov.h" +#include "qemu/filemonitor.h" #include "trace.h" #include "hw/usb.h" #include "desc.h" @@ -132,7 +131,6 @@ enum { EP_EVENT, }; -#ifdef CONFIG_INOTIFY1 typedef struct MTPMonEntry MTPMonEntry ;struct MTPMonEntry {@@ -141,7 +139,6 @@ struct MTPMonEntry {QTAILQ_ENTRY (MTPMonEntry) next; }; -#endif struct MTPControl {uint16_t code;@@ -172,10 +169,8 @@ struct MTPObject {char *name;char *path;struct stat stat; -#ifdef CONFIG_INOTIFY1 -/* inotify watch cookie */ -int watchfd; -#endif +/* file monitor watch id */ +int watchid;MTPObject *parent;uint32_t nchildren; QLIST_HEAD(, MTPObject) children;@@ -198,11 +193,8 @@ struct MTPState {bool readonly; QTAILQ_HEAD(, MTPObject) objects; -#ifdef CONFIG_INOTIFY1 -/* inotify descriptor */ -int inotifyfd; +QFileMonitor *file_monitor; QTAILQ_HEAD(, MTPMonEntry) events; -#endif /* Responder is expecting a write operation */ bool write_pending;struct {@@ -391,6 +383,7 @@ static MTPObject *usb_mtp_object_alloc(MTPState *s, uint32_t handle, goto ignore; } + o->watchid =-1 ; o->handle = handle; o->parent = parent; o->name =g_strdup (name);@@ -437,6 +430,10 @@ static void usb_mtp_object_free(MTPState *s, MTPObject *o)trace_usb_mtp_object_free (s->dev.addr, o->handle, o->path); +if (o->watchid !=-1 && s->file_monitor) { +qemu_file_monitor_remove_watch (s->file_monitor, o->path, o->watchid); + } +QTAILQ_REMOVE (&s->objects, o, next);if (o->parent) {QLIST_REMOVE (o, list);@@ -488,6 +485,10 @@ static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent, {MTPObject *iter; +if (len ==-1 ) { + len =strlen (name); + } + QLIST_FOREACH(iter, &parent->children, list) {if (strncmp (iter->name, name, len) ==0 ) {return iter;@@ -497,13 +498,12 @@ static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent,return NULL ; } -#ifdef CONFIG_INOTIFY1 -static MTPObject *usb_mtp_object_lookup_wd (MTPState *s,int wd) +static MTPObject *usb_mtp_object_lookup_id (MTPState *s,int id) {MTPObject *iter; QTAILQ_FOREACH(iter, &s->objects, next) { -if (iter->watchfd == wd) { +if (iter->watchid == id) {return iter; } }@@ -511,159 +511,103 @@ static MTPObject *usb_mtp_object_lookup_wd(MTPState *s, int wd)return NULL ; } -static void inotify_watchfn (void *arg) +static void file_monitor_event (int id, +QFileMonitorEvent ev, +const char *name, +void *opaque) { -MTPState *s = arg; -ssize_t bytes; -/* From the man page: atleast one event can be read */ -int pos; -char buf[sizeof (struct inotify_event ) +NAME_MAX +1 ]; - -for (;;) { - bytes =read (s->inotifyfd, buf,sizeof (buf)); - pos =0 ; - -if (bytes <=0 ) { -/* Better luck next time */ +MTPState *s = opaque; +MTPObject *parent =usb_mtp_object_lookup_id (s, id); +MTPMonEntry *entry =NULL ; +MTPObject *o; + +if (!parent) { +return ; + } + +switch (ev) { +case QFILE_MONITOR_EVENT_CREATED : +if (usb_mtp_object_lookup_name (parent, name,-1 )) { +/* Duplicate create event */ return ; } + entry =g_new0 (MTPMonEntry,1 ); + entry->handle = s->next_handle; + entry->event =EVT_OBJ_ADDED ; + o =usb_mtp_add_child (s, parent, name); +if (!o) { +g_free (entry); +return ; + } +trace_usb_mtp_file_monitor_event (s->dev.addr, name,"Obj Added" ); +break ; +case QFILE_MONITOR_EVENT_DELETED :/* -* TODO: Ignore initiator initiated events. -* For now we are good because the store is RO +* The kernel issues a IN_IGNORED event +* when a dir containing a watchpoint is +* deleted, so we don't have to delete the +* watchpoint */ -while (bytes >0 ) { -char *p = buf + pos; -struct inotify_event *event = (struct inotify_event *)p; -int watchfd =0 ; -uint32_t mask = event->mask & (IN_CREATE |IN_DELETE | -IN_MODIFY |IN_IGNORED ); -MTPObject *parent =usb_mtp_object_lookup_wd (s, event->wd); -MTPMonEntry *entry =NULL ; -MTPObject *o; - - pos = pos +sizeof (struct inotify_event ) + event->len; - bytes = bytes - pos; - -if (!parent) { -continue ; - } - -switch (mask) { -case IN_CREATE : -if (usb_mtp_object_lookup_name - (parent, event->name, event->len)) { -/* Duplicate create event */ -continue ; - } - entry =g_new0 (MTPMonEntry,1 ); - entry->handle = s->next_handle; - entry->event =EVT_OBJ_ADDED ; - o =usb_mtp_add_child (s, parent, event->name); -if (!o) { -g_free (entry); -continue ; - } - o->watchfd = watchfd; -trace_usb_mtp_inotify_event (s->dev.addr, event->name, - event->mask,"Obj Added" ); -break ; - -case IN_DELETE : -/* -* The kernel issues a IN_IGNORED event -* when a dir containing a watchpoint is -* deleted, so we don't have to delete the -* watchpoint -*/ - o =usb_mtp_object_lookup_name (parent, event->name, event->len); -if (!o) { -continue ; - } - entry =g_new0 (MTPMonEntry,1 ); - entry->handle = o->handle; - entry->event =EVT_OBJ_REMOVED ; -trace_usb_mtp_inotify_event (s->dev.addr, o->path, - event->mask,"Obj Deleted" ); -usb_mtp_object_free (s, o); -break ; - -case IN_MODIFY : - o =usb_mtp_object_lookup_name (parent, event->name, event->len); -if (!o) { -continue ; - } - entry =g_new0 (MTPMonEntry,1 ); - entry->handle = o->handle; - entry->event =EVT_OBJ_INFO_CHANGED ; -trace_usb_mtp_inotify_event (s->dev.addr, o->path, - event->mask,"Obj Modified" ); -break ; - -case IN_IGNORED : -trace_usb_mtp_inotify_event (s->dev.addr, parent->path, - event->mask,"Obj parent dir ignored" ); -break ; - -default : -fprintf (stderr,"usb-mtp: failed to parse inotify event\n" ); -continue ; - } - -if (entry) { -QTAILQ_INSERT_HEAD (&s->events, entry, next); - } + o =usb_mtp_object_lookup_name (parent, name,-1 ); +if (!o) { +return ; } - } -} + entry =g_new0 (MTPMonEntry,1 ); + entry->handle = o->handle; + entry->event =EVT_OBJ_REMOVED ; +trace_usb_mtp_file_monitor_event (s->dev.addr, o->path,"Obj Deleted" ); +usb_mtp_object_free (s, o); +break ; -static int usb_mtp_inotify_init (MTPState *s) -{ -int fd; +case QFILE_MONITOR_EVENT_MODIFIED : + o =usb_mtp_object_lookup_name (parent, name,-1 ); +if (!o) { +return ; + } + entry =g_new0 (MTPMonEntry,1 ); + entry->handle = o->handle; + entry->event =EVT_OBJ_INFO_CHANGED ; +trace_usb_mtp_file_monitor_event (s->dev.addr, o->path,"Obj Modified" ); +break ; - fd =inotify_init1 (IN_NONBLOCK ); -if (fd ==-1 ) { -return 1 ; - } +case QFILE_MONITOR_EVENT_IGNORED : +trace_usb_mtp_file_monitor_event (s->dev.addr, parent->path, +"Obj parent dir ignored" ); +break ; -QTAILQ_INIT (&s->events); - s->inotifyfd = fd; +case QFILE_MONITOR_EVENT_ATTRIBUTES : +break ; -qemu_set_fd_handler (fd, inotify_watchfn,NULL , s); +default : +g_assert_not_reached (); + } -return 0 ; +if (entry) { +QTAILQ_INSERT_HEAD (&s->events, entry, next); + } } -static void usb_mtp_inotify_cleanup (MTPState *s) +static void usb_mtp_file_monitor_cleanup (MTPState *s) {MTPMonEntry *e, *p; -if (!s->inotifyfd) { -return ; - } - -qemu_set_fd_handler (s->inotifyfd,NULL ,NULL , s); -close (s->inotifyfd); - QTAILQ_FOREACH_SAFE(e, &s->events, next, p) {QTAILQ_REMOVE (&s->events, e, next);g_free (e); } -} -static int usb_mtp_add_watch (int inotifyfd,const char *path) -{ -uint32_t mask =IN_CREATE |IN_DELETE |IN_MODIFY ; - -return inotify_add_watch (inotifyfd, path, mask); +qemu_file_monitor_free (s->file_monitor); + s->file_monitor =NULL ; } -#endif +static void usb_mtp_object_readdir (MTPState *s,MTPObject *o) {struct dirent *entry;DIR *dir;int fd; +Error *err =NULL ;if (o->have_children) {return ;@@ -679,16 +623,21 @@ static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)close (fd);return ; } -#ifdef CONFIG_INOTIFY1 -int watchfd =usb_mtp_add_watch (s->inotifyfd, o->path); -if (watchfd ==-1 ) { -fprintf (stderr,"usb-mtp: failed to add watch for %s\n" , o->path); - }else { -trace_usb_mtp_inotify_event (s->dev.addr, o->path, -0 ,"Watch Added" ); - o->watchfd = watchfd; + +if (s->file_monitor) { +int id =qemu_file_monitor_add_watch (s->file_monitor, o->path,NULL , + file_monitor_event, s, &err); +if (id ==-1 ) { +error_report ("usb-mtp: failed to add watch for %s: %s" , o->path, +error_get_pretty (err)); +error_free (err); + }else { +trace_usb_mtp_file_monitor_event (s->dev.addr, o->path, +"Watch Added" ); + o->watchid = id; + } } -#endif +while ((entry =readdir (dir)) !=NULL ) {usb_mtp_add_child (s, o, entry->d_name); }@@ -1196,13 +1145,11 @@ enum {/* Assumes that children, if any, have been already freed */ static void usb_mtp_object_free_one (MTPState *s,MTPObject *o) { -#ifndef CONFIG_INOTIFY1 assert (o->nchildren ==0 );QTAILQ_REMOVE (&s->objects, o, next);g_free (o->name);g_free (o->path);g_free (o); -#endif }static int usb_mtp_deletefn (MTPState *s,MTPObject *o,uint32_t trans)@@ -1301,6 +1248,7 @@ static void usb_mtp_command(MTPState *s, MTPControl *c)MTPData *data_in =NULL ;MTPObject *o =NULL ;uint32_t nres =0 , res0 =0 ; +Error *err =NULL ;/* sanity checks */ if (c->code >=CMD_CLOSE_SESSION && s->session ==0 ) {@@ -1328,19 +1276,21 @@ static void usb_mtp_command(MTPState *s, MTPControl *c)trace_usb_mtp_op_open_session (s->dev.addr); s->session = c->argv[0 ];usb_mtp_object_alloc (s, s->next_handle++,NULL , s->root); -#ifdef CONFIG_INOTIFY1 -if (usb_mtp_inotify_init (s)) { -fprintf (stderr,"usb-mtp: file monitoring init failed\n" ); + + s->file_monitor =qemu_file_monitor_new (&err); +if (err) { +error_report ("usb-mtp: file monitoring init failed: %s" , +error_get_pretty (err)); +error_free (err); + }else { +QTAILQ_INIT (&s->events); } -#endif break ;case CMD_CLOSE_SESSION :trace_usb_mtp_op_close_session (s->dev.addr); s->session =0 ; s->next_handle =0 ; -#ifdef CONFIG_INOTIFY1 -usb_mtp_inotify_cleanup (s); -#endif +usb_mtp_file_monitor_cleanup (s);usb_mtp_object_free (s,QTAILQ_FIRST (&s->objects));assert (QTAILQ_EMPTY (&s->objects));break ;@@ -1553,9 +1503,7 @@ static void usb_mtp_handle_reset(USBDevice *dev)trace_usb_mtp_reset (s->dev.addr); -#ifdef CONFIG_INOTIFY1 -usb_mtp_inotify_cleanup (s); -#endif +usb_mtp_file_monitor_cleanup (s);usb_mtp_object_free (s,QTAILQ_FIRST (&s->objects)); s->session =0 ;usb_mtp_data_free (s->data_in);@@ -2026,7 +1974,6 @@ static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p) }break ;case EP_EVENT : -#ifdef CONFIG_INOTIFY1 if (!QTAILQ_EMPTY (&s->events)) {struct MTPMonEntry *e =QTAILQ_LAST (&s->events);uint32_t handle;@@ -2050,7 +1997,6 @@ static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p)g_free (e);return ; } -#endif p->status =USB_RET_NAK ;return ;default :hw/usb/trace-events +1
-2@@ -237,7 +237,7 @@ usb_mtp_op_unknown(int dev, uint32_t code) "dev %d, command code 0x%x" usb_mtp_object_alloc(int dev, uint32_t handle, const char *path) "dev %d, handle 0x%x, path %s" usb_mtp_object_free(int dev, uint32_t handle, const char *path) "dev %d, handle 0x%x, path %s" usb_mtp_add_child(int dev, uint32_t handle, const char *path) "dev %d, handle 0x%x, path %s" -usb_mtp_inotify_event(int dev, const char *path, uint32_t mask, const char *s) "dev %d, path %s mask 0x%x event %s" +usb_mtp_file_monitor_event(int dev, const char *path, const char *s) "dev %d, path %s event %s" # hw/usb/host-libusb.c usb_host_open_started(int bus, int addr) "dev %d:%d" --2.20.1
PATCH v8 6/11 authz: add QAuthZ object as an authorization base class
In reply to Daniel P. BerrangéFrom: "Daniel P. Berrange" <[email protected]>
The current qemu_acl module provides a simple access control list facility inside QEMU, which is used via a set of monitor commands acl_show, acl_policy, acl_add, acl_remove & acl_reset.
Note there is no ability to create ACLs - the network services (eg VNC server) were expected to create ACLs that they want to check.
There is also no way to define ACLs on the command line, nor potentially integrate with external authorization systems like polkit, pam, ldap lookup, etc.
The QAuthZ object defines a minimal abstract QOM class that can be subclassed for creating different authorization providers.
--- MAINTAINERS | 7 +++ Makefile | 10 ++-- Makefile.objs | 6 +++ Makefile.target | 2 + authz/Makefile.objs | 1 + authz/base.c | 82 +++++++++++++++++++++++++++++++ authz/trace-events | 4 ++ include/authz/base.h | 112 +++++++++++++++++++++++++++++++++++++++++++ 8 files changed, 220 insertions(+), 4 deletions(-) create mode 100644 authz/Makefile.objs create mode 100644 authz/base.c create mode 100644 authz/trace-events create mode 100644 include/authz/base.h
MAINTAINERS +7 -0
@@ -2072,6 +2072,13 @@ F: io/ F: include/io/ F: tests/test-io-* +User authorization +M: Daniel P. Berrange <[email protected]> +S: Maintained +F: authz/ +F: include/authz/ +F: tests/test-authz-* + Sockets M: Daniel P. Berrange <[email protected]> M: Gerd Hoffmann <[email protected]>
Makefile +6 -4
@@ -359,6 +359,7 @@ endif dummy := $(call unnest-vars,, \ stub-obj-y \ + authz-obj-y \ chardev-obj-y \ util-obj-y \ qga-obj-y \
@@ -423,6 +424,7 @@ qemu-options.def: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool SUBDIR_RULES=$(patsubst %,subdir-%, $(TARGET_DIRS)) SOFTMMU_SUBDIR_RULES=$(filter %-softmmu,$(SUBDIR_RULES)) +$(SOFTMMU_SUBDIR_RULES): $(authz-obj-y) $(SOFTMMU_SUBDIR_RULES): $(block-obj-y) $(SOFTMMU_SUBDIR_RULES): $(crypto-obj-y) $(SOFTMMU_SUBDIR_RULES): $(io-obj-y)
@@ -485,9 +487,9 @@ COMMON_LDADDS = libqemuutil.a qemu-img.o: qemu-img-cmds.h -qemu-img$(EXESUF): qemu-img.o $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) -qemu-nbd$(EXESUF): qemu-nbd.o $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) -qemu-io$(EXESUF): qemu-io.o $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) +qemu-img$(EXESUF): qemu-img.o $(authz-obj-y) $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) +qemu-nbd$(EXESUF): qemu-nbd.o $(authz-obj-y) $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) +qemu-io$(EXESUF): qemu-io.o $(authz-obj-y) $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) qemu-bridge-helper$(EXESUF): qemu-bridge-helper.o $(COMMON_LDADDS)
@@ -498,7 +500,7 @@ qemu-edid$(EXESUF): qemu-edid.o hw/display/edid-generate.o $(COMMON_LDADDS) fsdev/virtfs-proxy-helper$(EXESUF): fsdev/virtfs-proxy-helper.o fsdev/9p-marshal.o fsdev/9p-iov-marshal.o $(COMMON_LDADDS) fsdev/virtfs-proxy-helper$(EXESUF): LIBS += -lcap -scsi/qemu-pr-helper$(EXESUF): scsi/qemu-pr-helper.o scsi/utils.o $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) +scsi/qemu-pr-helper$(EXESUF): scsi/qemu-pr-helper.o scsi/utils.o $(authz-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS) ifdef CONFIG_MPATH scsi/qemu-pr-helper$(EXESUF): LIBS += -ludev -lmultipath -lmpathpersist endif
Makefile.objs +6 -0
@@ -19,6 +19,11 @@ util-obj-y += qapi/qapi-introspect.o chardev-obj-y = chardev/ slirp-obj-$(CONFIG_SLIRP) = slirp/ +####################################################################### +# authz-obj-y is code used by both qemu system emulation and qemu-img + +authz-obj-y = authz/ + ####################################################################### # block-obj-y is code used by both qemu system emulation and qemu-img
@@ -140,6 +145,7 @@ trace-events-subdirs = trace-events-subdirs += accel/kvm trace-events-subdirs += accel/tcg trace-events-subdirs += audio +trace-events-subdirs += authz trace-events-subdirs += block trace-events-subdirs += chardev trace-events-subdirs += crypto
Makefile.target +2 -0
@@ -178,6 +178,7 @@ include $(SRC_PATH)/Makefile.objs dummy := $(call unnest-vars,,target-obj-y) target-obj-y-save := $(target-obj-y) dummy := $(call unnest-vars,.., \ + authz-obj-y \ block-obj-y \ block-obj-m \ chardev-obj-y \
@@ -192,6 +193,7 @@ target-obj-y := $(target-obj-y-save) all-obj-y += $(common-obj-y) all-obj-y += $(target-obj-y) all-obj-y += $(qom-obj-y) +all-obj-$(CONFIG_SOFTMMU) += $(authz-obj-y) all-obj-$(CONFIG_SOFTMMU) += $(block-obj-y) $(chardev-obj-y) all-obj-$(CONFIG_USER_ONLY) += $(crypto-aes-obj-y) all-obj-$(CONFIG_SOFTMMU) += $(crypto-obj-y)
authz/Makefile.objs new file +1 -0
@@ -0,0 +1 @@ +authz-obj-y += base.o
authz/base.c new file +82 -0
82 lines not on this page · raw message
authz/trace-events new file +4 -0
@@ -0,0 +1,4 @@ +# See docs/devel/tracing.txt for syntax documentation. + +# authz/base.c +qauthz_is_allowed(void *authz, const char *identity, bool allowed) "AuthZ %p check identity=%s allowed=%d"
include/authz/base.h new file +112 -0
112 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v8 7/11 authz: add QAuthZSimple object type for easy whitelist auth checks
In reply to Daniel P. BerrangéIn many cases a single VM will just need to whilelist a single identity as the allowed user of network services. This is especially the case for TLS live migration (optionally with NBD storage) where we just need to whitelist the x509 certificate distinguished name of the source QEMU host.
Via QMP this can be configured with:
{
"execute": "object-add",
"arguments": {
"qom-type": "authz-simple",
"id": "authz0",
"props": {
"identity": "fred"
}
}
}Or via the command line
-object authz-simple,id=authz0,identity=fred
--- authz/Makefile.objs | 1 + authz/simple.c | 115 ++++++++++++++++++++++++++++++++++++++ authz/trace-events | 3 + include/authz/simple.h | 84 ++++++++++++++++++++++++++++ qemu-options.hx | 24 ++++++++ tests/Makefile.include | 3 + tests/test-authz-simple.c | 50 +++++++++++++++++ 7 files changed, 280 insertions(+) create mode 100644 authz/simple.c create mode 100644 include/authz/simple.h create mode 100644 tests/test-authz-simple.c
authz/Makefile.objs +1 -0
@@ -1 +1,2 @@ authz-obj-y += base.o +authz-obj-y += simple.o
authz/simple.c new file +115 -0
115 lines not on this page · raw message
authz/trace-events +3 -0
@@ -2,3 +2,6 @@ # authz/base.c qauthz_is_allowed(void *authz, const char *identity, bool allowed) "AuthZ %p check identity=%s allowed=%d" + +# auth/simple.c +qauthz_simple_is_allowed(void *authz, const char *wantidentity, const char *gotidentity) "AuthZ simple %p check want identity=%s got identity=%s"
include/authz/simple.h new file +84 -0
84 lines not on this page · raw message
qemu-options.hx +24 -0
@@ -4360,6 +4360,30 @@ e.g to launch a SEV guest ..... @end example + + +@item -object authz-simple,id=@var{id},identity=@var{string} + +Create an authorization object that will control access to network services. + +The @option{identity} parameter is identifies the user and its format +depends on the network service that authorization object is associated +with. For authorizing based on TLS x509 certificates, the identity must +be the x509 distinguished name. Note that care must be taken to escape +any commas in the distinguished name. + +An example authorization object to validate a x509 distinguished name +would look like: +@example + # $QEMU \ + ... + -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \ + ... +@end example + +Note the use of quotes due to the x509 distinguished name containing +whitespace, and escaping of ','. + @end table ETEXI
tests/Makefile.include +3 -0
@@ -116,6 +116,7 @@ endif check-unit-y += tests/test-timed-average$(EXESUF) check-unit-$(CONFIG_INOTIFY1) += tests/test-util-filemonitor$(EXESUF) check-unit-y += tests/test-util-sockets$(EXESUF) +check-unit-y += tests/test-authz-simple$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)
@@ -536,6 +537,7 @@ test-qapi-obj-y = tests/test-qapi-visit.o tests/test-qapi-types.o \ benchmark-crypto-obj-y = $(crypto-obj-y) $(test-qom-obj-y) test-crypto-obj-y = $(crypto-obj-y) $(test-qom-obj-y) test-io-obj-y = $(io-obj-y) $(test-crypto-obj-y) +test-authz-obj-y = $(test-qom-obj-y) $(authz-obj-y) test-block-obj-y = $(block-obj-y) $(test-io-obj-y) tests/iothread.o tests/check-qnum$(EXESUF): tests/check-qnum.o $(test-util-obj-y)
@@ -662,6 +664,7 @@ tests/test-util-filemonitor$(EXESUF): tests/test-util-filemonitor.o \ $(test-util-obj-y) tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/socket-helpers.o $(test-util-obj-y) +tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)
tests/test-authz-simple.c new file +50 -0
50 lines not on this page · raw message
Signature · 1 line
2.20.1
Re: [Qemu-devel] [PATCH v8 07/11] authz: add QAuthZSimple object type for easy whitelist auth checks
Hi
Quoted 2 lines · Daniel P. Berrangé
In many cases a single VM will just need to whilelist a single identity
whitelist
Quoted 18 lines
as the allowed user of network services. This is especially the case for TLS live migration (optionally with NBD storage) where we just need to whitelist the x509 certificate distinguished name of the source QEMU host.
Via QMP this can be configured with:
{ "execute": "object-add", "arguments": { "qom-type": "authz-simple", "id": "authz0", "props": { "identity": "fred" } } }
Quoted 7 lines
Or via the command line
-object authz-simple,id=authz0,identity=fred
Reviewed-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Daniel P. Berrange <[email protected]>
Quoted 364 lines
--- authz/Makefile.objs | 1 + authz/simple.c | 115 ++++++++++++++++++++++++++++++++++++++ authz/trace-events | 3 + include/authz/simple.h | 84 ++++++++++++++++++++++++++++ qemu-options.hx | 24 ++++++++ tests/Makefile.include | 3 + tests/test-authz-simple.c | 50 +++++++++++++++++ 7 files changed, 280 insertions(+) create mode 100644 authz/simple.c create mode 100644 include/authz/simple.h create mode 100644 tests/test-authz-simple.cauthz/Makefile.objs +1
-0@@ -1 +1,2 @@ authz-obj-y += base.o +authz-obj-y += simple.oauthz/simple.c new file +115
-0@@ -0,0 +1,115 @@ +/* +* QEMU simple authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" +#include "authz/simple.h" +#include "authz/trace.h" +#include "qom/object_interfaces.h" + +static bool qauthz_simple_is_allowed (QAuthZ *authz, +const char *identity, +Error **errp) +{ +QAuthZSimple *sauthz =QAUTHZ_SIMPLE (authz); + +trace_qauthz_simple_is_allowed (authz, sauthz->identity, identity); +return g_str_equal (identity, sauthz->identity); +} + +static void +qauthz_simple_prop_set_identity (Object *obj, +const char *value, + Error **errp G_GNUC_UNUSED) +{ +QAuthZSimple *sauthz =QAUTHZ_SIMPLE (obj); + +g_free (sauthz->identity); + sauthz->identity =g_strdup (value); +} + + +static char * +qauthz_simple_prop_get_identity (Object *obj, + Error **errp G_GNUC_UNUSED) +{ +QAuthZSimple *sauthz =QAUTHZ_SIMPLE (obj); + +return g_strdup (sauthz->identity); +} + + +static void +qauthz_simple_finalize (Object *obj) +{ +QAuthZSimple *sauthz =QAUTHZ_SIMPLE (obj); + +g_free (sauthz->identity); +} + + +static void +qauthz_simple_class_init (ObjectClass *oc,void *data) +{ +QAuthZClass *authz =QAUTHZ_CLASS (oc); + + authz->is_allowed = qauthz_simple_is_allowed; + +object_class_property_add_str (oc,"identity" , + qauthz_simple_prop_get_identity, + qauthz_simple_prop_set_identity, +NULL ); +} + + +QAuthZSimple *qauthz_simple_new (const char *id, +const char *identity, +Error **errp) +{ +return QAUTHZ_SIMPLE ( +object_new_with_props (TYPE_QAUTHZ_SIMPLE , +object_get_objects_root (), + id, errp, +"identity" , identity, +NULL )); +} + + +static const TypeInfo qauthz_simple_info = { + .parent =TYPE_QAUTHZ , + .name =TYPE_QAUTHZ_SIMPLE , + .instance_size =sizeof (QAuthZSimple), + .instance_finalize = qauthz_simple_finalize, + .class_size =sizeof (QAuthZSimpleClass), + .class_init = qauthz_simple_class_init, + .interfaces = (InterfaceInfo []) { + {TYPE_USER_CREATABLE }, + { } + } +}; + + +static void +qauthz_simple_register_types (void ) +{ +type_register_static (&qauthz_simple_info); +} + + +type_init (qauthz_simple_register_types);authz/trace-events +3
-0@@ -2,3 +2,6 @@ # authz/base.c qauthz_is_allowed(void *authz, const char *identity, bool allowed) "AuthZ %p check identity=%s allowed=%d" + +# auth/simple.c +qauthz_simple_is_allowed(void *authz, const char *wantidentity, const char *gotidentity) "AuthZ simple %p check want identity=%s got identity=%s"include/authz/simple.h new file +84
-0@@ -0,0 +1,84 @@ +/* +* QEMU simple authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#ifndef QAUTHZ_SIMPLE_H__ +#define QAUTHZ_SIMPLE_H__ + +#include "authz/base.h" + +#define TYPE_QAUTHZ_SIMPLE "authz-simple" + +#define QAUTHZ_SIMPLE_CLASS (klass) \ + OBJECT_CLASS_CHECK(QAuthZSimpleClass, (klass), \ + TYPE_QAUTHZ_SIMPLE) +#define QAUTHZ_SIMPLE_GET_CLASS (obj) \ + OBJECT_GET_CLASS(QAuthZSimpleClass, (obj), \ + TYPE_QAUTHZ_SIMPLE) +#define QAUTHZ_SIMPLE (obj) \ + INTERFACE_CHECK(QAuthZSimple, (obj), \ + TYPE_QAUTHZ_SIMPLE) + +typedef struct QAuthZSimple QAuthZSimple ; +typedef struct QAuthZSimpleClass QAuthZSimpleClass ; + + +/** +* QAuthZSimple: +* +* This authorization driver provides a simple mechanism +* for granting access based on an exact matched username. +* +* To create an instance of this class via QMP: +* +* { +* "execute": "object-add", +* "arguments": { +* "qom-type": "authz-simple", +* "id": "authz0", +* "props": { +* "identity": "fred" +* } +* } +* } +* +* Or via the command line +* +* -object authz-simple,id=authz0,identity=fred +* +*/ +struct QAuthZSimple { +QAuthZ parent_obj; + +char *identity; +}; + + +struct QAuthZSimpleClass { +QAuthZClass parent_class; +}; + + +QAuthZSimple *qauthz_simple_new (const char *id, +const char *identity, +Error **errp); + + +#endif /* QAUTHZ_SIMPLE_H__ */ +qemu-options.hx +24
-0@@ -4360,6 +4360,30 @@ e.g to launch a SEV guest @end example + + +@item -object authz-simple,id=@var{id},identity=@var{string} + +Create an authorization object that will control access to network services. + +The @option{identity} parameter is identifies the user and its format +depends on the network service that authorization object is associated +with. For authorizing based on TLS x509 certificates, the identity must +be the x509 distinguished name. Note that care must be taken to escape +any commas in the distinguished name. + +An example authorization object to validate a x509 distinguished name +would look like: +@example + # $QEMU \ + ... + -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \ + ... +@end example + +Note the use of quotes due to the x509 distinguished name containing +whitespace, and escaping of ','. + @end table ETEXItests/Makefile.include +3
-0@@ -116,6 +116,7 @@ endif check-unit-y += tests/test-timed-average$(EXESUF) check-unit-$(CONFIG_INOTIFY1) += tests/test-util-filemonitor$(EXESUF) check-unit-y += tests/test-util-sockets$(EXESUF) +check-unit-y += tests/test-authz-simple$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)@@ -536,6 +537,7 @@ test-qapi-obj-y = tests/test-qapi-visit.o tests/test-qapi-types.o \ benchmark-crypto-obj-y = $(crypto-obj-y) $(test-qom-obj-y) test-crypto-obj-y = $(crypto-obj-y) $(test-qom-obj-y) test-io-obj-y = $(io-obj-y) $(test-crypto-obj-y) +test-authz-obj-y = $(test-qom-obj-y) $(authz-obj-y) test-block-obj-y = $(block-obj-y) $(test-io-obj-y) tests/iothread.o tests/check-qnum$(EXESUF): tests/check-qnum.o $(test-util-obj-y)@@ -662,6 +664,7 @@ tests/test-util-filemonitor$(EXESUF): tests/test-util-filemonitor.o \ $(test-util-obj-y) tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/socket-helpers.o $(test-util-obj-y) +tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)tests/test-authz-simple.c new file +50
-1@@ -0,0 +1,50 @@ +/* +* QEMU simple authorization object testing +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" +#include "qapi/error.h" + +#include "authz/simple.h" + + +static void test_authz_simple (void ) +{ +QAuthZSimple *authz =qauthz_simple_new ("authz0" , +"cthulu" , + &error_abort); + +g_assert (!qauthz_is_allowed (QAUTHZ (authz),"cthul" , &error_abort)); +g_assert (qauthz_is_allowed (QAUTHZ (authz),"cthulu" , &error_abort)); +g_assert (!qauthz_is_allowed (QAUTHZ (authz),"cthuluu" , &error_abort)); +g_assert (!qauthz_is_allowed (QAUTHZ (authz),"fred" , &error_abort)); + +object_unparent (OBJECT (authz)); +} + + +int main (int argc,char **argv) +{ +g_test_init (&argc, &argv,NULL ); +module_call_init (MODULE_INIT_QOM ); + +g_test_add_func ("/authz/simple" , test_authz_simple); + +return g_test_run (); +} --2.20.1
PATCH v8 8/11 authz: add QAuthZList object type for an access control list
In reply to Daniel P. BerrangéFrom: "Daniel P. Berrange" <[email protected]>
Add a QAuthZList object type that implements the QAuthZ interface. This built-in implementation maintains a trivial access control list with a sequence of match rules and a final default policy. This replicates the functionality currently provided by the qemu_acl module.
To create an instance of this object via the QMP monitor, the syntax used would be:
{
"execute": "object-add",
"arguments": {
"qom-type": "authz-list",
"id": "authz0",
"props": {
"rules": [
{ "match": "fred", "policy": "allow", "format": "exact" },
{ "match": "bob", "policy": "allow", "format": "exact" },
{ "match": "danb", "policy": "deny", "format": "glob" },
{ "match": "dan*", "policy": "allow", "format": "exact" },
],
"policy": "deny"
}
}
}This sets up an authorization rule that allows 'fred', 'bob' and anyone whose name starts with 'dan', except for 'danb'. Everyone unmatched is denied.
It is not currently possible to create this via -object, since there is no syntax supported to specify non-scalar properties for objects. This is likely to be addressed by later support for using JSON with -object, or an equivalent approach.
In any case the future "authz-listfile" object can be used from the CLI and is likely a better choice, as it allows the ACL to be refreshed automatically on change.
--- MAINTAINERS | 1 + Makefile.objs | 2 +- authz/Makefile.objs | 1 + authz/list.c | 271 ++++++++++++++++++++++++++++++++++++++++ authz/trace-events | 4 + include/authz/list.h | 106 ++++++++++++++++ qapi/authz.json | 58 +++++++++ qapi/qapi-schema.json | 1 + tests/Makefile.include | 2 + tests/test-authz-list.c | 159 +++++++++++++++++++++++ 10 files changed, 604 insertions(+), 1 deletion(-) create mode 100644 authz/list.c create mode 100644 include/authz/list.h create mode 100644 qapi/authz.json create mode 100644 tests/test-authz-list.c
MAINTAINERS +1 -0
@@ -2076,6 +2076,7 @@ User authorization M: Daniel P. Berrange <[email protected]> S: Maintained F: authz/ +F: qapi/authz.json F: include/authz/ F: tests/test-authz-*
Makefile.objs +1 -1
@@ -1,6 +1,6 @@ QAPI_MODULES = block-core block char common crypto introspect job migration QAPI_MODULES += misc net rdma rocker run-state sockets tpm trace transaction -QAPI_MODULES += ui +QAPI_MODULES += ui authz ####################################################################### # Common libraries for tools and emulators
authz/Makefile.objs +1 -0
@@ -1,2 +1,3 @@ authz-obj-y += base.o authz-obj-y += simple.o +authz-obj-y += list.o
authz/list.c new file +271 -0
271 lines not on this page · raw message
authz/trace-events +4 -0
@@ -5,3 +5,7 @@ qauthz_is_allowed(void *authz, const char *identity, bool allowed) "AuthZ %p che # auth/simple.c qauthz_simple_is_allowed(void *authz, const char *wantidentity, const char *gotidentity) "AuthZ simple %p check want identity=%s got identity=%s" + +# auth/list.c +qauthz_list_check_rule(void *authz, const char *identity, const char *rule, int format, int policy) "AuthZ list %p check rule=%s identity=%s format=%d policy=%d" +qauthz_list_default_policy(void *authz, const char *identity, int policy) "AuthZ list %p default identity=%s policy=%d"
include/authz/list.h new file +106 -0
106 lines not on this page · raw message
qapi/authz.json new file +58 -0
58 lines not on this page · raw message
qapi/qapi-schema.json +1 -0
@@ -92,6 +92,7 @@ { 'include': 'rocker.json' } { 'include': 'tpm.json' } { 'include': 'ui.json' } +{ 'include': 'authz.json' } { 'include': 'migration.json' } { 'include': 'transaction.json' } { 'include': 'trace.json' }
tests/Makefile.include +2 -0
@@ -117,6 +117,7 @@ check-unit-y += tests/test-timed-average$(EXESUF) check-unit-$(CONFIG_INOTIFY1) += tests/test-util-filemonitor$(EXESUF) check-unit-y += tests/test-util-sockets$(EXESUF) check-unit-y += tests/test-authz-simple$(EXESUF) +check-unit-y += tests/test-authz-list$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)
@@ -665,6 +666,7 @@ tests/test-util-filemonitor$(EXESUF): tests/test-util-filemonitor.o \ tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/socket-helpers.o $(test-util-obj-y) tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) +tests/test-authz-list$(EXESUF): tests/test-authz-list.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)
tests/test-authz-list.c new file +159 -0
159 lines not on this page · raw message
Signature · 1 line
2.20.1
Re: [Qemu-devel] [PATCH v8 08/11] authz: add QAuthZList object type for an access control list
Hi
Quoted 37 lines · Daniel P. Berrangé
From: "Daniel P. Berrange" <[email protected]>
Add a QAuthZList object type that implements the QAuthZ interface. This built-in implementation maintains a trivial access control list with a sequence of match rules and a final default policy. This replicates the functionality currently provided by the
qemu_aclmodule.To create an instance of this object via the QMP monitor, the syntax used would be:
{ "execute": "object-add", "arguments": { "qom-type": "authz-list", "id": "authz0", "props": { "rules": [ { "match": "fred", "policy": "allow", "format": "exact" }, { "match": "bob", "policy": "allow", "format": "exact" }, { "match": "danb", "policy": "deny", "format": "glob" }, { "match": "dan*", "policy": "allow", "format": "exact" }, ], "policy": "deny" } } }This sets up an authorization rule that allows 'fred', 'bob' and anyone whose name starts with 'dan', except for 'danb'. Everyone unmatched is denied.
It is not currently possible to create this via -object, since there is no syntax supported to specify non-scalar properties for objects. This is likely to be addressed by later support for using JSON with -object, or an equivalent approach.
Quoted 7 lines
In any case the future "authz-listfile" object can be used from the CLI and is likely a better choice, as it allows the ACL to be refreshed automatically on change.
Reviewed-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Daniel P. Berrange <[email protected]>
Quoted 714 lines
--- MAINTAINERS | 1 + Makefile.objs | 2 +- authz/Makefile.objs | 1 + authz/list.c | 271 ++++++++++++++++++++++++++++++++++++++++ authz/trace-events | 4 + include/authz/list.h | 106 ++++++++++++++++ qapi/authz.json | 58 +++++++++ qapi/qapi-schema.json | 1 + tests/Makefile.include | 2 + tests/test-authz-list.c | 159 +++++++++++++++++++++++ 10 files changed, 604 insertions(+), 1 deletion(-) create mode 100644 authz/list.c create mode 100644 include/authz/list.h create mode 100644 qapi/authz.json create mode 100644 tests/test-authz-list.cMAINTAINERS +1
-0@@ -2076,6 +2076,7 @@ User authorization M: Daniel P. Berrange <[email protected]> S: Maintained F: authz/ +F: qapi/authz.json F: include/authz/ F: tests/test-authz-*Makefile.objs +1
-1@@ -1,6 +1,6 @@ QAPI_MODULES = block-core block char common crypto introspect job migration QAPI_MODULES += misc net rdma rocker run-state sockets tpm trace transaction -QAPI_MODULES += ui +QAPI_MODULES += ui authz ####################################################################### # Common libraries for tools and emulatorsauthz/Makefile.objs +1
-0@@ -1,2 +1,3 @@ authz-obj-y += base.o authz-obj-y += simple.o +authz-obj-y += list.oauthz/list.c new file +271
-0@@ -0,0 +1,271 @@ +/* +* QEMU access control list authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" +#include "authz/list.h" +#include "authz/trace.h" +#include "qom/object_interfaces.h" +#include "qapi/qapi-visit-authz.h" + +static bool qauthz_list_is_allowed (QAuthZ *authz, +const char *identity, +Error **errp) +{ +QAuthZList *lauthz =QAUTHZ_LIST (authz); +QAuthZListRuleList *rules = lauthz->rules; + +while (rules) { +QAuthZListRule *rule = rules->value; +QAuthZListFormat format = rule->has_format ? rule->format : +QAUTHZ_LIST_FORMAT_EXACT ; + +trace_qauthz_list_check_rule (authz, rule->match, identity, + format, rule->policy); +switch (format) { +case QAUTHZ_LIST_FORMAT_EXACT : +if (g_str_equal (rule->match, identity)) { +return rule->policy ==QAUTHZ_LIST_POLICY_ALLOW ; + } +break ; +case QAUTHZ_LIST_FORMAT_GLOB : +if (g_pattern_match_simple (rule->match, identity)) { +return rule->policy ==QAUTHZ_LIST_POLICY_ALLOW ; + } +break ; +default : +g_warn_if_reached (); +return false; + } + rules = rules->next; + } + +trace_qauthz_list_default_policy (authz, identity, lauthz->policy); +return lauthz->policy ==QAUTHZ_LIST_POLICY_ALLOW ; +} + + +static void +qauthz_list_prop_set_policy (Object *obj, +int value, + Error **errp G_GNUC_UNUSED) +{ +QAuthZList *lauthz =QAUTHZ_LIST (obj); + + lauthz->policy = value; +} + + +static int +qauthz_list_prop_get_policy (Object *obj, + Error **errp G_GNUC_UNUSED) +{ +QAuthZList *lauthz =QAUTHZ_LIST (obj); + +return lauthz->policy; +} + + +static void +qauthz_list_prop_get_rules (Object *obj,Visitor *v,const char *name, +void *opaque,Error **errp) +{ +QAuthZList *lauthz =QAUTHZ_LIST (obj); + +visit_type_QAuthZListRuleList (v, name, &lauthz->rules, errp); +} + +static void +qauthz_list_prop_set_rules (Object *obj,Visitor *v,const char *name, +void *opaque,Error **errp) +{ +QAuthZList *lauthz =QAUTHZ_LIST (obj); +QAuthZListRuleList *oldrules; + + oldrules = lauthz->rules; +visit_type_QAuthZListRuleList (v, name, &lauthz->rules, errp); + +qapi_free_QAuthZListRuleList (oldrules); +} + + +static void +qauthz_list_finalize (Object *obj) +{ +QAuthZList *lauthz =QAUTHZ_LIST (obj); + +qapi_free_QAuthZListRuleList (lauthz->rules); +} + + +static void +qauthz_list_class_init (ObjectClass *oc,void *data) +{ +QAuthZClass *authz =QAUTHZ_CLASS (oc); + +object_class_property_add_enum (oc,"policy" , +"QAuthZListPolicy" , + &QAuthZListPolicy_lookup, + qauthz_list_prop_get_policy, + qauthz_list_prop_set_policy, +NULL ); + +object_class_property_add (oc,"rules" ,"QAuthZListRule" , + qauthz_list_prop_get_rules, + qauthz_list_prop_set_rules, +NULL ,NULL ,NULL ); + + authz->is_allowed = qauthz_list_is_allowed; +} + + +QAuthZList *qauthz_list_new (const char *id, +QAuthZListPolicy policy, +Error **errp) +{ +return QAUTHZ_LIST ( +object_new_with_props (TYPE_QAUTHZ_LIST , +object_get_objects_root (), + id, errp, +"policy" ,QAuthZListPolicy_str (policy), +NULL )); +} + +ssize_t qauthz_list_append_rule (QAuthZList *auth, +const char *match, +QAuthZListPolicy policy, +QAuthZListFormat format, +Error **errp) +{ +QAuthZListRule *rule; +QAuthZListRuleList *rules, *tmp; +size_t i =0 ; + + rule =g_new0 (QAuthZListRule,1 ); + rule->policy = policy; + rule->match =g_strdup (match); + rule->format = format; + rule->has_format = true; + + tmp =g_new0 (QAuthZListRuleList,1 ); + tmp->value = rule; + + rules = auth->rules; +if (rules) { +while (rules->next) { + i++; + rules = rules->next; + } + rules->next = tmp; +return i +1 ; + }else { + auth->rules = tmp; +return 0 ; + } +} + + +ssize_t qauthz_list_insert_rule (QAuthZList *auth, +const char *match, +QAuthZListPolicy policy, +QAuthZListFormat format, +size_t index, +Error **errp) +{ +QAuthZListRule *rule; +QAuthZListRuleList *rules, *tmp; +size_t i =0 ; + + rule =g_new0 (QAuthZListRule,1 ); + rule->policy = policy; + rule->match =g_strdup (match); + rule->format = format; + rule->has_format = true; + + tmp =g_new0 (QAuthZListRuleList,1 ); + tmp->value = rule; + + rules = auth->rules; +if (rules && index >0 ) { +while (rules->next && i < (index -1 )) { + i++; + rules = rules->next; + } + tmp->next = rules->next; + rules->next = tmp; +return i +1 ; + }else { + tmp->next = auth->rules; + auth->rules = tmp; +return 0 ; + } +} + + +ssize_t qauthz_list_delete_rule (QAuthZList *auth,const char *match) +{ +QAuthZListRule *rule; +QAuthZListRuleList *rules, *prev; +size_t i =0 ; + + prev =NULL ; + rules = auth->rules; +while (rules) { + rule = rules->value; +if (g_str_equal (rule->match, match)) { +if (prev) { + prev->next = rules->next; + }else { + auth->rules = rules->next; + } + rules->next =NULL ; +qapi_free_QAuthZListRuleList (rules); +return i; + } + prev = rules; + rules = rules->next; + i++; + } + +return -1 ; +} + + +static const TypeInfo qauthz_list_info = { + .parent =TYPE_QAUTHZ , + .name =TYPE_QAUTHZ_LIST , + .instance_size =sizeof (QAuthZList), + .instance_finalize = qauthz_list_finalize, + .class_size =sizeof (QAuthZListClass), + .class_init = qauthz_list_class_init, + .interfaces = (InterfaceInfo []) { + {TYPE_USER_CREATABLE }, + { } + } +}; + + +static void +qauthz_list_register_types (void ) +{ +type_register_static (&qauthz_list_info); +} + + +type_init (qauthz_list_register_types);authz/trace-events +4
-0@@ -5,3 +5,7 @@ qauthz_is_allowed(void *authz, const char *identity, bool allowed) "AuthZ %p che # auth/simple.c qauthz_simple_is_allowed(void *authz, const char *wantidentity, const char *gotidentity) "AuthZ simple %p check want identity=%s got identity=%s" + +# auth/list.c +qauthz_list_check_rule(void *authz, const char *identity, const char *rule, int format, int policy) "AuthZ list %p check rule=%s identity=%s format=%d policy=%d" +qauthz_list_default_policy(void *authz, const char *identity, int policy) "AuthZ list %p default identity=%s policy=%d"include/authz/list.h new file +106
-0@@ -0,0 +1,106 @@ +/* +* QEMU list authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#ifndef QAUTHZ_LIST_H__ +#define QAUTHZ_LIST_H__ + +#include "authz/base.h" +#include "qapi/qapi-types-authz.h" + +#define TYPE_QAUTHZ_LIST "authz-list" + +#define QAUTHZ_LIST_CLASS (klass) \ + OBJECT_CLASS_CHECK(QAuthZListClass, (klass), \ + TYPE_QAUTHZ_LIST) +#define QAUTHZ_LIST_GET_CLASS (obj) \ + OBJECT_GET_CLASS(QAuthZListClass, (obj), \ + TYPE_QAUTHZ_LIST) +#define QAUTHZ_LIST (obj) \ + INTERFACE_CHECK(QAuthZList, (obj), \ + TYPE_QAUTHZ_LIST) + +typedef struct QAuthZList QAuthZList ; +typedef struct QAuthZListClass QAuthZListClass ; + + +/** +* QAuthZList: +* +* This authorization driver provides a list mechanism +* for granting access by matching user names against a +* list of globs. Each match rule has an associated policy +* and a catch all policy applies if no rule matches +* +* To create an instance of this class via QMP: +* +* { +* "execute": "object-add", +* "arguments": { +* "qom-type": "authz-list", +* "id": "authz0", +* "props": { +* "rules": [ +* { "match": "fred", "policy": "allow", "format": "exact" }, +* { "match": "bob", "policy": "allow", "format": "exact" }, +* { "match": "danb", "policy": "deny", "format": "exact" }, +* { "match": "dan*", "policy": "allow", "format": "glob" } +* ], +* "policy": "deny" +* } +* } +* } +* +*/ +struct QAuthZList { +QAuthZ parent_obj; + +QAuthZListPolicy policy; +QAuthZListRuleList *rules; +}; + + +struct QAuthZListClass { +QAuthZClass parent_class; +}; + + +QAuthZList *qauthz_list_new (const char *id, +QAuthZListPolicy policy, +Error **errp); + +ssize_t qauthz_list_append_rule (QAuthZList *auth, +const char *match, +QAuthZListPolicy policy, +QAuthZListFormat format, +Error **errp); + +ssize_t qauthz_list_insert_rule (QAuthZList *auth, +const char *match, +QAuthZListPolicy policy, +QAuthZListFormat format, +size_t index, +Error **errp); + +ssize_t qauthz_list_delete_rule (QAuthZList *auth, +const char *match); + + +#endif /* QAUTHZ_LIST_H__ */ +qapi/authz.json new file +58
-0@@ -0,0 +1,58 @@ +# -*- Mode: Python -*- +# +# QAPI authz definitions + +## +# @QAuthZListPolicy: +# +# The authorization policy result +# +# @deny: deny access +# @allow: allow access +# +# Since: 4.0 +## +{ 'enum': 'QAuthZListPolicy', + 'prefix': 'QAUTHZ_LIST_POLICY', + 'data': ['deny', 'allow']} + +## +# @QAuthZListFormat: +# +# The authorization policy result +# +# @exact: an exact string match +# @glob: string with ? and * shell wildcard support +# +# Since: 4.0 +## +{ 'enum': 'QAuthZListFormat', + 'prefix': 'QAUTHZ_LIST_FORMAT', + 'data': ['exact', 'glob']} + +## +# @QAuthZListRule: +# +# A single authorization rule. +# +# @match: a glob to match against a user identity +# @policy: the result to return if @match evaluates to true +# @format: (optional) the format of the @match rule (default 'exact') +# +# Since: 4.0 +## +{ 'struct': 'QAuthZListRule', + 'data': {'match': 'str', + 'policy': 'QAuthZListPolicy', + '*format': 'QAuthZListFormat'}} + +## +# @QAuthZListRuleListHack: +# +# Not exposed via QMP; hack to generate QAuthZListRuleList +# for use internally by the code. +# +# Since: 4.0 +## +{ 'struct': 'QAuthZListRuleListHack', + 'data': { 'unused': ['QAuthZListRule'] } }qapi/qapi-schema.json +1
-0@@ -92,6 +92,7 @@ { 'include': 'rocker.json' } { 'include': 'tpm.json' } { 'include': 'ui.json' } +{ 'include': 'authz.json' } { 'include': 'migration.json' } { 'include': 'transaction.json' } { 'include': 'trace.json' }tests/Makefile.include +2
-0@@ -117,6 +117,7 @@ check-unit-y += tests/test-timed-average$(EXESUF) check-unit-$(CONFIG_INOTIFY1) += tests/test-util-filemonitor$(EXESUF) check-unit-y += tests/test-util-sockets$(EXESUF) check-unit-y += tests/test-authz-simple$(EXESUF) +check-unit-y += tests/test-authz-list$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)@@ -665,6 +666,7 @@ tests/test-util-filemonitor$(EXESUF): tests/test-util-filemonitor.o \ tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/socket-helpers.o $(test-util-obj-y) tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) +tests/test-authz-list$(EXESUF): tests/test-authz-list.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)tests/test-authz-list.c new file +159
-1@@ -0,0 +1,159 @@ +/* +* QEMU list file authorization object tests +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" + +#include "authz/list.h" + +static void test_authz_default_deny (void ) +{ +QAuthZList *auth =qauthz_list_new ("auth0" , +QAUTHZ_LIST_POLICY_DENY , + &error_abort); + +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +static void test_authz_default_allow (void ) +{ +QAuthZList *auth =qauthz_list_new ("auth0" , +QAUTHZ_LIST_POLICY_ALLOW , + &error_abort); + +g_assert (qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +static void test_authz_explicit_deny (void ) +{ +QAuthZList *auth =qauthz_list_new ("auth0" , +QAUTHZ_LIST_POLICY_ALLOW , + &error_abort); + +qauthz_list_append_rule (auth,"fred" ,QAUTHZ_LIST_POLICY_DENY , +QAUTHZ_LIST_FORMAT_EXACT , &error_abort); + +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +static void test_authz_explicit_allow (void ) +{ +QAuthZList *auth =qauthz_list_new ("auth0" , +QAUTHZ_LIST_POLICY_DENY , + &error_abort); + +qauthz_list_append_rule (auth,"fred" ,QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_EXACT , &error_abort); + +g_assert (qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + + +static void test_authz_complex (void ) +{ +QAuthZList *auth =qauthz_list_new ("auth0" , +QAUTHZ_LIST_POLICY_DENY , + &error_abort); + +qauthz_list_append_rule (auth,"fred" ,QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_EXACT , &error_abort); +qauthz_list_append_rule (auth,"bob" ,QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_EXACT , &error_abort); +qauthz_list_append_rule (auth,"dan" ,QAUTHZ_LIST_POLICY_DENY , +QAUTHZ_LIST_FORMAT_EXACT , &error_abort); +qauthz_list_append_rule (auth,"dan*" ,QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_GLOB , &error_abort); + +g_assert (qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); +g_assert (qauthz_is_allowed (QAUTHZ (auth),"bob" , &error_abort)); +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"dan" , &error_abort)); +g_assert (qauthz_is_allowed (QAUTHZ (auth),"danb" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +static void test_authz_add_remove (void ) +{ +QAuthZList *auth =qauthz_list_new ("auth0" , +QAUTHZ_LIST_POLICY_ALLOW , + &error_abort); + +g_assert_cmpint (qauthz_list_append_rule (auth,"fred" , +QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_EXACT , + &error_abort), + ==, 0); +g_assert_cmpint (qauthz_list_append_rule (auth,"bob" , +QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_EXACT , + &error_abort), + ==, 1); +g_assert_cmpint (qauthz_list_append_rule (auth,"dan" , +QAUTHZ_LIST_POLICY_DENY , +QAUTHZ_LIST_FORMAT_EXACT , + &error_abort), + ==, 2); +g_assert_cmpint (qauthz_list_append_rule (auth,"frank" , +QAUTHZ_LIST_POLICY_DENY , +QAUTHZ_LIST_FORMAT_EXACT , + &error_abort), + ==, 3); + +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"dan" , &error_abort)); + +g_assert_cmpint (qauthz_list_delete_rule (auth,"dan" ), + ==, 2); + +g_assert (qauthz_is_allowed (QAUTHZ (auth),"dan" , &error_abort)); + +g_assert_cmpint (qauthz_list_insert_rule (auth,"dan" , +QAUTHZ_LIST_POLICY_DENY , +QAUTHZ_LIST_FORMAT_EXACT , +2 , + &error_abort), + ==, 2); + +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"dan" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +int main (int argc,char **argv) +{ +g_test_init (&argc, &argv,NULL ); + +module_call_init (MODULE_INIT_QOM ); + +g_test_add_func ("/auth/list/default/deny" , test_authz_default_deny); +g_test_add_func ("/auth/list/default/allow" , test_authz_default_allow); +g_test_add_func ("/auth/list/explicit/deny" , test_authz_explicit_deny); +g_test_add_func ("/auth/list/explicit/allow" , test_authz_explicit_allow); +g_test_add_func ("/auth/list/complex" , test_authz_complex); +g_test_add_func ("/auth/list/add-remove" , test_authz_add_remove); + +return g_test_run (); +} --2.20.1
PATCH v8 9/11 authz: add QAuthZListFile object type for a file access control list
In reply to Daniel P. BerrangéAdd a QAuthZListFile object type that implements the QAuthZ interface. This built-in implementation is a proxy around the QAuthZList object type, initializing it from an external file, and optionally, automatically reloading it whenever it changes.
To create an instance of this object via the QMP monitor, the syntax used would be:
{
"execute": "object-add",
"arguments": {
"qom-type": "authz-list-file",
"id": "authz0",
"props": {
"filename": "/etc/qemu/vnc.acl",
"refresh": true
}
}
}If "refresh" is "yes", inotify is used to monitor the file, automatically reloading changes. If an error occurs during reloading, all authorizations will fail until the file is next successfully loaded.
The /etc/qemu/vnc.acl file would contain a JSON representation of a QAuthZList object
{
"rules": [
{ "match": "fred", "policy": "allow", "format": "exact" },
{ "match": "bob", "policy": "allow", "format": "exact" },
{ "match": "danb", "policy": "deny", "format": "glob" },
{ "match": "dan*", "policy": "allow", "format": "exact" },
],
"policy": "deny"
}This sets up an authorization rule that allows 'fred', 'bob' and anyone whose name starts with 'dan', except for 'danb'. Everyone unmatched is denied.
The object can be loaded on the comand line using
-object authz-list-file,id=authz0,filename=/etc/qemu/vnc.acl,refresh=yes
--- authz/Makefile.objs | 1 + authz/listfile.c | 283 ++++++++++++++++++++++++++++++++++++ authz/trace-events | 4 + include/authz/listfile.h | 111 ++++++++++++++ qemu-options.hx | 46 ++++++ tests/Makefile.include | 2 + tests/test-authz-listfile.c | 195 +++++++++++++++++++++++++ 7 files changed, 642 insertions(+) create mode 100644 authz/listfile.c create mode 100644 include/authz/listfile.h create mode 100644 tests/test-authz-listfile.c
authz/Makefile.objs +1 -0
@@ -1,3 +1,4 @@ authz-obj-y += base.o authz-obj-y += simple.o authz-obj-y += list.o +authz-obj-y += listfile.o
authz/listfile.c new file +283 -0
283 lines not on this page · raw message
authz/trace-events +4 -0
@@ -9,3 +9,7 @@ qauthz_simple_is_allowed(void *authz, const char *wantidentity, const char *goti # auth/list.c qauthz_list_check_rule(void *authz, const char *identity, const char *rule, int format, int policy) "AuthZ list %p check rule=%s identity=%s format=%d policy=%d" qauthz_list_default_policy(void *authz, const char *identity, int policy) "AuthZ list %p default identity=%s policy=%d" + +# auth/listfile.c +qauthz_list_file_load(void *authz, const char *filename) "AuthZ file %p load filename=%s" +qauthz_list_file_refresh(void *authz, const char *filename, int success) "AuthZ file %p load filename=%s success=%d"
include/authz/listfile.h new file +111 -0
111 lines not on this page · raw message
qemu-options.hx +46 -0
52 lines not on this page · raw message
tests/Makefile.include +2 -0
@@ -118,6 +118,7 @@ check-unit-$(CONFIG_INOTIFY1) += tests/test-util-filemonitor$(EXESUF) check-unit-y += tests/test-util-sockets$(EXESUF) check-unit-y += tests/test-authz-simple$(EXESUF) check-unit-y += tests/test-authz-list$(EXESUF) +check-unit-y += tests/test-authz-listfile$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)
@@ -667,6 +668,7 @@ tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/socket-helpers.o $(test-util-obj-y) tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) tests/test-authz-list$(EXESUF): tests/test-authz-list.o $(test-authz-obj-y) +tests/test-authz-listfile$(EXESUF): tests/test-authz-listfile.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)
tests/test-authz-listfile.c new file +195 -0
195 lines not on this page · raw message
Signature · 1 line
2.20.1
Re: [Qemu-devel] [PATCH v8 09/11] authz: add QAuthZListFile object type for a file access control list
Hi
Quoted 43 lines · Daniel P. Berrangé
Add a QAuthZListFile object type that implements the QAuthZ interface. This built-in implementation is a proxy around the QAuthZList object type, initializing it from an external file, and optionally, automatically reloading it whenever it changes.
To create an instance of this object via the QMP monitor, the syntax used would be:
{ "execute": "object-add", "arguments": { "qom-type": "authz-list-file", "id": "authz0", "props": { "filename": "/etc/qemu/vnc.acl", "refresh": true } } }If "refresh" is "yes", inotify is used to monitor the file, automatically reloading changes. If an error occurs during reloading, all authorizations will fail until the file is next successfully loaded.
The
/etc/qemu/vnc.aclfile would contain a JSON representation of a QAuthZList object{ "rules": [ { "match": "fred", "policy": "allow", "format": "exact" }, { "match": "bob", "policy": "allow", "format": "exact" }, { "match": "danb", "policy": "deny", "format": "glob" }, { "match": "dan*", "policy": "allow", "format": "exact" }, ], "policy": "deny" }This sets up an authorization rule that allows 'fred', 'bob' and anyone whose name starts with 'dan', except for 'danb'. Everyone unmatched is denied.
Quoted 7 lines
The object can be loaded on the comand line using
-object authz-list-file,id=authz0,filename=/etc/qemu/vnc.acl,refresh=yes
Reviewed-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Daniel P. Berrangé <[email protected]>
Quoted 721 lines
--- authz/Makefile.objs | 1 + authz/listfile.c | 283 ++++++++++++++++++++++++++++++++++++ authz/trace-events | 4 + include/authz/listfile.h | 111 ++++++++++++++ qemu-options.hx | 46 ++++++ tests/Makefile.include | 2 + tests/test-authz-listfile.c | 195 +++++++++++++++++++++++++ 7 files changed, 642 insertions(+) create mode 100644 authz/listfile.c create mode 100644 include/authz/listfile.h create mode 100644 tests/test-authz-listfile.cauthz/Makefile.objs +1
-0@@ -1,3 +1,4 @@ authz-obj-y += base.o authz-obj-y += simple.o authz-obj-y += list.o +authz-obj-y += listfile.oauthz/listfile.c new file +283
-0@@ -0,0 +1,283 @@ +/* +* QEMU access control list file authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" +#include "authz/listfile.h" +#include "authz/trace.h" +#include "qemu/error-report.h" +#include "qemu/main-loop.h" +#include "qemu/sockets.h" +#include "qemu/filemonitor.h" +#include "qom/object_interfaces.h" +#include "qapi/qapi-visit-authz.h" +#include "qapi/qmp/qjson.h" +#include "qapi/qmp/qobject.h" +#include "qapi/qmp/qerror.h" +#include "qapi/qobject-input-visitor.h" + + +static bool +qauthz_list_file_is_allowed (QAuthZ *authz, +const char *identity, +Error **errp) +{ +QAuthZListFile *fauthz =QAUTHZ_LIST_FILE (authz); +if (fauthz->list) { +return qauthz_is_allowed (fauthz->list, identity, errp); + } + +return false; +} + + +static QAuthZ * +qauthz_list_file_load (QAuthZListFile *fauthz,Error **errp) +{ +GError *err =NULL ; +gchar *content =NULL ; +gsize len; +QObject *obj =NULL ; +QDict *pdict; +Visitor *v =NULL ; +QAuthZ *ret =NULL ; + +trace_qauthz_list_file_load (fauthz, fauthz->filename); +if (!g_file_get_contents (fauthz->filename, &content, &len, &err)) { +error_setg (errp,"Unable to read '%s': %s" , + fauthz->filename, err->message); + goto cleanup; + } + + obj =qobject_from_json (content, errp); +if (!obj) { + goto cleanup; + } + + pdict =qobject_to (QDict, obj); +if (!pdict) { +error_setg (errp,QERR_INVALID_PARAMETER_TYPE ,"obj" ,"dict" ); + goto cleanup; + } + + v =qobject_input_visitor_new (obj); + + ret = (QAuthZ *)user_creatable_add_type (TYPE_QAUTHZ_LIST , +NULL , pdict, v, errp); + + cleanup: +visit_free (v); +qobject_unref (obj); +if (err) { +g_error_free (err); + } +g_free (content); +return ret; +} + + +static void +qauthz_list_file_event(int wd G_GNUC_UNUSED, + QFileMonitorEvent ev G_GNUC_UNUSED, + const char *name G_GNUC_UNUSED, +void *opaque) +{ +QAuthZListFile *fauthz = opaque; +Error *err =NULL ; + +if (ev !=QFILE_MONITOR_EVENT_MODIFIED && + ev !=QFILE_MONITOR_EVENT_CREATED ) { +return ; + } + +object_unref (OBJECT (fauthz->list)); + fauthz->list =qauthz_list_file_load (fauthz, &err); +trace_qauthz_list_file_refresh (fauthz, + fauthz->filename, fauthz->list ?1 :0 ); +if (!fauthz->list) { +error_report_err (err); + } +} + +static void +qauthz_list_file_complete (UserCreatable *uc,Error **errp) +{ +QAuthZListFile *fauthz =QAUTHZ_LIST_FILE (uc); +gchar *dir =NULL , *file =NULL ; + + fauthz->list =qauthz_list_file_load (fauthz, errp); + +if (!fauthz->refresh) { +return ; + } + + fauthz->file_monitor =qemu_file_monitor_new (errp); +if (!fauthz->file_monitor) { +return ; + } + + dir =g_path_get_dirname (fauthz->filename); +if (g_str_equal (dir,"." )) { +error_setg (errp,"Filename must be an absolute path" ); + goto cleanup; + } + file =g_path_get_basename (fauthz->filename); +if (g_str_equal (file,"." )) { +error_setg (errp,"Path has no trailing filename component" ); + goto cleanup; + } + + fauthz->file_watch =qemu_file_monitor_add_watch ( + fauthz->file_monitor, dir, file, + qauthz_list_file_event, fauthz, errp); +if (fauthz->file_watch <0 ) { + goto cleanup; + } + + cleanup: +g_free (file); +g_free (dir); +} + + +static void +qauthz_list_file_prop_set_filename (Object *obj, +const char *value, + Error **errp G_GNUC_UNUSED) +{ +QAuthZListFile *fauthz =QAUTHZ_LIST_FILE (obj); + +g_free (fauthz->filename); + fauthz->filename =g_strdup (value); +} + + +static char * +qauthz_list_file_prop_get_filename (Object *obj, + Error **errp G_GNUC_UNUSED) +{ +QAuthZListFile *fauthz =QAUTHZ_LIST_FILE (obj); + +return g_strdup (fauthz->filename); +} + + +static void +qauthz_list_file_prop_set_refresh (Object *obj, +bool value, + Error **errp G_GNUC_UNUSED) +{ +QAuthZListFile *fauthz =QAUTHZ_LIST_FILE (obj); + + fauthz->refresh = value; +} + + +static bool +qauthz_list_file_prop_get_refresh (Object *obj, + Error **errp G_GNUC_UNUSED) +{ +QAuthZListFile *fauthz =QAUTHZ_LIST_FILE (obj); + +return fauthz->refresh; +} + + +static void +qauthz_list_file_finalize (Object *obj) +{ +QAuthZListFile *fauthz =QAUTHZ_LIST_FILE (obj); + +object_unref (OBJECT (fauthz->list)); +g_free (fauthz->filename); +qemu_file_monitor_free (fauthz->file_monitor); +} + + +static void +qauthz_list_file_class_init (ObjectClass *oc,void *data) +{ +UserCreatableClass *ucc =USER_CREATABLE_CLASS (oc); +QAuthZClass *authz =QAUTHZ_CLASS (oc); + + ucc->complete = qauthz_list_file_complete; + +object_class_property_add_str (oc,"filename" , + qauthz_list_file_prop_get_filename, + qauthz_list_file_prop_set_filename, +NULL ); +object_class_property_add_bool (oc,"refresh" , + qauthz_list_file_prop_get_refresh, + qauthz_list_file_prop_set_refresh, +NULL ); + + authz->is_allowed = qauthz_list_file_is_allowed; +} + + +static void +qauthz_list_file_init (Object *obj) +{ +QAuthZListFile *authz =QAUTHZ_LIST_FILE (obj); + + authz->file_watch =-1 ; +#ifdef CONFIG_INOTIFY1 + authz->refresh = TRUE; +#endif +} + + +QAuthZListFile *qauthz_list_file_new (const char *id, +const char *filename, +bool refresh, +Error **errp) +{ +return QAUTHZ_LIST_FILE ( +object_new_with_props (TYPE_QAUTHZ_LIST_FILE , +object_get_objects_root (), + id, errp, +"filename" , filename, +"refresh" , refresh ?"yes" :"no" , +NULL )); +} + + +static const TypeInfo qauthz_list_file_info = { + .parent =TYPE_QAUTHZ , + .name =TYPE_QAUTHZ_LIST_FILE , + .instance_init = qauthz_list_file_init, + .instance_size =sizeof (QAuthZListFile), + .instance_finalize = qauthz_list_file_finalize, + .class_size =sizeof (QAuthZListFileClass), + .class_init = qauthz_list_file_class_init, + .interfaces = (InterfaceInfo []) { + {TYPE_USER_CREATABLE }, + { } + } +}; + + +static void +qauthz_list_file_register_types (void ) +{ +type_register_static (&qauthz_list_file_info); +} + + +type_init (qauthz_list_file_register_types);authz/trace-events +4
-0@@ -9,3 +9,7 @@ qauthz_simple_is_allowed(void *authz, const char *wantidentity, const char *goti # auth/list.c qauthz_list_check_rule(void *authz, const char *identity, const char *rule, int format, int policy) "AuthZ list %p check rule=%s identity=%s format=%d policy=%d" qauthz_list_default_policy(void *authz, const char *identity, int policy) "AuthZ list %p default identity=%s policy=%d" + +# auth/listfile.c +qauthz_list_file_load(void *authz, const char *filename) "AuthZ file %p load filename=%s" +qauthz_list_file_refresh(void *authz, const char *filename, int success) "AuthZ file %p load filename=%s success=%d"include/authz/listfile.h new file +111
-0@@ -0,0 +1,111 @@ +/* +* QEMU list file authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#ifndef QAUTHZ_LIST_FILE_H__ +#define QAUTHZ_LIST_FILE_H__ + +#include "authz/list.h" +#include "qapi/qapi-types-authz.h" +#include "qemu/filemonitor.h" + +#define TYPE_QAUTHZ_LIST_FILE "authz-list-file" + +#define QAUTHZ_LIST_FILE_CLASS (klass) \ + OBJECT_CLASS_CHECK(QAuthZListFileClass, (klass), \ + TYPE_QAUTHZ_LIST_FILE) +#define QAUTHZ_LIST_FILE_GET_CLASS (obj) \ + OBJECT_GET_CLASS(QAuthZListFileClass, (obj), \ + TYPE_QAUTHZ_LIST_FILE) +#define QAUTHZ_LIST_FILE (obj) \ + INTERFACE_CHECK(QAuthZListFile, (obj), \ + TYPE_QAUTHZ_LIST_FILE) + +typedef struct QAuthZListFile QAuthZListFile ; +typedef struct QAuthZListFileClass QAuthZListFileClass ; + + +/** +* QAuthZListFile: +* +* This authorization driver provides a file mechanism +* for granting access by matching user names against a +* file of globs. Each match rule has an associated policy +* and a catch all policy applies if no rule matches +* +* To create an instance of this class via QMP: +* +* { +* "execute": "object-add", +* "arguments": { +* "qom-type": "authz-list-file", +* "id": "authz0", +* "props": { +* "filename": "/etc/qemu/myvm-vnc.acl", +* "refresh": true +* } +* } +* } +* +* If 'refresh' is 'yes', inotify is used to monitor for changes +* to the file and auto-reload the rules. +* +* The myvm-vnc.acl file should contain the parameters for +* the QAuthZList object in JSON format: +* +* { +* "rules": [ +* { "match": "fred", "policy": "allow", "format": "exact" }, +* { "match": "bob", "policy": "allow", "format": "exact" }, +* { "match": "danb", "policy": "deny", "format": "exact" }, +* { "match": "dan*", "policy": "allow", "format": "glob" } +* ], +* "policy": "deny" +* } +* +* The object can be created on the command line using +* +* -object authz-list-file,id=authz0,\ +* filename=/etc/qemu/myvm-vnc.acl,refresh=yes +* +*/ +struct QAuthZListFile { +QAuthZ parent_obj; + +QAuthZ *list; +char *filename; +bool refresh; +QFileMonitor *file_monitor; +int file_watch; +}; + + +struct QAuthZListFileClass { +QAuthZClass parent_class; +}; + + +QAuthZListFile *qauthz_list_file_new (const char *id, +const char *filename, +bool refresh, +Error **errp); + + +#endif /* QAUTHZ_LIST_FILE_H__ */ +qemu-options.hx +46
-0@@ -4384,6 +4384,52 @@ would look like: Note the use of quotes due to the x509 distinguished name containing whitespace, and escaping of ','. +@item -object authz-listfile,id=@var{id},filename=@var{path},refresh=@var{yes|no} + +Create an authorization object that will control access to network services. + +The @option{filename} parameter is the fully qualified path to a file +containing the access control list rules in JSON format. + +An example set of rules that match against SASL usernames might look +like: + +@example + @{ + "rules": [ + @{ "match": "fred", "policy": "allow", "format": "exact" @}, + @{ "match": "bob", "policy": "allow", "format": "exact" @}, + @{ "match": "danb", "policy": "deny", "format": "glob" @}, + @{ "match": "dan*", "policy": "allow", "format": "exact" @}, + ], + "policy": "deny" + @} +@end example + +When checking access the object will iterate over all the rules and +the first rule to match will have its @option{policy} value returned +as the result. If no rules match, then the default @option{policy} +value is returned. + +The rules can either be an exact string match, or they can use the +simple UNIX glob pattern matching to allow wildcards to be used. + +If @option{refresh} is set to true the file will be monitored +and automatically reloaded whenever its content changes. + +As with the @code{authz-simple} object, the format of the identity +strings being matched depends on the network service, but is usually +a TLS x509 distinguished name, or a SASL username. + +An example authorization object to validate a SASL username +would look like: +@example + # $QEMU \ + ... + -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=yes + ... +@end example + @end table ETEXItests/Makefile.include +2
-0@@ -118,6 +118,7 @@ check-unit-$(CONFIG_INOTIFY1) += tests/test-util-filemonitor$(EXESUF) check-unit-y += tests/test-util-sockets$(EXESUF) check-unit-y += tests/test-authz-simple$(EXESUF) check-unit-y += tests/test-authz-list$(EXESUF) +check-unit-y += tests/test-authz-listfile$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)@@ -667,6 +668,7 @@ tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/socket-helpers.o $(test-util-obj-y) tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) tests/test-authz-list$(EXESUF): tests/test-authz-list.o $(test-authz-obj-y) +tests/test-authz-listfile$(EXESUF): tests/test-authz-listfile.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)tests/test-authz-listfile.c new file +195
-1@@ -0,0 +1,195 @@ +/* +* QEMU list authorization object tests +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" +#include "qemu/main-loop.h" +#include "authz/listfile.h" + +static char *workdir; + +static gchar *qemu_authz_listfile_test_save (const gchar *name, +const gchar *cfg) +{ +gchar *path =g_strdup_printf ("%s/default-deny.cfg" , workdir); +GError *gerr =NULL ; + +if (!g_file_set_contents (path, cfg,-1 , &gerr)) { +g_printerr ("Unable to save config %s: %s\n" , + path, gerr->message); +g_error_free (gerr); +g_free (path); +rmdir (workdir); +abort (); + } + +return path; +} + +static void test_authz_default_deny (void ) +{ +gchar *file =qemu_authz_listfile_test_save ( +"default-deny.cfg" , +"{ \"policy\": \"deny\" }" ); +Error *local_err =NULL ; + +QAuthZListFile *auth =qauthz_list_file_new ("auth0" , + file, false, + &local_err); +unlink (file); +g_free (file); +g_assert (local_err ==NULL ); +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +static void test_authz_default_allow (void ) +{ +gchar *file =qemu_authz_listfile_test_save ( +"default-allow.cfg" , +"{ \"policy\": \"allow\" }" ); +Error *local_err =NULL ; + +QAuthZListFile *auth =qauthz_list_file_new ("auth0" , + file, false, + &local_err); +unlink (file); +g_free (file); +g_assert (local_err ==NULL ); +g_assert (qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +static void test_authz_explicit_deny (void ) +{ +gchar *file =qemu_authz_listfile_test_save ( +"explicit-deny.cfg" , +"{ \"rules\": [ " +" { \"match\": \"fred\"," +" \"policy\": \"deny\"," +" \"format\": \"exact\" } ]," +" \"policy\": \"allow\" }" ); +Error *local_err =NULL ; + +QAuthZListFile *auth =qauthz_list_file_new ("auth0" , + file, false, + &local_err); +unlink (file); +g_free (file); +g_assert (local_err ==NULL ); + +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + +static void test_authz_explicit_allow (void ) +{ +gchar *file =qemu_authz_listfile_test_save ( +"explicit-allow.cfg" , +"{ \"rules\": [ " +" { \"match\": \"fred\"," +" \"policy\": \"allow\"," +" \"format\": \"exact\" } ]," +" \"policy\": \"deny\" }" ); +Error *local_err =NULL ; + +QAuthZListFile *auth =qauthz_list_file_new ("auth0" , + file, false, + &local_err); +unlink (file); +g_free (file); +g_assert (local_err ==NULL ); + +g_assert (qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + + +static void test_authz_complex (void ) +{ +gchar *file =qemu_authz_listfile_test_save ( +"complex.cfg" , +"{ \"rules\": [ " +" { \"match\": \"fred\"," +" \"policy\": \"allow\"," +" \"format\": \"exact\" }," +" { \"match\": \"bob\"," +" \"policy\": \"allow\"," +" \"format\": \"exact\" }," +" { \"match\": \"dan\"," +" \"policy\": \"deny\"," +" \"format\": \"exact\" }," +" { \"match\": \"dan*\"," +" \"policy\": \"allow\"," +" \"format\": \"glob\" } ]," +" \"policy\": \"deny\" }" ); + +Error *local_err =NULL ; + +QAuthZListFile *auth =qauthz_list_file_new ("auth0" , + file, false, + &local_err); +unlink (file); +g_free (file); +g_assert (local_err ==NULL ); + +g_assert (qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); +g_assert (qauthz_is_allowed (QAUTHZ (auth),"bob" , &error_abort)); +g_assert (!qauthz_is_allowed (QAUTHZ (auth),"dan" , &error_abort)); +g_assert (qauthz_is_allowed (QAUTHZ (auth),"danb" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + + +int main (int argc,char **argv) +{ +int ret; +GError *gerr =NULL ; + +g_test_init (&argc, &argv,NULL ); + +module_call_init (MODULE_INIT_QOM ); + + workdir =g_dir_make_tmp ("qemu-test-authz-listfile-XXXXXX" , + &gerr); +if (!workdir) { +g_printerr ("Unable to create temporary dir: %s\n" , + gerr->message); +g_error_free (gerr); +abort (); + } + +g_test_add_func ("/auth/list/default/deny" , test_authz_default_deny); +g_test_add_func ("/auth/list/default/allow" , test_authz_default_allow); +g_test_add_func ("/auth/list/explicit/deny" , test_authz_explicit_deny); +g_test_add_func ("/auth/list/explicit/allow" , test_authz_explicit_allow); +g_test_add_func ("/auth/list/complex" , test_authz_complex); + + ret =g_test_run (); + +rmdir (workdir); +g_free (workdir); + +return ret; +} --2.20.1
PATCH v8 10/11 authz: add QAuthZPAM object type for authorizing using PAM
In reply to Daniel P. BerrangéFrom: "Daniel P. Berrange" <[email protected]>
Add an authorization backend that talks to PAM to check whether the user identity is allowed. This only uses the PAM account validation facility, which is essentially just a check to see if the provided username is permitted access. It doesn't use the authentication or session parts of PAM, since that's dealt with by the relevant part of QEMU (eg VNC server).
Consider starting QEMU with a VNC server and telling it to use TLS with x509 client certificates and configuring it to use an PAM to validate the x509 distinguished name. In this example we're telling it to use PAM for the QAuthZ impl with a service name of "qemu-vnc"
$ qemu-system-x86_64 \
-object tls-creds-x509,id=tls0,dir=/home/berrange/security/qemutls,\
endpoint=server,verify-peer=yes \
-object authz-pam,id=authz0,service=qemu-vnc \
-vnc :1,tls-creds=tls0,tls-authz=authz0This requires an /etc/pam/qemu-vnc file to be created with the auth rules. A very simple file based whitelist can be setup using
$ cat > /etc/pam/qemu-vnc <<EOF account requisite pam_listfile.so item=user sense=allow file=/etc/qemu/vnc.allow EOF
The /etc/qemu/vnc.allow file simply contains one username per line. Any username not in the file is denied. The usernames in this example are the x509 distinguished name from the client's x509 cert.
$ cat > /etc/qemu/vnc.allow <<EOF CN=laptop.berrange.com,O=Berrange Home,L=London,ST=London,C=GB EOF
More interesting would be to configure PAM to use an LDAP backend, so that the QEMU authorization check data can be centralized instead of requiring each compute host to have file maintained.
The main limitation with this PAM module is that the rules apply to all QEMU instances on the host. Setting up different rules per VM, would require creating a separate PAM service name & config file for every guest. An alternative approach for the future might be to not pass in the plain username to PAM, but instead combine the VM name or UUID with the username. This requires further consideration though.
--- authz/Makefile.objs | 3 + authz/pamacct.c | 149 ++++++++++++++++++++++++++++++++++++++++ authz/trace-events | 3 + configure | 37 ++++++++++ include/authz/pamacct.h | 100 +++++++++++++++++++++++++++ qemu-options.hx | 35 ++++++++++ tests/Makefile.include | 2 + tests/test-authz-pam.c | 124 +++++++++++++++++++++++++++++++++ 8 files changed, 453 insertions(+) create mode 100644 authz/pamacct.c create mode 100644 include/authz/pamacct.h create mode 100644 tests/test-authz-pam.c
authz/Makefile.objs +3 -0
@@ -2,3 +2,6 @@ authz-obj-y += base.o authz-obj-y += simple.o authz-obj-y += list.o authz-obj-y += listfile.o +authz-obj-$(CONFIG_AUTH_PAM) += pamacct.o + +pamacct.o-libs = -lpam
authz/pamacct.c new file +149 -0
149 lines not on this page · raw message
authz/trace-events +3 -0
@@ -13,3 +13,6 @@ qauthz_list_default_policy(void *authz, const char *identity, int policy) "AuthZ # auth/listfile.c qauthz_list_file_load(void *authz, const char *filename) "AuthZ file %p load filename=%s" qauthz_list_file_refresh(void *authz, const char *filename, int success) "AuthZ file %p load filename=%s success=%d" + +# auth/pam.c +qauthz_pam_check(void *authz, const char *identity, const char *service) "AuthZ PAM %p identity=%s service=%s"
configure +37 -0
@@ -463,6 +463,7 @@ gnutls="" nettle="" gcrypt="" gcrypt_hmac="no" +auth_pam="" vte="" virglrenderer="" tpm="yes"
@@ -1381,6 +1382,10 @@ for opt do ;; --enable-gcrypt) gcrypt="yes" ;; + --disable-auth-pam) auth_pam="no" + ;; + --enable-auth-pam) auth_pam="yes" + ;; --enable-rdma) rdma="yes" ;; --disable-rdma) rdma="no"
@@ -1707,6 +1712,7 @@ disabled with --disable-FEATURE, default is enabled if available: gnutls GNUTLS cryptography support nettle nettle cryptography support gcrypt libgcrypt cryptography support + auth-pam PAM access control sdl SDL UI sdl_image SDL Image support for icons gtk gtk UI
@@ -2864,6 +2870,33 @@ else fi +########################################## +# PAM probe + +if test "x$auth_pam" != "no"; then + cat > $TMPC <<EOF +#include <security/pam_appl.h> +#include <stdio.h> +int main(void) { + const char *service_name = "qemu"; + const char *user = "frank"; + const struct pam_conv *pam_conv = NULL; + pam_handle_t *pamh = NULL; + pam_start(service_name, user, pam_conv, &pamh); + return 0; +} +EOF + if compile_prog "" "-lpam" ; then + auth_pam=yes + else + if test "$auth_pam" = "yes"; then + feature_not_found "PAM" "Install PAM development package" + else + auth_pam=no + fi + fi +fi + ########################################## # getifaddrs (for tests/test-io-channel-socket )
@@ -6083,6 +6116,7 @@ echo "GNUTLS support $gnutls" echo "libgcrypt $gcrypt" echo "nettle $nettle $(echo_version $nettle $nettle_version)" echo "libtasn1 $tasn1" +echo "PAM $auth_pam" echo "curses support $curses" echo "virgl support $virglrenderer $(echo_version $virglrenderer $virgl_version)" echo "curl support $curl"
@@ -6537,6 +6571,9 @@ fi if test "$tasn1" = "yes" ; then echo "CONFIG_TASN1=y" >> $config_host_mak fi +if test "$auth_pam" = "yes" ; then + echo "CONFIG_AUTH_PAM=y" >> $config_host_mak +fi if test "$have_ifaddrs_h" = "yes" ; then echo "HAVE_IFADDRS_H=y" >> $config_host_mak fi
include/authz/pamacct.h new file +100 -0
100 lines not on this page · raw message
qemu-options.hx +35 -0
@@ -4430,6 +4430,41 @@ would look like: ... @end example +@item -object authz-pam,id=@var{id},service=@var{string} + +Create an authorization object that will control access to network services. + +The @option{service} parameter provides the name of a PAM service to use +for authorization. It requires that a file @code{/etc/pam.d/@var{service}} +exist to provide the configuration for the @code{account} subsystem. + +An example authorization object to validate a TLS x509 distinguished +name would look like: + +@example + # $QEMU \ + ... + -object authz-pam,id=auth0,service=qemu-vnc + ... +@end example + +There would then be a corresponding config file for PAM at +@code{/etc/pam.d/qemu-vnc} that contains: + +@example +account requisite pam_listfile.so item=user sense=allow \ + file=/etc/qemu/vnc.allow +@end example + +Finally the @code{/etc/qemu/vnc.allow} file would contain +the list of x509 distingished names that are permitted +access + +@example +CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB +@end example + + @end table ETEXI
tests/Makefile.include +2 -0
@@ -119,6 +119,7 @@ check-unit-y += tests/test-util-sockets$(EXESUF) check-unit-y += tests/test-authz-simple$(EXESUF) check-unit-y += tests/test-authz-list$(EXESUF) check-unit-y += tests/test-authz-listfile$(EXESUF) +check-unit-$(CONFIG_AUTH_PAM) += tests/test-authz-pam$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)
@@ -669,6 +670,7 @@ tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) tests/test-authz-list$(EXESUF): tests/test-authz-list.o $(test-authz-obj-y) tests/test-authz-listfile$(EXESUF): tests/test-authz-listfile.o $(test-authz-obj-y) +tests/test-authz-pam$(EXESUF): tests/test-authz-pam.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)
tests/test-authz-pam.c new file +124 -0
124 lines not on this page · raw message
Signature · 1 line
2.20.1
Re: [Qemu-devel] [PATCH v8 10/11] authz: add QAuthZPAM object type for authorizing using PAM
Hi Daniel,
Quoted 126 lines · Daniel P. Berrangé
From: "Daniel P. Berrange" <[email protected]>
Add an authorization backend that talks to PAM to check whether the user identity is allowed. This only uses the PAM account validation facility, which is essentially just a check to see if the provided username is permitted access. It doesn't use the authentication or session parts of PAM, since that's dealt with by the relevant part of QEMU (eg VNC server).
Consider starting QEMU with a VNC server and telling it to use TLS with x509 client certificates and configuring it to use an PAM to validate the x509 distinguished name. In this example we're telling it to use PAM for the QAuthZ impl with a service name of "qemu-vnc"
$ qemu-system-x86_64 \ -object tls-creds-x509,id=tls0,dir=/home/berrange/security/qemutls,\ endpoint=server,verify-peer=yes \ -object authz-pam,id=authz0,service=qemu-vnc \ -vnc :1,tls-creds=tls0,tls-authz=authz0This requires an
/etc/pam/qemu-vncfile to be created with the auth rules. A very simple file based whitelist can be setup using$ cat > /etc/pam/qemu-vnc <<EOF account requisite pam_listfile.so item=user sense=allow file=/etc/qemu/vnc.allow EOFThe
/etc/qemu/vnc.allowfile simply contains one username per line. Any username not in the file is denied. The usernames in this example are the x509 distinguished name from the client's x509 cert.$ cat > /etc/qemu/vnc.allow <<EOF CN=laptop.berrange.com,O=Berrange Home,L=London,ST=London,C=GB EOFMore interesting would be to configure PAM to use an LDAP backend, so that the QEMU authorization check data can be centralized instead of requiring each compute host to have file maintained.
The main limitation with this PAM module is that the rules apply to all QEMU instances on the host. Setting up different rules per VM, would require creating a separate PAM service name & config file for every guest. An alternative approach for the future might be to not pass in the plain username to PAM, but instead combine the VM name or UUID with the username. This requires further consideration though.
Signed-off-by Daniel P. Berrange <[email protected]>--- authz/Makefile.objs | 3 + authz/pamacct.c | 149 ++++++++++++++++++++++++++++++++++++++++ authz/trace-events | 3 + configure | 37 ++++++++++ include/authz/pamacct.h | 100 +++++++++++++++++++++++++++ qemu-options.hx | 35 ++++++++++ tests/Makefile.include | 2 + tests/test-authz-pam.c | 124 +++++++++++++++++++++++++++++++++ 8 files changed, 453 insertions(+) create mode 100644 authz/pamacct.c create mode 100644 include/authz/pamacct.h create mode 100644 tests/test-authz-pam.cauthz/Makefile.objs +3
-0@@ -2,3 +2,6 @@ authz-obj-y += base.o authz-obj-y += simple.o authz-obj-y += list.o authz-obj-y += listfile.o +authz-obj-$(CONFIG_AUTH_PAM) += pamacct.o + +pamacct.o-libs = -lpamauthz/pamacct.c new file +49
-0@@ -0,0 +1,149 @@ +/* +* QEMU PAM authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" +#include "authz/pamacct.h" +#include "authz/trace.h" +#include "qom/object_interfaces.h" + +#include <security/pam_appl.h> + + +static bool qauthz_pam_is_allowed (QAuthZ *authz, +const char *identity, +Error **errp) +{ +QAuthZPAM *pauthz =QAUTHZ_PAM (authz); +const struct pam_conv pam_conversation = {0 }; +pam_handle_t *pamh =NULL ; +int ret; + +trace_qauthz_pam_check (authz, identity, pauthz->service); + ret =pam_start (pauthz->service, + identity, + &pam_conversation, + &pamh); +if (ret !=PAM_SUCCESS ) { +error_setg (errp,"Unable to start PAM transaction: %s" , +pam_strerror (NULL , ret)); +return false; + } + + ret =pam_acct_mgmt (pamh,PAM_SILENT );
authz/pamacct.c line 59
Quoted 10 lines
authz/pamacct.c new file +10
-0+if (ret !=PAM_SUCCESS ) { +error_setg (errp,"Unable to authorize user '%s': %s" , + identity,pam_strerror (pamh, ret)); + goto cleanup; + } + + cleanup: +pam_end (pamh, ret); +return ret ==PAM_SUCCESS ; +}
I still need to digest this function (reading more about PAM).
Code below reviewed/tested.
Quoted 133 lines
authz/pamacct.c new file +90
-0+ + +static void +qauthz_pam_prop_set_service (Object *obj, +const char *service, + Error **errp G_GNUC_UNUSED) +{ +QAuthZPAM *pauthz =QAUTHZ_PAM (obj); + +g_free (pauthz->service); + pauthz->service =g_strdup (service); +} + + +static char * +qauthz_pam_prop_get_service (Object *obj, + Error **errp G_GNUC_UNUSED) +{ +QAuthZPAM *pauthz =QAUTHZ_PAM (obj); + +return g_strdup (pauthz->service); +} + + +static void +qauthz_pam_complete (UserCreatable *uc,Error **errp) +{ +} + + +static void +qauthz_pam_finalize (Object *obj) +{ +QAuthZPAM *pauthz =QAUTHZ_PAM (obj); + +g_free (pauthz->service); +} + + +static void +qauthz_pam_class_init (ObjectClass *oc,void *data) +{ +UserCreatableClass *ucc =USER_CREATABLE_CLASS (oc); +QAuthZClass *authz =QAUTHZ_CLASS (oc); + + ucc->complete = qauthz_pam_complete; + authz->is_allowed = qauthz_pam_is_allowed; + +object_class_property_add_str (oc,"service" , + qauthz_pam_prop_get_service, + qauthz_pam_prop_set_service, +NULL ); +} + + +QAuthZPAM *qauthz_pam_new (const char *id, +const char *service, +Error **errp) +{ +return QAUTHZ_PAM ( +object_new_with_props (TYPE_QAUTHZ_PAM , +object_get_objects_root (), + id, errp, +"service" , service, +NULL )); +} + + +static const TypeInfo qauthz_pam_info = { + .parent =TYPE_QAUTHZ , + .name =TYPE_QAUTHZ_PAM , + .instance_size =sizeof (QAuthZPAM), + .instance_finalize = qauthz_pam_finalize, + .class_size =sizeof (QAuthZPAMClass), + .class_init = qauthz_pam_class_init, + .interfaces = (InterfaceInfo []) { + {TYPE_USER_CREATABLE }, + { } + } +}; + + +static void +qauthz_pam_register_types (void ) +{ +type_register_static (&qauthz_pam_info); +} + + +type_init (qauthz_pam_register_types);authz/trace-events +3
-0@@ -13,3 +13,6 @@ qauthz_list_default_policy(void *authz, const char *identity, int policy) "AuthZ # auth/listfile.c qauthz_list_file_load(void *authz, const char *filename) "AuthZ file %p load filename=%s" qauthz_list_file_refresh(void *authz, const char *filename, int success) "AuthZ file %p load filename=%s success=%d" + +# auth/pam.c +qauthz_pam_check(void *authz, const char *identity, const char *service) "AuthZ PAM %p identity=%s service=%s"configure +6
-0@@ -463,6 +463,7 @@ gnutls="" nettle="" gcrypt="" gcrypt_hmac="no" +auth_pam="" vte="" virglrenderer="" tpm="yes"@@ -1381,6 +1382,10 @@ for opt do ;; --enable-gcrypt) gcrypt="yes" ;; + --disable-auth-pam) auth_pam="no" + ;; + --enable-auth-pam) auth_pam="yes" + ;; --enable-rdma) rdma="yes" ;; --disable-rdma) rdma="no"@@ -1707,6 +1712,7 @@ disabled with --disable-FEATURE, default is enabled if available: gnutls GNUTLS cryptography support nettle nettle cryptography support gcrypt libgcrypt cryptography support + auth-pam PAM access control sdl SDL UI sdl_image SDL Image support for icons gtk gtk UI
configure else · line 2876
Quoted 7 lines
configure +4
-0@@ -2864,6 +2870,33 @@ else fi +########################################## +# PAM probe + +if test "x$auth_pam" != "no"; then
Either check "x$auth_pam" != "xno", or "$auth_pam" != "no" (the latter seems to follow the style of this file).
Currently this condition is always true, so the script always calls compile_prog. And if an user has PAM locally installed, it is not possible to not use it.
Quoted 337 lines
configure +27
-0+ cat > $TMPC <<EOF +#include <security/pam_appl.h> +#include <stdio.h> +int main(void) { + const char *service_name = "qemu"; + const char *user = "frank"; + const struct pam_conv *pam_conv = NULL; + pam_handle_t *pamh = NULL; + pam_start(service_name, user, pam_conv, &pamh); + return 0; +} +EOF + if compile_prog "" "-lpam" ; then + auth_pam=yes + else + if test "$auth_pam" = "yes"; then + feature_not_found "PAM" "Install PAM development package" + else + auth_pam=no + fi + fi +fi + ########################################## # getifaddrs (for tests/test-io-channel-socket )@@ -6083,6 +6116,7 @@ echo "GNUTLS support $gnutls" echo "libgcrypt $gcrypt" echo "nettle $nettle $(echo_version $nettle $nettle_version)" echo "libtasn1 $tasn1" +echo "PAM $auth_pam" echo "curses support $curses" echo "virgl support $virglrenderer $(echo_version $virglrenderer $virgl_version)" echo "curl support $curl"@@ -6537,6 +6571,9 @@ fi if test "$tasn1" = "yes" ; then echo "CONFIG_TASN1=y" >> $config_host_mak fi +if test "$auth_pam" = "yes" ; then + echo "CONFIG_AUTH_PAM=y" >> $config_host_mak +fi if test "$have_ifaddrs_h" = "yes" ; then echo "HAVE_IFADDRS_H=y" >> $config_host_mak fiinclude/authz/pamacct.h new file +100
-0@@ -0,0 +1,100 @@ +/* +* QEMU PAM authorization driver +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#ifndef QAUTHZ_PAM_H__ +#define QAUTHZ_PAM_H__ + +#include "authz/base.h" + + +#define TYPE_QAUTHZ_PAM "authz-pam" + +#define QAUTHZ_PAM_CLASS (klass) \ + OBJECT_CLASS_CHECK(QAuthZPAMClass, (klass), \ + TYPE_QAUTHZ_PAM) +#define QAUTHZ_PAM_GET_CLASS (obj) \ + OBJECT_GET_CLASS(QAuthZPAMClass, (obj), \ + TYPE_QAUTHZ_PAM) +#define QAUTHZ_PAM (obj) \ + INTERFACE_CHECK(QAuthZPAM, (obj), \ + TYPE_QAUTHZ_PAM) + +typedef struct QAuthZPAM QAuthZPAM ; +typedef struct QAuthZPAMClass QAuthZPAMClass ; + + +/** +* QAuthZPAM: +* +* This authorization driver provides a PAM mechanism +* for granting access by matching user names against a +* list of globs. Each match rule has an associated policy +* and a catch all policy applies if no rule matches +* +* To create an instance of this class via QMP: +* +* { +* "execute": "object-add", +* "arguments": { +* "qom-type": "authz-pam", +* "id": "authz0", +* "parameters": { +* "service": "qemu-vnc-tls" +* } +* } +* } +* +* The driver only uses the PAM "account" verification +* subsystem. The above config would require a config +* file /etc/pam.d/qemu-vnc-tls. For a simple file +* lookup it would contain +* +* account requisite pam_listfile.so item=user sense=allow \ +* file=/etc/qemu/vnc.allow +* +* The external file would then contain a list of usernames. +* If x509 cert was being used as the username, a suitable +* entry would match the distinguish name: +* +* CN=laptop.berrange.com,O=Berrange Home,L=London,ST=London,C=GB +* +* On the command line it can be created using +* +* -object authz-pam,id=authz0,service=qemu-vnc-tls +* +*/ +struct QAuthZPAM { +QAuthZ parent_obj; + +char *service; +}; + + +struct QAuthZPAMClass { +QAuthZClass parent_class; +}; + + +QAuthZPAM *qauthz_pam_new (const char *id, +const char *service, +Error **errp); + + +#endif /* QAUTHZ_PAM_H__ */ qemu-options.hx +35
-0@@ -4430,6 +4430,41 @@ would look like: @end example +@item -object authz-pam,id=@var{id},service=@var{string} + +Create an authorization object that will control access to network services. + +The @option{service} parameter provides the name of a PAM service to use +for authorization. It requires that a file @code{/etc/pam.d/@var{service}} +exist to provide the configuration for the @code{account} subsystem. + +An example authorization object to validate a TLS x509 distinguished +name would look like: + +@example + # $QEMU \ + ... + -object authz-pam,id=auth0,service=qemu-vnc + ... +@end example + +There would then be a corresponding config file for PAM at +@code{/etc/pam.d/qemu-vnc} that contains: + +@example +account requisite pam_listfile.so item=user sense=allow \ + file=/etc/qemu/vnc.allow +@end example + +Finally the @code{/etc/qemu/vnc.allow} file would contain +the list of x509 distingished names that are permitted +access + +@example +CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB +@end example + + @end table ETEXItests/Makefile.include +2
-0@@ -119,6 +119,7 @@ check-unit-y += tests/test-util-sockets$(EXESUF) check-unit-y += tests/test-authz-simple$(EXESUF) check-unit-y += tests/test-authz-list$(EXESUF) check-unit-y += tests/test-authz-listfile$(EXESUF) +check-unit-$(CONFIG_AUTH_PAM) += tests/test-authz-pam$(EXESUF) check-unit-y += tests/test-io-task$(EXESUF) check-unit-y += tests/test-io-channel-socket$(EXESUF) check-unit-y += tests/test-io-channel-file$(EXESUF)@@ -669,6 +670,7 @@ tests/test-util-sockets$(EXESUF): tests/test-util-sockets.o \ tests/test-authz-simple$(EXESUF): tests/test-authz-simple.o $(test-authz-obj-y) tests/test-authz-list$(EXESUF): tests/test-authz-list.o $(test-authz-obj-y) tests/test-authz-listfile$(EXESUF): tests/test-authz-listfile.o $(test-authz-obj-y) +tests/test-authz-pam$(EXESUF): tests/test-authz-pam.o $(test-authz-obj-y) tests/test-io-task$(EXESUF): tests/test-io-task.o $(test-io-obj-y) tests/test-io-channel-socket$(EXESUF): tests/test-io-channel-socket.o \ tests/io-channel-helpers.o tests/socket-helpers.o $(test-io-obj-y)tests/test-authz-pam.c new file +114
-0@@ -0,0 +1,124 @@ +/* +* QEMU PAM authorization object tests +* +* Copyright (c) 2018 Red Hat, Inc. +* +* This library is free software; you can redistribute it and/or +* modify it under the terms of the GNU Lesser General Public +* License as published by the Free Software Foundation; either +* version 2 of the License, or (at your option) any later version. +* +* This library is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* Lesser General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public +* License along with this library; if not, see <http://www.gnu.org/licenses/>. +* +*/ + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "authz/pamacct.h" + +#include <security/pam_appl.h> + +static bool failauth; + +/* +* These two functions are exported by libpam.so. +* +* By defining them again here, our impls are resolved +* by the linker instead of those in libpam.so +* +* The test suite is thus isolated from the host system +* PAM setup, so we can do predictable test scenarios +*/ +int +pam_start (const char *service_name,const char *user, +const struct pam_conv *pam_conversation, +pam_handle_t **pamh) +{ + failauth = true; +if (!g_str_equal (service_name,"qemu-vnc" )) { +return PAM_AUTH_ERR ; + } + +if (g_str_equal (user,"fred" )) { + failauth = false; + } + +return PAM_SUCCESS ; +} + + +int +pam_acct_mgmt (pam_handle_t *pamh,int flags) +{ +if (failauth) { +return PAM_AUTH_ERR ; + } + +return PAM_SUCCESS ; +} + + +static void test_authz_unknown_service (void ) +{ +Error *local_err =NULL ; +QAuthZPAM *auth =qauthz_pam_new ("auth0" , +"qemu-does-not-exist" , + &error_abort); + +g_assert_nonnull (auth); + +g_assert_false (qauthz_is_allowed (QAUTHZ (auth),"fred" , &local_err)); + +error_free_or_abort (&local_err); +object_unparent (OBJECT (auth)); +} + + +static void test_authz_good_user (void ) +{ +QAuthZPAM *auth =qauthz_pam_new ("auth0" , +"qemu-vnc" , + &error_abort); + +g_assert_nonnull (auth); + +g_assert_true (qauthz_is_allowed (QAUTHZ (auth),"fred" , &error_abort)); + +object_unparent (OBJECT (auth)); +} + + +static void test_authz_bad_user (void ) +{ +Error *local_err =NULL ; +QAuthZPAM *auth =qauthz_pam_new ("auth0" , +"qemu-vnc" , + &error_abort); + +g_assert_nonnull (auth); + +g_assert_false (qauthz_is_allowed (QAUTHZ (auth),"bob" , &local_err)); + +error_free_or_abort (&local_err); +object_unparent (OBJECT (auth)); +} + + +int main (int argc,char **argv) +{
tests/test-authz-pam.c line 124
Quoted 10 lines
tests/test-authz-pam.c new file +10
-0+g_test_init (&argc, &argv,NULL ); + +module_call_init (MODULE_INIT_QOM ); + +g_test_add_func ("/auth/pam/unknown-service" , test_authz_unknown_service); +g_test_add_func ("/auth/pam/good-user" , test_authz_good_user); +g_test_add_func ("/auth/pam/bad-user" , test_authz_bad_user); + +return g_test_run (); +}
Re: [Qemu-devel] [PATCH v8 10/11] authz: add QAuthZPAM object type for authorizing using PAM
Quoted 76 lines · Philippe Mathieu-Daudé
Hi Daniel,
Quoted 73 lines · Daniel P. Berrangé
From: "Daniel P. Berrange" <[email protected]>
Add an authorization backend that talks to PAM to check whether the user identity is allowed. This only uses the PAM account validation facility, which is essentially just a check to see if the provided username is permitted access. It doesn't use the authentication or session parts of PAM, since that's dealt with by the relevant part of QEMU (eg VNC server).
Consider starting QEMU with a VNC server and telling it to use TLS with x509 client certificates and configuring it to use an PAM to validate the x509 distinguished name. In this example we're telling it to use PAM for the QAuthZ impl with a service name of "qemu-vnc"
$ qemu-system-x86_64 \ -object tls-creds-x509,id=tls0,dir=/home/berrange/security/qemutls,\ endpoint=server,verify-peer=yes \ -object authz-pam,id=authz0,service=qemu-vnc \ -vnc :1,tls-creds=tls0,tls-authz=authz0This requires an
/etc/pam/qemu-vncfile to be created with the auth rules. A very simple file based whitelist can be setup using$ cat > /etc/pam/qemu-vnc <<EOF account requisite pam_listfile.so item=user sense=allow file=/etc/qemu/vnc.allow EOFThe
/etc/qemu/vnc.allowfile simply contains one username per line. Any username not in the file is denied. The usernames in this example are the x509 distinguished name from the client's x509 cert.$ cat > /etc/qemu/vnc.allow <<EOF CN=laptop.berrange.com,O=Berrange Home,L=London,ST=London,C=GB EOFMore interesting would be to configure PAM to use an LDAP backend, so that the QEMU authorization check data can be centralized instead of requiring each compute host to have file maintained.
The main limitation with this PAM module is that the rules apply to all QEMU instances on the host. Setting up different rules per VM, would require creating a separate PAM service name & config file for every guest. An alternative approach for the future might be to not pass in the plain username to PAM, but instead combine the VM name or UUID with the username. This requires further consideration though.
Signed-off-by Daniel P. Berrange <[email protected]>---
authz/pamacct.c new file +25
-0+static bool qauthz_pam_is_allowed (QAuthZ *authz, +const char *identity, +Error **errp) +{ +QAuthZPAM *pauthz =QAUTHZ_PAM (authz); +const struct pam_conv pam_conversation = {0 }; +pam_handle_t *pamh =NULL ; +int ret; + +trace_qauthz_pam_check (authz, identity, pauthz->service); + ret =pam_start (pauthz->service, + identity, + &pam_conversation, + &pamh); +if (ret !=PAM_SUCCESS ) { +error_setg (errp,"Unable to start PAM transaction: %s" , +pam_strerror (NULL , ret)); +return false; + } + + ret =pam_acct_mgmt (pamh,PAM_SILENT ); +if (ret !=PAM_SUCCESS ) { +error_setg (errp,"Unable to authorize user '%s': %s" , + identity,pam_strerror (pamh, ret)); + goto cleanup;
Quoted 8 lines
authz/pamacct.c line 59
Quoted 6 lines
authz/pamacct.c new file +6
-0+ } + + cleanup: +pam_end (pamh, ret); +return ret ==PAM_SUCCESS ; +}I still need to digest this function (reading more about PAM).
FWIW there's reasonably good manpages 'pam(3)' and 'pam(8)' are starting points.
Quoted 12 lines
configure else · line 2876
Quoted 8 lines
configure +4
-0@@ -2864,6 +2870,33 @@ else fi +########################################## +# PAM probe + +if test "x$auth_pam" != "no"; thenEither check "x$auth_pam" != "xno", or "$auth_pam" != "no" (the latter seems to follow the style of this file).
Quoted 3 lines
Currently this condition is always true, so the script always calls
compile_prog. And if an user has PAM locally installed, it is not possible to not use it.
Opps, yes, did I say I hate shell :-)
Quoted 14 lines
Quoted 14 lines
configure +13
-0+ cat > $TMPC <<EOF +#include <security/pam_appl.h> +#include <stdio.h> +int main(void) { + const char *service_name = "qemu"; + const char *user = "frank"; + const struct pam_conv *pam_conv = NULL; + pam_handle_t *pamh = NULL; + pam_start(service_name, user, pam_conv, &pamh); + return 0; +} +EOF + if compile_prog "" "-lpam" ; then
Quoted 8 lines
configure else · line 2897
Quoted 8 lines
configure +8
-0+ auth_pam=yes + else + if test "$auth_pam" = "yes"; then + feature_not_found "PAM" "Install PAM development package" + else + auth_pam=no + fi + fi
I notice some indentation damage here now due to tabs that I'll also fix.
Regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Philippe Mathieu-Daudé
Reviewed-byRe: [Qemu-devel] [PATCH v8 10/11] authz: add QAuthZPAM object type for authorizing using PAM
Hi Daniel,
Quoted 61 lines · Daniel P. Berrangé
Quoted 60 lines · Philippe Mathieu-Daudé
Hi Daniel,
Quoted 57 lines · Daniel P. Berrangé
From: "Daniel P. Berrange" <[email protected]>
Add an authorization backend that talks to PAM to check whether the user identity is allowed. This only uses the PAM account validation facility, which is essentially just a check to see if the provided username is permitted access. It doesn't use the authentication or session parts of PAM, since that's dealt with by the relevant part of QEMU (eg VNC server).
Consider starting QEMU with a VNC server and telling it to use TLS with x509 client certificates and configuring it to use an PAM to validate the x509 distinguished name. In this example we're telling it to use PAM for the QAuthZ impl with a service name of "qemu-vnc"
$ qemu-system-x86_64 \ -object tls-creds-x509,id=tls0,dir=/home/berrange/security/qemutls,\ endpoint=server,verify-peer=yes \ -object authz-pam,id=authz0,service=qemu-vnc \ -vnc :1,tls-creds=tls0,tls-authz=authz0This requires an
/etc/pam/qemu-vncfile to be created with the auth rules. A very simple file based whitelist can be setup using$ cat > /etc/pam/qemu-vnc <<EOF account requisite pam_listfile.so item=user sense=allow file=/etc/qemu/vnc.allow EOFThe
/etc/qemu/vnc.allowfile simply contains one username per line. Any username not in the file is denied. The usernames in this example are the x509 distinguished name from the client's x509 cert.$ cat > /etc/qemu/vnc.allow <<EOF CN=laptop.berrange.com,O=Berrange Home,L=London,ST=London,C=GB EOFMore interesting would be to configure PAM to use an LDAP backend, so that the QEMU authorization check data can be centralized instead of requiring each compute host to have file maintained.
The main limitation with this PAM module is that the rules apply to all QEMU instances on the host. Setting up different rules per VM, would require creating a separate PAM service name & config file for every guest. An alternative approach for the future might be to not pass in the plain username to PAM, but instead combine the VM name or UUID with the username. This requires further consideration though.
Signed-off-by Daniel P. Berrange <[email protected]>---
authz/pamacct.c new file +9
-0+static bool qauthz_pam_is_allowed (QAuthZ *authz, +const char *identity, +Error **errp) +{ +QAuthZPAM *pauthz =QAUTHZ_PAM (authz); +const struct pam_conv pam_conversation = {0 }; +pam_handle_t *pamh =NULL ; +int ret; +
Quoted 8 lines
Quoted 8 lines
authz/pamacct.c line 45
Quoted 8 lines
authz/pamacct.c new file +8
-0+trace_qauthz_pam_check (authz, identity, pauthz->service); + ret =pam_start (pauthz->service, + identity, + &pam_conversation, + &pamh); +if (ret !=PAM_SUCCESS ) { +error_setg (errp,"Unable to start PAM transaction: %s" , +pam_strerror (NULL , ret));
"In an error case is the content of pamh undefined." So it is safer to use NULL here indeed.
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
authz/pamacct.c new file +5
-0+return false; + } + + ret =pam_acct_mgmt (pamh,PAM_SILENT ); +if (ret !=PAM_SUCCESS ) {
Quoted 8 lines
Quoted 8 lines
authz/pamacct.c line 58
Quoted 8 lines
authz/pamacct.c new file +8
-0+error_setg (errp,"Unable to authorize user '%s': %s" , + identity,pam_strerror (pamh, ret)); + goto cleanup; + } + + cleanup: +pam_end (pamh, ret); +return ret ==PAM_SUCCESS ;
Hmm I find this fragile.
A 'cleanup' label means (to me) you expect someone to eventually add more code around, and I'm worried someone add a pam_smth() call after pam_acct_mgmt(), that sets ret to PAM_SUCCESS.
It looks safer to me to simply not use any label here (for the current code, if it is extended, we'll see).
Quoted 6 lines
Quoted 3 lines
Quoted 1 line
+}
I still need to digest this function (reading more about PAM).
FWIW there's reasonably good manpages 'pam(3)' and 'pam(8)' are starting points.
Easier inverted, first 'pam(8)' then 'pam(3)' ;)
Here I realize last time I checked 'pam(3)' was 17 years ago...
Quoted 35 lines
Quoted 12 lines
configure else · line 2876
Quoted 8 lines
configure +4
-0@@ -2864,6 +2870,33 @@ else fi +########################################## +# PAM probe + +if test "x$auth_pam" != "no"; thenEither check "x$auth_pam" != "xno", or "$auth_pam" != "no" (the latter seems to follow the style of this file).
Quoted 3 lines
Currently this condition is always true, so the script always calls
compile_prog. And if an user has PAM locally installed, it is not possible to not use it.Opps, yes, did I say I hate shell :-)
Quoted 17 lines
Quoted 17 lines
configure +16
-0+ cat > $TMPC <<EOF +#include <security/pam_appl.h> +#include <stdio.h> +int main(void) { + const char *service_name = "qemu"; + const char *user = "frank"; + const struct pam_conv *pam_conv = NULL; + pam_handle_t *pamh = NULL; + pam_start(service_name, user, pam_conv, &pamh); + return 0; +} +EOF + if compile_prog "" "-lpam" ; then + auth_pam=yes + else + if test "$auth_pam" = "yes"; then
Quoted 8 lines
Quoted 5 lines
configure else · line 2897
Quoted 5 lines
configure +5
-0+ feature_not_found "PAM" "Install PAM development package" + else + auth_pam=no + fi + fiI notice some indentation damage here now due to tabs that I'll also fix.
OK.
If you agree on removing the 'cleanup' label in qauthz_pam_is_allowed(), for the whole patch:
Regards,
Phil.
Quoted 4 lines
Regards,
Daniel
Re: [Qemu-devel] [PATCH v8 10/11] authz: add QAuthZPAM object type for authorizing using PAM
Quoted 96 lines · Philippe Mathieu-Daudé
Hi Daniel,
Quoted 61 lines · Daniel P. Berrangé
Quoted 60 lines · Philippe Mathieu-Daudé
Hi Daniel,
Quoted 57 lines · Daniel P. Berrangé
From: "Daniel P. Berrange" <[email protected]>
Add an authorization backend that talks to PAM to check whether the user identity is allowed. This only uses the PAM account validation facility, which is essentially just a check to see if the provided username is permitted access. It doesn't use the authentication or session parts of PAM, since that's dealt with by the relevant part of QEMU (eg VNC server).
Consider starting QEMU with a VNC server and telling it to use TLS with x509 client certificates and configuring it to use an PAM to validate the x509 distinguished name. In this example we're telling it to use PAM for the QAuthZ impl with a service name of "qemu-vnc"
$ qemu-system-x86_64 \ -object tls-creds-x509,id=tls0,dir=/home/berrange/security/qemutls,\ endpoint=server,verify-peer=yes \ -object authz-pam,id=authz0,service=qemu-vnc \ -vnc :1,tls-creds=tls0,tls-authz=authz0This requires an
/etc/pam/qemu-vncfile to be created with the auth rules. A very simple file based whitelist can be setup using$ cat > /etc/pam/qemu-vnc <<EOF account requisite pam_listfile.so item=user sense=allow file=/etc/qemu/vnc.allow EOFThe
/etc/qemu/vnc.allowfile simply contains one username per line. Any username not in the file is denied. The usernames in this example are the x509 distinguished name from the client's x509 cert.$ cat > /etc/qemu/vnc.allow <<EOF CN=laptop.berrange.com,O=Berrange Home,L=London,ST=London,C=GB EOFMore interesting would be to configure PAM to use an LDAP backend, so that the QEMU authorization check data can be centralized instead of requiring each compute host to have file maintained.
The main limitation with this PAM module is that the rules apply to all QEMU instances on the host. Setting up different rules per VM, would require creating a separate PAM service name & config file for every guest. An alternative approach for the future might be to not pass in the plain username to PAM, but instead combine the VM name or UUID with the username. This requires further consideration though.
Signed-off-by Daniel P. Berrange <[email protected]>---
(quoted diff) +9
-0+static bool qauthz_pam_is_allowed(QAuthZ *authz, + const char *identity, + Error **errp) +{ + QAuthZPAM *pauthz = QAUTHZ_PAM(authz); + const struct pam_conv pam_conversation = { 0 }; + pam_handle_t *pamh = NULL; + int ret; +Quoted 8 lines
Quoted 8 lines
Review
Quoted 8 lines
(quoted diff) +8
-0+ trace_qauthz_pam_check(authz, identity, pauthz->service); + ret = pam_start(pauthz->service, + identity, + &pam_conversation, + &pamh); + if (ret != PAM_SUCCESS) { + error_setg(errp, "Unable to start PAM transaction: %s", + pam_strerror(NULL, ret));"In an error case is the content of pamh undefined." So it is safer to use NULL here indeed.
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
(quoted diff) +5
-0+ return false; + } + + ret = pam_acct_mgmt(pamh, PAM_SILENT); + if (ret != PAM_SUCCESS) {Quoted 8 lines
Quoted 8 lines
Review
Quoted 8 lines
(quoted diff) +8
-0+ error_setg(errp, "Unable to authorize user '%s': %s", + identity, pam_strerror(pamh, ret)); + goto cleanup; + } + + cleanup: + pam_end(pamh, ret); + return ret == PAM_SUCCESS;Hmm I find this fragile.
A 'cleanup' label means (to me) you expect someone to eventually add more code around, and I'm worried someone add a
pam_smth()call afterpam_acct_mgmt(), that sets ret toPAM_SUCCESS.
Quoted 7 lines
It looks safer to me to simply not use any label here (for the current code, if it is extended, we'll see).
If you agree on removing the 'cleanup' label in
qauthz_pam_is_allowed(), for the whole patch:Reviewed-by Philippe Mathieu-Daudé <[email protected]>
Thanks, I will squash this in:
authz/pamacct.c +3 -4
@@ -47,15 +47,14 @@ static bool qauthz_pam_is_allowed(QAuthZ *authz, } ret =pam_acct_mgmt (pamh,PAM_SILENT ); +pam_end (pamh, ret);if (ret !=PAM_SUCCESS ) {error_setg (errp,"Unable to authorize user '%s': %s" , identity,pam_strerror (pamh, ret)); - goto cleanup; +return false; } - cleanup: -pam_end (pamh, ret); -return ret ==PAM_SUCCESS ; +return true; }
Regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
PATCH v8 11/11 authz: delete existing ACL implementation
In reply to Daniel P. BerrangéFrom: "Daniel P. Berrange" <[email protected]>
The 'qemu_acl' type was a previous non-QOM based attempt to provide an authorization facility in QEMU. Because it is non-QOM based it cannot be created via the command line and requires special monitor commands to manipulate it.
The new QAuthZ subclasses provide a superset of the functionality in qemu_acl, so the latter can now be deleted. The HMP 'acl_*' monitor commands are converted to use the new QAuthZSimple data type instead in order to provide temporary backwards compatibility.
--- configure | 17 ---- crypto/tlssession.c | 35 ++++--- crypto/trace-events | 2 +- include/qemu/acl.h | 66 ------------ monitor.c | 179 ++++++++++++++++++++++----------- tests/Makefile.include | 4 +- tests/test-crypto-tlssession.c | 15 ++- tests/test-io-channel-tls.c | 16 ++- ui/vnc-auth-sasl.c | 23 +++-- ui/vnc-auth-sasl.h | 5 +- ui/vnc-auth-vencrypt.c | 2 +- ui/vnc-ws.c | 2 +- ui/vnc.c | 37 ++++--- ui/vnc.h | 4 +- util/Makefile.objs | 1 - util/acl.c | 179 --------------------------------- 16 files changed, 209 insertions(+), 378 deletions(-) delete mode 100644 include/qemu/acl.h delete mode 100644 util/acl.c
configure +0 -17
@@ -3205,20 +3205,6 @@ if test "$xkbcommon" != "no" ; then fi fi -########################################## -# fnmatch() probe, used for ACL routines -fnmatch="no" -cat > $TMPC << EOF -#include <fnmatch.h> -int main(void) -{ - fnmatch("foo", "foo", 0); - return 0; -} -EOF -if compile_prog "" "" ; then - fnmatch="yes" -fi ########################################## # xfsctl() probe, used for file-posix.c
@@ -6408,9 +6394,6 @@ if test "$xkbcommon" = "yes" ; then echo "XKBCOMMON_CFLAGS=$xkbcommon_cflags" >> $config_host_mak echo "XKBCOMMON_LIBS=$xkbcommon_libs" >> $config_host_mak fi -if test "$fnmatch" = "yes" ; then - echo "CONFIG_FNMATCH=y" >> $config_host_mak -fi if test "$xfs" = "yes" ; then echo "CONFIG_XFS=y" >> $config_host_mak fi
crypto/tlssession.c +17 -18
@@ -24,7 +24,7 @@#include "crypto/tlscredspsk.h" #include "crypto/tlscredsx509.h" #include "qapi/error.h" -#include "qemu/acl.h" +#include "authz/base.h" #include "trace.h" #ifdef CONFIG_GNUTLS
@@ -37,7 +37,7 @@ struct QCryptoTLSSession {QCryptoTLSCreds *creds;gnutls_session_t handle;char *hostname; -char *aclname; +char *authzid;bool handshakeComplete;QCryptoTLSSessionWriteFunc writeFunc;QCryptoTLSSessionReadFunc readFunc;
@@ -56,7 +56,7 @@ qcrypto_tls_session_free(QCryptoTLSSession *session)gnutls_deinit (session->handle);g_free (session->hostname);g_free (session->peername); -g_free (session->aclname); +g_free (session->authzid);object_unref (OBJECT (session->creds));g_free (session); }
@@ -95,7 +95,7 @@ qcrypto_tls_session_pull(void *opaque, void *buf, size_t len)QCryptoTLSSession *qcrypto_tls_session_new (QCryptoTLSCreds *creds,const char *hostname, -const char *aclname, +const char *authzid,QCryptoTLSCredsEndpoint endpoint,Error **errp) {
@@ -105,13 +105,13 @@ qcrypto_tls_session_new(QCryptoTLSCreds *creds, session =g_new0 (QCryptoTLSSession,1 );trace_qcrypto_tls_session_new ( session, creds, hostname ? hostname :"<none>" , - aclname ? aclname :"<none>" , endpoint); + authzid ? authzid :"<none>" , endpoint);if (hostname) { session->hostname =g_strdup (hostname); } -if (aclname) { - session->aclname =g_strdup (aclname); +if (authzid) { + session->authzid =g_strdup (authzid); } session->creds = creds;object_ref (OBJECT (creds));
@@ -262,6 +262,7 @@ qcrypto_tls_session_check_certificate(QCryptoTLSSession *session,unsigned int nCerts, i;time_t now;gnutls_x509_crt_t cert =NULL ; +Error *err =NULL ; now =time (NULL );if (now == ((time_t)-1 )) {
@@ -349,19 +350,17 @@ qcrypto_tls_session_check_certificate(QCryptoTLSSession *session, gnutls_strerror(ret)); goto error; } -if (session->aclname) { -qemu_acl *acl =qemu_acl_find (session->aclname); -int allow; -if (!acl) { -error_setg (errp,"Cannot find ACL %s" , - session->aclname); +if (session->authzid) { +bool allow; + + allow =qauthz_is_allowed_by_id (session->authzid, + session->peername, &err); +if (err) { +error_propagate (errp, err); goto error; } - - allow =qemu_acl_party_is_allowed (acl, session->peername); -if (!allow) { -error_setg (errp,"TLS x509 ACL check for %s is denied" , +error_setg (errp,"TLS x509 authz check for %s is denied" , session->peername); goto error; }
@@ -555,7 +554,7 @@ qcrypto_tls_session_get_peer_name(QCryptoTLSSession *session) QCryptoTLSSession * qcrypto_tls_session_new(QCryptoTLSCreds *creds G_GNUC_UNUSED, const char *hostname G_GNUC_UNUSED, - const char *aclname G_GNUC_UNUSED, + const char *authzid G_GNUC_UNUSED, QCryptoTLSCredsEndpoint endpoint G_GNUC_UNUSED, Error **errp) {
crypto/trace-events +1 -1
@@ -19,5 +19,5 @@ qcrypto_tls_creds_x509_load_cert(void *creds, int isServer, const char *file) "T qcrypto_tls_creds_x509_load_cert_list(void *creds, const char *file) "TLS creds x509 load cert list creds=%p file=%s" # crypto/tlssession.c -qcrypto_tls_session_new(void *session, void *creds, const char *hostname, const char *aclname, int endpoint) "TLS session new session=%p creds=%p hostname=%s aclname=%s endpoint=%d" +qcrypto_tls_session_new(void *session, void *creds, const char *hostname, const char *authzid, int endpoint) "TLS session new session=%p creds=%p hostname=%s authzid=%s endpoint=%d" qcrypto_tls_session_check_creds(void *session, const char *status) "TLS session check creds session=%p status=%s"
include/qemu/acl.h deleted +0 -66
66 lines not on this page · raw message
monitor.c +119 -60
234 lines not on this page · raw message
tests/Makefile.include +2 -2
@@ -537,8 +537,8 @@ test-qom-obj-y = $(qom-obj-y) $(test-util-obj-y) test-qapi-obj-y = tests/test-qapi-visit.o tests/test-qapi-types.o \ tests/test-qapi-introspect.o \ $(test-qom-obj-y) -benchmark-crypto-obj-y = $(crypto-obj-y) $(test-qom-obj-y) -test-crypto-obj-y = $(crypto-obj-y) $(test-qom-obj-y) +benchmark-crypto-obj-y = $(authz-obj-y) $(crypto-obj-y) $(test-qom-obj-y) +test-crypto-obj-y = $(authz-obj-y) $(crypto-obj-y) $(test-qom-obj-y) test-io-obj-y = $(io-obj-y) $(test-crypto-obj-y) test-authz-obj-y = $(test-qom-obj-y) $(authz-obj-y) test-block-obj-y = $(block-obj-y) $(test-io-obj-y) tests/iothread.o
tests/test-crypto-tlssession.c +10 -5
@@ -28,7 +28,7 @@#include "qom/object_interfaces.h" #include "qapi/error.h" #include "qemu/sockets.h" -#include "qemu/acl.h" +#include "authz/list.h" #ifdef QCRYPTO_HAVE_TLS_TEST_SUPPORT
@@ -229,7 +229,7 @@ static void test_crypto_tls_session_x509(const void *opaque)QCryptoTLSCreds *serverCreds;QCryptoTLSSession *clientSess =NULL ;QCryptoTLSSession *serverSess =NULL ; -qemu_acl *acl; +QAuthZList *auth;const char *const *wildcards;int channel[2 ];bool clientShake = false;
@@ -285,11 +285,15 @@ static void test_crypto_tls_session_x509(const void *opaque) SERVER_CERT_DIR);g_assert (serverCreds !=NULL ); - acl =qemu_acl_init ("tlssessionacl" ); -qemu_acl_reset (acl); + auth =qauthz_list_new ("tlssessionacl" , +QAUTHZ_LIST_POLICY_DENY , + &error_abort); wildcards = data->wildcards;while (wildcards && *wildcards) { -qemu_acl_append (acl,0 , *wildcards); +qauthz_list_append_rule (auth, *wildcards, +QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_GLOB , + &error_abort); wildcards++; }
@@ -377,6 +381,7 @@ static void test_crypto_tls_session_x509(const void *opaque)object_unparent (OBJECT (serverCreds));object_unparent (OBJECT (clientCreds)); +object_unparent (OBJECT (auth));qcrypto_tls_session_free (serverSess);qcrypto_tls_session_free (clientSess);
tests/test-io-channel-tls.c +11 -5
@@ -29,8 +29,8 @@#include "io-channel-helpers.h" #include "crypto/init.h" #include "crypto/tlscredsx509.h" -#include "qemu/acl.h" #include "qapi/error.h" +#include "authz/list.h" #include "qom/object_interfaces.h" #ifdef QCRYPTO_HAVE_TLS_TEST_SUPPORT
@@ -113,7 +113,7 @@ static void test_io_channel_tls(const void *opaque)QIOChannelTLS *serverChanTLS;QIOChannelSocket *clientChanSock;QIOChannelSocket *serverChanSock; -qemu_acl *acl; +QAuthZList *auth;const char *const *wildcards;int channel[2 ];struct QIOChannelTLSHandshakeData clientHandshake = { false, false };
@@ -161,11 +161,15 @@ static void test_io_channel_tls(const void *opaque) SERVER_CERT_DIR);g_assert (serverCreds !=NULL ); - acl =qemu_acl_init ("channeltlsacl" ); -qemu_acl_reset (acl); + auth =qauthz_list_new ("channeltlsacl" , +QAUTHZ_LIST_POLICY_DENY , + &error_abort); wildcards = data->wildcards;while (wildcards && *wildcards) { -qemu_acl_append (acl,0 , *wildcards); +qauthz_list_append_rule (auth, *wildcards, +QAUTHZ_LIST_POLICY_ALLOW , +QAUTHZ_LIST_FORMAT_GLOB , + &error_abort); wildcards++; }
@@ -253,6 +257,8 @@ static void test_io_channel_tls(const void *opaque)object_unref (OBJECT (serverChanSock));object_unref (OBJECT (clientChanSock)); +object_unparent (OBJECT (auth)); +close (channel[0 ]);close (channel[1 ]); }
ui/vnc-auth-sasl.c +16 -7
@@ -24,6 +24,7 @@#include "qemu/osdep.h" #include "qapi/error.h" +#include "authz/base.h" #include "vnc.h" #include "trace.h"
@@ -146,13 +147,14 @@ size_t vnc_client_read_sasl(VncState *vs)static int vnc_auth_sasl_check_access (VncState *vs) {const void *val; -int err; -int allow; +int rv; +Error *err =NULL ; +bool allow; - err =sasl_getprop (vs->sasl.conn,SASL_USERNAME , &val); -if (err !=SASL_OK ) { + rv =sasl_getprop (vs->sasl.conn,SASL_USERNAME , &val); +if (rv !=SASL_OK ) {trace_vnc_auth_fail (vs, vs->auth,"Cannot fetch SASL username" , -sasl_errstring (err,NULL ,NULL )); +sasl_errstring (rv,NULL ,NULL ));return -1 ; }if (val ==NULL ) {
@@ -163,12 +165,19 @@ static int vnc_auth_sasl_check_access(VncState *vs) vs->sasl.username =g_strdup ((const char *)val);trace_vnc_auth_sasl_username (vs, vs->sasl.username); -if (vs->vd->sasl.acl ==NULL ) { +if (vs->vd->sasl.authzid ==NULL ) {trace_vnc_auth_sasl_acl (vs,1 );return 0 ; } - allow =qemu_acl_party_is_allowed (vs->vd->sasl.acl, vs->sasl.username); + allow =qauthz_is_allowed_by_id (vs->vd->sasl.authzid, + vs->sasl.username, &err); +if (err) { +trace_vnc_auth_fail (vs, vs->auth,"Error from authz" , +error_get_pretty (err)); +error_free (err); +return -1 ; + }trace_vnc_auth_sasl_acl (vs, allow);return allow ?0 :-1 ;
ui/vnc-auth-sasl.h +3 -2
@@ -30,8 +30,8 @@typedef struct VncStateSASL VncStateSASL ;typedef struct VncDisplaySASL VncDisplaySASL ; -#include "qemu/acl.h" #include "qemu/main-loop.h" +#include "authz/base.h" struct VncStateSASL {sasl_conn_t *conn;
@@ -60,7 +60,8 @@ struct VncStateSASL { };struct VncDisplaySASL { -qemu_acl *acl; +QAuthZ *authz; +char *authzid; };void vnc_sasl_client_cleanup (VncState *vs);
ui/vnc-auth-vencrypt.c +1 -1
@@ -109,7 +109,7 @@ static int protocol_client_vencrypt_auth(VncState *vs, uint8_t *data, size_t len tls =qio_channel_tls_new_server ( vs->ioc, vs->vd->tlscreds, - vs->vd->tlsaclname, + vs->vd->tlsauthzid, &err);if (!tls) { trace_vnc_auth_fail(vs, vs->auth, "TLS setup failed",
ui/vnc-ws.c +1 -1
@@ -62,7 +62,7 @@ gboolean vncws_tls_handshake_io(QIOChannel *ioc G_GNUC_UNUSED, tls =qio_channel_tls_new_server ( vs->ioc, vs->vd->tlscreds, - vs->vd->tlsaclname, + vs->vd->tlsauthzid, &err);if (!tls) {VNC_DEBUG ("Failed to setup TLS %s\n" ,error_get_pretty (err));
ui/vnc.c +25 -12
@@ -33,7 +33,7 @@#include "qemu/option.h" #include "qemu/sockets.h" #include "qemu/timer.h" -#include "qemu/acl.h" +#include "authz/list.h" #include "qemu/config-file.h" #include "qapi/qapi-events.h" #include "qapi/error.h"
@@ -3228,12 +3228,24 @@ static void vnc_display_close(VncDisplay *vd)object_unparent (OBJECT (vd->tlscreds)); vd->tlscreds =NULL ; } -g_free (vd->tlsaclname); - vd->tlsaclname =NULL ; +if (vd->tlsauthz) { +object_unparent (OBJECT (vd->tlsauthz)); + vd->tlsauthz =NULL ; + } +g_free (vd->tlsauthzid); + vd->tlsauthzid =NULL ;if (vd->lock_key_sync) {qemu_remove_led_event_handler (vd->led); vd->led =NULL ; } +#ifdef CONFIG_VNC_SASL +if (vd->sasl.authz) { +object_unparent (OBJECT (vd->sasl.authz)); + vd->sasl.authz =NULL ; + } +g_free (vd->sasl.authzid); + vd->sasl.authzid =NULL ; +#endif }int vnc_display_password (const char *id,const char *password)
@@ -3886,23 +3898,24 @@ void vnc_display_open(const char *id, Error **errp)if (acl) {if (strcmp (vd->id,"default" ) ==0 ) { - vd->tlsaclname =g_strdup ("vnc.x509dname" ); + vd->tlsauthzid =g_strdup ("vnc.x509dname" ); }else { - vd->tlsaclname =g_strdup_printf ("vnc.%s.x509dname" , vd->id); + vd->tlsauthzid =g_strdup_printf ("vnc.%s.x509dname" , vd->id); } -qemu_acl_init (vd->tlsaclname); + vd->tlsauthz =QAUTHZ (qauthz_list_new (vd->tlsauthzid, +QAUTHZ_LIST_POLICY_DENY , + &error_abort)); }#ifdef CONFIG_VNC_SASL if (acl && sasl) { -char *aclname; -if (strcmp (vd->id,"default" ) ==0 ) { - aclname =g_strdup ("vnc.username" ); + vd->sasl.authzid =g_strdup ("vnc.username" ); }else { - aclname =g_strdup_printf ("vnc.%s.username" , vd->id); + vd->sasl.authzid =g_strdup_printf ("vnc.%s.username" , vd->id); } - vd->sasl.acl =qemu_acl_init (aclname); -g_free (aclname); + vd->sasl.authz =QAUTHZ (qauthz_list_new (vd->sasl.authzid, +QAUTHZ_LIST_POLICY_DENY , + &error_abort)); }#endif
ui/vnc.h +3 -1
@@ -39,6 +39,7 @@#include "io/channel-socket.h" #include "io/channel-tls.h" #include "io/net-listener.h" +#include "authz/base.h" #include <zlib.h> #include "keymaps.h"
@@ -178,7 +179,8 @@ struct VncDisplaybool lossy;bool non_adaptive;QCryptoTLSCreds *tlscreds; -char *tlsaclname; +QAuthZ *tlsauthz; +char *tlsauthzid;#ifdef CONFIG_VNC_SASL VncDisplaySASL sasl;#endif
util/Makefile.objs +0 -1
@@ -20,7 +20,6 @@ util-obj-y += envlist.o path.o module.o util-obj-y += host-utils.o util-obj-y += bitmap.o bitops.o hbitmap.o util-obj-y += fifo8.o -util-obj-y += acl.o util-obj-y += cacheinfo.o util-obj-y += error.o qemu-error.o util-obj-y += id.o
util/acl.c deleted +0 -179
179 lines not on this page · raw message
Signature · 1 line
2.20.1