1CIFS.IDMAP(8)             System Administration tools            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       cifs.idmap works in conjuction with winbind facility of Samba suite to
25       map owner and group SIDs to uids and gids respectively.  It is best
26       utilized when
27       - a mount option of cifsacl is specified when mounting a cifs share
28       - winbind is specified as one of the search entries for passwd and
29       group databases in file /etc/nsswitch.conf
30       - file smb.conf has winbind specific entries
31       - winbind daemon program is running
32
33       In case winbind and cifs.idmap facilities are unavailable, file objects
34       in a mounted share are assigned uid and gid of the credentials of the
35       process that mounted the share.  So it is strongly recomemended to use
36       mount options of uid and gid to specify a default uid and gid to map
37       owner SIDs and group SIDs respectively in case services of winbind and
38       cifs.idmap facility are unavailable.
39

OPTIONS

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

CONFIGURATION FOR KEYCTL

53       cifs.idmap is designed to be called from the kernel via the request-key
54       callout program. This requires that request-key be told where and how
55       to call this program. Currently cifs.idmap handles a key type of:
56
57       cifs.idmap
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.conf5() for more info on each field.
69

SEE ALSO

71       request-key.conf(5), mount.cifs(8)
72

AUTHOR

74       Shirish Pargaonkar wrote the cifs.idmap program.
75
76       The Linux CIFS Mailing list is the preferred place to ask questions
77       regarding these programs.
78
79
80
81cifs-utils                        05/26/2011                     CIFS.IDMAP(8)
Impressum