@@ -17,23 +17,23 @@ #import "OFObject.h" OF_ASSUME_NONNULL_BEGIN -/*! @file */ +/** @file */ @class OFArray OF_GENERIC(ObjectType); @class OFMutableArray OF_GENERIC(ObjectType); @class OFPair OF_GENERIC(FirstType, SecondType); -/*! +/** * @brief An @ref OFPair for a path to unveil, with the first string being the * path and the second the permissions. */ typedef OFPair OF_GENERIC(OFString *, OFString *) *of_sandbox_unveil_path_t; -/*! +/** * @class OFSandbox OFSandbox.h ObjFW/OFSandbox.h * * @brief A class which describes a sandbox for the application. */ @interface OFSandbox: OFObject @@ -72,181 +72,181 @@ @public size_t _unveiledPathsIndex; OF_RESERVE_IVARS(OFSandbox, 4) } -/*! +/** * @brief Allows IO operations on previously allocated file descriptors. */ @property (nonatomic) bool allowsStdIO; -/*! +/** * @brief Allows read access to the file system. */ @property (nonatomic) bool allowsReadingFiles; -/*! +/** * @brief Allows write access to the file system. */ @property (nonatomic) bool allowsWritingFiles; -/*! +/** * @brief Allows creating files in the file system. */ @property (nonatomic) bool allowsCreatingFiles; -/*! +/** * @brief Allows creating special files in the file system. */ @property (nonatomic) bool allowsCreatingSpecialFiles; -/*! +/** * @brief Allows creating, reading and writing temporary files in `/tmp`. */ @property (nonatomic) bool allowsTemporaryFiles; -/*! +/** * @brief Allows using IP sockets. */ @property (nonatomic) bool allowsIPSockets; -/*! +/** * @brief Allows multicast sockets. */ @property (nonatomic) bool allowsMulticastSockets; -/*! +/** * @brief Allows explicit changes to file attributes. */ @property (nonatomic) bool allowsChangingFileAttributes; -/*! +/** * @brief Allows changing ownership of files. */ @property (nonatomic) bool allowsFileOwnerChanges; -/*! +/** * @brief Allows file locks. */ @property (nonatomic) bool allowsFileLocks; -/*! +/** * @brief Allows UNIX sockets. */ @property (nonatomic) bool allowsUNIXSockets; -/*! +/** * @brief Allows syscalls necessary for DNS lookups. */ @property (nonatomic) bool allowsDNS; -/*! +/** * @brief Allows to look up users and groups. */ @property (nonatomic) bool allowsUserDatabaseReading; -/*! +/** * @brief Allows sending file descriptors via sendmsg(). */ @property (nonatomic) bool allowsFileDescriptorSending; -/*! +/** * @brief Allows receiving file descriptors via recvmsg(). */ @property (nonatomic) bool allowsFileDescriptorReceiving; -/*! +/** * @brief Allows MTIOCGET and MTIOCTOP operations on tape devices. */ @property (nonatomic) bool allowsTape; -/*! +/** * @brief Allows read-write operations and ioctls on the TTY. */ @property (nonatomic) bool allowsTTY; -/*! +/** * @brief Allows various process relationshop operations. */ @property (nonatomic) bool allowsProcessOperations; -/*! +/** * @brief Allows execve(). */ @property (nonatomic) bool allowsExec; -/*! +/** * @brief Allows PROT_EXEC for `mmap()` and `mprotect()`. */ @property (nonatomic) bool allowsProtExec; -/*! +/** * @brief Allows `settime()`. */ @property (nonatomic) bool allowsSetTime; -/*! +/** * @brief Allows introspection of processes on the system. */ @property (nonatomic) bool allowsPS; -/*! +/** * @brief Allows introspection of the system's virtual memory. */ @property (nonatomic) bool allowsVMInfo; -/*! +/** * @brief Allows changing the rights of process, for example the UID. */ @property (nonatomic) bool allowsChangingProcessRights; -/*! +/** * @brief Allows certain ioctls on the PF device. */ @property (nonatomic) bool allowsPF; -/*! +/** * @brief Allows certain ioctls on audio devices. */ @property (nonatomic) bool allowsAudio; -/*! +/** * @brief Allows BIOCGSTATS to collect statistics from a BPF device. */ @property (nonatomic) bool allowsBPF; -/*! +/** * @brief Allows unveiling more paths. */ @property (nonatomic) bool allowsUnveil; -/*! +/** * @brief Returns errors instead of killing the process. */ @property (nonatomic) bool returnsErrors; #ifdef OF_HAVE_PLEDGE -/*! +/** * The string for OpenBSD's pledge() call. * * @warning Only available on systems with the pledge() call! */ @property (readonly, nonatomic) OFString *pledgeString; #endif -/*! +/** * @brief A list of unveiled paths. */ @property (readonly, nonatomic) OFArray OF_GENERIC(of_sandbox_unveil_path_t) *unveiledPaths; -/*! +/** * @brief Create a new, autorelease OFSandbox. */ + (instancetype)sandbox; -/*! +/** * @brief "Unveils" the specified path, meaning that it becomes visible from * the sandbox with the specified permissions. * * @param path The path to unveil * @param permissions The permissions for the path. The following permissions