1 /* crypto/ui/ui_openssl.c -*- mode:C; c-file-style: "eay" -*- */ 2 /* Written by Richard Levitte (richard@levitte.org) and others 3 * for the OpenSSL project 2001. 4 */ 5 /* ==================================================================== 6 * Copyright (c) 2001 The OpenSSL Project. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 20 * 3. All advertising materials mentioning features or use of this 21 * software must display the following acknowledgment: 22 * "This product includes software developed by the OpenSSL Project 23 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 24 * 25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 26 * endorse or promote products derived from this software without 27 * prior written permission. For written permission, please contact 28 * openssl-core@openssl.org. 29 * 30 * 5. Products derived from this software may not be called "OpenSSL" 31 * nor may "OpenSSL" appear in their names without prior written 32 * permission of the OpenSSL Project. 33 * 34 * 6. Redistributions of any form whatsoever must retain the following 35 * acknowledgment: 36 * "This product includes software developed by the OpenSSL Project 37 * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 38 * 39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50 * OF THE POSSIBILITY OF SUCH DAMAGE. 51 * ==================================================================== 52 * 53 * This product includes cryptographic software written by Eric Young 54 * (eay@cryptsoft.com). This product includes software written by Tim 55 * Hudson (tjh@cryptsoft.com). 56 * 57 */ 58 59 /* The lowest level part of this file was previously in crypto/des/read_pwd.c, 60 * Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 61 * All rights reserved. 62 * 63 * This package is an SSL implementation written 64 * by Eric Young (eay@cryptsoft.com). 65 * The implementation was written so as to conform with Netscapes SSL. 66 * 67 * This library is free for commercial and non-commercial use as long as 68 * the following conditions are aheared to. The following conditions 69 * apply to all code found in this distribution, be it the RC4, RSA, 70 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 71 * included with this distribution is covered by the same copyright terms 72 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 73 * 74 * Copyright remains Eric Young's, and as such any Copyright notices in 75 * the code are not to be removed. 76 * If this package is used in a product, Eric Young should be given attribution 77 * as the author of the parts of the library used. 78 * This can be in the form of a textual message at program startup or 79 * in documentation (online or textual) provided with the package. 80 * 81 * Redistribution and use in source and binary forms, with or without 82 * modification, are permitted provided that the following conditions 83 * are met: 84 * 1. Redistributions of source code must retain the copyright 85 * notice, this list of conditions and the following disclaimer. 86 * 2. Redistributions in binary form must reproduce the above copyright 87 * notice, this list of conditions and the following disclaimer in the 88 * documentation and/or other materials provided with the distribution. 89 * 3. All advertising materials mentioning features or use of this software 90 * must display the following acknowledgement: 91 * "This product includes cryptographic software written by 92 * Eric Young (eay@cryptsoft.com)" 93 * The word 'cryptographic' can be left out if the rouines from the library 94 * being used are not cryptographic related :-). 95 * 4. If you include any Windows specific code (or a derivative thereof) from 96 * the apps directory (application code) you must include an acknowledgement: 97 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 98 * 99 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 100 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 101 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 102 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 103 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 104 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 105 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 106 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 107 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 108 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 109 * SUCH DAMAGE. 110 * 111 * The licence and distribution terms for any publically available version or 112 * derivative of this code cannot be changed. i.e. this code cannot simply be 113 * copied and put under another distribution licence 114 * [including the GNU Public Licence.] 115 */ 116 117 118 #include <openssl/e_os2.h> 119 120 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) 121 # ifdef OPENSSL_UNISTD 122 # include OPENSSL_UNISTD 123 # else 124 # include <unistd.h> 125 # endif 126 /* If unistd.h defines _POSIX_VERSION, we conclude that we 127 * are on a POSIX system and have sigaction and termios. */ 128 # if defined(_POSIX_VERSION) 129 130 # define SIGACTION 131 # if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY) 132 # define TERMIOS 133 # endif 134 135 # endif 136 #endif 137 138 #ifdef WIN16TTY 139 # undef OPENSSL_SYS_WIN16 140 # undef WIN16 141 # undef _WINDOWS 142 # include <graph.h> 143 #endif 144 145 /* 06-Apr-92 Luke Brennan Support for VMS */ 146 #include "ui_locl.h" 147 #include "cryptlib.h" 148 #include <signal.h> 149 #include <stdio.h> 150 #include <string.h> 151 #include <errno.h> 152 153 #ifdef OPENSSL_SYS_VMS /* prototypes for sys$whatever */ 154 # include <starlet.h> 155 # ifdef __DECC 156 # pragma message disable DOLLARID 157 # endif 158 #endif 159 160 #ifdef WIN_CONSOLE_BUG 161 # include <windows.h> 162 # include <wincon.h> 163 #endif 164 165 166 /* There are 5 types of terminal interface supported, 167 * TERMIO, TERMIOS, VMS, MSDOS and SGTTY 168 */ 169 170 #if defined(__sgi) && !defined(TERMIOS) 171 # define TERMIOS 172 # undef TERMIO 173 # undef SGTTY 174 #endif 175 176 #if defined(linux) && !defined(TERMIO) 177 # undef TERMIOS 178 # define TERMIO 179 # undef SGTTY 180 #endif 181 182 #ifdef _LIBC 183 # undef TERMIOS 184 # define TERMIO 185 # undef SGTTY 186 #endif 187 188 #if !defined(TERMIO) && !defined(TERMIOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(MAC_OS_GUSI_SOURCE) 189 # undef TERMIOS 190 # undef TERMIO 191 # define SGTTY 192 #endif 193 194 #if defined(OPENSSL_SYS_VSWORKS) 195 #undef TERMIOS 196 #undef TERMIO 197 #undef SGTTY 198 #endif 199 200 #ifdef TERMIOS 201 # include <termios.h> 202 # define TTY_STRUCT struct termios 203 # define TTY_FLAGS c_lflag 204 # define TTY_get(tty,data) tcgetattr(tty,data) 205 # define TTY_set(tty,data) tcsetattr(tty,TCSANOW,data) 206 #endif 207 208 #ifdef TERMIO 209 # include <termio.h> 210 # define TTY_STRUCT struct termio 211 # define TTY_FLAGS c_lflag 212 # define TTY_get(tty,data) ioctl(tty,TCGETA,data) 213 # define TTY_set(tty,data) ioctl(tty,TCSETA,data) 214 #endif 215 216 #ifdef SGTTY 217 # include <sgtty.h> 218 # define TTY_STRUCT struct sgttyb 219 # define TTY_FLAGS sg_flags 220 # define TTY_get(tty,data) ioctl(tty,TIOCGETP,data) 221 # define TTY_set(tty,data) ioctl(tty,TIOCSETP,data) 222 #endif 223 224 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) 225 # include <sys/ioctl.h> 226 #endif 227 228 #ifdef OPENSSL_SYS_MSDOS 229 # include <conio.h> 230 #endif 231 232 #ifdef OPENSSL_SYS_VMS 233 # include <ssdef.h> 234 # include <iodef.h> 235 # include <ttdef.h> 236 # include <descrip.h> 237 struct IOSB { 238 short iosb$w_value; 239 short iosb$w_count; 240 long iosb$l_info; 241 }; 242 #endif 243 244 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(MAC_OS_GUSI_SOURCE) 245 /* 246 * This one needs work. As a matter of fact the code is unoperational 247 * and this is only a trick to get it compiled. 248 * <appro@fy.chalmers.se> 249 */ 250 # define TTY_STRUCT int 251 #endif 252 253 #ifndef NX509_SIG 254 # define NX509_SIG 32 255 #endif 256 257 258 /* Define globals. They are protected by a lock */ 259 #ifdef SIGACTION 260 static struct sigaction savsig[NX509_SIG]; 261 #else 262 static void (*savsig[NX509_SIG])(int ); 263 #endif 264 265 #ifdef OPENSSL_SYS_VMS 266 static struct IOSB iosb; 267 static $DESCRIPTOR(terminal,"TT"); 268 static long tty_orig[3], tty_new[3]; /* XXX Is there any guarantee that this will always suffice for the actual structures? */ 269 static long status; 270 static unsigned short channel = 0; 271 #else 272 #ifndef OPENSSL_SYS_MSDOS 273 static TTY_STRUCT tty_orig,tty_new; 274 #endif 275 #endif 276 static FILE *tty_in, *tty_out; 277 static int is_a_tty; 278 279 /* Declare static functions */ 280 static void read_till_nl(FILE *); 281 static void recsig(int); 282 static void pushsig(void); 283 static void popsig(void); 284 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16) 285 static int noecho_fgets(char *buf, int size, FILE *tty); 286 #endif 287 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl); 288 289 static int read_string(UI *ui, UI_STRING *uis); 290 static int write_string(UI *ui, UI_STRING *uis); 291 292 static int open_console(UI *ui); 293 static int echo_console(UI *ui); 294 static int noecho_console(UI *ui); 295 static int close_console(UI *ui); 296 297 static UI_METHOD ui_openssl = 298 { 299 "OpenSSL default user interface", 300 open_console, 301 write_string, 302 NULL, /* No flusher is needed for command lines */ 303 read_string, 304 close_console, 305 NULL 306 }; 307 308 /* The method with all the built-in thingies */ 309 UI_METHOD *UI_OpenSSL(void) 310 { 311 return &ui_openssl; 312 } 313 314 /* The following function makes sure that info and error strings are printed 315 before any prompt. */ 316 static int write_string(UI *ui, UI_STRING *uis) 317 { 318 switch (UI_get_string_type(uis)) 319 { 320 case UIT_ERROR: 321 case UIT_INFO: 322 fputs(UI_get0_output_string(uis), tty_out); 323 fflush(tty_out); 324 break; 325 default: 326 break; 327 } 328 return 1; 329 } 330 331 static int read_string(UI *ui, UI_STRING *uis) 332 { 333 int ok = 0; 334 335 switch (UI_get_string_type(uis)) 336 { 337 case UIT_BOOLEAN: 338 fputs(UI_get0_output_string(uis), tty_out); 339 fputs(UI_get0_action_string(uis), tty_out); 340 fflush(tty_out); 341 return read_string_inner(ui, uis, 342 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO, 0); 343 case UIT_PROMPT: 344 fputs(UI_get0_output_string(uis), tty_out); 345 fflush(tty_out); 346 return read_string_inner(ui, uis, 347 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO, 1); 348 case UIT_VERIFY: 349 fprintf(tty_out,"Verifying - %s", 350 UI_get0_output_string(uis)); 351 fflush(tty_out); 352 if ((ok = read_string_inner(ui, uis, 353 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO, 1)) <= 0) 354 return ok; 355 if (strcmp(UI_get0_result_string(uis), 356 UI_get0_test_string(uis)) != 0) 357 { 358 fprintf(tty_out,"Verify failure\n"); 359 fflush(tty_out); 360 return 0; 361 } 362 break; 363 default: 364 break; 365 } 366 return 1; 367 } 368 369 370 /* Internal functions to read a string without echoing */ 371 static void read_till_nl(FILE *in) 372 { 373 #define SIZE 4 374 char buf[SIZE+1]; 375 376 do { 377 fgets(buf,SIZE,in); 378 } while (strchr(buf,'\n') == NULL); 379 } 380 381 static sig_atomic_t intr_signal; 382 383 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl) 384 { 385 static int ps; 386 int ok; 387 char result[BUFSIZ]; 388 int maxsize = BUFSIZ-1; 389 char *p; 390 391 #ifndef OPENSSL_SYS_WIN16 392 intr_signal=0; 393 ok=0; 394 ps=0; 395 396 pushsig(); 397 ps=1; 398 399 if (!echo && !noecho_console(ui)) 400 goto error; 401 ps=2; 402 403 result[0]='\0'; 404 #ifdef OPENSSL_SYS_MSDOS 405 if (!echo) 406 { 407 noecho_fgets(result,maxsize,tty_in); 408 p=result; /* FIXME: noecho_fgets doesn't return errors */ 409 } 410 else 411 p=fgets(result,maxsize,tty_in); 412 #else 413 p=fgets(result,maxsize,tty_in); 414 #endif 415 if(!p) 416 goto error; 417 if (feof(tty_in)) goto error; 418 if (ferror(tty_in)) goto error; 419 if ((p=(char *)strchr(result,'\n')) != NULL) 420 { 421 if (strip_nl) 422 *p='\0'; 423 } 424 else 425 read_till_nl(tty_in); 426 if (UI_set_result(ui, uis, result) >= 0) 427 ok=1; 428 429 error: 430 if (intr_signal == SIGINT) 431 ok=-1; 432 if (!echo) fprintf(tty_out,"\n"); 433 if (ps >= 2 && !echo && !echo_console(ui)) 434 ok=0; 435 436 if (ps >= 1) 437 popsig(); 438 #else 439 ok=1; 440 #endif 441 442 memset(result,0,BUFSIZ); 443 return ok; 444 } 445 446 447 /* Internal functions to open, handle and close a channel to the console. */ 448 static int open_console(UI *ui) 449 { 450 CRYPTO_w_lock(CRYPTO_LOCK_UI); 451 is_a_tty = 1; 452 453 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(OPENSSL_SYS_VSWORKS) 454 tty_in=stdin; 455 tty_out=stderr; 456 #else 457 # ifdef OPENSSL_SYS_MSDOS 458 # define DEV_TTY "con" 459 # else 460 # define DEV_TTY "/dev/tty" 461 # endif 462 if ((tty_in=fopen(DEV_TTY,"r")) == NULL) 463 tty_in=stdin; 464 if ((tty_out=fopen(DEV_TTY,"w")) == NULL) 465 tty_out=stderr; 466 #endif 467 468 #if defined(TTY_get) && !defined(VMS) 469 if (TTY_get(fileno(tty_in),&tty_orig) == -1) 470 { 471 #ifdef ENOTTY 472 if (errno == ENOTTY) 473 is_a_tty=0; 474 else 475 #endif 476 #ifdef EINVAL 477 /* Ariel Glenn ariel@columbia.edu reports that solaris 478 * can return EINVAL instead. This should be ok */ 479 if (errno == EINVAL) 480 is_a_tty=0; 481 else 482 #endif 483 return 0; 484 } 485 #endif 486 #ifdef OPENSSL_SYS_VMS 487 status = sys$assign(&terminal,&channel,0,0); 488 if (status != SS$_NORMAL) 489 return 0; 490 status=sys$qiow(0,channel,IO$_SENSEMODE,&iosb,0,0,tty_orig,12,0,0,0,0); 491 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL)) 492 return 0; 493 #endif 494 return 1; 495 } 496 497 static int noecho_console(UI *ui) 498 { 499 #ifdef TTY_FLAGS 500 memcpy(&(tty_new),&(tty_orig),sizeof(tty_orig)); 501 tty_new.TTY_FLAGS &= ~ECHO; 502 #endif 503 504 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS) 505 if (is_a_tty && (TTY_set(fileno(tty_in),&tty_new) == -1)) 506 return 0; 507 #endif 508 #ifdef OPENSSL_SYS_VMS 509 tty_new[0] = tty_orig[0]; 510 tty_new[1] = tty_orig[1] | TT$M_NOECHO; 511 tty_new[2] = tty_orig[2]; 512 status = sys$qiow(0,channel,IO$_SETMODE,&iosb,0,0,tty_new,12,0,0,0,0); 513 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL)) 514 return 0; 515 #endif 516 return 1; 517 } 518 519 static int echo_console(UI *ui) 520 { 521 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS) 522 memcpy(&(tty_new),&(tty_orig),sizeof(tty_orig)); 523 tty_new.TTY_FLAGS |= ECHO; 524 #endif 525 526 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS) 527 if (is_a_tty && (TTY_set(fileno(tty_in),&tty_new) == -1)) 528 return 0; 529 #endif 530 #ifdef OPENSSL_SYS_VMS 531 tty_new[0] = tty_orig[0]; 532 tty_new[1] = tty_orig[1] & ~TT$M_NOECHO; 533 tty_new[2] = tty_orig[2]; 534 status = sys$qiow(0,channel,IO$_SETMODE,&iosb,0,0,tty_new,12,0,0,0,0); 535 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL)) 536 return 0; 537 #endif 538 return 1; 539 } 540 541 static int close_console(UI *ui) 542 { 543 if (tty_in != stderr) fclose(tty_in); 544 if (tty_out != stderr) fclose(tty_out); 545 #ifdef OPENSSL_SYS_VMS 546 status = sys$dassgn(channel); 547 #endif 548 CRYPTO_w_unlock(CRYPTO_LOCK_UI); 549 550 return 1; 551 } 552 553 554 /* Internal functions to handle signals and act on them */ 555 static void pushsig(void) 556 { 557 int i; 558 #ifdef SIGACTION 559 struct sigaction sa; 560 561 memset(&sa,0,sizeof sa); 562 sa.sa_handler=recsig; 563 #endif 564 565 for (i=1; i<NX509_SIG; i++) 566 { 567 #ifdef SIGUSR1 568 if (i == SIGUSR1) 569 continue; 570 #endif 571 #ifdef SIGUSR2 572 if (i == SIGUSR2) 573 continue; 574 #endif 575 #ifdef SIGKILL 576 if (i == SIGKILL) /* We can't make any action on that. */ 577 continue; 578 #endif 579 #ifdef SIGACTION 580 sigaction(i,&sa,&savsig[i]); 581 #else 582 savsig[i]=signal(i,recsig); 583 #endif 584 } 585 586 #ifdef SIGWINCH 587 signal(SIGWINCH,SIG_DFL); 588 #endif 589 } 590 591 static void popsig(void) 592 { 593 int i; 594 595 for (i=1; i<NX509_SIG; i++) 596 { 597 #ifdef SIGUSR1 598 if (i == SIGUSR1) 599 continue; 600 #endif 601 #ifdef SIGUSR2 602 if (i == SIGUSR2) 603 continue; 604 #endif 605 #ifdef SIGACTION 606 sigaction(i,&savsig[i],NULL); 607 #else 608 signal(i,savsig[i]); 609 #endif 610 } 611 } 612 613 static void recsig(int i) 614 { 615 intr_signal=i; 616 } 617 618 /* Internal functions specific for Windows */ 619 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16) 620 static int noecho_fgets(char *buf, int size, FILE *tty) 621 { 622 int i; 623 char *p; 624 625 p=buf; 626 for (;;) 627 { 628 if (size == 0) 629 { 630 *p='\0'; 631 break; 632 } 633 size--; 634 #ifdef WIN16TTY 635 i=_inchar(); 636 #else 637 i=getch(); 638 #endif 639 if (i == '\r') i='\n'; 640 *(p++)=i; 641 if (i == '\n') 642 { 643 *p='\0'; 644 break; 645 } 646 } 647 #ifdef WIN_CONSOLE_BUG 648 /* Win95 has several evil console bugs: one of these is that the 649 * last character read using getch() is passed to the next read: this is 650 * usually a CR so this can be trouble. No STDIO fix seems to work but 651 * flushing the console appears to do the trick. 652 */ 653 { 654 HANDLE inh; 655 inh = GetStdHandle(STD_INPUT_HANDLE); 656 FlushConsoleInputBuffer(inh); 657 } 658 #endif 659 return(strlen(buf)); 660 } 661 #endif 662