lib/libcapsicum/libcapsicum.h

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