From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.8 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 86A03C2D0C2 for ; Tue, 31 Dec 2019 18:51:20 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 4CFA5206D9 for ; Tue, 31 Dec 2019 18:51:20 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="livo8uJg" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727071AbfLaSvU (ORCPT ); Tue, 31 Dec 2019 13:51:20 -0500 Received: from mail-pf1-f193.google.com ([209.85.210.193]:37889 "EHLO mail-pf1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727068AbfLaSvT (ORCPT ); Tue, 31 Dec 2019 13:51:19 -0500 Received: by mail-pf1-f193.google.com with SMTP id x185so20032445pfc.5; Tue, 31 Dec 2019 10:51:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=gZNh7bgB8iP+bDZILsv+wSocwkC/xWvNqa6759pT4OM=; b=livo8uJgBwZ1yOWSLQwF7dfzDS6MMCN/1+NnFJcyZXb/X7JS3dPNlRKZtP4ptM1qDa NvECs/fr9k+HQG9FYY43xn3z+1WiHJBk/0j224TAxCCBZECufBg2SBfsn7UVwc2Q07YK VPMLuCowFYD1Uk+eNfJNtMzcc2GfrpzkP/pNKVWKVdz+vdQpaWt5gMKU0FWT/nMNFX8K RQoX1E8akSi5jdgJfCfuc8rb4B+f1aa5MuzY0x1yOOpv+TDVNUHM7L6QNYaKxh18yEii Gv5/EtxRPWk19nPWM1JZmxsQIr76K4x5KQn5rLNw6Dj1KXPpOaZNM6n2sHxh+QjBRxsF 9ByA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=gZNh7bgB8iP+bDZILsv+wSocwkC/xWvNqa6759pT4OM=; b=og5wjUn+Ux0V2fO65BXxs+X9ENBlTtqcpwz/qhywaoRs9DHMVb10Y7MESafU8oNC8b 4O6qyx/tn+yjecfKWTajWo6HDJ/Z64h/A1pA50RKUa9VxEva4AfNM6WYO0J8NdIJVUMn x3NtSQVqwO3i+WxcfjxttG/pNIuhRZDDapKbMdht7AptpBR+ZHLUFnvKrobgIuU01Xoa 58U7WrtCHBKsAuiUWr8/drvKpoMgJp53Q7yZCzChK+dADQ14EhRCWXHmY6TWUZ3Ls8b3 rBwZbA1mGY9eX6P3z0QwBHTQk+hhITqxwbhmxbNZavapUASHIrHbmgC4qlnP6v7cBrCY FaKA== X-Gm-Message-State: APjAAAXzKg4vPTirj97BTb8wAecOusvaMYFH9+2AMmbWsk+v2mu4YEFh i6mwFiU44kr6lPtDKgtkCQM= X-Google-Smtp-Source: APXvYqzrpP5+qGP/Gxh8HG07VQaQ17wFDmta1hbvDTeZGdO5DBazLFsJYojxgJKYTB+5WV+37F5N4Q== X-Received: by 2002:a65:5cc2:: with SMTP id b2mr79408442pgt.51.1577818278701; Tue, 31 Dec 2019 10:51:18 -0800 (PST) Received: from localhost.localdomain ([2804:14d:72b1:8920:a2ce:f815:f14d:bfac]) by smtp.gmail.com with ESMTPSA id w187sm39561354pfw.62.2019.12.31.10.51.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 31 Dec 2019 10:51:18 -0800 (PST) From: "Daniel W. S. Almeida" X-Google-Original-From: Daniel W. S. Almeida To: miklos@szeredi.hu, corbet@lwn.net, markus.heiser@darmarit.de Cc: "Daniel W. S. Almeida" , linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, skhan@linuxfoundation.org, linux-kernel-mentees@lists.linuxfoundation.org Subject: [PATCH v4] Documentation: filesystems: convert fuse to RST Date: Tue, 31 Dec 2019 15:51:10 -0300 Message-Id: <20191231185110.809467-1-dwlsalmeida@gmail.com> X-Mailer: git-send-email 2.24.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org From: "Daniel W. S. Almeida" Converts fuse.txt to reStructuredText format, improving the presentation without changing much of the underlying content. Signed-off-by: Daniel W. S. Almeida ----------------------------------------------------------- Changes in v4: Use definition list in a section I had forgotten. Change **term** to ``term`` in the definition lists No more standalone "::" Remove "#." notation Changes in v3: Removed unnecessary markup. Moved document back to Documentation/filesystems as per request from the maintainer. Changes in v2: -Copied FUSE maintainer (Miklos Szeredi) -Fixed the reference in the MAINTAINERS file -Removed some of the excessive markup in fuse.rst -Moved fuse.rst into admin-guide -Updated index.rst --- .../filesystems/{fuse.txt => fuse.rst} | 174 ++++++++---------- Documentation/filesystems/index.rst | 1 + MAINTAINERS | 2 +- 3 files changed, 80 insertions(+), 97 deletions(-) rename Documentation/filesystems/{fuse.txt => fuse.rst} (79%) diff --git a/Documentation/filesystems/fuse.txt b/Documentation/filesystems/fuse.rst similarity index 79% rename from Documentation/filesystems/fuse.txt rename to Documentation/filesystems/fuse.rst index 13af4a49e7db..aa7d6f506b8d 100644 --- a/Documentation/filesystems/fuse.txt +++ b/Documentation/filesystems/fuse.rst @@ -1,41 +1,39 @@ -Definitions -~~~~~~~~~~~ +============== +FUSE +============== -Userspace filesystem: +Definitions +=========== +``Userspace filesystem:`` A filesystem in which data and metadata are provided by an ordinary userspace process. The filesystem can be accessed normally through the kernel interface. -Filesystem daemon: - +``Filesystem daemon:`` The process(es) providing the data and metadata of the filesystem. -Non-privileged mount (or user mount): - +``Non-privileged mount (or user mount):`` A userspace filesystem mounted by a non-privileged (non-root) user. The filesystem daemon is running with the privileges of the mounting user. NOTE: this is not the same as mounts allowed with the "user" option in /etc/fstab, which is not discussed here. -Filesystem connection: - +``Filesystem connection:`` A connection between the filesystem daemon and the kernel. The connection exists until either the daemon dies, or the filesystem is umounted. Note that detaching (or lazy umounting) the filesystem - does _not_ break the connection, in this case it will exist until + does *not* break the connection, in this case it will exist until the last reference to the filesystem is released. -Mount owner: - +``Mount owner:`` The user who does the mounting. -User: - +``User:`` The user who is performing filesystem operations. What is FUSE? -~~~~~~~~~~~~~ +============= FUSE is a userspace filesystem framework. It consists of a kernel module (fuse.ko), a userspace library (libfuse.*) and a mount utility @@ -46,50 +44,41 @@ non-privileged mounts. This opens up new possibilities for the use of filesystems. A good example is sshfs: a secure network filesystem using the sftp protocol. -The userspace library and utilities are available from the FUSE -homepage: - - http://fuse.sourceforge.net/ +The userspace library and utilities are available from the +`FUSE homepage: `_ Filesystem type -~~~~~~~~~~~~~~~ +=============== The filesystem type given to mount(2) can be one of the following: -'fuse' - - This is the usual way to mount a FUSE filesystem. The first - argument of the mount system call may contain an arbitrary string, - which is not interpreted by the kernel. + ``fuse`` + This is the usual way to mount a FUSE filesystem. The first + argument of the mount system call may contain an arbitrary string, + which is not interpreted by the kernel. -'fuseblk' - - The filesystem is block device based. The first argument of the - mount system call is interpreted as the name of the device. + ``fuseblk`` + The filesystem is block device based. The first argument of the + mount system call is interpreted as the name of the device. Mount options -~~~~~~~~~~~~~ - -'fd=N' +============= +``fd=N`` The file descriptor to use for communication between the userspace filesystem and the kernel. The file descriptor must have been obtained by opening the FUSE device ('/dev/fuse'). -'rootmode=M' - +``rootmode=M`` The file mode of the filesystem's root in octal representation. -'user_id=N' - +``user_id=N`` The numeric user id of the mount owner. -'group_id=N' - +``group_id=N`` The numeric group id of the mount owner. -'default_permissions' - +``default_permissions`` By default FUSE doesn't check file access permissions, the filesystem is free to implement its access policy or leave it to the underlying file access mechanism (e.g. in case of network @@ -97,28 +86,25 @@ Mount options access based on file mode. It is usually useful together with the 'allow_other' mount option. -'allow_other' - +``allow_other`` This option overrides the security measure restricting file access to the user mounting the filesystem. This option is by default only allowed to root, but this restriction can be removed with a (userspace) configuration option. -'max_read=N' - +``max_read=N`` With this option the maximum size of read operations can be set. The default is infinite. Note that the size of read requests is limited anyway to 32 pages (which is 128kbyte on i386). -'blksize=N' - +``blksize=N`` Set the block size for the filesystem. The default is 512. This option is only valid for 'fuseblk' type mounts. Control filesystem -~~~~~~~~~~~~~~~~~~ +================== -There's a control filesystem for FUSE, which can be mounted by: +There's a control filesystem for FUSE, which can be mounted by:: mount -t fusectl none /sys/fs/fuse/connections @@ -130,53 +116,51 @@ named by a unique number. For each connection the following files exist within this directory: - 'waiting' - - The number of requests which are waiting to be transferred to - userspace or being processed by the filesystem daemon. If there is - no filesystem activity and 'waiting' is non-zero, then the - filesystem is hung or deadlocked. - - 'abort' + ``waiting`` + The number of requests which are waiting to be transferred to + userspace or being processed by the filesystem daemon. If there is + no filesystem activity and 'waiting' is non-zero, then the + filesystem is hung or deadlocked. - Writing anything into this file will abort the filesystem - connection. This means that all waiting requests will be aborted an - error returned for all aborted and new requests. + ``abort`` + Writing anything into this file will abort the filesystem + connection. This means that all waiting requests will be aborted an + error returned for all aborted and new requests. Only the owner of the mount may read or write these files. Interrupting filesystem operations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +################################## If a process issuing a FUSE filesystem request is interrupted, the following will happen: - 1) If the request is not yet sent to userspace AND the signal is + - If the request is not yet sent to userspace AND the signal is fatal (SIGKILL or unhandled fatal signal), then the request is dequeued and returns immediately. - 2) If the request is not yet sent to userspace AND the signal is not - fatal, then an 'interrupted' flag is set for the request. When + - If the request is not yet sent to userspace AND the signal is not + fatal, then an interrupted flag is set for the request. When the request has been successfully transferred to userspace and this flag is set, an INTERRUPT request is queued. - 3) If the request is already sent to userspace, then an INTERRUPT + - If the request is already sent to userspace, then an INTERRUPT request is queued. INTERRUPT requests take precedence over other requests, so the userspace filesystem will receive queued INTERRUPTs before any others. The userspace filesystem may ignore the INTERRUPT requests entirely, -or may honor them by sending a reply to the _original_ request, with +or may honor them by sending a reply to the *original* request, with the error set to EINTR. It is also possible that there's a race between processing the original request and its INTERRUPT request. There are two possibilities: - 1) The INTERRUPT request is processed before the original request is + 1. The INTERRUPT request is processed before the original request is processed - 2) The INTERRUPT request is processed after the original request has + 2. The INTERRUPT request is processed after the original request has been answered If the filesystem cannot find the original request, it should wait for @@ -186,7 +170,7 @@ should reply to the INTERRUPT request with an EAGAIN error. In case reply will be ignored. Aborting a filesystem connection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +================================ It is possible to get into certain situations where the filesystem is not responding. Reasons for this may be: @@ -216,7 +200,7 @@ the filesystem. There are several ways to do this: powerful method, always works. How do non-privileged mounts work? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +================================== Since the mount() system call is a privileged operation, a helper program (fusermount) is needed, which is installed setuid root. @@ -235,15 +219,13 @@ system. Obvious requirements arising from this are: other users' or the super user's processes How are requirements fulfilled? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +=============================== A) The mount owner could gain elevated privileges by either: - 1) creating a filesystem containing a device file, then opening - this device + 1. creating a filesystem containing a device file, then opening this device - 2) creating a filesystem containing a suid or sgid application, - then executing this application + 2. creating a filesystem containing a suid or sgid application, then executing this application The solution is not to allow opening device files and ignore setuid and setgid bits when executing programs. To ensure this @@ -275,16 +257,16 @@ How are requirements fulfilled? of other users' processes. i) It can slow down or indefinitely delay the execution of a - filesystem operation creating a DoS against the user or the - whole system. For example a suid application locking a - system file, and then accessing a file on the mount owner's - filesystem could be stopped, and thus causing the system - file to be locked forever. + filesystem operation creating a DoS against the user or the + whole system. For example a suid application locking a + system file, and then accessing a file on the mount owner's + filesystem could be stopped, and thus causing the system + file to be locked forever. ii) It can present files or directories of unlimited length, or - directory structures of unlimited depth, possibly causing a - system process to eat up diskspace, memory or other - resources, again causing DoS. + directory structures of unlimited depth, possibly causing a + system process to eat up diskspace, memory or other + resources, again causing *DoS*. The solution to this as well as B) is not to allow processes to access the filesystem, which could otherwise not be @@ -294,28 +276,27 @@ How are requirements fulfilled? ptrace can be used to check if a process is allowed to access the filesystem or not. - Note that the ptrace check is not strictly necessary to + Note that the *ptrace* check is not strictly necessary to prevent B/2/i, it is enough to check if mount owner has enough privilege to send signal to the process accessing the - filesystem, since SIGSTOP can be used to get a similar effect. + filesystem, since *SIGSTOP* can be used to get a similar effect. I think these limitations are unacceptable? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +=========================================== If a sysadmin trusts the users enough, or can ensure through other measures, that system processes will never enter non-privileged -mounts, it can relax the last limitation with a "user_allow_other" +mounts, it can relax the last limitation with a 'user_allow_other' config option. If this config option is set, the mounting user can -add the "allow_other" mount option which disables the check for other +add the 'allow_other' mount option which disables the check for other users' processes. Kernel - userspace interface -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +============================ The following diagram shows how a filesystem operation (in this -example unlink) is performed in FUSE. +example unlink) is performed in FUSE. :: -NOTE: everything in this description is greatly simplified | "rm /mnt/fuse/file" | FUSE filesystem daemon | | @@ -357,12 +338,13 @@ NOTE: everything in this description is greatly simplified | -- 2.24.1