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 <features.h> 43 44#ifdef _DEFAULT_SOURCE 45 46 47#include <stdint.h> 48#include <sys/cdefs.h> 49#include <sys/types.h> 50 51#define PROPERTY_MAX_NAME 64 52#define PROPERTY_MAX_VALUE 512 53 54/* for properties.c */ 55typedef struct _property { 56 struct _property *next; 57 char *name; 58 char *value; 59} *properties; 60 61#ifdef _SYS_PARAM_H 62/* for pidfile.c */ 63struct pidfh { 64 int pf_fd; 65 char pf_path[MAXPATHLEN + 1]; 66 dev_t pf_dev; 67 ino_t pf_ino; 68}; 69#endif 70 71/* Avoid pulling in all the include files for no need */ 72struct termios; 73struct winsize; 74struct utmp; 75struct in_addr; 76 77__BEGIN_DECLS 78void clean_environment(const char * const *_white, 79 const char * const *_more_white); 80int extattr_namespace_to_string(int _attrnamespace, char **_string); 81int extattr_string_to_namespace(const char *_string, int *_attrnamespace); 82void login(struct utmp *_ut); 83int login_tty(int _fd); 84int logout(const char *_line); 85void logwtmp(const char *_line, const char *_name, const char *_host); 86void trimdomain(char *_fullhost, int _hostsize); 87int humanize_number(char *_buf, size_t _len, int64_t _number, 88 const char *_suffix, int _scale, int _flags); 89const char *uu_lockerr(int _uu_lockresult); 90int uu_lock(const char *_ttyname); 91int uu_unlock(const char *_ttyname); 92int uu_lock_txfr(const char *_ttyname, pid_t _pid); 93int _secure_path(const char *_path, uid_t _uid, gid_t _gid); 94properties properties_read(int fd); 95void properties_free(properties list); 96char *property_find(properties list, const char *name); 97char *auth_getval(const char *name); 98int realhostname(char *host, size_t hsize, const struct in_addr *ip); 99struct sockaddr; 100int realhostname_sa(char *host, size_t hsize, struct sockaddr *addr, 101 int addrlen); 102 103int kld_isloaded(const char *name); 104int kld_load(const char *name); 105 106#ifdef _STDIO_H_ /* avoid adding new includes */ 107char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 108#endif 109 110#ifdef _PWD_H_ 111int pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw); 112struct passwd *pw_dup(const struct passwd *_pw); 113int pw_edit(int _notsetuid); 114int pw_equal(const struct passwd *_pw1, const struct passwd *_pw2); 115void pw_fini(void); 116int pw_init(const char *_dir, const char *_master); 117char *pw_make(const struct passwd *_pw); 118int pw_mkdb(const char *_user); 119int pw_lock(void); 120struct passwd *pw_scan(const char *_line, int _flags); 121const char *pw_tempname(void); 122int pw_tmp(int _mfd); 123#endif 124 125#ifdef _SYS_PARAM_H 126struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr); 127int pidfile_write(struct pidfh *pfh); 128int pidfile_close(struct pidfh *pfh); 129int pidfile_remove(struct pidfh *pfh); 130#endif 131 132__END_DECLS 133 134#define UU_LOCK_INUSE (1) 135#define UU_LOCK_OK (0) 136#define UU_LOCK_OPEN_ERR (-1) 137#define UU_LOCK_READ_ERR (-2) 138#define UU_LOCK_CREAT_ERR (-3) 139#define UU_LOCK_WRITE_ERR (-4) 140#define UU_LOCK_LINK_ERR (-5) 141#define UU_LOCK_TRY_ERR (-6) 142#define UU_LOCK_OWNER_ERR (-7) 143 144/* return values from realhostname() */ 145#define HOSTNAME_FOUND (0) 146#define HOSTNAME_INCORRECTNAME (1) 147#define HOSTNAME_INVALIDADDR (2) 148#define HOSTNAME_INVALIDNAME (3) 149 150/* fparseln(3) */ 151#define FPARSELN_UNESCESC 0x01 152#define FPARSELN_UNESCCONT 0x02 153#define FPARSELN_UNESCCOMM 0x04 154#define FPARSELN_UNESCREST 0x08 155#define FPARSELN_UNESCALL 0x0f 156 157/* pw_scan() */ 158#define PWSCAN_MASTER 0x01 159#define PWSCAN_WARN 0x02 160 161/* humanize_number(3) */ 162#define HN_DECIMAL 0x01 163#define HN_NOSPACE 0x02 164#define HN_B 0x04 165#define HN_DIVISOR_1000 0x08 166 167#define HN_GETSCALE 0x10 168#define HN_AUTOSCALE 0x20 169 170 171#endif 172 173 174#endif /* !_LIBUTIL_H_ */ 175