cifs.idmap.8.in

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