2 * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/usr.sbin/ppp/chat.c,v 1.70.2.3 2002/09/01 02:12:23 brian Exp $
29 #include <sys/param.h>
30 #include <netinet/in.h>
31 #include <netinet/in_systm.h>
32 #include <netinet/ip.h>
33 #include <sys/socket.h>
53 #include "throughput.h"
59 #include "descriptor.h"
65 #include "slcompress.h"
81 #define BUFLEFT(c) (sizeof (c)->buf - ((c)->bufend - (c)->buf))
83 static void ExecStr(struct physical *, char *, char *, int);
84 static char *ExpandString(struct chat *, const char *, char *, int, int);
87 chat_PauseTimer(void *v)
89 struct chat *c = (struct chat *)v;
90 timer_Stop(&c->pause);
95 chat_Pause(struct chat *c, u_long load)
97 timer_Stop(&c->pause);
98 c->pause.load += load;
99 c->pause.func = chat_PauseTimer;
100 c->pause.name = "chat pause";
102 timer_Start(&c->pause);
106 chat_TimeoutTimer(void *v)
108 struct chat *c = (struct chat *)v;
109 timer_Stop(&c->timeout);
114 chat_SetTimeout(struct chat *c)
116 timer_Stop(&c->timeout);
117 if (c->TimeoutSec > 0) {
118 c->timeout.load = SECTICKS * c->TimeoutSec;
119 c->timeout.func = chat_TimeoutTimer;
120 c->timeout.name = "chat timeout";
122 timer_Start(&c->timeout);
127 chat_NextChar(char *ptr, char ch)
132 else if (*ptr == '\\')
140 chat_UpdateSet(struct fdescriptor *d, fd_set *r, fd_set *w, fd_set *e, int *n)
142 struct chat *c = descriptor2chat(d);
143 int special, gotabort, gottimeout, needcr;
144 int TimedOut = c->TimedOut;
145 static char arg_term; /* An empty string */
147 if (c->pause.state == TIMER_RUNNING)
151 log_Printf(LogCHAT, "Expect timeout\n");
152 if (c->nargptr == NULL)
153 c->state = CHAT_FAILED;
155 /* c->state = CHAT_EXPECT; */
156 c->argptr = &arg_term;
161 if (c->state != CHAT_EXPECT && c->state != CHAT_SEND)
164 gottimeout = gotabort = 0;
166 if (c->arg < c->argc && (c->arg < 0 || *c->argptr == '\0')) {
167 /* Go get the next string */
168 if (c->arg < 0 || c->state == CHAT_SEND)
169 c->state = CHAT_EXPECT;
171 c->state = CHAT_SEND;
174 while (special && (c->nargptr || c->arg < c->argc - 1)) {
175 if (c->arg < 0 || (!TimedOut && c->state == CHAT_SEND))
178 if (c->nargptr != NULL) {
179 /* We're doing expect-send-expect.... */
180 c->argptr = c->nargptr;
181 /* Put the '-' back in case we ever want to rerun our script */
182 c->nargptr[-1] = '-';
183 c->nargptr = chat_NextChar(c->nargptr, '-');
184 if (c->nargptr != NULL)
185 *c->nargptr++ = '\0';
189 if ((c->argptr = c->argv[++c->arg]) == NULL) {
190 /* End of script - all ok */
191 c->state = CHAT_DONE;
195 if (c->state == CHAT_EXPECT) {
196 /* Look for expect-send-expect sequence */
197 c->nargptr = c->argptr;
199 while ((c->nargptr = chat_NextChar(c->nargptr, '-'))) {
205 log_Printf(LogWARN, "chat_UpdateSet: \"%s\": Uneven number of"
206 " '-' chars, all ignored\n", c->argptr);
208 c->nargptr = chat_NextChar(c->argptr, '-');
209 *c->nargptr++ = '\0';
215 * c->argptr now temporarily points into c->script (via c->argv)
216 * If it's an expect-send-expect sequence, we've just got the correct
217 * portion of that sequence.
220 needcr = c->state == CHAT_SEND &&
221 (*c->argptr != '!' || c->argptr[1] == '!');
223 /* We leave room for a potential HDLC header in the target string */
224 ExpandString(c, c->argptr, c->exp + 2, sizeof c->exp - 2, needcr);
227 * Now read our string. If it's not a special string, we unset
228 * ``special'' to break out of the loop.
231 if (c->abort.num < MAXABORTS) {
234 len = strlen(c->exp+2);
235 for (i = 0; i < c->abort.num; i++)
236 if (len > c->abort.string[i].len) {
239 for (last = c->abort.num; last > i; last--) {
240 c->abort.string[last].data = c->abort.string[last-1].data;
241 c->abort.string[last].len = c->abort.string[last-1].len;
245 c->abort.string[i].len = len;
246 c->abort.string[i].data = (char *)malloc(len+1);
247 memcpy(c->abort.string[i].data, c->exp+2, len+1);
250 log_Printf(LogERROR, "chat_UpdateSet: too many abort strings\n");
252 } else if (gottimeout) {
253 c->TimeoutSec = atoi(c->exp + 2);
254 if (c->TimeoutSec <= 0)
257 } else if (c->nargptr == NULL && !strcmp(c->exp+2, "ABORT"))
259 else if (c->nargptr == NULL && !strcmp(c->exp+2, "TIMEOUT"))
262 if (c->exp[2] == '!' && c->exp[3] != '!')
263 ExecStr(c->physical, c->exp + 3, c->exp + 3, sizeof c->exp - 3);
265 if (c->exp[2] == '\0') {
266 /* Empty string, reparse (this may be better as a `goto start') */
267 c->argptr = &arg_term;
268 return chat_UpdateSet(d, r, w, e, n);
277 log_Printf(LogWARN, "chat_UpdateSet: TIMEOUT: Argument expected\n");
279 log_Printf(LogWARN, "chat_UpdateSet: ABORT: Argument expected\n");
281 /* End of script - all ok */
282 c->state = CHAT_DONE;
286 /* set c->argptr to point in the right place */
287 c->argptr = c->exp + (c->exp[2] == '!' ? 3 : 2);
288 c->arglen = strlen(c->argptr);
290 if (c->state == CHAT_EXPECT) {
291 /* We must check to see if the string's already been found ! */
294 end = c->bufend - c->arglen + 1;
295 if (end < c->bufstart)
297 for (begin = c->bufstart; begin < end; begin++)
298 if (!strncmp(begin, c->argptr, c->arglen)) {
299 c->bufstart = begin + c->arglen;
300 c->argptr += c->arglen;
302 /* Continue - we've already read our expect string */
303 return chat_UpdateSet(d, r, w, e, n);
306 log_Printf(LogCHAT, "Expect(%d): %s\n", c->TimeoutSec, c->argptr);
312 * We now have c->argptr pointing at what we want to expect/send and
313 * c->state saying what we want to do... we now know what to put in
317 if (c->state == CHAT_EXPECT)
318 return physical_doUpdateSet(&c->physical->desc, r, NULL, e, n, 1);
320 return physical_doUpdateSet(&c->physical->desc, NULL, w, e, n, 1);
324 chat_IsSet(struct fdescriptor *d, const fd_set *fdset)
326 struct chat *c = descriptor2chat(d);
327 return c->argptr && physical_IsSet(&c->physical->desc, fdset);
331 chat_UpdateLog(struct chat *c, int in)
333 if (log_IsKept(LogCHAT) || log_IsKept(LogCONNECT)) {
335 * If a linefeed appears in the last `in' characters of `c's input
336 * buffer, output from there, all the way back to the last linefeed.
337 * This is called for every read of `in' bytes.
339 char *ptr, *end, *stop, ch;
342 level = log_IsKept(LogCHAT) ? LogCHAT : LogCONNECT;
344 end = ptr = c->bufend;
346 ptr = c->bufend - in;
347 for (end = c->bufend - 1; end >= ptr; end--)
353 for (ptr = c->bufend - (in == -1 ? 1 : in + 1); ptr >= c->bufstart; ptr--)
359 if ((stop = memchr(ptr, '\n', end - ptr)) == NULL)
363 if (level == LogCHAT || strstr(ptr, "CONNECT"))
364 log_Printf(level, "Received: %s\n", ptr);
373 chat_Read(struct fdescriptor *d, struct bundle *bundle, const fd_set *fdset)
375 struct chat *c = descriptor2chat(d);
377 if (c->state == CHAT_EXPECT) {
379 char *abegin, *ebegin, *begin, *aend, *eend, *end;
383 * XXX - should this read only 1 byte to guarantee that we don't
384 * swallow any ppp talk from the peer ?
387 if (in > sizeof c->buf / 2)
388 in = sizeof c->buf / 2;
390 in = physical_Read(c->physical, c->bufend, in);
394 /* `begin' and `end' delimit where we're going to strncmp() from */
395 ebegin = c->bufend - c->arglen + 1;
397 if (ebegin < c->bufstart)
398 ebegin = c->bufstart;
401 abegin = c->bufend - c->abort.string[0].len + 1;
402 aend = c->bufend - c->abort.string[c->abort.num-1].len + in + 1;
403 if (abegin < c->bufstart)
404 abegin = c->bufstart;
409 begin = abegin < ebegin ? abegin : ebegin;
410 end = aend < eend ? eend : aend;
414 chat_UpdateLog(c, in);
416 if (c->bufend > c->buf + sizeof c->buf / 2) {
417 /* Shuffle our receive buffer back a bit */
420 for (chop = begin - c->buf; chop; chop--)
421 if (c->buf[chop] == '\n')
422 /* found some already-logged garbage to remove :-) */
426 chop = begin - c->buf;
433 while (from < c->bufend)
446 for (; begin < end; begin++)
447 if (begin >= ebegin && begin < eend &&
448 !strncmp(begin, c->argptr, c->arglen)) {
450 timer_Stop(&c->timeout);
451 if (memchr(begin + c->arglen - 1, '\n',
452 c->bufend - begin - c->arglen + 1) == NULL) {
453 /* force it into the log */
455 c->bufend = begin + c->arglen;
456 chat_UpdateLog(c, -1);
459 c->bufstart = begin + c->arglen;
460 c->argptr += c->arglen;
463 } else if (begin >= abegin && begin < aend) {
464 for (n = c->abort.num - 1; n >= 0; n--) {
465 if (begin + c->abort.string[n].len > c->bufend)
467 if (!strncmp(begin, c->abort.string[n].data,
468 c->abort.string[n].len)) {
469 if (memchr(begin + c->abort.string[n].len - 1, '\n',
470 c->bufend - begin - c->abort.string[n].len + 1) == NULL) {
471 /* force it into the log */
473 c->bufend = begin + c->abort.string[n].len;
474 chat_UpdateLog(c, -1);
477 c->bufstart = begin + c->abort.string[n].len;
478 c->state = CHAT_FAILED;
487 chat_Write(struct fdescriptor *d, struct bundle *bundle, const fd_set *fdset)
489 struct chat *c = descriptor2chat(d);
492 if (c->state == CHAT_SEND) {
495 if (strstr(c->argv[c->arg], "\\P")) /* Don't log the password */
496 log_Printf(LogCHAT, "Send: %s\n", c->argv[c->arg]);
501 while (sz >= 0 && c->argptr[sz] == '\n')
503 log_Printf(LogCHAT, "Send: %.*s\n", sz + 1, c->argptr);
506 if (physical_IsSync(c->physical)) {
509 * This data should be stuffed down through the link layers
511 /* There's always room for the HDLC header */
514 memcpy(c->argptr, "\377\003", 2); /* Prepend HDLC header */
517 wrote = physical_Write(c->physical, c->argptr, c->arglen);
518 result = wrote > 0 ? 1 : 0;
520 if (errno != EINTR) {
521 log_Printf(LogWARN, "chat_Write: %s\n", strerror(errno));
524 if (physical_IsSync(c->physical)) {
528 } else if (wrote < 2 && physical_IsSync(c->physical)) {
529 /* Oops - didn't even write our HDLC header ! */
542 chat_Init(struct chat *c, struct physical *p)
544 c->desc.type = CHAT_DESCRIPTOR;
545 c->desc.UpdateSet = chat_UpdateSet;
546 c->desc.IsSet = chat_IsSet;
547 c->desc.Read = chat_Read;
548 c->desc.Write = chat_Write;
555 c->bufstart = c->bufend = c->buf;
557 memset(&c->pause, '\0', sizeof c->pause);
558 memset(&c->timeout, '\0', sizeof c->timeout);
562 chat_Setup(struct chat *c, const char *data, const char *phone)
564 c->state = CHAT_EXPECT;
570 strncpy(c->script, data, sizeof c->script - 1);
571 c->script[sizeof c->script - 1] = '\0';
572 c->argc = MakeArgs(c->script, c->argv, VECSIZE(c->argv), PARSE_NOHASH);
584 timer_Stop(&c->pause);
585 timer_Stop(&c->timeout);
591 chat_Finish(struct chat *c)
593 timer_Stop(&c->pause);
594 timer_Stop(&c->timeout);
596 free(c->abort.string[--c->abort.num].data);
601 chat_Destroy(struct chat *c)
608 * \d Sleep a little (delay 2 seconds
609 * \n Line feed character
610 * \P Auth Key password
612 * \r Carrige return character
614 * \T Telephone number(s) (defined via `set phone')
619 ExpandString(struct chat *c, const char *str, char *result, int reslen, int cr)
623 result[--reslen] = '\0';
624 while (*str && reslen > 0) {
632 case 'd': /* Delay 2 seconds */
633 chat_Pause(c, 2 * SECTICKS);
636 chat_Pause(c, SECTICKS / 4);
637 break; /* Delay 0.25 seconds */
655 strncpy(result, c->physical->dl->bundle->cfg.auth.key, reslen);
656 len = strlen(result);
662 strncpy(result, c->phone, reslen);
663 len = strlen(result);
669 strncpy(result, c->physical->dl->bundle->cfg.auth.name, reslen);
670 len = strlen(result);
685 *result++ = *str++ & 0x1f;
705 ExecStr(struct physical *physical, char *command, char *out, int olen)
709 char *argv[MAXARGS], *vector[MAXARGS], *startout, *endout;
710 int stat, nb, argc, i;
712 log_Printf(LogCHAT, "Exec: %s\n", command);
713 if ((argc = MakeArgs(command, vector, VECSIZE(vector),
714 PARSE_REDUCE|PARSE_NOHASH)) <= 0) {
716 log_Printf(LogWARN, "Syntax error in exec command\n");
721 if (pipe(fids) < 0) {
722 log_Printf(LogCHAT, "Unable to create pipe in ExecStr: %s\n",
727 if ((pid = fork()) == 0) {
728 command_Expand(argv, argc, (char const *const *)vector,
729 physical->dl->bundle, 0, getpid());
732 if (fids[1] == STDIN_FILENO)
733 fids[1] = dup(fids[1]);
734 dup2(physical->fd, STDIN_FILENO);
735 dup2(fids[1], STDERR_FILENO);
736 dup2(STDIN_FILENO, STDOUT_FILENO);
738 if (open(_PATH_TTY, O_RDWR) != 3)
739 open(_PATH_DEVNULL, O_RDWR); /* Leave it closed if it fails... */
740 for (i = getdtablesize(); i > 3; i--)
741 fcntl(i, F_SETFD, 1);
743 setuid(ID0realuid());
745 execvp(argv[0], argv);
746 fprintf(stderr, "execvp: %s: %s\n", argv[0], strerror(errno));
749 char *name = strdup(vector[0]);
752 endout = out + olen - 1;
754 while (out < endout) {
755 nb = read(fids[0], out, 1);
763 waitpid(pid, &stat, WNOHANG);
764 if (WIFSIGNALED(stat)) {
765 log_Printf(LogWARN, "%s: signal %d\n", name, WTERMSIG(stat));
769 } else if (WIFEXITED(stat)) {
770 switch (WEXITSTATUS(stat)) {
775 log_Printf(LogWARN, "%s: %s\n", name, startout);
781 log_Printf(LogWARN, "%s: exit %d\n", name, WEXITSTATUS(stat));
788 log_Printf(LogWARN, "%s: Unexpected exit result\n", name);