lib/libutil/libutil.h

   1 /*
   2  * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
   3  * All rights reserved.
   4  * Copyright (c) 2002 Networks Associates Technology, Inc.
   5  * All rights reserved.
   6  *
   7  * Portions of this software were developed for the FreeBSD Project by
   8  * ThinkSec AS and NAI Labs, the Security Research Division of Network
   9  * Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
  10  * ("CBOSS"), as part of the DARPA CHATS research program.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, is permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. The name of the author may not be used to endorse or promote
  21  *    products derived from this software without specific prior written
  22  *    permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  * $FreeBSD$
  37  */
  38
  39 #ifndef _LIBUTIL_H_
  40 #define _LIBUTIL_H_
  41
  42 #define PROPERTY_MAX_NAME       64
  43 #define PROPERTY_MAX_VALUE      512
  44
  45 /* for properties.c */
  46 typedef struct _property {
  47         struct _property *next;
  48         char *name;
  49         char *value;
  50 } *properties;
  51
  52 #ifdef _SYS_PARAM_H_
  53 /* for pidfile.c */
  54 struct pidfh {
  55         int     pf_fd;
  56         char    pf_path[MAXPATHLEN + 1];
  57         __dev_t pf_dev;
  58         ino_t   pf_ino;
  59 };
  60 #endif
  61
  62 /* Avoid pulling in all the include files for no need */
  63 struct termios;
  64 struct winsize;
  65 struct utmp;
  66 struct in_addr;
  67
  68 __BEGIN_DECLS
  69 void    clean_environment(const char * const *_white,
  70             const char * const *_more_white);
  71 int     extattr_namespace_to_string(int _attrnamespace, char **_string);
  72 int     extattr_string_to_namespace(const char *_string, int *_attrnamespace);
  73 int     flopen(const char *_path, int _flags, ...);
  74 void    login(struct utmp *_ut);
  75 int     login_tty(int _fd);
  76 int     logout(const char *_line);
  77 void    logwtmp(const char *_line, const char *_name, const char *_host);
  78 void    trimdomain(char *_fullhost, int _hostsize);
  79 int     openpty(int *_amaster, int *_aslave, char *_name,
  80                      struct termios *_termp, struct winsize *_winp);
  81 int     forkpty(int *_amaster, char *_name,
  82                      struct termios *_termp, struct winsize *_winp);
  83 int     humanize_number(char *_buf, size_t _len, int64_t _number,
  84             const char *_suffix, int _scale, int _flags);
  85 const char *uu_lockerr(int _uu_lockresult);
  86 int     uu_lock(const char *_ttyname);
  87 int     uu_unlock(const char *_ttyname);
  88 int     uu_lock_txfr(const char *_ttyname, pid_t _pid);
  89 int     _secure_path(const char *_path, uid_t _uid, gid_t _gid);
  90 properties properties_read(int fd);
  91 void    properties_free(properties list);
  92 char    *property_find(properties list, const char *name);
  93 char    *auth_getval(const char *name);
  94 int     realhostname(char *host, size_t hsize, const struct in_addr *ip);
  95 struct sockaddr;
  96 int     realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
  97                              int addrlen);
  98
  99 int     kld_isloaded(const char *name);
 100 int     kld_load(const char *name);
 101
 102 #ifdef _STDIO_H_        /* avoid adding new includes */
 103 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
 104 #endif
 105
 106 #ifdef _PWD_H_
 107 int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
 108 struct passwd *pw_dup(const struct passwd *_pw);
 109 int     pw_edit(int _notsetuid);
 110 int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
 111 void    pw_fini(void);
 112 int     pw_init(const char *_dir, const char *_master);
 113 char    *pw_make(const struct passwd *_pw);
 114 int     pw_mkdb(const char *_user);
 115 int     pw_lock(void);
 116 struct passwd *pw_scan(const char *_line, int _flags);
 117 const char *pw_tempname(void);
 118 int     pw_tmp(int _mfd);
 119 #endif
 120
 121 #ifdef _SYS_PARAM_H_
 122 struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr);
 123 int pidfile_write(struct pidfh *pfh);
 124 int pidfile_close(struct pidfh *pfh);
 125 int pidfile_remove(struct pidfh *pfh);
 126 #endif
 127
 128 __END_DECLS
 129
 130 #define UU_LOCK_INUSE (1)
 131 #define UU_LOCK_OK (0)
 132 #define UU_LOCK_OPEN_ERR (-1)
 133 #define UU_LOCK_READ_ERR (-2)
 134 #define UU_LOCK_CREAT_ERR (-3)
 135 #define UU_LOCK_WRITE_ERR (-4)
 136 #define UU_LOCK_LINK_ERR (-5)
 137 #define UU_LOCK_TRY_ERR (-6)
 138 #define UU_LOCK_OWNER_ERR (-7)
 139
 140 /* return values from realhostname() */
 141 #define HOSTNAME_FOUND          (0)
 142 #define HOSTNAME_INCORRECTNAME  (1)
 143 #define HOSTNAME_INVALIDADDR    (2)
 144 #define HOSTNAME_INVALIDNAME    (3)
 145
 146 /* fparseln(3) */
 147 #define FPARSELN_UNESCESC       0x01
 148 #define FPARSELN_UNESCCONT      0x02
 149 #define FPARSELN_UNESCCOMM      0x04
 150 #define FPARSELN_UNESCREST      0x08
 151 #define FPARSELN_UNESCALL       0x0f
 152
 153 /* pw_scan() */
 154 #define PWSCAN_MASTER           0x01
 155 #define PWSCAN_WARN             0x02
 156
 157 /* humanize_number(3) */
 158 #define HN_DECIMAL              0x01
 159 #define HN_NOSPACE              0x02
 160 #define HN_B                    0x04
 161 #define HN_DIVISOR_1000         0x08
 162
 163 #define HN_GETSCALE             0x10
 164 #define HN_AUTOSCALE            0x20
 165
 166 #endif /* !_LIBUTIL_H_ */