bump version in README
[pam_pcsc_cr.git] / pam_pcsc_cr.8
1 .\"Copyright (c) 2013 Eugene Crosser
2 .\"
3 .\"This software is provided 'as-is', without any express or implied
4 .\"warranty. In no event will the authors be held liable for any damages
5 .\"arising from the use of this software.
6 .\"
7 .\"Permission is granted to anyone to use this software for any purpose,
8 .\"including commercial applications, and to alter it and redistribute it
9 .\"freely, subject to the following restrictions:
10 .\"
11 .\"    1. The origin of this software must not be misrepresented; you must
12 .\"    not claim that you wrote the original software. If you use this
13 .\"    software in a product, an acknowledgment in the product documentation
14 .\"    would be appreciated but is not required.
15 .\"
16 .\"    2. Altered source versions must be plainly marked as such, and must
17 .\"    not be misrepresented as being the original software.
18 .\"
19 .\"    3. This notice may not be removed or altered from any source
20 .\"    distribution.
21 .\"
22 .TH PAM_PCSC_CR 8 "18 Dec 2013" PAM_PCSC_CR PAM_PCSC_CR
23 .SH NAME
24 pam_pcsc_cr \- Module for challenge-response authentication
25 .SH SYNOPSYS
26 .B pam_pcsc_cr.so [options]
27 .SH DESCRIPTION
28 This is a PAM module for crypto-token based authentication.
29 It only provides authentication component, the rest are stubs.
30 The module uses the contents of the auth file created with the
31 .B pam_cr_setup
32 command and optionally a password provided by the user to construct
33 challenge that is sent to the crypto-token over
34 .B pcsclite
35 framework. The token's response is used to decipher the encrypted part
36 of the file. If decryption is successful, then the extracted shared
37 secret is used to produce ithe expected response to the future
38 (different) challenge, encrypted again with the expected response,
39 and stowed into the file. Additional payload that was decrypted on
40 the way is optionally injected into the PAM framework as AUTH_TOKEN
41 to be later used by keyring-unlocking module.
42 .SH OPTIONS
43 .B verbose
44 \- write more error messages to syslog.
45 .PP
46 .B noaskpass
47 \- do not try to ask the user for the challenge password, use empty
48 string for the password.
49 .PP
50 .B injectauth
51 \- inject payload as PAM_AUTHTOK for the benefit of subsequent PAM modules.
52 .PP
53 .B path=<string>
54 \- template used to find the file.
55 .PP
56 .B backend:key=value
57 \- option specific to the crypto-token. At present, only Yubikey Neo
58 crypto-token is supported, and the only option is
59 .B ykneo:slot=[1|2].
60 .PP
61
62 .SH COPYRIGHT
63 2013 Eugene G. Crosser
64 .br
65 Released under zlib Open Source license.
66 .SH SEE ALSO
67 .BR pam "(3), "ykpersonalize "(1), "pam_cr_setup "(8)