1.\" $NetBSD: openpam_readline.3,v 1.2 2011/12/25 22:27:55 christos Exp $ 2.\" 3.\"- 4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 5.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav 6.\" All rights reserved. 7.\" 8.\" This software was developed for the FreeBSD Project by ThinkSec AS and 9.\" Network Associates Laboratories, the Security Research Division of 10.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 11.\" ("CBOSS"), as part of the DARPA CHATS research program. 12.\" 13.\" Redistribution and use in source and binary forms, with or without 14.\" modification, are permitted provided that the following conditions 15.\" are met: 16.\" 1. Redistributions of source code must retain the above copyright 17.\" notice, this list of conditions and the following disclaimer. 18.\" 2. Redistributions in binary form must reproduce the above copyright 19.\" notice, this list of conditions and the following disclaimer in the 20.\" documentation and/or other materials provided with the distribution. 21.\" 3. The name of the author may not be used to endorse or promote 22.\" products derived from this software without specific prior written 23.\" permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35.\" SUCH DAMAGE. 36.\" 37.\" Id 38.\" 39.Dd December 18, 2011 40.Dt OPENPAM_READLINE 3 41.Os 42.Sh NAME 43.Nm openpam_readline 44.Nd read a line from a file 45.Sh LIBRARY 46.Lb libpam 47.Sh SYNOPSIS 48.In sys/types.h 49.In security/pam_appl.h 50.In security/openpam.h 51.Ft "char *" 52.Fn openpam_readline "FILE *f" "int *lineno" "size_t *lenp" 53.Sh DESCRIPTION 54The 55.Nm 56function reads a line from a file, and returns it 57in a NUL-terminated buffer allocated with 58.Xr malloc 3 . 59.Pp 60The 61.Nm 62function performs a certain amount of processing 63on the data it reads: 64.Bl -bullet 65.It 66Comments (introduced by a hash sign) are stripped, as is leading and 67trailing whitespace. 68.It 69Any amount of linear whitespace is collapsed to a single space. 70.It 71Blank lines are ignored. 72.It 73If a line ends in a backslash, the backslash is stripped and the 74next line is appended. 75.El 76.Pp 77If 78.Fa lineno 79is not 80.Dv NULL , 81the integer variable it points to is 82incremented every time a newline character is read. 83.Pp 84If 85.Fa lenp 86is not 87.Dv NULL , 88the length of the line (not including the 89terminating NUL character) is stored in the variable it points to. 90.Pp 91The caller is responsible for releasing the returned buffer by passing 92it to 93.Xr free 3 . 94.Sh RETURN VALUES 95The 96.Nm 97function returns 98.Dv NULL 99on failure. 100.Sh SEE ALSO 101.Xr free 3 , 102.Xr malloc 3 , 103.Xr pam 3 104.Sh STANDARDS 105The 106.Nm 107function is an OpenPAM extension. 108.Sh AUTHORS 109The 110.Nm 111function and this manual page were developed for the 112.Fx 113Project by 114ThinkSec AS and Network Associates Laboratories, the 115Security Research Division of Network Associates, Inc.\& under 116DARPA/SPAWAR contract N66001-01-C-8035 117.Pq Dq CBOSS , 118as part of the DARPA CHATS research program. 119