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