lib/libutil/secure_path.3

   1 .\"     $NetBSD: secure_path.3,v 1.10 2010/05/04 06:41:27 jruoho 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 May 4, 2010
  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 .In util.h
  45 .Ft int
  46 .Fn secure_path "const char *path"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn secure_path
  50 function takes a path name and returns zero if the referenced file is
  51 .Dq secure ,
  52 non-zero if not.
  53 Any
  54 .Dq insecurity ,
  55 other than failure to access
  56 the referenced file, will be logged to the system log.
  57 .Pp
  58 To be
  59 .Dq secure ,
  60 the referenced file must exist, be a regular file (and not a
  61 directory), owned by the super-user, and writable only by the super-user.
  62 .Sh SEE ALSO
  63 .Xr openlog 3
  64 .Sh HISTORY
  65 The
  66 .Fn secure_path
  67 function is based on the
  68 .Bsx
  69 implementation of same, and appeared in
  70 .Nx 1.5
  71 by kind permission.