Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add smbclient.liststreams to enumerate ADS streams #294

Merged
merged 1 commit into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/smbclient/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
getxattr,
link,
listdir,
liststreams,
listxattr,
lstat,
makedirs,
Expand Down
46 changes: 46 additions & 0 deletions src/smbclient/_os.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Copyright: (c) 2019, Jordan Borean (@jborean93) <[email protected]>
# MIT License (see LICENSE or https://opensource.org/licenses/MIT)

from __future__ import annotations

import collections
import datetime
import errno
Expand Down Expand Up @@ -37,6 +39,7 @@
FileLinkInformation,
FileRenameInformation,
FileStandardInformation,
FileStreamInformation,
)
from smbprotocol.header import NtStatus
from smbprotocol.ioctl import (
Expand Down Expand Up @@ -102,6 +105,12 @@
)


class SMBFileStreamInformation(t.NamedTuple):
name: str
size: int
allocation_size: int


def is_remote_path(path: str) -> bool:
"""
Returns True iff the given path is a remote SMB path (rather than a local path).
Expand Down Expand Up @@ -1019,6 +1028,43 @@ def setxattr(path, attribute, value, flags=0, follow_symlinks=True, **kwargs):
set_info(transaction, ea_info)


def liststreams(path: str, follow_symlinks=True, **kwargs: t.Any) -> list[SMBFileStreamInformation]:
"""
Return a list of the alternative data streams on a path. Listed streams can
be opened by appending their name to the original path. An example call for
a file with a single extra stream may return:

```
[
SMBFileStreamInformation(name=':extra_stream:$DATA', size=8, allocation_size=8),
SMBFileStreamInformation(name='::$DATA', size=103472, allocation_size=131072),
]
```

:param path: The full UNC path to the file to get the list of streams for.
:param follow_symlinks: Whether to follow the symlink at path if encountered.
:param kwargs: Common SMB Session arguments for smbclient.
:return: List of streams on the file with each entry being a string.
"""

raw = SMBRawIO(
jborean93 marked this conversation as resolved.
Show resolved Hide resolved
path,
desired_access=FilePipePrinterAccessMask.FILE_READ_ATTRIBUTES,
create_options=0 if follow_symlinks else CreateOptions.FILE_OPEN_REPARSE_POINT,
mon marked this conversation as resolved.
Show resolved Hide resolved
**kwargs,
)

with SMBFileTransaction(raw) as transaction:
query_info(transaction, FileStreamInformation, output_buffer_length=MAX_PAYLOAD_SIZE)

return [
SMBFileStreamInformation(
s["stream_name"].get_value(), s["stream_size"].get_value(), s["stream_allocation_size"].get_value()
)
for s in transaction.results[0]
]


def _delete(raw_type, path, **kwargs):
# Ensures we delete the symlink (if present) and don't follow it down.
co = CreateOptions.FILE_OPEN_REPARSE_POINT
Expand Down
5 changes: 1 addition & 4 deletions tests/test_smbclient_os.py
Original file line number Diff line number Diff line change
Expand Up @@ -834,10 +834,7 @@ def test_open_file_with_ads(smb_share):

assert smbclient.listdir(smb_share) == ["file.txt"]

with smbclient.open_file(filename, buffering=0, mode="rb") as fd, SMBFileTransaction(fd) as trans:
query_info(trans, FileStreamInformation, output_buffer_length=1024)

actual = sorted([s["stream_name"].get_value() for s in trans.results[0]])
actual = sorted([s.name for s in smbclient.liststreams(filename)])
assert actual == ["::$DATA", ":ads:$DATA"]


Expand Down