aboutsummaryrefslogtreecommitdiffstats
path: root/cifs.idmap.rst.in
blob: 60d7f0a67a6c6b1d1eacfedb045b435be4825631 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
==========
cifs.idmap
==========

-----------------------------------------------------------------------
Userspace helper for mapping ids for Common Internet File System (CIFS)
-----------------------------------------------------------------------
:Manual section: 8

********
SYNOPSIS
********

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

***********
DESCRIPTION
***********

This tool is part of the cifs-utils suite.

``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.

``cifs.idmap``  is generally intended to be run when the kernel calls
request-key(8) 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.

This program is only called if a share is mounted with the ``cifsacl``
mount option. The kernel will only upcall to do this conversion if
that mount option is specified.

``cifs.idmap``  relies on a plugin to handle the ID mapping. If it can't
find the plugin then it will not work properly. The plugin (or a
symlink to it) must be at @pluginpath@.

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 situation.

*******
OPTIONS
*******

--help|-h
  Print the usage message and exit.

--timeout|-t
  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.

--version|-v
  Print version number and exit.

************************
CONFIGURATION FOR KEYCTL
************************

``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::

  cifs.idmap

This keytype is for mapping a SID to either an uid or a gid.

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::

     #OPERATION  TYPE           D C PROGRAM ARG1 ARG2...
     #=========  =============  = = ================================
     create      cifs.idmap     * * @sbindir@/cifs.idmap %k

See request-key.conf(5) for more info on each field.

*****
NOTES
*****

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

********
SEE ALSO
********

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

******
AUTHOR
******

Shirish Pargaonkar wrote the cifs.idmap program.

The Linux CIFS Mailing list is the preferred place to ask questions
regarding these programs.