# Directory Leasing Feature - Detailed Design Document

## 1. Overview

Directory leasing extends the SMB3 lease concept to directories, enabling client-side caching of directory metadata and change notifications. This significantly improves performance for applications that frequently enumerate directories or monitor directory changes.

## 2. Protocol Specification Reference

- **MS-SMB2 Section 2.2.13.2.12**: SMB2_CREATE_REQUEST_LEASE_V2 for directories

   * specific length.
   *
   * <p>For example, if you need 1024-bit hash codes, you could join two {@link Hashing#sha512} hash
   * functions together: {@code Hashing.concatenating(Hashing.sha512(), Hashing.sha512())}.
   *
   * @since 19.0
   */
  public static HashFunction concatenating(
      HashFunction first, HashFunction second, HashFunction... rest) {

const (
	xMinIOHealing = ReservedMetadataPrefix + "healing"
	xMinIODataMov = ReservedMetadataPrefix + "data-mov"
)

// SetHealing marks object (version) as being healed.
// Note: this is to be used only from healObject
func (fi *FileInfo) SetHealing() {
	if fi.Metadata == nil {
		fi.Metadata = make(map[string]string)
	}
	fi.Metadata[xMinIOHealing] = "true"
}

import jcifs.internal.smb2.lease.Smb2LeaseState;

/**
 * Extension methods for SmbFile to support directory leasing functionality.
 *
 * This utility class provides static methods that enhance SmbFile operations with
 * directory leasing capabilities for improved performance through caching when
 * SMB3 directory leasing is available and enabled.
 */
public class SmbFileDirectoryLeasingExtension {

    /**

            assertEquals(0x1, Smb2Constants.SMB2_GLOBAL_CAP_DFS, "DFS capability must be 0x1");
        }

        @Test
        @DisplayName("Leasing capability should be 0x2")
        void testGlobalCapLeasing() {
            assertEquals(0x2, Smb2Constants.SMB2_GLOBAL_CAP_LEASING, "Leasing capability must be 0x2");
        }

        @Test
        @DisplayName("Large MTU capability should be 0x4")

        run: |
          sudo sysctl net.ipv6.conf.all.disable_ipv6=0
          sudo sysctl net.ipv6.conf.default.disable_ipv6=0
          make verify-healing
          make verify-healing-inconsistent-versions
          make verify-healing-with-root-disks

Brad Fitzpatrick <******@****.***> 1764180701 -0800

     * @return lease key
     */
    public Smb2LeaseKey requestDirectoryLease(String directoryPath, int requestedState, DirectoryCacheScope scope) {
        // Directory leasing requires SMB 3.0 or higher
        // MS-SMB2: Level 2 leasing (which includes directory leasing) is only supported in SMB 3.0+
        // We'll validate this when we actually need to use the session

        // Request base lease

     */
    public static final int SMB2_DIALECT_ANY = 0x02FF;

    /**
     * Server supports DFS
     */
    public static final int SMB2_GLOBAL_CAP_DFS = 0x1;

    /**
     * Server supports leasing
     */
    public static final int SMB2_GLOBAL_CAP_LEASING = 0x2;

    /**
     * Server supports multi-credit operations
     */
    public static final int SMB2_GLOBAL_CAP_LARGE_MTU = 0x4;

    /**

In GitHub, the template will guide you to write the right question so that you can more easily get a good answer, or even solve the problem yourself even before asking. And in GitHub I can make sure I always answer everything, even if it takes some time. I can't personally do that with the chat systems. 😅