2.5.5.3 List Files in a Shared Directory - Application

  • Article

This use case supports the Access a File in a Workgroup use case (section 2.5.1) and Access a File in a Domain use case (section 2.5.2).

Context of Use: To display a list of files and directories when the User has selected a share to enumerate.

Goal: To list files and directories in a shared directory.

Actors

  • Application

  • SMB File Service

  • File Client

Stakeholders

  • User

Preconditions

The User knows the path of the directory to enumerate.

Main Success Scenario

Trigger: The Application receives a request from the User to display a list of files and directories in a given network share directory.

  1. The Application directs the file client to invoke the procedure defined in the use case Open a File in an SMB File Share, on the specified directory path, and receives a handle to the network share directory.

  2. The Application uses the file client to contact the SMB File Service and uses the mechanisms as defined in [MS-SMB2] section 3.2.4.17 to enumerate the directory.

  3. The SMB File Service performs the action and returns the results to the Application in the form corresponding to the mechanism requested by the Application in step 2.

Post Condition

The files in a share directory are listed.

Extensions

  • If the communication channel cannot be established, or it becomes disconnected, the application can attempt to establish connection multiple times. Ultimately, the use case ends with failure.

Variation (a): Performing the operation using the protocol described in [MS-SMB]: All details identical to the use case described in this section except that the protocol described in [MS-SMB] section 3.2.4.6, is used instead of the protocol described in [MS-SMB2].

Variation (b): Performing the operation using the protocol described in [MS-CIFS]: All details identical to the use case described in this section except that the protocol described in [MS-CIFS] section 2.2.5 is used instead of the protocol described in [MS-SMB2].