2 * exec.c Execute external programs.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2000-2004,2006 The FreeRADIUS server project
23 #include <freeradius-devel/ident.h>
26 #include <freeradius-devel/radiusd.h>
27 #include <freeradius-devel/rad_assert.h>
35 #ifdef HAVE_SYS_WAIT_H
36 # include <sys/wait.h>
39 # define WEXITSTATUS(stat_val) ((unsigned)(stat_val) >> 8)
42 # define WIFEXITED(stat_val) (((stat_val) & 255) == 0)
45 #define MAX_ARGV (256)
47 * Execute a program on successful authentication.
48 * Return 0 if exec_wait == 0.
49 * Return the exit code of the called program if exec_wait != 0.
50 * Return -1 on fork/other errors in the parent process.
52 int radius_exec_program(const char *cmd, REQUEST *request,
54 char *user_msg, int msg_len,
55 VALUE_PAIR *input_pairs,
56 VALUE_PAIR **output_pairs,
74 if (user_msg) *user_msg = '\0';
75 if (output_pairs) *output_pairs = NULL;
77 if (strlen(cmd) > (sizeof(mycmd) - 1)) {
78 radlog(L_ERR|L_CONS, "Command line is too long");
83 * Check for bad escapes.
85 if (cmd[strlen(cmd) - 1] == '\\') {
86 radlog(L_ERR|L_CONS, "Command line has final backslash, without a following character");
90 strlcpy(mycmd, cmd, sizeof(mycmd));
93 * Split the string into argv's BEFORE doing radius_xlat...
104 if ((*from == ' ') || (*from == '\t')) {
112 if (argc >= (MAX_ARGV - 1)) break;
115 * Copy the argv over to our buffer.
117 while (*from && (*from != ' ') && (*from != '\t')) {
118 if (to >= mycmd + sizeof(mycmd) - 1) {
119 return -1; /* ran out of space */
125 length = rad_copy_string(to, from);
127 radlog(L_ERR|L_CONS, "Invalid string passed as argument for external program");
135 if (from[1] == '{') {
138 length = rad_copy_variable(to, from);
140 radlog(L_ERR|L_CONS, "Invalid variable expansion passed as argument for external program");
145 } else { /* FIXME: catch %%{ ? */
153 } /* end of string, or found a space */
155 *(to++) = '\0'; /* terminate the string */
159 * We have to have SOMETHING, at least.
162 radlog(L_ERR, "Exec-Program: empty command line.");
167 * Expand each string, as appropriate.
170 left = sizeof(argv_buf);
171 for (i = 0; i < argc; i++) {
175 * Don't touch argv's which won't be translated.
177 if (strchr(argv[i], '%') == NULL) continue;
179 if (!request) continue;
181 sublen = radius_xlat(to, left - 1, argv[i], request, NULL);
184 * Fail to be backwards compatible.
186 * It's yucky, but it won't break anything,
187 * and it won't cause security problems.
199 radlog(L_ERR, "Exec-Program: Ran out of space while expanding arguments.");
206 * Open a pipe for child/parent communication, if necessary.
210 radlog(L_ERR|L_CONS, "Couldn't open pipe: %s",
216 * We're not waiting, so we don't look for a
224 pid = rad_fork(); /* remember PID */
226 pid = fork(); /* don't wait */
230 #define MAX_ENVP 1024
232 char *envp[MAX_ENVP];
239 * We try to be fail-safe here. So if ANYTHING
240 * goes wrong, we exit with status 1.
244 * Open STDIN to /dev/null
246 devnull = open("/dev/null", O_RDWR);
248 radlog(L_ERR|L_CONS, "Failed opening /dev/null: %s\n",
252 dup2(devnull, STDIN_FILENO);
255 * Only massage the pipe handles if the parent
260 * pd[0] is the FD the child will read from,
261 * which we don't want.
263 if (close(pd[0]) != 0) {
264 radlog(L_ERR|L_CONS, "Can't close pipe: %s",
270 * pd[1] is the FD that the child will write to,
271 * so we make it STDOUT.
273 if (dup2(pd[1], STDOUT_FILENO) != 1) {
274 radlog(L_ERR|L_CONS, "Can't dup stdout: %s",
279 } else { /* no pipe, STDOUT should be /dev/null */
280 dup2(devnull, STDOUT_FILENO);
284 * If we're not debugging, then we can't do
285 * anything with the error messages, so we throw
288 * If we are debugging, then we want the error
289 * messages to go to the STDERR of the server.
291 if (debug_flag == 0) {
292 dup2(devnull, STDERR_FILENO);
297 * The server may have MANY FD's open. We don't
298 * want to leave dangling FD's for the child process
299 * to play funky games with, so we close them.
304 * Set up the environment variables.
305 * We're in the child, and it will exit in 4 lines
306 * anyhow, so memory allocation isn't an issue.
310 for (vp = input_pairs; vp != NULL; vp = vp->next) {
312 * Hmm... maybe we shouldn't pass the
313 * user's password in an environment
316 snprintf(buffer, sizeof(buffer), "%s=", vp->name);
318 for (p = buffer; *p != '='; p++) {
321 } else if (isalpha((int) *p)) {
328 vp_prints_value(buffer+n, sizeof(buffer) - n, vp, shell_escape);
330 envp[envlen++] = strdup(buffer);
333 * Don't add too many attributes.
335 if (envlen == (MAX_ENVP - 1)) break;
339 execve(argv[0], argv, envp);
340 radlog(L_ERR, "Exec-Program: FAILED to execute %s: %s",
341 argv[0], strerror(errno));
349 radlog(L_ERR|L_CONS, "Couldn't fork %s: %s",
350 argv[0], strerror(errno));
355 * We're not waiting, exit, and ignore any child's status.
362 * Close the FD to which the child writes it's data.
364 * If we can't close it, then we close pd[0], and return an
367 if (close(pd[1]) != 0) {
368 radlog(L_ERR|L_CONS, "Can't close pipe: %s", strerror(errno));
374 * Read from the pipe until we doesn't get any more or
375 * until the message is full.
378 left = sizeof(answer) - 1;
380 status = read(pd[0], answer + done, left);
382 * Nothing more to read: stop.
389 * Error: See if we have to continue.
393 * We were interrupted: continue reading.
395 if (errno == EINTR) {
400 * There was another error. Most likely
401 * The child process has finished, and
409 if (left <= 0) break;
414 * Make sure that the writer can't block while writing to
415 * a pipe that no one is reading from anymore.
419 DEBUG2("Exec-Program output: %s", answer);
422 * Parse the output, if any.
428 * For backwards compatibility, first check
429 * for plain text (user_msg).
432 n = userparse(answer, &vp);
438 if (n == T_OP_INVALID) {
439 DEBUG("Exec-Program-Wait: plaintext: %s", answer);
441 strlcpy(user_msg, answer, msg_len);
445 * HACK: Replace '\n' with ',' so that
446 * userparse() can parse the buffer in
447 * one go (the proper way would be to
448 * fix userparse(), but oh well).
450 for (p = answer; *p; p++) {
452 *p = comma ? ' ' : ',';
456 if (*p == ',') comma++;
460 * Replace any trailing comma by a NUL.
462 if (answer[strlen(answer) - 1] == ',') {
463 answer[strlen(answer) - 1] = '\0';
466 radlog(L_DBG,"Exec-Program-Wait: value-pairs: %s", answer);
467 if (userparse(answer, &vp) == T_OP_INVALID) {
468 radlog(L_ERR, "Exec-Program-Wait: %s: unparsable reply", cmd);
472 * Tell the caller about the value
477 } /* else the answer was a set of VP's, not a text message */
478 } /* else we didn't read anything from the child */
481 * Call rad_waitpid (should map to waitpid on non-threaded
482 * or single-server systems).
484 child_pid = rad_waitpid(pid, &status);
485 if (child_pid == 0) {
486 radlog(L_DBG, "Exec-Program: Timeout waiting for child");
490 if (child_pid == pid) {
491 if (WIFEXITED(status)) {
492 status = WEXITSTATUS(status);
493 radlog(L_DBG, "Exec-Program: returned: %d", status);
498 radlog(L_ERR|L_CONS, "Exec-Program: Abnormal child exit: %s",