contrib/openpam/lib/openpam_readline.c

   1 /*-
   2  * Copyright (c) 2003 Networks Associates Technology, Inc.
   3  * Copyright (c) 2004-2011 Dag-Erling Smørgrav
   4  * All rights reserved.
   5  *
   6  * This software was developed for the FreeBSD Project by ThinkSec AS and
   7  * Network Associates Laboratories, the Security Research Division of
   8  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
   9  * ("CBOSS"), as part of the DARPA CHATS research program.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. The name of the author may not be used to endorse or promote
  20  *    products derived from this software without specific prior written
  21  *    permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  * $Id: openpam_readline.c 596 2012-04-14 14:52:40Z des $
  36  */
  37
  38 #ifdef HAVE_CONFIG_H
  39 # include "config.h"
  40 #endif
  41
  42 #include <ctype.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45
  46 #include <security/pam_appl.h>
  47
  48 #include "openpam_impl.h"
  49
  50 #define MIN_LINE_LENGTH 128
  51
  52 /*
  53  * OpenPAM extension
  54  *
  55  * Read a line from a file.
  56  */
  57
  58 char *
  59 openpam_readline(FILE *f, int *lineno, size_t *lenp)
  60 {
  61         char *line;
  62         size_t len, size;
  63         int ch;
  64
  65         line = NULL;
  66         if (openpam_straddch(&line, &size, &len, 0) != 0)
  67                 return (NULL);
  68         for (;;) {
  69                 ch = fgetc(f);
  70                 /* strip comment */
  71                 if (ch == '#') {
  72                         do {
  73                                 ch = fgetc(f);
  74                         } while (ch != EOF && ch != '\n');
  75                 }
  76                 /* eof */
  77                 if (ch == EOF) {
  78                         /* done */
  79                         break;
  80                 }
  81                 /* eol */
  82                 if (ch == '\n') {
  83                         if (lineno != NULL)
  84                                 ++*lineno;
  85                         /* skip blank lines */
  86                         if (len == 0)
  87                                 continue;
  88                         /* continuation */
  89                         if (line[len - 1] == '\\') {
  90                                 line[--len] = '\0';
  91                                 continue;
  92                         }
  93                         /* done */
  94                         break;
  95                 }
  96                 /* anything else */
  97                 if (openpam_straddch(&line, &size, &len, ch) != 0)
  98                         goto fail;
  99         }
 100         if (len == 0)
 101                 goto fail;
 102         if (lenp != NULL)
 103                 *lenp = len;
 104         openpam_log(PAM_LOG_LIBDEBUG, "returning '%s'", line);
 105         return (line);
 106 fail:
 107         FREE(line);
 108         return (NULL);
 109 }
 110
 111 /**
 112  * DEPRECATED openpam_readlinev
 113  *
 114  * The =openpam_readline function reads a line from a file, and returns it
 115  * in a NUL-terminated buffer allocated with =!malloc.
 116  *
 117  * The =openpam_readline function performs a certain amount of processing
 118  * on the data it reads:
 119  *
 120  *  - Comments (introduced by a hash sign) are stripped.
 121  *
 122  *  - Blank lines are ignored.
 123  *
 124  *  - If a line ends in a backslash, the backslash is stripped and the
 125  *    next line is appended.
 126  *
 127  * If =lineno is not =NULL, the integer variable it points to is
 128  * incremented every time a newline character is read.
 129  *
 130  * If =lenp is not =NULL, the length of the line (not including the
 131  * terminating NUL character) is stored in the variable it points to.
 132  *
 133  * The caller is responsible for releasing the returned buffer by passing
 134  * it to =!free.
 135  *
 136  * >openpam_readlinev
 137  * >openpam_readword
 138  */