ManagingSecurity.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!-- This document was created with Syntext Serna Free. --><chapter xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US" xml:id="managingsecurity">
   3   <title xml:id="managingsecurity.title">Managing Lustre Security</title>
   4   <para>This chapter describes Lustre security and includes the following sections:</para>
   5   <itemizedlist>
   6     <listitem>
   7       <para><xref linkend="dbdoclet.50438221_16221"/></para>
   8     </listitem>
   9     <listitem>
  10       <para><xref linkend="dbdoclet.50438221_64726"/></para>
  11     </listitem>
  12   </itemizedlist>
  13   <section xml:id="dbdoclet.50438221_16221">
  14       <title><indexterm><primary>Access Control List (ACL)</primary></indexterm>Using ACLs</title>
  15     <para>An access control list (ACL), is a set of data that informs an operating system about permissions or access rights that each user or group has to specific system objects, such as directories or files. Each object has a unique security attribute that identifies users who have access to it. The ACL lists each object and user access privileges such as read, write or execute.</para>
  16     <section remap="h3">
  17         <title><indexterm><primary>Access Control List (ACL)</primary><secondary>how they work</secondary></indexterm>How ACLs Work</title>
  18       <para>Implementing ACLs varies between operating systems. Systems that support the Portable Operating System Interface (POSIX) family of standards share a simple yet powerful file system permission model, which should be well-known to the Linux/Unix administrator. ACLs add finer-grained permissions to this model, allowing for more complicated permission schemes. For a detailed explanation of ACLs on Linux, refer to the SuSE Labs article, <emphasis>Posix Access Control Lists on Linux</emphasis>:</para>
  19       <para><link xl:href="http://www.suse.de/~agruen/acl/linux-acls/online/">http://www.suse.de/~agruen/acl/linux-acls/online/</link></para>
  20       <para>We have implemented ACLs according to this model. Lustre works with the standard Linux ACL tools, setfacl, getfacl, and the historical chacl, normally installed with the ACL package.</para>
  21       <note>
  22         <para>ACL support is a system-range feature, meaning that all clients have ACL enabled or not. You cannot specify which clients should enable ACL.</para>
  23       </note>
  24     </section>
  25     <section remap="h3">
  26         <title><indexterm><primary>Access Control List (ACL)</primary><secondary>using</secondary></indexterm>Using ACLs with Lustre</title>
  27       <para>POSIX Access Control Lists (ACLs) can be used with Lustre. An ACL consists of file entries representing permissions based on standard POSIX file system object permissions that define three classes of user (owner, group and other). Each class is associated with a set of permissions [read (r), write (w) and execute (x)].</para>
  28       <itemizedlist>
  29         <listitem>
  30           <para>Owner class permissions define access privileges of the file owner.</para>
  31         </listitem>
  32         <listitem>
  33           <para>Group class permissions define access privileges of the owning group.</para>
  34         </listitem>
  35         <listitem>
  36           <para>Other class permissions define access privileges of all users not in the owner or group class.</para>
  37         </listitem>
  38       </itemizedlist>
  39       <para>The <literal>ls -l</literal> command displays the owner, group, and other class permissions in the first column of its output (for example, <literal>-rw-r- --</literal> for a regular file with read and write access for the owner class, read access for the group class, and no access for others).</para>
  40       <para>Minimal ACLs have three entries. Extended ACLs have more than the three entries. Extended ACLs also contain a mask entry and may contain any number of named user and named group entries.</para>
  41       <para>The MDS needs to be configured to enable ACLs. Use <literal>--mountfsoptions</literal> to enable ACLs when creating your configuration:</para>
  42       <screen>$ mkfs.lustre --fsname spfs --mountfsoptions=acl --mdt -mgs /dev/sda</screen>
  43       <para>Alternately, you can enable ACLs at run time by using the <literal>--acl</literal> option with <literal>mkfs.lustre</literal>:</para>
  44       <screen>$ mount -t lustre -o acl /dev/sda /mnt/mdt</screen>
  45       <para>To check ACLs on the MDS:</para>
  46       <screen>$ lctl get_param -n mdc.home-MDT0000-mdc-*.connect_flags | grep acl acl</screen>
  47       <para>To mount the client with no ACLs:</para>
  48       <screen>$ mount -t lustre -o noacl ibmds2@o2ib:/home /home</screen>
  49       <para>ACLs are enabled in Lustre on a system-wide basis; either all clients enable ACLs or none do. Activating ACLs is controlled by MDS mount options <literal>acl</literal> / <literal>noacl</literal> (enable/disable ACLs). Client-side mount options acl/noacl are ignored. You do not need to change the client configuration, and the &apos;acl&apos; string will not appear in the client /etc/mtab. The client acl mount option is no longer needed. If a client is mounted with that option, then this message appears in the MDS syslog:</para>
  50       <screen>...MDS requires ACL support but client does not</screen>
  51       <para>The message is harmless but indicates a configuration issue, which should be corrected.</para>
  52       <para>If ACLs are not enabled on the MDS, then any attempts to reference an ACL on a client return an Operation not supported error.</para>
  53     </section>
  54     <section remap="h3">
  55         <title><indexterm><primary>Access Control List (ACL)</primary><secondary>examples</secondary></indexterm>Examples</title>
  56       <para>These examples are taken directly from the POSIX paper referenced above. ACLs on a Lustre file system work exactly like ACLs on any Linux file system. They are manipulated with the standard tools in the standard manner. Below, we create a directory and allow a specific user access.</para>
  57       <screen>[root@client lustre]# umask 027
  58 [root@client lustre]# mkdir rain
  59 [root@client lustre]# ls -ld rain
  60 drwxr-x---  2 root root 4096 Feb 20 06:50 rain
  61 [root@client lustre]# getfacl rain
  62 # file: rain
  63 # owner: root
  64 # group: root
  65 user::rwx
  66 group::r-x
  67 other::---
  68
  69 [root@client lustre]# setfacl -m user:chirag:rwx rain
  70 [root@client lustre]# ls -ld rain
  71 drwxrwx---+ 2 root root 4096 Feb 20 06:50 rain
  72 [root@client lustre]# getfacl --omit-header rain
  73 user::rwx
  74 user:chirag:rwx
  75 group::r-x
  76 mask::rwx
  77 other::---</screen>
  78     </section>
  79   </section>
  80   <section xml:id="dbdoclet.50438221_64726">
  81     <title><indexterm><primary>root squash</primary></indexterm>Using Root Squash</title>
  82     <para>Root squash is a security feature which restricts super-user access rights to a Lustre file system. Without the root squash feature enabled, Lustre users on untrusted clients could access or modify files owned by root on the filesystem, including deleting them. Using the root squash feature restricts file access/modifications as the root user to only the specified clients.  Note, however, that this does <emphasis>not</emphasis> prevent users on insecure clients from accessing files owned by <emphasis>other</emphasis> users.</para>
  83     <para>The root squash feature works by re-mapping the user ID (UID) and group ID (GID) of the root user to a UID and GID specified by the system administrator, via the Lustre configuration management server (MGS). The root squash feature also enables the Lustre administrator to specify a set of client for which UID/GID re-mapping does not apply.</para>
  84     <section remap="h3">
  85         <title><indexterm><primary>root squash</primary><secondary>configuring</secondary></indexterm>Configuring Root Squash</title>
  86       <para>Root squash functionality is managed by two configuration parameters, <literal>root_squash</literal> and <literal>nosquash_nids</literal>.</para>
  87       <itemizedlist>
  88         <listitem>
  89           <para>The <literal>root_squash</literal> parameter specifies the UID and GID with which the root user accesses the Lustre file system.</para>
  90         </listitem>
  91         <listitem>
  92           <para>The <literal>nosquash_nids</literal> parameter specifies the set of clients to which root squash does not apply. LNET NID range syntax is used for this parameter (see the NID range syntax rules described in <xref linkend="dbdoclet.50438221_48757"/>). For example:</para>
  93         </listitem>
  94       </itemizedlist>
  95       <screen>nosquash_nids=172.16.245.[0-255/2]@tcp</screen>
  96       <para>In this example, root squash does not apply to TCP clients on subnet 172.16.245.0 that have an even number as the last component of their IP address.</para>
  97     </section>
  98     <section xml:id="dbdoclet.50438221_48757">
  99         <title><indexterm><primary>root squash</primary><secondary>enabling</secondary></indexterm>Enabling and Tuning Root Squash</title>
 100       <para>The default value for <literal>nosquash_nids</literal> is NULL, which means that root squashing applies to all clients. Setting the root squash UID and GID to 0 turns root squash off.</para>
 101       <para>Root squash parameters can be set when the MDT is created (<literal>mkfs.lustre --mdt</literal>). For example:</para>
 102       <screen>mds# mkfs.lustre --reformat --fsname=testfs --mdt --mgs \
 103        --param &quot;mdt.root_squash=500:501&quot; \
 104        --param &quot;mdt.nosquash_nids=&apos;0@elan1 192.168.1.[10,11]&apos;&quot; /dev/sda1</screen>
 105       <para>Root squash parameters can also be changed on an unmounted device with <literal>tunefs.lustre</literal>. For example:</para>
 106       <screen>tunefs.lustre --param &quot;mdt.root_squash=65534:65534&quot;  \
 107 --param &quot;mdt.nosquash_nids=192.168.0.13@tcp0&quot; /dev/sda1
 108 </screen>
 109       <para>Root squash parameters can also be changed with the <literal>lctl conf_param</literal> command. For example:</para>
 110       <screen>mgs# lctl conf_param testfs.mdt.root_squash=&quot;1000:101&quot;
 111 mgs# lctl conf_param testfs.mdt.nosquash_nids=&quot;*@tcp&quot;</screen>
 112       <note>
 113         <para>When using the lctl conf_param command, keep in mind:</para>
 114         <itemizedlist>
 115           <listitem>
 116             <para><literal>lctl conf_param</literal> must be run on a live MGS</para>
 117           </listitem>
 118           <listitem>
 119             <para><literal>lctl conf_param</literal> causes the parameter to change on all MDSs</para>
 120           </listitem>
 121           <listitem>
 122             <para><literal>lctl conf_param</literal> is to be used once per a parameter</para>
 123           </listitem>
 124         </itemizedlist>
 125       </note>
 126       <para>The <literal>nosquash_nids</literal> list can be cleared with:</para>
 127       <screen>mgs# lctl conf_param testfs.mdt.nosquash_nids=&quot;NONE&quot;</screen>
 128       <para>- OR -</para>
 129       <screen>mgs# lctl conf_param testfs.mdt.nosquash_nids=&quot;clear&quot;</screen>
 130       <para>If the <literal>nosquash_nids</literal> value consists of several NID ranges (e.g. <literal>0@elan</literal>, <literal>1@elan1</literal>), the list of NID ranges must be quoted with single (&apos;) or double (&apos;&apos;) quotation marks. List elements must be separated with a space. For example:</para>
 131       <screen>mds# mkfs.lustre ... --param &quot;mdt.nosquash_nids=&apos;0@elan1 1@elan2&apos;&quot; /dev/sda1
 132 lctl conf_param testfs.mdt.nosquash_nids=&quot;24@elan 15@elan1&quot;</screen>
 133       <para>These are examples of incorrect syntax:</para>
 134       <screen>mds# mkfs.lustre ... --param &quot;mdt.nosquash_nids=0@elan1 1@elan2&quot; /dev/sda1
 135 lctl conf_param testfs.mdt.nosquash_nids=24@elan 15@elan1</screen>
 136       <para>To check root squash parameters, use the lctl get_param command:</para>
 137       <screen>mds# lctl get_param mdt.testfs-MDT0000.root_squash
 138 lctl get_param mdt.*.nosquash_nids</screen>
 139       <note>
 140         <para>An empty nosquash_nids list is reported as NONE.</para>
 141       </note>
 142     </section>
 143     <section remap="h3">
 144         <title><indexterm><primary>root squash</primary><secondary>tips</secondary></indexterm>Tips on Using Root Squash</title>
 145       <para>Lustre configuration management limits root squash in several ways.</para>
 146       <itemizedlist>
 147         <listitem>
 148           <para>The <literal>lctl conf_param</literal> value overwrites the parameter&apos;s previous value. If the new value uses an incorrect syntax, then the system continues with the old parameters and the previously-correct value is lost on remount. That is, be careful doing root squash tuning.</para>
 149         </listitem>
 150         <listitem>
 151           <para><literal>mkfs.lustre</literal> and <literal>tunefs.lustre</literal> do not perform parameter syntax checking. If the root squash parameters are incorrect, they are ignored on mount and the default values are used instead.</para>
 152         </listitem>
 153         <listitem>
 154           <para>Root squash parameters are parsed with rigorous syntax checking. The root_squash parameter should be specified as <literal>&lt;decnum&gt;:&lt;decnum&gt;</literal>. The <literal>nosquash_nids</literal> parameter should follow LNET NID range list syntax.</para>
 155         </listitem>
 156       </itemizedlist>
 157       <para>LNET NID range syntax:</para>
 158       <screen>&lt;nidlist&gt;     :== &lt;nidrange&gt; [ &apos; &apos; &lt;nidrange&gt; ]
 159 &lt;nidrange&gt;   :== &lt;addrrange&gt; &apos;@&apos; &lt;net&gt;
 160 &lt;addrrange&gt;  :== &apos;*&apos; |
 161            &lt;ipaddr_range&gt; |
 162            &lt;numaddr_range&gt;
 163 &lt;ipaddr_range&gt;       :==
 164 &lt;numaddr_range&gt;.&lt;numaddr_range&gt;.&lt;numaddr_range&gt;.&lt;numaddr_range&gt;
 165 &lt;numaddr_range&gt;      :== &lt;number&gt; |
 166                    &lt;expr_list&gt;
 167 &lt;expr_list&gt;  :== &apos;[&apos; &lt;range_expr&gt; [ &apos;,&apos; &lt;range_expr&gt;] &apos;]&apos;
 168 &lt;range_expr&gt; :== &lt;number&gt; |
 169            &lt;number&gt; &apos;-&apos; &lt;number&gt; |
 170            &lt;number&gt; &apos;-&apos; &lt;number&gt; &apos;/&apos; &lt;number&gt;
 171 &lt;net&gt;        :== &lt;netname&gt; | &lt;netname&gt;&lt;number&gt;
 172 &lt;netname&gt;    :== &quot;lo&quot; | &quot;tcp&quot; | &quot;o2ib&quot; | &quot;cib&quot; | &quot;openib&quot; | &quot;iib&quot; |
 173            &quot;vib&quot; | &quot;ra&quot; | &quot;elan&quot; | &quot;gm&quot; | &quot;mx&quot; | &quot;ptl&quot;
 174 &lt;number&gt;     :== &lt;nonnegative decimal&gt; | &lt;hexadecimal&gt;</screen>
 175       <note>
 176         <para>For networks using numeric addresses (e.g. elan), the address range must be specified in the <literal>&lt;numaddr_range&gt;</literal> syntax. For networks using IP addresses, the address range must be in the <literal>&lt;ipaddr_range&gt;</literal>. For example, if elan is using numeric addresses, <literal>1.2.3.4@elan</literal> is incorrect.</para>
 177       </note>
 178     </section>
 179   </section>
 180 </chapter>