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: src/lib/libutil/libutil.h,v 1.26.2.3 2000/11/22 03:49:49 murray Exp $
  37  */
  38
  39 #ifndef _LIBUTIL_H_
  40 #define _LIBUTIL_H_
  41
  42 #include <sys/types.h>
  43
  44 #ifdef _PWD_H_
  45 #define _PWSCAN_MASTER  0x01
  46 #define _PWSCAN_WARN    0x02
  47 #endif
  48
  49 #define PROPERTY_MAX_NAME       64
  50 #define PROPERTY_MAX_VALUE      512
  51
  52 /* for properties.c */
  53 typedef struct _property {
  54         struct _property *next;
  55         char *name;
  56         char *value;
  57 } *properties;
  58
  59 /* Avoid pulling in all the include files for no need */
  60 struct termios;
  61 struct winsize;
  62 struct utmp;
  63 struct utmpx;
  64 struct in_addr;
  65 struct sockaddr;
  66
  67 __BEGIN_DECLS
  68 int     flopen(const char *, int, ...);
  69 void    login(struct utmp *);
  70 void    loginx(const struct utmpx *);
  71 int     login_tty(int);
  72 int     logout(const char *);
  73 int     logoutx(const char *, int, int);
  74 void    logwtmp(const char *, const char *, const char *);
  75 void    logwtmpx(const char *, const char *, const char *, int, int);
  76 void    trimdomain(char *, int);
  77 int     openpty(int *, int *, char *, struct termios *, struct winsize *);
  78 int     forkpty(int *, char *, struct termios *, struct winsize *);
  79 int     dehumanize_number(const char *, int64_t *);
  80 int     humanize_number(char *, size_t, int64_t, const char *, int, int);
  81 int     humanize_unsigned(char *buf, size_t len, uint64_t bytes,
  82                                         const char *suffix, int divisor);
  83 int     format_bytes(char *buf, size_t len, uint64_t bytes);
  84 const char *uu_lockerr(int);
  85 int     uu_lock(const char *);
  86 int     uu_unlock(const char *);
  87 int     uu_lock_txfr(const char *, pid_t);
  88 int     _secure_path(const char *, uid_t, gid_t);
  89 int     pidfile(const char *);
  90 properties properties_read(int fd);
  91 void    properties_free(properties);
  92 char    *property_find(properties, const char *);
  93 char    *auth_getval(const char *);
  94 int     realhostname(char *, size_t, const struct in_addr *);
  95 int     realhostname_sa(char *, size_t, struct sockaddr *, int);
  96 #ifdef _STDIO_H_        /* avoid adding new includes */
  97 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
  98 #endif
  99
 100 #ifdef _PWD_H_
 101 int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
 102 struct passwd *pw_dup(const struct passwd *_pw);
 103 int     pw_edit(int _notsetuid);
 104 int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
 105 void    pw_fini(void);
 106 int     pw_init(const char *_dir, const char *_master);
 107 char    *pw_make(const struct passwd *_pw);
 108 int     pw_mkdb(const char *_user);
 109 int     pw_lock(void);
 110 struct passwd *pw_scan(const char *_line, int _flags);
 111 const char *pw_tempname(void);
 112 int     pw_tmp(int _mfd);
 113 #endif
 114
 115 /* Error checked functions */
 116 void            (*esetfunc(void (*)(int, const char *, ...)))
 117                 (int, const char *, ...);
 118 size_t          estrlcpy(char *, const char *, size_t);
 119 size_t          estrlcat(char *, const char *, size_t);
 120 char            *estrdup(const char *);
 121 char            *estrndup(const char *, size_t);
 122 void            *ecalloc(size_t, size_t);
 123 void            *emalloc(size_t);
 124 void            *erealloc(void *, size_t);
 125 int             easprintf(char ** __restrict, const char * __restrict, ...)
 126                 __printflike(2, 3);
 127 __END_DECLS
 128
 129 #define UU_LOCK_INUSE (1)
 130 #define UU_LOCK_OK (0)
 131 #define UU_LOCK_OPEN_ERR (-1)
 132 #define UU_LOCK_READ_ERR (-2)
 133 #define UU_LOCK_CREAT_ERR (-3)
 134 #define UU_LOCK_WRITE_ERR (-4)
 135 #define UU_LOCK_LINK_ERR (-5)
 136 #define UU_LOCK_TRY_ERR (-6)
 137 #define UU_LOCK_OWNER_ERR (-7)
 138
 139 /* return values from realhostname() */
 140 #define HOSTNAME_FOUND          (0)
 141 #define HOSTNAME_INCORRECTNAME  (1)
 142 #define HOSTNAME_INVALIDADDR    (2)
 143 #define HOSTNAME_INVALIDNAME    (3)
 144
 145 /* fparseln(3) */
 146 #define FPARSELN_UNESCESC       0x01
 147 #define FPARSELN_UNESCCONT      0x02
 148 #define FPARSELN_UNESCCOMM      0x04
 149 #define FPARSELN_UNESCREST      0x08
 150 #define FPARSELN_UNESCALL       0x0f
 151
 152 /* pw_scan() */
 153 #define PWSCAN_MASTER           0x01
 154 #define PWSCAN_WARN             0x02
 155
 156 /* humanize_number(3) */
 157 #define HN_DECIMAL              0x01
 158 #define HN_NOSPACE              0x02
 159 #define HN_B                    0x04
 160 #define HN_DIVISOR_1000         0x08
 161 #define HN_GETSCALE             0x10
 162 #define HN_AUTOSCALE            0x20
 163
 164 #endif /* !_LIBUTIL_H_ */