Package com.tnsai.server.security

Record Class WorkspaceConfig

java.lang.Object
java.lang.Record
com.tnsai.server.security.WorkspaceConfig
public record WorkspaceConfig(List<Path> roots, int maxFileCount) extends Record
Workspace allowlist + caps for /api/index (TNS-302).

Every path supplied by a client is canonicalised (symlinks resolved) and checked against this allowlist before any file system walk. The default allowlist is the JVM's working directory (user.dir); custom roots can be supplied via roots(Path...) or the TNSAI_WORKSPACE_ROOT environment variable (PATH-separated by File.pathSeparator).

maxFileCount() caps the directory tree size that can be indexed in one call, preventing a malicious request from forcing the server to walk an entire disk.

  • Field Details

  • Constructor Details

    • WorkspaceConfig

      public WorkspaceConfig(List<Path> roots, int maxFileCount)
      Creates an instance of a WorkspaceConfig record class.
      Parameters:
      roots - the value for the roots record component
      maxFileCount - the value for the maxFileCount record component

  • Method Details

    • cwd

      public static WorkspaceConfig cwd()
      JVM working directory as the only root.

    • roots

      public static WorkspaceConfig roots(Path... roots)
      Custom roots; each is canonicalised to its absolute real path.

    • withMaxFileCount

      public WorkspaceConfig withMaxFileCount(int max)

    • fromEnv

      public static WorkspaceConfig fromEnv()
      Reads roots from TNSAI_WORKSPACE_ROOT (File.pathSeparator-separated). Falls back to cwd() when unset. Reads TNSAI_WORKSPACE_MAX_FILES for the cap; falls back to DEFAULT_MAX_FILES.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • roots

      public List<Path> roots()
      Returns the value of the roots record component.
      Returns:
      the value of the roots record component

    • maxFileCount

      public int maxFileCount()
      Returns the value of the maxFileCount record component.
      Returns:
      the value of the maxFileCount record component