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 cifsaclmount
25       option. The kernel will only upcall to do this conversion if that mount
26       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 600
44          seconds (10 minutes). Setting this to 0 will cause the key to  never
45          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 request-key
52       callout program. This requires that request-key be told where  and  how
53       to call this program.  Currently cifs.idmap handles a key type of:
54
55       cifs.idmap
56          This keytype is for mapping a SID to either an uid or a gid
57
58       To make this program useful for CIFS, you will need to set up entry for
59       it in request-key.conf(5). Here is an example of an entry for this  key
60       type:
61
62          #OPERATION  TYPE           D C PROGRAM ARG1 ARG2...
63          #=========  =============  = = ================================
64          create      cifs.idmap     * * /usr/sbin/cifs.idmap %k
65
66       See request-key.conf(5) for more info on each field.
67

NOTES

69       Support  for  upcalls to cifs.idmap was initially introduced in the 3.0
70       kernel.
71

SEE ALSO

73       request-key.conf(5), mount.cifs(8)
74

AUTHOR

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