xref: /netbsd/lib/libutil/secure_path.3 (revision bf9ec67e)
1.\"	$NetBSD: secure_path.3,v 1.7 2002/02/07 07:00:52 ross Exp $
2.\"
3.\" Copyright (c) 1996,1997 Berkeley Software Design, Inc. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. All advertising materials mentioning features or use of this software
14.\"    must display the following acknowledgement:
15.\"	This product includes software developed by Berkeley Software Design,
16.\"	Inc.
17.\" 4. The name of Berkeley Software Design, Inc.  may not be used to endorse
18.\"    or promote products derived from this software without specific prior
19.\"    written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN, INC. ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN, INC. BE LIABLE
25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\" from BSDI: login_cap.3,v 1.4 1997/11/07 16:22:27 jch Exp
34.\"
35.Dd July 16, 1996
36.Dt SECURE_PATH 3
37.Os
38.Sh NAME
39.Nm secure_path
40.Nd determine if a file appears to be ``secure''
41.Sh LIBRARY
42.Lb libutil
43.Sh SYNOPSIS
44.Fd #include \*[Lt]util.h\*[Gt]
45.Ft int
46.Fn secure_path "const char *path"
47.Sh DESCRIPTION
48The
49.Fn secure_path
50function takes a path name and returns zero if the referenced file is
51.Dq secure ,
52non-zero if not.  Any
53.Dq insecurity ,
54other than failure to access
55the referenced file, will be logged to the system log.
56.Pp
57To be
58.Dq secure ,
59the referenced file must exist, be a regular file (and not a
60directory), owned by the super-user, and writable only by the super-user.
61.Sh SEE ALSO
62.Xr openlog 3
63.Sh HISTORY
64The
65.Nm
66function is based on the
67.Bsx
68implementation of same, and appeared in
69.Nx 1.5
70by kind permission.
71