diff mbox series

[v3,4/5] tools/virtiofsd: xattr name mapping examples

Message ID 20201014180209.49299-5-dgilbert@redhat.com
State New
Headers show
Series virtiofsd xattr name mappings | expand

Commit Message

Dr. David Alan Gilbert Oct. 14, 2020, 6:02 p.m. UTC
From: "Dr. David Alan Gilbert" <dgilbert@redhat.com>

Add a few examples of xattrmaps to the documentation.

Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
---
 docs/tools/virtiofsd.rst | 50 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

Comments

Stefan Hajnoczi Oct. 20, 2020, 9:56 a.m. UTC | #1
On Wed, Oct 14, 2020 at 07:02:08PM +0100, Dr. David Alan Gilbert (git) wrote:
> From: "Dr. David Alan Gilbert" <dgilbert@redhat.com>

> 

> Add a few examples of xattrmaps to the documentation.

> 

> Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>

> ---

>  docs/tools/virtiofsd.rst | 50 ++++++++++++++++++++++++++++++++++++++++

>  1 file changed, 50 insertions(+)


Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Vivek Goyal Oct. 20, 2020, 2:40 p.m. UTC | #2
On Wed, Oct 14, 2020 at 07:02:08PM +0100, Dr. David Alan Gilbert (git) wrote:
> From: "Dr. David Alan Gilbert" <dgilbert@redhat.com>

> 

> Add a few examples of xattrmaps to the documentation.

> 

> Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>

> ---

>  docs/tools/virtiofsd.rst | 50 ++++++++++++++++++++++++++++++++++++++++

>  1 file changed, 50 insertions(+)

> 

> diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst

> index a3a120da2f..5cb64612ed 100644

> --- a/docs/tools/virtiofsd.rst

> +++ b/docs/tools/virtiofsd.rst

> @@ -163,6 +163,56 @@ in which case a 'server' rule will always match on all names from

>  the server.

>  

>  

> +xattr-mapping Examples

> +----------------------

> +

> +1) Prefix all attributes with 'user.virtiofs.'

> +

> +::

> +

> +-o xattrmap=":prefix:all::user.virtiofs.::bad:all:::"

> +


Staring at rule.

":bad:all:::"

and trying to map this to ":type:scope:key:prepend:"

type==bad
scope==all
key==""
prepend==""

> +

> +This uses two rules, using : as the field separator;

> +the first rule prefixes and strips 'user.virtiofs.',

> +the second rule hides any non-prefixed attributes that

> +the host set.


What is non-prefixed xattr in this context. If client sends
"security.selinux", is prefixed or non-prefixed.

Documentation in first patch said.

+- 'bad' - If a client tries to use this name it's
+  denied using EPERM; when the server passes an attribute
+  name matching it's hidden.

I am not sure which xattr name will be blocked if key=="" and prepend==""

> +

> +2) Prefix 'trusted.' attributes, allow others through

> +

> +::

> +

> +   "/prefix/all/trusted./user.virtiofs./

> +    /bad/server//trusted./

> +    /bad/client/user.virtiofs.//

> +    /ok/all///"

> +

> +

> +Here there are four rules, using / as the field

> +separator, and also demonstrating that new lines can

> +be included between rules.

> +The first rule is the prefixing of 'trusted.' and

> +stripping of 'user.virtiofs.'.


So this is bidrectional rule, right. For setxattr(), "trusted."
will be replaced with "user.virtiofs" and for listxattr(),
server will replace user.virtiofs with trusted. ?

> +The second rule hides unprefixed 'trusted.' attributes

> +on the host.


If host has "trusted.*", we are not hiding it and as per first
rule we are converting it to "user.virtiofs.trusted.*", right?
So why this second rule is needed.

> +The third rule stops a guest from explicitly setting

> +the 'user.viritofs.' path directly.

> +Finally, the fourth rule lets all remaining attributes

> +through.


So If I don't specify third rule, and client does
setxattr(user.virtiofs.*), it will simply be a passthrough?

Thanks
Vivek

> +

> +3) Hide 'security.' attributes, and allow everything else

> +

> +::

> +

> +    "/bad/all/security./security./

> +     /ok/all///'

> +

> +The first rule combines what could be separate client and server

> +rules into a single 'all' rule, matching 'security.' in either

> +client arguments or lists returned from the host.  This stops

> +the client seeing any 'security.' attributes on the server and

> +stops it setting any.

> +

>  Examples

>  --------

>  

> -- 

> 2.28.0

>
Dr. David Alan Gilbert Oct. 20, 2020, 3:34 p.m. UTC | #3
* Vivek Goyal (vgoyal@redhat.com) wrote:
> On Wed, Oct 14, 2020 at 07:02:08PM +0100, Dr. David Alan Gilbert (git) wrote:

> > From: "Dr. David Alan Gilbert" <dgilbert@redhat.com>

> > 

> > Add a few examples of xattrmaps to the documentation.

> > 

> > Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>

> > ---

> >  docs/tools/virtiofsd.rst | 50 ++++++++++++++++++++++++++++++++++++++++

> >  1 file changed, 50 insertions(+)

> > 

> > diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst

> > index a3a120da2f..5cb64612ed 100644

> > --- a/docs/tools/virtiofsd.rst

> > +++ b/docs/tools/virtiofsd.rst

> > @@ -163,6 +163,56 @@ in which case a 'server' rule will always match on all names from

> >  the server.

> >  

> >  

> > +xattr-mapping Examples

> > +----------------------

> > +

> > +1) Prefix all attributes with 'user.virtiofs.'

> > +

