granicus.if.org Git - linux-pam/blob - libpam_misc/misc_conv.c

   1 /*
   2  * $Id$
   3  *
   4  * A generic conversation function for text based applications
   5  *
   6  * Written by Andrew Morgan <morgan@linux.kernel.org>
   7  */
   8
   9 #include <security/_pam_aconf.h>
  10
  11 #include <signal.h>
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <string.h>
  15 #include <sys/types.h>
  16 #include <termios.h>
  17 #include <time.h>
  18 #include <unistd.h>
  19
  20 #include <security/pam_appl.h>
  21 #include <security/pam_misc.h>
  22
  23 #define INPUTSIZE PAM_MAX_MSG_SIZE           /* maximum length of input+1 */
  24 #define CONV_ECHO_ON  1                            /* types of echo state */
  25 #define CONV_ECHO_OFF 0
  26
  27 /*
  28  * external timeout definitions - these can be overriden by the
  29  * application.
  30  */
  31
  32 time_t pam_misc_conv_warn_time = 0;                  /* time when we warn */
  33 time_t pam_misc_conv_die_time  = 0;               /* time when we timeout */
  34
  35 const char *pam_misc_conv_warn_line = "..\a.Time is running out...\n";
  36 const char *pam_misc_conv_die_line  = "..\a.Sorry, your time is up!\n";
  37
  38 int pam_misc_conv_died=0;       /* application can probe this for timeout */
  39
  40 /*
  41  * These functions are for binary prompt manipulation.
  42  * The manner in which a binary prompt is processed is application
  43  * specific, so these function pointers are provided and can be
  44  * initialized by the application prior to the conversation function
  45  * being used.
  46  */
  47
  48 static void pam_misc_conv_delete_binary(void *appdata,
  49                                         pamc_bp_t *delete_me)
  50 {
  51     PAM_BP_RENEW(delete_me, 0, 0);
  52 }
  53
  54 int (*pam_binary_handler_fn)(void *appdata, pamc_bp_t *prompt_p) = NULL;
  55 void (*pam_binary_handler_free)(void *appdata, pamc_bp_t *prompt_p)
  56       = pam_misc_conv_delete_binary;
  57
  58 /* the following code is used to get text input */
  59
  60 volatile static int expired=0;
  61
  62 /* return to the previous signal handling */
  63 static void reset_alarm(struct sigaction *o_ptr)
  64 {
  65     (void) alarm(0);                 /* stop alarm clock - if still ticking */
  66     (void) sigaction(SIGALRM, o_ptr, NULL);
  67 }
  68
  69 /* this is where we intercept the alarm signal */
  70 static void time_is_up(int ignore)
  71 {
  72     expired = 1;
  73 }
  74
  75 /* set the new alarm to hit the time_is_up() function */
  76 static int set_alarm(int delay, struct sigaction *o_ptr)
  77 {
  78     struct sigaction new_sig;
  79
  80     sigemptyset(&new_sig.sa_mask);
  81     new_sig.sa_flags = 0;
  82     new_sig.sa_handler = time_is_up;
  83     if ( sigaction(SIGALRM, &new_sig, o_ptr) ) {
  84         return 1;         /* setting signal failed */
  85     }
  86     if ( alarm(delay) ) {
  87         (void) sigaction(SIGALRM, o_ptr, NULL);
  88         return 1;         /* failed to set alarm */
  89     }
  90     return 0;             /* all seems to have worked */
  91 }
  92
  93 /* return the number of seconds to next alarm. 0 = no delay, -1 = expired */
  94 static int get_delay(void)
  95 {
  96     time_t now;
  97
  98     expired = 0;                                        /* reset flag */
  99     (void) time(&now);
 100
 101     /* has the quit time past? */
 102     if (pam_misc_conv_die_time && now >= pam_misc_conv_die_time) {
 103         fprintf(stderr,"%s",pam_misc_conv_die_line);
 104
 105         pam_misc_conv_died = 1;       /* note we do not reset the die_time */
 106         return -1;                                           /* time is up */
 107     }
 108
 109     /* has the warning time past? */
 110     if (pam_misc_conv_warn_time && now >= pam_misc_conv_warn_time) {
 111         fprintf(stderr, "%s", pam_misc_conv_warn_line);
 112         pam_misc_conv_warn_time = 0;                    /* reset warn_time */
 113
 114         /* indicate remaining delay - if any */
 115
 116         return (pam_misc_conv_die_time ? pam_misc_conv_die_time - now:0 );
 117     }
 118
 119     /* indicate possible warning delay */
 120
 121     if (pam_misc_conv_warn_time)
 122         return (pam_misc_conv_warn_time - now);
 123     else if (pam_misc_conv_die_time)
 124         return (pam_misc_conv_die_time - now);
 125     else
 126         return 0;
 127 }
 128
 129 /* read a line of input string, giving prompt when appropriate */
 130 static char *read_string(int echo, const char *prompt)
 131 {
 132     struct termios term_before, term_tmp;
 133     char line[INPUTSIZE];
 134     struct sigaction old_sig;
 135     int delay, nc, have_term=0;
 136
 137     D(("called with echo='%s', prompt='%s'.", echo ? "ON":"OFF" , prompt));
 138
 139     if (isatty(STDIN_FILENO)) {                      /* terminal state */
 140
 141         /* is a terminal so record settings and flush it */
 142         if ( tcgetattr(STDIN_FILENO, &term_before) != 0 ) {
 143             D(("<error: failed to get terminal settings>"));
 144             return NULL;
 145         }
 146         memcpy(&term_tmp, &term_before, sizeof(term_tmp));
 147         if (!echo) {
 148             term_tmp.c_lflag &= ~(ECHO);
 149         }
 150         have_term = 1;
 151
 152     } else if (!echo) {
 153         D(("<warning: cannot turn echo off>"));
 154     }
 155
 156     /* set up the signal handling */
 157     delay = get_delay();
 158
 159     /* reading the line */
 160     while (delay >= 0) {
 161
 162         fprintf(stderr, "%s", prompt);
 163         /* this may, or may not set echo off -- drop pending input */
 164         if (have_term)
 165             (void) tcsetattr(STDIN_FILENO, TCSAFLUSH, &term_tmp);
 166
 167         if ( delay > 0 && set_alarm(delay, &old_sig) ) {
 168             D(("<failed to set alarm>"));
 169             break;
 170         } else {
 171             nc = read(STDIN_FILENO, line, INPUTSIZE-1);
 172             if (have_term) {
 173                 (void) tcsetattr(STDIN_FILENO, TCSADRAIN, &term_before);
 174                 if (!echo || expired)             /* do we need a newline? */
 175                     fprintf(stderr,"\n");
 176             }
 177             if ( delay > 0 ) {
 178                 reset_alarm(&old_sig);
 179             }
 180             if (expired) {
 181                 delay = get_delay();
 182             } else if (nc > 0) {                 /* we got some user input */
 183                 char *input;
 184
 185                 if (nc > 0 && line[nc-1] == '\n') {     /* <NUL> terminate */
 186                     line[--nc] = '\0';
 187                 } else {
 188                     line[nc] = '\0';
 189                 }
 190                 input = x_strdup(line);
 191                 _pam_overwrite(line);
 192
 193                 return input;                  /* return malloc()ed string */
 194             } else if (nc == 0) {                                /* Ctrl-D */
 195                 D(("user did not want to type anything"));
 196                 fprintf(stderr, "\n");
 197                 break;
 198             }
 199         }
 200     }
 201
 202     /* getting here implies that the timer expired */
 203     if (have_term)
 204         (void) tcsetattr(STDIN_FILENO, TCSADRAIN, &term_before);
 205
 206     memset(line, 0, INPUTSIZE);                      /* clean up */
 207     return NULL;
 208 }
 209
 210 /* end of read_string functions */
 211
 212 int misc_conv(int num_msg, const struct pam_message **msgm,
 213               struct pam_response **response, void *appdata_ptr)
 214 {
 215     int count=0;
 216     struct pam_response *reply;
 217
 218     if (num_msg <= 0)
 219         return PAM_CONV_ERR;
 220
 221     D(("allocating empty response structure array."));
 222
 223     reply = (struct pam_response *) calloc(num_msg,
 224                                            sizeof(struct pam_response));
 225     if (reply == NULL) {
 226         D(("no memory for responses"));
 227         return PAM_CONV_ERR;
 228     }
 229
 230     D(("entering conversation function."));
 231
 232     for (count=0; count < num_msg; ++count) {
 233         char *string=NULL;
 234
 235         switch (msgm[count]->msg_style) {
 236         case PAM_PROMPT_ECHO_OFF:
 237             string = read_string(CONV_ECHO_OFF,msgm[count]->msg);
 238             if (string == NULL) {
 239                 goto failed_conversation;
 240             }
 241             break;
 242         case PAM_PROMPT_ECHO_ON:
 243             string = read_string(CONV_ECHO_ON,msgm[count]->msg);
 244             if (string == NULL) {
 245                 goto failed_conversation;
 246             }
 247             break;
 248         case PAM_ERROR_MSG:
 249             if (fprintf(stderr,"%s\n",msgm[count]->msg) < 0) {
 250                 goto failed_conversation;
 251             }
 252             break;
 253         case PAM_TEXT_INFO:
 254             if (fprintf(stdout,"%s\n",msgm[count]->msg) < 0) {
 255                 goto failed_conversation;
 256             }
 257             break;
 258         case PAM_BINARY_PROMPT:
 259         {
 260             pamc_bp_t binary_prompt = NULL;
 261
 262             if (!msgm[count]->msg || !pam_binary_handler_fn) {
 263                 goto failed_conversation;
 264             }
 265
 266             PAM_BP_RENEW(&binary_prompt,
 267                          PAM_BP_RCONTROL(msgm[count]->msg),
 268                          PAM_BP_LENGTH(msgm[count]->msg));
 269             PAM_BP_FILL(binary_prompt, 0, PAM_BP_LENGTH(msgm[count]->msg),
 270                         PAM_BP_RDATA(msgm[count]->msg));
 271
 272             if (pam_binary_handler_fn(appdata_ptr,
 273                                       &binary_prompt) != PAM_SUCCESS
 274                 || (binary_prompt == NULL)) {
 275                 goto failed_conversation;
 276             }
 277             string = (char *) binary_prompt;
 278             binary_prompt = NULL;
 279
 280             break;
 281         }
 282         default:
 283             fprintf(stderr, "erroneous conversation (%d)\n"
 284                     ,msgm[count]->msg_style);
 285             goto failed_conversation;
 286         }
 287
 288         if (string) {                         /* must add to reply array */
 289             /* add string to list of responses */
 290
 291             reply[count].resp_retcode = 0;
 292             reply[count].resp = string;
 293             string = NULL;
 294         }
 295     }
 296
 297     /* New (0.59+) behavior is to always have a reply - this is
 298        compatable with the X/Open (March 1997) spec. */
 299     *response = reply;
 300     reply = NULL;
 301
 302     return PAM_SUCCESS;
 303
 304 failed_conversation:
 305
 306     if (reply) {
 307         for (count=0; count<num_msg; ++count) {
 308             if (reply[count].resp == NULL) {
 309                 continue;
 310             }
 311             switch (msgm[count]->msg_style) {
 312             case PAM_PROMPT_ECHO_ON:
 313             case PAM_PROMPT_ECHO_OFF:
 314                 _pam_overwrite(reply[count].resp);
 315                 free(reply[count].resp);
 316                 break;
 317             case PAM_BINARY_PROMPT:
 318                 pam_binary_handler_free(appdata_ptr,
 319                                         (pamc_bp_t *) &reply[count].resp);
 320                 break;
 321             case PAM_ERROR_MSG:
 322             case PAM_TEXT_INFO:
 323                 /* should not actually be able to get here... */
 324                 free(reply[count].resp);
 325             }
 326             reply[count].resp = NULL;
 327         }
 328         /* forget reply too */
 329         free(reply);
 330         reply = NULL;
 331     }
 332
 333     return PAM_CONV_ERR;
 334 }
 335