xref: /freebsd/lib/libcapsicum/capsicum_helpers.h (revision e24ff5c99be080007ff9086398fbe3ef56cd94dc)
17a6e3cf8SMariusz Zaborski /*-
27a6e3cf8SMariusz Zaborski  * Copyright (c) 2016 Mariusz Zaborski <oshogbo@FreeBSD.org>
37a6e3cf8SMariusz Zaborski  * All rights reserved.
47a6e3cf8SMariusz Zaborski  *
57a6e3cf8SMariusz Zaborski  * Redistribution and use in source and binary forms, with or without
67a6e3cf8SMariusz Zaborski  * modification, are permitted provided that the following conditions
77a6e3cf8SMariusz Zaborski  * are met:
87a6e3cf8SMariusz Zaborski  * 1. Redistributions of source code must retain the above copyright
97a6e3cf8SMariusz Zaborski  *    notice, this list of conditions and the following disclaimer.
107a6e3cf8SMariusz Zaborski  * 2. Redistributions in binary form must reproduce the above copyright
117a6e3cf8SMariusz Zaborski  *    notice, this list of conditions and the following disclaimer in the
127a6e3cf8SMariusz Zaborski  *    documentation and/or other materials provided with the distribution.
137a6e3cf8SMariusz Zaborski  *
147a6e3cf8SMariusz Zaborski  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
157a6e3cf8SMariusz Zaborski  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
167a6e3cf8SMariusz Zaborski  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
177a6e3cf8SMariusz Zaborski  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
187a6e3cf8SMariusz Zaborski  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
197a6e3cf8SMariusz Zaborski  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
207a6e3cf8SMariusz Zaborski  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
217a6e3cf8SMariusz Zaborski  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
227a6e3cf8SMariusz Zaborski  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
237a6e3cf8SMariusz Zaborski  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
247a6e3cf8SMariusz Zaborski  * SUCH DAMAGE.
257a6e3cf8SMariusz Zaborski  */
267a6e3cf8SMariusz Zaborski 
277a6e3cf8SMariusz Zaborski #ifndef _CAPSICUM_HELPERS_H_
287a6e3cf8SMariusz Zaborski #define	_CAPSICUM_HELPERS_H_
297a6e3cf8SMariusz Zaborski 
307a6e3cf8SMariusz Zaborski #include <sys/param.h>
317a6e3cf8SMariusz Zaborski #include <sys/capsicum.h>
323e13c1faSKyle Evans #include <sys/ioctl.h>
337a6e3cf8SMariusz Zaborski 
347a6e3cf8SMariusz Zaborski #include <errno.h>
357a6e3cf8SMariusz Zaborski #include <nl_types.h>
367a6e3cf8SMariusz Zaborski #include <termios.h>
377a6e3cf8SMariusz Zaborski #include <time.h>
387a6e3cf8SMariusz Zaborski #include <unistd.h>
397a6e3cf8SMariusz Zaborski 
40cfb13e0aSMariusz Zaborski #include <libcasper.h>
41cfb13e0aSMariusz Zaborski 
427a6e3cf8SMariusz Zaborski #define	CAPH_IGNORE_EBADF	0x0001
437a6e3cf8SMariusz Zaborski #define	CAPH_READ		0x0002
447a6e3cf8SMariusz Zaborski #define	CAPH_WRITE		0x0004
456a1c4d1eSConrad Meyer #define	CAPH_LOOKUP		0x0008
467a6e3cf8SMariusz Zaborski 
472da0fcdeSMariusz Zaborski __BEGIN_DECLS
482da0fcdeSMariusz Zaborski 
49990beb03SKyle Evans static const unsigned long caph_stream_cmds[] =
507ec1ec4fSAlex Richardson     {
517ec1ec4fSAlex Richardson #ifdef TIOCGETA
527ec1ec4fSAlex Richardson 	TIOCGETA,
537ec1ec4fSAlex Richardson #endif
547ec1ec4fSAlex Richardson #ifdef TIOCGWINSZ
557ec1ec4fSAlex Richardson 	TIOCGWINSZ,
567ec1ec4fSAlex Richardson #endif
577ec1ec4fSAlex Richardson #ifdef FIODTYPE
587ec1ec4fSAlex Richardson 	FIODTYPE,
597ec1ec4fSAlex Richardson #endif
607ec1ec4fSAlex Richardson     };
61990beb03SKyle Evans static const uint32_t caph_stream_fcntls = CAP_FCNTL_GETFL;
62990beb03SKyle Evans 
63990beb03SKyle Evans static __inline void
64990beb03SKyle Evans caph_stream_rights(cap_rights_t *rights, int flags)
65990beb03SKyle Evans {
66990beb03SKyle Evans 
67990beb03SKyle Evans 	cap_rights_init(rights, CAP_EVENT, CAP_FCNTL, CAP_FSTAT,
68990beb03SKyle Evans 	    CAP_IOCTL, CAP_SEEK);
69990beb03SKyle Evans 
70990beb03SKyle Evans 	if ((flags & CAPH_READ) != 0)
71990beb03SKyle Evans 		cap_rights_set(rights, CAP_READ);
72990beb03SKyle Evans 	if ((flags & CAPH_WRITE) != 0)
73990beb03SKyle Evans 		cap_rights_set(rights, CAP_WRITE);
74990beb03SKyle Evans 	if ((flags & CAPH_LOOKUP) != 0)
75990beb03SKyle Evans 		cap_rights_set(rights, CAP_LOOKUP);
76990beb03SKyle Evans }
77990beb03SKyle Evans 
787a6e3cf8SMariusz Zaborski static __inline int
797a6e3cf8SMariusz Zaborski caph_limit_stream(int fd, int flags)
807a6e3cf8SMariusz Zaborski {
817a6e3cf8SMariusz Zaborski 	cap_rights_t rights;
827a6e3cf8SMariusz Zaborski 
83990beb03SKyle Evans 	caph_stream_rights(&rights, flags);
847a6e3cf8SMariusz Zaborski 	if (cap_rights_limit(fd, &rights) < 0 && errno != ENOSYS) {
857a6e3cf8SMariusz Zaborski 		if (errno == EBADF && (flags & CAPH_IGNORE_EBADF) != 0)
867a6e3cf8SMariusz Zaborski 			return (0);
877a6e3cf8SMariusz Zaborski 		return (-1);
887a6e3cf8SMariusz Zaborski 	}
897a6e3cf8SMariusz Zaborski 
90990beb03SKyle Evans 	if (cap_ioctls_limit(fd, caph_stream_cmds,
91990beb03SKyle Evans 	    nitems(caph_stream_cmds)) < 0 && errno != ENOSYS)
927a6e3cf8SMariusz Zaborski 		return (-1);
937a6e3cf8SMariusz Zaborski 
94990beb03SKyle Evans 	if (cap_fcntls_limit(fd, caph_stream_fcntls) < 0 && errno != ENOSYS)
957a6e3cf8SMariusz Zaborski 		return (-1);
967a6e3cf8SMariusz Zaborski 
977a6e3cf8SMariusz Zaborski 	return (0);
987a6e3cf8SMariusz Zaborski }
997a6e3cf8SMariusz Zaborski 
1007a6e3cf8SMariusz Zaborski static __inline int
1017a6e3cf8SMariusz Zaborski caph_limit_stdin(void)
1027a6e3cf8SMariusz Zaborski {
1037a6e3cf8SMariusz Zaborski 
1047a6e3cf8SMariusz Zaborski 	return (caph_limit_stream(STDIN_FILENO, CAPH_READ));
1057a6e3cf8SMariusz Zaborski }
1067a6e3cf8SMariusz Zaborski 
1077a6e3cf8SMariusz Zaborski static __inline int
1087a6e3cf8SMariusz Zaborski caph_limit_stderr(void)
1097a6e3cf8SMariusz Zaborski {
1107a6e3cf8SMariusz Zaborski 
1117a6e3cf8SMariusz Zaborski 	return (caph_limit_stream(STDERR_FILENO, CAPH_WRITE));
1127a6e3cf8SMariusz Zaborski }
1137a6e3cf8SMariusz Zaborski 
1147a6e3cf8SMariusz Zaborski static __inline int
1157a6e3cf8SMariusz Zaborski caph_limit_stdout(void)
1167a6e3cf8SMariusz Zaborski {
1177a6e3cf8SMariusz Zaborski 
1187a6e3cf8SMariusz Zaborski 	return (caph_limit_stream(STDOUT_FILENO, CAPH_WRITE));
1197a6e3cf8SMariusz Zaborski }
1207a6e3cf8SMariusz Zaborski 
1217a6e3cf8SMariusz Zaborski static __inline int
1227a6e3cf8SMariusz Zaborski caph_limit_stdio(void)
1237a6e3cf8SMariusz Zaborski {
124103701b1SConrad Meyer 	const int iebadf = CAPH_IGNORE_EBADF;
1257a6e3cf8SMariusz Zaborski 
126103701b1SConrad Meyer 	if (caph_limit_stream(STDIN_FILENO, CAPH_READ | iebadf) == -1 ||
127103701b1SConrad Meyer 	    caph_limit_stream(STDOUT_FILENO, CAPH_WRITE | iebadf) == -1 ||
128103701b1SConrad Meyer 	    caph_limit_stream(STDERR_FILENO, CAPH_WRITE | iebadf) == -1)
1297a6e3cf8SMariusz Zaborski 		return (-1);
1307a6e3cf8SMariusz Zaborski 	return (0);
1317a6e3cf8SMariusz Zaborski }
1327a6e3cf8SMariusz Zaborski 
1337a6e3cf8SMariusz Zaborski static __inline void
1347a6e3cf8SMariusz Zaborski caph_cache_tzdata(void)
1357a6e3cf8SMariusz Zaborski {
136*e24ff5c9SMariusz Zaborski 	time_t delta;
1377a6e3cf8SMariusz Zaborski 
1387a6e3cf8SMariusz Zaborski 	tzset();
139*e24ff5c9SMariusz Zaborski 
140*e24ff5c9SMariusz Zaborski 	/*
141*e24ff5c9SMariusz Zaborski 	 * The tzset() function does not cache all time zones.
142*e24ff5c9SMariusz Zaborski 	 * Some functions, such as gmtime(), require a GMT time zone.
143*e24ff5c9SMariusz Zaborski 	 * The only way to cache them is to call the function directly.
144*e24ff5c9SMariusz Zaborski 	 */
145*e24ff5c9SMariusz Zaborski 	delta = 0;
146*e24ff5c9SMariusz Zaborski 	(void)gmtime(&delta);
1477a6e3cf8SMariusz Zaborski }
1487a6e3cf8SMariusz Zaborski 
1497a6e3cf8SMariusz Zaborski static __inline void
1507a6e3cf8SMariusz Zaborski caph_cache_catpages(void)
1517a6e3cf8SMariusz Zaborski {
1527a6e3cf8SMariusz Zaborski 
1537a6e3cf8SMariusz Zaborski 	(void)catopen("libc", NL_CAT_LOCALE);
1547a6e3cf8SMariusz Zaborski }
1557a6e3cf8SMariusz Zaborski 
156cfb13e0aSMariusz Zaborski static __inline int
157cfb13e0aSMariusz Zaborski caph_enter(void)
158cfb13e0aSMariusz Zaborski {
159cfb13e0aSMariusz Zaborski 
160cfb13e0aSMariusz Zaborski 	if (cap_enter() < 0 && errno != ENOSYS)
161cfb13e0aSMariusz Zaborski 		return (-1);
162cfb13e0aSMariusz Zaborski 
163cfb13e0aSMariusz Zaborski 	return (0);
164cfb13e0aSMariusz Zaborski }
165cfb13e0aSMariusz Zaborski 
1665a453d5fSMariusz Zaborski static __inline int
1675a453d5fSMariusz Zaborski caph_rights_limit(int fd, const cap_rights_t *rights)
1685a453d5fSMariusz Zaborski {
1695a453d5fSMariusz Zaborski 
1705a453d5fSMariusz Zaborski 	if (cap_rights_limit(fd, rights) < 0 && errno != ENOSYS)
1715a453d5fSMariusz Zaborski 		return (-1);
1725a453d5fSMariusz Zaborski 
1735a453d5fSMariusz Zaborski 	return (0);
1745a453d5fSMariusz Zaborski }
1755a453d5fSMariusz Zaborski 
1765a453d5fSMariusz Zaborski static __inline int
1775a453d5fSMariusz Zaborski caph_ioctls_limit(int fd, const unsigned long *cmds, size_t ncmds)
1785a453d5fSMariusz Zaborski {
1795a453d5fSMariusz Zaborski 
1805a453d5fSMariusz Zaborski 	if (cap_ioctls_limit(fd, cmds, ncmds) < 0 && errno != ENOSYS)
1815a453d5fSMariusz Zaborski 		return (-1);
1825a453d5fSMariusz Zaborski 
1835a453d5fSMariusz Zaborski 	return (0);
1845a453d5fSMariusz Zaborski }
1855a453d5fSMariusz Zaborski 
1865a453d5fSMariusz Zaborski static __inline int
1875a453d5fSMariusz Zaborski caph_fcntls_limit(int fd, uint32_t fcntlrights)
1885a453d5fSMariusz Zaborski {
1895a453d5fSMariusz Zaborski 
1909e549375SMariusz Zaborski 	if (cap_fcntls_limit(fd, fcntlrights) < 0 && errno != ENOSYS)
1915a453d5fSMariusz Zaborski 		return (-1);
1925a453d5fSMariusz Zaborski 
1935a453d5fSMariusz Zaborski 	return (0);
1945a453d5fSMariusz Zaborski }
195cfb13e0aSMariusz Zaborski 
196cfb13e0aSMariusz Zaborski static __inline int
197cfb13e0aSMariusz Zaborski caph_enter_casper(void)
198cfb13e0aSMariusz Zaborski {
199cfb13e0aSMariusz Zaborski 
200cfb13e0aSMariusz Zaborski 	return (CASPER_SUPPORT == 0 ? 0 : caph_enter());
201cfb13e0aSMariusz Zaborski }
202cfb13e0aSMariusz Zaborski 
2032da0fcdeSMariusz Zaborski __END_DECLS
2042da0fcdeSMariusz Zaborski 
2057a6e3cf8SMariusz Zaborski #endif /* _CAPSICUM_HELPERS_H_ */
206