'\" t
.\"     Title: pam_ssh_add
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 06/02/2023
.\"    Manual: pam_ssh_add
.\"    Source: pam_ssh_add
.\"  Language: English
.\"
.TH "PAM_SSH_ADD" "8" "06/02/2023" "pam_ssh_add" "pam_ssh_add"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pam_ssh_add \- PAM module to auto load ssh keys into an agent
.SH "DESCRIPTION"
.PP
pam_ssh_add provides authentication and session modules that allow users to start their session with a running ssh\-agent with as many ssh keys loaded as possible\&.
.PP
If used, the authentication module simply stores the authentication token for later use by the session module\&. Because this module performs no actual authentication it returns PAM_CRED_INSUFFICIENT on success and should always be accompanied by an actual authentication module in your pam configuration\&.
.PP
By default the session module will start a new ssh\-agent and run ssh\-add, loading any keys that exist in the default path for the newly logged in user\&. If any keys prompt for a password, and a authentication token was successfully stored, that token will be provided as the password\&.
.SH "OPTIONS"
.PP
\fBdebug\fR
.RS 4
This option will turn on debug logging to syslog\&.
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
        auth     required  pam_unix\&.so
        auth     optional  pam_ssh_add\&.so
        session  optional  pam_ssh_add\&.so
      
.fi
.if n \{\
.RE
.\}
.SH "AUTHOR"
.PP
Cockpit has been written by many
\m[blue]\fBcontributors\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "BUGS"
.PP
Please send bug reports to either the distribution bug tracker or the
\m[blue]\fBupstream bug tracker\fR\m[]\&\s-2\u[2]\d\s+2\&.
.SH "NOTES"
.IP " 1." 4
contributors
.RS 4
\%https://github.com/cockpit-project/cockpit/
.RE
.IP " 2." 4
upstream bug tracker
.RS 4
\%https://github.com/cockpit-project/cockpit/issues/new
.RE