cifscreds.pod

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