> > +::

> > +

> > +-o xattrmap=":prefix:all::user.virtiofs.::bad:all:::"

> > +

> 

> Staring at rule.

> 

> ":bad:all:::"

> 

> and trying to map this to ":type:scope:key:prepend:"

> 

> type==bad

> scope==all

> key==""

> prepend==""


Correct.

> > +

> > +This uses two rules, using : as the field separator;

> > +the first rule prefixes and strips 'user.virtiofs.',

> > +the second rule hides any non-prefixed attributes that

> > +the host set.

> 

> What is non-prefixed xattr in this context. If client sends

> "security.selinux", is prefixed or non-prefixed.


Note that anything originating at the client (i.e. starting with "")
will get caught by the first rule and be prefixed with 'user.virtiofs.'
This second rule will only be triggered by an xattr name coming
from the server (i.e a listxattr) for a name that doesn't begin
with user.virtiofs. (i.e. didn't match the 1st rule for a server xattr).
This makes sure that only guest created xattr's (that were set and
had a prefix added) are then visible to the guest.

> Documentation in first patch said.

> 

> +- 'bad' - If a client tries to use this name it's

> +  denied using EPERM; when the server passes an attribute

> +  name matching it's hidden.

> 

> I am not sure which xattr name will be blocked if key=="" and prepend==""


All of them; they're still matched at the beginning; as the first
patch says 'It maybe empty in which case a 'client' rule will always
match on client names'

> > +2) Prefix 'trusted.' attributes, allow others through

> > +

> > +::

> > +

> > +   "/prefix/all/trusted./user.virtiofs./

> > +    /bad/server//trusted./

> > +    /bad/client/user.virtiofs.//

> > +    /ok/all///"

> > +

> > +

> > +Here there are four rules, using / as the field

> > +separator, and also demonstrating that new lines can

> > +be included between rules.

> > +The first rule is the prefixing of 'trusted.' and

> > +stripping of 'user.virtiofs.'.

> 

> So this is bidrectional rule, right. For setxattr(), "trusted."

> will be replaced with "user.virtiofs" and for listxattr(),

> server will replace user.virtiofs with trusted. ?


prefixed not replaced; so it'll turn "trusted." into
"user.virtiofs.trusted." and strip it back off for listxattr.

> > +The second rule hides unprefixed 'trusted.' attributes

> > +on the host.

> 

> If host has "trusted.*", we are not hiding it and as per first

> rule we are converting it to "user.virtiofs.trusted.*", right?

> So why this second rule is needed.


No, the first rule will only prefix strings provided by the guest
and strip strings provided by the server. This rule hides
existing server 'trusted.' xattrs - so if the guest sets
trusted.foo it's not confused by also seeing a server trusted.foo

> > +The third rule stops a guest from explicitly setting

> > +the 'user.viritofs.' path directly.

> > +Finally, the fourth rule lets all remaining attributes

> > +through.

> 

> So If I don't specify third rule, and client does

> setxattr(user.virtiofs.*), it will simply be a passthrough?


Right; and that's dangerous, because a non-privileged guest
process can set a user. xattr; so a non-priv guest process could
set user.virtiofs.trusted.foo and then it would get read back
and be used as trusted.foo that has an impact on priviliged processes.

Dave

> Thanks

> Vivek

> 

> > +

> > +3) Hide 'security.' attributes, and allow everything else

> > +

> > +::

> > +

> > +    "/bad/all/security./security./

> > +     /ok/all///'

> > +

> > +The first rule combines what could be separate client and server

> > +rules into a single 'all' rule, matching 'security.' in either

> > +client arguments or lists returned from the host.  This stops

> > +the client seeing any 'security.' attributes on the server and

> > +stops it setting any.

> > +

> >  Examples

> >  --------

> >  

> > -- 

> > 2.28.0

> > 

-- 
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK
diff mbox series

Patch

diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst
index a3a120da2f..5cb64612ed 100644
--- a/docs/tools/virtiofsd.rst
+++ b/docs/tools/virtiofsd.rst
@@ -163,6 +163,56 @@  in which case a 'server' rule will always match on all names from
 the server.
 
 
+xattr-mapping Examples
+----------------------
+
+1) Prefix all attributes with 'user.virtiofs.'
+
+::
+
+-o xattrmap=":prefix:all::user.virtiofs.::bad:all:::"
+
+
+This uses two rules, using : as the field separator;
+the first rule prefixes and strips 'user.virtiofs.',
+the second rule hides any non-prefixed attributes that
+the host set.
+
+2) Prefix 'trusted.' attributes, allow others through
+
+::
+
+   "/prefix/all/trusted./user.virtiofs./
+    /bad/server//trusted./
+    /bad/client/user.virtiofs.//
+    /ok/all///"
+
+
+Here there are four rules, using / as the field
+separator, and also demonstrating that new lines can
+be included between rules.
+The first rule is the prefixing of 'trusted.' and
+stripping of 'user.virtiofs.'.
+The second rule hides unprefixed 'trusted.' attributes
+on the host.
+The third rule stops a guest from explicitly setting
+the 'user.viritofs.' path directly.
+Finally, the fourth rule lets all remaining attributes
+through.
+
+3) Hide 'security.' attributes, and allow everything else
+
+::
+
+    "/bad/all/security./security./
+     /ok/all///'
+
+The first rule combines what could be separate client and server
+rules into a single 'all' rule, matching 'security.' in either
+client arguments or lists returned from the host.  This stops
+the client seeing any 'security.' attributes on the server and
+stops it setting any.
+
 Examples
 --------