2 * rlm_jradius - The FreeRADIUS JRadius Server Module
3 * Copyright (C) 2004-2006 PicoPoint, B.V.
4 * Copyright (c) 2007 David Bird
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * This module is used to connect FreeRADIUS to the JRadius server.
21 * JRadius is a Java RADIUS client and server framework, see doc/rlm_jradius
22 * and http://jradius.net/ for more information.
24 * Author(s): David Bird <dbird@acm.org>
26 * Connection pooling code based on rlm_sql, see rlm_sql/sql.c for copyright and license.
32 #include <sys/signal.h>
33 #include <sys/types.h>
37 #include <freeradius-devel/ident.h>
40 #include <freeradius-devel/autoconf.h>
41 #include <freeradius-devel/libradius.h>
42 #include <freeradius-devel/radiusd.h>
43 #include <freeradius-devel/modules.h>
44 #include <freeradius-devel/conffile.h>
50 #ifdef HAVE_SYS_SOCKET_H
51 #include <sys/socket.h>
55 #define O_NONBLOCK O_NDELAY
58 static const int JRADIUS_PORT = 1814;
59 static const int HALF_MESSAGE_LEN = 16384;
60 static const int MESSAGE_LEN = 32768;
62 static const int JRADIUS_authenticate = 1;
63 static const int JRADIUS_authorize = 2;
64 static const int JRADIUS_preacct = 3;
65 static const int JRADIUS_accounting = 4;
66 static const int JRADIUS_checksimul = 5;
67 static const int JRADIUS_pre_proxy = 6;
68 static const int JRADIUS_post_proxy = 7;
69 static const int JRADIUS_post_auth = 8;
71 #define LOG_PREFIX "rlm_jradius: "
74 typedef struct jradius_socket {
77 pthread_mutex_t mutex;
79 struct jradius_socket *next;
80 enum { is_connected, not_connected } state;
87 typedef struct jradius_inst {
93 char * host [MAX_HOSTS];
94 uint32_t ipaddr [MAX_HOSTS];
105 typedef struct _byte_array
113 static CONF_PARSER module_config[] = {
114 { "name", PW_TYPE_STRING_PTR, offsetof(JRADIUS, name), NULL, "localhost"},
115 { "primary", PW_TYPE_STRING_PTR, offsetof(JRADIUS, host[0]), NULL, "localhost"},
116 { "secondary", PW_TYPE_STRING_PTR, offsetof(JRADIUS, host[1]), NULL, NULL},
117 { "tertiary", PW_TYPE_STRING_PTR, offsetof(JRADIUS, host[2]), NULL, NULL},
118 { "timeout", PW_TYPE_INTEGER, offsetof(JRADIUS, timeout), NULL, "5"},
119 { "onfail", PW_TYPE_STRING_PTR, offsetof(JRADIUS, onfail_s), NULL, NULL},
120 { "keepalive", PW_TYPE_BOOLEAN, offsetof(JRADIUS, keepalive), NULL, "yes"},
121 { "connections", PW_TYPE_INTEGER, offsetof(JRADIUS, jrsock_cnt), NULL, "8"},
122 { "allow_codechange", PW_TYPE_BOOLEAN, offsetof(JRADIUS, allow_codechange), NULL, "no"},
123 { "allow_idchange", PW_TYPE_BOOLEAN, offsetof(JRADIUS, allow_idchange), NULL, "no"},
124 { NULL, -1, 0, NULL, NULL }
127 static int connect_socket(JRSOCK *jrsock, JRADIUS *inst)
129 struct sockaddr_in local_addr, serv_addr;
130 int i, connected = 0;
135 * Connect to jradius servers until we succeed or die trying
137 for (i = 0; !connected && i < MAX_HOSTS && inst->ipaddr[i] > 0; i++) {
140 * Allocate a TCP socket
142 if ((sock = socket(AF_INET, SOCK_STREAM, 0)) == -1) {
143 radlog(L_ERR, LOG_PREFIX "could not allocate TCP socket");
148 * If we have a timeout value set, make the socket non-blocking
150 if (inst->timeout > 0 &&
151 fcntl(sock, F_SETFL, fcntl(sock, F_GETFL, 0) | O_NONBLOCK) == -1) {
152 radlog(L_ERR, LOG_PREFIX "could not set non-blocking on socket");
157 * Bind to any local port
159 memset(&local_addr, 0, sizeof(local_addr));
160 local_addr.sin_family = AF_INET;
161 local_addr.sin_addr.s_addr = htonl(INADDR_ANY);
162 local_addr.sin_port = htons(0);
164 if (bind(sock, (struct sockaddr *) &local_addr, sizeof(local_addr)) < 0) {
165 radlog(L_ERR, LOG_PREFIX "could not locally bind TCP socket");
170 * Attempt connection to remote server
172 memset(&serv_addr, 0, sizeof(serv_addr));
173 serv_addr.sin_family = AF_INET;
174 memcpy((char *) &serv_addr.sin_addr, &(inst->ipaddr[i]), 4);
175 serv_addr.sin_port = htons(inst->port[i]);
177 if (connect(sock, (struct sockaddr *)&serv_addr, sizeof(serv_addr)) < 0) {
178 if (inst->timeout > 0 && (errno == EINPROGRESS || errno == EWOULDBLOCK)) {
180 * Wait to see if non-blocking socket connects or times-out
183 memset(&pfd, 0, sizeof(pfd));
186 pfd.events = POLLOUT;
188 if (poll(&pfd, 1, inst->timeout * 1000) == 1 && pfd.revents) {
190 * Lets make absolutely sure we are connected
192 struct sockaddr_in sa;
193 unsigned int salen = sizeof(sa);
194 if (getpeername(sock, (struct sockaddr *) &sa, &salen) != -1) {
196 * CONNECTED! break out of for-loop
207 radlog(L_ERR, LOG_PREFIX "could not connect to %s:%d",
208 ip_ntoa(buff, inst->ipaddr[i]), inst->port[i]);
212 * CONNECTED (instantly)! break out of for-loop
219 * Unable to connect, cleanup and start over
225 radlog(L_ERR, LOG_PREFIX "could not find any jradius server!");
230 * If we previously set the socket to non-blocking, restore blocking
232 if (inst->timeout > 0 &&
233 fcntl(sock, F_SETFL, fcntl(sock, F_GETFL, 0) & ~O_NONBLOCK) == -1) {
234 radlog(L_ERR, LOG_PREFIX "could not set blocking on socket");
238 jrsock->state = is_connected;
239 jrsock->con.sock = sock;
243 if (sock > 0) { shutdown(sock, 2); close(sock); }
244 jrsock->state = not_connected;
248 static void close_socket(UNUSED JRADIUS * inst, JRSOCK *jrsock)
250 radlog(L_INFO, "rlm_jradius: Closing JRadius connection %d", jrsock->id);
251 if (jrsock->con.sock > 0) {
252 shutdown(jrsock->con.sock, 2);
253 close(jrsock->con.sock);
255 jrsock->state = not_connected;
256 jrsock->con.sock = 0;
259 static void free_socket(JRADIUS * inst, JRSOCK *jrsock) {
260 close_socket(inst, jrsock);
261 if (inst->keepalive) {
262 #ifdef HAVE_PTHREAD_H
263 pthread_mutex_destroy(&jrsock->mutex);
269 static int socket_send(JRSOCK *jrsock, unsigned char *b, unsigned int blen) {
270 return send(jrsock->con.sock, b, blen, 0);
273 static int init_socketpool(JRADIUS * inst)
279 inst->connect_after = 0;
280 inst->sock_pool = NULL;
282 for (i = 0; i < inst->jrsock_cnt; i++) {
283 radlog(L_INFO, "rlm_jradius: starting JRadius connection %d", i);
285 if ((jrsock = rad_malloc(sizeof(*jrsock))) == 0) return -1;
287 memset(jrsock, 0, sizeof(*jrsock));
289 jrsock->state = not_connected;
291 #ifdef HAVE_PTHREAD_H
292 rcode = pthread_mutex_init(&jrsock->mutex,NULL);
294 radlog(L_ERR, "rlm_jradius: Failed to init lock: %s", strerror(errno));
299 if (time(NULL) > inst->connect_after)
300 if (connect_socket(jrsock, inst))
303 jrsock->next = inst->sock_pool;
304 inst->sock_pool = jrsock;
306 inst->last_used = NULL;
309 radlog(L_DBG, "rlm_jradius: Failed to connect to JRadius server.");
315 static void free_socketpool(JRADIUS * inst)
320 for (cur = inst->sock_pool; cur; cur = next) {
322 free_socket(inst, cur);
325 inst->sock_pool = NULL;
328 static JRSOCK * get_socket(JRADIUS * inst)
331 int tried_to_connect = 0;
334 start = inst->last_used;
335 if (!start) start = inst->sock_pool;
340 #ifdef HAVE_PTHREAD_H
341 if (pthread_mutex_trylock(&cur->mutex) != 0) {
346 if ((cur->state == not_connected) && (time(NULL) > inst->connect_after)) {
347 radlog(L_INFO, "rlm_jradius: Trying to (re)connect unconnected handle %d", cur->id);
349 connect_socket(cur, inst);
352 if (cur->state == not_connected) {
353 radlog(L_DBG, "rlm_jradius: Ignoring unconnected handle %d", cur->id);
355 #ifdef HAVE_PTHREAD_H
356 pthread_mutex_unlock(&cur->mutex);
361 radlog(L_DBG, "rlm_jradius: Reserving JRadius socket id: %d", cur->id);
363 if (unconnected != 0 || tried_to_connect != 0) {
364 radlog(L_INFO, "rlm_jradius: got socket %d after skipping %d unconnected handles, tried to reconnect %d though",
365 cur->id, unconnected, tried_to_connect);
368 inst->last_used = cur->next;
373 if (!cur) cur = inst->sock_pool;
374 if (cur == start) break;
377 radlog(L_INFO, "rlm_jradius: There are no sockets to use! skipped %d, tried to connect %d",
378 unconnected, tried_to_connect);
382 static int release_socket(UNUSED JRADIUS * inst, JRSOCK * jrsock)
384 #ifdef HAVE_PTHREAD_H
385 pthread_mutex_unlock(&jrsock->mutex);
388 radlog(L_DBG, "rlm_jradius: Released JRadius socket id: %d", jrsock->id);
395 * Initialize the jradius module
397 static int jradius_instantiate(CONF_SECTION *conf, void **instance)
399 JRADIUS *inst = (JRADIUS *) instance;
400 char host[128], b[128], *h;
403 inst = rad_malloc(sizeof(JRADIUS));
404 memset(inst, 0, sizeof(JRADIUS));
406 if (cf_section_parse(conf, inst, module_config) < 0) {
411 for (i = 0, idx = 0; i < MAX_HOSTS; i++) {
412 if (inst->host[i] && strlen(inst->host[i]) < sizeof(host)) {
417 if (sscanf(b, "%[^:]:%d", host, &port) == 2) { h = host; p = port; }
421 if (ip_hton(h, AF_INET, &ipaddr) < 0) {
422 radlog(L_ERR, "Can't find IP address for host %s", h);
425 if ((inst->ipaddr[idx] = ipaddr.ipaddr.ip4addr.s_addr) != htonl(INADDR_NONE)) {
427 radlog(L_INFO, LOG_PREFIX "configuring jradius server %s:%d", h, p);
430 radlog(L_ERR, LOG_PREFIX "invalid jradius server %s", h);
436 if (inst->keepalive) init_socketpool(inst);
438 inst->onfail = RLM_MODULE_FAIL;
440 if (inst->onfail_s) {
441 if (!strcmp(inst->onfail_s, "NOOP")) inst->onfail = RLM_MODULE_NOOP;
442 else if (!strcmp(inst->onfail_s, "REJECT")) inst->onfail = RLM_MODULE_REJECT;
443 else if (!strcmp(inst->onfail_s, "OK")) inst->onfail = RLM_MODULE_OK;
444 else if (!strcmp(inst->onfail_s, "FAIL")) inst->onfail = RLM_MODULE_FAIL;
445 else radlog(L_ERR, LOG_PREFIX "invalid jradius 'onfail' state %s", inst->onfail_s);
454 * Initialize a byte array buffer structure
456 static void init_byte_array(byte_array * ba, unsigned char *b, int blen)
459 ba->size = ba->left = blen;
464 * Pack a single byte into a byte array buffer
466 static int pack_byte(byte_array * ba, unsigned char c)
468 if (ba->left < 1) return -1;
478 * Pack an array of bytes into a byte array buffer
480 static int pack_bytes(byte_array * ba, unsigned char *d, unsigned int dlen)
482 if (ba->left < dlen) return -1;
484 memcpy((void *)(ba->b + ba->pos), d, dlen);
492 * Pack an integer into a byte array buffer (adjusting for byte-order)
494 static int pack_uint32(byte_array * ba, uint32_t i)
496 if (ba->left < 4) return -1;
500 memcpy((void *)(ba->b + ba->pos), (void *)&i, 4);
508 * Pack one byte array buffer into another byte array buffer
510 static int pack_array(byte_array * ba, byte_array * a)
512 if (ba->left < a->pos) return -1;
514 memcpy((void *)(ba->b + ba->pos), (void *)a->b, a->pos);
522 * Pack radius attributes into a byte array buffer
524 static int pack_vps(byte_array * ba, VALUE_PAIR * vps)
529 for (vp = vps; vp != NULL; vp = vp->next) {
531 radlog(L_DBG, LOG_PREFIX "packing attribute %s (type: %d; len: %d)",
532 vp->name, vp->attribute, vp->length);
534 i = vp->attribute; /* element is int, not uint32_t */
535 if (pack_uint32(ba, i) == -1) return -1;
537 if (pack_uint32(ba, i) == -1) return -1;
539 if (pack_uint32(ba, i) == -1) return -1;
542 case PW_TYPE_INTEGER:
544 if (pack_uint32(ba, vp->lvalue) == -1) return -1;
547 if (pack_bytes(ba, (void *)&vp->vp_ipaddr, vp->length) == -1) return -1;
550 if (pack_bytes(ba, (void *)vp->vp_octets, vp->length) == -1) return -1;
559 * Pack a radius packet into a byte array buffer
561 static int pack_packet(byte_array * ba, RADIUS_PACKET * p)
563 /*unsigned char code = p->code;*/
564 unsigned char buff[HALF_MESSAGE_LEN];
567 init_byte_array(&pba, buff, sizeof(buff));
569 if (pack_vps (&pba, p->vps) == -1) return -1;
571 radlog(L_DBG, LOG_PREFIX "packing packet with code: %d (attr length: %d)", p->code, pba.pos);
573 if (pack_byte (ba, p->code) == -1) return -1;
574 if (pack_byte (ba, p->id) == -1) return -1;
575 if (pack_uint32 (ba, pba.pos) == -1) return -1;
576 if (pba.pos == 0) return 0;
577 if (pack_array (ba, &pba) == -1) return -1;
582 static int pack_request(byte_array * ba, REQUEST *r)
584 unsigned char buff[HALF_MESSAGE_LEN];
587 init_byte_array(&pba, buff, sizeof(buff));
589 if (pack_vps (&pba, r->config_items) == -1) return -1;
590 if (pack_uint32 (ba, pba.pos) == -1) return -1;
591 if (pba.pos == 0) return 0;
592 if (pack_array (ba, &pba) == -1) return -1;
598 * Read a single byte from socket
600 static int read_byte(JRSOCK *jrsock, unsigned char *b)
602 return (read(jrsock->con.sock, b, 1) == 1) ? 0 : -1;
605 static void unpack_uint32(unsigned char *c, uint32_t *i)
608 memcpy((void *)&ii, c, 4);
613 * Read an integer from the socket (adjusting for byte-order)
615 static int read_uint32(JRSOCK *jrsock, uint32_t *i)
619 if (read(jrsock->con.sock, &ii, 4) != 4) return -1;
626 * Read a value-pair list from the socket
628 static int read_vps(JRSOCK *jrsock, VALUE_PAIR **pl, int plen)
631 unsigned char buff[MESSAGE_LEN];
632 uint32_t alen, atype, aop;
635 while (rlen < plen) {
636 if (read_uint32 (jrsock, &atype) == -1) return -1; rlen += 4;
637 if (read_uint32 (jrsock, &alen) == -1) return -1; rlen += 4;
638 if (read_uint32 (jrsock, &aop) == -1) return -1; rlen += 4;
640 radlog(L_DBG, LOG_PREFIX "reading attribute: type=%d; len=%d", atype, alen);
642 if (alen >= sizeof(buff)) {
643 radlog(L_ERR, LOG_PREFIX "packet value too large (len: %d)", alen);
647 if (read(jrsock->con.sock, buff, alen) != (int)alen) return -1; rlen += alen;
651 * Create new attribute
653 vp = paircreate(atype, -1);
656 if (vp->type == -1) {
658 * FreeRADIUS should know about the same attributes that JRadius knows
660 radlog(L_ERR, LOG_PREFIX "received attribute we do not recognize (type: %d)", atype);
666 * Fill in the attribute value based on type
669 case PW_TYPE_INTEGER:
672 unpack_uint32(buff, &vp->lvalue);
678 memcpy((void *)&vp->vp_ipaddr, buff, 4);
683 if (alen >= sizeof(vp->vp_octets)) alen = sizeof(vp->vp_octets) - 1;
684 memcpy((void *)vp->vp_octets, buff, alen);
690 * Add the attribute to the packet
699 * Read a radius packet from the socket
701 static int read_packet(JRADIUS * inst, JRSOCK *jrsock, RADIUS_PACKET *p)
707 if (read_byte (jrsock, &code) == -1) return -1;
708 if (read_byte (jrsock, &id) == -1) return -1;
709 if (read_uint32 (jrsock, &plen) == -1) return -1;
711 radlog(L_DBG, LOG_PREFIX "reading packet: code=%d len=%d", (int)code, plen);
713 if (inst->allow_codechange)
714 if (code != p->code) {
715 radlog(L_INFO, LOG_PREFIX "changing packet code from %d to %d", p->code, code);
719 if (inst->allow_idchange)
721 radlog(L_INFO, LOG_PREFIX "changing packet id from %d to %d", p->id, id);
726 * Delete previous attribute list
730 if (plen == 0) return 0;
732 if (read_vps (jrsock, &p->vps, plen) == -1) return -1;
737 static int read_request(JRSOCK *jrsock, REQUEST *p)
741 if (read_uint32(jrsock, &plen) == -1) return -1;
743 radlog(L_DBG, LOG_PREFIX "reading request: config_item: len=%d", plen);
746 * Delete previous attribute list
748 pairfree(&p->config_items);
750 if (plen == 0) return 0;
752 if (read_vps(jrsock, &p->config_items, plen) == -1) return -1;
757 static int rlm_jradius_call(char func, void *instance, REQUEST *req, int isproxy)
759 JRADIUS * inst = instance;
760 RADIUS_PACKET * request = isproxy ? req->proxy : req->packet;
761 RADIUS_PACKET * reply = isproxy ? req->proxy_reply : req->reply;
765 int exitstatus = inst->onfail;
766 unsigned char rcode, pcount;
768 unsigned char buff[MESSAGE_LEN];
771 char * n = inst->name;
772 unsigned int nlen = strlen(n);
773 const char * err = 0;
776 #define W_ERR(s) { err=s; goto packerror; }
777 #define R_ERR(s) { err=s; goto parseerror; }
779 if (inst->keepalive) {
780 jrsock = get_socket(inst);
781 if (!jrsock) return exitstatus;
784 memset(jrsock, 0, sizeof(*jrsock));
785 jrsock->state = not_connected;
788 init_byte_array(&ba, buff, sizeof(buff));
791 if (request) pcount++;
795 * Create byte array to send to jradius
797 if ((rc = pack_uint32 (&ba, nlen)) == -1) W_ERR("pack_uint32(nlen)");
798 if ((rc = pack_bytes (&ba, (void *)n, nlen)) == -1) W_ERR("pack_bytes(name)");
799 if ((rc = pack_byte (&ba, func)) == -1) W_ERR("pack_byte(fun)");
800 if ((rc = pack_byte (&ba, pcount)) == -1) W_ERR("pack_byte(pcnt)");
801 if (pcount > 0 && (rc = pack_packet (&ba, request)) == -1) W_ERR("pack_packet(req)");
802 if (pcount > 1 && (rc = pack_packet (&ba, reply)) == -1) W_ERR("pack_packet(rep)");
803 if ((rc = pack_request(&ba, req)) == -1) W_ERR("pack_request()");
809 if (jrsock->state == not_connected) {
810 if (attempt2) radlog(L_ERR, LOG_PREFIX "reconnecting socket id %d", jrsock->id);
811 if (!connect_socket(jrsock, inst)) {
812 if (attempt2) radlog(L_ERR, LOG_PREFIX "could not reconnect socket %d, giving up", jrsock->id);
816 radlog(L_DBG, LOG_PREFIX "sending %d bytes to socket %d", ba.pos, jrsock->id);
817 if (socket_send(jrsock, ba.b, ba.pos) != (int)ba.pos ||
818 (rc = read_byte (jrsock, &rcode)) == -1) {
820 * With an error on the write or the first read, try closing the socket
821 * and reconnecting to see if that improves matters any (tries this only once)
823 radlog(L_ERR, LOG_PREFIX "error sending request with socket %d", jrsock->id);
824 if (!inst->keepalive || attempt2) W_ERR("socket_send/first_read");
825 close_socket(inst, jrsock);
833 if ((rc = read_byte (jrsock, &pcount)) == -1) R_ERR("read_byte(pcnt)");
835 radlog(L_DBG, LOG_PREFIX "return code %d; receiving %d packets", (int)rcode, (int)pcount);
837 if (pcount > 0 && request) if ((rc = read_packet (inst, jrsock, request)) == -1) R_ERR("read_packet(req)");
838 if (pcount > 1 && reply) if ((rc = read_packet (inst, jrsock, reply)) == -1) R_ERR("read_packet(rep)");
840 if ((rc = read_request (jrsock, req)) == -1) R_ERR("read_request()");
843 * Since we deleted all the attribute lists in the request,
844 * we need to reconfigure a few pointers in the REQUEST object
847 req->username = pairfind(request->vps, PW_USER_NAME);
850 req->password = pairfind(request->vps, PW_PASSWORD);
851 if (!req->password) req->password = pairfind(request->vps, PW_CHAP_PASSWORD);
855 * All done, set return code and cleanup
857 exitstatus = (int)rcode;
861 radlog(L_ERR, LOG_PREFIX "problem parsing the data [%s]",err);
862 if (inst->keepalive) close_socket(inst, jrsock);
866 radlog(L_ERR, LOG_PREFIX "problem packing the data[%s]",err);
867 if (inst->keepalive) close_socket(inst, jrsock);
871 release_socket(inst, jrsock);
873 close_socket(inst, jrsock);
878 static int jradius_authenticate(void *instance, REQUEST *request)
880 return rlm_jradius_call(JRADIUS_authenticate, instance, request, 0);
883 static int jradius_authorize(void *instance, REQUEST *request)
885 return rlm_jradius_call(JRADIUS_authorize, instance, request, 0);
888 static int jradius_preacct(void *instance, REQUEST *request)
890 return rlm_jradius_call(JRADIUS_preacct, instance, request, 0);
893 static int jradius_accounting(void *instance, REQUEST *request)
895 return rlm_jradius_call(JRADIUS_accounting, instance, request, 0);
898 static int jradius_checksimul(void *instance, REQUEST *request)
900 return rlm_jradius_call(JRADIUS_checksimul, instance, request, 0);
903 static int jradius_pre_proxy(void *instance, REQUEST *request)
905 return rlm_jradius_call(JRADIUS_pre_proxy, instance, request, 1);
908 static int jradius_post_proxy(void *instance, REQUEST *request)
910 return rlm_jradius_call(JRADIUS_post_proxy, instance, request, 1);
913 static int jradius_post_auth(void *instance, REQUEST *request)
915 return rlm_jradius_call(JRADIUS_post_auth, instance, request, 0);
918 static int jradius_detach(void *instance)
920 JRADIUS *inst = (JRADIUS *) instance;
921 free_socketpool(inst);
926 module_t rlm_jradius = {
929 RLM_TYPE_THREAD_SAFE,
933 jradius_authenticate,