xref: /freebsd/lib/libutil/libutil.h (revision 3193579b66fd7067f898dbc54bdea81a0e6f9bd0)
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 /* Avoid pulling in all the include files for no need */
53 struct termios;
54 struct winsize;
55 struct utmp;
56 struct in_addr;
57 
58 __BEGIN_DECLS
59 int	extattr_namespace_to_string(int _attrnamespace, char **_string);
60 int	extattr_string_to_namespace(const char *_string, int *_attrnamespace);
61 void	login(struct utmp *_ut);
62 int	login_tty(int _fd);
63 int	logout(const char *_line);
64 void	logwtmp(const char *_line, const char *_name, const char *_host);
65 void	trimdomain(char *_fullhost, int _hostsize);
66 int	openpty(int *_amaster, int *_aslave, char *_name,
67 		     struct termios *_termp, struct winsize *_winp);
68 int	forkpty(int *_amaster, char *_name,
69 		     struct termios *_termp, struct winsize *_winp);
70 const char *uu_lockerr(int _uu_lockresult);
71 int	uu_lock(const char *_ttyname);
72 int	uu_unlock(const char *_ttyname);
73 int	uu_lock_txfr(const char *_ttyname, pid_t _pid);
74 int	_secure_path(const char *_path, uid_t _uid, gid_t _gid);
75 properties properties_read(int fd);
76 void	properties_free(properties list);
77 char	*property_find(properties list, const char *name);
78 char	*auth_getval(const char *name);
79 int	realhostname(char *host, size_t hsize, const struct in_addr *ip);
80 struct sockaddr;
81 int	realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
82 			     int addrlen);
83 #ifdef _STDIO_H_	/* avoid adding new includes */
84 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
85 #endif
86 
87 #ifdef _PWD_H_
88 int	pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
89 struct passwd *pw_dup(const struct passwd *_pw);
90 int	pw_edit(int _notsetuid);
91 int	pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
92 void	pw_fini(void);
93 int	pw_init(const char *_dir, const char *_master);
94 char	*pw_make(const struct passwd *_pw);
95 int	pw_mkdb(const char *_user);
96 int	pw_lock(void);
97 struct passwd *pw_scan(const char *_line, int _flags);
98 const char *pw_tempname(void);
99 int	pw_tmp(int _mfd);
100 #endif
101 __END_DECLS
102 
103 #define UU_LOCK_INUSE (1)
104 #define UU_LOCK_OK (0)
105 #define UU_LOCK_OPEN_ERR (-1)
106 #define UU_LOCK_READ_ERR (-2)
107 #define UU_LOCK_CREAT_ERR (-3)
108 #define UU_LOCK_WRITE_ERR (-4)
109 #define UU_LOCK_LINK_ERR (-5)
110 #define UU_LOCK_TRY_ERR (-6)
111 #define UU_LOCK_OWNER_ERR (-7)
112 
113 /* return values from realhostname() */
114 #define HOSTNAME_FOUND		(0)
115 #define HOSTNAME_INCORRECTNAME	(1)
116 #define HOSTNAME_INVALIDADDR	(2)
117 #define HOSTNAME_INVALIDNAME	(3)
118 
119 /* fparseln(3) */
120 #define	FPARSELN_UNESCESC	0x01
121 #define	FPARSELN_UNESCCONT	0x02
122 #define	FPARSELN_UNESCCOMM	0x04
123 #define	FPARSELN_UNESCREST	0x08
124 #define	FPARSELN_UNESCALL	0x0f
125 
126 /* pw_scan() */
127 #define PWSCAN_MASTER		0x01
128 #define PWSCAN_WARN		0x02
129 
130 #endif /* !_LIBUTIL_H_ */
131