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