FreeBSD manual
download PDF document: cap_fileargs.3.pdf
CAP_FILEARGS(3) FreeBSD Library Functions Manual CAP_FILEARGS(3)
NAME
fileargs_cinit, fileargs_cinitnv, fileargs_init, fileargs_initnv,
fileargs_free, fileargs_lstat, fileargs_open, fileargs_fopen - library
for handling files in capability mode
LIBRARY
library "libcap_fileargs"
SYNOPSIS
#include <sys/nv.h>
#include <libcasper.h>
#include <casper/cap_fileargs.h>
fileargs_t *
fileargs_init(int argc, char *argv[], int flags, mode_t mode,
cap_rights_t *rightsp, int operations);
fileargs_t *
fileargs_cinit(cap_channel_t *cas, int argc, char *argv[], int flags,
mode_t mode, cap_rights_t *rightsp, int operations);
fileargs_t *
fileargs_cinitnv(cap_channel_t *cas, nvlist_t *limits);
fileargs_t *
fileargs_initnv(nvlist_t *limits);
void
fileargs_free(fileargs_t *fa);
int
fileargs_lstat(fileargs_t *fa, const char *path, struct stat *sb);
int
fileargs_open(fileargs_t *fa, const char *name);
FILE *
fileargs_fopen(fileargs_t *fa, const char *name, const char *mode);
char *
fileargs_realpath(fileargs_t *fa, const char *pathname,
char *reserved_path);
DESCRIPTION
The library is used to simplify Capsicumizing a tools that are using file
system. Idea behind the library is that we are passing a remaining argc
and argv which contains a list of files that should be open for this
program. The library will create a service that will serve those files.
The function fileargs_init() create a service to the system.fileargs.
The argv contains a list of files that should be opened. The argument
can be set to NULL which will not create a service and all files will be
prohibited to be opened. The argc argument contains a number of passed
files. The flags argument limits opened files for either execution or
reading and/or writing. The mode argument tells which what mode file
should be created if the O_CREATE flag is present . For more details of
the flags and mode arguments see open(2). The rightsp argument contains
FA_LSTAT
Allow fileargs_lstat().
FA_REALPATH
Allow fileargs_realpath().
The function fileargs_cinit() is equivalent to fileargs_init() except
that the connection to the Casper needs to be provided.
The functions fileargs_initnv() and fileargs_cinitnv() are respectively
equivalent to fileargs_init() and fileargs_cinit() expect that all
arguments all provided as nvlist(9). For details see LIMITS.
The fileargs_free close connection to the system.fileargs service and
free are structures. The function handle NULL argument.
The function fileargs_lstat() is equivalent to lstat(2).
The functions fileargs_open() and fileargs_fopen() are respectively
equivalent to open(2) and fopen(3) expect that all arguments are fetched
from the fileargs_t structure.
The function fileargs_realpath() is equivalent to realpath(3).
LIMITS
This section describe which values and types should be used to pass
arguments to the system.fileargs through the fileargs_initnv() and
fileargs_cinitnv() functions. The nvlist(9) for that functions must
contain the following values and types:
flags (NV_TYPE_NUMBER)
The flags limits opened files for either execution or reading
and/or writing.
mode (NV_TYPE_NUMBER)
If in the flags argument the O_CREATE flag was defined the
nvlist(9) must contain the mode. The mode argument tells which
what mode file should be created.
operations (NV_TYPE_NUMBER)
The operations limits the usable operations for system.fileargs.
The possible values are explained as operations argument with
fileargs_init().
The nvlist(9) for that functions may contain the following values and
types:
cap_rights (NV_TYPE_BINARY)
The cap_rights argument contains a list of the capability rights
which file should be limited to.
(NV_TYPE_NULL)
Any number of NV_TYPE_NULL where the name of the element is name of
the file which can be opened.
EXAMPLES
The following example first parse some options and then create the
system.fileargs service with remaining arguments.
case 'h':
default:
usage();
}
}
argc -= optind;
argv += optind;
/* Create capability to the system.fileargs service. */
fa = fileargs_init(argc, argv, O_RDONLY, 0,
cap_rights_init(&rights, CAP_READ), FA_OPEN);
if (fa == NULL)
err(1, "unable to open system.fileargs service");
/* Enter capability mode sandbox. */
if (cap_enter() < 0 && errno != ENOSYS)
err(1, "unable to enter capability mode");
/* Open files. */
for (i = 0; i < argc; i++) {
fd = fileargs_open(fa, argv[i]);
if (fd < 0)
err(1, "unable to open file %s", argv[i]);
printf("File %s opened in capability mode\n", argv[i]);
close(fd);
}
fileargs_free(fa);
SEE ALSO
cap_enter(2), lstat(2), open(2), cap_rights_init(3), err(3), fopen(3),
getopt(3), realpath(3), capsicum(4), nv(9)
HISTORY
The cap_fileargs service first appeared in FreeBSD 10.3.
AUTHORS
Mariusz Zaborski <oshogbo@FreeBSD.org>
BUGS
The library "cap_fileargs" included in FreeBSD is considered
experimental, and should not be deployed in production environments
without careful consideration of the risks associated with the use of
experimental operating system features.
FreeBSD 14.0-RELEASE-p6 January 10, 2021 FreeBSD 14.0-RELEASE-p6