2 * PAM authenticator module for Squid.
3 * Copyright (C) 1999,2002,2003 Henrik Nordstrom <hno@squid-cache.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
19 * Install instructions:
21 * This program authenticates users against a PAM configured authentication
22 * service "squid". This allows you to authenticate Squid users to any
23 * authentication source for which you have a PAM module. Commonly available
24 * PAM modules includes "UNIX", RADIUS, Kerberos and SMB, but a lot of other
25 * PAM modules are available from various sources.
27 * Example PAM configuration for standard UNIX passwd authentication:
29 * squid auth required /lib/security/pam_unix.so.1
30 * squid account required /lib/security/pam_unix.so.1
32 * Note that some PAM modules (for example shadow password authentication)
33 * requires the program to be installed suid root to gain access to the
34 * user password database
38 * Version 2.3, 2009-11-06
39 * Converted to C++. Brought into line with Squid-3 code styles.
41 * Version 2.2, 2003-11-05
42 * One shot mode is now the default mode of operation
43 * with persistent PAM connections enabled by -t option.
44 * Support for clearing the PAM_AUTHTOK attribute on
45 * persistent PAM connections.
47 * Version 2.1, 2002-08-12
48 * Squid-2.5 support (URL encoded login, password strings)
50 * Version 2.0, 2002-01-07
51 * One shot mode, command line options
54 * Version 1.3, 1999-12-10
55 * Bugfix release 1.3 to work around Solaris 2.6
56 * brokenness (not sending arguments to conversation
59 * Version 1.2, internal release
61 * Version 1.1, 1999-05-11
64 * Compile this program with: gcc -o basic_pam_auth basic_pam_auth.cc -lpam -ldl
67 #include "helpers/defines.h"
89 #if HAVE_SECURITY_PAM_APPL_H
90 #include <security/pam_appl.h>
93 /* The default PAM service name */
94 #if !defined(DEFAULT_SQUID_PAM_SERVICE)
95 #define DEFAULT_SQUID_PAM_SERVICE "squid"
99 #if !defined(DEFAULT_SQUID_PAM_TTL)
100 #define DEFAULT_SQUID_PAM_TTL 0
104 static char *password
= NULL
; /* Workaround for Solaris 2.6 brokenness */
107 extern "C" int password_conversation(int num_msg
, PAM_CONV_FUNC_CONST_PARM
struct pam_message
**msg
,
108 struct pam_response
**resp
, void *appdata_ptr
);
111 * A simple "conversation" function returning the supplied password.
112 * Has a bit to much error control, but this is my first PAM application
113 * so I'd rather check everything than make any mistakes. The function
114 * expects a single converstation message of type PAM_PROMPT_ECHO_OFF.
117 password_conversation(int num_msg
, PAM_CONV_FUNC_CONST_PARM
struct pam_message
**msg
, struct pam_response
**resp
, void *appdata_ptr
)
119 if (num_msg
!= 1 || msg
[0]->msg_style
!= PAM_PROMPT_ECHO_OFF
) {
120 debug("ERROR: Unexpected PAM converstaion '%d/%s'\n", msg
[0]->msg_style
, msg
[0]->msg
);
125 /* Workaround for Solaris 2.6 where the PAM library is broken
126 * and does not pass appdata_ptr to the conversation routine
128 appdata_ptr
= password
;
132 debug("ERROR: No password available to password_converstation!\n");
135 *resp
= static_cast<struct pam_response
*>(calloc(num_msg
, sizeof(struct pam_response
)));
137 debug("ERROR: Out of memory!\n");
140 (*resp
)[0].resp
= xstrdup((char *) appdata_ptr
);
141 (*resp
)[0].resp_retcode
= 0;
143 return ((*resp
)[0].resp
? PAM_SUCCESS
: PAM_CONV_ERR
);
146 static struct pam_conv conv
= {
147 &password_conversation
,
151 static void usage(char *program
)
153 fprintf(stderr
, "Usage: %s [options..]\n", program
);
154 fprintf(stderr
, " -n service_name\n");
155 fprintf(stderr
, " The PAM service name (default \"%s\")\n", DEFAULT_SQUID_PAM_SERVICE
);
156 fprintf(stderr
, " -t ttl PAM connection ttl in seconds (default %d)\n", DEFAULT_SQUID_PAM_TTL
);
157 fprintf(stderr
, " during this time the same connection will be reused\n");
158 fprintf(stderr
, " to authenticate all users\n");
159 fprintf(stderr
, " -o Do not perform account mgmt (account expiration etc)\n");
160 fprintf(stderr
, " -1 Only one user authentication per PAM connection\n");
164 main(int argc
, char *argv
[])
166 pam_handle_t
*pamh
= NULL
;
167 int retval
= PAM_SUCCESS
;
170 char buf
[HELPER_INPUT_BUFFER
];
171 time_t pamh_created
= 0;
172 int ttl
= DEFAULT_SQUID_PAM_TTL
;
173 const char *service
= DEFAULT_SQUID_PAM_SERVICE
;
174 int no_acct_mgmt
= 0;
176 /* make standard output line buffered */
177 setvbuf(stdout
, NULL
, _IOLBF
, 0);
180 int ch
= getopt(argc
, argv
, "1n:t:o");
197 fprintf(stderr
, "FATAL: Unknown getopt value '%c'\n", ch
);
204 fprintf(stderr
, "FATAL: Unknown option '%s'\n", argv
[optind
]);
209 while (fgets(buf
, HELPER_INPUT_BUFFER
, stdin
)) {
211 password_buf
= strchr(buf
, '\n');
213 debug("ERROR: %s: Unexpected input '%s'\n", argv
[0], buf
);
216 *password_buf
= '\0';
217 password_buf
= strchr(buf
, ' ');
219 debug("ERROR: %s: Unexpected input '%s'\n", argv
[0], buf
);
222 *password_buf
= '\0';
224 rfc1738_unescape(user
);
225 rfc1738_unescape(password_buf
);
226 conv
.appdata_ptr
= (char *) password_buf
; /* from buf above. not allocated */
229 /* Workaround for Solaris 2.6 where the PAM library is broken
230 * and does not pass appdata_ptr to the conversation routine
232 password
= password_buf
;
235 /* Create PAM connection */
236 retval
= pam_start(service
, user
, &conv
, &pamh
);
237 if (retval
!= PAM_SUCCESS
) {
238 debug("ERROR: failed to create PAM authenticator\n");
241 } else if (!pamh
|| (time(NULL
) - pamh_created
) >= ttl
|| pamh_created
> time(NULL
)) {
242 /* Close previous PAM connection */
244 retval
= pam_end(pamh
, retval
);
245 if (retval
!= PAM_SUCCESS
) {
246 debug("WARNING: failed to release PAM authenticator\n");
250 /* Initialize persistent PAM connection */
251 retval
= pam_start(service
, "squid@", &conv
, &pamh
);
252 if (retval
!= PAM_SUCCESS
) {
253 debug("ERROR: failed to create PAM authenticator\n");
256 pamh_created
= time(NULL
);
259 retval
= PAM_SUCCESS
;
261 if (retval
== PAM_SUCCESS
)
262 retval
= pam_set_item(pamh
, PAM_USER
, user
);
263 if (retval
== PAM_SUCCESS
)
264 retval
= pam_set_item(pamh
, PAM_CONV
, &conv
);
266 if (retval
== PAM_SUCCESS
)
267 retval
= pam_authenticate(pamh
, 0);
268 if (retval
== PAM_SUCCESS
&& !no_acct_mgmt
)
269 retval
= pam_acct_mgmt(pamh
, 0);
270 if (retval
== PAM_SUCCESS
) {
277 retval
= PAM_SUCCESS
;
278 #if defined(PAM_AUTHTOK)
280 if (retval
== PAM_SUCCESS
)
281 retval
= pam_set_item(pamh
, PAM_AUTHTOK
, NULL
);
284 if (ttl
== 0 || retval
!= PAM_SUCCESS
) {
285 retval
= pam_end(pamh
, retval
);
286 if (retval
!= PAM_SUCCESS
) {
287 debug("WARNING: failed to release PAM authenticator\n");
294 retval
= pam_end(pamh
, retval
);
295 if (retval
!= PAM_SUCCESS
) {
297 debug("ERROR: failed to release PAM authenticator\n");