xref: /freebsd/contrib/openpam/doc/man/openpam_readword.3 (revision 2f3ed61901142025bf8b99c3bda7b38dd74b09a8)

.\"-
.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
.\" All rights reserved.
.\"
.\" This software was developed for the FreeBSD Project by ThinkSec AS and
.\" Network Associates Laboratories, the Security Research Division of
.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
.\" ("CBOSS"), as part of the DARPA CHATS research program.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote
.\"    products derived from this software without specific prior written
.\"    permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id$
.\"
.Dd May 26, 2012
.Dt OPENPAM_READWORD 3
.Os
.Sh NAME
.Nm openpam_readword
.Nd read a word from a file, respecting shell quoting rules
.Sh LIBRARY
.Lb libpam
.Sh SYNOPSIS
.In sys/types.h
.In stdio.h
.In security/pam_appl.h
.In security/openpam.h
.Ft "char *"
.Fn openpam_readword "FILE *f" "int *lineno" "size_t *lenp"
.Sh DESCRIPTION
The
.Fn openpam_readword
function reads the next word from a file, and
returns it in a NUL-terminated buffer allocated with
.Xr malloc 3 .
.Pp
A word is a sequence of non-whitespace characters.
However, whitespace characters can be included in a word if quoted or
escaped according to the following rules:
.Bl -bullet
.It
An unescaped single or double quote introduces a quoted string,
which ends when the same quote character is encountered a second
time.
The quotes themselves are stripped.
.It
Within a single- or double-quoted string, all whitespace characters,
including the newline character, are preserved as-is.
.It
Outside a quoted string, a backslash escapes the next character,
which is preserved as-is, unless that character is a newline, in
which case it is discarded and reading continues at the beginning of
the next line as if the backslash and newline had not been there.
In all cases, the backslash itself is discarded.
.It
Within a single-quoted string, double quotes and backslashes are
preserved as-is.
.It
Within a double-quoted string, a single quote is preserved as-is,
and a backslash is preserved as-is unless used to escape a double
quote.
.El
.Pp
In addition, if the first non-whitespace character on the line is a
hash character (#), the rest of the line is discarded.
If a hash character occurs within a word, however, it is preserved
as-is.
A backslash at the end of a comment does cause line continuation.
.Pp
If
.Fa lineno
is not
.Dv NULL ,
the integer variable it points to is
incremented every time a quoted or escaped newline character is read.
.Pp
If
.Fa lenp
is not
.Dv NULL ,
the length of the word (after quotes and
backslashes have been removed) is stored in the variable it points to.
.Sh RETURN VALUES
If successful, the
.Fn openpam_readword
function returns a pointer to a
dynamically allocated NUL-terminated string containing the first word
encountered on the line.
.Pp
The caller is responsible for releasing the returned buffer by passing
it to
.Xr free 3 .
.Pp
If
.Fn openpam_readword
reaches the end of the line or file before any
characters are copied to the word, it returns
.Dv NULL .
In the former
case, the newline is pushed back to the file.
.Pp
If
.Fn openpam_readword
reaches the end of the file while a quote or
backslash escape is in effect, it sets
.Va errno
to
.Dv EINVAL
and returns
.Dv NULL .
.Sh IMPLEMENTATION NOTES
The parsing rules are intended to be equivalent to the normal POSIX
shell quoting rules.
Any discrepancy is a bug and should be reported to the author along
with sample input that can be used to reproduce the error.
.Pp
.Sh SEE ALSO
.Xr openpam_readline 3 ,
.Xr openpam_readlinev 3 ,
.Xr pam 3
.Sh STANDARDS
The
.Fn openpam_readword
function is an OpenPAM extension.
.Sh AUTHORS
The
.Fn openpam_readword
function and this manual page were
developed by
.An Dag-Erling Sm\(/orgrav Aq des@des.no .