cifscreds.rst

   1 =========
   2 cifscreds
   3 =========
   4
   5 -----------------------------------------
   6 manage NTLM credentials in kernel keyring
   7 -----------------------------------------
   8 :Manual section: 1
   9
  10 ********
  11 SYNOPSIS
  12 ********
  13
  14   cifscreds add|clear|clearall|update [-u username] [-d] host|domain
  15
  16 ***********
  17 DESCRIPTION
  18 ***********
  19
  20 The ``cifscreds``  program is a tool for managing credentials (username
  21 and password) for the purpose of establishing sessions in multiuser
  22 mounts.
  23
  24 When a cifs filesystem is mounted with the "multiuser" option, and does
  25 not use krb5 authentication, it needs to be able to get the credentials
  26 for each user from somewhere. The ``cifscreds`` program is the tool used
  27 to provide these credentials to the kernel.
  28
  29 The first non-option argument to cifscreds is a command (see the
  30 `COMMANDS`_  section below). The second non-option argument is a hostname
  31 or address, or an NT domain name.
  32
  33 ********
  34 COMMANDS
  35 ********
  36
  37 add
  38   Add credentials to the kernel to be used for connecting to the given
  39   server, or servers in the given domain.
  40
  41 clear
  42   Clear credentials for a particular host or domain from the kernel.
  43
  44 clearall
  45   Clear all cifs credentials from the kernel.
  46
  47 update
  48   Update stored credentials in the kernel with a new username and
  49   password.
  50
  51 *******
  52 OPTIONS
  53 *******
  54
  55 -d, --domain
  56   The provided host/domain argument is a NT domainname.
  57
  58   Ordinarily the second argument provided to cifscreds is treated as a
  59   hostname or IP address. This option causes the cifscreds program to
  60   treat that argument as an NT domainname instead.
  61
  62   If there are not host specific credentials for the mounted server, then
  63   the kernel will next look for a set of domain credentials equivalent to
  64   the domain= option provided at mount time.
  65
  66 -u, --username
  67   Ordinarily, the username is derived from the unix username of the user
  68   adding the credentials. This option allows the user to substitute a
  69   different username.
  70
  71 *****
  72 NOTES
  73 *****
  74
  75 The cifscreds utility requires a kernel built with support for the
  76 ``login`` key type. That key type was added in v3.3 in mainline Linux
  77 kernels.
  78
  79 Since ``cifscreds`` adds keys to the session keyring, it is highly
  80 recommended that one use ``pam_keyinit`` to ensure that a session keyring
  81 is established at login time.
  82
  83 ********
  84 SEE ALSO
  85 ********
  86
  87 pam_keyinit(8)
  88
  89 *******
  90 AUTHORS
  91 *******
  92
  93 The cifscreds program was originally developed by Igor Druzhinin
  94 <jaxbrigs@gmail.com>. This manpage and a redesign of the code was done
  95 by Jeff Layton <jlayton@samba.org>.