cifs.idmap.rst.in

   1 ==========
   2 cifs.idmap
   3 ==========
   4
   5 -----------------------------------------------------------------------
   6 Userspace helper for mapping ids for Common Internet File System (CIFS)
   7 -----------------------------------------------------------------------
   8 :Manual section: 8
   9
  10 ********
  11 SYNOPSIS
  12 ********
  13
  14   cifs.idmap [--help|-h] [--timeout|-t] [--version|-v] {keyid}
  15
  16 ***********
  17 DESCRIPTION
  18 ***********
  19
  20 This tool is part of the cifs-utils suite.
  21
  22 ``cifs.idmap``  is a userspace helper program for the linux CIFS client
  23 filesystem. There are a number of activities that the kernel cannot
  24 easily do itself. This program is a callout program that does these
  25 things for the kernel and then returns the result.
  26
  27 ``cifs.idmap``  is generally intended to be run when the kernel calls
  28 request-key(8) for a particular key type. While it can be run
  29 directly from the command-line, it is not generally intended to be run
  30 that way.
  31
  32 This program is only called if a share is mounted with the ``cifsacl``
  33 mount option. The kernel will only upcall to do this conversion if
  34 that mount option is specified.
  35
  36 ``cifs.idmap``  relies on a plugin to handle the ID mapping. If it can't
  37 find the plugin then it will not work properly. The plugin (or a
  38 symlink to it) must be at @pluginpath@.
  39
  40 In the case where ``cifs.idmap`` or the plugin are unavailable, file
  41 objects in a mounted share are assigned uid and gid of the credentials
  42 of the process that mounted the share. It is strongly recomemended to
  43 use mount options of uid and gid to specify a default uid and gid to
  44 map owner SIDs and group SIDs in this situation.
  45
  46 *******
  47 OPTIONS
  48 *******
  49
  50 --help|-h
  51   Print the usage message and exit.
  52
  53 --timeout|-t
  54   Set the expiration timer, in seconds on the key. The default is 600
  55   seconds (10 minutes). Setting this to 0 will cause the key to never
  56   expire.
  57
  58 --version|-v
  59   Print version number and exit.
  60
  61 ************************
  62 CONFIGURATION FOR KEYCTL
  63 ************************
  64
  65 ``cifs.idmap``  is designed to be called from the kernel via the
  66 request-key callout program. This requires that request-key be told
  67 where and how to call this program.  Currently ``cifs.idmap``  handles a
  68 key type of::
  69
  70   cifs.idmap
  71
  72 This keytype is for mapping a SID to either an uid or a gid.
  73
  74 To make this program useful for CIFS, you will need to set up entry for it in
  75 request-key.conf(5). Here is an example of an entry for this key type::
  76
  77      #OPERATION  TYPE           D C PROGRAM ARG1 ARG2...
  78      #=========  =============  = = ================================
  79      create      cifs.idmap     * * @sbindir@/cifs.idmap %k
  80
  81 See request-key.conf(5) for more info on each field.
  82
  83 *****
  84 NOTES
  85 *****
  86
  87 Support for upcalls to cifs.idmap was initially introduced in the 3.0
  88 kernel.
  89
  90 ********
  91 SEE ALSO
  92 ********
  93
  94 request-key.conf(5), mount.cifs(8)
  95
  96 ******
  97 AUTHOR
  98 ******
  99
 100 Shirish Pargaonkar wrote the cifs.idmap program.
 101
 102 The Linux CIFS Mailing list is the preferred place to ask questions
 103 regarding these programs.