1 /*- 2 * Copyright (c) 2012-2013 The FreeBSD Foundation 3 * Copyright (c) 2015 Mariusz Zaborski <oshogbo@FreeBSD.org> 4 * All rights reserved. 5 * 6 * This software was developed by Pawel Jakub Dawidek under sponsorship from 7 * the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef _LIBCASPER_H_ 34 #define _LIBCASPER_H_ 35 36 #include <sys/types.h> 37 38 #ifndef _NVLIST_T_DECLARED 39 #define _NVLIST_T_DECLARED 40 struct nvlist; 41 42 typedef struct nvlist nvlist_t; 43 #endif 44 45 #ifndef _CAP_CHANNEL_T_DECLARED 46 #define _CAP_CHANNEL_T_DECLARED 47 struct cap_channel; 48 49 typedef struct cap_channel cap_channel_t; 50 #endif 51 52 /* 53 * The functions opens unrestricted communication channel to Casper. 54 */ 55 cap_channel_t *cap_init(void); 56 57 /* 58 * The functions to communicate with service. 59 */ 60 cap_channel_t *cap_service_open(const cap_channel_t *chan, const char *name); 61 int cap_service_limit(const cap_channel_t *chan, 62 const char * const *names, size_t nnames); 63 64 /* 65 * The function creates cap_channel_t based on the given socket. 66 */ 67 cap_channel_t *cap_wrap(int sock); 68 69 /* 70 * The function returns communication socket and frees cap_channel_t. 71 */ 72 int cap_unwrap(cap_channel_t *chan); 73 74 /* 75 * The function clones the given capability. 76 */ 77 cap_channel_t *cap_clone(const cap_channel_t *chan); 78 79 /* 80 * The function closes the given capability. 81 */ 82 void cap_close(cap_channel_t *chan); 83 84 /* 85 * The function returns socket descriptor associated with the given 86 * cap_channel_t for use with select(2)/kqueue(2)/etc. 87 */ 88 int cap_sock(const cap_channel_t *chan); 89 90 /* 91 * The function limits the given capability. 92 * It always destroys 'limits' on return. 93 */ 94 int cap_limit_set(const cap_channel_t *chan, nvlist_t *limits); 95 96 /* 97 * The function returns current limits of the given capability. 98 */ 99 int cap_limit_get(const cap_channel_t *chan, nvlist_t **limitsp); 100 101 /* 102 * Function sends nvlist over the given capability. 103 */ 104 int cap_send_nvlist(const cap_channel_t *chan, const nvlist_t *nvl); 105 /* 106 * Function receives nvlist over the given capability. 107 */ 108 nvlist_t *cap_recv_nvlist(const cap_channel_t *chan, int flags); 109 /* 110 * Function sends the given nvlist, destroys it and receives new nvlist in 111 * response over the given capability. 112 */ 113 nvlist_t *cap_xfer_nvlist(const cap_channel_t *chan, nvlist_t *nvl, int flags); 114 115 #endif /* !_LIBCASPER_H_ */ 116