pam_cifscreds(8) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | NOTES | SEE ALSO | AUTHOR | COLOPHON

PAM_CIFSCREDS(8)         System Manager's Manual         PAM_CIFSCREDS(8)

NAME         top

       pam_cifscreds - PAM module to manage NTLM credentials in kernel
       keyring

SYNOPSIS         top

       Edit the PAM configuration files for the systems that you want to
       automatically register NTLM credentials for, e.g.
       /etc/pam.d/login, and modify as follows:

              ...
              auth       substack     system-auth
          +++ auth       optional     pam_cifscreds.so
              auth       include      postlogin
              ...

              ...
              session    include      system-auth
          +++ session    optional     pam_cifscreds.so domain=DOMAIN
              session    include      postlogin
              ...

       Change DOMAIN to the name of you Windows domain, or use host= as
       described below.

DESCRIPTION         top

       The pam_cifscreds PAM module is a tool for automatically adding
       credentials (username and password) for the purpose of
       establishing sessions in multiuser mounts.

       When a cifs filesystem is mounted with the "multiuser" option, and
       does not use krb5 authentication, it needs to be able to get the
       credentials for each user from somewhere. The pam_cifscreds module
       can be used to provide these credentials to the kernel
       automatically at login.

       In the session section of the PAM configuration file, the module
       can either an NT domain name or a list of hostname or addresses.

OPTIONS         top

       pam_cifscreds supports a couple options which can be set in the
       PAM configuration files. You must have one (and only one) of
       domain= or host=.

       debug  Turns on some extra debug logging.

       domain=<NT domain name>
              Credentials will be added for the specified NT domain name.

       host=<hostname or IP address>[,...]
              Credentials will be added for the specified hostnames or IP
              addresses.

NOTES         top

       The pam_cifscreds PAM module requires a kernel built with support
       for the login key type. That key type was added in v3.3 in
       mainline Linux kernels.

       Since pam_cifscreds adds keys to the session keyring, it is highly
       recommended that one use pam_keyinit to ensure that a session
       keyring is established at login time.

SEE ALSO         top

       cifscreds(1), pam_keyinit(8)

AUTHOR         top

       The pam_cifscreds PAM module was developed by Orion Poplawski <
       <orion@nwra.com> >.

COLOPHON         top

       This page is part of the LinuxCIFS utils (network filesystem
       mounts from Linux (e.g. to Samba, ksmbd, etc.)) project.
       Information about the project can be found at 
       ⟨https://wiki.samba.org/index.php/LinuxCIFS_utils⟩.  If you have a
       bug report for this manual page, send it to
       linux-cifs@vger.kernel.org, samba-technical@lists.samba.org.  This
       page was obtained from the project's upstream Git repository
       ⟨git://git.samba.org/cifs-utils.git⟩ on 2025-08-11.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2025-06-10.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                         PAM_CIFSCREDS(8)