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.");
213 * No user name, doesn't compare.
215 if (!req->username) {
218 username = (char *)req->username->strvalue;
220 if (group_inst->cache_passwd &&
221 (retval = H_groupcmp(group_inst->cache, check, username)) != -2)
224 if (group_inst->passwd_file)
225 pwd = fgetpwnam(group_inst->passwd_file, username);
227 pwd = getpwnam(username);
231 if (group_inst->group_file)
232 grp = fgetgrnam(group_inst->group_file, (char *)check->strvalue);
234 grp = getgrnam((char *)check->strvalue);
238 retval = (pwd->pw_gid == grp->gr_gid) ? 0 : -1;
240 for (member = grp->gr_mem; *member && retval; member++) {
241 if (strcmp(*member, pwd->pw_name) == 0)
250 * FIXME: We really should have an 'init' which makes
251 * System auth == Unix
253 static int unix_init(void)
255 /* FIXME - delay these until a group file has been read so we know
256 * groupcmp can actually do something */
257 paircompare_register(PW_GROUP, PW_USER_NAME, groupcmp, NULL);
258 #ifdef PW_GROUP_NAME /* compat */
259 paircompare_register(PW_GROUP_NAME, PW_USER_NAME, groupcmp, NULL);
264 static int unix_instantiate(CONF_SECTION *conf, void **instance)
266 struct unix_instance *inst;
269 * Allocate room for the instance.
271 inst = *instance = rad_malloc(sizeof(*inst));
275 memset(inst, 0, sizeof(*inst));
278 * Parse the configuration, failing if we can't do so.
280 if (cf_section_parse(conf, inst, module_config) < 0) {
285 if (inst->cache_passwd) {
286 radlog(L_INFO, "HASH: Reinitializing hash structures "
287 "and lists for caching...");
288 if ((inst->cache = unix_buildpwcache(inst->passwd_file,
290 inst->group_file))==NULL)
292 radlog(L_ERR, "HASH: unable to create user "
293 "hash table. disable caching and run debugs");
294 if (inst->passwd_file)
295 free((char *) inst->passwd_file);
296 if (inst->shadow_file)
297 free((char *) inst->shadow_file);
298 if (inst->group_file)
299 free((char *) inst->group_file);
301 free((char *) inst->radwtmp);
306 if (inst->cache_reload) {
307 inst->last_reload = 0;
308 inst->next_reload = time(NULL) + inst->cache_reload;
314 if (inst->usegroup) {
315 if (group_inst_explicit) {
316 radlog(L_ERR, "Only one group list may be active");
319 group_inst_explicit = 1;
321 } else if (!group_inst) {
332 static int unix_detach(void *instance)
334 #define inst ((struct unix_instance *)instance)
335 if (group_inst == inst) {
337 group_inst_explicit = 0;
339 if (inst->passwd_file)
340 free((char *) inst->passwd_file);
341 if (inst->shadow_file)
342 free((char *) inst->shadow_file);
343 if (inst->group_file)
344 free((char *) inst->group_file);
346 free((char *) inst->radwtmp);
348 unix_freepwcache(inst->cache);
355 static int unix_destroy(void)
357 paircompare_unregister(PW_GROUP, groupcmp);
359 paircompare_unregister(PW_GROUP_NAME, groupcmp);
366 * Check the users password against the standard UNIX
369 static int unix_authenticate(void *instance, REQUEST *request)
371 #define inst ((struct unix_instance *)instance)
374 const char *encrypted_pass;
377 shadow_pwd_t *spwd = NULL;
380 struct pr_passwd *pr_pw;
384 char *progname = "radius";
385 SIAENTITY *ent = NULL;
387 #ifdef HAVE_GETUSERSHELL
391 /* See if we should refresh the cache */
392 if (inst->cache && inst->cache_reload
393 && (inst->next_reload < request->timestamp)) {
394 /* Time to refresh, maybe ? */
398 DEBUG2("rlm_users : Time to refresh cache.");
399 /* Check if any of the files has changed */
400 if (inst->passwd_file
401 && (stat(inst->passwd_file, &statbuf) != -1)
402 && (statbuf.st_mtime > inst->last_reload)) {
406 if (inst->shadow_file
407 && (stat(inst->shadow_file, &statbuf) != -1)
408 && (statbuf.st_mtime > inst->last_reload)) {
413 && (stat(inst->group_file, &statbuf) != -1)
414 && (statbuf.st_mtime > inst->last_reload)) {
419 /* Build a new cache to replace old one */
420 struct pwcache *oldcache;
421 struct pwcache *newcache = unix_buildpwcache(
427 oldcache = inst->cache;
428 inst->cache = newcache;
429 unix_freepwcache(oldcache);
431 inst->last_reload = time(NULL);
434 DEBUG2("rlm_users : Files were unchanged. Not reloading.");
437 /* Schedule next refresh */
438 inst->next_reload = time(NULL) + inst->cache_reload;
442 * We can only authenticate user requests which HAVE
443 * a User-Name attribute.
445 if (!request->username) {
446 radlog(L_AUTH, "rlm_unix: Attribute \"User-Name\" is required for authentication.");
447 return RLM_MODULE_INVALID;
451 * We can only authenticate user requests which HAVE
452 * a User-Password attribute.
454 if (!request->password) {
455 radlog(L_AUTH, "rlm_unix: Attribute \"User-Password\" is required for authentication.");
456 return RLM_MODULE_INVALID;
460 * Ensure that we're being passed a plain-text password,
461 * and not anything else.
463 if (request->password->attribute != PW_PASSWORD) {
464 radlog(L_AUTH, "rlm_unix: Attribute \"User-Password\" is required for authentication. Cannot use \"%s\".", request->password->name);
465 return RLM_MODULE_INVALID;
468 name = (char *)request->username->strvalue;
469 passwd = (char *)request->password->strvalue;
471 if (inst->cache_passwd &&
472 (ret = H_unix_pass(inst->cache, name, passwd, &request->reply->vps)) != -2)
473 return (ret == 0) ? RLM_MODULE_OK : RLM_MODULE_REJECT;
478 if (sia_ses_init (&ent, 1, info, NULL, name, NULL, 0, NULL) !=
480 return RLM_MODULE_NOTFOUND;
481 if ((ret = sia_ses_authent (NULL, passwd, ent)) != SIASUCCESS) {
483 sia_ses_release (&ent);
484 return RLM_MODULE_NOTFOUND;
486 if (sia_ses_estab (NULL, ent) == SIASUCCESS) {
487 sia_ses_release (&ent);
488 return RLM_MODULE_OK;
491 return RLM_MODULE_NOTFOUND;
494 if ((pr_pw = getprpwnam(name)) == NULL)
495 return RLM_MODULE_NOTFOUND;
496 encrypted_pass = pr_pw->ufld.fd_encrypt;
499 * Get encrypted password from password file
501 * If a password file was explicitly specified, use it,
502 * otherwise, use the system routines to read the
503 * system password file
505 if (inst->passwd_file != NULL) {
506 if ((pwd = fgetpwnam(inst->passwd_file, name)) == NULL)
507 return RLM_MODULE_NOTFOUND;
508 } else if ((pwd = getpwnam(name)) == NULL) {
509 return RLM_MODULE_NOTFOUND;
511 encrypted_pass = pwd->pw_passwd;
516 * See if there is a shadow password.
518 * If a shadow file was explicitly specified, use it,
519 * otherwise, use the system routines to read the
520 * system shadow file.
522 * Also, if we explicitly specify the password file,
523 * only query the _system_ shadow file if the encrypted
524 * password from the passwd file is < 10 characters (i.e.
525 * a valid password would never crypt() to it). This will
526 * prevents users from using NULL password fields as things
529 if (inst->shadow_file != NULL) {
530 if ((spwd = fgetspnam(inst->shadow_file, name)) != NULL)
531 encrypted_pass = get_shadow_encrypted_pwd(spwd);
532 } else if ((encrypted_pass == NULL) || (strlen(encrypted_pass) < 10)) {
533 if ((spwd = getspnam(name)) != NULL)
534 encrypted_pass = get_shadow_encrypted_pwd(spwd);
536 #endif /* HAVE_GETSPNAM */
540 * Undocumented temporary compatibility for iphil.NET
541 * Users with a certain shell are always denied access.
543 if (strcmp(pwd->pw_shell, DENY_SHELL) == 0) {
544 radlog(L_AUTH, "rlm_unix: [%s]: invalid shell", name);
545 return RLM_MODULE_REJECT;
549 #if HAVE_GETUSERSHELL
551 * Check /etc/shells for a valid shell. If that file
552 * contains /RADIUSD/ANY/SHELL then any shell will do.
554 while ((shell = getusershell()) != NULL) {
555 if (strcmp(shell, pwd->pw_shell) == 0 ||
556 strcmp(shell, "/RADIUSD/ANY/SHELL") == 0) {
562 radlog(L_AUTH, "rlm_unix: [%s]: invalid shell [%s]",
563 name, pwd->pw_shell);
564 return RLM_MODULE_REJECT;
568 #if defined(HAVE_GETSPNAM) && !defined(M_UNIX)
570 * Check if password has expired.
572 if (spwd && spwd->sp_expire > 0 &&
573 (request->timestamp / 86400) > spwd->sp_expire) {
574 radlog(L_AUTH, "rlm_unix: [%s]: password has expired", name);
575 return RLM_MODULE_REJECT;
579 #if defined(__FreeBSD__) || defined(bsdi) || defined(_PWF_EXPIRE)
581 * Check if password has expired.
583 if ((pwd->pw_expire > 0) &&
584 (request->timestamp > pwd->pw_expire)) {
585 radlog(L_AUTH, "rlm_unix: [%s]: password has expired", name);
586 return RLM_MODULE_REJECT;
592 * Check if account is locked.
594 if (pr_pw->uflg.fg_lock!=1) {
595 radlog(L_AUTH, "rlm_unix: [%s]: account locked", name);
596 return RLM_MODULE_USERLOCK;
601 * We might have a passwordless account.
603 if (encrypted_pass[0] == 0)
604 return RLM_MODULE_OK;
607 * Check encrypted password.
609 if (lrad_crypt_check(passwd, encrypted_pass)) {
610 radlog(L_AUTH, "rlm_unix: [%s]: invalid password", name);
611 return RLM_MODULE_REJECT;
613 return RLM_MODULE_OK;
619 * UUencode 4 bits base64. We use this to turn a 4 byte field
620 * (an IP address) into 6 bytes of ASCII. This is used for the
621 * wtmp file if we didn't find a short name in the naslist file.
623 static char *uue(void *in)
626 static unsigned char res[7];
627 unsigned char *data = (unsigned char *)in;
629 res[0] = ENC( data[0] >> 2 );
630 res[1] = ENC( ((data[0] << 4) & 060) + ((data[1] >> 4) & 017) );
631 res[2] = ENC( ((data[1] << 2) & 074) + ((data[2] >> 6) & 03) );
632 res[3] = ENC( data[2] & 077 );
634 res[4] = ENC( data[3] >> 2 );
635 res[5] = ENC( (data[3] << 4) & 060 );
638 for(i = 0; i < 6; i++) {
639 if (res[i] == ' ') res[i] = '`';
640 if (res[i] < 32 || res[i] > 127)
641 printf("uue: protocol error ?!\n");
648 * Unix accounting - write a wtmp file.
650 static int unix_accounting(void *instance, REQUEST *request)
662 int framed_address = 0;
666 int nas_port_type = 0;
667 struct unix_instance *inst = (struct unix_instance *) instance;
670 * No radwtmp. Don't do anything.
672 if (!inst->radwtmp) {
673 DEBUG2("rlm_unix: No radwtmp file configured. Ignoring accounting request.");
674 return RLM_MODULE_NOOP;
678 * Which type is this.
680 if ((vp = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE))==NULL) {
681 radlog(L_ERR, "rlm_unix: no Accounting-Status-Type attribute in request.");
682 return RLM_MODULE_NOOP;
687 * FIXME: handle PW_STATUS_ALIVE like 1.5.4.3 did.
689 if (status != PW_STATUS_START &&
690 status != PW_STATUS_STOP)
691 return RLM_MODULE_NOOP;
694 * We're only interested in accounting messages
695 * with a username in it.
697 if ((vp = pairfind(request->packet->vps, PW_USER_NAME)) == NULL)
698 return RLM_MODULE_NOOP;
700 t = request->timestamp;
701 memset(&ut, 0, sizeof(ut));
704 * First, find the interesting attributes.
706 for (vp = request->packet->vps; vp; vp = vp->next) {
707 switch (vp->attribute) {
709 if (vp->length >= sizeof(ut.ut_name)) {
710 memcpy(ut.ut_name, (char *)vp->strvalue, sizeof(ut.ut_name));
712 strNcpy(ut.ut_name, (char *)vp->strvalue, sizeof(ut.ut_name));
715 case PW_LOGIN_IP_HOST:
716 case PW_FRAMED_IP_ADDRESS:
717 framed_address = vp->lvalue;
719 case PW_FRAMED_PROTOCOL:
720 protocol = vp->lvalue;
722 case PW_NAS_IP_ADDRESS:
723 nas_address = vp->lvalue;
726 nas_port = vp->lvalue;
729 case PW_ACCT_DELAY_TIME:
732 case PW_NAS_PORT_TYPE:
733 nas_port_type = vp->lvalue;
739 * We don't store !root sessions, or sessions
740 * where we didn't see a NAS-Port attribute.
742 if (strncmp(ut.ut_name, "!root", sizeof(ut.ut_name)) == 0 || !port_seen)
743 return RLM_MODULE_NOOP;
746 * If we didn't find out the NAS address, use the
747 * originator's IP address.
749 if (nas_address == 0)
750 nas_address = request->packet->src_ipaddr;
754 * Linux has a field for the client address.
756 ut.ut_addr = framed_address;
759 * We use the tty field to store the terminal servers' port
760 * and address so that the tty field is unique.
763 if ((cl = client_find(nas_address)) != NULL)
765 if (s == NULL || s[0] == 0) s = uue(&(nas_address));
766 sprintf(buf, "%03d:%s", nas_port, s);
767 strNcpy(ut.ut_line, buf, sizeof(ut.ut_line));
770 * We store the dynamic IP address in the hostname field.
773 if (framed_address) {
774 ip_ntoa(buf, framed_address);
775 strncpy(ut.ut_host, buf, sizeof(ut.ut_host));
779 ut.ut_xtime = t- delay;
781 ut.ut_time = t - delay;
785 * And we can use the ID field to store
788 if (protocol == PW_PPP)
789 strcpy(ut.ut_id, "P");
790 else if (protocol == PW_SLIP)
791 strcpy(ut.ut_id, "S");
793 strcpy(ut.ut_id, "T");
794 ut.ut_type = status == PW_STATUS_STOP ? DEAD_PROCESS : USER_PROCESS;
796 if (status == PW_STATUS_STOP)
800 * Write a RADIUS wtmp log file.
802 * Try to open the file if we can't, we don't write the
803 * wtmp file. If we can try to write. If we fail,
804 * return RLM_MODULE_FAIL ..
806 if ((fp = fopen(inst->radwtmp, "a")) != NULL) {
807 if ((fwrite(&ut, sizeof(ut), 1, fp)) != 1) {
809 return RLM_MODULE_FAIL;
813 return RLM_MODULE_FAIL;
815 return RLM_MODULE_OK;
818 /* globally exported name */
819 module_t rlm_unix = {
821 RLM_TYPE_THREAD_UNSAFE, /* type: reserved */
822 unix_init, /* initialization */
823 unix_instantiate, /* instantiation */
825 unix_authenticate, /* authentication */
826 NULL, /* authorization */
827 NULL, /* preaccounting */
828 unix_accounting, /* accounting */
829 NULL, /* checksimul */
830 NULL, /* pre-proxy */
831 NULL, /* post-proxy */
834 unix_detach, /* detach */
835 unix_destroy, /* destroy */