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    hexdump(const void *ptr, int length, const char *hdr, int flags);
  75 void    login(struct utmp *_ut);
  76 int     login_tty(int _fd);
  77 int     logout(const char *_line);
  78 void    logwtmp(const char *_line, const char *_name, const char *_host);
  79 void    trimdomain(char *_fullhost, int _hostsize);
  80 int     openpty(int *_amaster, int *_aslave, char *_name,
  81                      struct termios *_termp, struct winsize *_winp);
  82 int     forkpty(int *_amaster, char *_name,
  83                      struct termios *_termp, struct winsize *_winp);
  84 int     humanize_number(char *_buf, size_t _len, int64_t _number,
  85             const char *_suffix, int _scale, int _flags);
  86 int     expand_number(const char *_buf, int64_t *_num);
  87 const char *uu_lockerr(int _uu_lockresult);
  88 int     uu_lock(const char *_ttyname);
  89 int     uu_unlock(const char *_ttyname);
  90 int     uu_lock_txfr(const char *_ttyname, pid_t _pid);
  91 int     _secure_path(const char *_path, uid_t _uid, gid_t _gid);
  92 properties properties_read(int fd);
  93 void    properties_free(properties list);
  94 char    *property_find(properties list, const char *name);
  95 char    *auth_getval(const char *name);
  96 int     realhostname(char *host, size_t hsize, const struct in_addr *ip);
  97 struct sockaddr;
  98 int     realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
  99                              int addrlen);
 100
 101 int     kld_isloaded(const char *name);
 102 int     kld_load(const char *name);
 103
 104 #ifdef _STDIO_H_        /* avoid adding new includes */
 105 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
 106 #endif
 107
 108 #ifdef _PWD_H_
 109 int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
 110 struct passwd *pw_dup(const struct passwd *_pw);
 111 int     pw_edit(int _notsetuid);
 112 int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
 113 void    pw_fini(void);
 114 int     pw_init(const char *_dir, const char *_master);
 115 char    *pw_make(const struct passwd *_pw);
 116 int     pw_mkdb(const char *_user);
 117 int     pw_lock(void);
 118 struct passwd *pw_scan(const char *_line, int _flags);
 119 const char *pw_tempname(void);
 120 int     pw_tmp(int _mfd);
 121 #endif
 122
 123 #ifdef _GRP_H_
 124 int     gr_equal(const struct group *gr1, const struct group *gr2);
 125 char    *gr_make(const struct group *gr);
 126 struct group *gr_dup(const struct group *gr);
 127 struct group *gr_scan(const char *line);
 128 #endif
 129
 130 #ifdef _SYS_PARAM_H_
 131 struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr);
 132 int pidfile_write(struct pidfh *pfh);
 133 int pidfile_close(struct pidfh *pfh);
 134 int pidfile_remove(struct pidfh *pfh);
 135 #endif
 136
 137 __END_DECLS
 138
 139 #define UU_LOCK_INUSE (1)
 140 #define UU_LOCK_OK (0)
 141 #define UU_LOCK_OPEN_ERR (-1)
 142 #define UU_LOCK_READ_ERR (-2)
 143 #define UU_LOCK_CREAT_ERR (-3)
 144 #define UU_LOCK_WRITE_ERR (-4)
 145 #define UU_LOCK_LINK_ERR (-5)
 146 #define UU_LOCK_TRY_ERR (-6)
 147 #define UU_LOCK_OWNER_ERR (-7)
 148
 149 /* return values from realhostname() */
 150 #define HOSTNAME_FOUND          (0)
 151 #define HOSTNAME_INCORRECTNAME  (1)
 152 #define HOSTNAME_INVALIDADDR    (2)
 153 #define HOSTNAME_INVALIDNAME    (3)
 154
 155 /* fparseln(3) */
 156 #define FPARSELN_UNESCESC       0x01
 157 #define FPARSELN_UNESCCONT      0x02
 158 #define FPARSELN_UNESCCOMM      0x04
 159 #define FPARSELN_UNESCREST      0x08
 160 #define FPARSELN_UNESCALL       0x0f
 161
 162 /* pw_scan() */
 163 #define PWSCAN_MASTER           0x01
 164 #define PWSCAN_WARN             0x02
 165
 166 /* humanize_number(3) */
 167 #define HN_DECIMAL              0x01
 168 #define HN_NOSPACE              0x02
 169 #define HN_B                    0x04
 170 #define HN_DIVISOR_1000         0x08
 171
 172 #define HN_GETSCALE             0x10
 173 #define HN_AUTOSCALE            0x20
 174
 175 /* hexdump(3) */
 176 #define HD_COLUMN_MASK          0xff
 177 #define HD_DELIM_MASK           0xff00
 178 #define HD_OMIT_COUNT           (1 << 16)
 179 #define HD_OMIT_HEX             (1 << 17)
 180 #define HD_OMIT_CHARS           (1 << 18)
 181
 182 #endif /* !_LIBUTIL_H_ */