1 .\" Copyright (c) 2013 The FreeBSD Foundation
2 .\" All rights reserved.
4 .\" This documentation was written by Pawel Jakub Dawidek under sponsorship
5 .\" from the FreeBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 .Nd "library for handling application capabilities"
55 .Fn cap_wrap "int sock"
57 .Fn cap_unwrap "cap_channel_t *chan"
59 .Fn cap_sock "const cap_channel_t *chan"
61 .Fn cap_clone "const cap_channel_t *chan"
63 .Fn cap_close "cap_channel_t *chan"
65 .Fn cap_limit_get "const cap_channel_t *chan" "nvlist_t **limitsp"
67 .Fn cap_limit_set "const cap_channel_t *chan" "nvlist_t *limits"
69 .Fn cap_send_nvlist "const cap_channel_t *chan" "const nvlist_t *nvl"
71 .Fn cap_recv_nvlist "const cap_channel_t *chan"
73 .Fn cap_xfer_nvlist "const cap_channel_t *chan" "nvlist_t *nvl"
74 .In libcapsicum_service.h
76 .Fn cap_service_open "const cap_channel_t *chan" "const char *name"
80 library allows to manage application capabilities through the
84 The application capability (represented by the
86 type) is a communication channel between the caller and the
88 daemon or an instance of one of its services.
91 daemon obtained with the
93 function allows to create capabilities to casper's services via the
99 function opens capability to the
107 based on the given socket.
108 The function is used when capability is inherited through
112 domain socket as a regular file descriptor and has to be represented as
118 function is the opposite of the
123 structure and returns
125 domain socket associated with it.
129 function clones the given capability.
133 function closes the given capability.
139 domain socket descriptor associated with the given capability for use with
148 function stores current limits of the given capability in the
151 If the function return
157 it means there are no limits set.
161 function sets limits for the given capability.
162 The limits are provided as nvlist.
163 The exact format depends on the service the capability represents.
167 function sends the given nvlist over the given capability.
168 This is low level interface to communicate with casper services.
169 Most services should provide higher level API.
173 function receives the given nvlist over the given capability.
177 function sends the given nvlist, destroys it and receives new nvlist in
178 response over the given capability.
179 It does not matter if the function succeeds or fails, the nvlist given
180 for sending will always be destroyed once the function returns.
184 function opens casper service of the given name through casper capability
188 The function returns capability that provides access to opened service.
193 .Fn cap_recv_nvlist ,
194 .Fn cap_service_open ,
220 functions always succeed.
222 The following example first opens capability to the
224 daemon, then using this capability creates new capability to the
226 casper service and uses the latter capability to resolve IP address.
228 cap_channel_t *capcas, *capdns;
230 const char *ipstr = "127.0.0.1";
234 /* Open capability to the Casper daemon. */
237 err(1, "Unable to contact Casper daemon");
239 /* Enter capability mode sandbox. */
240 if (cap_enter() < 0 && errno != ENOSYS)
241 err(1, "Unable to enter capability mode");
243 /* Use Casper capability to create capability to the system.dns service. */
244 capdns = cap_service_open(capcas, "system.dns");
246 err(1, "Unable to open system.dns service");
248 /* Close Casper capability, we don't need it anymore. */
251 /* Limit system.dns to reverse DNS lookups and IPv4 addresses. */
252 limits = nvlist_create(0);
253 nvlist_add_string(limits, "type", "ADDR");
254 nvlist_add_number(limits, "family", (uint64_t)AF_INET);
255 if (cap_limit_set(capdns, limits) < 0)
256 err(1, "Unable to limit access to the system.dns service");
258 /* Convert IP address in C-string to in_addr. */
259 if (!inet_aton(ipstr, &ip))
260 errx(1, "Unable to parse IP address %s.", ipstr);
262 /* Find hostname for the given IP address. */
263 hp = cap_gethostbyaddr(capdns, (const void *)&ip, sizeof(ip), AF_INET);
265 errx(1, "No name associated with %s.", ipstr);
267 printf("Name associated with %s is %s.\\n", ipstr, hp->h_name);
275 .Xr cap_gethostbyaddr 3 ,
277 .Xr gethostbyaddr 3 ,
286 library was implemented by
287 .An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net
288 under sponsorship from the FreeBSD Foundation.