Adding an Uncacheable Attribute to NFSv4.2

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶

This Internet-Draft will expire on 14 March 2025.¶

Copyright Notice

Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

1. Introduction

In the Network File System version4.2 (NFSv4.2), a client queries for either a file's or directory's attributes via either GETATTR (see Section 18.7 of [RFC8881]) or READDIR (see Section 18.23 of [RFC8881]) to the server. These directory entries (dirents) can be cached locally by the client.¶

As these cached dirents are shared by all users on the clients and the client can not determine access to these dirents, all users are presented with the same set of attributes. We introduce the new uncacheable attribute, which informs the client not to cache a dirent for that file object. As such each time the client queries attributes for that file object, the response can be tailored to that user. That decision can be based on either Access Control List (ACL) on a file object (see Section 6 of [RFC8881]) or proprietary policies.¶

Using the process detailed in [RFC8178], the revisions in this document become an extension of NFSv4.2 [RFC7862]. They are built on top of the external data representation (XDR) [RFC4506] generated from [RFC7863].¶

2. Uncacheable Dirents

If a file object has the uncacheable attribute set, then the client MUST NOT cache the dirent for that object. I.e., just because it presented the attributes for that object to user A on the first request, then on a subsequent request, it MUST query for those attributes again. Also, the client MUST NOT share attributes between different users.¶

<CODE BEGINS>
///
/// typedef bool            fattr4_uncacheable;
///
/// const FATTR4_UNCACHEABLE            = 87;
///


<CODE ENDS>

3. Extraction of XDR

This document contains the external data representation (XDR) [RFC4506] description of the uncacheable attribute. The XDR description is embedded in this document in a way that makes it simple for the reader to extract into a ready-to-compile form. The reader can feed this document into the following shell script to produce the machine readable XDR description of the new flags:¶

<CODE BEGINS>
#!/bin/sh
grep '^ *///' $* | sed 's?^ */// ??' | sed 's?^ *///$??'


<CODE ENDS>

That is, if the above script is stored in a file called "extract.sh", and this document is in a file called "spec.txt", then the reader can do:¶

<CODE BEGINS>
sh extract.sh < spec.txt > uncacheable_prot.x


<CODE ENDS>

The effect of the script is to remove leading white space from each line, plus a sentinel sequence of "///". XDR descriptions with the sentinel sequence are embedded throughout the document.¶

Note that the XDR code contained in this document depends on types from the NFSv4.2 nfs4_prot.x file (generated from [RFC7863]). This includes both nfs types that end with a 4, such as offset4, length4, etc., as well as more generic types such as uint32_t and uint64_t.¶

While the XDR can be appended to that from [RFC7863], the various code snippets belong in their respective areas of that XDR.¶

4. Security Considerations

Clients MUST NOT make access decisions to uncacheable dirents, these decisions MUST be made by the server. With the uncacheable attribute, dirents can be annotated such that attributes can be presented to the user based on the server's decision.¶

5. IANA Considerations

There are no IANA considerations.¶

Author's Address