1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2007 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.\" $P4$ 36.\" 37.Dd December 21, 2007 38.Dt OPENPAM_READLINE 3 39.Os 40.Sh NAME 41.Nm openpam_readline 42.Nd read a line from a file 43.Sh LIBRARY 44.Lb libpam 45.Sh SYNOPSIS 46.In sys/types.h 47.In security/pam_appl.h 48.In security/openpam.h 49.Ft "char *" 50.Fn openpam_readline "FILE *f" "int *lineno" "size_t *lenp" 51.Sh DESCRIPTION 52The 53.Nm 54function reads a line from a file, and returns it 55in a NUL-terminated buffer allocated with 56.Xr malloc 3 . 57.Pp 58The 59.Nm 60function performs a certain amount of processing 61on the data it reads. 62Comments (introduced by a hash sign) are stripped, as is leading and 63trailing whitespace. 64Any amount of linear whitespace is collapsed to a single space. 65Blank lines are ignored. 66If a line ends in a backslash, the backslash is stripped and the next 67line is appended. 68.Pp 69If 70.Fa lineno 71is not 72.Dv NULL , 73the integer variable it points to is 74incremented every time a newline character is read. 75.Pp 76If 77.Fa lenp 78is not 79.Dv NULL , 80the length of the line (not including the 81terminating NUL character) is stored in the variable it points to. 82.Pp 83The caller is responsible for releasing the returned buffer by passing 84it to 85.Xr free 3 . 86.Sh RETURN VALUES 87The 88.Nm 89function returns 90.Dv NULL 91on failure. 92.Sh SEE ALSO 93.Xr free 3 , 94.Xr malloc 3 , 95.Xr pam 3 96.Sh STANDARDS 97The 98.Nm 99function is an OpenPAM extension. 100.Sh AUTHORS 101The 102.Nm 103function and this manual page were developed for the 104.Fx 105Project by ThinkSec AS and Network Associates Laboratories, the 106Security Research Division of Network Associates, Inc.\& under 107DARPA/SPAWAR contract N66001-01-C-8035 108.Pq Dq CBOSS , 109as part of the DARPA CHATS research program. 110