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: head/lib/libutil/libutil.h 247919 2013-03-07 19:00:00Z db $ 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 in_addr; 61 struct pidfh; 62 struct sockaddr; 63 struct termios; 64 struct winsize; 65 struct utmp; 66 struct utmpx; 67 68 __BEGIN_DECLS 69 char *auth_getval(const char *_name); 70 void login(struct utmp *); 71 void loginx(const struct utmpx *); 72 int login_tty(int); 73 int logout(const char *); 74 int logoutx(const char *, int, int); 75 void logwtmp(const char *, const char *, const char *); 76 void logwtmpx(const char *, const char *, const char *, int, int); 77 void trimdomain(char *, int); 78 int flopen(const char *_path, int _flags, ...); 79 int forkpty(int *_amaster, char *_name, 80 struct termios *_termp, struct winsize *_winp); 81 int dehumanize_number(const char *, int64_t *); 82 void hexdump(const void *_ptr, int _length, const char *_hdr, int _flags); 83 int humanize_number(char *_buf, size_t _len, int64_t _number, 84 const char *_suffix, int _scale, int _flags); 85 int humanize_unsigned(char *buf, size_t len, uint64_t bytes, 86 const char *suffix, int divisor); 87 int format_bytes(char *buf, size_t len, uint64_t bytes); 88 const char *uu_lockerr(int); 89 int uu_lock(const char *); 90 int uu_unlock(const char *); 91 int uu_lock_txfr(const char *, pid_t); 92 int _secure_path(const char *, uid_t, gid_t); 93 int openpty(int *_amaster, int *_aslave, char *_name, 94 struct termios *_termp, struct winsize *_winp); 95 int pidfile_close(struct pidfh *_pfh); 96 int pidfile_fileno(const struct pidfh *_pfh); 97 struct pidfh * 98 pidfile_open(const char *_path, mode_t _mode, pid_t *_pidptr); 99 int pidfile_remove(struct pidfh *_pfh); 100 int pidfile_write(struct pidfh *_pfh); 101 void properties_free(properties _list); 102 char *property_find(properties _list, const char *_name); 103 properties 104 properties_read(int fd); 105 int realhostname(char *, size_t, const struct in_addr *); 106 int realhostname_sa(char *, size_t, struct sockaddr *, int); 107 #ifdef _STDIO_H_ /* avoid adding new includes */ 108 char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 109 #endif 110 111 #ifdef _PWD_H_ 112 int pw_copy(int _ffd, int _tfd, const struct passwd *_pw, 113 struct passwd *_old_pw); 114 struct passwd 115 *pw_dup(const struct passwd *_pw); 116 int pw_edit(int _notsetuid); 117 int pw_equal(const struct passwd *_pw1, const struct passwd *_pw2); 118 void pw_fini(void); 119 int pw_init(const char *_dir, const char *_master); 120 char *pw_make(const struct passwd *_pw); 121 char *pw_make_v7(const struct passwd *_pw); 122 int pw_mkdb(const char *_user); 123 int pw_lock(void); 124 struct passwd * 125 pw_scan(const char *_line, int _flags); 126 const char * 127 pw_tempname(void); 128 int pw_tmp(int _mfd); 129 #endif 130 131 #ifdef _GRP_H_ 132 int gr_copy(int __ffd, int _tfd, const struct group *_gr, 133 struct group *_old_gr); 134 struct group * 135 gr_dup(const struct group *_gr); 136 struct group * 137 gr_add(const struct group *_gr, const char *_newmember); 138 int gr_equal(const struct group *_gr1, const struct group *_gr2); 139 void gr_fini(void); 140 int gr_init(const char *_dir, const char *_master); 141 int gr_lock(void); 142 char *gr_make(const struct group *_gr); 143 int gr_mkdb(void); 144 struct group * 145 gr_scan(const char *_line); 146 int gr_tmp(int _mdf); 147 #endif 148 149 /* Error checked functions */ 150 void (*esetfunc(void (*)(int, const char *, ...))) 151 (int, const char *, ...); 152 size_t estrlcpy(char *, const char *, size_t); 153 size_t estrlcat(char *, const char *, size_t); 154 char *estrdup(const char *); 155 char *estrndup(const char *, size_t); 156 void *ecalloc(size_t, size_t); 157 void *emalloc(size_t); 158 void *erealloc(void *, size_t); 159 int easprintf(char ** __restrict, const char * __restrict, ...) 160 __printflike(2, 3); 161 __END_DECLS 162 163 /* fparseln(3) */ 164 #define FPARSELN_UNESCESC 0x01 165 #define FPARSELN_UNESCCONT 0x02 166 #define FPARSELN_UNESCCOMM 0x04 167 #define FPARSELN_UNESCREST 0x08 168 #define FPARSELN_UNESCALL 0x0f 169 170 /* Flags for hexdump(3). */ 171 #define HD_COLUMN_MASK 0xff 172 #define HD_DELIM_MASK 0xff00 173 #define HD_OMIT_COUNT (1 << 16) 174 #define HD_OMIT_HEX (1 << 17) 175 #define HD_OMIT_CHARS (1 << 18) 176 177 /* Values for humanize_number(3)'s flags parameter. */ 178 #define HN_DECIMAL 0x01 179 #define HN_NOSPACE 0x02 180 #define HN_B 0x04 181 #define HN_DIVISOR_1000 0x08 182 #define HN_IEC_PREFIXES 0x10 183 #define HN_FRACTIONAL 0x20 184 185 /* Values for humanize_number(3)'s scale parameter. */ 186 #define HN_GETSCALE 0x10 187 #define HN_AUTOSCALE 0x20 188 189 /* Return values from realhostname(). */ 190 #define HOSTNAME_FOUND 0 191 #define HOSTNAME_INCORRECTNAME 1 192 #define HOSTNAME_INVALIDADDR 2 193 #define HOSTNAME_INVALIDNAME 3 194 195 /* Flags for pw_scan(). */ 196 #define PWSCAN_MASTER 0x01 197 #define PWSCAN_WARN 0x02 198 199 /* Return values from uu_lock(). */ 200 #define UU_LOCK_INUSE 1 201 #define UU_LOCK_OK 0 202 #define UU_LOCK_OPEN_ERR (-1) 203 #define UU_LOCK_READ_ERR (-2) 204 #define UU_LOCK_CREAT_ERR (-3) 205 #define UU_LOCK_WRITE_ERR (-4) 206 #define UU_LOCK_LINK_ERR (-5) 207 #define UU_LOCK_TRY_ERR (-6) 208 #define UU_LOCK_OWNER_ERR (-7) 209 210 #endif /* !_LIBUTIL_H_ */ 211