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.42 2006/02/18 11:25:28 des Exp $ 37 */ 38 39 #ifndef _LIBUTIL_H_ 40 #define _LIBUTIL_H_ 41 42 #include <stdint.h> 43 #include <sys/cdefs.h> 44 #include <sys/types.h> 45 46 #define PROPERTY_MAX_NAME 64 47 #define PROPERTY_MAX_VALUE 512 48 49 /* for properties.c */ 50 typedef struct _property { 51 struct _property *next; 52 char *name; 53 char *value; 54 } *properties; 55 56 #ifdef _SYS_PARAM_H 57 /* for pidfile.c */ 58 struct pidfh { 59 int pf_fd; 60 char pf_path[MAXPATHLEN + 1]; 61 dev_t pf_dev; 62 ino_t pf_ino; 63 }; 64 #endif 65 66 /* Avoid pulling in all the include files for no need */ 67 struct termios; 68 struct winsize; 69 struct utmp; 70 struct in_addr; 71 72 __BEGIN_DECLS 73 void clean_environment(const char * const *_white, 74 const char * const *_more_white); 75 int extattr_namespace_to_string(int _attrnamespace, char **_string); 76 int extattr_string_to_namespace(const char *_string, int *_attrnamespace); 77 void login(struct utmp *_ut); 78 int login_tty(int _fd); 79 int logout(const char *_line); 80 void logwtmp(const char *_line, const char *_name, const char *_host); 81 void trimdomain(char *_fullhost, int _hostsize); 82 int humanize_number(char *_buf, size_t _len, int64_t _number, 83 const char *_suffix, int _scale, int _flags); 84 const char *uu_lockerr(int _uu_lockresult); 85 int uu_lock(const char *_ttyname); 86 int uu_unlock(const char *_ttyname); 87 int uu_lock_txfr(const char *_ttyname, pid_t _pid); 88 int _secure_path(const char *_path, uid_t _uid, gid_t _gid); 89 properties properties_read(int fd); 90 void properties_free(properties list); 91 char *property_find(properties list, const char *name); 92 char *auth_getval(const char *name); 93 int realhostname(char *host, size_t hsize, const struct in_addr *ip); 94 struct sockaddr; 95 int realhostname_sa(char *host, size_t hsize, struct sockaddr *addr, 96 int addrlen); 97 98 int kld_isloaded(const char *name); 99 int kld_load(const char *name); 100 101 #ifdef _STDIO_H_ /* avoid adding new includes */ 102 char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 103 #endif 104 105 #ifdef _PWD_H_ 106 int pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw); 107 struct passwd *pw_dup(const struct passwd *_pw); 108 int pw_edit(int _notsetuid); 109 int pw_equal(const struct passwd *_pw1, const struct passwd *_pw2); 110 void pw_fini(void); 111 int pw_init(const char *_dir, const char *_master); 112 char *pw_make(const struct passwd *_pw); 113 int pw_mkdb(const char *_user); 114 int pw_lock(void); 115 struct passwd *pw_scan(const char *_line, int _flags); 116 const char *pw_tempname(void); 117 int pw_tmp(int _mfd); 118 #endif 119 120 #ifdef _SYS_PARAM_H 121 struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr); 122 int pidfile_write(struct pidfh *pfh); 123 int pidfile_close(struct pidfh *pfh); 124 int pidfile_remove(struct pidfh *pfh); 125 #endif 126 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 162 #define HN_GETSCALE 0x10 163 #define HN_AUTOSCALE 0x20 164 165 #endif /* !_LIBUTIL_H_ */ 166