2 * rlm_unix.c authentication: Unix user authentication
3 * accounting: Functions to write radwtmp file.
4 * Also contains handler for "Group".
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * Copyright 2000 The FreeRADIUS server project
23 * Copyright 2000 Jeff Carneal <jeff@apex.net>
24 * Copyright 2000 Alan Curry <pacman@world.std.com>
26 static const char rcsid[] = "$Id$";
29 #include "libradius.h"
35 #include <sys/types.h>
45 # include <sys/security.h>
61 static char trans[64] =
62 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
63 #define ENC(c) trans[c]
65 struct unix_instance {
67 const char *passwd_file;
68 const char *shadow_file;
69 const char *group_file;
72 struct pwcache *cache;
78 static CONF_PARSER module_config[] = {
80 * Cache the password by default.
82 { "cache", PW_TYPE_BOOLEAN,
83 offsetof(struct unix_instance,cache_passwd), NULL, "no" },
84 { "passwd", PW_TYPE_STRING_PTR,
85 offsetof(struct unix_instance,passwd_file), NULL, NULL },
86 { "shadow", PW_TYPE_STRING_PTR,
87 offsetof(struct unix_instance,shadow_file), NULL, NULL },
88 { "group", PW_TYPE_STRING_PTR,
89 offsetof(struct unix_instance,group_file), NULL, NULL },
90 { "radwtmp", PW_TYPE_STRING_PTR,
91 offsetof(struct unix_instance,radwtmp), NULL, "NULL" },
92 { "usegroup", PW_TYPE_BOOLEAN,
93 offsetof(struct unix_instance,usegroup), NULL, "no" },
94 { "cache_reload", PW_TYPE_INTEGER,
95 offsetof(struct unix_instance,cache_reload), NULL, "600" },
97 { NULL, -1, 0, NULL, NULL } /* end the list */
101 * groupcmp is part of autz. But it uses the data from an auth instance. So
102 * here is where it gets it. By default this will be the first configured
103 * auth instance. That can be changed by putting "usegroup = yes" inside an
104 * auth instance to explicitly bind all Group checks to it.
107 /* binds "Group=" to an instance (a particular passwd file) */
108 static struct unix_instance *group_inst;
110 /* Tells if the above binding was explicit (usegroup=yes specified in config
111 * file) or not ("Group=" was bound to the first instance of rlm_unix */
112 static int group_inst_explicit;
116 static inline const char *get_shadow_name(shadow_pwd_t *spwd) {
117 if (spwd == NULL) return NULL;
118 return (spwd->pw_name);
121 static inline const char *get_shadow_encrypted_pwd(shadow_pwd_t *spwd) {
122 if (spwd == NULL) return NULL;
123 return (spwd->pw_passwd);
126 static inline const char *get_shadow_name(shadow_pwd_t *spwd) {
127 if (spwd == NULL) return NULL;
128 return (spwd->sp_namp);
130 static inline const char *get_shadow_encrypted_pwd(shadow_pwd_t *spwd) {
131 if (spwd == NULL) return NULL;
132 return (spwd->sp_pwdp);
135 #endif /* HAVE_GETSPNAM */
137 static struct passwd *fgetpwnam(const char *fname, const char *name) {
138 FILE *file = fopen(fname, "ro");
139 struct passwd *pwd = NULL;
141 if(file == NULL) return NULL;
143 pwd = fgetpwent(file);
148 } while (strcmp(name, pwd->pw_name) != 0);
154 static struct group *fgetgrnam(const char *fname, const char *name) {
155 FILE *file = fopen(fname, "ro");
156 struct group *grp = NULL;
158 if(file == NULL) return NULL;
161 grp = fgetgrent(file);
166 } while(strcmp(name, grp->gr_name) != 0);
173 static shadow_pwd_t *fgetspnam(const char *fname, const char *name) {
174 FILE *file = fopen(fname, "ro");
175 shadow_pwd_t *spwd = NULL;
177 if(file == NULL) return NULL;
179 spwd = fgetspent(file);
184 } while(strcmp(name, get_shadow_name(spwd)) != 0);
192 * The Group = handler.
194 static int groupcmp(void *instance, REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
195 VALUE_PAIR *check_pairs, VALUE_PAIR **reply_pairs)
204 check_pairs = check_pairs;
205 reply_pairs = reply_pairs;
208 radlog(L_ERR, "groupcmp: no group list known.");
212 if (!req->username) {
215 username = (char *)req->username->strvalue;
217 if (group_inst->cache_passwd &&
218 (retval = H_groupcmp(group_inst->cache, check, username)) != -2)
221 if (group_inst->passwd_file)
222 pwd = fgetpwnam(group_inst->passwd_file, username);
224 pwd = getpwnam(username);
228 if (group_inst->group_file)
229 grp = fgetgrnam(group_inst->group_file, (char *)check->strvalue);
231 grp = getgrnam((char *)check->strvalue);
235 retval = (pwd->pw_gid == grp->gr_gid) ? 0 : -1;
237 for (member = grp->gr_mem; *member && retval; member++) {
238 if (strcmp(*member, pwd->pw_name) == 0)
247 * FIXME: We really should have an 'init' which makes
248 * System auth == Unix
250 static int unix_init(void)
252 /* FIXME - delay these until a group file has been read so we know
253 * groupcmp can actually do something */
254 paircompare_register(PW_GROUP, PW_USER_NAME, groupcmp, NULL);
255 #ifdef PW_GROUP_NAME /* compat */
256 paircompare_register(PW_GROUP_NAME, PW_USER_NAME, groupcmp, NULL);
261 static int unix_instantiate(CONF_SECTION *conf, void **instance)
263 struct unix_instance *inst;
266 * Allocate room for the instance.
268 inst = *instance = rad_malloc(sizeof(*inst));
272 memset(inst, 0, sizeof(*inst));
275 * Parse the configuration, failing if we can't do so.
277 if (cf_section_parse(conf, inst, module_config) < 0) {
282 if (inst->cache_passwd) {
283 radlog(L_INFO, "HASH: Reinitializing hash structures "
284 "and lists for caching...");
285 if ((inst->cache = unix_buildpwcache(inst->passwd_file,
287 inst->group_file))==NULL)
289 radlog(L_ERR, "HASH: unable to create user "
290 "hash table. disable caching and run debugs");
291 if (inst->passwd_file)
292 free((char *) inst->passwd_file);
293 if (inst->shadow_file)
294 free((char *) inst->shadow_file);
295 if (inst->group_file)
296 free((char *) inst->group_file);
298 free((char *) inst->radwtmp);
303 if (inst->cache_reload) {
304 inst->last_reload = 0;
305 inst->next_reload = time(NULL) + inst->cache_reload;
311 if (inst->usegroup) {
312 if (group_inst_explicit) {
313 radlog(L_ERR, "Only one group list may be active");
316 group_inst_explicit = 1;
318 } else if (!group_inst) {
329 static int unix_detach(void *instance)
331 #define inst ((struct unix_instance *)instance)
332 if (group_inst == inst) {
334 group_inst_explicit = 0;
336 if (inst->passwd_file)
337 free((char *) inst->passwd_file);
338 if (inst->shadow_file)
339 free((char *) inst->shadow_file);
340 if (inst->group_file)
341 free((char *) inst->group_file);
343 free((char *) inst->radwtmp);
345 unix_freepwcache(inst->cache);
352 static int unix_destroy(void)
354 paircompare_unregister(PW_GROUP, groupcmp);
356 paircompare_unregister(PW_GROUP_NAME, groupcmp);
363 * Check the users password against the standard UNIX
366 static int unix_authenticate(void *instance, REQUEST *request)
368 #define inst ((struct unix_instance *)instance)
371 const char *encrypted_pass;
374 shadow_pwd_t *spwd = NULL;
377 struct pr_passwd *pr_pw;
381 char *progname = "radius";
382 SIAENTITY *ent = NULL;
384 #ifdef HAVE_GETUSERSHELL
388 /* See if we should refresh the cache */
389 if (inst->cache && inst->cache_reload
390 && (inst->next_reload < request->timestamp)) {
391 /* Time to refresh, maybe ? */
395 DEBUG2("rlm_users : Time to refresh cache.");
396 /* Check if any of the files has changed */
397 if (inst->passwd_file
398 && (stat(inst->passwd_file, &statbuf) != -1)
399 && (statbuf.st_mtime > inst->last_reload)) {
403 if (inst->shadow_file
404 && (stat(inst->shadow_file, &statbuf) != -1)
405 && (statbuf.st_mtime > inst->last_reload)) {
410 && (stat(inst->group_file, &statbuf) != -1)
411 && (statbuf.st_mtime > inst->last_reload)) {
416 /* Build a new cache to replace old one */
417 struct pwcache *oldcache;
418 struct pwcache *newcache = unix_buildpwcache(
424 oldcache = inst->cache;
425 inst->cache = newcache;
426 unix_freepwcache(oldcache);
428 inst->last_reload = time(NULL);
431 DEBUG2("rlm_users : Files were unchanged. Not reloading.");
434 /* Schedule next refresh */
435 inst->next_reload = time(NULL) + inst->cache_reload;
439 * We can only authenticate user requests which HAVE
440 * a User-Name attribute.
442 if (!request->username) {
443 radlog(L_AUTH, "rlm_unix: Attribute \"User-Name\" is required for authentication.");
444 return RLM_MODULE_INVALID;
448 * We can only authenticate user requests which HAVE
449 * a User-Password attribute.
451 if (!request->password) {
452 radlog(L_AUTH, "rlm_unix: Attribute \"User-Password\" is required for authentication.");
453 return RLM_MODULE_INVALID;
457 * Ensure that we're being passed a plain-text password,
458 * and not anything else.
460 if (request->password->attribute != PW_PASSWORD) {
461 radlog(L_AUTH, "rlm_unix: Attribute \"User-Password\" is required for authentication. Cannot use \"%s\".", request->password->name);
462 return RLM_MODULE_INVALID;
465 name = (char *)request->username->strvalue;
466 passwd = (char *)request->password->strvalue;
468 if (inst->cache_passwd &&
469 (ret = H_unix_pass(inst->cache, name, passwd, &request->reply->vps)) != -2)
470 return (ret == 0) ? RLM_MODULE_OK : RLM_MODULE_REJECT;
475 if (sia_ses_init (&ent, 1, info, NULL, name, NULL, 0, NULL) !=
477 return RLM_MODULE_NOTFOUND;
478 if ((ret = sia_ses_authent (NULL, passwd, ent)) != SIASUCCESS) {
480 sia_ses_release (&ent);
481 return RLM_MODULE_NOTFOUND;
483 if (sia_ses_estab (NULL, ent) == SIASUCCESS) {
484 sia_ses_release (&ent);
485 return RLM_MODULE_OK;
488 return RLM_MODULE_NOTFOUND;
491 if ((pr_pw = getprpwnam(name)) == NULL)
492 return RLM_MODULE_NOTFOUND;
493 encrypted_pass = pr_pw->ufld.fd_encrypt;
496 * Get encrypted password from password file
498 * If a password file was explicitly specified, use it,
499 * otherwise, use the system routines to read the
500 * system password file
502 if (inst->passwd_file != NULL) {
503 if ((pwd = fgetpwnam(inst->passwd_file, name)) == NULL)
504 return RLM_MODULE_NOTFOUND;
505 } else if ((pwd = getpwnam(name)) == NULL) {
506 return RLM_MODULE_NOTFOUND;
508 encrypted_pass = pwd->pw_passwd;
513 * See if there is a shadow password.
515 * If a shadow file was explicitly specified, use it,
516 * otherwise, use the system routines to read the
517 * system shadow file.
519 * Also, if we explicitly specify the password file,
520 * only query the _system_ shadow file if the encrypted
521 * password from the passwd file is < 10 characters (i.e.
522 * a valid password would never crypt() to it). This will
523 * prevents users from using NULL password fields as things
526 if (inst->shadow_file != NULL) {
527 if ((spwd = fgetspnam(inst->shadow_file, name)) != NULL)
528 encrypted_pass = get_shadow_encrypted_pwd(spwd);
529 } else if ((encrypted_pass == NULL) || (strlen(encrypted_pass) < 10)) {
530 if ((spwd = getspnam(name)) != NULL)
531 encrypted_pass = get_shadow_encrypted_pwd(spwd);
533 #endif /* HAVE_GETSPNAM */
537 * Undocumented temporary compatibility for iphil.NET
538 * Users with a certain shell are always denied access.
540 if (strcmp(pwd->pw_shell, DENY_SHELL) == 0) {
541 radlog(L_AUTH, "rlm_unix: [%s]: invalid shell", name);
542 return RLM_MODULE_REJECT;
546 #if HAVE_GETUSERSHELL
548 * Check /etc/shells for a valid shell. If that file
549 * contains /RADIUSD/ANY/SHELL then any shell will do.
551 while ((shell = getusershell()) != NULL) {
552 if (strcmp(shell, pwd->pw_shell) == 0 ||
553 strcmp(shell, "/RADIUSD/ANY/SHELL") == 0) {
559 radlog(L_AUTH, "rlm_unix: [%s]: invalid shell [%s]",
560 name, pwd->pw_shell);
561 return RLM_MODULE_REJECT;
565 #if defined(HAVE_GETSPNAM) && !defined(M_UNIX)
567 * Check if password has expired.
569 if (spwd && spwd->sp_expire > 0 &&
570 (request->timestamp / 86400) > spwd->sp_expire) {
571 radlog(L_AUTH, "rlm_unix: [%s]: password has expired", name);
572 return RLM_MODULE_REJECT;
576 #if defined(__FreeBSD__) || defined(bsdi) || defined(_PWF_EXPIRE)
578 * Check if password has expired.
580 if ((pwd->pw_expire > 0) &&
581 (request->timestamp > pwd->pw_expire)) {
582 radlog(L_AUTH, "rlm_unix: [%s]: password has expired", name);
583 return RLM_MODULE_REJECT;
589 * Check if account is locked.
591 if (pr_pw->uflg.fg_lock!=1) {
592 radlog(L_AUTH, "rlm_unix: [%s]: account locked", name);
593 return RLM_MODULE_USERLOCK;
598 * We might have a passwordless account.
600 if (encrypted_pass[0] == 0)
601 return RLM_MODULE_OK;
604 * Check encrypted password.
606 if (lrad_crypt_check(passwd, encrypted_pass)) {
607 radlog(L_AUTH, "rlm_unix: [%s]: invalid password", name);
608 return RLM_MODULE_REJECT;
610 return RLM_MODULE_OK;
616 * UUencode 4 bits base64. We use this to turn a 4 byte field
617 * (an IP address) into 6 bytes of ASCII. This is used for the
618 * wtmp file if we didn't find a short name in the naslist file.
620 static char *uue(void *in)
623 static unsigned char res[7];
624 unsigned char *data = (unsigned char *)in;
626 res[0] = ENC( data[0] >> 2 );
627 res[1] = ENC( ((data[0] << 4) & 060) + ((data[1] >> 4) & 017) );
628 res[2] = ENC( ((data[1] << 2) & 074) + ((data[2] >> 6) & 03) );
629 res[3] = ENC( data[2] & 077 );
631 res[4] = ENC( data[3] >> 2 );
632 res[5] = ENC( (data[3] << 4) & 060 );
635 for(i = 0; i < 6; i++) {
636 if (res[i] == ' ') res[i] = '`';
637 if (res[i] < 32 || res[i] > 127)
638 printf("uue: protocol error ?!\n");
645 * Unix accounting - write a wtmp file.
647 static int unix_accounting(void *instance, REQUEST *request)
659 int framed_address = 0;
663 int nas_port_type = 0;
664 struct unix_instance *inst = (struct unix_instance *) instance;
667 * No radwtmp. Don't do anything.
669 if (!inst->radwtmp) {
670 DEBUG2("rlm_unix: No radwtmp file configured. Ignoring accounting request.");
671 return RLM_MODULE_NOOP;
675 * Which type is this.
677 if ((vp = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE))==NULL) {
678 radlog(L_ERR, "rlm_unix: no Accounting-Status-Type attribute in request.");
679 return RLM_MODULE_NOOP;
684 * FIXME: handle PW_STATUS_ALIVE like 1.5.4.3 did.
686 if (status != PW_STATUS_START &&
687 status != PW_STATUS_STOP)
688 return RLM_MODULE_NOOP;
691 * We're only interested in accounting messages
692 * with a username in it.
694 if ((vp = pairfind(request->packet->vps, PW_USER_NAME)) == NULL)
695 return RLM_MODULE_NOOP;
697 t = request->timestamp;
698 memset(&ut, 0, sizeof(ut));
701 * First, find the interesting attributes.
703 for (vp = request->packet->vps; vp; vp = vp->next) {
704 switch (vp->attribute) {
706 if (vp->length >= sizeof(ut.ut_name)) {
707 memcpy(ut.ut_name, (char *)vp->strvalue, sizeof(ut.ut_name));
709 strNcpy(ut.ut_name, (char *)vp->strvalue, sizeof(ut.ut_name));
712 case PW_LOGIN_IP_HOST:
713 case PW_FRAMED_IP_ADDRESS:
714 framed_address = vp->lvalue;
716 case PW_FRAMED_PROTOCOL:
717 protocol = vp->lvalue;
719 case PW_NAS_IP_ADDRESS:
720 nas_address = vp->lvalue;
723 nas_port = vp->lvalue;
726 case PW_ACCT_DELAY_TIME:
729 case PW_NAS_PORT_TYPE:
730 nas_port_type = vp->lvalue;
736 * We don't store !root sessions, or sessions
737 * where we didn't see a NAS-Port attribute.
739 if (strncmp(ut.ut_name, "!root", sizeof(ut.ut_name)) == 0 || !port_seen)
740 return RLM_MODULE_NOOP;
743 * If we didn't find out the NAS address, use the
744 * originator's IP address.
746 if (nas_address == 0)
747 nas_address = request->packet->src_ipaddr;
751 * Linux has a field for the client address.
753 ut.ut_addr = framed_address;
756 * We use the tty field to store the terminal servers' port
757 * and address so that the tty field is unique.
760 if ((cl = client_find(nas_address)) != NULL)
762 if (s == NULL || s[0] == 0) s = uue(&(nas_address));
763 sprintf(buf, "%03d:%s", nas_port, s);
764 strNcpy(ut.ut_line, buf, sizeof(ut.ut_line));
767 * We store the dynamic IP address in the hostname field.
770 if (framed_address) {
771 ip_ntoa(buf, framed_address);
772 strncpy(ut.ut_host, buf, sizeof(ut.ut_host));
776 ut.ut_xtime = t- delay;
778 ut.ut_time = t - delay;
782 * And we can use the ID field to store
785 if (protocol == PW_PPP)
786 strcpy(ut.ut_id, "P");
787 else if (protocol == PW_SLIP)
788 strcpy(ut.ut_id, "S");
790 strcpy(ut.ut_id, "T");
791 ut.ut_type = status == PW_STATUS_STOP ? DEAD_PROCESS : USER_PROCESS;
793 if (status == PW_STATUS_STOP)
797 * Write a RADIUS wtmp log file.
799 * Try to open the file if we can't, we don't write the
800 * wtmp file. If we can try to write. If we fail,
801 * return RLM_MODULE_FAIL ..
803 if ((fp = fopen(inst->radwtmp, "a")) != NULL) {
804 if ((fwrite(&ut, sizeof(ut), 1, fp)) != 1) {
806 return RLM_MODULE_FAIL;
810 return RLM_MODULE_FAIL;
812 return RLM_MODULE_OK;
815 /* globally exported name */
816 module_t rlm_unix = {
818 RLM_TYPE_THREAD_UNSAFE, /* type: reserved */
819 unix_init, /* initialization */
820 unix_instantiate, /* instantiation */
822 unix_authenticate, /* authentication */
823 NULL, /* authorization */
824 NULL, /* preaccounting */
825 unix_accounting, /* accounting */
826 NULL, /* checksimul */
827 NULL, /* pre-proxy */
828 NULL, /* post-proxy */
831 unix_detach, /* detach */
832 unix_destroy, /* destroy */