67 lines
1.4 KiB
Groff
67 lines
1.4 KiB
Groff
|
.TH "PAM_EID" "8" "" "German id card PAM module manual" ""
|
||
|
|
.hy
|
||
|
|
.SH NAME
|
||
|
|
.PP
|
||
|
|
pam_eid \- PAM module for authentication with German id card
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.PP
|
||
|
|
\f[B]pam_eid.so\f[] [debug] [echo_pin]
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.PP
|
||
|
|
The \f[B]pam_eid\f[] module is designed to allow user authentication with a
|
||
|
|
German id card and its corresponding PIN. With card readers that have a pinpad,
|
||
|
|
the PIN must be entered there, while with card readers without pinpad the PIN
|
||
|
|
is entered the same way as a classic UNIX password.
|
||
|
|
.PP
|
||
|
|
Before a user can authenticate with an id card, the contents of the card must
|
||
|
|
be saved in a file. Start program \f[B]AusweisApp\f[] and then program
|
||
|
|
\f[B]add-eid\f[] for doing that.
|
||
|
|
.SH OPTIONS
|
||
|
|
.TP
|
||
|
|
.B debug
|
||
|
|
Enable more verbose log messages in syslog.
|
||
|
|
.RS
|
||
|
|
.RE
|
||
|
|
.TP
|
||
|
|
.B echo_pin
|
||
|
|
Echo the PIN when it is entered by the user.
|
||
|
|
.RS
|
||
|
|
.RE
|
||
|
|
.SH MODULE TYPE PROVIDED
|
||
|
|
.PP
|
||
|
|
Only the \f[B]auth\f[] module type is provided.
|
||
|
|
.SH RETURN VALUES
|
||
|
|
.TP
|
||
|
|
.B PAM_SUCCESS
|
||
|
|
The provided PIN is correct.
|
||
|
|
.RS
|
||
|
|
.RE
|
||
|
|
.TP
|
||
|
|
.B PAM_AUTH_ERR
|
||
|
|
The provided PIN isn\[aq]t correct.
|
||
|
|
.RS
|
||
|
|
.RE
|
||
|
|
.TP
|
||
|
|
.B PAM_SERVICE_ERR
|
||
|
|
An error happened in the module
|
||
|
|
.RS
|
||
|
|
.RE
|
||
|
|
.TP
|
||
|
|
.B PAM_PUF_ERR
|
||
|
|
Failure while trying to allocate memory
|
||
|
|
.RS
|
||
|
|
.RE
|
||
|
|
.TP
|
||
|
|
.B PAM_AUTHINFO_UNAVAIL
|
||
|
|
Authentication information unavailable
|
||
|
|
.RS
|
||
|
|
.RE
|
||
|
|
.SH EXAMPLES
|
||
|
|
.PP
|
||
|
|
The following lines may be used to enable this PAM module:
|
||
|
|
.IP \[bu] 2
|
||
|
|
\f[C]auth\ required\ pam_eid.so\f[] # Normal logging output
|
||
|
|
.IP \[bu] 2
|
||
|
|
\f[C]auth\ required\ pam_eid.so\ debug\f[] # Debugging output
|
||
|
|
.PP
|