diff --git a/lib/libcasper/libcasper/libcasper.3 b/lib/libcasper/libcasper/libcasper.3 index 02c08270dcf2..2151131e29ec 100644 --- a/lib/libcasper/libcasper/libcasper.3 +++ b/lib/libcasper/libcasper/libcasper.3 @@ -1,298 +1,298 @@ .\" Copyright (c) 2013 The FreeBSD Foundation .\" Copyright (c) 2018 Mariusz Zaborski .\" All rights reserved. .\" .\" This documentation was written by Pawel Jakub Dawidek under sponsorship .\" from the FreeBSD Foundation. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd November 15, 2021 .Dt LIBCASPER 3 .Os .Sh NAME .Nm cap_init , .Nm cap_wrap , .Nm cap_unwrap , .Nm cap_sock , .Nm cap_clone , .Nm cap_close , .Nm cap_limit_get , .Nm cap_limit_set , .Nm cap_send_nvlist , .Nm cap_recv_nvlist , .Nm cap_xfer_nvlist , .Nm cap_service_open .Nd "library for handling application capabilities" .Sh LIBRARY .Lb libcasper .Sh SYNOPSIS .Fd #define WITH_CASPER .In sys/nv.h .In libcasper.h .Ft "cap_channel_t *" .Fn cap_init "void" .Ft "cap_channel_t *" .Fn cap_wrap "int sock" "int flags" .Ft "int" .Fn cap_unwrap "cap_channel_t *chan" "int *flags" .Ft "int" .Fn cap_sock "const cap_channel_t *chan" .Ft "cap_channel_t *" .Fn cap_clone "const cap_channel_t *chan" .Ft "void" .Fn cap_close "cap_channel_t *chan" .Ft "int" .Fn cap_limit_get "const cap_channel_t *chan" "nvlist_t **limitsp" .Ft "int" .Fn cap_limit_set "const cap_channel_t *chan" "nvlist_t *limits" .Ft "int" .Fn cap_send_nvlist "const cap_channel_t *chan" "const nvlist_t *nvl" .Ft "nvlist_t *" .Fn cap_recv_nvlist "const cap_channel_t *chan" .Ft "nvlist_t *" .Fn cap_xfer_nvlist "const cap_channel_t *chan" "nvlist_t *nvl" .Ft "cap_channel_t *" .Fn cap_service_open "const cap_channel_t *chan" "const char *name" .Sh DESCRIPTION The .Nm libcasper library provides for the control of application capabilities through the casper process. .Pp An application capability, represented by the .Vt cap_channel_t type, is a communication channel between the caller and the casper daemon or an instance of one of the daemon's services. A capability to the casper process, obtained with the .Fn cap_init function, allows a program to create capabilities to access the casper daemon's services via the .Fn cap_service_open function. .Pp The .Fn cap_init function instantiates a capability to allow a program to access the casper daemon. .Pp The .Fn cap_wrap function creates a .Vt cap_channel_t based on the socket supplied in the call. The function is used when a capability is inherited through the .Xr execve 2 system call, or sent over a .Xr unix 4 domain socket as a file descriptor, and has to be converted into a .Vt cap_channel_t . The .Fa flags argument defines the channel behavior. The supported flags are: .Bl -ohang -offset indent .It CASPER_NO_UNIQ -The communication between the process and the casper daemon no +The communication between the process and the casper daemon uses no unique version of nvlist. .El .Pp The .Fn cap_unwrap function returns the .Xr unix 4 domain socket used by the daemon service, and frees the .Vt cap_channel_t structure. .Pp The .Fn cap_clone function returns a clone of the capability passed as its only argument. .Pp The .Fn cap_close function closes, and frees, the given capability. .Pp The .Fn cap_sock function returns the .Xr unix 4 domain socket descriptor associated with the given capability for use with system calls such as: .Xr kevent 2 , -.Xr poll 2 +.Xr poll 2 , and .Xr select 2 . .Pp The .Fn cap_limit_get function stores the current limits of the given capability in the .Fa limitsp argument. If the function returns .Va 0 and .Dv NULL is stored in the .Fa limitsp argument, there are no limits set. .Pp The .Fn cap_limit_set function sets limits for the given capability. The limits are provided as an .Xr nvlist 9 . The exact format of the limits depends on the service that the capability represents. .Fn cap_limit_set frees the limits passed to the call, whether or not the operation succeeds or fails. .Pp The .Fn cap_send_nvlist function sends the given .Xr nvlist 9 over the given capability. This is a low level interface to communicate with casper services. It is expected that most services will provide a higher level API. .Pp The .Fn cap_recv_nvlist function receives the given .Xr nvlist 9 over the given capability. .Pp The .Fn cap_xfer_nvlist function sends the given .Xr nvlist 9 , destroys it, and receives a new .Xr nvlist 9 in response over the given capability. It does not matter if the function succeeds or fails, the .Xr nvlist 9 given for sending will always be destroyed before the function returns. .Pp The .Fn cap_service_open function opens the casper service named in the call using the casper capability obtained via the .Fn cap_init function. The .Fn cap_service_open function returns a capability that provides access to the opened service. Casper supports the following services in the base system: .Pp .Bl -tag -width "system.random" -compact -offset indent .It system.dns provides libc compatible DNS API .It system.grp provides a .Xr getgrent 3 compatible API .It system.net provides a libc compatible network API .It system.pwd provides a .Xr getpwent 3 compatible API .It system.sysctl provides a .Xr sysctlbyname 3 compatible API .It system.syslog provides a .Xr syslog 3 compatible API .El .Sh RETURN VALUES The .Fn cap_clone , .Fn cap_init , .Fn cap_recv_nvlist , .Fn cap_service_open , .Fn cap_wrap and .Fn cap_xfer_nvlist functions return .Dv NULL and set the .Va errno variable on failure. .Pp The .Fn cap_limit_get , .Fn cap_limit_set and .Fn cap_send_nvlist functions return .Dv -1 and set the .Va errno variable on failure. .Pp The .Fn cap_close , .Fn cap_sock and .Fn cap_unwrap functions always succeed. .Sh SEE ALSO .Xr errno 2 , .Xr execve 2 , .Xr kevent 2 , .Xr poll 2 , .Xr select 2 , .Xr cap_dns 3 , .Xr cap_grp 3 , .Xr cap_net 3 , .Xr cap_pwd 3 , .Xr cap_sysctl 3 , .Xr cap_syslog 3 , .Xr libcasper_service 3 , .Xr capsicum 4 , .Xr unix 4 , .Xr nv 9 .Sh HISTORY The .Nm libcasper library first appeared in .Fx 10.3 . .Sh AUTHORS The .Nm libcasper library was implemented by .An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net under sponsorship from the FreeBSD Foundation. The .Nm libcasper new architecture was implemented by .An Mariusz Zaborski Aq Mt oshogbo@FreeBSD.org . diff --git a/lib/libcasper/libcasper/libcasper_service.3 b/lib/libcasper/libcasper/libcasper_service.3 index 9e0f76cf98d0..8ddc41f3d617 100644 --- a/lib/libcasper/libcasper/libcasper_service.3 +++ b/lib/libcasper/libcasper/libcasper_service.3 @@ -1,120 +1,121 @@ .\" Copyright (c) 2018 Mariusz Zaborski .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd November 15, 2021 .Dt LIBCASPER 3 .Os .Sh NAME .Nm CREATE_SERVICE .Nd "casper service declaration macro" .Sh LIBRARY .Lb libcasper .Sh SYNOPSIS .In sys/nv.h .In libcasper.h .In libcasper_service.h .Bd -literal typedef int service_limit_func_t(const nvlist_t *, const nvlist_t *); typedef int service_command_func_t(const char *, const nvlist_t *, nvlist_t *, nvlist_t *); .Ed .Fn CREATE_SERVICE "name" "limit_func" "command_func" "flags" .Sh DESCRIPTION The .Nm CREATE_SERVICE macro is used to create a new casper service. The .Fa name is a string containing the service name, which will be used in the .Xr cap_service_open 3 , function to identify it. .Pp The .Fa limit_func is a function of type .Li service_limit_func_t -where the first argument of the function contains an containing +where the first argument of the function contains an .Xr nvlist 9 , -old service limits and the second argument contains the new limits. +old service limits and +the second argument contains the new limits. If the service was not limited then the old limits will be set to .Dv NULL . This function must not allow the extension of service limits. The .Fa command_func is a function of type .Li service_command_func_t where the first argument is the name of the command that should be executed. The first .Xr nvlist 9 contains the current limits and the second contains an .Xr nvlist 9 with the current request. The last argument contains a return value .Xr nvlist 9 which contains the response from casper. .Pp The .Fa flags argument defines the limits of the service. The supported flags are: .Bl -ohang -offset indent .It CASPER_SERVICE_STDIO The casper service has access to the stdio descriptors from the process it was spawned from. .It CASPER_SERVICE_FD The casper service has access to all of the descriptors, besides the stdio descriptors, from the process it was spawned from. .It CASPER_SERVICE_NO_UNIQ_LIMITS The whole casper communication is using an .Xr nvlist 9 with the .Xr NVLIST_NO_UNIQ 9 flag. .El .Sh SEE ALSO .Xr cap_enter 2 , .Xr libcasper 3 , .Xr capsicum 4 , .Xr nv 9 .Sh HISTORY The .Nm libcasper library first appeared in .Fx 10.3 . .Sh AUTHORS The .Nm libcasper library was implemented by .An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net under sponsorship from the FreeBSD Foundation. The .Nm libcasper new architecture was implemented by .An Mariusz Zaborski Aq Mt oshogbo@FreeBSD.org .