<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"

"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">

<reference>

<title>SSSD Manual pages</title>

<refentry>

<refentryinfo>

<productname>SSSD</productname>

<orgname>The SSSD upstream - http://fedorahosted.org/sssd</orgname>

</refentryinfo>

<refmeta>

<refentrytitle>pam_sss</refentrytitle>

<manvolnum>8</manvolnum>

</refmeta>

<refnamediv id='name'>

<refname>pam_sss</refname>

<refpurpose>PAM module for SSSD</refpurpose>

</refnamediv>

<refsynopsisdiv id='synopsis'>

<cmdsynopsis>

<command>pam_sss.so</command>

<arg choice='opt'>

<replaceable>quiet</replaceable>

</arg>

<arg choice='opt'>

<replaceable>forward_pass</replaceable>

</arg>

<arg choice='opt'>

<replaceable>use_first_pass</replaceable>

</arg>

<arg choice='opt'>

<replaceable>use_authtok</replaceable>

</arg>

<arg choice='opt'>

<replaceable>retry=N</replaceable>

</arg>

<arg choice='opt'>

<replaceable>ignore_unknown_user</replaceable>

</arg>

<arg choice='opt'>

<replaceable>ignore_authinfo_unavail</replaceable>

</arg>

<arg choice='opt'>

<replaceable>domains=X</replaceable>

</arg>

<arg choice='opt'>

<replaceable>allow_missing_name</replaceable>

</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1 id='description'>

<title>DESCRIPTION</title>

<para><command>pam_sss.so</command> is the PAM interface to the System

Security Services daemon (SSSD). Errors and results are logged through

<command>syslog(3)</command> with the LOG_AUTHPRIV facility.</para>

</refsect1>

<refsect1 id='options'>

<title>OPTIONS</title>

<variablelist remap='IP'>

<varlistentry>

<term>

<option>quiet</option>

</term>

<listitem>

<para>Suppress log messages for unknown users.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>forward_pass</option>

</term>

<listitem>

<para>If <option>forward_pass</option> is set the entered

password is put on the stack for other PAM modules to use.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>use_first_pass</option>

</term>

<listitem>

<para>The argument use_first_pass forces the module to use

a previous stacked modules password and will never prompt

the user - if no password is available or the password is

not appropriate, the user will be denied access.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>use_authtok</option>

</term>

<listitem>

<para>When password changing enforce the module to set the

new password to the one provided by a previously stacked

password module.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>retry=N</option>

</term>

<listitem>

<para>If specified the user is asked another N times for a

password if authentication fails. Default is 0.</para>

<para>Please note that this option might not work as

expected if the application calling PAM handles the user

dialog on its own. A typical example is

<command>sshd</command> with

<option>PasswordAuthentication</option>.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>ignore_unknown_user</option>

</term>

<listitem>

<para>If this option is specified and the user does not

exist, the PAM module will return PAM_IGNORE. This causes

the PAM framework to ignore this module.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>ignore_authinfo_unavail</option>

</term>

<listitem>

<para>

Specifies that the PAM module should return PAM_IGNORE

if it cannot contact the SSSD daemon. This causes

the PAM framework to ignore this module.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>domains</option>

</term>

<listitem>

<para>

Allows the administrator to restrict the domains a

particular PAM service is allowed to authenticate

against. The format is a comma-separated list of

SSSD domain names, as specified in the sssd.conf file.

</para>

<para>

NOTE: Must be used in conjunction with the

<quote>pam_trusted_users</quote> and

<quote>pam_public_domains</quote> options.

Please see the

<citerefentry>

<refentrytitle>sssd.conf</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> manual page for more information

on these two PAM responder options.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>allow_missing_name</option>

</term>

<listitem>

<para>

The main purpose of this option is to let SSSD determine

the user name based on additional information, e.g. the

certificate from a Smartcard.

</para>

<para>

The current use case are login managers which can

monitor a Smartcard reader for card events. In case a

Smartcard is inserted the login manager will call a PAM

stack which includes a line like

<programlisting>

auth sufficient pam_sss.so allow_missing_name

</programlisting>

In this case SSSD will try to determine the user name

based on the content of the Smartcard, returns it to

pam_sss which will finally put it on the PAM stack.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 id='module_types_provides'>

<title>MODULE TYPES PROVIDED</title>

<para>All module types (<option>account</option>, <option>auth</option>,

<option>password</option> and <option>session</option>) are provided.

</para>

</refsect1>

<refsect1 id='files'>

<title>FILES</title>

<para>If a password reset by root fails, because the corresponding SSSD

provider does not support password resets, an individual message can be

displayed. This message can e.g. contain instructions about how to reset

a password.</para>

<para>The message is read from the file

<filename>pam_sss_pw_reset_message.LOC</filename> where LOC stands for a

locale string returned by <citerefentry>

<refentrytitle>setlocale</refentrytitle><manvolnum>3</manvolnum>

</citerefentry>. If there is no matching file the content of

<filename>pam_sss_pw_reset_message.txt</filename> is displayed. Root

must be the owner of the files and only root may have read and write

permissions while all other users must have only read

permissions.</para>

<para>These files are searched in the directory

<filename>/etc/sssd/customize/DOMAIN_NAME/</filename>. If no matching

file is present a generic message is displayed.</para>

</refsect1>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />

</refentry>

</reference>