cifs.idmap(8)

1CIFS.IDMAP(8)                                                    CIFS.IDMAP(8)
2
3
4

NAME

6       cifs.idmap  - Userspace helper for mapping ids for Common Internet File
7       System (CIFS)
8

SYNOPSIS

10          cifs.idmap [--help|-h] [--timeout|-t] [--version|-v] {keyid}
11

DESCRIPTION

13       This tool is part of the cifs-utils suite.
14
15       cifs.idmap  is a userspace helper program for  the  linux  CIFS  client
16       filesystem.  There  are  a  number of activities that the kernel cannot
17       easily do itself. This program is a callout  program  that  does  these
18       things for the kernel and then returns the result.
19
20       cifs.idmap   is  generally  intended  to  be  run when the kernel calls
21       request-key(8) for a particular key type. While it can be run  directly
22       from the command-line, it is not generally intended to be run that way.
23
24       This  program  is  only  called  if a share is mounted with the cifsacl
25       mount option. The kernel will only upcall to do this conversion if that
26       mount option is specified.
27
28       cifs.idmap   relies  on  a plugin to handle the ID mapping. If it can't
29       find the plugin then it will not work properly. The plugin (or  a  sym‐
30       link to it) must be at /etc/cifs-utils/idmap-plugin.
31
32       In  the  case  where  cifs.idmap  or  the  plugin are unavailable, file
33       objects in a mounted share are assigned uid and gid of the  credentials
34       of  the  process that mounted the share. It is strongly recomemended to
35       use mount options of uid and gid to specify a default uid  and  gid  to
36       map owner SIDs and group SIDs in this situation.
37

OPTIONS

39       --help|-h
40              Print the usage message and exit.
41
42       --timeout|-t
43              Set  the expiration timer, in seconds on the key. The default is
44              600 seconds (10 minutes). Setting this to 0 will cause  the  key
45              to never expire.
46
47       --version|-v
48              Print version number and exit.
49

CONFIGURATION FOR KEYCTL

51       cifs.idmap    is  designed  to  be  called  from  the  kernel  via  the
52       request-key callout program. This requires  that  request-key  be  told
53       where  and  how  to call this program.  Currently cifs.idmap  handles a
54       key type of:
55
56          cifs.idmap
57
58       This keytype is for mapping a SID to either an uid or a gid.
59
60       To make this program useful for CIFS, you will need to set up entry for
61       it  in request-key.conf(5). Here is an example of an entry for this key
62       type:
63
64          #OPERATION  TYPE           D C PROGRAM ARG1 ARG2...
65          #=========  =============  = = ================================
66          create      cifs.idmap     * * /usr/sbin/cifs.idmap %k
67
68       See request-key.conf(5) for more info on each field.
69

NOTES

71       Support for upcalls to cifs.idmap was initially introduced in  the  3.0
72       kernel.
73

AUTHOR

78       Shirish Pargaonkar wrote the cifs.idmap program.
79
80       The  Linux  CIFS  Mailing  list is the preferred place to ask questions
81       regarding these programs.
82
83
84
85
86                                                                 CIFS.IDMAP(8)