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