{"library":"smbprotocol","title":"SMB Protocol Library","type":"library","description":"smbprotocol is a Python library designed to interact with servers using the SMB 2/3 Protocol. It provides low-level access to SMB operations, allowing for file and directory manipulation, session management, and authentication against SMB/CIFS shares. The current version is 1.16.1, and the project maintains an active release cadence with multiple updates per year.","language":"python","status":"active","last_verified":"Wed May 20","install":{"commands":["pip install smbprotocol"],"cli":null},"imports":["from smbprotocol.connection import Connection","from smbprotocol.session import Session","from smbprotocol.tree import TreeConnect","from smbprotocol.open import Open","from smbprotocol.file import FilePipe","from smbprotocol.file import CreateDisposition"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/jborean93/smbprotocol","docs":null,"changelog":null,"pypi":"https://pypi.org/project/smbprotocol/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import os\nfrom smbprotocol.connection import Connection\nfrom smbprotocol.session import Session\nfrom smbprotocol.tree import TreeConnect\nfrom smbprotocol.open import Open, CreateDisposition\n\n# Replace with your SMB server details\nSERVER_IP = os.environ.get('SMB_SERVER_IP', '127.0.0.1')\nUSERNAME = os.environ.get('SMB_USERNAME', 'guest')\nPASSWORD = os.environ.get('SMB_PASSWORD', '')\nSHARE_NAME = os.environ.get('SMB_SHARE_NAME', 'share') # e.g., 'myshare'\n\ndef list_share_contents():\n    connection = None\n    session = None\n    tree_connect = None\n    try:\n        print(f\"Connecting to {SERVER_IP}...\")\n        connection = Connection(SERVER_IP, port=445)\n        connection.connect()\n        print(\"Connection established.\")\n\n        print(f\"Authenticating as {USERNAME}...\")\n        session = Session(connection, USERNAME, PASSWORD)\n        session.connect()\n        print(\"Authentication successful.\")\n\n        print(f\"Connecting to share \\\\{SERVER_IP}\\{SHARE_NAME}...\")\n        # SMB paths use backslashes, but smbprotocol handles forward slashes too\n        tree_connect = TreeConnect(connection, session, f'\\\\\\\\{SERVER_IP}\\\\{SHARE_NAME}')\n        tree_connect.connect()\n        print(f\"Connected to share '{SHARE_NAME}'.\")\n\n        print(f\"Listing contents of '{SHARE_NAME}':\")\n        # Open the directory itself to enumerate its contents\n        dir_open = Open(tree_connect, '/*', CreateDisposition.FILE_OPEN, access_mask=0x80000000) # FILE_LIST_DIRECTORY\n        dir_open.create()\n\n        for entry in dir_open.query_directory():\n            print(f\"  - {entry.file_name}\")\n        dir_open.close()\n        \n    except Exception as e:\n        print(f\"An error occurred: {e}\")\n    finally:\n        if tree_connect:\n            print(\"Disconnecting from tree connect...\")\n            tree_connect.disconnect()\n        if session:\n            print(\"Logging off session...\")\n            session.logoff()\n        if connection:\n            print(\"Disconnecting connection...\")\n            connection.disconnect()\n        print(\"Cleanup complete.\")\n\nif __name__ == '__main__':\n    list_share_contents()","lang":"python","description":"This quickstart demonstrates how to establish a connection to an SMB server, authenticate a user, connect to a shared folder, and list its contents. It emphasizes the critical need to explicitly close all resources (Connection, Session, TreeConnect, Open objects) in a `finally` block to prevent resource leaks.","tag":null,"tag_description":null,"last_tested":"2026-04-24","results":[{"runtime":"python:3.10-alpine","exit_code":0},{"runtime":"python:3.10-slim","exit_code":0},{"runtime":"python:3.11-alpine","exit_code":0},{"runtime":"python:3.11-slim","exit_code":0},{"runtime":"python:3.12-alpine","exit_code":0},{"runtime":"python:3.12-slim","exit_code":0},{"runtime":"python:3.13-alpine","exit_code":0},{"runtime":"python:3.13-slim","exit_code":0},{"runtime":"python:3.9-alpine","exit_code":0},{"runtime":"python:3.9-slim","exit_code":0}]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-20","installed_version":"1.16.1","pypi_latest":"1.16.1","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":2.6,"avg_import_s":0.12,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.1,"mem_mb":4.7,"disk_size":"36.4M"},{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.1,"mem_mb":4.5,"disk_size":"35.3M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.8,"import_time_s":0.07,"mem_mb":4.7,"disk_size":"37M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.08,"mem_mb":4.5,"disk_size":"36M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.15,"mem_mb":5.1,"disk_size":"38.9M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.2,"mem_mb":4.9,"disk_size":"37.8M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.5,"import_time_s":0.13,"mem_mb":5.1,"disk_size":"39M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.19,"mem_mb":4.9,"disk_size":"38M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.13,"mem_mb":5,"disk_size":"30.6M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.14,"mem_mb":4.9,"disk_size":"29.5M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.3,"import_time_s":0.12,"mem_mb":5,"disk_size":"31M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.14,"mem_mb":4.9,"disk_size":"30M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.13,"mem_mb":5.4,"disk_size":"30.4M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.13,"mem_mb":5.2,"disk_size":"29.2M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.3,"import_time_s":0.13,"mem_mb":5.4,"disk_size":"31M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.18,"mem_mb":5.2,"disk_size":"30M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.09,"mem_mb":4.7,"disk_size":"36.6M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.1,"mem_mb":4.5,"disk_size":"35.6M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3.2,"import_time_s":0.1,"mem_mb":4.7,"disk_size":"37M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"smbprotocol","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.1,"mem_mb":4.5,"disk_size":"36M"}]}}