utils/nfsidmap/nfsidmap.man

   1 .\"
   2 .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
   3 .\"
   4 .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
   5 .TH nfsidmap 5 "1 October 2010"
   6 .SH NAME
   7 nfsidmap \- The NFS idmapper upcall program
   8 .SH DESCRIPTION
   9 The file
  10 .I /usr/sbin/nfsidmap
  11 is used by the NFS idmapper to translate user and group ids into names, and to
  12 translate user and group names into ids. Idmapper uses request-key to perform
  13 the upcall and cache the result.
  14 .I /usr/sbin/nfsidmap
  15 should only be called by request-key, and will perform the translation and
  16 initialize a key with the resulting information.
  17 .PP
  18 NFS_USE_NEW_IDMAPPER must be selected when configuring the kernel to use this
  19 feature.
  20 .SH CONFIGURING
  21 The file
  22 .I /etc/request-key.conf
  23 will need to be modified so
  24 .I /sbin/request-key
  25 can properly direct the upcall. The following line should be added before a call
  26 to keyctl negate:
  27 .PP
  28 create  id_resolver     *       *       /usr/sbin/nfsidmap %k %d 600
  29 .PP
  30 This will direct all id_resolver requests to the program
  31 .I /usr/sbin/nfsidmap
  32 The last parameter, 600, defines how many seconds into the future the key will
  33 expire.  This is an optional parameter for
  34 .I /usr/sbin/nfsidmap
  35 and will default to 600 seconds when not specified.
  36 .PP
  37 The idmapper system uses four key descriptions:
  38 .PP
  39           uid: Find the UID for the given user
  40 .br
  41           gid: Find the GID for the given group
  42 .br
  43          user: Find the user name for the given UID
  44 .br
  45         group: Find the group name for the given GID
  46 .PP
  47 You can choose to handle any of these individually, rather than using the
  48 generic upcall program.  If you would like to use your own program for a uid
  49 lookup then you would edit your request-key.conf so it looks similar to this:
  50 .PP
  51 create  id_resolver     uid:*   *       /some/other/program %k %d 600
  52 .br
  53 create  id_resolver     *               *       /usr/sbin/nfsidmap %k %d 600
  54 .PP
  55 Notice that the new line was added above the line for the generic program.
  56 request-key will find the first matching line and run the corresponding program.
  57 In this case, /some/other/program will handle all uid lookups, and
  58 /usr/sbin/nfsidmap will handle gid, user, and group lookups.
  59 .SH AUTHOR
  60 Bryan Schumaker, <bjschuma@netapp.com>