1.\"-
2.\" Copyright (c) 2001-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$
36.\"
37.Dd December 18, 2011
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:
62.Bl -bullet
63.It
64Comments (introduced by a hash sign) are stripped, as is leading and
65trailing whitespace.
66.It
67Any amount of linear whitespace is collapsed to a single space.
68.It
69Blank lines are ignored.
70.It
71If a line ends in a backslash, the backslash is stripped and the
72next line is appended.
73.El
74.Pp
75If
76.Fa lineno
77is not
78.Dv NULL ,
79the integer variable it points to is
80incremented every time a newline character is read.
81.Pp
82If
83.Fa lenp
84is not
85.Dv NULL ,
86the length of the line (not including the
87terminating NUL character) is stored in the variable it points to.
88.Pp
89The caller is responsible for releasing the returned buffer by passing
90it to
91.Xr free 3 .
92.Sh RETURN VALUES
93The
94.Nm
95function returns
96.Dv NULL
97on failure.
98.Sh SEE ALSO
99.Xr free 3 ,
100.Xr malloc 3 ,
101.Xr pam 3
102.Sh STANDARDS
103The
104.Nm
105function is an OpenPAM extension.
106.Sh AUTHORS
107The
108.Nm
109function and this manual page were developed for the
110.Fx
111Project by
112ThinkSec AS and Network Associates Laboratories, the
113Security Research Division of Network Associates, Inc.\& under
114DARPA/SPAWAR contract N66001-01-C-8035
115.Pq Dq CBOSS ,
116as part of the DARPA CHATS research program.
117