cifscreds(1)

1CIFSCREDS(1)                                                      CIFSCREDS(1)
2
3
4

NAME

6       cifscreds - manage NTLM credentials in kernel keyring
7

SYNOPSIS

9       cifscreds add|clear|clearall|update [-u username] [-d] host|domain
10

DESCRIPTION

12       The cifscreds program is a tool for managing credentials (username and
13       password) for the purpose of establishing sessions in multiuser mounts.
14
15       When a cifs filesystem is mounted with the "multiuser" option, and does
16       not use krb5 authentication, it needs to be able to get the credentials
17       for each user from somewhere. The cifscreds program is the tool used to
18       provide these credentials to the kernel.
19
20       The first non-option argument to cifscreds is a command (see the
21       COMMANDS section below). The second non-option argument is a hostname
22       or address, or an NT domain name.
23

COMMANDS

25       add Add credentials to the kernel to be used for connecting to the
26           given server, or servers in the given domain.
27
28       clear
29           Clear credentials for a particular host or domain from the kernel.
30
31       clearall
32           Clear all cifs credentials from the kernel.
33
34       update
35           Update stored credentials in the kernel with a new username and
36           password.
37

OPTIONS

39       -d, --domain
40           The provided host/domain argument is a NT domainname.
41
42           Ordinarily the second argument provided to cifscreds is treated as
43           a hostname or IP address. This option causes the cifscreds program
44           to treat that argument as an NT domainname instead.
45
46           If there are not host specific credentials for the mounted server,
47           then the kernel will next look for a set of domain credentials
48           equivalent to the domain= option provided at mount time.
49
50       -u, --username
51           Ordinarily, the username is derived from the unix username of the
52           user adding the credentials. This option allows the user to
53           substitute a different username.
54

NOTES

56       The cifscreds utility requires a kernel built with support for the
57       login key type. That key type was added in v3.3 in mainline Linux
58       kernels.
59
60       Since cifscreds adds keys to the session keyring, it is highly
61       recommended that one use pam_keyinit to ensure that a session keyring
62       is established at login time.
63

AUTHORS

68       The cifscreds program was originally developed by Igor Druzhinin
69       <jaxbrigs@gmail.com>. This manpage and a redesign of the code was done
70       by Jeff Layton <jlayton@samba.org>.
71
72
73
74                                  2012-07-17                      CIFSCREDS(1)