[ { "path": ".gitignore", "content": "# Ignore per-file backup from text editors\n*~\n\n# For virtualenvs in development\n/venv2\n/venv3\n\n#\n# From https://github.com/github/gitignore/blob/master/Python.gitignore\n#\n\n# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\ncover/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\n.pybuilder/\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n# For a library or package, you might want to ignore these files since the code is\n# intended to run in multiple environments; otherwise, check them in:\n# .python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n# pytype static type analyzer\n.pytype/\n\n# Cython debug symbols\ncython_debug/\n\n### End of https://github.com/github/gitignore/blob/master/Python.gitignore\n" }, { "path": ".readthedocs.yaml", "content": "# Read the Docs configuration file for Sphinx projects\n# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details\n\n# Required\nversion: 2\n\n# Set the OS, Python version and other tools you might need\nbuild:\n os: ubuntu-22.04\n tools:\n python: \"3.12\"\n # You can also specify other tool versions:\n # nodejs: \"20\"\n # rust: \"1.70\"\n # golang: \"1.20\"\n\n# Build documentation in the \"docs/\" directory with Sphinx\nsphinx:\n configuration: sphinx/source/conf.py\n # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs\n # builder: \"dirhtml\"\n # Fail on all warnings to avoid broken references\n # fail_on_warning: true\n\n# Optionally build your docs in additional formats such as PDF and ePub\n# formats:\n# - pdf\n# - epub\n\n# Optional but recommended, declare the Python requirements required\n# to build your documentation\n# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html\npython:\n install:\n - requirements: sphinx/requirements.txt\n" }, { "path": "CHANGELOG", "content": "pysmb-1.2.13, 20 Sep 2025\n=========================\n\n- Fix type hinting issues on Python versions prior to 3.9. (#230)\n\npysmb-1.2.12, 19 Sep 2025\n=========================\n\n- Add support for NetBIOS packet polling on Linux (#229)\n\npysmb-1.2.11, 25 Mar 2025\n=========================\n\n- Fix out-of-memory issues during large file operations (due to accumulation of messages in message_history).\n\npysmb-1.2.10, 25 Sep 2024\n=========================\n\n- Fix a bug where the OperationFailure exceptions do not contain the error messages that were thrown when the exception occurred (#212)\n- Update test cases to replace SafeConfigParser with ConfigParser (#219)\n- Allow callers to override default tqdm kwargs (#222)\n\npysmb-1.2.9, 25 Dec 2022\n========================\n\n- Add support for tqdm progress display (#205)\n- Fix bug where timeout parameter was not passed to socket.createConnection() (#202)\n\npysmb-1.2.8, 12 Jun 2022\n========================\n\n- Fix issue with listPath based on recommendation in #195\n- Fix embedded MD4 algorithm\n- Add SMB UTF-16 surrogate exception workaround policy\n\npysmb-1.2.7, 30 May 2021\n========================\n\n- Fix compatibility issues on file retrievals with Likewise servers (#177)\n- Improve SMBConnection's connect() method to remove the need to provide sock_family\n parameter for IPv6 addresses in Python 3.x (#180)\n\npysmb-1.2.6, 9 Dec 2020\n=======================\n- Fix bug in SMB1 store file implmentation which generates SMB_COM_WRITE_ANDX\n packets larger than the allowed max buffer size (#175)\n\npysmb-1.2.5, 18 Oct 2020\n=======================\n- Fix bug in filename encoding which leads to failure for file retrieval and upload operations (#170 #171).\n- Improve resetFileAttributes() method in SMBConnection class to allow the\n new attribute to be specified in the reset operation (#172).\n\npysmb-1.2.4, 6 Oct 2020\n=======================\n- Remove dependency on pycrypto as it is no longer under active maintenance\n\npysmb-1.2.3, 6 Oct 2020\n=======================\n- Fix bug in session key generation during session negotiation (#166)\n- Fix bug in SMB message signing which leads to operation failures with Samba services.\n\npysmb-1.2.2, 5 Sep 2020\n=======================\n- Improve SMB URL handlers to support specifying server's machine name and IP\n address. (#162)\n- Improvements to documentation on SMB URLs (#160)\n\npysmb-1.2.1, 17 May 2020\n========================\n- Fix bug in deleteFiles() method which can fail for certain search patterns.\n\npysmb-1.2.0, 17 May 2020\n=========================\n- Add new parameter, delete_matching_folders, to deleteFiles() method to\n support deletion of child folders that match the search pattern.\n\npysmb-1.1.29, 16 May 2020\n=========================\n- Fix unhandled exception for short NBNS queries #149\n- Fix wildcard file deletion with servers on SMB2 protocol #33\n\npysmb-1.1.28, 23 Nov 2019\n========================\n- SharedFile instances returned from the listPath() method now has a new\n file_id attribute which represents the file reference number given by the SMB server.\n\npysmb-1.1.27, 9 Jan 2019\n========================\n- Remove support for SMB-2.1 dialect as it seems to have issues with Windows 2008 R2\n\npysmb-1.1.26, 5 Jan 2019\n========================\n- Prevents OperationError from being raised when listPath() operation does not\n return any matching file results.\n- SMBConnection is now a context manager #122.\n\npysmb-1.1.25, 28 July 2018\n========================\n- Fix buggy support for search parameter in listPath() method. Add\n SMB_FILE_ATTRIBUTE_INCL_NORMAL bit constant to include 'normal' files with\n other file types in the returned result. From now on, pysmb defines a 'normal' file\n as a file entry that is not read-only, not hidden, not system, not archive and\n not a directory; it ignores other attributes like compression, indexed, sparse,\n temporary and encryption. listPath() method will now include 'normal' files\n using the default search parameter.\n- Add isNormal property to SharedFile class to support test if the file is a\n 'normal' file (according to pysmb definition of 'normal' file).\n\npysmb-1.1.24, 19 July 2018\n========================\n- Improve listPath implementation for SMB1\n- Support for STATUS_PENDING responses across all SMB2 operations.\n\npysmb-1.1.23, 5 May 2018\n========================\n- Fix bug in listShares() method which fails when the remote server has many shares.\n- Improve echo() method to test and fail if the provided data to echo is not a bytes object.\n- Fix bug in listPath() method where the path to query is not properly terminated.\n\npysmb-1.1.22, 17 Sep 2017\n========================\n- Fix bug in getAttributes() method which should return only the filename\n instead of the entire path for the filename property for the return result.\n\npysmb-1.1.21, 9 Sep 2017\n========================\n- Fix bug where timestamp values for SMB1 getAttributes() response are not\n converted properly from FILETIME to epoch time values.\n\npysmb-1.1.20, 13 Aug 2017\n=========================\n- Add getSecurity() method to support security descriptors query via SMB2\n- Improve retrieveFile() and retrieveFileFromOffset() methods to allow file\n retrievals over SMB2 even when the file is being locked on the server.\n- Silently discards NMB SESSION_KEEPALIVE packets instead of raising warnings.\n- SMB sessionID will be sent in ECHO requests to conform to SMB2 specs.\n- Fix type errors for MD4 functions in python3.\n\npysmb-1.1.19, 13 Nov 2016\n=========================\n- Ignore STATUS_PENDING during delete and file store operations\n\npysmb-1.1.18, 9 Apr 2016\n========================\n\n- Rollback fixes to NTLMv2 response algorithm in pysmb 1.1.17. The fixes\n fail to work with some servers.\n- Add missing errno imports in SMBConnection.py\n- Fix UnboundLocalError raised when using type() in SMBConnection.py\n\npysmb-1.1.17, 11 Nov 2015\n=========================\n\n- Fix crashes in directory listing with keyerror 'support_dfs'\n- Fix bugs in NTLMv2 response algorithm.\n- Fix bugs where client domain is not included as part of the session negotiation.\n\npysmb-1.1.16, 10 May 2015\n=========================\n\n- Fix typo errors in authentication error messages\n- Improve share listings on SMB2 protocol by ignoring interim STATUS_PENDING responses.\n\npysmb-1.1.15, 15 Feb 2015\n=========================\n\n- Add new parameter to SMBConnection's storeFileFromOffset method to determine\n whether the remote file is to be truncated before writing.\n\npysmb-1.1.14, 1 Feb 2015\n========================\n\n- Add support for DFS shares in listPath()\n- Bug fix for python3's _listPath_SMB2 implementation\n\npysmb-1.1.13, 18 Oct 2014\n=========================\n\n- Add missing methods and improve compatibility with python3\n- Fix bug in SMB2 rename implementation which fails to rename directory\n\npysmb-1.1.12, 21 Sep 2014\n=========================\n\n- Fix syntax error for python3 NBNSProtocol implementation\n- Fix bug in SMB1 implementation which results in access denied errors with Samba 3.0\n\npysmb-1.1.11, 13 Sep 2014\n=========================\n\n- Add support for unicode characters in domain, username and password.\n- Add storeFileFromOffset method to SMB API\n- Fix bug in getAttributes implementation for SMB1\n- Fix bug for NMB which uses broadcast flag for unicast queries\n- Update the Tree Connect Andx request implementation to MS-SMB 2.2.4.7.1 extensions\n\npysmb-1.1.10, 29 Jun 2014\n=========================\n\n- Add getAttributes() method to SMBConnection and SMBProtocolFactory class\n- Add isReadOnly property to SharedFile class\n\npysmb-1.1.9, 1 Jun 2014\n=======================\n\n- Add support for domains in smb:// URLs\n- Fix a bug which fails to test for the correct GSS security provider OID values\n\npysmb-1.1.8, 21 Dec 2013\n========================\n\n- Fix a bug in storeFile() method when the destination file is not overwritten if\n it exists in SMB1 communication\n- Fix a SMB1 authentication problem when extended negotation is not carried out\n because the remote server has specified its support for extended security in the\n payload, instead of in the message flags2.\n\npysmb-1.1.7, 27 Sep 2013\n========================\n\n- Improve listShares() function which can fail with the listing response is\n separated into multiple SMB packets for large number of shares.\n- Fix bug in python3 implementation where session connection can fail when\n remote server supports message signing.\n\npysmb-1.1.6, 16 Aug 2013\n========================\n\n- Fix bug where the status of the SMB_COM_NEGOTIATE reply is not checked for error\n before allowing further processing.\n\npysmb-1.1.5, 19 June 2013\n=========================\n\n- Adds support for Direct hosting of SMB over TCP/IP (TCP port: 445)\n\npysmb-1.1.4, 31 May 2013\n========================\n\n- Improve query performance for query IP addresses for NetBIOS names in\n NetBIOSProtocol.py\n- Fix bugs in SMBConnection when sending large data packets can result in\n AssertionError.\n\npysmb-1.1.3, 18 Mar 2013\n========================\n\n- Fix bug which results in endless loop in SMBConnection when remote CIFS\n server closes the connection.\n\npysmb-1.1.2, 28 Sep 2012\n========================\n\n- Improve queryIPForName() in nmb.NetBIOS and nmb.NBNSProtocol class to\n return only server machine name and ignore workgroup names.\n\npysmb-1.1.1, 9 June 2012\n========================\n\n- Adds support for Python3. Noted that the Python3 SMB/NMB protocol implementations\n for Twisted are not well-tested as Twisted (as of v12.1) is not Python3 ready yet.\n- Adds support for retrieving list of shadow copies (also known as\n \"previous versions\" in Windows). Note that not all Windows editions support shadow\n copies.\n\n\npysmb-1.1.0, 1 June 2012\n========================\n\n- Adds SMB2 protocol implementation with signing for outgoing SMB2 messages.\n pysmb will utilize SMB2 protocol with servers that support SMB2\n (eg. Windows Vista, Windows 7 and Samba 3).\n If the remote server does not support SMB2, pysmb will fall back automatically\n to using SMB1 protocol.\n\n\npysmb-1.0.5, 7 May 2012\n=======================\n\n- Add supports for SMB message signing. pysmb will sign all SMB messages from\n the CIFS client to the server, but it does not verify the signatures of the\n SMB messages from the server.\n\n\npysmb-1.0.4, 1 May 2012\n=======================\n\n- Adds support for \"smb://\" URL in urllib2 python packages to retrieve or upload\n files from/to remote CIFS servers.\n- Improve documentation\n\n\npysmb-1.0.3, 28 April 2012\n===========================\n\n- Fix a crash in SMB._storFile() method which occurs when the remote CIFS server\n utilizes a max raw size larger than 65535 bytes. The bug was discovered with\n Windows 7 Pro SP1.\n- Fix a bug in SMB._listPath() method where the files/folders time information are\n not properly converted to Epoch time.\n- Add NBNSProtocol.queryIPForName() and NetBIOS.queryIPForName() methods to\n query for a machine's NetBIOS name at the given IP address.\n- Add SMBProtocol.retrieveFileFromOffset() and SMBConnection.retrieveFileFromOffset()\n methods for a finer control of file retrieval operation with read offset and write\n limits.\n\n\npysmb-1.0.2, 31 March 2012\n==========================\n\n- Fix a bug in SMB._handleSessionChallenge() method in base.py where the domain attribute\n was not used to generate the corresponding NTLM authentication packets, resulting in\n the default WORKGROUP domain for used for all subsequent authentications.\n\npysmb-1.0.1, 25 Jan 2012\n========================\n\n- Fixes a bug in listPath() method which causes directory listing for\n sub-directories to return an empty list.\n- Fixes an incorrect implementation of the TRANS2_FIND_FIRST2 and\n TRANS2_FIND_NEXT2 request/response handling which causes directory listing\n to crash when the remote directory contains a certain number of entries.\n\n\npysmb-1.0.0, 25 Dec 2011\n========================\n\n- Completely rewrites pysmb. API is not compatible with previous pysmb-0.x.x\n- Supports NTLMv1 and NTLMv2 authentication\n- Adds in NMB/SMB protocol implementation for use with Twisted framework\n- Tested with Windows XP SP3, Windows Vista, Windows 7 and Samba 3.x\n- Requires Python 2.4.4 or later, and pyasn1. Not tested with Python3\n\npysmb-0.4.5, 22 Jun 2009\n========================\n\n- Prevents pysmb from failing when there are too many files/folders to\n be returned in a single SMB TRANS2 call. pysmb will \"resume\" requesting\n for more files/folders information in subsequent SMB TRANS2 requests.\n\npysmb-0.4.4, 12 Jan 2004\n========================\n\n- Add in support for AMK's Python Cryptography Toolkit which will be used\n for DES password hashing. If AMK's pycrypto is found, it will be used\n instead of mxCrypto.\n\npysmb-0.4.3, 22 Feb 2003\n========================\n\n- Fix a bug which fails to close the socket in nmb.py on socket exception\n- Fix a bug which fails to close the NetBIOSSession in smb.py if the session\n has not been properly established yet.\n\npysmb-0.4.2, 03 Aug 2002\n========================\n\n- Add new methods to SharedFile instances, get_mtime_epoch, get_atime_epoch\n and get_ctime_epoch. These methods will return the mtime, atime and ctime in\n epoch time rather than SMB time.\n- Remove debugging printout in smb.py which has been released accidentally\n with the last release.\n- Fix a bug in smbcp which causes to local to remote copy to fail\n\npysmb-0.4.1, 22 Jun 2002\n========================\n\n- Fix a bug in smb.py which does not return the correct file size for files\n with their archive bits turned off. This results in these files not being\n retrieved or sent properly.\n- Fix some typo error in the documentations\n\npysmb-0.4.0, 17 Apr 2002\n========================\n\n- Use NT LM0.12 dialect.\n- New smb.SMBMachine class\n- Add SMB.get_server_domain(), smb.get_server_os(), SMB.get_server_lanman()\n\npysmb-0.3.1, 12 Nov 2001\n========================\n\n- Fix a problem with some Windows server where an UID is required when server is in share mode.\n Now, pysmb calls login() with empty authentication information when server is in share mode.\n- Add TYPE_DOMAIN_MASTER constant and description to nmb.py.\n\npysmb-0.3.0, 10 Nov 2001\n========================\n\n- Add support for services in share mode. Minor changes to smb.SMB class API.\n- Fix a bug in smb.py's __raw_retr_file which has failed to initialize the max_buf_size prior to usage.\n- Fix a bug in smblistshare which fails to print the correct NMB error message\n- Modify smb.py not throw AttributeError in the destructor when there is an error while creating a session\n in the constructor\n\npysmb-0.2.0, 04 Oct 2001\n========================\n\n- Add support for encrypted authentication using DES\n- Fix a bug(?) which treats all services and filenames as case-sensitive\n\npysmb-0.1.3, 03 Sep 2001\n========================\n\n- Fix a bug in smblistshare and smbdu which fails to catch the nmb.NetBIOSError raised when session\n setup fails.\n- Fix a bug in smb.SMB that arises from the change in nmb.NetBIOSSession which sends\n the session port number as the remote host type.\n\npysmb-0.1.2, 01 Sep 2001\n========================\n\n- Fix a bug in nmb.NetBIOSSession which specifies a TYPE_WORKSTATION for remote host instead of TYPE_SERVER.\n- Minor change to nmb.NetBIOSSession constructor API.\n- Fix a bug in smbdu which raises OverflowError when printing long file size values.\n- Fix a bug in smbcp which does not handle the destination path correctly when\n the source file is copied to a different filename.\n\npysmb-0.1.1, 25 Aug 2001\n========================\n\n- Change nmb's NetBIOS and NetBIOSSession class such that they raise a NetBIOSError\n with a tuple of ( err_msg, err_class, err_code )\n- Add a function strerror() in both smb and nmb to return human readable messages\n for error codes.\n- Fix a bug in smbcp which fails to print an error message and terminate when the\n remote source path is not found.\n- Add in another utility, smblistshare.\n\npysmb-0.1.0, 20 Aug 2001\n========================\n\n- First public release\n" }, { "path": "LICENSE", "content": "\nCopyright (C) 2001-2025 Michael Teo \n\nThis software is provided 'as-is', without any express or implied warranty.\nIn no event will the author be held liable for any damages arising from the\nuse of this software.\n\nPermission is granted to anyone to use this software for any purpose,\nincluding commercial applications, and to alter it and redistribute it\nfreely, subject to the following restrictions:\n\n1. The origin of this software must not be misrepresented; you must not\n claim that you wrote the original software. If you use this software\n in a product, an acknowledgment in the product documentation would be\n appreciated but is not required.\n\n2. Altered source versions must be plainly marked as such, and must not be\n misrepresented as being the original software.\n\n3. This notice cannot be removed or altered from any source distribution.\n" }, { "path": "MANIFEST.in", "content": "include LICENSE\ninclude CHANGELOG\nrecursive-include python2 *\nrecursive-exclude python2 *.pyc\nrecursive-exclude python2 *~\nrecursive-include python3 *\nrecursive-exclude python3 *.pyc\nrecursive-exclude python3 *~\nrecursive-include sphinx *\nrecursive-include docs *\nrecursive-exclude docs *.zip\n" }, { "path": "README.md", "content": "pysmb\n=====\n\npysmb is an experimental SMB/CIFS library written in Python. It implements the client-side SMB/CIFS protocol (SMB1 and SMB2) which allows your Python application to access and transfer files to/from SMB/CIFS shared folders like your Windows file sharing and Samba folders.\n\n* Primary Project Website: https://miketeo.net/blog/projects/pysmb\n* Documentation: http://pysmb.readthedocs.io/\n* Issue Tracker: Please use the [issue tracker on github](https://github.com/miketeo/pysmb/issues).\n" }, { "path": "README.txt", "content": "pysmb is an experimental SMB/CIFS library written in Python.\nIt implements the client-side SMB/CIFS protocol (SMB1 and SMB2) which allows your Python application to access\nand transfer files to/from SMB/CIFS shared folders like your Windows file sharing and Samba folders.\n" }, { "path": "docs/html/.buildinfo", "content": "# Sphinx build info version 1\n# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.\nconfig: 02747f6883e56a04531aef4d47846d2a\ntags: 645f666f9bcd5a90fca523b33c5a78b7\n" }, { "path": "docs/html/_modules/index.html", "content": "\n\n\n \n \n \n Overview: module code — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

All modules for which code is available

\n\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/_modules/nmb/NetBIOS.html", "content": "\n\n\n \n \n \n nmb.NetBIOS — pysmb 1.2.12 documentation\n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Source code for nmb.NetBIOS

\n\nimport os, logging, random, socket, time, select\nfrom .base import NBNS, NotConnectedError\nfrom .nmb_constants import TYPE_CLIENT, TYPE_SERVER, TYPE_WORKSTATION\n\n
\n[docs]\nclass NetBIOS(NBNS):\n\n    log = logging.getLogger('NMB.NetBIOS')\n\n
\n[docs]\n    def __init__(self, broadcast = True, listen_port = 0):\n        """\n        Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.\n\n        :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode\n        :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.\n        """\n        self.broadcast = broadcast\n        self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)\n        if self.broadcast:\n            self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)\n        if listen_port:\n            self.sock.bind(( '', listen_port ))
\n\n\n
\n[docs]\n    def close(self):\n        """\n        Close the underlying and free resources.\n\n        The NetBIOS instance should not be used to perform any operations after this method returns.\n\n        :return: None\n        """\n        self.sock.close()\n        self.sock = None
\n\n\n    def write(self, data, ip, port):\n        assert self.sock, 'Socket is already closed'\n        self.sock.sendto(data, ( ip, port ))\n\n
\n[docs]\n    def queryName(self, name, ip = '', port = 137, timeout = 30):\n        """\n        Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.\n\n        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n        :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n        :return: A list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). On timeout, returns None.\n        """\n        assert self.sock, 'Socket is already closed'\n\n        trn_id = random.randint(1, 0xFFFF)\n        data = self.prepareNameQuery(trn_id, name)\n        if self.broadcast and not ip:\n            ip = '<broadcast>'\n        elif not ip:\n            self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')\n\n        self.write(data, ip, port)\n\n        return self._pollForNetBIOSPacket(trn_id, timeout)
\n\n\n
\n[docs]\n    def queryIPForName(self, ip, port = 137, timeout = 30):\n        """\n        Send a query to the machine with *ip* and hopes that the machine will reply back with its name.\n\n        The implementation of this function is contributed by Jason Anderson.\n\n        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n        :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n        :return: A list of string containing the names of the machine at *ip*. On timeout, returns None.\n        """\n        assert self.sock, 'Socket is already closed'\n\n        trn_id = random.randint(1, 0xFFFF)\n        data = self.prepareNetNameQuery(trn_id, False)\n        self.write(data, ip, port)\n        ret = self._pollForQueryPacket(trn_id, timeout)\n        if ret:\n            return list(map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret)))\n        else:\n            return None
\n\n\n    #\n    # Protected Methods\n    #\n\n    def _pollForNetBIOSPacket(self, wait_trn_id, timeout):\n        end_time = time.time() - timeout\n        while True:\n            try:\n                _timeout = time.time()-end_time\n                if _timeout <= 0:\n                    return None\n\n                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)\n                if not ready:\n                    return None\n\n                data, _ = self.sock.recvfrom(0xFFFF)\n                if len(data) == 0:\n                    raise NotConnectedError\n\n                trn_id, ret = self.decodePacket(data)\n\n                if trn_id == wait_trn_id:\n                    return ret\n            except select.error as ex:\n                if type(ex) is tuple:\n                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n                        raise ex\n                else:\n                    raise ex\n\n    #\n    # Contributed by Jason Anderson\n    #\n    def _pollForQueryPacket(self, wait_trn_id, timeout):\n        end_time = time.time() - timeout\n        while True:\n            try:\n                _timeout = time.time()-end_time\n                if _timeout <= 0:\n                    return None\n\n                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)\n                if not ready:\n                    return None\n\n                data, _ = self.sock.recvfrom(0xFFFF)\n                if len(data) == 0:\n                    raise NotConnectedError\n\n                trn_id, ret = self.decodeIPQueryPacket(data)\n\n                if trn_id == wait_trn_id:\n                    return ret\n            except select.error as ex:\n                if type(ex) is tuple:\n                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n                        raise ex\n                else:\n                    raise ex
\n\n
\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/_modules/nmb/NetBIOSProtocol.html", "content": "\n\n\n\n \n \n \n nmb.NetBIOSProtocol — pysmb 1.2.7 documentation\n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Source code for nmb.NetBIOSProtocol

\n\nimport os, logging, random, socket, time\nfrom twisted.internet import reactor, defer\nfrom twisted.internet.protocol import DatagramProtocol\nfrom .base import NBNS\n\n
[docs]class NetBIOSTimeout(Exception):\n    """Raised in NBNSProtocol via Deferred.errback method when queryName method has timeout waiting for reply"""\n    pass
\n\n
[docs]class NBNSProtocol(DatagramProtocol, NBNS):\n\n    log = logging.getLogger('NMB.NBNSProtocol')\n\n
[docs]    def __init__(self, broadcast = True, listen_port = 0):\n        """\n        Instantiate a NBNSProtocol instance.\n\n        This automatically calls reactor.listenUDP method to start listening for incoming packets, so you **must not** call the listenUDP method again.\n\n        :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode\n        :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.\n        """\n        self.broadcast = broadcast\n        self.pending_trns = { }  # TRN ID -> ( expiry_time, name, Deferred instance )\n        self.transport = reactor.listenUDP(listen_port, self)\n        if self.broadcast:\n            self.transport.getHandle().setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)\n        reactor.callLater(1, self.cleanupPendingTrns)
\n\n
[docs]    def datagramReceived(self, data, from_info):\n        host, port = from_info\n        trn_id, ret = self.decodePacket(data)\n\n        # pending transaction exists for trn_id - handle it and remove from queue\n        if trn_id in self.pending_trns:\n            _, ip, d = self.pending_trns.pop(trn_id)\n            if ip is NAME_QUERY:\n                # decode as query packet\n                trn_id, ret = self.decodeIPQueryPacket(data)\n            d.callback(ret)
\n\n    def write(self, data, ip, port):\n        # We don't use the transport.write method directly as it keeps raising DeprecationWarning for ip='<broadcast>'\n        self.transport.getHandle().sendto(data, ( ip, port ))\n\n
[docs]    def queryName(self, name, ip = '', port = 137, timeout = 30):\n        """\n        Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.\n\n        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n        :param integer/float timeout: Number of seconds to wait for a reply, after which the returned Deferred instance will be called with a NetBIOSTimeout exception.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of IP addresses in dotted notation (aaa.bbb.ccc.ddd).\n                 On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception\n        """\n        trn_id = random.randint(1, 0xFFFF)\n        while True:\n            if trn_id not in self.pending_trns:\n                break\n            else:\n                trn_id = (trn_id + 1) & 0xFFFF\n\n        data = self.prepareNameQuery(trn_id, name)\n        if self.broadcast and not ip:\n            ip = '<broadcast>'\n        elif not ip:\n            self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')\n\n        self.write(data, ip, port)\n\n        d = defer.Deferred()\n        self.pending_trns[trn_id] = ( time.time()+timeout, name, d )\n        return d
\n\n
[docs]    def queryIPForName(self, ip, port = 137, timeout = 30):\n        """\n        Send a query to the machine with *ip* and hopes that the machine will reply back with its name.\n\n        The implementation of this function is contributed by Jason Anderson.\n\n        :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n                          If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n        :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n        :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of names of the machine at *ip*.\n                 On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception\n        """\n        trn_id = random.randint(1, 0xFFFF)\n        while True:\n            if trn_id not in self.pending_trns:\n                break\n            else:\n                trn_id = (trn_id + 1) & 0xFFFF\n\n        data = self.prepareNetNameQuery(trn_id)\n        self.write(data, ip, port)\n\n        d = defer.Deferred()\n        d2 = defer.Deferred()\n        d2.addErrback(d.errback)\n\n        def stripCode(ret):\n            if ret is not None: # got valid response. Somehow the callback is also called when there is an error.\n                d.callback(map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret)))\n\n        d2.addCallback(stripCode)\n        self.pending_trns[trn_id] = ( time.time()+timeout, NAME_QUERY, d2 )\n        return d
\n\n
[docs]    def stopProtocol(self):\n        DatagramProtocol.stopProtocol(self)
\n\n    def cleanupPendingTrns(self):\n        now = time.time()\n\n        # reply should have been received in the past\n        # info is tuple of ( expiry_time, name, d )\n        expired = filter(lambda trn_id, info: info[0] < now, self.pending_trns.iteritems())\n\n        # remove expired items from dict + call errback\n        def expire_item(item):\n            trn_id, (expiry_time, name, d) = item\n\n            del self.pending_trns[trn_id]\n            try:\n                d.errback(NetBIOSTimeout(name))\n            except: pass\n\n        map(expire_item, expired)\n\n        if self.transport:\n            reactor.callLater(1, self.cleanupPendingTrns)
\n
\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2021, Michael Teo https://miketeo.net/.\n Created using Sphinx 3.4.3.\n
\n \n" }, { "path": "docs/html/_modules/smb/SMBConnection.html", "content": "\n\n\n\n \n \n \n smb.SMBConnection — pysmb 1.2.9 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Source code for smb.SMBConnection

\n\nimport os, logging, select, socket, types, struct, errno\n\nfrom tqdm import tqdm\nfrom .smb_constants import *\nfrom .smb_structs import *\nfrom .base import SMB, NotConnectedError, NotReadyError, SMBTimeout\n\n\n
[docs]class SMBConnection(SMB):\n\n    log = logging.getLogger('SMB.SMBConnection')\n\n    #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n    SIGN_NEVER = 0\n    #: SMB messages will be signed when remote server supports signing but not requires signing.\n    SIGN_WHEN_SUPPORTED = 1\n    #: SMB messages will only be signed when remote server requires signing.\n    SIGN_WHEN_REQUIRED = 2\n\n
[docs]    def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n        """\n        Create a new SMBConnection instance.\n\n        *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.\n        *password* can be a string or a callable returning a string.\n        File operations can only be proceeded after the connection has been authenticated successfully.\n\n        Note that you need to call *connect* method to actually establish the SMB connection to the remote server and perform authentication.\n\n        The default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.\n        Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.\n\n        :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.\n                               You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\\\\/:*?";|+``\n        :param string remote_name: The NetBIOS machine name of the remote server.\n                                   On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties".\n                                   This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.\n        :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.\n        :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.\n                                    The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.\n                                    Hence, we can only "guess" or try both algorithms.\n                                    On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.\n        :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.\n                                 If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.\n                                 If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.\n                                 If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n        :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.\n                                      The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).\n        """\n        SMB.__init__(self, username, password, my_name, remote_name, domain, use_ntlm_v2, sign_options, is_direct_tcp)\n        self.sock = None\n        self.auth_result = None\n        self.is_busy = False\n        self.is_direct_tcp = is_direct_tcp
\n\n    #\n    # SMB (and its superclass) Methods\n    #\n\n    def onAuthOK(self):\n        self.auth_result = True\n\n    def onAuthFailed(self):\n        self.auth_result = False\n\n    def write(self, data):\n        assert self.sock\n        data_len = len(data)\n        total_sent = 0\n        while total_sent < data_len:\n            sent = self.sock.send(data[total_sent:])\n            if sent == 0:\n                raise NotConnectedError('Server disconnected')\n            total_sent = total_sent + sent\n\n    #\n    # Support for "with" context\n    #\n    def __enter__(self):\n        return self\n\n    def __exit__(self, *args):\n        self.close()\n\n    #\n    # Misc Properties\n    #\n\n    @property\n    def isUsingSMB2(self):\n        """A convenient property to return True if the underlying SMB connection is using SMB2 protocol."""\n        return self.is_using_smb2\n\n\n    #\n    # Public Methods\n    #\n\n
[docs]    def connect(self, ip, port = 139, sock_family = None, timeout = 60):\n        """\n        Establish the SMB connection to the remote SMB/CIFS server.\n\n        You must call this method before attempting any of the file operations with the remote server.\n        This method will block until the SMB connection has attempted at least one authentication.\n\n        :param port: Defaults to 139. If you are using direct TCP mode (is_direct_tcp=true when creating this SMBConnection instance), use 445.\n        :param sock_family: In Python 3.x, use *None* as we can infer the socket family from the provided *ip*. In Python 2.x, it must be either *socket.AF_INET* or *socket.AF_INET6*.\n        :return: A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise.\n        """\n        if self.sock:\n            self.sock.close()\n\n        self.auth_result = None\n        if sock_family:\n            self.sock = socket.socket(sock_family)\n            self.sock.settimeout(timeout)\n            self.sock.connect(( ip, port ))\n        else:\n            self.sock = socket.create_connection(( ip, port ))\n\n        self.is_busy = True\n        try:\n            if not self.is_direct_tcp:\n                self.requestNMBSession()\n            else:\n                self.onNMBSessionOK()\n            while self.auth_result is None:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return self.auth_result
\n\n
[docs]    def close(self):\n        """\n        Terminate the SMB connection (if it has been started) and release any sources held by the underlying socket.\n        """\n        if self.sock:\n            self.sock.close()\n            self.sock = None
\n\n
[docs]    def listShares(self, timeout = 30):\n        """\n        Retrieve a list of shared resources on remote server.\n\n        :return: A list of :doc:`smb.base.SharedDevice<smb_SharedDevice>` instances describing the shared resource\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(entries):\n            self.is_busy = False\n            results.extend(entries)\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._listShares(cb, eb, timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results
\n\n
[docs]    def listPath(self, service_name, path,\n                 search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL,\n                 pattern = '*', timeout = 30):\n        """\n        Retrieve a directory listing of files/folders at *path*\n\n        For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n        It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n\n        Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),\n        system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files\n        and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).\n        If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.\n        SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.\n        :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).\n        :param string/unicode pattern: the filter to apply to the results before returning to the client.\n        :return: A list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances.\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(entries):\n            self.is_busy = False\n            results.extend(entries)\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._listPath(service_name, path, cb, eb, search = search, pattern = pattern, timeout = timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results
\n\n
[docs]    def listSnapshots(self, service_name, path, timeout = 30):\n        """\n        Retrieve a list of available snapshots (shadow copies) for *path*.\n\n        Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots\n        :return: A list of python *datetime.DateTime* instances in GMT/UTC time zone\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(entries):\n            self.is_busy = False\n            results.extend(entries)\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._listSnapshots(service_name, path, cb, eb, timeout = timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results
\n\n
[docs]    def getAttributes(self, service_name, path, timeout = 30):\n        """\n        Retrieve information about the file at *path* on the *service_name*.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.\n        :return: A :doc:`smb.base.SharedFile<smb_SharedFile>` instance containing the attributes of the file.\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(info):\n            self.is_busy = False\n            results.append(info)\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._getAttributes(service_name, path, cb, eb, timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results[0]
\n\n
[docs]    def getSecurity(self, service_name, path, timeout = 30):\n        """\n        Retrieve the security descriptor of the file at *path* on the *service_name*.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.\n        :return: A :class:`smb.security_descriptors.SecurityDescriptor` instance containing the security information of the file.\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(info):\n            self.is_busy = False\n            results.append(info)\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._getSecurity(service_name, path, cb, eb, timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results[0]
\n\n
[docs]    def retrieveFile(self, service_name, path, file_obj, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n        """\n        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n        Use *retrieveFileFromOffset()* method if you wish to specify the offset to read from the remote *path* and/or the number of bytes to write to the *file_obj*.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.\n        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n        :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n        :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).\n                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n        """\n        return self.retrieveFileFromOffset(service_name, path, file_obj, 0, -1, timeout, show_progress = show_progress, tqdm_kwargs = tqdm_kwargs)
\n\n
[docs]    def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0, max_length = -1, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n        """\n        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.\n        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* up to *max_length* number of bytes. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n        :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.\n        :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.\n                                        If zero, the method returns immediately after the file is opened successfully for reading.\n        :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n        :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).\n                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(r):\n            self.is_busy = False\n            results.append(r[1:])\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        \n        try:\n            self._retrieveFileFromOffset(service_name, path, file_obj, cb, eb, offset, max_length, timeout = timeout, show_progress=show_progress, tqdm_kwargs=tqdm_kwargs)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results[0]
\n\n
[docs]    def storeFile(self, service_name, path, file_obj, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n        """\n        Store the contents of the *file_obj* at *path* on the *service_name*.\n        If the file already exists on the remote server, it will be truncated and overwritten.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.\n                                    If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure<smb_exceptions>` will be raised.\n        :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF. In Python3, this file-like object must have a *read* method which returns a bytes parameter.\n        :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n        :return: Number of bytes uploaded\n        """\n        return self.storeFileFromOffset(service_name, path, file_obj, 0, True, timeout, show_progress = show_progress, tqdm_kwargs = tqdm_kwargs)
\n\n
[docs]    def storeFileFromOffset(self, service_name, path, file_obj, offset = 0, truncate = False, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n        """\n        Store the contents of the *file_obj* at *path* on the *service_name*.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created.\n                                    If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure<smb_exceptions>` will be raised.\n        :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.\n        :param offset: Long integer value which specifies the offset in the remote server to start writing. First byte of the file is 0.\n        :param truncate: Boolean value. If True and the file exists on the remote server, it will be truncated first before writing. Default is False.\n        :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n        :return: the file position where the next byte will be written.\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(r):\n            self.is_busy = False\n            results.append(r[1])\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._storeFileFromOffset(service_name, path, file_obj, cb, eb, offset, truncate = truncate, timeout = timeout, show_progress=show_progress, tqdm_kwargs=tqdm_kwargs)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results[0]
\n\n
[docs]    def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30):\n        """\n        Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.\n\n        If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n                                                 Wildcards may be used in th filename component of the path.\n                                                 If your path/filename contains non-English characters, you must pass in an unicode string.\n        :return: None\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        def cb(r):\n            self.is_busy = False\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._deleteFiles(service_name, path_file_pattern, delete_matching_folders, cb, eb, timeout = timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False
\n\n
[docs]    def resetFileAttributes(self, service_name, path_file_pattern, file_attributes = ATTR_NORMAL, timeout = 30):\n        """\n        Reset file attributes of one or more regular files or folders.\n        It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request.\n        This function is very helpful when deleting files/folders that are read-only.\n        By default, it sets the ATTR_NORMAL flag, therefore clearing all other flags.\n        (See https://msdn.microsoft.com/en-us/library/cc232110.aspx for further information)\n\n        Note: this function is currently only implemented for SMB2!\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n                                                 Wildcards may be used in the filename component of the path.\n                                                 If your path/filename contains non-English characters, you must pass in an unicode string.\n        :param int file_attributes: The desired file attributes to set. Defaults to `ATTR_NORMAL`.\n        :return: None\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        def cb(r):\n            self.is_busy = False\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._resetFileAttributes(service_name, path_file_pattern, cb, eb, file_attributes, timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False
\n\n
[docs]    def createDirectory(self, service_name, path, timeout = 30):\n        """\n        Creates a new directory *path* on the *service_name*.\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param string/unicode path: The path of the new folder (relative to) the shared folder.\n                                    If the path contains non-English characters, an unicode string must be used to pass in the path.\n        :return: None\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        def cb(r):\n            self.is_busy = False\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._createDirectory(service_name, path, cb, eb, timeout = timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False
\n\n
[docs]    def deleteDirectory(self, service_name, path, timeout = 30):\n        """\n        Delete the empty folder at *path* on *service_name*\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.\n                                    If the path contains non-English characters, an unicode string must be used to pass in the path.\n        :return: None\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        def cb(r):\n            self.is_busy = False\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._deleteDirectory(service_name, path, cb, eb, timeout = timeout)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False
\n\n
[docs]    def rename(self, service_name, old_path, new_path, timeout = 30):\n        """\n        Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders\n\n        *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.\n        If the path contains non-English characters, an unicode string must be used to pass in the path.\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :return: None\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        def cb(r):\n            self.is_busy = False\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._rename(service_name, old_path, new_path, cb, eb)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False
\n\n
[docs]    def echo(self, data, timeout = 10):\n        """\n        Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.\n\n        :param bytes data: Data to send to the remote server. Must be a bytes object.\n        :return: The *data* parameter\n        """\n        if not self.sock:\n            raise NotConnectedError('Not connected to server')\n\n        results = [ ]\n\n        def cb(r):\n            self.is_busy = False\n            results.append(r)\n\n        def eb(failure):\n            self.is_busy = False\n            raise failure\n\n        self.is_busy = True\n        try:\n            self._echo(data, cb, eb)\n            while self.is_busy:\n                self._pollForNetBIOSPacket(timeout)\n        finally:\n            self.is_busy = False\n\n        return results[0]
\n\n    #\n    # Protected Methods\n    #\n\n    def _pollForNetBIOSPacket(self, timeout):\n        expiry_time = time.time() + timeout\n        read_len = 4\n        data = b''\n\n        while read_len > 0:\n            try:\n                if expiry_time < time.time():\n                    raise SMBTimeout\n\n                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], timeout)\n                if not ready:\n                    raise SMBTimeout\n\n                d = self.sock.recv(read_len)\n                if len(d) == 0:\n                    raise NotConnectedError\n\n                data = data + d\n                read_len -= len(d)\n            except select.error as ex:\n                if isinstance(ex, tuple):\n                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n                        raise ex\n                else:\n                    raise ex\n\n        type, flags, length = struct.unpack('>BBH', data)\n        if flags & 0x01:\n            length = length | 0x10000\n\n        read_len = length\n        while read_len > 0:\n            try:\n                if expiry_time < time.time():\n                    raise SMBTimeout\n\n                ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], timeout)\n                if not ready:\n                    raise SMBTimeout\n\n                d = self.sock.recv(read_len)\n                if len(d) == 0:\n                    raise NotConnectedError\n\n                data = data + d\n                read_len -= len(d)\n            except select.error as ex:\n                if isinstance(ex, tuple):\n                    if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n                        raise ex\n                else:\n                    raise ex\n\n        self.feedData(data)
\n
\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2021, Michael Teo https://miketeo.net/.\n Created using Sphinx 5.0.1.\n
\n \n" }, { "path": "docs/html/_modules/smb/SMBProtocol.html", "content": "\n\n\n\n \n \n \n smb.SMBProtocol — pysmb 1.2.7 documentation\n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Source code for smb.SMBProtocol

\n\nimport os, logging, time\nfrom twisted.internet import reactor, defer\nfrom twisted.internet.protocol import ClientFactory, Protocol\nfrom .smb_constants import *\nfrom .smb_structs import *\nfrom .base import SMB, NotConnectedError, NotReadyError, SMBTimeout\n\n\n__all__ = [ 'SMBProtocolFactory', 'NotConnectedError', 'NotReadyError' ]\n\n\nclass SMBProtocol(Protocol, SMB):\n\n    log = logging.getLogger('SMB.SMBProtocol')\n\n    #\n    # Protocol Methods\n    #\n\n    def connectionMade(self):\n        self.factory.instance = self\n        if not self.is_direct_tcp:\n            self.requestNMBSession()\n        else:\n            self.onNMBSessionOK()\n\n\n    def connectionLost(self, reason):\n        if self.factory.instance == self:\n            self.instance = None\n\n    def dataReceived(self, data):\n        self.feedData(data)\n\n    #\n    # SMB (and its superclass) Methods\n    #\n\n    def write(self, data):\n        self.transport.write(data)\n\n    def onAuthOK(self):\n        if self.factory.instance == self:\n            self.factory.onAuthOK()\n            reactor.callLater(1, self._cleanupPendingRequests)\n\n    def onAuthFailed(self):\n        if self.factory.instance == self:\n            self.factory.onAuthFailed()\n\n    def onNMBSessionFailed(self):\n        self.log.error('Cannot establish NetBIOS session. You might have provided a wrong remote_name')\n\n    #\n    # Protected Methods\n    #\n\n    def _cleanupPendingRequests(self):\n        if self.factory.instance == self:\n            now = time.time()\n            to_remove = []\n            for mid, r in self.pending_requests.items():\n                if r.expiry_time < now:\n                    try:\n                        r.errback(SMBTimeout())\n                    except Exception: pass\n                    to_remove.append(mid)\n\n            for mid in to_remove:\n                del self.pending_requests[mid]\n\n            reactor.callLater(1, self._cleanupPendingRequests)\n\n\n
[docs]class SMBProtocolFactory(ClientFactory):\n\n    protocol = SMBProtocol\n    log = logging.getLogger('SMB.SMBFactory')\n\n    #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n    SIGN_NEVER = 0\n    #: SMB messages will be signed when remote server supports signing but not requires signing.\n    SIGN_WHEN_SUPPORTED = 1\n    #: SMB messages will only be signed when remote server requires signing.\n    SIGN_WHEN_REQUIRED = 2\n\n
[docs]    def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n        """\n        Create a new SMBProtocolFactory instance. You will pass this instance to *reactor.connectTCP()* which will then instantiate the TCP connection to the remote SMB/CIFS server.\n        Note that the default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.\n        Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.\n\n        *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.\n        File operations can only be proceeded after the connection has been authenticated successfully.\n\n        :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.\n                               You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\\/:*?";|+``\n        :param string remote_name: The NetBIOS machine name of the remote server.\n                                   On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties".\n                                   This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.\n        :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.\n        :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.\n                                    The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.\n                                    Hence, we can only "guess" or try both algorithms.\n                                    On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.\n        :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.\n                                 If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.\n                                 If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.\n                                 If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n        :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.\n                                      The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).\n        """\n        self.username = username\n        self.password = password\n        self.my_name = my_name\n        self.remote_name = remote_name\n        self.domain = domain\n        self.use_ntlm_v2 = use_ntlm_v2\n        self.sign_options = sign_options\n        self.is_direct_tcp = is_direct_tcp\n        self.instance = None    #: The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.
\n\n    #\n    # Public Property\n    #\n\n    @property\n    def isReady(self):\n        """A convenient property to return True if the underlying SMB connection has connected to remote server, has successfully authenticated itself and is ready for file operations."""\n        return bool(self.instance and self.instance.has_authenticated)\n\n    @property\n    def isUsingSMB2(self):\n        """A convenient property to return True if the underlying SMB connection is using SMB2 protocol."""\n        return self.instance and self.instance.is_using_smb2\n\n    #\n    # Public Methods for Callbacks\n    #\n\n
[docs]    def onAuthOK(self):\n        """\n        Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.\n        This method will be called when the server has replied that the SMB connection has been successfully authenticated.\n        File operations can proceed when this method has been called.\n        """\n        pass
\n\n
[docs]    def onAuthFailed(self):\n        """\n        Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.\n        This method will be called when the server has replied that the SMB connection has been successfully authenticated.\n\n        If you want to retry authenticating from this method,\n         1. Disconnect the underlying SMB connection (call ``self.instance.transport.loseConnection()``)\n         2. Create a new SMBProtocolFactory subclass instance with different user credientials or different NTLM algorithm flag.\n         3. Call ``reactor.connectTCP`` with the new instance to re-establish the SMB connection\n        """\n        pass
\n\n    #\n    # Public Methods\n    #\n\n
[docs]    def listShares(self, timeout = 30):\n        """\n        Retrieve a list of shared resources on remote server.\n\n        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedDevice<smb_SharedDevice>` instances.\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._listShares(d.callback, d.errback, timeout)\n        return d
\n\n
[docs]    def listPath(self, service_name, path,\n                 search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL,\n                 pattern = '*', timeout = 30):\n        """\n        Retrieve a directory listing of files/folders at *path*\n\n        For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n        It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n\n        Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),\n        system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files\n        and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).\n        If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.\n        SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.\n        :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).\n        :param string/unicode pattern: the filter to apply to the results before returning to the client.\n        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances.\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._listPath(service_name, path, d.callback, d.errback, search = search, pattern = pattern, timeout = timeout)\n        return d
\n\n
[docs]    def listSnapshots(self, service_name, path, timeout = 30):\n        """\n        Retrieve a list of available snapshots (a.k.a. shadow copies) for *path*.\n\n        Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of python *datetime.DateTime*\n                 instances in GMT/UTC time zone\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._listSnapshots(service_name, path, d.callback, d.errback, timeout = timeout)\n        return d
\n\n
[docs]    def getAttributes(self, service_name, path, timeout = 30):\n        """\n        Retrieve information about the file at *path* on the *service_name*.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be raised.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a :doc:`smb.base.SharedFile<smb_SharedFile>` instance containing the attributes of the file.\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._getAttributes(service_name, path, d.callback, d.errback, timeout = timeout)\n        return d
\n\n
[docs]    def retrieveFile(self, service_name, path, file_obj, timeout = 30):\n        """\n        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n        Use *retrieveFileFromOffset()* method if you need to specify the offset to read from the remote *path* and/or the maximum number of bytes to write to the *file_obj*.\n\n        The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size\n        of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).\n        The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be called in the returned *Deferred* errback.\n        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).\n                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n        """\n        return self.retrieveFileFromOffset(service_name, path, file_obj, 0, -1, timeout)
\n\n
[docs]    def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0, max_length = -1, timeout = 30):\n        """\n        Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n        The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size\n        of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).\n        The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure<smb_exceptions>` will be called in the returned *Deferred* errback.\n        :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n        :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.\n        :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.\n                                        If zero, the *Deferred* callback is invoked immediately after the file is opened successfully for reading.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).\n                 The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._retrieveFileFromOffset(service_name, path, file_obj, d.callback, d.errback, offset, max_length, timeout = timeout)\n        return d
\n\n
[docs]    def storeFile(self, service_name, path, file_obj, timeout = 30):\n        """\n        Store the contents of the *file_obj* at *path* on the *service_name*.\n\n        The meaning of the *timeout* parameter will be different from other file operation methods. As the uploaded file usually exceeeds the maximum size\n        of each SMB/CIFS data message, it will be packetized into a series of messages (usually about 60kBytes).\n        The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and acknowledged\n        by the remote SMB/CIFS server.\n\n        :param string/unicode service_name: the name of the shared folder for the *path*\n        :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.\n                                    If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure<smb_exceptions>` will be called in the returned *Deferred* errback.\n        :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF. In Python3, this file-like object must have a *read* method which returns a bytes parameter.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *file_obj*, number of bytes uploaded ).\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._storeFile(service_name, path, file_obj, d.callback, d.errback, timeout = timeout)\n        return d
\n\n
[docs]    def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30):\n        """\n        Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.\n\n        If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.\n        \n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n                                                 Wildcards may be used in th filename component of the path.\n                                                 If your path/filename contains non-English characters, you must pass in an unicode string.\n        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path_file_pattern* parameter.\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._deleteFiles(service_name, path_file_pattern, delete_matching_folders, d.callback, d.errback, timeout = timeout)\n        return d
\n\n
[docs]    def createDirectory(self, service_name, path):\n        """\n        Creates a new directory *path* on the *service_name*.\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param string/unicode path: The path of the new folder (relative to) the shared folder.\n                                    If the path contains non-English characters, an unicode string must be used to pass in the path.\n        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._createDirectory(service_name, path, d.callback, d.errback)\n        return d
\n\n
[docs]    def deleteDirectory(self, service_name, path):\n        """\n        Delete the empty folder at *path* on *service_name*\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.\n                                    If the path contains non-English characters, an unicode string must be used to pass in the path.\n        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._deleteDirectory(service_name, path, d.callback, d.errback)\n        return d
\n\n
[docs]    def rename(self, service_name, old_path, new_path):\n        """\n        Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders\n\n        *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.\n        If the path contains non-English characters, an unicode string must be used to pass in the path.\n\n        :param string/unicode service_name: Contains the name of the shared folder.\n        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *old_path*, *new_path* ).\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._rename(service_name, old_path, new_path, d.callback, d.errback)\n        return d
\n\n
[docs]    def echo(self, data, timeout = 10):\n        """\n        Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.\n\n        :param bytes data: Data to send to the remote server. Must be a bytes object.\n        :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n        :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *data* parameter.\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        d = defer.Deferred()\n        self.instance._echo(data, d.callback, d.errback, timeout)\n        return d
\n\n
[docs]    def closeConnection(self):\n        """\n        Disconnect from the remote SMB/CIFS server. The TCP connection will be closed at the earliest opportunity after this method returns.\n\n        :return: None\n        """\n        if not self.instance:\n            raise NotConnectedError('Not connected to server')\n\n        self.instance.transport.loseConnection()
\n\n    #\n    # ClientFactory methods\n    # (Do not touch these unless you know what you are doing)\n    #\n\n
[docs]    def buildProtocol(self, addr):\n        p = self.protocol(self.username, self.password, self.my_name, self.remote_name, self.domain, self.use_ntlm_v2, self.sign_options, self.is_direct_tcp)\n        p.factory = self\n        return p
\n
\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2021, Michael Teo https://miketeo.net/.\n Created using Sphinx 3.4.3.\n
\n \n" }, { "path": "docs/html/_modules/smb/base.html", "content": "\n\n\n\n \n \n \n smb.base — pysmb 1.2.11 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Source code for smb.base

\n\nimport logging, binascii, time, hmac\nfrom datetime import datetime\nfrom tqdm import tqdm\n\nfrom .smb_constants import *\nfrom .smb2_constants import *\nfrom .smb_structs import *\nfrom .smb2_structs import *\nfrom .security_descriptors import SecurityDescriptor\nfrom nmb.base import NMBSession\nfrom .utils import convertFILETIMEtoEpoch\nfrom . import ntlm, securityblob\nfrom .strategy import DataFaultToleranceStrategy\n\ntry:\n    import hashlib\n    sha256 = hashlib.sha256\nexcept ImportError:\n    from .utils import sha256\n\n\n
[docs]class NotReadyError(Exception):\n    """Raised when SMB connection is not ready (i.e. not authenticated or authentication failed)"""\n    pass
\n\n
[docs]class NotConnectedError(Exception):\n    """Raised when underlying SMB connection has been disconnected or not connected yet"""\n    pass
\n\n
[docs]class SMBTimeout(Exception):\n    """Raised when a timeout has occurred while waiting for a response or for a SMB/CIFS operation to complete."""\n    pass
\n\n\nclass SMB(NMBSession):\n    """\n    This class represents a "connection" to the remote SMB/CIFS server.\n    It is not meant to be used directly in an application as it does not have any network transport implementations.\n\n    For application use, please refer to\n      - L{SMBProtocol.SMBProtocolFactory<smb.SMBProtocol>} if you are using Twisted framework\n\n    In [MS-CIFS], this class will contain attributes of Client, Client.Connection and Client.Session abstract data models.\n\n    References:\n    ===========\n      - [MS-CIFS]: 3.2.1\n    """\n\n    log = logging.getLogger('SMB.SMB')\n\n    SIGN_NEVER = 0\n    SIGN_WHEN_SUPPORTED = 1\n    SIGN_WHEN_REQUIRED = 2\n\n    def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n        NMBSession.__init__(self, my_name, remote_name, is_direct_tcp = is_direct_tcp)\n        self.username = username\n        self._password = password\n        self.domain = domain\n        self.sign_options = sign_options\n        self.is_direct_tcp = is_direct_tcp\n        self.use_ntlm_v2 = use_ntlm_v2 #: Similar to LMAuthenticationPolicy and NTAuthenticationPolicy as described in [MS-CIFS] 3.2.1.1\n        self.smb_message = SMBMessage()\n        self.is_using_smb2 = False   #: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True\n        self.async_requests = { }    #: AsyncID mapped to _PendingRequest instance\n        self.pending_requests = { }  #: MID mapped to _PendingRequest instance\n        self.connected_trees = { }   #: Share name mapped to TID\n        self.next_rpc_call_id = 1    #: Next RPC callID value. Not used directly in SMB message. Usually encapsulated in sub-commands under SMB_COM_TRANSACTION or SMB_COM_TRANSACTION2 messages\n\n        self.has_negotiated = False\n        self.has_authenticated = False\n        self.is_signing_active = False           #: True if the remote server accepts message signing. All outgoing messages will be signed. Simiar to IsSigningActive as described in [MS-CIFS] 3.2.1.2\n        self.signing_session_key = None          #: Session key for signing packets, if signing is active. Similar to SigningSessionKey as described in [MS-CIFS] 3.2.1.2\n        self.signing_challenge_response = None   #: Contains the challenge response for signing, if signing is active. Similar to SigningChallengeResponse as described in [MS-CIFS] 3.2.1.2\n        self.mid = 0\n        self.uid = 0\n        self.next_signing_id = 2     #: Similar to ClientNextSendSequenceNumber as described in [MS-CIFS] 3.2.1.2\n\n        # SMB1 and SMB2 attributes\n        # Note that the interpretations of the values may differ between SMB1 and SMB2 protocols\n        self.capabilities = 0\n        self.security_mode = 0     #: Initialized from the SecurityMode field of the SMB_COM_NEGOTIATE message\n\n        # SMB1 attributes\n        # Most of the following attributes will be initialized upon receipt of SMB_COM_NEGOTIATE message from server (via self._updateServerInfo_SMB1 method)\n        self.use_plaintext_authentication = False  #: Similar to PlaintextAuthenticationPolicy in in [MS-CIFS] 3.2.1.1\n        self.max_raw_size = 0\n        self.max_buffer_size = 0   #: Similar to MaxBufferSize as described in [MS-CIFS] 3.2.1.1\n        self.max_mpx_count = 0     #: Similar to MaxMpxCount as described in [MS-CIFS] 3.2.1.1\n\n        # SMB2 attributes\n        self.max_read_size = 0      #: Similar to MaxReadSize as described in [MS-SMB2] 2.2.4\n        self.max_write_size = 0     #: Similar to MaxWriteSize as described in [MS-SMB2] 2.2.4\n        self.max_transact_size = 0  #: Similar to MaxTransactSize as described in [MS-SMB2] 2.2.4\n        self.session_id = 0         #: Similar to SessionID as described in [MS-SMB2] 2.2.4. This will be set in _updateState_SMB2 method\n\n        # tqdm attributes for tracking progress\n        self.pbar = None            #: If not None, it means there is an active tqdm progress bar being shown\n\n        self._setupSMB1Methods()\n\n        self.log.info('Authentication with remote machine "%s" for user "%s" will be using NTLM %s authentication (%s extended security)',\n                      self.remote_name, self.username,\n                      (self.use_ntlm_v2 and 'v2') or 'v1',\n                      (SUPPORT_EXTENDED_SECURITY and 'with') or 'without')\n\n    @property\n    def password(self):\n        if callable(self._password):\n            return self._password()\n        return self._password\n\n    #\n    # NMBSession Methods\n    #\n\n    def onNMBSessionOK(self):\n        self._sendSMBMessage(SMBMessage(ComNegotiateRequest()))\n\n    def onNMBSessionFailed(self):\n        pass\n\n    def onNMBSessionMessage(self, flags, data):\n        while True:\n            try:\n                i = self.smb_message.decode(data)\n            except SMB2ProtocolHeaderError:\n                self.log.info('Now switching over to SMB2 protocol communication')\n                self.is_using_smb2 = True\n                self.mid = 0  # Must reset messageID counter, or else remote SMB2 server will disconnect\n                self._setupSMB2Methods()\n                self.smb_message = self._klassSMBMessage()\n                i = self.smb_message.decode(data)\n\n            next_message_offset = 0\n            if self.is_using_smb2:\n                next_message_offset = self.smb_message.next_command_offset\n\n            if i > 0:\n                if not self.is_using_smb2:\n                    self.log.debug('Received SMB message "%s" (command:0x%2X flags:0x%02X flags2:0x%04X TID:%d UID:%d)',\n                                   SMB_COMMAND_NAMES.get(self.smb_message.command, '<unknown>'),\n                                   self.smb_message.command, self.smb_message.flags, self.smb_message.flags2, self.smb_message.tid, self.smb_message.uid)\n                else:\n                    self.log.debug('Received SMB2 message "%s" (command:0x%04X flags:0x%04x)',\n                                   SMB2_COMMAND_NAMES.get(self.smb_message.command, '<unknown>'),\n                                   self.smb_message.command, self.smb_message.flags)\n                if self._updateState(self.smb_message):\n                    # We need to create a new instance instead of calling reset() because the instance could be captured in the message history.\n                    self.smb_message = self._klassSMBMessage()\n\n            if next_message_offset > 0:\n                data = data[next_message_offset:]\n            else:\n                break\n\n    #\n    # Public Methods for Overriding in Subclasses\n    #\n\n    def onAuthOK(self):\n        pass\n\n    def onAuthFailed(self):\n        pass\n\n    #\n    # Protected Methods\n    #\n\n    def _setupSMB1Methods(self):\n        self._klassSMBMessage = SMBMessage\n        self._updateState = self._updateState_SMB1\n        self._updateServerInfo = self._updateServerInfo_SMB1\n        self._handleNegotiateResponse = self._handleNegotiateResponse_SMB1\n        self._sendSMBMessage = self._sendSMBMessage_SMB1\n        self._handleSessionChallenge = self._handleSessionChallenge_SMB1\n        self._listShares = self._listShares_SMB1\n        self._listPath = self._listPath_SMB1\n        self._listSnapshots = self._listSnapshots_SMB1\n        self._getSecurity = self._getSecurity_SMB1\n        self._getAttributes = self._getAttributes_SMB1\n        self._retrieveFile = self._retrieveFile_SMB1\n        self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB1\n        self._storeFile = self._storeFile_SMB1\n        self._storeFileFromOffset = self._storeFileFromOffset_SMB1\n        self._deleteFiles = self._deleteFiles_SMB1\n        self._resetFileAttributes = self._resetFileAttributes_SMB1\n        self._createDirectory = self._createDirectory_SMB1\n        self._deleteDirectory = self._deleteDirectory_SMB1\n        self._rename = self._rename_SMB1\n        self._echo = self._echo_SMB1\n\n    def _setupSMB2Methods(self):\n        self._klassSMBMessage = SMB2Message\n        self._updateState = self._updateState_SMB2\n        self._updateServerInfo = self._updateServerInfo_SMB2\n        self._handleNegotiateResponse = self._handleNegotiateResponse_SMB2\n        self._sendSMBMessage = self._sendSMBMessage_SMB2\n        self._handleSessionChallenge = self._handleSessionChallenge_SMB2\n        self._listShares = self._listShares_SMB2\n        self._listPath = self._listPath_SMB2\n        self._listSnapshots = self._listSnapshots_SMB2\n        self._getSecurity = self._getSecurity_SMB2\n        self._getAttributes = self._getAttributes_SMB2\n        self._retrieveFile = self._retrieveFile_SMB2\n        self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB2\n        self._storeFile = self._storeFile_SMB2\n        self._storeFileFromOffset = self._storeFileFromOffset_SMB2\n        self._deleteFiles = self._deleteFiles_SMB2\n        self._resetFileAttributes = self._resetFileAttributes_SMB2\n        self._createDirectory = self._createDirectory_SMB2\n        self._deleteDirectory = self._deleteDirectory_SMB2\n        self._rename = self._rename_SMB2\n        self._echo = self._echo_SMB2\n\n    def _getNextRPCCallID(self):\n        self.next_rpc_call_id += 1\n        return self.next_rpc_call_id\n\n    #\n    # SMB2 Methods Family\n    #\n\n    def _sendSMBMessage_SMB2(self, smb_message):\n        if smb_message.mid == 0:\n            smb_message.mid = self._getNextMID_SMB2()\n\n        if smb_message.command != SMB2_COM_NEGOTIATE:\n            smb_message.session_id = self.session_id\n\n        if self.is_signing_active:\n            smb_message.flags |= SMB2_FLAGS_SIGNED\n            raw_data = smb_message.encode()\n            smb_message.signature = hmac.new(self.signing_session_key, raw_data, sha256).digest()[:16]\n\n            smb_message.raw_data = smb_message.encode()\n            self.log.debug('MID is %d. Signature is %s. Total raw message is %d bytes', smb_message.mid, binascii.hexlify(smb_message.signature), len(smb_message.raw_data))\n        else:\n            smb_message.raw_data = smb_message.encode()\n        self.sendNMBMessage(smb_message.raw_data)\n\n    def _getNextMID_SMB2(self):\n        self.mid += 1\n        return self.mid\n\n    def _updateState_SMB2(self, message):\n        if message.isReply:\n            if message.command == SMB2_COM_NEGOTIATE:\n                if message.status == 0:\n                    self.has_negotiated = True\n                    self.log.info('SMB2 dialect negotiation successful')\n                    self._updateServerInfo(message.payload)\n                    self._handleNegotiateResponse(message)\n                else:\n                    raise ProtocolError('Unknown status value (0x%08X) in SMB2_COM_NEGOTIATE' % message.status,\n                                        message.raw_data, message)\n            elif message.command == SMB2_COM_SESSION_SETUP:\n                if message.status == 0:\n                    self.session_id = message.session_id\n                    try:\n                        result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)\n                        if result == securityblob.RESULT_ACCEPT_COMPLETED:\n                            self.has_authenticated = True\n                            self.log.info('Authentication (on SMB2) successful!')\n\n                            # [MS-SMB2]: 3.2.5.3.1\n                            # If the security subsystem indicates that the session was established by an anonymous user,\n                            # Session.SigningRequired MUST be set to FALSE.\n                            # If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags field of the\n                            # SMB2 SESSION_SETUP Response and if Session.SigningRequired is TRUE, this indicates a SESSION_SETUP\n                            # failure and the connection MUST be terminated. If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags\n                            # field of the SMB2 SESSION_SETUP Response and if RequireMessageSigning is FALSE, Session.SigningRequired\n                            # MUST be set to FALSE.\n                            if message.payload.isGuestSession or message.payload.isAnonymousSession:\n                                self.is_signing_active = False\n                                self.log.info('Signing disabled because session is guest/anonymous')\n\n                            self.onAuthOK()\n                        else:\n                            raise ProtocolError('SMB2_COM_SESSION_SETUP status is 0 but security blob negResult value is %d' % result, message.raw_data, message)\n                    except securityblob.BadSecurityBlobError as ex:\n                        raise ProtocolError(str(ex), message.raw_data, message)\n                elif message.status == 0xc0000016:  # STATUS_MORE_PROCESSING_REQUIRED\n                    self.session_id = message.session_id\n                    try:\n                        result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)\n                        if result == securityblob.RESULT_ACCEPT_INCOMPLETE:\n                            self._handleSessionChallenge(message, ntlm_token)\n                    except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ) as ex:\n                        raise ProtocolError(str(ex), message.raw_data, message)\n                elif (message.status == 0xc000006d   # STATUS_LOGON_FAILURE\n                    or message.status == 0xc0000064  # STATUS_NO_SUCH_USER\n                    or message.status == 0xc000006a):# STATUS_WRONG_PASSWORD\n                    self.has_authenticated = False\n                    self.log.info('Authentication (on SMB2) failed. Please check username and password.')\n                    self.onAuthFailed()\n                elif (message.status == 0xc0000193    # STATUS_ACCOUNT_EXPIRED\n                    or message.status == 0xC0000071): # STATUS_PASSWORD_EXPIRED\n                    self.has_authenticated = False\n                    self.log.info('Authentication (on SMB2) failed. Account or password has expired.')\n                    self.onAuthFailed()\n                elif message.status == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT\n                    self.has_authenticated = False\n                    self.log.info('Authentication (on SMB2) failed. Account has been locked due to too many invalid logon attempts.')\n                    self.onAuthFailed()\n                elif message.status == 0xc0000072: # STATUS_ACCOUNT_DISABLED\n                    self.has_authenticated = False\n                    self.log.info('Authentication (on SMB2) failed. Account has been disabled.')\n                    self.onAuthFailed()\n                elif (message.status == 0xc000006f    # STATUS_INVALID_LOGON_HOURS\n                    or message.status == 0xc000015b   # STATUS_LOGON_TYPE_NOT_GRANTED\n                    or message.status == 0xc0000070): # STATUS_INVALID_WORKSTATION\n                    self.has_authenticated = False\n                    self.log.info('Authentication (on SMB2) failed. Not allowed.')\n                    self.onAuthFailed()\n                elif message.status == 0xc000018c:  # STATUS_TRUSTED_DOMAIN_FAILURE\n                    self.has_authenticated = False\n                    self.log.info('Authentication (on SMB2) failed. Domain not trusted.')\n                    self.onAuthFailed()\n                elif message.status == 0xc000018d:  # STATUS_TRUSTED_RELATIONSHIP_FAILURE\n                    self.has_authenticated = False\n                    self.log.info('Authentication (on SMB2) failed. Workstation not trusted.')\n                    self.onAuthFailed()\n                else:\n                    raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status,\n                                        message.raw_data, message)\n\n            if message.isAsync:\n                if message.status == 0x00000103:  # STATUS_PENDING\n                    req = self.pending_requests.pop(message.mid, None)\n                    if req:\n                        self.async_requests[message.async_id] = req\n                else: # All other status including SUCCESS\n                    req = self.async_requests.pop(message.async_id, None)\n                    if req:\n                        req.callback(message, **req.kwargs)\n                        return True\n            else:\n                req = self.pending_requests.pop(message.mid, None)\n                if req:\n                    req.callback(message, **req.kwargs)\n                    return True\n\n\n    def _updateServerInfo_SMB2(self, payload):\n        self.capabilities = payload.capabilities\n        self.security_mode = payload.security_mode\n        self.max_transact_size = payload.max_transact_size\n        self.max_read_size = payload.max_read_size\n        self.max_write_size = payload.max_write_size\n        self.use_plaintext_authentication = False   # SMB2 never allows plaintext authentication\n\n\n    def _handleNegotiateResponse_SMB2(self, message):\n        ntlm_data = ntlm.generateNegotiateMessage()\n        blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n        self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))\n\n\n    def _handleSessionChallenge_SMB2(self, message, ntlm_token):\n        server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)\n\n        self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge))\n\n        if self.use_ntlm_v2:\n            self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge))\n            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,\n                                                                                                         self.username,\n                                                                                                         server_challenge,\n                                                                                                         server_info,\n                                                                                                         self.domain)\n\n        else:\n            self.log.info('Performing NTLMv1 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge))\n            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)\n\n        ntlm_data, session_signing_key = ntlm.generateAuthenticateMessage(server_flags,\n                                                                          nt_challenge_response,\n                                                                          lm_challenge_response,\n                                                                          session_key,\n                                                                          self.username,\n                                                                          self.domain,\n                                                                          self.my_name)\n\n        if self.log.isEnabledFor(logging.DEBUG):\n            self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))\n            self.log.debug('LM challenge response is "%s" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))\n\n        blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n        self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))\n\n        if self.security_mode & SMB2_NEGOTIATE_SIGNING_REQUIRED:\n            self.log.info('Server requires all SMB messages to be signed')\n            self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)\n        elif self.security_mode & SMB2_NEGOTIATE_SIGNING_ENABLED:\n            self.log.info('Server supports SMB signing')\n            self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)\n        else:\n            self.is_signing_active = False\n\n        if self.is_signing_active:\n            self.log.info("SMB signing activated. All SMB messages will be signed.")\n            self.signing_session_key = session_signing_key\n            if self.log.isEnabledFor(logging.DEBUG):\n                self.log.info("SMB signing key is %s", binascii.hexlify(self.signing_session_key))\n\n            if self.capabilities & CAP_EXTENDED_SECURITY:\n                self.signing_challenge_response = None\n            else:\n                self.signing_challenge_response = blob\n        else:\n            self.log.info("SMB signing deactivated. SMB messages will NOT be signed.")\n\n\n    def _listShares_SMB2(self, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = 'IPC$'\n        messages_history = [ ]\n\n        def connectSrvSvc(tid):\n            m = SMB2Message(SMB2CreateRequest('srvsvc',\n                                              file_attributes = 0,\n                                              access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_NON_DIRECTORY_FILE | FILE_OPEN_NO_RECALL,\n                                              create_disp = FILE_OPEN))\n\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def connectSrvSvcCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                call_id = self._getNextRPCCallID()\n                # The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]\n                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream\n                data_bytes = \\\n                    binascii.unhexlify(b"""05 00 0b 03 10 00 00 00 74 00 00 00""".replace(b' ', b'')) + \\\n                    struct.pack('<I', call_id) + \\\n                    binascii.unhexlify(b"""\nb8 10 b8 10 00 00 00 00 02 00 00 00 00 00 01 00\nc8 4f 32 4b 70 16 d3 01 12 78 5a 47 bf 6e e1 88\n03 00 00 00 04 5d 88 8a eb 1c c9 11 9f e8 08 00\n2b 10 48 60 02 00 00 00 01 00 01 00 c8 4f 32 4b\n70 16 d3 01 12 78 5a 47 bf 6e e1 88 03 00 00 00\n2c 1c b7 6c 12 98 40 45 03 00 00 00 00 00 00 00\n01 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n                m = SMB2Message(SMB2WriteRequest(create_message.payload.fid, data_bytes, 0))\n                m.tid = kwargs['tid']\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid)\n                self._pushToArray(messages_history, m)\n            else:\n                errback(OperationFailure('Failed to list shares: Unable to locate Server Service RPC endpoint', messages_history))\n\n        def rpcBindCB(trans_message, **kwargs):\n            self._pushToArray(messages_history, trans_message)\n            if trans_message.status == 0:\n                m = SMB2Message(SMB2ReadRequest(kwargs['fid'], read_len = 1024, read_offset = 0))\n                m.tid = kwargs['tid']\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcReadCB, errback, tid = kwargs['tid'], fid = kwargs['fid'])\n                self._pushToArray(messages_history, m)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], error = 'Failed to list shares: Unable to read from Server Service RPC endpoint')\n\n        def rpcReadCB(read_message, **kwargs):\n            self._pushToArray(messages_history, read_message)\n            if read_message.status == 0:\n                call_id = self._getNextRPCCallID()\n\n                padding = b''\n                remote_name = '\\\\\\\\' + self.remote_name\n                server_len = len(remote_name) + 1\n                server_bytes_len = server_len * 2\n                if server_len % 2 != 0:\n                    padding = b'\\0\\0'\n                    server_bytes_len += 2\n\n                # The data bytes are the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.\n                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream\n                data_bytes = \\\n                    binascii.unhexlify(b"""05 00 00 03 10 00 00 00""".replace(b' ', b'')) + \\\n                    struct.pack('<HHI', 72+server_bytes_len, 0, call_id) + \\\n                    binascii.unhexlify(b"""4c 00 00 00 00 00 0f 00 00 00 02 00""".replace(b' ', b'')) + \\\n                    struct.pack('<III', server_len, 0, server_len) + \\\n                    (remote_name + '\\0').encode('UTF-16LE') + padding + \\\n                    binascii.unhexlify(b"""\n01 00 00 00 01 00 00 00 04 00 02 00 00 00 00 00\n00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n                m = SMB2Message(SMB2IoctlRequest(kwargs['fid'], 0x0011C017, flags = 0x01, max_out_size = 8196, in_data = data_bytes))\n                m.tid = kwargs['tid']\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, tid = kwargs['tid'], fid = kwargs['fid'])\n                self._pushToArray(messages_history, m)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], error = 'Failed to list shares: Unable to bind to Server Service RPC endpoint')\n\n        def listShareResultsCB(result_message, **kwargs):\n            self._pushToArray(messages_history, result_message)\n            if result_message.status == 0:\n                # The payload.data_bytes will contain the results of the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.\n                data_bytes = result_message.payload.out_data\n\n                if data_bytes[3] & 0x02 == 0:\n                    sendReadRequest(kwargs['tid'], kwargs['fid'], data_bytes)\n                else:\n                    decodeResults(kwargs['tid'], kwargs['fid'], data_bytes)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'])\n                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))\n\n        def decodeResults(tid, fid, data_bytes):\n            shares_count = struct.unpack('<I', data_bytes[36:40])[0]\n            results = [ ]     # A list of SharedDevice instances\n            offset = 36 + 12  # You need to study the byte stream to understand the meaning of these constants\n            for i in range(0, shares_count):\n                results.append(SharedDevice(struct.unpack('<I', data_bytes[offset+4:offset+8])[0], None, None))\n                offset += 12\n\n            for i in range(0, shares_count):\n                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])\n                offset += 12\n                results[i].name = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset:offset+length*2-2])\n\n                if length % 2 != 0:\n                    offset += (length * 2 + 2)\n                else:\n                    offset += (length * 2)\n\n                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])\n                offset += 12\n                results[i].comments = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset:offset+length*2-2])\n\n                if length % 2 != 0:\n                    offset += (length * 2 + 2)\n                else:\n                    offset += (length * 2)\n\n            closeFid(tid, fid)\n            callback(results)\n\n        def sendReadRequest(tid, fid, data_bytes):\n            read_count = min(4280, self.max_read_size)\n            m = SMB2Message(SMB2ReadRequest(fid, 0, read_count))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback,\n                                                           tid = tid, fid = fid, data_bytes = data_bytes)\n\n        def readCB(read_message, **kwargs):\n            self._pushToArray(messages_history, read_message)\n            if read_message.status == 0:\n                data_bytes = read_message.payload.data\n\n                if data_bytes[3] & 0x02 == 0:\n                    sendReadRequest(kwargs['tid'], kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:])\n                else:\n                    decodeResults(kwargs['tid'], kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:])\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'])\n                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))\n\n        def closeFid(tid, fid, results = None, error = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, results = results, error = error)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['results'] is not None:\n                callback(kwargs['results'])\n            elif kwargs['error'] is not None:\n                errback(OperationFailure(kwargs['error'], messages_history))\n\n        if path not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[path] = connect_message.tid\n                    connectSrvSvc(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to list shares: Unable to connect to IPC$', messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), path )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = path)\n            self._pushToArray(messages_history, m)\n        else:\n            connectSrvSvc(self.connected_trees[path])\n\n    def _listPath_SMB2(self, service_name, path, callback, errback, search, pattern, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n        results = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = FILE_READ_DATA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_DIRECTORY_FILE,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                sendQuery(kwargs['tid'], create_message.payload.fid, b'')\n            elif create_message.status == 0xC0000034: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID\n                errback(OperationFailure('Failed to list %s on %s: Path not found' % ( path, service_name ), messages_history))\n            else:\n                errback(OperationFailure('Failed to list %s on %s: Unable to open directory' % ( path, service_name ), messages_history))\n\n        def sendQuery(tid, fid, data_buf):\n            m = SMB2Message(SMB2QueryDirectoryRequest(fid, pattern,\n                                                      info_class = 0x25,   # FileIdBothDirectoryInformation\n                                                      flags = 0,\n                                                      output_buf_len = self.max_transact_size))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = tid, fid = fid, data_buf = data_buf)\n            self._pushToArray(messages_history, m)\n\n        def queryCB(query_message, **kwargs):\n            self._pushToArray(messages_history, query_message)\n            if query_message.status == 0:\n                data_buf = decodeQueryStruct(kwargs['data_buf'] + query_message.payload.data)\n                sendQuery(kwargs['tid'], kwargs['fid'], data_buf)\n            elif query_message.status == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE\n                # If there are no matching files, we just treat as success instead of failing\n                closeFid(kwargs['tid'], kwargs['fid'], results = results)\n            elif query_message.status == 0x80000006:  # STATUS_NO_MORE_FILES\n                closeFid(kwargs['tid'], kwargs['fid'], results = results)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status)\n\n        def decodeQueryStruct(data_bytes):\n            # FileIdBothDirectoryInformation structure. See [MS-SMB]: 2.2.8.1.3 and [MS-FSCC]: 2.4.17\n            info_format = '<IIQQQQQQIIIBB24sHQ'\n            info_size = struct.calcsize(info_format)\n\n            data_length = len(data_bytes)\n            offset = 0\n            while offset < data_length:\n                if offset + info_size > data_length:\n                    return data_bytes[offset:]\n\n                next_offset, _, \\\n                create_time, last_access_time, last_write_time, last_attr_change_time, \\\n                file_size, alloc_size, file_attributes, filename_length, ea_size, \\\n                short_name_length, _, short_name, _, file_id = struct.unpack(info_format, data_bytes[offset:offset+info_size])\n\n                offset2 = offset + info_size\n                if offset2 + filename_length > data_length:\n                    return data_bytes[offset:]\n\n                filename = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset2:offset2+filename_length])\n                short_name = DataFaultToleranceStrategy.data_bytes_decode(short_name[:short_name_length])\n\n                accept_result = False\n                if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc\n                    accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n                else:\n                    accept_result = (file_attributes & search) > 0\n                if accept_result:\n                    results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),\n                                              convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),\n                                              file_size, alloc_size, file_attributes, short_name, filename, file_id))\n\n                if next_offset:\n                    offset += next_offset\n                else:\n                    break\n            return b''\n\n        def closeFid(tid, fid, results = None, error = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, results = results, error = error)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['results'] is not None:\n                callback(kwargs['results'])\n            elif kwargs['error'] is not None:\n                if kwargs['error'] == 0xC000000F:  # [MS-ERREF]: STATUS_NO_SUCH_FILE\n                    # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files\n                    callback([ ])\n                else:\n                    errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to list %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _getAttributes_SMB2(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify("""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(' ', '').replace('\\n', ''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = 0,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                p = create_message.payload\n                filename = self._extractLastPathComponent(path)\n                info = SharedFile(p.create_time, p.lastaccess_time, p.lastwrite_time, p.change_time,\n                                  p.file_size, p.allocation_size, p.file_attributes,\n                                  filename, filename)\n                closeFid(kwargs['tid'], p.fid, info = info)\n            else:\n                errback(OperationFailure('Failed to get attributes for %s on %s: Unable to open remote file object' % ( path, service_name ), messages_history))\n\n        def closeFid(tid, fid, info = None, error = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, info = info, error = error)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['info'] is not None:\n                callback(kwargs['info'])\n            elif kwargs['error'] is not None:\n                errback(OperationFailure('Failed to get attributes for %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _getSecurity_SMB2(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n        results = [ ]\n\n        def sendCreate(tid):\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = 0,\n                                              create_disp = FILE_OPEN))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid,\n                                                     flags = 0,\n                                                     additional_info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION | DACL_SECURITY_INFORMATION,\n                                                     info_type = SMB2_INFO_SECURITY,\n                                                     file_info_class = 0, # [MS-SMB2] 2.2.37, 3.2.4.12\n                                                     input_buf = '',\n                                                     output_buf_len = self.max_transact_size))\n                m.tid = kwargs['tid']\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid)\n                self._pushToArray(messages_history, m)\n            else:\n                errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to open file or directory' % ( path, service_name ), messages_history))\n\n        def queryCB(query_message, **kwargs):\n            self._pushToArray(messages_history, query_message)\n            if query_message.status == 0:\n                security = SecurityDescriptor.from_bytes(query_message.payload.data)\n                closeFid(kwargs['tid'], kwargs['fid'], result = security)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status)\n\n        def closeFid(tid, fid, result = None, error = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, result = result, error = error)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['result'] is not None:\n                callback(kwargs['result'])\n            elif kwargs['error'] is not None:\n                errback(OperationFailure('Failed to get the security descriptor of %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _retrieveFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):\n        return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0, -1, timeout)\n\n    def _retrieveFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, max_length, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n        results = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid,\n                                                     flags = 0,\n                                                     additional_info = 0,\n                                                     info_type = SMB2_INFO_FILE,\n                                                     file_info_class = 0x05,  # FileStandardInformation [MS-FSCC] 2.4\n                                                     input_buf = b'',\n                                                     output_buf_len = 4096))\n                m.tid = kwargs['tid']\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, infoCB, errback,\n                                                               tid = kwargs['tid'],\n                                                               fid = create_message.payload.fid,\n                                                               file_attributes = create_message.payload.file_attributes)\n                self._pushToArray(messages_history, m)\n            else:\n                errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n        def infoCB(info_message, **kwargs):\n            self._pushToArray(messages_history, info_message)\n            if info_message.status == 0:\n                file_len = struct.unpack('<Q', info_message.payload.data[8:16])[0]\n                if max_length == 0 or starting_offset > file_len:\n                    if self.pbar:\n                        self.pbar.close()\n                        self.pbar = None\n                    closeFid(info_message.tid, kwargs['fid'])\n                    callback(( file_obj, kwargs['file_attributes'], 0 ))  # Note that this is a tuple of 3-elements\n                else:\n                    remaining_len = max_length\n                    if remaining_len < 0:\n                        remaining_len = file_len\n                    if starting_offset + remaining_len > file_len:\n                        remaining_len = file_len - starting_offset\n                    if show_progress:\n                        tqdm_kwargs.setdefault("total", remaining_len)\n                        tqdm_kwargs.setdefault("unit", "B")\n                        tqdm_kwargs.setdefault("unit_scale", True)\n                        tqdm_kwargs.setdefault("unit_divisor", 1024)\n                        tqdm_kwargs.setdefault("desc", f"Downloading {path}")\n                        self.pbar = tqdm(**tqdm_kwargs)\n                    sendRead(kwargs['tid'], kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes'])\n            else:\n                errback(OperationFailure('Failed to retrieve %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history))\n\n        def sendRead(tid, fid, offset, remaining_len, read_len, file_attributes):\n            read_count = min(self.max_read_size, remaining_len)\n            m = SMB2Message(SMB2ReadRequest(fid, offset, read_count))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback,\n                                                           tid = tid, fid = fid, offset = offset,\n                                                           remaining_len = remaining_len,\n                                                           read_len = read_len,\n                                                           file_attributes = file_attributes)\n\n        def readCB(read_message, **kwargs):\n            # To avoid crazy memory usage when retrieving large files, we do not save every read_message in messages_history.\n            if read_message.status == 0:\n                data_len = read_message.payload.data_length\n                file_obj.write(read_message.payload.data)\n\n                remaining_len = kwargs['remaining_len'] - data_len\n\n                if remaining_len > 0:\n                    sendRead(kwargs['tid'], kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes'])\n                    if self.pbar:\n                        self.pbar.update(data_len)\n                else:\n                    if self.pbar:\n                        self.pbar.close()\n                        self.pbar = None\n                    closeFid(kwargs['tid'], kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len ))\n            else:\n                self._pushToArray(messages_history, read_message)\n                closeFid(kwargs['tid'], kwargs['fid'], error = read_message.status)\n\n        def closeFid(tid, fid, ret = None, error = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, ret = ret, error = error)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['ret'] is not None:\n                callback(kwargs['ret'])\n            elif kwargs['error'] is not None:\n                errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _storeFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):\n        self._storeFileFromOffset_SMB2(service_name, path, file_obj, callback, errback, 0, True, timeout)\n\n    def _storeFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n\n        if show_progress:\n            total_bytes = os.stat(file_obj.name).st_size\n            tqdm_kwargs.setdefault("total", total_bytes)\n            tqdm_kwargs.setdefault("unit", "B")\n            tqdm_kwargs.setdefault("unit_scale", True)\n            tqdm_kwargs.setdefault("unit_divisor", 1024)\n            tqdm_kwargs.setdefault("desc", f"Uploading {path}")\n            self.pbar = tqdm(**tqdm_kwargs)\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 20 00 00 00 10 00 04 00\n00 00 18 00 08 00 00 00 41 6c 53 69 00 00 00 00\n85 62 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = ATTR_ARCHIVE,\n                                              access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | SYNCHRONIZE,\n                                              share_access = 0,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,\n                                              create_disp = FILE_OVERWRITE_IF if truncate else FILE_OPEN_IF,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            create_message.tid = kwargs['tid']\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                sendWrite(create_message.tid, create_message.payload.fid, starting_offset)\n            else:\n                errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n        def sendWrite(tid, fid, offset):\n            write_count = self.max_write_size\n            data = file_obj.read(write_count)\n            data_len = len(data)\n            if data_len > 0:\n                m = SMB2Message(SMB2WriteRequest(fid, data, offset))\n                m.tid = tid\n                self._sendSMBMessage(m)\n                if self.pbar:\n                    self.pbar.update(data_len)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, tid = tid, fid = fid, offset = offset+data_len)\n            else:\n                if self.pbar:\n                    self.pbar.close()\n                    self.pbar = None\n                closeFid(tid, fid, offset = offset)\n\n        def writeCB(write_message, **kwargs):\n            # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.\n            if write_message.status == 0:\n                sendWrite(kwargs['tid'], kwargs['fid'], kwargs['offset'])\n            else:\n                if self.pbar:\n                    self.pbar.close()\n                    self.pbar = None\n                self._pushToArray(messages_history, write_message)\n                closeFid(kwargs['tid'], kwargs['fid'])\n                errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n        def closeFid(tid, fid, error = None, offset = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, fid = fid, offset = offset, error = error)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['offset'] is not None:\n                callback(( file_obj, kwargs['offset'] ))  # Note that this is a tuple of 2-elements\n            elif kwargs['error'] is not None:\n                errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n\n    def _deleteFiles_SMB2(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        pattern = None\n        path = path_file_pattern.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        else:\n            path_components = path.split('\\\\')\n            if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1:\n                path = '\\\\'.join(path_components[:-1])\n                pattern = path_components[-1]\n        messages_history, files_queue = [ ], [ ]\n\n        if pattern is None:\n            path_components = path.split('\\\\')\n            if len(path_components) > 1:\n                files_queue.append(( '\\\\'.join(path_components[:-1]), path_components[-1] ))\n            else:\n                files_queue.append(( '', path ))\n\n        def deleteCB(path):\n            if files_queue:\n                p, filename = files_queue.pop(0)\n                if filename:\n                    if p:\n                        filename = p + '\\\\' + filename\n                    self._deleteFiles_SMB2__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout)\n                else:\n                    self._deleteDirectory_SMB2(service_name, p, deleteCB, errback, timeout)\n            else:\n                callback(path_file_pattern)\n\n        def listCB(files_list):\n            files_queue.extend(files_list)\n            deleteCB(None)\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    if files_queue:\n                        deleteCB(None)\n                    else:\n                        self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n                else:\n                    errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            if files_queue:\n                deleteCB(None)\n            else:\n                self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n\n    def _deleteFiles_SMB2__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30):\n        folder_queue = [ ]\n        files_list = [ ]\n        current_path = [ path ]\n        search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL\n\n        def listCB(results):\n            files = [ ]\n            for f in filter(lambda x: x.filename not in [ '.', '..' ], results):\n                if f.isDirectory:\n                    if delete_matching_folders:\n                        folder_queue.append(current_path[0]+'\\\\'+f.filename)\n                else:\n                    files.append(( current_path[0], f.filename ))\n            if current_path[0]!=path and delete_matching_folders:\n                files.append(( current_path[0], None ))\n\n            if files:\n                files_list[0:0] = files\n\n            if folder_queue:\n                p = folder_queue.pop()\n                current_path[0] = p\n                self._listPath_SMB2(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30)\n            else:\n                callback(files_list)\n\n        self._listPath_SMB2(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout)\n\n    def _deleteFiles_SMB2__del(self, service_name, tid, path, callback, errback, timeout = 30):\n        messages_history = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n    28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n    44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n    00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n    00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n    00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n    51 46 69 64 00 00 00 00\n    """.replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = DELETE | FILE_READ_ATTRIBUTES,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_NON_DIRECTORY_FILE,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(open_message, **kwargs):\n            open_message.tid = kwargs['tid']\n            self._pushToArray(messages_history, open_message)\n            if open_message.status == 0:\n                sendDelete(open_message.tid, open_message.payload.fid)\n            elif open_message.status == 0xc0000034:  # STATUS_OBJECT_NAME_NOT_FOUND\n                callback(path)\n            elif open_message.status == 0xC00000BA:  # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY\n                errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history))\n            else:\n                errback(OperationFailure('Failed to delete %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n        def sendDelete(tid, fid):\n            m = SMB2Message(SMB2SetInfoRequest(fid,\n                                               additional_info = 0,\n                                               info_type = SMB2_INFO_FILE,\n                                               file_info_class = 0x0d,  # SMB2_FILE_DISPOSITION_INFO\n                                               data = b'\\x01'))\n            # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4.11\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid)\n            self._pushToArray(messages_history, m)\n\n        def deleteCB(delete_message, **kwargs):\n            self._pushToArray(messages_history, delete_message)\n            if delete_message.status == 0:\n                closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status)\n\n        def closeFid(tid, fid, status = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['status'] == 0:\n                callback(path)\n            else:\n                errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n        sendCreate(tid)\n\n    def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, file_attributes = ATTR_NORMAL, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path_file_pattern.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = FILE_WRITE_ATTRIBUTES,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = 0,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(open_message, **kwargs):\n            self._pushToArray(messages_history, open_message)\n            if open_message.status == 0:\n                sendReset(kwargs['tid'], open_message.payload.fid)\n            else:\n                errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n        def sendReset(tid, fid):\n            m = SMB2Message(SMB2SetInfoRequest(fid,\n                                               additional_info = 0,\n                                               info_type = SMB2_INFO_FILE,\n                                               file_info_class = 4,  # FileBasicInformation\n                                               data = struct.pack('qqqqii', 0, 0, 0, 0, file_attributes, 0)))\n            # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4, [MS-FSCC]: 2.4.7, [MS-FSCC]: 2.6\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, tid = tid, fid = fid)\n            self._pushToArray(messages_history, m)\n\n        def resetCB(reset_message, **kwargs):\n            self._pushToArray(messages_history, reset_message)\n            if reset_message.status == 0:\n                closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], status = reset_message.status)\n\n        def closeFid(tid, fid, status = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['status'] == 0:\n                callback(path_file_pattern)\n            else:\n                errback(OperationFailure('Failed to reset attributes of %s on %s: Reset failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _createDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_READ_EA | FILE_WRITE_EA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | READ_CONTROL | DELETE | SYNCHRONIZE,\n                                              share_access = 0,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,\n                                              create_disp = FILE_CREATE,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                closeFid(kwargs['tid'], create_message.payload.fid)\n            else:\n                errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))\n\n        def closeFid(tid, fid):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            callback(path)\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _deleteDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = DELETE | FILE_READ_ATTRIBUTES,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_DIRECTORY_FILE,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(open_message, **kwargs):\n            self._pushToArray(messages_history, open_message)\n            if open_message.status == 0:\n                sendDelete(kwargs['tid'], open_message.payload.fid)\n            else:\n                errback(OperationFailure('Failed to delete %s on %s: Unable to open directory' % ( path, service_name ), messages_history))\n\n        def sendDelete(tid, fid):\n            m = SMB2Message(SMB2SetInfoRequest(fid,\n                                               additional_info = 0,\n                                               info_type = SMB2_INFO_FILE,\n                                               file_info_class = 0x0d,  # SMB2_FILE_DISPOSITION_INFO\n                                               data = b'\\x01'))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid)\n            self._pushToArray(messages_history, m)\n\n        def deleteCB(delete_message, **kwargs):\n            self._pushToArray(messages_history, delete_message)\n            if delete_message.status == 0:\n                closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status)\n\n        def closeFid(tid, fid, status = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['status'] == 0:\n                callback(path)\n            else:\n                errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _rename_SMB2(self, service_name, old_path, new_path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        messages_history = [ ]\n\n        new_path = new_path.replace('/', '\\\\')\n        if new_path.startswith('\\\\'):\n            new_path = new_path[1:]\n        if new_path.endswith('\\\\'):\n            new_path = new_path[:-1]\n\n        old_path = old_path.replace('/', '\\\\')\n        if old_path.startswith('\\\\'):\n            old_path = old_path[1:]\n        if old_path.endswith('\\\\'):\n            old_path = old_path[:-1]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(old_path,\n                                              file_attributes = 0,\n                                              access_mask = DELETE | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_SYNCHRONOUS_IO_NONALERT,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                sendRename(kwargs['tid'], create_message.payload.fid)\n            else:\n                errback(OperationFailure('Failed to rename %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history))\n\n        def sendRename(tid, fid):\n            data = b'\\x00'*16 + struct.pack('<I', len(new_path)*2) + new_path.encode('UTF-16LE')\n            m = SMB2Message(SMB2SetInfoRequest(fid,\n                                               additional_info = 0,\n                                               info_type = SMB2_INFO_FILE,\n                                               file_info_class = 0x0a,  # SMB2_FILE_RENAME_INFO\n                                               data = data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback, tid = tid, fid = fid)\n            self._pushToArray(messages_history, m)\n\n        def renameCB(rename_message, **kwargs):\n            self._pushToArray(messages_history, rename_message)\n            if rename_message.status == 0:\n                closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], status = rename_message.status)\n\n        def closeFid(tid, fid, status = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['status'] == 0:\n                callback(( old_path, new_path ))\n            else:\n                errback(OperationFailure('Failed to rename %s on %s: Rename failed' % ( old_path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to rename %s on %s: Unable to connect to shared device' % ( old_path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _listSnapshots_SMB2(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n\n        def sendCreate(tid):\n            create_context_data = binascii.unhexlify(b"""\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 00 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n            m = SMB2Message(SMB2CreateRequest(path,\n                                              file_attributes = 0,\n                                              access_mask = FILE_READ_DATA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n                                              share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n                                              oplock = SMB2_OPLOCK_LEVEL_NONE,\n                                              impersonation = SEC_IMPERSONATE,\n                                              create_options = FILE_SYNCHRONOUS_IO_NONALERT,\n                                              create_disp = FILE_OPEN,\n                                              create_context_data = create_context_data))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if create_message.status == 0:\n                sendEnumSnapshots(kwargs['tid'], create_message.payload.fid)\n            else:\n                errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open file/directory' % ( path, service_name ), messages_history))\n\n        def sendEnumSnapshots(tid, fid):\n            m = SMB2Message(SMB2IoctlRequest(fid,\n                                             ctlcode = 0x00144064,  # FSCTL_SRV_ENUMERATE_SNAPSHOTS\n                                             flags = 0x0001,\n                                             in_data = b''))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, enumSnapshotsCB, errback, tid = tid, fid = fid)\n            self._pushToArray(messages_history, m)\n\n        def enumSnapshotsCB(enum_message, **kwargs):\n            self._pushToArray(messages_history, enum_message)\n            if enum_message.status == 0:\n                results = [ ]\n                snapshots_count = struct.unpack('<I', enum_message.payload.out_data[4:8])[0]\n                for i in range(0, snapshots_count):\n                    s = DataFaultToleranceStrategy.data_bytes_decode(enum_message.payload.out_data[12+i*50:12+48+i*50])\n                    results.append(datetime(*list(map(int, ( s[5:9], s[10:12], s[13:15], s[16:18], s[19:21], s[22:24] )))))\n                closeFid(kwargs['tid'], kwargs['fid'], results = results)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'], status = enum_message.status)\n\n        def closeFid(tid, fid, status = None, results = None):\n            m = SMB2Message(SMB2CloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status, results = results)\n            self._pushToArray(messages_history, m)\n\n        def closeCB(close_message, **kwargs):\n            if kwargs['results'] is not None:\n                callback(kwargs['results'])\n            else:\n                errback(OperationFailure('Failed to list snapshots %s on %s: List failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if connect_message.status == 0:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to list snapshots %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _echo_SMB2(self, data, callback, errback, timeout = 30):\n        messages_history = [ ]\n\n        def echoCB(echo_message, **kwargs):\n            self._pushToArray(messages_history, echo_message)\n            if echo_message.status == 0:\n                callback(data)\n            else:\n                errback(OperationFailure('Echo failed', messages_history))\n\n        m = SMB2Message(SMB2EchoRequest())\n        self._sendSMBMessage(m)\n        self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, echoCB, errback)\n        self._pushToArray(messages_history, m)\n\n\n    #\n    # SMB1 Methods Family\n    #\n\n    def _sendSMBMessage_SMB1(self, smb_message):\n        if smb_message.mid == 0:\n            smb_message.mid = self._getNextMID_SMB1()\n        if not smb_message.uid:\n            smb_message.uid = self.uid\n        if self.is_signing_active:\n            smb_message.flags2 |= SMB_FLAGS2_SMB_SECURITY_SIGNATURE\n\n            # Increment the next_signing_id as described in [MS-CIFS] 3.2.4.1.3\n            smb_message.security = self.next_signing_id\n            self.next_signing_id += 2  # All our defined messages currently have responses, so always increment by 2\n            raw_data = smb_message.encode()\n\n            md = ntlm.MD5(self.signing_session_key)\n            if self.signing_challenge_response:\n                md.update(self.signing_challenge_response)\n            md.update(raw_data)\n            signature = md.digest()[:8]\n\n            self.log.debug('MID is %d. Signing ID is %d. Signature is %s. Total raw message is %d bytes', smb_message.mid, smb_message.security, binascii.hexlify(signature), len(raw_data))\n            smb_message.raw_data = raw_data[:14] + signature + raw_data[22:]\n        else:\n            smb_message.raw_data = smb_message.encode()\n        self.sendNMBMessage(smb_message.raw_data)\n\n    def _getNextMID_SMB1(self):\n        self.mid += 1\n        if self.mid >= 0xFFFF: # MID cannot be 0xFFFF. [MS-CIFS]: 2.2.1.6.2\n            # We don't use MID of 0 as MID can be reused for SMB_COM_TRANSACTION2_SECONDARY messages\n            # where if mid=0, _sendSMBMessage will re-assign new MID values again\n            self.mid = 1\n        return self.mid\n\n    def _updateState_SMB1(self, message):\n        if message.isReply:\n            if message.command == SMB_COM_NEGOTIATE:\n                if not message.status.hasError:\n                    self.has_negotiated = True\n                    self.log.info('SMB dialect negotiation successful (ExtendedSecurity:%s)', message.hasExtendedSecurity)\n                    self._updateServerInfo(message.payload)\n                    self._handleNegotiateResponse(message)\n                else:\n                    raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_NEGOTIATE' % message.status.internal_value,\n                                        message.raw_data, message)\n            elif message.command == SMB_COM_SESSION_SETUP_ANDX:\n                if message.hasExtendedSecurity:\n                    if not message.status.hasError:\n                        try:\n                            result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)\n                            if result == securityblob.RESULT_ACCEPT_COMPLETED:\n                                self.log.debug('SMB uid is now %d', message.uid)\n                                self.uid = message.uid\n                                self.has_authenticated = True\n                                self.log.info('Authentication (with extended security) successful!')\n                                self.onAuthOK()\n                            else:\n                                raise ProtocolError('SMB_COM_SESSION_SETUP_ANDX status is 0 but security blob negResult value is %d' % result, message.raw_data, message)\n                        except securityblob.BadSecurityBlobError as ex:\n                            raise ProtocolError(str(ex), message.raw_data, message)\n                    elif message.status.internal_value == 0xc0000016:  # STATUS_MORE_PROCESSING_REQUIRED\n                        try:\n                            result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)\n                            if result == securityblob.RESULT_ACCEPT_INCOMPLETE:\n                                self._handleSessionChallenge(message, ntlm_token)\n                        except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ) as ex:\n                            raise ProtocolError(str(ex), message.raw_data, message)\n                    elif (message.status.internal_value == 0xc000006d    # STATUS_LOGON_FAILURE\n                        or message.status.internal_value == 0xc0000064   # STATUS_NO_SUCH_USER\n                        or message.status.internal_value == 0xc000006a): # STATUS_WRONG_PASSWORD\n                        self.has_authenticated = False\n                        self.log.info('Authentication (with extended security) failed. Please check username and password.')\n                        self.onAuthFailed()\n                    elif (message.status.internal_value == 0xc0000193    # STATUS_ACCOUNT_EXPIRED\n                        or message.status.internal_value == 0xC0000071): # STATUS_PASSWORD_EXPIRED\n                        self.has_authenticated = False\n                        self.log.info('Authentication (with extended security) failed. Account or password has expired.')\n                        self.onAuthFailed()\n                    elif message.status.internal_value == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT\n                        self.has_authenticated = False\n                        self.log.info('Authentication (with extended security) failed. Account has been locked due to too many invalid logon attempts.')\n                        self.onAuthFailed()\n                    elif message.status.internal_value == 0xc0000072: # STATUS_ACCOUNT_DISABLED\n                        self.has_authenticated = False\n                        self.log.info('Authentication (with extended security) failed. Account has been disabled.')\n                        self.onAuthFailed()\n                    elif (message.status.internal_value == 0xc000006f    # STATUS_INVALID_LOGON_HOURS\n                        or message.status.internal_value == 0xc000015b   # STATUS_LOGON_TYPE_NOT_GRANTED\n                        or message.status.internal_value == 0xc0000070): # STATUS_INVALID_WORKSTATION\n                        self.has_authenticated = False\n                        self.log.info('Authentication (with extended security) failed. Not allowed.')\n                        self.onAuthFailed()\n                    elif message.status.internal_value == 0xc000018c:  # STATUS_TRUSTED_DOMAIN_FAILURE\n                        self.has_authenticated = False\n                        self.log.info('Authentication (with extended security) failed. Domain not trusted.')\n                        self.onAuthFailed()\n                    elif message.status.internal_value == 0xc000018d:  # STATUS_TRUSTED_RELATIONSHIP_FAILURE\n                        self.has_authenticated = False\n                        self.log.info('Authentication (with extended security) failed. Workstation not trusted.')\n                        self.onAuthFailed()\n                    else:\n                        raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status.internal_value,\n                                            message.raw_data, message)\n                else:\n                    if message.status.internal_value == 0:\n                        self.log.debug('SMB uid is now %d', message.uid)\n                        self.uid = message.uid\n                        self.has_authenticated = True\n                        self.log.info('Authentication (without extended security) successful!')\n                        self.onAuthOK()\n                    else:\n                        self.has_authenticated = False\n                        self.log.info('Authentication (without extended security) failed. Please check username and password')\n                        self.onAuthFailed()\n            elif message.command == SMB_COM_TREE_CONNECT_ANDX:\n                try:\n                    req = self.pending_requests[message.mid]\n                except KeyError:\n                    pass\n                else:\n                    if not message.status.hasError:\n                        self.connected_trees[req.kwargs['path']] = message.tid\n\n            req = self.pending_requests.pop(message.mid, None)\n            if req:\n                req.callback(message, **req.kwargs)\n                return True\n\n\n    def _updateServerInfo_SMB1(self, payload):\n        self.capabilities = payload.capabilities\n        self.security_mode = payload.security_mode\n        self.max_raw_size = payload.max_raw_size\n        self.max_buffer_size = payload.max_buffer_size\n        self.max_mpx_count = payload.max_mpx_count\n        self.use_plaintext_authentication = not bool(payload.security_mode & NEGOTIATE_ENCRYPT_PASSWORDS)\n\n        if self.use_plaintext_authentication:\n            self.log.warning('Remote server only supports plaintext authentication. Your password can be stolen easily over the network.')\n\n\n    def _handleSessionChallenge_SMB1(self, message, ntlm_token):\n        assert message.hasExtendedSecurity\n\n        if message.uid and not self.uid:\n            self.uid = message.uid\n\n        server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)\n        if self.use_ntlm_v2:\n            self.log.info('Performing NTLMv2 authentication (with extended security) with server challenge "%s"', binascii.hexlify(server_challenge))\n            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,\n                                                                                                         self.username,\n                                                                                                         server_challenge,\n                                                                                                         server_info,\n                                                                                                         self.domain)\n\n        else:\n            self.log.info('Performing NTLMv1 authentication (with extended security) with server challenge "%s"', binascii.hexlify(server_challenge))\n            nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)\n\n        ntlm_data, signing_session_key = ntlm.generateAuthenticateMessage(server_flags,\n                                                                          nt_challenge_response,\n                                                                          lm_challenge_response,\n                                                                          session_key,\n                                                                          self.username,\n                                                                          self.domain,\n                                                                          self.my_name)\n\n        if self.log.isEnabledFor(logging.DEBUG):\n            self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))\n            self.log.debug('LM challenge response is "%s" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))\n\n        blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n        self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(0, blob)))\n\n        if self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_REQUIRE:\n            self.log.info('Server requires all SMB messages to be signed')\n            self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)\n        elif self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_ENABLE:\n            self.log.info('Server supports SMB signing')\n            self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)\n        else:\n            self.is_signing_active = False\n\n        if self.is_signing_active:\n            self.log.info("SMB signing activated. All SMB messages will be signed.")\n            self.signing_session_key = signing_session_key\n            if self.capabilities & CAP_EXTENDED_SECURITY:\n                self.signing_challenge_response = None\n            else:\n                self.signing_challenge_response = blob\n        else:\n            self.log.info("SMB signing deactivated. SMB messages will NOT be signed.")\n\n\n    def _handleNegotiateResponse_SMB1(self, message):\n        if message.uid and not self.uid:\n            self.uid = message.uid\n\n        if message.hasExtendedSecurity or message.payload.supportsExtendedSecurity:\n            ntlm_data = ntlm.generateNegotiateMessage()\n            blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n            self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(message.payload.session_key, blob)))\n        else:\n            nt_password, _, _ = ntlm.generateChallengeResponseV1(self.password, message.payload.challenge, False)\n            self.log.info('Performing NTLMv1 authentication (without extended security) with challenge "%s" and hashed password of "%s"',\n                          binascii.hexlify(message.payload.challenge),\n                          binascii.hexlify(nt_password))\n            self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__NoSecurityExtension(message.payload.session_key,\n                                                                                           self.username,\n                                                                                           nt_password,\n                                                                                           True,\n                                                                                           self.domain)))\n\n    def _listShares_SMB1(self, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = 'IPC$'\n        messages_history = [ ]\n\n        def connectSrvSvc(tid):\n            m = SMBMessage(ComNTCreateAndxRequest('\\\\srvsvc',\n                                                  flags = NT_CREATE_REQUEST_EXTENDED_RESPONSE,\n                                                  access_mask = READ_CONTROL | FILE_WRITE_ATTRIBUTES | FILE_READ_ATTRIBUTES | FILE_WRITE_EA | FILE_READ_EA | FILE_APPEND_DATA | FILE_WRITE_DATA | FILE_READ_DATA,\n                                                  share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n                                                  create_disp = FILE_OPEN,\n                                                  create_options = FILE_OPEN_NO_RECALL | FILE_NON_DIRECTORY_FILE,\n                                                  impersonation = SEC_IMPERSONATE,\n                                                  security_flags = 0))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def connectSrvSvcCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if not create_message.status.hasError:\n                call_id = self._getNextRPCCallID()\n                # See [MS-CIFS]: 2.2.5.6.1 for more information on TRANS_TRANSACT_NMPIPE (0x0026) parameters\n                setup_bytes = struct.pack('<HH', 0x0026, create_message.payload.fid)\n                # The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]\n                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream\n                data_bytes = \\\n                    binascii.unhexlify(b"""05 00 0b 03 10 00 00 00 48 00 00 00""".replace(b' ', b'')) + \\\n                    struct.pack('<I', call_id) + \\\n                    binascii.unhexlify(b"""\nb8 10 b8 10 00 00 00 00 01 00 00 00 00 00 01 00\nc8 4f 32 4b 70 16 d3 01 12 78 5a 47 bf 6e e1 88\n03 00 00 00 04 5d 88 8a eb 1c c9 11 9f e8 08 00\n2b 10 48 60 02 00 00 00""".replace(b' ', b'').replace(b'\\n', b''))\n                m = SMBMessage(ComTransactionRequest(max_params_count = 0,\n                                                     max_data_count = 4280,\n                                                     max_setup_count = 0,\n                                                     data_bytes = data_bytes,\n                                                     setup_bytes = setup_bytes))\n                m.tid = create_message.tid\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, fid = create_message.payload.fid)\n                self._pushToArray(messages_history, m)\n            else:\n                errback(OperationFailure('Failed to list shares: Unable to locate Server Service RPC endpoint', messages_history))\n\n        def rpcBindCB(trans_message, **kwargs):\n            self._pushToArray(messages_history, trans_message)\n            if not trans_message.status.hasError:\n                call_id = self._getNextRPCCallID()\n\n                padding = b''\n                server_len = len(self.remote_name) + 1\n                server_bytes_len = server_len * 2\n                if server_len % 2 != 0:\n                    padding = b'\\0\\0'\n                    server_bytes_len += 2\n\n                # See [MS-CIFS]: 2.2.5.6.1 for more information on TRANS_TRANSACT_NMPIPE (0x0026) parameters\n                setup_bytes = struct.pack('<HH', 0x0026, kwargs['fid'])\n                # The data bytes are the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.\n                # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream\n                data_bytes = \\\n                    binascii.unhexlify(b"""05 00 00 03 10 00 00 00""".replace(b' ', b'')) + \\\n                    struct.pack('<HHI', 72+server_bytes_len, 0, call_id) + \\\n                    binascii.unhexlify(b"""4c 00 00 00 00 00 0f 00 00 00 02 00""".replace(b' ', b'')) + \\\n                    struct.pack('<III', server_len, 0, server_len) + \\\n                    (self.remote_name + '\\0').encode('UTF-16LE') + padding + \\\n                    binascii.unhexlify(b"""\n01 00 00 00 01 00 00 00 04 00 02 00 00 00 00 00\n00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00\n""".replace(b' ', b'').replace(b'\\n', b''))\n                m = SMBMessage(ComTransactionRequest(max_params_count = 0,\n                                                     max_data_count = 4280,\n                                                     max_setup_count = 0,\n                                                     data_bytes = data_bytes,\n                                                     setup_bytes = setup_bytes))\n                m.tid = trans_message.tid\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid'])\n                self._pushToArray(messages_history, m)\n            else:\n                closeFid(trans_message.tid, kwargs['fid'])\n                errback(OperationFailure('Failed to list shares: Unable to bind to Server Service RPC endpoint', messages_history))\n\n        def listShareResultsCB(result_message, **kwargs):\n            self._pushToArray(messages_history, result_message)\n            if not result_message.status.hasError:\n                # The payload.data_bytes will contain the results of the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.\n                data_bytes = result_message.payload.data_bytes\n\n                if data_bytes[3] & 0x02 == 0:\n                    sendReadRequest(result_message.tid, kwargs['fid'], data_bytes)\n                else:\n                    decodeResults(result_message.tid, kwargs['fid'], data_bytes)\n            else:\n                closeFid(result_message.tid, kwargs['fid'])\n                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))\n\n        def decodeResults(tid, fid, data_bytes):\n            shares_count = struct.unpack('<I', data_bytes[36:40])[0]\n            results = [ ]     # A list of SharedDevice instances\n            offset = 36 + 12  # You need to study the byte stream to understand the meaning of these constants\n            for i in range(0, shares_count):\n                results.append(SharedDevice(struct.unpack('<I', data_bytes[offset+4:offset+8])[0], None, None))\n                offset += 12\n\n            for i in range(0, shares_count):\n                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])\n                offset += 12\n                results[i].name = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset:offset+length*2-2])\n\n                if length % 2 != 0:\n                    offset += (length * 2 + 2)\n                else:\n                    offset += (length * 2)\n\n                max_length, _, length = struct.unpack('<III', data_bytes[offset:offset+12])\n                offset += 12\n                results[i].comments = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset:offset+length*2-2])\n\n                if length % 2 != 0:\n                    offset += (length * 2 + 2)\n                else:\n                    offset += (length * 2)\n\n            closeFid(tid, fid)\n            callback(results)\n\n        def sendReadRequest(tid, fid, data_bytes):\n            read_count = min(4280, self.max_raw_size - 2)\n            m = SMBMessage(ComReadAndxRequest(fid = fid,\n                                              offset = 0,\n                                              max_return_bytes_count = read_count,\n                                              min_return_bytes_count = read_count))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, fid = fid, data_bytes = data_bytes)\n\n        def readCB(read_message, **kwargs):\n            self._pushToArray(messages_history, read_message)\n            if not read_message.status.hasError:\n                data_bytes = read_message.payload.data\n\n                if data_bytes[3] & 0x02 == 0:\n                    sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:])\n                else:\n                    decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:])\n            else:\n                closeFid(read_message.tid, kwargs['fid'])\n                errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history))\n\n        def closeFid(tid, fid):\n            m = SMBMessage(ComCloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self._pushToArray(messages_history, m)\n\n        def connectCB(connect_message, **kwargs):\n            self._pushToArray(messages_history, connect_message)\n            if not connect_message.status.hasError:\n                self.connected_trees[path] = connect_message.tid\n                connectSrvSvc(connect_message.tid)\n            else:\n                errback(OperationFailure('Failed to list shares: Unable to connect to IPC$', messages_history))\n\n        m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), path ), SERVICE_ANY, ''))\n        self._sendSMBMessage(m)\n        self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = path)\n        self._pushToArray(messages_history, m)\n\n    def _listPath_SMB1(self, service_name, path, callback, errback, search, pattern, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if not path.endswith('\\\\'):\n            path += '\\\\'\n        messages_history = [ ]\n        results = [ ]\n\n        def sendFindFirst(tid, support_dfs=False):\n            setup_bytes = struct.pack('<H', 0x0001)  # TRANS2_FIND_FIRST2 sub-command. See [MS-CIFS]: 2.2.6.2.1\n            params_bytes = \\\n                struct.pack('<HHHHI',\n                            search & 0xFFFF, # SearchAttributes (need to restrict the values due to introduction of SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n                            100,    # SearchCount\n                            0x0006, # Flags: SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS\n                            0x0104, # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO\n                            0x0000) # SearchStorageType (seems to be ignored by Windows)\n            if support_dfs:\n                params_bytes += ("\\\\" + self.remote_name + "\\\\" + service_name + path + pattern + '\\0').encode('UTF-16LE')\n            else:\n                params_bytes += (path + pattern + '\\0').encode('UTF-16LE')\n\n            m = SMBMessage(ComTransaction2Request(max_params_count = 10,\n                                                  max_data_count = 16644,\n                                                  max_setup_count = 0,\n                                                  params_bytes = params_bytes,\n                                                  setup_bytes = setup_bytes))\n            m.tid = tid\n            if support_dfs:\n                m.flags2 |= SMB_FLAGS2_DFS\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, findFirstCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def decodeFindStruct(data_bytes):\n            # SMB_FIND_FILE_BOTH_DIRECTORY_INFO structure. See [MS-CIFS]: 2.2.8.1.7 and [MS-SMB]: 2.2.8.1.1\n            info_format = '<IIQQQQQQIIIBB24s'\n            info_size = struct.calcsize(info_format)\n\n            data_length = len(data_bytes)\n            offset = 0\n            while offset < data_length:\n                if offset + info_size > data_length:\n                    return data_bytes[offset:]\n\n                next_offset, _, \\\n                create_time, last_access_time, last_write_time, last_attr_change_time, \\\n                file_size, alloc_size, file_attributes, filename_length, ea_size, \\\n                short_name_length, _, short_name = struct.unpack(info_format, data_bytes[offset:offset+info_size])\n\n                offset2 = offset + info_size\n                if offset2 + filename_length > data_length:\n                    return data_bytes[offset:]\n\n                filename = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset2:offset2+filename_length])\n                short_name = DataFaultToleranceStrategy.data_bytes_decode(short_name)\n\n                accept_result = False\n                if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc\n                    accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n                else:\n                    accept_result = (file_attributes & search) > 0\n                if accept_result:\n                    results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),\n                                              convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),\n                                              file_size, alloc_size, file_attributes, short_name, filename))\n\n                if next_offset:\n                    offset += next_offset\n                else:\n                    break\n            return b''\n\n        def findFirstCB(find_message, **kwargs):\n            self._pushToArray(messages_history, find_message)\n            if not find_message.status.hasError:\n                if 'total_count' not in kwargs:\n                    # TRANS2_FIND_FIRST2 response. [MS-CIFS]: 2.2.6.2.2\n                    sid, search_count, end_of_search, _, last_name_offset = struct.unpack('<HHHHH', find_message.payload.params_bytes[:10])\n                    kwargs.update({ 'sid': sid, 'end_of_search': end_of_search, 'last_name_offset': last_name_offset, 'data_buf': b'' })\n                else:\n                    sid, end_of_search, last_name_offset = kwargs['sid'], kwargs['end_of_search'], kwargs['last_name_offset']\n\n                send_next = True\n                if find_message.payload.data_bytes:\n                    d = decodeFindStruct(kwargs['data_buf'] + find_message.payload.data_bytes)\n                    if 'data_count' not in kwargs:\n                        if len(find_message.payload.data_bytes) != find_message.payload.total_data_count:\n                            kwargs.update({ 'data_count': len(find_message.payload.data_bytes),\n                                            'total_count': find_message.payload.total_data_count,\n                                            'data_buf': d,\n                                            })\n                            send_next = False\n                    else:\n                        kwargs['data_count'] += len(find_message.payload.data_bytes)\n                        kwargs['total_count'] = min(find_message.payload.total_data_count, kwargs['total_count'])\n                        kwargs['data_buf'] = d\n                        if kwargs['data_count'] != kwargs['total_count']:\n                            send_next = False\n\n                if not send_next:\n                    self.pending_requests[find_message.mid] = _PendingRequest(find_message.mid, expiry_time, findFirstCB, errback, **kwargs)\n                elif end_of_search:\n                    callback(results)\n                else:\n                    sendFindNext(find_message.tid, sid, 0, results[-1].filename, kwargs.get('support_dfs', False))\n            else:\n                if find_message.status.internal_value == 0xC000000F:  # [MS-ERREF]: STATUS_NO_SUCH_FILE\n                    # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files\n                    callback([ ])\n                else:\n                    errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history))\n\n        def sendFindNext(tid, sid, resume_key, resume_file, support_dfs):\n            setup_bytes = struct.pack('<H', 0x0002)  # TRANS2_FIND_NEXT2 sub-command. See [MS-CIFS]: 2.2.6.3.1\n            params_bytes = \\\n                struct.pack('<HHHIH',\n                            sid,        # SID\n                            100,        # SearchCount\n                            0x0104,     # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO\n                            resume_key, # ResumeKey\n                            0x0006)     # Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS\n            params_bytes += (resume_file+'\\0').encode('UTF-16LE')\n\n            m = SMBMessage(ComTransaction2Request(max_params_count = 10,\n                                                  max_data_count = 16644,\n                                                  max_setup_count = 0,\n                                                  params_bytes = params_bytes,\n                                                  setup_bytes = setup_bytes))\n            m.tid = tid\n            if support_dfs:\n                m.flags2 |= SMB_FLAGS2_DFS\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, findNextCB, errback, sid = sid, support_dfs = support_dfs)\n            self._pushToArray(messages_history, m)\n\n        def findNextCB(find_message, **kwargs):\n            self._pushToArray(messages_history, find_message)\n            if not find_message.status.hasError:\n                if 'total_count' not in kwargs:\n                    # TRANS2_FIND_NEXT2 response. [MS-CIFS]: 2.2.6.3.2\n                    search_count, end_of_search, _, last_name_offset = struct.unpack('<HHHH', find_message.payload.params_bytes[:8])\n                    kwargs.update({ 'end_of_search': end_of_search, 'last_name_offset': last_name_offset, 'data_buf': b'' })\n                else:\n                    end_of_search, last_name_offset = kwargs['end_of_search'], kwargs['last_name_offset']\n\n                send_next = True\n                if find_message.payload.data_bytes:\n                    d = decodeFindStruct(kwargs['data_buf'] + find_message.payload.data_bytes)\n                    if 'data_count' not in kwargs:\n                        if len(find_message.payload.data_bytes) != find_message.payload.total_data_count:\n                            kwargs.update({ 'data_count': len(find_message.payload.data_bytes),\n                                            'total_count': find_message.payload.total_data_count,\n                                            'data_buf': d,\n                                            })\n                            send_next = False\n                    else:\n                        kwargs['data_count'] += len(find_message.payload.data_bytes)\n                        kwargs['total_count'] = min(find_message.payload.total_data_count, kwargs['total_count'])\n                        kwargs['data_buf'] = d\n                        if kwargs['data_count'] != kwargs['total_count']:\n                            send_next = False\n\n                if not send_next:\n                    self.pending_requests[find_message.mid] = _PendingRequest(find_message.mid, expiry_time, findNextCB, errback, **kwargs)\n                elif end_of_search:\n                    callback(results)\n                else:\n                    sendFindNext(find_message.tid, kwargs['sid'], 0, results[-1].filename, kwargs.get('support_dfs', False))\n            else:\n                errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history))\n\n        def sendDFSReferral(tid):\n            setup_bytes = struct.pack('<H', 0x0010)  # TRANS2_GET_DFS_REFERRAL sub-command. See [MS-CIFS]: 2.2.6.16.1\n            params_bytes = struct.pack('<H', 3)      # Max referral level 3\n            params_bytes += ("\\\\" + self.remote_name + "\\\\" + service_name).encode('UTF-16LE')\n\n            m = SMBMessage(ComTransaction2Request(max_params_count = 10,\n                                                  max_data_count = 16644,\n                                                  max_setup_count = 0,\n                                                  params_bytes = params_bytes,\n                                                  setup_bytes = setup_bytes))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, dfsReferralCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def dfsReferralCB(dfs_message, **kwargs):\n            sendFindFirst(dfs_message.tid, True)\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    if connect_message.payload.optional_support & SMB_TREE_CONNECTX_SUPPORT_DFS:\n                        sendDFSReferral(connect_message.tid)\n                    else:\n                        sendFindFirst(connect_message.tid, False)\n                else:\n                    errback(OperationFailure('Failed to list %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendFindFirst(self.connected_trees[service_name])\n\n    def _getAttributes_SMB1(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        messages_history = [ ]\n\n        def sendQuery(tid):\n            setup_bytes = struct.pack('<H', 0x0005)  # TRANS2_QUERY_PATH_INFORMATION sub-command. See [MS-CIFS]: 2.2.6.6.1\n            params_bytes = \\\n                struct.pack('<HI',\n                            0x0107, # SMB_QUERY_FILE_ALL_INFO ([MS-CIFS] 2.2.2.3.3)\n                            0x0000) # Reserved\n            params_bytes += (path + '\\0').encode('UTF-16LE')\n\n            m = SMBMessage(ComTransaction2Request(max_params_count = 2,\n                                                  max_data_count = 65535,\n                                                  max_setup_count = 0,\n                                                  params_bytes = params_bytes,\n                                                  setup_bytes = setup_bytes))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def queryCB(query_message, **kwargs):\n            self._pushToArray(messages_history, query_message)\n            if not query_message.status.hasError:\n                info_format = '<QQQQIIQQ'\n                info_size = struct.calcsize(info_format)\n                create_time, last_access_time, last_write_time, last_attr_change_time, \\\n                file_attributes, _, alloc_size, file_size = struct.unpack(info_format, query_message.payload.data_bytes[:info_size])\n                filename = self._extractLastPathComponent(path)\n\n                info = SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),\n                                  file_size, alloc_size, file_attributes, filename, filename)\n                callback(info)\n            else:\n                errback(OperationFailure('Failed to get attributes for %s on %s: Read failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendQuery(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendQuery(self.connected_trees[service_name])\n\n    def _getSecurity_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30):\n        raise NotReadyError('getSecurity is not yet implemented for SMB1')\n\n    def _retrieveFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n        return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0, -1, timeout, show_progress, tqdm_kwargs)\n\n    def _retrieveFileFromOffset_SMB1(self, service_name, path, file_obj, callback, errback, starting_offset, max_length, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        path = path.replace('/', '\\\\')\n        messages_history = [ ]\n\n        def sendOpen(tid):\n            m = SMBMessage(ComOpenAndxRequest(filename = path,\n                                              access_mode = 0x0040,  # Sharing mode: Deny nothing to others\n                                              open_mode = 0x0001,    # Failed if file does not exist\n                                              search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM,\n                                              timeout = timeout * 1000))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def openCB(open_message, **kwargs):\n            self._pushToArray(messages_history, open_message)\n            if not open_message.status.hasError:\n                if max_length == 0:\n                    closeFid(open_message.tid, open_message.payload.fid)\n                    callback(( file_obj, open_message.payload.file_attributes, 0 ))\n                else:\n                    if show_progress and max_length > 0:\n                        tqdm_kwargs.setdefault("total", max_length)\n                        tqdm_kwargs.setdefault("unit", "B")\n                        tqdm_kwargs.setdefault("unit_scale", True)\n                        tqdm_kwargs.setdefault("unit_divisor", 1024)\n                        tqdm_kwargs.setdefault("desc", f"Downloading {path}")\n                        self.pbar = tqdm(**tqdm_kwargs)\n                    sendRead(open_message.tid, open_message.payload.fid, starting_offset, open_message.payload.file_attributes, 0, max_length)\n            else:\n                errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n        def sendRead(tid, fid, offset, file_attributes, read_len, remaining_len):\n            read_count = self.max_raw_size - 2\n            m = SMBMessage(ComReadAndxRequest(fid = fid,\n                                              offset = offset,\n                                              max_return_bytes_count = read_count,\n                                              min_return_bytes_count = min(0xFFFF, read_count)))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, fid = fid, offset = offset, file_attributes = file_attributes,\n                                                           read_len = read_len, remaining_len = remaining_len)\n\n        def readCB(read_message, **kwargs):\n            # To avoid crazy memory usage when retrieving large files, we do not save every read_message in messages_history.\n            if not read_message.status.hasError:\n                read_len = kwargs['read_len']\n                remaining_len = kwargs['remaining_len']\n                data_len = read_message.payload.data_length\n                if max_length > 0:\n                    if data_len > remaining_len:\n                        file_obj.write(read_message.payload.data[:remaining_len])\n                        read_len += remaining_len\n                        remaining_len = 0\n                    else:\n                        file_obj.write(read_message.payload.data)\n                        remaining_len -= data_len\n                        read_len += data_len\n                else:\n                    file_obj.write(read_message.payload.data)\n                    read_len += data_len\n\n                if self.pbar:\n                    self.pbar.update(data_len)\n\n                if (max_length > 0 and remaining_len <= 0) or data_len < (self.max_raw_size - 2):\n                    if self.pbar:\n                        self.pbar.close()\n                        self.pbar = None\n                    closeFid(read_message.tid, kwargs['fid'])\n                    callback(( file_obj, kwargs['file_attributes'], read_len ))  # Note that this is a tuple of 3-elements\n                else:\n                    sendRead(read_message.tid, kwargs['fid'], kwargs['offset']+data_len, kwargs['file_attributes'], read_len, remaining_len)\n            else:\n                if self.pbar:\n                    self.pbar.close()\n                    self.pbar = None\n                self._pushToArray(messages_history, read_message)\n                closeFid(read_message.tid, kwargs['fid'])\n                errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))\n\n        def closeFid(tid, fid):\n            m = SMBMessage(ComCloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self._pushToArray(messages_history, m)\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendOpen(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendOpen(self.connected_trees[service_name])\n\n    def _storeFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n        self._storeFileFromOffset_SMB1(service_name, path, file_obj, callback, errback, 0, True, timeout, show_progress, tqdm_kwargs)\n\n    def _storeFileFromOffset_SMB1(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        path = path.replace('/', '\\\\')\n        messages_history = [ ]\n\n        def sendOpen(tid):\n            m = SMBMessage(ComOpenAndxRequest(filename = path,\n                                              access_mode = 0x0041,  # Sharing mode: Deny nothing to others + Open for writing\n                                              open_mode = 0x0012 if truncate else 0x0011,    # Create file if file does not exist. Overwrite or append depending on truncate parameter.\n                                              search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM,\n                                              timeout = timeout * 1000))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def openCB(open_message, **kwargs):\n            self._pushToArray(messages_history, open_message)\n            if not open_message.status.hasError:\n                if show_progress:\n                    tqdm_kwargs.setdefault("unit", "B")\n                    tqdm_kwargs.setdefault("unit_scale", True)\n                    tqdm_kwargs.setdefault("unit_divisor", 1024)\n                    tqdm_kwargs.setdefault("desc", f"Uploading {path}")\n                    self.pbar = tqdm(**tqdm_kwargs)\n                sendWrite(open_message.tid, open_message.payload.fid, starting_offset)\n            else:\n                errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n        def sendWrite(tid, fid, offset):\n            # [MS-SMB] 2.2.4.5.2.2: The total SMB message size (inclusive of SMB header) must be not exceed the max_buffer_size.\n            write_count = min(self.max_buffer_size-64, 0xFFFF-64) # SMB header is 32-bytes. We factor in another 32-bytes for the message parameter block\n            data_bytes = file_obj.read(write_count)\n            data_len = len(data_bytes)\n            if data_len > 0:\n                m = SMBMessage(ComWriteAndxRequest(fid = fid, offset = offset, data_bytes = data_bytes))\n                m.tid = tid\n                self._sendSMBMessage(m)\n                self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, fid = fid, offset = offset+data_len)\n            else:\n                if self.pbar:\n                    self.pbar.close()\n                    self.pbar = None\n                closeFid(tid, fid)\n                callback(( file_obj, offset ))  # Note that this is a tuple of 2-elements\n\n        def writeCB(write_message, **kwargs):\n            # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.\n            if not write_message.status.hasError:\n                if self.pbar:\n                    self.pbar.update(kwargs['offset'])\n                sendWrite(write_message.tid, kwargs['fid'], kwargs['offset'])\n            else:\n                if self.pbar:\n                    self.pbar.close()\n                    self.pbar = None\n                self._pushToArray(messages_history, write_message)\n                closeFid(write_message.tid, kwargs['fid'])\n                errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n        def closeFid(tid, fid):\n            m = SMBMessage(ComCloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self._pushToArray(messages_history, m)\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendOpen(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendOpen(self.connected_trees[service_name])\n\n    def _deleteFiles_SMB1(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        pattern = None\n        path = path_file_pattern.replace('/', '\\\\')\n        if path.startswith('\\\\'):\n            path = path[1:]\n        if path.endswith('\\\\'):\n            path = path[:-1]\n        else:\n            path_components = path.split('\\\\')\n            if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1:\n                path = '\\\\'.join(path_components[:-1])\n                pattern = path_components[-1]\n        messages_history, files_queue = [ ], [ ]\n\n        if pattern is None:\n            path_components = path.split('\\\\')\n            if len(path_components) > 1:\n                files_queue.append(( '\\\\'.join(path_components[:-1]), path_components[-1] ))\n            else:\n                files_queue.append(( '', path ))\n\n        def deleteCB(path):\n            if files_queue:\n                p, filename = files_queue.pop(0)\n                if filename:\n                    if p:\n                        filename = p + '\\\\' + filename\n                    self._deleteFiles_SMB1__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout)\n                else:\n                    self._deleteDirectory_SMB1(service_name, p, deleteCB, errback, timeout = 30)\n            else:\n                callback(path_file_pattern)\n\n        def listCB(files_list):\n            files_queue.extend(files_list)\n            deleteCB(None)\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    if files_queue:\n                        deleteCB(None)\n                    else:\n                        self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n                else:\n                    errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            if files_queue:\n                deleteCB(None)\n            else:\n                self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n\n    def _deleteFiles_SMB1__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30):\n        folder_queue = [ ]\n        files_list = [ ]\n        current_path = [ path ]\n        search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL\n\n        def listCB(results):\n            files = [ ]\n            for f in filter(lambda x: x.filename not in [ '.', '..' ], results):\n                if f.isDirectory:\n                    if delete_matching_folders:\n                        folder_queue.append(current_path[0]+'\\\\'+f.filename)\n                else:\n                    files.append(( current_path[0], f.filename ))\n            if current_path[0]!=path and delete_matching_folders:\n                files.append(( current_path[0], None ))\n\n            if files:\n                files_list[0:0] = files\n\n            if folder_queue:\n                p = folder_queue.pop()\n                current_path[0] = p\n                self._listPath_SMB1(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30)\n            else:\n                callback(files_list)\n\n        self._listPath_SMB1(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout)\n\n    def _deleteFiles_SMB1__del(self, service_name, tid, path, callback, errback, timeout = 30):\n        messages_history = [ ]\n\n        def sendDelete(tid):\n            m = SMBMessage(ComDeleteRequest(filename_pattern = path,\n                                            search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def deleteCB(delete_message, **kwargs):\n            self._pushToArray(messages_history, delete_message)\n            if not delete_message.status.hasError:\n                callback(path)\n            elif delete_message.status.internal_value == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE\n                # If there are no matching files, we just treat as success instead of failing\n                callback(path)\n            elif delete_message.status.internal_value == 0xC00000BA: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY\n                errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history))\n            elif delete_message.status.internal_value == 0xC0000034: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID\n                errback(OperationFailure('Failed to delete %s on %s: Path not found' % ( path, service_name ), messages_history))\n            else:\n                errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n        sendDelete(tid)\n\n    def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, file_attributes=ATTR_NORMAL, timeout = 30):\n        raise NotReadyError('resetFileAttributes is not yet implemented for SMB1')\n\n    def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        path = path.replace('/', '\\\\')\n        messages_history = [ ]\n\n        def sendCreate(tid):\n            m = SMBMessage(ComCreateDirectoryRequest(path))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def createCB(create_message, **kwargs):\n            self._pushToArray(messages_history, create_message)\n            if not create_message.status.hasError:\n                callback(path)\n            else:\n                errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendCreate(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendCreate(self.connected_trees[service_name])\n\n    def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        path = path.replace('/', '\\\\')\n        messages_history = [ ]\n\n        def sendDelete(tid):\n            m = SMBMessage(ComDeleteDirectoryRequest(path))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def deleteCB(delete_message, **kwargs):\n            self._pushToArray(messages_history, delete_message)\n            if not delete_message.status.hasError:\n                callback(path)\n            else:\n                errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendDelete(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to delete directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendDelete(self.connected_trees[service_name])\n\n    def _rename_SMB1(self, service_name, old_path, new_path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        new_path = new_path.replace('/', '\\\\')\n        old_path = old_path.replace('/', '\\\\')\n        messages_history = [ ]\n\n        def sendRename(tid):\n            m = SMBMessage(ComRenameRequest(old_path = old_path,\n                                            new_path = new_path,\n                                            search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def renameCB(rename_message, **kwargs):\n            self._pushToArray(messages_history, rename_message)\n            if not rename_message.status.hasError:\n                callback(( old_path, new_path ))  # Note that this is a tuple of 2-elements\n            else:\n                errback(OperationFailure('Failed to rename %s on %s: Rename failed' % ( old_path, service_name ), messages_history))\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendRename(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to rename %s on %s: Unable to connect to shared device' % ( old_path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendRename(self.connected_trees[service_name])\n\n    def _listSnapshots_SMB1(self, service_name, path, callback, errback, timeout = 30):\n        if not self.has_authenticated:\n            raise NotReadyError('SMB connection not authenticated')\n\n        expiry_time = time.time() + timeout\n        path = path.replace('/', '\\\\')\n        if not path.endswith('\\\\'):\n            path += '\\\\'\n        messages_history = [ ]\n        results = [ ]\n\n        def sendOpen(tid):\n            m = SMBMessage(ComOpenAndxRequest(filename = path,\n                                              access_mode = 0x0040,  # Sharing mode: Deny nothing to others\n                                              open_mode = 0x0001,    # Failed if file does not exist\n                                              search_attributes = 0,\n                                              timeout = timeout * 1000))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)\n            self._pushToArray(messages_history, m)\n\n        def openCB(open_message, **kwargs):\n            self._pushToArray(messages_history, open_message)\n            if not open_message.status.hasError:\n                sendEnumSnapshots(open_message.tid, open_message.payload.fid)\n            else:\n                errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open path' % ( path, service_name ), messages_history))\n\n        def sendEnumSnapshots(tid, fid):\n            # [MS-CIFS]: 2.2.7.2\n            # [MS-SMB]: 2.2.7.2.1\n            setup_bytes = struct.pack('<IHBB',\n                                      0x00144064,  # [MS-SMB]: 2.2.7.2.1\n                                      fid,         # FID\n                                      0x01,        # IsFctl\n                                      0)           # IsFlags\n            m = SMBMessage(ComNTTransactRequest(function = 0x0002,  # NT_TRANSACT_IOCTL. [MS-CIFS]: 2.2.7.2.1\n                                                max_params_count = 0,\n                                                max_data_count = 0xFFFF,\n                                                max_setup_count = 0,\n                                                setup_bytes = setup_bytes))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, enumSnapshotsCB, errback, tid = tid, fid = fid)\n            self._pushToArray(messages_history, m)\n\n        def enumSnapshotsCB(enum_message, **kwargs):\n            self._pushToArray(messages_history, enum_message)\n            if not enum_message.status.hasError:\n                results = [ ]\n                snapshots_count = struct.unpack('<I', enum_message.payload.data_bytes[4:8])[0]\n                for i in range(0, snapshots_count):\n                    s = DataFaultToleranceStrategy.data_bytes_decode(enum_message.payload.data_bytes[12+i*50:12+48+i*50])\n                    results.append(datetime(*list(map(int, ( s[5:9], s[10:12], s[13:15], s[16:18], s[19:21], s[22:24] )))))\n                closeFid(kwargs['tid'], kwargs['fid'])\n                callback(results)\n            else:\n                closeFid(kwargs['tid'], kwargs['fid'])\n                errback(OperationFailure('Failed to list snapshots %s on %s: Unable to list snapshots on path' % ( path, service_name ), messages_history))\n\n        def closeFid(tid, fid):\n            m = SMBMessage(ComCloseRequest(fid))\n            m.tid = tid\n            self._sendSMBMessage(m)\n            self._pushToArray(messages_history, m)\n\n        if service_name not in self.connected_trees:\n            def connectCB(connect_message, **kwargs):\n                self._pushToArray(messages_history, connect_message)\n                if not connect_message.status.hasError:\n                    self.connected_trees[service_name] = connect_message.tid\n                    sendOpen(connect_message.tid)\n                else:\n                    errback(OperationFailure('Failed to list snapshots %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n            m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n            self._sendSMBMessage(m)\n            self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n            self._pushToArray(messages_history, m)\n        else:\n            sendOpen(self.connected_trees[service_name])\n\n    def _echo_SMB1(self, data, callback, errback, timeout = 30):\n        messages_history = [ ]\n\n        if not isinstance(data, type(b'')):\n            raise TypeError('Echo data must be %s not %s' % (type(b'').__name__, type(data).__name__))\n\n        def echoCB(echo_message, **kwargs):\n            self._pushToArray(messages_history, echo_message)\n            if not echo_message.status.hasError:\n                callback(echo_message.payload.data)\n            else:\n                errback(OperationFailure('Echo failed', messages_history))\n\n        m = SMBMessage(ComEchoRequest(echo_data = data))\n        self._sendSMBMessage(m)\n        self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, echoCB, errback)\n        self._pushToArray(messages_history, m)\n\n    def _extractLastPathComponent(self, path):\n        return path.replace('\\\\', '/').split('/')[-1]\n\n    def _pushToArray(self, messages_history, message):\n        if len(messages_history) > 10:\n            messages_history.pop(0)\n        messages_history.append(message)\n\n
[docs]class SharedDevice:\n    """\n    Contains information about a single shared device on the remote server.\n\n    The following attributes are available:\n\n    * name : An unicode string containing the name of the shared device\n    * comments : An unicode string containing the user description of the shared device\n    """\n\n    # The following constants are taken from [MS-SRVS]: 2.2.2.4\n    # They are used to identify the type of shared resource from the results from the NetrShareEnum in Server Service RPC\n    DISK_TREE   = 0x00\n    PRINT_QUEUE = 0x01\n    COMM_DEVICE = 0x02\n    IPC         = 0x03\n\n    def __init__(self, type, name, comments):\n        self._type = type\n        self.name = name         #: An unicode string containing the name of the shared device\n        self.comments = comments #: An unicode string containing the user description of the shared device\n\n    @property\n    def type(self):\n        """\n        Returns one of the following integral constants.\n         - SharedDevice.DISK_TREE\n         - SharedDevice.PRINT_QUEUE\n         - SharedDevice.COMM_DEVICE\n         - SharedDevice.IPC\n        """\n        return self._type & 0xFFFF\n\n    @property\n    def isSpecial(self):\n        """\n        Returns True if this shared device is a special share reserved for interprocess communication (IPC$)\n        or remote administration of the server (ADMIN$). Can also refer to administrative shares such as\n        C$, D$, E$, and so forth\n        """\n        return bool(self._type & 0x80000000)\n\n    @property\n    def isTemporary(self):\n        """\n        Returns True if this is a temporary share that is not persisted for creation each time the file server initializes.\n        """\n        return bool(self._type & 0x40000000)\n\n    def __unicode__(self):\n        return 'Shared device: %s (type:0x%02x comments:%s)' % (self.name, self.type, self.comments )
\n\n\n
[docs]class SharedFile:\n    """\n    Contain information about a file/folder entry that is shared on the shared device.\n\n    As an application developer, you should not need to instantiate a *SharedFile* instance directly in your application.\n    These *SharedFile* instances are usually returned via a call to *listPath* method in :doc:`smb.SMBProtocol.SMBProtocolFactory<smb_SMBProtocolFactory>`.\n\n    If you encounter *SharedFile* instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond\n    to any files/folders on your remote shared device, it could be that the original filename on the file/folder entry on the shared device contains\n    one of these prohibited characters: "\\\\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).\n\n    The following attributes are available:\n\n    * create_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of creation of this file resource on the remote server\n    * last_access_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last access of this file resource on the remote server\n    * last_write_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last modification of this file resource on the remote server\n    * last_attr_change_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last attribute change of this file resource on the remote server\n    * file_size : File size in number of bytes\n    * alloc_size : Total number of bytes allocated to store this file\n    * file_attributes : A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.\n    * short_name : Unicode string containing the short name of this file (usually in 8.3 notation)\n    * filename : Unicode string containing the long filename of this file. Each OS has a limit to the length of this file name. On Windows, it is 256 characters.\n    * file_id : Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17\n    """\n\n    def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename, file_id=None):\n        self.create_time = create_time  #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of creation of this file resource on the remote server\n        self.last_access_time = last_access_time  #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last access of this file resource on the remote server\n        self.last_write_time = last_write_time    #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last modification of this file resource on the remote server\n        self.last_attr_change_time = last_attr_change_time  #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last attribute change of this file resource on the remote server\n        self.file_size = file_size   #: File size in number of bytes\n        self.alloc_size = alloc_size #: Total number of bytes allocated to store this file\n        self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.\n        self.short_name = short_name #: Unicode string containing the short name of this file (usually in 8.3 notation)\n        self.filename = filename     #: Unicode string containing the long filename of this file. Each OS has a limit to the length of this file name. On Windows, it is 256 characters.\n        self.file_id = file_id       #: Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17\n\n    @property\n    def isDirectory(self):\n        """A convenience property to return True if this file resource is a directory on the remote server"""\n        return bool(self.file_attributes & ATTR_DIRECTORY)\n\n    @property\n    def isReadOnly(self):\n        """A convenient property to return True if this file resource is read-only on the remote server"""\n        return bool(self.file_attributes & ATTR_READONLY)\n\n    @property\n    def isNormal(self):\n        """\n        A convenient property to return True if this is a normal file.\n\n        Note that pysmb defines a normal file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n        It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n        """\n        return (self.file_attributes==ATTR_NORMAL) or ((self.file_attributes & 0xff)==0)\n\n    def __unicode__(self):\n        return 'Shared file: %s (FileSize:%d bytes, isDirectory:%s)' % ( self.filename, self.file_size, self.isDirectory )
\n\n\nclass _PendingRequest:\n\n    def __init__(self, mid, expiry_time, callback, errback, **kwargs):\n        self.mid = mid\n        self.expiry_time = expiry_time\n        self.callback = callback\n        self.errback = errback\n        self.kwargs = kwargs\n
\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 5.0.1.\n
\n \n" }, { "path": "docs/html/_modules/smb/security_descriptors.html", "content": "\n\n\n \n \n \n smb.security_descriptors — pysmb 1.2.12 documentation\n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Source code for smb.security_descriptors

\n"""\nThis module implements security descriptors, and the partial structures\nused in them, as specified in [MS-DTYP].\n"""\n\nimport struct\n\n\n# Security descriptor control flags\n# [MS-DTYP]: 2.4.6\nSECURITY_DESCRIPTOR_OWNER_DEFAULTED = 0x0001\nSECURITY_DESCRIPTOR_GROUP_DEFAULTED = 0x0002\nSECURITY_DESCRIPTOR_DACL_PRESENT = 0x0004\nSECURITY_DESCRIPTOR_DACL_DEFAULTED = 0x0008\nSECURITY_DESCRIPTOR_SACL_PRESENT = 0x0010\nSECURITY_DESCRIPTOR_SACL_DEFAULTED = 0x0020\nSECURITY_DESCRIPTOR_SERVER_SECURITY = 0x0040\nSECURITY_DESCRIPTOR_DACL_TRUSTED = 0x0080\nSECURITY_DESCRIPTOR_DACL_COMPUTED_INHERITANCE_REQUIRED = 0x0100\nSECURITY_DESCRIPTOR_SACL_COMPUTED_INHERITANCE_REQUIRED = 0x0200\nSECURITY_DESCRIPTOR_DACL_AUTO_INHERITED = 0x0400\nSECURITY_DESCRIPTOR_SACL_AUTO_INHERITED = 0x0800\nSECURITY_DESCRIPTOR_DACL_PROTECTED = 0x1000\nSECURITY_DESCRIPTOR_SACL_PROTECTED = 0x2000\nSECURITY_DESCRIPTOR_RM_CONTROL_VALID = 0x4000\nSECURITY_DESCRIPTOR_SELF_RELATIVE = 0x8000\n\n# ACE types\n# [MS-DTYP]: 2.4.4.1\nACE_TYPE_ACCESS_ALLOWED = 0x00\nACE_TYPE_ACCESS_DENIED = 0x01\nACE_TYPE_SYSTEM_AUDIT = 0x02\nACE_TYPE_SYSTEM_ALARM = 0x03\nACE_TYPE_ACCESS_ALLOWED_COMPOUND = 0x04\nACE_TYPE_ACCESS_ALLOWED_OBJECT = 0x05\nACE_TYPE_ACCESS_DENIED_OBJECT = 0x06\nACE_TYPE_SYSTEM_AUDIT_OBJECT = 0x07\nACE_TYPE_SYSTEM_ALARM_OBJECT = 0x08\nACE_TYPE_ACCESS_ALLOWED_CALLBACK = 0x09\nACE_TYPE_ACCESS_DENIED_CALLBACK = 0x0A\nACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT = 0x0B\nACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT = 0x0C\nACE_TYPE_SYSTEM_AUDIT_CALLBACK = 0x0D\nACE_TYPE_SYSTEM_ALARM_CALLBACK = 0x0E\nACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT = 0x0F\nACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT = 0x10\nACE_TYPE_SYSTEM_MANDATORY_LABEL = 0x11\nACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE = 0x12\nACE_TYPE_SYSTEM_SCOPED_POLICY_ID = 0x13\n\n# ACE flags\n# [MS-DTYP]: 2.4.4.1\nACE_FLAG_OBJECT_INHERIT = 0x01\nACE_FLAG_CONTAINER_INHERIT = 0x02\nACE_FLAG_NO_PROPAGATE_INHERIT = 0x04\nACE_FLAG_INHERIT_ONLY = 0x08\nACE_FLAG_INHERITED = 0x10\nACE_FLAG_SUCCESSFUL_ACCESS = 0x40\nACE_FLAG_FAILED_ACCESS = 0x80\n\n# Pre-defined well-known SIDs\n# [MS-DTYP]: 2.4.2.4\nSID_NULL = "S-1-0-0"\nSID_EVERYONE = "S-1-1-0"\nSID_LOCAL = "S-1-2-0"\nSID_CONSOLE_LOGON = "S-1-2-1"\nSID_CREATOR_OWNER = "S-1-3-0"\nSID_CREATOR_GROUP = "S-1-3-1"\nSID_OWNER_SERVER = "S-1-3-2"\nSID_GROUP_SERVER = "S-1-3-3"\nSID_OWNER_RIGHTS = "S-1-3-4"\nSID_NT_AUTHORITY = "S-1-5"\nSID_DIALUP = "S-1-5-1"\nSID_NETWORK = "S-1-5-2"\nSID_BATCH = "S-1-5-3"\nSID_INTERACTIVE = "S-1-5-4"\nSID_SERVICE = "S-1-5-6"\nSID_ANONYMOUS = "S-1-5-7"\nSID_PROXY = "S-1-5-8"\nSID_ENTERPRISE_DOMAIN_CONTROLLERS = "S-1-5-9"\nSID_PRINCIPAL_SELF = "S-1-5-10"\nSID_AUTHENTICATED_USERS = "S-1-5-11"\nSID_RESTRICTED_CODE = "S-1-5-12"\nSID_TERMINAL_SERVER_USER = "S-1-5-13"\nSID_REMOTE_INTERACTIVE_LOGON = "S-1-5-14"\nSID_THIS_ORGANIZATION = "S-1-5-15"\nSID_IUSR = "S-1-5-17"\nSID_LOCAL_SYSTEM = "S-1-5-18"\nSID_LOCAL_SERVICE = "S-1-5-19"\nSID_NETWORK_SERVICE = "S-1-5-20"\nSID_COMPOUNDED_AUTHENTICATION = "S-1-5-21-0-0-0-496"\nSID_CLAIMS_VALID = "S-1-5-21-0-0-0-497"\nSID_BUILTIN_ADMINISTRATORS = "S-1-5-32-544"\nSID_BUILTIN_USERS = "S-1-5-32-545"\nSID_BUILTIN_GUESTS = "S-1-5-32-546"\nSID_POWER_USERS = "S-1-5-32-547"\nSID_ACCOUNT_OPERATORS = "S-1-5-32-548"\nSID_SERVER_OPERATORS = "S-1-5-32-549"\nSID_PRINTER_OPERATORS = "S-1-5-32-550"\nSID_BACKUP_OPERATORS = "S-1-5-32-551"\nSID_REPLICATOR = "S-1-5-32-552"\nSID_ALIAS_PREW2KCOMPACC = "S-1-5-32-554"\nSID_REMOTE_DESKTOP = "S-1-5-32-555"\nSID_NETWORK_CONFIGURATION_OPS = "S-1-5-32-556"\nSID_INCOMING_FOREST_TRUST_BUILDERS = "S-1-5-32-557"\nSID_PERFMON_USERS = "S-1-5-32-558"\nSID_PERFLOG_USERS = "S-1-5-32-559"\nSID_WINDOWS_AUTHORIZATION_ACCESS_GROUP = "S-1-5-32-560"\nSID_TERMINAL_SERVER_LICENSE_SERVERS = "S-1-5-32-561"\nSID_DISTRIBUTED_COM_USERS = "S-1-5-32-562"\nSID_IIS_IUSRS = "S-1-5-32-568"\nSID_CRYPTOGRAPHIC_OPERATORS = "S-1-5-32-569"\nSID_EVENT_LOG_READERS = "S-1-5-32-573"\nSID_CERTIFICATE_SERVICE_DCOM_ACCESS = "S-1-5-32-574"\nSID_RDS_REMOTE_ACCESS_SERVERS = "S-1-5-32-575"\nSID_RDS_ENDPOINT_SERVERS = "S-1-5-32-576"\nSID_RDS_MANAGEMENT_SERVERS = "S-1-5-32-577"\nSID_HYPER_V_ADMINS = "S-1-5-32-578"\nSID_ACCESS_CONTROL_ASSISTANCE_OPS = "S-1-5-32-579"\nSID_REMOTE_MANAGEMENT_USERS = "S-1-5-32-580"\nSID_WRITE_RESTRICTED_CODE = "S-1-5-33"\nSID_NTLM_AUTHENTICATION = "S-1-5-64-10"\nSID_SCHANNEL_AUTHENTICATION = "S-1-5-64-14"\nSID_DIGEST_AUTHENTICATION = "S-1-5-64-21"\nSID_THIS_ORGANIZATION_CERTIFICATE = "S-1-5-65-1"\nSID_NT_SERVICE = "S-1-5-80"\nSID_USER_MODE_DRIVERS = "S-1-5-84-0-0-0-0-0"\nSID_LOCAL_ACCOUNT = "S-1-5-113"\nSID_LOCAL_ACCOUNT_AND_MEMBER_OF_ADMINISTRATORS_GROUP = "S-1-5-114"\nSID_OTHER_ORGANIZATION = "S-1-5-1000"\nSID_ALL_APP_PACKAGES = "S-1-15-2-1"\nSID_ML_UNTRUSTED = "S-1-16-0"\nSID_ML_LOW = "S-1-16-4096"\nSID_ML_MEDIUM = "S-1-16-8192"\nSID_ML_MEDIUM_PLUS = "S-1-16-8448"\nSID_ML_HIGH = "S-1-16-12288"\nSID_ML_SYSTEM = "S-1-16-16384"\nSID_ML_PROTECTED_PROCESS = "S-1-16-20480"\nSID_AUTHENTICATION_AUTHORITY_ASSERTED_IDENTITY = "S-1-18-1"\nSID_SERVICE_ASSERTED_IDENTITY = "S-1-18-2"\nSID_FRESH_PUBLIC_KEY_IDENTITY = "S-1-18-3"\nSID_KEY_TRUST_IDENTITY = "S-1-18-4"\nSID_KEY_PROPERTY_MFA = "S-1-18-5"\nSID_KEY_PROPERTY_ATTESTATION = "S-1-18-6"\n\n\n
\n[docs]\nclass SID(object):\n    """\n    A Windows security identifier. Represents a single principal, such a\n    user or a group, as a sequence of numbers consisting of the revision,\n    identifier authority, and a variable-length list of subauthorities.\n\n    See [MS-DTYP]: 2.4.2\n    """\n    def __init__(self, revision, identifier_authority, subauthorities):\n        #: Revision, should always be 1.\n        self.revision = revision\n        #: An integer representing the identifier authority.\n        self.identifier_authority = identifier_authority\n        #: A list of integers representing all subauthorities.\n        self.subauthorities = subauthorities\n\n    def __str__(self):\n        """\n        String representation, as specified in [MS-DTYP]: 2.4.2.1\n        """\n        if self.identifier_authority >= 2**32:\n            id_auth = '%#x' % (self.identifier_authority,)\n        else:\n            id_auth = self.identifier_authority\n        auths = [self.revision, id_auth] + self.subauthorities\n        return 'S-' + '-'.join(str(subauth) for subauth in auths)\n\n    def __repr__(self):\n        return 'SID(%r)' % (str(self),)\n\n    @classmethod\n    def from_bytes(cls, data, return_tail=False):\n        revision, subauth_count = struct.unpack('<BB', data[:2])\n        identifier_authority = struct.unpack('>Q', b'\\x00\\x00' + data[2:8])[0]\n        subauth_data = data[8:]\n        subauthorities = [struct.unpack('<L', subauth_data[4 * i : 4 * (i+1)])[0]\n                          for i in range(subauth_count)]\n        sid = cls(revision, identifier_authority, subauthorities)\n        if return_tail:\n            return sid, subauth_data[4 * subauth_count :]\n        return sid
\n\n\n\n
\n[docs]\nclass ACE(object):\n    """\n    Represents a single access control entry.\n\n    See [MS-DTYP]: 2.4.4\n    """\n    HEADER_FORMAT = '<BBH'\n\n    def __init__(self, type_, flags, mask, sid, additional_data):\n        #: An integer representing the type of the ACE. One of the\n        #: ``ACE_TYPE_*`` constants. Corresponds to the ``AceType`` field\n        #: from [MS-DTYP] 2.4.4.1.\n        self.type = type_\n        #: An integer bitmask with ACE flags, corresponds to the\n        #: ``AceFlags`` field.\n        self.flags = flags\n        #: An integer representing the ``ACCESS_MASK`` as specified in\n        #: [MS-DTYP] 2.4.3.\n        self.mask = mask\n        #: The :class:`SID` of a trustee.\n        self.sid = sid\n        #: A dictionary of additional fields present in the ACE, depending\n        #: on the type. The following fields can be present:\n        #:\n        #: * ``flags``\n        #: * ``object_type``\n        #: * ``inherited_object_type``\n        #: * ``application_data``\n        #: * ``attribute_data``\n        self.additional_data = additional_data\n\n    def __repr__(self):\n        return "ACE(type=%#04x, flags=%#04x, mask=%#010x, sid=%s)" % (\n            self.type, self.flags, self.mask, self.sid,\n        )\n\n    @property\n    def isInheritOnly(self):\n        """Convenience property which indicates if this ACE is inherit\n        only, meaning that it doesn't apply to the object itself."""\n        return bool(self.flags & ACE_FLAG_INHERIT_ONLY)\n\n    @classmethod\n    def from_bytes(cls, data):\n        header_size = struct.calcsize(cls.HEADER_FORMAT)\n        header = data[:header_size]\n        type_, flags, size = struct.unpack(cls.HEADER_FORMAT, header)\n\n        assert len(data) >= size\n\n        body = data[header_size:size]\n        additional_data = {}\n\n        # In all ACE types, the mask immediately follows the header.\n        mask = struct.unpack('<I', body[:4])[0]\n        body = body[4:]\n\n        # All OBJECT-type ACEs contain additional flags, and two GUIDs as\n        # the following fields.\n        if type_ in (ACE_TYPE_ACCESS_ALLOWED_OBJECT,\n                     ACE_TYPE_ACCESS_DENIED_OBJECT,\n                     ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT,\n                     ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT,\n                     ACE_TYPE_SYSTEM_AUDIT_OBJECT,\n                     ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT):\n            additional_data['flags'] = struct.unpack('<I', body[:4])[0]\n            additional_data['object_type'] = body[4:20]\n            additional_data['inherited_object_type'] = body[20:36]\n            body = body[36:]\n\n        # Then the SID in all types.\n        sid, body = SID.from_bytes(body, return_tail=True)\n\n        # CALLBACK-type ACEs (and for some obscure reason,\n        # SYSTEM_AUDIT_OBJECT) have a final tail of application data.\n        if type_ in (ACE_TYPE_ACCESS_ALLOWED_CALLBACK,\n                     ACE_TYPE_ACCESS_DENIED_CALLBACK,\n                     ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT,\n                     ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT,\n                     ACE_TYPE_SYSTEM_AUDIT_OBJECT,\n                     ACE_TYPE_SYSTEM_AUDIT_CALLBACK,\n                     ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT):\n            additional_data['application_data'] = body\n\n        # SYSTEM_RESOURCE_ATTRIBUTE ACEs have a tail of attribute data.\n        if type_ == ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE:\n            additional_data['attribute_data'] = body\n\n        return cls(type_, flags, mask, sid, additional_data)
\n\n\n\n
\n[docs]\nclass ACL(object):\n    """\n    Access control list, encapsulating a sequence of access control\n    entries.\n\n    See [MS-DTYP]: 2.4.5\n    """\n    HEADER_FORMAT = '<BBHHH'\n\n    def __init__(self, revision, aces):\n        #: Integer value of the revision.\n        self.revision = revision\n        #: List of :class:`ACE` instances.\n        self.aces = aces\n\n    def __repr__(self):\n        return "ACL(%r)" % (self.aces,)\n\n    @classmethod\n    def from_bytes(cls, data):\n        revision = None\n        aces = []\n\n        header_size = struct.calcsize(cls.HEADER_FORMAT)\n        header, remaining = data[:header_size], data[header_size:]\n        revision, sbz1, size, count, sbz2 = struct.unpack(cls.HEADER_FORMAT, header)\n\n        assert len(data) >= size\n\n        for i in range(count):\n            ace_size = struct.unpack('<H', remaining[2:4])[0]\n            ace_data, remaining = remaining[:ace_size], remaining[ace_size:]\n            aces.append(ACE.from_bytes(ace_data))\n\n        return cls(revision, aces)
\n\n\n\n
\n[docs]\nclass SecurityDescriptor(object):\n    """\n    Represents a security descriptor.\n\n    See [MS-DTYP]: 2.4.6\n    """\n\n    HEADER_FORMAT = '<BBHIIII'\n\n    def __init__(self, flags, owner, group, dacl, sacl):\n        #: Integer bitmask of control flags. Corresponds to the\n        #: ``Control`` field in [MS-DTYP] 2.4.6.\n        self.flags = flags\n        #: Instance of :class:`SID` representing the owner user.\n        self.owner = owner\n        #: Instance of :class:`SID` representing the owner group.\n        self.group = group\n        #: Instance of :class:`ACL` representing the discretionary access\n        #: control list, which specifies access restrictions of an object.\n        self.dacl = dacl\n        #: Instance of :class:`ACL` representing the system access control\n        #: list, which specifies audit logging of an object.\n        self.sacl = sacl\n\n    @classmethod\n    def from_bytes(cls, data):\n        owner = None\n        group = None\n        dacl = None\n        sacl = None\n\n        header = data[:struct.calcsize(cls.HEADER_FORMAT)]\n        (revision, sbz1, flags, owner_offset, group_offset, sacl_offset,\n         dacl_offset) = struct.unpack(cls.HEADER_FORMAT, header)\n\n        assert revision == 1\n        assert flags & SECURITY_DESCRIPTOR_SELF_RELATIVE\n        for offset in (owner_offset, group_offset, sacl_offset, dacl_offset):\n            assert 0 <= offset < len(data)\n\n        if owner_offset:\n            owner = SID.from_bytes(data[owner_offset:])\n        if group_offset:\n            group = SID.from_bytes(data[group_offset:])\n        if dacl_offset:\n            dacl = ACL.from_bytes(data[dacl_offset:])\n        if sacl_offset:\n            sacl = ACL.from_bytes(data[sacl_offset:])\n\n        return cls(flags, owner, group, dacl, sacl)
\n\n
\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/_modules/smb/smb_structs.html", "content": "\n\n\n \n \n \n smb.smb_structs — pysmb 1.2.12 documentation\n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Source code for smb.smb_structs

\n\nimport os, sys, struct, types, logging, binascii, time\nfrom copy import copy\nfrom io import StringIO\nfrom .smb_constants import *\nfrom .strategy import DataFaultToleranceStrategy\n\n# Set to True if you want to enable support for extended security. Required for Windows Vista and later\nSUPPORT_EXTENDED_SECURITY = True\n\n# Set to True if you want to enable SMB2 protocol.\nSUPPORT_SMB2 = True\n\n# Supported dialects\nDIALECTS = [ ]\nfor i, ( name, dialect ) in enumerate([ ( 'NT_LAN_MANAGER_DIALECT', b'NT LM 0.12' ), ]):\n    DIALECTS.append(dialect)\n    globals()[name] = i\n\nDIALECTS2 = [ ]\nfor i, ( name, dialect ) in enumerate([ ( 'SMB2_DIALECT', b'SMB 2.002' ) ]):\n    DIALECTS2.append(dialect)\n    globals()[name] = i + len(DIALECTS)\n\n\n
\n[docs]\nclass UnsupportedFeature(Exception):\n    """\n    Raised when an supported feature is present/required in the protocol but is not\n    currently supported by pysmb\n    """\n    pass
\n\n\n\n
\n[docs]\nclass ProtocolError(Exception):\n\n    def __init__(self, message, data_buf = None, smb_message = None):\n        self.message = message\n        self.data_buf = data_buf\n        self.smb_message = smb_message\n\n    def __str__(self):\n        b = StringIO()\n        b.write(self.message + os.linesep)\n        if self.smb_message:\n            b.write('=' * 20 + ' SMB Message ' + '=' * 20 + os.linesep)\n            b.write(str(self.smb_message))\n\n        if self.data_buf:\n            b.write('=' * 20 + ' SMB Data Packet (hex) ' + '=' * 20 + os.linesep)\n            b.write(str(binascii.hexlify(self.data_buf)))\n            b.write(os.linesep)\n\n        return b.getvalue()
\n\n\nclass SMB2ProtocolHeaderError(ProtocolError):\n\n    def __init__(self):\n        ProtocolError.__init__(self, "Packet header belongs to SMB2")\n\n
\n[docs]\nclass OperationFailure(Exception):\n\n    def __init__(self, message, smb_messages):\n        self.message = message\n        self.smb_messages = [copy(msg) for msg in smb_messages]\n        self.args = (message, self.smb_messages)\n\n    def __str__(self):\n        b = StringIO()\n        b.write(self.message + os.linesep)\n\n        for idx, m in enumerate(self.smb_messages):\n            b.write('=' * 20 + ' SMB Message %d ' % idx + '=' * 20 + os.linesep)\n            b.write('SMB Header:' + os.linesep)\n            b.write('-----------' + os.linesep)\n            b.write(str(m))\n            b.write('SMB Data Packet (hex):' + os.linesep)\n            b.write('----------------------' + os.linesep)\n            b.write(str(binascii.hexlify(m.raw_data)))\n            b.write(os.linesep)\n\n        return b.getvalue()
\n\n\n\nclass SMBError:\n\n    def __init__(self):\n        self.reset()\n\n    def reset(self):\n        self.internal_value = 0\n        self.is_ntstatus = True\n\n    def __str__(self):\n        if self.is_ntstatus:\n            return 'NTSTATUS=0x%08X' % self.internal_value\n        else:\n            return 'ErrorClass=0x%02X ErrorCode=0x%04X' % ( self.internal_value >> 24, self.internal_value & 0xFFFF )\n\n    @property\n    def hasError(self):\n        return self.internal_value != 0\n\n\nclass SMBMessage:\n\n    HEADER_STRUCT_FORMAT = "<4sBIBHHQxxHHHHB"\n    HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n    log = logging.getLogger('SMB.SMBMessage')\n    protocol = 1\n\n    def __init__(self, payload = None):\n        self.reset()\n        if payload:\n            self.payload = payload\n            self.payload.initMessage(self)\n\n    def __str__(self):\n        b = StringIO()\n        b.write('Command: 0x%02X (%s) %s' % ( self.command, SMB_COMMAND_NAMES.get(self.command, '<unknown>'), os.linesep ))\n        b.write('Status: %s %s' % ( str(self.status), os.linesep ))\n        b.write('Flags: 0x%02X %s' % ( self.flags, os.linesep ))\n        b.write('Flags2: 0x%04X %s' % ( self.flags2, os.linesep ))\n        b.write('PID: %d %s' % ( self.pid, os.linesep ))\n        b.write('UID: %d %s' % ( self.uid, os.linesep ))\n        b.write('MID: %d %s' % ( self.mid, os.linesep ))\n        b.write('TID: %d %s' % ( self.tid, os.linesep ))\n        b.write('Security: 0x%016X %s' % ( self.security, os.linesep ))\n        b.write('Parameters: %d bytes %s%s %s' % ( len(self.parameters_data), os.linesep, str(binascii.hexlify(self.parameters_data)), os.linesep ))\n        b.write('Data: %d bytes %s%s %s' % ( len(self.data), os.linesep, str(binascii.hexlify(self.data)), os.linesep ))\n        return b.getvalue()\n\n    def reset(self):\n        self.raw_data = b''\n        self.command = 0\n        self.status = SMBError()\n        self.flags = 0\n        self.flags2 = 0\n        self.pid = 0\n        self.tid = 0\n        self.uid = 0\n        self.mid = 0\n        self.security = 0\n        self.parameters_data = b''\n        self.data = b''\n        self.payload = None\n\n    @property\n    def isAsync(self):\n        return bool(self.flags & SMB2_FLAGS_ASYNC_COMMAND)\n\n    @property\n    def isReply(self):\n        return bool(self.flags & SMB_FLAGS_REPLY)\n\n    @property\n    def hasExtendedSecurity(self):\n        return bool(self.flags2 & SMB_FLAGS2_EXTENDED_SECURITY)\n\n    def encode(self):\n        """\n        Encode this SMB message into a series of bytes suitable to be embedded with a NetBIOS session message.\n        AssertionError will be raised if this SMB message has not been initialized with a Payload instance\n\n        @return: a string containing the encoded SMB message\n        """\n        assert self.payload\n\n        self.pid = os.getpid()\n        self.payload.prepare(self)\n\n        parameters_len = len(self.parameters_data)\n        assert parameters_len % 2 == 0\n\n        headers_data = struct.pack(self.HEADER_STRUCT_FORMAT,\n                                   b'\\xFFSMB', self.command, self.status.internal_value, self.flags,\n                                   self.flags2, (self.pid >> 16) & 0xFFFF, self.security, self.tid,\n                                   self.pid & 0xFFFF, self.uid, self.mid, int(parameters_len / 2))\n        return headers_data + self.parameters_data + struct.pack('<H', len(self.data)) + self.data\n\n    def decode(self, buf):\n        """\n        Decodes the SMB message in buf.\n        All fields of the SMBMessage object will be reset to default values before decoding.\n        On errors, do not assume that the fields will be reinstated back to what they are before\n        this method is invoked.\n\n        @param buf: data containing one complete SMB message\n        @type buf: string\n        @return: a positive integer indicating the number of bytes used in buf to decode this SMB message\n        @raise ProtocolError: raised when decoding fails\n        """\n        buf_len = len(buf)\n        if buf_len < self.HEADER_STRUCT_SIZE:\n            # We need at least 32 bytes (header) + 1 byte (parameter count)\n            raise ProtocolError('Not enough data to decode SMB header', buf)\n\n        self.reset()\n\n        protocol, self.command, status, self.flags, \\\n        self.flags2, pid_high, self.security, self.tid, \\\n        pid_low, self.uid, self.mid, params_count = struct.unpack(self.HEADER_STRUCT_FORMAT, buf[:self.HEADER_STRUCT_SIZE])\n\n        if protocol == b'\\xFESMB':\n            raise SMB2ProtocolHeaderError()\n        if protocol != b'\\xFFSMB':\n            raise ProtocolError('Invalid 4-byte protocol field', buf)\n\n        self.pid = (pid_high << 16) | pid_low\n        self.status.internal_value = status\n        self.status.is_ntstatus = bool(self.flags2 & SMB_FLAGS2_NT_STATUS)\n\n        offset = self.HEADER_STRUCT_SIZE\n        if buf_len < params_count * 2 + 2:\n            # Not enough data in buf to decode up to body length\n            raise ProtocolError('Not enough data. Parameters list decoding failed', buf)\n\n        datalen_offset = offset + params_count*2\n        body_len = struct.unpack('<H', buf[datalen_offset:datalen_offset+2])[0]\n        if body_len > 0 and buf_len < (datalen_offset + 2 + body_len):\n            # Not enough data in buf to decode body\n            raise ProtocolError('Not enough data. Body decoding failed', buf)\n\n        self.parameters_data = buf[offset:datalen_offset]\n\n        if body_len > 0:\n            self.data = buf[datalen_offset+2:datalen_offset+2+body_len]\n\n        self.raw_data = buf\n        self._decodePayload()\n\n        return self.HEADER_STRUCT_SIZE + params_count * 2 + 2 + body_len\n\n    def _decodePayload(self):\n        if self.command == SMB_COM_READ_ANDX:\n            self.payload = ComReadAndxResponse()\n        elif self.command == SMB_COM_WRITE_ANDX:\n            self.payload = ComWriteAndxResponse()\n        elif self.command == SMB_COM_TRANSACTION:\n            self.payload = ComTransactionResponse()\n        elif self.command == SMB_COM_TRANSACTION2:\n            self.payload = ComTransaction2Response()\n        elif self.command == SMB_COM_OPEN_ANDX:\n            self.payload = ComOpenAndxResponse()\n        elif self.command == SMB_COM_NT_CREATE_ANDX:\n            self.payload = ComNTCreateAndxResponse()\n        elif self.command == SMB_COM_TREE_CONNECT_ANDX:\n            self.payload = ComTreeConnectAndxResponse()\n        elif self.command == SMB_COM_ECHO:\n            self.payload = ComEchoResponse()\n        elif self.command == SMB_COM_SESSION_SETUP_ANDX:\n            self.payload = ComSessionSetupAndxResponse()\n        elif self.command == SMB_COM_NEGOTIATE:\n            self.payload = ComNegotiateResponse()\n\n        if self.payload:\n            self.payload.decode(self)\n\n\nclass Payload:\n\n    DEFAULT_ANDX_PARAM_HEADER = b'\\xFF\\x00\\x00\\x00'\n    DEFAULT_ANDX_PARAM_SIZE = 4\n\n    def initMessage(self, message):\n        # SMB_FLAGS2_UNICODE must always be enabled. Without this, almost all the Payload subclasses will need to be\n        # rewritten to check for OEM/Unicode strings which will be tedious. Fortunately, almost all tested CIFS services\n        # support SMB_FLAGS2_UNICODE by default.\n        assert message.payload == self\n        message.flags =  SMB_FLAGS_CASE_INSENSITIVE | SMB_FLAGS_CANONICALIZED_PATHS\n        message.flags2 = SMB_FLAGS2_UNICODE | SMB_FLAGS2_NT_STATUS | SMB_FLAGS2_IS_LONG_NAME | SMB_FLAGS2_LONG_NAMES\n\n        if SUPPORT_EXTENDED_SECURITY:\n            message.flags2 |= SMB_FLAGS2_EXTENDED_SECURITY\n\n    def prepare(self, message):\n        raise NotImplementedError\n\n    def decode(self, message):\n        raise NotImplementedError\n\n\nclass ComNegotiateRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.52.1\n    - [MS-SMB]: 2.2.4.5.1\n    """\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_NEGOTIATE\n\n    def prepare(self, message):\n        assert message.payload == self\n        message.parameters_data = b''\n        if SUPPORT_SMB2:\n            message.data = b''.join([b'\\x02'+s+b'\\x00' for s in DIALECTS + DIALECTS2])\n        else:\n            message.data = b''.join([b'\\x02'+s+b'\\x00' for s in DIALECTS])\n\n\nclass ComNegotiateResponse(Payload):\n    """\n    Contains information on the SMB_COM_NEGOTIATE response from server\n\n    After calling the decode method, each instance will contain the following attributes,\n    - security_mode (integer)\n    - max_mpx_count (integer)\n    - max_number_vcs (integer)\n    - max_buffer_size (long)\n    - max_raw_size (long)\n    - session_key (long)\n    - capabilities (long)\n    - system_time (long)\n    - server_time_zone (integer)\n    - challenge_length (integer)\n\n    If the underlying SMB message's flag2 does not have SMB_FLAGS2_EXTENDED_SECURITY bit enabled,\n    then the instance will have the following additional attributes,\n    - challenge (string)\n    - domain (unicode)\n\n    If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled,\n    then the instance will have the following additional attributes,\n    - server_guid (string)\n    - security_blob (string)\n\n    References:\n    ===========\n    - [MS-SMB]: 2.2.4.5.2.1\n    - [MS-CIFS]: 2.2.4.52.2\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HBHHIIIIQHB'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_NEGOTIATE\n\n        if not message.isReply:\n            raise ProtocolError('Not a SMB_COM_NEGOTIATE reply', message.raw_data, message)\n\n        self.security_mode, self.max_mpx_count, self.max_number_vcs, self.max_buffer_size, \\\n        self.max_raw_size, self.session_key, self.capabilities, self.system_time, self.server_time_zone, \\\n        self.challenge_length = ( 0, ) * 10\n\n        data_len = len(message.parameters_data)\n        if data_len < 2:\n            raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE dialect_index field', message.raw_data, message)\n\n        self.dialect_index = struct.unpack('<H', message.parameters_data[:2])[0]\n        if self.dialect_index == NT_LAN_MANAGER_DIALECT:\n            if data_len != (0x11 * 2):\n                raise ProtocolError('NT LAN Manager dialect selected in SMB_COM_NEGOTIATE but parameters bytes count (%d) does not meet specs' % data_len,\n                                    message.raw_data, message)\n            else:\n                _, self.security_mode, self.max_mpx_count, self.max_number_vcs, self.max_buffer_size, \\\n                self.max_raw_size, self.session_key, self.capabilities, self.system_time, self.server_time_zone, \\\n                self.challenge_length = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n        elif self.dialect_index == 0xFFFF:\n            raise ProtocolError('Server does not support any of the pysmb dialects. Please email pysmb to add in support for your OS',\n                                message.raw_data, message)\n        else:\n            raise ProtocolError('Unknown dialect index (0x%04X)' % self.dialect_index, message.raw_data, message)\n\n        data_len = len(message.data)\n        if not message.hasExtendedSecurity:\n            self.challenge, self.domain = '', ''\n            if self.challenge_length > 0:\n                if data_len >= self.challenge_length:\n                    self.challenge = message.data[:self.challenge_length]\n\n                    s = b''\n                    offset = self.challenge_length\n                    while offset < data_len:\n                        _s = message.data[offset:offset+2]\n                        if _s == b'\\0\\0':\n                            self.domain = DataFaultToleranceStrategy.data_bytes_decode(s)#.decode('UTF-16LE')\n                            break\n                        else:\n                            s += _s\n                            offset += 2\n                else:\n                    raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (without security extensions) Challenge field', message.raw_data, message)\n        else:\n            if data_len < 16:\n                raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (with security extensions) ServerGUID field', message.raw_data, message)\n\n            self.server_guid = message.data[:16]\n            self.security_blob = message.data[16:]\n\n    @property\n    def supportsExtendedSecurity(self):\n        return bool(self.capabilities & CAP_EXTENDED_SECURITY)\n\n\nclass ComSessionSetupAndxRequest__WithSecurityExtension(Payload):\n    """\n    References:\n    ===========\n    - [MS-SMB]: 2.2.4.6.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HHHIHII'\n\n    def __init__(self, session_key, security_blob):\n        self.session_key = session_key\n        self.security_blob = security_blob\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_SESSION_SETUP_ANDX\n\n    def prepare(self, message):\n        assert message.hasExtendedSecurity\n\n        message.flags2 |= SMB_FLAGS2_UNICODE\n\n        cap = CAP_UNICODE | CAP_STATUS32 | CAP_EXTENDED_SECURITY | CAP_NT_SMBS\n\n        message.parameters_data = \\\n            self.DEFAULT_ANDX_PARAM_HEADER + \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        16644, 10, 1, self.session_key, len(self.security_blob), 0, cap)\n\n        message.data = self.security_blob\n        if (SMBMessage.HEADER_STRUCT_SIZE + len(message.parameters_data) + len(message.data)) % 2 != 0:\n            message.data = message.data + b'\\0'\n        message.data = message.data + b'\\0' * 4\n\n\nclass ComSessionSetupAndxRequest__NoSecurityExtension(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.53.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HHHIHHII'\n\n    def __init__(self, session_key, username, password, is_unicode, domain):\n        self.username = username\n        self.session_key = session_key\n        self.password = password\n        self.is_unicode = is_unicode\n        self.domain = domain\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_SESSION_SETUP_ANDX\n\n    def prepare(self, message):\n        if self.is_unicode:\n            message.flags2 |= SMB_FLAGS2_UNICODE\n        else:\n            message.flags2 &= (~SMB_FLAGS2_UNICODE & 0xFFFF)\n\n        password_len = len(self.password)\n        message.parameters_data = \\\n            self.DEFAULT_ANDX_PARAM_HEADER + \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        16644, 10, 0, self.session_key,\n                        (not self.is_unicode and password_len) or 0,\n                        (self.is_unicode and password_len) or 0,\n                        0,\n                        CAP_UNICODE | CAP_LARGE_FILES | CAP_STATUS32)\n\n        est_offset = SMBMessage.HEADER_STRUCT_SIZE + len(message.parameters_data)  # To check if data until SMB paramaters are aligned to a 16-bit boundary\n\n        message.data = self.password\n        if (est_offset + len(message.data)) % 2 != 0 and message.flags2 & SMB_FLAGS2_UNICODE:\n            message.data = message.data + b'\\0'\n\n        if message.flags2 & SMB_FLAGS2_UNICODE:\n            message.data = message.data + self.username.encode('UTF-16LE') + b'\\0'\n        else:\n            message.data = message.data + str(self.username).encode('UTF-8') + b'\\0'\n\n        if (est_offset + len(message.data)) % 2 != 0 and message.flags2 & SMB_FLAGS2_UNICODE:\n            message.data = message.data + b'\\0'\n\n        if message.flags2 & SMB_FLAGS2_UNICODE:\n            message.data = message.data + self.domain.encode('UTF-16LE') + b'\\0\\0' + 'pysmb'.encode('UTF-16LE') + b'\\0\\0'\n        else:\n            message.data = message.data + self.domain.encode('UTF-8') + b'\\0pysmb\\0'\n\n\nclass ComSessionSetupAndxResponse(Payload):\n    """\n    Contains information on the SMB_COM_SESSION_SETUP_ANDX response from server\n\n    If the underlying SMB message's flags2 does not have SMB_FLAGS2_EXTENDED_SECURITY bit enabled,\n    then the instance will have the following attributes,\n    - action\n\n    If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled\n    and the message status is STATUS_MORE_PROCESSING_REQUIRED or equals to 0x00 (no error),\n    then the instance will have the following attributes,\n    - action\n    - securityblob\n\n    If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled but\n    the message status is not STATUS_MORE_PROCESSING_REQUIRED\n\n    References:\n    ===========\n    - [MS-SMB]: 2.2.4.6.2\n    - [MS-CIFS]: 2.2.4.53.2\n    """\n\n    NOSECURE_PARAMETER_STRUCT_FORMAT = '<BBHH'\n    NOSECURE_PARAMETER_STRUCT_SIZE = struct.calcsize(NOSECURE_PARAMETER_STRUCT_FORMAT)\n\n    SECURE_PARAMETER_STRUCT_FORMAT = '<BBHHH'\n    SECURE_PARAMETER_STRUCT_SIZE = struct.calcsize(SECURE_PARAMETER_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_SESSION_SETUP_ANDX\n        if not message.hasExtendedSecurity:\n            if not message.status.hasError:\n                if len(message.parameters_data) < self.NOSECURE_PARAMETER_STRUCT_SIZE:\n                    raise ProtocolError('Not enough data to decode SMB_COM_SESSION_SETUP_ANDX (no security extensions) parameters', message.raw_data, message)\n\n                _, _, _, self.action = struct.unpack(self.NOSECURE_PARAMETER_STRUCT_FORMAT, message.parameters_data[:self.NOSECURE_PARAMETER_STRUCT_SIZE])\n        else:\n            if not message.status.hasError or message.status.internal_value == 0xc0000016:   # STATUS_MORE_PROCESSING_REQUIRED\n                if len(message.parameters_data) < self.SECURE_PARAMETER_STRUCT_SIZE:\n                    raise ProtocolError('Not enough data to decode SMB_COM_SESSION_SETUP_ANDX (with security extensions) parameters', message.raw_data, message)\n\n                _, _, _, self.action, blob_length = struct.unpack(self.SECURE_PARAMETER_STRUCT_FORMAT, message.parameters_data[:self.SECURE_PARAMETER_STRUCT_SIZE])\n                if len(message.data) < blob_length:\n                    raise ProtocolError('Not enough data to decode SMB_COM_SESSION_SETUP_ANDX (with security extensions) security blob', message.raw_data, message)\n\n                self.security_blob = message.data[:blob_length]\n\n\nclass ComTreeConnectAndxRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.55.1\n    - [MS-SMB]: 2.2.4.7.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, path, service, password = ''):\n        self.path = path\n        self.service = service\n        self.password = password + '\\0'\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_TREE_CONNECT_ANDX\n\n    def prepare(self, message):\n        password_len = len(self.password)\n        message.parameters_data = \\\n            self.DEFAULT_ANDX_PARAM_HEADER + \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        0x08 | \\\n                            ((message.hasExtendedSecurity and 0x0004) or 0x00) | \\\n                            ((message.tid and message.tid != 0xffff and 0x0001) or 0x00),  # Disconnect tid, if message.tid must be non-zero\n                        password_len)\n\n        padding = b''\n        if password_len % 2 == 0:\n            padding = b'\\0'\n\n        # Note that service field is never encoded in UTF-16LE. [MS-CIFS]: 2.2.1.1\n        message.data = self.password.encode('UTF-8') + padding + self.path.encode('UTF-16LE') + b'\\0\\0' + self.service.encode('UTF-8') + b'\\0'\n\n\nclass ComTreeConnectAndxResponse(Payload):\n    """\n    Contains information about the SMB_COM_TREE_CONNECT_ANDX response from the server.\n\n    If the message has no errors, each instance contains the following attributes:\n    - optional_support\n\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.55.2\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<BBHH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_TREE_CONNECT_ANDX\n\n        if not message.status.hasError:\n            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:\n                raise ProtocolError('Not enough data to decode SMB_COM_TREE_CONNECT_ANDX parameters', message.raw_data, message)\n\n            _, _, _, self.optional_support = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n\nclass ComNTCreateAndxRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.64.1\n    - [MS-SMB]: 2.2.4.9.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<BHIIIQIIIIIB'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, filename, flags = 0, root_fid = 0, access_mask = 0, allocation_size = 0, ext_attr = 0,\n                 share_access = 0, create_disp = 0, create_options = 0, impersonation = 0, security_flags = 0):\n        self.filename = (filename + '\\0').encode('UTF-16LE')\n        self.flags = flags\n        self.root_fid = root_fid\n        self.access_mask = access_mask\n        self.allocation_size = allocation_size\n        self.ext_attr = ext_attr\n        self.share_access = share_access\n        self.create_disp = create_disp\n        self.create_options = create_options\n        self.impersonation = impersonation\n        self.security_flags = security_flags\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_NT_CREATE_ANDX\n\n    def prepare(self, message):\n        filename_len = len(self.filename)\n\n        message.parameters_data = \\\n            self.DEFAULT_ANDX_PARAM_HEADER + \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        0x00,                  # reserved\n                        filename_len,          # NameLength\n                        self.flags,            # Flags\n                        self.root_fid,         # RootDirectoryFID\n                        self.access_mask,      # DesiredAccess\n                        self.allocation_size,  # AllocationSize\n                        self.ext_attr,         # ExtFileAttributes\n                        self.share_access,     # ShareAccess\n                        self.create_disp,      # CreateDisposition\n                        self.create_options,   # CreateOptions\n                        self.impersonation,    # ImpersonationLevel\n                        self.security_flags)   # SecurityFlags\n\n        padding = b''\n        if (message.HEADER_STRUCT_SIZE + len(message.parameters_data)) % 2 != 0:\n            padding = b'\\0'\n\n        message.data = padding + self.filename\n\n\nclass ComNTCreateAndxResponse(Payload):\n    """\n    Contains (partial) information about the SMB_COM_NT_CREATE_ANDX response from the server.\n\n    Each instance contains the following attributes after decoding:\n    - oplock_level\n    - fid\n\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.64.2\n    """\n    PAYLOAD_STRUCT_FORMAT = '<BBHBH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_NT_CREATE_ANDX\n\n        if not message.status.hasError:\n            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:\n                raise ProtocolError('Not enough data to decode SMB_COM_NT_CREATE_ANDX parameters', message.raw_data, message)\n\n            _, _, _, self.oplock_level, self.fid = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n\nclass ComTransactionRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.33.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HHHHBBHIHHHHHH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, max_params_count, max_data_count, max_setup_count,\n                 total_params_count = 0, total_data_count = 0,\n                 params_bytes = b'', data_bytes = b'', setup_bytes = b'',\n                 flags = 0, timeout = 0, name = "\\\\PIPE\\\\"):\n        self.total_params_count = total_params_count or len(params_bytes)\n        self.total_data_count = total_data_count or len(data_bytes)\n        self.max_params_count = max_params_count\n        self.max_data_count = max_data_count\n        self.max_setup_count = max_setup_count\n        self.flags = flags\n        self.timeout = timeout\n        self.params_bytes = params_bytes\n        self.data_bytes = data_bytes\n        self.setup_bytes = setup_bytes\n        self.name = name\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_TRANSACTION\n\n    def prepare(self, message):\n        name = (self.name + '\\0').encode('UTF-16LE')\n        name_len = len(name)\n        setup_bytes_len = len(self.setup_bytes)\n        params_bytes_len = len(self.params_bytes)\n        data_bytes_len = len(self.data_bytes)\n\n        padding0 = b''\n        offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n        if offset % 2 != 0:\n            padding0 = b'\\0'\n            offset += 1\n\n        offset += name_len  # For the name field\n        padding1 = b''\n        if offset % 4 != 0:\n            padding1 = b'\\0'*(4-offset%4)\n            offset += (4-offset%4)\n\n        if params_bytes_len > 0:\n            params_bytes_offset = offset\n            offset += params_bytes_len\n        else:\n            params_bytes_offset = 0\n\n        padding2 = b''\n        if offset % 4 != 0:\n            padding2 = b'\\0'*(4-offset%4)\n            offset += (4-offset%4)\n\n        if data_bytes_len > 0:\n            data_bytes_offset = offset\n        else:\n            data_bytes_offset = 0\n\n        message.parameters_data = \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        self.total_params_count,\n                        self.total_data_count,\n                        self.max_params_count,\n                        self.max_data_count,\n                        self.max_setup_count,\n                        0x00,           # Reserved1. Must be 0x00\n                        self.flags,\n                        self.timeout,\n                        0x0000,         # Reserved2. Must be 0x0000\n                        params_bytes_len,\n                        params_bytes_offset,\n                        data_bytes_len,\n                        data_bytes_offset,\n                        int(setup_bytes_len / 2)) + \\\n            self.setup_bytes\n\n        message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes\n\n\nclass ComTransactionResponse(Payload):\n    """\n    Contains information about a SMB_COM_TRANSACTION response from the server\n\n    After decoding, each instance contains the following attributes:\n    - total_params_count (integer)\n    - total_data_count (integer)\n    - setup_bytes (string)\n    - data_bytes (string)\n    - params_bytes (string)\n\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.33.2\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HHHHHHHHHH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_TRANSACTION\n\n        if not message.status.hasError:\n            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:\n                raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)\n\n            self.total_params_count, self.total_data_count, _, \\\n            params_bytes_len, params_bytes_offset, params_bytes_displ, \\\n            data_bytes_len, data_bytes_offset, data_bytes_displ, \\\n            setup_count = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n            if setup_count > 0:\n                setup_bytes_len = setup_count * 2\n\n                if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:\n                    raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)\n\n                self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]\n            else:\n                self.setup_bytes = ''\n\n            offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n\n            if params_bytes_len > 0:\n                self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]\n            else:\n                self.params_bytes = ''\n\n            if data_bytes_len > 0:\n                self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]\n            else:\n                self.data_bytes = ''\n\n\nclass ComTransaction2Request(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.46.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = 'HHHHBBHIHHHHHH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, max_params_count, max_data_count, max_setup_count,\n                 total_params_count = 0, total_data_count = 0,\n                 params_bytes = b'', data_bytes = b'', setup_bytes = b'',\n                 flags = 0, timeout = 0):\n        self.total_params_count = total_params_count or len(params_bytes)\n        self.total_data_count = total_data_count or len(data_bytes)\n        self.max_params_count = max_params_count\n        self.max_data_count = max_data_count\n        self.max_setup_count = max_setup_count\n        self.flags = flags\n        self.timeout = timeout\n        self.params_bytes = params_bytes\n        self.data_bytes = data_bytes\n        self.setup_bytes = setup_bytes\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_TRANSACTION2\n\n    def prepare(self, message):\n        setup_bytes_len = len(self.setup_bytes)\n        params_bytes_len = len(self.params_bytes)\n        data_bytes_len = len(self.data_bytes)\n        name = b'\\0\\0'\n\n        padding0 = b''\n        offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n        if offset % 2 != 0:\n            padding0 = b'\\0'\n            offset += 1\n\n        offset += 2  # For the name field\n        padding1 = b''\n        if offset % 4 != 0:\n            padding1 = b'\\0'*(4-offset%4)\n\n        if params_bytes_len > 0:\n            params_bytes_offset = offset\n            offset += params_bytes_len\n        else:\n            params_bytes_offset = 0\n\n        padding2 = b''\n        if offset % 4 != 0:\n            padding2 = b'\\0'*(4-offset%4)\n\n        if data_bytes_len > 0:\n            data_bytes_offset = offset\n        else:\n            data_bytes_offset = 0\n\n        message.parameters_data = \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        self.total_params_count,\n                        self.total_data_count,\n                        self.max_params_count,\n                        self.max_data_count,\n                        self.max_setup_count,\n                        0x00,           # Reserved1. Must be 0x00\n                        self.flags,\n                        self.timeout,\n                        0x0000,         # Reserved2. Must be 0x0000\n                        params_bytes_len,\n                        params_bytes_offset,\n                        data_bytes_len,\n                        data_bytes_offset,\n                        int(setup_bytes_len / 2)) + \\\n            self.setup_bytes\n\n        message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes\n\n\nclass ComTransaction2Response(Payload):\n    """\n    Contains information about a SMB_COM_TRANSACTION2 response from the server\n\n    After decoding, each instance contains the following attributes:\n    - total_params_count (integer)\n    - total_data_count (integer)\n    - setup_bytes (string)\n    - data_bytes (string)\n    - params_bytes (string)\n\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.46.2\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HHHHHHHHHBB'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_TRANSACTION2\n\n        if not message.status.hasError:\n            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:\n                raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION2 parameters', message.raw_data, message)\n\n            self.total_params_count, self.total_data_count, _, \\\n            params_bytes_len, params_bytes_offset, params_bytes_displ, \\\n            data_bytes_len, data_bytes_offset, data_bytes_displ, \\\n            setup_count, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n            if setup_count > 0:\n                setup_bytes_len = setup_count * 2\n\n                if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:\n                    raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)\n\n                self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]\n            else:\n                self.setup_bytes = ''\n\n            offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n\n            if params_bytes_len > 0:\n                self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]\n            else:\n                self.params_bytes = ''\n\n            if data_bytes_len > 0:\n                self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]\n            else:\n                self.data_bytes = ''\n\n\nclass ComCloseRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.5.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HI'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, fid, last_modified_time = 0xFFFFFFFF):\n        self.fid = fid\n        self.last_modified_time = last_modified_time\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_CLOSE\n\n    def prepare(self, message):\n        message.parameters_data = struct.pack(self.PAYLOAD_STRUCT_FORMAT, self.fid, self.last_modified_time)\n        message.data = b''\n\n\nclass ComOpenAndxRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.41.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HHHHIHIII'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, filename, access_mode, open_mode, flags = 0x0000, search_attributes = 0, file_attributes = 0, create_time = 0, timeout = 0):\n        """\n        @param create_time: Epoch time value to indicate the time of creation for this file. If zero, we will automatically assign the current time\n        @type create_time: int\n        @param timeout: Number of milliseconds to wait for blocked open request before failing\n        @type timeout: int\n        """\n        self.filename = filename\n        self.access_mode = access_mode\n        self.open_mode = open_mode\n        self.flags = flags\n        self.search_attributes = search_attributes\n        self.file_attributes = file_attributes\n        self.create_time = create_time or int(time.time())\n        self.timeout = timeout\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_OPEN_ANDX\n\n    def prepare(self, message):\n        message.parameters_data = \\\n            self.DEFAULT_ANDX_PARAM_HEADER + \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        self.flags,\n                        self.access_mode,\n                        self.search_attributes,\n                        self.file_attributes,\n                        self.create_time,\n                        self.open_mode,\n                        0,  # AllocationSize\n                        0,  # Timeout (in milli-secs)\n                        0)  # Reserved\n\n        message.data = b'\\0' + self.filename.encode('UTF-16LE') + b'\\0\\0'\n\n\nclass ComOpenAndxResponse(Payload):\n    """\n    Contains information about a SMB_COM_OPEN_ANDX response from the server\n\n    After decoding, each instance will contain the following attributes:\n    - fid (integer)\n    - file_attributes (integer)\n    - last_write_time (long)\n    - access_rights (integer)\n    - resource_type (integer)\n    - open_results (integer)\n\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.41.2\n    - [MS-SMB]: 2.2.4.1.2\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<BBHHHIIHHHHHHH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_OPEN_ANDX\n\n        if not message.status.hasError:\n            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:\n                raise ProtocolError('Not enough data to decode SMB_COM_OPEN_ANDX parameters', message.raw_data, message)\n\n            _, _, _, self.fid, self.file_attributes, self.last_write_time, _, \\\n            self.access_rights, self.resource_type, _, self.open_results, _, _, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,\n                                                                                                  message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n\nclass ComWriteAndxRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.43.1\n    - [MS-SMB]: 2.2.4.3.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HIIHHHHHI'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, fid, data_bytes, offset, write_mode = 0, timeout = 0):\n        """\n        @param timeout: Number of milliseconds to wait for blocked write request before failing. Must be zero for writing to regular file\n        @type timeout: int\n        """\n        self.fid = fid\n        self.offset = offset\n        self.data_bytes = data_bytes\n        self.timeout = timeout\n        self.write_mode = write_mode\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_WRITE_ANDX\n\n    def prepare(self, message):\n        # constant 1 is to account for the pad byte in the message.data\n        # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n        data_offset = message.HEADER_STRUCT_SIZE + self.DEFAULT_ANDX_PARAM_SIZE + self.PAYLOAD_STRUCT_SIZE + 1 + 2\n        data_len = len(self.data_bytes)\n\n        message.parameters_data = \\\n            self.DEFAULT_ANDX_PARAM_HEADER + \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        self.fid,\n                        self.offset & 0xFFFFFFFF,\n                        self.timeout,\n                        self.write_mode,\n                        data_len,   # Remaining\n                        0x0000,     # Reserved\n                        len(self.data_bytes),  # DataLength\n                        data_offset,           # DataOffset\n                        self.offset >> 32)     # OffsetHigh field defined in [MS-SMB]: 2.2.4.3.1\n\n        message.data = b'\\0' + self.data_bytes\n\n\nclass ComWriteAndxResponse(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.43.2\n    - [MS-SMB]: 2.2.4.3.2\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<BBHHHHH'  # We follow the SMB_COM_WRITEX_ANDX server extensions in [MS-SMB]: 2.2.4.3.2\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_WRITE_ANDX\n\n        if not message.status.hasError:\n            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:\n                raise ProtocolError('Not enough data to decode SMB_COM_WRITE_ANDX parameters', message.raw_data, message)\n\n            _, _, _, count, self.available, high_count, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT, message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n            self.count = (count & 0xFFFF) | (high_count << 16)\n\n\nclass ComReadAndxRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.42.1\n    - [MS-SMB]: 2.2.4.2.1\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<HIHHIHI'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, fid, offset, max_return_bytes_count, min_return_bytes_count, timeout = 0, remaining = 0):\n        """\n        @param timeout: If reading from a regular file, this parameter must be 0.\n        @type timeout: int\n        """\n        self.fid = fid\n        self.remaining = remaining\n        self.max_return_bytes_count = max_return_bytes_count\n        self.min_return_bytes_count = min_return_bytes_count\n        self.offset = offset\n        self.timeout = timeout\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_READ_ANDX\n\n    def prepare(self, message):\n        message.parameters_data = \\\n            self.DEFAULT_ANDX_PARAM_HEADER + \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        self.fid,\n                        self.offset & 0xFFFFFFFF,\n                        self.max_return_bytes_count,\n                        self.min_return_bytes_count,\n                        self.timeout or (self.max_return_bytes_count >> 32),  # Note that in [MS-SMB]: 2.2.4.2.1, this field can also act as MaxCountHigh field\n                        self.remaining, # In [MS-CIFS]: 2.2.4.42.1, this field must be set to 0x0000\n                        self.offset >> 32)\n\n        message.data = b''\n\n\nclass ComReadAndxResponse(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.42.2\n    - [MS-SMB]: 2.2.4.2.2\n    """\n\n    PAYLOAD_STRUCT_FORMAT = '<BBHHHHHHHHHHH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_READ_ANDX\n\n        if not message.status.hasError:\n            if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE:\n                raise ProtocolError('Not enough data to decode SMB_COM_READ_ANDX parameters', message.raw_data, message)\n\n            _, _, _, _, _, _, self.data_length, data_offset, _, _, _, _, _ = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,\n                                                                                           message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n            offset = data_offset - message.HEADER_STRUCT_SIZE - self.PAYLOAD_STRUCT_SIZE - 2  # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n            self.data = message.data[offset:offset+self.data_length]\n            assert len(self.data) == self.data_length\n\n\nclass ComDeleteRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.7.1\n    """\n\n    def __init__(self, filename_pattern, search_attributes = 0):\n        self.filename_pattern = filename_pattern\n        self.search_attributes = search_attributes\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_DELETE\n\n    def prepare(self, message):\n        message.parameters_data = struct.pack('<H', self.search_attributes)\n        message.data = b'\\x04' + self.filename_pattern.encode('UTF-16LE') + b'\\0\\0'\n\n\nclass ComCreateDirectoryRequest(Payload):\n    """\n    Although this command has been marked deprecated in [MS-CIFS], we continue to use it for its simplicity\n    as compared to its replacement TRANS2_CREATE_DIRECTORY sub-command [MS-CIFS]: 2.2.6.14\n\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.1.1\n    """\n\n    def __init__(self, path):\n        self.path = path\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_CREATE_DIRECTORY\n\n    def prepare(self, message):\n        message.parameters_data = b''\n        message.data = b'\\x04' + self.path.encode('UTF-16LE') + b'\\0\\0'\n\n\nclass ComDeleteDirectoryRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.2.1\n    """\n\n    def __init__(self, path):\n        self.path = path\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_DELETE_DIRECTORY\n\n    def prepare(self, message):\n        message.parameters_data = b''\n        message.data = b'\\x04' + self.path.encode('UTF-16LE') + b'\\0\\0'\n\n\nclass ComRenameRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.8.1\n    """\n\n    def __init__(self, old_path, new_path, search_attributes = 0):\n        self.old_path = old_path\n        self.new_path = new_path\n        self.search_attributes = search_attributes\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_RENAME\n\n    def prepare(self, message):\n        message.parameters_data = struct.pack('<H', self.search_attributes)\n        message.data = b'\\x04' + self.old_path.encode('UTF-16LE') + b'\\x00\\x00\\x04\\x00' + self.new_path.encode('UTF-16LE') + b'\\x00\\x00'\n\n\nclass ComEchoRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.39.1\n    """\n\n    def __init__(self, echo_data = b'', echo_count = 1):\n        self.echo_count = echo_count\n        self.echo_data = echo_data\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_ECHO\n        message.tid = 0xFFFF\n\n    def prepare(self, message):\n        message.parameters_data = struct.pack('<H', self.echo_count)\n        message.data = self.echo_data\n\n\nclass ComEchoResponse(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.39.2\n    """\n\n    def decode(self, message):\n        self.sequence_number = struct.unpack('<H', message.parameters_data[:2])[0]\n        self.data = message.data\n\n\nclass ComNTTransactRequest(Payload):\n    """\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.62.1\n    """\n    PAYLOAD_STRUCT_FORMAT = '<BHIIIIIIIIBH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def __init__(self, function, max_params_count, max_data_count, max_setup_count,\n                 total_params_count = 0, total_data_count = 0,\n                 params_bytes = b'', setup_bytes = b'', data_bytes = b''):\n        self.function = function\n        self.total_params_count = total_params_count or len(params_bytes)\n        self.total_data_count = total_data_count or len(data_bytes)\n        self.max_params_count = max_params_count\n        self.max_data_count = max_data_count\n        self.max_setup_count = max_setup_count\n        self.params_bytes = params_bytes\n        self.setup_bytes = setup_bytes\n        self.data_bytes = data_bytes\n\n    def initMessage(self, message):\n        Payload.initMessage(self, message)\n        message.command = SMB_COM_NT_TRANSACT\n\n    def prepare(self, message):\n        setup_bytes_len = len(self.setup_bytes)\n        params_bytes_len = len(self.params_bytes)\n        data_bytes_len = len(self.data_bytes)\n\n        padding0 = b''\n        offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n        if offset % 4 != 0:\n            padding0 = b'\\0'*(4-offset%4)\n            offset += (4-offset%4)\n\n        if params_bytes_len > 0:\n            params_bytes_offset = offset\n        else:\n            params_bytes_offset = 0\n\n        offset += params_bytes_len\n        padding1 = b''\n        if offset % 4 != 0:\n            padding1 = b'\\0'*(4-offset%4)\n            offset += (4-offset%4)\n\n        if data_bytes_len > 0:\n            data_bytes_offset = offset\n        else:\n            data_bytes_offset = 0\n\n        message.parameters_data = \\\n            struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n                        self.max_setup_count,\n                        0x00,           # Reserved1. Must be 0x00\n                        self.total_params_count,\n                        self.total_data_count,\n                        self.max_params_count,\n                        self.max_data_count,\n                        params_bytes_len,\n                        params_bytes_offset,\n                        data_bytes_len,\n                        data_bytes_offset,\n                        int(setup_bytes_len / 2),\n                        self.function) + \\\n            self.setup_bytes\n\n        message.data = padding0 + self.params_bytes + padding1 + self.data_bytes\n\n\nclass ComNTTransactResponse(Payload):\n    """\n    Contains information about a SMB_COM_NT_TRANSACT response from the server\n\n    After decoding, each instance contains the following attributes:\n    - total_params_count (integer)\n    - total_data_count (integer)\n    - setup_bytes (string)\n    - data_bytes (string)\n    - params_bytes (string)\n\n    References:\n    ===========\n    - [MS-CIFS]: 2.2.4.62.2\n    """\n    PAYLOAD_STRUCT_FORMAT = '<3sIIIIIIIIBH'\n    PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n    def decode(self, message):\n        assert message.command == SMB_COM_NT_TRANSACT\n\n        if not message.status.hasError:\n            _, self.total_params_count, self.total_data_count, \\\n            params_count, params_offset, params_displ, \\\n            data_count, data_offset, data_displ, setup_count = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,\n                                                                             message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n            self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_count*2]\n\n            if params_count > 0:\n                params_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2\n                self.params_bytes = message.data[params_offset:params_offset+params_count]\n            else:\n                self.params_bytes = b''\n\n            if data_count > 0:\n                data_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2\n                self.data_bytes = message.data[data_offset:data_offset+data_count]\n            else:\n                self.data_bytes = b''\n
\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/_sources/api/nmb_NBNSProtocol.rst.txt", "content": "\nNBNSProtocol Class\n==================\n\npysmb has a *NBNSProtocol* implementation for Twisted framework.\nThis allows you to perform name query asynchronously without having your application to block and wait for the results.\n\nIn your project,\n 1. Create a NBNSProtocol instance.\n 2. Just call *queryName* method which will return a *Deferred* instance. Add your callback function to the *Deferred* instance via *addCallback* method to receive the results of the name query.\n 3. When you are done with the NBNSProtocol instance, call its .transport.stopListening method to remove this instance from the reactor.\n\n.. autoclass:: nmb.NetBIOSProtocol.NBNSProtocol\n :members:\n :special-members:\n\n.. autoclass:: nmb.NetBIOSProtocol.NetBIOSTimeout\n :members:\n" }, { "path": "docs/html/_sources/api/nmb_NBNSProtocol.txt", "content": "\nNBNSProtocol Class\n==================\n\npysmb has a *NBNSProtocol* implementation for Twisted framework.\nThis allows you to perform name query asynchronously without having your application to block and wait for the results.\n\nIn your project,\n 1. Create a NBNSProtocol instance.\n 2. Just call *queryName* method which will return a *Deferred* instance. Add your callback function to the *Deferred* instance via *addCallback* method to receive the results of the name query.\n 3. When you are done with the NBNSProtocol instance, call its .transport.stopListening method to remove this instance from the reactor.\n\n.. autoclass:: nmb.NetBIOSProtocol.NBNSProtocol\n :members:\n :special-members:\n\n.. autoclass:: nmb.NetBIOSProtocol.NetBIOSTimeout\n :members:\n" }, { "path": "docs/html/_sources/api/nmb_NetBIOS.rst.txt", "content": "\nNetBIOS class\n=============\n\nTo use the NetBIOS class in your application,\n 1. Create a new NetBIOS instance\n 2. Call *queryName* method for each name you wish to query. The method will block until a reply is received from the remote SMB/CIFS service, or until timeout.\n 3. When you are done, call *close* method to release the underlying resources.\n\n.. autoclass:: nmb.NetBIOS.NetBIOS\n :members:\n :special-members:\n" }, { "path": "docs/html/_sources/api/nmb_NetBIOS.txt", "content": "\nNetBIOS class\n=============\n\nTo use the NetBIOS class in your application,\n 1. Create a new NetBIOS instance\n 2. Call *queryName* method for each name you wish to query. The method will block until a reply is received from the remote SMB/CIFS service, or until timeout.\n 3. When you are done, call *close* method to release the underlying resources.\n\n.. autoclass:: nmb.NetBIOS.NetBIOS\n :members:\n :special-members:\n" }, { "path": "docs/html/_sources/api/smb_SMBConnection.rst.txt", "content": "\nSMBConnection Class\n===================\n\nThe SMBConnection is suitable for developers who wish to use pysmb to perform file operations with a remote SMB/CIFS server sequentially.\n\nEach file operation method, when invoked, will block and return after it has completed or has encountered an error.\n\nExample\n-------\n\nThe following illustrates a simple file retrieving implementation.::\n\n import tempfile\n from smb.SMBConnection import SMBConnection\n\n # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n # client_machine_name can be an arbitary ASCII string\n # server_name should match the remote machine name, or else the connection will be rejected\n conn = SMBConnection(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\n assert conn.connect(server_ip, 139)\n\n file_obj = tempfile.NamedTemporaryFile()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', file_obj)\n\n # Retrieved file contents are inside file_obj\n # Do what you need with the file_obj and then close it\n # Note that the file obj is positioned at the end-of-file,\n # so you might need to perform a file_obj.seek() if you need\n # to read from the beginning\n file_obj.close()\n\nSMB2 Support\n-------------\n\nStarting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.\n\nTo disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBConnection* instance.::\n\n from smb import smb_structs\n smb_structs.SUPPORT_SMB2 = False\n\nCaveats\n-------\n\n* It is not meant to be used asynchronously.\n* A single *SMBConnection* instance should not be used to perform more than one operation concurrently at the same time.\n* Do not keep a *SMBConnection* instance \"idle\" for too long, i.e. keeping a *SMBConnection* instance but not using it.\n Most SMB/CIFS servers have some sort of keepalive mechanism and impose a timeout limit.\n If the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client.\n\n.. autoclass:: smb.SMBConnection.SMBConnection\n :members:\n :special-members:\n" }, { "path": "docs/html/_sources/api/smb_SMBConnection.txt", "content": "\nSMBConnection Class\n===================\n\nThe SMBConnection is suitable for developers who wish to use pysmb to perform file operations with a remote SMB/CIFS server sequentially.\n\nEach file operation method, when invoked, will block and return after it has completed or has encountered an error.\n\nExample\n-------\n\nThe following illustrates a simple file retrieving implementation.::\n\n import tempfile\n from smb.SMBConnection import SMBConnection\n\n # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n # client_machine_name can be an arbitary ASCII string\n # server_name should match the remote machine name, or else the connection will be rejected\n conn = SMBConnection(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\n assert conn.connect(server_ip, 139)\n\n file_obj = tempfile.NamedTemporaryFile()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', file_obj)\n\n # Retrieved file contents are inside file_obj\n # Do what you need with the file_obj and then close it\n # Note that the file obj is positioned at the end-of-file,\n # so you might need to perform a file_obj.seek() if you need\n # to read from the beginning\n file_obj.close()\n\nSMB2 Support\n-------------\n\nStarting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.\n\nTo disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBConnection* instance.::\n\n from smb import smb_structs\n smb_structs.SUPPORT_SMB2 = False\n\nCaveats\n-------\n\n* It is not meant to be used asynchronously.\n* A single *SMBConnection* instance should not be used to perform more than one operation concurrently at the same time.\n* Do not keep a *SMBConnection* instance \"idle\" for too long, i.e. keeping a *SMBConnection* instance but not using it.\n Most SMB/CIFS servers have some sort of keepalive mechanism and impose a timeout limit.\n If the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client.\n\n.. autoclass:: smb.SMBConnection.SMBConnection\n :members:\n :special-members:\n" }, { "path": "docs/html/_sources/api/smb_SMBHandler.rst.txt", "content": "\nSMbHandler Class\n================\n\nThe SMBHandler class provides support for \"smb://\" URLs in the `urllib2 `_ python package.\n\nNotes\n-----\n* The host component of the URL must be one of the following:\n\n * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com\n * An IP address. Example: 192.168.1.1\n * A comma-separated string \",\" where ** is the Windows/NetBIOS machine name for remote SMB service, and ** is the service's IP address. Example: MYSERVER,192.168.1.1\n\n* The first component of the path in the URL points to the name of the shared folder.\n Subsequent path components will point to the directory/folder of the file.\n* You can retrieve and upload files, but you cannot delete files/folders or create folders.\n In uploads, if the parent folders do not exist, an *urllib2.URLError* will be raised.\n\nExample\n-------\n\nThe following code snippet illustrates file retrieval with Python 2.::\n\n # -*- coding: utf-8 -*-\n import urllib2\n from smb.SMBHandler import SMBHandler\n\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n # Process fh like a file-like object and then close it.\n fh.close()\n\n # For paths/files with unicode characters, simply pass in the URL as an unicode string\n fh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n # Process fh2 like a file-like object and then close it.\n fh2.close()\n\nThe following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the *data* parameter in the *open()* method::\n\n import urllib2\n from smb.SMBHandler import SMBHandler\n\n file_fh = open('local_file.dat', 'rb')\n\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n # Reading from fh will only return an empty string\n fh.close()\n\n\nThe following code snippet illustrates file retrieval with Python 3.::\n\n import urllib\n from smb.SMBHandler import SMBHandler\n\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n # Process fh like a file-like object and then close it.\n fh.close()\n\n # For paths/files with unicode characters, simply pass in the URL as an unicode string\n fh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n # Process fh2 like a file-like object and then close it.\n fh2.close()\n\nThe following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the *data* parameter in the *open()* method::\n\n import urllib\n from smb.SMBHandler import SMBHandler\n\n file_fh = open('local_file.dat', 'rb')\n\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n # Reading from fh will only return an empty string\n fh.close()\n" }, { "path": "docs/html/_sources/api/smb_SMBHandler.txt", "content": "\nSMbHandler Class\n================\n\nThe SMBHandler class provides support for \"smb://\" URLs in the `urllib2 `_ python package.\n\nNotes\n-----\n* The host component of the URL must be one of the following:\n\n * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com\n * An IP address. Example: 192.168.1.1\n * A comma-separated string \",\" where ** is the Windows/NetBIOS machine name for remote SMB service, and ** is the service's IP address. Example: MYSERVER,192.168.1.1\n\n* The first component of the path in the URL points to the name of the shared folder.\n Subsequent path components will point to the directory/folder of the file.\n* You can retrieve and upload files, but you cannot delete files/folders or create folders.\n In uploads, if the parent folders do not exist, an *urllib2.URLError* will be raised.\n\nExample\n-------\n\nThe following code snippet illustrates file retrieval with Python 2.::\n\n # -*- coding: utf-8 -*-\n import urllib2\n from smb.SMBHandler import SMBHandler\n\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n # Process fh like a file-like object and then close it.\n fh.close()\n\n # For paths/files with unicode characters, simply pass in the URL as an unicode string\n fh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n # Process fh2 like a file-like object and then close it.\n fh2.close()\n\nThe following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the *data* parameter in the *open()* method::\n\n import urllib2\n from smb.SMBHandler import SMBHandler\n\n file_fh = open('local_file.dat', 'rb')\n\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n # Reading from fh will only return an empty string\n fh.close()\n\n\nThe following code snippet illustrates file retrieval with Python 3.::\n\n import urllib\n from smb.SMBHandler import SMBHandler\n\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n # Process fh like a file-like object and then close it.\n fh.close()\n\n # For paths/files with unicode characters, simply pass in the URL as an unicode string\n fh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n # Process fh2 like a file-like object and then close it.\n fh2.close()\n\nThe following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the *data* parameter in the *open()* method::\n\n import urllib\n from smb.SMBHandler import SMBHandler\n\n file_fh = open('local_file.dat', 'rb')\n\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n # Reading from fh will only return an empty string\n fh.close()\n" }, { "path": "docs/html/_sources/api/smb_SMBProtocolFactory.rst.txt", "content": "\nSMBProtocolFactory Class\n========================\n\nFor those who want to utilize pysmb in Twisted framework, pysmb has a *smb.SMBProtocol.SMBProtocol* implementation.\nIn most cases, you do not need to touch or import the *SMBProtocol* directly. All the SMB functionalities are exposed in the *SMBProtocolFactory*.\n\nIn your project,\n 1. Create a new class and subclass *SMBProtocolFactory*.\n 2. Override the *SMBProtocolFactory.onAuthOK* and *SMBProtocolFactory.onAuthFailed* instance methods to provide your own post-authenthentication handling.\n Once *SMBProtocolFactory.onAuthOK* has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through\n the *SMBProtocolFactory* public methods such as *SMBProtocolFactory.storeFile*, *SMBProtocolFactory.retrieveFile*, etc.\n 3. When you want to disconnect from the remote SMB/CIFS server, just call *SMBProtocolFactory.closeConnection* method.\n\nAll the *SMBProtocolFactory* public methods that provide file functionlities will return a *twisted.internet.defer.Deferred* instance.\nA :doc:`NotReadyError` exception is raised when the underlying SMB is not authenticated.\nIf the underlying SMB connection has been terminated, a :doc:`NotConnectedError` exception is raised.\n\nAll the file operation methods in *SMBProtocolFactory* class accept a *timeout* parameter. This parameter specifies the time limit where pysmb will wait for the\nentire file operation (except *storeFile* and *retrieveFile* methods) to complete. If the file operation fails to complete within the timeout period, the returned\n*Deferred* instance's *errback* method will be called with a *SMBTimeout* exception.\n\nIf you are interested in learning the results of the operation or to know when the operation has completed, you should\nadd a handling method to the returned *Deferred* instance via *Deferred.addCallback*. If the file operation fails, the *Deferred.errback* function will be called\nwith an :doc:`OperationFailure`; on timeout, it will be called with a :doc:`SMBTimeout`.\n\nExample\n-------\n\nThe following illustrates a simple file retrieving implementation.::\n\n import tempfile\n from twisted.internet import reactor\n from smb.SMBProtocol import SMBProtocolFactory\n\n class RetrieveFileFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n\n def fileRetrieved(self, write_result):\n file_obj, file_attributes, file_size = write_result\n\n # Retrieved file contents are inside file_obj\n # Do what you need with the file_obj and then close it\n # Note that the file obj is positioned at the end-of-file,\n # so you might need to perform a file_obj.seek() to if you\n # need to read from the beginning\n file_obj.close()\n\n self.transport.loseConnection()\n\n def onAuthOK(self):\n d = self.retrieveFile(self.service, self.path, tempfile.NamedTemporaryFile())\n d.addCallback(self.fileRetrieved)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n print 'Auth failed'\n\n # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n # client_machine_name can be an arbitary ASCII string\n # server_name should match the remote machine name, or else the connection will be rejected\n factory = RetrieveFileFactory(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/rfc1001.txt'\n reactor.connectTCP(server_ip, 139, factory)\n\n\n\n\nSMB2 Support\n-------------\n\nStarting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.\n\nTo disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBProtocolFactory* instance.::\n\n from smb import smb_structs\n smb_structs.SUPPORT_SMB2 = False\n\nCaveats\n-------\n\n* A new factory instance must be created for each SMB connection to the remote SMB/CIFS service. Avoid reusing the same factory instance for more than one SMB connection.\n* The remote SMB/CIFS server usually imposes a limit of the number of concurrent file operations for each client. For example, to transfer a thousand files, you may need to setup a queue in your application and call *storeFile* or *retrieveFile* in batches.\n* The *timeout* parameter in the file operation methods are not precise; it is accurate to within 1 second interval, i.e. with a timeout of 0.5 sec, pysmb might raise\n *SMBTimeout* exception after 1.5 sec.\n\n.. autoclass:: smb.SMBProtocol.SMBProtocolFactory\n :members:\n :special-members:\n" }, { "path": "docs/html/_sources/api/smb_SMBProtocolFactory.txt", "content": "\nSMBProtocolFactory Class\n========================\n\nFor those who want to utilize pysmb in Twisted framework, pysmb has a *smb.SMBProtocol.SMBProtocol* implementation.\nIn most cases, you do not need to touch or import the *SMBProtocol* directly. All the SMB functionalities are exposed in the *SMBProtocolFactory*.\n\nIn your project,\n 1. Create a new class and subclass *SMBProtocolFactory*.\n 2. Override the *SMBProtocolFactory.onAuthOK* and *SMBProtocolFactory.onAuthFailed* instance methods to provide your own post-authenthentication handling.\n Once *SMBProtocolFactory.onAuthOK* has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through\n the *SMBProtocolFactory* public methods such as *SMBProtocolFactory.storeFile*, *SMBProtocolFactory.retrieveFile*, etc.\n 3. When you want to disconnect from the remote SMB/CIFS server, just call *SMBProtocolFactory.closeConnection* method.\n\nAll the *SMBProtocolFactory* public methods that provide file functionlities will return a *twisted.internet.defer.Deferred* instance.\nA :doc:`NotReadyError` exception is raised when the underlying SMB is not authenticated.\nIf the underlying SMB connection has been terminated, a :doc:`NotConnectedError` exception is raised.\n\nAll the file operation methods in *SMBProtocolFactory* class accept a *timeout* parameter. This parameter specifies the time limit where pysmb will wait for the\nentire file operation (except *storeFile* and *retrieveFile* methods) to complete. If the file operation fails to complete within the timeout period, the returned\n*Deferred* instance's *errback* method will be called with a *SMBTimeout* exception.\n\nIf you are interested in learning the results of the operation or to know when the operation has completed, you should\nadd a handling method to the returned *Deferred* instance via *Deferred.addCallback*. If the file operation fails, the *Deferred.errback* function will be called\nwith an :doc:`OperationFailure`; on timeout, it will be called with a :doc:`SMBTimeout`.\n\nExample\n-------\n\nThe following illustrates a simple file retrieving implementation.::\n\n import tempfile\n from twisted.internet import reactor\n from smb.SMBProtocol import SMBProtocolFactory\n\n class RetrieveFileFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n\n def fileRetrieved(self, write_result):\n file_obj, file_attributes, file_size = write_result\n\n # Retrieved file contents are inside file_obj\n # Do what you need with the file_obj and then close it\n # Note that the file obj is positioned at the end-of-file,\n # so you might need to perform a file_obj.seek() to if you\n # need to read from the beginning\n file_obj.close()\n\n self.transport.loseConnection()\n\n def onAuthOK(self):\n d = self.retrieveFile(self.service, self.path, tempfile.NamedTemporaryFile())\n d.addCallback(self.fileRetrieved)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n print 'Auth failed'\n\n # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n # client_machine_name can be an arbitary ASCII string\n # server_name should match the remote machine name, or else the connection will be rejected\n factory = RetrieveFileFactory(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/rfc1001.txt'\n reactor.connectTCP(server_ip, 139, factory)\n\n\n\n\nSMB2 Support\n-------------\n\nStarting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.\n\nTo disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBProtocolFactory* instance.::\n\n from smb import smb_structs\n smb_structs.SUPPORT_SMB2 = False\n\nCaveats\n-------\n\n* A new factory instance must be created for each SMB connection to the remote SMB/CIFS service. Avoid reusing the same factory instance for more than one SMB connection.\n* The remote SMB/CIFS server usually imposes a limit of the number of concurrent file operations for each client. For example, to transfer a thousand files, you may need to setup a queue in your application and call *storeFile* or *retrieveFile* in batches.\n* The *timeout* parameter in the file operation methods are not precise; it is accurate to within 1 second interval, i.e. with a timeout of 0.5 sec, pysmb might raise\n *SMBTimeout* exception after 1.5 sec.\n\n.. autoclass:: smb.SMBProtocol.SMBProtocolFactory\n :members:\n :special-members:\n" }, { "path": "docs/html/_sources/api/smb_SharedDevice.rst.txt", "content": "\nSharedDevice Class\n==================\n\n.. autoclass:: smb.base.SharedDevice\n :members:\n" }, { "path": "docs/html/_sources/api/smb_SharedDevice.txt", "content": "\nSharedDevice Class\n==================\n\n.. autoclass:: smb.base.SharedDevice\n :members:\n" }, { "path": "docs/html/_sources/api/smb_SharedFile.rst.txt", "content": "\nSharedFile Class\n================\n\n.. autoclass:: smb.base.SharedFile\n :members:\n" }, { "path": "docs/html/_sources/api/smb_SharedFile.txt", "content": "\nSharedFile Class\n================\n\n.. autoclass:: smb.base.SharedFile\n :members:\n" }, { "path": "docs/html/_sources/api/smb_exceptions.rst.txt", "content": "\nSMB Exceptions\n==============\n\n.. autoclass:: smb.base.SMBTimeout\n :members:\n\n.. autoclass:: smb.base.NotReadyError\n :members:\n\n.. autoclass:: smb.base.NotConnectedError\n :members:\n\n.. autoclass:: smb.smb_structs.UnsupportedFeature\n :members:\n\n.. autoclass:: smb.smb_structs.ProtocolError\n :members:\n\n.. autoclass:: smb.smb_structs.OperationFailure\n :members:\n" }, { "path": "docs/html/_sources/api/smb_exceptions.txt", "content": "\nSMB Exceptions\n==============\n\n.. autoclass:: smb.base.SMBTimeout\n :members:\n\n.. autoclass:: smb.base.NotReadyError\n :members:\n\n.. autoclass:: smb.base.NotConnectedError\n :members:\n\n.. autoclass:: smb.smb_structs.UnsupportedFeature\n :members:\n\n.. autoclass:: smb.smb_structs.ProtocolError\n :members:\n\n.. autoclass:: smb.smb_structs.OperationFailure\n :members:\n" }, { "path": "docs/html/_sources/api/smb_security_descriptors.rst.txt", "content": "\nSecurity Descriptors\n====================\n\n.. module:: smb.security_descriptors\n :synopsis: Data structures used in Windows security descriptors.\n\nThis module implements security descriptors, and associated data\nstructures, as specified in `[MS-DTYP]`_.\n\n.. autoclass:: SID\n :members:\n\n.. autoclass:: ACE\n :members:\n\n.. autoclass:: ACL\n :members:\n\n.. autoclass:: SecurityDescriptor\n :members:\n\n.. _[MS-DTYP]: https://msdn.microsoft.com/en-us/library/cc230273.aspx\n" }, { "path": "docs/html/_sources/api/smb_security_descriptors.txt", "content": "\nSecurity Descriptors\n====================\n\n.. module:: smb.security_descriptors\n :synopsis: Data structures used in Windows security descriptors.\n\nThis module implements security descriptors, and associated data\nstructures, as specified in `[MS-DTYP]`_.\n\n.. autoclass:: SID\n :members:\n\n.. autoclass:: ACE\n :members:\n\n.. autoclass:: ACL\n :members:\n\n.. autoclass:: SecurityDescriptor\n :members:\n\n.. _[MS-DTYP]: https://msdn.microsoft.com/en-us/library/cc230273.aspx\n" }, { "path": "docs/html/_sources/extending.rst.txt", "content": "\nExtending pysmb For Other Frameworks\n====================================\n\nThis page briefly describes the steps involved in extending pysmb for other frameworks.\n\nIn general, you need to take care of the SMB TCP connection setup, i.e. finding the IP address of the remote server and connect to the SMB/CIFS service.\nThen you need to read/write synchronously or asynchronously from and to the SMB socket. And you need to handle post-authentication callback methods, and from these methods,\ninitiate file operations with the remote SMB/CIFS server.\n\nNow the above steps in more technical details:\n 1. Create a new class which subclasses the *smb.base.SMB* class. Most often, the connection setup will be part of the *__init__* method.\n 2. Override the *write(self, data)* method to provide an implementation which will write *data* to the socket.\n 3. Write your own loop handling method to read data from the socket. Once data have been read, call *feedData* method with the parameter.\n The *feedData* method has its own internal buffer, so it can accept incomplete NetBIOS session packet data.\n 4. Override\n \n * *onAuthOK* method to include your own operations to perform when authentication is successful. You can initiate file operations in this method.\n * *onAuthFailed* method to include your own processing on what to do when authentication fails. You can report this as an error, or to try a different NTLM authentication algorithm (*use_ntlm_v2* parameter in the constructor).\n * *onNMBSessionFailed* method to include your own processing on what to do when pysmb fails to setup the NetBIOS session with the remote server. Usually, this is due to a wrong *remote_name* parameter in the constructor.\n" }, { "path": "docs/html/_sources/extending.txt", "content": "\nExtending pysmb For Other Frameworks\n====================================\n\nThis page briefly describes the steps involved in extending pysmb for other frameworks.\n\nIn general, you need to take care of the SMB TCP connection setup, i.e. finding the IP address of the remote server and connect to the SMB/CIFS service.\nThen you need to read/write synchronously or asynchronously from and to the SMB socket. And you need to handle post-authentication callback methods, and from these methods,\ninitiate file operations with the remote SMB/CIFS server.\n\nNow the above steps in more technical details:\n 1. Create a new class which subclasses the *smb.base.SMB* class. Most often, the connection setup will be part of the *__init__* method.\n 2. Override the *write(self, data)* method to provide an implementation which will write *data* to the socket.\n 3. Write your own loop handling method to read data from the socket. Once data have been read, call *feedData* method with the parameter.\n The *feedData* method has its own internal buffer, so it can accept incomplete NetBIOS session packet data.\n 4. Override\n * *onAuthOK* method to include your own operations to perform when authentication is successful. You can initiate file operations in this method.\n * *onAuthFailed* method to include your own processing on what to do when authentication fails. You can report this as an error, or to try a different NTLM authentication algorithm (*use_ntlm_v2* parameter in the constructor).\n * *onNMBSessionFailed* method to include your own processing on what to do when pysmb fails to setup the NetBIOS session with the remote server. Usually, this is due to a wrong *remote_name* parameter in the constructor.\n" }, { "path": "docs/html/_sources/index.rst.txt", "content": "Welcome to pysmb's documentation!\n=================================\n\npysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol\nthat facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application.\npysmb is developed in Python 2.7.x and Python 3.8.x and has been tested against shared folders on Windows 7, Windows 10 and Samba 4.x.\n\nThe latest version of pysmb is always available at the pysmb project page at `miketeo.net `_.\n\nLicense\n-------\npysmb itself is licensed under an opensource license.\nYou are free to use pysmb in any applications, including for commercial purposes.\nFor more details on the terms of use, please read the LICENSE file that comes with your pysmb source.\n\npysmb depends on other 3rd-party modules whose terms of use are not covered by pysmb.\nUse of these modules could possibly conflict with your licensing needs. Please exercise your own discretion to determine their suitabilities.\nI have listed these modules in the following section.\n\nCredits\n-------\npysmb is not alone. It is made possible with support from other modules.\n\n* **pyasn1** : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately)\n* **md4** and **U32** : Pure Python implementation of MD4 hashing algorithm and 32-bit unsigned integer by Dmitry Rozmanov. Licensed under LGPL and included together with pysmb.\n* **pyDes** : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb.\n* **sha256** : Pure Python implementation of SHA-256 message digest by Thomas Dixon. Licensed under MIT and included together with pysmb. This module is imported only when\n the Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm.\n\nIn various places, there are references to different specifications. Most of these referenced specifications\ncan be downloaded from Microsoft web site under Microsoft's \"Open Specification Promise\". If you need to download\na copy of these specifications, please google for it. For example, google for \"MS-CIFS\" to download the CIFS specification for NT LM dialect.\n\nPackage Contents and Description\n================================\n\npysmb is organized into 2 main packages: smb and nmb.\nThe smb package contains all the functionalities related to Server Message Block (SMB) implementation.\nAs an application developer, you will be importing this module into your application.\nHence, please take some time to familiarize yourself with the smb package contents.\n\n* **nmb/base.py** :\n Contains the NetBIOSSession and NBNS abstract class which implements NetBIOS session and NetBIOS Name Service communication\n without any network transport specifics.\n* **nmb/NetBIOS.py**:\n Provides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O.\n* **nmb/NetBIOSProtocol.py** :\n Provides the NBNS protocol implementation for use in Twisted framework.\n\n* **smb/base.py** :\n Contains the SMB abstract class which implements the SMB communication without any network transport specifics.\n* **smb/ntlm.py** :\n Contains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages.\n* **smb/securityblob.py** :\n Provides routines to encode/decode the NTLMSSP security blob in the SMB messages.\n* **smb/smb_constants.py** :\n All the constants used in the smb package for SMB1 protocol\n* **smb/smb_structs.py** :\n Contains the internal classes used in the SMB package for SMB1 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB1 message.\n* **smb/smb2_constants.py** :\n All the constants used in the smb package for SMB2 protocol\n* **smb/smb2_structs.py** :\n Contains the internal classes used in the SMB package for SMB2 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB2 message.\n* **smb/SMBConnection.py** :\n Contains a SMB protocol implementation. All operations are blocking I/O.\n* **smb/SMBProtocol.py** :\n Contains the SMB protocol implementation for use in the Twisted framework.\n* **smb/SMBHandler.py** :\n Provides support for \"smb://\" URL in the urllib2 python package.\n\nUsing pysmb\n===========\n\nAs an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses,\n * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read\n :doc:`nmb.NetBIOS.NetBIOS` documentation.\n * To use pysmb in Twisted, please read :doc:`nmb.NetBIOSProtocol.NBNSProtocol` documentation.\n\nAs an application developer who is looking to use pysmb to implement file transfer or authentication over SMB:\n * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read\n :doc:`smb.SMBConnection.SMBConnection` documentation.\n * To use pysmb in Twisted, please read :doc:`smb.SMBProtocol.SMBProtocolFactory` documentation.\n * To support \"smb://\" URL in urllib2 python package, read :doc:`smb.SMBHandler.SMBHandler` documentation.\n\nAs a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks:\n * Read :doc:`extending`\n\nIf you are upgrading from older pysmb versions:\n * Read :doc:`upgrading`\n\n\nIndices and tables\n==================\n\n.. toctree::\n :glob:\n :maxdepth: 1\n\n api/*\n extending\n upgrading\n\n* :ref:`genindex`\n* :ref:`search`\n" }, { "path": "docs/html/_sources/index.txt", "content": ".. pysmb documentation master file, created by\n sphinx-quickstart on Sun Dec 18 15:54:40 2011.\n You can adapt this file completely to your liking, but it should at least\n contain the root `toctree` directive.\n\nWelcome to pysmb's documentation!\n=================================\n\npysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol\nthat facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application.\npysmb is developed in Python 2.7.x and Python 3.5.x and has been tested against shared folders on Windows XP SP3, Windows Vista, Windows 7 and Samba 3.x.\n\nThe latest version of pysmb is always available at the pysmb project page at `miketeo.net `_.\n\nLicense\n-------\npysmb itself is licensed under an opensource license.\nYou are free to use pysmb in any applications, including for commercial purposes.\nFor more details on the terms of use, please read the LICENSE file that comes with your pysmb source.\n\npysmb depends on other 3rd-party modules whose terms of use are not covered by pysmb.\nUse of these modules could possibly conflict with your licensing needs. Please exercise your own discretion to determine their suitabilities.\nI have listed these modules in the following section.\n\nCredits\n-------\npysmb is not alone. It is made possible with support from other modules.\n\n* **pyasn1** : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately)\n* **md4** and **U32** : Pure Python implementation of MD4 hashing algorithm and 32-bit unsigned integer by Dmitry Rozmanov. Licensed under LGPL and included together with pysmb.\n* **pyDes** : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb.\n* **sha256** : Pure Python implementation of SHA-256 message digest by Thomas Dixon. Licensed under MIT and included together with pysmb. This module is imported only when\n the Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm.\n\nIn various places, there are references to different specifications. Most of these referenced specifications\ncan be downloaded from Microsoft web site under Microsoft's \"Open Specification Promise\". If you need to download\na copy of these specifications, please google for it. For example, google for \"MS-CIFS\" to download the CIFS specification for NT LM dialect.\n\nPackage Contents and Description\n================================\n\npysmb is organized into 2 main packages: smb and nmb.\nThe smb package contains all the functionalities related to Server Message Block (SMB) implementation.\nAs an application developer, you will be importing this module into your application.\nHence, please take some time to familiarize yourself with the smb package contents.\n\n* **nmb/base.py** :\n Contains the NetBIOSSession and NBNS abstract class which implements NetBIOS session and NetBIOS Name Service communication\n without any network transport specifics.\n* **nmb/NetBIOS.py**:\n Provides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O.\n* **nmb/NetBIOSProtocol.py** :\n Provides the NBNS protocol implementation for use in Twisted framework.\n\n* **smb/base.py** :\n Contains the SMB abstract class which implements the SMB communication without any network transport specifics.\n* **smb/ntlm.py** :\n Contains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages.\n* **smb/securityblob.py** :\n Provides routines to encode/decode the NTLMSSP security blob in the SMB messages.\n* **smb/smb_constants.py** :\n All the constants used in the smb package for SMB1 protocol\n* **smb/smb_structs.py** :\n Contains the internal classes used in the SMB package for SMB1 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB1 message.\n* **smb/smb2_constants.py** :\n All the constants used in the smb package for SMB2 protocol\n* **smb/smb2_structs.py** :\n Contains the internal classes used in the SMB package for SMB2 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB2 message.\n* **smb/SMBConnection.py** :\n Contains a SMB protocol implementation. All operations are blocking I/O.\n* **smb/SMBProtocol.py** :\n Contains the SMB protocol implementation for use in the Twisted framework.\n* **smb/SMBHandler.py** :\n Provides support for \"smb://\" URL in the urllib2 python package.\n\nUsing pysmb\n===========\n\nAs an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses,\n * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read\n :doc:`nmb.NetBIOS.NetBIOS` documentation.\n * To use pysmb in Twisted, please read :doc:`nmb.NetBIOSProtocol.NBNSProtocol` documentation.\n\nAs an application developer who is looking to use pysmb to implement file transfer or authentication over SMB:\n * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read\n :doc:`smb.SMBConnection.SMBConnection` documentation.\n * To use pysmb in Twisted, please read :doc:`smb.SMBProtocol.SMBProtocolFactory` documentation.\n * To support \"smb://\" URL in urllib2 python package, read :doc:`smb.SMBHandler.SMBHandler` documentation.\n\nAs a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks:\n * Read :doc:`extending`\n\nIf you are upgrading from older pysmb versions:\n * Read :doc:`upgrading`\n\n\nIndices and tables\n==================\n\n.. toctree::\n :glob:\n :maxdepth: 1\n\n api/*\n extending\n upgrading\n\n* :ref:`genindex`\n* :ref:`search`\n" }, { "path": "docs/html/_sources/upgrading.rst.txt", "content": "Upgrading from older pysmb versions\n====================================\n\nThis page documents the improvements and changes to the API that could be incompatible with previous releases.\n\npysmb 1.2.0\n-----------\n- Add new `delete_matching_folders` parameter to `deleteFiles()` method in SMBProtocolFactory and SMBConnection\n class to support deletion of sub-folders. If you are passing timeout parameter to the `deleteFiles()` method\n in your application, please switch to using named parameter for timeout.\n\npysmb 1.1.28\n------------\n- SharedFile instances returned from the `listPath()` method now has a new property\n `file_id` attribute which represents the file reference number given by the remote SMB server.\n\npysmb 1.1.26\n------------\n- SMBConnection class can now be used as a context manager\n\npysmb 1.1.25\n------------\n- SharedFile class has a new property `isNormal` which will be True if the file is a\n 'normal' file. pysmb defines a 'normal' file as a file entry that is not\n read-only, not hidden, not system, not archive and not a directory;\n it ignores other attributes like compression, indexed, sparse, temporary and encryption.\n- `listPath()` method in SMBProtocolFactory and SMBConnection class will now include\n 'normal' files by default if you do not specify the `search` parameter.\n\npysmb 1.1.20\n------------\n- A new method `getSecurity()` was added to SMBConnection and SMBProtocolFactory class.\n\npysmb 1.1.15\n------------\n- Add new `truncate` parameter to `storeFileFromOffset()` in SMBProtocolFactory and SMBConnection\n class to support truncation of the file before writing. If you are passing timeout parameter\n to the `storeFileFromOffset()` method in your application, please switch to using named parameter for timeout.\n\npysmb 1.1.11\n------------\n- A new method `storeFileFromOffset()` was added to SMBConnection and SMBProtocolFactory class.\n\npysmb 1.1.10\n------------\n- A new method `getAttributes()` was added to SMBConnection and SMBProtocolFactory class\n- SharedFile class has a new property `isReadOnly` to indicate the file is read-only on the remote filesystem.\n\npysmb 1.1.2\n-----------\n- `queryIPForName()` method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names.\n\npysmb 1.0.3\n-----------\n- Two new methods were added to NBNSProtocol class: `queryIPForName()` and `NetBIOS.queryIPForName()`\n to support querying for a machine's NetBIOS name at the given IP address.\n- A new method `retrieveFileFromOffset()` was added to SMBProtocolFactory and SMBConnection\n to support finer control of file retrieval operation.\n\npysmb 1.0.0\n-----------\npysmb was completely rewritten in version 1.0.0.\nIf you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API.\n" }, { "path": "docs/html/_sources/upgrading.txt", "content": "Upgrading from older pysmb versions\n====================================\n\nThis page documents the improvements and changes to the API that could be incompatible with previous releases.\n\npysmb 1.2.0\n-----------\n- Add new `delete_matching_folders` parameter to `deleteFiles()` method in SMBProtocolFactory and SMBConnection\n class to support deletion of sub-folders. If you are passing timeout parameter to the `deleteFiles()` method\n in your application, please switch to using named parameter for timeout.\n\npysmb 1.1.28\n------------\n- SharedFile instances returned from the `listPath()` method now has a new property\n `file_id` attribute which represents the file reference number given by the remote SMB server.\n\npysmb 1.1.26\n------------\n- SMBConnection class can now be used as a context manager\n\npysmb 1.1.25\n------------\n- SharedFile class has a new property `isNormal` which will be True if the file is a\n 'normal' file. pysmb defines a 'normal' file as a file entry that is not\n read-only, not hidden, not system, not archive and not a directory;\n it ignores other attributes like compression, indexed, sparse, temporary and encryption.\n- `listPath()` method in SMBProtocolFactory and SMBConnection class will now include\n 'normal' files by default if you do not specify the `search` parameter.\n\npysmb 1.1.20\n------------\n- A new method `getSecurity()` was added to SMBConnection and SMBProtocolFactory class.\n\npysmb 1.1.15\n------------\n- Add new `truncate` parameter to `storeFileFromOffset()` in SMBProtocolFactory and SMBConnection\n class to support truncation of the file before writing. If you are passing timeout parameter\n to the `storeFileFromOffset()` method in your application, please switch to using named parameter for timeout.\n\npysmb 1.1.11\n------------\n- A new method `storeFileFromOffset()` was added to SMBConnection and SMBProtocolFactory class.\n\npysmb 1.1.10\n------------\n- A new method `getAttributes()` was added to SMBConnection and SMBProtocolFactory class\n- SharedFile class has a new property `isReadOnly` to indicate the file is read-only on the remote filesystem.\n\npysmb 1.1.2\n-----------\n- `queryIPForName()` method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names.\n\npysmb 1.0.3\n-----------\n- Two new methods were added to NBNSProtocol class: `queryIPForName()` and `NetBIOS.queryIPForName()`\n to support querying for a machine's NetBIOS name at the given IP address.\n- A new method `retrieveFileFromOffset()` was added to SMBProtocolFactory and SMBConnection\n to support finer control of file retrieval operation.\n\npysmb 1.0.0\n-----------\npysmb was completely rewritten in version 1.0.0.\nIf you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API.\n" }, { "path": "docs/html/_static/_sphinx_javascript_frameworks_compat.js", "content": "/*\n * _sphinx_javascript_frameworks_compat.js\n * ~~~~~~~~~~\n *\n * Compatability shim for jQuery and underscores.js.\n *\n * WILL BE REMOVED IN Sphinx 6.0\n * xref RemovedInSphinx60Warning\n *\n */\n\n/**\n * select a different prefix for underscore\n */\n$u = _.noConflict();\n\n\n/**\n * small helper function to urldecode strings\n *\n * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL\n */\njQuery.urldecode = function(x) {\n if (!x) {\n return x\n }\n return decodeURIComponent(x.replace(/\\+/g, ' '));\n};\n\n/**\n * small helper function to urlencode strings\n */\njQuery.urlencode = encodeURIComponent;\n\n/**\n * This function returns the parsed url parameters of the\n * current request. Multiple values per key are supported,\n * it will always return arrays of strings for the value parts.\n */\njQuery.getQueryParameters = function(s) {\n if (typeof s === 'undefined')\n s = document.location.search;\n var parts = s.substr(s.indexOf('?') + 1).split('&');\n var result = {};\n for (var i = 0; i < parts.length; i++) {\n var tmp = parts[i].split('=', 2);\n var key = jQuery.urldecode(tmp[0]);\n var value = jQuery.urldecode(tmp[1]);\n if (key in result)\n result[key].push(value);\n else\n result[key] = [value];\n }\n return result;\n};\n\n/**\n * highlight a given string on a jquery object by wrapping it in\n * span elements with the given class name.\n */\njQuery.fn.highlightText = function(text, className) {\n function highlight(node, addItems) {\n if (node.nodeType === 3) {\n var val = node.nodeValue;\n var pos = val.toLowerCase().indexOf(text);\n if (pos >= 0 &&\n !jQuery(node.parentNode).hasClass(className) &&\n !jQuery(node.parentNode).hasClass(\"nohighlight\")) {\n var span;\n var isInSVG = jQuery(node).closest(\"body, svg, foreignObject\").is(\"svg\");\n if (isInSVG) {\n span = document.createElementNS(\"http://www.w3.org/2000/svg\", \"tspan\");\n } else {\n span = document.createElement(\"span\");\n span.className = className;\n }\n span.appendChild(document.createTextNode(val.substr(pos, text.length)));\n node.parentNode.insertBefore(span, node.parentNode.insertBefore(\n document.createTextNode(val.substr(pos + text.length)),\n node.nextSibling));\n node.nodeValue = val.substr(0, pos);\n if (isInSVG) {\n var rect = document.createElementNS(\"http://www.w3.org/2000/svg\", \"rect\");\n var bbox = node.parentElement.getBBox();\n rect.x.baseVal.value = bbox.x;\n rect.y.baseVal.value = bbox.y;\n rect.width.baseVal.value = bbox.width;\n rect.height.baseVal.value = bbox.height;\n rect.setAttribute('class', className);\n addItems.push({\n \"parent\": node.parentNode,\n \"target\": rect});\n }\n }\n }\n else if (!jQuery(node).is(\"button, select, textarea\")) {\n jQuery.each(node.childNodes, function() {\n highlight(this, addItems);\n });\n }\n }\n var addItems = [];\n var result = this.each(function() {\n highlight(this, addItems);\n });\n for (var i = 0; i < addItems.length; ++i) {\n jQuery(addItems[i].parent).before(addItems[i].target);\n }\n return result;\n};\n\n/*\n * backward compatibility for jQuery.browser\n * This will be supported until firefox bug is fixed.\n */\nif (!jQuery.browser) {\n jQuery.uaMatch = function(ua) {\n ua = ua.toLowerCase();\n\n var match = /(chrome)[ \\/]([\\w.]+)/.exec(ua) ||\n /(webkit)[ \\/]([\\w.]+)/.exec(ua) ||\n /(opera)(?:.*version|)[ \\/]([\\w.]+)/.exec(ua) ||\n /(msie) ([\\w.]+)/.exec(ua) ||\n ua.indexOf(\"compatible\") < 0 && /(mozilla)(?:.*? rv:([\\w.]+)|)/.exec(ua) ||\n [];\n\n return {\n browser: match[ 1 ] || \"\",\n version: match[ 2 ] || \"0\"\n };\n };\n jQuery.browser = {};\n jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;\n}\n" }, { "path": "docs/html/_static/basic.css", "content": "/*\n * basic.css\n * ~~~~~~~~~\n *\n * Sphinx stylesheet -- basic theme.\n *\n * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.\n * :license: BSD, see LICENSE for details.\n *\n */\n\n/* -- main layout ----------------------------------------------------------- */\n\ndiv.clearer {\n clear: both;\n}\n\ndiv.section::after {\n display: block;\n content: '';\n clear: left;\n}\n\n/* -- relbar ---------------------------------------------------------------- */\n\ndiv.related {\n width: 100%;\n font-size: 90%;\n}\n\ndiv.related h3 {\n display: none;\n}\n\ndiv.related ul {\n margin: 0;\n padding: 0 0 0 10px;\n list-style: none;\n}\n\ndiv.related li {\n display: inline;\n}\n\ndiv.related li.right {\n float: right;\n margin-right: 5px;\n}\n\n/* -- sidebar --------------------------------------------------------------- */\n\ndiv.sphinxsidebarwrapper {\n padding: 10px 5px 0 10px;\n}\n\ndiv.sphinxsidebar {\n float: left;\n width: 230px;\n margin-left: -100%;\n font-size: 90%;\n word-wrap: break-word;\n overflow-wrap : break-word;\n}\n\ndiv.sphinxsidebar ul {\n list-style: none;\n}\n\ndiv.sphinxsidebar ul ul,\ndiv.sphinxsidebar ul.want-points {\n margin-left: 20px;\n list-style: square;\n}\n\ndiv.sphinxsidebar ul ul {\n margin-top: 0;\n margin-bottom: 0;\n}\n\ndiv.sphinxsidebar form {\n margin-top: 10px;\n}\n\ndiv.sphinxsidebar input {\n border: 1px solid #98dbcc;\n font-family: sans-serif;\n font-size: 1em;\n}\n\ndiv.sphinxsidebar #searchbox form.search {\n overflow: hidden;\n}\n\ndiv.sphinxsidebar #searchbox input[type=\"text\"] {\n float: left;\n width: 80%;\n padding: 0.25em;\n box-sizing: border-box;\n}\n\ndiv.sphinxsidebar #searchbox input[type=\"submit\"] {\n float: left;\n width: 20%;\n border-left: none;\n padding: 0.25em;\n box-sizing: border-box;\n}\n\n\nimg {\n border: 0;\n max-width: 100%;\n}\n\n/* -- search page ----------------------------------------------------------- */\n\nul.search {\n margin: 10px 0 0 20px;\n padding: 0;\n}\n\nul.search li {\n padding: 5px 0 5px 20px;\n background-image: url(file.png);\n background-repeat: no-repeat;\n background-position: 0 7px;\n}\n\nul.search li a {\n font-weight: bold;\n}\n\nul.search li p.context {\n color: #888;\n margin: 2px 0 0 30px;\n text-align: left;\n}\n\nul.keywordmatches li.goodmatch a {\n font-weight: bold;\n}\n\n/* -- index page ------------------------------------------------------------ */\n\ntable.contentstable {\n width: 90%;\n margin-left: auto;\n margin-right: auto;\n}\n\ntable.contentstable p.biglink {\n line-height: 150%;\n}\n\na.biglink {\n font-size: 1.3em;\n}\n\nspan.linkdescr {\n font-style: italic;\n padding-top: 5px;\n font-size: 90%;\n}\n\n/* -- general index --------------------------------------------------------- */\n\ntable.indextable {\n width: 100%;\n}\n\ntable.indextable td {\n text-align: left;\n vertical-align: top;\n}\n\ntable.indextable ul {\n margin-top: 0;\n margin-bottom: 0;\n list-style-type: none;\n}\n\ntable.indextable > tbody > tr > td > ul {\n padding-left: 0em;\n}\n\ntable.indextable tr.pcap {\n height: 10px;\n}\n\ntable.indextable tr.cap {\n margin-top: 10px;\n background-color: #f2f2f2;\n}\n\nimg.toggler {\n margin-right: 3px;\n margin-top: 3px;\n cursor: pointer;\n}\n\ndiv.modindex-jumpbox {\n border-top: 1px solid #ddd;\n border-bottom: 1px solid #ddd;\n margin: 1em 0 1em 0;\n padding: 0.4em;\n}\n\ndiv.genindex-jumpbox {\n border-top: 1px solid #ddd;\n border-bottom: 1px solid #ddd;\n margin: 1em 0 1em 0;\n padding: 0.4em;\n}\n\n/* -- domain module index --------------------------------------------------- */\n\ntable.modindextable td {\n padding: 2px;\n border-collapse: collapse;\n}\n\n/* -- general body styles --------------------------------------------------- */\n\ndiv.body {\n min-width: 360px;\n max-width: 800px;\n}\n\ndiv.body p, div.body dd, div.body li, div.body blockquote {\n -moz-hyphens: auto;\n -ms-hyphens: auto;\n -webkit-hyphens: auto;\n hyphens: auto;\n}\n\na.headerlink {\n visibility: hidden;\n}\n\na:visited {\n color: #551A8B;\n}\n\nh1:hover > a.headerlink,\nh2:hover > a.headerlink,\nh3:hover > a.headerlink,\nh4:hover > a.headerlink,\nh5:hover > a.headerlink,\nh6:hover > a.headerlink,\ndt:hover > a.headerlink,\ncaption:hover > a.headerlink,\np.caption:hover > a.headerlink,\ndiv.code-block-caption:hover > a.headerlink {\n visibility: visible;\n}\n\ndiv.body p.caption {\n text-align: inherit;\n}\n\ndiv.body td {\n text-align: left;\n}\n\n.first {\n margin-top: 0 !important;\n}\n\np.rubric {\n margin-top: 30px;\n font-weight: bold;\n}\n\nimg.align-left, figure.align-left, .figure.align-left, object.align-left {\n clear: left;\n float: left;\n margin-right: 1em;\n}\n\nimg.align-right, figure.align-right, .figure.align-right, object.align-right {\n clear: right;\n float: right;\n margin-left: 1em;\n}\n\nimg.align-center, figure.align-center, .figure.align-center, object.align-center {\n display: block;\n margin-left: auto;\n margin-right: auto;\n}\n\nimg.align-default, figure.align-default, .figure.align-default {\n display: block;\n margin-left: auto;\n margin-right: auto;\n}\n\n.align-left {\n text-align: left;\n}\n\n.align-center {\n text-align: center;\n}\n\n.align-default {\n text-align: center;\n}\n\n.align-right {\n text-align: right;\n}\n\n/* -- sidebars -------------------------------------------------------------- */\n\ndiv.sidebar,\naside.sidebar {\n margin: 0 0 0.5em 1em;\n border: 1px solid #ddb;\n padding: 7px;\n background-color: #ffe;\n width: 40%;\n float: right;\n clear: right;\n overflow-x: auto;\n}\n\np.sidebar-title {\n font-weight: bold;\n}\n\nnav.contents,\naside.topic,\ndiv.admonition, div.topic, blockquote {\n clear: left;\n}\n\n/* -- topics ---------------------------------------------------------------- */\n\nnav.contents,\naside.topic,\ndiv.topic {\n border: 1px solid #ccc;\n padding: 7px;\n margin: 10px 0 10px 0;\n}\n\np.topic-title {\n font-size: 1.1em;\n font-weight: bold;\n margin-top: 10px;\n}\n\n/* -- admonitions ----------------------------------------------------------- */\n\ndiv.admonition {\n margin-top: 10px;\n margin-bottom: 10px;\n padding: 7px;\n}\n\ndiv.admonition dt {\n font-weight: bold;\n}\n\np.admonition-title {\n margin: 0px 10px 5px 0px;\n font-weight: bold;\n}\n\ndiv.body p.centered {\n text-align: center;\n margin-top: 25px;\n}\n\n/* -- content of sidebars/topics/admonitions -------------------------------- */\n\ndiv.sidebar > :last-child,\naside.sidebar > :last-child,\nnav.contents > :last-child,\naside.topic > :last-child,\ndiv.topic > :last-child,\ndiv.admonition > :last-child {\n margin-bottom: 0;\n}\n\ndiv.sidebar::after,\naside.sidebar::after,\nnav.contents::after,\naside.topic::after,\ndiv.topic::after,\ndiv.admonition::after,\nblockquote::after {\n display: block;\n content: '';\n clear: both;\n}\n\n/* -- tables ---------------------------------------------------------------- */\n\ntable.docutils {\n margin-top: 10px;\n margin-bottom: 10px;\n border: 0;\n border-collapse: collapse;\n}\n\ntable.align-center {\n margin-left: auto;\n margin-right: auto;\n}\n\ntable.align-default {\n margin-left: auto;\n margin-right: auto;\n}\n\ntable caption span.caption-number {\n font-style: italic;\n}\n\ntable caption span.caption-text {\n}\n\ntable.docutils td, table.docutils th {\n padding: 1px 8px 1px 5px;\n border-top: 0;\n border-left: 0;\n border-right: 0;\n border-bottom: 1px solid #aaa;\n}\n\nth {\n text-align: left;\n padding-right: 5px;\n}\n\ntable.citation {\n border-left: solid 1px gray;\n margin-left: 1px;\n}\n\ntable.citation td {\n border-bottom: none;\n}\n\nth > :first-child,\ntd > :first-child {\n margin-top: 0px;\n}\n\nth > :last-child,\ntd > :last-child {\n margin-bottom: 0px;\n}\n\n/* -- figures --------------------------------------------------------------- */\n\ndiv.figure, figure {\n margin: 0.5em;\n padding: 0.5em;\n}\n\ndiv.figure p.caption, figcaption {\n padding: 0.3em;\n}\n\ndiv.figure p.caption span.caption-number,\nfigcaption span.caption-number {\n font-style: italic;\n}\n\ndiv.figure p.caption span.caption-text,\nfigcaption span.caption-text {\n}\n\n/* -- field list styles ----------------------------------------------------- */\n\ntable.field-list td, table.field-list th {\n border: 0 !important;\n}\n\n.field-list ul {\n margin: 0;\n padding-left: 1em;\n}\n\n.field-list p {\n margin: 0;\n}\n\n.field-name {\n -moz-hyphens: manual;\n -ms-hyphens: manual;\n -webkit-hyphens: manual;\n hyphens: manual;\n}\n\n/* -- hlist styles ---------------------------------------------------------- */\n\ntable.hlist {\n margin: 1em 0;\n}\n\ntable.hlist td {\n vertical-align: top;\n}\n\n/* -- object description styles --------------------------------------------- */\n\n.sig {\n\tfont-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;\n}\n\n.sig-name, code.descname {\n background-color: transparent;\n font-weight: bold;\n}\n\n.sig-name {\n\tfont-size: 1.1em;\n}\n\ncode.descname {\n font-size: 1.2em;\n}\n\n.sig-prename, code.descclassname {\n background-color: transparent;\n}\n\n.optional {\n font-size: 1.3em;\n}\n\n.sig-paren {\n font-size: larger;\n}\n\n.sig-param.n {\n\tfont-style: italic;\n}\n\n/* C++ specific styling */\n\n.sig-inline.c-texpr,\n.sig-inline.cpp-texpr {\n\tfont-family: unset;\n}\n\n.sig.c .k, .sig.c .kt,\n.sig.cpp .k, .sig.cpp .kt {\n\tcolor: #0033B3;\n}\n\n.sig.c .m,\n.sig.cpp .m {\n\tcolor: #1750EB;\n}\n\n.sig.c .s, .sig.c .sc,\n.sig.cpp .s, .sig.cpp .sc {\n\tcolor: #067D17;\n}\n\n\n/* -- other body styles ----------------------------------------------------- */\n\nol.arabic {\n list-style: decimal;\n}\n\nol.loweralpha {\n list-style: lower-alpha;\n}\n\nol.upperalpha {\n list-style: upper-alpha;\n}\n\nol.lowerroman {\n list-style: lower-roman;\n}\n\nol.upperroman {\n list-style: upper-roman;\n}\n\n:not(li) > ol > li:first-child > :first-child,\n:not(li) > ul > li:first-child > :first-child {\n margin-top: 0px;\n}\n\n:not(li) > ol > li:last-child > :last-child,\n:not(li) > ul > li:last-child > :last-child {\n margin-bottom: 0px;\n}\n\nol.simple ol p,\nol.simple ul p,\nul.simple ol p,\nul.simple ul p {\n margin-top: 0;\n}\n\nol.simple > li:not(:first-child) > p,\nul.simple > li:not(:first-child) > p {\n margin-top: 0;\n}\n\nol.simple p,\nul.simple p {\n margin-bottom: 0;\n}\n\naside.footnote > span,\ndiv.citation > span {\n float: left;\n}\naside.footnote > span:last-of-type,\ndiv.citation > span:last-of-type {\n padding-right: 0.5em;\n}\naside.footnote > p {\n margin-left: 2em;\n}\ndiv.citation > p {\n margin-left: 4em;\n}\naside.footnote > p:last-of-type,\ndiv.citation > p:last-of-type {\n margin-bottom: 0em;\n}\naside.footnote > p:last-of-type:after,\ndiv.citation > p:last-of-type:after {\n content: \"\";\n clear: both;\n}\n\ndl.field-list {\n display: grid;\n grid-template-columns: fit-content(30%) auto;\n}\n\ndl.field-list > dt {\n font-weight: bold;\n word-break: break-word;\n padding-left: 0.5em;\n padding-right: 5px;\n}\n\ndl.field-list > dd {\n padding-left: 0.5em;\n margin-top: 0em;\n margin-left: 0em;\n margin-bottom: 0em;\n}\n\ndl {\n margin-bottom: 15px;\n}\n\ndd > :first-child {\n margin-top: 0px;\n}\n\ndd ul, dd table {\n margin-bottom: 10px;\n}\n\ndd {\n margin-top: 3px;\n margin-bottom: 10px;\n margin-left: 30px;\n}\n\n.sig dd {\n margin-top: 0px;\n margin-bottom: 0px;\n}\n\n.sig dl {\n margin-top: 0px;\n margin-bottom: 0px;\n}\n\ndl > dd:last-child,\ndl > dd:last-child > :last-child {\n margin-bottom: 0;\n}\n\ndt:target, span.highlighted {\n background-color: #fbe54e;\n}\n\nrect.highlighted {\n fill: #fbe54e;\n}\n\ndl.glossary dt {\n font-weight: bold;\n font-size: 1.1em;\n}\n\n.versionmodified {\n font-style: italic;\n}\n\n.system-message {\n background-color: #fda;\n padding: 5px;\n border: 3px solid red;\n}\n\n.footnote:target {\n background-color: #ffa;\n}\n\n.line-block {\n display: block;\n margin-top: 1em;\n margin-bottom: 1em;\n}\n\n.line-block .line-block {\n margin-top: 0;\n margin-bottom: 0;\n margin-left: 1.5em;\n}\n\n.guilabel, .menuselection {\n font-family: sans-serif;\n}\n\n.accelerator {\n text-decoration: underline;\n}\n\n.classifier {\n font-style: oblique;\n}\n\n.classifier:before {\n font-style: normal;\n margin: 0 0.5em;\n content: \":\";\n display: inline-block;\n}\n\nabbr, acronym {\n border-bottom: dotted 1px;\n cursor: help;\n}\n\n.translated {\n background-color: rgba(207, 255, 207, 0.2)\n}\n\n.untranslated {\n background-color: rgba(255, 207, 207, 0.2)\n}\n\n/* -- code displays --------------------------------------------------------- */\n\npre {\n overflow: auto;\n overflow-y: hidden; /* fixes display issues on Chrome browsers */\n}\n\npre, div[class*=\"highlight-\"] {\n clear: both;\n}\n\nspan.pre {\n -moz-hyphens: none;\n -ms-hyphens: none;\n -webkit-hyphens: none;\n hyphens: none;\n white-space: nowrap;\n}\n\ndiv[class*=\"highlight-\"] {\n margin: 1em 0;\n}\n\ntd.linenos pre {\n border: 0;\n background-color: transparent;\n color: #aaa;\n}\n\ntable.highlighttable {\n display: block;\n}\n\ntable.highlighttable tbody {\n display: block;\n}\n\ntable.highlighttable tr {\n display: flex;\n}\n\ntable.highlighttable td {\n margin: 0;\n padding: 0;\n}\n\ntable.highlighttable td.linenos {\n padding-right: 0.5em;\n}\n\ntable.highlighttable td.code {\n flex: 1;\n overflow: hidden;\n}\n\n.highlight .hll {\n display: block;\n}\n\ndiv.highlight pre,\ntable.highlighttable pre {\n margin: 0;\n}\n\ndiv.code-block-caption + div {\n margin-top: 0;\n}\n\ndiv.code-block-caption {\n margin-top: 1em;\n padding: 2px 5px;\n font-size: small;\n}\n\ndiv.code-block-caption code {\n background-color: transparent;\n}\n\ntable.highlighttable td.linenos,\nspan.linenos,\ndiv.highlight span.gp { /* gp: Generic.Prompt */\n user-select: none;\n -webkit-user-select: text; /* Safari fallback only */\n -webkit-user-select: none; /* Chrome/Safari */\n -moz-user-select: none; /* Firefox */\n -ms-user-select: none; /* IE10+ */\n}\n\ndiv.code-block-caption span.caption-number {\n padding: 0.1em 0.3em;\n font-style: italic;\n}\n\ndiv.code-block-caption span.caption-text {\n}\n\ndiv.literal-block-wrapper {\n margin: 1em 0;\n}\n\ncode.xref, a code {\n background-color: transparent;\n font-weight: bold;\n}\n\nh1 code, h2 code, h3 code, h4 code, h5 code, h6 code {\n background-color: transparent;\n}\n\n.viewcode-link {\n float: right;\n}\n\n.viewcode-back {\n float: right;\n font-family: sans-serif;\n}\n\ndiv.viewcode-block:target {\n margin: -1px -10px;\n padding: 0 10px;\n}\n\n/* -- math display ---------------------------------------------------------- */\n\nimg.math {\n vertical-align: middle;\n}\n\ndiv.body div.math p {\n text-align: center;\n}\n\nspan.eqno {\n float: right;\n}\n\nspan.eqno a.headerlink {\n position: absolute;\n z-index: 1;\n}\n\ndiv.math:hover a.headerlink {\n visibility: visible;\n}\n\n/* -- printout stylesheet --------------------------------------------------- */\n\n@media print {\n div.document,\n div.documentwrapper,\n div.bodywrapper {\n margin: 0 !important;\n width: 100%;\n }\n\n div.sphinxsidebar,\n div.related,\n div.footer,\n #top-link {\n display: none;\n }\n}" }, { "path": "docs/html/_static/doctools.js", "content": "/*\n * doctools.js\n * ~~~~~~~~~~~\n *\n * Base JavaScript utilities for all Sphinx HTML documentation.\n *\n * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.\n * :license: BSD, see LICENSE for details.\n *\n */\n\"use strict\";\n\nconst BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([\n \"TEXTAREA\",\n \"INPUT\",\n \"SELECT\",\n \"BUTTON\",\n]);\n\nconst _ready = (callback) => {\n if (document.readyState !== \"loading\") {\n callback();\n } else {\n document.addEventListener(\"DOMContentLoaded\", callback);\n }\n};\n\n/**\n * Small JavaScript module for the documentation.\n */\nconst Documentation = {\n init: () => {\n Documentation.initDomainIndexTable();\n Documentation.initOnKeyListeners();\n },\n\n /**\n * i18n support\n */\n TRANSLATIONS: {},\n PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),\n LOCALE: \"unknown\",\n\n // gettext and ngettext don't access this so that the functions\n // can safely bound to a different name (_ = Documentation.gettext)\n gettext: (string) => {\n const translated = Documentation.TRANSLATIONS[string];\n switch (typeof translated) {\n case \"undefined\":\n return string; // no translation\n case \"string\":\n return translated; // translation exists\n default:\n return translated[0]; // (singular, plural) translation tuple exists\n }\n },\n\n ngettext: (singular, plural, n) => {\n const translated = Documentation.TRANSLATIONS[singular];\n if (typeof translated !== \"undefined\")\n return translated[Documentation.PLURAL_EXPR(n)];\n return n === 1 ? singular : plural;\n },\n\n addTranslations: (catalog) => {\n Object.assign(Documentation.TRANSLATIONS, catalog.messages);\n Documentation.PLURAL_EXPR = new Function(\n \"n\",\n `return (${catalog.plural_expr})`\n );\n Documentation.LOCALE = catalog.locale;\n },\n\n /**\n * helper function to focus on search bar\n */\n focusSearchBar: () => {\n document.querySelectorAll(\"input[name=q]\")[0]?.focus();\n },\n\n /**\n * Initialise the domain index toggle buttons\n */\n initDomainIndexTable: () => {\n const toggler = (el) => {\n const idNumber = el.id.substr(7);\n const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);\n if (el.src.substr(-9) === \"minus.png\") {\n el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;\n toggledRows.forEach((el) => (el.style.display = \"none\"));\n } else {\n el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;\n toggledRows.forEach((el) => (el.style.display = \"\"));\n }\n };\n\n const togglerElements = document.querySelectorAll(\"img.toggler\");\n togglerElements.forEach((el) =>\n el.addEventListener(\"click\", (event) => toggler(event.currentTarget))\n );\n togglerElements.forEach((el) => (el.style.display = \"\"));\n if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);\n },\n\n initOnKeyListeners: () => {\n // only install a listener if it is really needed\n if (\n !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&\n !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS\n )\n return;\n\n document.addEventListener(\"keydown\", (event) => {\n // bail for input elements\n if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;\n // bail with special keys\n if (event.altKey || event.ctrlKey || event.metaKey) return;\n\n if (!event.shiftKey) {\n switch (event.key) {\n case \"ArrowLeft\":\n if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;\n\n const prevLink = document.querySelector('link[rel=\"prev\"]');\n if (prevLink && prevLink.href) {\n window.location.href = prevLink.href;\n event.preventDefault();\n }\n break;\n case \"ArrowRight\":\n if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;\n\n const nextLink = document.querySelector('link[rel=\"next\"]');\n if (nextLink && nextLink.href) {\n window.location.href = nextLink.href;\n event.preventDefault();\n }\n break;\n }\n }\n\n // some keyboard layouts may need Shift to get /\n switch (event.key) {\n case \"/\":\n if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;\n Documentation.focusSearchBar();\n event.preventDefault();\n }\n });\n },\n};\n\n// quick alias for translations\nconst _ = Documentation.gettext;\n\n_ready(Documentation.init);\n" }, { "path": "docs/html/_static/documentation_options.js", "content": "const DOCUMENTATION_OPTIONS = {\n VERSION: '1.2.13',\n LANGUAGE: 'en',\n COLLAPSE_INDEX: false,\n BUILDER: 'html',\n FILE_SUFFIX: '.html',\n LINK_SUFFIX: '.html',\n HAS_SOURCE: true,\n SOURCELINK_SUFFIX: '.txt',\n NAVIGATION_WITH_KEYS: false,\n SHOW_SEARCH_SUMMARY: true,\n ENABLE_SEARCH_SHORTCUTS: true,\n};" }, { "path": "docs/html/_static/jquery-3.5.1.js", "content": "/*!\n * jQuery JavaScript Library v3.5.1\n * https://jquery.com/\n *\n * Includes Sizzle.js\n * https://sizzlejs.com/\n *\n * Copyright JS Foundation and other contributors\n * Released under the MIT license\n * https://jquery.org/license\n *\n * Date: 2020-05-04T22:49Z\n */\n( function( global, factory ) {\n\n\t\"use strict\";\n\n\tif ( typeof module === \"object\" && typeof module.exports === \"object\" ) {\n\n\t\t// For CommonJS and CommonJS-like environments where a proper `window`\n\t\t// is present, execute the factory and get jQuery.\n\t\t// For environments that do not have a `window` with a `document`\n\t\t// (such as Node.js), expose a factory as module.exports.\n\t\t// This accentuates the need for the creation of a real `window`.\n\t\t// e.g. var jQuery = require(\"jquery\")(window);\n\t\t// See ticket #14549 for more info.\n\t\tmodule.exports = global.document ?\n\t\t\tfactory( global, true ) :\n\t\t\tfunction( w ) {\n\t\t\t\tif ( !w.document ) {\n\t\t\t\t\tthrow new Error( \"jQuery requires a window with a document\" );\n\t\t\t\t}\n\t\t\t\treturn factory( w );\n\t\t\t};\n\t} else {\n\t\tfactory( global );\n\t}\n\n// Pass this if window is not defined yet\n} )( typeof window !== \"undefined\" ? window : this, function( window, noGlobal ) {\n\n// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1\n// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode\n// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common\n// enough that all such attempts are guarded in a try block.\n\"use strict\";\n\nvar arr = [];\n\nvar getProto = Object.getPrototypeOf;\n\nvar slice = arr.slice;\n\nvar flat = arr.flat ? function( array ) {\n\treturn arr.flat.call( array );\n} : function( array ) {\n\treturn arr.concat.apply( [], array );\n};\n\n\nvar push = arr.push;\n\nvar indexOf = arr.indexOf;\n\nvar class2type = {};\n\nvar toString = class2type.toString;\n\nvar hasOwn = class2type.hasOwnProperty;\n\nvar fnToString = hasOwn.toString;\n\nvar ObjectFunctionString = fnToString.call( Object );\n\nvar support = {};\n\nvar isFunction = function isFunction( obj ) {\n\n // Support: Chrome <=57, Firefox <=52\n // In some browsers, typeof returns \"function\" for HTML elements\n // (i.e., `typeof document.createElement( \"object\" ) === \"function\"`).\n // We don't want to classify *any* DOM node as a function.\n return typeof obj === \"function\" && typeof obj.nodeType !== \"number\";\n };\n\n\nvar isWindow = function isWindow( obj ) {\n\t\treturn obj != null && obj === obj.window;\n\t};\n\n\nvar document = window.document;\n\n\n\n\tvar preservedScriptAttributes = {\n\t\ttype: true,\n\t\tsrc: true,\n\t\tnonce: true,\n\t\tnoModule: true\n\t};\n\n\tfunction DOMEval( code, node, doc ) {\n\t\tdoc = doc || document;\n\n\t\tvar i, val,\n\t\t\tscript = doc.createElement( \"script\" );\n\n\t\tscript.text = code;\n\t\tif ( node ) {\n\t\t\tfor ( i in preservedScriptAttributes ) {\n\n\t\t\t\t// Support: Firefox 64+, Edge 18+\n\t\t\t\t// Some browsers don't support the \"nonce\" property on scripts.\n\t\t\t\t// On the other hand, just using `getAttribute` is not enough as\n\t\t\t\t// the `nonce` attribute is reset to an empty string whenever it\n\t\t\t\t// becomes browsing-context connected.\n\t\t\t\t// See https://github.com/whatwg/html/issues/2369\n\t\t\t\t// See https://html.spec.whatwg.org/#nonce-attributes\n\t\t\t\t// The `node.getAttribute` check was added for the sake of\n\t\t\t\t// `jQuery.globalEval` so that it can fake a nonce-containing node\n\t\t\t\t// via an object.\n\t\t\t\tval = node[ i ] || node.getAttribute && node.getAttribute( i );\n\t\t\t\tif ( val ) {\n\t\t\t\t\tscript.setAttribute( i, val );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tdoc.head.appendChild( script ).parentNode.removeChild( script );\n\t}\n\n\nfunction toType( obj ) {\n\tif ( obj == null ) {\n\t\treturn obj + \"\";\n\t}\n\n\t// Support: Android <=2.3 only (functionish RegExp)\n\treturn typeof obj === \"object\" || typeof obj === \"function\" ?\n\t\tclass2type[ toString.call( obj ) ] || \"object\" :\n\t\ttypeof obj;\n}\n/* global Symbol */\n// Defining this global in .eslintrc.json would create a danger of using the global\n// unguarded in another place, it seems safer to define global only for this module\n\n\n\nvar\n\tversion = \"3.5.1\",\n\n\t// Define a local copy of jQuery\n\tjQuery = function( selector, context ) {\n\n\t\t// The jQuery object is actually just the init constructor 'enhanced'\n\t\t// Need init if jQuery is called (just allow error to be thrown if not included)\n\t\treturn new jQuery.fn.init( selector, context );\n\t};\n\njQuery.fn = jQuery.prototype = {\n\n\t// The current version of jQuery being used\n\tjquery: version,\n\n\tconstructor: jQuery,\n\n\t// The default length of a jQuery object is 0\n\tlength: 0,\n\n\ttoArray: function() {\n\t\treturn slice.call( this );\n\t},\n\n\t// Get the Nth element in the matched element set OR\n\t// Get the whole matched element set as a clean array\n\tget: function( num ) {\n\n\t\t// Return all the elements in a clean array\n\t\tif ( num == null ) {\n\t\t\treturn slice.call( this );\n\t\t}\n\n\t\t// Return just the one element from the set\n\t\treturn num < 0 ? this[ num + this.length ] : this[ num ];\n\t},\n\n\t// Take an array of elements and push it onto the stack\n\t// (returning the new matched element set)\n\tpushStack: function( elems ) {\n\n\t\t// Build a new jQuery matched element set\n\t\tvar ret = jQuery.merge( this.constructor(), elems );\n\n\t\t// Add the old object onto the stack (as a reference)\n\t\tret.prevObject = this;\n\n\t\t// Return the newly-formed element set\n\t\treturn ret;\n\t},\n\n\t// Execute a callback for every element in the matched set.\n\teach: function( callback ) {\n\t\treturn jQuery.each( this, callback );\n\t},\n\n\tmap: function( callback ) {\n\t\treturn this.pushStack( jQuery.map( this, function( elem, i ) {\n\t\t\treturn callback.call( elem, i, elem );\n\t\t} ) );\n\t},\n\n\tslice: function() {\n\t\treturn this.pushStack( slice.apply( this, arguments ) );\n\t},\n\n\tfirst: function() {\n\t\treturn this.eq( 0 );\n\t},\n\n\tlast: function() {\n\t\treturn this.eq( -1 );\n\t},\n\n\teven: function() {\n\t\treturn this.pushStack( jQuery.grep( this, function( _elem, i ) {\n\t\t\treturn ( i + 1 ) % 2;\n\t\t} ) );\n\t},\n\n\todd: function() {\n\t\treturn this.pushStack( jQuery.grep( this, function( _elem, i ) {\n\t\t\treturn i % 2;\n\t\t} ) );\n\t},\n\n\teq: function( i ) {\n\t\tvar len = this.length,\n\t\t\tj = +i + ( i < 0 ? len : 0 );\n\t\treturn this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );\n\t},\n\n\tend: function() {\n\t\treturn this.prevObject || this.constructor();\n\t},\n\n\t// For internal use only.\n\t// Behaves like an Array's method, not like a jQuery method.\n\tpush: push,\n\tsort: arr.sort,\n\tsplice: arr.splice\n};\n\njQuery.extend = jQuery.fn.extend = function() {\n\tvar options, name, src, copy, copyIsArray, clone,\n\t\ttarget = arguments[ 0 ] || {},\n\t\ti = 1,\n\t\tlength = arguments.length,\n\t\tdeep = false;\n\n\t// Handle a deep copy situation\n\tif ( typeof target === \"boolean\" ) {\n\t\tdeep = target;\n\n\t\t// Skip the boolean and the target\n\t\ttarget = arguments[ i ] || {};\n\t\ti++;\n\t}\n\n\t// Handle case when target is a string or something (possible in deep copy)\n\tif ( typeof target !== \"object\" && !isFunction( target ) ) {\n\t\ttarget = {};\n\t}\n\n\t// Extend jQuery itself if only one argument is passed\n\tif ( i === length ) {\n\t\ttarget = this;\n\t\ti--;\n\t}\n\n\tfor ( ; i < length; i++ ) {\n\n\t\t// Only deal with non-null/undefined values\n\t\tif ( ( options = arguments[ i ] ) != null ) {\n\n\t\t\t// Extend the base object\n\t\t\tfor ( name in options ) {\n\t\t\t\tcopy = options[ name ];\n\n\t\t\t\t// Prevent Object.prototype pollution\n\t\t\t\t// Prevent never-ending loop\n\t\t\t\tif ( name === \"__proto__\" || target === copy ) {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Recurse if we're merging plain objects or arrays\n\t\t\t\tif ( deep && copy && ( jQuery.isPlainObject( copy ) ||\n\t\t\t\t\t( copyIsArray = Array.isArray( copy ) ) ) ) {\n\t\t\t\t\tsrc = target[ name ];\n\n\t\t\t\t\t// Ensure proper type for the source value\n\t\t\t\t\tif ( copyIsArray && !Array.isArray( src ) ) {\n\t\t\t\t\t\tclone = [];\n\t\t\t\t\t} else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) {\n\t\t\t\t\t\tclone = {};\n\t\t\t\t\t} else {\n\t\t\t\t\t\tclone = src;\n\t\t\t\t\t}\n\t\t\t\t\tcopyIsArray = false;\n\n\t\t\t\t\t// Never move original objects, clone them\n\t\t\t\t\ttarget[ name ] = jQuery.extend( deep, clone, copy );\n\n\t\t\t\t// Don't bring in undefined values\n\t\t\t\t} else if ( copy !== undefined ) {\n\t\t\t\t\ttarget[ name ] = copy;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Return the modified object\n\treturn target;\n};\n\njQuery.extend( {\n\n\t// Unique for each copy of jQuery on the page\n\texpando: \"jQuery\" + ( version + Math.random() ).replace( /\\D/g, \"\" ),\n\n\t// Assume jQuery is ready without the ready module\n\tisReady: true,\n\n\terror: function( msg ) {\n\t\tthrow new Error( msg );\n\t},\n\n\tnoop: function() {},\n\n\tisPlainObject: function( obj ) {\n\t\tvar proto, Ctor;\n\n\t\t// Detect obvious negatives\n\t\t// Use toString instead of jQuery.type to catch host objects\n\t\tif ( !obj || toString.call( obj ) !== \"[object Object]\" ) {\n\t\t\treturn false;\n\t\t}\n\n\t\tproto = getProto( obj );\n\n\t\t// Objects with no prototype (e.g., `Object.create( null )`) are plain\n\t\tif ( !proto ) {\n\t\t\treturn true;\n\t\t}\n\n\t\t// Objects with prototype are plain iff they were constructed by a global Object function\n\t\tCtor = hasOwn.call( proto, \"constructor\" ) && proto.constructor;\n\t\treturn typeof Ctor === \"function\" && fnToString.call( Ctor ) === ObjectFunctionString;\n\t},\n\n\tisEmptyObject: function( obj ) {\n\t\tvar name;\n\n\t\tfor ( name in obj ) {\n\t\t\treturn false;\n\t\t}\n\t\treturn true;\n\t},\n\n\t// Evaluates a script in a provided context; falls back to the global one\n\t// if not specified.\n\tglobalEval: function( code, options, doc ) {\n\t\tDOMEval( code, { nonce: options && options.nonce }, doc );\n\t},\n\n\teach: function( obj, callback ) {\n\t\tvar length, i = 0;\n\n\t\tif ( isArrayLike( obj ) ) {\n\t\t\tlength = obj.length;\n\t\t\tfor ( ; i < length; i++ ) {\n\t\t\t\tif ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfor ( i in obj ) {\n\t\t\t\tif ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn obj;\n\t},\n\n\t// results is for internal usage only\n\tmakeArray: function( arr, results ) {\n\t\tvar ret = results || [];\n\n\t\tif ( arr != null ) {\n\t\t\tif ( isArrayLike( Object( arr ) ) ) {\n\t\t\t\tjQuery.merge( ret,\n\t\t\t\t\ttypeof arr === \"string\" ?\n\t\t\t\t\t[ arr ] : arr\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tpush.call( ret, arr );\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\tinArray: function( elem, arr, i ) {\n\t\treturn arr == null ? -1 : indexOf.call( arr, elem, i );\n\t},\n\n\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t// push.apply(_, arraylike) throws on ancient WebKit\n\tmerge: function( first, second ) {\n\t\tvar len = +second.length,\n\t\t\tj = 0,\n\t\t\ti = first.length;\n\n\t\tfor ( ; j < len; j++ ) {\n\t\t\tfirst[ i++ ] = second[ j ];\n\t\t}\n\n\t\tfirst.length = i;\n\n\t\treturn first;\n\t},\n\n\tgrep: function( elems, callback, invert ) {\n\t\tvar callbackInverse,\n\t\t\tmatches = [],\n\t\t\ti = 0,\n\t\t\tlength = elems.length,\n\t\t\tcallbackExpect = !invert;\n\n\t\t// Go through the array, only saving the items\n\t\t// that pass the validator function\n\t\tfor ( ; i < length; i++ ) {\n\t\t\tcallbackInverse = !callback( elems[ i ], i );\n\t\t\tif ( callbackInverse !== callbackExpect ) {\n\t\t\t\tmatches.push( elems[ i ] );\n\t\t\t}\n\t\t}\n\n\t\treturn matches;\n\t},\n\n\t// arg is for internal usage only\n\tmap: function( elems, callback, arg ) {\n\t\tvar length, value,\n\t\t\ti = 0,\n\t\t\tret = [];\n\n\t\t// Go through the array, translating each of the items to their new values\n\t\tif ( isArrayLike( elems ) ) {\n\t\t\tlength = elems.length;\n\t\t\tfor ( ; i < length; i++ ) {\n\t\t\t\tvalue = callback( elems[ i ], i, arg );\n\n\t\t\t\tif ( value != null ) {\n\t\t\t\t\tret.push( value );\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Go through every key on the object,\n\t\t} else {\n\t\t\tfor ( i in elems ) {\n\t\t\t\tvalue = callback( elems[ i ], i, arg );\n\n\t\t\t\tif ( value != null ) {\n\t\t\t\t\tret.push( value );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Flatten any nested arrays\n\t\treturn flat( ret );\n\t},\n\n\t// A global GUID counter for objects\n\tguid: 1,\n\n\t// jQuery.support is not used in Core but other projects attach their\n\t// properties to it so it needs to exist.\n\tsupport: support\n} );\n\nif ( typeof Symbol === \"function\" ) {\n\tjQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];\n}\n\n// Populate the class2type map\njQuery.each( \"Boolean Number String Function Array Date RegExp Object Error Symbol\".split( \" \" ),\nfunction( _i, name ) {\n\tclass2type[ \"[object \" + name + \"]\" ] = name.toLowerCase();\n} );\n\nfunction isArrayLike( obj ) {\n\n\t// Support: real iOS 8.2 only (not reproducible in simulator)\n\t// `in` check used to prevent JIT error (gh-2145)\n\t// hasOwn isn't used here due to false negatives\n\t// regarding Nodelist length in IE\n\tvar length = !!obj && \"length\" in obj && obj.length,\n\t\ttype = toType( obj );\n\n\tif ( isFunction( obj ) || isWindow( obj ) ) {\n\t\treturn false;\n\t}\n\n\treturn type === \"array\" || length === 0 ||\n\t\ttypeof length === \"number\" && length > 0 && ( length - 1 ) in obj;\n}\nvar Sizzle =\n/*!\n * Sizzle CSS Selector Engine v2.3.5\n * https://sizzlejs.com/\n *\n * Copyright JS Foundation and other contributors\n * Released under the MIT license\n * https://js.foundation/\n *\n * Date: 2020-03-14\n */\n( function( window ) {\nvar i,\n\tsupport,\n\tExpr,\n\tgetText,\n\tisXML,\n\ttokenize,\n\tcompile,\n\tselect,\n\toutermostContext,\n\tsortInput,\n\thasDuplicate,\n\n\t// Local document vars\n\tsetDocument,\n\tdocument,\n\tdocElem,\n\tdocumentIsHTML,\n\trbuggyQSA,\n\trbuggyMatches,\n\tmatches,\n\tcontains,\n\n\t// Instance-specific data\n\texpando = \"sizzle\" + 1 * new Date(),\n\tpreferredDoc = window.document,\n\tdirruns = 0,\n\tdone = 0,\n\tclassCache = createCache(),\n\ttokenCache = createCache(),\n\tcompilerCache = createCache(),\n\tnonnativeSelectorCache = createCache(),\n\tsortOrder = function( a, b ) {\n\t\tif ( a === b ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn 0;\n\t},\n\n\t// Instance methods\n\thasOwn = ( {} ).hasOwnProperty,\n\tarr = [],\n\tpop = arr.pop,\n\tpushNative = arr.push,\n\tpush = arr.push,\n\tslice = arr.slice,\n\n\t// Use a stripped-down indexOf as it's faster than native\n\t// https://jsperf.com/thor-indexof-vs-for/5\n\tindexOf = function( list, elem ) {\n\t\tvar i = 0,\n\t\t\tlen = list.length;\n\t\tfor ( ; i < len; i++ ) {\n\t\t\tif ( list[ i ] === elem ) {\n\t\t\t\treturn i;\n\t\t\t}\n\t\t}\n\t\treturn -1;\n\t},\n\n\tbooleans = \"checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|\" +\n\t\t\"ismap|loop|multiple|open|readonly|required|scoped\",\n\n\t// Regular expressions\n\n\t// http://www.w3.org/TR/css3-selectors/#whitespace\n\twhitespace = \"[\\\\x20\\\\t\\\\r\\\\n\\\\f]\",\n\n\t// https://www.w3.org/TR/css-syntax-3/#ident-token-diagram\n\tidentifier = \"(?:\\\\\\\\[\\\\da-fA-F]{1,6}\" + whitespace +\n\t\t\"?|\\\\\\\\[^\\\\r\\\\n\\\\f]|[\\\\w-]|[^\\0-\\\\x7f])+\",\n\n\t// Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors\n\tattributes = \"\\\\[\" + whitespace + \"*(\" + identifier + \")(?:\" + whitespace +\n\n\t\t// Operator (capture 2)\n\t\t\"*([*^$|!~]?=)\" + whitespace +\n\n\t\t// \"Attribute values must be CSS identifiers [capture 5]\n\t\t// or strings [capture 3 or capture 4]\"\n\t\t\"*(?:'((?:\\\\\\\\.|[^\\\\\\\\'])*)'|\\\"((?:\\\\\\\\.|[^\\\\\\\\\\\"])*)\\\"|(\" + identifier + \"))|)\" +\n\t\twhitespace + \"*\\\\]\",\n\n\tpseudos = \":(\" + identifier + \")(?:\\\\((\" +\n\n\t\t// To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:\n\t\t// 1. quoted (capture 3; capture 4 or capture 5)\n\t\t\"('((?:\\\\\\\\.|[^\\\\\\\\'])*)'|\\\"((?:\\\\\\\\.|[^\\\\\\\\\\\"])*)\\\")|\" +\n\n\t\t// 2. simple (capture 6)\n\t\t\"((?:\\\\\\\\.|[^\\\\\\\\()[\\\\]]|\" + attributes + \")*)|\" +\n\n\t\t// 3. anything else (capture 2)\n\t\t\".*\" +\n\t\t\")\\\\)|)\",\n\n\t// Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter\n\trwhitespace = new RegExp( whitespace + \"+\", \"g\" ),\n\trtrim = new RegExp( \"^\" + whitespace + \"+|((?:^|[^\\\\\\\\])(?:\\\\\\\\.)*)\" +\n\t\twhitespace + \"+$\", \"g\" ),\n\n\trcomma = new RegExp( \"^\" + whitespace + \"*,\" + whitespace + \"*\" ),\n\trcombinators = new RegExp( \"^\" + whitespace + \"*([>+~]|\" + whitespace + \")\" + whitespace +\n\t\t\"*\" ),\n\trdescend = new RegExp( whitespace + \"|>\" ),\n\n\trpseudo = new RegExp( pseudos ),\n\tridentifier = new RegExp( \"^\" + identifier + \"$\" ),\n\n\tmatchExpr = {\n\t\t\"ID\": new RegExp( \"^#(\" + identifier + \")\" ),\n\t\t\"CLASS\": new RegExp( \"^\\\\.(\" + identifier + \")\" ),\n\t\t\"TAG\": new RegExp( \"^(\" + identifier + \"|[*])\" ),\n\t\t\"ATTR\": new RegExp( \"^\" + attributes ),\n\t\t\"PSEUDO\": new RegExp( \"^\" + pseudos ),\n\t\t\"CHILD\": new RegExp( \"^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\\\(\" +\n\t\t\twhitespace + \"*(even|odd|(([+-]|)(\\\\d*)n|)\" + whitespace + \"*(?:([+-]|)\" +\n\t\t\twhitespace + \"*(\\\\d+)|))\" + whitespace + \"*\\\\)|)\", \"i\" ),\n\t\t\"bool\": new RegExp( \"^(?:\" + booleans + \")$\", \"i\" ),\n\n\t\t// For use in libraries implementing .is()\n\t\t// We use this for POS matching in `select`\n\t\t\"needsContext\": new RegExp( \"^\" + whitespace +\n\t\t\t\"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\\\(\" + whitespace +\n\t\t\t\"*((?:-\\\\d)?\\\\d*)\" + whitespace + \"*\\\\)|)(?=[^-]|$)\", \"i\" )\n\t},\n\n\trhtml = /HTML$/i,\n\trinputs = /^(?:input|select|textarea|button)$/i,\n\trheader = /^h\\d$/i,\n\n\trnative = /^[^{]+\\{\\s*\\[native \\w/,\n\n\t// Easily-parseable/retrievable ID or TAG or CLASS selectors\n\trquickExpr = /^(?:#([\\w-]+)|(\\w+)|\\.([\\w-]+))$/,\n\n\trsibling = /[+~]/,\n\n\t// CSS escapes\n\t// http://www.w3.org/TR/CSS21/syndata.html#escaped-characters\n\trunescape = new RegExp( \"\\\\\\\\[\\\\da-fA-F]{1,6}\" + whitespace + \"?|\\\\\\\\([^\\\\r\\\\n\\\\f])\", \"g\" ),\n\tfunescape = function( escape, nonHex ) {\n\t\tvar high = \"0x\" + escape.slice( 1 ) - 0x10000;\n\n\t\treturn nonHex ?\n\n\t\t\t// Strip the backslash prefix from a non-hex escape sequence\n\t\t\tnonHex :\n\n\t\t\t// Replace a hexadecimal escape sequence with the encoded Unicode code point\n\t\t\t// Support: IE <=11+\n\t\t\t// For values outside the Basic Multilingual Plane (BMP), manually construct a\n\t\t\t// surrogate pair\n\t\t\thigh < 0 ?\n\t\t\t\tString.fromCharCode( high + 0x10000 ) :\n\t\t\t\tString.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );\n\t},\n\n\t// CSS string/identifier serialization\n\t// https://drafts.csswg.org/cssom/#common-serializing-idioms\n\trcssescape = /([\\0-\\x1f\\x7f]|^-?\\d)|^-$|[^\\0-\\x1f\\x7f-\\uFFFF\\w-]/g,\n\tfcssescape = function( ch, asCodePoint ) {\n\t\tif ( asCodePoint ) {\n\n\t\t\t// U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER\n\t\t\tif ( ch === \"\\0\" ) {\n\t\t\t\treturn \"\\uFFFD\";\n\t\t\t}\n\n\t\t\t// Control characters and (dependent upon position) numbers get escaped as code points\n\t\t\treturn ch.slice( 0, -1 ) + \"\\\\\" +\n\t\t\t\tch.charCodeAt( ch.length - 1 ).toString( 16 ) + \" \";\n\t\t}\n\n\t\t// Other potentially-special ASCII characters get backslash-escaped\n\t\treturn \"\\\\\" + ch;\n\t},\n\n\t// Used for iframes\n\t// See setDocument()\n\t// Removing the function wrapper causes a \"Permission Denied\"\n\t// error in IE\n\tunloadHandler = function() {\n\t\tsetDocument();\n\t},\n\n\tinDisabledFieldset = addCombinator(\n\t\tfunction( elem ) {\n\t\t\treturn elem.disabled === true && elem.nodeName.toLowerCase() === \"fieldset\";\n\t\t},\n\t\t{ dir: \"parentNode\", next: \"legend\" }\n\t);\n\n// Optimize for push.apply( _, NodeList )\ntry {\n\tpush.apply(\n\t\t( arr = slice.call( preferredDoc.childNodes ) ),\n\t\tpreferredDoc.childNodes\n\t);\n\n\t// Support: Android<4.0\n\t// Detect silently failing push.apply\n\t// eslint-disable-next-line no-unused-expressions\n\tarr[ preferredDoc.childNodes.length ].nodeType;\n} catch ( e ) {\n\tpush = { apply: arr.length ?\n\n\t\t// Leverage slice if possible\n\t\tfunction( target, els ) {\n\t\t\tpushNative.apply( target, slice.call( els ) );\n\t\t} :\n\n\t\t// Support: IE<9\n\t\t// Otherwise append directly\n\t\tfunction( target, els ) {\n\t\t\tvar j = target.length,\n\t\t\t\ti = 0;\n\n\t\t\t// Can't trust NodeList.length\n\t\t\twhile ( ( target[ j++ ] = els[ i++ ] ) ) {}\n\t\t\ttarget.length = j - 1;\n\t\t}\n\t};\n}\n\nfunction Sizzle( selector, context, results, seed ) {\n\tvar m, i, elem, nid, match, groups, newSelector,\n\t\tnewContext = context && context.ownerDocument,\n\n\t\t// nodeType defaults to 9, since context defaults to document\n\t\tnodeType = context ? context.nodeType : 9;\n\n\tresults = results || [];\n\n\t// Return early from calls with invalid selector or context\n\tif ( typeof selector !== \"string\" || !selector ||\n\t\tnodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {\n\n\t\treturn results;\n\t}\n\n\t// Try to shortcut find operations (as opposed to filters) in HTML documents\n\tif ( !seed ) {\n\t\tsetDocument( context );\n\t\tcontext = context || document;\n\n\t\tif ( documentIsHTML ) {\n\n\t\t\t// If the selector is sufficiently simple, try using a \"get*By*\" DOM method\n\t\t\t// (excepting DocumentFragment context, where the methods don't exist)\n\t\t\tif ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) {\n\n\t\t\t\t// ID selector\n\t\t\t\tif ( ( m = match[ 1 ] ) ) {\n\n\t\t\t\t\t// Document context\n\t\t\t\t\tif ( nodeType === 9 ) {\n\t\t\t\t\t\tif ( ( elem = context.getElementById( m ) ) ) {\n\n\t\t\t\t\t\t\t// Support: IE, Opera, Webkit\n\t\t\t\t\t\t\t// TODO: identify versions\n\t\t\t\t\t\t\t// getElementById can match elements by name instead of ID\n\t\t\t\t\t\t\tif ( elem.id === m ) {\n\t\t\t\t\t\t\t\tresults.push( elem );\n\t\t\t\t\t\t\t\treturn results;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\treturn results;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t// Element context\n\t\t\t\t\t} else {\n\n\t\t\t\t\t\t// Support: IE, Opera, Webkit\n\t\t\t\t\t\t// TODO: identify versions\n\t\t\t\t\t\t// getElementById can match elements by name instead of ID\n\t\t\t\t\t\tif ( newContext && ( elem = newContext.getElementById( m ) ) &&\n\t\t\t\t\t\t\tcontains( context, elem ) &&\n\t\t\t\t\t\t\telem.id === m ) {\n\n\t\t\t\t\t\t\tresults.push( elem );\n\t\t\t\t\t\t\treturn results;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t// Type selector\n\t\t\t\t} else if ( match[ 2 ] ) {\n\t\t\t\t\tpush.apply( results, context.getElementsByTagName( selector ) );\n\t\t\t\t\treturn results;\n\n\t\t\t\t// Class selector\n\t\t\t\t} else if ( ( m = match[ 3 ] ) && support.getElementsByClassName &&\n\t\t\t\t\tcontext.getElementsByClassName ) {\n\n\t\t\t\t\tpush.apply( results, context.getElementsByClassName( m ) );\n\t\t\t\t\treturn results;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Take advantage of querySelectorAll\n\t\t\tif ( support.qsa &&\n\t\t\t\t!nonnativeSelectorCache[ selector + \" \" ] &&\n\t\t\t\t( !rbuggyQSA || !rbuggyQSA.test( selector ) ) &&\n\n\t\t\t\t// Support: IE 8 only\n\t\t\t\t// Exclude object elements\n\t\t\t\t( nodeType !== 1 || context.nodeName.toLowerCase() !== \"object\" ) ) {\n\n\t\t\t\tnewSelector = selector;\n\t\t\t\tnewContext = context;\n\n\t\t\t\t// qSA considers elements outside a scoping root when evaluating child or\n\t\t\t\t// descendant combinators, which is not what we want.\n\t\t\t\t// In such cases, we work around the behavior by prefixing every selector in the\n\t\t\t\t// list with an ID selector referencing the scope context.\n\t\t\t\t// The technique has to be used as well when a leading combinator is used\n\t\t\t\t// as such selectors are not recognized by querySelectorAll.\n\t\t\t\t// Thanks to Andrew Dupont for this technique.\n\t\t\t\tif ( nodeType === 1 &&\n\t\t\t\t\t( rdescend.test( selector ) || rcombinators.test( selector ) ) ) {\n\n\t\t\t\t\t// Expand context for sibling selectors\n\t\t\t\t\tnewContext = rsibling.test( selector ) && testContext( context.parentNode ) ||\n\t\t\t\t\t\tcontext;\n\n\t\t\t\t\t// We can use :scope instead of the ID hack if the browser\n\t\t\t\t\t// supports it & if we're not changing the context.\n\t\t\t\t\tif ( newContext !== context || !support.scope ) {\n\n\t\t\t\t\t\t// Capture the context ID, setting it first if necessary\n\t\t\t\t\t\tif ( ( nid = context.getAttribute( \"id\" ) ) ) {\n\t\t\t\t\t\t\tnid = nid.replace( rcssescape, fcssescape );\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tcontext.setAttribute( \"id\", ( nid = expando ) );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Prefix every selector in the list\n\t\t\t\t\tgroups = tokenize( selector );\n\t\t\t\t\ti = groups.length;\n\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\tgroups[ i ] = ( nid ? \"#\" + nid : \":scope\" ) + \" \" +\n\t\t\t\t\t\t\ttoSelector( groups[ i ] );\n\t\t\t\t\t}\n\t\t\t\t\tnewSelector = groups.join( \",\" );\n\t\t\t\t}\n\n\t\t\t\ttry {\n\t\t\t\t\tpush.apply( results,\n\t\t\t\t\t\tnewContext.querySelectorAll( newSelector )\n\t\t\t\t\t);\n\t\t\t\t\treturn results;\n\t\t\t\t} catch ( qsaError ) {\n\t\t\t\t\tnonnativeSelectorCache( selector, true );\n\t\t\t\t} finally {\n\t\t\t\t\tif ( nid === expando ) {\n\t\t\t\t\t\tcontext.removeAttribute( \"id\" );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// All others\n\treturn select( selector.replace( rtrim, \"$1\" ), context, results, seed );\n}\n\n/**\n * Create key-value caches of limited size\n * @returns {function(string, object)} Returns the Object data after storing it on itself with\n *\tproperty name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)\n *\tdeleting the oldest entry\n */\nfunction createCache() {\n\tvar keys = [];\n\n\tfunction cache( key, value ) {\n\n\t\t// Use (key + \" \") to avoid collision with native prototype properties (see Issue #157)\n\t\tif ( keys.push( key + \" \" ) > Expr.cacheLength ) {\n\n\t\t\t// Only keep the most recent entries\n\t\t\tdelete cache[ keys.shift() ];\n\t\t}\n\t\treturn ( cache[ key + \" \" ] = value );\n\t}\n\treturn cache;\n}\n\n/**\n * Mark a function for special use by Sizzle\n * @param {Function} fn The function to mark\n */\nfunction markFunction( fn ) {\n\tfn[ expando ] = true;\n\treturn fn;\n}\n\n/**\n * Support testing using an element\n * @param {Function} fn Passed the created element and returns a boolean result\n */\nfunction assert( fn ) {\n\tvar el = document.createElement( \"fieldset\" );\n\n\ttry {\n\t\treturn !!fn( el );\n\t} catch ( e ) {\n\t\treturn false;\n\t} finally {\n\n\t\t// Remove from its parent by default\n\t\tif ( el.parentNode ) {\n\t\t\tel.parentNode.removeChild( el );\n\t\t}\n\n\t\t// release memory in IE\n\t\tel = null;\n\t}\n}\n\n/**\n * Adds the same handler for all of the specified attrs\n * @param {String} attrs Pipe-separated list of attributes\n * @param {Function} handler The method that will be applied\n */\nfunction addHandle( attrs, handler ) {\n\tvar arr = attrs.split( \"|\" ),\n\t\ti = arr.length;\n\n\twhile ( i-- ) {\n\t\tExpr.attrHandle[ arr[ i ] ] = handler;\n\t}\n}\n\n/**\n * Checks document order of two siblings\n * @param {Element} a\n * @param {Element} b\n * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b\n */\nfunction siblingCheck( a, b ) {\n\tvar cur = b && a,\n\t\tdiff = cur && a.nodeType === 1 && b.nodeType === 1 &&\n\t\t\ta.sourceIndex - b.sourceIndex;\n\n\t// Use IE sourceIndex if available on both nodes\n\tif ( diff ) {\n\t\treturn diff;\n\t}\n\n\t// Check if b follows a\n\tif ( cur ) {\n\t\twhile ( ( cur = cur.nextSibling ) ) {\n\t\t\tif ( cur === b ) {\n\t\t\t\treturn -1;\n\t\t\t}\n\t\t}\n\t}\n\n\treturn a ? 1 : -1;\n}\n\n/**\n * Returns a function to use in pseudos for input types\n * @param {String} type\n */\nfunction createInputPseudo( type ) {\n\treturn function( elem ) {\n\t\tvar name = elem.nodeName.toLowerCase();\n\t\treturn name === \"input\" && elem.type === type;\n\t};\n}\n\n/**\n * Returns a function to use in pseudos for buttons\n * @param {String} type\n */\nfunction createButtonPseudo( type ) {\n\treturn function( elem ) {\n\t\tvar name = elem.nodeName.toLowerCase();\n\t\treturn ( name === \"input\" || name === \"button\" ) && elem.type === type;\n\t};\n}\n\n/**\n * Returns a function to use in pseudos for :enabled/:disabled\n * @param {Boolean} disabled true for :disabled; false for :enabled\n */\nfunction createDisabledPseudo( disabled ) {\n\n\t// Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable\n\treturn function( elem ) {\n\n\t\t// Only certain elements can match :enabled or :disabled\n\t\t// https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled\n\t\t// https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled\n\t\tif ( \"form\" in elem ) {\n\n\t\t\t// Check for inherited disabledness on relevant non-disabled elements:\n\t\t\t// * listed form-associated elements in a disabled fieldset\n\t\t\t// https://html.spec.whatwg.org/multipage/forms.html#category-listed\n\t\t\t// https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled\n\t\t\t// * option elements in a disabled optgroup\n\t\t\t// https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled\n\t\t\t// All such elements have a \"form\" property.\n\t\t\tif ( elem.parentNode && elem.disabled === false ) {\n\n\t\t\t\t// Option elements defer to a parent optgroup if present\n\t\t\t\tif ( \"label\" in elem ) {\n\t\t\t\t\tif ( \"label\" in elem.parentNode ) {\n\t\t\t\t\t\treturn elem.parentNode.disabled === disabled;\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn elem.disabled === disabled;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Support: IE 6 - 11\n\t\t\t\t// Use the isDisabled shortcut property to check for disabled fieldset ancestors\n\t\t\t\treturn elem.isDisabled === disabled ||\n\n\t\t\t\t\t// Where there is no isDisabled, check manually\n\t\t\t\t\t/* jshint -W018 */\n\t\t\t\t\telem.isDisabled !== !disabled &&\n\t\t\t\t\tinDisabledFieldset( elem ) === disabled;\n\t\t\t}\n\n\t\t\treturn elem.disabled === disabled;\n\n\t\t// Try to winnow out elements that can't be disabled before trusting the disabled property.\n\t\t// Some victims get caught in our net (label, legend, menu, track), but it shouldn't\n\t\t// even exist on them, let alone have a boolean value.\n\t\t} else if ( \"label\" in elem ) {\n\t\t\treturn elem.disabled === disabled;\n\t\t}\n\n\t\t// Remaining elements are neither :enabled nor :disabled\n\t\treturn false;\n\t};\n}\n\n/**\n * Returns a function to use in pseudos for positionals\n * @param {Function} fn\n */\nfunction createPositionalPseudo( fn ) {\n\treturn markFunction( function( argument ) {\n\t\targument = +argument;\n\t\treturn markFunction( function( seed, matches ) {\n\t\t\tvar j,\n\t\t\t\tmatchIndexes = fn( [], seed.length, argument ),\n\t\t\t\ti = matchIndexes.length;\n\n\t\t\t// Match elements found at the specified indexes\n\t\t\twhile ( i-- ) {\n\t\t\t\tif ( seed[ ( j = matchIndexes[ i ] ) ] ) {\n\t\t\t\t\tseed[ j ] = !( matches[ j ] = seed[ j ] );\n\t\t\t\t}\n\t\t\t}\n\t\t} );\n\t} );\n}\n\n/**\n * Checks a node for validity as a Sizzle context\n * @param {Element|Object=} context\n * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value\n */\nfunction testContext( context ) {\n\treturn context && typeof context.getElementsByTagName !== \"undefined\" && context;\n}\n\n// Expose support vars for convenience\nsupport = Sizzle.support = {};\n\n/**\n * Detects XML nodes\n * @param {Element|Object} elem An element or a document\n * @returns {Boolean} True iff elem is a non-HTML XML node\n */\nisXML = Sizzle.isXML = function( elem ) {\n\tvar namespace = elem.namespaceURI,\n\t\tdocElem = ( elem.ownerDocument || elem ).documentElement;\n\n\t// Support: IE <=8\n\t// Assume HTML when documentElement doesn't yet exist, such as inside loading iframes\n\t// https://bugs.jquery.com/ticket/4833\n\treturn !rhtml.test( namespace || docElem && docElem.nodeName || \"HTML\" );\n};\n\n/**\n * Sets document-related variables once based on the current document\n * @param {Element|Object} [doc] An element or document object to use to set the document\n * @returns {Object} Returns the current document\n */\nsetDocument = Sizzle.setDocument = function( node ) {\n\tvar hasCompare, subWindow,\n\t\tdoc = node ? node.ownerDocument || node : preferredDoc;\n\n\t// Return early if doc is invalid or already selected\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) {\n\t\treturn document;\n\t}\n\n\t// Update global variables\n\tdocument = doc;\n\tdocElem = document.documentElement;\n\tdocumentIsHTML = !isXML( document );\n\n\t// Support: IE 9 - 11+, Edge 12 - 18+\n\t// Accessing iframe documents after unload throws \"permission denied\" errors (jQuery #13936)\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( preferredDoc != document &&\n\t\t( subWindow = document.defaultView ) && subWindow.top !== subWindow ) {\n\n\t\t// Support: IE 11, Edge\n\t\tif ( subWindow.addEventListener ) {\n\t\t\tsubWindow.addEventListener( \"unload\", unloadHandler, false );\n\n\t\t// Support: IE 9 - 10 only\n\t\t} else if ( subWindow.attachEvent ) {\n\t\t\tsubWindow.attachEvent( \"onunload\", unloadHandler );\n\t\t}\n\t}\n\n\t// Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only,\n\t// Safari 4 - 5 only, Opera <=11.6 - 12.x only\n\t// IE/Edge & older browsers don't support the :scope pseudo-class.\n\t// Support: Safari 6.0 only\n\t// Safari 6.0 supports :scope but it's an alias of :root there.\n\tsupport.scope = assert( function( el ) {\n\t\tdocElem.appendChild( el ).appendChild( document.createElement( \"div\" ) );\n\t\treturn typeof el.querySelectorAll !== \"undefined\" &&\n\t\t\t!el.querySelectorAll( \":scope fieldset div\" ).length;\n\t} );\n\n\t/* Attributes\n\t---------------------------------------------------------------------- */\n\n\t// Support: IE<8\n\t// Verify that getAttribute really returns attributes and not properties\n\t// (excepting IE8 booleans)\n\tsupport.attributes = assert( function( el ) {\n\t\tel.className = \"i\";\n\t\treturn !el.getAttribute( \"className\" );\n\t} );\n\n\t/* getElement(s)By*\n\t---------------------------------------------------------------------- */\n\n\t// Check if getElementsByTagName(\"*\") returns only elements\n\tsupport.getElementsByTagName = assert( function( el ) {\n\t\tel.appendChild( document.createComment( \"\" ) );\n\t\treturn !el.getElementsByTagName( \"*\" ).length;\n\t} );\n\n\t// Support: IE<9\n\tsupport.getElementsByClassName = rnative.test( document.getElementsByClassName );\n\n\t// Support: IE<10\n\t// Check if getElementById returns elements by name\n\t// The broken getElementById methods don't pick up programmatically-set names,\n\t// so use a roundabout getElementsByName test\n\tsupport.getById = assert( function( el ) {\n\t\tdocElem.appendChild( el ).id = expando;\n\t\treturn !document.getElementsByName || !document.getElementsByName( expando ).length;\n\t} );\n\n\t// ID filter and find\n\tif ( support.getById ) {\n\t\tExpr.filter[ \"ID\" ] = function( id ) {\n\t\t\tvar attrId = id.replace( runescape, funescape );\n\t\t\treturn function( elem ) {\n\t\t\t\treturn elem.getAttribute( \"id\" ) === attrId;\n\t\t\t};\n\t\t};\n\t\tExpr.find[ \"ID\" ] = function( id, context ) {\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && documentIsHTML ) {\n\t\t\t\tvar elem = context.getElementById( id );\n\t\t\t\treturn elem ? [ elem ] : [];\n\t\t\t}\n\t\t};\n\t} else {\n\t\tExpr.filter[ \"ID\" ] = function( id ) {\n\t\t\tvar attrId = id.replace( runescape, funescape );\n\t\t\treturn function( elem ) {\n\t\t\t\tvar node = typeof elem.getAttributeNode !== \"undefined\" &&\n\t\t\t\t\telem.getAttributeNode( \"id\" );\n\t\t\t\treturn node && node.value === attrId;\n\t\t\t};\n\t\t};\n\n\t\t// Support: IE 6 - 7 only\n\t\t// getElementById is not reliable as a find shortcut\n\t\tExpr.find[ \"ID\" ] = function( id, context ) {\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && documentIsHTML ) {\n\t\t\t\tvar node, i, elems,\n\t\t\t\t\telem = context.getElementById( id );\n\n\t\t\t\tif ( elem ) {\n\n\t\t\t\t\t// Verify the id attribute\n\t\t\t\t\tnode = elem.getAttributeNode( \"id\" );\n\t\t\t\t\tif ( node && node.value === id ) {\n\t\t\t\t\t\treturn [ elem ];\n\t\t\t\t\t}\n\n\t\t\t\t\t// Fall back on getElementsByName\n\t\t\t\t\telems = context.getElementsByName( id );\n\t\t\t\t\ti = 0;\n\t\t\t\t\twhile ( ( elem = elems[ i++ ] ) ) {\n\t\t\t\t\t\tnode = elem.getAttributeNode( \"id\" );\n\t\t\t\t\t\tif ( node && node.value === id ) {\n\t\t\t\t\t\t\treturn [ elem ];\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn [];\n\t\t\t}\n\t\t};\n\t}\n\n\t// Tag\n\tExpr.find[ \"TAG\" ] = support.getElementsByTagName ?\n\t\tfunction( tag, context ) {\n\t\t\tif ( typeof context.getElementsByTagName !== \"undefined\" ) {\n\t\t\t\treturn context.getElementsByTagName( tag );\n\n\t\t\t// DocumentFragment nodes don't have gEBTN\n\t\t\t} else if ( support.qsa ) {\n\t\t\t\treturn context.querySelectorAll( tag );\n\t\t\t}\n\t\t} :\n\n\t\tfunction( tag, context ) {\n\t\t\tvar elem,\n\t\t\t\ttmp = [],\n\t\t\t\ti = 0,\n\n\t\t\t\t// By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too\n\t\t\t\tresults = context.getElementsByTagName( tag );\n\n\t\t\t// Filter out possible comments\n\t\t\tif ( tag === \"*\" ) {\n\t\t\t\twhile ( ( elem = results[ i++ ] ) ) {\n\t\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\t\ttmp.push( elem );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn tmp;\n\t\t\t}\n\t\t\treturn results;\n\t\t};\n\n\t// Class\n\tExpr.find[ \"CLASS\" ] = support.getElementsByClassName && function( className, context ) {\n\t\tif ( typeof context.getElementsByClassName !== \"undefined\" && documentIsHTML ) {\n\t\t\treturn context.getElementsByClassName( className );\n\t\t}\n\t};\n\n\t/* QSA/matchesSelector\n\t---------------------------------------------------------------------- */\n\n\t// QSA and matchesSelector support\n\n\t// matchesSelector(:active) reports false when true (IE9/Opera 11.5)\n\trbuggyMatches = [];\n\n\t// qSa(:focus) reports false when true (Chrome 21)\n\t// We allow this because of a bug in IE8/9 that throws an error\n\t// whenever `document.activeElement` is accessed on an iframe\n\t// So, we allow :focus to pass through QSA all the time to avoid the IE error\n\t// See https://bugs.jquery.com/ticket/13378\n\trbuggyQSA = [];\n\n\tif ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) {\n\n\t\t// Build QSA regex\n\t\t// Regex strategy adopted from Diego Perini\n\t\tassert( function( el ) {\n\n\t\t\tvar input;\n\n\t\t\t// Select is set to empty string on purpose\n\t\t\t// This is to test IE's treatment of not explicitly\n\t\t\t// setting a boolean content attribute,\n\t\t\t// since its presence should be enough\n\t\t\t// https://bugs.jquery.com/ticket/12359\n\t\t\tdocElem.appendChild( el ).innerHTML = \"\" +\n\t\t\t\t\"\";\n\n\t\t\t// Support: IE8, Opera 11-12.16\n\t\t\t// Nothing should be selected when empty strings follow ^= or $= or *=\n\t\t\t// The test attribute must be unknown in Opera but \"safe\" for WinRT\n\t\t\t// https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section\n\t\t\tif ( el.querySelectorAll( \"[msallowcapture^='']\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"[*^$]=\" + whitespace + \"*(?:''|\\\"\\\")\" );\n\t\t\t}\n\n\t\t\t// Support: IE8\n\t\t\t// Boolean attributes and \"value\" are not treated correctly\n\t\t\tif ( !el.querySelectorAll( \"[selected]\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"\\\\[\" + whitespace + \"*(?:value|\" + booleans + \")\" );\n\t\t\t}\n\n\t\t\t// Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+\n\t\t\tif ( !el.querySelectorAll( \"[id~=\" + expando + \"-]\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"~=\" );\n\t\t\t}\n\n\t\t\t// Support: IE 11+, Edge 15 - 18+\n\t\t\t// IE 11/Edge don't find elements on a `[name='']` query in some cases.\n\t\t\t// Adding a temporary attribute to the document before the selection works\n\t\t\t// around the issue.\n\t\t\t// Interestingly, IE 10 & older don't seem to have the issue.\n\t\t\tinput = document.createElement( \"input\" );\n\t\t\tinput.setAttribute( \"name\", \"\" );\n\t\t\tel.appendChild( input );\n\t\t\tif ( !el.querySelectorAll( \"[name='']\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"\\\\[\" + whitespace + \"*name\" + whitespace + \"*=\" +\n\t\t\t\t\twhitespace + \"*(?:''|\\\"\\\")\" );\n\t\t\t}\n\n\t\t\t// Webkit/Opera - :checked should return selected option elements\n\t\t\t// http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked\n\t\t\t// IE8 throws error here and will not see later tests\n\t\t\tif ( !el.querySelectorAll( \":checked\" ).length ) {\n\t\t\t\trbuggyQSA.push( \":checked\" );\n\t\t\t}\n\n\t\t\t// Support: Safari 8+, iOS 8+\n\t\t\t// https://bugs.webkit.org/show_bug.cgi?id=136851\n\t\t\t// In-page `selector#id sibling-combinator selector` fails\n\t\t\tif ( !el.querySelectorAll( \"a#\" + expando + \"+*\" ).length ) {\n\t\t\t\trbuggyQSA.push( \".#.+[+~]\" );\n\t\t\t}\n\n\t\t\t// Support: Firefox <=3.6 - 5 only\n\t\t\t// Old Firefox doesn't throw on a badly-escaped identifier.\n\t\t\tel.querySelectorAll( \"\\\\\\f\" );\n\t\t\trbuggyQSA.push( \"[\\\\r\\\\n\\\\f]\" );\n\t\t} );\n\n\t\tassert( function( el ) {\n\t\t\tel.innerHTML = \"\" +\n\t\t\t\t\"\";\n\n\t\t\t// Support: Windows 8 Native Apps\n\t\t\t// The type and name attributes are restricted during .innerHTML assignment\n\t\t\tvar input = document.createElement( \"input\" );\n\t\t\tinput.setAttribute( \"type\", \"hidden\" );\n\t\t\tel.appendChild( input ).setAttribute( \"name\", \"D\" );\n\n\t\t\t// Support: IE8\n\t\t\t// Enforce case-sensitivity of name attribute\n\t\t\tif ( el.querySelectorAll( \"[name=d]\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"name\" + whitespace + \"*[*^$|!~]?=\" );\n\t\t\t}\n\n\t\t\t// FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)\n\t\t\t// IE8 throws error here and will not see later tests\n\t\t\tif ( el.querySelectorAll( \":enabled\" ).length !== 2 ) {\n\t\t\t\trbuggyQSA.push( \":enabled\", \":disabled\" );\n\t\t\t}\n\n\t\t\t// Support: IE9-11+\n\t\t\t// IE's :disabled selector does not pick up the children of disabled fieldsets\n\t\t\tdocElem.appendChild( el ).disabled = true;\n\t\t\tif ( el.querySelectorAll( \":disabled\" ).length !== 2 ) {\n\t\t\t\trbuggyQSA.push( \":enabled\", \":disabled\" );\n\t\t\t}\n\n\t\t\t// Support: Opera 10 - 11 only\n\t\t\t// Opera 10-11 does not throw on post-comma invalid pseudos\n\t\t\tel.querySelectorAll( \"*,:x\" );\n\t\t\trbuggyQSA.push( \",.*:\" );\n\t\t} );\n\t}\n\n\tif ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches ||\n\t\tdocElem.webkitMatchesSelector ||\n\t\tdocElem.mozMatchesSelector ||\n\t\tdocElem.oMatchesSelector ||\n\t\tdocElem.msMatchesSelector ) ) ) ) {\n\n\t\tassert( function( el ) {\n\n\t\t\t// Check to see if it's possible to do matchesSelector\n\t\t\t// on a disconnected node (IE 9)\n\t\t\tsupport.disconnectedMatch = matches.call( el, \"*\" );\n\n\t\t\t// This should fail with an exception\n\t\t\t// Gecko does not error, returns false instead\n\t\t\tmatches.call( el, \"[s!='']:x\" );\n\t\t\trbuggyMatches.push( \"!=\", pseudos );\n\t\t} );\n\t}\n\n\trbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( \"|\" ) );\n\trbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( \"|\" ) );\n\n\t/* Contains\n\t---------------------------------------------------------------------- */\n\thasCompare = rnative.test( docElem.compareDocumentPosition );\n\n\t// Element contains another\n\t// Purposefully self-exclusive\n\t// As in, an element does not contain itself\n\tcontains = hasCompare || rnative.test( docElem.contains ) ?\n\t\tfunction( a, b ) {\n\t\t\tvar adown = a.nodeType === 9 ? a.documentElement : a,\n\t\t\t\tbup = b && b.parentNode;\n\t\t\treturn a === bup || !!( bup && bup.nodeType === 1 && (\n\t\t\t\tadown.contains ?\n\t\t\t\t\tadown.contains( bup ) :\n\t\t\t\t\ta.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16\n\t\t\t) );\n\t\t} :\n\t\tfunction( a, b ) {\n\t\t\tif ( b ) {\n\t\t\t\twhile ( ( b = b.parentNode ) ) {\n\t\t\t\t\tif ( b === a ) {\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn false;\n\t\t};\n\n\t/* Sorting\n\t---------------------------------------------------------------------- */\n\n\t// Document order sorting\n\tsortOrder = hasCompare ?\n\tfunction( a, b ) {\n\n\t\t// Flag for duplicate removal\n\t\tif ( a === b ) {\n\t\t\thasDuplicate = true;\n\t\t\treturn 0;\n\t\t}\n\n\t\t// Sort on method existence if only one input has compareDocumentPosition\n\t\tvar compare = !a.compareDocumentPosition - !b.compareDocumentPosition;\n\t\tif ( compare ) {\n\t\t\treturn compare;\n\t\t}\n\n\t\t// Calculate position if both inputs belong to the same document\n\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t// two documents; shallow comparisons work.\n\t\t// eslint-disable-next-line eqeqeq\n\t\tcompare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ?\n\t\t\ta.compareDocumentPosition( b ) :\n\n\t\t\t// Otherwise we know they are disconnected\n\t\t\t1;\n\n\t\t// Disconnected nodes\n\t\tif ( compare & 1 ||\n\t\t\t( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) {\n\n\t\t\t// Choose the first element that is related to our preferred document\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\tif ( a == document || a.ownerDocument == preferredDoc &&\n\t\t\t\tcontains( preferredDoc, a ) ) {\n\t\t\t\treturn -1;\n\t\t\t}\n\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\tif ( b == document || b.ownerDocument == preferredDoc &&\n\t\t\t\tcontains( preferredDoc, b ) ) {\n\t\t\t\treturn 1;\n\t\t\t}\n\n\t\t\t// Maintain original order\n\t\t\treturn sortInput ?\n\t\t\t\t( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :\n\t\t\t\t0;\n\t\t}\n\n\t\treturn compare & 4 ? -1 : 1;\n\t} :\n\tfunction( a, b ) {\n\n\t\t// Exit early if the nodes are identical\n\t\tif ( a === b ) {\n\t\t\thasDuplicate = true;\n\t\t\treturn 0;\n\t\t}\n\n\t\tvar cur,\n\t\t\ti = 0,\n\t\t\taup = a.parentNode,\n\t\t\tbup = b.parentNode,\n\t\t\tap = [ a ],\n\t\t\tbp = [ b ];\n\n\t\t// Parentless nodes are either documents or disconnected\n\t\tif ( !aup || !bup ) {\n\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t/* eslint-disable eqeqeq */\n\t\t\treturn a == document ? -1 :\n\t\t\t\tb == document ? 1 :\n\t\t\t\t/* eslint-enable eqeqeq */\n\t\t\t\taup ? -1 :\n\t\t\t\tbup ? 1 :\n\t\t\t\tsortInput ?\n\t\t\t\t( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :\n\t\t\t\t0;\n\n\t\t// If the nodes are siblings, we can do a quick check\n\t\t} else if ( aup === bup ) {\n\t\t\treturn siblingCheck( a, b );\n\t\t}\n\n\t\t// Otherwise we need full lists of their ancestors for comparison\n\t\tcur = a;\n\t\twhile ( ( cur = cur.parentNode ) ) {\n\t\t\tap.unshift( cur );\n\t\t}\n\t\tcur = b;\n\t\twhile ( ( cur = cur.parentNode ) ) {\n\t\t\tbp.unshift( cur );\n\t\t}\n\n\t\t// Walk down the tree looking for a discrepancy\n\t\twhile ( ap[ i ] === bp[ i ] ) {\n\t\t\ti++;\n\t\t}\n\n\t\treturn i ?\n\n\t\t\t// Do a sibling check if the nodes have a common ancestor\n\t\t\tsiblingCheck( ap[ i ], bp[ i ] ) :\n\n\t\t\t// Otherwise nodes in our document sort first\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t/* eslint-disable eqeqeq */\n\t\t\tap[ i ] == preferredDoc ? -1 :\n\t\t\tbp[ i ] == preferredDoc ? 1 :\n\t\t\t/* eslint-enable eqeqeq */\n\t\t\t0;\n\t};\n\n\treturn document;\n};\n\nSizzle.matches = function( expr, elements ) {\n\treturn Sizzle( expr, null, null, elements );\n};\n\nSizzle.matchesSelector = function( elem, expr ) {\n\tsetDocument( elem );\n\n\tif ( support.matchesSelector && documentIsHTML &&\n\t\t!nonnativeSelectorCache[ expr + \" \" ] &&\n\t\t( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&\n\t\t( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {\n\n\t\ttry {\n\t\t\tvar ret = matches.call( elem, expr );\n\n\t\t\t// IE 9's matchesSelector returns false on disconnected nodes\n\t\t\tif ( ret || support.disconnectedMatch ||\n\n\t\t\t\t// As well, disconnected nodes are said to be in a document\n\t\t\t\t// fragment in IE 9\n\t\t\t\telem.document && elem.document.nodeType !== 11 ) {\n\t\t\t\treturn ret;\n\t\t\t}\n\t\t} catch ( e ) {\n\t\t\tnonnativeSelectorCache( expr, true );\n\t\t}\n\t}\n\n\treturn Sizzle( expr, document, null, [ elem ] ).length > 0;\n};\n\nSizzle.contains = function( context, elem ) {\n\n\t// Set document vars if needed\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( ( context.ownerDocument || context ) != document ) {\n\t\tsetDocument( context );\n\t}\n\treturn contains( context, elem );\n};\n\nSizzle.attr = function( elem, name ) {\n\n\t// Set document vars if needed\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( ( elem.ownerDocument || elem ) != document ) {\n\t\tsetDocument( elem );\n\t}\n\n\tvar fn = Expr.attrHandle[ name.toLowerCase() ],\n\n\t\t// Don't get fooled by Object.prototype properties (jQuery #13807)\n\t\tval = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?\n\t\t\tfn( elem, name, !documentIsHTML ) :\n\t\t\tundefined;\n\n\treturn val !== undefined ?\n\t\tval :\n\t\tsupport.attributes || !documentIsHTML ?\n\t\t\telem.getAttribute( name ) :\n\t\t\t( val = elem.getAttributeNode( name ) ) && val.specified ?\n\t\t\t\tval.value :\n\t\t\t\tnull;\n};\n\nSizzle.escape = function( sel ) {\n\treturn ( sel + \"\" ).replace( rcssescape, fcssescape );\n};\n\nSizzle.error = function( msg ) {\n\tthrow new Error( \"Syntax error, unrecognized expression: \" + msg );\n};\n\n/**\n * Document sorting and removing duplicates\n * @param {ArrayLike} results\n */\nSizzle.uniqueSort = function( results ) {\n\tvar elem,\n\t\tduplicates = [],\n\t\tj = 0,\n\t\ti = 0;\n\n\t// Unless we *know* we can detect duplicates, assume their presence\n\thasDuplicate = !support.detectDuplicates;\n\tsortInput = !support.sortStable && results.slice( 0 );\n\tresults.sort( sortOrder );\n\n\tif ( hasDuplicate ) {\n\t\twhile ( ( elem = results[ i++ ] ) ) {\n\t\t\tif ( elem === results[ i ] ) {\n\t\t\t\tj = duplicates.push( i );\n\t\t\t}\n\t\t}\n\t\twhile ( j-- ) {\n\t\t\tresults.splice( duplicates[ j ], 1 );\n\t\t}\n\t}\n\n\t// Clear input after sorting to release objects\n\t// See https://github.com/jquery/sizzle/pull/225\n\tsortInput = null;\n\n\treturn results;\n};\n\n/**\n * Utility function for retrieving the text value of an array of DOM nodes\n * @param {Array|Element} elem\n */\ngetText = Sizzle.getText = function( elem ) {\n\tvar node,\n\t\tret = \"\",\n\t\ti = 0,\n\t\tnodeType = elem.nodeType;\n\n\tif ( !nodeType ) {\n\n\t\t// If no nodeType, this is expected to be an array\n\t\twhile ( ( node = elem[ i++ ] ) ) {\n\n\t\t\t// Do not traverse comment nodes\n\t\t\tret += getText( node );\n\t\t}\n\t} else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {\n\n\t\t// Use textContent for elements\n\t\t// innerText usage removed for consistency of new lines (jQuery #11153)\n\t\tif ( typeof elem.textContent === \"string\" ) {\n\t\t\treturn elem.textContent;\n\t\t} else {\n\n\t\t\t// Traverse its children\n\t\t\tfor ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {\n\t\t\t\tret += getText( elem );\n\t\t\t}\n\t\t}\n\t} else if ( nodeType === 3 || nodeType === 4 ) {\n\t\treturn elem.nodeValue;\n\t}\n\n\t// Do not include comment or processing instruction nodes\n\n\treturn ret;\n};\n\nExpr = Sizzle.selectors = {\n\n\t// Can be adjusted by the user\n\tcacheLength: 50,\n\n\tcreatePseudo: markFunction,\n\n\tmatch: matchExpr,\n\n\tattrHandle: {},\n\n\tfind: {},\n\n\trelative: {\n\t\t\">\": { dir: \"parentNode\", first: true },\n\t\t\" \": { dir: \"parentNode\" },\n\t\t\"+\": { dir: \"previousSibling\", first: true },\n\t\t\"~\": { dir: \"previousSibling\" }\n\t},\n\n\tpreFilter: {\n\t\t\"ATTR\": function( match ) {\n\t\t\tmatch[ 1 ] = match[ 1 ].replace( runescape, funescape );\n\n\t\t\t// Move the given value to match[3] whether quoted or unquoted\n\t\t\tmatch[ 3 ] = ( match[ 3 ] || match[ 4 ] ||\n\t\t\t\tmatch[ 5 ] || \"\" ).replace( runescape, funescape );\n\n\t\t\tif ( match[ 2 ] === \"~=\" ) {\n\t\t\t\tmatch[ 3 ] = \" \" + match[ 3 ] + \" \";\n\t\t\t}\n\n\t\t\treturn match.slice( 0, 4 );\n\t\t},\n\n\t\t\"CHILD\": function( match ) {\n\n\t\t\t/* matches from matchExpr[\"CHILD\"]\n\t\t\t\t1 type (only|nth|...)\n\t\t\t\t2 what (child|of-type)\n\t\t\t\t3 argument (even|odd|\\d*|\\d*n([+-]\\d+)?|...)\n\t\t\t\t4 xn-component of xn+y argument ([+-]?\\d*n|)\n\t\t\t\t5 sign of xn-component\n\t\t\t\t6 x of xn-component\n\t\t\t\t7 sign of y-component\n\t\t\t\t8 y of y-component\n\t\t\t*/\n\t\t\tmatch[ 1 ] = match[ 1 ].toLowerCase();\n\n\t\t\tif ( match[ 1 ].slice( 0, 3 ) === \"nth\" ) {\n\n\t\t\t\t// nth-* requires argument\n\t\t\t\tif ( !match[ 3 ] ) {\n\t\t\t\t\tSizzle.error( match[ 0 ] );\n\t\t\t\t}\n\n\t\t\t\t// numeric x and y parameters for Expr.filter.CHILD\n\t\t\t\t// remember that false/true cast respectively to 0/1\n\t\t\t\tmatch[ 4 ] = +( match[ 4 ] ?\n\t\t\t\t\tmatch[ 5 ] + ( match[ 6 ] || 1 ) :\n\t\t\t\t\t2 * ( match[ 3 ] === \"even\" || match[ 3 ] === \"odd\" ) );\n\t\t\t\tmatch[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === \"odd\" );\n\n\t\t\t\t// other types prohibit arguments\n\t\t\t} else if ( match[ 3 ] ) {\n\t\t\t\tSizzle.error( match[ 0 ] );\n\t\t\t}\n\n\t\t\treturn match;\n\t\t},\n\n\t\t\"PSEUDO\": function( match ) {\n\t\t\tvar excess,\n\t\t\t\tunquoted = !match[ 6 ] && match[ 2 ];\n\n\t\t\tif ( matchExpr[ \"CHILD\" ].test( match[ 0 ] ) ) {\n\t\t\t\treturn null;\n\t\t\t}\n\n\t\t\t// Accept quoted arguments as-is\n\t\t\tif ( match[ 3 ] ) {\n\t\t\t\tmatch[ 2 ] = match[ 4 ] || match[ 5 ] || \"\";\n\n\t\t\t// Strip excess characters from unquoted arguments\n\t\t\t} else if ( unquoted && rpseudo.test( unquoted ) &&\n\n\t\t\t\t// Get excess from tokenize (recursively)\n\t\t\t\t( excess = tokenize( unquoted, true ) ) &&\n\n\t\t\t\t// advance to the next closing parenthesis\n\t\t\t\t( excess = unquoted.indexOf( \")\", unquoted.length - excess ) - unquoted.length ) ) {\n\n\t\t\t\t// excess is a negative index\n\t\t\t\tmatch[ 0 ] = match[ 0 ].slice( 0, excess );\n\t\t\t\tmatch[ 2 ] = unquoted.slice( 0, excess );\n\t\t\t}\n\n\t\t\t// Return only captures needed by the pseudo filter method (type and argument)\n\t\t\treturn match.slice( 0, 3 );\n\t\t}\n\t},\n\n\tfilter: {\n\n\t\t\"TAG\": function( nodeNameSelector ) {\n\t\t\tvar nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();\n\t\t\treturn nodeNameSelector === \"*\" ?\n\t\t\t\tfunction() {\n\t\t\t\t\treturn true;\n\t\t\t\t} :\n\t\t\t\tfunction( elem ) {\n\t\t\t\t\treturn elem.nodeName && elem.nodeName.toLowerCase() === nodeName;\n\t\t\t\t};\n\t\t},\n\n\t\t\"CLASS\": function( className ) {\n\t\t\tvar pattern = classCache[ className + \" \" ];\n\n\t\t\treturn pattern ||\n\t\t\t\t( pattern = new RegExp( \"(^|\" + whitespace +\n\t\t\t\t\t\")\" + className + \"(\" + whitespace + \"|$)\" ) ) && classCache(\n\t\t\t\t\t\tclassName, function( elem ) {\n\t\t\t\t\t\t\treturn pattern.test(\n\t\t\t\t\t\t\t\ttypeof elem.className === \"string\" && elem.className ||\n\t\t\t\t\t\t\t\ttypeof elem.getAttribute !== \"undefined\" &&\n\t\t\t\t\t\t\t\t\telem.getAttribute( \"class\" ) ||\n\t\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t);\n\t\t\t\t} );\n\t\t},\n\n\t\t\"ATTR\": function( name, operator, check ) {\n\t\t\treturn function( elem ) {\n\t\t\t\tvar result = Sizzle.attr( elem, name );\n\n\t\t\t\tif ( result == null ) {\n\t\t\t\t\treturn operator === \"!=\";\n\t\t\t\t}\n\t\t\t\tif ( !operator ) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\n\t\t\t\tresult += \"\";\n\n\t\t\t\t/* eslint-disable max-len */\n\n\t\t\t\treturn operator === \"=\" ? result === check :\n\t\t\t\t\toperator === \"!=\" ? result !== check :\n\t\t\t\t\toperator === \"^=\" ? check && result.indexOf( check ) === 0 :\n\t\t\t\t\toperator === \"*=\" ? check && result.indexOf( check ) > -1 :\n\t\t\t\t\toperator === \"$=\" ? check && result.slice( -check.length ) === check :\n\t\t\t\t\toperator === \"~=\" ? ( \" \" + result.replace( rwhitespace, \" \" ) + \" \" ).indexOf( check ) > -1 :\n\t\t\t\t\toperator === \"|=\" ? result === check || result.slice( 0, check.length + 1 ) === check + \"-\" :\n\t\t\t\t\tfalse;\n\t\t\t\t/* eslint-enable max-len */\n\n\t\t\t};\n\t\t},\n\n\t\t\"CHILD\": function( type, what, _argument, first, last ) {\n\t\t\tvar simple = type.slice( 0, 3 ) !== \"nth\",\n\t\t\t\tforward = type.slice( -4 ) !== \"last\",\n\t\t\t\tofType = what === \"of-type\";\n\n\t\t\treturn first === 1 && last === 0 ?\n\n\t\t\t\t// Shortcut for :nth-*(n)\n\t\t\t\tfunction( elem ) {\n\t\t\t\t\treturn !!elem.parentNode;\n\t\t\t\t} :\n\n\t\t\t\tfunction( elem, _context, xml ) {\n\t\t\t\t\tvar cache, uniqueCache, outerCache, node, nodeIndex, start,\n\t\t\t\t\t\tdir = simple !== forward ? \"nextSibling\" : \"previousSibling\",\n\t\t\t\t\t\tparent = elem.parentNode,\n\t\t\t\t\t\tname = ofType && elem.nodeName.toLowerCase(),\n\t\t\t\t\t\tuseCache = !xml && !ofType,\n\t\t\t\t\t\tdiff = false;\n\n\t\t\t\t\tif ( parent ) {\n\n\t\t\t\t\t\t// :(first|last|only)-(child|of-type)\n\t\t\t\t\t\tif ( simple ) {\n\t\t\t\t\t\t\twhile ( dir ) {\n\t\t\t\t\t\t\t\tnode = elem;\n\t\t\t\t\t\t\t\twhile ( ( node = node[ dir ] ) ) {\n\t\t\t\t\t\t\t\t\tif ( ofType ?\n\t\t\t\t\t\t\t\t\t\tnode.nodeName.toLowerCase() === name :\n\t\t\t\t\t\t\t\t\t\tnode.nodeType === 1 ) {\n\n\t\t\t\t\t\t\t\t\t\treturn false;\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t// Reverse direction for :only-* (if we haven't yet done so)\n\t\t\t\t\t\t\t\tstart = dir = type === \"only\" && !start && \"nextSibling\";\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\treturn true;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tstart = [ forward ? parent.firstChild : parent.lastChild ];\n\n\t\t\t\t\t\t// non-xml :nth-child(...) stores cache data on `parent`\n\t\t\t\t\t\tif ( forward && useCache ) {\n\n\t\t\t\t\t\t\t// Seek `elem` from a previously-cached index\n\n\t\t\t\t\t\t\t// ...in a gzip-friendly way\n\t\t\t\t\t\t\tnode = parent;\n\t\t\t\t\t\t\touterCache = node[ expando ] || ( node[ expando ] = {} );\n\n\t\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\t\tuniqueCache = outerCache[ node.uniqueID ] ||\n\t\t\t\t\t\t\t\t( outerCache[ node.uniqueID ] = {} );\n\n\t\t\t\t\t\t\tcache = uniqueCache[ type ] || [];\n\t\t\t\t\t\t\tnodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];\n\t\t\t\t\t\t\tdiff = nodeIndex && cache[ 2 ];\n\t\t\t\t\t\t\tnode = nodeIndex && parent.childNodes[ nodeIndex ];\n\n\t\t\t\t\t\t\twhile ( ( node = ++nodeIndex && node && node[ dir ] ||\n\n\t\t\t\t\t\t\t\t// Fallback to seeking `elem` from the start\n\t\t\t\t\t\t\t\t( diff = nodeIndex = 0 ) || start.pop() ) ) {\n\n\t\t\t\t\t\t\t\t// When found, cache indexes on `parent` and break\n\t\t\t\t\t\t\t\tif ( node.nodeType === 1 && ++diff && node === elem ) {\n\t\t\t\t\t\t\t\t\tuniqueCache[ type ] = [ dirruns, nodeIndex, diff ];\n\t\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t// Use previously-cached element index if available\n\t\t\t\t\t\t\tif ( useCache ) {\n\n\t\t\t\t\t\t\t\t// ...in a gzip-friendly way\n\t\t\t\t\t\t\t\tnode = elem;\n\t\t\t\t\t\t\t\touterCache = node[ expando ] || ( node[ expando ] = {} );\n\n\t\t\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\t\t\tuniqueCache = outerCache[ node.uniqueID ] ||\n\t\t\t\t\t\t\t\t\t( outerCache[ node.uniqueID ] = {} );\n\n\t\t\t\t\t\t\t\tcache = uniqueCache[ type ] || [];\n\t\t\t\t\t\t\t\tnodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];\n\t\t\t\t\t\t\t\tdiff = nodeIndex;\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t// xml :nth-child(...)\n\t\t\t\t\t\t\t// or :nth-last-child(...) or :nth(-last)?-of-type(...)\n\t\t\t\t\t\t\tif ( diff === false ) {\n\n\t\t\t\t\t\t\t\t// Use the same loop as above to seek `elem` from the start\n\t\t\t\t\t\t\t\twhile ( ( node = ++nodeIndex && node && node[ dir ] ||\n\t\t\t\t\t\t\t\t\t( diff = nodeIndex = 0 ) || start.pop() ) ) {\n\n\t\t\t\t\t\t\t\t\tif ( ( ofType ?\n\t\t\t\t\t\t\t\t\t\tnode.nodeName.toLowerCase() === name :\n\t\t\t\t\t\t\t\t\t\tnode.nodeType === 1 ) &&\n\t\t\t\t\t\t\t\t\t\t++diff ) {\n\n\t\t\t\t\t\t\t\t\t\t// Cache the index of each encountered element\n\t\t\t\t\t\t\t\t\t\tif ( useCache ) {\n\t\t\t\t\t\t\t\t\t\t\touterCache = node[ expando ] ||\n\t\t\t\t\t\t\t\t\t\t\t\t( node[ expando ] = {} );\n\n\t\t\t\t\t\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\t\t\t\t\t\tuniqueCache = outerCache[ node.uniqueID ] ||\n\t\t\t\t\t\t\t\t\t\t\t\t( outerCache[ node.uniqueID ] = {} );\n\n\t\t\t\t\t\t\t\t\t\t\tuniqueCache[ type ] = [ dirruns, diff ];\n\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\tif ( node === elem ) {\n\t\t\t\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// Incorporate the offset, then check against cycle size\n\t\t\t\t\t\tdiff -= last;\n\t\t\t\t\t\treturn diff === first || ( diff % first === 0 && diff / first >= 0 );\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t},\n\n\t\t\"PSEUDO\": function( pseudo, argument ) {\n\n\t\t\t// pseudo-class names are case-insensitive\n\t\t\t// http://www.w3.org/TR/selectors/#pseudo-classes\n\t\t\t// Prioritize by case sensitivity in case custom pseudos are added with uppercase letters\n\t\t\t// Remember that setFilters inherits from pseudos\n\t\t\tvar args,\n\t\t\t\tfn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||\n\t\t\t\t\tSizzle.error( \"unsupported pseudo: \" + pseudo );\n\n\t\t\t// The user may use createPseudo to indicate that\n\t\t\t// arguments are needed to create the filter function\n\t\t\t// just as Sizzle does\n\t\t\tif ( fn[ expando ] ) {\n\t\t\t\treturn fn( argument );\n\t\t\t}\n\n\t\t\t// But maintain support for old signatures\n\t\t\tif ( fn.length > 1 ) {\n\t\t\t\targs = [ pseudo, pseudo, \"\", argument ];\n\t\t\t\treturn Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?\n\t\t\t\t\tmarkFunction( function( seed, matches ) {\n\t\t\t\t\t\tvar idx,\n\t\t\t\t\t\t\tmatched = fn( seed, argument ),\n\t\t\t\t\t\t\ti = matched.length;\n\t\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\t\tidx = indexOf( seed, matched[ i ] );\n\t\t\t\t\t\t\tseed[ idx ] = !( matches[ idx ] = matched[ i ] );\n\t\t\t\t\t\t}\n\t\t\t\t\t} ) :\n\t\t\t\t\tfunction( elem ) {\n\t\t\t\t\t\treturn fn( elem, 0, args );\n\t\t\t\t\t};\n\t\t\t}\n\n\t\t\treturn fn;\n\t\t}\n\t},\n\n\tpseudos: {\n\n\t\t// Potentially complex pseudos\n\t\t\"not\": markFunction( function( selector ) {\n\n\t\t\t// Trim the selector passed to compile\n\t\t\t// to avoid treating leading and trailing\n\t\t\t// spaces as combinators\n\t\t\tvar input = [],\n\t\t\t\tresults = [],\n\t\t\t\tmatcher = compile( selector.replace( rtrim, \"$1\" ) );\n\n\t\t\treturn matcher[ expando ] ?\n\t\t\t\tmarkFunction( function( seed, matches, _context, xml ) {\n\t\t\t\t\tvar elem,\n\t\t\t\t\t\tunmatched = matcher( seed, null, xml, [] ),\n\t\t\t\t\t\ti = seed.length;\n\n\t\t\t\t\t// Match elements unmatched by `matcher`\n\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\tif ( ( elem = unmatched[ i ] ) ) {\n\t\t\t\t\t\t\tseed[ i ] = !( matches[ i ] = elem );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} ) :\n\t\t\t\tfunction( elem, _context, xml ) {\n\t\t\t\t\tinput[ 0 ] = elem;\n\t\t\t\t\tmatcher( input, null, xml, results );\n\n\t\t\t\t\t// Don't keep the element (issue #299)\n\t\t\t\t\tinput[ 0 ] = null;\n\t\t\t\t\treturn !results.pop();\n\t\t\t\t};\n\t\t} ),\n\n\t\t\"has\": markFunction( function( selector ) {\n\t\t\treturn function( elem ) {\n\t\t\t\treturn Sizzle( selector, elem ).length > 0;\n\t\t\t};\n\t\t} ),\n\n\t\t\"contains\": markFunction( function( text ) {\n\t\t\ttext = text.replace( runescape, funescape );\n\t\t\treturn function( elem ) {\n\t\t\t\treturn ( elem.textContent || getText( elem ) ).indexOf( text ) > -1;\n\t\t\t};\n\t\t} ),\n\n\t\t// \"Whether an element is represented by a :lang() selector\n\t\t// is based solely on the element's language value\n\t\t// being equal to the identifier C,\n\t\t// or beginning with the identifier C immediately followed by \"-\".\n\t\t// The matching of C against the element's language value is performed case-insensitively.\n\t\t// The identifier C does not have to be a valid language name.\"\n\t\t// http://www.w3.org/TR/selectors/#lang-pseudo\n\t\t\"lang\": markFunction( function( lang ) {\n\n\t\t\t// lang value must be a valid identifier\n\t\t\tif ( !ridentifier.test( lang || \"\" ) ) {\n\t\t\t\tSizzle.error( \"unsupported lang: \" + lang );\n\t\t\t}\n\t\t\tlang = lang.replace( runescape, funescape ).toLowerCase();\n\t\t\treturn function( elem ) {\n\t\t\t\tvar elemLang;\n\t\t\t\tdo {\n\t\t\t\t\tif ( ( elemLang = documentIsHTML ?\n\t\t\t\t\t\telem.lang :\n\t\t\t\t\t\telem.getAttribute( \"xml:lang\" ) || elem.getAttribute( \"lang\" ) ) ) {\n\n\t\t\t\t\t\telemLang = elemLang.toLowerCase();\n\t\t\t\t\t\treturn elemLang === lang || elemLang.indexOf( lang + \"-\" ) === 0;\n\t\t\t\t\t}\n\t\t\t\t} while ( ( elem = elem.parentNode ) && elem.nodeType === 1 );\n\t\t\t\treturn false;\n\t\t\t};\n\t\t} ),\n\n\t\t// Miscellaneous\n\t\t\"target\": function( elem ) {\n\t\t\tvar hash = window.location && window.location.hash;\n\t\t\treturn hash && hash.slice( 1 ) === elem.id;\n\t\t},\n\n\t\t\"root\": function( elem ) {\n\t\t\treturn elem === docElem;\n\t\t},\n\n\t\t\"focus\": function( elem ) {\n\t\t\treturn elem === document.activeElement &&\n\t\t\t\t( !document.hasFocus || document.hasFocus() ) &&\n\t\t\t\t!!( elem.type || elem.href || ~elem.tabIndex );\n\t\t},\n\n\t\t// Boolean properties\n\t\t\"enabled\": createDisabledPseudo( false ),\n\t\t\"disabled\": createDisabledPseudo( true ),\n\n\t\t\"checked\": function( elem ) {\n\n\t\t\t// In CSS3, :checked should return both checked and selected elements\n\t\t\t// http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked\n\t\t\tvar nodeName = elem.nodeName.toLowerCase();\n\t\t\treturn ( nodeName === \"input\" && !!elem.checked ) ||\n\t\t\t\t( nodeName === \"option\" && !!elem.selected );\n\t\t},\n\n\t\t\"selected\": function( elem ) {\n\n\t\t\t// Accessing this property makes selected-by-default\n\t\t\t// options in Safari work properly\n\t\t\tif ( elem.parentNode ) {\n\t\t\t\t// eslint-disable-next-line no-unused-expressions\n\t\t\t\telem.parentNode.selectedIndex;\n\t\t\t}\n\n\t\t\treturn elem.selected === true;\n\t\t},\n\n\t\t// Contents\n\t\t\"empty\": function( elem ) {\n\n\t\t\t// http://www.w3.org/TR/selectors/#empty-pseudo\n\t\t\t// :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),\n\t\t\t// but not by others (comment: 8; processing instruction: 7; etc.)\n\t\t\t// nodeType < 6 works because attributes (2) do not appear as children\n\t\t\tfor ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {\n\t\t\t\tif ( elem.nodeType < 6 ) {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn true;\n\t\t},\n\n\t\t\"parent\": function( elem ) {\n\t\t\treturn !Expr.pseudos[ \"empty\" ]( elem );\n\t\t},\n\n\t\t// Element/input types\n\t\t\"header\": function( elem ) {\n\t\t\treturn rheader.test( elem.nodeName );\n\t\t},\n\n\t\t\"input\": function( elem ) {\n\t\t\treturn rinputs.test( elem.nodeName );\n\t\t},\n\n\t\t\"button\": function( elem ) {\n\t\t\tvar name = elem.nodeName.toLowerCase();\n\t\t\treturn name === \"input\" && elem.type === \"button\" || name === \"button\";\n\t\t},\n\n\t\t\"text\": function( elem ) {\n\t\t\tvar attr;\n\t\t\treturn elem.nodeName.toLowerCase() === \"input\" &&\n\t\t\t\telem.type === \"text\" &&\n\n\t\t\t\t// Support: IE<8\n\t\t\t\t// New HTML5 attribute values (e.g., \"search\") appear with elem.type === \"text\"\n\t\t\t\t( ( attr = elem.getAttribute( \"type\" ) ) == null ||\n\t\t\t\t\tattr.toLowerCase() === \"text\" );\n\t\t},\n\n\t\t// Position-in-collection\n\t\t\"first\": createPositionalPseudo( function() {\n\t\t\treturn [ 0 ];\n\t\t} ),\n\n\t\t\"last\": createPositionalPseudo( function( _matchIndexes, length ) {\n\t\t\treturn [ length - 1 ];\n\t\t} ),\n\n\t\t\"eq\": createPositionalPseudo( function( _matchIndexes, length, argument ) {\n\t\t\treturn [ argument < 0 ? argument + length : argument ];\n\t\t} ),\n\n\t\t\"even\": createPositionalPseudo( function( matchIndexes, length ) {\n\t\t\tvar i = 0;\n\t\t\tfor ( ; i < length; i += 2 ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} ),\n\n\t\t\"odd\": createPositionalPseudo( function( matchIndexes, length ) {\n\t\t\tvar i = 1;\n\t\t\tfor ( ; i < length; i += 2 ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} ),\n\n\t\t\"lt\": createPositionalPseudo( function( matchIndexes, length, argument ) {\n\t\t\tvar i = argument < 0 ?\n\t\t\t\targument + length :\n\t\t\t\targument > length ?\n\t\t\t\t\tlength :\n\t\t\t\t\targument;\n\t\t\tfor ( ; --i >= 0; ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} ),\n\n\t\t\"gt\": createPositionalPseudo( function( matchIndexes, length, argument ) {\n\t\t\tvar i = argument < 0 ? argument + length : argument;\n\t\t\tfor ( ; ++i < length; ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} )\n\t}\n};\n\nExpr.pseudos[ \"nth\" ] = Expr.pseudos[ \"eq\" ];\n\n// Add button/input type pseudos\nfor ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {\n\tExpr.pseudos[ i ] = createInputPseudo( i );\n}\nfor ( i in { submit: true, reset: true } ) {\n\tExpr.pseudos[ i ] = createButtonPseudo( i );\n}\n\n// Easy API for creating new setFilters\nfunction setFilters() {}\nsetFilters.prototype = Expr.filters = Expr.pseudos;\nExpr.setFilters = new setFilters();\n\ntokenize = Sizzle.tokenize = function( selector, parseOnly ) {\n\tvar matched, match, tokens, type,\n\t\tsoFar, groups, preFilters,\n\t\tcached = tokenCache[ selector + \" \" ];\n\n\tif ( cached ) {\n\t\treturn parseOnly ? 0 : cached.slice( 0 );\n\t}\n\n\tsoFar = selector;\n\tgroups = [];\n\tpreFilters = Expr.preFilter;\n\n\twhile ( soFar ) {\n\n\t\t// Comma and first run\n\t\tif ( !matched || ( match = rcomma.exec( soFar ) ) ) {\n\t\t\tif ( match ) {\n\n\t\t\t\t// Don't consume trailing commas as valid\n\t\t\t\tsoFar = soFar.slice( match[ 0 ].length ) || soFar;\n\t\t\t}\n\t\t\tgroups.push( ( tokens = [] ) );\n\t\t}\n\n\t\tmatched = false;\n\n\t\t// Combinators\n\t\tif ( ( match = rcombinators.exec( soFar ) ) ) {\n\t\t\tmatched = match.shift();\n\t\t\ttokens.push( {\n\t\t\t\tvalue: matched,\n\n\t\t\t\t// Cast descendant combinators to space\n\t\t\t\ttype: match[ 0 ].replace( rtrim, \" \" )\n\t\t\t} );\n\t\t\tsoFar = soFar.slice( matched.length );\n\t\t}\n\n\t\t// Filters\n\t\tfor ( type in Expr.filter ) {\n\t\t\tif ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] ||\n\t\t\t\t( match = preFilters[ type ]( match ) ) ) ) {\n\t\t\t\tmatched = match.shift();\n\t\t\t\ttokens.push( {\n\t\t\t\t\tvalue: matched,\n\t\t\t\t\ttype: type,\n\t\t\t\t\tmatches: match\n\t\t\t\t} );\n\t\t\t\tsoFar = soFar.slice( matched.length );\n\t\t\t}\n\t\t}\n\n\t\tif ( !matched ) {\n\t\t\tbreak;\n\t\t}\n\t}\n\n\t// Return the length of the invalid excess\n\t// if we're just parsing\n\t// Otherwise, throw an error or return tokens\n\treturn parseOnly ?\n\t\tsoFar.length :\n\t\tsoFar ?\n\t\t\tSizzle.error( selector ) :\n\n\t\t\t// Cache the tokens\n\t\t\ttokenCache( selector, groups ).slice( 0 );\n};\n\nfunction toSelector( tokens ) {\n\tvar i = 0,\n\t\tlen = tokens.length,\n\t\tselector = \"\";\n\tfor ( ; i < len; i++ ) {\n\t\tselector += tokens[ i ].value;\n\t}\n\treturn selector;\n}\n\nfunction addCombinator( matcher, combinator, base ) {\n\tvar dir = combinator.dir,\n\t\tskip = combinator.next,\n\t\tkey = skip || dir,\n\t\tcheckNonElements = base && key === \"parentNode\",\n\t\tdoneName = done++;\n\n\treturn combinator.first ?\n\n\t\t// Check against closest ancestor/preceding element\n\t\tfunction( elem, context, xml ) {\n\t\t\twhile ( ( elem = elem[ dir ] ) ) {\n\t\t\t\tif ( elem.nodeType === 1 || checkNonElements ) {\n\t\t\t\t\treturn matcher( elem, context, xml );\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn false;\n\t\t} :\n\n\t\t// Check against all ancestor/preceding elements\n\t\tfunction( elem, context, xml ) {\n\t\t\tvar oldCache, uniqueCache, outerCache,\n\t\t\t\tnewCache = [ dirruns, doneName ];\n\n\t\t\t// We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching\n\t\t\tif ( xml ) {\n\t\t\t\twhile ( ( elem = elem[ dir ] ) ) {\n\t\t\t\t\tif ( elem.nodeType === 1 || checkNonElements ) {\n\t\t\t\t\t\tif ( matcher( elem, context, xml ) ) {\n\t\t\t\t\t\t\treturn true;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\twhile ( ( elem = elem[ dir ] ) ) {\n\t\t\t\t\tif ( elem.nodeType === 1 || checkNonElements ) {\n\t\t\t\t\t\touterCache = elem[ expando ] || ( elem[ expando ] = {} );\n\n\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\tuniqueCache = outerCache[ elem.uniqueID ] ||\n\t\t\t\t\t\t\t( outerCache[ elem.uniqueID ] = {} );\n\n\t\t\t\t\t\tif ( skip && skip === elem.nodeName.toLowerCase() ) {\n\t\t\t\t\t\t\telem = elem[ dir ] || elem;\n\t\t\t\t\t\t} else if ( ( oldCache = uniqueCache[ key ] ) &&\n\t\t\t\t\t\t\toldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {\n\n\t\t\t\t\t\t\t// Assign to newCache so results back-propagate to previous elements\n\t\t\t\t\t\t\treturn ( newCache[ 2 ] = oldCache[ 2 ] );\n\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t// Reuse newcache so results back-propagate to previous elements\n\t\t\t\t\t\t\tuniqueCache[ key ] = newCache;\n\n\t\t\t\t\t\t\t// A match means we're done; a fail means we have to keep checking\n\t\t\t\t\t\t\tif ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) {\n\t\t\t\t\t\t\t\treturn true;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn false;\n\t\t};\n}\n\nfunction elementMatcher( matchers ) {\n\treturn matchers.length > 1 ?\n\t\tfunction( elem, context, xml ) {\n\t\t\tvar i = matchers.length;\n\t\t\twhile ( i-- ) {\n\t\t\t\tif ( !matchers[ i ]( elem, context, xml ) ) {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn true;\n\t\t} :\n\t\tmatchers[ 0 ];\n}\n\nfunction multipleContexts( selector, contexts, results ) {\n\tvar i = 0,\n\t\tlen = contexts.length;\n\tfor ( ; i < len; i++ ) {\n\t\tSizzle( selector, contexts[ i ], results );\n\t}\n\treturn results;\n}\n\nfunction condense( unmatched, map, filter, context, xml ) {\n\tvar elem,\n\t\tnewUnmatched = [],\n\t\ti = 0,\n\t\tlen = unmatched.length,\n\t\tmapped = map != null;\n\n\tfor ( ; i < len; i++ ) {\n\t\tif ( ( elem = unmatched[ i ] ) ) {\n\t\t\tif ( !filter || filter( elem, context, xml ) ) {\n\t\t\t\tnewUnmatched.push( elem );\n\t\t\t\tif ( mapped ) {\n\t\t\t\t\tmap.push( i );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn newUnmatched;\n}\n\nfunction setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {\n\tif ( postFilter && !postFilter[ expando ] ) {\n\t\tpostFilter = setMatcher( postFilter );\n\t}\n\tif ( postFinder && !postFinder[ expando ] ) {\n\t\tpostFinder = setMatcher( postFinder, postSelector );\n\t}\n\treturn markFunction( function( seed, results, context, xml ) {\n\t\tvar temp, i, elem,\n\t\t\tpreMap = [],\n\t\t\tpostMap = [],\n\t\t\tpreexisting = results.length,\n\n\t\t\t// Get initial elements from seed or context\n\t\t\telems = seed || multipleContexts(\n\t\t\t\tselector || \"*\",\n\t\t\t\tcontext.nodeType ? [ context ] : context,\n\t\t\t\t[]\n\t\t\t),\n\n\t\t\t// Prefilter to get matcher input, preserving a map for seed-results synchronization\n\t\t\tmatcherIn = preFilter && ( seed || !selector ) ?\n\t\t\t\tcondense( elems, preMap, preFilter, context, xml ) :\n\t\t\t\telems,\n\n\t\t\tmatcherOut = matcher ?\n\n\t\t\t\t// If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,\n\t\t\t\tpostFinder || ( seed ? preFilter : preexisting || postFilter ) ?\n\n\t\t\t\t\t// ...intermediate processing is necessary\n\t\t\t\t\t[] :\n\n\t\t\t\t\t// ...otherwise use results directly\n\t\t\t\t\tresults :\n\t\t\t\tmatcherIn;\n\n\t\t// Find primary matches\n\t\tif ( matcher ) {\n\t\t\tmatcher( matcherIn, matcherOut, context, xml );\n\t\t}\n\n\t\t// Apply postFilter\n\t\tif ( postFilter ) {\n\t\t\ttemp = condense( matcherOut, postMap );\n\t\t\tpostFilter( temp, [], context, xml );\n\n\t\t\t// Un-match failing elements by moving them back to matcherIn\n\t\t\ti = temp.length;\n\t\t\twhile ( i-- ) {\n\t\t\t\tif ( ( elem = temp[ i ] ) ) {\n\t\t\t\t\tmatcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif ( seed ) {\n\t\t\tif ( postFinder || preFilter ) {\n\t\t\t\tif ( postFinder ) {\n\n\t\t\t\t\t// Get the final matcherOut by condensing this intermediate into postFinder contexts\n\t\t\t\t\ttemp = [];\n\t\t\t\t\ti = matcherOut.length;\n\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\tif ( ( elem = matcherOut[ i ] ) ) {\n\n\t\t\t\t\t\t\t// Restore matcherIn since elem is not yet a final match\n\t\t\t\t\t\t\ttemp.push( ( matcherIn[ i ] = elem ) );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tpostFinder( null, ( matcherOut = [] ), temp, xml );\n\t\t\t\t}\n\n\t\t\t\t// Move matched elements from seed to results to keep them synchronized\n\t\t\t\ti = matcherOut.length;\n\t\t\t\twhile ( i-- ) {\n\t\t\t\t\tif ( ( elem = matcherOut[ i ] ) &&\n\t\t\t\t\t\t( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) {\n\n\t\t\t\t\t\tseed[ temp ] = !( results[ temp ] = elem );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Add elements to results, through postFinder if defined\n\t\t} else {\n\t\t\tmatcherOut = condense(\n\t\t\t\tmatcherOut === results ?\n\t\t\t\t\tmatcherOut.splice( preexisting, matcherOut.length ) :\n\t\t\t\t\tmatcherOut\n\t\t\t);\n\t\t\tif ( postFinder ) {\n\t\t\t\tpostFinder( null, results, matcherOut, xml );\n\t\t\t} else {\n\t\t\t\tpush.apply( results, matcherOut );\n\t\t\t}\n\t\t}\n\t} );\n}\n\nfunction matcherFromTokens( tokens ) {\n\tvar checkContext, matcher, j,\n\t\tlen = tokens.length,\n\t\tleadingRelative = Expr.relative[ tokens[ 0 ].type ],\n\t\timplicitRelative = leadingRelative || Expr.relative[ \" \" ],\n\t\ti = leadingRelative ? 1 : 0,\n\n\t\t// The foundational matcher ensures that elements are reachable from top-level context(s)\n\t\tmatchContext = addCombinator( function( elem ) {\n\t\t\treturn elem === checkContext;\n\t\t}, implicitRelative, true ),\n\t\tmatchAnyContext = addCombinator( function( elem ) {\n\t\t\treturn indexOf( checkContext, elem ) > -1;\n\t\t}, implicitRelative, true ),\n\t\tmatchers = [ function( elem, context, xml ) {\n\t\t\tvar ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || (\n\t\t\t\t( checkContext = context ).nodeType ?\n\t\t\t\t\tmatchContext( elem, context, xml ) :\n\t\t\t\t\tmatchAnyContext( elem, context, xml ) );\n\n\t\t\t// Avoid hanging onto element (issue #299)\n\t\t\tcheckContext = null;\n\t\t\treturn ret;\n\t\t} ];\n\n\tfor ( ; i < len; i++ ) {\n\t\tif ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) {\n\t\t\tmatchers = [ addCombinator( elementMatcher( matchers ), matcher ) ];\n\t\t} else {\n\t\t\tmatcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches );\n\n\t\t\t// Return special upon seeing a positional matcher\n\t\t\tif ( matcher[ expando ] ) {\n\n\t\t\t\t// Find the next relative operator (if any) for proper handling\n\t\t\t\tj = ++i;\n\t\t\t\tfor ( ; j < len; j++ ) {\n\t\t\t\t\tif ( Expr.relative[ tokens[ j ].type ] ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn setMatcher(\n\t\t\t\t\ti > 1 && elementMatcher( matchers ),\n\t\t\t\t\ti > 1 && toSelector(\n\n\t\t\t\t\t// If the preceding token was a descendant combinator, insert an implicit any-element `*`\n\t\t\t\t\ttokens\n\t\t\t\t\t\t.slice( 0, i - 1 )\n\t\t\t\t\t\t.concat( { value: tokens[ i - 2 ].type === \" \" ? \"*\" : \"\" } )\n\t\t\t\t\t).replace( rtrim, \"$1\" ),\n\t\t\t\t\tmatcher,\n\t\t\t\t\ti < j && matcherFromTokens( tokens.slice( i, j ) ),\n\t\t\t\t\tj < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ),\n\t\t\t\t\tj < len && toSelector( tokens )\n\t\t\t\t);\n\t\t\t}\n\t\t\tmatchers.push( matcher );\n\t\t}\n\t}\n\n\treturn elementMatcher( matchers );\n}\n\nfunction matcherFromGroupMatchers( elementMatchers, setMatchers ) {\n\tvar bySet = setMatchers.length > 0,\n\t\tbyElement = elementMatchers.length > 0,\n\t\tsuperMatcher = function( seed, context, xml, results, outermost ) {\n\t\t\tvar elem, j, matcher,\n\t\t\t\tmatchedCount = 0,\n\t\t\t\ti = \"0\",\n\t\t\t\tunmatched = seed && [],\n\t\t\t\tsetMatched = [],\n\t\t\t\tcontextBackup = outermostContext,\n\n\t\t\t\t// We must always have either seed elements or outermost context\n\t\t\t\telems = seed || byElement && Expr.find[ \"TAG\" ]( \"*\", outermost ),\n\n\t\t\t\t// Use integer dirruns iff this is the outermost matcher\n\t\t\t\tdirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ),\n\t\t\t\tlen = elems.length;\n\n\t\t\tif ( outermost ) {\n\n\t\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t\t// two documents; shallow comparisons work.\n\t\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\t\toutermostContext = context == document || context || outermost;\n\t\t\t}\n\n\t\t\t// Add elements passing elementMatchers directly to results\n\t\t\t// Support: IE<9, Safari\n\t\t\t// Tolerate NodeList properties (IE: \"length\"; Safari: ) matching elements by id\n\t\t\tfor ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) {\n\t\t\t\tif ( byElement && elem ) {\n\t\t\t\t\tj = 0;\n\n\t\t\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t\t\t// two documents; shallow comparisons work.\n\t\t\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\t\t\tif ( !context && elem.ownerDocument != document ) {\n\t\t\t\t\t\tsetDocument( elem );\n\t\t\t\t\t\txml = !documentIsHTML;\n\t\t\t\t\t}\n\t\t\t\t\twhile ( ( matcher = elementMatchers[ j++ ] ) ) {\n\t\t\t\t\t\tif ( matcher( elem, context || document, xml ) ) {\n\t\t\t\t\t\t\tresults.push( elem );\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif ( outermost ) {\n\t\t\t\t\t\tdirruns = dirrunsUnique;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Track unmatched elements for set filters\n\t\t\t\tif ( bySet ) {\n\n\t\t\t\t\t// They will have gone through all possible matchers\n\t\t\t\t\tif ( ( elem = !matcher && elem ) ) {\n\t\t\t\t\t\tmatchedCount--;\n\t\t\t\t\t}\n\n\t\t\t\t\t// Lengthen the array for every element, matched or not\n\t\t\t\t\tif ( seed ) {\n\t\t\t\t\t\tunmatched.push( elem );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// `i` is now the count of elements visited above, and adding it to `matchedCount`\n\t\t\t// makes the latter nonnegative.\n\t\t\tmatchedCount += i;\n\n\t\t\t// Apply set filters to unmatched elements\n\t\t\t// NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`\n\t\t\t// equals `i`), unless we didn't visit _any_ elements in the above loop because we have\n\t\t\t// no element matchers and no seed.\n\t\t\t// Incrementing an initially-string \"0\" `i` allows `i` to remain a string only in that\n\t\t\t// case, which will result in a \"00\" `matchedCount` that differs from `i` but is also\n\t\t\t// numerically zero.\n\t\t\tif ( bySet && i !== matchedCount ) {\n\t\t\t\tj = 0;\n\t\t\t\twhile ( ( matcher = setMatchers[ j++ ] ) ) {\n\t\t\t\t\tmatcher( unmatched, setMatched, context, xml );\n\t\t\t\t}\n\n\t\t\t\tif ( seed ) {\n\n\t\t\t\t\t// Reintegrate element matches to eliminate the need for sorting\n\t\t\t\t\tif ( matchedCount > 0 ) {\n\t\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\t\tif ( !( unmatched[ i ] || setMatched[ i ] ) ) {\n\t\t\t\t\t\t\t\tsetMatched[ i ] = pop.call( results );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Discard index placeholder values to get only actual matches\n\t\t\t\t\tsetMatched = condense( setMatched );\n\t\t\t\t}\n\n\t\t\t\t// Add matches to results\n\t\t\t\tpush.apply( results, setMatched );\n\n\t\t\t\t// Seedless set matches succeeding multiple successful matchers stipulate sorting\n\t\t\t\tif ( outermost && !seed && setMatched.length > 0 &&\n\t\t\t\t\t( matchedCount + setMatchers.length ) > 1 ) {\n\n\t\t\t\t\tSizzle.uniqueSort( results );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Override manipulation of globals by nested matchers\n\t\t\tif ( outermost ) {\n\t\t\t\tdirruns = dirrunsUnique;\n\t\t\t\toutermostContext = contextBackup;\n\t\t\t}\n\n\t\t\treturn unmatched;\n\t\t};\n\n\treturn bySet ?\n\t\tmarkFunction( superMatcher ) :\n\t\tsuperMatcher;\n}\n\ncompile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {\n\tvar i,\n\t\tsetMatchers = [],\n\t\telementMatchers = [],\n\t\tcached = compilerCache[ selector + \" \" ];\n\n\tif ( !cached ) {\n\n\t\t// Generate a function of recursive functions that can be used to check each element\n\t\tif ( !match ) {\n\t\t\tmatch = tokenize( selector );\n\t\t}\n\t\ti = match.length;\n\t\twhile ( i-- ) {\n\t\t\tcached = matcherFromTokens( match[ i ] );\n\t\t\tif ( cached[ expando ] ) {\n\t\t\t\tsetMatchers.push( cached );\n\t\t\t} else {\n\t\t\t\telementMatchers.push( cached );\n\t\t\t}\n\t\t}\n\n\t\t// Cache the compiled function\n\t\tcached = compilerCache(\n\t\t\tselector,\n\t\t\tmatcherFromGroupMatchers( elementMatchers, setMatchers )\n\t\t);\n\n\t\t// Save selector and tokenization\n\t\tcached.selector = selector;\n\t}\n\treturn cached;\n};\n\n/**\n * A low-level selection function that works with Sizzle's compiled\n * selector functions\n * @param {String|Function} selector A selector or a pre-compiled\n * selector function built with Sizzle.compile\n * @param {Element} context\n * @param {Array} [results]\n * @param {Array} [seed] A set of elements to match against\n */\nselect = Sizzle.select = function( selector, context, results, seed ) {\n\tvar i, tokens, token, type, find,\n\t\tcompiled = typeof selector === \"function\" && selector,\n\t\tmatch = !seed && tokenize( ( selector = compiled.selector || selector ) );\n\n\tresults = results || [];\n\n\t// Try to minimize operations if there is only one selector in the list and no seed\n\t// (the latter of which guarantees us context)\n\tif ( match.length === 1 ) {\n\n\t\t// Reduce context if the leading compound selector is an ID\n\t\ttokens = match[ 0 ] = match[ 0 ].slice( 0 );\n\t\tif ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === \"ID\" &&\n\t\t\tcontext.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) {\n\n\t\t\tcontext = ( Expr.find[ \"ID\" ]( token.matches[ 0 ]\n\t\t\t\t.replace( runescape, funescape ), context ) || [] )[ 0 ];\n\t\t\tif ( !context ) {\n\t\t\t\treturn results;\n\n\t\t\t// Precompiled matchers will still verify ancestry, so step up a level\n\t\t\t} else if ( compiled ) {\n\t\t\t\tcontext = context.parentNode;\n\t\t\t}\n\n\t\t\tselector = selector.slice( tokens.shift().value.length );\n\t\t}\n\n\t\t// Fetch a seed set for right-to-left matching\n\t\ti = matchExpr[ \"needsContext\" ].test( selector ) ? 0 : tokens.length;\n\t\twhile ( i-- ) {\n\t\t\ttoken = tokens[ i ];\n\n\t\t\t// Abort if we hit a combinator\n\t\t\tif ( Expr.relative[ ( type = token.type ) ] ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( ( find = Expr.find[ type ] ) ) {\n\n\t\t\t\t// Search, expanding context for leading sibling combinators\n\t\t\t\tif ( ( seed = find(\n\t\t\t\t\ttoken.matches[ 0 ].replace( runescape, funescape ),\n\t\t\t\t\trsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) ||\n\t\t\t\t\t\tcontext\n\t\t\t\t) ) ) {\n\n\t\t\t\t\t// If seed is empty or no tokens remain, we can return early\n\t\t\t\t\ttokens.splice( i, 1 );\n\t\t\t\t\tselector = seed.length && toSelector( tokens );\n\t\t\t\t\tif ( !selector ) {\n\t\t\t\t\t\tpush.apply( results, seed );\n\t\t\t\t\t\treturn results;\n\t\t\t\t\t}\n\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Compile and execute a filtering function if one is not provided\n\t// Provide `match` to avoid retokenization if we modified the selector above\n\t( compiled || compile( selector, match ) )(\n\t\tseed,\n\t\tcontext,\n\t\t!documentIsHTML,\n\t\tresults,\n\t\t!context || rsibling.test( selector ) && testContext( context.parentNode ) || context\n\t);\n\treturn results;\n};\n\n// One-time assignments\n\n// Sort stability\nsupport.sortStable = expando.split( \"\" ).sort( sortOrder ).join( \"\" ) === expando;\n\n// Support: Chrome 14-35+\n// Always assume duplicates if they aren't passed to the comparison function\nsupport.detectDuplicates = !!hasDuplicate;\n\n// Initialize against the default document\nsetDocument();\n\n// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)\n// Detached nodes confoundingly follow *each other*\nsupport.sortDetached = assert( function( el ) {\n\n\t// Should return 1, but returns 4 (following)\n\treturn el.compareDocumentPosition( document.createElement( \"fieldset\" ) ) & 1;\n} );\n\n// Support: IE<8\n// Prevent attribute/property \"interpolation\"\n// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx\nif ( !assert( function( el ) {\n\tel.innerHTML = \"\";\n\treturn el.firstChild.getAttribute( \"href\" ) === \"#\";\n} ) ) {\n\taddHandle( \"type|href|height|width\", function( elem, name, isXML ) {\n\t\tif ( !isXML ) {\n\t\t\treturn elem.getAttribute( name, name.toLowerCase() === \"type\" ? 1 : 2 );\n\t\t}\n\t} );\n}\n\n// Support: IE<9\n// Use defaultValue in place of getAttribute(\"value\")\nif ( !support.attributes || !assert( function( el ) {\n\tel.innerHTML = \"\";\n\tel.firstChild.setAttribute( \"value\", \"\" );\n\treturn el.firstChild.getAttribute( \"value\" ) === \"\";\n} ) ) {\n\taddHandle( \"value\", function( elem, _name, isXML ) {\n\t\tif ( !isXML && elem.nodeName.toLowerCase() === \"input\" ) {\n\t\t\treturn elem.defaultValue;\n\t\t}\n\t} );\n}\n\n// Support: IE<9\n// Use getAttributeNode to fetch booleans when getAttribute lies\nif ( !assert( function( el ) {\n\treturn el.getAttribute( \"disabled\" ) == null;\n} ) ) {\n\taddHandle( booleans, function( elem, name, isXML ) {\n\t\tvar val;\n\t\tif ( !isXML ) {\n\t\t\treturn elem[ name ] === true ? name.toLowerCase() :\n\t\t\t\t( val = elem.getAttributeNode( name ) ) && val.specified ?\n\t\t\t\t\tval.value :\n\t\t\t\t\tnull;\n\t\t}\n\t} );\n}\n\nreturn Sizzle;\n\n} )( window );\n\n\n\njQuery.find = Sizzle;\njQuery.expr = Sizzle.selectors;\n\n// Deprecated\njQuery.expr[ \":\" ] = jQuery.expr.pseudos;\njQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort;\njQuery.text = Sizzle.getText;\njQuery.isXMLDoc = Sizzle.isXML;\njQuery.contains = Sizzle.contains;\njQuery.escapeSelector = Sizzle.escape;\n\n\n\n\nvar dir = function( elem, dir, until ) {\n\tvar matched = [],\n\t\ttruncate = until !== undefined;\n\n\twhile ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) {\n\t\tif ( elem.nodeType === 1 ) {\n\t\t\tif ( truncate && jQuery( elem ).is( until ) ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tmatched.push( elem );\n\t\t}\n\t}\n\treturn matched;\n};\n\n\nvar siblings = function( n, elem ) {\n\tvar matched = [];\n\n\tfor ( ; n; n = n.nextSibling ) {\n\t\tif ( n.nodeType === 1 && n !== elem ) {\n\t\t\tmatched.push( n );\n\t\t}\n\t}\n\n\treturn matched;\n};\n\n\nvar rneedsContext = jQuery.expr.match.needsContext;\n\n\n\nfunction nodeName( elem, name ) {\n\n return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();\n\n};\nvar rsingleTag = ( /^<([a-z][^\\/\\0>:\\x20\\t\\r\\n\\f]*)[\\x20\\t\\r\\n\\f]*\\/?>(?:<\\/\\1>|)$/i );\n\n\n\n// Implement the identical functionality for filter and not\nfunction winnow( elements, qualifier, not ) {\n\tif ( isFunction( qualifier ) ) {\n\t\treturn jQuery.grep( elements, function( elem, i ) {\n\t\t\treturn !!qualifier.call( elem, i, elem ) !== not;\n\t\t} );\n\t}\n\n\t// Single element\n\tif ( qualifier.nodeType ) {\n\t\treturn jQuery.grep( elements, function( elem ) {\n\t\t\treturn ( elem === qualifier ) !== not;\n\t\t} );\n\t}\n\n\t// Arraylike of elements (jQuery, arguments, Array)\n\tif ( typeof qualifier !== \"string\" ) {\n\t\treturn jQuery.grep( elements, function( elem ) {\n\t\t\treturn ( indexOf.call( qualifier, elem ) > -1 ) !== not;\n\t\t} );\n\t}\n\n\t// Filtered directly for both simple and complex selectors\n\treturn jQuery.filter( qualifier, elements, not );\n}\n\njQuery.filter = function( expr, elems, not ) {\n\tvar elem = elems[ 0 ];\n\n\tif ( not ) {\n\t\texpr = \":not(\" + expr + \")\";\n\t}\n\n\tif ( elems.length === 1 && elem.nodeType === 1 ) {\n\t\treturn jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [];\n\t}\n\n\treturn jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {\n\t\treturn elem.nodeType === 1;\n\t} ) );\n};\n\njQuery.fn.extend( {\n\tfind: function( selector ) {\n\t\tvar i, ret,\n\t\t\tlen = this.length,\n\t\t\tself = this;\n\n\t\tif ( typeof selector !== \"string\" ) {\n\t\t\treturn this.pushStack( jQuery( selector ).filter( function() {\n\t\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t\tif ( jQuery.contains( self[ i ], this ) ) {\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} ) );\n\t\t}\n\n\t\tret = this.pushStack( [] );\n\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tjQuery.find( selector, self[ i ], ret );\n\t\t}\n\n\t\treturn len > 1 ? jQuery.uniqueSort( ret ) : ret;\n\t},\n\tfilter: function( selector ) {\n\t\treturn this.pushStack( winnow( this, selector || [], false ) );\n\t},\n\tnot: function( selector ) {\n\t\treturn this.pushStack( winnow( this, selector || [], true ) );\n\t},\n\tis: function( selector ) {\n\t\treturn !!winnow(\n\t\t\tthis,\n\n\t\t\t// If this is a positional/relative selector, check membership in the returned set\n\t\t\t// so $(\"p:first\").is(\"p:last\") won't return true for a doc with two \"p\".\n\t\t\ttypeof selector === \"string\" && rneedsContext.test( selector ) ?\n\t\t\t\tjQuery( selector ) :\n\t\t\t\tselector || [],\n\t\t\tfalse\n\t\t).length;\n\t}\n} );\n\n\n// Initialize a jQuery object\n\n\n// A central reference to the root jQuery(document)\nvar rootjQuery,\n\n\t// A simple way to check for HTML strings\n\t// Prioritize #id over to avoid XSS via location.hash (#9521)\n\t// Strict HTML recognition (#11290: must start with <)\n\t// Shortcut simple #id case for speed\n\trquickExpr = /^(?:\\s*(<[\\w\\W]+>)[^>]*|#([\\w-]+))$/,\n\n\tinit = jQuery.fn.init = function( selector, context, root ) {\n\t\tvar match, elem;\n\n\t\t// HANDLE: $(\"\"), $(null), $(undefined), $(false)\n\t\tif ( !selector ) {\n\t\t\treturn this;\n\t\t}\n\n\t\t// Method init() accepts an alternate rootjQuery\n\t\t// so migrate can support jQuery.sub (gh-2101)\n\t\troot = root || rootjQuery;\n\n\t\t// Handle HTML strings\n\t\tif ( typeof selector === \"string\" ) {\n\t\t\tif ( selector[ 0 ] === \"<\" &&\n\t\t\t\tselector[ selector.length - 1 ] === \">\" &&\n\t\t\t\tselector.length >= 3 ) {\n\n\t\t\t\t// Assume that strings that start and end with <> are HTML and skip the regex check\n\t\t\t\tmatch = [ null, selector, null ];\n\n\t\t\t} else {\n\t\t\t\tmatch = rquickExpr.exec( selector );\n\t\t\t}\n\n\t\t\t// Match html or make sure no context is specified for #id\n\t\t\tif ( match && ( match[ 1 ] || !context ) ) {\n\n\t\t\t\t// HANDLE: $(html) -> $(array)\n\t\t\t\tif ( match[ 1 ] ) {\n\t\t\t\t\tcontext = context instanceof jQuery ? context[ 0 ] : context;\n\n\t\t\t\t\t// Option to run scripts is true for back-compat\n\t\t\t\t\t// Intentionally let the error be thrown if parseHTML is not present\n\t\t\t\t\tjQuery.merge( this, jQuery.parseHTML(\n\t\t\t\t\t\tmatch[ 1 ],\n\t\t\t\t\t\tcontext && context.nodeType ? context.ownerDocument || context : document,\n\t\t\t\t\t\ttrue\n\t\t\t\t\t) );\n\n\t\t\t\t\t// HANDLE: $(html, props)\n\t\t\t\t\tif ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {\n\t\t\t\t\t\tfor ( match in context ) {\n\n\t\t\t\t\t\t\t// Properties of context are called as methods if possible\n\t\t\t\t\t\t\tif ( isFunction( this[ match ] ) ) {\n\t\t\t\t\t\t\t\tthis[ match ]( context[ match ] );\n\n\t\t\t\t\t\t\t// ...and otherwise set as attributes\n\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\tthis.attr( match, context[ match ] );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\treturn this;\n\n\t\t\t\t// HANDLE: $(#id)\n\t\t\t\t} else {\n\t\t\t\t\telem = document.getElementById( match[ 2 ] );\n\n\t\t\t\t\tif ( elem ) {\n\n\t\t\t\t\t\t// Inject the element directly into the jQuery object\n\t\t\t\t\t\tthis[ 0 ] = elem;\n\t\t\t\t\t\tthis.length = 1;\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\n\t\t\t// HANDLE: $(expr, $(...))\n\t\t\t} else if ( !context || context.jquery ) {\n\t\t\t\treturn ( context || root ).find( selector );\n\n\t\t\t// HANDLE: $(expr, context)\n\t\t\t// (which is just equivalent to: $(context).find(expr)\n\t\t\t} else {\n\t\t\t\treturn this.constructor( context ).find( selector );\n\t\t\t}\n\n\t\t// HANDLE: $(DOMElement)\n\t\t} else if ( selector.nodeType ) {\n\t\t\tthis[ 0 ] = selector;\n\t\t\tthis.length = 1;\n\t\t\treturn this;\n\n\t\t// HANDLE: $(function)\n\t\t// Shortcut for document ready\n\t\t} else if ( isFunction( selector ) ) {\n\t\t\treturn root.ready !== undefined ?\n\t\t\t\troot.ready( selector ) :\n\n\t\t\t\t// Execute immediately if ready is not present\n\t\t\t\tselector( jQuery );\n\t\t}\n\n\t\treturn jQuery.makeArray( selector, this );\n\t};\n\n// Give the init function the jQuery prototype for later instantiation\ninit.prototype = jQuery.fn;\n\n// Initialize central reference\nrootjQuery = jQuery( document );\n\n\nvar rparentsprev = /^(?:parents|prev(?:Until|All))/,\n\n\t// Methods guaranteed to produce a unique set when starting from a unique set\n\tguaranteedUnique = {\n\t\tchildren: true,\n\t\tcontents: true,\n\t\tnext: true,\n\t\tprev: true\n\t};\n\njQuery.fn.extend( {\n\thas: function( target ) {\n\t\tvar targets = jQuery( target, this ),\n\t\t\tl = targets.length;\n\n\t\treturn this.filter( function() {\n\t\t\tvar i = 0;\n\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\tif ( jQuery.contains( this, targets[ i ] ) ) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t}\n\t\t} );\n\t},\n\n\tclosest: function( selectors, context ) {\n\t\tvar cur,\n\t\t\ti = 0,\n\t\t\tl = this.length,\n\t\t\tmatched = [],\n\t\t\ttargets = typeof selectors !== \"string\" && jQuery( selectors );\n\n\t\t// Positional selectors never match, since there's no _selection_ context\n\t\tif ( !rneedsContext.test( selectors ) ) {\n\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\tfor ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {\n\n\t\t\t\t\t// Always skip document fragments\n\t\t\t\t\tif ( cur.nodeType < 11 && ( targets ?\n\t\t\t\t\t\ttargets.index( cur ) > -1 :\n\n\t\t\t\t\t\t// Don't pass non-elements to Sizzle\n\t\t\t\t\t\tcur.nodeType === 1 &&\n\t\t\t\t\t\t\tjQuery.find.matchesSelector( cur, selectors ) ) ) {\n\n\t\t\t\t\t\tmatched.push( cur );\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );\n\t},\n\n\t// Determine the position of an element within the set\n\tindex: function( elem ) {\n\n\t\t// No argument, return index in parent\n\t\tif ( !elem ) {\n\t\t\treturn ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;\n\t\t}\n\n\t\t// Index in selector\n\t\tif ( typeof elem === \"string\" ) {\n\t\t\treturn indexOf.call( jQuery( elem ), this[ 0 ] );\n\t\t}\n\n\t\t// Locate the position of the desired element\n\t\treturn indexOf.call( this,\n\n\t\t\t// If it receives a jQuery object, the first element is used\n\t\t\telem.jquery ? elem[ 0 ] : elem\n\t\t);\n\t},\n\n\tadd: function( selector, context ) {\n\t\treturn this.pushStack(\n\t\t\tjQuery.uniqueSort(\n\t\t\t\tjQuery.merge( this.get(), jQuery( selector, context ) )\n\t\t\t)\n\t\t);\n\t},\n\n\taddBack: function( selector ) {\n\t\treturn this.add( selector == null ?\n\t\t\tthis.prevObject : this.prevObject.filter( selector )\n\t\t);\n\t}\n} );\n\nfunction sibling( cur, dir ) {\n\twhile ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}\n\treturn cur;\n}\n\njQuery.each( {\n\tparent: function( elem ) {\n\t\tvar parent = elem.parentNode;\n\t\treturn parent && parent.nodeType !== 11 ? parent : null;\n\t},\n\tparents: function( elem ) {\n\t\treturn dir( elem, \"parentNode\" );\n\t},\n\tparentsUntil: function( elem, _i, until ) {\n\t\treturn dir( elem, \"parentNode\", until );\n\t},\n\tnext: function( elem ) {\n\t\treturn sibling( elem, \"nextSibling\" );\n\t},\n\tprev: function( elem ) {\n\t\treturn sibling( elem, \"previousSibling\" );\n\t},\n\tnextAll: function( elem ) {\n\t\treturn dir( elem, \"nextSibling\" );\n\t},\n\tprevAll: function( elem ) {\n\t\treturn dir( elem, \"previousSibling\" );\n\t},\n\tnextUntil: function( elem, _i, until ) {\n\t\treturn dir( elem, \"nextSibling\", until );\n\t},\n\tprevUntil: function( elem, _i, until ) {\n\t\treturn dir( elem, \"previousSibling\", until );\n\t},\n\tsiblings: function( elem ) {\n\t\treturn siblings( ( elem.parentNode || {} ).firstChild, elem );\n\t},\n\tchildren: function( elem ) {\n\t\treturn siblings( elem.firstChild );\n\t},\n\tcontents: function( elem ) {\n\t\tif ( elem.contentDocument != null &&\n\n\t\t\t// Support: IE 11+\n\t\t\t// elements with no `data` attribute has an object\n\t\t\t// `contentDocument` with a `null` prototype.\n\t\t\tgetProto( elem.contentDocument ) ) {\n\n\t\t\treturn elem.contentDocument;\n\t\t}\n\n\t\t// Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only\n\t\t// Treat the template element as a regular one in browsers that\n\t\t// don't support it.\n\t\tif ( nodeName( elem, \"template\" ) ) {\n\t\t\telem = elem.content || elem;\n\t\t}\n\n\t\treturn jQuery.merge( [], elem.childNodes );\n\t}\n}, function( name, fn ) {\n\tjQuery.fn[ name ] = function( until, selector ) {\n\t\tvar matched = jQuery.map( this, fn, until );\n\n\t\tif ( name.slice( -5 ) !== \"Until\" ) {\n\t\t\tselector = until;\n\t\t}\n\n\t\tif ( selector && typeof selector === \"string\" ) {\n\t\t\tmatched = jQuery.filter( selector, matched );\n\t\t}\n\n\t\tif ( this.length > 1 ) {\n\n\t\t\t// Remove duplicates\n\t\t\tif ( !guaranteedUnique[ name ] ) {\n\t\t\t\tjQuery.uniqueSort( matched );\n\t\t\t}\n\n\t\t\t// Reverse order for parents* and prev-derivatives\n\t\t\tif ( rparentsprev.test( name ) ) {\n\t\t\t\tmatched.reverse();\n\t\t\t}\n\t\t}\n\n\t\treturn this.pushStack( matched );\n\t};\n} );\nvar rnothtmlwhite = ( /[^\\x20\\t\\r\\n\\f]+/g );\n\n\n\n// Convert String-formatted options into Object-formatted ones\nfunction createOptions( options ) {\n\tvar object = {};\n\tjQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) {\n\t\tobject[ flag ] = true;\n\t} );\n\treturn object;\n}\n\n/*\n * Create a callback list using the following parameters:\n *\n *\toptions: an optional list of space-separated options that will change how\n *\t\t\tthe callback list behaves or a more traditional option object\n *\n * By default a callback list will act like an event callback list and can be\n * \"fired\" multiple times.\n *\n * Possible options:\n *\n *\tonce:\t\t\twill ensure the callback list can only be fired once (like a Deferred)\n *\n *\tmemory:\t\t\twill keep track of previous values and will call any callback added\n *\t\t\t\t\tafter the list has been fired right away with the latest \"memorized\"\n *\t\t\t\t\tvalues (like a Deferred)\n *\n *\tunique:\t\t\twill ensure a callback can only be added once (no duplicate in the list)\n *\n *\tstopOnFalse:\tinterrupt callings when a callback returns false\n *\n */\njQuery.Callbacks = function( options ) {\n\n\t// Convert options from String-formatted to Object-formatted if needed\n\t// (we check in cache first)\n\toptions = typeof options === \"string\" ?\n\t\tcreateOptions( options ) :\n\t\tjQuery.extend( {}, options );\n\n\tvar // Flag to know if list is currently firing\n\t\tfiring,\n\n\t\t// Last fire value for non-forgettable lists\n\t\tmemory,\n\n\t\t// Flag to know if list was already fired\n\t\tfired,\n\n\t\t// Flag to prevent firing\n\t\tlocked,\n\n\t\t// Actual callback list\n\t\tlist = [],\n\n\t\t// Queue of execution data for repeatable lists\n\t\tqueue = [],\n\n\t\t// Index of currently firing callback (modified by add/remove as needed)\n\t\tfiringIndex = -1,\n\n\t\t// Fire callbacks\n\t\tfire = function() {\n\n\t\t\t// Enforce single-firing\n\t\t\tlocked = locked || options.once;\n\n\t\t\t// Execute callbacks for all pending executions,\n\t\t\t// respecting firingIndex overrides and runtime changes\n\t\t\tfired = firing = true;\n\t\t\tfor ( ; queue.length; firingIndex = -1 ) {\n\t\t\t\tmemory = queue.shift();\n\t\t\t\twhile ( ++firingIndex < list.length ) {\n\n\t\t\t\t\t// Run callback and check for early termination\n\t\t\t\t\tif ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false &&\n\t\t\t\t\t\toptions.stopOnFalse ) {\n\n\t\t\t\t\t\t// Jump to end and forget the data so .add doesn't re-fire\n\t\t\t\t\t\tfiringIndex = list.length;\n\t\t\t\t\t\tmemory = false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Forget the data if we're done with it\n\t\t\tif ( !options.memory ) {\n\t\t\t\tmemory = false;\n\t\t\t}\n\n\t\t\tfiring = false;\n\n\t\t\t// Clean up if we're done firing for good\n\t\t\tif ( locked ) {\n\n\t\t\t\t// Keep an empty list if we have data for future add calls\n\t\t\t\tif ( memory ) {\n\t\t\t\t\tlist = [];\n\n\t\t\t\t// Otherwise, this object is spent\n\t\t\t\t} else {\n\t\t\t\t\tlist = \"\";\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\n\t\t// Actual Callbacks object\n\t\tself = {\n\n\t\t\t// Add a callback or a collection of callbacks to the list\n\t\t\tadd: function() {\n\t\t\t\tif ( list ) {\n\n\t\t\t\t\t// If we have memory from a past run, we should fire after adding\n\t\t\t\t\tif ( memory && !firing ) {\n\t\t\t\t\t\tfiringIndex = list.length - 1;\n\t\t\t\t\t\tqueue.push( memory );\n\t\t\t\t\t}\n\n\t\t\t\t\t( function add( args ) {\n\t\t\t\t\t\tjQuery.each( args, function( _, arg ) {\n\t\t\t\t\t\t\tif ( isFunction( arg ) ) {\n\t\t\t\t\t\t\t\tif ( !options.unique || !self.has( arg ) ) {\n\t\t\t\t\t\t\t\t\tlist.push( arg );\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} else if ( arg && arg.length && toType( arg ) !== \"string\" ) {\n\n\t\t\t\t\t\t\t\t// Inspect recursively\n\t\t\t\t\t\t\t\tadd( arg );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} );\n\t\t\t\t\t} )( arguments );\n\n\t\t\t\t\tif ( memory && !firing ) {\n\t\t\t\t\t\tfire();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Remove a callback from the list\n\t\t\tremove: function() {\n\t\t\t\tjQuery.each( arguments, function( _, arg ) {\n\t\t\t\t\tvar index;\n\t\t\t\t\twhile ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) {\n\t\t\t\t\t\tlist.splice( index, 1 );\n\n\t\t\t\t\t\t// Handle firing indexes\n\t\t\t\t\t\tif ( index <= firingIndex ) {\n\t\t\t\t\t\t\tfiringIndex--;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} );\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Check if a given callback is in the list.\n\t\t\t// If no argument is given, return whether or not list has callbacks attached.\n\t\t\thas: function( fn ) {\n\t\t\t\treturn fn ?\n\t\t\t\t\tjQuery.inArray( fn, list ) > -1 :\n\t\t\t\t\tlist.length > 0;\n\t\t\t},\n\n\t\t\t// Remove all callbacks from the list\n\t\t\tempty: function() {\n\t\t\t\tif ( list ) {\n\t\t\t\t\tlist = [];\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Disable .fire and .add\n\t\t\t// Abort any current/pending executions\n\t\t\t// Clear all callbacks and values\n\t\t\tdisable: function() {\n\t\t\t\tlocked = queue = [];\n\t\t\t\tlist = memory = \"\";\n\t\t\t\treturn this;\n\t\t\t},\n\t\t\tdisabled: function() {\n\t\t\t\treturn !list;\n\t\t\t},\n\n\t\t\t// Disable .fire\n\t\t\t// Also disable .add unless we have memory (since it would have no effect)\n\t\t\t// Abort any pending executions\n\t\t\tlock: function() {\n\t\t\t\tlocked = queue = [];\n\t\t\t\tif ( !memory && !firing ) {\n\t\t\t\t\tlist = memory = \"\";\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\t\t\tlocked: function() {\n\t\t\t\treturn !!locked;\n\t\t\t},\n\n\t\t\t// Call all callbacks with the given context and arguments\n\t\t\tfireWith: function( context, args ) {\n\t\t\t\tif ( !locked ) {\n\t\t\t\t\targs = args || [];\n\t\t\t\t\targs = [ context, args.slice ? args.slice() : args ];\n\t\t\t\t\tqueue.push( args );\n\t\t\t\t\tif ( !firing ) {\n\t\t\t\t\t\tfire();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Call all the callbacks with the given arguments\n\t\t\tfire: function() {\n\t\t\t\tself.fireWith( this, arguments );\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// To know if the callbacks have already been called at least once\n\t\t\tfired: function() {\n\t\t\t\treturn !!fired;\n\t\t\t}\n\t\t};\n\n\treturn self;\n};\n\n\nfunction Identity( v ) {\n\treturn v;\n}\nfunction Thrower( ex ) {\n\tthrow ex;\n}\n\nfunction adoptValue( value, resolve, reject, noValue ) {\n\tvar method;\n\n\ttry {\n\n\t\t// Check for promise aspect first to privilege synchronous behavior\n\t\tif ( value && isFunction( ( method = value.promise ) ) ) {\n\t\t\tmethod.call( value ).done( resolve ).fail( reject );\n\n\t\t// Other thenables\n\t\t} else if ( value && isFunction( ( method = value.then ) ) ) {\n\t\t\tmethod.call( value, resolve, reject );\n\n\t\t// Other non-thenables\n\t\t} else {\n\n\t\t\t// Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer:\n\t\t\t// * false: [ value ].slice( 0 ) => resolve( value )\n\t\t\t// * true: [ value ].slice( 1 ) => resolve()\n\t\t\tresolve.apply( undefined, [ value ].slice( noValue ) );\n\t\t}\n\n\t// For Promises/A+, convert exceptions into rejections\n\t// Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in\n\t// Deferred#then to conditionally suppress rejection.\n\t} catch ( value ) {\n\n\t\t// Support: Android 4.0 only\n\t\t// Strict mode functions invoked without .call/.apply get global-object context\n\t\treject.apply( undefined, [ value ] );\n\t}\n}\n\njQuery.extend( {\n\n\tDeferred: function( func ) {\n\t\tvar tuples = [\n\n\t\t\t\t// action, add listener, callbacks,\n\t\t\t\t// ... .then handlers, argument index, [final state]\n\t\t\t\t[ \"notify\", \"progress\", jQuery.Callbacks( \"memory\" ),\n\t\t\t\t\tjQuery.Callbacks( \"memory\" ), 2 ],\n\t\t\t\t[ \"resolve\", \"done\", jQuery.Callbacks( \"once memory\" ),\n\t\t\t\t\tjQuery.Callbacks( \"once memory\" ), 0, \"resolved\" ],\n\t\t\t\t[ \"reject\", \"fail\", jQuery.Callbacks( \"once memory\" ),\n\t\t\t\t\tjQuery.Callbacks( \"once memory\" ), 1, \"rejected\" ]\n\t\t\t],\n\t\t\tstate = \"pending\",\n\t\t\tpromise = {\n\t\t\t\tstate: function() {\n\t\t\t\t\treturn state;\n\t\t\t\t},\n\t\t\t\talways: function() {\n\t\t\t\t\tdeferred.done( arguments ).fail( arguments );\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\t\t\t\t\"catch\": function( fn ) {\n\t\t\t\t\treturn promise.then( null, fn );\n\t\t\t\t},\n\n\t\t\t\t// Keep pipe for back-compat\n\t\t\t\tpipe: function( /* fnDone, fnFail, fnProgress */ ) {\n\t\t\t\t\tvar fns = arguments;\n\n\t\t\t\t\treturn jQuery.Deferred( function( newDefer ) {\n\t\t\t\t\t\tjQuery.each( tuples, function( _i, tuple ) {\n\n\t\t\t\t\t\t\t// Map tuples (progress, done, fail) to arguments (done, fail, progress)\n\t\t\t\t\t\t\tvar fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];\n\n\t\t\t\t\t\t\t// deferred.progress(function() { bind to newDefer or newDefer.notify })\n\t\t\t\t\t\t\t// deferred.done(function() { bind to newDefer or newDefer.resolve })\n\t\t\t\t\t\t\t// deferred.fail(function() { bind to newDefer or newDefer.reject })\n\t\t\t\t\t\t\tdeferred[ tuple[ 1 ] ]( function() {\n\t\t\t\t\t\t\t\tvar returned = fn && fn.apply( this, arguments );\n\t\t\t\t\t\t\t\tif ( returned && isFunction( returned.promise ) ) {\n\t\t\t\t\t\t\t\t\treturned.promise()\n\t\t\t\t\t\t\t\t\t\t.progress( newDefer.notify )\n\t\t\t\t\t\t\t\t\t\t.done( newDefer.resolve )\n\t\t\t\t\t\t\t\t\t\t.fail( newDefer.reject );\n\t\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\t\tnewDefer[ tuple[ 0 ] + \"With\" ](\n\t\t\t\t\t\t\t\t\t\tthis,\n\t\t\t\t\t\t\t\t\t\tfn ? [ returned ] : arguments\n\t\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} );\n\t\t\t\t\t\t} );\n\t\t\t\t\t\tfns = null;\n\t\t\t\t\t} ).promise();\n\t\t\t\t},\n\t\t\t\tthen: function( onFulfilled, onRejected, onProgress ) {\n\t\t\t\t\tvar maxDepth = 0;\n\t\t\t\t\tfunction resolve( depth, deferred, handler, special ) {\n\t\t\t\t\t\treturn function() {\n\t\t\t\t\t\t\tvar that = this,\n\t\t\t\t\t\t\t\targs = arguments,\n\t\t\t\t\t\t\t\tmightThrow = function() {\n\t\t\t\t\t\t\t\t\tvar returned, then;\n\n\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.3.3.3\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-59\n\t\t\t\t\t\t\t\t\t// Ignore double-resolution attempts\n\t\t\t\t\t\t\t\t\tif ( depth < maxDepth ) {\n\t\t\t\t\t\t\t\t\t\treturn;\n\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\treturned = handler.apply( that, args );\n\n\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.1\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-48\n\t\t\t\t\t\t\t\t\tif ( returned === deferred.promise() ) {\n\t\t\t\t\t\t\t\t\t\tthrow new TypeError( \"Thenable self-resolution\" );\n\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t// Support: Promises/A+ sections 2.3.3.1, 3.5\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-54\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-75\n\t\t\t\t\t\t\t\t\t// Retrieve `then` only once\n\t\t\t\t\t\t\t\t\tthen = returned &&\n\n\t\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.4\n\t\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-64\n\t\t\t\t\t\t\t\t\t\t// Only check objects and functions for thenability\n\t\t\t\t\t\t\t\t\t\t( typeof returned === \"object\" ||\n\t\t\t\t\t\t\t\t\t\t\ttypeof returned === \"function\" ) &&\n\t\t\t\t\t\t\t\t\t\treturned.then;\n\n\t\t\t\t\t\t\t\t\t// Handle a returned thenable\n\t\t\t\t\t\t\t\t\tif ( isFunction( then ) ) {\n\n\t\t\t\t\t\t\t\t\t\t// Special processors (notify) just wait for resolution\n\t\t\t\t\t\t\t\t\t\tif ( special ) {\n\t\t\t\t\t\t\t\t\t\t\tthen.call(\n\t\t\t\t\t\t\t\t\t\t\t\treturned,\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Identity, special ),\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Thrower, special )\n\t\t\t\t\t\t\t\t\t\t\t);\n\n\t\t\t\t\t\t\t\t\t\t// Normal processors (resolve) also hook into progress\n\t\t\t\t\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t\t\t\t\t// ...and disregard older resolution values\n\t\t\t\t\t\t\t\t\t\t\tmaxDepth++;\n\n\t\t\t\t\t\t\t\t\t\t\tthen.call(\n\t\t\t\t\t\t\t\t\t\t\t\treturned,\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Identity, special ),\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Thrower, special ),\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Identity,\n\t\t\t\t\t\t\t\t\t\t\t\t\tdeferred.notifyWith )\n\t\t\t\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t// Handle all other returned values\n\t\t\t\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t\t\t\t// Only substitute handlers pass on context\n\t\t\t\t\t\t\t\t\t\t// and multiple values (non-spec behavior)\n\t\t\t\t\t\t\t\t\t\tif ( handler !== Identity ) {\n\t\t\t\t\t\t\t\t\t\t\tthat = undefined;\n\t\t\t\t\t\t\t\t\t\t\targs = [ returned ];\n\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\t// Process the value(s)\n\t\t\t\t\t\t\t\t\t\t// Default process is resolve\n\t\t\t\t\t\t\t\t\t\t( special || deferred.resolveWith )( that, args );\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\n\t\t\t\t\t\t\t\t// Only normal processors (resolve) catch and reject exceptions\n\t\t\t\t\t\t\t\tprocess = special ?\n\t\t\t\t\t\t\t\t\tmightThrow :\n\t\t\t\t\t\t\t\t\tfunction() {\n\t\t\t\t\t\t\t\t\t\ttry {\n\t\t\t\t\t\t\t\t\t\t\tmightThrow();\n\t\t\t\t\t\t\t\t\t\t} catch ( e ) {\n\n\t\t\t\t\t\t\t\t\t\t\tif ( jQuery.Deferred.exceptionHook ) {\n\t\t\t\t\t\t\t\t\t\t\t\tjQuery.Deferred.exceptionHook( e,\n\t\t\t\t\t\t\t\t\t\t\t\t\tprocess.stackTrace );\n\t\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.3.3.4.1\n\t\t\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-61\n\t\t\t\t\t\t\t\t\t\t\t// Ignore post-resolution exceptions\n\t\t\t\t\t\t\t\t\t\t\tif ( depth + 1 >= maxDepth ) {\n\n\t\t\t\t\t\t\t\t\t\t\t\t// Only substitute handlers pass on context\n\t\t\t\t\t\t\t\t\t\t\t\t// and multiple values (non-spec behavior)\n\t\t\t\t\t\t\t\t\t\t\t\tif ( handler !== Thrower ) {\n\t\t\t\t\t\t\t\t\t\t\t\t\tthat = undefined;\n\t\t\t\t\t\t\t\t\t\t\t\t\targs = [ e ];\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\t\t\tdeferred.rejectWith( that, args );\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t};\n\n\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.3.3.1\n\t\t\t\t\t\t\t// https://promisesaplus.com/#point-57\n\t\t\t\t\t\t\t// Re-resolve promises immediately to dodge false rejection from\n\t\t\t\t\t\t\t// subsequent errors\n\t\t\t\t\t\t\tif ( depth ) {\n\t\t\t\t\t\t\t\tprocess();\n\t\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t\t// Call an optional hook to record the stack, in case of exception\n\t\t\t\t\t\t\t\t// since it's otherwise lost when execution goes async\n\t\t\t\t\t\t\t\tif ( jQuery.Deferred.getStackHook ) {\n\t\t\t\t\t\t\t\t\tprocess.stackTrace = jQuery.Deferred.getStackHook();\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\twindow.setTimeout( process );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t};\n\t\t\t\t\t}\n\n\t\t\t\t\treturn jQuery.Deferred( function( newDefer ) {\n\n\t\t\t\t\t\t// progress_handlers.add( ... )\n\t\t\t\t\t\ttuples[ 0 ][ 3 ].add(\n\t\t\t\t\t\t\tresolve(\n\t\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t\tnewDefer,\n\t\t\t\t\t\t\t\tisFunction( onProgress ) ?\n\t\t\t\t\t\t\t\t\tonProgress :\n\t\t\t\t\t\t\t\t\tIdentity,\n\t\t\t\t\t\t\t\tnewDefer.notifyWith\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\t// fulfilled_handlers.add( ... )\n\t\t\t\t\t\ttuples[ 1 ][ 3 ].add(\n\t\t\t\t\t\t\tresolve(\n\t\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t\tnewDefer,\n\t\t\t\t\t\t\t\tisFunction( onFulfilled ) ?\n\t\t\t\t\t\t\t\t\tonFulfilled :\n\t\t\t\t\t\t\t\t\tIdentity\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\t// rejected_handlers.add( ... )\n\t\t\t\t\t\ttuples[ 2 ][ 3 ].add(\n\t\t\t\t\t\t\tresolve(\n\t\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t\tnewDefer,\n\t\t\t\t\t\t\t\tisFunction( onRejected ) ?\n\t\t\t\t\t\t\t\t\tonRejected :\n\t\t\t\t\t\t\t\t\tThrower\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t);\n\t\t\t\t\t} ).promise();\n\t\t\t\t},\n\n\t\t\t\t// Get a promise for this deferred\n\t\t\t\t// If obj is provided, the promise aspect is added to the object\n\t\t\t\tpromise: function( obj ) {\n\t\t\t\t\treturn obj != null ? jQuery.extend( obj, promise ) : promise;\n\t\t\t\t}\n\t\t\t},\n\t\t\tdeferred = {};\n\n\t\t// Add list-specific methods\n\t\tjQuery.each( tuples, function( i, tuple ) {\n\t\t\tvar list = tuple[ 2 ],\n\t\t\t\tstateString = tuple[ 5 ];\n\n\t\t\t// promise.progress = list.add\n\t\t\t// promise.done = list.add\n\t\t\t// promise.fail = list.add\n\t\t\tpromise[ tuple[ 1 ] ] = list.add;\n\n\t\t\t// Handle state\n\t\t\tif ( stateString ) {\n\t\t\t\tlist.add(\n\t\t\t\t\tfunction() {\n\n\t\t\t\t\t\t// state = \"resolved\" (i.e., fulfilled)\n\t\t\t\t\t\t// state = \"rejected\"\n\t\t\t\t\t\tstate = stateString;\n\t\t\t\t\t},\n\n\t\t\t\t\t// rejected_callbacks.disable\n\t\t\t\t\t// fulfilled_callbacks.disable\n\t\t\t\t\ttuples[ 3 - i ][ 2 ].disable,\n\n\t\t\t\t\t// rejected_handlers.disable\n\t\t\t\t\t// fulfilled_handlers.disable\n\t\t\t\t\ttuples[ 3 - i ][ 3 ].disable,\n\n\t\t\t\t\t// progress_callbacks.lock\n\t\t\t\t\ttuples[ 0 ][ 2 ].lock,\n\n\t\t\t\t\t// progress_handlers.lock\n\t\t\t\t\ttuples[ 0 ][ 3 ].lock\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// progress_handlers.fire\n\t\t\t// fulfilled_handlers.fire\n\t\t\t// rejected_handlers.fire\n\t\t\tlist.add( tuple[ 3 ].fire );\n\n\t\t\t// deferred.notify = function() { deferred.notifyWith(...) }\n\t\t\t// deferred.resolve = function() { deferred.resolveWith(...) }\n\t\t\t// deferred.reject = function() { deferred.rejectWith(...) }\n\t\t\tdeferred[ tuple[ 0 ] ] = function() {\n\t\t\t\tdeferred[ tuple[ 0 ] + \"With\" ]( this === deferred ? undefined : this, arguments );\n\t\t\t\treturn this;\n\t\t\t};\n\n\t\t\t// deferred.notifyWith = list.fireWith\n\t\t\t// deferred.resolveWith = list.fireWith\n\t\t\t// deferred.rejectWith = list.fireWith\n\t\t\tdeferred[ tuple[ 0 ] + \"With\" ] = list.fireWith;\n\t\t} );\n\n\t\t// Make the deferred a promise\n\t\tpromise.promise( deferred );\n\n\t\t// Call given func if any\n\t\tif ( func ) {\n\t\t\tfunc.call( deferred, deferred );\n\t\t}\n\n\t\t// All done!\n\t\treturn deferred;\n\t},\n\n\t// Deferred helper\n\twhen: function( singleValue ) {\n\t\tvar\n\n\t\t\t// count of uncompleted subordinates\n\t\t\tremaining = arguments.length,\n\n\t\t\t// count of unprocessed arguments\n\t\t\ti = remaining,\n\n\t\t\t// subordinate fulfillment data\n\t\t\tresolveContexts = Array( i ),\n\t\t\tresolveValues = slice.call( arguments ),\n\n\t\t\t// the master Deferred\n\t\t\tmaster = jQuery.Deferred(),\n\n\t\t\t// subordinate callback factory\n\t\t\tupdateFunc = function( i ) {\n\t\t\t\treturn function( value ) {\n\t\t\t\t\tresolveContexts[ i ] = this;\n\t\t\t\t\tresolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value;\n\t\t\t\t\tif ( !( --remaining ) ) {\n\t\t\t\t\t\tmaster.resolveWith( resolveContexts, resolveValues );\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t\t};\n\n\t\t// Single- and empty arguments are adopted like Promise.resolve\n\t\tif ( remaining <= 1 ) {\n\t\t\tadoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject,\n\t\t\t\t!remaining );\n\n\t\t\t// Use .then() to unwrap secondary thenables (cf. gh-3000)\n\t\t\tif ( master.state() === \"pending\" ||\n\t\t\t\tisFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) {\n\n\t\t\t\treturn master.then();\n\t\t\t}\n\t\t}\n\n\t\t// Multiple arguments are aggregated like Promise.all array elements\n\t\twhile ( i-- ) {\n\t\t\tadoptValue( resolveValues[ i ], updateFunc( i ), master.reject );\n\t\t}\n\n\t\treturn master.promise();\n\t}\n} );\n\n\n// These usually indicate a programmer mistake during development,\n// warn about them ASAP rather than swallowing them by default.\nvar rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;\n\njQuery.Deferred.exceptionHook = function( error, stack ) {\n\n\t// Support: IE 8 - 9 only\n\t// Console exists when dev tools are open, which can happen at any time\n\tif ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) {\n\t\twindow.console.warn( \"jQuery.Deferred exception: \" + error.message, error.stack, stack );\n\t}\n};\n\n\n\n\njQuery.readyException = function( error ) {\n\twindow.setTimeout( function() {\n\t\tthrow error;\n\t} );\n};\n\n\n\n\n// The deferred used on DOM ready\nvar readyList = jQuery.Deferred();\n\njQuery.fn.ready = function( fn ) {\n\n\treadyList\n\t\t.then( fn )\n\n\t\t// Wrap jQuery.readyException in a function so that the lookup\n\t\t// happens at the time of error handling instead of callback\n\t\t// registration.\n\t\t.catch( function( error ) {\n\t\t\tjQuery.readyException( error );\n\t\t} );\n\n\treturn this;\n};\n\njQuery.extend( {\n\n\t// Is the DOM ready to be used? Set to true once it occurs.\n\tisReady: false,\n\n\t// A counter to track how many items to wait for before\n\t// the ready event fires. See #6781\n\treadyWait: 1,\n\n\t// Handle when the DOM is ready\n\tready: function( wait ) {\n\n\t\t// Abort if there are pending holds or we're already ready\n\t\tif ( wait === true ? --jQuery.readyWait : jQuery.isReady ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Remember that the DOM is ready\n\t\tjQuery.isReady = true;\n\n\t\t// If a normal DOM Ready event fired, decrement, and wait if need be\n\t\tif ( wait !== true && --jQuery.readyWait > 0 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// If there are functions bound, to execute\n\t\treadyList.resolveWith( document, [ jQuery ] );\n\t}\n} );\n\njQuery.ready.then = readyList.then;\n\n// The ready event handler and self cleanup method\nfunction completed() {\n\tdocument.removeEventListener( \"DOMContentLoaded\", completed );\n\twindow.removeEventListener( \"load\", completed );\n\tjQuery.ready();\n}\n\n// Catch cases where $(document).ready() is called\n// after the browser event has already occurred.\n// Support: IE <=9 - 10 only\n// Older IE sometimes signals \"interactive\" too soon\nif ( document.readyState === \"complete\" ||\n\t( document.readyState !== \"loading\" && !document.documentElement.doScroll ) ) {\n\n\t// Handle it asynchronously to allow scripts the opportunity to delay ready\n\twindow.setTimeout( jQuery.ready );\n\n} else {\n\n\t// Use the handy event callback\n\tdocument.addEventListener( \"DOMContentLoaded\", completed );\n\n\t// A fallback to window.onload, that will always work\n\twindow.addEventListener( \"load\", completed );\n}\n\n\n\n\n// Multifunctional method to get and set values of a collection\n// The value/s can optionally be executed if it's a function\nvar access = function( elems, fn, key, value, chainable, emptyGet, raw ) {\n\tvar i = 0,\n\t\tlen = elems.length,\n\t\tbulk = key == null;\n\n\t// Sets many values\n\tif ( toType( key ) === \"object\" ) {\n\t\tchainable = true;\n\t\tfor ( i in key ) {\n\t\t\taccess( elems, fn, i, key[ i ], true, emptyGet, raw );\n\t\t}\n\n\t// Sets one value\n\t} else if ( value !== undefined ) {\n\t\tchainable = true;\n\n\t\tif ( !isFunction( value ) ) {\n\t\t\traw = true;\n\t\t}\n\n\t\tif ( bulk ) {\n\n\t\t\t// Bulk operations run against the entire set\n\t\t\tif ( raw ) {\n\t\t\t\tfn.call( elems, value );\n\t\t\t\tfn = null;\n\n\t\t\t// ...except when executing function values\n\t\t\t} else {\n\t\t\t\tbulk = fn;\n\t\t\t\tfn = function( elem, _key, value ) {\n\t\t\t\t\treturn bulk.call( jQuery( elem ), value );\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\n\t\tif ( fn ) {\n\t\t\tfor ( ; i < len; i++ ) {\n\t\t\t\tfn(\n\t\t\t\t\telems[ i ], key, raw ?\n\t\t\t\t\tvalue :\n\t\t\t\t\tvalue.call( elems[ i ], i, fn( elems[ i ], key ) )\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( chainable ) {\n\t\treturn elems;\n\t}\n\n\t// Gets\n\tif ( bulk ) {\n\t\treturn fn.call( elems );\n\t}\n\n\treturn len ? fn( elems[ 0 ], key ) : emptyGet;\n};\n\n\n// Matches dashed string for camelizing\nvar rmsPrefix = /^-ms-/,\n\trdashAlpha = /-([a-z])/g;\n\n// Used by camelCase as callback to replace()\nfunction fcamelCase( _all, letter ) {\n\treturn letter.toUpperCase();\n}\n\n// Convert dashed to camelCase; used by the css and data modules\n// Support: IE <=9 - 11, Edge 12 - 15\n// Microsoft forgot to hump their vendor prefix (#9572)\nfunction camelCase( string ) {\n\treturn string.replace( rmsPrefix, \"ms-\" ).replace( rdashAlpha, fcamelCase );\n}\nvar acceptData = function( owner ) {\n\n\t// Accepts only:\n\t// - Node\n\t// - Node.ELEMENT_NODE\n\t// - Node.DOCUMENT_NODE\n\t// - Object\n\t// - Any\n\treturn owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );\n};\n\n\n\n\nfunction Data() {\n\tthis.expando = jQuery.expando + Data.uid++;\n}\n\nData.uid = 1;\n\nData.prototype = {\n\n\tcache: function( owner ) {\n\n\t\t// Check if the owner object already has a cache\n\t\tvar value = owner[ this.expando ];\n\n\t\t// If not, create one\n\t\tif ( !value ) {\n\t\t\tvalue = {};\n\n\t\t\t// We can accept data for non-element nodes in modern browsers,\n\t\t\t// but we should not, see #8335.\n\t\t\t// Always return an empty object.\n\t\t\tif ( acceptData( owner ) ) {\n\n\t\t\t\t// If it is a node unlikely to be stringify-ed or looped over\n\t\t\t\t// use plain assignment\n\t\t\t\tif ( owner.nodeType ) {\n\t\t\t\t\towner[ this.expando ] = value;\n\n\t\t\t\t// Otherwise secure it in a non-enumerable property\n\t\t\t\t// configurable must be true to allow the property to be\n\t\t\t\t// deleted when data is removed\n\t\t\t\t} else {\n\t\t\t\t\tObject.defineProperty( owner, this.expando, {\n\t\t\t\t\t\tvalue: value,\n\t\t\t\t\t\tconfigurable: true\n\t\t\t\t\t} );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn value;\n\t},\n\tset: function( owner, data, value ) {\n\t\tvar prop,\n\t\t\tcache = this.cache( owner );\n\n\t\t// Handle: [ owner, key, value ] args\n\t\t// Always use camelCase key (gh-2257)\n\t\tif ( typeof data === \"string\" ) {\n\t\t\tcache[ camelCase( data ) ] = value;\n\n\t\t// Handle: [ owner, { properties } ] args\n\t\t} else {\n\n\t\t\t// Copy the properties one-by-one to the cache object\n\t\t\tfor ( prop in data ) {\n\t\t\t\tcache[ camelCase( prop ) ] = data[ prop ];\n\t\t\t}\n\t\t}\n\t\treturn cache;\n\t},\n\tget: function( owner, key ) {\n\t\treturn key === undefined ?\n\t\t\tthis.cache( owner ) :\n\n\t\t\t// Always use camelCase key (gh-2257)\n\t\t\towner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ];\n\t},\n\taccess: function( owner, key, value ) {\n\n\t\t// In cases where either:\n\t\t//\n\t\t// 1. No key was specified\n\t\t// 2. A string key was specified, but no value provided\n\t\t//\n\t\t// Take the \"read\" path and allow the get method to determine\n\t\t// which value to return, respectively either:\n\t\t//\n\t\t// 1. The entire cache object\n\t\t// 2. The data stored at the key\n\t\t//\n\t\tif ( key === undefined ||\n\t\t\t\t( ( key && typeof key === \"string\" ) && value === undefined ) ) {\n\n\t\t\treturn this.get( owner, key );\n\t\t}\n\n\t\t// When the key is not a string, or both a key and value\n\t\t// are specified, set or extend (existing objects) with either:\n\t\t//\n\t\t// 1. An object of properties\n\t\t// 2. A key and value\n\t\t//\n\t\tthis.set( owner, key, value );\n\n\t\t// Since the \"set\" path can have two possible entry points\n\t\t// return the expected data based on which path was taken[*]\n\t\treturn value !== undefined ? value : key;\n\t},\n\tremove: function( owner, key ) {\n\t\tvar i,\n\t\t\tcache = owner[ this.expando ];\n\n\t\tif ( cache === undefined ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( key !== undefined ) {\n\n\t\t\t// Support array or space separated string of keys\n\t\t\tif ( Array.isArray( key ) ) {\n\n\t\t\t\t// If key is an array of keys...\n\t\t\t\t// We always set camelCase keys, so remove that.\n\t\t\t\tkey = key.map( camelCase );\n\t\t\t} else {\n\t\t\t\tkey = camelCase( key );\n\n\t\t\t\t// If a key with the spaces exists, use it.\n\t\t\t\t// Otherwise, create an array by matching non-whitespace\n\t\t\t\tkey = key in cache ?\n\t\t\t\t\t[ key ] :\n\t\t\t\t\t( key.match( rnothtmlwhite ) || [] );\n\t\t\t}\n\n\t\t\ti = key.length;\n\n\t\t\twhile ( i-- ) {\n\t\t\t\tdelete cache[ key[ i ] ];\n\t\t\t}\n\t\t}\n\n\t\t// Remove the expando if there's no more data\n\t\tif ( key === undefined || jQuery.isEmptyObject( cache ) ) {\n\n\t\t\t// Support: Chrome <=35 - 45\n\t\t\t// Webkit & Blink performance suffers when deleting properties\n\t\t\t// from DOM nodes, so set to undefined instead\n\t\t\t// https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted)\n\t\t\tif ( owner.nodeType ) {\n\t\t\t\towner[ this.expando ] = undefined;\n\t\t\t} else {\n\t\t\t\tdelete owner[ this.expando ];\n\t\t\t}\n\t\t}\n\t},\n\thasData: function( owner ) {\n\t\tvar cache = owner[ this.expando ];\n\t\treturn cache !== undefined && !jQuery.isEmptyObject( cache );\n\t}\n};\nvar dataPriv = new Data();\n\nvar dataUser = new Data();\n\n\n\n//\tImplementation Summary\n//\n//\t1. Enforce API surface and semantic compatibility with 1.9.x branch\n//\t2. Improve the module's maintainability by reducing the storage\n//\t\tpaths to a single mechanism.\n//\t3. Use the same single mechanism to support \"private\" and \"user\" data.\n//\t4. _Never_ expose \"private\" data to user code (TODO: Drop _data, _removeData)\n//\t5. Avoid exposing implementation details on user objects (eg. expando properties)\n//\t6. Provide a clear path for implementation upgrade to WeakMap in 2014\n\nvar rbrace = /^(?:\\{[\\w\\W]*\\}|\\[[\\w\\W]*\\])$/,\n\trmultiDash = /[A-Z]/g;\n\nfunction getData( data ) {\n\tif ( data === \"true\" ) {\n\t\treturn true;\n\t}\n\n\tif ( data === \"false\" ) {\n\t\treturn false;\n\t}\n\n\tif ( data === \"null\" ) {\n\t\treturn null;\n\t}\n\n\t// Only convert to a number if it doesn't change the string\n\tif ( data === +data + \"\" ) {\n\t\treturn +data;\n\t}\n\n\tif ( rbrace.test( data ) ) {\n\t\treturn JSON.parse( data );\n\t}\n\n\treturn data;\n}\n\nfunction dataAttr( elem, key, data ) {\n\tvar name;\n\n\t// If nothing was found internally, try to fetch any\n\t// data from the HTML5 data-* attribute\n\tif ( data === undefined && elem.nodeType === 1 ) {\n\t\tname = \"data-\" + key.replace( rmultiDash, \"-$&\" ).toLowerCase();\n\t\tdata = elem.getAttribute( name );\n\n\t\tif ( typeof data === \"string\" ) {\n\t\t\ttry {\n\t\t\t\tdata = getData( data );\n\t\t\t} catch ( e ) {}\n\n\t\t\t// Make sure we set the data so it isn't changed later\n\t\t\tdataUser.set( elem, key, data );\n\t\t} else {\n\t\t\tdata = undefined;\n\t\t}\n\t}\n\treturn data;\n}\n\njQuery.extend( {\n\thasData: function( elem ) {\n\t\treturn dataUser.hasData( elem ) || dataPriv.hasData( elem );\n\t},\n\n\tdata: function( elem, name, data ) {\n\t\treturn dataUser.access( elem, name, data );\n\t},\n\n\tremoveData: function( elem, name ) {\n\t\tdataUser.remove( elem, name );\n\t},\n\n\t// TODO: Now that all calls to _data and _removeData have been replaced\n\t// with direct calls to dataPriv methods, these can be deprecated.\n\t_data: function( elem, name, data ) {\n\t\treturn dataPriv.access( elem, name, data );\n\t},\n\n\t_removeData: function( elem, name ) {\n\t\tdataPriv.remove( elem, name );\n\t}\n} );\n\njQuery.fn.extend( {\n\tdata: function( key, value ) {\n\t\tvar i, name, data,\n\t\t\telem = this[ 0 ],\n\t\t\tattrs = elem && elem.attributes;\n\n\t\t// Gets all values\n\t\tif ( key === undefined ) {\n\t\t\tif ( this.length ) {\n\t\t\t\tdata = dataUser.get( elem );\n\n\t\t\t\tif ( elem.nodeType === 1 && !dataPriv.get( elem, \"hasDataAttrs\" ) ) {\n\t\t\t\t\ti = attrs.length;\n\t\t\t\t\twhile ( i-- ) {\n\n\t\t\t\t\t\t// Support: IE 11 only\n\t\t\t\t\t\t// The attrs elements can be null (#14894)\n\t\t\t\t\t\tif ( attrs[ i ] ) {\n\t\t\t\t\t\t\tname = attrs[ i ].name;\n\t\t\t\t\t\t\tif ( name.indexOf( \"data-\" ) === 0 ) {\n\t\t\t\t\t\t\t\tname = camelCase( name.slice( 5 ) );\n\t\t\t\t\t\t\t\tdataAttr( elem, name, data[ name ] );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tdataPriv.set( elem, \"hasDataAttrs\", true );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn data;\n\t\t}\n\n\t\t// Sets multiple values\n\t\tif ( typeof key === \"object\" ) {\n\t\t\treturn this.each( function() {\n\t\t\t\tdataUser.set( this, key );\n\t\t\t} );\n\t\t}\n\n\t\treturn access( this, function( value ) {\n\t\t\tvar data;\n\n\t\t\t// The calling jQuery object (element matches) is not empty\n\t\t\t// (and therefore has an element appears at this[ 0 ]) and the\n\t\t\t// `value` parameter was not undefined. An empty jQuery object\n\t\t\t// will result in `undefined` for elem = this[ 0 ] which will\n\t\t\t// throw an exception if an attempt to read a data cache is made.\n\t\t\tif ( elem && value === undefined ) {\n\n\t\t\t\t// Attempt to get data from the cache\n\t\t\t\t// The key will always be camelCased in Data\n\t\t\t\tdata = dataUser.get( elem, key );\n\t\t\t\tif ( data !== undefined ) {\n\t\t\t\t\treturn data;\n\t\t\t\t}\n\n\t\t\t\t// Attempt to \"discover\" the data in\n\t\t\t\t// HTML5 custom data-* attrs\n\t\t\t\tdata = dataAttr( elem, key );\n\t\t\t\tif ( data !== undefined ) {\n\t\t\t\t\treturn data;\n\t\t\t\t}\n\n\t\t\t\t// We tried really hard, but the data doesn't exist.\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// Set the data...\n\t\t\tthis.each( function() {\n\n\t\t\t\t// We always store the camelCased key\n\t\t\t\tdataUser.set( this, key, value );\n\t\t\t} );\n\t\t}, null, value, arguments.length > 1, null, true );\n\t},\n\n\tremoveData: function( key ) {\n\t\treturn this.each( function() {\n\t\t\tdataUser.remove( this, key );\n\t\t} );\n\t}\n} );\n\n\njQuery.extend( {\n\tqueue: function( elem, type, data ) {\n\t\tvar queue;\n\n\t\tif ( elem ) {\n\t\t\ttype = ( type || \"fx\" ) + \"queue\";\n\t\t\tqueue = dataPriv.get( elem, type );\n\n\t\t\t// Speed up dequeue by getting out quickly if this is just a lookup\n\t\t\tif ( data ) {\n\t\t\t\tif ( !queue || Array.isArray( data ) ) {\n\t\t\t\t\tqueue = dataPriv.access( elem, type, jQuery.makeArray( data ) );\n\t\t\t\t} else {\n\t\t\t\t\tqueue.push( data );\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn queue || [];\n\t\t}\n\t},\n\n\tdequeue: function( elem, type ) {\n\t\ttype = type || \"fx\";\n\n\t\tvar queue = jQuery.queue( elem, type ),\n\t\t\tstartLength = queue.length,\n\t\t\tfn = queue.shift(),\n\t\t\thooks = jQuery._queueHooks( elem, type ),\n\t\t\tnext = function() {\n\t\t\t\tjQuery.dequeue( elem, type );\n\t\t\t};\n\n\t\t// If the fx queue is dequeued, always remove the progress sentinel\n\t\tif ( fn === \"inprogress\" ) {\n\t\t\tfn = queue.shift();\n\t\t\tstartLength--;\n\t\t}\n\n\t\tif ( fn ) {\n\n\t\t\t// Add a progress sentinel to prevent the fx queue from being\n\t\t\t// automatically dequeued\n\t\t\tif ( type === \"fx\" ) {\n\t\t\t\tqueue.unshift( \"inprogress\" );\n\t\t\t}\n\n\t\t\t// Clear up the last queue stop function\n\t\t\tdelete hooks.stop;\n\t\t\tfn.call( elem, next, hooks );\n\t\t}\n\n\t\tif ( !startLength && hooks ) {\n\t\t\thooks.empty.fire();\n\t\t}\n\t},\n\n\t// Not public - generate a queueHooks object, or return the current one\n\t_queueHooks: function( elem, type ) {\n\t\tvar key = type + \"queueHooks\";\n\t\treturn dataPriv.get( elem, key ) || dataPriv.access( elem, key, {\n\t\t\tempty: jQuery.Callbacks( \"once memory\" ).add( function() {\n\t\t\t\tdataPriv.remove( elem, [ type + \"queue\", key ] );\n\t\t\t} )\n\t\t} );\n\t}\n} );\n\njQuery.fn.extend( {\n\tqueue: function( type, data ) {\n\t\tvar setter = 2;\n\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tdata = type;\n\t\t\ttype = \"fx\";\n\t\t\tsetter--;\n\t\t}\n\n\t\tif ( arguments.length < setter ) {\n\t\t\treturn jQuery.queue( this[ 0 ], type );\n\t\t}\n\n\t\treturn data === undefined ?\n\t\t\tthis :\n\t\t\tthis.each( function() {\n\t\t\t\tvar queue = jQuery.queue( this, type, data );\n\n\t\t\t\t// Ensure a hooks for this queue\n\t\t\t\tjQuery._queueHooks( this, type );\n\n\t\t\t\tif ( type === \"fx\" && queue[ 0 ] !== \"inprogress\" ) {\n\t\t\t\t\tjQuery.dequeue( this, type );\n\t\t\t\t}\n\t\t\t} );\n\t},\n\tdequeue: function( type ) {\n\t\treturn this.each( function() {\n\t\t\tjQuery.dequeue( this, type );\n\t\t} );\n\t},\n\tclearQueue: function( type ) {\n\t\treturn this.queue( type || \"fx\", [] );\n\t},\n\n\t// Get a promise resolved when queues of a certain type\n\t// are emptied (fx is the type by default)\n\tpromise: function( type, obj ) {\n\t\tvar tmp,\n\t\t\tcount = 1,\n\t\t\tdefer = jQuery.Deferred(),\n\t\t\telements = this,\n\t\t\ti = this.length,\n\t\t\tresolve = function() {\n\t\t\t\tif ( !( --count ) ) {\n\t\t\t\t\tdefer.resolveWith( elements, [ elements ] );\n\t\t\t\t}\n\t\t\t};\n\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tobj = type;\n\t\t\ttype = undefined;\n\t\t}\n\t\ttype = type || \"fx\";\n\n\t\twhile ( i-- ) {\n\t\t\ttmp = dataPriv.get( elements[ i ], type + \"queueHooks\" );\n\t\t\tif ( tmp && tmp.empty ) {\n\t\t\t\tcount++;\n\t\t\t\ttmp.empty.add( resolve );\n\t\t\t}\n\t\t}\n\t\tresolve();\n\t\treturn defer.promise( obj );\n\t}\n} );\nvar pnum = ( /[+-]?(?:\\d*\\.|)\\d+(?:[eE][+-]?\\d+|)/ ).source;\n\nvar rcssNum = new RegExp( \"^(?:([+-])=|)(\" + pnum + \")([a-z%]*)$\", \"i\" );\n\n\nvar cssExpand = [ \"Top\", \"Right\", \"Bottom\", \"Left\" ];\n\nvar documentElement = document.documentElement;\n\n\n\n\tvar isAttached = function( elem ) {\n\t\t\treturn jQuery.contains( elem.ownerDocument, elem );\n\t\t},\n\t\tcomposed = { composed: true };\n\n\t// Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only\n\t// Check attachment across shadow DOM boundaries when possible (gh-3504)\n\t// Support: iOS 10.0-10.2 only\n\t// Early iOS 10 versions support `attachShadow` but not `getRootNode`,\n\t// leading to errors. We need to check for `getRootNode`.\n\tif ( documentElement.getRootNode ) {\n\t\tisAttached = function( elem ) {\n\t\t\treturn jQuery.contains( elem.ownerDocument, elem ) ||\n\t\t\t\telem.getRootNode( composed ) === elem.ownerDocument;\n\t\t};\n\t}\nvar isHiddenWithinTree = function( elem, el ) {\n\n\t\t// isHiddenWithinTree might be called from jQuery#filter function;\n\t\t// in that case, element will be second argument\n\t\telem = el || elem;\n\n\t\t// Inline style trumps all\n\t\treturn elem.style.display === \"none\" ||\n\t\t\telem.style.display === \"\" &&\n\n\t\t\t// Otherwise, check computed style\n\t\t\t// Support: Firefox <=43 - 45\n\t\t\t// Disconnected elements can have computed display: none, so first confirm that elem is\n\t\t\t// in the document.\n\t\t\tisAttached( elem ) &&\n\n\t\t\tjQuery.css( elem, \"display\" ) === \"none\";\n\t};\n\n\n\nfunction adjustCSS( elem, prop, valueParts, tween ) {\n\tvar adjusted, scale,\n\t\tmaxIterations = 20,\n\t\tcurrentValue = tween ?\n\t\t\tfunction() {\n\t\t\t\treturn tween.cur();\n\t\t\t} :\n\t\t\tfunction() {\n\t\t\t\treturn jQuery.css( elem, prop, \"\" );\n\t\t\t},\n\t\tinitial = currentValue(),\n\t\tunit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? \"\" : \"px\" ),\n\n\t\t// Starting value computation is required for potential unit mismatches\n\t\tinitialInUnit = elem.nodeType &&\n\t\t\t( jQuery.cssNumber[ prop ] || unit !== \"px\" && +initial ) &&\n\t\t\trcssNum.exec( jQuery.css( elem, prop ) );\n\n\tif ( initialInUnit && initialInUnit[ 3 ] !== unit ) {\n\n\t\t// Support: Firefox <=54\n\t\t// Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144)\n\t\tinitial = initial / 2;\n\n\t\t// Trust units reported by jQuery.css\n\t\tunit = unit || initialInUnit[ 3 ];\n\n\t\t// Iteratively approximate from a nonzero starting point\n\t\tinitialInUnit = +initial || 1;\n\n\t\twhile ( maxIterations-- ) {\n\n\t\t\t// Evaluate and update our best guess (doubling guesses that zero out).\n\t\t\t// Finish if the scale equals or crosses 1 (making the old*new product non-positive).\n\t\t\tjQuery.style( elem, prop, initialInUnit + unit );\n\t\t\tif ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) {\n\t\t\t\tmaxIterations = 0;\n\t\t\t}\n\t\t\tinitialInUnit = initialInUnit / scale;\n\n\t\t}\n\n\t\tinitialInUnit = initialInUnit * 2;\n\t\tjQuery.style( elem, prop, initialInUnit + unit );\n\n\t\t// Make sure we update the tween properties later on\n\t\tvalueParts = valueParts || [];\n\t}\n\n\tif ( valueParts ) {\n\t\tinitialInUnit = +initialInUnit || +initial || 0;\n\n\t\t// Apply relative offset (+=/-=) if specified\n\t\tadjusted = valueParts[ 1 ] ?\n\t\t\tinitialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] :\n\t\t\t+valueParts[ 2 ];\n\t\tif ( tween ) {\n\t\t\ttween.unit = unit;\n\t\t\ttween.start = initialInUnit;\n\t\t\ttween.end = adjusted;\n\t\t}\n\t}\n\treturn adjusted;\n}\n\n\nvar defaultDisplayMap = {};\n\nfunction getDefaultDisplay( elem ) {\n\tvar temp,\n\t\tdoc = elem.ownerDocument,\n\t\tnodeName = elem.nodeName,\n\t\tdisplay = defaultDisplayMap[ nodeName ];\n\n\tif ( display ) {\n\t\treturn display;\n\t}\n\n\ttemp = doc.body.appendChild( doc.createElement( nodeName ) );\n\tdisplay = jQuery.css( temp, \"display\" );\n\n\ttemp.parentNode.removeChild( temp );\n\n\tif ( display === \"none\" ) {\n\t\tdisplay = \"block\";\n\t}\n\tdefaultDisplayMap[ nodeName ] = display;\n\n\treturn display;\n}\n\nfunction showHide( elements, show ) {\n\tvar display, elem,\n\t\tvalues = [],\n\t\tindex = 0,\n\t\tlength = elements.length;\n\n\t// Determine new display value for elements that need to change\n\tfor ( ; index < length; index++ ) {\n\t\telem = elements[ index ];\n\t\tif ( !elem.style ) {\n\t\t\tcontinue;\n\t\t}\n\n\t\tdisplay = elem.style.display;\n\t\tif ( show ) {\n\n\t\t\t// Since we force visibility upon cascade-hidden elements, an immediate (and slow)\n\t\t\t// check is required in this first loop unless we have a nonempty display value (either\n\t\t\t// inline or about-to-be-restored)\n\t\t\tif ( display === \"none\" ) {\n\t\t\t\tvalues[ index ] = dataPriv.get( elem, \"display\" ) || null;\n\t\t\t\tif ( !values[ index ] ) {\n\t\t\t\t\telem.style.display = \"\";\n\t\t\t\t}\n\t\t\t}\n\t\t\tif ( elem.style.display === \"\" && isHiddenWithinTree( elem ) ) {\n\t\t\t\tvalues[ index ] = getDefaultDisplay( elem );\n\t\t\t}\n\t\t} else {\n\t\t\tif ( display !== \"none\" ) {\n\t\t\t\tvalues[ index ] = \"none\";\n\n\t\t\t\t// Remember what we're overwriting\n\t\t\t\tdataPriv.set( elem, \"display\", display );\n\t\t\t}\n\t\t}\n\t}\n\n\t// Set the display of the elements in a second loop to avoid constant reflow\n\tfor ( index = 0; index < length; index++ ) {\n\t\tif ( values[ index ] != null ) {\n\t\t\telements[ index ].style.display = values[ index ];\n\t\t}\n\t}\n\n\treturn elements;\n}\n\njQuery.fn.extend( {\n\tshow: function() {\n\t\treturn showHide( this, true );\n\t},\n\thide: function() {\n\t\treturn showHide( this );\n\t},\n\ttoggle: function( state ) {\n\t\tif ( typeof state === \"boolean\" ) {\n\t\t\treturn state ? this.show() : this.hide();\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tif ( isHiddenWithinTree( this ) ) {\n\t\t\t\tjQuery( this ).show();\n\t\t\t} else {\n\t\t\t\tjQuery( this ).hide();\n\t\t\t}\n\t\t} );\n\t}\n} );\nvar rcheckableType = ( /^(?:checkbox|radio)$/i );\n\nvar rtagName = ( /<([a-z][^\\/\\0>\\x20\\t\\r\\n\\f]*)/i );\n\nvar rscriptType = ( /^$|^module$|\\/(?:java|ecma)script/i );\n\n\n\n( function() {\n\tvar fragment = document.createDocumentFragment(),\n\t\tdiv = fragment.appendChild( document.createElement( \"div\" ) ),\n\t\tinput = document.createElement( \"input\" );\n\n\t// Support: Android 4.0 - 4.3 only\n\t// Check state lost if the name is set (#11217)\n\t// Support: Windows Web Apps (WWA)\n\t// `name` and `type` must use .setAttribute for WWA (#14901)\n\tinput.setAttribute( \"type\", \"radio\" );\n\tinput.setAttribute( \"checked\", \"checked\" );\n\tinput.setAttribute( \"name\", \"t\" );\n\n\tdiv.appendChild( input );\n\n\t// Support: Android <=4.1 only\n\t// Older WebKit doesn't clone checked state correctly in fragments\n\tsupport.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked;\n\n\t// Support: IE <=11 only\n\t// Make sure textarea (and checkbox) defaultValue is properly cloned\n\tdiv.innerHTML = \"\";\n\tsupport.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue;\n\n\t// Support: IE <=9 only\n\t// IE <=9 replaces \";\n\tsupport.option = !!div.lastChild;\n} )();\n\n\n// We have to close these tags to support XHTML (#13200)\nvar wrapMap = {\n\n\t// XHTML parsers do not magically insert elements in the\n\t// same way that tag soup parsers do. So we cannot shorten\n\t// this by omitting or other required elements.\n\tthead: [ 1, \"\", \"
\" ],\n\tcol: [ 2, \"\", \"
\" ],\n\ttr: [ 2, \"\", \"
\" ],\n\ttd: [ 3, \"\", \"
\" ],\n\n\t_default: [ 0, \"\", \"\" ]\n};\n\nwrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;\nwrapMap.th = wrapMap.td;\n\n// Support: IE <=9 only\nif ( !support.option ) {\n\twrapMap.optgroup = wrapMap.option = [ 1, \"\" ];\n}\n\n\nfunction getAll( context, tag ) {\n\n\t// Support: IE <=9 - 11 only\n\t// Use typeof to avoid zero-argument method invocation on host objects (#15151)\n\tvar ret;\n\n\tif ( typeof context.getElementsByTagName !== \"undefined\" ) {\n\t\tret = context.getElementsByTagName( tag || \"*\" );\n\n\t} else if ( typeof context.querySelectorAll !== \"undefined\" ) {\n\t\tret = context.querySelectorAll( tag || \"*\" );\n\n\t} else {\n\t\tret = [];\n\t}\n\n\tif ( tag === undefined || tag && nodeName( context, tag ) ) {\n\t\treturn jQuery.merge( [ context ], ret );\n\t}\n\n\treturn ret;\n}\n\n\n// Mark scripts as having already been evaluated\nfunction setGlobalEval( elems, refElements ) {\n\tvar i = 0,\n\t\tl = elems.length;\n\n\tfor ( ; i < l; i++ ) {\n\t\tdataPriv.set(\n\t\t\telems[ i ],\n\t\t\t\"globalEval\",\n\t\t\t!refElements || dataPriv.get( refElements[ i ], \"globalEval\" )\n\t\t);\n\t}\n}\n\n\nvar rhtml = /<|&#?\\w+;/;\n\nfunction buildFragment( elems, context, scripts, selection, ignored ) {\n\tvar elem, tmp, tag, wrap, attached, j,\n\t\tfragment = context.createDocumentFragment(),\n\t\tnodes = [],\n\t\ti = 0,\n\t\tl = elems.length;\n\n\tfor ( ; i < l; i++ ) {\n\t\telem = elems[ i ];\n\n\t\tif ( elem || elem === 0 ) {\n\n\t\t\t// Add nodes directly\n\t\t\tif ( toType( elem ) === \"object\" ) {\n\n\t\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t\t// push.apply(_, arraylike) throws on ancient WebKit\n\t\t\t\tjQuery.merge( nodes, elem.nodeType ? [ elem ] : elem );\n\n\t\t\t// Convert non-html into a text node\n\t\t\t} else if ( !rhtml.test( elem ) ) {\n\t\t\t\tnodes.push( context.createTextNode( elem ) );\n\n\t\t\t// Convert html into DOM nodes\n\t\t\t} else {\n\t\t\t\ttmp = tmp || fragment.appendChild( context.createElement( \"div\" ) );\n\n\t\t\t\t// Deserialize a standard representation\n\t\t\t\ttag = ( rtagName.exec( elem ) || [ \"\", \"\" ] )[ 1 ].toLowerCase();\n\t\t\t\twrap = wrapMap[ tag ] || wrapMap._default;\n\t\t\t\ttmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ];\n\n\t\t\t\t// Descend through wrappers to the right content\n\t\t\t\tj = wrap[ 0 ];\n\t\t\t\twhile ( j-- ) {\n\t\t\t\t\ttmp = tmp.lastChild;\n\t\t\t\t}\n\n\t\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t\t// push.apply(_, arraylike) throws on ancient WebKit\n\t\t\t\tjQuery.merge( nodes, tmp.childNodes );\n\n\t\t\t\t// Remember the top-level container\n\t\t\t\ttmp = fragment.firstChild;\n\n\t\t\t\t// Ensure the created nodes are orphaned (#12392)\n\t\t\t\ttmp.textContent = \"\";\n\t\t\t}\n\t\t}\n\t}\n\n\t// Remove wrapper from fragment\n\tfragment.textContent = \"\";\n\n\ti = 0;\n\twhile ( ( elem = nodes[ i++ ] ) ) {\n\n\t\t// Skip elements already in the context collection (trac-4087)\n\t\tif ( selection && jQuery.inArray( elem, selection ) > -1 ) {\n\t\t\tif ( ignored ) {\n\t\t\t\tignored.push( elem );\n\t\t\t}\n\t\t\tcontinue;\n\t\t}\n\n\t\tattached = isAttached( elem );\n\n\t\t// Append to fragment\n\t\ttmp = getAll( fragment.appendChild( elem ), \"script\" );\n\n\t\t// Preserve script evaluation history\n\t\tif ( attached ) {\n\t\t\tsetGlobalEval( tmp );\n\t\t}\n\n\t\t// Capture executables\n\t\tif ( scripts ) {\n\t\t\tj = 0;\n\t\t\twhile ( ( elem = tmp[ j++ ] ) ) {\n\t\t\t\tif ( rscriptType.test( elem.type || \"\" ) ) {\n\t\t\t\t\tscripts.push( elem );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn fragment;\n}\n\n\nvar\n\trkeyEvent = /^key/,\n\trmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/,\n\trtypenamespace = /^([^.]*)(?:\\.(.+)|)/;\n\nfunction returnTrue() {\n\treturn true;\n}\n\nfunction returnFalse() {\n\treturn false;\n}\n\n// Support: IE <=9 - 11+\n// focus() and blur() are asynchronous, except when they are no-op.\n// So expect focus to be synchronous when the element is already active,\n// and blur to be synchronous when the element is not already active.\n// (focus and blur are always synchronous in other supported browsers,\n// this just defines when we can count on it).\nfunction expectSync( elem, type ) {\n\treturn ( elem === safeActiveElement() ) === ( type === \"focus\" );\n}\n\n// Support: IE <=9 only\n// Accessing document.activeElement can throw unexpectedly\n// https://bugs.jquery.com/ticket/13393\nfunction safeActiveElement() {\n\ttry {\n\t\treturn document.activeElement;\n\t} catch ( err ) { }\n}\n\nfunction on( elem, types, selector, data, fn, one ) {\n\tvar origFn, type;\n\n\t// Types can be a map of types/handlers\n\tif ( typeof types === \"object\" ) {\n\n\t\t// ( types-Object, selector, data )\n\t\tif ( typeof selector !== \"string\" ) {\n\n\t\t\t// ( types-Object, data )\n\t\t\tdata = data || selector;\n\t\t\tselector = undefined;\n\t\t}\n\t\tfor ( type in types ) {\n\t\t\ton( elem, type, selector, data, types[ type ], one );\n\t\t}\n\t\treturn elem;\n\t}\n\n\tif ( data == null && fn == null ) {\n\n\t\t// ( types, fn )\n\t\tfn = selector;\n\t\tdata = selector = undefined;\n\t} else if ( fn == null ) {\n\t\tif ( typeof selector === \"string\" ) {\n\n\t\t\t// ( types, selector, fn )\n\t\t\tfn = data;\n\t\t\tdata = undefined;\n\t\t} else {\n\n\t\t\t// ( types, data, fn )\n\t\t\tfn = data;\n\t\t\tdata = selector;\n\t\t\tselector = undefined;\n\t\t}\n\t}\n\tif ( fn === false ) {\n\t\tfn = returnFalse;\n\t} else if ( !fn ) {\n\t\treturn elem;\n\t}\n\n\tif ( one === 1 ) {\n\t\torigFn = fn;\n\t\tfn = function( event ) {\n\n\t\t\t// Can use an empty set, since event contains the info\n\t\t\tjQuery().off( event );\n\t\t\treturn origFn.apply( this, arguments );\n\t\t};\n\n\t\t// Use same guid so caller can remove using origFn\n\t\tfn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );\n\t}\n\treturn elem.each( function() {\n\t\tjQuery.event.add( this, types, fn, data, selector );\n\t} );\n}\n\n/*\n * Helper functions for managing events -- not part of the public interface.\n * Props to Dean Edwards' addEvent library for many of the ideas.\n */\njQuery.event = {\n\n\tglobal: {},\n\n\tadd: function( elem, types, handler, data, selector ) {\n\n\t\tvar handleObjIn, eventHandle, tmp,\n\t\t\tevents, t, handleObj,\n\t\t\tspecial, handlers, type, namespaces, origType,\n\t\t\telemData = dataPriv.get( elem );\n\n\t\t// Only attach events to objects that accept data\n\t\tif ( !acceptData( elem ) ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Caller can pass in an object of custom data in lieu of the handler\n\t\tif ( handler.handler ) {\n\t\t\thandleObjIn = handler;\n\t\t\thandler = handleObjIn.handler;\n\t\t\tselector = handleObjIn.selector;\n\t\t}\n\n\t\t// Ensure that invalid selectors throw exceptions at attach time\n\t\t// Evaluate against documentElement in case elem is a non-element node (e.g., document)\n\t\tif ( selector ) {\n\t\t\tjQuery.find.matchesSelector( documentElement, selector );\n\t\t}\n\n\t\t// Make sure that the handler has a unique ID, used to find/remove it later\n\t\tif ( !handler.guid ) {\n\t\t\thandler.guid = jQuery.guid++;\n\t\t}\n\n\t\t// Init the element's event structure and main handler, if this is the first\n\t\tif ( !( events = elemData.events ) ) {\n\t\t\tevents = elemData.events = Object.create( null );\n\t\t}\n\t\tif ( !( eventHandle = elemData.handle ) ) {\n\t\t\teventHandle = elemData.handle = function( e ) {\n\n\t\t\t\t// Discard the second event of a jQuery.event.trigger() and\n\t\t\t\t// when an event is called after a page has unloaded\n\t\t\t\treturn typeof jQuery !== \"undefined\" && jQuery.event.triggered !== e.type ?\n\t\t\t\t\tjQuery.event.dispatch.apply( elem, arguments ) : undefined;\n\t\t\t};\n\t\t}\n\n\t\t// Handle multiple events separated by a space\n\t\ttypes = ( types || \"\" ).match( rnothtmlwhite ) || [ \"\" ];\n\t\tt = types.length;\n\t\twhile ( t-- ) {\n\t\t\ttmp = rtypenamespace.exec( types[ t ] ) || [];\n\t\t\ttype = origType = tmp[ 1 ];\n\t\t\tnamespaces = ( tmp[ 2 ] || \"\" ).split( \".\" ).sort();\n\n\t\t\t// There *must* be a type, no attaching namespace-only handlers\n\t\t\tif ( !type ) {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\t// If event changes its type, use the special event handlers for the changed type\n\t\t\tspecial = jQuery.event.special[ type ] || {};\n\n\t\t\t// If selector defined, determine special event api type, otherwise given type\n\t\t\ttype = ( selector ? special.delegateType : special.bindType ) || type;\n\n\t\t\t// Update special based on newly reset type\n\t\t\tspecial = jQuery.event.special[ type ] || {};\n\n\t\t\t// handleObj is passed to all event handlers\n\t\t\thandleObj = jQuery.extend( {\n\t\t\t\ttype: type,\n\t\t\t\torigType: origType,\n\t\t\t\tdata: data,\n\t\t\t\thandler: handler,\n\t\t\t\tguid: handler.guid,\n\t\t\t\tselector: selector,\n\t\t\t\tneedsContext: selector && jQuery.expr.match.needsContext.test( selector ),\n\t\t\t\tnamespace: namespaces.join( \".\" )\n\t\t\t}, handleObjIn );\n\n\t\t\t// Init the event handler queue if we're the first\n\t\t\tif ( !( handlers = events[ type ] ) ) {\n\t\t\t\thandlers = events[ type ] = [];\n\t\t\t\thandlers.delegateCount = 0;\n\n\t\t\t\t// Only use addEventListener if the special events handler returns false\n\t\t\t\tif ( !special.setup ||\n\t\t\t\t\tspecial.setup.call( elem, data, namespaces, eventHandle ) === false ) {\n\n\t\t\t\t\tif ( elem.addEventListener ) {\n\t\t\t\t\t\telem.addEventListener( type, eventHandle );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( special.add ) {\n\t\t\t\tspecial.add.call( elem, handleObj );\n\n\t\t\t\tif ( !handleObj.handler.guid ) {\n\t\t\t\t\thandleObj.handler.guid = handler.guid;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Add to the element's handler list, delegates in front\n\t\t\tif ( selector ) {\n\t\t\t\thandlers.splice( handlers.delegateCount++, 0, handleObj );\n\t\t\t} else {\n\t\t\t\thandlers.push( handleObj );\n\t\t\t}\n\n\t\t\t// Keep track of which events have ever been used, for event optimization\n\t\t\tjQuery.event.global[ type ] = true;\n\t\t}\n\n\t},\n\n\t// Detach an event or set of events from an element\n\tremove: function( elem, types, handler, selector, mappedTypes ) {\n\n\t\tvar j, origCount, tmp,\n\t\t\tevents, t, handleObj,\n\t\t\tspecial, handlers, type, namespaces, origType,\n\t\t\telemData = dataPriv.hasData( elem ) && dataPriv.get( elem );\n\n\t\tif ( !elemData || !( events = elemData.events ) ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Once for each type.namespace in types; type may be omitted\n\t\ttypes = ( types || \"\" ).match( rnothtmlwhite ) || [ \"\" ];\n\t\tt = types.length;\n\t\twhile ( t-- ) {\n\t\t\ttmp = rtypenamespace.exec( types[ t ] ) || [];\n\t\t\ttype = origType = tmp[ 1 ];\n\t\t\tnamespaces = ( tmp[ 2 ] || \"\" ).split( \".\" ).sort();\n\n\t\t\t// Unbind all events (on this namespace, if provided) for the element\n\t\t\tif ( !type ) {\n\t\t\t\tfor ( type in events ) {\n\t\t\t\t\tjQuery.event.remove( elem, type + types[ t ], handler, selector, true );\n\t\t\t\t}\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tspecial = jQuery.event.special[ type ] || {};\n\t\t\ttype = ( selector ? special.delegateType : special.bindType ) || type;\n\t\t\thandlers = events[ type ] || [];\n\t\t\ttmp = tmp[ 2 ] &&\n\t\t\t\tnew RegExp( \"(^|\\\\.)\" + namespaces.join( \"\\\\.(?:.*\\\\.|)\" ) + \"(\\\\.|$)\" );\n\n\t\t\t// Remove matching events\n\t\t\torigCount = j = handlers.length;\n\t\t\twhile ( j-- ) {\n\t\t\t\thandleObj = handlers[ j ];\n\n\t\t\t\tif ( ( mappedTypes || origType === handleObj.origType ) &&\n\t\t\t\t\t( !handler || handler.guid === handleObj.guid ) &&\n\t\t\t\t\t( !tmp || tmp.test( handleObj.namespace ) ) &&\n\t\t\t\t\t( !selector || selector === handleObj.selector ||\n\t\t\t\t\t\tselector === \"**\" && handleObj.selector ) ) {\n\t\t\t\t\thandlers.splice( j, 1 );\n\n\t\t\t\t\tif ( handleObj.selector ) {\n\t\t\t\t\t\thandlers.delegateCount--;\n\t\t\t\t\t}\n\t\t\t\t\tif ( special.remove ) {\n\t\t\t\t\t\tspecial.remove.call( elem, handleObj );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Remove generic event handler if we removed something and no more handlers exist\n\t\t\t// (avoids potential for endless recursion during removal of special event handlers)\n\t\t\tif ( origCount && !handlers.length ) {\n\t\t\t\tif ( !special.teardown ||\n\t\t\t\t\tspecial.teardown.call( elem, namespaces, elemData.handle ) === false ) {\n\n\t\t\t\t\tjQuery.removeEvent( elem, type, elemData.handle );\n\t\t\t\t}\n\n\t\t\t\tdelete events[ type ];\n\t\t\t}\n\t\t}\n\n\t\t// Remove data and the expando if it's no longer used\n\t\tif ( jQuery.isEmptyObject( events ) ) {\n\t\t\tdataPriv.remove( elem, \"handle events\" );\n\t\t}\n\t},\n\n\tdispatch: function( nativeEvent ) {\n\n\t\tvar i, j, ret, matched, handleObj, handlerQueue,\n\t\t\targs = new Array( arguments.length ),\n\n\t\t\t// Make a writable jQuery.Event from the native event object\n\t\t\tevent = jQuery.event.fix( nativeEvent ),\n\n\t\t\thandlers = (\n\t\t\t\t\tdataPriv.get( this, \"events\" ) || Object.create( null )\n\t\t\t\t)[ event.type ] || [],\n\t\t\tspecial = jQuery.event.special[ event.type ] || {};\n\n\t\t// Use the fix-ed jQuery.Event rather than the (read-only) native event\n\t\targs[ 0 ] = event;\n\n\t\tfor ( i = 1; i < arguments.length; i++ ) {\n\t\t\targs[ i ] = arguments[ i ];\n\t\t}\n\n\t\tevent.delegateTarget = this;\n\n\t\t// Call the preDispatch hook for the mapped type, and let it bail if desired\n\t\tif ( special.preDispatch && special.preDispatch.call( this, event ) === false ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Determine handlers\n\t\thandlerQueue = jQuery.event.handlers.call( this, event, handlers );\n\n\t\t// Run delegates first; they may want to stop propagation beneath us\n\t\ti = 0;\n\t\twhile ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) {\n\t\t\tevent.currentTarget = matched.elem;\n\n\t\t\tj = 0;\n\t\t\twhile ( ( handleObj = matched.handlers[ j++ ] ) &&\n\t\t\t\t!event.isImmediatePropagationStopped() ) {\n\n\t\t\t\t// If the event is namespaced, then each handler is only invoked if it is\n\t\t\t\t// specially universal or its namespaces are a superset of the event's.\n\t\t\t\tif ( !event.rnamespace || handleObj.namespace === false ||\n\t\t\t\t\tevent.rnamespace.test( handleObj.namespace ) ) {\n\n\t\t\t\t\tevent.handleObj = handleObj;\n\t\t\t\t\tevent.data = handleObj.data;\n\n\t\t\t\t\tret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle ||\n\t\t\t\t\t\thandleObj.handler ).apply( matched.elem, args );\n\n\t\t\t\t\tif ( ret !== undefined ) {\n\t\t\t\t\t\tif ( ( event.result = ret ) === false ) {\n\t\t\t\t\t\t\tevent.preventDefault();\n\t\t\t\t\t\t\tevent.stopPropagation();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Call the postDispatch hook for the mapped type\n\t\tif ( special.postDispatch ) {\n\t\t\tspecial.postDispatch.call( this, event );\n\t\t}\n\n\t\treturn event.result;\n\t},\n\n\thandlers: function( event, handlers ) {\n\t\tvar i, handleObj, sel, matchedHandlers, matchedSelectors,\n\t\t\thandlerQueue = [],\n\t\t\tdelegateCount = handlers.delegateCount,\n\t\t\tcur = event.target;\n\n\t\t// Find delegate handlers\n\t\tif ( delegateCount &&\n\n\t\t\t// Support: IE <=9\n\t\t\t// Black-hole SVG instance trees (trac-13180)\n\t\t\tcur.nodeType &&\n\n\t\t\t// Support: Firefox <=42\n\t\t\t// Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861)\n\t\t\t// https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click\n\t\t\t// Support: IE 11 only\n\t\t\t// ...but not arrow key \"clicks\" of radio inputs, which can have `button` -1 (gh-2343)\n\t\t\t!( event.type === \"click\" && event.button >= 1 ) ) {\n\n\t\t\tfor ( ; cur !== this; cur = cur.parentNode || this ) {\n\n\t\t\t\t// Don't check non-elements (#13208)\n\t\t\t\t// Don't process clicks on disabled elements (#6911, #8165, #11382, #11764)\n\t\t\t\tif ( cur.nodeType === 1 && !( event.type === \"click\" && cur.disabled === true ) ) {\n\t\t\t\t\tmatchedHandlers = [];\n\t\t\t\t\tmatchedSelectors = {};\n\t\t\t\t\tfor ( i = 0; i < delegateCount; i++ ) {\n\t\t\t\t\t\thandleObj = handlers[ i ];\n\n\t\t\t\t\t\t// Don't conflict with Object.prototype properties (#13203)\n\t\t\t\t\t\tsel = handleObj.selector + \" \";\n\n\t\t\t\t\t\tif ( matchedSelectors[ sel ] === undefined ) {\n\t\t\t\t\t\t\tmatchedSelectors[ sel ] = handleObj.needsContext ?\n\t\t\t\t\t\t\t\tjQuery( sel, this ).index( cur ) > -1 :\n\t\t\t\t\t\t\t\tjQuery.find( sel, this, null, [ cur ] ).length;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif ( matchedSelectors[ sel ] ) {\n\t\t\t\t\t\t\tmatchedHandlers.push( handleObj );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif ( matchedHandlers.length ) {\n\t\t\t\t\t\thandlerQueue.push( { elem: cur, handlers: matchedHandlers } );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Add the remaining (directly-bound) handlers\n\t\tcur = this;\n\t\tif ( delegateCount < handlers.length ) {\n\t\t\thandlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } );\n\t\t}\n\n\t\treturn handlerQueue;\n\t},\n\n\taddProp: function( name, hook ) {\n\t\tObject.defineProperty( jQuery.Event.prototype, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: true,\n\n\t\t\tget: isFunction( hook ) ?\n\t\t\t\tfunction() {\n\t\t\t\t\tif ( this.originalEvent ) {\n\t\t\t\t\t\t\treturn hook( this.originalEvent );\n\t\t\t\t\t}\n\t\t\t\t} :\n\t\t\t\tfunction() {\n\t\t\t\t\tif ( this.originalEvent ) {\n\t\t\t\t\t\t\treturn this.originalEvent[ name ];\n\t\t\t\t\t}\n\t\t\t\t},\n\n\t\t\tset: function( value ) {\n\t\t\t\tObject.defineProperty( this, name, {\n\t\t\t\t\tenumerable: true,\n\t\t\t\t\tconfigurable: true,\n\t\t\t\t\twritable: true,\n\t\t\t\t\tvalue: value\n\t\t\t\t} );\n\t\t\t}\n\t\t} );\n\t},\n\n\tfix: function( originalEvent ) {\n\t\treturn originalEvent[ jQuery.expando ] ?\n\t\t\toriginalEvent :\n\t\t\tnew jQuery.Event( originalEvent );\n\t},\n\n\tspecial: {\n\t\tload: {\n\n\t\t\t// Prevent triggered image.load events from bubbling to window.load\n\t\t\tnoBubble: true\n\t\t},\n\t\tclick: {\n\n\t\t\t// Utilize native event to ensure correct state for checkable inputs\n\t\t\tsetup: function( data ) {\n\n\t\t\t\t// For mutual compressibility with _default, replace `this` access with a local var.\n\t\t\t\t// `|| data` is dead code meant only to preserve the variable through minification.\n\t\t\t\tvar el = this || data;\n\n\t\t\t\t// Claim the first handler\n\t\t\t\tif ( rcheckableType.test( el.type ) &&\n\t\t\t\t\tel.click && nodeName( el, \"input\" ) ) {\n\n\t\t\t\t\t// dataPriv.set( el, \"click\", ... )\n\t\t\t\t\tleverageNative( el, \"click\", returnTrue );\n\t\t\t\t}\n\n\t\t\t\t// Return false to allow normal processing in the caller\n\t\t\t\treturn false;\n\t\t\t},\n\t\t\ttrigger: function( data ) {\n\n\t\t\t\t// For mutual compressibility with _default, replace `this` access with a local var.\n\t\t\t\t// `|| data` is dead code meant only to preserve the variable through minification.\n\t\t\t\tvar el = this || data;\n\n\t\t\t\t// Force setup before triggering a click\n\t\t\t\tif ( rcheckableType.test( el.type ) &&\n\t\t\t\t\tel.click && nodeName( el, \"input\" ) ) {\n\n\t\t\t\t\tleverageNative( el, \"click\" );\n\t\t\t\t}\n\n\t\t\t\t// Return non-false to allow normal event-path propagation\n\t\t\t\treturn true;\n\t\t\t},\n\n\t\t\t// For cross-browser consistency, suppress native .click() on links\n\t\t\t// Also prevent it if we're currently inside a leveraged native-event stack\n\t\t\t_default: function( event ) {\n\t\t\t\tvar target = event.target;\n\t\t\t\treturn rcheckableType.test( target.type ) &&\n\t\t\t\t\ttarget.click && nodeName( target, \"input\" ) &&\n\t\t\t\t\tdataPriv.get( target, \"click\" ) ||\n\t\t\t\t\tnodeName( target, \"a\" );\n\t\t\t}\n\t\t},\n\n\t\tbeforeunload: {\n\t\t\tpostDispatch: function( event ) {\n\n\t\t\t\t// Support: Firefox 20+\n\t\t\t\t// Firefox doesn't alert if the returnValue field is not set.\n\t\t\t\tif ( event.result !== undefined && event.originalEvent ) {\n\t\t\t\t\tevent.originalEvent.returnValue = event.result;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n};\n\n// Ensure the presence of an event listener that handles manually-triggered\n// synthetic events by interrupting progress until reinvoked in response to\n// *native* events that it fires directly, ensuring that state changes have\n// already occurred before other listeners are invoked.\nfunction leverageNative( el, type, expectSync ) {\n\n\t// Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add\n\tif ( !expectSync ) {\n\t\tif ( dataPriv.get( el, type ) === undefined ) {\n\t\t\tjQuery.event.add( el, type, returnTrue );\n\t\t}\n\t\treturn;\n\t}\n\n\t// Register the controller as a special universal handler for all event namespaces\n\tdataPriv.set( el, type, false );\n\tjQuery.event.add( el, type, {\n\t\tnamespace: false,\n\t\thandler: function( event ) {\n\t\t\tvar notAsync, result,\n\t\t\t\tsaved = dataPriv.get( this, type );\n\n\t\t\tif ( ( event.isTrigger & 1 ) && this[ type ] ) {\n\n\t\t\t\t// Interrupt processing of the outer synthetic .trigger()ed event\n\t\t\t\t// Saved data should be false in such cases, but might be a leftover capture object\n\t\t\t\t// from an async native handler (gh-4350)\n\t\t\t\tif ( !saved.length ) {\n\n\t\t\t\t\t// Store arguments for use when handling the inner native event\n\t\t\t\t\t// There will always be at least one argument (an event object), so this array\n\t\t\t\t\t// will not be confused with a leftover capture object.\n\t\t\t\t\tsaved = slice.call( arguments );\n\t\t\t\t\tdataPriv.set( this, type, saved );\n\n\t\t\t\t\t// Trigger the native event and capture its result\n\t\t\t\t\t// Support: IE <=9 - 11+\n\t\t\t\t\t// focus() and blur() are asynchronous\n\t\t\t\t\tnotAsync = expectSync( this, type );\n\t\t\t\t\tthis[ type ]();\n\t\t\t\t\tresult = dataPriv.get( this, type );\n\t\t\t\t\tif ( saved !== result || notAsync ) {\n\t\t\t\t\t\tdataPriv.set( this, type, false );\n\t\t\t\t\t} else {\n\t\t\t\t\t\tresult = {};\n\t\t\t\t\t}\n\t\t\t\t\tif ( saved !== result ) {\n\n\t\t\t\t\t\t// Cancel the outer synthetic event\n\t\t\t\t\t\tevent.stopImmediatePropagation();\n\t\t\t\t\t\tevent.preventDefault();\n\t\t\t\t\t\treturn result.value;\n\t\t\t\t\t}\n\n\t\t\t\t// If this is an inner synthetic event for an event with a bubbling surrogate\n\t\t\t\t// (focus or blur), assume that the surrogate already propagated from triggering the\n\t\t\t\t// native event and prevent that from happening again here.\n\t\t\t\t// This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the\n\t\t\t\t// bubbling surrogate propagates *after* the non-bubbling base), but that seems\n\t\t\t\t// less bad than duplication.\n\t\t\t\t} else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) {\n\t\t\t\t\tevent.stopPropagation();\n\t\t\t\t}\n\n\t\t\t// If this is a native event triggered above, everything is now in order\n\t\t\t// Fire an inner synthetic event with the original arguments\n\t\t\t} else if ( saved.length ) {\n\n\t\t\t\t// ...and capture the result\n\t\t\t\tdataPriv.set( this, type, {\n\t\t\t\t\tvalue: jQuery.event.trigger(\n\n\t\t\t\t\t\t// Support: IE <=9 - 11+\n\t\t\t\t\t\t// Extend with the prototype to reset the above stopImmediatePropagation()\n\t\t\t\t\t\tjQuery.extend( saved[ 0 ], jQuery.Event.prototype ),\n\t\t\t\t\t\tsaved.slice( 1 ),\n\t\t\t\t\t\tthis\n\t\t\t\t\t)\n\t\t\t\t} );\n\n\t\t\t\t// Abort handling of the native event\n\t\t\t\tevent.stopImmediatePropagation();\n\t\t\t}\n\t\t}\n\t} );\n}\n\njQuery.removeEvent = function( elem, type, handle ) {\n\n\t// This \"if\" is needed for plain objects\n\tif ( elem.removeEventListener ) {\n\t\telem.removeEventListener( type, handle );\n\t}\n};\n\njQuery.Event = function( src, props ) {\n\n\t// Allow instantiation without the 'new' keyword\n\tif ( !( this instanceof jQuery.Event ) ) {\n\t\treturn new jQuery.Event( src, props );\n\t}\n\n\t// Event object\n\tif ( src && src.type ) {\n\t\tthis.originalEvent = src;\n\t\tthis.type = src.type;\n\n\t\t// Events bubbling up the document may have been marked as prevented\n\t\t// by a handler lower down the tree; reflect the correct value.\n\t\tthis.isDefaultPrevented = src.defaultPrevented ||\n\t\t\t\tsrc.defaultPrevented === undefined &&\n\n\t\t\t\t// Support: Android <=2.3 only\n\t\t\t\tsrc.returnValue === false ?\n\t\t\treturnTrue :\n\t\t\treturnFalse;\n\n\t\t// Create target properties\n\t\t// Support: Safari <=6 - 7 only\n\t\t// Target should not be a text node (#504, #13143)\n\t\tthis.target = ( src.target && src.target.nodeType === 3 ) ?\n\t\t\tsrc.target.parentNode :\n\t\t\tsrc.target;\n\n\t\tthis.currentTarget = src.currentTarget;\n\t\tthis.relatedTarget = src.relatedTarget;\n\n\t// Event type\n\t} else {\n\t\tthis.type = src;\n\t}\n\n\t// Put explicitly provided properties onto the event object\n\tif ( props ) {\n\t\tjQuery.extend( this, props );\n\t}\n\n\t// Create a timestamp if incoming event doesn't have one\n\tthis.timeStamp = src && src.timeStamp || Date.now();\n\n\t// Mark it as fixed\n\tthis[ jQuery.expando ] = true;\n};\n\n// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding\n// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html\njQuery.Event.prototype = {\n\tconstructor: jQuery.Event,\n\tisDefaultPrevented: returnFalse,\n\tisPropagationStopped: returnFalse,\n\tisImmediatePropagationStopped: returnFalse,\n\tisSimulated: false,\n\n\tpreventDefault: function() {\n\t\tvar e = this.originalEvent;\n\n\t\tthis.isDefaultPrevented = returnTrue;\n\n\t\tif ( e && !this.isSimulated ) {\n\t\t\te.preventDefault();\n\t\t}\n\t},\n\tstopPropagation: function() {\n\t\tvar e = this.originalEvent;\n\n\t\tthis.isPropagationStopped = returnTrue;\n\n\t\tif ( e && !this.isSimulated ) {\n\t\t\te.stopPropagation();\n\t\t}\n\t},\n\tstopImmediatePropagation: function() {\n\t\tvar e = this.originalEvent;\n\n\t\tthis.isImmediatePropagationStopped = returnTrue;\n\n\t\tif ( e && !this.isSimulated ) {\n\t\t\te.stopImmediatePropagation();\n\t\t}\n\n\t\tthis.stopPropagation();\n\t}\n};\n\n// Includes all common event props including KeyEvent and MouseEvent specific props\njQuery.each( {\n\taltKey: true,\n\tbubbles: true,\n\tcancelable: true,\n\tchangedTouches: true,\n\tctrlKey: true,\n\tdetail: true,\n\teventPhase: true,\n\tmetaKey: true,\n\tpageX: true,\n\tpageY: true,\n\tshiftKey: true,\n\tview: true,\n\t\"char\": true,\n\tcode: true,\n\tcharCode: true,\n\tkey: true,\n\tkeyCode: true,\n\tbutton: true,\n\tbuttons: true,\n\tclientX: true,\n\tclientY: true,\n\toffsetX: true,\n\toffsetY: true,\n\tpointerId: true,\n\tpointerType: true,\n\tscreenX: true,\n\tscreenY: true,\n\ttargetTouches: true,\n\ttoElement: true,\n\ttouches: true,\n\n\twhich: function( event ) {\n\t\tvar button = event.button;\n\n\t\t// Add which for key events\n\t\tif ( event.which == null && rkeyEvent.test( event.type ) ) {\n\t\t\treturn event.charCode != null ? event.charCode : event.keyCode;\n\t\t}\n\n\t\t// Add which for click: 1 === left; 2 === middle; 3 === right\n\t\tif ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) {\n\t\t\tif ( button & 1 ) {\n\t\t\t\treturn 1;\n\t\t\t}\n\n\t\t\tif ( button & 2 ) {\n\t\t\t\treturn 3;\n\t\t\t}\n\n\t\t\tif ( button & 4 ) {\n\t\t\t\treturn 2;\n\t\t\t}\n\n\t\t\treturn 0;\n\t\t}\n\n\t\treturn event.which;\n\t}\n}, jQuery.event.addProp );\n\njQuery.each( { focus: \"focusin\", blur: \"focusout\" }, function( type, delegateType ) {\n\tjQuery.event.special[ type ] = {\n\n\t\t// Utilize native event if possible so blur/focus sequence is correct\n\t\tsetup: function() {\n\n\t\t\t// Claim the first handler\n\t\t\t// dataPriv.set( this, \"focus\", ... )\n\t\t\t// dataPriv.set( this, \"blur\", ... )\n\t\t\tleverageNative( this, type, expectSync );\n\n\t\t\t// Return false to allow normal processing in the caller\n\t\t\treturn false;\n\t\t},\n\t\ttrigger: function() {\n\n\t\t\t// Force setup before trigger\n\t\t\tleverageNative( this, type );\n\n\t\t\t// Return non-false to allow normal event-path propagation\n\t\t\treturn true;\n\t\t},\n\n\t\tdelegateType: delegateType\n\t};\n} );\n\n// Create mouseenter/leave events using mouseover/out and event-time checks\n// so that event delegation works in jQuery.\n// Do the same for pointerenter/pointerleave and pointerover/pointerout\n//\n// Support: Safari 7 only\n// Safari sends mouseenter too often; see:\n// https://bugs.chromium.org/p/chromium/issues/detail?id=470258\n// for the description of the bug (it existed in older Chrome versions as well).\njQuery.each( {\n\tmouseenter: \"mouseover\",\n\tmouseleave: \"mouseout\",\n\tpointerenter: \"pointerover\",\n\tpointerleave: \"pointerout\"\n}, function( orig, fix ) {\n\tjQuery.event.special[ orig ] = {\n\t\tdelegateType: fix,\n\t\tbindType: fix,\n\n\t\thandle: function( event ) {\n\t\t\tvar ret,\n\t\t\t\ttarget = this,\n\t\t\t\trelated = event.relatedTarget,\n\t\t\t\thandleObj = event.handleObj;\n\n\t\t\t// For mouseenter/leave call the handler if related is outside the target.\n\t\t\t// NB: No relatedTarget if the mouse left/entered the browser window\n\t\t\tif ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) {\n\t\t\t\tevent.type = handleObj.origType;\n\t\t\t\tret = handleObj.handler.apply( this, arguments );\n\t\t\t\tevent.type = fix;\n\t\t\t}\n\t\t\treturn ret;\n\t\t}\n\t};\n} );\n\njQuery.fn.extend( {\n\n\ton: function( types, selector, data, fn ) {\n\t\treturn on( this, types, selector, data, fn );\n\t},\n\tone: function( types, selector, data, fn ) {\n\t\treturn on( this, types, selector, data, fn, 1 );\n\t},\n\toff: function( types, selector, fn ) {\n\t\tvar handleObj, type;\n\t\tif ( types && types.preventDefault && types.handleObj ) {\n\n\t\t\t// ( event ) dispatched jQuery.Event\n\t\t\thandleObj = types.handleObj;\n\t\t\tjQuery( types.delegateTarget ).off(\n\t\t\t\thandleObj.namespace ?\n\t\t\t\t\thandleObj.origType + \".\" + handleObj.namespace :\n\t\t\t\t\thandleObj.origType,\n\t\t\t\thandleObj.selector,\n\t\t\t\thandleObj.handler\n\t\t\t);\n\t\t\treturn this;\n\t\t}\n\t\tif ( typeof types === \"object\" ) {\n\n\t\t\t// ( types-object [, selector] )\n\t\t\tfor ( type in types ) {\n\t\t\t\tthis.off( type, selector, types[ type ] );\n\t\t\t}\n\t\t\treturn this;\n\t\t}\n\t\tif ( selector === false || typeof selector === \"function\" ) {\n\n\t\t\t// ( types [, fn] )\n\t\t\tfn = selector;\n\t\t\tselector = undefined;\n\t\t}\n\t\tif ( fn === false ) {\n\t\t\tfn = returnFalse;\n\t\t}\n\t\treturn this.each( function() {\n\t\t\tjQuery.event.remove( this, types, fn, selector );\n\t\t} );\n\t}\n} );\n\n\nvar\n\n\t// Support: IE <=10 - 11, Edge 12 - 13 only\n\t// In IE/Edge using regex groups here causes severe slowdowns.\n\t// See https://connect.microsoft.com/IE/feedback/details/1736512/\n\trnoInnerhtml = /\\s*$/g;\n\n// Prefer a tbody over its parent table for containing new rows\nfunction manipulationTarget( elem, content ) {\n\tif ( nodeName( elem, \"table\" ) &&\n\t\tnodeName( content.nodeType !== 11 ? content : content.firstChild, \"tr\" ) ) {\n\n\t\treturn jQuery( elem ).children( \"tbody\" )[ 0 ] || elem;\n\t}\n\n\treturn elem;\n}\n\n// Replace/restore the type attribute of script elements for safe DOM manipulation\nfunction disableScript( elem ) {\n\telem.type = ( elem.getAttribute( \"type\" ) !== null ) + \"/\" + elem.type;\n\treturn elem;\n}\nfunction restoreScript( elem ) {\n\tif ( ( elem.type || \"\" ).slice( 0, 5 ) === \"true/\" ) {\n\t\telem.type = elem.type.slice( 5 );\n\t} else {\n\t\telem.removeAttribute( \"type\" );\n\t}\n\n\treturn elem;\n}\n\nfunction cloneCopyEvent( src, dest ) {\n\tvar i, l, type, pdataOld, udataOld, udataCur, events;\n\n\tif ( dest.nodeType !== 1 ) {\n\t\treturn;\n\t}\n\n\t// 1. Copy private data: events, handlers, etc.\n\tif ( dataPriv.hasData( src ) ) {\n\t\tpdataOld = dataPriv.get( src );\n\t\tevents = pdataOld.events;\n\n\t\tif ( events ) {\n\t\t\tdataPriv.remove( dest, \"handle events\" );\n\n\t\t\tfor ( type in events ) {\n\t\t\t\tfor ( i = 0, l = events[ type ].length; i < l; i++ ) {\n\t\t\t\t\tjQuery.event.add( dest, type, events[ type ][ i ] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// 2. Copy user data\n\tif ( dataUser.hasData( src ) ) {\n\t\tudataOld = dataUser.access( src );\n\t\tudataCur = jQuery.extend( {}, udataOld );\n\n\t\tdataUser.set( dest, udataCur );\n\t}\n}\n\n// Fix IE bugs, see support tests\nfunction fixInput( src, dest ) {\n\tvar nodeName = dest.nodeName.toLowerCase();\n\n\t// Fails to persist the checked state of a cloned checkbox or radio button.\n\tif ( nodeName === \"input\" && rcheckableType.test( src.type ) ) {\n\t\tdest.checked = src.checked;\n\n\t// Fails to return the selected option to the default selected state when cloning options\n\t} else if ( nodeName === \"input\" || nodeName === \"textarea\" ) {\n\t\tdest.defaultValue = src.defaultValue;\n\t}\n}\n\nfunction domManip( collection, args, callback, ignored ) {\n\n\t// Flatten any nested arrays\n\targs = flat( args );\n\n\tvar fragment, first, scripts, hasScripts, node, doc,\n\t\ti = 0,\n\t\tl = collection.length,\n\t\tiNoClone = l - 1,\n\t\tvalue = args[ 0 ],\n\t\tvalueIsFunction = isFunction( value );\n\n\t// We can't cloneNode fragments that contain checked, in WebKit\n\tif ( valueIsFunction ||\n\t\t\t( l > 1 && typeof value === \"string\" &&\n\t\t\t\t!support.checkClone && rchecked.test( value ) ) ) {\n\t\treturn collection.each( function( index ) {\n\t\t\tvar self = collection.eq( index );\n\t\t\tif ( valueIsFunction ) {\n\t\t\t\targs[ 0 ] = value.call( this, index, self.html() );\n\t\t\t}\n\t\t\tdomManip( self, args, callback, ignored );\n\t\t} );\n\t}\n\n\tif ( l ) {\n\t\tfragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored );\n\t\tfirst = fragment.firstChild;\n\n\t\tif ( fragment.childNodes.length === 1 ) {\n\t\t\tfragment = first;\n\t\t}\n\n\t\t// Require either new content or an interest in ignored elements to invoke the callback\n\t\tif ( first || ignored ) {\n\t\t\tscripts = jQuery.map( getAll( fragment, \"script\" ), disableScript );\n\t\t\thasScripts = scripts.length;\n\n\t\t\t// Use the original fragment for the last item\n\t\t\t// instead of the first because it can end up\n\t\t\t// being emptied incorrectly in certain situations (#8070).\n\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\tnode = fragment;\n\n\t\t\t\tif ( i !== iNoClone ) {\n\t\t\t\t\tnode = jQuery.clone( node, true, true );\n\n\t\t\t\t\t// Keep references to cloned scripts for later restoration\n\t\t\t\t\tif ( hasScripts ) {\n\n\t\t\t\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t\t\t\t// push.apply(_, arraylike) throws on ancient WebKit\n\t\t\t\t\t\tjQuery.merge( scripts, getAll( node, \"script\" ) );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tcallback.call( collection[ i ], node, i );\n\t\t\t}\n\n\t\t\tif ( hasScripts ) {\n\t\t\t\tdoc = scripts[ scripts.length - 1 ].ownerDocument;\n\n\t\t\t\t// Reenable scripts\n\t\t\t\tjQuery.map( scripts, restoreScript );\n\n\t\t\t\t// Evaluate executable scripts on first document insertion\n\t\t\t\tfor ( i = 0; i < hasScripts; i++ ) {\n\t\t\t\t\tnode = scripts[ i ];\n\t\t\t\t\tif ( rscriptType.test( node.type || \"\" ) &&\n\t\t\t\t\t\t!dataPriv.access( node, \"globalEval\" ) &&\n\t\t\t\t\t\tjQuery.contains( doc, node ) ) {\n\n\t\t\t\t\t\tif ( node.src && ( node.type || \"\" ).toLowerCase() !== \"module\" ) {\n\n\t\t\t\t\t\t\t// Optional AJAX dependency, but won't run scripts if not present\n\t\t\t\t\t\t\tif ( jQuery._evalUrl && !node.noModule ) {\n\t\t\t\t\t\t\t\tjQuery._evalUrl( node.src, {\n\t\t\t\t\t\t\t\t\tnonce: node.nonce || node.getAttribute( \"nonce\" )\n\t\t\t\t\t\t\t\t}, doc );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tDOMEval( node.textContent.replace( rcleanScript, \"\" ), node, doc );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn collection;\n}\n\nfunction remove( elem, selector, keepData ) {\n\tvar node,\n\t\tnodes = selector ? jQuery.filter( selector, elem ) : elem,\n\t\ti = 0;\n\n\tfor ( ; ( node = nodes[ i ] ) != null; i++ ) {\n\t\tif ( !keepData && node.nodeType === 1 ) {\n\t\t\tjQuery.cleanData( getAll( node ) );\n\t\t}\n\n\t\tif ( node.parentNode ) {\n\t\t\tif ( keepData && isAttached( node ) ) {\n\t\t\t\tsetGlobalEval( getAll( node, \"script\" ) );\n\t\t\t}\n\t\t\tnode.parentNode.removeChild( node );\n\t\t}\n\t}\n\n\treturn elem;\n}\n\njQuery.extend( {\n\thtmlPrefilter: function( html ) {\n\t\treturn html;\n\t},\n\n\tclone: function( elem, dataAndEvents, deepDataAndEvents ) {\n\t\tvar i, l, srcElements, destElements,\n\t\t\tclone = elem.cloneNode( true ),\n\t\t\tinPage = isAttached( elem );\n\n\t\t// Fix IE cloning issues\n\t\tif ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) &&\n\t\t\t\t!jQuery.isXMLDoc( elem ) ) {\n\n\t\t\t// We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2\n\t\t\tdestElements = getAll( clone );\n\t\t\tsrcElements = getAll( elem );\n\n\t\t\tfor ( i = 0, l = srcElements.length; i < l; i++ ) {\n\t\t\t\tfixInput( srcElements[ i ], destElements[ i ] );\n\t\t\t}\n\t\t}\n\n\t\t// Copy the events from the original to the clone\n\t\tif ( dataAndEvents ) {\n\t\t\tif ( deepDataAndEvents ) {\n\t\t\t\tsrcElements = srcElements || getAll( elem );\n\t\t\t\tdestElements = destElements || getAll( clone );\n\n\t\t\t\tfor ( i = 0, l = srcElements.length; i < l; i++ ) {\n\t\t\t\t\tcloneCopyEvent( srcElements[ i ], destElements[ i ] );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tcloneCopyEvent( elem, clone );\n\t\t\t}\n\t\t}\n\n\t\t// Preserve script evaluation history\n\t\tdestElements = getAll( clone, \"script\" );\n\t\tif ( destElements.length > 0 ) {\n\t\t\tsetGlobalEval( destElements, !inPage && getAll( elem, \"script\" ) );\n\t\t}\n\n\t\t// Return the cloned set\n\t\treturn clone;\n\t},\n\n\tcleanData: function( elems ) {\n\t\tvar data, elem, type,\n\t\t\tspecial = jQuery.event.special,\n\t\t\ti = 0;\n\n\t\tfor ( ; ( elem = elems[ i ] ) !== undefined; i++ ) {\n\t\t\tif ( acceptData( elem ) ) {\n\t\t\t\tif ( ( data = elem[ dataPriv.expando ] ) ) {\n\t\t\t\t\tif ( data.events ) {\n\t\t\t\t\t\tfor ( type in data.events ) {\n\t\t\t\t\t\t\tif ( special[ type ] ) {\n\t\t\t\t\t\t\t\tjQuery.event.remove( elem, type );\n\n\t\t\t\t\t\t\t// This is a shortcut to avoid jQuery.event.remove's overhead\n\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\tjQuery.removeEvent( elem, type, data.handle );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Support: Chrome <=35 - 45+\n\t\t\t\t\t// Assign undefined instead of using delete, see Data#remove\n\t\t\t\t\telem[ dataPriv.expando ] = undefined;\n\t\t\t\t}\n\t\t\t\tif ( elem[ dataUser.expando ] ) {\n\n\t\t\t\t\t// Support: Chrome <=35 - 45+\n\t\t\t\t\t// Assign undefined instead of using delete, see Data#remove\n\t\t\t\t\telem[ dataUser.expando ] = undefined;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n} );\n\njQuery.fn.extend( {\n\tdetach: function( selector ) {\n\t\treturn remove( this, selector, true );\n\t},\n\n\tremove: function( selector ) {\n\t\treturn remove( this, selector );\n\t},\n\n\ttext: function( value ) {\n\t\treturn access( this, function( value ) {\n\t\t\treturn value === undefined ?\n\t\t\t\tjQuery.text( this ) :\n\t\t\t\tthis.empty().each( function() {\n\t\t\t\t\tif ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {\n\t\t\t\t\t\tthis.textContent = value;\n\t\t\t\t\t}\n\t\t\t\t} );\n\t\t}, null, value, arguments.length );\n\t},\n\n\tappend: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {\n\t\t\t\tvar target = manipulationTarget( this, elem );\n\t\t\t\ttarget.appendChild( elem );\n\t\t\t}\n\t\t} );\n\t},\n\n\tprepend: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {\n\t\t\t\tvar target = manipulationTarget( this, elem );\n\t\t\t\ttarget.insertBefore( elem, target.firstChild );\n\t\t\t}\n\t\t} );\n\t},\n\n\tbefore: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.parentNode ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this );\n\t\t\t}\n\t\t} );\n\t},\n\n\tafter: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.parentNode ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this.nextSibling );\n\t\t\t}\n\t\t} );\n\t},\n\n\tempty: function() {\n\t\tvar elem,\n\t\t\ti = 0;\n\n\t\tfor ( ; ( elem = this[ i ] ) != null; i++ ) {\n\t\t\tif ( elem.nodeType === 1 ) {\n\n\t\t\t\t// Prevent memory leaks\n\t\t\t\tjQuery.cleanData( getAll( elem, false ) );\n\n\t\t\t\t// Remove any remaining nodes\n\t\t\t\telem.textContent = \"\";\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tclone: function( dataAndEvents, deepDataAndEvents ) {\n\t\tdataAndEvents = dataAndEvents == null ? false : dataAndEvents;\n\t\tdeepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;\n\n\t\treturn this.map( function() {\n\t\t\treturn jQuery.clone( this, dataAndEvents, deepDataAndEvents );\n\t\t} );\n\t},\n\n\thtml: function( value ) {\n\t\treturn access( this, function( value ) {\n\t\t\tvar elem = this[ 0 ] || {},\n\t\t\t\ti = 0,\n\t\t\t\tl = this.length;\n\n\t\t\tif ( value === undefined && elem.nodeType === 1 ) {\n\t\t\t\treturn elem.innerHTML;\n\t\t\t}\n\n\t\t\t// See if we can take a shortcut and just use innerHTML\n\t\t\tif ( typeof value === \"string\" && !rnoInnerhtml.test( value ) &&\n\t\t\t\t!wrapMap[ ( rtagName.exec( value ) || [ \"\", \"\" ] )[ 1 ].toLowerCase() ] ) {\n\n\t\t\t\tvalue = jQuery.htmlPrefilter( value );\n\n\t\t\t\ttry {\n\t\t\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\t\t\telem = this[ i ] || {};\n\n\t\t\t\t\t\t// Remove element nodes and prevent memory leaks\n\t\t\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\t\t\tjQuery.cleanData( getAll( elem, false ) );\n\t\t\t\t\t\t\telem.innerHTML = value;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\telem = 0;\n\n\t\t\t\t// If using innerHTML throws an exception, use the fallback method\n\t\t\t\t} catch ( e ) {}\n\t\t\t}\n\n\t\t\tif ( elem ) {\n\t\t\t\tthis.empty().append( value );\n\t\t\t}\n\t\t}, null, value, arguments.length );\n\t},\n\n\treplaceWith: function() {\n\t\tvar ignored = [];\n\n\t\t// Make the changes, replacing each non-ignored context element with the new content\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tvar parent = this.parentNode;\n\n\t\t\tif ( jQuery.inArray( this, ignored ) < 0 ) {\n\t\t\t\tjQuery.cleanData( getAll( this ) );\n\t\t\t\tif ( parent ) {\n\t\t\t\t\tparent.replaceChild( elem, this );\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Force callback invocation\n\t\t}, ignored );\n\t}\n} );\n\njQuery.each( {\n\tappendTo: \"append\",\n\tprependTo: \"prepend\",\n\tinsertBefore: \"before\",\n\tinsertAfter: \"after\",\n\treplaceAll: \"replaceWith\"\n}, function( name, original ) {\n\tjQuery.fn[ name ] = function( selector ) {\n\t\tvar elems,\n\t\t\tret = [],\n\t\t\tinsert = jQuery( selector ),\n\t\t\tlast = insert.length - 1,\n\t\t\ti = 0;\n\n\t\tfor ( ; i <= last; i++ ) {\n\t\t\telems = i === last ? this : this.clone( true );\n\t\t\tjQuery( insert[ i ] )[ original ]( elems );\n\n\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t// .get() because push.apply(_, arraylike) throws on ancient WebKit\n\t\t\tpush.apply( ret, elems.get() );\n\t\t}\n\n\t\treturn this.pushStack( ret );\n\t};\n} );\nvar rnumnonpx = new RegExp( \"^(\" + pnum + \")(?!px)[a-z%]+$\", \"i\" );\n\nvar getStyles = function( elem ) {\n\n\t\t// Support: IE <=11 only, Firefox <=30 (#15098, #14150)\n\t\t// IE throws on elements created in popups\n\t\t// FF meanwhile throws on frame elements through \"defaultView.getComputedStyle\"\n\t\tvar view = elem.ownerDocument.defaultView;\n\n\t\tif ( !view || !view.opener ) {\n\t\t\tview = window;\n\t\t}\n\n\t\treturn view.getComputedStyle( elem );\n\t};\n\nvar swap = function( elem, options, callback ) {\n\tvar ret, name,\n\t\told = {};\n\n\t// Remember the old values, and insert the new ones\n\tfor ( name in options ) {\n\t\told[ name ] = elem.style[ name ];\n\t\telem.style[ name ] = options[ name ];\n\t}\n\n\tret = callback.call( elem );\n\n\t// Revert the old values\n\tfor ( name in options ) {\n\t\telem.style[ name ] = old[ name ];\n\t}\n\n\treturn ret;\n};\n\n\nvar rboxStyle = new RegExp( cssExpand.join( \"|\" ), \"i\" );\n\n\n\n( function() {\n\n\t// Executing both pixelPosition & boxSizingReliable tests require only one layout\n\t// so they're executed at the same time to save the second computation.\n\tfunction computeStyleTests() {\n\n\t\t// This is a singleton, we need to execute it only once\n\t\tif ( !div ) {\n\t\t\treturn;\n\t\t}\n\n\t\tcontainer.style.cssText = \"position:absolute;left:-11111px;width:60px;\" +\n\t\t\t\"margin-top:1px;padding:0;border:0\";\n\t\tdiv.style.cssText =\n\t\t\t\"position:relative;display:block;box-sizing:border-box;overflow:scroll;\" +\n\t\t\t\"margin:auto;border:1px;padding:1px;\" +\n\t\t\t\"width:60%;top:1%\";\n\t\tdocumentElement.appendChild( container ).appendChild( div );\n\n\t\tvar divStyle = window.getComputedStyle( div );\n\t\tpixelPositionVal = divStyle.top !== \"1%\";\n\n\t\t// Support: Android 4.0 - 4.3 only, Firefox <=3 - 44\n\t\treliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12;\n\n\t\t// Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3\n\t\t// Some styles come back with percentage values, even though they shouldn't\n\t\tdiv.style.right = \"60%\";\n\t\tpixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36;\n\n\t\t// Support: IE 9 - 11 only\n\t\t// Detect misreporting of content dimensions for box-sizing:border-box elements\n\t\tboxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36;\n\n\t\t// Support: IE 9 only\n\t\t// Detect overflow:scroll screwiness (gh-3699)\n\t\t// Support: Chrome <=64\n\t\t// Don't get tricked when zoom affects offsetWidth (gh-4029)\n\t\tdiv.style.position = \"absolute\";\n\t\tscrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12;\n\n\t\tdocumentElement.removeChild( container );\n\n\t\t// Nullify the div so it wouldn't be stored in the memory and\n\t\t// it will also be a sign that checks already performed\n\t\tdiv = null;\n\t}\n\n\tfunction roundPixelMeasures( measure ) {\n\t\treturn Math.round( parseFloat( measure ) );\n\t}\n\n\tvar pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal,\n\t\treliableTrDimensionsVal, reliableMarginLeftVal,\n\t\tcontainer = document.createElement( \"div\" ),\n\t\tdiv = document.createElement( \"div\" );\n\n\t// Finish early in limited (non-browser) environments\n\tif ( !div.style ) {\n\t\treturn;\n\t}\n\n\t// Support: IE <=9 - 11 only\n\t// Style of cloned element affects source element cloned (#8908)\n\tdiv.style.backgroundClip = \"content-box\";\n\tdiv.cloneNode( true ).style.backgroundClip = \"\";\n\tsupport.clearCloneStyle = div.style.backgroundClip === \"content-box\";\n\n\tjQuery.extend( support, {\n\t\tboxSizingReliable: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn boxSizingReliableVal;\n\t\t},\n\t\tpixelBoxStyles: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn pixelBoxStylesVal;\n\t\t},\n\t\tpixelPosition: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn pixelPositionVal;\n\t\t},\n\t\treliableMarginLeft: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn reliableMarginLeftVal;\n\t\t},\n\t\tscrollboxSize: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn scrollboxSizeVal;\n\t\t},\n\n\t\t// Support: IE 9 - 11+, Edge 15 - 18+\n\t\t// IE/Edge misreport `getComputedStyle` of table rows with width/height\n\t\t// set in CSS while `offset*` properties report correct values.\n\t\t// Behavior in IE 9 is more subtle than in newer versions & it passes\n\t\t// some versions of this test; make sure not to make it pass there!\n\t\treliableTrDimensions: function() {\n\t\t\tvar table, tr, trChild, trStyle;\n\t\t\tif ( reliableTrDimensionsVal == null ) {\n\t\t\t\ttable = document.createElement( \"table\" );\n\t\t\t\ttr = document.createElement( \"tr\" );\n\t\t\t\ttrChild = document.createElement( \"div\" );\n\n\t\t\t\ttable.style.cssText = \"position:absolute;left:-11111px\";\n\t\t\t\ttr.style.height = \"1px\";\n\t\t\t\ttrChild.style.height = \"9px\";\n\n\t\t\t\tdocumentElement\n\t\t\t\t\t.appendChild( table )\n\t\t\t\t\t.appendChild( tr )\n\t\t\t\t\t.appendChild( trChild );\n\n\t\t\t\ttrStyle = window.getComputedStyle( tr );\n\t\t\t\treliableTrDimensionsVal = parseInt( trStyle.height ) > 3;\n\n\t\t\t\tdocumentElement.removeChild( table );\n\t\t\t}\n\t\t\treturn reliableTrDimensionsVal;\n\t\t}\n\t} );\n} )();\n\n\nfunction curCSS( elem, name, computed ) {\n\tvar width, minWidth, maxWidth, ret,\n\n\t\t// Support: Firefox 51+\n\t\t// Retrieving style before computed somehow\n\t\t// fixes an issue with getting wrong values\n\t\t// on detached elements\n\t\tstyle = elem.style;\n\n\tcomputed = computed || getStyles( elem );\n\n\t// getPropertyValue is needed for:\n\t// .css('filter') (IE 9 only, #12537)\n\t// .css('--customProperty) (#3144)\n\tif ( computed ) {\n\t\tret = computed.getPropertyValue( name ) || computed[ name ];\n\n\t\tif ( ret === \"\" && !isAttached( elem ) ) {\n\t\t\tret = jQuery.style( elem, name );\n\t\t}\n\n\t\t// A tribute to the \"awesome hack by Dean Edwards\"\n\t\t// Android Browser returns percentage for some values,\n\t\t// but width seems to be reliably pixels.\n\t\t// This is against the CSSOM draft spec:\n\t\t// https://drafts.csswg.org/cssom/#resolved-values\n\t\tif ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) {\n\n\t\t\t// Remember the original values\n\t\t\twidth = style.width;\n\t\t\tminWidth = style.minWidth;\n\t\t\tmaxWidth = style.maxWidth;\n\n\t\t\t// Put in the new values to get a computed value out\n\t\t\tstyle.minWidth = style.maxWidth = style.width = ret;\n\t\t\tret = computed.width;\n\n\t\t\t// Revert the changed values\n\t\t\tstyle.width = width;\n\t\t\tstyle.minWidth = minWidth;\n\t\t\tstyle.maxWidth = maxWidth;\n\t\t}\n\t}\n\n\treturn ret !== undefined ?\n\n\t\t// Support: IE <=9 - 11 only\n\t\t// IE returns zIndex value as an integer.\n\t\tret + \"\" :\n\t\tret;\n}\n\n\nfunction addGetHookIf( conditionFn, hookFn ) {\n\n\t// Define the hook, we'll check on the first run if it's really needed.\n\treturn {\n\t\tget: function() {\n\t\t\tif ( conditionFn() ) {\n\n\t\t\t\t// Hook not needed (or it's not possible to use it due\n\t\t\t\t// to missing dependency), remove it.\n\t\t\t\tdelete this.get;\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// Hook needed; redefine it so that the support test is not executed again.\n\t\t\treturn ( this.get = hookFn ).apply( this, arguments );\n\t\t}\n\t};\n}\n\n\nvar cssPrefixes = [ \"Webkit\", \"Moz\", \"ms\" ],\n\temptyStyle = document.createElement( \"div\" ).style,\n\tvendorProps = {};\n\n// Return a vendor-prefixed property or undefined\nfunction vendorPropName( name ) {\n\n\t// Check for vendor prefixed names\n\tvar capName = name[ 0 ].toUpperCase() + name.slice( 1 ),\n\t\ti = cssPrefixes.length;\n\n\twhile ( i-- ) {\n\t\tname = cssPrefixes[ i ] + capName;\n\t\tif ( name in emptyStyle ) {\n\t\t\treturn name;\n\t\t}\n\t}\n}\n\n// Return a potentially-mapped jQuery.cssProps or vendor prefixed property\nfunction finalPropName( name ) {\n\tvar final = jQuery.cssProps[ name ] || vendorProps[ name ];\n\n\tif ( final ) {\n\t\treturn final;\n\t}\n\tif ( name in emptyStyle ) {\n\t\treturn name;\n\t}\n\treturn vendorProps[ name ] = vendorPropName( name ) || name;\n}\n\n\nvar\n\n\t// Swappable if display is none or starts with table\n\t// except \"table\", \"table-cell\", or \"table-caption\"\n\t// See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display\n\trdisplayswap = /^(none|table(?!-c[ea]).+)/,\n\trcustomProp = /^--/,\n\tcssShow = { position: \"absolute\", visibility: \"hidden\", display: \"block\" },\n\tcssNormalTransform = {\n\t\tletterSpacing: \"0\",\n\t\tfontWeight: \"400\"\n\t};\n\nfunction setPositiveNumber( _elem, value, subtract ) {\n\n\t// Any relative (+/-) values have already been\n\t// normalized at this point\n\tvar matches = rcssNum.exec( value );\n\treturn matches ?\n\n\t\t// Guard against undefined \"subtract\", e.g., when used as in cssHooks\n\t\tMath.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || \"px\" ) :\n\t\tvalue;\n}\n\nfunction boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) {\n\tvar i = dimension === \"width\" ? 1 : 0,\n\t\textra = 0,\n\t\tdelta = 0;\n\n\t// Adjustment may not be necessary\n\tif ( box === ( isBorderBox ? \"border\" : \"content\" ) ) {\n\t\treturn 0;\n\t}\n\n\tfor ( ; i < 4; i += 2 ) {\n\n\t\t// Both box models exclude margin\n\t\tif ( box === \"margin\" ) {\n\t\t\tdelta += jQuery.css( elem, box + cssExpand[ i ], true, styles );\n\t\t}\n\n\t\t// If we get here with a content-box, we're seeking \"padding\" or \"border\" or \"margin\"\n\t\tif ( !isBorderBox ) {\n\n\t\t\t// Add padding\n\t\t\tdelta += jQuery.css( elem, \"padding\" + cssExpand[ i ], true, styles );\n\n\t\t\t// For \"border\" or \"margin\", add border\n\t\t\tif ( box !== \"padding\" ) {\n\t\t\t\tdelta += jQuery.css( elem, \"border\" + cssExpand[ i ] + \"Width\", true, styles );\n\n\t\t\t// But still keep track of it otherwise\n\t\t\t} else {\n\t\t\t\textra += jQuery.css( elem, \"border\" + cssExpand[ i ] + \"Width\", true, styles );\n\t\t\t}\n\n\t\t// If we get here with a border-box (content + padding + border), we're seeking \"content\" or\n\t\t// \"padding\" or \"margin\"\n\t\t} else {\n\n\t\t\t// For \"content\", subtract padding\n\t\t\tif ( box === \"content\" ) {\n\t\t\t\tdelta -= jQuery.css( elem, \"padding\" + cssExpand[ i ], true, styles );\n\t\t\t}\n\n\t\t\t// For \"content\" or \"padding\", subtract border\n\t\t\tif ( box !== \"margin\" ) {\n\t\t\t\tdelta -= jQuery.css( elem, \"border\" + cssExpand[ i ] + \"Width\", true, styles );\n\t\t\t}\n\t\t}\n\t}\n\n\t// Account for positive content-box scroll gutter when requested by providing computedVal\n\tif ( !isBorderBox && computedVal >= 0 ) {\n\n\t\t// offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border\n\t\t// Assuming integer scroll gutter, subtract the rest and round down\n\t\tdelta += Math.max( 0, Math.ceil(\n\t\t\telem[ \"offset\" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -\n\t\t\tcomputedVal -\n\t\t\tdelta -\n\t\t\textra -\n\t\t\t0.5\n\n\t\t// If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter\n\t\t// Use an explicit zero to avoid NaN (gh-3964)\n\t\t) ) || 0;\n\t}\n\n\treturn delta;\n}\n\nfunction getWidthOrHeight( elem, dimension, extra ) {\n\n\t// Start with computed style\n\tvar styles = getStyles( elem ),\n\n\t\t// To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322).\n\t\t// Fake content-box until we know it's needed to know the true value.\n\t\tboxSizingNeeded = !support.boxSizingReliable() || extra,\n\t\tisBorderBox = boxSizingNeeded &&\n\t\t\tjQuery.css( elem, \"boxSizing\", false, styles ) === \"border-box\",\n\t\tvalueIsBorderBox = isBorderBox,\n\n\t\tval = curCSS( elem, dimension, styles ),\n\t\toffsetProp = \"offset\" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 );\n\n\t// Support: Firefox <=54\n\t// Return a confounding non-pixel value or feign ignorance, as appropriate.\n\tif ( rnumnonpx.test( val ) ) {\n\t\tif ( !extra ) {\n\t\t\treturn val;\n\t\t}\n\t\tval = \"auto\";\n\t}\n\n\n\t// Support: IE 9 - 11 only\n\t// Use offsetWidth/offsetHeight for when box sizing is unreliable.\n\t// In those cases, the computed value can be trusted to be border-box.\n\tif ( ( !support.boxSizingReliable() && isBorderBox ||\n\n\t\t// Support: IE 10 - 11+, Edge 15 - 18+\n\t\t// IE/Edge misreport `getComputedStyle` of table rows with width/height\n\t\t// set in CSS while `offset*` properties report correct values.\n\t\t// Interestingly, in some cases IE 9 doesn't suffer from this issue.\n\t\t!support.reliableTrDimensions() && nodeName( elem, \"tr\" ) ||\n\n\t\t// Fall back to offsetWidth/offsetHeight when value is \"auto\"\n\t\t// This happens for inline elements with no explicit setting (gh-3571)\n\t\tval === \"auto\" ||\n\n\t\t// Support: Android <=4.1 - 4.3 only\n\t\t// Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602)\n\t\t!parseFloat( val ) && jQuery.css( elem, \"display\", false, styles ) === \"inline\" ) &&\n\n\t\t// Make sure the element is visible & connected\n\t\telem.getClientRects().length ) {\n\n\t\tisBorderBox = jQuery.css( elem, \"boxSizing\", false, styles ) === \"border-box\";\n\n\t\t// Where available, offsetWidth/offsetHeight approximate border box dimensions.\n\t\t// Where not available (e.g., SVG), assume unreliable box-sizing and interpret the\n\t\t// retrieved value as a content box dimension.\n\t\tvalueIsBorderBox = offsetProp in elem;\n\t\tif ( valueIsBorderBox ) {\n\t\t\tval = elem[ offsetProp ];\n\t\t}\n\t}\n\n\t// Normalize \"\" and auto\n\tval = parseFloat( val ) || 0;\n\n\t// Adjust for the element's box model\n\treturn ( val +\n\t\tboxModelAdjustment(\n\t\t\telem,\n\t\t\tdimension,\n\t\t\textra || ( isBorderBox ? \"border\" : \"content\" ),\n\t\t\tvalueIsBorderBox,\n\t\t\tstyles,\n\n\t\t\t// Provide the current computed size to request scroll gutter calculation (gh-3589)\n\t\t\tval\n\t\t)\n\t) + \"px\";\n}\n\njQuery.extend( {\n\n\t// Add in style property hooks for overriding the default\n\t// behavior of getting and setting a style property\n\tcssHooks: {\n\t\topacity: {\n\t\t\tget: function( elem, computed ) {\n\t\t\t\tif ( computed ) {\n\n\t\t\t\t\t// We should always get a number back from opacity\n\t\t\t\t\tvar ret = curCSS( elem, \"opacity\" );\n\t\t\t\t\treturn ret === \"\" ? \"1\" : ret;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t},\n\n\t// Don't automatically add \"px\" to these possibly-unitless properties\n\tcssNumber: {\n\t\t\"animationIterationCount\": true,\n\t\t\"columnCount\": true,\n\t\t\"fillOpacity\": true,\n\t\t\"flexGrow\": true,\n\t\t\"flexShrink\": true,\n\t\t\"fontWeight\": true,\n\t\t\"gridArea\": true,\n\t\t\"gridColumn\": true,\n\t\t\"gridColumnEnd\": true,\n\t\t\"gridColumnStart\": true,\n\t\t\"gridRow\": true,\n\t\t\"gridRowEnd\": true,\n\t\t\"gridRowStart\": true,\n\t\t\"lineHeight\": true,\n\t\t\"opacity\": true,\n\t\t\"order\": true,\n\t\t\"orphans\": true,\n\t\t\"widows\": true,\n\t\t\"zIndex\": true,\n\t\t\"zoom\": true\n\t},\n\n\t// Add in properties whose names you wish to fix before\n\t// setting or getting the value\n\tcssProps: {},\n\n\t// Get and set the style property on a DOM Node\n\tstyle: function( elem, name, value, extra ) {\n\n\t\t// Don't set styles on text and comment nodes\n\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Make sure that we're working with the right name\n\t\tvar ret, type, hooks,\n\t\t\torigName = camelCase( name ),\n\t\t\tisCustomProp = rcustomProp.test( name ),\n\t\t\tstyle = elem.style;\n\n\t\t// Make sure that we're working with the right name. We don't\n\t\t// want to query the value if it is a CSS custom property\n\t\t// since they are user-defined.\n\t\tif ( !isCustomProp ) {\n\t\t\tname = finalPropName( origName );\n\t\t}\n\n\t\t// Gets hook for the prefixed version, then unprefixed version\n\t\thooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];\n\n\t\t// Check if we're setting a value\n\t\tif ( value !== undefined ) {\n\t\t\ttype = typeof value;\n\n\t\t\t// Convert \"+=\" or \"-=\" to relative numbers (#7345)\n\t\t\tif ( type === \"string\" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {\n\t\t\t\tvalue = adjustCSS( elem, name, ret );\n\n\t\t\t\t// Fixes bug #9237\n\t\t\t\ttype = \"number\";\n\t\t\t}\n\n\t\t\t// Make sure that null and NaN values aren't set (#7116)\n\t\t\tif ( value == null || value !== value ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// If a number was passed in, add the unit (except for certain CSS properties)\n\t\t\t// The isCustomProp check can be removed in jQuery 4.0 when we only auto-append\n\t\t\t// \"px\" to a few hardcoded values.\n\t\t\tif ( type === \"number\" && !isCustomProp ) {\n\t\t\t\tvalue += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? \"\" : \"px\" );\n\t\t\t}\n\n\t\t\t// background-* props affect original clone's values\n\t\t\tif ( !support.clearCloneStyle && value === \"\" && name.indexOf( \"background\" ) === 0 ) {\n\t\t\t\tstyle[ name ] = \"inherit\";\n\t\t\t}\n\n\t\t\t// If a hook was provided, use that value, otherwise just set the specified value\n\t\t\tif ( !hooks || !( \"set\" in hooks ) ||\n\t\t\t\t( value = hooks.set( elem, value, extra ) ) !== undefined ) {\n\n\t\t\t\tif ( isCustomProp ) {\n\t\t\t\t\tstyle.setProperty( name, value );\n\t\t\t\t} else {\n\t\t\t\t\tstyle[ name ] = value;\n\t\t\t\t}\n\t\t\t}\n\n\t\t} else {\n\n\t\t\t// If a hook was provided get the non-computed value from there\n\t\t\tif ( hooks && \"get\" in hooks &&\n\t\t\t\t( ret = hooks.get( elem, false, extra ) ) !== undefined ) {\n\n\t\t\t\treturn ret;\n\t\t\t}\n\n\t\t\t// Otherwise just get the value from the style object\n\t\t\treturn style[ name ];\n\t\t}\n\t},\n\n\tcss: function( elem, name, extra, styles ) {\n\t\tvar val, num, hooks,\n\t\t\torigName = camelCase( name ),\n\t\t\tisCustomProp = rcustomProp.test( name );\n\n\t\t// Make sure that we're working with the right name. We don't\n\t\t// want to modify the value if it is a CSS custom property\n\t\t// since they are user-defined.\n\t\tif ( !isCustomProp ) {\n\t\t\tname = finalPropName( origName );\n\t\t}\n\n\t\t// Try prefixed name followed by the unprefixed name\n\t\thooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];\n\n\t\t// If a hook was provided get the computed value from there\n\t\tif ( hooks && \"get\" in hooks ) {\n\t\t\tval = hooks.get( elem, true, extra );\n\t\t}\n\n\t\t// Otherwise, if a way to get the computed value exists, use that\n\t\tif ( val === undefined ) {\n\t\t\tval = curCSS( elem, name, styles );\n\t\t}\n\n\t\t// Convert \"normal\" to computed value\n\t\tif ( val === \"normal\" && name in cssNormalTransform ) {\n\t\t\tval = cssNormalTransform[ name ];\n\t\t}\n\n\t\t// Make numeric if forced or a qualifier was provided and val looks numeric\n\t\tif ( extra === \"\" || extra ) {\n\t\t\tnum = parseFloat( val );\n\t\t\treturn extra === true || isFinite( num ) ? num || 0 : val;\n\t\t}\n\n\t\treturn val;\n\t}\n} );\n\njQuery.each( [ \"height\", \"width\" ], function( _i, dimension ) {\n\tjQuery.cssHooks[ dimension ] = {\n\t\tget: function( elem, computed, extra ) {\n\t\t\tif ( computed ) {\n\n\t\t\t\t// Certain elements can have dimension info if we invisibly show them\n\t\t\t\t// but it must have a current display style that would benefit\n\t\t\t\treturn rdisplayswap.test( jQuery.css( elem, \"display\" ) ) &&\n\n\t\t\t\t\t// Support: Safari 8+\n\t\t\t\t\t// Table columns in Safari have non-zero offsetWidth & zero\n\t\t\t\t\t// getBoundingClientRect().width unless display is changed.\n\t\t\t\t\t// Support: IE <=11 only\n\t\t\t\t\t// Running getBoundingClientRect on a disconnected node\n\t\t\t\t\t// in IE throws an error.\n\t\t\t\t\t( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ?\n\t\t\t\t\t\tswap( elem, cssShow, function() {\n\t\t\t\t\t\t\treturn getWidthOrHeight( elem, dimension, extra );\n\t\t\t\t\t\t} ) :\n\t\t\t\t\t\tgetWidthOrHeight( elem, dimension, extra );\n\t\t\t}\n\t\t},\n\n\t\tset: function( elem, value, extra ) {\n\t\t\tvar matches,\n\t\t\t\tstyles = getStyles( elem ),\n\n\t\t\t\t// Only read styles.position if the test has a chance to fail\n\t\t\t\t// to avoid forcing a reflow.\n\t\t\t\tscrollboxSizeBuggy = !support.scrollboxSize() &&\n\t\t\t\t\tstyles.position === \"absolute\",\n\n\t\t\t\t// To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991)\n\t\t\t\tboxSizingNeeded = scrollboxSizeBuggy || extra,\n\t\t\t\tisBorderBox = boxSizingNeeded &&\n\t\t\t\t\tjQuery.css( elem, \"boxSizing\", false, styles ) === \"border-box\",\n\t\t\t\tsubtract = extra ?\n\t\t\t\t\tboxModelAdjustment(\n\t\t\t\t\t\telem,\n\t\t\t\t\t\tdimension,\n\t\t\t\t\t\textra,\n\t\t\t\t\t\tisBorderBox,\n\t\t\t\t\t\tstyles\n\t\t\t\t\t) :\n\t\t\t\t\t0;\n\n\t\t\t// Account for unreliable border-box dimensions by comparing offset* to computed and\n\t\t\t// faking a content-box to get border and padding (gh-3699)\n\t\t\tif ( isBorderBox && scrollboxSizeBuggy ) {\n\t\t\t\tsubtract -= Math.ceil(\n\t\t\t\t\telem[ \"offset\" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -\n\t\t\t\t\tparseFloat( styles[ dimension ] ) -\n\t\t\t\t\tboxModelAdjustment( elem, dimension, \"border\", false, styles ) -\n\t\t\t\t\t0.5\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// Convert to pixels if value adjustment is needed\n\t\t\tif ( subtract && ( matches = rcssNum.exec( value ) ) &&\n\t\t\t\t( matches[ 3 ] || \"px\" ) !== \"px\" ) {\n\n\t\t\t\telem.style[ dimension ] = value;\n\t\t\t\tvalue = jQuery.css( elem, dimension );\n\t\t\t}\n\n\t\t\treturn setPositiveNumber( elem, value, subtract );\n\t\t}\n\t};\n} );\n\njQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft,\n\tfunction( elem, computed ) {\n\t\tif ( computed ) {\n\t\t\treturn ( parseFloat( curCSS( elem, \"marginLeft\" ) ) ||\n\t\t\t\telem.getBoundingClientRect().left -\n\t\t\t\t\tswap( elem, { marginLeft: 0 }, function() {\n\t\t\t\t\t\treturn elem.getBoundingClientRect().left;\n\t\t\t\t\t} )\n\t\t\t\t) + \"px\";\n\t\t}\n\t}\n);\n\n// These hooks are used by animate to expand properties\njQuery.each( {\n\tmargin: \"\",\n\tpadding: \"\",\n\tborder: \"Width\"\n}, function( prefix, suffix ) {\n\tjQuery.cssHooks[ prefix + suffix ] = {\n\t\texpand: function( value ) {\n\t\t\tvar i = 0,\n\t\t\t\texpanded = {},\n\n\t\t\t\t// Assumes a single number if not a string\n\t\t\t\tparts = typeof value === \"string\" ? value.split( \" \" ) : [ value ];\n\n\t\t\tfor ( ; i < 4; i++ ) {\n\t\t\t\texpanded[ prefix + cssExpand[ i ] + suffix ] =\n\t\t\t\t\tparts[ i ] || parts[ i - 2 ] || parts[ 0 ];\n\t\t\t}\n\n\t\t\treturn expanded;\n\t\t}\n\t};\n\n\tif ( prefix !== \"margin\" ) {\n\t\tjQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber;\n\t}\n} );\n\njQuery.fn.extend( {\n\tcss: function( name, value ) {\n\t\treturn access( this, function( elem, name, value ) {\n\t\t\tvar styles, len,\n\t\t\t\tmap = {},\n\t\t\t\ti = 0;\n\n\t\t\tif ( Array.isArray( name ) ) {\n\t\t\t\tstyles = getStyles( elem );\n\t\t\t\tlen = name.length;\n\n\t\t\t\tfor ( ; i < len; i++ ) {\n\t\t\t\t\tmap[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles );\n\t\t\t\t}\n\n\t\t\t\treturn map;\n\t\t\t}\n\n\t\t\treturn value !== undefined ?\n\t\t\t\tjQuery.style( elem, name, value ) :\n\t\t\t\tjQuery.css( elem, name );\n\t\t}, name, value, arguments.length > 1 );\n\t}\n} );\n\n\nfunction Tween( elem, options, prop, end, easing ) {\n\treturn new Tween.prototype.init( elem, options, prop, end, easing );\n}\njQuery.Tween = Tween;\n\nTween.prototype = {\n\tconstructor: Tween,\n\tinit: function( elem, options, prop, end, easing, unit ) {\n\t\tthis.elem = elem;\n\t\tthis.prop = prop;\n\t\tthis.easing = easing || jQuery.easing._default;\n\t\tthis.options = options;\n\t\tthis.start = this.now = this.cur();\n\t\tthis.end = end;\n\t\tthis.unit = unit || ( jQuery.cssNumber[ prop ] ? \"\" : \"px\" );\n\t},\n\tcur: function() {\n\t\tvar hooks = Tween.propHooks[ this.prop ];\n\n\t\treturn hooks && hooks.get ?\n\t\t\thooks.get( this ) :\n\t\t\tTween.propHooks._default.get( this );\n\t},\n\trun: function( percent ) {\n\t\tvar eased,\n\t\t\thooks = Tween.propHooks[ this.prop ];\n\n\t\tif ( this.options.duration ) {\n\t\t\tthis.pos = eased = jQuery.easing[ this.easing ](\n\t\t\t\tpercent, this.options.duration * percent, 0, 1, this.options.duration\n\t\t\t);\n\t\t} else {\n\t\t\tthis.pos = eased = percent;\n\t\t}\n\t\tthis.now = ( this.end - this.start ) * eased + this.start;\n\n\t\tif ( this.options.step ) {\n\t\t\tthis.options.step.call( this.elem, this.now, this );\n\t\t}\n\n\t\tif ( hooks && hooks.set ) {\n\t\t\thooks.set( this );\n\t\t} else {\n\t\t\tTween.propHooks._default.set( this );\n\t\t}\n\t\treturn this;\n\t}\n};\n\nTween.prototype.init.prototype = Tween.prototype;\n\nTween.propHooks = {\n\t_default: {\n\t\tget: function( tween ) {\n\t\t\tvar result;\n\n\t\t\t// Use a property on the element directly when it is not a DOM element,\n\t\t\t// or when there is no matching style property that exists.\n\t\t\tif ( tween.elem.nodeType !== 1 ||\n\t\t\t\ttween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) {\n\t\t\t\treturn tween.elem[ tween.prop ];\n\t\t\t}\n\n\t\t\t// Passing an empty string as a 3rd parameter to .css will automatically\n\t\t\t// attempt a parseFloat and fallback to a string if the parse fails.\n\t\t\t// Simple values such as \"10px\" are parsed to Float;\n\t\t\t// complex values such as \"rotate(1rad)\" are returned as-is.\n\t\t\tresult = jQuery.css( tween.elem, tween.prop, \"\" );\n\n\t\t\t// Empty strings, null, undefined and \"auto\" are converted to 0.\n\t\t\treturn !result || result === \"auto\" ? 0 : result;\n\t\t},\n\t\tset: function( tween ) {\n\n\t\t\t// Use step hook for back compat.\n\t\t\t// Use cssHook if its there.\n\t\t\t// Use .style if available and use plain properties where available.\n\t\t\tif ( jQuery.fx.step[ tween.prop ] ) {\n\t\t\t\tjQuery.fx.step[ tween.prop ]( tween );\n\t\t\t} else if ( tween.elem.nodeType === 1 && (\n\t\t\t\t\tjQuery.cssHooks[ tween.prop ] ||\n\t\t\t\t\ttween.elem.style[ finalPropName( tween.prop ) ] != null ) ) {\n\t\t\t\tjQuery.style( tween.elem, tween.prop, tween.now + tween.unit );\n\t\t\t} else {\n\t\t\t\ttween.elem[ tween.prop ] = tween.now;\n\t\t\t}\n\t\t}\n\t}\n};\n\n// Support: IE <=9 only\n// Panic based approach to setting things on disconnected nodes\nTween.propHooks.scrollTop = Tween.propHooks.scrollLeft = {\n\tset: function( tween ) {\n\t\tif ( tween.elem.nodeType && tween.elem.parentNode ) {\n\t\t\ttween.elem[ tween.prop ] = tween.now;\n\t\t}\n\t}\n};\n\njQuery.easing = {\n\tlinear: function( p ) {\n\t\treturn p;\n\t},\n\tswing: function( p ) {\n\t\treturn 0.5 - Math.cos( p * Math.PI ) / 2;\n\t},\n\t_default: \"swing\"\n};\n\njQuery.fx = Tween.prototype.init;\n\n// Back compat <1.8 extension point\njQuery.fx.step = {};\n\n\n\n\nvar\n\tfxNow, inProgress,\n\trfxtypes = /^(?:toggle|show|hide)$/,\n\trrun = /queueHooks$/;\n\nfunction schedule() {\n\tif ( inProgress ) {\n\t\tif ( document.hidden === false && window.requestAnimationFrame ) {\n\t\t\twindow.requestAnimationFrame( schedule );\n\t\t} else {\n\t\t\twindow.setTimeout( schedule, jQuery.fx.interval );\n\t\t}\n\n\t\tjQuery.fx.tick();\n\t}\n}\n\n// Animations created synchronously will run synchronously\nfunction createFxNow() {\n\twindow.setTimeout( function() {\n\t\tfxNow = undefined;\n\t} );\n\treturn ( fxNow = Date.now() );\n}\n\n// Generate parameters to create a standard animation\nfunction genFx( type, includeWidth ) {\n\tvar which,\n\t\ti = 0,\n\t\tattrs = { height: type };\n\n\t// If we include width, step value is 1 to do all cssExpand values,\n\t// otherwise step value is 2 to skip over Left and Right\n\tincludeWidth = includeWidth ? 1 : 0;\n\tfor ( ; i < 4; i += 2 - includeWidth ) {\n\t\twhich = cssExpand[ i ];\n\t\tattrs[ \"margin\" + which ] = attrs[ \"padding\" + which ] = type;\n\t}\n\n\tif ( includeWidth ) {\n\t\tattrs.opacity = attrs.width = type;\n\t}\n\n\treturn attrs;\n}\n\nfunction createTween( value, prop, animation ) {\n\tvar tween,\n\t\tcollection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ \"*\" ] ),\n\t\tindex = 0,\n\t\tlength = collection.length;\n\tfor ( ; index < length; index++ ) {\n\t\tif ( ( tween = collection[ index ].call( animation, prop, value ) ) ) {\n\n\t\t\t// We're done with this property\n\t\t\treturn tween;\n\t\t}\n\t}\n}\n\nfunction defaultPrefilter( elem, props, opts ) {\n\tvar prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display,\n\t\tisBox = \"width\" in props || \"height\" in props,\n\t\tanim = this,\n\t\torig = {},\n\t\tstyle = elem.style,\n\t\thidden = elem.nodeType && isHiddenWithinTree( elem ),\n\t\tdataShow = dataPriv.get( elem, \"fxshow\" );\n\n\t// Queue-skipping animations hijack the fx hooks\n\tif ( !opts.queue ) {\n\t\thooks = jQuery._queueHooks( elem, \"fx\" );\n\t\tif ( hooks.unqueued == null ) {\n\t\t\thooks.unqueued = 0;\n\t\t\toldfire = hooks.empty.fire;\n\t\t\thooks.empty.fire = function() {\n\t\t\t\tif ( !hooks.unqueued ) {\n\t\t\t\t\toldfire();\n\t\t\t\t}\n\t\t\t};\n\t\t}\n\t\thooks.unqueued++;\n\n\t\tanim.always( function() {\n\n\t\t\t// Ensure the complete handler is called before this completes\n\t\t\tanim.always( function() {\n\t\t\t\thooks.unqueued--;\n\t\t\t\tif ( !jQuery.queue( elem, \"fx\" ).length ) {\n\t\t\t\t\thooks.empty.fire();\n\t\t\t\t}\n\t\t\t} );\n\t\t} );\n\t}\n\n\t// Detect show/hide animations\n\tfor ( prop in props ) {\n\t\tvalue = props[ prop ];\n\t\tif ( rfxtypes.test( value ) ) {\n\t\t\tdelete props[ prop ];\n\t\t\ttoggle = toggle || value === \"toggle\";\n\t\t\tif ( value === ( hidden ? \"hide\" : \"show\" ) ) {\n\n\t\t\t\t// Pretend to be hidden if this is a \"show\" and\n\t\t\t\t// there is still data from a stopped show/hide\n\t\t\t\tif ( value === \"show\" && dataShow && dataShow[ prop ] !== undefined ) {\n\t\t\t\t\thidden = true;\n\n\t\t\t\t// Ignore all other no-op show/hide data\n\t\t\t\t} else {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\t\t\torig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop );\n\t\t}\n\t}\n\n\t// Bail out if this is a no-op like .hide().hide()\n\tpropTween = !jQuery.isEmptyObject( props );\n\tif ( !propTween && jQuery.isEmptyObject( orig ) ) {\n\t\treturn;\n\t}\n\n\t// Restrict \"overflow\" and \"display\" styles during box animations\n\tif ( isBox && elem.nodeType === 1 ) {\n\n\t\t// Support: IE <=9 - 11, Edge 12 - 15\n\t\t// Record all 3 overflow attributes because IE does not infer the shorthand\n\t\t// from identically-valued overflowX and overflowY and Edge just mirrors\n\t\t// the overflowX value there.\n\t\topts.overflow = [ style.overflow, style.overflowX, style.overflowY ];\n\n\t\t// Identify a display type, preferring old show/hide data over the CSS cascade\n\t\trestoreDisplay = dataShow && dataShow.display;\n\t\tif ( restoreDisplay == null ) {\n\t\t\trestoreDisplay = dataPriv.get( elem, \"display\" );\n\t\t}\n\t\tdisplay = jQuery.css( elem, \"display\" );\n\t\tif ( display === \"none\" ) {\n\t\t\tif ( restoreDisplay ) {\n\t\t\t\tdisplay = restoreDisplay;\n\t\t\t} else {\n\n\t\t\t\t// Get nonempty value(s) by temporarily forcing visibility\n\t\t\t\tshowHide( [ elem ], true );\n\t\t\t\trestoreDisplay = elem.style.display || restoreDisplay;\n\t\t\t\tdisplay = jQuery.css( elem, \"display\" );\n\t\t\t\tshowHide( [ elem ] );\n\t\t\t}\n\t\t}\n\n\t\t// Animate inline elements as inline-block\n\t\tif ( display === \"inline\" || display === \"inline-block\" && restoreDisplay != null ) {\n\t\t\tif ( jQuery.css( elem, \"float\" ) === \"none\" ) {\n\n\t\t\t\t// Restore the original display value at the end of pure show/hide animations\n\t\t\t\tif ( !propTween ) {\n\t\t\t\t\tanim.done( function() {\n\t\t\t\t\t\tstyle.display = restoreDisplay;\n\t\t\t\t\t} );\n\t\t\t\t\tif ( restoreDisplay == null ) {\n\t\t\t\t\t\tdisplay = style.display;\n\t\t\t\t\t\trestoreDisplay = display === \"none\" ? \"\" : display;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tstyle.display = \"inline-block\";\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( opts.overflow ) {\n\t\tstyle.overflow = \"hidden\";\n\t\tanim.always( function() {\n\t\t\tstyle.overflow = opts.overflow[ 0 ];\n\t\t\tstyle.overflowX = opts.overflow[ 1 ];\n\t\t\tstyle.overflowY = opts.overflow[ 2 ];\n\t\t} );\n\t}\n\n\t// Implement show/hide animations\n\tpropTween = false;\n\tfor ( prop in orig ) {\n\n\t\t// General show/hide setup for this element animation\n\t\tif ( !propTween ) {\n\t\t\tif ( dataShow ) {\n\t\t\t\tif ( \"hidden\" in dataShow ) {\n\t\t\t\t\thidden = dataShow.hidden;\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tdataShow = dataPriv.access( elem, \"fxshow\", { display: restoreDisplay } );\n\t\t\t}\n\n\t\t\t// Store hidden/visible for toggle so `.stop().toggle()` \"reverses\"\n\t\t\tif ( toggle ) {\n\t\t\t\tdataShow.hidden = !hidden;\n\t\t\t}\n\n\t\t\t// Show elements before animating them\n\t\t\tif ( hidden ) {\n\t\t\t\tshowHide( [ elem ], true );\n\t\t\t}\n\n\t\t\t/* eslint-disable no-loop-func */\n\n\t\t\tanim.done( function() {\n\n\t\t\t/* eslint-enable no-loop-func */\n\n\t\t\t\t// The final step of a \"hide\" animation is actually hiding the element\n\t\t\t\tif ( !hidden ) {\n\t\t\t\t\tshowHide( [ elem ] );\n\t\t\t\t}\n\t\t\t\tdataPriv.remove( elem, \"fxshow\" );\n\t\t\t\tfor ( prop in orig ) {\n\t\t\t\t\tjQuery.style( elem, prop, orig[ prop ] );\n\t\t\t\t}\n\t\t\t} );\n\t\t}\n\n\t\t// Per-property setup\n\t\tpropTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim );\n\t\tif ( !( prop in dataShow ) ) {\n\t\t\tdataShow[ prop ] = propTween.start;\n\t\t\tif ( hidden ) {\n\t\t\t\tpropTween.end = propTween.start;\n\t\t\t\tpropTween.start = 0;\n\t\t\t}\n\t\t}\n\t}\n}\n\nfunction propFilter( props, specialEasing ) {\n\tvar index, name, easing, value, hooks;\n\n\t// camelCase, specialEasing and expand cssHook pass\n\tfor ( index in props ) {\n\t\tname = camelCase( index );\n\t\teasing = specialEasing[ name ];\n\t\tvalue = props[ index ];\n\t\tif ( Array.isArray( value ) ) {\n\t\t\teasing = value[ 1 ];\n\t\t\tvalue = props[ index ] = value[ 0 ];\n\t\t}\n\n\t\tif ( index !== name ) {\n\t\t\tprops[ name ] = value;\n\t\t\tdelete props[ index ];\n\t\t}\n\n\t\thooks = jQuery.cssHooks[ name ];\n\t\tif ( hooks && \"expand\" in hooks ) {\n\t\t\tvalue = hooks.expand( value );\n\t\t\tdelete props[ name ];\n\n\t\t\t// Not quite $.extend, this won't overwrite existing keys.\n\t\t\t// Reusing 'index' because we have the correct \"name\"\n\t\t\tfor ( index in value ) {\n\t\t\t\tif ( !( index in props ) ) {\n\t\t\t\t\tprops[ index ] = value[ index ];\n\t\t\t\t\tspecialEasing[ index ] = easing;\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tspecialEasing[ name ] = easing;\n\t\t}\n\t}\n}\n\nfunction Animation( elem, properties, options ) {\n\tvar result,\n\t\tstopped,\n\t\tindex = 0,\n\t\tlength = Animation.prefilters.length,\n\t\tdeferred = jQuery.Deferred().always( function() {\n\n\t\t\t// Don't match elem in the :animated selector\n\t\t\tdelete tick.elem;\n\t\t} ),\n\t\ttick = function() {\n\t\t\tif ( stopped ) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t\tvar currentTime = fxNow || createFxNow(),\n\t\t\t\tremaining = Math.max( 0, animation.startTime + animation.duration - currentTime ),\n\n\t\t\t\t// Support: Android 2.3 only\n\t\t\t\t// Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497)\n\t\t\t\ttemp = remaining / animation.duration || 0,\n\t\t\t\tpercent = 1 - temp,\n\t\t\t\tindex = 0,\n\t\t\t\tlength = animation.tweens.length;\n\n\t\t\tfor ( ; index < length; index++ ) {\n\t\t\t\tanimation.tweens[ index ].run( percent );\n\t\t\t}\n\n\t\t\tdeferred.notifyWith( elem, [ animation, percent, remaining ] );\n\n\t\t\t// If there's more to do, yield\n\t\t\tif ( percent < 1 && length ) {\n\t\t\t\treturn remaining;\n\t\t\t}\n\n\t\t\t// If this was an empty animation, synthesize a final progress notification\n\t\t\tif ( !length ) {\n\t\t\t\tdeferred.notifyWith( elem, [ animation, 1, 0 ] );\n\t\t\t}\n\n\t\t\t// Resolve the animation and report its conclusion\n\t\t\tdeferred.resolveWith( elem, [ animation ] );\n\t\t\treturn false;\n\t\t},\n\t\tanimation = deferred.promise( {\n\t\t\telem: elem,\n\t\t\tprops: jQuery.extend( {}, properties ),\n\t\t\topts: jQuery.extend( true, {\n\t\t\t\tspecialEasing: {},\n\t\t\t\teasing: jQuery.easing._default\n\t\t\t}, options ),\n\t\t\toriginalProperties: properties,\n\t\t\toriginalOptions: options,\n\t\t\tstartTime: fxNow || createFxNow(),\n\t\t\tduration: options.duration,\n\t\t\ttweens: [],\n\t\t\tcreateTween: function( prop, end ) {\n\t\t\t\tvar tween = jQuery.Tween( elem, animation.opts, prop, end,\n\t\t\t\t\t\tanimation.opts.specialEasing[ prop ] || animation.opts.easing );\n\t\t\t\tanimation.tweens.push( tween );\n\t\t\t\treturn tween;\n\t\t\t},\n\t\t\tstop: function( gotoEnd ) {\n\t\t\t\tvar index = 0,\n\n\t\t\t\t\t// If we are going to the end, we want to run all the tweens\n\t\t\t\t\t// otherwise we skip this part\n\t\t\t\t\tlength = gotoEnd ? animation.tweens.length : 0;\n\t\t\t\tif ( stopped ) {\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\t\t\t\tstopped = true;\n\t\t\t\tfor ( ; index < length; index++ ) {\n\t\t\t\t\tanimation.tweens[ index ].run( 1 );\n\t\t\t\t}\n\n\t\t\t\t// Resolve when we played the last frame; otherwise, reject\n\t\t\t\tif ( gotoEnd ) {\n\t\t\t\t\tdeferred.notifyWith( elem, [ animation, 1, 0 ] );\n\t\t\t\t\tdeferred.resolveWith( elem, [ animation, gotoEnd ] );\n\t\t\t\t} else {\n\t\t\t\t\tdeferred.rejectWith( elem, [ animation, gotoEnd ] );\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t}\n\t\t} ),\n\t\tprops = animation.props;\n\n\tpropFilter( props, animation.opts.specialEasing );\n\n\tfor ( ; index < length; index++ ) {\n\t\tresult = Animation.prefilters[ index ].call( animation, elem, props, animation.opts );\n\t\tif ( result ) {\n\t\t\tif ( isFunction( result.stop ) ) {\n\t\t\t\tjQuery._queueHooks( animation.elem, animation.opts.queue ).stop =\n\t\t\t\t\tresult.stop.bind( result );\n\t\t\t}\n\t\t\treturn result;\n\t\t}\n\t}\n\n\tjQuery.map( props, createTween, animation );\n\n\tif ( isFunction( animation.opts.start ) ) {\n\t\tanimation.opts.start.call( elem, animation );\n\t}\n\n\t// Attach callbacks from options\n\tanimation\n\t\t.progress( animation.opts.progress )\n\t\t.done( animation.opts.done, animation.opts.complete )\n\t\t.fail( animation.opts.fail )\n\t\t.always( animation.opts.always );\n\n\tjQuery.fx.timer(\n\t\tjQuery.extend( tick, {\n\t\t\telem: elem,\n\t\t\tanim: animation,\n\t\t\tqueue: animation.opts.queue\n\t\t} )\n\t);\n\n\treturn animation;\n}\n\njQuery.Animation = jQuery.extend( Animation, {\n\n\ttweeners: {\n\t\t\"*\": [ function( prop, value ) {\n\t\t\tvar tween = this.createTween( prop, value );\n\t\t\tadjustCSS( tween.elem, prop, rcssNum.exec( value ), tween );\n\t\t\treturn tween;\n\t\t} ]\n\t},\n\n\ttweener: function( props, callback ) {\n\t\tif ( isFunction( props ) ) {\n\t\t\tcallback = props;\n\t\t\tprops = [ \"*\" ];\n\t\t} else {\n\t\t\tprops = props.match( rnothtmlwhite );\n\t\t}\n\n\t\tvar prop,\n\t\t\tindex = 0,\n\t\t\tlength = props.length;\n\n\t\tfor ( ; index < length; index++ ) {\n\t\t\tprop = props[ index ];\n\t\t\tAnimation.tweeners[ prop ] = Animation.tweeners[ prop ] || [];\n\t\t\tAnimation.tweeners[ prop ].unshift( callback );\n\t\t}\n\t},\n\n\tprefilters: [ defaultPrefilter ],\n\n\tprefilter: function( callback, prepend ) {\n\t\tif ( prepend ) {\n\t\t\tAnimation.prefilters.unshift( callback );\n\t\t} else {\n\t\t\tAnimation.prefilters.push( callback );\n\t\t}\n\t}\n} );\n\njQuery.speed = function( speed, easing, fn ) {\n\tvar opt = speed && typeof speed === \"object\" ? jQuery.extend( {}, speed ) : {\n\t\tcomplete: fn || !fn && easing ||\n\t\t\tisFunction( speed ) && speed,\n\t\tduration: speed,\n\t\teasing: fn && easing || easing && !isFunction( easing ) && easing\n\t};\n\n\t// Go to the end state if fx are off\n\tif ( jQuery.fx.off ) {\n\t\topt.duration = 0;\n\n\t} else {\n\t\tif ( typeof opt.duration !== \"number\" ) {\n\t\t\tif ( opt.duration in jQuery.fx.speeds ) {\n\t\t\t\topt.duration = jQuery.fx.speeds[ opt.duration ];\n\n\t\t\t} else {\n\t\t\t\topt.duration = jQuery.fx.speeds._default;\n\t\t\t}\n\t\t}\n\t}\n\n\t// Normalize opt.queue - true/undefined/null -> \"fx\"\n\tif ( opt.queue == null || opt.queue === true ) {\n\t\topt.queue = \"fx\";\n\t}\n\n\t// Queueing\n\topt.old = opt.complete;\n\n\topt.complete = function() {\n\t\tif ( isFunction( opt.old ) ) {\n\t\t\topt.old.call( this );\n\t\t}\n\n\t\tif ( opt.queue ) {\n\t\t\tjQuery.dequeue( this, opt.queue );\n\t\t}\n\t};\n\n\treturn opt;\n};\n\njQuery.fn.extend( {\n\tfadeTo: function( speed, to, easing, callback ) {\n\n\t\t// Show any hidden elements after setting opacity to 0\n\t\treturn this.filter( isHiddenWithinTree ).css( \"opacity\", 0 ).show()\n\n\t\t\t// Animate to the value specified\n\t\t\t.end().animate( { opacity: to }, speed, easing, callback );\n\t},\n\tanimate: function( prop, speed, easing, callback ) {\n\t\tvar empty = jQuery.isEmptyObject( prop ),\n\t\t\toptall = jQuery.speed( speed, easing, callback ),\n\t\t\tdoAnimation = function() {\n\n\t\t\t\t// Operate on a copy of prop so per-property easing won't be lost\n\t\t\t\tvar anim = Animation( this, jQuery.extend( {}, prop ), optall );\n\n\t\t\t\t// Empty animations, or finishing resolves immediately\n\t\t\t\tif ( empty || dataPriv.get( this, \"finish\" ) ) {\n\t\t\t\t\tanim.stop( true );\n\t\t\t\t}\n\t\t\t};\n\t\t\tdoAnimation.finish = doAnimation;\n\n\t\treturn empty || optall.queue === false ?\n\t\t\tthis.each( doAnimation ) :\n\t\t\tthis.queue( optall.queue, doAnimation );\n\t},\n\tstop: function( type, clearQueue, gotoEnd ) {\n\t\tvar stopQueue = function( hooks ) {\n\t\t\tvar stop = hooks.stop;\n\t\t\tdelete hooks.stop;\n\t\t\tstop( gotoEnd );\n\t\t};\n\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tgotoEnd = clearQueue;\n\t\t\tclearQueue = type;\n\t\t\ttype = undefined;\n\t\t}\n\t\tif ( clearQueue ) {\n\t\t\tthis.queue( type || \"fx\", [] );\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tvar dequeue = true,\n\t\t\t\tindex = type != null && type + \"queueHooks\",\n\t\t\t\ttimers = jQuery.timers,\n\t\t\t\tdata = dataPriv.get( this );\n\n\t\t\tif ( index ) {\n\t\t\t\tif ( data[ index ] && data[ index ].stop ) {\n\t\t\t\t\tstopQueue( data[ index ] );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( index in data ) {\n\t\t\t\t\tif ( data[ index ] && data[ index ].stop && rrun.test( index ) ) {\n\t\t\t\t\t\tstopQueue( data[ index ] );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tfor ( index = timers.length; index--; ) {\n\t\t\t\tif ( timers[ index ].elem === this &&\n\t\t\t\t\t( type == null || timers[ index ].queue === type ) ) {\n\n\t\t\t\t\ttimers[ index ].anim.stop( gotoEnd );\n\t\t\t\t\tdequeue = false;\n\t\t\t\t\ttimers.splice( index, 1 );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Start the next in the queue if the last step wasn't forced.\n\t\t\t// Timers currently will call their complete callbacks, which\n\t\t\t// will dequeue but only if they were gotoEnd.\n\t\t\tif ( dequeue || !gotoEnd ) {\n\t\t\t\tjQuery.dequeue( this, type );\n\t\t\t}\n\t\t} );\n\t},\n\tfinish: function( type ) {\n\t\tif ( type !== false ) {\n\t\t\ttype = type || \"fx\";\n\t\t}\n\t\treturn this.each( function() {\n\t\t\tvar index,\n\t\t\t\tdata = dataPriv.get( this ),\n\t\t\t\tqueue = data[ type + \"queue\" ],\n\t\t\t\thooks = data[ type + \"queueHooks\" ],\n\t\t\t\ttimers = jQuery.timers,\n\t\t\t\tlength = queue ? queue.length : 0;\n\n\t\t\t// Enable finishing flag on private data\n\t\t\tdata.finish = true;\n\n\t\t\t// Empty the queue first\n\t\t\tjQuery.queue( this, type, [] );\n\n\t\t\tif ( hooks && hooks.stop ) {\n\t\t\t\thooks.stop.call( this, true );\n\t\t\t}\n\n\t\t\t// Look for any active animations, and finish them\n\t\t\tfor ( index = timers.length; index--; ) {\n\t\t\t\tif ( timers[ index ].elem === this && timers[ index ].queue === type ) {\n\t\t\t\t\ttimers[ index ].anim.stop( true );\n\t\t\t\t\ttimers.splice( index, 1 );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Look for any animations in the old queue and finish them\n\t\t\tfor ( index = 0; index < length; index++ ) {\n\t\t\t\tif ( queue[ index ] && queue[ index ].finish ) {\n\t\t\t\t\tqueue[ index ].finish.call( this );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Turn off finishing flag\n\t\t\tdelete data.finish;\n\t\t} );\n\t}\n} );\n\njQuery.each( [ \"toggle\", \"show\", \"hide\" ], function( _i, name ) {\n\tvar cssFn = jQuery.fn[ name ];\n\tjQuery.fn[ name ] = function( speed, easing, callback ) {\n\t\treturn speed == null || typeof speed === \"boolean\" ?\n\t\t\tcssFn.apply( this, arguments ) :\n\t\t\tthis.animate( genFx( name, true ), speed, easing, callback );\n\t};\n} );\n\n// Generate shortcuts for custom animations\njQuery.each( {\n\tslideDown: genFx( \"show\" ),\n\tslideUp: genFx( \"hide\" ),\n\tslideToggle: genFx( \"toggle\" ),\n\tfadeIn: { opacity: \"show\" },\n\tfadeOut: { opacity: \"hide\" },\n\tfadeToggle: { opacity: \"toggle\" }\n}, function( name, props ) {\n\tjQuery.fn[ name ] = function( speed, easing, callback ) {\n\t\treturn this.animate( props, speed, easing, callback );\n\t};\n} );\n\njQuery.timers = [];\njQuery.fx.tick = function() {\n\tvar timer,\n\t\ti = 0,\n\t\ttimers = jQuery.timers;\n\n\tfxNow = Date.now();\n\n\tfor ( ; i < timers.length; i++ ) {\n\t\ttimer = timers[ i ];\n\n\t\t// Run the timer and safely remove it when done (allowing for external removal)\n\t\tif ( !timer() && timers[ i ] === timer ) {\n\t\t\ttimers.splice( i--, 1 );\n\t\t}\n\t}\n\n\tif ( !timers.length ) {\n\t\tjQuery.fx.stop();\n\t}\n\tfxNow = undefined;\n};\n\njQuery.fx.timer = function( timer ) {\n\tjQuery.timers.push( timer );\n\tjQuery.fx.start();\n};\n\njQuery.fx.interval = 13;\njQuery.fx.start = function() {\n\tif ( inProgress ) {\n\t\treturn;\n\t}\n\n\tinProgress = true;\n\tschedule();\n};\n\njQuery.fx.stop = function() {\n\tinProgress = null;\n};\n\njQuery.fx.speeds = {\n\tslow: 600,\n\tfast: 200,\n\n\t// Default speed\n\t_default: 400\n};\n\n\n// Based off of the plugin by Clint Helfers, with permission.\n// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/\njQuery.fn.delay = function( time, type ) {\n\ttime = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;\n\ttype = type || \"fx\";\n\n\treturn this.queue( type, function( next, hooks ) {\n\t\tvar timeout = window.setTimeout( next, time );\n\t\thooks.stop = function() {\n\t\t\twindow.clearTimeout( timeout );\n\t\t};\n\t} );\n};\n\n\n( function() {\n\tvar input = document.createElement( \"input\" ),\n\t\tselect = document.createElement( \"select\" ),\n\t\topt = select.appendChild( document.createElement( \"option\" ) );\n\n\tinput.type = \"checkbox\";\n\n\t// Support: Android <=4.3 only\n\t// Default value for a checkbox should be \"on\"\n\tsupport.checkOn = input.value !== \"\";\n\n\t// Support: IE <=11 only\n\t// Must access selectedIndex to make default options select\n\tsupport.optSelected = opt.selected;\n\n\t// Support: IE <=11 only\n\t// An input loses its value after becoming a radio\n\tinput = document.createElement( \"input\" );\n\tinput.value = \"t\";\n\tinput.type = \"radio\";\n\tsupport.radioValue = input.value === \"t\";\n} )();\n\n\nvar boolHook,\n\tattrHandle = jQuery.expr.attrHandle;\n\njQuery.fn.extend( {\n\tattr: function( name, value ) {\n\t\treturn access( this, jQuery.attr, name, value, arguments.length > 1 );\n\t},\n\n\tremoveAttr: function( name ) {\n\t\treturn this.each( function() {\n\t\t\tjQuery.removeAttr( this, name );\n\t\t} );\n\t}\n} );\n\njQuery.extend( {\n\tattr: function( elem, name, value ) {\n\t\tvar ret, hooks,\n\t\t\tnType = elem.nodeType;\n\n\t\t// Don't get/set attributes on text, comment and attribute nodes\n\t\tif ( nType === 3 || nType === 8 || nType === 2 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Fallback to prop when attributes are not supported\n\t\tif ( typeof elem.getAttribute === \"undefined\" ) {\n\t\t\treturn jQuery.prop( elem, name, value );\n\t\t}\n\n\t\t// Attribute hooks are determined by the lowercase version\n\t\t// Grab necessary hook if one is defined\n\t\tif ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {\n\t\t\thooks = jQuery.attrHooks[ name.toLowerCase() ] ||\n\t\t\t\t( jQuery.expr.match.bool.test( name ) ? boolHook : undefined );\n\t\t}\n\n\t\tif ( value !== undefined ) {\n\t\t\tif ( value === null ) {\n\t\t\t\tjQuery.removeAttr( elem, name );\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif ( hooks && \"set\" in hooks &&\n\t\t\t\t( ret = hooks.set( elem, value, name ) ) !== undefined ) {\n\t\t\t\treturn ret;\n\t\t\t}\n\n\t\t\telem.setAttribute( name, value + \"\" );\n\t\t\treturn value;\n\t\t}\n\n\t\tif ( hooks && \"get\" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {\n\t\t\treturn ret;\n\t\t}\n\n\t\tret = jQuery.find.attr( elem, name );\n\n\t\t// Non-existent attributes return null, we normalize to undefined\n\t\treturn ret == null ? undefined : ret;\n\t},\n\n\tattrHooks: {\n\t\ttype: {\n\t\t\tset: function( elem, value ) {\n\t\t\t\tif ( !support.radioValue && value === \"radio\" &&\n\t\t\t\t\tnodeName( elem, \"input\" ) ) {\n\t\t\t\t\tvar val = elem.value;\n\t\t\t\t\telem.setAttribute( \"type\", value );\n\t\t\t\t\tif ( val ) {\n\t\t\t\t\t\telem.value = val;\n\t\t\t\t\t}\n\t\t\t\t\treturn value;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t},\n\n\tremoveAttr: function( elem, value ) {\n\t\tvar name,\n\t\t\ti = 0,\n\n\t\t\t// Attribute names can contain non-HTML whitespace characters\n\t\t\t// https://html.spec.whatwg.org/multipage/syntax.html#attributes-2\n\t\t\tattrNames = value && value.match( rnothtmlwhite );\n\n\t\tif ( attrNames && elem.nodeType === 1 ) {\n\t\t\twhile ( ( name = attrNames[ i++ ] ) ) {\n\t\t\t\telem.removeAttribute( name );\n\t\t\t}\n\t\t}\n\t}\n} );\n\n// Hooks for boolean attributes\nboolHook = {\n\tset: function( elem, value, name ) {\n\t\tif ( value === false ) {\n\n\t\t\t// Remove boolean attributes when set to false\n\t\t\tjQuery.removeAttr( elem, name );\n\t\t} else {\n\t\t\telem.setAttribute( name, name );\n\t\t}\n\t\treturn name;\n\t}\n};\n\njQuery.each( jQuery.expr.match.bool.source.match( /\\w+/g ), function( _i, name ) {\n\tvar getter = attrHandle[ name ] || jQuery.find.attr;\n\n\tattrHandle[ name ] = function( elem, name, isXML ) {\n\t\tvar ret, handle,\n\t\t\tlowercaseName = name.toLowerCase();\n\n\t\tif ( !isXML ) {\n\n\t\t\t// Avoid an infinite loop by temporarily removing this function from the getter\n\t\t\thandle = attrHandle[ lowercaseName ];\n\t\t\tattrHandle[ lowercaseName ] = ret;\n\t\t\tret = getter( elem, name, isXML ) != null ?\n\t\t\t\tlowercaseName :\n\t\t\t\tnull;\n\t\t\tattrHandle[ lowercaseName ] = handle;\n\t\t}\n\t\treturn ret;\n\t};\n} );\n\n\n\n\nvar rfocusable = /^(?:input|select|textarea|button)$/i,\n\trclickable = /^(?:a|area)$/i;\n\njQuery.fn.extend( {\n\tprop: function( name, value ) {\n\t\treturn access( this, jQuery.prop, name, value, arguments.length > 1 );\n\t},\n\n\tremoveProp: function( name ) {\n\t\treturn this.each( function() {\n\t\t\tdelete this[ jQuery.propFix[ name ] || name ];\n\t\t} );\n\t}\n} );\n\njQuery.extend( {\n\tprop: function( elem, name, value ) {\n\t\tvar ret, hooks,\n\t\t\tnType = elem.nodeType;\n\n\t\t// Don't get/set properties on text, comment and attribute nodes\n\t\tif ( nType === 3 || nType === 8 || nType === 2 ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {\n\n\t\t\t// Fix name and attach hooks\n\t\t\tname = jQuery.propFix[ name ] || name;\n\t\t\thooks = jQuery.propHooks[ name ];\n\t\t}\n\n\t\tif ( value !== undefined ) {\n\t\t\tif ( hooks && \"set\" in hooks &&\n\t\t\t\t( ret = hooks.set( elem, value, name ) ) !== undefined ) {\n\t\t\t\treturn ret;\n\t\t\t}\n\n\t\t\treturn ( elem[ name ] = value );\n\t\t}\n\n\t\tif ( hooks && \"get\" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {\n\t\t\treturn ret;\n\t\t}\n\n\t\treturn elem[ name ];\n\t},\n\n\tpropHooks: {\n\t\ttabIndex: {\n\t\t\tget: function( elem ) {\n\n\t\t\t\t// Support: IE <=9 - 11 only\n\t\t\t\t// elem.tabIndex doesn't always return the\n\t\t\t\t// correct value when it hasn't been explicitly set\n\t\t\t\t// https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/\n\t\t\t\t// Use proper attribute retrieval(#12072)\n\t\t\t\tvar tabindex = jQuery.find.attr( elem, \"tabindex\" );\n\n\t\t\t\tif ( tabindex ) {\n\t\t\t\t\treturn parseInt( tabindex, 10 );\n\t\t\t\t}\n\n\t\t\t\tif (\n\t\t\t\t\trfocusable.test( elem.nodeName ) ||\n\t\t\t\t\trclickable.test( elem.nodeName ) &&\n\t\t\t\t\telem.href\n\t\t\t\t) {\n\t\t\t\t\treturn 0;\n\t\t\t\t}\n\n\t\t\t\treturn -1;\n\t\t\t}\n\t\t}\n\t},\n\n\tpropFix: {\n\t\t\"for\": \"htmlFor\",\n\t\t\"class\": \"className\"\n\t}\n} );\n\n// Support: IE <=11 only\n// Accessing the selectedIndex property\n// forces the browser to respect setting selected\n// on the option\n// The getter ensures a default option is selected\n// when in an optgroup\n// eslint rule \"no-unused-expressions\" is disabled for this code\n// since it considers such accessions noop\nif ( !support.optSelected ) {\n\tjQuery.propHooks.selected = {\n\t\tget: function( elem ) {\n\n\t\t\t/* eslint no-unused-expressions: \"off\" */\n\n\t\t\tvar parent = elem.parentNode;\n\t\t\tif ( parent && parent.parentNode ) {\n\t\t\t\tparent.parentNode.selectedIndex;\n\t\t\t}\n\t\t\treturn null;\n\t\t},\n\t\tset: function( elem ) {\n\n\t\t\t/* eslint no-unused-expressions: \"off\" */\n\n\t\t\tvar parent = elem.parentNode;\n\t\t\tif ( parent ) {\n\t\t\t\tparent.selectedIndex;\n\n\t\t\t\tif ( parent.parentNode ) {\n\t\t\t\t\tparent.parentNode.selectedIndex;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t};\n}\n\njQuery.each( [\n\t\"tabIndex\",\n\t\"readOnly\",\n\t\"maxLength\",\n\t\"cellSpacing\",\n\t\"cellPadding\",\n\t\"rowSpan\",\n\t\"colSpan\",\n\t\"useMap\",\n\t\"frameBorder\",\n\t\"contentEditable\"\n], function() {\n\tjQuery.propFix[ this.toLowerCase() ] = this;\n} );\n\n\n\n\n\t// Strip and collapse whitespace according to HTML spec\n\t// https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace\n\tfunction stripAndCollapse( value ) {\n\t\tvar tokens = value.match( rnothtmlwhite ) || [];\n\t\treturn tokens.join( \" \" );\n\t}\n\n\nfunction getClass( elem ) {\n\treturn elem.getAttribute && elem.getAttribute( \"class\" ) || \"\";\n}\n\nfunction classesToArray( value ) {\n\tif ( Array.isArray( value ) ) {\n\t\treturn value;\n\t}\n\tif ( typeof value === \"string\" ) {\n\t\treturn value.match( rnothtmlwhite ) || [];\n\t}\n\treturn [];\n}\n\njQuery.fn.extend( {\n\taddClass: function( value ) {\n\t\tvar classes, elem, cur, curValue, clazz, j, finalValue,\n\t\t\ti = 0;\n\n\t\tif ( isFunction( value ) ) {\n\t\t\treturn this.each( function( j ) {\n\t\t\t\tjQuery( this ).addClass( value.call( this, j, getClass( this ) ) );\n\t\t\t} );\n\t\t}\n\n\t\tclasses = classesToArray( value );\n\n\t\tif ( classes.length ) {\n\t\t\twhile ( ( elem = this[ i++ ] ) ) {\n\t\t\t\tcurValue = getClass( elem );\n\t\t\t\tcur = elem.nodeType === 1 && ( \" \" + stripAndCollapse( curValue ) + \" \" );\n\n\t\t\t\tif ( cur ) {\n\t\t\t\t\tj = 0;\n\t\t\t\t\twhile ( ( clazz = classes[ j++ ] ) ) {\n\t\t\t\t\t\tif ( cur.indexOf( \" \" + clazz + \" \" ) < 0 ) {\n\t\t\t\t\t\t\tcur += clazz + \" \";\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Only assign if different to avoid unneeded rendering.\n\t\t\t\t\tfinalValue = stripAndCollapse( cur );\n\t\t\t\t\tif ( curValue !== finalValue ) {\n\t\t\t\t\t\telem.setAttribute( \"class\", finalValue );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tremoveClass: function( value ) {\n\t\tvar classes, elem, cur, curValue, clazz, j, finalValue,\n\t\t\ti = 0;\n\n\t\tif ( isFunction( value ) ) {\n\t\t\treturn this.each( function( j ) {\n\t\t\t\tjQuery( this ).removeClass( value.call( this, j, getClass( this ) ) );\n\t\t\t} );\n\t\t}\n\n\t\tif ( !arguments.length ) {\n\t\t\treturn this.attr( \"class\", \"\" );\n\t\t}\n\n\t\tclasses = classesToArray( value );\n\n\t\tif ( classes.length ) {\n\t\t\twhile ( ( elem = this[ i++ ] ) ) {\n\t\t\t\tcurValue = getClass( elem );\n\n\t\t\t\t// This expression is here for better compressibility (see addClass)\n\t\t\t\tcur = elem.nodeType === 1 && ( \" \" + stripAndCollapse( curValue ) + \" \" );\n\n\t\t\t\tif ( cur ) {\n\t\t\t\t\tj = 0;\n\t\t\t\t\twhile ( ( clazz = classes[ j++ ] ) ) {\n\n\t\t\t\t\t\t// Remove *all* instances\n\t\t\t\t\t\twhile ( cur.indexOf( \" \" + clazz + \" \" ) > -1 ) {\n\t\t\t\t\t\t\tcur = cur.replace( \" \" + clazz + \" \", \" \" );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Only assign if different to avoid unneeded rendering.\n\t\t\t\t\tfinalValue = stripAndCollapse( cur );\n\t\t\t\t\tif ( curValue !== finalValue ) {\n\t\t\t\t\t\telem.setAttribute( \"class\", finalValue );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\ttoggleClass: function( value, stateVal ) {\n\t\tvar type = typeof value,\n\t\t\tisValidValue = type === \"string\" || Array.isArray( value );\n\n\t\tif ( typeof stateVal === \"boolean\" && isValidValue ) {\n\t\t\treturn stateVal ? this.addClass( value ) : this.removeClass( value );\n\t\t}\n\n\t\tif ( isFunction( value ) ) {\n\t\t\treturn this.each( function( i ) {\n\t\t\t\tjQuery( this ).toggleClass(\n\t\t\t\t\tvalue.call( this, i, getClass( this ), stateVal ),\n\t\t\t\t\tstateVal\n\t\t\t\t);\n\t\t\t} );\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tvar className, i, self, classNames;\n\n\t\t\tif ( isValidValue ) {\n\n\t\t\t\t// Toggle individual class names\n\t\t\t\ti = 0;\n\t\t\t\tself = jQuery( this );\n\t\t\t\tclassNames = classesToArray( value );\n\n\t\t\t\twhile ( ( className = classNames[ i++ ] ) ) {\n\n\t\t\t\t\t// Check each className given, space separated list\n\t\t\t\t\tif ( self.hasClass( className ) ) {\n\t\t\t\t\t\tself.removeClass( className );\n\t\t\t\t\t} else {\n\t\t\t\t\t\tself.addClass( className );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t// Toggle whole class name\n\t\t\t} else if ( value === undefined || type === \"boolean\" ) {\n\t\t\t\tclassName = getClass( this );\n\t\t\t\tif ( className ) {\n\n\t\t\t\t\t// Store className if set\n\t\t\t\t\tdataPriv.set( this, \"__className__\", className );\n\t\t\t\t}\n\n\t\t\t\t// If the element has a class name or if we're passed `false`,\n\t\t\t\t// then remove the whole classname (if there was one, the above saved it).\n\t\t\t\t// Otherwise bring back whatever was previously saved (if anything),\n\t\t\t\t// falling back to the empty string if nothing was stored.\n\t\t\t\tif ( this.setAttribute ) {\n\t\t\t\t\tthis.setAttribute( \"class\",\n\t\t\t\t\t\tclassName || value === false ?\n\t\t\t\t\t\t\"\" :\n\t\t\t\t\t\tdataPriv.get( this, \"__className__\" ) || \"\"\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\t\t} );\n\t},\n\n\thasClass: function( selector ) {\n\t\tvar className, elem,\n\t\t\ti = 0;\n\n\t\tclassName = \" \" + selector + \" \";\n\t\twhile ( ( elem = this[ i++ ] ) ) {\n\t\t\tif ( elem.nodeType === 1 &&\n\t\t\t\t( \" \" + stripAndCollapse( getClass( elem ) ) + \" \" ).indexOf( className ) > -1 ) {\n\t\t\t\t\treturn true;\n\t\t\t}\n\t\t}\n\n\t\treturn false;\n\t}\n} );\n\n\n\n\nvar rreturn = /\\r/g;\n\njQuery.fn.extend( {\n\tval: function( value ) {\n\t\tvar hooks, ret, valueIsFunction,\n\t\t\telem = this[ 0 ];\n\n\t\tif ( !arguments.length ) {\n\t\t\tif ( elem ) {\n\t\t\t\thooks = jQuery.valHooks[ elem.type ] ||\n\t\t\t\t\tjQuery.valHooks[ elem.nodeName.toLowerCase() ];\n\n\t\t\t\tif ( hooks &&\n\t\t\t\t\t\"get\" in hooks &&\n\t\t\t\t\t( ret = hooks.get( elem, \"value\" ) ) !== undefined\n\t\t\t\t) {\n\t\t\t\t\treturn ret;\n\t\t\t\t}\n\n\t\t\t\tret = elem.value;\n\n\t\t\t\t// Handle most common string cases\n\t\t\t\tif ( typeof ret === \"string\" ) {\n\t\t\t\t\treturn ret.replace( rreturn, \"\" );\n\t\t\t\t}\n\n\t\t\t\t// Handle cases where value is null/undef or number\n\t\t\t\treturn ret == null ? \"\" : ret;\n\t\t\t}\n\n\t\t\treturn;\n\t\t}\n\n\t\tvalueIsFunction = isFunction( value );\n\n\t\treturn this.each( function( i ) {\n\t\t\tvar val;\n\n\t\t\tif ( this.nodeType !== 1 ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif ( valueIsFunction ) {\n\t\t\t\tval = value.call( this, i, jQuery( this ).val() );\n\t\t\t} else {\n\t\t\t\tval = value;\n\t\t\t}\n\n\t\t\t// Treat null/undefined as \"\"; convert numbers to string\n\t\t\tif ( val == null ) {\n\t\t\t\tval = \"\";\n\n\t\t\t} else if ( typeof val === \"number\" ) {\n\t\t\t\tval += \"\";\n\n\t\t\t} else if ( Array.isArray( val ) ) {\n\t\t\t\tval = jQuery.map( val, function( value ) {\n\t\t\t\t\treturn value == null ? \"\" : value + \"\";\n\t\t\t\t} );\n\t\t\t}\n\n\t\t\thooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ];\n\n\t\t\t// If set returns undefined, fall back to normal setting\n\t\t\tif ( !hooks || !( \"set\" in hooks ) || hooks.set( this, val, \"value\" ) === undefined ) {\n\t\t\t\tthis.value = val;\n\t\t\t}\n\t\t} );\n\t}\n} );\n\njQuery.extend( {\n\tvalHooks: {\n\t\toption: {\n\t\t\tget: function( elem ) {\n\n\t\t\t\tvar val = jQuery.find.attr( elem, \"value\" );\n\t\t\t\treturn val != null ?\n\t\t\t\t\tval :\n\n\t\t\t\t\t// Support: IE <=10 - 11 only\n\t\t\t\t\t// option.text throws exceptions (#14686, #14858)\n\t\t\t\t\t// Strip and collapse whitespace\n\t\t\t\t\t// https://html.spec.whatwg.org/#strip-and-collapse-whitespace\n\t\t\t\t\tstripAndCollapse( jQuery.text( elem ) );\n\t\t\t}\n\t\t},\n\t\tselect: {\n\t\t\tget: function( elem ) {\n\t\t\t\tvar value, option, i,\n\t\t\t\t\toptions = elem.options,\n\t\t\t\t\tindex = elem.selectedIndex,\n\t\t\t\t\tone = elem.type === \"select-one\",\n\t\t\t\t\tvalues = one ? null : [],\n\t\t\t\t\tmax = one ? index + 1 : options.length;\n\n\t\t\t\tif ( index < 0 ) {\n\t\t\t\t\ti = max;\n\n\t\t\t\t} else {\n\t\t\t\t\ti = one ? index : 0;\n\t\t\t\t}\n\n\t\t\t\t// Loop through all the selected options\n\t\t\t\tfor ( ; i < max; i++ ) {\n\t\t\t\t\toption = options[ i ];\n\n\t\t\t\t\t// Support: IE <=9 only\n\t\t\t\t\t// IE8-9 doesn't update selected after form reset (#2551)\n\t\t\t\t\tif ( ( option.selected || i === index ) &&\n\n\t\t\t\t\t\t\t// Don't return options that are disabled or in a disabled optgroup\n\t\t\t\t\t\t\t!option.disabled &&\n\t\t\t\t\t\t\t( !option.parentNode.disabled ||\n\t\t\t\t\t\t\t\t!nodeName( option.parentNode, \"optgroup\" ) ) ) {\n\n\t\t\t\t\t\t// Get the specific value for the option\n\t\t\t\t\t\tvalue = jQuery( option ).val();\n\n\t\t\t\t\t\t// We don't need an array for one selects\n\t\t\t\t\t\tif ( one ) {\n\t\t\t\t\t\t\treturn value;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// Multi-Selects return an array\n\t\t\t\t\t\tvalues.push( value );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn values;\n\t\t\t},\n\n\t\t\tset: function( elem, value ) {\n\t\t\t\tvar optionSet, option,\n\t\t\t\t\toptions = elem.options,\n\t\t\t\t\tvalues = jQuery.makeArray( value ),\n\t\t\t\t\ti = options.length;\n\n\t\t\t\twhile ( i-- ) {\n\t\t\t\t\toption = options[ i ];\n\n\t\t\t\t\t/* eslint-disable no-cond-assign */\n\n\t\t\t\t\tif ( option.selected =\n\t\t\t\t\t\tjQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1\n\t\t\t\t\t) {\n\t\t\t\t\t\toptionSet = true;\n\t\t\t\t\t}\n\n\t\t\t\t\t/* eslint-enable no-cond-assign */\n\t\t\t\t}\n\n\t\t\t\t// Force browsers to behave consistently when non-matching value is set\n\t\t\t\tif ( !optionSet ) {\n\t\t\t\t\telem.selectedIndex = -1;\n\t\t\t\t}\n\t\t\t\treturn values;\n\t\t\t}\n\t\t}\n\t}\n} );\n\n// Radios and checkboxes getter/setter\njQuery.each( [ \"radio\", \"checkbox\" ], function() {\n\tjQuery.valHooks[ this ] = {\n\t\tset: function( elem, value ) {\n\t\t\tif ( Array.isArray( value ) ) {\n\t\t\t\treturn ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 );\n\t\t\t}\n\t\t}\n\t};\n\tif ( !support.checkOn ) {\n\t\tjQuery.valHooks[ this ].get = function( elem ) {\n\t\t\treturn elem.getAttribute( \"value\" ) === null ? \"on\" : elem.value;\n\t\t};\n\t}\n} );\n\n\n\n\n// Return jQuery for attributes-only inclusion\n\n\nsupport.focusin = \"onfocusin\" in window;\n\n\nvar rfocusMorph = /^(?:focusinfocus|focusoutblur)$/,\n\tstopPropagationCallback = function( e ) {\n\t\te.stopPropagation();\n\t};\n\njQuery.extend( jQuery.event, {\n\n\ttrigger: function( event, data, elem, onlyHandlers ) {\n\n\t\tvar i, cur, tmp, bubbleType, ontype, handle, special, lastElement,\n\t\t\teventPath = [ elem || document ],\n\t\t\ttype = hasOwn.call( event, \"type\" ) ? event.type : event,\n\t\t\tnamespaces = hasOwn.call( event, \"namespace\" ) ? event.namespace.split( \".\" ) : [];\n\n\t\tcur = lastElement = tmp = elem = elem || document;\n\n\t\t// Don't do events on text and comment nodes\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// focus/blur morphs to focusin/out; ensure we're not firing them right now\n\t\tif ( rfocusMorph.test( type + jQuery.event.triggered ) ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( type.indexOf( \".\" ) > -1 ) {\n\n\t\t\t// Namespaced trigger; create a regexp to match event type in handle()\n\t\t\tnamespaces = type.split( \".\" );\n\t\t\ttype = namespaces.shift();\n\t\t\tnamespaces.sort();\n\t\t}\n\t\tontype = type.indexOf( \":\" ) < 0 && \"on\" + type;\n\n\t\t// Caller can pass in a jQuery.Event object, Object, or just an event type string\n\t\tevent = event[ jQuery.expando ] ?\n\t\t\tevent :\n\t\t\tnew jQuery.Event( type, typeof event === \"object\" && event );\n\n\t\t// Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true)\n\t\tevent.isTrigger = onlyHandlers ? 2 : 3;\n\t\tevent.namespace = namespaces.join( \".\" );\n\t\tevent.rnamespace = event.namespace ?\n\t\t\tnew RegExp( \"(^|\\\\.)\" + namespaces.join( \"\\\\.(?:.*\\\\.|)\" ) + \"(\\\\.|$)\" ) :\n\t\t\tnull;\n\n\t\t// Clean up the event in case it is being reused\n\t\tevent.result = undefined;\n\t\tif ( !event.target ) {\n\t\t\tevent.target = elem;\n\t\t}\n\n\t\t// Clone any incoming data and prepend the event, creating the handler arg list\n\t\tdata = data == null ?\n\t\t\t[ event ] :\n\t\t\tjQuery.makeArray( data, [ event ] );\n\n\t\t// Allow special events to draw outside the lines\n\t\tspecial = jQuery.event.special[ type ] || {};\n\t\tif ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Determine event propagation path in advance, per W3C events spec (#9951)\n\t\t// Bubble up to document, then to window; watch for a global ownerDocument var (#9724)\n\t\tif ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) {\n\n\t\t\tbubbleType = special.delegateType || type;\n\t\t\tif ( !rfocusMorph.test( bubbleType + type ) ) {\n\t\t\t\tcur = cur.parentNode;\n\t\t\t}\n\t\t\tfor ( ; cur; cur = cur.parentNode ) {\n\t\t\t\teventPath.push( cur );\n\t\t\t\ttmp = cur;\n\t\t\t}\n\n\t\t\t// Only add window if we got to document (e.g., not plain obj or detached DOM)\n\t\t\tif ( tmp === ( elem.ownerDocument || document ) ) {\n\t\t\t\teventPath.push( tmp.defaultView || tmp.parentWindow || window );\n\t\t\t}\n\t\t}\n\n\t\t// Fire handlers on the event path\n\t\ti = 0;\n\t\twhile ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) {\n\t\t\tlastElement = cur;\n\t\t\tevent.type = i > 1 ?\n\t\t\t\tbubbleType :\n\t\t\t\tspecial.bindType || type;\n\n\t\t\t// jQuery handler\n\t\t\thandle = (\n\t\t\t\t\tdataPriv.get( cur, \"events\" ) || Object.create( null )\n\t\t\t\t)[ event.type ] &&\n\t\t\t\tdataPriv.get( cur, \"handle\" );\n\t\t\tif ( handle ) {\n\t\t\t\thandle.apply( cur, data );\n\t\t\t}\n\n\t\t\t// Native handler\n\t\t\thandle = ontype && cur[ ontype ];\n\t\t\tif ( handle && handle.apply && acceptData( cur ) ) {\n\t\t\t\tevent.result = handle.apply( cur, data );\n\t\t\t\tif ( event.result === false ) {\n\t\t\t\t\tevent.preventDefault();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tevent.type = type;\n\n\t\t// If nobody prevented the default action, do it now\n\t\tif ( !onlyHandlers && !event.isDefaultPrevented() ) {\n\n\t\t\tif ( ( !special._default ||\n\t\t\t\tspecial._default.apply( eventPath.pop(), data ) === false ) &&\n\t\t\t\tacceptData( elem ) ) {\n\n\t\t\t\t// Call a native DOM method on the target with the same name as the event.\n\t\t\t\t// Don't do default actions on window, that's where global variables be (#6170)\n\t\t\t\tif ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) {\n\n\t\t\t\t\t// Don't re-trigger an onFOO event when we call its FOO() method\n\t\t\t\t\ttmp = elem[ ontype ];\n\n\t\t\t\t\tif ( tmp ) {\n\t\t\t\t\t\telem[ ontype ] = null;\n\t\t\t\t\t}\n\n\t\t\t\t\t// Prevent re-triggering of the same event, since we already bubbled it above\n\t\t\t\t\tjQuery.event.triggered = type;\n\n\t\t\t\t\tif ( event.isPropagationStopped() ) {\n\t\t\t\t\t\tlastElement.addEventListener( type, stopPropagationCallback );\n\t\t\t\t\t}\n\n\t\t\t\t\telem[ type ]();\n\n\t\t\t\t\tif ( event.isPropagationStopped() ) {\n\t\t\t\t\t\tlastElement.removeEventListener( type, stopPropagationCallback );\n\t\t\t\t\t}\n\n\t\t\t\t\tjQuery.event.triggered = undefined;\n\n\t\t\t\t\tif ( tmp ) {\n\t\t\t\t\t\telem[ ontype ] = tmp;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn event.result;\n\t},\n\n\t// Piggyback on a donor event to simulate a different one\n\t// Used only for `focus(in | out)` events\n\tsimulate: function( type, elem, event ) {\n\t\tvar e = jQuery.extend(\n\t\t\tnew jQuery.Event(),\n\t\t\tevent,\n\t\t\t{\n\t\t\t\ttype: type,\n\t\t\t\tisSimulated: true\n\t\t\t}\n\t\t);\n\n\t\tjQuery.event.trigger( e, null, elem );\n\t}\n\n} );\n\njQuery.fn.extend( {\n\n\ttrigger: function( type, data ) {\n\t\treturn this.each( function() {\n\t\t\tjQuery.event.trigger( type, data, this );\n\t\t} );\n\t},\n\ttriggerHandler: function( type, data ) {\n\t\tvar elem = this[ 0 ];\n\t\tif ( elem ) {\n\t\t\treturn jQuery.event.trigger( type, data, elem, true );\n\t\t}\n\t}\n} );\n\n\n// Support: Firefox <=44\n// Firefox doesn't have focus(in | out) events\n// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787\n//\n// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1\n// focus(in | out) events fire after focus & blur events,\n// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order\n// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857\nif ( !support.focusin ) {\n\tjQuery.each( { focus: \"focusin\", blur: \"focusout\" }, function( orig, fix ) {\n\n\t\t// Attach a single capturing handler on the document while someone wants focusin/focusout\n\t\tvar handler = function( event ) {\n\t\t\tjQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) );\n\t\t};\n\n\t\tjQuery.event.special[ fix ] = {\n\t\t\tsetup: function() {\n\n\t\t\t\t// Handle: regular nodes (via `this.ownerDocument`), window\n\t\t\t\t// (via `this.document`) & document (via `this`).\n\t\t\t\tvar doc = this.ownerDocument || this.document || this,\n\t\t\t\t\tattaches = dataPriv.access( doc, fix );\n\n\t\t\t\tif ( !attaches ) {\n\t\t\t\t\tdoc.addEventListener( orig, handler, true );\n\t\t\t\t}\n\t\t\t\tdataPriv.access( doc, fix, ( attaches || 0 ) + 1 );\n\t\t\t},\n\t\t\tteardown: function() {\n\t\t\t\tvar doc = this.ownerDocument || this.document || this,\n\t\t\t\t\tattaches = dataPriv.access( doc, fix ) - 1;\n\n\t\t\t\tif ( !attaches ) {\n\t\t\t\t\tdoc.removeEventListener( orig, handler, true );\n\t\t\t\t\tdataPriv.remove( doc, fix );\n\n\t\t\t\t} else {\n\t\t\t\t\tdataPriv.access( doc, fix, attaches );\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t} );\n}\nvar location = window.location;\n\nvar nonce = { guid: Date.now() };\n\nvar rquery = ( /\\?/ );\n\n\n\n// Cross-browser xml parsing\njQuery.parseXML = function( data ) {\n\tvar xml;\n\tif ( !data || typeof data !== \"string\" ) {\n\t\treturn null;\n\t}\n\n\t// Support: IE 9 - 11 only\n\t// IE throws on parseFromString with invalid input.\n\ttry {\n\t\txml = ( new window.DOMParser() ).parseFromString( data, \"text/xml\" );\n\t} catch ( e ) {\n\t\txml = undefined;\n\t}\n\n\tif ( !xml || xml.getElementsByTagName( \"parsererror\" ).length ) {\n\t\tjQuery.error( \"Invalid XML: \" + data );\n\t}\n\treturn xml;\n};\n\n\nvar\n\trbracket = /\\[\\]$/,\n\trCRLF = /\\r?\\n/g,\n\trsubmitterTypes = /^(?:submit|button|image|reset|file)$/i,\n\trsubmittable = /^(?:input|select|textarea|keygen)/i;\n\nfunction buildParams( prefix, obj, traditional, add ) {\n\tvar name;\n\n\tif ( Array.isArray( obj ) ) {\n\n\t\t// Serialize array item.\n\t\tjQuery.each( obj, function( i, v ) {\n\t\t\tif ( traditional || rbracket.test( prefix ) ) {\n\n\t\t\t\t// Treat each array item as a scalar.\n\t\t\t\tadd( prefix, v );\n\n\t\t\t} else {\n\n\t\t\t\t// Item is non-scalar (array or object), encode its numeric index.\n\t\t\t\tbuildParams(\n\t\t\t\t\tprefix + \"[\" + ( typeof v === \"object\" && v != null ? i : \"\" ) + \"]\",\n\t\t\t\t\tv,\n\t\t\t\t\ttraditional,\n\t\t\t\t\tadd\n\t\t\t\t);\n\t\t\t}\n\t\t} );\n\n\t} else if ( !traditional && toType( obj ) === \"object\" ) {\n\n\t\t// Serialize object item.\n\t\tfor ( name in obj ) {\n\t\t\tbuildParams( prefix + \"[\" + name + \"]\", obj[ name ], traditional, add );\n\t\t}\n\n\t} else {\n\n\t\t// Serialize scalar item.\n\t\tadd( prefix, obj );\n\t}\n}\n\n// Serialize an array of form elements or a set of\n// key/values into a query string\njQuery.param = function( a, traditional ) {\n\tvar prefix,\n\t\ts = [],\n\t\tadd = function( key, valueOrFunction ) {\n\n\t\t\t// If value is a function, invoke it and use its return value\n\t\t\tvar value = isFunction( valueOrFunction ) ?\n\t\t\t\tvalueOrFunction() :\n\t\t\t\tvalueOrFunction;\n\n\t\t\ts[ s.length ] = encodeURIComponent( key ) + \"=\" +\n\t\t\t\tencodeURIComponent( value == null ? \"\" : value );\n\t\t};\n\n\tif ( a == null ) {\n\t\treturn \"\";\n\t}\n\n\t// If an array was passed in, assume that it is an array of form elements.\n\tif ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {\n\n\t\t// Serialize the form elements\n\t\tjQuery.each( a, function() {\n\t\t\tadd( this.name, this.value );\n\t\t} );\n\n\t} else {\n\n\t\t// If traditional, encode the \"old\" way (the way 1.3.2 or older\n\t\t// did it), otherwise encode params recursively.\n\t\tfor ( prefix in a ) {\n\t\t\tbuildParams( prefix, a[ prefix ], traditional, add );\n\t\t}\n\t}\n\n\t// Return the resulting serialization\n\treturn s.join( \"&\" );\n};\n\njQuery.fn.extend( {\n\tserialize: function() {\n\t\treturn jQuery.param( this.serializeArray() );\n\t},\n\tserializeArray: function() {\n\t\treturn this.map( function() {\n\n\t\t\t// Can add propHook for \"elements\" to filter or add form elements\n\t\t\tvar elements = jQuery.prop( this, \"elements\" );\n\t\t\treturn elements ? jQuery.makeArray( elements ) : this;\n\t\t} )\n\t\t.filter( function() {\n\t\t\tvar type = this.type;\n\n\t\t\t// Use .is( \":disabled\" ) so that fieldset[disabled] works\n\t\t\treturn this.name && !jQuery( this ).is( \":disabled\" ) &&\n\t\t\t\trsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) &&\n\t\t\t\t( this.checked || !rcheckableType.test( type ) );\n\t\t} )\n\t\t.map( function( _i, elem ) {\n\t\t\tvar val = jQuery( this ).val();\n\n\t\t\tif ( val == null ) {\n\t\t\t\treturn null;\n\t\t\t}\n\n\t\t\tif ( Array.isArray( val ) ) {\n\t\t\t\treturn jQuery.map( val, function( val ) {\n\t\t\t\t\treturn { name: elem.name, value: val.replace( rCRLF, \"\\r\\n\" ) };\n\t\t\t\t} );\n\t\t\t}\n\n\t\t\treturn { name: elem.name, value: val.replace( rCRLF, \"\\r\\n\" ) };\n\t\t} ).get();\n\t}\n} );\n\n\nvar\n\tr20 = /%20/g,\n\trhash = /#.*$/,\n\trantiCache = /([?&])_=[^&]*/,\n\trheaders = /^(.*?):[ \\t]*([^\\r\\n]*)$/mg,\n\n\t// #7653, #8125, #8152: local protocol detection\n\trlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,\n\trnoContent = /^(?:GET|HEAD)$/,\n\trprotocol = /^\\/\\//,\n\n\t/* Prefilters\n\t * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)\n\t * 2) These are called:\n\t * - BEFORE asking for a transport\n\t * - AFTER param serialization (s.data is a string if s.processData is true)\n\t * 3) key is the dataType\n\t * 4) the catchall symbol \"*\" can be used\n\t * 5) execution will start with transport dataType and THEN continue down to \"*\" if needed\n\t */\n\tprefilters = {},\n\n\t/* Transports bindings\n\t * 1) key is the dataType\n\t * 2) the catchall symbol \"*\" can be used\n\t * 3) selection will start with transport dataType and THEN go to \"*\" if needed\n\t */\n\ttransports = {},\n\n\t// Avoid comment-prolog char sequence (#10098); must appease lint and evade compression\n\tallTypes = \"*/\".concat( \"*\" ),\n\n\t// Anchor tag for parsing the document origin\n\toriginAnchor = document.createElement( \"a\" );\n\toriginAnchor.href = location.href;\n\n// Base \"constructor\" for jQuery.ajaxPrefilter and jQuery.ajaxTransport\nfunction addToPrefiltersOrTransports( structure ) {\n\n\t// dataTypeExpression is optional and defaults to \"*\"\n\treturn function( dataTypeExpression, func ) {\n\n\t\tif ( typeof dataTypeExpression !== \"string\" ) {\n\t\t\tfunc = dataTypeExpression;\n\t\t\tdataTypeExpression = \"*\";\n\t\t}\n\n\t\tvar dataType,\n\t\t\ti = 0,\n\t\t\tdataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || [];\n\n\t\tif ( isFunction( func ) ) {\n\n\t\t\t// For each dataType in the dataTypeExpression\n\t\t\twhile ( ( dataType = dataTypes[ i++ ] ) ) {\n\n\t\t\t\t// Prepend if requested\n\t\t\t\tif ( dataType[ 0 ] === \"+\" ) {\n\t\t\t\t\tdataType = dataType.slice( 1 ) || \"*\";\n\t\t\t\t\t( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func );\n\n\t\t\t\t// Otherwise append\n\t\t\t\t} else {\n\t\t\t\t\t( structure[ dataType ] = structure[ dataType ] || [] ).push( func );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t};\n}\n\n// Base inspection function for prefilters and transports\nfunction inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) {\n\n\tvar inspected = {},\n\t\tseekingTransport = ( structure === transports );\n\n\tfunction inspect( dataType ) {\n\t\tvar selected;\n\t\tinspected[ dataType ] = true;\n\t\tjQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) {\n\t\t\tvar dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR );\n\t\t\tif ( typeof dataTypeOrTransport === \"string\" &&\n\t\t\t\t!seekingTransport && !inspected[ dataTypeOrTransport ] ) {\n\n\t\t\t\toptions.dataTypes.unshift( dataTypeOrTransport );\n\t\t\t\tinspect( dataTypeOrTransport );\n\t\t\t\treturn false;\n\t\t\t} else if ( seekingTransport ) {\n\t\t\t\treturn !( selected = dataTypeOrTransport );\n\t\t\t}\n\t\t} );\n\t\treturn selected;\n\t}\n\n\treturn inspect( options.dataTypes[ 0 ] ) || !inspected[ \"*\" ] && inspect( \"*\" );\n}\n\n// A special extend for ajax options\n// that takes \"flat\" options (not to be deep extended)\n// Fixes #9887\nfunction ajaxExtend( target, src ) {\n\tvar key, deep,\n\t\tflatOptions = jQuery.ajaxSettings.flatOptions || {};\n\n\tfor ( key in src ) {\n\t\tif ( src[ key ] !== undefined ) {\n\t\t\t( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];\n\t\t}\n\t}\n\tif ( deep ) {\n\t\tjQuery.extend( true, target, deep );\n\t}\n\n\treturn target;\n}\n\n/* Handles responses to an ajax request:\n * - finds the right dataType (mediates between content-type and expected dataType)\n * - returns the corresponding response\n */\nfunction ajaxHandleResponses( s, jqXHR, responses ) {\n\n\tvar ct, type, finalDataType, firstDataType,\n\t\tcontents = s.contents,\n\t\tdataTypes = s.dataTypes;\n\n\t// Remove auto dataType and get content-type in the process\n\twhile ( dataTypes[ 0 ] === \"*\" ) {\n\t\tdataTypes.shift();\n\t\tif ( ct === undefined ) {\n\t\t\tct = s.mimeType || jqXHR.getResponseHeader( \"Content-Type\" );\n\t\t}\n\t}\n\n\t// Check if we're dealing with a known content-type\n\tif ( ct ) {\n\t\tfor ( type in contents ) {\n\t\t\tif ( contents[ type ] && contents[ type ].test( ct ) ) {\n\t\t\t\tdataTypes.unshift( type );\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\t// Check to see if we have a response for the expected dataType\n\tif ( dataTypes[ 0 ] in responses ) {\n\t\tfinalDataType = dataTypes[ 0 ];\n\t} else {\n\n\t\t// Try convertible dataTypes\n\t\tfor ( type in responses ) {\n\t\t\tif ( !dataTypes[ 0 ] || s.converters[ type + \" \" + dataTypes[ 0 ] ] ) {\n\t\t\t\tfinalDataType = type;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( !firstDataType ) {\n\t\t\t\tfirstDataType = type;\n\t\t\t}\n\t\t}\n\n\t\t// Or just use first one\n\t\tfinalDataType = finalDataType || firstDataType;\n\t}\n\n\t// If we found a dataType\n\t// We add the dataType to the list if needed\n\t// and return the corresponding response\n\tif ( finalDataType ) {\n\t\tif ( finalDataType !== dataTypes[ 0 ] ) {\n\t\t\tdataTypes.unshift( finalDataType );\n\t\t}\n\t\treturn responses[ finalDataType ];\n\t}\n}\n\n/* Chain conversions given the request and the original response\n * Also sets the responseXXX fields on the jqXHR instance\n */\nfunction ajaxConvert( s, response, jqXHR, isSuccess ) {\n\tvar conv2, current, conv, tmp, prev,\n\t\tconverters = {},\n\n\t\t// Work with a copy of dataTypes in case we need to modify it for conversion\n\t\tdataTypes = s.dataTypes.slice();\n\n\t// Create converters map with lowercased keys\n\tif ( dataTypes[ 1 ] ) {\n\t\tfor ( conv in s.converters ) {\n\t\t\tconverters[ conv.toLowerCase() ] = s.converters[ conv ];\n\t\t}\n\t}\n\n\tcurrent = dataTypes.shift();\n\n\t// Convert to each sequential dataType\n\twhile ( current ) {\n\n\t\tif ( s.responseFields[ current ] ) {\n\t\t\tjqXHR[ s.responseFields[ current ] ] = response;\n\t\t}\n\n\t\t// Apply the dataFilter if provided\n\t\tif ( !prev && isSuccess && s.dataFilter ) {\n\t\t\tresponse = s.dataFilter( response, s.dataType );\n\t\t}\n\n\t\tprev = current;\n\t\tcurrent = dataTypes.shift();\n\n\t\tif ( current ) {\n\n\t\t\t// There's only work to do if current dataType is non-auto\n\t\t\tif ( current === \"*\" ) {\n\n\t\t\t\tcurrent = prev;\n\n\t\t\t// Convert response if prev dataType is non-auto and differs from current\n\t\t\t} else if ( prev !== \"*\" && prev !== current ) {\n\n\t\t\t\t// Seek a direct converter\n\t\t\t\tconv = converters[ prev + \" \" + current ] || converters[ \"* \" + current ];\n\n\t\t\t\t// If none found, seek a pair\n\t\t\t\tif ( !conv ) {\n\t\t\t\t\tfor ( conv2 in converters ) {\n\n\t\t\t\t\t\t// If conv2 outputs current\n\t\t\t\t\t\ttmp = conv2.split( \" \" );\n\t\t\t\t\t\tif ( tmp[ 1 ] === current ) {\n\n\t\t\t\t\t\t\t// If prev can be converted to accepted input\n\t\t\t\t\t\t\tconv = converters[ prev + \" \" + tmp[ 0 ] ] ||\n\t\t\t\t\t\t\t\tconverters[ \"* \" + tmp[ 0 ] ];\n\t\t\t\t\t\t\tif ( conv ) {\n\n\t\t\t\t\t\t\t\t// Condense equivalence converters\n\t\t\t\t\t\t\t\tif ( conv === true ) {\n\t\t\t\t\t\t\t\t\tconv = converters[ conv2 ];\n\n\t\t\t\t\t\t\t\t// Otherwise, insert the intermediate dataType\n\t\t\t\t\t\t\t\t} else if ( converters[ conv2 ] !== true ) {\n\t\t\t\t\t\t\t\t\tcurrent = tmp[ 0 ];\n\t\t\t\t\t\t\t\t\tdataTypes.unshift( tmp[ 1 ] );\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Apply converter (if not an equivalence)\n\t\t\t\tif ( conv !== true ) {\n\n\t\t\t\t\t// Unless errors are allowed to bubble, catch and return them\n\t\t\t\t\tif ( conv && s.throws ) {\n\t\t\t\t\t\tresponse = conv( response );\n\t\t\t\t\t} else {\n\t\t\t\t\t\ttry {\n\t\t\t\t\t\t\tresponse = conv( response );\n\t\t\t\t\t\t} catch ( e ) {\n\t\t\t\t\t\t\treturn {\n\t\t\t\t\t\t\t\tstate: \"parsererror\",\n\t\t\t\t\t\t\t\terror: conv ? e : \"No conversion from \" + prev + \" to \" + current\n\t\t\t\t\t\t\t};\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn { state: \"success\", data: response };\n}\n\njQuery.extend( {\n\n\t// Counter for holding the number of active queries\n\tactive: 0,\n\n\t// Last-Modified header cache for next request\n\tlastModified: {},\n\tetag: {},\n\n\tajaxSettings: {\n\t\turl: location.href,\n\t\ttype: \"GET\",\n\t\tisLocal: rlocalProtocol.test( location.protocol ),\n\t\tglobal: true,\n\t\tprocessData: true,\n\t\tasync: true,\n\t\tcontentType: \"application/x-www-form-urlencoded; charset=UTF-8\",\n\n\t\t/*\n\t\ttimeout: 0,\n\t\tdata: null,\n\t\tdataType: null,\n\t\tusername: null,\n\t\tpassword: null,\n\t\tcache: null,\n\t\tthrows: false,\n\t\ttraditional: false,\n\t\theaders: {},\n\t\t*/\n\n\t\taccepts: {\n\t\t\t\"*\": allTypes,\n\t\t\ttext: \"text/plain\",\n\t\t\thtml: \"text/html\",\n\t\t\txml: \"application/xml, text/xml\",\n\t\t\tjson: \"application/json, text/javascript\"\n\t\t},\n\n\t\tcontents: {\n\t\t\txml: /\\bxml\\b/,\n\t\t\thtml: /\\bhtml/,\n\t\t\tjson: /\\bjson\\b/\n\t\t},\n\n\t\tresponseFields: {\n\t\t\txml: \"responseXML\",\n\t\t\ttext: \"responseText\",\n\t\t\tjson: \"responseJSON\"\n\t\t},\n\n\t\t// Data converters\n\t\t// Keys separate source (or catchall \"*\") and destination types with a single space\n\t\tconverters: {\n\n\t\t\t// Convert anything to text\n\t\t\t\"* text\": String,\n\n\t\t\t// Text to html (true = no transformation)\n\t\t\t\"text html\": true,\n\n\t\t\t// Evaluate text as a json expression\n\t\t\t\"text json\": JSON.parse,\n\n\t\t\t// Parse text as xml\n\t\t\t\"text xml\": jQuery.parseXML\n\t\t},\n\n\t\t// For options that shouldn't be deep extended:\n\t\t// you can add your own custom options here if\n\t\t// and when you create one that shouldn't be\n\t\t// deep extended (see ajaxExtend)\n\t\tflatOptions: {\n\t\t\turl: true,\n\t\t\tcontext: true\n\t\t}\n\t},\n\n\t// Creates a full fledged settings object into target\n\t// with both ajaxSettings and settings fields.\n\t// If target is omitted, writes into ajaxSettings.\n\tajaxSetup: function( target, settings ) {\n\t\treturn settings ?\n\n\t\t\t// Building a settings object\n\t\t\tajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) :\n\n\t\t\t// Extending ajaxSettings\n\t\t\tajaxExtend( jQuery.ajaxSettings, target );\n\t},\n\n\tajaxPrefilter: addToPrefiltersOrTransports( prefilters ),\n\tajaxTransport: addToPrefiltersOrTransports( transports ),\n\n\t// Main method\n\tajax: function( url, options ) {\n\n\t\t// If url is an object, simulate pre-1.5 signature\n\t\tif ( typeof url === \"object\" ) {\n\t\t\toptions = url;\n\t\t\turl = undefined;\n\t\t}\n\n\t\t// Force options to be an object\n\t\toptions = options || {};\n\n\t\tvar transport,\n\n\t\t\t// URL without anti-cache param\n\t\t\tcacheURL,\n\n\t\t\t// Response headers\n\t\t\tresponseHeadersString,\n\t\t\tresponseHeaders,\n\n\t\t\t// timeout handle\n\t\t\ttimeoutTimer,\n\n\t\t\t// Url cleanup var\n\t\t\turlAnchor,\n\n\t\t\t// Request state (becomes false upon send and true upon completion)\n\t\t\tcompleted,\n\n\t\t\t// To know if global events are to be dispatched\n\t\t\tfireGlobals,\n\n\t\t\t// Loop variable\n\t\t\ti,\n\n\t\t\t// uncached part of the url\n\t\t\tuncached,\n\n\t\t\t// Create the final options object\n\t\t\ts = jQuery.ajaxSetup( {}, options ),\n\n\t\t\t// Callbacks context\n\t\t\tcallbackContext = s.context || s,\n\n\t\t\t// Context for global events is callbackContext if it is a DOM node or jQuery collection\n\t\t\tglobalEventContext = s.context &&\n\t\t\t\t( callbackContext.nodeType || callbackContext.jquery ) ?\n\t\t\t\t\tjQuery( callbackContext ) :\n\t\t\t\t\tjQuery.event,\n\n\t\t\t// Deferreds\n\t\t\tdeferred = jQuery.Deferred(),\n\t\t\tcompleteDeferred = jQuery.Callbacks( \"once memory\" ),\n\n\t\t\t// Status-dependent callbacks\n\t\t\tstatusCode = s.statusCode || {},\n\n\t\t\t// Headers (they are sent all at once)\n\t\t\trequestHeaders = {},\n\t\t\trequestHeadersNames = {},\n\n\t\t\t// Default abort message\n\t\t\tstrAbort = \"canceled\",\n\n\t\t\t// Fake xhr\n\t\t\tjqXHR = {\n\t\t\t\treadyState: 0,\n\n\t\t\t\t// Builds headers hashtable if needed\n\t\t\t\tgetResponseHeader: function( key ) {\n\t\t\t\t\tvar match;\n\t\t\t\t\tif ( completed ) {\n\t\t\t\t\t\tif ( !responseHeaders ) {\n\t\t\t\t\t\t\tresponseHeaders = {};\n\t\t\t\t\t\t\twhile ( ( match = rheaders.exec( responseHeadersString ) ) ) {\n\t\t\t\t\t\t\t\tresponseHeaders[ match[ 1 ].toLowerCase() + \" \" ] =\n\t\t\t\t\t\t\t\t\t( responseHeaders[ match[ 1 ].toLowerCase() + \" \" ] || [] )\n\t\t\t\t\t\t\t\t\t\t.concat( match[ 2 ] );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\tmatch = responseHeaders[ key.toLowerCase() + \" \" ];\n\t\t\t\t\t}\n\t\t\t\t\treturn match == null ? null : match.join( \", \" );\n\t\t\t\t},\n\n\t\t\t\t// Raw string\n\t\t\t\tgetAllResponseHeaders: function() {\n\t\t\t\t\treturn completed ? responseHeadersString : null;\n\t\t\t\t},\n\n\t\t\t\t// Caches the header\n\t\t\t\tsetRequestHeader: function( name, value ) {\n\t\t\t\t\tif ( completed == null ) {\n\t\t\t\t\t\tname = requestHeadersNames[ name.toLowerCase() ] =\n\t\t\t\t\t\t\trequestHeadersNames[ name.toLowerCase() ] || name;\n\t\t\t\t\t\trequestHeaders[ name ] = value;\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\n\t\t\t\t// Overrides response content-type header\n\t\t\t\toverrideMimeType: function( type ) {\n\t\t\t\t\tif ( completed == null ) {\n\t\t\t\t\t\ts.mimeType = type;\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\n\t\t\t\t// Status-dependent callbacks\n\t\t\t\tstatusCode: function( map ) {\n\t\t\t\t\tvar code;\n\t\t\t\t\tif ( map ) {\n\t\t\t\t\t\tif ( completed ) {\n\n\t\t\t\t\t\t\t// Execute the appropriate callbacks\n\t\t\t\t\t\t\tjqXHR.always( map[ jqXHR.status ] );\n\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t// Lazy-add the new callbacks in a way that preserves old ones\n\t\t\t\t\t\t\tfor ( code in map ) {\n\t\t\t\t\t\t\t\tstatusCode[ code ] = [ statusCode[ code ], map[ code ] ];\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\n\t\t\t\t// Cancel the request\n\t\t\t\tabort: function( statusText ) {\n\t\t\t\t\tvar finalText = statusText || strAbort;\n\t\t\t\t\tif ( transport ) {\n\t\t\t\t\t\ttransport.abort( finalText );\n\t\t\t\t\t}\n\t\t\t\t\tdone( 0, finalText );\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\t\t\t};\n\n\t\t// Attach deferreds\n\t\tdeferred.promise( jqXHR );\n\n\t\t// Add protocol if not provided (prefilters might expect it)\n\t\t// Handle falsy url in the settings object (#10093: consistency with old signature)\n\t\t// We also use the url parameter if available\n\t\ts.url = ( ( url || s.url || location.href ) + \"\" )\n\t\t\t.replace( rprotocol, location.protocol + \"//\" );\n\n\t\t// Alias method option to type as per ticket #12004\n\t\ts.type = options.method || options.type || s.method || s.type;\n\n\t\t// Extract dataTypes list\n\t\ts.dataTypes = ( s.dataType || \"*\" ).toLowerCase().match( rnothtmlwhite ) || [ \"\" ];\n\n\t\t// A cross-domain request is in order when the origin doesn't match the current origin.\n\t\tif ( s.crossDomain == null ) {\n\t\t\turlAnchor = document.createElement( \"a\" );\n\n\t\t\t// Support: IE <=8 - 11, Edge 12 - 15\n\t\t\t// IE throws exception on accessing the href property if url is malformed,\n\t\t\t// e.g. http://example.com:80x/\n\t\t\ttry {\n\t\t\t\turlAnchor.href = s.url;\n\n\t\t\t\t// Support: IE <=8 - 11 only\n\t\t\t\t// Anchor's host property isn't correctly set when s.url is relative\n\t\t\t\turlAnchor.href = urlAnchor.href;\n\t\t\t\ts.crossDomain = originAnchor.protocol + \"//\" + originAnchor.host !==\n\t\t\t\t\turlAnchor.protocol + \"//\" + urlAnchor.host;\n\t\t\t} catch ( e ) {\n\n\t\t\t\t// If there is an error parsing the URL, assume it is crossDomain,\n\t\t\t\t// it can be rejected by the transport if it is invalid\n\t\t\t\ts.crossDomain = true;\n\t\t\t}\n\t\t}\n\n\t\t// Convert data if not already a string\n\t\tif ( s.data && s.processData && typeof s.data !== \"string\" ) {\n\t\t\ts.data = jQuery.param( s.data, s.traditional );\n\t\t}\n\n\t\t// Apply prefilters\n\t\tinspectPrefiltersOrTransports( prefilters, s, options, jqXHR );\n\n\t\t// If request was aborted inside a prefilter, stop there\n\t\tif ( completed ) {\n\t\t\treturn jqXHR;\n\t\t}\n\n\t\t// We can fire global events as of now if asked to\n\t\t// Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118)\n\t\tfireGlobals = jQuery.event && s.global;\n\n\t\t// Watch for a new set of requests\n\t\tif ( fireGlobals && jQuery.active++ === 0 ) {\n\t\t\tjQuery.event.trigger( \"ajaxStart\" );\n\t\t}\n\n\t\t// Uppercase the type\n\t\ts.type = s.type.toUpperCase();\n\n\t\t// Determine if request has content\n\t\ts.hasContent = !rnoContent.test( s.type );\n\n\t\t// Save the URL in case we're toying with the If-Modified-Since\n\t\t// and/or If-None-Match header later on\n\t\t// Remove hash to simplify url manipulation\n\t\tcacheURL = s.url.replace( rhash, \"\" );\n\n\t\t// More options handling for requests with no content\n\t\tif ( !s.hasContent ) {\n\n\t\t\t// Remember the hash so we can put it back\n\t\t\tuncached = s.url.slice( cacheURL.length );\n\n\t\t\t// If data is available and should be processed, append data to url\n\t\t\tif ( s.data && ( s.processData || typeof s.data === \"string\" ) ) {\n\t\t\t\tcacheURL += ( rquery.test( cacheURL ) ? \"&\" : \"?\" ) + s.data;\n\n\t\t\t\t// #9682: remove data so that it's not used in an eventual retry\n\t\t\t\tdelete s.data;\n\t\t\t}\n\n\t\t\t// Add or update anti-cache param if needed\n\t\t\tif ( s.cache === false ) {\n\t\t\t\tcacheURL = cacheURL.replace( rantiCache, \"$1\" );\n\t\t\t\tuncached = ( rquery.test( cacheURL ) ? \"&\" : \"?\" ) + \"_=\" + ( nonce.guid++ ) +\n\t\t\t\t\tuncached;\n\t\t\t}\n\n\t\t\t// Put hash and anti-cache on the URL that will be requested (gh-1732)\n\t\t\ts.url = cacheURL + uncached;\n\n\t\t// Change '%20' to '+' if this is encoded form body content (gh-2658)\n\t\t} else if ( s.data && s.processData &&\n\t\t\t( s.contentType || \"\" ).indexOf( \"application/x-www-form-urlencoded\" ) === 0 ) {\n\t\t\ts.data = s.data.replace( r20, \"+\" );\n\t\t}\n\n\t\t// Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.\n\t\tif ( s.ifModified ) {\n\t\t\tif ( jQuery.lastModified[ cacheURL ] ) {\n\t\t\t\tjqXHR.setRequestHeader( \"If-Modified-Since\", jQuery.lastModified[ cacheURL ] );\n\t\t\t}\n\t\t\tif ( jQuery.etag[ cacheURL ] ) {\n\t\t\t\tjqXHR.setRequestHeader( \"If-None-Match\", jQuery.etag[ cacheURL ] );\n\t\t\t}\n\t\t}\n\n\t\t// Set the correct header, if data is being sent\n\t\tif ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {\n\t\t\tjqXHR.setRequestHeader( \"Content-Type\", s.contentType );\n\t\t}\n\n\t\t// Set the Accepts header for the server, depending on the dataType\n\t\tjqXHR.setRequestHeader(\n\t\t\t\"Accept\",\n\t\t\ts.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ?\n\t\t\t\ts.accepts[ s.dataTypes[ 0 ] ] +\n\t\t\t\t\t( s.dataTypes[ 0 ] !== \"*\" ? \", \" + allTypes + \"; q=0.01\" : \"\" ) :\n\t\t\t\ts.accepts[ \"*\" ]\n\t\t);\n\n\t\t// Check for headers option\n\t\tfor ( i in s.headers ) {\n\t\t\tjqXHR.setRequestHeader( i, s.headers[ i ] );\n\t\t}\n\n\t\t// Allow custom headers/mimetypes and early abort\n\t\tif ( s.beforeSend &&\n\t\t\t( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) {\n\n\t\t\t// Abort if not done already and return\n\t\t\treturn jqXHR.abort();\n\t\t}\n\n\t\t// Aborting is no longer a cancellation\n\t\tstrAbort = \"abort\";\n\n\t\t// Install callbacks on deferreds\n\t\tcompleteDeferred.add( s.complete );\n\t\tjqXHR.done( s.success );\n\t\tjqXHR.fail( s.error );\n\n\t\t// Get transport\n\t\ttransport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );\n\n\t\t// If no transport, we auto-abort\n\t\tif ( !transport ) {\n\t\t\tdone( -1, \"No Transport\" );\n\t\t} else {\n\t\t\tjqXHR.readyState = 1;\n\n\t\t\t// Send global event\n\t\t\tif ( fireGlobals ) {\n\t\t\t\tglobalEventContext.trigger( \"ajaxSend\", [ jqXHR, s ] );\n\t\t\t}\n\n\t\t\t// If request was aborted inside ajaxSend, stop there\n\t\t\tif ( completed ) {\n\t\t\t\treturn jqXHR;\n\t\t\t}\n\n\t\t\t// Timeout\n\t\t\tif ( s.async && s.timeout > 0 ) {\n\t\t\t\ttimeoutTimer = window.setTimeout( function() {\n\t\t\t\t\tjqXHR.abort( \"timeout\" );\n\t\t\t\t}, s.timeout );\n\t\t\t}\n\n\t\t\ttry {\n\t\t\t\tcompleted = false;\n\t\t\t\ttransport.send( requestHeaders, done );\n\t\t\t} catch ( e ) {\n\n\t\t\t\t// Rethrow post-completion exceptions\n\t\t\t\tif ( completed ) {\n\t\t\t\t\tthrow e;\n\t\t\t\t}\n\n\t\t\t\t// Propagate others as results\n\t\t\t\tdone( -1, e );\n\t\t\t}\n\t\t}\n\n\t\t// Callback for when everything is done\n\t\tfunction done( status, nativeStatusText, responses, headers ) {\n\t\t\tvar isSuccess, success, error, response, modified,\n\t\t\t\tstatusText = nativeStatusText;\n\n\t\t\t// Ignore repeat invocations\n\t\t\tif ( completed ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tcompleted = true;\n\n\t\t\t// Clear timeout if it exists\n\t\t\tif ( timeoutTimer ) {\n\t\t\t\twindow.clearTimeout( timeoutTimer );\n\t\t\t}\n\n\t\t\t// Dereference transport for early garbage collection\n\t\t\t// (no matter how long the jqXHR object will be used)\n\t\t\ttransport = undefined;\n\n\t\t\t// Cache response headers\n\t\t\tresponseHeadersString = headers || \"\";\n\n\t\t\t// Set readyState\n\t\t\tjqXHR.readyState = status > 0 ? 4 : 0;\n\n\t\t\t// Determine if successful\n\t\t\tisSuccess = status >= 200 && status < 300 || status === 304;\n\n\t\t\t// Get response data\n\t\t\tif ( responses ) {\n\t\t\t\tresponse = ajaxHandleResponses( s, jqXHR, responses );\n\t\t\t}\n\n\t\t\t// Use a noop converter for missing script\n\t\t\tif ( !isSuccess && jQuery.inArray( \"script\", s.dataTypes ) > -1 ) {\n\t\t\t\ts.converters[ \"text script\" ] = function() {};\n\t\t\t}\n\n\t\t\t// Convert no matter what (that way responseXXX fields are always set)\n\t\t\tresponse = ajaxConvert( s, response, jqXHR, isSuccess );\n\n\t\t\t// If successful, handle type chaining\n\t\t\tif ( isSuccess ) {\n\n\t\t\t\t// Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.\n\t\t\t\tif ( s.ifModified ) {\n\t\t\t\t\tmodified = jqXHR.getResponseHeader( \"Last-Modified\" );\n\t\t\t\t\tif ( modified ) {\n\t\t\t\t\t\tjQuery.lastModified[ cacheURL ] = modified;\n\t\t\t\t\t}\n\t\t\t\t\tmodified = jqXHR.getResponseHeader( \"etag\" );\n\t\t\t\t\tif ( modified ) {\n\t\t\t\t\t\tjQuery.etag[ cacheURL ] = modified;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// if no content\n\t\t\t\tif ( status === 204 || s.type === \"HEAD\" ) {\n\t\t\t\t\tstatusText = \"nocontent\";\n\n\t\t\t\t// if not modified\n\t\t\t\t} else if ( status === 304 ) {\n\t\t\t\t\tstatusText = \"notmodified\";\n\n\t\t\t\t// If we have data, let's convert it\n\t\t\t\t} else {\n\t\t\t\t\tstatusText = response.state;\n\t\t\t\t\tsuccess = response.data;\n\t\t\t\t\terror = response.error;\n\t\t\t\t\tisSuccess = !error;\n\t\t\t\t}\n\t\t\t} else {\n\n\t\t\t\t// Extract error from statusText and normalize for non-aborts\n\t\t\t\terror = statusText;\n\t\t\t\tif ( status || !statusText ) {\n\t\t\t\t\tstatusText = \"error\";\n\t\t\t\t\tif ( status < 0 ) {\n\t\t\t\t\t\tstatus = 0;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set data for the fake xhr object\n\t\t\tjqXHR.status = status;\n\t\t\tjqXHR.statusText = ( nativeStatusText || statusText ) + \"\";\n\n\t\t\t// Success/Error\n\t\t\tif ( isSuccess ) {\n\t\t\t\tdeferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );\n\t\t\t} else {\n\t\t\t\tdeferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );\n\t\t\t}\n\n\t\t\t// Status-dependent callbacks\n\t\t\tjqXHR.statusCode( statusCode );\n\t\t\tstatusCode = undefined;\n\n\t\t\tif ( fireGlobals ) {\n\t\t\t\tglobalEventContext.trigger( isSuccess ? \"ajaxSuccess\" : \"ajaxError\",\n\t\t\t\t\t[ jqXHR, s, isSuccess ? success : error ] );\n\t\t\t}\n\n\t\t\t// Complete\n\t\t\tcompleteDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );\n\n\t\t\tif ( fireGlobals ) {\n\t\t\t\tglobalEventContext.trigger( \"ajaxComplete\", [ jqXHR, s ] );\n\n\t\t\t\t// Handle the global AJAX counter\n\t\t\t\tif ( !( --jQuery.active ) ) {\n\t\t\t\t\tjQuery.event.trigger( \"ajaxStop\" );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn jqXHR;\n\t},\n\n\tgetJSON: function( url, data, callback ) {\n\t\treturn jQuery.get( url, data, callback, \"json\" );\n\t},\n\n\tgetScript: function( url, callback ) {\n\t\treturn jQuery.get( url, undefined, callback, \"script\" );\n\t}\n} );\n\njQuery.each( [ \"get\", \"post\" ], function( _i, method ) {\n\tjQuery[ method ] = function( url, data, callback, type ) {\n\n\t\t// Shift arguments if data argument was omitted\n\t\tif ( isFunction( data ) ) {\n\t\t\ttype = type || callback;\n\t\t\tcallback = data;\n\t\t\tdata = undefined;\n\t\t}\n\n\t\t// The url can be an options object (which then must have .url)\n\t\treturn jQuery.ajax( jQuery.extend( {\n\t\t\turl: url,\n\t\t\ttype: method,\n\t\t\tdataType: type,\n\t\t\tdata: data,\n\t\t\tsuccess: callback\n\t\t}, jQuery.isPlainObject( url ) && url ) );\n\t};\n} );\n\njQuery.ajaxPrefilter( function( s ) {\n\tvar i;\n\tfor ( i in s.headers ) {\n\t\tif ( i.toLowerCase() === \"content-type\" ) {\n\t\t\ts.contentType = s.headers[ i ] || \"\";\n\t\t}\n\t}\n} );\n\n\njQuery._evalUrl = function( url, options, doc ) {\n\treturn jQuery.ajax( {\n\t\turl: url,\n\n\t\t// Make this explicit, since user can override this through ajaxSetup (#11264)\n\t\ttype: \"GET\",\n\t\tdataType: \"script\",\n\t\tcache: true,\n\t\tasync: false,\n\t\tglobal: false,\n\n\t\t// Only evaluate the response if it is successful (gh-4126)\n\t\t// dataFilter is not invoked for failure responses, so using it instead\n\t\t// of the default converter is kludgy but it works.\n\t\tconverters: {\n\t\t\t\"text script\": function() {}\n\t\t},\n\t\tdataFilter: function( response ) {\n\t\t\tjQuery.globalEval( response, options, doc );\n\t\t}\n\t} );\n};\n\n\njQuery.fn.extend( {\n\twrapAll: function( html ) {\n\t\tvar wrap;\n\n\t\tif ( this[ 0 ] ) {\n\t\t\tif ( isFunction( html ) ) {\n\t\t\t\thtml = html.call( this[ 0 ] );\n\t\t\t}\n\n\t\t\t// The elements to wrap the target around\n\t\t\twrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true );\n\n\t\t\tif ( this[ 0 ].parentNode ) {\n\t\t\t\twrap.insertBefore( this[ 0 ] );\n\t\t\t}\n\n\t\t\twrap.map( function() {\n\t\t\t\tvar elem = this;\n\n\t\t\t\twhile ( elem.firstElementChild ) {\n\t\t\t\t\telem = elem.firstElementChild;\n\t\t\t\t}\n\n\t\t\t\treturn elem;\n\t\t\t} ).append( this );\n\t\t}\n\n\t\treturn this;\n\t},\n\n\twrapInner: function( html ) {\n\t\tif ( isFunction( html ) ) {\n\t\t\treturn this.each( function( i ) {\n\t\t\t\tjQuery( this ).wrapInner( html.call( this, i ) );\n\t\t\t} );\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tvar self = jQuery( this ),\n\t\t\t\tcontents = self.contents();\n\n\t\t\tif ( contents.length ) {\n\t\t\t\tcontents.wrapAll( html );\n\n\t\t\t} else {\n\t\t\t\tself.append( html );\n\t\t\t}\n\t\t} );\n\t},\n\n\twrap: function( html ) {\n\t\tvar htmlIsFunction = isFunction( html );\n\n\t\treturn this.each( function( i ) {\n\t\t\tjQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html );\n\t\t} );\n\t},\n\n\tunwrap: function( selector ) {\n\t\tthis.parent( selector ).not( \"body\" ).each( function() {\n\t\t\tjQuery( this ).replaceWith( this.childNodes );\n\t\t} );\n\t\treturn this;\n\t}\n} );\n\n\njQuery.expr.pseudos.hidden = function( elem ) {\n\treturn !jQuery.expr.pseudos.visible( elem );\n};\njQuery.expr.pseudos.visible = function( elem ) {\n\treturn !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length );\n};\n\n\n\n\njQuery.ajaxSettings.xhr = function() {\n\ttry {\n\t\treturn new window.XMLHttpRequest();\n\t} catch ( e ) {}\n};\n\nvar xhrSuccessStatus = {\n\n\t\t// File protocol always yields status code 0, assume 200\n\t\t0: 200,\n\n\t\t// Support: IE <=9 only\n\t\t// #1450: sometimes IE returns 1223 when it should be 204\n\t\t1223: 204\n\t},\n\txhrSupported = jQuery.ajaxSettings.xhr();\n\nsupport.cors = !!xhrSupported && ( \"withCredentials\" in xhrSupported );\nsupport.ajax = xhrSupported = !!xhrSupported;\n\njQuery.ajaxTransport( function( options ) {\n\tvar callback, errorCallback;\n\n\t// Cross domain only allowed if supported through XMLHttpRequest\n\tif ( support.cors || xhrSupported && !options.crossDomain ) {\n\t\treturn {\n\t\t\tsend: function( headers, complete ) {\n\t\t\t\tvar i,\n\t\t\t\t\txhr = options.xhr();\n\n\t\t\t\txhr.open(\n\t\t\t\t\toptions.type,\n\t\t\t\t\toptions.url,\n\t\t\t\t\toptions.async,\n\t\t\t\t\toptions.username,\n\t\t\t\t\toptions.password\n\t\t\t\t);\n\n\t\t\t\t// Apply custom fields if provided\n\t\t\t\tif ( options.xhrFields ) {\n\t\t\t\t\tfor ( i in options.xhrFields ) {\n\t\t\t\t\t\txhr[ i ] = options.xhrFields[ i ];\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Override mime type if needed\n\t\t\t\tif ( options.mimeType && xhr.overrideMimeType ) {\n\t\t\t\t\txhr.overrideMimeType( options.mimeType );\n\t\t\t\t}\n\n\t\t\t\t// X-Requested-With header\n\t\t\t\t// For cross-domain requests, seeing as conditions for a preflight are\n\t\t\t\t// akin to a jigsaw puzzle, we simply never set it to be sure.\n\t\t\t\t// (it can always be set on a per-request basis or even using ajaxSetup)\n\t\t\t\t// For same-domain requests, won't change header if already provided.\n\t\t\t\tif ( !options.crossDomain && !headers[ \"X-Requested-With\" ] ) {\n\t\t\t\t\theaders[ \"X-Requested-With\" ] = \"XMLHttpRequest\";\n\t\t\t\t}\n\n\t\t\t\t// Set headers\n\t\t\t\tfor ( i in headers ) {\n\t\t\t\t\txhr.setRequestHeader( i, headers[ i ] );\n\t\t\t\t}\n\n\t\t\t\t// Callback\n\t\t\t\tcallback = function( type ) {\n\t\t\t\t\treturn function() {\n\t\t\t\t\t\tif ( callback ) {\n\t\t\t\t\t\t\tcallback = errorCallback = xhr.onload =\n\t\t\t\t\t\t\t\txhr.onerror = xhr.onabort = xhr.ontimeout =\n\t\t\t\t\t\t\t\t\txhr.onreadystatechange = null;\n\n\t\t\t\t\t\t\tif ( type === \"abort\" ) {\n\t\t\t\t\t\t\t\txhr.abort();\n\t\t\t\t\t\t\t} else if ( type === \"error\" ) {\n\n\t\t\t\t\t\t\t\t// Support: IE <=9 only\n\t\t\t\t\t\t\t\t// On a manual native abort, IE9 throws\n\t\t\t\t\t\t\t\t// errors on any property access that is not readyState\n\t\t\t\t\t\t\t\tif ( typeof xhr.status !== \"number\" ) {\n\t\t\t\t\t\t\t\t\tcomplete( 0, \"error\" );\n\t\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\t\tcomplete(\n\n\t\t\t\t\t\t\t\t\t\t// File: protocol always yields status 0; see #8605, #14207\n\t\t\t\t\t\t\t\t\t\txhr.status,\n\t\t\t\t\t\t\t\t\t\txhr.statusText\n\t\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\tcomplete(\n\t\t\t\t\t\t\t\t\txhrSuccessStatus[ xhr.status ] || xhr.status,\n\t\t\t\t\t\t\t\t\txhr.statusText,\n\n\t\t\t\t\t\t\t\t\t// Support: IE <=9 only\n\t\t\t\t\t\t\t\t\t// IE9 has no XHR2 but throws on binary (trac-11426)\n\t\t\t\t\t\t\t\t\t// For XHR2 non-text, let the caller handle it (gh-2498)\n\t\t\t\t\t\t\t\t\t( xhr.responseType || \"text\" ) !== \"text\" ||\n\t\t\t\t\t\t\t\t\ttypeof xhr.responseText !== \"string\" ?\n\t\t\t\t\t\t\t\t\t\t{ binary: xhr.response } :\n\t\t\t\t\t\t\t\t\t\t{ text: xhr.responseText },\n\t\t\t\t\t\t\t\t\txhr.getAllResponseHeaders()\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t};\n\t\t\t\t};\n\n\t\t\t\t// Listen to events\n\t\t\t\txhr.onload = callback();\n\t\t\t\terrorCallback = xhr.onerror = xhr.ontimeout = callback( \"error\" );\n\n\t\t\t\t// Support: IE 9 only\n\t\t\t\t// Use onreadystatechange to replace onabort\n\t\t\t\t// to handle uncaught aborts\n\t\t\t\tif ( xhr.onabort !== undefined ) {\n\t\t\t\t\txhr.onabort = errorCallback;\n\t\t\t\t} else {\n\t\t\t\t\txhr.onreadystatechange = function() {\n\n\t\t\t\t\t\t// Check readyState before timeout as it changes\n\t\t\t\t\t\tif ( xhr.readyState === 4 ) {\n\n\t\t\t\t\t\t\t// Allow onerror to be called first,\n\t\t\t\t\t\t\t// but that will not handle a native abort\n\t\t\t\t\t\t\t// Also, save errorCallback to a variable\n\t\t\t\t\t\t\t// as xhr.onerror cannot be accessed\n\t\t\t\t\t\t\twindow.setTimeout( function() {\n\t\t\t\t\t\t\t\tif ( callback ) {\n\t\t\t\t\t\t\t\t\terrorCallback();\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} );\n\t\t\t\t\t\t}\n\t\t\t\t\t};\n\t\t\t\t}\n\n\t\t\t\t// Create the abort callback\n\t\t\t\tcallback = callback( \"abort\" );\n\n\t\t\t\ttry {\n\n\t\t\t\t\t// Do send the request (this may raise an exception)\n\t\t\t\t\txhr.send( options.hasContent && options.data || null );\n\t\t\t\t} catch ( e ) {\n\n\t\t\t\t\t// #14683: Only rethrow if this hasn't been notified as an error yet\n\t\t\t\t\tif ( callback ) {\n\t\t\t\t\t\tthrow e;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\n\t\t\tabort: function() {\n\t\t\t\tif ( callback ) {\n\t\t\t\t\tcallback();\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t}\n} );\n\n\n\n\n// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432)\njQuery.ajaxPrefilter( function( s ) {\n\tif ( s.crossDomain ) {\n\t\ts.contents.script = false;\n\t}\n} );\n\n// Install script dataType\njQuery.ajaxSetup( {\n\taccepts: {\n\t\tscript: \"text/javascript, application/javascript, \" +\n\t\t\t\"application/ecmascript, application/x-ecmascript\"\n\t},\n\tcontents: {\n\t\tscript: /\\b(?:java|ecma)script\\b/\n\t},\n\tconverters: {\n\t\t\"text script\": function( text ) {\n\t\t\tjQuery.globalEval( text );\n\t\t\treturn text;\n\t\t}\n\t}\n} );\n\n// Handle cache's special case and crossDomain\njQuery.ajaxPrefilter( \"script\", function( s ) {\n\tif ( s.cache === undefined ) {\n\t\ts.cache = false;\n\t}\n\tif ( s.crossDomain ) {\n\t\ts.type = \"GET\";\n\t}\n} );\n\n// Bind script tag hack transport\njQuery.ajaxTransport( \"script\", function( s ) {\n\n\t// This transport only deals with cross domain or forced-by-attrs requests\n\tif ( s.crossDomain || s.scriptAttrs ) {\n\t\tvar script, callback;\n\t\treturn {\n\t\t\tsend: function( _, complete ) {\n\t\t\t\tscript = jQuery( \"\n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

NBNSProtocol Class

\n

pysmb has a NBNSProtocol implementation for Twisted framework.\nThis allows you to perform name query asynchronously without having your application to block and wait for the results.

\n
\n
In your project,
    \n

  1. Create a NBNSProtocol instance.

    2. \n

  2. Just call queryName method which will return a Deferred instance. Add your callback function to the Deferred instance via addCallback method to receive the results of the name query.

    3. \n

  3. When you are done with the NBNSProtocol instance, call its <NBNSProtocol instance>.transport.stopListening method to remove this instance from the reactor.

    4. \n
\n
\n
\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Next topic

\n

NetBIOS class

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/nmb_NetBIOS.html", "content": "\n\n\n \n \n \n\n NetBIOS class — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

NetBIOS class

\n
\n
To use the NetBIOS class in your application,
    \n

  1. Create a new NetBIOS instance

    2. \n

  2. Call queryName method for each name you wish to query. The method will block until a reply is received from the remote SMB/CIFS service, or until timeout.

    3. \n

  3. When you are done, call close method to release the underlying resources.

    4. \n
\n
\n
\n
\n
\nclass nmb.NetBIOS.NetBIOS(broadcast=True, listen_port=0)[source]
\n
\n
\n__init__(broadcast=True, listen_port=0)[source]
\n

Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.

\n
\n
Parameters:
\n
    \n

  • broadcast (boolean) – A boolean flag to indicate if we should setup the listening UDP port in broadcast mode

    • \n

  • listen_port (integer) – Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.

    • \n
\n
\n
\n
\n\n
\n
\nclose()[source]
\n

Close the underlying and free resources.

\n

The NetBIOS instance should not be used to perform any operations after this method returns.

\n
\n
Returns:
\n

None

\n
\n
\n
\n\n
\n
\nqueryIPForName(ip, port=137, timeout=30)[source]
\n

Send a query to the machine with ip and hopes that the machine will reply back with its name.

\n

The implementation of this function is contributed by Jason Anderson.

\n
\n
Parameters:
\n
    \n

  • ip (string) – If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\nIf the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.

    • \n

  • port (integer) – The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.

    • \n

  • timeout (integer/float) – Number of seconds to wait for a reply, after which the method will return None

    • \n
\n
\n
Returns:
\n

A list of string containing the names of the machine at ip. On timeout, returns None.

\n
\n
\n
\n\n
\n
\nqueryName(name, ip='', port=137, timeout=30)[source]
\n

Send a query on the network and hopes that if machine matching the name will reply with its IP address.

\n
\n
Parameters:
\n
    \n

  • ip (string) – If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\nIf the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.

    • \n

  • port (integer) – The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.

    • \n

  • timeout (integer/float) – Number of seconds to wait for a reply, after which the method will return None

    • \n
\n
\n
Returns:
\n

A list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). On timeout, returns None.

\n
\n
\n
\n\n
\n\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Previous topic

\n

NBNSProtocol Class

\n
\n
\n

Next topic

\n

SMBConnection Class

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/smb_SMBConnection.html", "content": "\n\n\n \n \n \n\n SMBConnection Class — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

SMBConnection Class

\n

The SMBConnection is suitable for developers who wish to use pysmb to perform file operations with a remote SMB/CIFS server sequentially.

\n

Each file operation method, when invoked, will block and return after it has completed or has encountered an error.

\n
\n

Example

\n

The following illustrates a simple file retrieving implementation.:

\n
import tempfile\nfrom smb.SMBConnection import SMBConnection\n\n# There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n# client_machine_name can be an arbitary ASCII string\n# server_name should match the remote machine name, or else the connection will be rejected\nconn = SMBConnection(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\nassert conn.connect(server_ip, 139)\n\nfile_obj = tempfile.NamedTemporaryFile()\nfile_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', file_obj)\n\n# Retrieved file contents are inside file_obj\n# Do what you need with the file_obj and then close it\n# Note that the file obj is positioned at the end-of-file,\n# so you might need to perform a file_obj.seek() if you need\n# to read from the beginning\nfile_obj.close()\n
\n
\n
\n
\n

SMB2 Support

\n

Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.

\n

To disable SMB2 protocol in pysmb, set the SUPPORT_SMB2 flag in the smb_structs module to False before creating the SMBConnection instance.:

\n
from smb import smb_structs\nsmb_structs.SUPPORT_SMB2 = False\n
\n
\n
\n
\n

Caveats

\n
    \n

  • It is not meant to be used asynchronously.

    • \n

  • A single SMBConnection instance should not be used to perform more than one operation concurrently at the same time.

    • \n

  • Do not keep a SMBConnection instance “idle” for too long, i.e. keeping a SMBConnection instance but not using it.\nMost SMB/CIFS servers have some sort of keepalive mechanism and impose a timeout limit.\nIf the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client.

    • \n
\n
\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Previous topic

\n

NetBIOS class

\n
\n
\n

Next topic

\n

SMbHandler Class

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/smb_SMBHandler.html", "content": "\n\n\n \n \n \n\n SMbHandler Class — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

SMbHandler Class

\n

The SMBHandler class provides support for “smb://” URLs in the urllib2 python package.

\n
\n

Notes

\n
    \n

  • The host component of the URL must be one of the following:

    \n
      \n

    • A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com

      • \n

    • An IP address. Example: 192.168.1.1

      • \n

    • A comma-separated string “<NBName>,<IP>” where <NBName> is the Windows/NetBIOS machine name for remote SMB service, and <IP> is the service’s IP address. Example: MYSERVER,192.168.1.1

      • \n
    \n
    • \n

  • The first component of the path in the URL points to the name of the shared folder.\nSubsequent path components will point to the directory/folder of the file.

    • \n

  • You can retrieve and upload files, but you cannot delete files/folders or create folders.\nIn uploads, if the parent folders do not exist, an urllib2.URLError will be raised.

    • \n
\n
\n
\n

Example

\n

The following code snippet illustrates file retrieval with Python 2.:

\n
# -*- coding: utf-8 -*-\nimport urllib2\nfrom smb.SMBHandler import SMBHandler\n\ndirector = urllib2.build_opener(SMBHandler)\nfh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n# Process fh like a file-like object and then close it.\nfh.close()\n\n# For paths/files with unicode characters, simply pass in the URL as an unicode string\nfh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n# Process fh2 like a file-like object and then close it.\nfh2.close()\n
\n
\n

The following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the data parameter in the open() method:

\n
import urllib2\nfrom smb.SMBHandler import SMBHandler\n\nfile_fh = open('local_file.dat', 'rb')\n\ndirector = urllib2.build_opener(SMBHandler)\nfh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n# Reading from fh will only return an empty string\nfh.close()\n
\n
\n

The following code snippet illustrates file retrieval with Python 3.:

\n
import urllib\nfrom smb.SMBHandler import SMBHandler\n\ndirector = urllib.request.build_opener(SMBHandler)\nfh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n# Process fh like a file-like object and then close it.\nfh.close()\n\n# For paths/files with unicode characters, simply pass in the URL as an unicode string\nfh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n# Process fh2 like a file-like object and then close it.\nfh2.close()\n
\n
\n

The following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the data parameter in the open() method:

\n
import urllib\nfrom smb.SMBHandler import SMBHandler\n\nfile_fh = open('local_file.dat', 'rb')\n\ndirector = urllib.request.build_opener(SMBHandler)\nfh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n# Reading from fh will only return an empty string\nfh.close()\n
\n
\n
\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Previous topic

\n

SMBConnection Class

\n
\n
\n

Next topic

\n

SMBProtocolFactory Class

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/smb_SMBProtocolFactory.html", "content": "\n\n\n \n \n \n\n SMBProtocolFactory Class — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

SMBProtocolFactory Class

\n

For those who want to utilize pysmb in Twisted framework, pysmb has a smb.SMBProtocol.SMBProtocol implementation.\nIn most cases, you do not need to touch or import the SMBProtocol directly. All the SMB functionalities are exposed in the SMBProtocolFactory.

\n
\n
In your project,
    \n

  1. Create a new class and subclass SMBProtocolFactory.

    2. \n

  2. Override the SMBProtocolFactory.onAuthOK and SMBProtocolFactory.onAuthFailed instance methods to provide your own post-authenthentication handling.\nOnce SMBProtocolFactory.onAuthOK has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through\nthe SMBProtocolFactory public methods such as SMBProtocolFactory.storeFile, SMBProtocolFactory.retrieveFile, etc.

    3. \n

  3. When you want to disconnect from the remote SMB/CIFS server, just call SMBProtocolFactory.closeConnection method.

    4. \n
\n
\n
\n

All the SMBProtocolFactory public methods that provide file functionlities will return a twisted.internet.defer.Deferred instance.\nA NotReadyError exception is raised when the underlying SMB is not authenticated.\nIf the underlying SMB connection has been terminated, a NotConnectedError exception is raised.

\n

All the file operation methods in SMBProtocolFactory class accept a timeout parameter. This parameter specifies the time limit where pysmb will wait for the\nentire file operation (except storeFile and retrieveFile methods) to complete. If the file operation fails to complete within the timeout period, the returned\nDeferred instance’s errback method will be called with a SMBTimeout exception.

\n

If you are interested in learning the results of the operation or to know when the operation has completed, you should\nadd a handling method to the returned Deferred instance via Deferred.addCallback. If the file operation fails, the Deferred.errback function will be called\nwith an OperationFailure; on timeout, it will be called with a SMBTimeout.

\n
\n

Example

\n

The following illustrates a simple file retrieving implementation.:

\n
import tempfile\nfrom twisted.internet import reactor\nfrom smb.SMBProtocol import SMBProtocolFactory\n\nclass RetrieveFileFactory(SMBProtocolFactory):\n\n    def __init__(self, *args, **kwargs):\n        SMBProtocolFactory.__init__(self, *args, **kwargs)\n\n    def fileRetrieved(self, write_result):\n        file_obj, file_attributes, file_size = write_result\n\n        # Retrieved file contents are inside file_obj\n        # Do what you need with the file_obj and then close it\n        # Note that the file obj is positioned at the end-of-file,\n        # so you might need to perform a file_obj.seek() to if you\n        # need to read from the beginning\n        file_obj.close()\n\n        self.transport.loseConnection()\n\n    def onAuthOK(self):\n        d = self.retrieveFile(self.service, self.path, tempfile.NamedTemporaryFile())\n        d.addCallback(self.fileRetrieved)\n        d.addErrback(self.d.errback)\n\n    def onAuthFailed(self):\n        print 'Auth failed'\n\n# There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n# client_machine_name can be an arbitary ASCII string\n# server_name should match the remote machine name, or else the connection will be rejected\nfactory = RetrieveFileFactory(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\nfactory.service = 'smbtest'\nfactory.path = '/rfc1001.txt'\nreactor.connectTCP(server_ip, 139, factory)\n
\n
\n
\n
\n

SMB2 Support

\n

Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.

\n

To disable SMB2 protocol in pysmb, set the SUPPORT_SMB2 flag in the smb_structs module to False before creating the SMBProtocolFactory instance.:

\n
from smb import smb_structs\nsmb_structs.SUPPORT_SMB2 = False\n
\n
\n
\n
\n

Caveats

\n
    \n

  • A new factory instance must be created for each SMB connection to the remote SMB/CIFS service. Avoid reusing the same factory instance for more than one SMB connection.

    • \n

  • The remote SMB/CIFS server usually imposes a limit of the number of concurrent file operations for each client. For example, to transfer a thousand files, you may need to setup a queue in your application and call storeFile or retrieveFile in batches.

    • \n

  • The timeout parameter in the file operation methods are not precise; it is accurate to within 1 second interval, i.e. with a timeout of 0.5 sec, pysmb might raise\nSMBTimeout exception after 1.5 sec.

    • \n
\n
\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Previous topic

\n

SMbHandler Class

\n
\n
\n

Next topic

\n

SharedDevice Class

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/smb_SharedDevice.html", "content": "\n\n\n \n \n \n\n SharedDevice Class — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

SharedDevice Class

\n
\n\n\n
\n
\n
\n
\n
\n
\n
\n

Previous topic

\n

SMBProtocolFactory Class

\n
\n
\n

Next topic

\n

SharedFile Class

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/smb_SharedFile.html", "content": "\n\n\n \n \n \n\n SharedFile Class — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

SharedFile Class

\n
\n\n\n
\n
\n
\n
\n
\n
\n
\n

Previous topic

\n

SharedDevice Class

\n
\n
\n

Next topic

\n

SMB Exceptions

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/smb_exceptions.html", "content": "\n\n\n \n \n \n\n SMB Exceptions — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

SMB Exceptions

\n
\n
\nclass smb.smb_structs.UnsupportedFeature[source]
\n

Raised when an supported feature is present/required in the protocol but is not\ncurrently supported by pysmb

\n
\n\n
\n
\nclass smb.smb_structs.ProtocolError(message, data_buf=None, smb_message=None)[source]
\n
\n\n
\n
\nclass smb.smb_structs.OperationFailure(message, smb_messages)[source]
\n
\n\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Previous topic

\n

SharedFile Class

\n
\n
\n

Next topic

\n

Security Descriptors

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/api/smb_security_descriptors.html", "content": "\n\n\n \n \n \n\n Security Descriptors — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

Security Descriptors

\n

This module implements security descriptors, and associated data\nstructures, as specified in [MS-DTYP].

\n
\n
\nclass smb.security_descriptors.SID(revision, identifier_authority, subauthorities)[source]
\n

A Windows security identifier. Represents a single principal, such a\nuser or a group, as a sequence of numbers consisting of the revision,\nidentifier authority, and a variable-length list of subauthorities.

\n

See [MS-DTYP]: 2.4.2

\n
\n
\nidentifier_authority
\n

An integer representing the identifier authority.

\n
\n\n
\n
\nrevision
\n

Revision, should always be 1.

\n
\n\n
\n
\nsubauthorities
\n

A list of integers representing all subauthorities.

\n
\n\n
\n\n
\n
\nclass smb.security_descriptors.ACE(type_, flags, mask, sid, additional_data)[source]
\n

Represents a single access control entry.

\n

See [MS-DTYP]: 2.4.4

\n
\n
\nadditional_data
\n

A dictionary of additional fields present in the ACE, depending\non the type. The following fields can be present:

\n
    \n

  • flags

    • \n

  • object_type

    • \n

  • inherited_object_type

    • \n

  • application_data

    • \n

  • attribute_data

    • \n
\n
\n\n
\n
\nflags
\n

An integer bitmask with ACE flags, corresponds to the\nAceFlags field.

\n
\n\n
\n
\nproperty isInheritOnly
\n

Convenience property which indicates if this ACE is inherit\nonly, meaning that it doesn’t apply to the object itself.

\n
\n\n
\n
\nmask
\n

An integer representing the ACCESS_MASK as specified in\n[MS-DTYP] 2.4.3.

\n
\n\n
\n
\nsid
\n

The SID of a trustee.

\n
\n\n
\n
\ntype
\n

An integer representing the type of the ACE. One of the\nACE_TYPE_* constants. Corresponds to the AceType field\nfrom [MS-DTYP] 2.4.4.1.

\n
\n\n
\n\n
\n
\nclass smb.security_descriptors.ACL(revision, aces)[source]
\n

Access control list, encapsulating a sequence of access control\nentries.

\n

See [MS-DTYP]: 2.4.5

\n
\n
\naces
\n

List of ACE instances.

\n
\n\n
\n
\nrevision
\n

Integer value of the revision.

\n
\n\n
\n\n
\n
\nclass smb.security_descriptors.SecurityDescriptor(flags, owner, group, dacl, sacl)[source]
\n

Represents a security descriptor.

\n

See [MS-DTYP]: 2.4.6

\n
\n
\ndacl
\n

Instance of ACL representing the discretionary access\ncontrol list, which specifies access restrictions of an object.

\n
\n\n
\n
\nflags
\n

Integer bitmask of control flags. Corresponds to the\nControl field in [MS-DTYP] 2.4.6.

\n
\n\n
\n
\ngroup
\n

Instance of SID representing the owner group.

\n
\n\n
\n
\nowner
\n

Instance of SID representing the owner user.

\n
\n\n
\n
\nsacl
\n

Instance of ACL representing the system access control\nlist, which specifies audit logging of an object.

\n
\n\n
\n\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Previous topic

\n

SMB Exceptions

\n
\n \n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/extending.html", "content": "\n\n\n \n \n \n\n Extending pysmb For Other Frameworks — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

Extending pysmb For Other Frameworks

\n

This page briefly describes the steps involved in extending pysmb for other frameworks.

\n

In general, you need to take care of the SMB TCP connection setup, i.e. finding the IP address of the remote server and connect to the SMB/CIFS service.\nThen you need to read/write synchronously or asynchronously from and to the SMB socket. And you need to handle post-authentication callback methods, and from these methods,\ninitiate file operations with the remote SMB/CIFS server.

\n
\n
Now the above steps in more technical details:
    \n

  1. Create a new class which subclasses the smb.base.SMB class. Most often, the connection setup will be part of the __init__ method.

    2. \n

  2. Override the write(self, data) method to provide an implementation which will write data to the socket.

    3. \n

  3. Write your own loop handling method to read data from the socket. Once data have been read, call feedData method with the parameter.\nThe feedData method has its own internal buffer, so it can accept incomplete NetBIOS session packet data.

    4. \n

  4. Override

    5. \n
\n
\n
    \n

  • onAuthOK method to include your own operations to perform when authentication is successful. You can initiate file operations in this method.

    • \n

  • onAuthFailed method to include your own processing on what to do when authentication fails. You can report this as an error, or to try a different NTLM authentication algorithm (use_ntlm_v2 parameter in the constructor).

    • \n

  • onNMBSessionFailed method to include your own processing on what to do when pysmb fails to setup the NetBIOS session with the remote server. Usually, this is due to a wrong remote_name parameter in the constructor.

    • \n
\n
\n
\n
\n
\n\n\n
\n
\n
\n
\n
\n
\n
\n

Previous topic

\n

Security Descriptors

\n
\n \n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/genindex.html", "content": "\n\n\n \n \n \n Index — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n\n

Index

\n\n
\n _\n | A\n | C\n | D\n | F\n | G\n | I\n | M\n | N\n | O\n | P\n | Q\n | R\n | S\n | T\n | U\n \n
\n

_

\n\n \n
\n\n

A

\n\n \n \n
\n\n

C

\n\n \n
\n\n

D

\n\n \n
\n\n

F

\n\n \n
\n\n

G

\n\n \n
\n\n

I

\n\n \n \n
\n\n

M

\n\n \n \n
\n\n

N

\n\n \n
\n\n

O

\n\n \n \n
\n\n

P

\n\n \n
\n\n

Q

\n\n \n \n
\n\n

R

\n\n \n
\n\n

S

\n\n \n \n
\n\n

T

\n\n \n
\n\n

U

\n\n \n
\n\n\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/index.html", "content": "\n\n\n \n \n \n\n Welcome to pysmb’s documentation! — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

Welcome to pysmb’s documentation!

\n

pysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol\nthat facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application.\npysmb is developed in Python 2.7.x and Python 3.8.x and has been tested against shared folders on Windows 7, Windows 10 and Samba 4.x.

\n

The latest version of pysmb is always available at the pysmb project page at miketeo.net.

\n
\n

License

\n

pysmb itself is licensed under an opensource license.\nYou are free to use pysmb in any applications, including for commercial purposes.\nFor more details on the terms of use, please read the LICENSE file that comes with your pysmb source.

\n

pysmb depends on other 3rd-party modules whose terms of use are not covered by pysmb.\nUse of these modules could possibly conflict with your licensing needs. Please exercise your own discretion to determine their suitabilities.\nI have listed these modules in the following section.

\n
\n
\n

Credits

\n

pysmb is not alone. It is made possible with support from other modules.

\n
    \n

  • pyasn1 : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately)

    • \n

  • md4 and U32 : Pure Python implementation of MD4 hashing algorithm and 32-bit unsigned integer by Dmitry Rozmanov. Licensed under LGPL and included together with pysmb.

    • \n

  • pyDes : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb.

    • \n

  • sha256 : Pure Python implementation of SHA-256 message digest by Thomas Dixon. Licensed under MIT and included together with pysmb. This module is imported only when\nthe Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm.

    • \n
\n

In various places, there are references to different specifications. Most of these referenced specifications\ncan be downloaded from Microsoft web site under Microsoft’s “Open Specification Promise”. If you need to download\na copy of these specifications, please google for it. For example, google for “MS-CIFS” to download the CIFS specification for NT LM dialect.

\n
\n
\n
\n

Package Contents and Description

\n

pysmb is organized into 2 main packages: smb and nmb.\nThe smb package contains all the functionalities related to Server Message Block (SMB) implementation.\nAs an application developer, you will be importing this module into your application.\nHence, please take some time to familiarize yourself with the smb package contents.

\n
    \n

  • nmb/base.py :\nContains the NetBIOSSession and NBNS abstract class which implements NetBIOS session and NetBIOS Name Service communication\nwithout any network transport specifics.

    • \n

  • nmb/NetBIOS.py:\nProvides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O.

    • \n

  • nmb/NetBIOSProtocol.py :\nProvides the NBNS protocol implementation for use in Twisted framework.

    • \n

  • smb/base.py :\nContains the SMB abstract class which implements the SMB communication without any network transport specifics.

    • \n

  • smb/ntlm.py :\nContains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages.

    • \n

  • smb/securityblob.py :\nProvides routines to encode/decode the NTLMSSP security blob in the SMB messages.

    • \n

  • smb/smb_constants.py :\nAll the constants used in the smb package for SMB1 protocol

    • \n

  • smb/smb_structs.py :\nContains the internal classes used in the SMB package for SMB1 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB1 message.

    • \n

  • smb/smb2_constants.py :\nAll the constants used in the smb package for SMB2 protocol

    • \n

  • smb/smb2_structs.py :\nContains the internal classes used in the SMB package for SMB2 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB2 message.

    • \n

  • smb/SMBConnection.py :\nContains a SMB protocol implementation. All operations are blocking I/O.

    • \n

  • smb/SMBProtocol.py :\nContains the SMB protocol implementation for use in the Twisted framework.

    • \n

  • smb/SMBHandler.py :\nProvides support for “smb://” URL in the urllib2 python package.

    • \n
\n
\n
\n

Using pysmb

\n
\n
As an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses,
    \n

  • To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read\nnmb.NetBIOS.NetBIOS documentation.

    • \n

  • To use pysmb in Twisted, please read nmb.NetBIOSProtocol.NBNSProtocol documentation.

    • \n
\n
\n
As an application developer who is looking to use pysmb to implement file transfer or authentication over SMB:
\n
\n
As a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks:
\n
\n
If you are upgrading from older pysmb versions:
\n
\n
\n
\n
\n

Indices and tables

\n
\n\n
\n\n
\n\n\n
\n
\n
\n
\n
\n
\n \n
\n

Next topic

\n

NBNSProtocol Class

\n
\n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/py-modindex.html", "content": "\n\n\n \n \n \n Python Module Index — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n\n\n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n\n

Python Module Index

\n\n
\n s\n
\n\n \n \n \n \n \n \n \n \n \n
 
\n s
\"-\"\n smb\n
   \n smb.security_descriptors\n Data structures used in Windows security descriptors.
\n\n\n
\n
\n
\n
\n
\n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/search.html", "content": "\n\n\n \n \n \n Search — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n \n \n \n\n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n

Search

\n \n \n \n \n

\n Searching for multiple words only shows matches that contain\n all words.\n

\n \n \n
\n \n \n \n
\n \n \n \n
\n \n
\n \n\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "docs/html/searchindex.js", "content": "Search.setIndex({\"docnames\": [\"api/nmb_NBNSProtocol\", \"api/nmb_NetBIOS\", \"api/smb_SMBConnection\", \"api/smb_SMBHandler\", \"api/smb_SMBProtocolFactory\", \"api/smb_SharedDevice\", \"api/smb_SharedFile\", \"api/smb_exceptions\", \"api/smb_security_descriptors\", \"extending\", \"index\", \"upgrading\"], \"filenames\": [\"api/nmb_NBNSProtocol.rst\", \"api/nmb_NetBIOS.rst\", \"api/smb_SMBConnection.rst\", \"api/smb_SMBHandler.rst\", \"api/smb_SMBProtocolFactory.rst\", \"api/smb_SharedDevice.rst\", \"api/smb_SharedFile.rst\", \"api/smb_exceptions.rst\", \"api/smb_security_descriptors.rst\", \"extending.rst\", \"index.rst\", \"upgrading.rst\"], \"titles\": [\"NBNSProtocol Class\", \"NetBIOS class\", \"SMBConnection Class\", \"SMbHandler Class\", \"SMBProtocolFactory Class\", \"SharedDevice Class\", \"SharedFile Class\", \"SMB Exceptions\", \"Security Descriptors\", \"Extending pysmb For Other Frameworks\", \"Welcome to pysmb\\u2019s documentation!\", \"Upgrading from older pysmb versions\"], \"terms\": {\"pysmb\": [0, 2, 4, 7], \"ha\": [0, 2, 4, 9, 10, 11], \"implement\": [0, 1, 2, 4, 8, 9, 10], \"twist\": [0, 4, 10], \"framework\": [0, 4, 10], \"thi\": [0, 1, 4, 8, 9, 10, 11], \"allow\": 0, \"you\": [0, 1, 2, 3, 4, 9, 10, 11], \"perform\": [0, 1, 2, 4, 9], \"name\": [0, 1, 2, 3, 4, 10, 11], \"queri\": [0, 1, 10, 11], \"asynchron\": [0, 2, 9], \"without\": [0, 10], \"have\": [0, 2, 9, 10, 11], \"your\": [0, 1, 3, 4, 9, 10, 11], \"applic\": [0, 1, 4, 10, 11], \"block\": [0, 1, 2, 10], \"wait\": [0, 1, 4], \"result\": [0, 4], \"In\": [0, 3, 4, 9, 10], \"project\": [0, 4, 10], \"creat\": [0, 1, 2, 3, 4, 9], \"instanc\": [0, 1, 2, 4, 8, 11], \"just\": [0, 4], \"call\": [0, 1, 4, 9], \"querynam\": [0, 1], \"method\": [0, 1, 2, 3, 4, 9, 11], \"which\": [0, 1, 8, 9, 10, 11], \"return\": [0, 1, 2, 3, 4, 10, 11], \"defer\": [0, 4], \"add\": [0, 4, 11], \"callback\": [0, 9], \"function\": [0, 1, 4, 10], \"via\": [0, 4, 10], \"addcallback\": [0, 4], \"receiv\": [0, 1], \"when\": [0, 1, 2, 4, 7, 9, 10], \"ar\": [0, 1, 2, 4, 10, 11], \"done\": [0, 1], \"its\": [0, 1, 9], \"transport\": [0, 4, 10], \"stoplisten\": 0, \"remov\": 0, \"from\": [0, 1, 2, 3, 4, 8, 9, 10], \"reactor\": [0, 4], \"To\": [1, 2, 4, 10], \"us\": [1, 2, 4, 11], \"new\": [1, 4, 9, 11], \"each\": [1, 2, 4], \"wish\": [1, 2], \"The\": [1, 2, 3, 4, 8, 9, 10], \"until\": 1, \"repli\": 1, \"i\": [1, 2, 3, 4, 7, 8, 9, 10, 11], \"remot\": [1, 2, 3, 4, 9, 11], \"smb\": [1, 2, 3, 4, 8, 9, 10, 11], \"cif\": [1, 2, 4, 9, 10], \"servic\": [1, 2, 3, 4, 9, 10], \"timeout\": [1, 2, 4, 11], \"close\": [1, 2, 3, 4], \"releas\": [1, 11], \"underli\": [1, 4, 10], \"resourc\": 1, \"nmb\": [1, 10, 11], \"broadcast\": 1, \"true\": [1, 2, 4, 11], \"listen_port\": 1, \"0\": [1, 2, 4], \"sourc\": [1, 7, 8, 10], \"__init__\": [1, 4, 9], \"instanti\": 1, \"ipv4\": 1, \"udp\": 1, \"socket\": [1, 9], \"listen\": 1, \"send\": 1, \"nbn\": [1, 10], \"packet\": [1, 9], \"paramet\": [1, 3, 4, 9, 10, 11], \"boolean\": 1, \"A\": [1, 2, 3, 4, 8, 11], \"flag\": [1, 2, 4, 8], \"indic\": [1, 8, 11], \"we\": 1, \"should\": [1, 2, 4, 8], \"setup\": [1, 4, 9], \"port\": 1, \"mode\": 1, \"integ\": [1, 8, 10], \"specifi\": [1, 4, 8, 11], \"number\": [1, 4, 8, 11], \"bind\": 1, \"If\": [1, 2, 4, 10, 11], \"zero\": 1, \"o\": [1, 10], \"automat\": [1, 2, 4], \"select\": 1, \"free\": [1, 10], \"ani\": [1, 10], \"oper\": [1, 2, 4, 9, 10, 11], \"after\": [1, 2, 4, 10], \"none\": [1, 7], \"queryipfornam\": [1, 11], \"ip\": [1, 3, 9, 10, 11], \"137\": 1, \"30\": 1, \"machin\": [1, 2, 3, 4, 10, 11], \"hope\": 1, \"back\": [1, 2, 4], \"contribut\": 1, \"jason\": 1, \"anderson\": 1, \"string\": [1, 2, 3, 4], \"nbnsprotocol\": [1, 10, 11], \"wa\": [1, 11], \"instiant\": 1, \"can\": [1, 2, 3, 4, 8, 9, 10, 11], \"an\": [1, 2, 3, 4, 7, 8, 9, 10], \"empti\": [1, 3], \"leav\": 1, \"determin\": [1, 10], \"appropri\": 1, \"address\": [1, 3, 9, 10, 11], \"fals\": [1, 2, 4], \"provid\": [1, 3, 4, 9, 10], \"target\": 1, \"n\": 1, \"iana\": 1, \"standard\": [1, 10], \"defin\": [1, 11], \"touch\": [1, 4], \"unless\": 1, \"know\": [1, 4], \"what\": [1, 2, 4, 9], \"do\": [1, 2, 3, 4, 9, 11], \"float\": 1, \"second\": [1, 4], \"list\": [1, 8, 10], \"contain\": [1, 10], \"On\": 1, \"network\": [1, 10], \"match\": [1, 2, 4], \"dot\": 1, \"notat\": 1, \"aaa\": 1, \"bbb\": 1, \"ccc\": 1, \"ddd\": 1, \"suitabl\": [2, 10], \"develop\": [2, 10], \"who\": [2, 4, 10], \"file\": [2, 3, 4, 9, 10, 11], \"server\": [2, 4, 9, 10, 11], \"sequenti\": 2, \"invok\": 2, \"complet\": [2, 4, 10, 11], \"encount\": 2, \"error\": [2, 9], \"follow\": [2, 3, 4, 8, 10], \"illustr\": [2, 3, 4], \"simpl\": [2, 4], \"retriev\": [2, 3, 4, 11], \"import\": [2, 3, 4, 10], \"tempfil\": [2, 4], \"There\": [2, 4], \"some\": [2, 4, 10], \"mechan\": [2, 4], \"captur\": [2, 4], \"userid\": [2, 4], \"password\": [2, 4], \"client_machine_nam\": [2, 4], \"server_nam\": [2, 4], \"server_ip\": [2, 4], \"arbitari\": [2, 4], \"ascii\": [2, 4], \"els\": [2, 4], \"connect\": [2, 4, 9], \"reject\": [2, 4], \"conn\": 2, \"use_ntlm_v2\": [2, 4, 9], \"assert\": 2, \"139\": [2, 4], \"file_obj\": [2, 4], \"namedtemporaryfil\": [2, 4], \"file_attribut\": [2, 4], \"files\": 2, \"retrievefil\": [2, 4], \"smbtest\": [2, 4], \"rfc1001\": [2, 3, 4], \"txt\": [2, 3, 4], \"content\": [2, 4], \"insid\": [2, 4], \"need\": [2, 3, 4, 9, 10], \"note\": [2, 4], \"obj\": [2, 4], \"posit\": [2, 4], \"end\": [2, 4], \"so\": [2, 4, 9, 10], \"might\": [2, 4], \"seek\": [2, 4], \"read\": [2, 3, 4, 9, 10, 11], \"begin\": [2, 4], \"start\": [2, 4], \"1\": [2, 3, 4, 8, 10], \"util\": [2, 4], \"protocol\": [2, 4, 7, 10], \"commun\": [2, 4, 10], \"otherwis\": [2, 4], \"fallback\": [2, 4], \"smb1\": [2, 4, 10], \"disabl\": [2, 4], \"set\": [2, 4], \"support_smb2\": [2, 4], \"smb_struct\": [2, 4, 7, 10], \"modul\": [2, 4, 8, 10], \"befor\": [2, 4, 11], \"It\": [2, 10], \"meant\": 2, \"singl\": [2, 8], \"more\": [2, 4, 9, 10], \"than\": [2, 4], \"one\": [2, 3, 4], \"concurr\": [2, 4], \"same\": [2, 4], \"time\": [2, 4, 10], \"keep\": 2, \"idl\": 2, \"too\": 2, \"long\": 2, \"e\": [2, 4, 9], \"most\": [2, 4, 9, 10, 11], \"sort\": 2, \"keepal\": 2, \"impos\": [2, 4], \"limit\": [2, 4], \"client\": [2, 4, 10], \"fail\": [2, 4, 9], \"respond\": 2, \"within\": [2, 4, 10], \"mai\": [2, 4], \"disconnect\": [2, 4], \"support\": [3, 7, 10, 11], \"url\": [3, 10], \"urllib2\": [3, 10], \"python\": [3, 10], \"packag\": 3, \"host\": 3, \"compon\": 3, \"must\": [3, 4], \"fulli\": 3, \"qualifi\": 3, \"hostnam\": 3, \"resolv\": 3, \"local\": 3, \"dn\": 3, \"myserv\": 3, \"test\": [3, 10], \"com\": 3, \"192\": 3, \"168\": 3, \"comma\": 3, \"separ\": [3, 10], \"nbname\": 3, \"where\": [3, 4, 10], \"window\": [3, 8, 10], \"netbio\": [3, 9, 10, 11], \"\": [3, 4, 11], \"first\": 3, \"path\": [3, 4], \"point\": 3, \"share\": [3, 10], \"folder\": [3, 10, 11], \"subsequ\": 3, \"directori\": [3, 11], \"upload\": 3, \"cannot\": 3, \"delet\": [3, 11], \"parent\": 3, \"exist\": 3, \"urlerror\": 3, \"rais\": [3, 4, 7], \"code\": 3, \"snippet\": 3, \"2\": [3, 8, 10], \"utf\": 3, \"8\": [3, 10], \"director\": 3, \"build_open\": 3, \"fh\": 3, \"open\": [3, 10], \"myuserid\": 3, \"mypassword\": 3, \"sharedfold\": 3, \"process\": [3, 9], \"like\": [3, 11], \"object\": [3, 8], \"For\": [3, 4, 10], \"unicod\": 3, \"charact\": 3, \"simpli\": 3, \"pass\": [3, 11], \"fh2\": 3, \"u\": 3, \"\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939\": 3, \"\\u5783\\u573e\\u6587\\u4ef6\": 3, \"dat\": 3, \"data\": [3, 8, 9, 10], \"file_fh\": 3, \"local_fil\": 3, \"rb\": 3, \"upload_fil\": 3, \"onli\": [3, 8, 10, 11], \"3\": [3, 8, 10], \"urllib\": 3, \"request\": 3, \"those\": 4, \"want\": [4, 10], \"smbprotocol\": [4, 10], \"case\": 4, \"directli\": 4, \"all\": [4, 8, 10], \"expos\": 4, \"subclass\": [4, 9], \"overrid\": [4, 9], \"onauthok\": [4, 9], \"onauthfail\": [4, 9], \"own\": [4, 9, 10], \"post\": [4, 9], \"authenthent\": 4, \"handl\": [4, 9], \"onc\": [4, 9], \"been\": [4, 9, 10], \"pymsb\": 4, \"intern\": [4, 9, 10], \"readi\": 4, \"through\": 4, \"public\": 4, \"storefil\": 4, \"etc\": 4, \"closeconnect\": 4, \"functionl\": 4, \"internet\": 4, \"notreadyerror\": 4, \"except\": [4, 10], \"authent\": [4, 9, 10], \"termin\": 4, \"notconnectederror\": 4, \"accept\": [4, 9], \"entir\": 4, \"period\": 4, \"errback\": 4, \"smbtimeout\": 4, \"interest\": 4, \"learn\": 4, \"operationfailur\": [4, 7], \"retrievefilefactori\": 4, \"def\": 4, \"self\": [4, 9], \"arg\": 4, \"kwarg\": 4, \"fileretriev\": 4, \"write_result\": 4, \"file_s\": 4, \"loseconnect\": 4, \"d\": 4, \"adderrback\": 4, \"print\": [4, 10], \"auth\": 4, \"factori\": 4, \"connecttcp\": 4, \"avoid\": 4, \"reus\": 4, \"usual\": [4, 9, 10], \"transfer\": [4, 10], \"thousand\": 4, \"queue\": 4, \"batch\": 4, \"precis\": 4, \"accur\": 4, \"interv\": 4, \"5\": [4, 8], \"sec\": 4, \"class\": [7, 8, 9, 10, 11], \"unsupportedfeatur\": 7, \"featur\": 7, \"present\": [7, 8], \"requir\": 7, \"current\": 7, \"protocolerror\": 7, \"messag\": [7, 10], \"data_buf\": 7, \"smb_messag\": 7, \"associ\": 8, \"structur\": 8, \"m\": [8, 10], \"dtyp\": 8, \"security_descriptor\": 8, \"sid\": 8, \"revis\": 8, \"identifier_author\": 8, \"subauthor\": 8, \"identifi\": 8, \"repres\": [8, 11], \"princip\": 8, \"user\": 8, \"group\": 8, \"sequenc\": 8, \"consist\": 8, \"author\": 8, \"variabl\": 8, \"length\": 8, \"see\": 8, \"4\": [8, 10], \"alwai\": [8, 10], \"ac\": 8, \"type_\": 8, \"mask\": 8, \"additional_data\": 8, \"access\": 8, \"control\": [8, 11], \"entri\": [8, 11], \"dictionari\": 8, \"addit\": 8, \"field\": 8, \"depend\": [8, 10], \"type\": 8, \"object_typ\": 8, \"inherited_object_typ\": 8, \"application_data\": 8, \"attribute_data\": 8, \"bitmask\": 8, \"correspond\": 8, \"aceflag\": 8, \"properti\": [8, 11], \"isinheritonli\": 8, \"conveni\": 8, \"inherit\": 8, \"mean\": 8, \"doesn\": 8, \"t\": 8, \"appli\": 8, \"itself\": [8, 10], \"access_mask\": 8, \"truste\": 8, \"One\": 8, \"ace_type_\": 8, \"constant\": [8, 10], \"acetyp\": 8, \"acl\": 8, \"encapsul\": 8, \"valu\": 8, \"securitydescriptor\": 8, \"owner\": 8, \"dacl\": 8, \"sacl\": 8, \"6\": 8, \"discretionari\": 8, \"restrict\": 8, \"system\": [8, 11], \"audit\": 8, \"log\": 8, \"page\": [9, 10, 11], \"briefli\": 9, \"describ\": 9, \"step\": 9, \"involv\": 9, \"gener\": 9, \"take\": [9, 10], \"care\": 9, \"tcp\": 9, \"find\": 9, \"Then\": 9, \"write\": [9, 11], \"synchron\": [9, 10], \"And\": 9, \"initi\": 9, \"now\": [9, 11], \"abov\": 9, \"technic\": 9, \"detail\": [9, 10], \"base\": [9, 10], \"often\": 9, \"part\": 9, \"loop\": 9, \"feeddata\": 9, \"buffer\": 9, \"incomplet\": 9, \"session\": [9, 10], \"includ\": [9, 10, 11], \"success\": 9, \"report\": 9, \"try\": 9, \"differ\": [9, 10], \"ntlm\": [9, 10], \"algorithm\": [9, 10], \"constructor\": 9, \"onnmbsessionfail\": 9, \"due\": 9, \"wrong\": 9, \"remote_nam\": 9, \"pure\": 10, \"side\": 10, \"smb2\": 10, \"facilit\": 10, \"between\": 10, \"well\": 10, \"linux\": 10, \"samba\": 10, \"7\": 10, \"x\": [10, 11], \"against\": 10, \"10\": 10, \"latest\": 10, \"version\": 10, \"avail\": 10, \"miketeo\": 10, \"net\": 10, \"under\": 10, \"opensourc\": 10, \"commerci\": 10, \"purpos\": 10, \"term\": 10, \"pleas\": [10, 11], \"come\": 10, \"other\": [10, 11], \"3rd\": 10, \"parti\": 10, \"whose\": 10, \"cover\": 10, \"could\": [10, 11], \"possibli\": 10, \"conflict\": 10, \"exercis\": 10, \"discret\": 10, \"section\": 10, \"alon\": 10, \"made\": 10, \"possibl\": 10, \"pyasn1\": 10, \"asn\": 10, \"pars\": 10, \"encod\": 10, \"togeth\": 10, \"instal\": 10, \"md4\": 10, \"u32\": 10, \"hash\": 10, \"32\": 10, \"bit\": 10, \"unsign\": 10, \"dmitri\": 10, \"rozmanov\": 10, \"lgpl\": 10, \"pyde\": 10, \"de\": 10, \"encrypt\": [10, 11], \"todd\": 10, \"whiteman\": 10, \"domain\": 10, \"sha256\": 10, \"sha\": 10, \"256\": 10, \"digest\": 10, \"thoma\": 10, \"dixon\": 10, \"mit\": 10, \"librari\": 10, \"doe\": 10, \"variou\": 10, \"place\": 10, \"refer\": [10, 11], \"specif\": 10, \"referenc\": 10, \"download\": 10, \"microsoft\": 10, \"web\": 10, \"site\": 10, \"promis\": 10, \"copi\": 10, \"googl\": 10, \"exampl\": 10, \"nt\": 10, \"lm\": 10, \"dialect\": 10, \"organ\": 10, \"main\": 10, \"relat\": 10, \"As\": 10, \"henc\": 10, \"familiar\": 10, \"yourself\": 10, \"py\": 10, \"netbiossess\": 10, \"abstract\": 10, \"netbiosprotocol\": 10, \"ntlmv1\": 10, \"ntlmv2\": 10, \"routin\": 10, \"decod\": 10, \"securityblob\": 10, \"ntlmssp\": 10, \"secur\": 10, \"blob\": 10, \"smb_constant\": 10, \"These\": 10, \"smb2_constant\": 10, \"smb2_struct\": 10, \"smbconnect\": [10, 11], \"smbhandler\": 10, \"look\": 10, \"translat\": 10, \"thei\": 10, \"style\": 10, \"over\": 10, \"smbprotocolfactori\": [10, 11], \"softwar\": 10, \"modifi\": 10, \"integr\": 10, \"extend\": 10, \"upgrad\": 10, \"older\": 10, \"shareddevic\": 10, \"sharedfil\": [10, 11], \"descriptor\": 10, \"index\": [10, 11], \"search\": [10, 11], \"document\": 11, \"improv\": 11, \"chang\": 11, \"api\": 11, \"incompat\": 11, \"previou\": 11, \"delete_matching_fold\": 11, \"deletefil\": 11, \"sub\": 11, \"switch\": 11, \"listpath\": 11, \"file_id\": 11, \"attribut\": 11, \"given\": 11, \"context\": 11, \"manag\": 11, \"isnorm\": 11, \"normal\": 11, \"hidden\": 11, \"archiv\": 11, \"ignor\": 11, \"compress\": 11, \"spars\": 11, \"temporari\": 11, \"default\": 11, \"getsecur\": 11, \"ad\": 11, \"truncat\": 11, \"storefilefromoffset\": 11, \"getattribut\": 11, \"isreadonli\": 11, \"filesystem\": 11, \"workgroup\": 11, \"two\": 11, \"were\": 11, \"retrievefilefromoffset\": 11, \"finer\": 11, \"rewritten\": 11, \"rewrit\": 11}, \"objects\": {\"nmb.NetBIOS\": [[1, 0, 1, \"\", \"NetBIOS\"]], \"nmb.NetBIOS.NetBIOS\": [[1, 1, 1, \"\", \"__init__\"], [1, 1, 1, \"\", \"close\"], [1, 1, 1, \"\", \"queryIPForName\"], [1, 1, 1, \"\", \"queryName\"]], \"smb\": [[8, 2, 0, \"-\", \"security_descriptors\"]], \"smb.security_descriptors\": [[8, 0, 1, \"\", \"ACE\"], [8, 0, 1, \"\", \"ACL\"], [8, 0, 1, \"\", \"SID\"], [8, 0, 1, \"\", \"SecurityDescriptor\"]], \"smb.security_descriptors.ACE\": [[8, 3, 1, \"\", \"additional_data\"], [8, 3, 1, \"\", \"flags\"], [8, 4, 1, \"\", \"isInheritOnly\"], [8, 3, 1, \"\", \"mask\"], [8, 3, 1, \"\", \"sid\"], [8, 3, 1, \"\", \"type\"]], \"smb.security_descriptors.ACL\": [[8, 3, 1, \"\", \"aces\"], [8, 3, 1, \"\", \"revision\"]], \"smb.security_descriptors.SID\": [[8, 3, 1, \"\", \"identifier_authority\"], [8, 3, 1, \"\", \"revision\"], [8, 3, 1, \"\", \"subauthorities\"]], \"smb.security_descriptors.SecurityDescriptor\": [[8, 3, 1, \"\", \"dacl\"], [8, 3, 1, \"\", \"flags\"], [8, 3, 1, \"\", \"group\"], [8, 3, 1, \"\", \"owner\"], [8, 3, 1, \"\", \"sacl\"]], \"smb.smb_structs\": [[7, 0, 1, \"\", \"OperationFailure\"], [7, 0, 1, \"\", \"ProtocolError\"], [7, 0, 1, \"\", \"UnsupportedFeature\"]]}, \"objtypes\": {\"0\": \"py:class\", \"1\": \"py:method\", \"2\": \"py:module\", \"3\": \"py:attribute\", \"4\": \"py:property\"}, \"objnames\": {\"0\": [\"py\", \"class\", \"Python class\"], \"1\": [\"py\", \"method\", \"Python method\"], \"2\": [\"py\", \"module\", \"Python module\"], \"3\": [\"py\", \"attribute\", \"Python attribute\"], \"4\": [\"py\", \"property\", \"Python property\"]}, \"titleterms\": {\"nbnsprotocol\": 0, \"class\": [0, 1, 2, 3, 4, 5, 6], \"netbio\": 1, \"smbconnect\": 2, \"exampl\": [2, 3, 4], \"smb2\": [2, 4], \"support\": [2, 4], \"caveat\": [2, 4], \"smbhandler\": 3, \"note\": 3, \"smbprotocolfactori\": 4, \"shareddevic\": 5, \"sharedfil\": 6, \"smb\": 7, \"except\": 7, \"secur\": 8, \"descriptor\": 8, \"extend\": 9, \"pysmb\": [9, 10, 11], \"For\": 9, \"other\": 9, \"framework\": 9, \"welcom\": 10, \"\": 10, \"document\": 10, \"licens\": 10, \"credit\": 10, \"packag\": 10, \"content\": 10, \"descript\": 10, \"us\": 10, \"indic\": 10, \"tabl\": 10, \"upgrad\": 11, \"from\": 11, \"older\": 11, \"version\": 11, \"1\": 11, \"2\": 11, \"0\": 11, \"28\": 11, \"26\": 11, \"25\": 11, \"20\": 11, \"15\": 11, \"11\": 11, \"10\": 11, \"3\": 11}, \"envversion\": {\"sphinx.domains.c\": 3, \"sphinx.domains.changeset\": 1, \"sphinx.domains.citation\": 1, \"sphinx.domains.cpp\": 9, \"sphinx.domains.index\": 1, \"sphinx.domains.javascript\": 3, \"sphinx.domains.math\": 2, \"sphinx.domains.python\": 4, \"sphinx.domains.rst\": 2, \"sphinx.domains.std\": 2, \"sphinx.ext.todo\": 2, \"sphinx.ext.viewcode\": 1, \"sphinx\": 60}, \"alltitles\": {\"NBNSProtocol Class\": [[0, \"nbnsprotocol-class\"]], \"NetBIOS class\": [[1, \"netbios-class\"]], \"SMBConnection Class\": [[2, \"smbconnection-class\"]], \"Example\": [[2, \"example\"], [3, \"example\"], [4, \"example\"]], \"SMB2 Support\": [[2, \"smb2-support\"], [4, \"smb2-support\"]], \"Caveats\": [[2, \"caveats\"], [4, \"caveats\"]], \"SMbHandler Class\": [[3, \"smbhandler-class\"]], \"Notes\": [[3, \"notes\"]], \"SMBProtocolFactory Class\": [[4, \"smbprotocolfactory-class\"]], \"SharedDevice Class\": [[5, \"shareddevice-class\"]], \"SharedFile Class\": [[6, \"sharedfile-class\"]], \"SMB Exceptions\": [[7, \"smb-exceptions\"]], \"Security Descriptors\": [[8, \"module-smb.security_descriptors\"]], \"Extending pysmb For Other Frameworks\": [[9, \"extending-pysmb-for-other-frameworks\"]], \"Welcome to pysmb\\u2019s documentation!\": [[10, \"welcome-to-pysmb-s-documentation\"]], \"License\": [[10, \"license\"]], \"Credits\": [[10, \"credits\"]], \"Package Contents and Description\": [[10, \"package-contents-and-description\"]], \"Using pysmb\": [[10, \"using-pysmb\"]], \"Indices and tables\": [[10, \"indices-and-tables\"]], \"Upgrading from older pysmb versions\": [[11, \"upgrading-from-older-pysmb-versions\"]], \"pysmb 1.2.0\": [[11, \"pysmb-1-2-0\"]], \"pysmb 1.1.28\": [[11, \"pysmb-1-1-28\"]], \"pysmb 1.1.26\": [[11, \"pysmb-1-1-26\"]], \"pysmb 1.1.25\": [[11, \"pysmb-1-1-25\"]], \"pysmb 1.1.20\": [[11, \"pysmb-1-1-20\"]], \"pysmb 1.1.15\": [[11, \"pysmb-1-1-15\"]], \"pysmb 1.1.11\": [[11, \"pysmb-1-1-11\"]], \"pysmb 1.1.10\": [[11, \"pysmb-1-1-10\"]], \"pysmb 1.1.2\": [[11, \"pysmb-1-1-2\"]], \"pysmb 1.0.3\": [[11, \"pysmb-1-0-3\"]], \"pysmb 1.0.0\": [[11, \"pysmb-1-0-0\"]]}, \"indexentries\": {\"netbios (class in nmb.netbios)\": [[1, \"nmb.NetBIOS.NetBIOS\"]], \"__init__() (nmb.netbios.netbios method)\": [[1, \"nmb.NetBIOS.NetBIOS.__init__\"]], \"close() (nmb.netbios.netbios method)\": [[1, \"nmb.NetBIOS.NetBIOS.close\"]], \"queryipforname() (nmb.netbios.netbios method)\": [[1, \"nmb.NetBIOS.NetBIOS.queryIPForName\"]], \"queryname() (nmb.netbios.netbios method)\": [[1, \"nmb.NetBIOS.NetBIOS.queryName\"]], \"operationfailure (class in smb.smb_structs)\": [[7, \"smb.smb_structs.OperationFailure\"]], \"protocolerror (class in smb.smb_structs)\": [[7, \"smb.smb_structs.ProtocolError\"]], \"unsupportedfeature (class in smb.smb_structs)\": [[7, \"smb.smb_structs.UnsupportedFeature\"]], \"ace (class in smb.security_descriptors)\": [[8, \"smb.security_descriptors.ACE\"]], \"acl (class in smb.security_descriptors)\": [[8, \"smb.security_descriptors.ACL\"]], \"sid (class in smb.security_descriptors)\": [[8, \"smb.security_descriptors.SID\"]], \"securitydescriptor (class in smb.security_descriptors)\": [[8, \"smb.security_descriptors.SecurityDescriptor\"]], \"aces (smb.security_descriptors.acl attribute)\": [[8, \"smb.security_descriptors.ACL.aces\"]], \"additional_data (smb.security_descriptors.ace attribute)\": [[8, \"smb.security_descriptors.ACE.additional_data\"]], \"dacl (smb.security_descriptors.securitydescriptor attribute)\": [[8, \"smb.security_descriptors.SecurityDescriptor.dacl\"]], \"flags (smb.security_descriptors.ace attribute)\": [[8, \"smb.security_descriptors.ACE.flags\"]], \"flags (smb.security_descriptors.securitydescriptor attribute)\": [[8, \"smb.security_descriptors.SecurityDescriptor.flags\"]], \"group (smb.security_descriptors.securitydescriptor attribute)\": [[8, \"smb.security_descriptors.SecurityDescriptor.group\"]], \"identifier_authority (smb.security_descriptors.sid attribute)\": [[8, \"smb.security_descriptors.SID.identifier_authority\"]], \"isinheritonly (smb.security_descriptors.ace property)\": [[8, \"smb.security_descriptors.ACE.isInheritOnly\"]], \"mask (smb.security_descriptors.ace attribute)\": [[8, \"smb.security_descriptors.ACE.mask\"]], \"module\": [[8, \"module-smb.security_descriptors\"]], \"owner (smb.security_descriptors.securitydescriptor attribute)\": [[8, \"smb.security_descriptors.SecurityDescriptor.owner\"]], \"revision (smb.security_descriptors.acl attribute)\": [[8, \"smb.security_descriptors.ACL.revision\"]], \"revision (smb.security_descriptors.sid attribute)\": [[8, \"smb.security_descriptors.SID.revision\"]], \"sacl (smb.security_descriptors.securitydescriptor attribute)\": [[8, \"smb.security_descriptors.SecurityDescriptor.sacl\"]], \"sid (smb.security_descriptors.ace attribute)\": [[8, \"smb.security_descriptors.ACE.sid\"]], \"smb.security_descriptors\": [[8, \"module-smb.security_descriptors\"]], \"subauthorities (smb.security_descriptors.sid attribute)\": [[8, \"smb.security_descriptors.SID.subauthorities\"]], \"type (smb.security_descriptors.ace attribute)\": [[8, \"smb.security_descriptors.ACE.type\"]]}})" }, { "path": "docs/html/upgrading.html", "content": "\n\n\n \n \n \n\n Upgrading from older pysmb versions — pysmb 1.2.13 documentation\n \n \n \n \n \n \n \n \n \n
\n

Navigation

\n \n
\n\n
\n
\n
\n
\n \n
\n

Upgrading from older pysmb versions

\n

This page documents the improvements and changes to the API that could be incompatible with previous releases.

\n
\n

pysmb 1.2.0

\n
    \n

  • Add new delete_matching_folders parameter to deleteFiles() method in SMBProtocolFactory and SMBConnection\nclass to support deletion of sub-folders. If you are passing timeout parameter to the deleteFiles() method\nin your application, please switch to using named parameter for timeout.

    • \n
\n
\n
\n

pysmb 1.1.28

\n
    \n

  • SharedFile instances returned from the listPath() method now has a new property\nfile_id attribute which represents the file reference number given by the remote SMB server.

    • \n
\n
\n
\n

pysmb 1.1.26

\n
    \n

  • SMBConnection class can now be used as a context manager

    • \n
\n
\n
\n

pysmb 1.1.25

\n
    \n

  • SharedFile class has a new property isNormal which will be True if the file is a\n‘normal’ file. pysmb defines a ‘normal’ file as a file entry that is not\nread-only, not hidden, not system, not archive and not a directory;\nit ignores other attributes like compression, indexed, sparse, temporary and encryption.

    • \n

  • listPath() method in SMBProtocolFactory and SMBConnection class will now include\n‘normal’ files by default if you do not specify the search parameter.

    • \n
\n
\n
\n

pysmb 1.1.20

\n
    \n

  • A new method getSecurity() was added to SMBConnection and SMBProtocolFactory class.

    • \n
\n
\n
\n

pysmb 1.1.15

\n
    \n

  • Add new truncate parameter to storeFileFromOffset() in SMBProtocolFactory and SMBConnection\nclass to support truncation of the file before writing. If you are passing timeout parameter\nto the storeFileFromOffset() method in your application, please switch to using named parameter for timeout.

    • \n
\n
\n
\n

pysmb 1.1.11

\n
    \n

  • A new method storeFileFromOffset() was added to SMBConnection and SMBProtocolFactory class.

    • \n
\n
\n
\n

pysmb 1.1.10

\n
    \n

  • A new method getAttributes() was added to SMBConnection and SMBProtocolFactory class

    • \n

  • SharedFile class has a new property isReadOnly to indicate the file is read-only on the remote filesystem.

    • \n
\n
\n
\n

pysmb 1.1.2

\n
    \n

  • queryIPForName() method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names.

    • \n
\n
\n
\n

pysmb 1.0.3

\n
    \n

  • Two new methods were added to NBNSProtocol class: queryIPForName() and NetBIOS.queryIPForName()\nto support querying for a machine’s NetBIOS name at the given IP address.

    • \n

  • A new method retrieveFileFromOffset() was added to SMBProtocolFactory and SMBConnection\nto support finer control of file retrieval operation.

    • \n
\n
\n
\n

pysmb 1.0.0

\n

pysmb was completely rewritten in version 1.0.0.\nIf you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API.

\n
\n
\n\n\n
\n
\n
\n
\n
\n
\n \n \n
\n

This Page

\n \n
\n
\n

Quick search

\n
\n
\n \n \n
\n
\n
\n\n
\n
\n
\n
\n
\n

Navigation

\n \n
\n
\n © Copyright 2001-2025, Michael Teo https://miketeo.net/.\n Created using Sphinx 7.2.6.\n
\n \n" }, { "path": "python2/nmb/NetBIOS.py", "content": "\nimport os, logging, random, socket, time, select\nfrom base import NBNS, NotConnectedError\nfrom nmb_constants import TYPE_CLIENT, TYPE_SERVER, TYPE_WORKSTATION\n\nclass NetBIOS(NBNS):\n\n log = logging.getLogger('NMB.NetBIOS')\n\n def __init__(self, broadcast = True, listen_port = 0):\n \"\"\"\n Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.\n\n :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode\n :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.\n \"\"\"\n self.broadcast = broadcast\n self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)\n if self.broadcast:\n self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)\n if listen_port:\n self.sock.bind(( '', listen_port ))\n\n def close(self):\n \"\"\"\n Close the underlying and free resources.\n\n The NetBIOS instance should not be used to perform any operations after this method returns.\n\n :return: None\n \"\"\"\n self.sock.close()\n self.sock = None\n\n def write(self, data, ip, port):\n assert self.sock, 'Socket is already closed'\n self.sock.sendto(data, ( ip, port ))\n\n def queryName(self, name, ip = '', port = 137, timeout = 30):\n \"\"\"\n Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n :return: A list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). On timeout, returns None.\n \"\"\"\n assert self.sock, 'Socket is already closed'\n\n trn_id = random.randint(1, 0xFFFF)\n data = self.prepareNameQuery(trn_id, name)\n if self.broadcast and not ip:\n ip = ''\n elif not ip:\n self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')\n\n self.write(data, ip, port)\n\n return self._pollForNetBIOSPacket(trn_id, timeout)\n\n def queryIPForName(self, ip, port = 137, timeout = 30):\n \"\"\"\n Send a query to the machine with *ip* and hopes that the machine will reply back with its name.\n\n The implementation of this function is contributed by Jason Anderson.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n :return: A list of string containing the names of the machine at *ip*. On timeout, returns None.\n \"\"\"\n assert self.sock, 'Socket is already closed'\n\n trn_id = random.randint(1, 0xFFFF)\n data = self.prepareNetNameQuery(trn_id, False)\n self.write(data, ip, port)\n ret = self._pollForQueryPacket(trn_id, timeout)\n if ret:\n return map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret))\n else:\n return None\n\n #\n # Protected Methods\n #\n\n def _pollForNetBIOSPacket(self, wait_trn_id, timeout):\n end_time = time.time() + timeout\n while True:\n try:\n _timeout = end_time - time.time()\n if _timeout <= 0:\n return None\n\n ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)\n if not ready:\n return None\n\n data, _ = self.sock.recvfrom(0xFFFF)\n if len(data) == 0:\n raise NotConnectedError\n\n trn_id, ret = self.decodePacket(data)\n\n if trn_id == wait_trn_id:\n return ret\n except select.error, ex:\n if type(ex) is types.TupleType:\n if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n raise ex\n else:\n raise ex\n\n #\n # Contributed by Jason Anderson\n #\n def _pollForQueryPacket(self, wait_trn_id, timeout):\n end_time = time.time() + timeout\n while True:\n try:\n _timeout = end_time - time.time()\n if _timeout <= 0:\n return None\n\n ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)\n if not ready:\n return None\n\n data, _ = self.sock.recvfrom(0xFFFF)\n if len(data) == 0:\n raise NotConnectedError\n\n trn_id, ret = self.decodeIPQueryPacket(data)\n\n if trn_id == wait_trn_id:\n return ret\n except select.error, ex:\n if type(ex) is types.TupleType:\n if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n raise ex\n else:\n raise ex\n" }, { "path": "python2/nmb/NetBIOSProtocol.py", "content": "\nimport os, logging, random, socket, time\nfrom twisted.internet import reactor, defer\nfrom twisted.internet.protocol import DatagramProtocol\nfrom nmb_constants import TYPE_SERVER\nfrom base import NBNS\n\nIP_QUERY, NAME_QUERY = range(2)\n\nclass NetBIOSTimeout(Exception):\n \"\"\"Raised in NBNSProtocol via Deferred.errback method when queryName method has timeout waiting for reply\"\"\"\n pass\n\nclass NBNSProtocol(DatagramProtocol, NBNS):\n\n log = logging.getLogger('NMB.NBNSProtocol')\n\n def __init__(self, broadcast = True, listen_port = 0):\n \"\"\"\n Instantiate a NBNSProtocol instance.\n\n This automatically calls reactor.listenUDP method to start listening for incoming packets, so you **must not** call the listenUDP method again.\n\n :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode\n :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.\n \"\"\"\n self.broadcast = broadcast\n self.pending_trns = { } # TRN ID -> ( expiry_time, name, Deferred instance )\n self.transport = reactor.listenUDP(listen_port, self)\n if self.broadcast:\n self.transport.getHandle().setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)\n reactor.callLater(1, self.cleanupPendingTrns)\n\n def datagramReceived(self, data, from_info):\n host, port = from_info\n trn_id, ret = self.decodePacket(data)\n\n # pending transaction exists for trn_id - handle it and remove from queue\n if trn_id in self.pending_trns:\n _, ip, d = self.pending_trns.pop(trn_id)\n if ip is NAME_QUERY:\n # decode as query packet\n trn_id, ret = self.decodeIPQueryPacket(data)\n d.callback(ret)\n\n def write(self, data, ip, port):\n # We don't use the transport.write method directly as it keeps raising DeprecationWarning for ip=''\n self.transport.getHandle().sendto(data, ( ip, port ))\n\n def queryName(self, name, ip = '', port = 137, timeout = 30):\n \"\"\"\n Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the returned Deferred instance will be called with a NetBIOSTimeout exception.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of IP addresses in dotted notation (aaa.bbb.ccc.ddd).\n On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception\n \"\"\"\n trn_id = random.randint(1, 0xFFFF)\n while True:\n if not self.pending_trns.has_key(trn_id):\n break\n else:\n trn_id = (trn_id + 1) & 0xFFFF\n\n data = self.prepareNameQuery(trn_id, name)\n if self.broadcast and not ip:\n ip = ''\n elif not ip:\n self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')\n\n self.write(data, ip, port)\n\n d = defer.Deferred()\n self.pending_trns[trn_id] = ( time.time()+timeout, name, d )\n return d\n\n def queryIPForName(self, ip, port = 137, timeout = 30):\n \"\"\"\n Send a query to the machine with *ip* and hopes that the machine will reply back with its name.\n\n The implementation of this function is contributed by Jason Anderson.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of names of the machine at *ip*.\n On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception\n \"\"\"\n trn_id = random.randint(1, 0xFFFF)\n while True:\n if not self.pending_trns.has_key(trn_id):\n break\n else:\n trn_id = (trn_id + 1) & 0xFFFF\n\n data = self.prepareNetNameQuery(trn_id)\n self.write(data, ip, port)\n\n d = defer.Deferred()\n d2 = defer.Deferred()\n d2.addErrback(d.errback)\n\n def stripCode(ret):\n if ret is not None: # got valid response. Somehow the callback is also called when there is an error.\n d.callback(map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret)))\n\n d2.addCallback(stripCode)\n self.pending_trns[trn_id] = ( time.time()+timeout, NAME_QUERY, d2 )\n return d\n\n def stopProtocol(self):\n DatagramProtocol.stopProtocol(self)\n\n def cleanupPendingTrns(self):\n now = time.time()\n\n # reply should have been received in the past\n expired = filter(lambda (trn_id, (expiry_time, name, d)): expiry_time < now, self.pending_trns.iteritems())\n\n # remove expired items from dict + call errback\n def expire_item(item):\n trn_id, (expiry_time, name, d) = item\n\n del self.pending_trns[trn_id]\n try:\n d.errback(NetBIOSTimeout(name))\n except: pass\n\n map(expire_item, expired)\n\n if self.transport:\n reactor.callLater(1, self.cleanupPendingTrns)\n" }, { "path": "python2/nmb/__init__.py", "content": "" }, { "path": "python2/nmb/base.py", "content": "\nimport struct, logging, random\nfrom nmb_constants import *\nfrom nmb_structs import *\nfrom utils import encode_name\n\nclass NMBSession:\n\n log = logging.getLogger('NMB.NMBSession')\n\n def __init__(self, my_name, remote_name, host_type = TYPE_SERVER, is_direct_tcp = False):\n self.my_name = my_name.upper()\n self.remote_name = remote_name.upper()\n self.host_type = host_type\n self.data_buf = ''\n\n if is_direct_tcp:\n self.data_nmb = DirectTCPSessionMessage()\n self.sendNMBPacket = self._sendNMBPacket_DirectTCP\n else:\n self.data_nmb = NMBSessionMessage()\n self.sendNMBPacket = self._sendNMBPacket_NetBIOS\n\n #\n # Overridden Methods\n #\n\n def write(self, data):\n raise NotImplementedError\n\n def onNMBSessionMessage(self, flags, data):\n pass\n\n def onNMBSessionOK(self):\n pass\n\n def onNMBSessionFailed(self):\n pass\n\n #\n # Public Methods\n #\n\n def feedData(self, data):\n self.data_buf = self.data_buf + data\n\n offset = 0\n while True:\n length = self.data_nmb.decode(self.data_buf, offset)\n if length == 0:\n break\n elif length > 0:\n offset += length\n self._processNMBSessionPacket(self.data_nmb)\n else:\n raise NMBError\n\n if offset > 0:\n self.data_buf = self.data_buf[offset:]\n\n def sendNMBMessage(self, data):\n self.sendNMBPacket(SESSION_MESSAGE, data)\n\n def requestNMBSession(self):\n my_name_encoded = encode_name(self.my_name, TYPE_WORKSTATION)\n remote_name_encoded = encode_name(self.remote_name, self.host_type)\n self.sendNMBPacket(SESSION_REQUEST, remote_name_encoded + my_name_encoded)\n\n #\n # Protected Methods\n #\n\n def _processNMBSessionPacket(self, packet):\n if packet.type == SESSION_MESSAGE:\n self.onNMBSessionMessage(packet.flags, packet.data)\n elif packet.type == POSITIVE_SESSION_RESPONSE:\n self.onNMBSessionOK()\n elif packet.type == NEGATIVE_SESSION_RESPONSE:\n self.onNMBSessionFailed()\n elif packet.type == SESSION_KEEPALIVE:\n # Discard keepalive packets - [RFC1002]: 5.2.2.1\n pass\n else:\n self.log.warning('Unrecognized NMB session type: 0x%02x', packet.type)\n\n def _sendNMBPacket_NetBIOS(self, packet_type, data):\n length = len(data)\n assert length <= 0x01FFFF\n flags = 0\n if length > 0xFFFF:\n flags |= 0x01\n length &= 0xFFFF\n self.write(struct.pack('>BBH', packet_type, flags, length) + data)\n\n def _sendNMBPacket_DirectTCP(self, packet_type, data):\n length = len(data)\n assert length <= 0x00FFFFFF\n self.write(struct.pack('>I', length) + data)\n\n\nclass NBNS:\n\n log = logging.getLogger('NMB.NBNS')\n\n HEADER_STRUCT_FORMAT = '>HHHHHH'\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n def write(self, data, ip, port):\n raise NotImplementedError\n\n def decodePacket(self, data):\n if len(data) < self.HEADER_STRUCT_SIZE:\n raise Exception\n\n trn_id, code, question_count, answer_count, authority_count, additional_count = struct.unpack(self.HEADER_STRUCT_FORMAT, data[:self.HEADER_STRUCT_SIZE])\n\n is_response = bool((code >> 15) & 0x01)\n opcode = (code >> 11) & 0x0F\n flags = (code >> 4) & 0x7F\n rcode = code & 0x0F\n\n if opcode == 0x0000 and is_response:\n name_len = ord(data[self.HEADER_STRUCT_SIZE])\n offset = self.HEADER_STRUCT_SIZE+2+name_len+8 # constant 2 for the padding bytes before/after the Name and constant 8 for the Type, Class and TTL fields in the Answer section after the Name\n record_count = (struct.unpack('>H', data[offset:offset+2])[0]) / 6\n\n offset += 4 # Constant 4 for the Data Length and Flags field\n ret = [ ]\n for i in range(0, record_count):\n ret.append('%d.%d.%d.%d' % struct.unpack('4B', (data[offset:offset + 4])))\n offset += 6\n return trn_id, ret\n else:\n return trn_id, None\n\n\n def prepareNameQuery(self, trn_id, name, is_broadcast = True):\n header = struct.pack(self.HEADER_STRUCT_FORMAT,\n trn_id, (is_broadcast and 0x0110) or 0x0100, 1, 0, 0, 0)\n payload = encode_name(name, 0x20) + '\\x00\\x20\\x00\\x01'\n\n return header + payload\n\n #\n # Contributed by Jason Anderson\n #\n def decodeIPQueryPacket(self, data):\n if len(data) < self.HEADER_STRUCT_SIZE:\n raise Exception\n\n trn_id, code, question_count, answer_count, authority_count, additional_count = struct.unpack(self.HEADER_STRUCT_FORMAT, data[:self.HEADER_STRUCT_SIZE])\n\n is_response = bool((code >> 15) & 0x01)\n opcode = (code >> 11) & 0x0F\n flags = (code >> 4) & 0x7F\n rcode = code & 0x0F\n\n try:\n numnames = struct.unpack('B', data[self.HEADER_STRUCT_SIZE + 44])[0]\n\n if numnames > 0:\n ret = [ ]\n offset = self.HEADER_STRUCT_SIZE + 45\n\n for i in range(0, numnames):\n mynme = data[offset:offset + 15]\n mynme = mynme.strip()\n ret.append(( mynme, ord(data[offset+15]) ))\n offset += 18\n\n return trn_id, ret\n except IndexError:\n pass\n\n return trn_id, None\n\n #\n # Contributed by Jason Anderson\n #\n def prepareNetNameQuery(self, trn_id, is_broadcast = True):\n header = struct.pack(self.HEADER_STRUCT_FORMAT,\n trn_id, (is_broadcast and 0x0010) or 0x0000, 1, 0, 0, 0)\n payload = encode_name('*', 0) + '\\x00\\x21\\x00\\x01'\n\n return header + payload\n" }, { "path": "python2/nmb/nmb_constants.py", "content": "\n# Default port for NetBIOS name service\nNETBIOS_NS_PORT = 137\n\n# Default port for NetBIOS session service\nNETBIOS_SESSION_PORT = 139\n\n# Owner Node Type Constants\nNODE_B = 0x00\nNODE_P = 0x01\nNODE_M = 0x10\nNODE_RESERVED = 0x11\n\n# Name Type Constants\nTYPE_UNKNOWN = 0x01\nTYPE_WORKSTATION = 0x00\nTYPE_CLIENT = 0x03\nTYPE_SERVER = 0x20\nTYPE_DOMAIN_MASTER = 0x1B\nTYPE_MASTER_BROWSER = 0x1D\nTYPE_BROWSER = 0x1E\n\nTYPE_NAMES = { TYPE_UNKNOWN: 'Unknown',\n TYPE_WORKSTATION: 'Workstation',\n TYPE_CLIENT: 'Client',\n TYPE_SERVER: 'Server',\n TYPE_MASTER_BROWSER: 'Master Browser',\n TYPE_BROWSER: 'Browser Server',\n TYPE_DOMAIN_MASTER: 'Domain Master'\n }\n\n# Values for Session Packet Type field in Session Packets\nSESSION_MESSAGE = 0x00\nSESSION_REQUEST = 0x81\nPOSITIVE_SESSION_RESPONSE = 0x82\nNEGATIVE_SESSION_RESPONSE = 0x83\nREGTARGET_SESSION_RESPONSE = 0x84\nSESSION_KEEPALIVE = 0x85\n" }, { "path": "python2/nmb/nmb_structs.py", "content": "\nimport struct\n\nclass NMBError(Exception): pass\n\n\nclass NotConnectedError(NMBError):\n \"\"\"\n Raisd when the underlying NMB connection has been disconnected or not connected yet\n \"\"\"\n pass\n\n\nclass NMBSessionMessage:\n\n HEADER_STRUCT_FORMAT = '>BBH'\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n def __init__(self):\n self.reset()\n\n def reset(self):\n self.type = 0\n self.flags = 0\n self.data = ''\n\n def decode(self, data, offset):\n data_len = len(data)\n\n if data_len < offset + self.HEADER_STRUCT_SIZE:\n # Not enough data for decoding\n return 0\n\n self.reset()\n self.type, self.flags, length = struct.unpack(self.HEADER_STRUCT_FORMAT, data[offset:offset+self.HEADER_STRUCT_SIZE])\n\n if self.flags & 0x01:\n length |= 0x010000\n\n if data_len < offset + self.HEADER_STRUCT_SIZE + length:\n return 0\n\n self.data = data[offset+self.HEADER_STRUCT_SIZE:offset+self.HEADER_STRUCT_SIZE+length]\n return self.HEADER_STRUCT_SIZE + length\n\n\nclass DirectTCPSessionMessage(NMBSessionMessage):\n\n HEADER_STRUCT_FORMAT = '>I'\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n def decode(self, data, offset):\n data_len = len(data)\n\n if data_len < offset + self.HEADER_STRUCT_SIZE:\n # Not enough data for decoding\n return 0\n\n self.reset()\n length = struct.unpack(self.HEADER_STRUCT_FORMAT, data[offset:offset+self.HEADER_STRUCT_SIZE])[0]\n\n if length >> 24 != 0:\n raise NMBError(\"Invalid protocol header for Direct TCP session message\")\n\n if data_len < offset + self.HEADER_STRUCT_SIZE + length:\n return 0\n\n self.data = data[offset+self.HEADER_STRUCT_SIZE:offset+self.HEADER_STRUCT_SIZE+length]\n return self.HEADER_STRUCT_SIZE + length\n" }, { "path": "python2/nmb/utils.py", "content": "\nimport string, re\n\n\ndef encode_name(name, type, scope = None):\n \"\"\"\n Perform first and second level encoding of name as specified in RFC 1001 (Section 4)\n \"\"\"\n if name == '*':\n name = name + '\\0' * 15\n elif len(name) > 15:\n name = name[:15] + chr(type)\n else:\n name = string.ljust(name, 15) + chr(type)\n\n def _do_first_level_encoding(m):\n s = ord(m.group(0))\n return string.uppercase[s >> 4] + string.uppercase[s & 0x0f]\n\n encoded_name = chr(len(name) * 2) + re.sub('.', _do_first_level_encoding, name)\n if scope:\n encoded_scope = ''\n for s in string.split(scope, '.'):\n encoded_scope = encoded_scope + chr(len(s)) + s\n return encoded_name + encoded_scope + '\\0'\n else:\n return encoded_name + '\\0'\n\n\ndef decode_name(name):\n name_length = ord(name[0])\n assert name_length == 32\n\n def _do_first_level_decoding(m):\n s = m.group(0)\n return chr(((ord(s[0]) - ord('A')) << 4) | (ord(s[1]) - ord('A')))\n\n decoded_name = re.sub('..', _do_first_level_decoding, name[1:33])\n if name[33] == '\\0':\n return 34, decoded_name, ''\n else:\n decoded_domain = ''\n offset = 34\n while 1:\n domain_length = ord(name[offset])\n if domain_length == 0:\n break\n decoded_domain = '.' + name[offset:offset + domain_length]\n offset = offset + domain_length\n return offset + 1, decoded_name, decoded_domain\n" }, { "path": "python2/smb/SMBConnection.py", "content": "\nimport os, logging, select, socket, struct, errno\nfrom smb_constants import *\nfrom smb_structs import *\nfrom base import SMB, NotConnectedError, NotReadyError, SMBTimeout\n\n\nclass SMBConnection(SMB):\n\n log = logging.getLogger('SMB.SMBConnection')\n\n #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n SIGN_NEVER = 0\n #: SMB messages will be signed when remote server supports signing but not requires signing.\n SIGN_WHEN_SUPPORTED = 1\n #: SMB messages will only be signed when remote server requires signing.\n SIGN_WHEN_REQUIRED = 2\n\n def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n \"\"\"\n Create a new SMBConnection instance.\n\n *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.\n *password* can be a string or a callable returning a string.\n File operations can only be proceeded after the connection has been authenticated successfully.\n\n Note that you need to call *connect* method to actually establish the SMB connection to the remote server and perform authentication.\n\n The default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.\n Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.\n\n :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.\n You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\\\\/:*?\";|+``\n :param string remote_name: The NetBIOS machine name of the remote server.\n On windows, you can find out the machine name by right-clicking on the \"My Computer\" and selecting \"Properties\".\n This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.\n :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.\n :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.\n The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.\n Hence, we can only \"guess\" or try both algorithms.\n On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.\n :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.\n If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.\n If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.\n If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.\n The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).\n \"\"\"\n SMB.__init__(self, username, password, my_name, remote_name, domain, use_ntlm_v2, sign_options, is_direct_tcp)\n self.sock = None\n self.auth_result = None\n self.is_busy = False\n self.is_direct_tcp = is_direct_tcp\n\n #\n # SMB (and its superclass) Methods\n #\n\n def onAuthOK(self):\n self.auth_result = True\n\n def onAuthFailed(self):\n self.auth_result = False\n\n def write(self, data):\n assert self.sock\n data_len = len(data)\n total_sent = 0\n while total_sent < data_len:\n sent = self.sock.send(data[total_sent:])\n if sent == 0:\n raise NotConnectedError('Server disconnected')\n total_sent = total_sent + sent\n\n #\n # Support for \"with\" context\n #\n def __enter__(self):\n return self\n\n def __exit__(self, *args):\n self.close()\n\n #\n # Misc Properties\n #\n\n @property\n def isUsingSMB2(self):\n \"\"\"A convenient property to return True if the underlying SMB connection is using SMB2 protocol.\"\"\"\n return self.is_using_smb2\n\n\n #\n # Public Methods\n #\n\n def connect(self, ip, port = 139, sock_family = socket.AF_INET, timeout = 60):\n \"\"\"\n Establish the SMB connection to the remote SMB/CIFS server.\n\n You must call this method before attempting any of the file operations with the remote server.\n This method will block until the SMB connection has attempted at least one authentication.\n\n :return: A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise.\n \"\"\"\n if self.sock:\n self.sock.close()\n\n self.auth_result = None\n self.sock = socket.socket(sock_family)\n self.sock.settimeout(timeout)\n self.sock.connect(( ip, port ))\n\n self.is_busy = True\n try:\n if not self.is_direct_tcp:\n self.requestNMBSession()\n else:\n self.onNMBSessionOK()\n while self.auth_result is None:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return self.auth_result\n\n def close(self):\n \"\"\"\n Terminate the SMB connection (if it has been started) and release any sources held by the underlying socket.\n \"\"\"\n if self.sock:\n self.sock.close()\n self.sock = None\n\n def listShares(self, timeout = 30):\n \"\"\"\n Retrieve a list of shared resources on remote server.\n\n :return: A list of :doc:`smb.base.SharedDevice` instances describing the shared resource\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(entries):\n self.is_busy = False\n results.extend(entries)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._listShares(cb, eb, timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results\n\n def listPath(self, service_name, path,\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL,\n pattern = '*', timeout = 30):\n \"\"\"\n Retrieve a directory listing of files/folders at *path*\n\n For simplicity, pysmb defines a \"normal\" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n\n Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),\n system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files\n and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).\n If you do not need to include \"normal\" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.\n SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.\n :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).\n :param string/unicode pattern: the filter to apply to the results before returning to the client.\n :return: A list of :doc:`smb.base.SharedFile` instances.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(entries):\n self.is_busy = False\n results.extend(entries)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._listPath(service_name, path, cb, eb, search = search, pattern = pattern, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results\n\n def listSnapshots(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve a list of available snapshots (shadow copies) for *path*.\n\n Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots\n :return: A list of python *datetime.DateTime* instances in GMT/UTC time zone\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(entries):\n self.is_busy = False\n results.extend(entries)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._listSnapshots(service_name, path, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results\n\n def getAttributes(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve information about the file at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :return: A :doc:`smb.base.SharedFile` instance containing the attributes of the file.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(info):\n self.is_busy = False\n results.append(info)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._getAttributes(service_name, path, cb, eb, timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def getSecurity(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve the security descriptor of the file at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :return: A :class:`smb.security_descriptors.SecurityDescriptor` instance containing the security information of the file.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(info):\n self.is_busy = False\n results.append(info)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._getSecurity(service_name, path, cb, eb, timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def retrieveFile(self, service_name, path, file_obj, timeout = 30):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n Use *retrieveFileFromOffset()* method if you wish to specify the offset to read from the remote *path* and/or the number of bytes to write to the *file_obj*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service.\n :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n return self.retrieveFileFromOffset(service_name, path, file_obj, 0L, -1L, timeout)\n\n def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0L, max_length = -1L, timeout = 30):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* up to *max_length* number of bytes.\n :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.\n :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.\n If zero, the method returns immediately after the file is opened successfully for reading.\n :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(r):\n self.is_busy = False\n results.append(r[1:])\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._retrieveFileFromOffset(service_name, path, file_obj, cb, eb, offset, max_length, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def storeFile(self, service_name, path, file_obj, timeout = 30):\n \"\"\"\n Store the contents of the *file_obj* at *path* on the *service_name*.\n If the file already exists on the remote server, it will be truncated and overwritten.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.\n If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.\n :return: Number of bytes uploaded\n \"\"\"\n return self.storeFileFromOffset(service_name, path, file_obj, 0L, True, timeout)\n\n def storeFileFromOffset(self, service_name, path, file_obj, offset = 0L, truncate = False, timeout = 30):\n \"\"\"\n Store the contents of the *file_obj* at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created.\n If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.\n :param offset: Long integer value which specifies the offset in the remote server to start writing. First byte of the file is 0.\n :param truncate: Boolean value. If True and the file exists on the remote server, it will be truncated first before writing. Default is False.\n :return: the file position where the next byte will be written.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(r):\n self.is_busy = False\n results.append(r[1])\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._storeFileFromOffset(service_name, path, file_obj, cb, eb, offset, truncate = truncate, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30):\n \"\"\"\n Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.\n\n If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n Wildcards may be used in th filename component of the path.\n If your path/filename contains non-English characters, you must pass in an unicode string.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._deleteFiles(service_name, path_file_pattern, delete_matching_folders, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def resetFileAttributes(self, service_name, path_file_pattern, file_attributes = ATTR_NORMAL, timeout = 30):\n \"\"\"\n Reset file attributes of one or more regular files or folders.\n It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request.\n This function is very helpful when deleting files/folders that are read-only.\n By default, it sets the ATTR_NORMAL flag, therefore clearing all other flags.\n (See https://msdn.microsoft.com/en-us/library/cc232110.aspx for further information)\n\n Note: this function is currently only implemented for SMB2!\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n Wildcards may be used in the filename component of the path.\n If your path/filename contains non-English characters, you must pass in an unicode string.\n :param int file_attributes: The desired file attributes to set. Defaults to `ATTR_NORMAL`.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._resetFileAttributes(service_name, path_file_pattern, cb, eb, file_attributes, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def createDirectory(self, service_name, path, timeout = 30):\n \"\"\"\n Creates a new directory *path* on the *service_name*.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the new folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._createDirectory(service_name, path, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def deleteDirectory(self, service_name, path, timeout = 30):\n \"\"\"\n Delete the empty folder at *path* on *service_name*\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._deleteDirectory(service_name, path, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def rename(self, service_name, old_path, new_path, timeout = 30):\n \"\"\"\n Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders\n\n *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._rename(service_name, old_path, new_path, cb, eb)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def echo(self, data, timeout = 10):\n \"\"\"\n Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.\n\n :param bytes data: Data to send to the remote server. Must be a bytes object.\n :return: The *data* parameter\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(r):\n self.is_busy = False\n results.append(r)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._echo(data, cb, eb)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n #\n # Protected Methods\n #\n\n def _pollForNetBIOSPacket(self, timeout):\n expiry_time = time.time() + timeout\n read_len = 4\n data = ''\n\n while read_len > 0:\n try:\n if expiry_time < time.time():\n raise SMBTimeout\n\n ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], timeout)\n if not ready:\n raise SMBTimeout\n\n d = self.sock.recv(read_len)\n if len(d) == 0:\n raise NotConnectedError\n\n data = data + d\n read_len -= len(d)\n except select.error, ex:\n if isinstance(ex, types.TupleType):\n if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n raise ex\n else:\n raise ex\n\n type_, flags, length = struct.unpack('>BBH', data)\n if flags & 0x01:\n length = length | 0x10000\n\n read_len = length\n while read_len > 0:\n try:\n if expiry_time < time.time():\n raise SMBTimeout\n\n ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], timeout)\n if not ready:\n raise SMBTimeout\n\n d = self.sock.recv(read_len)\n if len(d) == 0:\n raise NotConnectedError\n\n data = data + d\n read_len -= len(d)\n except select.error, ex:\n if isinstance(ex, types.TupleType):\n if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n raise ex\n else:\n raise ex\n\n self.feedData(data)\n" }, { "path": "python2/smb/SMBHandler.py", "content": "\nimport os, sys, socket, urllib2, mimetypes, mimetools, tempfile\nfrom urllib import (unwrap, unquote, splittype, splithost, quote,\n addinfourl, splitport, splittag,\n splitattr, ftpwrapper, splituser, splitpasswd, splitvalue)\nfrom nmb.NetBIOS import NetBIOS\nfrom smb.SMBConnection import SMBConnection\n\ntry:\n from cStringIO import StringIO\nexcept ImportError:\n from StringIO import StringIO\n\nUSE_NTLM = True\nMACHINE_NAME = None\n\nclass SMBHandler(urllib2.BaseHandler):\n\n def smb_open(self, req):\n global USE_NTLM, MACHINE_NAME\n\n host = req.get_host()\n if not host:\n raise urllib2.URLError('SMB error: no host given')\n host, port = splitport(host)\n if port is None:\n port = 139\n else:\n port = int(port)\n\n # username/password handling\n user, host = splituser(host)\n if user:\n user, passwd = splitpasswd(user)\n else:\n passwd = None\n host = unquote(host)\n user = user or ''\n\n domain = ''\n if ';' in user:\n domain, user = user.split(';', 1)\n\n passwd = passwd or ''\n myname = MACHINE_NAME or self.generateClientMachineName()\n\n server_name,host = host.split(',') if ',' in host else [None,host]\n\n if server_name is None:\n n = NetBIOS()\n names = n.queryIPForName(host)\n if names:\n server_name = names[0]\n else:\n raise urllib2.URLError('SMB error: Hostname does not reply back with its machine name')\n\n path, attrs = splitattr(req.get_selector())\n if path.startswith('/'):\n path = path[1:]\n dirs = path.split('/')\n dirs = map(unquote, dirs)\n service, path = dirs[0], '/'.join(dirs[1:])\n\n try:\n conn = SMBConnection(user, passwd, myname, server_name, domain=domain, use_ntlm_v2 = USE_NTLM)\n conn.connect(host, port)\n\n if req.has_data():\n data_fp = req.get_data()\n filelen = conn.storeFile(service, path, data_fp)\n\n headers = \"Content-length: 0\\n\"\n fp = StringIO(\"\")\n else:\n fp = self.createTempFile()\n file_attrs, retrlen = conn.retrieveFile(service, path, fp)\n fp.seek(0)\n\n headers = \"\"\n mtype = mimetypes.guess_type(req.get_full_url())[0]\n if mtype:\n headers += \"Content-type: %s\\n\" % mtype\n if retrlen is not None and retrlen >= 0:\n headers += \"Content-length: %d\\n\" % retrlen\n\n sf = StringIO(headers)\n headers = mimetools.Message(sf)\n\n return addinfourl(fp, headers, req.get_full_url())\n except Exception, ex:\n raise urllib2.URLError, ('smb error: %s' % ex), sys.exc_info()[2]\n\n def createTempFile(self):\n return tempfile.TemporaryFile()\n\n def generateClientMachineName(self):\n hostname = socket.gethostname()\n if hostname:\n return hostname.split('.')[0]\n return 'SMB%d' % os.getpid()\n" }, { "path": "python2/smb/SMBProtocol.py", "content": "\nimport os, logging, time\nfrom twisted.internet import reactor, defer\nfrom twisted.internet.protocol import ClientFactory, Protocol\nfrom smb_constants import *\nfrom smb_structs import *\nfrom base import SMB, NotConnectedError, NotReadyError, SMBTimeout\n\n\n__all__ = [ 'SMBProtocolFactory', 'NotConnectedError', 'NotReadyError' ]\n\n\nclass SMBProtocol(Protocol, SMB):\n\n log = logging.getLogger('SMB.SMBProtocol')\n\n #\n # Protocol Methods\n #\n\n def connectionMade(self):\n self.factory.instance = self\n if not self.is_direct_tcp:\n self.requestNMBSession()\n else:\n self.onNMBSessionOK()\n\n def connectionLost(self, reason):\n if self.factory.instance == self:\n self.instance = None\n\n def dataReceived(self, data):\n self.feedData(data)\n\n #\n # SMB (and its superclass) Methods\n #\n\n def write(self, data):\n self.transport.write(data)\n\n def onAuthOK(self):\n if self.factory.instance == self:\n self.factory.onAuthOK()\n reactor.callLater(1, self._cleanupPendingRequests)\n\n def onAuthFailed(self):\n if self.factory.instance == self:\n self.factory.onAuthFailed()\n\n def onNMBSessionFailed(self):\n self.log.error('Cannot establish NetBIOS session. You might have provided a wrong remote_name')\n\n #\n # Protected Methods\n #\n\n def _cleanupPendingRequests(self):\n if self.factory.instance == self:\n now = time.time()\n to_remove = []\n for mid, r in self.pending_requests.iteritems():\n if r.expiry_time < now:\n try:\n r.errback(SMBTimeout())\n except Exception: pass\n to_remove.append(mid)\n\n for mid in to_remove:\n del self.pending_requests[mid]\n\n reactor.callLater(1, self._cleanupPendingRequests)\n\n\nclass SMBProtocolFactory(ClientFactory):\n\n protocol = SMBProtocol\n log = logging.getLogger('SMB.SMBFactory')\n\n #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n SIGN_NEVER = 0\n #: SMB messages will be signed when remote server supports signing but not requires signing.\n SIGN_WHEN_SUPPORTED = 1\n #: SMB messages will only be signed when remote server requires signing.\n SIGN_WHEN_REQUIRED = 2\n\n def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n \"\"\"\n Create a new SMBProtocolFactory instance. You will pass this instance to *reactor.connectTCP()* which will then instantiate the TCP connection to the remote SMB/CIFS server.\n Note that the default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.\n Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.\n\n *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.\n File operations can only be proceeded after the connection has been authenticated successfully.\n\n :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.\n You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\\/:*?\";|+``.\n :param string remote_name: The NetBIOS machine name of the remote server.\n On windows, you can find out the machine name by right-clicking on the \"My Computer\" and selecting \"Properties\".\n This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.\n :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.\n :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.\n The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.\n Hence, we can only \"guess\" or try both algorithms.\n On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.\n :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.\n If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.\n If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.\n If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.\n The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).\n \"\"\"\n self.username = username\n self.password = password\n self.my_name = my_name\n self.remote_name = remote_name\n self.domain = domain\n self.use_ntlm_v2 = use_ntlm_v2\n self.sign_options = sign_options\n self.is_direct_tcp = is_direct_tcp\n self.instance = None #: The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.\n\n #\n # Public Property\n #\n\n @property\n def isReady(self):\n \"\"\"A convenient property to return True if the underlying SMB connection has connected to remote server, has successfully authenticated itself and is ready for file operations.\"\"\"\n return bool(self.instance and self.instance.has_authenticated)\n\n @property\n def isUsingSMB2(self):\n \"\"\"A convenient property to return True if the underlying SMB connection is using SMB2 protocol.\"\"\"\n return self.instance and self.instance.is_using_smb2\n\n #\n # Public Methods for Callbacks\n #\n\n def onAuthOK(self):\n \"\"\"\n Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.\n This method will be called when the server has replied that the SMB connection has been successfully authenticated.\n File operations can proceed when this method has been called.\n \"\"\"\n pass\n\n def onAuthFailed(self):\n \"\"\"\n Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.\n This method will be called when the server has replied that the SMB connection has been successfully authenticated.\n\n If you want to retry authenticating from this method,\n 1. Disconnect the underlying SMB connection (call ``self.instance.transport.loseConnection()``)\n 2. Create a new SMBProtocolFactory subclass instance with different user credientials or different NTLM algorithm flag.\n 3. Call ``reactor.connectTCP`` with the new instance to re-establish the SMB connection\n \"\"\"\n pass\n\n #\n # Public Methods\n #\n\n def listShares(self, timeout = 30):\n \"\"\"\n Retrieve a list of shared resources on remote server.\n\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedDevice` instances.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._listShares(d.callback, d.errback, timeout)\n return d\n\n def listPath(self, service_name, path,\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL,\n pattern = '*', timeout = 30):\n \"\"\"\n Retrieve a directory listing of files/folders at *path*\n\n For simplicity, pysmb defines a \"normal\" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n\n Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),\n system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files\n and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).\n If you do not need to include \"normal\" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.\n SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.\n :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).\n :param string/unicode pattern: the filter to apply to the results before returning to the client.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedFile` instances.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._listPath(service_name, path, d.callback, d.errback, search = search, pattern = pattern, timeout = timeout)\n return d\n\n def listSnapshots(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve a list of available snapshots (a.k.a. shadow copies) for *path*.\n\n Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of python *datetime.DateTime*\n instances in GMT/UTC time zone\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._listSnapshots(service_name, path, d.callback, d.errback, timeout = timeout)\n return d\n\n def getAttributes(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve information about the file at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a :doc:`smb.base.SharedFile` instance containing the attributes of the file.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._getAttributes(service_name, path, d.callback, d.errback, timeout = timeout)\n return d\n\n def retrieveFile(self, service_name, path, file_obj, timeout = 30):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n Use *retrieveFileFromOffset()* method if you need to specify the offset to read from the remote *path* and/or the maximum number of bytes to write to the *file_obj*.\n\n The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size\n of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).\n The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be called in the returned *Deferred* errback.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n return self.retrieveFileFromOffset(service_name, path, file_obj, 0L, -1L, timeout)\n\n def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0L, max_length = -1L, timeout = 30):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size\n of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).\n The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be called in the returned *Deferred* errback.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service.\n :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.\n :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.\n If zero, the *Deferred* callback is invoked immediately after the file is opened successfully for reading.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._retrieveFileFromOffset(service_name, path, file_obj, d.callback, d.errback, offset, max_length, timeout = timeout)\n return d\n\n def storeFile(self, service_name, path, file_obj, timeout = 30):\n \"\"\"\n Store the contents of the *file_obj* at *path* on the *service_name*.\n\n The meaning of the *timeout* parameter will be different from other file operation methods. As the uploaded file usually exceeeds the maximum size\n of each SMB/CIFS data message, it will be packetized into a series of messages (usually about 60kBytes).\n The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and acknowledged\n by the remote SMB/CIFS server.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.\n If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure` will be called in the returned *Deferred* errback.\n :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *file_obj*, number of bytes uploaded ).\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._storeFile(service_name, path, file_obj, d.callback, d.errback, timeout = timeout)\n return d\n\n def deleteFiles(self, service_name, path_file_pattern, timeout = 30):\n \"\"\"\n Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n Wildcards may be used in th filename component of the path.\n If your path/filename contains non-English characters, you must pass in an unicode string.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path_file_pattern* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._deleteFiles(service_name, path_file_pattern, d.callback, d.errback, timeout = timeout)\n return d\n\n def createDirectory(self, service_name, path):\n \"\"\"\n Creates a new directory *path* on the *service_name*.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the new folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._createDirectory(service_name, path, d.callback, d.errback)\n return d\n\n def deleteDirectory(self, service_name, path):\n \"\"\"\n Delete the empty folder at *path* on *service_name*\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._deleteDirectory(service_name, path, d.callback, d.errback)\n return d\n\n def rename(self, service_name, old_path, new_path):\n \"\"\"\n Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders\n\n *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *old_path*, *new_path* ).\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._rename(service_name, old_path, new_path, d.callback, d.errback)\n return d\n\n def echo(self, data, timeout = 10):\n \"\"\"\n Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.\n\n :param bytes data: Data to send to the remote server. Must be a bytes object.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *data* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._echo(data, d.callback, d.errback, timeout)\n return d\n\n def closeConnection(self):\n \"\"\"\n Disconnect from the remote SMB/CIFS server. The TCP connection will be closed at the earliest opportunity after this method returns.\n\n :return: None\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n self.instance.transport.loseConnection()\n\n #\n # ClientFactory methods\n # (Do not touch these unless you know what you are doing)\n #\n\n def buildProtocol(self, addr):\n p = self.protocol(self.username, self.password, self.my_name, self.remote_name, self.domain, self.use_ntlm_v2, self.sign_options, self.is_direct_tcp)\n p.factory = self\n return p\n" }, { "path": "python2/smb/__init__.py", "content": "\n" }, { "path": "python2/smb/base.py", "content": "\nimport logging, binascii, time, hmac\nfrom datetime import datetime\nfrom smb_constants import *\nfrom smb2_constants import *\nfrom smb_structs import *\nfrom smb2_structs import *\nfrom .security_descriptors import SecurityDescriptor\nfrom nmb.base import NMBSession\nfrom utils import convertFILETIMEtoEpoch\nimport ntlm, securityblob\n\ntry:\n import hashlib\n sha256 = hashlib.sha256\nexcept ImportError:\n from utils import sha256\n\n\nclass NotReadyError(Exception):\n \"\"\"Raised when SMB connection is not ready (i.e. not authenticated or authentication failed)\"\"\"\n pass\n\nclass NotConnectedError(Exception):\n \"\"\"Raised when underlying SMB connection has been disconnected or not connected yet\"\"\"\n pass\n\nclass SMBTimeout(Exception):\n \"\"\"Raised when a timeout has occurred while waiting for a response or for a SMB/CIFS operation to complete.\"\"\"\n pass\n\n\ndef _convert_to_unicode(string):\n if not isinstance(string, unicode):\n string = unicode(string, \"utf-8\")\n return string\n\n\nclass SMB(NMBSession):\n \"\"\"\n This class represents a \"connection\" to the remote SMB/CIFS server.\n It is not meant to be used directly in an application as it does not have any network transport implementations.\n\n For application use, please refer to\n - L{SMBProtocol.SMBProtocolFactory} if you are using Twisted framework\n\n In [MS-CIFS], this class will contain attributes of Client, Client.Connection and Client.Session abstract data models.\n\n References:\n ===========\n - [MS-CIFS]: 3.2.1\n \"\"\"\n\n log = logging.getLogger('SMB.SMB')\n\n SIGN_NEVER = 0\n SIGN_WHEN_SUPPORTED = 1\n SIGN_WHEN_REQUIRED = 2\n\n def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n NMBSession.__init__(self, my_name, remote_name, is_direct_tcp = is_direct_tcp)\n self.username = _convert_to_unicode(username)\n self._password = password\n self.domain = _convert_to_unicode(domain)\n self.sign_options = sign_options\n self.is_direct_tcp = is_direct_tcp\n self.use_ntlm_v2 = use_ntlm_v2 #: Similar to LMAuthenticationPolicy and NTAuthenticationPolicy as described in [MS-CIFS] 3.2.1.1\n self.smb_message = SMBMessage()\n self.is_using_smb2 = False #: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True\n self.async_requests = { } #: AsyncID mapped to _PendingRequest instance\n self.pending_requests = { } #: MID mapped to _PendingRequest instance\n self.connected_trees = { } #: Share name mapped to TID\n self.next_rpc_call_id = 1 #: Next RPC callID value. Not used directly in SMB message. Usually encapsulated in sub-commands under SMB_COM_TRANSACTION or SMB_COM_TRANSACTION2 messages\n\n self.has_negotiated = False\n self.has_authenticated = False\n self.is_signing_active = False #: True if the remote server accepts message signing. All outgoing messages will be signed. Simiar to IsSigningActive as described in [MS-CIFS] 3.2.1.2\n self.signing_session_key = None #: Session key for signing packets, if signing is active. Similar to SigningSessionKey as described in [MS-CIFS] 3.2.1.2\n self.signing_challenge_response = None #: Contains the challenge response for signing, if signing is active. Similar to SigningChallengeResponse as described in [MS-CIFS] 3.2.1.2\n self.mid = 0\n self.uid = 0\n self.next_signing_id = 2 #: Similar to ClientNextSendSequenceNumber as described in [MS-CIFS] 3.2.1.2\n\n # SMB1 and SMB2 attributes\n # Note that the interpretations of the values may differ between SMB1 and SMB2 protocols\n self.capabilities = 0\n self.security_mode = 0 #: Initialized from the SecurityMode field of the SMB_COM_NEGOTIATE message\n\n # SMB1 attributes\n # Most of the following attributes will be initialized upon receipt of SMB_COM_NEGOTIATE message from server (via self._updateServerInfo_SMB1 method)\n self.use_plaintext_authentication = False #: Similar to PlaintextAuthenticationPolicy in in [MS-CIFS] 3.2.1.1\n self.max_raw_size = 0\n self.max_buffer_size = 0 #: Similar to MaxBufferSize as described in [MS-CIFS] 3.2.1.1\n self.max_mpx_count = 0 #: Similar to MaxMpxCount as described in [MS-CIFS] 3.2.1.1\n\n # SMB2 attributes\n self.max_read_size = 0 #: Similar to MaxReadSize as described in [MS-SMB2] 2.2.4\n self.max_write_size = 0 #: Similar to MaxWriteSize as described in [MS-SMB2] 2.2.4\n self.max_transact_size = 0 #: Similar to MaxTransactSize as described in [MS-SMB2] 2.2.4\n self.session_id = 0 #: Similar to SessionID as described in [MS-SMB2] 2.2.4. This will be set in _updateState_SMB2 method\n\n self._setupSMB1Methods()\n\n self.log.info('Authentication with remote machine \"%s\" for user \"%s\" will be using NTLM %s authentication (%s extended security)',\n self.remote_name, self.username,\n (self.use_ntlm_v2 and 'v2') or 'v1',\n (SUPPORT_EXTENDED_SECURITY and 'with') or 'without')\n\n @property\n def password(self):\n password = self._password() if callable(self._password) else self._password\n return _convert_to_unicode(password)\n\n #\n # NMBSession Methods\n #\n\n def onNMBSessionOK(self):\n self._sendSMBMessage(SMBMessage(ComNegotiateRequest()))\n\n def onNMBSessionFailed(self):\n pass\n\n def onNMBSessionMessage(self, flags, data):\n while True:\n try:\n i = self.smb_message.decode(data)\n except SMB2ProtocolHeaderError:\n self.log.info('Now switching over to SMB2 protocol communication')\n self.is_using_smb2 = True\n self.mid = 0 # Must reset messageID counter, or else remote SMB2 server will disconnect\n self._setupSMB2Methods()\n self.smb_message = self._klassSMBMessage()\n i = self.smb_message.decode(data)\n\n next_message_offset = 0\n if self.is_using_smb2:\n next_message_offset = self.smb_message.next_command_offset\n\n if i > 0:\n if not self.is_using_smb2:\n self.log.debug('Received SMB message \"%s\" (command:0x%2X flags:0x%02X flags2:0x%04X TID:%d UID:%d)',\n SMB_COMMAND_NAMES.get(self.smb_message.command, ''),\n self.smb_message.command, self.smb_message.flags, self.smb_message.flags2, self.smb_message.tid, self.smb_message.uid)\n else:\n self.log.debug('Received SMB2 message \"%s\" (command:0x%04X flags:0x%04x)',\n SMB2_COMMAND_NAMES.get(self.smb_message.command, ''),\n self.smb_message.command, self.smb_message.flags)\n if self._updateState(self.smb_message):\n # We need to create a new instance instead of calling reset() because the instance could be captured in the message history.\n self.smb_message = self._klassSMBMessage()\n\n if next_message_offset > 0:\n data = data[next_message_offset:]\n else:\n break\n\n #\n # Public Methods for Overriding in Subclasses\n #\n\n def onAuthOK(self):\n pass\n\n def onAuthFailed(self):\n pass\n\n #\n # Protected Methods\n #\n\n def _setupSMB1Methods(self):\n self._klassSMBMessage = SMBMessage\n self._updateState = self._updateState_SMB1\n self._updateServerInfo = self._updateServerInfo_SMB1\n self._handleNegotiateResponse = self._handleNegotiateResponse_SMB1\n self._sendSMBMessage = self._sendSMBMessage_SMB1\n self._handleSessionChallenge = self._handleSessionChallenge_SMB1\n self._listShares = self._listShares_SMB1\n self._listPath = self._listPath_SMB1\n self._listSnapshots = self._listSnapshots_SMB1\n self._getSecurity = self._getSecurity_SMB1\n self._getAttributes = self._getAttributes_SMB1\n self._retrieveFile = self._retrieveFile_SMB1\n self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB1\n self._storeFile = self._storeFile_SMB1\n self._storeFileFromOffset = self._storeFileFromOffset_SMB1\n self._deleteFiles = self._deleteFiles_SMB1\n self._resetFileAttributes = self._resetFileAttributes_SMB1\n self._createDirectory = self._createDirectory_SMB1\n self._deleteDirectory = self._deleteDirectory_SMB1\n self._rename = self._rename_SMB1\n self._echo = self._echo_SMB1\n\n def _setupSMB2Methods(self):\n self._klassSMBMessage = SMB2Message\n self._updateState = self._updateState_SMB2\n self._updateServerInfo = self._updateServerInfo_SMB2\n self._handleNegotiateResponse = self._handleNegotiateResponse_SMB2\n self._sendSMBMessage = self._sendSMBMessage_SMB2\n self._handleSessionChallenge = self._handleSessionChallenge_SMB2\n self._listShares = self._listShares_SMB2\n self._listPath = self._listPath_SMB2\n self._listSnapshots = self._listSnapshots_SMB2\n self._getAttributes = self._getAttributes_SMB2\n self._getSecurity = self._getSecurity_SMB2\n self._retrieveFile = self._retrieveFile_SMB2\n self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB2\n self._storeFile = self._storeFile_SMB2\n self._storeFileFromOffset = self._storeFileFromOffset_SMB2\n self._deleteFiles = self._deleteFiles_SMB2\n self._resetFileAttributes = self._resetFileAttributes_SMB2\n self._createDirectory = self._createDirectory_SMB2\n self._deleteDirectory = self._deleteDirectory_SMB2\n self._rename = self._rename_SMB2\n self._echo = self._echo_SMB2\n\n def _getNextRPCCallID(self):\n self.next_rpc_call_id += 1\n return self.next_rpc_call_id\n\n #\n # SMB2 Methods Family\n #\n\n def _sendSMBMessage_SMB2(self, smb_message):\n if smb_message.mid == 0:\n smb_message.mid = self._getNextMID_SMB2()\n\n if smb_message.command != SMB2_COM_NEGOTIATE:\n smb_message.session_id = self.session_id\n\n if self.is_signing_active:\n smb_message.flags |= SMB2_FLAGS_SIGNED\n raw_data = smb_message.encode()\n smb_message.signature = hmac.new(self.signing_session_key, raw_data, sha256).digest()[:16]\n\n smb_message.raw_data = smb_message.encode()\n self.log.debug('MID is %d. Signature is %s. Total raw message is %d bytes', smb_message.mid, binascii.hexlify(smb_message.signature), len(smb_message.raw_data))\n else:\n smb_message.raw_data = smb_message.encode()\n self.sendNMBMessage(smb_message.raw_data)\n\n def _getNextMID_SMB2(self):\n self.mid += 1\n return self.mid\n\n def _updateState_SMB2(self, message):\n if message.isReply:\n if message.command == SMB2_COM_NEGOTIATE:\n if message.status == 0:\n self.has_negotiated = True\n self.log.info('SMB2 dialect negotiation successful')\n self._updateServerInfo(message.payload)\n self._handleNegotiateResponse(message)\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB2_COM_NEGOTIATE' % message.status,\n message.raw_data, message)\n elif message.command == SMB2_COM_SESSION_SETUP:\n if message.status == 0:\n self.session_id = message.session_id\n try:\n result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_COMPLETED:\n self.has_authenticated = True\n self.log.info('Authentication (on SMB2) successful!')\n\n # [MS-SMB2]: 3.2.5.3.1\n # If the security subsystem indicates that the session was established by an anonymous user,\n # Session.SigningRequired MUST be set to FALSE.\n # If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags field of the\n # SMB2 SESSION_SETUP Response and if Session.SigningRequired is TRUE, this indicates a SESSION_SETUP\n # failure and the connection MUST be terminated. If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags\n # field of the SMB2 SESSION_SETUP Response and if RequireMessageSigning is FALSE, Session.SigningRequired\n # MUST be set to FALSE.\n if message.payload.isGuestSession or message.payload.isAnonymousSession:\n self.is_signing_active = False\n self.log.info('Signing disabled because session is guest/anonymous')\n\n self.onAuthOK()\n else:\n raise ProtocolError('SMB2_COM_SESSION_SETUP status is 0 but security blob negResult value is %d' % result, message.raw_data, message)\n except securityblob.BadSecurityBlobError, ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif message.status == 0xc0000016: # STATUS_MORE_PROCESSING_REQUIRED\n self.session_id = message.session_id\n try:\n result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_INCOMPLETE:\n self._handleSessionChallenge(message, ntlm_token)\n except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ), ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif (message.status == 0xc000006d # STATUS_LOGON_FAILURE\n or message.status == 0xc0000064 # STATUS_NO_SUCH_USER\n or message.status == 0xc000006a):# STATUS_WRONG_PASSWORD\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Please check username and password.')\n self.onAuthFailed()\n elif (message.status == 0xc0000193 # STATUS_ACCOUNT_EXPIRED\n or message.status == 0xC0000071): # STATUS_PASSWORD_EXPIRED\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Account or password has expired.')\n self.onAuthFailed()\n elif message.status == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Account has been locked due to too many invalid logon attempts.')\n self.onAuthFailed()\n elif message.status == 0xc0000072: # STATUS_ACCOUNT_DISABLED\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Account has been disabled.')\n self.onAuthFailed()\n elif (message.status == 0xc000006f # STATUS_INVALID_LOGON_HOURS\n or message.status == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED\n or message.status == 0xc0000070): # STATUS_INVALID_WORKSTATION\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Not allowed.')\n self.onAuthFailed()\n elif message.status == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Domain not trusted.')\n self.onAuthFailed()\n elif message.status == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Workstation not trusted.')\n self.onAuthFailed()\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status,\n message.raw_data, message)\n\n if message.isAsync:\n if message.status == 0x00000103: # STATUS_PENDING\n req = self.pending_requests.pop(message.mid, None)\n if req:\n self.async_requests[message.async_id] = req\n else: # All other status including SUCCESS\n req = self.async_requests.pop(message.async_id, None)\n if req:\n req.callback(message, **req.kwargs)\n return True\n else:\n req = self.pending_requests.pop(message.mid, None)\n if req:\n req.callback(message, **req.kwargs)\n return True\n\n\n def _updateServerInfo_SMB2(self, payload):\n self.capabilities = payload.capabilities\n self.security_mode = payload.security_mode\n self.max_transact_size = payload.max_transact_size\n self.max_read_size = payload.max_read_size\n self.max_write_size = payload.max_write_size\n self.use_plaintext_authentication = False # SMB2 never allows plaintext authentication\n\n\n def _handleNegotiateResponse_SMB2(self, message):\n ntlm_data = ntlm.generateNegotiateMessage()\n blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))\n\n\n def _handleSessionChallenge_SMB2(self, message, ntlm_token):\n server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)\n\n self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n\n if self.use_ntlm_v2:\n self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,\n self.username,\n server_challenge,\n server_info,\n self.domain)\n\n else:\n self.log.info('Performing NTLMv1 authentication (on SMB2) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)\n\n ntlm_data, session_signing_key = ntlm.generateAuthenticateMessage(server_flags,\n nt_challenge_response,\n lm_challenge_response,\n session_key,\n self.username,\n self.domain,\n self.my_name)\n\n if self.log.isEnabledFor(logging.DEBUG):\n self.log.debug('NT challenge response is \"%s\" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))\n self.log.debug('LM challenge response is \"%s\" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))\n\n blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))\n\n if self.security_mode & SMB2_NEGOTIATE_SIGNING_REQUIRED:\n self.log.info('Server requires all SMB messages to be signed')\n self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)\n elif self.security_mode & SMB2_NEGOTIATE_SIGNING_ENABLED:\n self.log.info('Server supports SMB signing')\n self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)\n else:\n self.is_signing_active = False\n\n if self.is_signing_active:\n self.log.info(\"SMB signing activated. All SMB messages will be signed.\")\n self.signing_session_key = session_signing_key\n if self.log.isEnabledFor(logging.DEBUG):\n self.log.info(\"SMB signing key is %s\", binascii.hexlify(self.signing_session_key))\n\n if self.capabilities & CAP_EXTENDED_SECURITY:\n self.signing_challenge_response = None\n else:\n self.signing_challenge_response = blob\n else:\n self.log.info(\"SMB signing deactivated. SMB messages will NOT be signed.\")\n\n\n def _listShares_SMB2(self, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = 'IPC$'\n messages_history = [ ]\n\n def connectSrvSvc(tid):\n m = SMB2Message(SMB2CreateRequest('srvsvc',\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_NON_DIRECTORY_FILE | FILE_OPEN_NO_RECALL,\n create_disp = FILE_OPEN))\n\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def connectSrvSvcCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n call_id = self._getNextRPCCallID()\n # The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]\n # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream\n data_bytes = \\\n binascii.unhexlify(\"\"\"05 00 0b 03 10 00 00 00 74 00 00 00\"\"\".replace(' ', '')) + \\\n struct.pack(' data_length:\n return data_bytes[offset:]\n\n next_offset, _, \\\n create_time, last_access_time, last_write_time, last_attr_change_time, \\\n file_size, alloc_size, file_attributes, filename_length, ea_size, \\\n short_name_length, _, short_name, _, file_id = struct.unpack(info_format, data_bytes[offset:offset+info_size])\n\n offset2 = offset + info_size\n if offset2 + filename_length > data_length:\n return data_bytes[offset:]\n\n filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE')\n short_name = short_name[:short_name_length].decode('UTF-16LE')\n\n accept_result = False\n if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc\n accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n else:\n accept_result = (file_attributes & search) > 0\n if accept_result:\n results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),\n convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),\n file_size, alloc_size, file_attributes, short_name, filename, file_id))\n\n if next_offset:\n offset += next_offset\n else:\n break\n return ''\n\n def closeFid(tid, fid, results = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, results = results, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['results'] is not None:\n callback(kwargs['results'])\n elif kwargs['error'] is not None:\n if kwargs['error'] == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE\n # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files\n callback([ ])\n else:\n errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to list %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _getAttributes_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = 0,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n p = create_message.payload\n filename = self._extractLastPathComponent(unicode(path))\n info = SharedFile(p.create_time, p.lastaccess_time, p.lastwrite_time, p.change_time,\n p.file_size, p.allocation_size, p.file_attributes,\n filename, filename)\n closeFid(kwargs['tid'], p.fid, info = info)\n else:\n errback(OperationFailure('Failed to get attributes for %s on %s: Unable to open remote file object' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid, info = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, info = info, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['info'] is not None:\n callback(kwargs['info'])\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to get attributes for %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _getSecurity_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n results = [ ]\n\n def sendCreate(tid):\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = 0,\n create_disp = FILE_OPEN))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid,\n flags = 0,\n additional_info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION | DACL_SECURITY_INFORMATION,\n info_type = SMB2_INFO_SECURITY,\n file_info_class = 0, # [MS-SMB2] 2.2.37, 3.2.4.12\n input_buf = '',\n output_buf_len = self.max_transact_size))\n m.tid = kwargs['tid']\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid)\n self._pushToArray(messages_history, m)\n else:\n errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to open file or directory' % ( path, service_name ), messages_history))\n\n def queryCB(query_message, **kwargs):\n self._pushToArray(messages_history, query_message)\n if query_message.status == 0:\n security = SecurityDescriptor.from_bytes(query_message.payload.data)\n closeFid(kwargs['tid'], kwargs['fid'], result = security)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status)\n\n def closeFid(tid, fid, result = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, result = result, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['result'] is not None:\n callback(kwargs['result'])\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to get the security descriptor of %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _retrieveFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):\n return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0L, -1L, timeout)\n\n def _retrieveFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, max_length, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n results = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid,\n flags = 0,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 0x05, # FileStandardInformation [MS-FSCC] 2.4\n input_buf = '',\n output_buf_len = 4096))\n m.tid = kwargs['tid']\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, infoCB, errback,\n tid = kwargs['tid'],\n fid = create_message.payload.fid,\n file_attributes = create_message.payload.file_attributes)\n self._pushToArray(messages_history, m)\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def infoCB(info_message, **kwargs):\n self._pushToArray(messages_history, info_message)\n if info_message.status == 0:\n file_len = struct.unpack(' file_len:\n closeFid(info_message.tid, kwargs['fid'])\n callback(( file_obj, kwargs['file_attributes'], 0 )) # Note that this is a tuple of 3-elements\n else:\n remaining_len = max_length\n if remaining_len < 0:\n remaining_len = file_len\n if starting_offset + remaining_len > file_len:\n remaining_len = file_len - starting_offset\n sendRead(kwargs['tid'], kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes'])\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history))\n\n def sendRead(tid, fid, offset, remaining_len, read_len, file_attributes):\n read_count = min(self.max_read_size, remaining_len)\n m = SMB2Message(SMB2ReadRequest(fid, offset, read_count))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback,\n tid = tid, fid = fid, offset = offset,\n remaining_len = remaining_len,\n read_len = read_len,\n file_attributes = file_attributes)\n\n def readCB(read_message, **kwargs):\n # To avoid crazy memory usage when retrieving large files, we do not save every read_message in messages_history.\n if read_message.status == 0:\n data_len = read_message.payload.data_length\n file_obj.write(read_message.payload.data)\n\n remaining_len = kwargs['remaining_len'] - data_len\n\n if remaining_len > 0:\n sendRead(kwargs['tid'], kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes'])\n else:\n closeFid(kwargs['tid'], kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len ))\n else:\n self._pushToArray(messages_history, read_message)\n closeFid(kwargs['tid'], kwargs['fid'], error = read_message.status)\n\n def closeFid(tid, fid, ret = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, ret = ret, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['ret'] is not None:\n callback(kwargs['ret'])\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _storeFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):\n self._storeFileFromOffset_SMB2(service_name, path, file_obj, callback, errback, 0L, True, timeout)\n\n def _storeFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 20 00 00 00 10 00 04 00\n00 00 18 00 08 00 00 00 41 6c 53 69 00 00 00 00\n85 62 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = ATTR_ARCHIVE,\n access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | SYNCHRONIZE,\n share_access = 0,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,\n create_disp = FILE_OVERWRITE_IF if truncate else FILE_OPEN_IF,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n create_message.tid = kwargs['tid']\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n sendWrite(create_message.tid, create_message.payload.fid, starting_offset)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendWrite(tid, fid, offset):\n write_count = self.max_write_size\n data = file_obj.read(write_count)\n data_len = len(data)\n if data_len > 0:\n m = SMB2Message(SMB2WriteRequest(fid, data, offset))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, tid = tid, fid = fid, offset = offset+data_len)\n else:\n closeFid(tid, fid, offset = offset)\n\n def writeCB(write_message, **kwargs):\n # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.\n if write_message.status == 0:\n sendWrite(kwargs['tid'], kwargs['fid'], kwargs['offset'])\n else:\n self._pushToArray(messages_history, write_message)\n closeFid(kwargs['tid'], kwargs['fid'])\n errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid, error = None, offset = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, fid = fid, offset = offset, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['offset'] is not None:\n callback(( file_obj, kwargs['offset'] )) # Note that this is a tuple of 2-elements\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n\n def _deleteFiles_SMB2(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n pattern = None\n path = path_file_pattern.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n else:\n path_components = path.split('\\\\')\n if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1:\n path = '\\\\'.join(path_components[:-1])\n pattern = path_components[-1]\n messages_history, files_queue = [ ], [ ]\n\n if pattern is None:\n path_components = path.split('\\\\')\n if len(path_components) > 1:\n files_queue.append(( '\\\\'.join(path_components[:-1]), path_components[-1] ))\n else:\n files_queue.append(( '', path ))\n\n def deleteCB(path):\n if files_queue:\n p, filename = files_queue.pop(0)\n if filename:\n if p:\n filename = p + '\\\\' + filename\n self._deleteFiles_SMB2__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout)\n else:\n self._deleteDirectory_SMB2(service_name, p, deleteCB, errback, timeout)\n else:\n callback(path_file_pattern)\n\n def listCB(files_list):\n files_queue.extend(files_list)\n deleteCB(None)\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n\n def _deleteFiles_SMB2__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30):\n folder_queue = [ ]\n files_list = [ ]\n current_path = [ path ]\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL\n\n def listCB(results):\n files = [ ]\n for f in filter(lambda x: x.filename not in [ '.', '..' ], results):\n if f.isDirectory:\n if delete_matching_folders:\n folder_queue.append(current_path[0]+'\\\\'+f.filename)\n else:\n files.append(( current_path[0], f.filename ))\n if current_path[0]!=path and delete_matching_folders:\n files.append(( current_path[0], None ))\n\n if files:\n files_list[0:0] = files\n\n if folder_queue:\n p = folder_queue.pop()\n current_path[0] = p\n self._listPath_SMB2(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30)\n else:\n callback(files_list)\n\n self._listPath_SMB2(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout)\n\n def _deleteFiles_SMB2__del(self, service_name, tid, path, callback, errback, timeout = 30):\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = DELETE | FILE_READ_ATTRIBUTES,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_NON_DIRECTORY_FILE,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(open_message, **kwargs):\n open_message.tid = kwargs['tid']\n self._pushToArray(messages_history, open_message)\n if open_message.status == 0:\n sendDelete(open_message.tid, open_message.payload.fid)\n elif open_message.status == 0xC0000034L: # [MS-ERREF]: STATUS_OBJECT_NAME_NOT_FOUND\n callback(path)\n elif open_message.status == 0xC00000BAL: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY\n errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append \"/*\" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history))\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendDelete(tid, fid):\n m = SMB2Message(SMB2SetInfoRequest(fid,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 0x0d, # SMB2_FILE_DISPOSITION_INFO\n data = '\\x01'))\n # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4.11\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if delete_message.status == 0:\n closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status)\n\n def closeFid(tid, fid, status = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['status'] == 0:\n callback(path)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n sendCreate(tid)\n\n def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, file_attributes = ATTR_NORMAL, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path_file_pattern.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_WRITE_ATTRIBUTES,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = 0,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if open_message.status == 0:\n sendReset(kwargs['tid'], open_message.payload.fid)\n else:\n errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendReset(tid, fid):\n m = SMB2Message(SMB2SetInfoRequest(fid,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 4, # FileBasicInformation\n data = struct.pack('qqqqii',0,0,0,0,file_attributes,0)))\n # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4, [MS-FSCC]: 2.4.7, [MS-FSCC]: 2.6\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, tid = tid, fid = fid)\n self._pushToArray(messages_history, m)\n\n def resetCB(reset_message, **kwargs):\n self._pushToArray(messages_history, reset_message)\n if reset_message.status == 0:\n closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], status = reset_message.status)\n\n def closeFid(tid, fid, status = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['status'] == 0:\n callback(path_file_pattern)\n else:\n errback(OperationFailure('Failed to reset attributes of %s on %s: Reset failed' % ( path, service_name ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _createDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_READ_EA | FILE_WRITE_EA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | READ_CONTROL | DELETE | SYNCHRONIZE,\n share_access = 0,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,\n create_disp = FILE_CREATE,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n closeFid(kwargs['tid'], create_message.payload.fid)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n callback(path)\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _deleteDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = DELETE | FILE_READ_ATTRIBUTES,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_DIRECTORY_FILE,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if open_message.status == 0:\n sendDelete(kwargs['tid'], open_message.payload.fid)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to open directory' % ( path, service_name ), messages_history))\n\n def sendDelete(tid, fid):\n m = SMB2Message(SMB2SetInfoRequest(fid,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 0x0d, # SMB2_FILE_DISPOSITION_INFO\n data = '\\x01'))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if delete_message.status == 0:\n closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status)\n\n def closeFid(tid, fid, status = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['status'] == 0:\n callback(path)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _rename_SMB2(self, service_name, old_path, new_path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n messages_history = [ ]\n\n new_path = new_path.replace('/', '\\\\')\n if new_path.startswith('\\\\'):\n new_path = new_path[1:]\n if new_path.endswith('\\\\'):\n new_path = new_path[:-1]\n\n old_path = old_path.replace('/', '\\\\')\n if old_path.startswith('\\\\'):\n old_path = old_path[1:]\n if old_path.endswith('\\\\'):\n old_path = old_path[:-1]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(old_path,\n file_attributes = 0,\n access_mask = DELETE | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_SYNCHRONOUS_IO_NONALERT,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n sendRename(kwargs['tid'], create_message.payload.fid)\n else:\n errback(OperationFailure('Failed to rename %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history))\n\n def sendRename(tid, fid):\n data = '\\x00'*16 + struct.pack('= 0xFFFF: # MID cannot be 0xFFFF. [MS-CIFS]: 2.2.1.6.2\n # We don't use MID of 0 as MID can be reused for SMB_COM_TRANSACTION2_SECONDARY messages\n # where if mid=0, _sendSMBMessage will re-assign new MID values again\n self.mid = 1\n return self.mid\n\n def _updateState_SMB1(self, message):\n if message.isReply:\n if message.command == SMB_COM_NEGOTIATE:\n if not message.status.hasError:\n self.has_negotiated = True\n self.log.info('SMB dialect negotiation successful (ExtendedSecurity:%s)', message.hasExtendedSecurity)\n self._updateServerInfo(message.payload)\n self._handleNegotiateResponse(message)\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_NEGOTIATE' % message.status.internal_value,\n message.raw_data, message)\n elif message.command == SMB_COM_SESSION_SETUP_ANDX:\n if message.hasExtendedSecurity:\n if not message.status.hasError:\n try:\n result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_COMPLETED:\n self.log.debug('SMB uid is now %d', message.uid)\n self.uid = message.uid\n self.has_authenticated = True\n self.log.info('Authentication (with extended security) successful!')\n self.onAuthOK()\n else:\n raise ProtocolError('SMB_COM_SESSION_SETUP_ANDX status is 0 but security blob negResult value is %d' % result, message.raw_data, message)\n except securityblob.BadSecurityBlobError, ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif message.status.internal_value == 0xc0000016: # STATUS_MORE_PROCESSING_REQUIRED\n try:\n result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_INCOMPLETE:\n self._handleSessionChallenge(message, ntlm_token)\n except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ), ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif (message.status.internal_value == 0xc000006d # STATUS_LOGON_FAILURE\n or message.status.internal_value == 0xc0000064 # STATUS_NO_SUCH_USER\n or message.status.internal_value == 0xc000006a): # STATUS_WRONG_PASSWORD\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Please check username and password.')\n self.onAuthFailed()\n elif (message.status.internal_value == 0xc0000193 # STATUS_ACCOUNT_EXPIRED\n or message.status.internal_value == 0xC0000071): # STATUS_PASSWORD_EXPIRED\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Account or password has expired.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Account has been locked due to too many invalid logon attempts.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc0000072: # STATUS_ACCOUNT_DISABLED\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Account has been disabled.')\n self.onAuthFailed()\n elif (message.status.internal_value == 0xc000006f # STATUS_INVALID_LOGON_HOURS\n or message.status.internal_value == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED\n or message.status.internal_value == 0xc0000070): # STATUS_INVALID_WORKSTATION\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Not allowed.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Domain not trusted.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Workstation not trusted.')\n self.onAuthFailed()\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status.internal_value,\n message.raw_data, message)\n else:\n if message.status.internal_value == 0:\n self.log.debug('SMB uid is now %d', message.uid)\n self.uid = message.uid\n self.has_authenticated = True\n self.log.info('Authentication (without extended security) successful!')\n self.onAuthOK()\n else:\n self.has_authenticated = False\n self.log.info('Authentication (without extended security) failed. Please check username and password')\n self.onAuthFailed()\n elif message.command == SMB_COM_TREE_CONNECT_ANDX:\n try:\n req = self.pending_requests[message.mid]\n except KeyError:\n pass\n else:\n if not message.status.hasError:\n self.connected_trees[req.kwargs['path']] = message.tid\n\n req = self.pending_requests.pop(message.mid, None)\n if req:\n req.callback(message, **req.kwargs)\n return True\n\n\n def _updateServerInfo_SMB1(self, payload):\n self.capabilities = payload.capabilities\n self.security_mode = payload.security_mode\n self.max_raw_size = payload.max_raw_size\n self.max_buffer_size = payload.max_buffer_size\n self.max_mpx_count = payload.max_mpx_count\n self.use_plaintext_authentication = not bool(payload.security_mode & NEGOTIATE_ENCRYPT_PASSWORDS)\n\n if self.use_plaintext_authentication:\n self.log.warning('Remote server only supports plaintext authentication. Your password can be stolen easily over the network.')\n\n\n def _handleSessionChallenge_SMB1(self, message, ntlm_token):\n assert message.hasExtendedSecurity\n\n if message.uid and not self.uid:\n self.uid = message.uid\n\n server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)\n if self.use_ntlm_v2:\n self.log.info('Performing NTLMv2 authentication (with extended security) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,\n self.username,\n server_challenge,\n server_info,\n self.domain)\n\n else:\n self.log.info('Performing NTLMv1 authentication (with extended security) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)\n\n ntlm_data, session_signing_key = ntlm.generateAuthenticateMessage(server_flags,\n nt_challenge_response,\n lm_challenge_response,\n session_key,\n self.username,\n self.domain,\n self.my_name)\n\n if self.log.isEnabledFor(logging.DEBUG):\n self.log.debug('NT challenge response is \"%s\" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))\n self.log.debug('LM challenge response is \"%s\" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))\n\n blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(0, blob)))\n\n if self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_REQUIRE:\n self.log.info('Server requires all SMB messages to be signed')\n self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)\n elif self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_ENABLE:\n self.log.info('Server supports SMB signing')\n self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)\n else:\n self.is_signing_active = False\n\n if self.is_signing_active:\n self.log.info(\"SMB signing activated. All SMB messages will be signed.\")\n self.signing_session_key = session_signing_key\n if self.capabilities & CAP_EXTENDED_SECURITY:\n self.signing_challenge_response = None\n else:\n self.signing_challenge_response = blob\n else:\n self.log.info(\"SMB signing deactivated. SMB messages will NOT be signed.\")\n\n\n def _handleNegotiateResponse_SMB1(self, message):\n if message.uid and not self.uid:\n self.uid = message.uid\n\n if message.hasExtendedSecurity or message.payload.supportsExtendedSecurity:\n ntlm_data = ntlm.generateNegotiateMessage()\n blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(message.payload.session_key, blob)))\n else:\n nt_password, _, _ = ntlm.generateChallengeResponseV1(self.password, message.payload.challenge, False)\n self.log.info('Performing NTLMv1 authentication (without extended security) with challenge \"%s\" and hashed password of \"%s\"',\n binascii.hexlify(message.payload.challenge),\n binascii.hexlify(nt_password))\n self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__NoSecurityExtension(message.payload.session_key,\n self.username,\n nt_password,\n True,\n self.domain)))\n\n def _listShares_SMB1(self, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = 'IPC$'\n messages_history = [ ]\n\n def connectSrvSvc(tid):\n m = SMBMessage(ComNTCreateAndxRequest('\\\\srvsvc',\n flags = NT_CREATE_REQUEST_EXTENDED_RESPONSE,\n access_mask = READ_CONTROL | FILE_WRITE_ATTRIBUTES | FILE_READ_ATTRIBUTES | FILE_WRITE_EA | FILE_READ_EA | FILE_APPEND_DATA | FILE_WRITE_DATA | FILE_READ_DATA,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n create_disp = FILE_OPEN,\n create_options = FILE_OPEN_NO_RECALL | FILE_NON_DIRECTORY_FILE,\n impersonation = SEC_IMPERSONATE,\n security_flags = 0))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback)\n self._pushToArray(messages_history, m)\n\n def connectSrvSvcCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if not create_message.status.hasError:\n call_id = self._getNextRPCCallID()\n # See [MS-CIFS]: 2.2.5.6.1 for more information on TRANS_TRANSACT_NMPIPE (0x0026) parameters\n setup_bytes = struct.pack(' data_length:\n return data_bytes[offset:]\n\n next_offset, _, \\\n create_time, last_access_time, last_write_time, last_attr_change_time, \\\n file_size, alloc_size, file_attributes, filename_length, ea_size, \\\n short_name_length, _, short_name = struct.unpack(info_format, data_bytes[offset:offset+info_size])\n\n offset2 = offset + info_size\n if offset2 + filename_length > data_length:\n return data_bytes[offset:]\n\n filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE')\n short_name = short_name.decode('UTF-16LE')\n\n accept_result = False\n if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc\n accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n else:\n accept_result = (file_attributes & search) > 0\n if accept_result:\n results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),\n convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),\n file_size, alloc_size, file_attributes, short_name, filename))\n\n if next_offset:\n offset += next_offset\n else:\n break\n return ''\n\n def findFirstCB(find_message, **kwargs):\n self._pushToArray(messages_history, find_message)\n if not find_message.status.hasError:\n if not kwargs.has_key('total_count'):\n # TRANS2_FIND_FIRST2 response. [MS-CIFS]: 2.2.6.2.2\n sid, search_count, end_of_search, _, last_name_offset = struct.unpack(' 0:\n if data_len > remaining_len:\n file_obj.write(read_message.payload.data[:remaining_len])\n read_len += remaining_len\n remaining_len = 0\n else:\n file_obj.write(read_message.payload.data)\n remaining_len -= data_len\n read_len += data_len\n else:\n file_obj.write(read_message.payload.data)\n read_len += data_len\n\n if (max_length > 0 and remaining_len <= 0) or data_len < (self.max_raw_size - 2):\n closeFid(read_message.tid, kwargs['fid'])\n callback(( file_obj, kwargs['file_attributes'], read_len )) # Note that this is a tuple of 3-elements\n else:\n sendRead(read_message.tid, kwargs['fid'], kwargs['offset']+data_len, kwargs['file_attributes'], read_len, remaining_len)\n else:\n self._pushToArray(messages_history, read_message)\n closeFid(read_message.tid, kwargs['fid'])\n errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid):\n m = SMBMessage(ComCloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self._pushToArray(messages_history, m)\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendOpen(connect_message.tid)\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendOpen(self.connected_trees[service_name])\n\n def _storeFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30):\n self._storeFileFromOffset_SMB1(service_name, path, file_obj, callback, errback, 0L, True, timeout)\n\n def _storeFileFromOffset_SMB1(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n path = path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendOpen(tid):\n m = SMBMessage(ComOpenAndxRequest(filename = path,\n access_mode = 0x0041, # Sharing mode: Deny nothing to others + Open for writing\n open_mode = 0x0012 if truncate else 0x0011, # Create file if file does not exist. Overwrite or append depending on truncate parameter.\n search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM,\n timeout = timeout * 1000))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)\n self._pushToArray(messages_history, m)\n\n def openCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if not open_message.status.hasError:\n sendWrite(open_message.tid, open_message.payload.fid, starting_offset)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendWrite(tid, fid, offset):\n # [MS-SMB] 2.2.4.5.2.2: The total SMB message size (inclusive of SMB header) must be not exceed the max_buffer_size.\n write_count = min(self.max_buffer_size-64, 0xFFFF-64) # SMB header is 32-bytes. We factor in another 32-bytes for the message parameter block\n data_bytes = file_obj.read(write_count)\n data_len = len(data_bytes)\n if data_len > 0:\n m = SMBMessage(ComWriteAndxRequest(fid = fid, offset = offset, data_bytes = data_bytes))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, fid = fid, offset = offset+data_len)\n else:\n closeFid(tid, fid)\n callback(( file_obj, offset )) # Note that this is a tuple of 2-elements\n\n def writeCB(write_message, **kwargs):\n # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.\n if not write_message.status.hasError:\n sendWrite(write_message.tid, kwargs['fid'], kwargs['offset'])\n else:\n self._pushToArray(messages_history, write_message)\n closeFid(write_message.tid, kwargs['fid'])\n errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid):\n m = SMBMessage(ComCloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self._pushToArray(messages_history, m)\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendOpen(connect_message.tid)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendOpen(self.connected_trees[service_name])\n\n def _deleteFiles_SMB1(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n pattern = None\n path = path_file_pattern.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n else:\n path_components = path.split('\\\\')\n if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1:\n path = '\\\\'.join(path_components[:-1])\n pattern = path_components[-1]\n messages_history, files_queue = [ ], [ ]\n\n if pattern is None:\n path_components = path.split('\\\\')\n if len(path_components) > 1:\n files_queue.append(( '\\\\'.join(path_components[:-1]), path_components[-1] ))\n else:\n files_queue.append(( '', path ))\n\n def deleteCB(path):\n if files_queue:\n p, filename = files_queue.pop(0)\n if filename:\n if p:\n filename = p + '\\\\' + filename\n self._deleteFiles_SMB1__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout)\n else:\n self._deleteDirectory_SMB1(service_name, p, deleteCB, errback, timeout = 30)\n else:\n callback(path_file_pattern)\n\n def listCB(files_list):\n files_queue.extend(files_list)\n deleteCB(None)\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n\n def _deleteFiles_SMB1__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30):\n folder_queue = [ ]\n files_list = [ ]\n current_path = [ path ]\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL\n\n def listCB(results):\n files = [ ]\n for f in filter(lambda x: x.filename not in [ '.', '..' ], results):\n if f.isDirectory:\n if delete_matching_folders:\n folder_queue.append(current_path[0]+'\\\\'+f.filename)\n else:\n files.append(( current_path[0], f.filename ))\n if current_path[0]!=path and delete_matching_folders:\n files.append(( current_path[0], None ))\n\n if files:\n files_list[0:0] = files\n\n if folder_queue:\n p = folder_queue.pop()\n current_path[0] = p\n self._listPath_SMB1(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30)\n else:\n callback(files_list)\n\n self._listPath_SMB1(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout)\n\n\n def _deleteFiles_SMB1__del(self, service_name, tid, path, callback, errback, timeout = 30):\n messages_history = [ ]\n\n def sendDelete(tid):\n m = SMBMessage(ComDeleteRequest(filename_pattern = path,\n search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if not delete_message.status.hasError:\n callback(path)\n elif delete_message.status.internal_value == 0xC000000FL: # [MS-ERREF]: STATUS_NO_SUCH_FILE\n # If there are no matching files, we just treat as success instead of failing\n callback(path)\n elif delete_message.status.internal_value == 0xC00000BAL: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY\n errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append \"/*\" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history))\n elif delete_message.status.internal_value == 0xC0000034L: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID\n errback(OperationFailure('Failed to delete %s on %s: Path not found' % ( path, service_name ), messages_history))\n else:\n errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n sendDelete(tid)\n\n def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, file_attributes=ATTR_NORMAL, timeout = 30):\n raise NotReadyError('resetFileAttributes is not yet implemented for SMB1')\n\n def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n path = path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendCreate(tid):\n m = SMBMessage(ComCreateDirectoryRequest(path))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if not create_message.status.hasError:\n callback(path)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n path = path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendDelete(tid):\n m = SMBMessage(ComDeleteDirectoryRequest(path))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if not delete_message.status.hasError:\n callback(path)\n else:\n errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendDelete(connect_message.tid)\n else:\n errback(OperationFailure('Failed to delete directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendDelete(self.connected_trees[service_name])\n\n def _rename_SMB1(self, service_name, old_path, new_path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n new_path = new_path.replace('/', '\\\\')\n old_path = old_path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendRename(tid):\n m = SMBMessage(ComRenameRequest(old_path = old_path,\n new_path = new_path,\n search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback)\n self._pushToArray(messages_history, m)\n\n def renameCB(rename_message, **kwargs):\n self._pushToArray(messages_history, rename_message)\n if not rename_message.status.hasError:\n callback(( old_path, new_path )) # Note that this is a tuple of 2-elements\n else:\n errback(OperationFailure('Failed to rename %s on %s: Rename failed' % ( old_path, service_name ), messages_history))\n\n if not self.connected_trees.has_key(service_name):\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendRename(connect_message.tid)\n else:\n errback(OperationFailure('Failed to rename %s on %s: Unable to connect to shared device' % ( old_path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendRename(self.connected_trees[service_name])\n\n def _listSnapshots_SMB1(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if not path.endswith('\\\\'):\n path += '\\\\'\n messages_history = [ ]\n results = [ ]\n\n def sendOpen(tid):\n m = SMBMessage(ComOpenAndxRequest(filename = path,\n access_mode = 0x0040, # Sharing mode: Deny nothing to others\n open_mode = 0x0001, # Failed if file does not exist\n search_attributes = 0,\n timeout = timeout * 1000))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)\n self._pushToArray(messages_history, m)\n\n def openCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if not open_message.status.hasError:\n sendEnumSnapshots(open_message.tid, open_message.payload.fid)\n else:\n errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open path' % ( path, service_name ), messages_history))\n\n def sendEnumSnapshots(tid, fid):\n # [MS-CIFS]: 2.2.7.2\n # [MS-SMB]: 2.2.7.2.1\n setup_bytes = struct.pack(' 10:\n messages_history.pop(0)\n messages_history.append(message)\n\nclass SharedDevice:\n \"\"\"\n Contains information about a single shared device on the remote server.\n\n The following attributes are available:\n\n * name : An unicode string containing the name of the shared device\n * comments : An unicode string containing the user description of the shared device\n \"\"\"\n\n # The following constants are taken from [MS-SRVS]: 2.2.2.4\n # They are used to identify the type of shared resource from the results from the NetrShareEnum in Server Service RPC\n DISK_TREE = 0x00\n PRINT_QUEUE = 0x01\n COMM_DEVICE = 0x02\n IPC = 0x03\n\n def __init__(self, type, name, comments):\n self._type = type\n self.name = name #: An unicode string containing the name of the shared device\n self.comments = comments #: An unicode string containing the user description of the shared device\n\n @property\n def type(self):\n \"\"\"\n Returns one of the following integral constants.\n - SharedDevice.DISK_TREE\n - SharedDevice.PRINT_QUEUE\n - SharedDevice.COMM_DEVICE\n - SharedDevice.IPC\n \"\"\"\n return self._type & 0xFFFF\n\n @property\n def isSpecial(self):\n \"\"\"\n Returns True if this shared device is a special share reserved for interprocess communication (IPC$)\n or remote administration of the server (ADMIN$). Can also refer to administrative shares such as\n C$, D$, E$, and so forth\n \"\"\"\n return bool(self._type & 0x80000000)\n\n @property\n def isTemporary(self):\n \"\"\"\n Returns True if this is a temporary share that is not persisted for creation each time the file server initializes.\n \"\"\"\n return bool(self._type & 0x40000000)\n\n def __unicode__(self):\n return u'Shared device: %s (type:0x%02x comments:%s)' % (self.name, self.type, self.comments )\n\n\nclass SharedFile:\n \"\"\"\n Contain information about a file/folder entry that is shared on the shared device.\n\n As an application developer, you should not need to instantiate a *SharedFile* instance directly in your application.\n These *SharedFile* instances are usually returned via a call to *listPath* method in :doc:`smb.SMBProtocol.SMBProtocolFactory`.\n\n If you encounter *SharedFile* instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond\n to any files/folders on your remote shared device, it could be that the original filename on the file/folder entry on the shared device contains\n one of these prohibited characters: \"\\\\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).\n\n The following attributes are available:\n\n * create_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of creation of this file resource on the remote server\n * last_access_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last access of this file resource on the remote server\n * last_write_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last modification of this file resource on the remote server\n * last_attr_change_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last attribute change of this file resource on the remote server\n * file_size : File size in number of bytes\n * alloc_size : Total number of bytes allocated to store this file\n * file_attributes : A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.\n * short_name : Unicode string containing the short name of this file (usually in 8.3 notation)\n * filename : Unicode string containing the long filename of this file. Each OS has a limit to the length of this file name. On Windows, it is 256 characters.\n * file_id : Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17\n \"\"\"\n\n def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename, file_id=None):\n self.create_time = create_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of creation of this file resource on the remote server\n self.last_access_time = last_access_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last access of this file resource on the remote server\n self.last_write_time = last_write_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last modification of this file resource on the remote server\n self.last_attr_change_time = last_attr_change_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last attribute change of this file resource on the remote server\n self.file_size = file_size #: File size in number of bytes\n self.alloc_size = alloc_size #: Total number of bytes allocated to store this file\n self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.\n self.short_name = short_name #: Unicode string containing the short name of this file (usually in 8.3 notation)\n self.filename = filename #: Unicode string containing the long filename of this file. Each OS has a limit to the length of this file name. On Windows, it is 256 characters.\n self.file_id = file_id #: Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17\n\n @property\n def isDirectory(self):\n \"\"\"A convenient property to return True if this file resource is a directory on the remote server\"\"\"\n return bool(self.file_attributes & ATTR_DIRECTORY)\n\n @property\n def isReadOnly(self):\n \"\"\"A convenient property to return True if this file resource is read-only on the remote server\"\"\"\n return bool(self.file_attributes & ATTR_READONLY)\n\n @property\n def isNormal(self):\n \"\"\"\n A convenient property to return True if this is a normal file.\n\n Note that pysmb defines a normal file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n \"\"\"\n return (self.file_attributes==ATTR_NORMAL) or ((self.file_attributes & 0xff)==0)\n\n def __unicode__(self):\n return u'Shared file: %s (FileSize:%d bytes, isDirectory:%s)' % ( self.filename, self.file_size, self.isDirectory )\n\n\nclass _PendingRequest:\n\n def __init__(self, mid, expiry_time, callback, errback, **kwargs):\n self.mid = mid\n self.expiry_time = expiry_time\n self.callback = callback\n self.errback = errback\n self.kwargs = kwargs\n" }, { "path": "python2/smb/ntlm.py", "content": "\nimport types, hmac, binascii, struct, random, string\nfrom .utils.rc4 import RC4_encrypt\nfrom utils.pyDes import des\n\ntry:\n import hashlib\n hashlib.new('md4')\n\n def MD4(): return hashlib.new('md4')\nexcept ( ImportError, ValueError ):\n from utils.md4 import MD4\n\ntry:\n import hashlib\n def MD5(s): return hashlib.md5(s)\nexcept ImportError:\n import md5\n def MD5(s): return md5.new(s)\n\n################\n# NTLMv2 Methods\n################\n\n# The following constants are defined in accordance to [MS-NLMP]: 2.2.2.5\n\nNTLM_NegotiateUnicode = 0x00000001\nNTLM_NegotiateOEM = 0x00000002\nNTLM_RequestTarget = 0x00000004\nNTLM_Unknown9 = 0x00000008\nNTLM_NegotiateSign = 0x00000010\nNTLM_NegotiateSeal = 0x00000020\nNTLM_NegotiateDatagram = 0x00000040\nNTLM_NegotiateLanManagerKey = 0x00000080\nNTLM_Unknown8 = 0x00000100\nNTLM_NegotiateNTLM = 0x00000200\nNTLM_NegotiateNTOnly = 0x00000400\nNTLM_Anonymous = 0x00000800\nNTLM_NegotiateOemDomainSupplied = 0x00001000\nNTLM_NegotiateOemWorkstationSupplied = 0x00002000\nNTLM_Unknown6 = 0x00004000\nNTLM_NegotiateAlwaysSign = 0x00008000\nNTLM_TargetTypeDomain = 0x00010000\nNTLM_TargetTypeServer = 0x00020000\nNTLM_TargetTypeShare = 0x00040000\nNTLM_NegotiateExtendedSecurity = 0x00080000\nNTLM_NegotiateIdentify = 0x00100000\nNTLM_Unknown5 = 0x00200000\nNTLM_RequestNonNTSessionKey = 0x00400000\nNTLM_NegotiateTargetInfo = 0x00800000\nNTLM_Unknown4 = 0x01000000\nNTLM_NegotiateVersion = 0x02000000\nNTLM_Unknown3 = 0x04000000\nNTLM_Unknown2 = 0x08000000\nNTLM_Unknown1 = 0x10000000\nNTLM_Negotiate128 = 0x20000000\nNTLM_NegotiateKeyExchange = 0x40000000\nNTLM_Negotiate56 = 0x80000000\n\nNTLM_FLAGS = NTLM_NegotiateUnicode | \\\n NTLM_RequestTarget | \\\n NTLM_NegotiateSign | \\\n NTLM_NegotiateNTLM | \\\n NTLM_NegotiateAlwaysSign | \\\n NTLM_NegotiateExtendedSecurity | \\\n NTLM_NegotiateTargetInfo | \\\n NTLM_NegotiateVersion | \\\n NTLM_Negotiate128 | \\\n NTLM_NegotiateKeyExchange\n\ndef generateNegotiateMessage():\n \"\"\"\n References:\n ===========\n - [MS-NLMP]: 2.2.1.1\n \"\"\"\n s = struct.pack('<8sII8s8s8s',\n 'NTLMSSP\\0', 0x01, NTLM_FLAGS,\n '\\0' * 8, # Domain\n '\\0' * 8, # Workstation\n '\\x06\\x00\\x72\\x17\\x00\\x00\\x00\\x0F') # Version [MS-NLMP]: 2.2.2.10\n return s\n\n\ndef generateAuthenticateMessage(challenge_flags, nt_response, lm_response, request_session_key, user, domain = 'WORKGROUP', workstation = 'LOCALHOST'):\n \"\"\"\n References:\n ===========\n - [MS-NLMP]: 2.2.1.3\n \"\"\"\n FORMAT = '<8sIHHIHHIHHIHHIHHIHHII'\n FORMAT_SIZE = struct.calcsize(FORMAT)\n\n # [MS-NLMP]: 3.1.5.1.2\n # http://grutz.jingojango.net/exploits/davenport-ntlm.html\n session_key = session_signing_key = request_session_key\n if challenge_flags & NTLM_NegotiateKeyExchange:\n session_signing_key = \"\".join([ random.choice(string.digits+string.ascii_letters) for _ in range(16) ]).encode('ascii')\n session_key = RC4_encrypt(request_session_key, session_signing_key)\n\n lm_response_length = len(lm_response)\n lm_response_offset = FORMAT_SIZE\n nt_response_length = len(nt_response)\n nt_response_offset = lm_response_offset + lm_response_length\n domain_unicode = domain.encode('UTF-16LE')\n domain_length = len(domain_unicode)\n domain_offset = nt_response_offset + nt_response_length\n\n padding = ''\n if domain_offset % 2 != 0:\n padding = '\\0'\n domain_offset += 1\n\n user_unicode = user.encode('UTF-16LE')\n user_length = len(user_unicode)\n user_offset = domain_offset + domain_length\n workstation_unicode = workstation.encode('UTF-16LE')\n workstation_length = len(workstation_unicode)\n workstation_offset = user_offset + user_length\n session_key_length = len(session_key)\n session_key_offset = workstation_offset + workstation_length\n\n auth_flags = challenge_flags\n auth_flags &= ~NTLM_NegotiateVersion\n\n s = struct.pack(FORMAT,\n 'NTLMSSP\\0', 0x03,\n lm_response_length, lm_response_length, lm_response_offset,\n nt_response_length, nt_response_length, nt_response_offset,\n domain_length, domain_length, domain_offset,\n user_length, user_length, user_offset,\n workstation_length, workstation_length, workstation_offset,\n session_key_length, session_key_length, session_key_offset,\n auth_flags)\n\n return s + lm_response + nt_response + padding + domain_unicode + user_unicode + workstation_unicode + session_key, session_signing_key\n\n\ndef decodeChallengeMessage(ntlm_data):\n \"\"\"\n References:\n ===========\n - [MS-NLMP]: 2.2.1.2\n - [MS-NLMP]: 2.2.2.1 (AV_PAIR)\n \"\"\"\n FORMAT = '<8sIHHII8s8sHHI'\n FORMAT_SIZE = struct.calcsize(FORMAT)\n\n signature, message_type, \\\n targetname_len, targetname_maxlen, targetname_offset, \\\n flags, challenge, _, \\\n targetinfo_len, targetinfo_maxlen, targetinfo_offset, \\\n = struct.unpack(FORMAT, ntlm_data[:FORMAT_SIZE])\n\n assert signature == 'NTLMSSP\\0'\n assert message_type == 0x02\n\n return challenge, flags, ntlm_data[targetinfo_offset:targetinfo_offset+targetinfo_len]\n\n\ndef generateChallengeResponseV2(password, user, server_challenge, server_info, domain = '', client_challenge = None):\n client_timestamp = '\\0' * 8\n\n if not client_challenge:\n client_challenge = ''\n for i in range(0, 8):\n client_challenge += chr(random.getrandbits(8))\n assert len(client_challenge) == 8\n\n d = MD4()\n d.update(password.encode('UTF-16LE'))\n ntlm_hash = d.digest() # The NT password hash\n response_key = hmac.new(ntlm_hash, (user.upper() + domain).encode('UTF-16LE')).digest() # The NTLMv2 password hash. In [MS-NLMP], this is the result of NTOWFv2 and LMOWFv2 functions\n temp = '\\x01\\x01' + '\\0'*6 + client_timestamp + client_challenge + '\\0'*4 + server_info\n ntproofstr = hmac.new(response_key, server_challenge + temp).digest()\n\n nt_challenge_response = ntproofstr + temp\n lm_challenge_response = hmac.new(response_key, server_challenge + client_challenge).digest() + client_challenge\n session_key = hmac.new(response_key, ntproofstr).digest()\n\n return nt_challenge_response, lm_challenge_response, session_key\n\n\n################\n# NTLMv1 Methods\n################\n\ndef expandDesKey(key):\n \"\"\"Expand the key from a 7-byte password key into a 8-byte DES key\"\"\"\n s = chr(((ord(key[0]) >> 1) & 0x7f) << 1)\n s = s + chr(((ord(key[0]) & 0x01) << 6 | ((ord(key[1]) >> 2) & 0x3f)) << 1)\n s = s + chr(((ord(key[1]) & 0x03) << 5 | ((ord(key[2]) >> 3) & 0x1f)) << 1)\n s = s + chr(((ord(key[2]) & 0x07) << 4 | ((ord(key[3]) >> 4) & 0x0f)) << 1)\n s = s + chr(((ord(key[3]) & 0x0f) << 3 | ((ord(key[4]) >> 5) & 0x07)) << 1)\n s = s + chr(((ord(key[4]) & 0x1f) << 2 | ((ord(key[5]) >> 6) & 0x03)) << 1)\n s = s + chr(((ord(key[5]) & 0x3f) << 1 | ((ord(key[6]) >> 7) & 0x01)) << 1)\n s = s + chr((ord(key[6]) & 0x7f) << 1)\n return s\n\n\ndef DESL(K, D):\n \"\"\"\n References:\n ===========\n - http://ubiqx.org/cifs/SMB.html (2.8.3.4)\n - [MS-NLMP]: Section 6\n \"\"\"\n d1 = des(expandDesKey(K[0:7]))\n d2 = des(expandDesKey(K[7:14]))\n d3 = des(expandDesKey(K[14:16] + '\\0' * 5))\n return d1.encrypt(D) + d2.encrypt(D) + d3.encrypt(D)\n\n\ndef generateChallengeResponseV1(password, server_challenge, has_extended_security = False, client_challenge = None):\n \"\"\"\n Generate a NTLMv1 response\n\n @param password: User password string\n @param server_challange: A 8-byte challenge string sent from the server\n @param has_extended_security: A boolean value indicating whether NTLMSSP_NEGOTIATE_EXTENDED_SESSIONSECURITY flag is enabled in the NTLM negFlag\n @param client_challenge: A 8-byte string representing client challenge. If None, it will be generated randomly if needed by the response generation\n @return: a tuple of ( NT challenge response string, LM challenge response string )\n\n References:\n ===========\n - http://ubiqx.org/cifs/SMB.html (2.8.3.3 and 2.8.3.4)\n - [MS-NLMP]: 3.3.1\n \"\"\"\n _password = (password.upper() + '\\0' * 14)[:14]\n d1 = des(expandDesKey(_password[:7]))\n d2 = des(expandDesKey(_password[7:]))\n lm_response_key = d1.encrypt(\"KGS!@#$%\") + d2.encrypt(\"KGS!@#$%\") # LM password hash. In [MS-NLMP], this is the result of LMOWFv1 function\n\n d = MD4()\n d.update(password.encode('UTF-16LE'))\n nt_response_key = d.digest() # In [MS-NLMP], this is the result of NTOWFv1 function\n\n if has_extended_security:\n if not client_challenge:\n client_challenge = ''\n for i in range(0, 8):\n client_challenge += chr(random.getrandbits(8))\n\n assert len(client_challenge) == 8\n\n lm_challenge_response = client_challenge + '\\0'*16\n nt_challenge_response = DESL(nt_response_key, MD5(server_challenge + client_challenge).digest()[0:8])\n else:\n nt_challenge_response = DESL(nt_response_key, server_challenge) # The result after DESL is the NT response\n lm_challenge_response = DESL(lm_response_key, server_challenge) # The result after DESL is the LM response\n\n d = MD4()\n d.update(nt_response_key)\n session_key = d.digest()\n\n return nt_challenge_response, lm_challenge_response, session_key\n" }, { "path": "python2/smb/security_descriptors.py", "content": "\"\"\"\nThis module implements security descriptors, and the partial structures\nused in them, as specified in [MS-DTYP].\n\"\"\"\n\nimport struct\n\n\n# Security descriptor control flags\n# [MS-DTYP]: 2.4.6\nSECURITY_DESCRIPTOR_OWNER_DEFAULTED = 0x0001\nSECURITY_DESCRIPTOR_GROUP_DEFAULTED = 0x0002\nSECURITY_DESCRIPTOR_DACL_PRESENT = 0x0004\nSECURITY_DESCRIPTOR_DACL_DEFAULTED = 0x0008\nSECURITY_DESCRIPTOR_SACL_PRESENT = 0x0010\nSECURITY_DESCRIPTOR_SACL_DEFAULTED = 0x0020\nSECURITY_DESCRIPTOR_SERVER_SECURITY = 0x0040\nSECURITY_DESCRIPTOR_DACL_TRUSTED = 0x0080\nSECURITY_DESCRIPTOR_DACL_COMPUTED_INHERITANCE_REQUIRED = 0x0100\nSECURITY_DESCRIPTOR_SACL_COMPUTED_INHERITANCE_REQUIRED = 0x0200\nSECURITY_DESCRIPTOR_DACL_AUTO_INHERITED = 0x0400\nSECURITY_DESCRIPTOR_SACL_AUTO_INHERITED = 0x0800\nSECURITY_DESCRIPTOR_DACL_PROTECTED = 0x1000\nSECURITY_DESCRIPTOR_SACL_PROTECTED = 0x2000\nSECURITY_DESCRIPTOR_RM_CONTROL_VALID = 0x4000\nSECURITY_DESCRIPTOR_SELF_RELATIVE = 0x8000\n\n# ACE types\n# [MS-DTYP]: 2.4.4.1\nACE_TYPE_ACCESS_ALLOWED = 0x00\nACE_TYPE_ACCESS_DENIED = 0x01\nACE_TYPE_SYSTEM_AUDIT = 0x02\nACE_TYPE_SYSTEM_ALARM = 0x03\nACE_TYPE_ACCESS_ALLOWED_COMPOUND = 0x04\nACE_TYPE_ACCESS_ALLOWED_OBJECT = 0x05\nACE_TYPE_ACCESS_DENIED_OBJECT = 0x06\nACE_TYPE_SYSTEM_AUDIT_OBJECT = 0x07\nACE_TYPE_SYSTEM_ALARM_OBJECT = 0x08\nACE_TYPE_ACCESS_ALLOWED_CALLBACK = 0x09\nACE_TYPE_ACCESS_DENIED_CALLBACK = 0x0A\nACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT = 0x0B\nACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT = 0x0C\nACE_TYPE_SYSTEM_AUDIT_CALLBACK = 0x0D\nACE_TYPE_SYSTEM_ALARM_CALLBACK = 0x0E\nACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT = 0x0F\nACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT = 0x10\nACE_TYPE_SYSTEM_MANDATORY_LABEL = 0x11\nACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE = 0x12\nACE_TYPE_SYSTEM_SCOPED_POLICY_ID = 0x13\n\n# ACE flags\n# [MS-DTYP]: 2.4.4.1\nACE_FLAG_OBJECT_INHERIT = 0x01\nACE_FLAG_CONTAINER_INHERIT = 0x02\nACE_FLAG_NO_PROPAGATE_INHERIT = 0x04\nACE_FLAG_INHERIT_ONLY = 0x08\nACE_FLAG_INHERITED = 0x10\nACE_FLAG_SUCCESSFUL_ACCESS = 0x40\nACE_FLAG_FAILED_ACCESS = 0x80\n\n# Pre-defined well-known SIDs\n# [MS-DTYP]: 2.4.2.4\nSID_NULL = \"S-1-0-0\"\nSID_EVERYONE = \"S-1-1-0\"\nSID_LOCAL = \"S-1-2-0\"\nSID_CONSOLE_LOGON = \"S-1-2-1\"\nSID_CREATOR_OWNER = \"S-1-3-0\"\nSID_CREATOR_GROUP = \"S-1-3-1\"\nSID_OWNER_SERVER = \"S-1-3-2\"\nSID_GROUP_SERVER = \"S-1-3-3\"\nSID_OWNER_RIGHTS = \"S-1-3-4\"\nSID_NT_AUTHORITY = \"S-1-5\"\nSID_DIALUP = \"S-1-5-1\"\nSID_NETWORK = \"S-1-5-2\"\nSID_BATCH = \"S-1-5-3\"\nSID_INTERACTIVE = \"S-1-5-4\"\nSID_SERVICE = \"S-1-5-6\"\nSID_ANONYMOUS = \"S-1-5-7\"\nSID_PROXY = \"S-1-5-8\"\nSID_ENTERPRISE_DOMAIN_CONTROLLERS = \"S-1-5-9\"\nSID_PRINCIPAL_SELF = \"S-1-5-10\"\nSID_AUTHENTICATED_USERS = \"S-1-5-11\"\nSID_RESTRICTED_CODE = \"S-1-5-12\"\nSID_TERMINAL_SERVER_USER = \"S-1-5-13\"\nSID_REMOTE_INTERACTIVE_LOGON = \"S-1-5-14\"\nSID_THIS_ORGANIZATION = \"S-1-5-15\"\nSID_IUSR = \"S-1-5-17\"\nSID_LOCAL_SYSTEM = \"S-1-5-18\"\nSID_LOCAL_SERVICE = \"S-1-5-19\"\nSID_NETWORK_SERVICE = \"S-1-5-20\"\nSID_COMPOUNDED_AUTHENTICATION = \"S-1-5-21-0-0-0-496\"\nSID_CLAIMS_VALID = \"S-1-5-21-0-0-0-497\"\nSID_BUILTIN_ADMINISTRATORS = \"S-1-5-32-544\"\nSID_BUILTIN_USERS = \"S-1-5-32-545\"\nSID_BUILTIN_GUESTS = \"S-1-5-32-546\"\nSID_POWER_USERS = \"S-1-5-32-547\"\nSID_ACCOUNT_OPERATORS = \"S-1-5-32-548\"\nSID_SERVER_OPERATORS = \"S-1-5-32-549\"\nSID_PRINTER_OPERATORS = \"S-1-5-32-550\"\nSID_BACKUP_OPERATORS = \"S-1-5-32-551\"\nSID_REPLICATOR = \"S-1-5-32-552\"\nSID_ALIAS_PREW2KCOMPACC = \"S-1-5-32-554\"\nSID_REMOTE_DESKTOP = \"S-1-5-32-555\"\nSID_NETWORK_CONFIGURATION_OPS = \"S-1-5-32-556\"\nSID_INCOMING_FOREST_TRUST_BUILDERS = \"S-1-5-32-557\"\nSID_PERFMON_USERS = \"S-1-5-32-558\"\nSID_PERFLOG_USERS = \"S-1-5-32-559\"\nSID_WINDOWS_AUTHORIZATION_ACCESS_GROUP = \"S-1-5-32-560\"\nSID_TERMINAL_SERVER_LICENSE_SERVERS = \"S-1-5-32-561\"\nSID_DISTRIBUTED_COM_USERS = \"S-1-5-32-562\"\nSID_IIS_IUSRS = \"S-1-5-32-568\"\nSID_CRYPTOGRAPHIC_OPERATORS = \"S-1-5-32-569\"\nSID_EVENT_LOG_READERS = \"S-1-5-32-573\"\nSID_CERTIFICATE_SERVICE_DCOM_ACCESS = \"S-1-5-32-574\"\nSID_RDS_REMOTE_ACCESS_SERVERS = \"S-1-5-32-575\"\nSID_RDS_ENDPOINT_SERVERS = \"S-1-5-32-576\"\nSID_RDS_MANAGEMENT_SERVERS = \"S-1-5-32-577\"\nSID_HYPER_V_ADMINS = \"S-1-5-32-578\"\nSID_ACCESS_CONTROL_ASSISTANCE_OPS = \"S-1-5-32-579\"\nSID_REMOTE_MANAGEMENT_USERS = \"S-1-5-32-580\"\nSID_WRITE_RESTRICTED_CODE = \"S-1-5-33\"\nSID_NTLM_AUTHENTICATION = \"S-1-5-64-10\"\nSID_SCHANNEL_AUTHENTICATION = \"S-1-5-64-14\"\nSID_DIGEST_AUTHENTICATION = \"S-1-5-64-21\"\nSID_THIS_ORGANIZATION_CERTIFICATE = \"S-1-5-65-1\"\nSID_NT_SERVICE = \"S-1-5-80\"\nSID_USER_MODE_DRIVERS = \"S-1-5-84-0-0-0-0-0\"\nSID_LOCAL_ACCOUNT = \"S-1-5-113\"\nSID_LOCAL_ACCOUNT_AND_MEMBER_OF_ADMINISTRATORS_GROUP = \"S-1-5-114\"\nSID_OTHER_ORGANIZATION = \"S-1-5-1000\"\nSID_ALL_APP_PACKAGES = \"S-1-15-2-1\"\nSID_ML_UNTRUSTED = \"S-1-16-0\"\nSID_ML_LOW = \"S-1-16-4096\"\nSID_ML_MEDIUM = \"S-1-16-8192\"\nSID_ML_MEDIUM_PLUS = \"S-1-16-8448\"\nSID_ML_HIGH = \"S-1-16-12288\"\nSID_ML_SYSTEM = \"S-1-16-16384\"\nSID_ML_PROTECTED_PROCESS = \"S-1-16-20480\"\nSID_AUTHENTICATION_AUTHORITY_ASSERTED_IDENTITY = \"S-1-18-1\"\nSID_SERVICE_ASSERTED_IDENTITY = \"S-1-18-2\"\nSID_FRESH_PUBLIC_KEY_IDENTITY = \"S-1-18-3\"\nSID_KEY_TRUST_IDENTITY = \"S-1-18-4\"\nSID_KEY_PROPERTY_MFA = \"S-1-18-5\"\nSID_KEY_PROPERTY_ATTESTATION = \"S-1-18-6\"\n\n\nclass SID(object):\n \"\"\"\n A Windows security identifier. Represents a single principal, such a\n user or a group, as a sequence of numbers consisting of the revision,\n identifier authority, and a variable-length list of subauthorities.\n\n See [MS-DTYP]: 2.4.2\n \"\"\"\n def __init__(self, revision, identifier_authority, subauthorities):\n #: Revision, should always be 1.\n self.revision = revision\n #: An integer representing the identifier authority.\n self.identifier_authority = identifier_authority\n #: A list of integers representing all subauthorities.\n self.subauthorities = subauthorities\n\n def __str__(self):\n \"\"\"\n String representation, as specified in [MS-DTYP]: 2.4.2.1\n \"\"\"\n if self.identifier_authority >= 2**32:\n id_auth = '%#x' % (self.identifier_authority,)\n else:\n id_auth = self.identifier_authority\n auths = [self.revision, id_auth] + self.subauthorities\n return 'S-' + '-'.join(str(subauth) for subauth in auths)\n\n def __repr__(self):\n return 'SID(%r)' % (str(self),)\n\n @classmethod\n def from_bytes(cls, data, return_tail=False):\n revision, subauth_count = struct.unpack('Q', '\\x00\\x00' + data[2:8])[0]\n subauth_data = data[8:]\n subauthorities = [struct.unpack('= size\n\n body = data[header_size:size]\n additional_data = {}\n\n # In all ACE types, the mask immediately follows the header.\n mask = struct.unpack('= size\n\n for i in range(count):\n ace_size = struct.unpack(''), os.linesep ))\n b.write('Status: 0x%08X %s' % ( self.status, os.linesep ))\n b.write('Flags: 0x%02X %s' % ( self.flags, os.linesep ))\n b.write('PID: %d %s' % ( self.pid, os.linesep ))\n b.write('MID: %d %s' % ( self.mid, os.linesep ))\n b.write('TID: %d %s' % ( self.tid, os.linesep ))\n b.write('Data: %d bytes %s%s %s' % ( len(self.data), os.linesep, binascii.hexlify(self.data), os.linesep ))\n return b.getvalue()\n\n def reset(self):\n self.raw_data = ''\n self.command = 0\n self.status = 0\n self.flags = 0\n\n self.next_command_offset = 0\n self.mid = 0\n self.session_id = 0\n self.signature = '\\0'*16\n self.payload = None\n self.data = ''\n\n # For async SMB2 message\n self.async_id = 0\n\n # For sync SMB2 message\n self.pid = 0\n self.tid = 0\n\n # Not used in this class. Maintained for compatibility with SMBMessage class\n self.flags2 = 0\n self.uid = 0\n self.security = 0L\n self.parameters_data = ''\n\n def encode(self):\n \"\"\"\n Encode this SMB2 message into a series of bytes suitable to be embedded with a NetBIOS session message.\n AssertionError will be raised if this SMB message has not been initialized with a Payload instance\n\n @return: a string containing the encoded SMB2 message\n \"\"\"\n assert self.payload\n\n self.pid = os.getpid()\n self.payload.prepare(self)\n\n headers_data = struct.pack(self.HEADER_STRUCT_FORMAT,\n '\\xFESMB', self.HEADER_SIZE, 0, self.status, self.command, 0, self.flags) + \\\n struct.pack(self.SYNC_HEADER_STRUCT_FORMAT, self.next_command_offset, self.mid, self.pid, self.tid, self.session_id, self.signature)\n return headers_data + self.data\n\n def decode(self, buf):\n \"\"\"\n Decodes the SMB message in buf.\n All fields of the SMB2Message object will be reset to default values before decoding.\n On errors, do not assume that the fields will be reinstated back to what they are before\n this method is invoked.\n\n References\n ==========\n - [MS-SMB2]: 2.2.1\n\n @param buf: data containing one complete SMB2 message\n @type buf: string\n @return: a positive integer indicating the number of bytes used in buf to decode this SMB message\n @raise ProtocolError: raised when decoding fails\n \"\"\"\n buf_len = len(buf)\n if buf_len < 64: # All SMB2 headers must be at least 64 bytes. [MS-SMB2]: 2.2.1.1, 2.2.1.2\n raise ProtocolError('Not enough data to decode SMB2 header', buf)\n\n self.reset()\n\n protocol, struct_size, self.credit_charge, self.status, \\\n self.command, self.credit_re, self.flags = struct.unpack(self.HEADER_STRUCT_FORMAT, buf[:self.HEADER_STRUCT_SIZE])\n\n if protocol != '\\xFESMB':\n raise ProtocolError('Invalid 4-byte SMB2 protocol field', buf)\n\n if struct_size != self.HEADER_SIZE:\n raise ProtocolError('Invalid SMB2 header structure size')\n\n if self.isAsync:\n if buf_len < self.HEADER_STRUCT_SIZE+self.ASYNC_HEADER_STRUCT_SIZE:\n raise ProtocolError('Not enough data to decode SMB2 header', buf)\n\n self.next_command_offset, self.mid, self.async_id, self.session_id, \\\n self.signature = struct.unpack(self.ASYNC_HEADER_STRUCT_FORMAT,\n buf[self.HEADER_STRUCT_SIZE:self.HEADER_STRUCT_SIZE+self.ASYNC_HEADER_STRUCT_SIZE])\n else:\n if buf_len < self.HEADER_STRUCT_SIZE+self.SYNC_HEADER_STRUCT_SIZE:\n raise ProtocolError('Not enough data to decode SMB2 header', buf)\n\n self.next_command_offset, self.mid, self.pid, self.tid, self.session_id, \\\n self.signature = struct.unpack(self.SYNC_HEADER_STRUCT_FORMAT,\n buf[self.HEADER_STRUCT_SIZE:self.HEADER_STRUCT_SIZE+self.SYNC_HEADER_STRUCT_SIZE])\n\n if self.next_command_offset > 0:\n self.raw_data = buf[:self.next_command_offset]\n self.data = buf[self.HEADER_SIZE:self.next_command_offset]\n else:\n self.raw_data = buf\n self.data = buf[self.HEADER_SIZE:]\n\n self._decodeCommand()\n if self.payload:\n self.payload.decode(self)\n\n return len(self.raw_data)\n\n def _decodeCommand(self):\n if self.command == SMB2_COM_READ:\n self.payload = SMB2ReadResponse()\n elif self.command == SMB2_COM_WRITE:\n self.payload = SMB2WriteResponse()\n elif self.command == SMB2_COM_QUERY_DIRECTORY:\n self.payload = SMB2QueryDirectoryResponse()\n elif self.command == SMB2_COM_CREATE:\n self.payload = SMB2CreateResponse()\n elif self.command == SMB2_COM_CLOSE:\n self.payload = SMB2CloseResponse()\n elif self.command == SMB2_COM_QUERY_INFO:\n self.payload = SMB2QueryInfoResponse()\n elif self.command == SMB2_COM_SET_INFO:\n self.payload = SMB2SetInfoResponse()\n elif self.command == SMB2_COM_IOCTL:\n self.payload = SMB2IoctlResponse()\n elif self.command == SMB2_COM_TREE_CONNECT:\n self.payload = SMB2TreeConnectResponse()\n elif self.command == SMB2_COM_SESSION_SETUP:\n self.payload = SMB2SessionSetupResponse()\n elif self.command == SMB2_COM_NEGOTIATE:\n self.payload = SMB2NegotiateResponse()\n elif self.command == SMB2_COM_ECHO:\n self.payload = SMB2EchoResponse()\n\n @property\n def isAsync(self):\n return bool(self.flags & SMB2_FLAGS_ASYNC_COMMAND)\n\n @property\n def isReply(self):\n return bool(self.flags & SMB2_FLAGS_SERVER_TO_REDIR)\n\n\nclass Structure:\n\n def initMessage(self, message):\n pass\n\n def prepare(self, message):\n raise NotImplementedError\n\n def decode(self, message):\n raise NotImplementedError\n\n\nclass SMB2NegotiateResponse(Structure):\n \"\"\"\n Contains information on the SMB2_NEGOTIATE response from server\n\n After calling the decode method, each instance will contain the following attributes,\n - security_mode (integer)\n - dialect_revision (integer)\n - server_guid (string)\n - max_transact_size (integer)\n - max_read_size (integer)\n - max_write_size (integer)\n - system_time (long)\n - server_start_time (long)\n - security_blob (string)\n\n References:\n ===========\n - [MS-SMB2]: 2.2.4\n \"\"\"\n\n STRUCTURE_FORMAT = \" 0 # SMB2_SESSION_FLAG_IS_GUEST\n\n @property\n def isAnonymousSession(self):\n return (self.session_flags & 0x0002) > 0 # SMB2_SESSION_FLAG_IS_NULL\n\n def decode(self, message):\n assert message.command == SMB2_COM_SESSION_SETUP\n\n struct_size, self.session_flags, security_blob_offset, security_blob_len \\\n = struct.unpack(self.STRUCTURE_FORMAT, message.raw_data[SMB2Message.HEADER_SIZE:SMB2Message.HEADER_SIZE+self.STRUCTURE_SIZE])\n\n self.security_blob = message.raw_data[security_blob_offset:security_blob_offset+security_blob_len]\n\n\nclass SMB2TreeConnectRequest(Structure):\n \"\"\"\n References:\n ===========\n - [MS-SMB2]: 2.2.9\n \"\"\"\n\n STRUCTURE_FORMAT = \" 0:\n self.in_data = message.raw_data[input_offset:input_offset+input_len]\n else:\n self.in_data = ''\n\n if output_len > 0:\n self.out_data = message.raw_data[output_offset:output_offset+output_len]\n else:\n self.out_data = ''\n\n\nclass SMB2CloseRequest(Structure):\n \"\"\"\n References:\n ===========\n - [MS-SMB2]: 2.2.15\n \"\"\"\n\n STRUCTURE_FORMAT = \"> 24, self.internal_value & 0xFFFF )\n\n @property\n def hasError(self):\n return self.internal_value != 0\n\n\nclass SMBMessage:\n\n HEADER_STRUCT_FORMAT = \"<4sBIBHHQxxHHHHB\"\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n log = logging.getLogger('SMB.SMBMessage')\n protocol = 1\n\n def __init__(self, payload = None):\n self.reset()\n if payload:\n self.payload = payload\n self.payload.initMessage(self)\n\n def __str__(self):\n b = StringIO()\n b.write('Command: 0x%02X (%s) %s' % ( self.command, SMB_COMMAND_NAMES.get(self.command, ''), os.linesep ))\n b.write('Status: %s %s' % ( str(self.status), os.linesep ))\n b.write('Flags: 0x%02X %s' % ( self.flags, os.linesep ))\n b.write('Flags2: 0x%04X %s' % ( self.flags2, os.linesep ))\n b.write('PID: %d %s' % ( self.pid, os.linesep ))\n b.write('UID: %d %s' % ( self.uid, os.linesep ))\n b.write('MID: %d %s' % ( self.mid, os.linesep ))\n b.write('TID: %d %s' % ( self.tid, os.linesep ))\n b.write('Security: 0x%016X %s' % ( self.security, os.linesep ))\n b.write('Parameters: %d bytes %s%s %s' % ( len(self.parameters_data), os.linesep, binascii.hexlify(self.parameters_data), os.linesep ))\n b.write('Data: %d bytes %s%s %s' % ( len(self.data), os.linesep, binascii.hexlify(self.data), os.linesep ))\n return b.getvalue()\n\n def reset(self):\n self.raw_data = ''\n self.command = 0\n self.status = SMBError()\n self.flags = 0\n self.flags2 = 0\n self.pid = 0\n self.tid = 0\n self.uid = 0\n self.mid = 0\n self.security = 0L\n self.parameters_data = ''\n self.data = ''\n self.payload = None\n\n @property\n def isReply(self):\n return bool(self.flags & SMB_FLAGS_REPLY)\n\n @property\n def hasExtendedSecurity(self):\n return bool(self.flags2 & SMB_FLAGS2_EXTENDED_SECURITY)\n\n def encode(self):\n \"\"\"\n Encode this SMB message into a series of bytes suitable to be embedded with a NetBIOS session message.\n AssertionError will be raised if this SMB message has not been initialized with a Payload instance\n\n @return: a string containing the encoded SMB message\n \"\"\"\n assert self.payload\n\n self.pid = os.getpid()\n self.payload.prepare(self)\n\n parameters_len = len(self.parameters_data)\n assert parameters_len % 2 == 0\n\n headers_data = struct.pack(self.HEADER_STRUCT_FORMAT,\n '\\xFFSMB', self.command, self.status.internal_value, self.flags,\n self.flags2, (self.pid >> 16) & 0xFFFF, self.security, self.tid,\n self.pid & 0xFFFF, self.uid, self.mid, int(parameters_len / 2))\n return headers_data + self.parameters_data + struct.pack(' 0 and buf_len < (datalen_offset + 2 + body_len):\n # Not enough data in buf to decode body\n raise ProtocolError('Not enough data. Body decoding failed', buf)\n\n self.parameters_data = buf[offset:datalen_offset]\n\n if body_len > 0:\n self.data = buf[datalen_offset+2:datalen_offset+2+body_len]\n\n self.raw_data = buf\n self._decodePayload()\n\n return self.HEADER_STRUCT_SIZE + params_count * 2 + 2 + body_len\n\n def _decodePayload(self):\n if self.command == SMB_COM_READ_ANDX:\n self.payload = ComReadAndxResponse()\n elif self.command == SMB_COM_WRITE_ANDX:\n self.payload = ComWriteAndxResponse()\n elif self.command == SMB_COM_TRANSACTION:\n self.payload = ComTransactionResponse()\n elif self.command == SMB_COM_TRANSACTION2:\n self.payload = ComTransaction2Response()\n elif self.command == SMB_COM_OPEN_ANDX:\n self.payload = ComOpenAndxResponse()\n elif self.command == SMB_COM_NT_CREATE_ANDX:\n self.payload = ComNTCreateAndxResponse()\n elif self.command == SMB_COM_TREE_CONNECT_ANDX:\n self.payload = ComTreeConnectAndxResponse()\n elif self.command == SMB_COM_ECHO:\n self.payload = ComEchoResponse()\n elif self.command == SMB_COM_SESSION_SETUP_ANDX:\n self.payload = ComSessionSetupAndxResponse()\n elif self.command == SMB_COM_NEGOTIATE:\n self.payload = ComNegotiateResponse()\n\n if self.payload:\n self.payload.decode(self)\n\n\nclass Payload:\n\n DEFAULT_ANDX_PARAM_HEADER = '\\xFF\\x00\\x00\\x00'\n DEFAULT_ANDX_PARAM_SIZE = 4\n\n def initMessage(self, message):\n # SMB_FLAGS2_UNICODE must always be enabled. Without this, almost all the Payload subclasses will need to be\n # rewritten to check for OEM/Unicode strings which will be tedious. Fortunately, almost all tested CIFS services\n # support SMB_FLAGS2_UNICODE by default.\n assert message.payload == self\n message.flags = SMB_FLAGS_CASE_INSENSITIVE | SMB_FLAGS_CANONICALIZED_PATHS\n message.flags2 = SMB_FLAGS2_UNICODE | SMB_FLAGS2_NT_STATUS | SMB_FLAGS2_LONG_NAMES | SMB_FLAGS2_EAS\n\n if SUPPORT_EXTENDED_SECURITY:\n message.flags2 |= SMB_FLAGS2_EXTENDED_SECURITY | SMB_FLAGS2_SMB_SECURITY_SIGNATURE\n\n def prepare(self, message):\n raise NotImplementedError\n\n def decode(self, message):\n raise NotImplementedError\n\n\nclass ComNegotiateRequest(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.52.1\n - [MS-SMB]: 2.2.4.5.1\n \"\"\"\n\n def initMessage(self, message):\n Payload.initMessage(self, message)\n message.command = SMB_COM_NEGOTIATE\n\n def prepare(self, message):\n assert message.payload == self\n message.parameters_data = ''\n if SUPPORT_SMB2:\n message.data = ''.join(map(lambda s: '\\x02'+s+'\\x00', DIALECTS + DIALECTS2))\n else:\n message.data = ''.join(map(lambda s: '\\x02'+s+'\\x00', DIALECTS))\n\n\nclass ComNegotiateResponse(Payload):\n \"\"\"\n Contains information on the SMB_COM_NEGOTIATE response from server\n\n After calling the decode method, each instance will contain the following attributes,\n - security_mode (integer)\n - max_mpx_count (integer)\n - max_number_vcs (integer)\n - max_buffer_size (long)\n - max_raw_size (long)\n - session_key (long)\n - capabilities (long)\n - system_time (long)\n - server_time_zone (integer)\n - challenge_length (integer)\n\n If the underlying SMB message's flag2 does not have SMB_FLAGS2_EXTENDED_SECURITY bit enabled,\n then the instance will have the following additional attributes,\n - challenge (string)\n - domain (unicode)\n\n If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled,\n then the instance will have the following additional attributes,\n - server_guid (string)\n - security_blob (string)\n\n References:\n ===========\n - [MS-SMB]: 2.2.4.5.2.1\n - [MS-CIFS]: 2.2.4.52.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n if data_len >= self.challenge_length:\n self.challenge = message.data[:self.challenge_length]\n\n s = ''\n offset = self.challenge_length\n while offset < data_len:\n _s = message.data[offset:offset+2]\n if _s == '\\0\\0':\n self.domain = s.decode('UTF-16LE')\n break\n else:\n s += _s\n offset += 2\n else:\n raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (without security extensions) Challenge field', message.raw_data, message)\n else:\n if data_len < 16:\n raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (with security extensions) ServerGUID field', message.raw_data, message)\n\n self.server_guid = message.data[:16]\n self.security_blob = message.data[16:]\n\n @property\n def supportsExtendedSecurity(self):\n return bool(self.capabilities & CAP_EXTENDED_SECURITY)\n\n\nclass ComSessionSetupAndxRequest__WithSecurityExtension(Payload):\n \"\"\"\n References:\n ===========\n - [MS-SMB]: 2.2.4.6.1\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n params_bytes_offset = offset\n offset += params_bytes_len\n else:\n params_bytes_offset = 0\n\n padding2 = ''\n if offset % 4 != 0:\n padding2 = '\\0'*(4-offset%4)\n offset += (4-offset%4)\n\n if data_bytes_len > 0:\n data_bytes_offset = offset\n else:\n data_bytes_offset = 0\n\n message.parameters_data = \\\n struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n self.total_params_count,\n self.total_data_count,\n self.max_params_count,\n self.max_data_count,\n self.max_setup_count,\n 0x00, # Reserved1. Must be 0x00\n self.flags,\n self.timeout,\n 0x0000, # Reserved2. Must be 0x0000\n params_bytes_len,\n params_bytes_offset,\n data_bytes_len,\n data_bytes_offset,\n int(setup_bytes_len / 2)) + \\\n self.setup_bytes\n\n message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes\n\n\nclass ComTransactionResponse(Payload):\n \"\"\"\n Contains information about a SMB_COM_TRANSACTION response from the server\n\n After decoding, each instance contains the following attributes:\n - total_params_count (integer)\n - total_data_count (integer)\n - setup_bytes (string)\n - data_bytes (string)\n - params_bytes (string)\n\n References:\n ===========\n - [MS-CIFS]: 2.2.4.33.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n setup_bytes_len = setup_count * 2\n\n if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:\n raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)\n\n self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]\n else:\n self.setup_bytes = ''\n\n offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n\n if params_bytes_len > 0:\n self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]\n else:\n self.params_bytes = ''\n\n if data_bytes_len > 0:\n self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]\n else:\n self.data_bytes = ''\n\n\nclass ComTransaction2Request(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.46.1\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = 'HHHHBBHIHHHHHH'\n PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n def __init__(self, max_params_count, max_data_count, max_setup_count,\n total_params_count = 0, total_data_count = 0,\n params_bytes = '', data_bytes = '', setup_bytes = '',\n flags = 0, timeout = 0):\n self.total_params_count = total_params_count or len(params_bytes)\n self.total_data_count = total_data_count or len(data_bytes)\n self.max_params_count = max_params_count\n self.max_data_count = max_data_count\n self.max_setup_count = max_setup_count\n self.flags = flags\n self.timeout = timeout\n self.params_bytes = params_bytes\n self.data_bytes = data_bytes\n self.setup_bytes = setup_bytes\n\n def initMessage(self, message):\n Payload.initMessage(self, message)\n message.command = SMB_COM_TRANSACTION2\n\n def prepare(self, message):\n setup_bytes_len = len(self.setup_bytes)\n params_bytes_len = len(self.params_bytes)\n data_bytes_len = len(self.data_bytes)\n name = '\\0\\0'\n\n padding0 = ''\n offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n if offset % 2 != 0:\n padding0 = '\\0'\n offset += 1\n\n offset += 2 # For the name field\n padding1 = ''\n if offset % 4 != 0:\n padding1 = '\\0'*(4-offset%4)\n\n if params_bytes_len > 0:\n params_bytes_offset = offset\n offset += params_bytes_len\n else:\n params_bytes_offset = 0\n\n padding2 = ''\n if offset % 4 != 0:\n padding2 = '\\0'*(4-offset%4)\n\n if data_bytes_len > 0:\n data_bytes_offset = offset\n else:\n data_bytes_offset = 0\n\n message.parameters_data = \\\n struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n self.total_params_count,\n self.total_data_count,\n self.max_params_count,\n self.max_data_count,\n self.max_setup_count,\n 0x00, # Reserved1. Must be 0x00\n self.flags,\n self.timeout,\n 0x0000, # Reserved2. Must be 0x0000\n params_bytes_len,\n params_bytes_offset,\n data_bytes_len,\n data_bytes_offset,\n int(setup_bytes_len / 2)) + \\\n self.setup_bytes\n\n message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes\n\n\nclass ComTransaction2Response(Payload):\n \"\"\"\n Contains information about a SMB_COM_TRANSACTION2 response from the server\n\n After decoding, each instance contains the following attributes:\n - total_params_count (integer)\n - total_data_count (integer)\n - setup_bytes (string)\n - data_bytes (string)\n - params_bytes (string)\n\n References:\n ===========\n - [MS-CIFS]: 2.2.4.46.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n setup_bytes_len = setup_count * 2\n\n if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:\n raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)\n\n self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]\n else:\n self.setup_bytes = ''\n\n offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n\n if params_bytes_len > 0:\n self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]\n else:\n self.params_bytes = ''\n\n if data_bytes_len > 0:\n self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]\n else:\n self.data_bytes = ''\n\n\nclass ComCloseRequest(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.5.1\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = '> 32) # OffsetHigh field defined in [MS-SMB]: 2.2.4.3.1\n\n message.data = '\\0' + self.data_bytes\n\n\nclass ComWriteAndxResponse(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.43.2\n - [MS-SMB]: 2.2.4.3.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = '> 32), # Note that in [MS-SMB]: 2.2.4.2.1, this field can also act as MaxCountHigh field\n self.remaining, # In [MS-CIFS]: 2.2.4.42.1, this field must be set to 0x0000\n self.offset >> 32)\n\n message.data = ''\n\n\nclass ComReadAndxResponse(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.42.2\n - [MS-SMB]: 2.2.4.2.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n params_bytes_offset = offset\n else:\n params_bytes_offset = 0\n\n offset += params_bytes_len\n padding1 = ''\n if offset % 4 != 0:\n padding1 = '\\0'*(4-offset%4)\n offset += (4-offset%4)\n\n if data_bytes_len > 0:\n data_bytes_offset = offset\n else:\n data_bytes_offset = 0\n\n message.parameters_data = \\\n struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n self.max_setup_count,\n 0x00, # Reserved1. Must be 0x00\n self.total_params_count,\n self.total_data_count,\n self.max_params_count,\n self.max_data_count,\n params_bytes_len,\n params_bytes_offset,\n data_bytes_len,\n data_bytes_offset,\n int(setup_bytes_len / 2),\n self.function) + \\\n self.setup_bytes\n\n message.data = padding0 + self.params_bytes + padding1 + self.data_bytes\n\n\nclass ComNTTransactResponse(Payload):\n \"\"\"\n Contains information about a SMB_COM_NT_TRANSACT response from the server\n\n After decoding, each instance contains the following attributes:\n - total_params_count (integer)\n - total_data_count (integer)\n - setup_bytes (string)\n - data_bytes (string)\n - params_bytes (string)\n\n References:\n ===========\n - [MS-CIFS]: 2.2.4.62.2\n \"\"\"\n PAYLOAD_STRUCT_FORMAT = '<3sIIIIIIIIBH'\n PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n def decode(self, message):\n assert message.command == SMB_COM_NT_TRANSACT\n\n if not message.status.hasError:\n _, self.total_params_count, self.total_data_count, \\\n params_count, params_offset, params_displ, \\\n data_count, data_offset, data_displ, setup_count = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,\n message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_count*2]\n\n if params_count > 0:\n params_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2\n self.params_bytes = message.data[params_offset:params_offset+params_count]\n else:\n self.params_bytes = ''\n\n if data_count > 0:\n data_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2\n self.data_bytes = message.data[data_offset:data_offset+data_count]\n else:\n self.data_bytes = ''\n" }, { "path": "python2/smb/utils/README.txt", "content": "\nmd4.py and U32.py\nBoth modules downloaded from http://www.oocities.org/rozmanov/python/md4.html.\nLicensed under LGPL\n\npyDes.py 2.0.0\nDownloaded from http://twhiteman.netfirms.com/des.html\nLicensed under public domain\n\nsha256.py\nDownloaded from http://xbmc-addons.googlecode.com/svn-history/r1686/trunk/scripts/OpenSubtitles_OSD/resources/lib/sha256.py\nLicensed under MIT\n" }, { "path": "python2/smb/utils/U32.py", "content": "# U32.py implements 32-bit unsigned int class for Python\r\n# Version 1.0\r\n# Copyright (C) 2001-2002 Dmitry Rozmanov\r\n#\r\n# This library is free software; you can redistribute it and/or\r\n# modify it under the terms of the GNU Lesser General Public\r\n# License as published by the Free Software Foundation; either\r\n# version 2.1 of the License, or (at your option) any later version.\r\n#\r\n# This library is distributed in the hope that it will be useful,\r\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\r\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r\n# Lesser General Public License for more details.\r\n#\r\n# You should have received a copy of the GNU Lesser General Public\r\n# License along with this library; if not, write to the Free Software\r\n# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\r\n#\r\n# e-mail: dima@xenon.spb.ru\r\n#\r\n#====================================================================\r\n\r\nC = 0x1000000000L\r\n\r\n#--------------------------------------------------------------------\r\ndef norm(n):\r\n return n & 0xFFFFFFFFL\r\n\r\n#====================================================================\r\nclass U32:\r\n v = 0L\r\n\r\n #--------------------------------------------------------------------\r\n def __init__(self, value = 0):\r\n self.v = C + norm(abs(long(value)))\r\n\r\n #--------------------------------------------------------------------\r\n def set(self, value = 0):\r\n self.v = C + norm(abs(long(value)))\r\n\r\n #--------------------------------------------------------------------\r\n def __repr__(self):\r\n return hex(norm(self.v))\r\n\r\n #--------------------------------------------------------------------\r\n def __long__(self): return long(norm(self.v))\r\n\r\n #--------------------------------------------------------------------\r\n def __int__(self): return int(norm(self.v))\r\n\r\n #--------------------------------------------------------------------\r\n def __chr__(self): return chr(norm(self.v))\r\n\r\n #--------------------------------------------------------------------\r\n def __add__(self, b):\r\n r = U32()\r\n r.v = C + norm(self.v + b.v)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __sub__(self, b):\r\n r = U32()\r\n if self.v < b.v:\r\n r.v = C + norm(0x100000000L - (b.v - self.v))\r\n else: r.v = C + norm(self.v - b.v)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __mul__(self, b):\r\n r = U32()\r\n r.v = C + norm(self.v * b.v)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __div__(self, b):\r\n r = U32()\r\n r.v = C + (norm(self.v) / norm(b.v))\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __mod__(self, b):\r\n r = U32()\r\n r.v = C + (norm(self.v) % norm(b.v))\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __neg__(self): return U32(self.v)\r\n\r\n #--------------------------------------------------------------------\r\n def __pos__(self): return U32(self.v)\r\n\r\n #--------------------------------------------------------------------\r\n def __abs__(self): return U32(self.v)\r\n\r\n #--------------------------------------------------------------------\r\n def __invert__(self):\r\n r = U32()\r\n r.v = C + norm(~self.v)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __lshift__(self, b):\r\n r = U32()\r\n r.v = C + norm(self.v << b)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __rshift__(self, b):\r\n r = U32()\r\n r.v = C + (norm(self.v) >> b)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __and__(self, b):\r\n r = U32()\r\n r.v = C + norm(self.v & b.v)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __or__(self, b):\r\n r = U32()\r\n r.v = C + norm(self.v | b.v)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __xor__(self, b):\r\n r = U32()\r\n r.v = C + norm(self.v ^ b.v)\r\n return r\r\n\r\n #--------------------------------------------------------------------\r\n def __not__(self):\r\n return U32(not norm(self.v))\r\n\r\n #--------------------------------------------------------------------\r\n def truth(self):\r\n return norm(self.v)\r\n\r\n #--------------------------------------------------------------------\r\n def __cmp__(self, b):\r\n if norm(self.v) > norm(b.v): return 1\r\n elif norm(self.v) < norm(b.v): return -1\r\n else: return 0\r\n\r\n #--------------------------------------------------------------------\r\n def __nonzero__(self):\r\n return norm(self.v)\r\n \r\n" }, { "path": "python2/smb/utils/__init__.py", "content": "\ndef convertFILETIMEtoEpoch(t):\n return (t - 116444736000000000L) / 10000000.0;\n" }, { "path": "python2/smb/utils/md4.py", "content": "# md4.py implements md4 hash class for Python\n# Version 1.0\n# Copyright (C) 2001-2002 Dmitry Rozmanov\n#\n# based on md4.c from \"the Python Cryptography Toolkit, version 1.0.0\n# Copyright (C) 1995, A.M. Kuchling\"\n#\n# This library is free software; you can redistribute it and/or\n# modify it under the terms of the GNU Lesser General Public\n# License as published by the Free Software Foundation; either\n# version 2.1 of the License, or (at your option) any later version.\n#\n# This library is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n# Lesser General Public License for more details.\n#\n# You should have received a copy of the GNU Lesser General Public\n# License along with this library; if not, write to the Free Software\n# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\n#\n# e-mail: dima@xenon.spb.ru\n#\n#====================================================================\n\n# MD4 validation data\n\nmd4_test= [\n ('', 0x31d6cfe0d16ae931b73c59d7e0c089c0L),\n (\"a\", 0xbde52cb31de33e46245e05fbdbd6fb24L),\n (\"abc\", 0xa448017aaf21d8525fc10ae87aa6729dL),\n (\"message digest\", 0xd9130a8164549fe818874806e1c7014bL),\n (\"abcdefghijklmnopqrstuvwxyz\", 0xd79e1c308aa5bbcdeea8ed63df412da9L),\n (\"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\",\n 0x043f8582f241db351ce627e153e7f0e4L),\n (\"12345678901234567890123456789012345678901234567890123456789012345678901234567890\",\n 0xe33b4ddc9c38f2199c3e7b164fcc0536L),\n ]\n\n#====================================================================\nfrom U32 import U32\n\n#--------------------------------------------------------------------\nclass MD4:\n A = None\n B = None\n C = None\n D = None\n count, len1, len2 = None, None, None\n buf = []\n\n #-----------------------------------------------------\n def __init__(self):\n\n\n self.A = U32(0x67452301L)\n self.B = U32(0xefcdab89L)\n self.C = U32(0x98badcfeL)\n self.D = U32(0x10325476L)\n self.count, self.len1, self.len2 = U32(0L), U32(0L), U32(0L)\n self.buf = [0x00] * 64\n\n #-----------------------------------------------------\n def __repr__(self):\n r = 'A = %s, \\nB = %s, \\nC = %s, \\nD = %s.\\n' % (self.A.__repr__(), self.B.__repr__(), self.C.__repr__(), self.D.__repr__())\n r = r + 'count = %s, \\nlen1 = %s, \\nlen2 = %s.\\n' % (self.count.__repr__(), self.len1.__repr__(), self.len2.__repr__())\n for i in range(4):\n for j in range(16):\n r = r + '%4s ' % hex(self.buf[i+j])\n r = r + '\\n'\n\n return r\n #-----------------------------------------------------\n def make_copy(self):\n\n dest = new()\n\n dest.len1 = self.len1\n dest.len2 = self.len2\n dest.A = self.A\n dest.B = self.B\n dest.C = self.C\n dest.D = self.D\n dest.count = self.count\n for i in range(self.count):\n dest.buf[i] = self.buf[i]\n\n return dest\n\n #-----------------------------------------------------\n def update(self, str):\n\n buf = []\n for i in str: buf.append(ord(i))\n ilen = U32(len(buf))\n\n # check if the first length is out of range\n # as the length is measured in bits then multiplay it by 8\n if (long(self.len1 + (ilen << 3)) < long(self.len1)):\n self.len2 = self.len2 + U32(1)\n\n self.len1 = self.len1 + (ilen << 3)\n self.len2 = self.len2 + (ilen >> 29)\n\n L = U32(0)\n bufpos = 0\n while (long(ilen) > 0):\n if (64 - long(self.count)) < long(ilen): L = U32(64 - long(self.count))\n else: L = ilen\n for i in range(int(L)): self.buf[i + int(self.count)] = buf[i + bufpos]\n self.count = self.count + L\n ilen = ilen - L\n bufpos = bufpos + int(L)\n\n if (long(self.count) == 64L):\n self.count = U32(0L)\n X = []\n i = 0\n for j in range(16):\n X.append(U32(self.buf[i]) + (U32(self.buf[i+1]) << 8) + \\\n (U32(self.buf[i+2]) << 16) + (U32(self.buf[i+3]) << 24))\n i = i + 4\n\n A = self.A\n B = self.B\n C = self.C\n D = self.D\n\n A = f1(A,B,C,D, 0, 3, X)\n D = f1(D,A,B,C, 1, 7, X)\n C = f1(C,D,A,B, 2,11, X)\n B = f1(B,C,D,A, 3,19, X)\n A = f1(A,B,C,D, 4, 3, X)\n D = f1(D,A,B,C, 5, 7, X)\n C = f1(C,D,A,B, 6,11, X)\n B = f1(B,C,D,A, 7,19, X)\n A = f1(A,B,C,D, 8, 3, X)\n D = f1(D,A,B,C, 9, 7, X)\n C = f1(C,D,A,B,10,11, X)\n B = f1(B,C,D,A,11,19, X)\n A = f1(A,B,C,D,12, 3, X)\n D = f1(D,A,B,C,13, 7, X)\n C = f1(C,D,A,B,14,11, X)\n B = f1(B,C,D,A,15,19, X)\n\n A = f2(A,B,C,D, 0, 3, X)\n D = f2(D,A,B,C, 4, 5, X)\n C = f2(C,D,A,B, 8, 9, X)\n B = f2(B,C,D,A,12,13, X)\n A = f2(A,B,C,D, 1, 3, X)\n D = f2(D,A,B,C, 5, 5, X)\n C = f2(C,D,A,B, 9, 9, X)\n B = f2(B,C,D,A,13,13, X)\n A = f2(A,B,C,D, 2, 3, X)\n D = f2(D,A,B,C, 6, 5, X)\n C = f2(C,D,A,B,10, 9, X)\n B = f2(B,C,D,A,14,13, X)\n A = f2(A,B,C,D, 3, 3, X)\n D = f2(D,A,B,C, 7, 5, X)\n C = f2(C,D,A,B,11, 9, X)\n B = f2(B,C,D,A,15,13, X)\n\n A = f3(A,B,C,D, 0, 3, X)\n D = f3(D,A,B,C, 8, 9, X)\n C = f3(C,D,A,B, 4,11, X)\n B = f3(B,C,D,A,12,15, X)\n A = f3(A,B,C,D, 2, 3, X)\n D = f3(D,A,B,C,10, 9, X)\n C = f3(C,D,A,B, 6,11, X)\n B = f3(B,C,D,A,14,15, X)\n A = f3(A,B,C,D, 1, 3, X)\n D = f3(D,A,B,C, 9, 9, X)\n C = f3(C,D,A,B, 5,11, X)\n B = f3(B,C,D,A,13,15, X)\n A = f3(A,B,C,D, 3, 3, X)\n D = f3(D,A,B,C,11, 9, X)\n C = f3(C,D,A,B, 7,11, X)\n B = f3(B,C,D,A,15,15, X)\n\n self.A = self.A + A\n self.B = self.B + B\n self.C = self.C + C\n self.D = self.D + D\n\n #-----------------------------------------------------\n def digest(self):\n\n res = [0x00] * 16\n s = [0x00] * 8\n padding = [0x00] * 64\n padding[0] = 0x80\n padlen, oldlen1, oldlen2 = U32(0), U32(0), U32(0)\n\n temp = self.make_copy()\n\n oldlen1 = temp.len1\n oldlen2 = temp.len2\n if (56 <= long(self.count)): padlen = U32(56 - long(self.count) + 64)\n else: padlen = U32(56 - long(self.count))\n\n temp.update(int_array2str(padding[:int(padlen)]))\n\n s[0]= (oldlen1) & U32(0xFF)\n s[1]=((oldlen1) >> 8) & U32(0xFF)\n s[2]=((oldlen1) >> 16) & U32(0xFF)\n s[3]=((oldlen1) >> 24) & U32(0xFF)\n s[4]= (oldlen2) & U32(0xFF)\n s[5]=((oldlen2) >> 8) & U32(0xFF)\n s[6]=((oldlen2) >> 16) & U32(0xFF)\n s[7]=((oldlen2) >> 24) & U32(0xFF)\n temp.update(int_array2str(s))\n\n res[ 0]= temp.A & U32(0xFF)\n res[ 1]=(temp.A >> 8) & U32(0xFF)\n res[ 2]=(temp.A >> 16) & U32(0xFF)\n res[ 3]=(temp.A >> 24) & U32(0xFF)\n res[ 4]= temp.B & U32(0xFF)\n res[ 5]=(temp.B >> 8) & U32(0xFF)\n res[ 6]=(temp.B >> 16) & U32(0xFF)\n res[ 7]=(temp.B >> 24) & U32(0xFF)\n res[ 8]= temp.C & U32(0xFF)\n res[ 9]=(temp.C >> 8) & U32(0xFF)\n res[10]=(temp.C >> 16) & U32(0xFF)\n res[11]=(temp.C >> 24) & U32(0xFF)\n res[12]= temp.D & U32(0xFF)\n res[13]=(temp.D >> 8) & U32(0xFF)\n res[14]=(temp.D >> 16) & U32(0xFF)\n res[15]=(temp.D >> 24) & U32(0xFF)\n\n return int_array2str(res)\n\n#====================================================================\n# helpers\ndef F(x, y, z): return (((x) & (y)) | ((~x) & (z)))\ndef G(x, y, z): return (((x) & (y)) | ((x) & (z)) | ((y) & (z)))\ndef H(x, y, z): return ((x) ^ (y) ^ (z))\n\ndef ROL(x, n): return (((x) << n) | ((x) >> (32-n)))\n\ndef f1(a, b, c, d, k, s, X): return ROL(a + F(b, c, d) + X[k], s)\ndef f2(a, b, c, d, k, s, X): return ROL(a + G(b, c, d) + X[k] + U32(0x5a827999L), s)\ndef f3(a, b, c, d, k, s, X): return ROL(a + H(b, c, d) + X[k] + U32(0x6ed9eba1L), s)\n\n#--------------------------------------------------------------------\n# helper function\ndef int_array2str(array):\n str = ''\n for i in array:\n str = str + chr(i)\n return str\n\n#--------------------------------------------------------------------\n# To be able to use md4.new() instead of md4.MD4()\nnew = MD4\n" }, { "path": "python2/smb/utils/pyDes.py", "content": "#############################################################################\n# \t\t\t\tDocumentation\t\t\t\t #\n#############################################################################\n\n# Author: Todd Whiteman\n# Date: 16th March, 2009\n# Verion: 2.0.0\n# License: Public Domain - free to do as you wish\n# Homepage: http://twhiteman.netfirms.com/des.html\n#\n# This is a pure python implementation of the DES encryption algorithm.\n# It's pure python to avoid portability issues, since most DES \n# implementations are programmed in C (for performance reasons).\n#\n# Triple DES class is also implemented, utilising the DES base. Triple DES\n# is either DES-EDE3 with a 24 byte key, or DES-EDE2 with a 16 byte key.\n#\n# See the README.txt that should come with this python module for the\n# implementation methods used.\n#\n# Thanks to:\n# * David Broadwell for ideas, comments and suggestions.\n# * Mario Wolff for pointing out and debugging some triple des CBC errors.\n# * Santiago Palladino for providing the PKCS5 padding technique.\n# * Shaya for correcting the PAD_PKCS5 triple des CBC errors.\n#\n\"\"\"A pure python implementation of the DES and TRIPLE DES encryption algorithms.\n\nClass initialization\n--------------------\npyDes.des(key, [mode], [IV], [pad], [padmode])\npyDes.triple_des(key, [mode], [IV], [pad], [padmode])\n\nkey -> Bytes containing the encryption key. 8 bytes for DES, 16 or 24 bytes\n\t for Triple DES\nmode -> Optional argument for encryption type, can be either\n\t pyDes.ECB (Electronic Code Book) or pyDes.CBC (Cypher Block Chaining)\nIV -> Optional Initial Value bytes, must be supplied if using CBC mode.\n\t Length must be 8 bytes.\npad -> Optional argument, set the pad character (PAD_NORMAL) to use during\n\t all encrypt/decrpt operations done with this instance.\npadmode -> Optional argument, set the padding mode (PAD_NORMAL or PAD_PKCS5)\n\t to use during all encrypt/decrpt operations done with this instance.\n\nI recommend to use PAD_PKCS5 padding, as then you never need to worry about any\npadding issues, as the padding can be removed unambiguously upon decrypting\ndata that was encrypted using PAD_PKCS5 padmode.\n\nCommon methods\n--------------\nencrypt(data, [pad], [padmode])\ndecrypt(data, [pad], [padmode])\n\ndata -> Bytes to be encrypted/decrypted\npad -> Optional argument. Only when using padmode of PAD_NORMAL. For\n\t encryption, adds this characters to the end of the data block when\n\t data is not a multiple of 8 bytes. For decryption, will remove the\n\t trailing characters that match this pad character from the last 8\n\t bytes of the unencrypted data block.\npadmode -> Optional argument, set the padding mode, must be one of PAD_NORMAL\n\t or PAD_PKCS5). Defaults to PAD_NORMAL.\n\t \n\nExample\n-------\nfrom pyDes import *\n\ndata = \"Please encrypt my data\"\nk = des(\"DESCRYPT\", CBC, \"\\0\\0\\0\\0\\0\\0\\0\\0\", pad=None, padmode=PAD_PKCS5)\n# For Python3, you'll need to use bytes, i.e.:\n# data = b\"Please encrypt my data\"\n# k = des(b\"DESCRYPT\", CBC, b\"\\0\\0\\0\\0\\0\\0\\0\\0\", pad=None, padmode=PAD_PKCS5)\nd = k.encrypt(data)\nprint \"Encrypted: %r\" % d\nprint \"Decrypted: %r\" % k.decrypt(d)\nassert k.decrypt(d, padmode=PAD_PKCS5) == data\n\n\nSee the module source (pyDes.py) for more examples of use.\nYou can also run the pyDes.py file without and arguments to see a simple test.\n\nNote: This code was not written for high-end systems needing a fast\n implementation, but rather a handy portable solution with small usage.\n\n\"\"\"\n\nimport sys\n\n# _pythonMajorVersion is used to handle Python2 and Python3 differences.\n_pythonMajorVersion = sys.version_info[0]\n\n# Modes of crypting / cyphering\nECB =\t0\nCBC =\t1\n\n# Modes of padding\nPAD_NORMAL = 1\nPAD_PKCS5 = 2\n\n# PAD_PKCS5: is a method that will unambiguously remove all padding\n# characters after decryption, when originally encrypted with\n# this padding mode.\n# For a good description of the PKCS5 padding technique, see:\n# http://www.faqs.org/rfcs/rfc1423.html\n\n# The base class shared by des and triple des.\nclass _baseDes(object):\n\tdef __init__(self, mode=ECB, IV=None, pad=None, padmode=PAD_NORMAL):\n\t\tif IV:\n\t\t\tIV = self._guardAgainstUnicode(IV)\n\t\tif pad:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tself.block_size = 8\n\t\t# Sanity checking of arguments.\n\t\tif pad and padmode == PAD_PKCS5:\n\t\t\traise ValueError(\"Cannot use a pad character with PAD_PKCS5\")\n\t\tif IV and len(IV) != self.block_size:\n\t\t\traise ValueError(\"Invalid Initial Value (IV), must be a multiple of \" + str(self.block_size) + \" bytes\")\n\n\t\t# Set the passed in variables\n\t\tself._mode = mode\n\t\tself._iv = IV\n\t\tself._padding = pad\n\t\tself._padmode = padmode\n\n\tdef getKey(self):\n\t\t\"\"\"getKey() -> bytes\"\"\"\n\t\treturn self.__key\n\n\tdef setKey(self, key):\n\t\t\"\"\"Will set the crypting key for this object.\"\"\"\n\t\tkey = self._guardAgainstUnicode(key)\n\t\tself.__key = key\n\n\tdef getMode(self):\n\t\t\"\"\"getMode() -> pyDes.ECB or pyDes.CBC\"\"\"\n\t\treturn self._mode\n\n\tdef setMode(self, mode):\n\t\t\"\"\"Sets the type of crypting mode, pyDes.ECB or pyDes.CBC\"\"\"\n\t\tself._mode = mode\n\n\tdef getPadding(self):\n\t\t\"\"\"getPadding() -> bytes of length 1. Padding character.\"\"\"\n\t\treturn self._padding\n\n\tdef setPadding(self, pad):\n\t\t\"\"\"setPadding() -> bytes of length 1. Padding character.\"\"\"\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tself._padding = pad\n\n\tdef getPadMode(self):\n\t\t\"\"\"getPadMode() -> pyDes.PAD_NORMAL or pyDes.PAD_PKCS5\"\"\"\n\t\treturn self._padmode\n\t\t\n\tdef setPadMode(self, mode):\n\t\t\"\"\"Sets the type of padding mode, pyDes.PAD_NORMAL or pyDes.PAD_PKCS5\"\"\"\n\t\tself._padmode = mode\n\n\tdef getIV(self):\n\t\t\"\"\"getIV() -> bytes\"\"\"\n\t\treturn self._iv\n\n\tdef setIV(self, IV):\n\t\t\"\"\"Will set the Initial Value, used in conjunction with CBC mode\"\"\"\n\t\tif not IV or len(IV) != self.block_size:\n\t\t\traise ValueError(\"Invalid Initial Value (IV), must be a multiple of \" + str(self.block_size) + \" bytes\")\n\t\tIV = self._guardAgainstUnicode(IV)\n\t\tself._iv = IV\n\n\tdef _padData(self, data, pad, padmode):\n\t\t# Pad data depending on the mode\n\t\tif padmode is None:\n\t\t\t# Get the default padding mode.\n\t\t\tpadmode = self.getPadMode()\n\t\tif pad and padmode == PAD_PKCS5:\n\t\t\traise ValueError(\"Cannot use a pad character with PAD_PKCS5\")\n\n\t\tif padmode == PAD_NORMAL:\n\t\t\tif len(data) % self.block_size == 0:\n\t\t\t\t# No padding required.\n\t\t\t\treturn data\n\n\t\t\tif not pad:\n\t\t\t\t# Get the default padding.\n\t\t\t\tpad = self.getPadding()\n\t\t\tif not pad:\n\t\t\t\traise ValueError(\"Data must be a multiple of \" + str(self.block_size) + \" bytes in length. Use padmode=PAD_PKCS5 or set the pad character.\")\n\t\t\tdata += (self.block_size - (len(data) % self.block_size)) * pad\n\t\t\n\t\telif padmode == PAD_PKCS5:\n\t\t\tpad_len = 8 - (len(data) % self.block_size)\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\tdata += pad_len * chr(pad_len)\n\t\t\telse:\n\t\t\t\tdata += bytes([pad_len] * pad_len)\n\n\t\treturn data\n\n\tdef _unpadData(self, data, pad, padmode):\n\t\t# Unpad data depending on the mode.\n\t\tif not data:\n\t\t\treturn data\n\t\tif pad and padmode == PAD_PKCS5:\n\t\t\traise ValueError(\"Cannot use a pad character with PAD_PKCS5\")\n\t\tif padmode is None:\n\t\t\t# Get the default padding mode.\n\t\t\tpadmode = self.getPadMode()\n\n\t\tif padmode == PAD_NORMAL:\n\t\t\tif not pad:\n\t\t\t\t# Get the default padding.\n\t\t\t\tpad = self.getPadding()\n\t\t\tif pad:\n\t\t\t\tdata = data[:-self.block_size] + \\\n\t\t\t\t data[-self.block_size:].rstrip(pad)\n\n\t\telif padmode == PAD_PKCS5:\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\tpad_len = ord(data[-1])\n\t\t\telse:\n\t\t\t\tpad_len = data[-1]\n\t\t\tdata = data[:-pad_len]\n\n\t\treturn data\n\n\tdef _guardAgainstUnicode(self, data):\n\t\t# Only accept byte strings or ascii unicode values, otherwise\n\t\t# there is no way to correctly decode the data into bytes.\n\t\tif _pythonMajorVersion < 3:\n\t\t\tif isinstance(data, unicode):\n\t\t\t\traise ValueError(\"pyDes can only work with bytes, not Unicode strings.\")\n\t\telse:\n\t\t\tif isinstance(data, str):\n\t\t\t\t# Only accept ascii unicode values.\n\t\t\t\ttry:\n\t\t\t\t\treturn data.encode('ascii')\n\t\t\t\texcept UnicodeEncodeError:\n\t\t\t\t\tpass\n\t\t\t\traise ValueError(\"pyDes can only work with encoded strings, not Unicode.\")\n\t\treturn data\n\n#############################################################################\n# \t\t\t\t DES\t\t\t\t\t #\n#############################################################################\nclass des(_baseDes):\n\t\"\"\"DES encryption/decrytpion class\n\n\tSupports ECB (Electronic Code Book) and CBC (Cypher Block Chaining) modes.\n\n\tpyDes.des(key,[mode], [IV])\n\n\tkey -> Bytes containing the encryption key, must be exactly 8 bytes\n\tmode -> Optional argument for encryption type, can be either pyDes.ECB\n\t\t(Electronic Code Book), pyDes.CBC (Cypher Block Chaining)\n\tIV -> Optional Initial Value bytes, must be supplied if using CBC mode.\n\t\tMust be 8 bytes in length.\n\tpad -> Optional argument, set the pad character (PAD_NORMAL) to use\n\t\tduring all encrypt/decrpt operations done with this instance.\n\tpadmode -> Optional argument, set the padding mode (PAD_NORMAL or\n\t\tPAD_PKCS5) to use during all encrypt/decrpt operations done\n\t\twith this instance.\n\t\"\"\"\n\n\n\t# Permutation and translation tables for DES\n\t__pc1 = [56, 48, 40, 32, 24, 16, 8,\n\t\t 0, 57, 49, 41, 33, 25, 17,\n\t\t 9, 1, 58, 50, 42, 34, 26,\n\t\t 18, 10, 2, 59, 51, 43, 35,\n\t\t 62, 54, 46, 38, 30, 22, 14,\n\t\t 6, 61, 53, 45, 37, 29, 21,\n\t\t 13, 5, 60, 52, 44, 36, 28,\n\t\t 20, 12, 4, 27, 19, 11, 3\n\t]\n\n\t# number left rotations of pc1\n\t__left_rotations = [\n\t\t1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1\n\t]\n\n\t# permuted choice key (table 2)\n\t__pc2 = [\n\t\t13, 16, 10, 23, 0, 4,\n\t\t 2, 27, 14, 5, 20, 9,\n\t\t22, 18, 11, 3, 25, 7,\n\t\t15, 6, 26, 19, 12, 1,\n\t\t40, 51, 30, 36, 46, 54,\n\t\t29, 39, 50, 44, 32, 47,\n\t\t43, 48, 38, 55, 33, 52,\n\t\t45, 41, 49, 35, 28, 31\n\t]\n\n\t# initial permutation IP\n\t__ip = [57, 49, 41, 33, 25, 17, 9, 1,\n\t\t59, 51, 43, 35, 27, 19, 11, 3,\n\t\t61, 53, 45, 37, 29, 21, 13, 5,\n\t\t63, 55, 47, 39, 31, 23, 15, 7,\n\t\t56, 48, 40, 32, 24, 16, 8, 0,\n\t\t58, 50, 42, 34, 26, 18, 10, 2,\n\t\t60, 52, 44, 36, 28, 20, 12, 4,\n\t\t62, 54, 46, 38, 30, 22, 14, 6\n\t]\n\n\t# Expansion table for turning 32 bit blocks into 48 bits\n\t__expansion_table = [\n\t\t31, 0, 1, 2, 3, 4,\n\t\t 3, 4, 5, 6, 7, 8,\n\t\t 7, 8, 9, 10, 11, 12,\n\t\t11, 12, 13, 14, 15, 16,\n\t\t15, 16, 17, 18, 19, 20,\n\t\t19, 20, 21, 22, 23, 24,\n\t\t23, 24, 25, 26, 27, 28,\n\t\t27, 28, 29, 30, 31, 0\n\t]\n\n\t# The (in)famous S-boxes\n\t__sbox = [\n\t\t# S1\n\t\t[14, 4, 13, 1, 2, 15, 11, 8, 3, 10, 6, 12, 5, 9, 0, 7,\n\t\t 0, 15, 7, 4, 14, 2, 13, 1, 10, 6, 12, 11, 9, 5, 3, 8,\n\t\t 4, 1, 14, 8, 13, 6, 2, 11, 15, 12, 9, 7, 3, 10, 5, 0,\n\t\t 15, 12, 8, 2, 4, 9, 1, 7, 5, 11, 3, 14, 10, 0, 6, 13],\n\n\t\t# S2\n\t\t[15, 1, 8, 14, 6, 11, 3, 4, 9, 7, 2, 13, 12, 0, 5, 10,\n\t\t 3, 13, 4, 7, 15, 2, 8, 14, 12, 0, 1, 10, 6, 9, 11, 5,\n\t\t 0, 14, 7, 11, 10, 4, 13, 1, 5, 8, 12, 6, 9, 3, 2, 15,\n\t\t 13, 8, 10, 1, 3, 15, 4, 2, 11, 6, 7, 12, 0, 5, 14, 9],\n\n\t\t# S3\n\t\t[10, 0, 9, 14, 6, 3, 15, 5, 1, 13, 12, 7, 11, 4, 2, 8,\n\t\t 13, 7, 0, 9, 3, 4, 6, 10, 2, 8, 5, 14, 12, 11, 15, 1,\n\t\t 13, 6, 4, 9, 8, 15, 3, 0, 11, 1, 2, 12, 5, 10, 14, 7,\n\t\t 1, 10, 13, 0, 6, 9, 8, 7, 4, 15, 14, 3, 11, 5, 2, 12],\n\n\t\t# S4\n\t\t[7, 13, 14, 3, 0, 6, 9, 10, 1, 2, 8, 5, 11, 12, 4, 15,\n\t\t 13, 8, 11, 5, 6, 15, 0, 3, 4, 7, 2, 12, 1, 10, 14, 9,\n\t\t 10, 6, 9, 0, 12, 11, 7, 13, 15, 1, 3, 14, 5, 2, 8, 4,\n\t\t 3, 15, 0, 6, 10, 1, 13, 8, 9, 4, 5, 11, 12, 7, 2, 14],\n\n\t\t# S5\n\t\t[2, 12, 4, 1, 7, 10, 11, 6, 8, 5, 3, 15, 13, 0, 14, 9,\n\t\t 14, 11, 2, 12, 4, 7, 13, 1, 5, 0, 15, 10, 3, 9, 8, 6,\n\t\t 4, 2, 1, 11, 10, 13, 7, 8, 15, 9, 12, 5, 6, 3, 0, 14,\n\t\t 11, 8, 12, 7, 1, 14, 2, 13, 6, 15, 0, 9, 10, 4, 5, 3],\n\n\t\t# S6\n\t\t[12, 1, 10, 15, 9, 2, 6, 8, 0, 13, 3, 4, 14, 7, 5, 11,\n\t\t 10, 15, 4, 2, 7, 12, 9, 5, 6, 1, 13, 14, 0, 11, 3, 8,\n\t\t 9, 14, 15, 5, 2, 8, 12, 3, 7, 0, 4, 10, 1, 13, 11, 6,\n\t\t 4, 3, 2, 12, 9, 5, 15, 10, 11, 14, 1, 7, 6, 0, 8, 13],\n\n\t\t# S7\n\t\t[4, 11, 2, 14, 15, 0, 8, 13, 3, 12, 9, 7, 5, 10, 6, 1,\n\t\t 13, 0, 11, 7, 4, 9, 1, 10, 14, 3, 5, 12, 2, 15, 8, 6,\n\t\t 1, 4, 11, 13, 12, 3, 7, 14, 10, 15, 6, 8, 0, 5, 9, 2,\n\t\t 6, 11, 13, 8, 1, 4, 10, 7, 9, 5, 0, 15, 14, 2, 3, 12],\n\n\t\t# S8\n\t\t[13, 2, 8, 4, 6, 15, 11, 1, 10, 9, 3, 14, 5, 0, 12, 7,\n\t\t 1, 15, 13, 8, 10, 3, 7, 4, 12, 5, 6, 11, 0, 14, 9, 2,\n\t\t 7, 11, 4, 1, 9, 12, 14, 2, 0, 6, 10, 13, 15, 3, 5, 8,\n\t\t 2, 1, 14, 7, 4, 10, 8, 13, 15, 12, 9, 0, 3, 5, 6, 11],\n\t]\n\n\n\t# 32-bit permutation function P used on the output of the S-boxes\n\t__p = [\n\t\t15, 6, 19, 20, 28, 11,\n\t\t27, 16, 0, 14, 22, 25,\n\t\t4, 17, 30, 9, 1, 7,\n\t\t23,13, 31, 26, 2, 8,\n\t\t18, 12, 29, 5, 21, 10,\n\t\t3, 24\n\t]\n\n\t# final permutation IP^-1\n\t__fp = [\n\t\t39, 7, 47, 15, 55, 23, 63, 31,\n\t\t38, 6, 46, 14, 54, 22, 62, 30,\n\t\t37, 5, 45, 13, 53, 21, 61, 29,\n\t\t36, 4, 44, 12, 52, 20, 60, 28,\n\t\t35, 3, 43, 11, 51, 19, 59, 27,\n\t\t34, 2, 42, 10, 50, 18, 58, 26,\n\t\t33, 1, 41, 9, 49, 17, 57, 25,\n\t\t32, 0, 40, 8, 48, 16, 56, 24\n\t]\n\n\t# Type of crypting being done\n\tENCRYPT =\t0x00\n\tDECRYPT =\t0x01\n\n\t# Initialisation\n\tdef __init__(self, key, mode=ECB, IV=None, pad=None, padmode=PAD_NORMAL):\n\t\t# Sanity checking of arguments.\n\t\tif len(key) != 8:\n\t\t\traise ValueError(\"Invalid DES key size. Key must be exactly 8 bytes long.\")\n\t\t_baseDes.__init__(self, mode, IV, pad, padmode)\n\t\tself.key_size = 8\n\n\t\tself.L = []\n\t\tself.R = []\n\t\tself.Kn = [ [0] * 48 ] * 16\t# 16 48-bit keys (K1 - K16)\n\t\tself.final = []\n\n\t\tself.setKey(key)\n\n\tdef setKey(self, key):\n\t\t\"\"\"Will set the crypting key for this object. Must be 8 bytes.\"\"\"\n\t\t_baseDes.setKey(self, key)\n\t\tself.__create_sub_keys()\n\n\tdef __String_to_BitList(self, data):\n\t\t\"\"\"Turn the string data, into a list of bits (1, 0)'s\"\"\"\n\t\tif _pythonMajorVersion < 3:\n\t\t\t# Turn the strings into integers. Python 3 uses a bytes\n\t\t\t# class, which already has this behaviour.\n\t\t\tdata = [ord(c) for c in data]\n\t\tl = len(data) * 8\n\t\tresult = [0] * l\n\t\tpos = 0\n\t\tfor ch in data:\n\t\t\ti = 7\n\t\t\twhile i >= 0:\n\t\t\t\tif ch & (1 << i) != 0:\n\t\t\t\t\tresult[pos] = 1\n\t\t\t\telse:\n\t\t\t\t\tresult[pos] = 0\n\t\t\t\tpos += 1\n\t\t\t\ti -= 1\n\n\t\treturn result\n\n\tdef __BitList_to_String(self, data):\n\t\t\"\"\"Turn the list of bits -> data, into a string\"\"\"\n\t\tresult = []\n\t\tpos = 0\n\t\tc = 0\n\t\twhile pos < len(data):\n\t\t\tc += data[pos] << (7 - (pos % 8))\n\t\t\tif (pos % 8) == 7:\n\t\t\t\tresult.append(c)\n\t\t\t\tc = 0\n\t\t\tpos += 1\n\n\t\tif _pythonMajorVersion < 3:\n\t\t\treturn ''.join([ chr(c) for c in result ])\n\t\telse:\n\t\t\treturn bytes(result)\n\n\tdef __permutate(self, table, block):\n\t\t\"\"\"Permutate this block with the specified table\"\"\"\n\t\treturn list(map(lambda x: block[x], table))\n\t\n\t# Transform the secret key, so that it is ready for data processing\n\t# Create the 16 subkeys, K[1] - K[16]\n\tdef __create_sub_keys(self):\n\t\t\"\"\"Create the 16 subkeys K[1] to K[16] from the given key\"\"\"\n\t\tkey = self.__permutate(des.__pc1, self.__String_to_BitList(self.getKey()))\n\t\ti = 0\n\t\t# Split into Left and Right sections\n\t\tself.L = key[:28]\n\t\tself.R = key[28:]\n\t\twhile i < 16:\n\t\t\tj = 0\n\t\t\t# Perform circular left shifts\n\t\t\twhile j < des.__left_rotations[i]:\n\t\t\t\tself.L.append(self.L[0])\n\t\t\t\tdel self.L[0]\n\n\t\t\t\tself.R.append(self.R[0])\n\t\t\t\tdel self.R[0]\n\n\t\t\t\tj += 1\n\n\t\t\t# Create one of the 16 subkeys through pc2 permutation\n\t\t\tself.Kn[i] = self.__permutate(des.__pc2, self.L + self.R)\n\n\t\t\ti += 1\n\n\t# Main part of the encryption algorithm, the number cruncher :)\n\tdef __des_crypt(self, block, crypt_type):\n\t\t\"\"\"Crypt the block of data through DES bit-manipulation\"\"\"\n\t\tblock = self.__permutate(des.__ip, block)\n\t\tself.L = block[:32]\n\t\tself.R = block[32:]\n\n\t\t# Encryption starts from Kn[1] through to Kn[16]\n\t\tif crypt_type == des.ENCRYPT:\n\t\t\titeration = 0\n\t\t\titeration_adjustment = 1\n\t\t# Decryption starts from Kn[16] down to Kn[1]\n\t\telse:\n\t\t\titeration = 15\n\t\t\titeration_adjustment = -1\n\n\t\ti = 0\n\t\twhile i < 16:\n\t\t\t# Make a copy of R[i-1], this will later become L[i]\n\t\t\ttempR = self.R[:]\n\n\t\t\t# Permutate R[i - 1] to start creating R[i]\n\t\t\tself.R = self.__permutate(des.__expansion_table, self.R)\n\n\t\t\t# Exclusive or R[i - 1] with K[i], create B[1] to B[8] whilst here\n\t\t\tself.R = list(map(lambda x, y: x ^ y, self.R, self.Kn[iteration]))\n\t\t\tB = [self.R[:6], self.R[6:12], self.R[12:18], self.R[18:24], self.R[24:30], self.R[30:36], self.R[36:42], self.R[42:]]\n\t\t\t# Optimization: Replaced below commented code with above\n\t\t\t#j = 0\n\t\t\t#B = []\n\t\t\t#while j < len(self.R):\n\t\t\t#\tself.R[j] = self.R[j] ^ self.Kn[iteration][j]\n\t\t\t#\tj += 1\n\t\t\t#\tif j % 6 == 0:\n\t\t\t#\t\tB.append(self.R[j-6:j])\n\n\t\t\t# Permutate B[1] to B[8] using the S-Boxes\n\t\t\tj = 0\n\t\t\tBn = [0] * 32\n\t\t\tpos = 0\n\t\t\twhile j < 8:\n\t\t\t\t# Work out the offsets\n\t\t\t\tm = (B[j][0] << 1) + B[j][5]\n\t\t\t\tn = (B[j][1] << 3) + (B[j][2] << 2) + (B[j][3] << 1) + B[j][4]\n\n\t\t\t\t# Find the permutation value\n\t\t\t\tv = des.__sbox[j][(m << 4) + n]\n\n\t\t\t\t# Turn value into bits, add it to result: Bn\n\t\t\t\tBn[pos] = (v & 8) >> 3\n\t\t\t\tBn[pos + 1] = (v & 4) >> 2\n\t\t\t\tBn[pos + 2] = (v & 2) >> 1\n\t\t\t\tBn[pos + 3] = v & 1\n\n\t\t\t\tpos += 4\n\t\t\t\tj += 1\n\n\t\t\t# Permutate the concatination of B[1] to B[8] (Bn)\n\t\t\tself.R = self.__permutate(des.__p, Bn)\n\n\t\t\t# Xor with L[i - 1]\n\t\t\tself.R = list(map(lambda x, y: x ^ y, self.R, self.L))\n\t\t\t# Optimization: This now replaces the below commented code\n\t\t\t#j = 0\n\t\t\t#while j < len(self.R):\n\t\t\t#\tself.R[j] = self.R[j] ^ self.L[j]\n\t\t\t#\tj += 1\n\n\t\t\t# L[i] becomes R[i - 1]\n\t\t\tself.L = tempR\n\n\t\t\ti += 1\n\t\t\titeration += iteration_adjustment\n\t\t\n\t\t# Final permutation of R[16]L[16]\n\t\tself.final = self.__permutate(des.__fp, self.R + self.L)\n\t\treturn self.final\n\n\n\t# Data to be encrypted/decrypted\n\tdef crypt(self, data, crypt_type):\n\t\t\"\"\"Crypt the data in blocks, running it through des_crypt()\"\"\"\n\n\t\t# Error check the data\n\t\tif not data:\n\t\t\treturn ''\n\t\tif len(data) % self.block_size != 0:\n\t\t\tif crypt_type == des.DECRYPT: # Decryption must work on 8 byte blocks\n\t\t\t\traise ValueError(\"Invalid data length, data must be a multiple of \" + str(self.block_size) + \" bytes\\n.\")\n\t\t\tif not self.getPadding():\n\t\t\t\traise ValueError(\"Invalid data length, data must be a multiple of \" + str(self.block_size) + \" bytes\\n. Try setting the optional padding character\")\n\t\t\telse:\n\t\t\t\tdata += (self.block_size - (len(data) % self.block_size)) * self.getPadding()\n\t\t\t# print \"Len of data: %f\" % (len(data) / self.block_size)\n\n\t\tif self.getMode() == CBC:\n\t\t\tif self.getIV():\n\t\t\t\tiv = self.__String_to_BitList(self.getIV())\n\t\t\telse:\n\t\t\t\traise ValueError(\"For CBC mode, you must supply the Initial Value (IV) for ciphering\")\n\n\t\t# Split the data into blocks, crypting each one seperately\n\t\ti = 0\n\t\tdict = {}\n\t\tresult = []\n\t\t#cached = 0\n\t\t#lines = 0\n\t\twhile i < len(data):\n\t\t\t# Test code for caching encryption results\n\t\t\t#lines += 1\n\t\t\t#if dict.has_key(data[i:i+8]):\n\t\t\t\t#print \"Cached result for: %s\" % data[i:i+8]\n\t\t\t#\tcached += 1\n\t\t\t#\tresult.append(dict[data[i:i+8]])\n\t\t\t#\ti += 8\n\t\t\t#\tcontinue\n\t\t\t\t\n\t\t\tblock = self.__String_to_BitList(data[i:i+8])\n\n\t\t\t# Xor with IV if using CBC mode\n\t\t\tif self.getMode() == CBC:\n\t\t\t\tif crypt_type == des.ENCRYPT:\n\t\t\t\t\tblock = list(map(lambda x, y: x ^ y, block, iv))\n\t\t\t\t\t#j = 0\n\t\t\t\t\t#while j < len(block):\n\t\t\t\t\t#\tblock[j] = block[j] ^ iv[j]\n\t\t\t\t\t#\tj += 1\n\n\t\t\t\tprocessed_block = self.__des_crypt(block, crypt_type)\n\n\t\t\t\tif crypt_type == des.DECRYPT:\n\t\t\t\t\tprocessed_block = list(map(lambda x, y: x ^ y, processed_block, iv))\n\t\t\t\t\t#j = 0\n\t\t\t\t\t#while j < len(processed_block):\n\t\t\t\t\t#\tprocessed_block[j] = processed_block[j] ^ iv[j]\n\t\t\t\t\t#\tj += 1\n\t\t\t\t\tiv = block\n\t\t\t\telse:\n\t\t\t\t\tiv = processed_block\n\t\t\telse:\n\t\t\t\tprocessed_block = self.__des_crypt(block, crypt_type)\n\n\n\t\t\t# Add the resulting crypted block to our list\n\t\t\t#d = self.__BitList_to_String(processed_block)\n\t\t\t#result.append(d)\n\t\t\tresult.append(self.__BitList_to_String(processed_block))\n\t\t\t#dict[data[i:i+8]] = d\n\t\t\ti += 8\n\n\t\t# print \"Lines: %d, cached: %d\" % (lines, cached)\n\n\t\t# Return the full crypted string\n\t\tif _pythonMajorVersion < 3:\n\t\t\treturn ''.join(result)\n\t\telse:\n\t\t\treturn bytes.fromhex('').join(result)\n\n\tdef encrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"encrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : Bytes to be encrypted\n\t\tpad : Optional argument for encryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be encrypted\n\t\twith the already specified key. Data does not have to be a\n\t\tmultiple of 8 bytes if the padding character is supplied, or\n\t\tthe padmode is set to PAD_PKCS5, as bytes will then added to\n\t\tensure the be padded data is a multiple of 8 bytes.\n\t\t\"\"\"\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tdata = self._padData(data, pad, padmode)\n\t\treturn self.crypt(data, des.ENCRYPT)\n\n\tdef decrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"decrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : Bytes to be encrypted\n\t\tpad : Optional argument for decryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be decrypted\n\t\twith the already specified key. In PAD_NORMAL mode, if the\n\t\toptional padding character is supplied, then the un-encrypted\n\t\tdata will have the padding characters removed from the end of\n\t\tthe bytes. This pad removal only occurs on the last 8 bytes of\n\t\tthe data (last data block). In PAD_PKCS5 mode, the special\n\t\tpadding end markers will be removed from the data after decrypting.\n\t\t\"\"\"\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tdata = self.crypt(data, des.DECRYPT)\n\t\treturn self._unpadData(data, pad, padmode)\n\n\n\n#############################################################################\n# \t\t\t\tTriple DES\t\t\t\t #\n#############################################################################\nclass triple_des(_baseDes):\n\t\"\"\"Triple DES encryption/decrytpion class\n\n\tThis algorithm uses the DES-EDE3 (when a 24 byte key is supplied) or\n\tthe DES-EDE2 (when a 16 byte key is supplied) encryption methods.\n\tSupports ECB (Electronic Code Book) and CBC (Cypher Block Chaining) modes.\n\n\tpyDes.des(key, [mode], [IV])\n\n\tkey -> Bytes containing the encryption key, must be either 16 or\n\t 24 bytes long\n\tmode -> Optional argument for encryption type, can be either pyDes.ECB\n\t\t(Electronic Code Book), pyDes.CBC (Cypher Block Chaining)\n\tIV -> Optional Initial Value bytes, must be supplied if using CBC mode.\n\t\tMust be 8 bytes in length.\n\tpad -> Optional argument, set the pad character (PAD_NORMAL) to use\n\t\tduring all encrypt/decrpt operations done with this instance.\n\tpadmode -> Optional argument, set the padding mode (PAD_NORMAL or\n\t\tPAD_PKCS5) to use during all encrypt/decrpt operations done\n\t\twith this instance.\n\t\"\"\"\n\tdef __init__(self, key, mode=ECB, IV=None, pad=None, padmode=PAD_NORMAL):\n\t\t_baseDes.__init__(self, mode, IV, pad, padmode)\n\t\tself.setKey(key)\n\n\tdef setKey(self, key):\n\t\t\"\"\"Will set the crypting key for this object. Either 16 or 24 bytes long.\"\"\"\n\t\tself.key_size = 24 # Use DES-EDE3 mode\n\t\tif len(key) != self.key_size:\n\t\t\tif len(key) == 16: # Use DES-EDE2 mode\n\t\t\t\tself.key_size = 16\n\t\t\telse:\n\t\t\t\traise ValueError(\"Invalid triple DES key size. Key must be either 16 or 24 bytes long\")\n\t\tif self.getMode() == CBC:\n\t\t\tif not self.getIV():\n\t\t\t\t# Use the first 8 bytes of the key\n\t\t\t\tself._iv = key[:self.block_size]\n\t\t\tif len(self.getIV()) != self.block_size:\n\t\t\t\traise ValueError(\"Invalid IV, must be 8 bytes in length\")\n\t\tself.__key1 = des(key[:8], self._mode, self._iv,\n\t\t\t\t self._padding, self._padmode)\n\t\tself.__key2 = des(key[8:16], self._mode, self._iv,\n\t\t\t\t self._padding, self._padmode)\n\t\tif self.key_size == 16:\n\t\t\tself.__key3 = self.__key1\n\t\telse:\n\t\t\tself.__key3 = des(key[16:], self._mode, self._iv,\n\t\t\t\t\t self._padding, self._padmode)\n\t\t_baseDes.setKey(self, key)\n\n\t# Override setter methods to work on all 3 keys.\n\n\tdef setMode(self, mode):\n\t\t\"\"\"Sets the type of crypting mode, pyDes.ECB or pyDes.CBC\"\"\"\n\t\t_baseDes.setMode(self, mode)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setMode(mode)\n\n\tdef setPadding(self, pad):\n\t\t\"\"\"setPadding() -> bytes of length 1. Padding character.\"\"\"\n\t\t_baseDes.setPadding(self, pad)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setPadding(pad)\n\n\tdef setPadMode(self, mode):\n\t\t\"\"\"Sets the type of padding mode, pyDes.PAD_NORMAL or pyDes.PAD_PKCS5\"\"\"\n\t\t_baseDes.setPadMode(self, mode)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setPadMode(mode)\n\n\tdef setIV(self, IV):\n\t\t\"\"\"Will set the Initial Value, used in conjunction with CBC mode\"\"\"\n\t\t_baseDes.setIV(self, IV)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setIV(IV)\n\n\tdef encrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"encrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : bytes to be encrypted\n\t\tpad : Optional argument for encryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be encrypted\n\t\twith the already specified key. Data does not have to be a\n\t\tmultiple of 8 bytes if the padding character is supplied, or\n\t\tthe padmode is set to PAD_PKCS5, as bytes will then added to\n\t\tensure the be padded data is a multiple of 8 bytes.\n\t\t\"\"\"\n\t\tENCRYPT = des.ENCRYPT\n\t\tDECRYPT = des.DECRYPT\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\t# Pad the data accordingly.\n\t\tdata = self._padData(data, pad, padmode)\n\t\tif self.getMode() == CBC:\n\t\t\tself.__key1.setIV(self.getIV())\n\t\t\tself.__key2.setIV(self.getIV())\n\t\t\tself.__key3.setIV(self.getIV())\n\t\t\ti = 0\n\t\t\tresult = []\n\t\t\twhile i < len(data):\n\t\t\t\tblock = self.__key1.crypt(data[i:i+8], ENCRYPT)\n\t\t\t\tblock = self.__key2.crypt(block, DECRYPT)\n\t\t\t\tblock = self.__key3.crypt(block, ENCRYPT)\n\t\t\t\tself.__key1.setIV(block)\n\t\t\t\tself.__key2.setIV(block)\n\t\t\t\tself.__key3.setIV(block)\n\t\t\t\tresult.append(block)\n\t\t\t\ti += 8\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\treturn ''.join(result)\n\t\t\telse:\n\t\t\t\treturn bytes.fromhex('').join(result)\n\t\telse:\n\t\t\tdata = self.__key1.crypt(data, ENCRYPT)\n\t\t\tdata = self.__key2.crypt(data, DECRYPT)\n\t\t\treturn self.__key3.crypt(data, ENCRYPT)\n\n\tdef decrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"decrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : bytes to be encrypted\n\t\tpad : Optional argument for decryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be decrypted\n\t\twith the already specified key. In PAD_NORMAL mode, if the\n\t\toptional padding character is supplied, then the un-encrypted\n\t\tdata will have the padding characters removed from the end of\n\t\tthe bytes. This pad removal only occurs on the last 8 bytes of\n\t\tthe data (last data block). In PAD_PKCS5 mode, the special\n\t\tpadding end markers will be removed from the data after\n\t\tdecrypting, no pad character is required for PAD_PKCS5.\n\t\t\"\"\"\n\t\tENCRYPT = des.ENCRYPT\n\t\tDECRYPT = des.DECRYPT\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tif self.getMode() == CBC:\n\t\t\tself.__key1.setIV(self.getIV())\n\t\t\tself.__key2.setIV(self.getIV())\n\t\t\tself.__key3.setIV(self.getIV())\n\t\t\ti = 0\n\t\t\tresult = []\n\t\t\twhile i < len(data):\n\t\t\t\tiv = data[i:i+8]\n\t\t\t\tblock = self.__key3.crypt(iv, DECRYPT)\n\t\t\t\tblock = self.__key2.crypt(block, ENCRYPT)\n\t\t\t\tblock = self.__key1.crypt(block, DECRYPT)\n\t\t\t\tself.__key1.setIV(iv)\n\t\t\t\tself.__key2.setIV(iv)\n\t\t\t\tself.__key3.setIV(iv)\n\t\t\t\tresult.append(block)\n\t\t\t\ti += 8\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\tdata = ''.join(result)\n\t\t\telse:\n\t\t\t\tdata = bytes.fromhex('').join(result)\n\t\telse:\n\t\t\tdata = self.__key3.crypt(data, DECRYPT)\n\t\t\tdata = self.__key2.crypt(data, ENCRYPT)\n\t\t\tdata = self.__key1.crypt(data, DECRYPT)\n\t\treturn self._unpadData(data, pad, padmode)\n" }, { "path": "python2/smb/utils/rc4.py", "content": "\ndef RC4_encrypt(key, data):\n S = list(range(256))\n j = 0\n\n key_len = len(key)\n for i in list(range(256)):\n j = (j + S[i] + ord(key[i % key_len])) % 256\n S[i], S[j] = S[j], S[i]\n\n j = 0\n y = 0\n out = []\n\n for char in data:\n j = (j + 1) % 256\n y = (y + S[j]) % 256\n S[j], S[y] = S[y], S[j]\n\n out.append(chr(ord(char) ^ S[(S[j] + S[y]) % 256]))\n\n return ''.join(out)\n" }, { "path": "python2/smb/utils/sha256.py", "content": "__author__ = 'Thomas Dixon'\n__license__ = 'MIT'\n\nimport copy, struct, sys\n\ndigest_size = 32\nblocksize = 1\n\ndef new(m=None):\n return sha256(m)\n\nclass sha256(object):\n _k = (0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5,\n 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,\n 0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3,\n 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,\n 0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc,\n 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,\n 0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7,\n 0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,\n 0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13,\n 0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,\n 0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3,\n 0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,\n 0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5,\n 0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,\n 0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208,\n 0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2)\n _h = (0x6a09e667, 0xbb67ae85, 0x3c6ef372, 0xa54ff53a,\n 0x510e527f, 0x9b05688c, 0x1f83d9ab, 0x5be0cd19)\n _output_size = 8\n\n blocksize = 1\n block_size = 64\n digest_size = 32\n\n def __init__(self, m=None):\n self._buffer = ''\n self._counter = 0\n\n if m is not None:\n if type(m) is not str:\n raise TypeError, '%s() argument 1 must be string, not %s' % (self.__class__.__name__, type(m).__name__)\n self.update(m)\n\n def _rotr(self, x, y):\n return ((x >> y) | (x << (32-y))) & 0xFFFFFFFF\n\n def _sha256_process(self, c):\n w = [0]*64\n w[0:15] = struct.unpack('!16L', c)\n\n for i in range(16, 64):\n s0 = self._rotr(w[i-15], 7) ^ self._rotr(w[i-15], 18) ^ (w[i-15] >> 3)\n s1 = self._rotr(w[i-2], 17) ^ self._rotr(w[i-2], 19) ^ (w[i-2] >> 10)\n w[i] = (w[i-16] + s0 + w[i-7] + s1) & 0xFFFFFFFF\n\n a,b,c,d,e,f,g,h = self._h\n\n for i in range(64):\n s0 = self._rotr(a, 2) ^ self._rotr(a, 13) ^ self._rotr(a, 22)\n maj = (a & b) ^ (a & c) ^ (b & c)\n t2 = s0 + maj\n s1 = self._rotr(e, 6) ^ self._rotr(e, 11) ^ self._rotr(e, 25)\n ch = (e & f) ^ ((~e) & g)\n t1 = h + s1 + ch + self._k[i] + w[i]\n\n h = g\n g = f\n f = e\n e = (d + t1) & 0xFFFFFFFF\n d = c\n c = b\n b = a\n a = (t1 + t2) & 0xFFFFFFFF\n\n self._h = [(x+y) & 0xFFFFFFFF for x,y in zip(self._h, [a,b,c,d,e,f,g,h])]\n\n def update(self, m):\n if not m:\n return\n if type(m) is not str:\n raise TypeError, '%s() argument 1 must be string, not %s' % (sys._getframe().f_code.co_name, type(m).__name__)\n\n self._buffer += m\n self._counter += len(m)\n\n while len(self._buffer) >= 64:\n self._sha256_process(self._buffer[:64])\n self._buffer = self._buffer[64:]\n\n def digest(self):\n mdi = self._counter & 0x3F\n length = struct.pack('!Q', self._counter<<3)\n\n if mdi < 56:\n padlen = 55-mdi\n else:\n padlen = 119-mdi\n\n r = self.copy()\n r.update('\\x80'+('\\x00'*padlen)+length)\n return ''.join([struct.pack('!L', i) for i in r._h[:self._output_size]])\n\n def hexdigest(self):\n return self.digest().encode('hex')\n\n def copy(self):\n return copy.deepcopy(self)\n" }, { "path": "python2/tests/DirectSMBConnectionTests/__init__.py", "content": "" }, { "path": "python2/tests/DirectSMBConnectionTests/test_SMBHandler.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, urllib, urllib2, time, random\nfrom StringIO import StringIO\nfrom smb.SMBHandler import SMBHandler\nimport util\n\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\n\n\ndef test_basic():\n # Basic test for smb URLs\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/rfc1001.txt' % util.getConnectionInfo())\n\n s = fh.read()\n md = MD5()\n md.update(s)\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert len(s) == 158437\n\n fh.close()\n\n\ndef test_unicode():\n # Test smb URLs with unicode paths\n director = urllib2.build_opener(SMBHandler)\n fh = director.open(u'smb://%(user)s:%(password)s@%(server_ip)s/smbtest/测试文件夹/垃圾文件.dat' % util.getConnectionInfo())\n\n s = fh.read()\n md = MD5()\n md.update(s)\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert len(s) == 256000\n\n fh.close()\n\n\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\ndef test_upload():\n info = util.getConnectionInfo()\n info['filename'] = os.sep + 'StoreTest-%d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n director = urllib2.build_opener(SMBHandler)\n upload_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info, data = open(TEST_FILENAME, 'rb'))\n\n retr_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info)\n\n s = retr_fh.read()\n md = MD5()\n md.update(s)\n\n assert md.hexdigest() == TEST_DIGEST\n assert len(s) == TEST_FILESIZE\n\n\ndef test_overwrite():\n info = util.getConnectionInfo()\n info['filename'] = os.sep + 'StoreTest-%d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n test_s = 'test1234'\n test_md = MD5()\n test_md.update(test_s)\n\n director = urllib2.build_opener(SMBHandler)\n upload_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info, data = StringIO(test_s))\n\n retr_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info)\n\n s = retr_fh.read()\n md = MD5()\n md.update(s)\n\n assert md.hexdigest() == test_md.hexdigest()\n assert len(s) == len(test_s)\n\n upload_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info, data = open(TEST_FILENAME, 'rb'))\n\n retr_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info)\n\n s = retr_fh.read()\n md = MD5()\n md.update(s)\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_auth.py", "content": "\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn, conn2, conn3 = None, None, None\n\ndef teardown_func():\n global conn, conn2, conn3\n if conn:\n conn.close()\n if conn2:\n conn2.close()\n if conn3:\n conn3.close();\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv1_auth_SMB1():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv1_auth_SMB1_callable_password():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], lambda: info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv2_auth_SMB1():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv1_auth_SMB2():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv2_auth_SMB2():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_createdeletedirectory.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_english_directory_SMB1():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_english_directory_SMB2():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_unicode_directory_SMB1():\n global conn\n\n path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_unicode_directory_SMB2():\n global conn\n\n path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_echo.py", "content": "\nimport random\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\n\nconn = None\n\ndef setup_func():\n global conn\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func, teardown_func)\ndef test_echo():\n global conn\n\n data = '%d' % random.randint(1000, 9999)\n assert conn.echo(data) == data\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_listpath.py", "content": "# -*- coding: utf-8 -*-\n\nfrom smb.SMBConnection import SMBConnection\nfrom smb.smb_constants import *\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( u'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( u'TestDir1', True ) in filenames # Test short English folder names\n assert ( u'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( u'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listSubPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathWithManyFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames)==999\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( u'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( u'TestDir1', True ) in filenames # Test short English folder names\n assert ( u'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( u'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listSubPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathWithManyFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames)==999\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterForDirectory_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterForDirectory_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterForFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterForFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterPattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterPattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterUnicodePattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterUnicodePattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_listshares.py", "content": "\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listshares_SMB1():\n global conn\n results = conn.listShares()\n assert 'smbtest' in map(lambda r: r.name.lower(), results)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listshares_SMB2():\n global conn\n results = conn.listShares()\n assert 'smbtest' in map(lambda r: r.name.lower(), results)\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_listsnapshots.py", "content": "\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listsnapshots_SMB1():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listsnapshots_SMB2():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_rename.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_english_file_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_english_file_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_unicode_file_SMB1():\n global conn\n\n old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_unicode_file_SMB2():\n global conn\n\n old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_english_directory_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_english_directory_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_unicode_directory_SMB1():\n global conn\n\n old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_unicode_directory_SMB2():\n global conn\n\n old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_retrievefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_multiplereads_SMB1():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_multiplereads_SMB2():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_longfilename_SMB1():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_longfilename_SMB2():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_unicodefilename_SMB1():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_unicodefilename_SMB2():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_SMB1():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_SMB2():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_and_biglimit_SMB1():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_and_biglimit_SMB2():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_and_smalllimit_SMB1():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_and_smalllimit_SMB2():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_and_zerolimit_SMB1():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_and_zerolimit_SMB2():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n" }, { "path": "python2/tests/DirectSMBConnectionTests/test_storefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile, random, time\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_store_long_filename_SMB1():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_store_long_filename_SMB2():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_store_unicode_filename_SMB1():\n filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_store_unicode_filename_SMB2():\n filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n" }, { "path": "python2/tests/DirectSMBConnectionTests/util.py", "content": "\nimport os\nfrom ConfigParser import ConfigParser\n\ndef getConnectionInfo():\n config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini')\n cp = ConfigParser()\n cp.read(config_filename)\n\n info = {\n 'server_name': cp.get('server', 'name'),\n 'server_ip': cp.get('server', 'ip'),\n 'server_port': cp.getint('server', 'direct_port'),\n 'client_name': cp.get('client', 'name'),\n 'user': cp.get('user', 'name'),\n 'password': cp.get('user', 'password'),\n 'is_direct_tcp': True,\n }\n return info\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_auth.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass AuthFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n self.d.callback(True)\n\n def onAuthFailed(self):\n self.d.callback(False)\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv1_auth_SMB1():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv2_auth_SMB1():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv1_auth_SMB2():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv2_auth_SMB2():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_createdeletedirectory.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, random, time\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass DirectoryFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service_name = ''\n self.path = ''\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def createDone(self, result):\n d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep)))\n d.addCallback(self.listComplete)\n d.addErrback(self.d.errback)\n\n def listComplete(self, entries):\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(self.path.replace('/', os.sep)) in names\n\n d = self.deleteDirectory(self.service_name, self.path)\n d.addCallback(self.deleteDone)\n d.addErrback(self.d.errback)\n\n def deleteDone(self, result):\n d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep)))\n d.addCallback(self.list2Complete)\n d.addErrback(self.d.errback)\n\n def list2Complete(self, entries):\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(self.path.replace('/', os.sep)) not in names\n self.d.callback(True)\n\n def onAuthOK(self):\n d = self.createDirectory(self.service_name, self.path)\n d.addCallback(self.createDone)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_english_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_english_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_unicode_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_unicode_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_echo.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom util import getConnectionInfo\n\n\nclass EchoFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.echo_data = 'This is an echo test'\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(data):\n assert data == self.echo_data\n self.d.callback(True)\n\n d = self.echo(self.echo_data)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_echo():\n info = getConnectionInfo()\n factory = EchoFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_listpath.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass ListPathFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(results):\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( u'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( u'TestDir1', True ) in filenames # Test short English folder names\n assert ( u'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( u'rfc1001.txt', False ) in filenames # Test short English file names\n\n self.d.callback(True)\n\n d = self.listPath('smbtest', '/', timeout = 15)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_listPath_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_listPath_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_listshares.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass ListSharesFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(results):\n assert 'smbtest' in map(lambda r: r.name.lower(), results)\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n d = self.listShares(timeout = 15)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_listsnapshots.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass ListSnapshotsFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service_name = None\n self.path = None\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(results):\n assert len(results) > 0\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n d = self.listSnapshots(self.service_name, self.path, timeout = 15)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = '/rfc1001.txt'\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = '/rfc1001.txt'\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_rename.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, random, time\nfrom StringIO import StringIO\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass RenameFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service = ''\n self.new_path = ''\n self.old_path = ''\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def pathCreated(self, result):\n d = self.listPath(self.service, os.path.dirname(self.old_path.replace('/', os.sep)))\n d.addCallback(self.listComplete)\n d.addErrback(self.d.errback)\n\n def listComplete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(self.new_path.replace('/', os.sep)) not in filenames\n\n d = self.rename(self.service, self.old_path, self.new_path)\n d.addCallback(self.renameComplete)\n d.addErrback(self.d.errback)\n\n def renameComplete(self, result):\n d = self.listPath(self.service, os.path.dirname(self.new_path.replace('/', os.sep)))\n d.addCallback(self.list2Complete)\n d.addErrback(self.d.errback)\n\n def list2Complete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.new_path.replace('/', os.sep)) in filenames\n assert os.path.basename(self.old_path.replace('/', os.sep)) not in filenames\n self.cleanup()\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\nclass RenameFileFactory(RenameFactory):\n\n def onAuthOK(self):\n d = self.storeFile(self.service, self.old_path, StringIO('Rename file test'))\n d.addCallback(self.pathCreated)\n d.addErrback(self.d.errback)\n\n def cleanup(self):\n d = self.deleteFiles(self.service, self.new_path)\n d.chainDeferred(self.d)\n\n\nclass RenameDirectoryFactory(RenameFactory):\n\n def onAuthOK(self):\n d = self.createDirectory(self.service, self.old_path)\n d.addCallback(self.pathCreated)\n d.addErrback(self.d.errback)\n\n def cleanup(self):\n d = self.deleteDirectory(self.service, self.new_path)\n d.chainDeferred(self.d)\n\n\n@deferred(timeout=30.0)\ndef test_rename_english_file_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_english_file_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_file_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_file_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_english_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_english_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_retrievefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\n\nclass RetrieveFileFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.temp_fh = tempfile.NamedTemporaryFile(prefix = 'pysmbtest-')\n self.service = ''\n self.path = ''\n self.digest = ''\n self.offset = 0\n self.max_length = -1\n self.filesize = 0\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def fileRetrieved(self, write_result):\n file_obj, file_attributes, file_size = write_result\n assert file_obj == self.temp_fh\n\n md = MD5()\n filesize = 0\n self.temp_fh.seek(0)\n while True:\n s = self.temp_fh.read(8192)\n if not s:\n break\n md.update(s)\n filesize += len(s)\n\n assert self.filesize == filesize\n assert md.hexdigest() == self.digest\n\n self.temp_fh.close()\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n def onAuthOK(self):\n assert self.service\n assert self.path\n\n d = self.retrieveFileFromOffset(self.service, self.path, self.temp_fh, self.offset, self.max_length, timeout = 15)\n d.addCallback(self.fileRetrieved)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=30.0)\ndef test_retr_multiplereads_SMB1():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/rfc1001.txt'\n factory.digest = '5367c2bbf97f521059c78eab65309ad3'\n factory.filesize = 158437\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_multiplereads_SMB2():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/rfc1001.txt'\n factory.digest = '5367c2bbf97f521059c78eab65309ad3'\n factory.filesize = 158437\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_longfilename_SMB1():\n # Test file retrieval that has a long English filename\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/Implementing CIFS - SMB.html'\n factory.digest = '671c5700d279fcbbf958c1bba3c2639e'\n factory.filesize = 421269\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_longfilename_SMB2():\n # Test file retrieval that has a long English filename\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/Implementing CIFS - SMB.html'\n factory.digest = '671c5700d279fcbbf958c1bba3c2639e'\n factory.filesize = 421269\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_unicodefilename_SMB1():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '8a44c1e80d55e91c92350955cdf83442'\n factory.filesize = 256000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_unicodefilename_SMB2():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '8a44c1e80d55e91c92350955cdf83442'\n factory.filesize = 256000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_SMB1():\n # Test file retrieval from offset to EOF\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n factory.filesize = 156000\n factory.offset = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_SMB2():\n # Test file retrieval from offset to EOF\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n factory.filesize = 156000\n factory.offset = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_biglimit_SMB1():\n # Test file retrieval from offset with a big max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5'\n factory.filesize = 100000\n factory.offset = 100000\n factory.max_length = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_biglimit_SMB2():\n # Test file retrieval from offset with a big max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5'\n factory.filesize = 100000\n factory.offset = 100000\n factory.max_length = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_smalllimit_SMB1():\n # Test file retrieval from offset with a small max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '746f60a96b39b712a7b6e17ddde19986'\n factory.filesize = 10\n factory.offset = 100000\n factory.max_length = 10\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_smalllimit_SMB2():\n # Test file retrieval from offset with a small max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '746f60a96b39b712a7b6e17ddde19986'\n factory.filesize = 10\n factory.offset = 100000\n factory.max_length = 10\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_zerolimit_SMB1():\n # Test file retrieval from offset to EOF with max_length=0\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'd41d8cd98f00b204e9800998ecf8427e'\n factory.filesize = 0\n factory.offset = 100000\n factory.max_length = 0\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_zerolimit_SMB2():\n # Test file retrieval from offset to EOF with max_length=0\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n \n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'd41d8cd98f00b204e9800998ecf8427e'\n factory.filesize = 0\n factory.offset = 100000\n factory.max_length = 0\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/test_storefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom StringIO import StringIO\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nclass StoreFilesFactory(SMBProtocolFactory):\n \"\"\"\n A super test factory that tests store file, list files, retrieve file and delete file functionlities in sequence.\n \"\"\"\n\n TEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\n TEST_FILESIZE = 256000\n TEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service_name = ''\n self.filename = ''\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def storeComplete(self, result):\n file_obj, filesize = result\n file_obj.close()\n assert filesize == self.TEST_FILESIZE\n\n d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep)))\n d.addCallback(self.listComplete)\n d.addErrback(self.d.errback)\n\n def listComplete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.filename.replace('/', os.sep)) in filenames\n\n for entry in entries:\n if os.path.basename(self.filename.replace('/', os.sep)) == entry.filename:\n # The following asserts will fail if the remote machine's time is not in sync with the test machine's time\n assert abs(entry.create_time - time.time()) < 3\n assert abs(entry.last_access_time - time.time()) < 3\n assert abs(entry.last_write_time - time.time()) < 3\n assert abs(entry.last_attr_change_time - time.time()) < 3\n break\n\n d = self.retrieveFile(self.service_name, self.filename, StringIO())\n d.addCallback(self.retrieveComplete)\n d.addErrback(self.d.errback)\n\n def retrieveComplete(self, result):\n file_obj, file_attributes, file_size = result\n\n md = MD5()\n md.update(file_obj.getvalue())\n file_obj.close()\n\n assert file_size == self.TEST_FILESIZE\n assert md.hexdigest() == self.TEST_DIGEST\n\n d = self.deleteFiles(self.service_name, self.filename)\n d.addCallback(self.deleteComplete)\n d.addErrback(self.d.errback)\n\n def deleteComplete(self, result):\n d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep)))\n d.addCallback(self.list2Complete)\n d.addErrback(self.d.errback)\n\n def list2Complete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.filename.replace('/', os.sep)) not in filenames\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n def onAuthOK(self):\n d = self.storeFile(self.service_name, self.filename, open(self.TEST_FILENAME, 'rb'))\n d.addCallback(self.storeComplete)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=30.0)\ndef test_store_long_filename_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_store_long_filename_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_store_unicode_filename_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_store_unicode_filename_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/DirectSMBTwistedTests/util.py", "content": "\nimport os\nfrom ConfigParser import ConfigParser\n\ndef getConnectionInfo():\n config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini')\n cp = ConfigParser()\n cp.read(config_filename)\n\n info = {\n 'server_name': cp.get('server', 'name'),\n 'server_ip': cp.get('server', 'ip'),\n 'server_port': cp.getint('server', 'direct_port'),\n 'client_name': cp.get('client', 'name'),\n 'user': cp.get('user', 'name'),\n 'password': cp.get('user', 'password'),\n 'is_direct_tcp': True,\n }\n return info\n" }, { "path": "python2/tests/NetBIOSTests/__init__.py", "content": "" }, { "path": "python2/tests/NetBIOSTests/test_queryname.py", "content": "\nfrom nmb.NetBIOS import NetBIOS\nfrom nose.tools import with_setup\n\nconn = None\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(teardown = teardown_func)\ndef test_broadcast():\n global conn\n conn = NetBIOS()\n assert conn.queryName('MICHAEL-I5PC', timeout = 10)\n\n" }, { "path": "python2/tests/NetBIOSTwistedTests/__init__.py", "content": "" }, { "path": "python2/tests/NetBIOSTwistedTests/test_queryname.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom nmb.NetBIOSProtocol import NBNSProtocol\nfrom nose.tools import with_setup\n\n\n@deferred(timeout=15.0)\ndef test_broadcast():\n def cb(results):\n assert results\n\n def cleanup(r):\n p.transport.stopListening()\n\n p = NBNSProtocol()\n d = p.queryName('MICHAEL-I5PC', timeout = 10)\n d.addCallback(cb)\n d.addBoth(cleanup)\n\n return d\n" }, { "path": "python2/tests/README.md", "content": "\nSteps to Follow to Run the Unit Tests\n=====================================\n\n## Step 1: Install system dependencies ##\n\nIf you are using Ubuntu 20.04 LTS, you can install the system dependencies with the following command\n```\n$> apt-get install virtualenv python-dev gcc g++ make automake autoconf\n```\nFor other distributions, you can use their package managers and install the system dependencies (although the package names might differ slightly).\n\n## Step 2: Setup python virtualenv ##\n\nWe will create a python2 virtualenv and install the python dependencies for testing in the \"venv2\" folder.\n\n```\n$> cd /python2\n$> virtualenv -p /usr/bin/python2 venv2\n$> source venv2/bin/activate\n$venv2> pip install nose pyasn1 twisted\n```\n\n## Step 3: Setup shared folder on your remote SMB server ##\n\nPrepare a shared folder called \"smbtest\" on your remote SMB server (Windows or Samba). \n\nThen, download [smbtest.zip](https://miketeo.net/files/Projects/pysmb/smbtest.zip) and unzip the contents of this zip file in the shared folder.\n\nYou should also configure a user on the SMB server with read-write access to the \"smbtest\" folder.\n\n## Step 4: Update connection details in connection.ini ##\n\nIn the same folder where you are viewing this readme file, there should be an ini file called \"connection.ini\". Edit this file's connection details to match the shared folder's access information.\n\n## Step 5: Run the unit tests in the python2 folder ##\n\nBefore running the tests, the venv2 virtualenv must be activated.\n```\n$> cd /python2\n$> source venv2/bin/activate\n```\n\nTo run all the tests:\n```\n $venv2> nosetests -v tests\n```\n\nTo selectively run some tests: \n```\n $venv2> nosetests -v tests/SMBConnectionTests\n $venv2> nosetests -v tests/SMBConnectionTests/test_rename.py\n $venv2> nosetests -v tests/SMBConnectionTests/test_rename.py:test_rename_english_file_SMB1\n```\n\nFor more information, please consult the [documentation for nose](https://nose.readthedocs.io/).\n\n\n" }, { "path": "python2/tests/SMBConnectionTests/__init__.py", "content": "" }, { "path": "python2/tests/SMBConnectionTests/test_SMBHandler.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, urllib, urllib2, time, random\nfrom StringIO import StringIO\nfrom smb.SMBHandler import SMBHandler\nimport util\n\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\n\n\ndef test_basic():\n # Basic test for smb URLs\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/rfc1001.txt' % util.getConnectionInfo())\n\n s = fh.read()\n md = MD5()\n md.update(s)\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert len(s) == 158437\n\n fh.close()\n\n\ndef test_unicode():\n # Test smb URLs with unicode paths\n director = urllib2.build_opener(SMBHandler)\n fh = director.open(u'smb://%(user)s:%(password)s@%(server_ip)s/smbtest/测试文件夹/垃圾文件.dat' % util.getConnectionInfo())\n\n s = fh.read()\n md = MD5()\n md.update(s)\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert len(s) == 256000\n\n fh.close()\n\n\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\ndef test_upload():\n info = util.getConnectionInfo()\n info['filename'] = os.sep + 'StoreTest-%d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n director = urllib2.build_opener(SMBHandler)\n upload_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info, data = open(TEST_FILENAME, 'rb'))\n\n retr_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info)\n\n s = retr_fh.read()\n md = MD5()\n md.update(s)\n\n assert md.hexdigest() == TEST_DIGEST\n assert len(s) == TEST_FILESIZE\n\n" }, { "path": "python2/tests/SMBConnectionTests/test_auth.py", "content": "\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn, conn2, conn3 = None, None, None\n\ndef teardown_func():\n global conn, conn2, conn3\n if conn:\n conn.close()\n if conn2:\n conn2.close()\n if conn3:\n conn3.close();\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv1_auth_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv2_auth_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv1_auth_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_setup(teardown = teardown_func)\ndef test_NTLMv2_auth_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n" }, { "path": "python2/tests/SMBConnectionTests/test_createdeletedirectory.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_english_directory_SMB1():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_english_directory_SMB2():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_unicode_directory_SMB1():\n global conn\n\n path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_unicode_directory_SMB2():\n global conn\n\n path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(path.replace('/', os.sep)) not in names\n" }, { "path": "python2/tests/SMBConnectionTests/test_deletepattern.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_delete_without_subfolder_SMB1():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, StringIO(\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, StringIO(\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt')\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*')\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_delete_with_subfolder_SMB1():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, StringIO(\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, StringIO(\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' not in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_delete_without_subfolder_SMB2():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, StringIO(\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, StringIO(\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt')\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*')\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_delete_with_subfolder_SMB2():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, StringIO(\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, StringIO(\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = map(lambda r: r.filename, results)\n assert 'aaTest.Folder' not in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n" }, { "path": "python2/tests/SMBConnectionTests/test_echo.py", "content": "\nimport random\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\n\nconn = None\n\ndef setup_func():\n global conn\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func, teardown_func)\ndef test_echo():\n global conn\n\n data = '%d' % random.randint(1000, 9999)\n assert conn.echo(data) == data\n \n" }, { "path": "python2/tests/SMBConnectionTests/test_getattributes.py", "content": "# -*- coding: utf-8 -*-\n\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n \n@with_setup(setup_func_SMB2, teardown_func)\ndef test_getAttributes_SMB2():\n global conn\n info = conn.getAttributes('smbtest', '/Test Folder with Long Name/')\n assert info.isDirectory\n \n info = conn.getAttributes('smbtest', '/rfc1001.txt')\n assert not info.isDirectory\n assert info.file_size == 158437\n assert info.alloc_size == 159744\n \n info = conn.getAttributes('smbtest', u'/\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939')\n assert info.isDirectory\n \n@with_setup(setup_func_SMB1, teardown_func)\ndef test_getAttributes_SMB1():\n global conn\n info = conn.getAttributes('smbtest', '/Test Folder with Long Name/')\n assert info.isDirectory\n \n info = conn.getAttributes('smbtest', '/rfc1001.txt')\n assert not info.isDirectory\n assert info.file_size == 158437\n assert info.alloc_size == 159744\n \n info = conn.getAttributes('smbtest', u'/\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939')\n assert info.isDirectory\n \n " }, { "path": "python2/tests/SMBConnectionTests/test_listpath.py", "content": "# -*- coding: utf-8 -*-\n\nfrom smb.SMBConnection import SMBConnection\nfrom smb.smb_constants import *\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( u'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( u'TestDir1', True ) in filenames # Test short English folder names\n assert ( u'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( u'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listSubPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathWithManyFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames)==999\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( u'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( u'TestDir1', True ) in filenames # Test short English folder names\n assert ( u'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( u'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listSubPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathWithManyFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames)==999\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterForDirectory_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterForDirectory_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterForFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterForFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterPattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterPattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterUnicodePattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterUnicodePattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listPathFilterEmptyList_SMB1():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listPathFilterEmptyList_SMB2():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n" }, { "path": "python2/tests/SMBConnectionTests/test_listshares.py", "content": "\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listshares_SMB1():\n global conn\n results = conn.listShares()\n assert 'smbtest' in map(lambda r: r.name.lower(), results)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listshares_SMB2():\n global conn\n results = conn.listShares()\n assert 'smbtest' in map(lambda r: r.name.lower(), results)\n" }, { "path": "python2/tests/SMBConnectionTests/test_listsnapshots.py", "content": "\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_listsnapshots_SMB1():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_listsnapshots_SMB2():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n" }, { "path": "python2/tests/SMBConnectionTests/test_rename.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_english_file_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_english_file_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_unicode_file_SMB1():\n global conn\n\n old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_unicode_file_SMB2():\n global conn\n\n old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, StringIO('Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_english_directory_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_english_directory_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_rename_unicode_directory_SMB1():\n global conn\n\n old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_rename_unicode_directory_SMB2():\n global conn\n\n old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n" }, { "path": "python2/tests/SMBConnectionTests/test_retrievefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_multiplereads_SMB1():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_multiplereads_SMB2():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_longfilename_SMB1():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_longfilename_SMB2():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_unicodefilename_SMB1():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_unicodefilename_SMB2():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_SMB1():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_SMB2():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_and_biglimit_SMB1():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_and_biglimit_SMB2():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_and_smalllimit_SMB1():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_and_smalllimit_SMB2():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_retr_offset_and_zerolimit_SMB1():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_retr_offset_and_zerolimit_SMB2():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = StringIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', u'/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n" }, { "path": "python2/tests/SMBConnectionTests/test_security.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_security_SMB2():\n global conn\n # TODO: Need a way to setup the environment on the remote server and perform some verification on the returned results.\n attributes = conn.getSecurity('smbtest', '/rfc1001.txt')\n" }, { "path": "python2/tests/SMBConnectionTests/test_storefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile, random, time\nfrom StringIO import StringIO\nfrom smb.SMBConnection import SMBConnection\nfrom util import getConnectionInfo\nfrom nose.tools import with_setup\nfrom smb import smb_structs\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_store_long_filename_SMB1():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_store_from_offset_SMB1():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n buf = StringIO('0123456789')\n filesize = conn.storeFile('smbtest', filename, buf)\n assert filesize == 10\n\n buf = StringIO('aa')\n pos = conn.storeFileFromOffset('smbtest', filename, buf, 5)\n assert pos == 7\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == 10\n assert buf.getvalue() == '01234aa789'\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_store_long_filename_SMB2():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB1, teardown_func)\ndef test_store_unicode_filename_SMB1():\n filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_store_unicode_filename_SMB2():\n filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n@with_setup(setup_func_SMB2, teardown_func)\ndef test_store_from_offset_SMB2():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n buf = StringIO('0123456789')\n filesize = conn.storeFile('smbtest', filename, buf)\n assert filesize == 10\n\n buf = StringIO('aa')\n pos = conn.storeFileFromOffset('smbtest', filename, buf, 5)\n assert pos == 7\n\n buf = StringIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == 10\n assert buf.getvalue() == '01234aa789'\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n " }, { "path": "python2/tests/SMBConnectionTests/test_with_context.py", "content": "# -*- coding: utf-8 -*-\n\nfrom smb.SMBConnection import SMBConnection\nfrom .util import getConnectionInfo\n\ndef test_context():\n info = getConnectionInfo()\n with SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) as conn:\n assert conn.connect(info['server_ip'], info['server_port'])\n\n assert conn.sock is None\n" }, { "path": "python2/tests/SMBConnectionTests/util.py", "content": "\nimport os\nfrom ConfigParser import ConfigParser\n\ndef getConnectionInfo():\n config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini')\n cp = ConfigParser()\n cp.read(config_filename)\n\n info = {\n 'server_name': cp.get('server', 'name'),\n 'server_ip': cp.get('server', 'ip'),\n 'server_port': cp.getint('server', 'port'),\n 'client_name': cp.get('client', 'name'),\n 'user': cp.get('user', 'name'),\n 'password': cp.get('user', 'password'),\n 'domain': cp.get('user', 'domain')\n }\n return info\n" }, { "path": "python2/tests/SMBTwistedTests/__init__.py", "content": "" }, { "path": "python2/tests/SMBTwistedTests/test_auth.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass AuthFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n self.d.callback(True)\n\n def onAuthFailed(self):\n self.d.callback(False)\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv1_auth_SMB1():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv2_auth_SMB1():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv1_auth_SMB2():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n\n@deferred(timeout=5.0)\ndef test_NTLMv2_auth_SMB2():\n def result(auth_passed):\n assert auth_passed\n\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.d.addCallback(result)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_createdeletedirectory.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, random, time\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass DirectoryFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service_name = ''\n self.path = ''\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def createDone(self, result):\n d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep)))\n d.addCallback(self.listComplete)\n d.addErrback(self.d.errback)\n\n def listComplete(self, entries):\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(self.path.replace('/', os.sep)) in names\n\n d = self.deleteDirectory(self.service_name, self.path)\n d.addCallback(self.deleteDone)\n d.addErrback(self.d.errback)\n\n def deleteDone(self, result):\n d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep)))\n d.addCallback(self.list2Complete)\n d.addErrback(self.d.errback)\n\n def list2Complete(self, entries):\n names = map(lambda e: e.filename, entries)\n assert os.path.basename(self.path.replace('/', os.sep)) not in names\n self.d.callback(True)\n\n def onAuthOK(self):\n d = self.createDirectory(self.service_name, self.path)\n d.addCallback(self.createDone)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_english_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_english_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_unicode_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_unicode_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = os.sep + u'文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_echo.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom util import getConnectionInfo\n\n\nclass EchoFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.echo_data = 'This is an echo test'\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(data):\n assert data == self.echo_data\n self.d.callback(True)\n\n d = self.echo(self.echo_data)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_echo():\n info = getConnectionInfo()\n factory = EchoFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_getattributes.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass GetAttributesFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.path = ''\n self.is_directory = False\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(info):\n assert info.isDirectory == self.is_directory\n self.d.callback(True)\n\n d = self.getAttributes('smbtest', self.path, timeout = 15)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_getAttributes_SMB1_test1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.path = '/Test Folder with Long Name/'\n factory.is_directory = True\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_getAttributes_SMB1_test2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.path = '/rfc1001.txt'\n factory.is_directory = False\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_getAttributes_SMB1_test3():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.path = u'/\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939'\n factory.is_directory = True\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_getAttributes_SMB2_test1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.path = '/Test Folder with Long Name/'\n factory.is_directory = True\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_getAttributes_SMB2_test2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.path = '/rfc1001.txt'\n factory.is_directory = False\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_getAttributes_SMB2_test3():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.path = u'/\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939'\n factory.is_directory = True\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_listpath.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass ListPathFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(results):\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert ( u'\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( u'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( u'TestDir1', True ) in filenames # Test short English folder names\n assert ( u'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( u'rfc1001.txt', False ) in filenames # Test short English file names\n\n self.d.callback(True)\n\n d = self.listPath('smbtest', '/', timeout = 15)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_listPath_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_listPath_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_listshares.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass ListSharesFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(results):\n assert 'smbtest' in map(lambda r: r.name.lower(), results)\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n d = self.listShares(timeout = 15)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_listsnapshots.py", "content": "\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass ListSnapshotsFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service_name = None\n self.path = None\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def onAuthOK(self):\n def cb(results):\n assert len(results) > 0\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n d = self.listSnapshots(self.service_name, self.path, timeout = 15)\n d.addCallback(cb)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = '/rfc1001.txt'\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=15.0)\ndef test_listshares_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.path = '/rfc1001.txt'\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_rename.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, random, time\nfrom StringIO import StringIO\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\n\nclass RenameFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service = ''\n self.new_path = ''\n self.old_path = ''\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def pathCreated(self, result):\n d = self.listPath(self.service, os.path.dirname(self.old_path.replace('/', os.sep)))\n d.addCallback(self.listComplete)\n d.addErrback(self.d.errback)\n\n def listComplete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(self.new_path.replace('/', os.sep)) not in filenames\n\n d = self.rename(self.service, self.old_path, self.new_path)\n d.addCallback(self.renameComplete)\n d.addErrback(self.d.errback)\n\n def renameComplete(self, result):\n d = self.listPath(self.service, os.path.dirname(self.new_path.replace('/', os.sep)))\n d.addCallback(self.list2Complete)\n d.addErrback(self.d.errback)\n\n def list2Complete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.new_path.replace('/', os.sep)) in filenames\n assert os.path.basename(self.old_path.replace('/', os.sep)) not in filenames\n self.cleanup()\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\nclass RenameFileFactory(RenameFactory):\n\n def onAuthOK(self):\n d = self.storeFile(self.service, self.old_path, StringIO('Rename file test'))\n d.addCallback(self.pathCreated)\n d.addErrback(self.d.errback)\n\n def cleanup(self):\n d = self.deleteFiles(self.service, self.new_path)\n d.chainDeferred(self.d)\n\n\nclass RenameDirectoryFactory(RenameFactory):\n\n def onAuthOK(self):\n d = self.createDirectory(self.service, self.old_path)\n d.addCallback(self.pathCreated)\n d.addErrback(self.d.errback)\n\n def cleanup(self):\n d = self.deleteDirectory(self.service, self.new_path)\n d.chainDeferred(self.d)\n\n\n@deferred(timeout=30.0)\ndef test_rename_english_file_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_english_file_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_file_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_file_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_english_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_english_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_directory_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_rename_unicode_directory_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.old_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n factory.new_path = u'/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_retrievefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\n\nclass RetrieveFileFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.temp_fh = tempfile.NamedTemporaryFile(prefix = 'pysmbtest-')\n self.service = ''\n self.path = ''\n self.digest = ''\n self.offset = 0\n self.max_length = -1\n self.filesize = 0\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def fileRetrieved(self, write_result):\n file_obj, file_attributes, file_size = write_result\n assert file_obj == self.temp_fh\n\n md = MD5()\n filesize = 0\n self.temp_fh.seek(0)\n while True:\n s = self.temp_fh.read(8192)\n if not s:\n break\n md.update(s)\n filesize += len(s)\n\n assert self.filesize == filesize\n assert md.hexdigest() == self.digest\n\n self.temp_fh.close()\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n def onAuthOK(self):\n assert self.service\n assert self.path\n\n d = self.retrieveFileFromOffset(self.service, self.path, self.temp_fh, self.offset, self.max_length, timeout = 15)\n d.addCallback(self.fileRetrieved)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=30.0)\ndef test_retr_multiplereads_SMB1():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/rfc1001.txt'\n factory.digest = '5367c2bbf97f521059c78eab65309ad3'\n factory.filesize = 158437\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_multiplereads_SMB2():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/rfc1001.txt'\n factory.digest = '5367c2bbf97f521059c78eab65309ad3'\n factory.filesize = 158437\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_longfilename_SMB1():\n # Test file retrieval that has a long English filename\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/Implementing CIFS - SMB.html'\n factory.digest = '671c5700d279fcbbf958c1bba3c2639e'\n factory.filesize = 421269\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_longfilename_SMB2():\n # Test file retrieval that has a long English filename\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/Implementing CIFS - SMB.html'\n factory.digest = '671c5700d279fcbbf958c1bba3c2639e'\n factory.filesize = 421269\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_unicodefilename_SMB1():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '8a44c1e80d55e91c92350955cdf83442'\n factory.filesize = 256000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_unicodefilename_SMB2():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '8a44c1e80d55e91c92350955cdf83442'\n factory.filesize = 256000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_SMB1():\n # Test file retrieval from offset to EOF\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n factory.filesize = 156000\n factory.offset = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_SMB2():\n # Test file retrieval from offset to EOF\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n factory.filesize = 156000\n factory.offset = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_biglimit_SMB1():\n # Test file retrieval from offset with a big max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5'\n factory.filesize = 100000\n factory.offset = 100000\n factory.max_length = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_biglimit_SMB2():\n # Test file retrieval from offset with a big max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5'\n factory.filesize = 100000\n factory.offset = 100000\n factory.max_length = 100000\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_smalllimit_SMB1():\n # Test file retrieval from offset with a small max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '746f60a96b39b712a7b6e17ddde19986'\n factory.filesize = 10\n factory.offset = 100000\n factory.max_length = 10\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_smalllimit_SMB2():\n # Test file retrieval from offset with a small max_length\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = '746f60a96b39b712a7b6e17ddde19986'\n factory.filesize = 10\n factory.offset = 100000\n factory.max_length = 10\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_zerolimit_SMB1():\n # Test file retrieval from offset to EOF with max_length=0\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'd41d8cd98f00b204e9800998ecf8427e'\n factory.filesize = 0\n factory.offset = 100000\n factory.max_length = 0\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_retr_offset_and_zerolimit_SMB2():\n # Test file retrieval from offset to EOF with max_length=0\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n \n factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = u'/测试文件夹/垃圾文件.dat'\n factory.digest = 'd41d8cd98f00b204e9800998ecf8427e'\n factory.filesize = 0\n factory.offset = 100000\n factory.max_length = 0\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/test_storefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom StringIO import StringIO\nfrom nose.twistedtools import reactor, deferred\nfrom twisted.internet import defer\nfrom smb.SMBProtocol import SMBProtocolFactory\nfrom smb import smb_structs\nfrom util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nclass StoreFilesFactory(SMBProtocolFactory):\n \"\"\"\n A super test factory that tests store file, list files, retrieve file and delete file functionlities in sequence.\n \"\"\"\n\n TEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\n TEST_FILESIZE = 256000\n TEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n self.d = defer.Deferred()\n self.d.addBoth(self.testDone)\n self.service_name = ''\n self.filename = ''\n\n def testDone(self, r):\n if self.instance:\n self.instance.transport.loseConnection()\n return r\n\n def storeComplete(self, result):\n file_obj, filesize = result\n file_obj.close()\n assert filesize == self.TEST_FILESIZE\n\n d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep)))\n d.addCallback(self.listComplete)\n d.addErrback(self.d.errback)\n\n def listComplete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.filename.replace('/', os.sep)) in filenames\n\n for entry in entries:\n if os.path.basename(self.filename.replace('/', os.sep)) == entry.filename:\n # The following asserts will fail if the remote machine's time is not in sync with the test machine's time\n assert abs(entry.create_time - time.time()) < 3\n assert abs(entry.last_access_time - time.time()) < 3\n assert abs(entry.last_write_time - time.time()) < 3\n assert abs(entry.last_attr_change_time - time.time()) < 3\n break\n\n d = self.retrieveFile(self.service_name, self.filename, StringIO())\n d.addCallback(self.retrieveComplete)\n d.addErrback(self.d.errback)\n\n def retrieveComplete(self, result):\n file_obj, file_attributes, file_size = result\n\n md = MD5()\n md.update(file_obj.getvalue())\n file_obj.close()\n\n assert file_size == self.TEST_FILESIZE\n assert md.hexdigest() == self.TEST_DIGEST\n\n d = self.deleteFiles(self.service_name, self.filename)\n d.addCallback(self.deleteComplete)\n d.addErrback(self.d.errback)\n\n def deleteComplete(self, result):\n d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep)))\n d.addCallback(self.list2Complete)\n d.addErrback(self.d.errback)\n\n def list2Complete(self, entries):\n filenames = map(lambda e: e.filename, entries)\n assert os.path.basename(self.filename.replace('/', os.sep)) not in filenames\n self.d.callback(True)\n self.instance.transport.loseConnection()\n\n def onAuthOK(self):\n d = self.storeFile(self.service_name, self.filename, open(self.TEST_FILENAME, 'rb'))\n d.addCallback(self.storeComplete)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n self.d.errback('Auth failed')\n\n\n@deferred(timeout=30.0)\ndef test_store_long_filename_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_store_long_filename_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_store_unicode_filename_SMB1():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = False\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n\n@deferred(timeout=30.0)\ndef test_store_unicode_filename_SMB2():\n info = getConnectionInfo()\n smb_structs.SUPPORT_SMB2 = True\n\n factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n factory.service_name = 'smbtest'\n factory.filename = os.sep + u'上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n reactor.connectTCP(info['server_ip'], info['server_port'], factory)\n return factory.d\n" }, { "path": "python2/tests/SMBTwistedTests/util.py", "content": "\nimport os\nfrom ConfigParser import ConfigParser\n\ndef getConnectionInfo():\n config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini')\n cp = ConfigParser()\n cp.read(config_filename)\n\n info = {\n 'server_name': cp.get('server', 'name'),\n 'server_ip': cp.get('server', 'ip'),\n 'server_port': cp.getint('server', 'port'),\n 'client_name': cp.get('client', 'name'),\n 'user': cp.get('user', 'name'),\n 'password': cp.get('user', 'password'),\n }\n return info\n" }, { "path": "python2/tests/__init__.py", "content": "" }, { "path": "python2/tests/connection.ini", "content": "\n[server]\nname = SERVER\nip = 192.168.1.1\nport = 139\ndirect_port = 445\n\n[client]\nname = TESTCLIENT\n\n[user]\nname = myuser\npassword = mypassword\ndomain =\n" }, { "path": "python2/tests/test_ntlm.py", "content": "\nimport binascii\nfrom smb import ntlm\n\ndef test_NTLMv1_without_extended_security():\n password = 'Password'\n server_challenge = '\\x01\\x23\\x45\\x67\\x89\\xab\\xcd\\xef'\n\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(password,\n server_challenge,\n has_extended_security = False,\n client_challenge = '\\xAA'*8)\n\n assert binascii.hexlify(nt_challenge_response).lower() == '67 c4 30 11 f3 02 98 a2 ad 35 ec e6 4f 16 33 1c 44 bd be d9 27 84 1f 94'.replace(' ', '') # [MS-NLMP]: 4.2.2.2.1\n assert binascii.hexlify(lm_challenge_response).lower() == '98 de f7 b8 7f 88 aa 5d af e2 df 77 96 88 a1 72 de f1 1c 7d 5c cd ef 13'.replace(' ', '') # [MS-NLMP]: 4.2.2.2.2\n\n\ndef test_NTLMv1_with_extended_security():\n password = 'Password'\n server_challenge = '\\x01\\x23\\x45\\x67\\x89\\xab\\xcd\\xef'\n\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(password,\n server_challenge,\n has_extended_security = True,\n client_challenge = '\\xAA'*8)\n\n assert binascii.hexlify(nt_challenge_response).lower() == '75 37 f8 03 ae 36 71 28 ca 45 82 04 bd e7 ca f8 1e 97 ed 26 83 26 72 32'.replace(' ', '') # [MS-NLMP]: 4.2.3.2.2\n assert binascii.hexlify(lm_challenge_response).lower() == 'aa aa aa aa aa aa aa aa 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00'.replace(' ', '') # [MS-NLMP]: 4.2.3.2.1\n\n\ndef test_NTLMv2():\n user = 'User'\n password = 'Password'\n domain = 'Domain'\n server_challenge = '\\x01\\x23\\x45\\x67\\x89\\xab\\xcd\\xef'\n\n server_avpair = binascii.unhexlify('01 00 0c 00 53 00 65 00 72 00 76 00 65 00 72 00'.replace(' ', ''))\n domain_avpair = binascii.unhexlify('02 00 0c 00 44 00 6f 00 6d 00 61 00 69 00 6e 00'.replace(' ', ''))\n\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(password,\n user,\n server_challenge,\n server_avpair + domain_avpair + '\\0'*4,\n domain,\n client_challenge = '\\xAA'*8)\n\n assert binascii.hexlify(lm_challenge_response).lower() == '86 c3 50 97 ac 9c ec 10 25 54 76 4a 57 cc cc 19 aa aa aa aa aa aa aa aa'.replace(' ', '') # [MS-NLMP]: 4.2.4.2.1\n" }, { "path": "python2/tests/test_security_descriptors.py", "content": "import binascii\n\nfrom smb import security_descriptors as sd\nfrom smb import smb_constants as sc\n\n\ndef test_sid_string_representation():\n sid = sd.SID(1, 5, [2, 3, 4])\n assert str(sid) == \"S-1-5-2-3-4\"\n sid = sd.SID(1, 2**32 + 3, [])\n assert str(sid) == \"S-1-0x100000003\"\n sid = sd.SID(1, 2**32, [3, 2, 1])\n assert str(sid) == \"S-1-0x100000000-3-2-1\"\n\n\ndef test_sid_binary_parsing():\n raw_sid = binascii.unhexlify(\"\"\"\n 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a\n 2a 4f da ca c1 79 a6 32 b1 04 00 00\n \"\"\".translate(None, ' \\n'))\n assert str(sd.SID.from_bytes(raw_sid)) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n raw_sid += \"garbage\"\n assert str(sd.SID.from_bytes(raw_sid)) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n sid, tail = sd.SID.from_bytes(raw_sid, return_tail=True)\n assert str(sid) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n assert tail == \"garbage\"\n\n\ndef test_ace_binary_parsing():\n raw_ace = binascii.unhexlify(\"\"\"\n 00 10 24 00 ff 01 1f 00 01 05 00 00 00 00 00 05\n 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32\n 6e 04 00 00\n \"\"\".translate(None, ' \\n'))\n ace = sd.ACE.from_bytes(raw_ace)\n assert str(ace.sid) == \"S-1-5-21-717312990-3403304746-849770945-1134\"\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert ace.flags == sd.ACE_FLAG_INHERITED\n assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC\n | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA\n | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA\n | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE\n | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES\n | sc.FILE_WRITE_ATTRIBUTES)\n assert not ace.additional_data\n\n raw_ace = binascii.unhexlify(\"\"\"\n 00 13 18 00 a9 00 12 00 01 02 00 00 00 00 00 05\n 20 00 00 00 21 02 00 00\n \"\"\".translate(None, ' \\n'))\n ace = sd.ACE.from_bytes(raw_ace)\n assert str(ace.sid) == \"S-1-5-32-545\"\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert ace.flags == (sd.ACE_FLAG_INHERITED | sd.ACE_FLAG_CONTAINER_INHERIT\n | sd.ACE_FLAG_OBJECT_INHERIT)\n assert ace.mask == (sc.SYNCHRONIZE | sc.READ_CONTROL | sc.FILE_READ_DATA\n | sc.FILE_READ_EA | sc.FILE_EXECUTE\n | sc.FILE_READ_ATTRIBUTES)\n assert not ace.additional_data\n\n raw_ace = binascii.unhexlify(\"\"\"\n 01 03 24 00 a9 00 02 00 01 05 00 00 00 00 00 05\n 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32\n 6c 04 00 00\n \"\"\".translate(None, ' \\n'))\n ace = sd.ACE.from_bytes(raw_ace)\n assert str(ace.sid) == \"S-1-5-21-717312990-3403304746-849770945-1132\"\n assert ace.type == sd.ACE_TYPE_ACCESS_DENIED\n assert ace.flags == (sd.ACE_FLAG_CONTAINER_INHERIT\n | sd.ACE_FLAG_OBJECT_INHERIT)\n assert ace.mask == (sc.READ_CONTROL | sc.FILE_READ_DATA | sc.FILE_READ_EA\n | sc.FILE_EXECUTE | sc.FILE_READ_ATTRIBUTES)\n assert not ace.additional_data\n\n\ndef test_acl_binary_parsing():\n raw_acl = binascii.unhexlify(\"\"\"\n 02 00 70 00 04 00 00 00 00 10 18 00 89 00 10 00\n 01 02 00 00 00 00 00 05 20 00 00 00 21 02 00 00\n 00 10 14 00 ff 01 1f 00 01 01 00 00 00 00 00 05\n 12 00 00 00 00 10 18 00 ff 01 1f 00 01 02 00 00\n 00 00 00 05 20 00 00 00 20 02 00 00 00 10 24 00\n ff 01 1f 00 01 05 00 00 00 00 00 05 15 00 00 00\n de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00\n \"\"\".translate(None, ' \\n'))\n acl = sd.ACL.from_bytes(raw_acl)\n assert acl.revision == 2\n assert len(acl.aces) == 4\n\n ace = acl.aces[0]\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert str(ace.sid) == \"S-1-5-32-545\"\n assert ace.flags == sd.ACE_FLAG_INHERITED\n assert ace.mask == (sc.SYNCHRONIZE | sc.FILE_READ_DATA | sc.FILE_READ_EA\n | sc.FILE_READ_ATTRIBUTES)\n\n ace = acl.aces[3]\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert str(ace.sid) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n assert ace.flags == sd.ACE_FLAG_INHERITED\n assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC\n | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA\n | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA\n | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE\n | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES\n | sc.FILE_WRITE_ATTRIBUTES)\n\n\ndef test_descriptor_binary_parsing():\n raw_descriptor = binascii.unhexlify(\"\"\"\n 01 00 04 84 14 00 00 00 30 00 00 00 00 00 00 00\n 4c 00 00 00 01 05 00 00 00 00 00 05 15 00 00 00\n de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00\n 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a\n 2a 4f da ca c1 79 a6 32 01 02 00 00 02 00 70 00\n 04 00 00 00 00 10 18 00 89 00 10 00 01 02 00 00\n 00 00 00 05 20 00 00 00 21 02 00 00 00 10 14 00\n ff 01 1f 00 01 01 00 00 00 00 00 05 12 00 00 00\n 00 10 18 00 ff 01 1f 00 01 02 00 00 00 00 00 05\n 20 00 00 00 20 02 00 00 00 10 24 00 ff 01 1f 00\n 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a\n 2a 4f da ca c1 79 a6 32 b1 04 00 00\n \"\"\".translate(None, ' \\n'))\n descriptor = sd.SecurityDescriptor.from_bytes(raw_descriptor)\n assert descriptor.flags == (sd.SECURITY_DESCRIPTOR_SELF_RELATIVE\n | sd.SECURITY_DESCRIPTOR_DACL_PRESENT\n | sd.SECURITY_DESCRIPTOR_DACL_AUTO_INHERITED)\n assert descriptor.dacl is not None\n assert descriptor.sacl is None\n assert str(descriptor.owner) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n assert str(descriptor.group) == \"S-1-5-21-717312990-3403304746-849770945-513\"\n\n acl = descriptor.dacl\n assert acl.revision == 2\n assert len(acl.aces) == 4\n assert str(acl.aces[0].sid) == sd.SID_BUILTIN_USERS\n assert str(acl.aces[1].sid) == sd.SID_LOCAL_SYSTEM\n assert str(acl.aces[2].sid) == sd.SID_BUILTIN_ADMINISTRATORS\n assert str(acl.aces[3].sid) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n" }, { "path": "python2/tests/test_securityblob.py", "content": "\nimport binascii\nfrom smb import securityblob\n\n\ndef test_NTLMSSP_NEGOTIATE_encoding():\n ntlm_data = binascii.unhexlify('4e544c4d5353500001000000978208e200000000000000000000000000000000060072170000000f') # The NTLM negotiate message\n blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n\n TARGET = binascii.unhexlify(\"\"\"\n60 48 06 06 2b 06 01 05 05 02 a0 3e 30 3c a0 0e\n30 0c 06 0a 2b 06 01 04 01 82 37 02 02 0a a2 2a\n04 28 4e 54 4c 4d 53 53 50 00 01 00 00 00 97 82\n08 e2 00 00 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 06 00 72 17 00 00 00 0f\n\"\"\".replace(' ', '').replace('\\n', ''))\n\n assert blob == TARGET\n\n\ndef test_NTLMSSP_CHALLENGE_decoding():\n blob = binascii.unhexlify(\"\"\"\na1 81 be 30 81 bb a0 03 0a 01 01 a1 0c 06 0a 2b\n06 01 04 01 82 37 02 02 0a a2 81 a5 04 81 a2 4e\n54 4c 4d 53 53 50 00 02 00 00 00 0a 00 0a 00 38\n00 00 00 15 82 8a e2 32 81 ce 29 7f de 3f 80 00\n00 00 00 00 00 00 00 60 00 60 00 42 00 00 00 06\n01 00 00 00 00 00 0f 43 00 45 00 54 00 55 00 53\n00 02 00 0a 00 43 00 45 00 54 00 55 00 53 00 01\n00 0a 00 43 00 45 00 54 00 55 00 53 00 04 00 16\n00 6c 00 6f 00 63 00 61 00 6c 00 64 00 6f 00 6d\n00 61 00 69 00 6e 00 03 00 22 00 63 00 65 00 74\n00 75 00 73 00 2e 00 6c 00 6f 00 63 00 61 00 6c\n00 64 00 6f 00 6d 00 61 00 69 00 6e 00 00 00 00\n00\"\"\".replace(' ', '').replace('\\n', ''))\n\n RESPONSE_TOKENS = binascii.unhexlify(\"\"\"\n4e 54 4c 4d 53 53 50 00 02 00 00 00 0a 00 0a 00\n38 00 00 00 15 82 8a e2 32 81 ce 29 7f de 3f 80\n00 00 00 00 00 00 00 00 60 00 60 00 42 00 00 00\n06 01 00 00 00 00 00 0f 43 00 45 00 54 00 55 00\n53 00 02 00 0a 00 43 00 45 00 54 00 55 00 53 00\n01 00 0a 00 43 00 45 00 54 00 55 00 53 00 04 00\n16 00 6c 00 6f 00 63 00 61 00 6c 00 64 00 6f 00\n6d 00 61 00 69 00 6e 00 03 00 22 00 63 00 65 00\n74 00 75 00 73 00 2e 00 6c 00 6f 00 63 00 61 00\n6c 00 64 00 6f 00 6d 00 61 00 69 00 6e 00 00 00\n00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n\n result, response_tokens = securityblob.decodeChallengeSecurityBlob(blob)\n\n assert result == securityblob.RESULT_ACCEPT_INCOMPLETE\n assert response_tokens == RESPONSE_TOKENS\n\n\ndef test_NTLMSSP_AUTH_encoding():\n ntlm_data = binascii.unhexlify(\"\"\"\n4e 54 4c 4d 53 53 50 00 03 00 00 00 01 00 01 00\n70 00 00 00 00 00 00 00 71 00 00 00 00 00 00 00\n58 00 00 00 00 00 00 00 58 00 00 00 18 00 18 00\n58 00 00 00 10 00 10 00 71 00 00 00 15 8a 88 e2\n06 00 72 17 00 00 00 0f 06 49 3b c4 f6 2a 2b be\n61 a6 81 e7 cc 58 37 b4 4d 00 49 00 43 00 48 00\n41 00 45 00 4c 00 2d 00 49 00 35 00 50 00 43 00\n00 a7 0d b4 74 c3 d8 14 c9 df 3d 80 6d 87 94 42\nbc\n\"\"\".replace(' ', '').replace('\\n', ''))\n\n TARGET = binascii.unhexlify(\"\"\"\na1 81 8a 30 81 87 a2 81 84 04 81 81 4e 54 4c 4d\n53 53 50 00 03 00 00 00 01 00 01 00 70 00 00 00\n00 00 00 00 71 00 00 00 00 00 00 00 58 00 00 00\n00 00 00 00 58 00 00 00 18 00 18 00 58 00 00 00\n10 00 10 00 71 00 00 00 15 8a 88 e2 06 00 72 17\n00 00 00 0f 06 49 3b c4 f6 2a 2b be 61 a6 81 e7\ncc 58 37 b4 4d 00 49 00 43 00 48 00 41 00 45 00\n4c 00 2d 00 49 00 35 00 50 00 43 00 00 a7 0d b4\n74 c3 d8 14 c9 df 3d 80 6d 87 94 42 bc\n\"\"\".replace(' ', '').replace('\\n', ''))\n\n blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n\n assert blob == TARGET\n\n\ndef test_auth_response_decoding():\n blob = binascii.unhexlify(\"a1 07 30 05 a0 03 0a 01 00\".replace(' ', ''))\n\n result = securityblob.decodeAuthResponseSecurityBlob(blob)\n assert result == securityblob.RESULT_ACCEPT_COMPLETED\n" }, { "path": "python3/nmb/NetBIOS.py", "content": "\nimport os, logging, random, socket, time, select\nfrom .base import NBNS, NotConnectedError\nfrom .nmb_constants import TYPE_CLIENT, TYPE_SERVER, TYPE_WORKSTATION\n\nclass NetBIOS(NBNS):\n\n log = logging.getLogger('NMB.NetBIOS')\n\n def __init__(self, broadcast = True, listen_port = 0):\n \"\"\"\n Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.\n\n :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode\n :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.\n \"\"\"\n self.broadcast = broadcast\n self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)\n if self.broadcast:\n self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)\n if listen_port:\n self.sock.bind(( '', listen_port ))\n\n def close(self):\n \"\"\"\n Close the underlying and free resources.\n\n The NetBIOS instance should not be used to perform any operations after this method returns.\n\n :return: None\n \"\"\"\n self.sock.close()\n self.sock = None\n\n def write(self, data, ip, port):\n assert self.sock, 'Socket is already closed'\n self.sock.sendto(data, ( ip, port ))\n\n def queryName(self, name, ip = '', port = 137, timeout = 30):\n \"\"\"\n Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n :return: A list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). On timeout, returns None.\n \"\"\"\n assert self.sock, 'Socket is already closed'\n\n trn_id = random.randint(1, 0xFFFF)\n data = self.prepareNameQuery(trn_id, name)\n if self.broadcast and not ip:\n ip = ''\n elif not ip:\n self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')\n\n self.write(data, ip, port)\n\n return self._pollForNetBIOSPacket(trn_id, timeout)\n\n def queryIPForName(self, ip, port = 137, timeout = 30):\n \"\"\"\n Send a query to the machine with *ip* and hopes that the machine will reply back with its name.\n\n The implementation of this function is contributed by Jason Anderson.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n :return: A list of string containing the names of the machine at *ip*. On timeout, returns None.\n \"\"\"\n assert self.sock, 'Socket is already closed'\n\n trn_id = random.randint(1, 0xFFFF)\n data = self.prepareNetNameQuery(trn_id, False)\n self.write(data, ip, port)\n ret = self._pollForQueryPacket(trn_id, timeout)\n if ret:\n return list(map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret)))\n else:\n return None\n\n #\n # Protected Methods\n #\n\n def _pollForNetBIOSPacket(self, wait_trn_id, timeout):\n end_time = time.time() - timeout\n while True:\n try:\n _timeout = time.time()-end_time\n if _timeout <= 0:\n return None\n\n ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)\n if not ready:\n return None\n\n data, _ = self.sock.recvfrom(0xFFFF)\n if len(data) == 0:\n raise NotConnectedError\n\n trn_id, ret = self.decodePacket(data)\n\n if trn_id == wait_trn_id:\n return ret\n except select.error as ex:\n if type(ex) is tuple:\n if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n raise ex\n else:\n raise ex\n\n #\n # Contributed by Jason Anderson\n #\n def _pollForQueryPacket(self, wait_trn_id, timeout):\n end_time = time.time() - timeout\n while True:\n try:\n _timeout = time.time()-end_time\n if _timeout <= 0:\n return None\n\n ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], _timeout)\n if not ready:\n return None\n\n data, _ = self.sock.recvfrom(0xFFFF)\n if len(data) == 0:\n raise NotConnectedError\n\n trn_id, ret = self.decodeIPQueryPacket(data)\n\n if trn_id == wait_trn_id:\n return ret\n except select.error as ex:\n if type(ex) is tuple:\n if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n raise ex\n else:\n raise ex\n" }, { "path": "python3/nmb/NetBIOSProtocol.py", "content": "\nimport os, logging, random, socket, time\nfrom twisted.internet import reactor, defer\nfrom twisted.internet.protocol import DatagramProtocol\nfrom .base import NBNS\n\nclass NetBIOSTimeout(Exception):\n \"\"\"Raised in NBNSProtocol via Deferred.errback method when queryName method has timeout waiting for reply\"\"\"\n pass\n\nclass NBNSProtocol(DatagramProtocol, NBNS):\n\n log = logging.getLogger('NMB.NBNSProtocol')\n\n def __init__(self, broadcast = True, listen_port = 0):\n \"\"\"\n Instantiate a NBNSProtocol instance.\n\n This automatically calls reactor.listenUDP method to start listening for incoming packets, so you **must not** call the listenUDP method again.\n\n :param boolean broadcast: A boolean flag to indicate if we should setup the listening UDP port in broadcast mode\n :param integer listen_port: Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.\n \"\"\"\n self.broadcast = broadcast\n self.pending_trns = { } # TRN ID -> ( expiry_time, name, Deferred instance )\n self.transport = reactor.listenUDP(listen_port, self)\n if self.broadcast:\n self.transport.getHandle().setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)\n reactor.callLater(1, self.cleanupPendingTrns)\n\n def datagramReceived(self, data, from_info):\n host, port = from_info\n trn_id, ret = self.decodePacket(data)\n\n # pending transaction exists for trn_id - handle it and remove from queue\n if trn_id in self.pending_trns:\n _, ip, d = self.pending_trns.pop(trn_id)\n if ip is NAME_QUERY:\n # decode as query packet\n trn_id, ret = self.decodeIPQueryPacket(data)\n d.callback(ret)\n\n def write(self, data, ip, port):\n # We don't use the transport.write method directly as it keeps raising DeprecationWarning for ip=''\n self.transport.getHandle().sendto(data, ( ip, port ))\n\n def queryName(self, name, ip = '', port = 137, timeout = 30):\n \"\"\"\n Send a query on the network and hopes that if machine matching the *name* will reply with its IP address.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the returned Deferred instance will be called with a NetBIOSTimeout exception.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of IP addresses in dotted notation (aaa.bbb.ccc.ddd).\n On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception\n \"\"\"\n trn_id = random.randint(1, 0xFFFF)\n while True:\n if trn_id not in self.pending_trns:\n break\n else:\n trn_id = (trn_id + 1) & 0xFFFF\n\n data = self.prepareNameQuery(trn_id, name)\n if self.broadcast and not ip:\n ip = ''\n elif not ip:\n self.log.warning('queryName: ip parameter is empty. OS might not transmit this query to the network')\n\n self.write(data, ip, port)\n\n d = defer.Deferred()\n self.pending_trns[trn_id] = ( time.time()+timeout, name, d )\n return d\n\n def queryIPForName(self, ip, port = 137, timeout = 30):\n \"\"\"\n Send a query to the machine with *ip* and hopes that the machine will reply back with its name.\n\n The implementation of this function is contributed by Jason Anderson.\n\n :param string ip: If the NBNSProtocol instance was instianted with broadcast=True, then this parameter can be an empty string. We will leave it to the OS to determine an appropriate broadcast address.\n If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.\n :param integer port: The NetBIOS-NS port (IANA standard defines this port to be 137). You should not touch this parameter unless you know what you are doing.\n :param integer/float timeout: Number of seconds to wait for a reply, after which the method will return None\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of names of the machine at *ip*.\n On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception\n \"\"\"\n trn_id = random.randint(1, 0xFFFF)\n while True:\n if trn_id not in self.pending_trns:\n break\n else:\n trn_id = (trn_id + 1) & 0xFFFF\n\n data = self.prepareNetNameQuery(trn_id)\n self.write(data, ip, port)\n\n d = defer.Deferred()\n d2 = defer.Deferred()\n d2.addErrback(d.errback)\n\n def stripCode(ret):\n if ret is not None: # got valid response. Somehow the callback is also called when there is an error.\n d.callback(map(lambda s: s[0], filter(lambda s: s[1] == TYPE_SERVER, ret)))\n\n d2.addCallback(stripCode)\n self.pending_trns[trn_id] = ( time.time()+timeout, NAME_QUERY, d2 )\n return d\n\n def stopProtocol(self):\n DatagramProtocol.stopProtocol(self)\n\n def cleanupPendingTrns(self):\n now = time.time()\n\n # reply should have been received in the past\n # info is tuple of ( expiry_time, name, d )\n expired = filter(lambda trn_id, info: info[0] < now, self.pending_trns.iteritems())\n\n # remove expired items from dict + call errback\n def expire_item(item):\n trn_id, (expiry_time, name, d) = item\n\n del self.pending_trns[trn_id]\n try:\n d.errback(NetBIOSTimeout(name))\n except: pass\n\n map(expire_item, expired)\n\n if self.transport:\n reactor.callLater(1, self.cleanupPendingTrns)\n" }, { "path": "python3/nmb/__init__.py", "content": "" }, { "path": "python3/nmb/base.py", "content": "\nimport struct, logging, random\nfrom .nmb_constants import *\nfrom .nmb_structs import *\nfrom .utils import encode_name\n\nclass NMBSession:\n\n log = logging.getLogger('NMB.NMBSession')\n\n def __init__(self, my_name, remote_name, host_type = TYPE_SERVER, is_direct_tcp = False):\n self.my_name = my_name.upper()\n self.remote_name = remote_name.upper()\n self.host_type = host_type\n self.data_buf = b''\n\n if is_direct_tcp:\n self.data_nmb = DirectTCPSessionMessage()\n self.sendNMBPacket = self._sendNMBPacket_DirectTCP\n else:\n self.data_nmb = NMBSessionMessage()\n self.sendNMBPacket = self._sendNMBPacket_NetBIOS\n\n #\n # Overridden Methods\n #\n\n def write(self, data):\n raise NotImplementedError\n\n def onNMBSessionMessage(self, flags, data):\n pass\n\n def onNMBSessionOK(self):\n pass\n\n def onNMBSessionFailed(self):\n pass\n\n #\n # Public Methods\n #\n\n def feedData(self, data):\n self.data_buf = self.data_buf + data\n\n offset = 0\n while True:\n length = self.data_nmb.decode(self.data_buf, offset)\n if length == 0:\n break\n elif length > 0:\n offset += length\n self._processNMBSessionPacket(self.data_nmb)\n else:\n raise NMBError\n\n if offset > 0:\n self.data_buf = self.data_buf[offset:]\n\n def sendNMBMessage(self, data):\n self.sendNMBPacket(SESSION_MESSAGE, data)\n\n def requestNMBSession(self):\n my_name_encoded = encode_name(self.my_name, TYPE_WORKSTATION)\n remote_name_encoded = encode_name(self.remote_name, self.host_type)\n self.sendNMBPacket(SESSION_REQUEST, remote_name_encoded + my_name_encoded)\n\n #\n # Protected Methods\n #\n\n def _processNMBSessionPacket(self, packet):\n if packet.type == SESSION_MESSAGE:\n self.onNMBSessionMessage(packet.flags, packet.data)\n elif packet.type == POSITIVE_SESSION_RESPONSE:\n self.onNMBSessionOK()\n elif packet.type == NEGATIVE_SESSION_RESPONSE:\n self.onNMBSessionFailed()\n elif packet.type == SESSION_KEEPALIVE:\n # Discard keepalive packets - [RFC1002]: 5.2.2.1\n pass\n else:\n self.log.warning('Unrecognized NMB session type: 0x%02x', packet.type)\n\n def _sendNMBPacket_NetBIOS(self, packet_type, data):\n length = len(data)\n assert length <= 0x01FFFF\n flags = 0\n if length > 0xFFFF:\n flags |= 0x01\n length &= 0xFFFF\n self.write(struct.pack('>BBH', packet_type, flags, length) + data)\n\n def _sendNMBPacket_DirectTCP(self, packet_type, data):\n length = len(data)\n assert length <= 0x00FFFFFF\n self.write(struct.pack('>I', length) + data)\n\n\nclass NBNS:\n\n log = logging.getLogger('NMB.NBNS')\n\n HEADER_STRUCT_FORMAT = '>HHHHHH'\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n def write(self, data, ip, port):\n raise NotImplementedError\n\n def decodePacket(self, data):\n if len(data) < self.HEADER_STRUCT_SIZE:\n raise Exception\n\n trn_id, code, question_count, answer_count, authority_count, additional_count = \\\n struct.unpack(self.HEADER_STRUCT_FORMAT, data[:self.HEADER_STRUCT_SIZE])\n\n is_response = bool((code >> 15) & 0x01)\n opcode = (code >> 11) & 0x0F\n flags = (code >> 4) & 0x7F\n rcode = code & 0x0F\n\n if opcode == 0x0000 and is_response:\n name_len = data[self.HEADER_STRUCT_SIZE]\n # Constant 2 for the padding bytes before/after the Name and constant 8 for the Type,\n # Class and TTL fields in the Answer section after the Name:\n offset = self.HEADER_STRUCT_SIZE + 2 + name_len + 8\n record_count = (struct.unpack('>H', data[offset:offset+2])[0]) // 6\n\n offset += 4 # Constant 4 for the Data Length and Flags field\n ret = []\n for i in range(0, record_count):\n ret.append('%d.%d.%d.%d' % struct.unpack('4B', (data[offset:offset + 4])))\n offset += 6\n return trn_id, ret\n else:\n return trn_id, None\n\n def prepareNameQuery(self, trn_id, name, is_broadcast = True):\n header = struct.pack(self.HEADER_STRUCT_FORMAT,\n trn_id, (is_broadcast and 0x0110) or 0x0100, 1, 0, 0, 0)\n payload = encode_name(name, 0x20) + b'\\x00\\x20\\x00\\x01'\n\n return header + payload\n\n #\n # Contributed by Jason Anderson\n #\n def decodeIPQueryPacket(self, data):\n if len(data) < self.HEADER_STRUCT_SIZE:\n raise Exception\n\n trn_id, code, question_count, answer_count, authority_count, additional_count = struct.unpack(self.HEADER_STRUCT_FORMAT, data[:self.HEADER_STRUCT_SIZE])\n\n is_response = bool((code >> 15) & 0x01)\n opcode = (code >> 11) & 0x0F\n flags = (code >> 4) & 0x7F\n rcode = code & 0x0F\n\n try:\n numnames = data[self.HEADER_STRUCT_SIZE + 44]\n\n if numnames > 0:\n ret = [ ]\n offset = self.HEADER_STRUCT_SIZE + 45\n\n for i in range(0, numnames):\n mynme = data[offset:offset + 15]\n mynme = mynme.strip()\n ret.append(( str(mynme, 'ascii'), data[offset+15] ))\n offset += 18\n\n return trn_id, ret\n except IndexError:\n pass\n \n return trn_id, None\n\n #\n # Contributed by Jason Anderson\n #\n def prepareNetNameQuery(self, trn_id, is_broadcast = True):\n header = struct.pack(self.HEADER_STRUCT_FORMAT,\n trn_id, (is_broadcast and 0x0010) or 0x0000, 1, 0, 0, 0)\n payload = encode_name('*', 0) + b'\\x00\\x21\\x00\\x01'\n\n return header + payload\n" }, { "path": "python3/nmb/nmb_constants.py", "content": "\n# Default port for NetBIOS name service\nNETBIOS_NS_PORT = 137\n\n# Default port for NetBIOS session service\nNETBIOS_SESSION_PORT = 139\n\n# Owner Node Type Constants\nNODE_B = 0x00\nNODE_P = 0x01\nNODE_M = 0x10\nNODE_RESERVED = 0x11\n\n# Name Type Constants\nTYPE_UNKNOWN = 0x01\nTYPE_WORKSTATION = 0x00\nTYPE_CLIENT = 0x03\nTYPE_SERVER = 0x20\nTYPE_DOMAIN_MASTER = 0x1B\nTYPE_MASTER_BROWSER = 0x1D\nTYPE_BROWSER = 0x1E\n\nTYPE_NAMES = { TYPE_UNKNOWN: 'Unknown',\n TYPE_WORKSTATION: 'Workstation',\n TYPE_CLIENT: 'Client',\n TYPE_SERVER: 'Server',\n TYPE_MASTER_BROWSER: 'Master Browser',\n TYPE_BROWSER: 'Browser Server',\n TYPE_DOMAIN_MASTER: 'Domain Master'\n }\n\n# Values for Session Packet Type field in Session Packets\nSESSION_MESSAGE = 0x00\nSESSION_REQUEST = 0x81\nPOSITIVE_SESSION_RESPONSE = 0x82\nNEGATIVE_SESSION_RESPONSE = 0x83\nREGTARGET_SESSION_RESPONSE = 0x84\nSESSION_KEEPALIVE = 0x85\n" }, { "path": "python3/nmb/nmb_structs.py", "content": "\nimport struct\n\nclass NMBError(Exception): pass\n\nclass NotConnectedError(NMBError):\n \"\"\"\n Raisd when the underlying NMB connection has been disconnected or not connected yet\n \"\"\"\n pass\n\nclass NMBSessionMessage:\n\n HEADER_STRUCT_FORMAT = '>BBH'\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n def __init__(self):\n self.reset()\n\n def reset(self):\n self.type = 0\n self.flags = 0\n self.data = ''\n\n def decode(self, data, offset):\n data_len = len(data)\n\n if data_len < offset + self.HEADER_STRUCT_SIZE:\n # Not enough data for decoding\n return 0\n\n self.reset()\n self.type, self.flags, length = struct.unpack(self.HEADER_STRUCT_FORMAT, data[offset:offset+self.HEADER_STRUCT_SIZE])\n\n if self.flags & 0x01:\n length |= 0x010000\n\n if data_len < offset + self.HEADER_STRUCT_SIZE + length:\n return 0\n\n self.data = data[offset+self.HEADER_STRUCT_SIZE:offset+self.HEADER_STRUCT_SIZE+length]\n return self.HEADER_STRUCT_SIZE + length\n\nclass DirectTCPSessionMessage(NMBSessionMessage):\n\n HEADER_STRUCT_FORMAT = '>I'\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n def decode(self, data, offset):\n data_len = len(data)\n\n if data_len < offset + self.HEADER_STRUCT_SIZE:\n # Not enough data for decoding\n return 0\n\n self.reset()\n length = struct.unpack(self.HEADER_STRUCT_FORMAT, data[offset:offset+self.HEADER_STRUCT_SIZE])[0]\n\n if length >> 24 != 0:\n raise NMBError(\"Invalid protocol header for Direct TCP session message\")\n\n if data_len < offset + self.HEADER_STRUCT_SIZE + length:\n return 0\n\n self.data = data[offset+self.HEADER_STRUCT_SIZE:offset+self.HEADER_STRUCT_SIZE+length]\n return self.HEADER_STRUCT_SIZE + length\n" }, { "path": "python3/nmb/utils.py", "content": "\nimport string, re\n\n\ndef encode_name(name, type, scope = None):\n \"\"\"\n Perform first and second level encoding of name as specified in RFC 1001 (Section 4)\n \"\"\"\n if name == '*':\n name = name + '\\0' * 15\n elif len(name) > 15:\n name = name[:15] + chr(type)\n else:\n name = name.ljust(15) + chr(type)\n\n def _do_first_level_encoding(m):\n s = ord(m.group(0))\n return string.ascii_uppercase[s >> 4] + string.ascii_uppercase[s & 0x0f]\n\n encoded_name = chr(len(name) * 2) + re.sub('.', _do_first_level_encoding, name)\n if scope:\n encoded_scope = ''\n for s in string.split(scope, '.'):\n encoded_scope = encoded_scope + chr(len(s)) + s\n return bytes(encoded_name + encoded_scope + '\\0', 'ascii')\n else:\n return bytes(encoded_name + '\\0', 'ascii')\n\n\ndef decode_name(name):\n name_length = ord(name[0])\n assert name_length == 32\n\n def _do_first_level_decoding(m):\n s = m.group(0)\n return chr(((ord(s[0]) - ord('A')) << 4) | (ord(s[1]) - ord('A')))\n\n decoded_name = re.sub('..', _do_first_level_decoding, name[1:33])\n if name[33] == '\\0':\n return 34, decoded_name, ''\n else:\n decoded_domain = ''\n offset = 34\n while 1:\n domain_length = ord(name[offset])\n if domain_length == 0:\n break\n decoded_domain = '.' + name[offset:offset + domain_length]\n offset = offset + domain_length\n return offset + 1, decoded_name, decoded_domain\n" }, { "path": "python3/smb/SMBConnection.py", "content": "\nimport os, logging, select, socket, types, typing, struct, errno\n\nfrom tqdm import tqdm\nfrom .smb_constants import *\nfrom .smb_structs import *\nfrom .base import SMB, NotConnectedError, NotReadyError, SMBTimeout\n\n\nclass SMBConnection(SMB):\n\n log = logging.getLogger('SMB.SMBConnection')\n\n #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n SIGN_NEVER = 0\n #: SMB messages will be signed when remote server supports signing but not requires signing.\n SIGN_WHEN_SUPPORTED = 1\n #: SMB messages will only be signed when remote server requires signing.\n SIGN_WHEN_REQUIRED = 2\n\n def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n \"\"\"\n Create a new SMBConnection instance.\n\n *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.\n *password* can be a string or a callable returning a string.\n File operations can only be proceeded after the connection has been authenticated successfully.\n\n Note that you need to call *connect* method to actually establish the SMB connection to the remote server and perform authentication.\n\n The default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.\n Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.\n\n :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.\n You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\\\\/:*?\";|+``\n :param string remote_name: The NetBIOS machine name of the remote server.\n On windows, you can find out the machine name by right-clicking on the \"My Computer\" and selecting \"Properties\".\n This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.\n :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.\n :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.\n The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.\n Hence, we can only \"guess\" or try both algorithms.\n On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.\n :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.\n If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.\n If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.\n If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.\n The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).\n \"\"\"\n SMB.__init__(self, username, password, my_name, remote_name, domain, use_ntlm_v2, sign_options, is_direct_tcp)\n self.sock = None\n self.auth_result = None\n self.is_busy = False\n self.is_direct_tcp = is_direct_tcp\n\n #\n # SMB (and its superclass) Methods\n #\n\n def onAuthOK(self):\n self.auth_result = True\n\n def onAuthFailed(self):\n self.auth_result = False\n\n def write(self, data):\n assert self.sock\n data_len = len(data)\n total_sent = 0\n while total_sent < data_len:\n sent = self.sock.send(data[total_sent:])\n if sent == 0:\n raise NotConnectedError('Server disconnected')\n total_sent = total_sent + sent\n\n #\n # Support for \"with\" context\n #\n def __enter__(self):\n return self\n\n def __exit__(self, *args):\n self.close()\n\n #\n # Misc Properties\n #\n\n @property\n def isUsingSMB2(self):\n \"\"\"A convenient property to return True if the underlying SMB connection is using SMB2 protocol.\"\"\"\n return self.is_using_smb2\n\n\n #\n # Public Methods\n #\n\n def connect(self, ip, port = 139, sock_family = None, timeout = 60):\n \"\"\"\n Establish the SMB connection to the remote SMB/CIFS server.\n\n You must call this method before attempting any of the file operations with the remote server.\n This method will block until the SMB connection has attempted at least one authentication.\n\n :param port: Defaults to 139. If you are using direct TCP mode (is_direct_tcp=true when creating this SMBConnection instance), use 445.\n :param sock_family: In Python 3.x, use *None* as we can infer the socket family from the provided *ip*. In Python 2.x, it must be either *socket.AF_INET* or *socket.AF_INET6*.\n :return: A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise.\n \"\"\"\n if self.sock:\n self.sock.close()\n\n self.auth_result = None\n if sock_family:\n self.sock = socket.socket(sock_family)\n self.sock.settimeout(timeout)\n self.sock.connect(( ip, port ))\n else:\n self.sock = socket.create_connection(( ip, port ), timeout = timeout)\n\n self.is_busy = True\n try:\n if not self.is_direct_tcp:\n self.requestNMBSession()\n else:\n self.onNMBSessionOK()\n while self.auth_result is None:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return self.auth_result\n\n def close(self):\n \"\"\"\n Terminate the SMB connection (if it has been started) and release any sources held by the underlying socket.\n \"\"\"\n if self.sock:\n self.sock.close()\n self.sock = None\n\n def listShares(self, timeout = 30):\n \"\"\"\n Retrieve a list of shared resources on remote server.\n\n :return: A list of :doc:`smb.base.SharedDevice` instances describing the shared resource\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(entries):\n self.is_busy = False\n results.extend(entries)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._listShares(cb, eb, timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results\n\n def listPath(self, service_name, path,\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL,\n pattern = '*', timeout = 30):\n \"\"\"\n Retrieve a directory listing of files/folders at *path*\n\n For simplicity, pysmb defines a \"normal\" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n\n Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),\n system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files\n and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).\n If you do not need to include \"normal\" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.\n SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.\n :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).\n :param string/unicode pattern: the filter to apply to the results before returning to the client.\n :return: A list of :doc:`smb.base.SharedFile` instances.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(entries):\n self.is_busy = False\n results.extend(entries)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._listPath(service_name, path, cb, eb, search = search, pattern = pattern, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results\n\n def listSnapshots(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve a list of available snapshots (shadow copies) for *path*.\n\n Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots\n :return: A list of python *datetime.DateTime* instances in GMT/UTC time zone\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(entries):\n self.is_busy = False\n results.extend(entries)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._listSnapshots(service_name, path, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results\n\n def getAttributes(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve information about the file at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :return: A :doc:`smb.base.SharedFile` instance containing the attributes of the file.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(info):\n self.is_busy = False\n results.append(info)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._getAttributes(service_name, path, cb, eb, timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def getSecurity(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve the security descriptor of the file at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :return: A :class:`smb.security_descriptors.SecurityDescriptor` instance containing the security information of the file.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(info):\n self.is_busy = False\n results.append(info)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._getSecurity(service_name, path, cb, eb, timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def retrieveFile(self, service_name, path, file_obj, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n Use *retrieveFileFromOffset()* method if you wish to specify the offset to read from the remote *path* and/or the number of bytes to write to the *file_obj*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n return self.retrieveFileFromOffset(service_name, path, file_obj, 0, -1, timeout, show_progress = show_progress, tqdm_kwargs = tqdm_kwargs)\n\n def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0, max_length = -1, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* up to *max_length* number of bytes. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.\n :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.\n If zero, the method returns immediately after the file is opened successfully for reading.\n :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(r):\n self.is_busy = False\n results.append(r[1:])\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n \n try:\n self._retrieveFileFromOffset(service_name, path, file_obj, cb, eb, offset, max_length, timeout = timeout, show_progress=show_progress, tqdm_kwargs=tqdm_kwargs)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def storeFile(self, service_name, path, file_obj, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n \"\"\"\n Store the contents of the *file_obj* at *path* on the *service_name*.\n If the file already exists on the remote server, it will be truncated and overwritten.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.\n If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF. In Python3, this file-like object must have a *read* method which returns a bytes parameter.\n :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n :return: Number of bytes uploaded\n \"\"\"\n return self.storeFileFromOffset(service_name, path, file_obj, 0, True, timeout, show_progress = show_progress, tqdm_kwargs = tqdm_kwargs)\n\n def storeFileFromOffset(self, service_name, path, file_obj, offset = 0, truncate = False, timeout = 30, show_progress = False, tqdm_kwargs = {}):\n \"\"\"\n Store the contents of the *file_obj* at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created.\n If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure` will be raised.\n :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.\n :param offset: Long integer value which specifies the offset in the remote server to start writing. First byte of the file is 0.\n :param truncate: Boolean value. If True and the file exists on the remote server, it will be truncated first before writing. Default is False.\n :param bool show_progress: If True, a progress bar will be shown to reflect the current file operation progress.\n :return: the file position where the next byte will be written.\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(r):\n self.is_busy = False\n results.append(r[1])\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._storeFileFromOffset(service_name, path, file_obj, cb, eb, offset, truncate = truncate, timeout = timeout, show_progress=show_progress, tqdm_kwargs=tqdm_kwargs)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30):\n \"\"\"\n Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.\n\n If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n Wildcards may be used in th filename component of the path.\n If your path/filename contains non-English characters, you must pass in an unicode string.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._deleteFiles(service_name, path_file_pattern, delete_matching_folders, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def resetFileAttributes(self, service_name, path_file_pattern, file_attributes = ATTR_NORMAL, timeout = 30):\n \"\"\"\n Reset file attributes of one or more regular files or folders.\n It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request.\n This function is very helpful when deleting files/folders that are read-only.\n By default, it sets the ATTR_NORMAL flag, therefore clearing all other flags.\n (See https://msdn.microsoft.com/en-us/library/cc232110.aspx for further information)\n\n Note: this function is currently only implemented for SMB2!\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n Wildcards may be used in the filename component of the path.\n If your path/filename contains non-English characters, you must pass in an unicode string.\n :param int file_attributes: The desired file attributes to set. Defaults to `ATTR_NORMAL`.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._resetFileAttributes(service_name, path_file_pattern, cb, eb, file_attributes, timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def createDirectory(self, service_name, path, timeout = 30):\n \"\"\"\n Creates a new directory *path* on the *service_name*.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the new folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._createDirectory(service_name, path, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def deleteDirectory(self, service_name, path, timeout = 30):\n \"\"\"\n Delete the empty folder at *path* on *service_name*\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._deleteDirectory(service_name, path, cb, eb, timeout = timeout)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def rename(self, service_name, old_path, new_path, timeout = 30):\n \"\"\"\n Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders\n\n *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :return: None\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n def cb(r):\n self.is_busy = False\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._rename(service_name, old_path, new_path, cb, eb)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n def echo(self, data, timeout = 10):\n \"\"\"\n Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.\n\n :param bytes data: Data to send to the remote server. Must be a bytes object.\n :return: The *data* parameter\n \"\"\"\n if not self.sock:\n raise NotConnectedError('Not connected to server')\n\n results = [ ]\n\n def cb(r):\n self.is_busy = False\n results.append(r)\n\n def eb(failure):\n self.is_busy = False\n raise failure\n\n self.is_busy = True\n try:\n self._echo(data, cb, eb)\n while self.is_busy:\n self._pollForNetBIOSPacket(timeout)\n finally:\n self.is_busy = False\n\n return results[0]\n\n #\n # Protected Methods\n #\n\n def _poll_for_data(self, expiry_time, read_len, data, timeout, poller):\n while read_len > 0:\n try:\n if expiry_time < time.time():\n raise SMBTimeout\n\n if poller:\n ready = poller.poll(timeout * 1000)\n else:\n ready, _, _ = select.select([self.sock.fileno()], [], [], timeout)\n if not ready:\n raise SMBTimeout\n\n d = self.sock.recv(read_len)\n if len(d) == 0:\n raise NotConnectedError\n data += d\n read_len -= len(d)\n except select.error as ex:\n if getattr(ex, \"errno\", None) not in (errno.EINTR, errno.EAGAIN):\n raise ex\n return data, read_len\n\n def _pollForNetBIOSPacket(self, timeout):\n if os.name == \"posix\":\n poller = select.poll()\n poller.register(self.sock, select.POLLIN)\n else:\n poller = None\n expiry_time = time.time() + timeout\n read_len = 4\n data = b\"\"\n\n data, read_len = self._poll_for_data(\n expiry_time=expiry_time,\n read_len=read_len,\n data=data,\n timeout=timeout,\n poller=poller,\n )\n\n type, flags, length = struct.unpack(\">BBH\", data)\n if flags & 0x01:\n length = length | 0x10000\n\n data, read_len = self._poll_for_data(\n expiry_time=expiry_time,\n read_len=length,\n data=data,\n timeout=timeout,\n poller=poller,\n )\n\n self.feedData(data)\n" }, { "path": "python3/smb/SMBHandler.py", "content": "import os, sys, socket, urllib.request, urllib.error, urllib.parse, mimetypes, email, tempfile\nfrom urllib.parse import (unwrap, unquote, splittype, splithost, quote,\n splitport, splittag, splitattr, splituser, splitpasswd, splitvalue)\nfrom urllib.response import addinfourl\nfrom urllib.request import ftpwrapper\nfrom nmb.NetBIOS import NetBIOS\nfrom smb.SMBConnection import SMBConnection\n\nfrom io import BytesIO\n\nUSE_NTLM = True\nMACHINE_NAME = None\n\nclass SMBHandler(urllib.request.BaseHandler):\n\n def smb_open(self, req):\n global USE_NTLM, MACHINE_NAME\n\n if not req.host:\n raise urllib.error.URLError('SMB error: no host given')\n host, port = splitport(req.host)\n if port is None:\n port = 139\n else:\n port = int(port)\n\n # username/password handling\n\n user, host = splituser(host)\n \n if user:\n user, passwd = splitpasswd(user)\n else:\n passwd = None\n \n host = unquote(host)\n user = user or ''\n\n domain = ''\n if ';' in user:\n domain, user = user.split(';', 1)\n\n passwd = passwd or ''\n myname = MACHINE_NAME or self.generateClientMachineName()\n\n server_name,host = host.split(',') if ',' in host else [None,host]\n\n if server_name is None:\n n = NetBIOS()\n\n names = n.queryIPForName(host)\n if names:\n server_name = names[0]\n else:\n raise urllib.error.URLError('SMB error: Hostname does not reply back with its machine name')\n\n path, attrs = splitattr(req.selector)\n if path.startswith('/'):\n path = path[1:]\n dirs = path.split('/')\n dirs = list(map(unquote, dirs))\n service, path = dirs[0], '/'.join(dirs[1:])\n\n try:\n conn = SMBConnection(user, passwd, myname, server_name, domain=domain, use_ntlm_v2 = USE_NTLM)\n conn.connect(host, port)\n\n headers = email.message.Message()\n if req.data:\n filelen = conn.storeFile(service, path, req.data)\n\n headers.add_header('Content-length', '0')\n fp = BytesIO(b\"\")\n else:\n fp = self.createTempFile()\n file_attrs, retrlen = conn.retrieveFile(service, path, fp)\n fp.seek(0)\n\n mtype = mimetypes.guess_type(req.get_full_url())[0]\n if mtype:\n headers.add_header('Content-type', mtype)\n if retrlen is not None and retrlen >= 0:\n headers.add_header('Content-length', '%d' % retrlen)\n\n return addinfourl(fp, headers, req.get_full_url())\n except Exception as ex:\n raise urllib.error.URLError('smb error: %s' % ex).with_traceback(sys.exc_info()[2])\n\n def createTempFile(self):\n return tempfile.TemporaryFile()\n\n def generateClientMachineName(self):\n hostname = socket.gethostname()\n if hostname:\n return hostname.split('.')[0]\n return 'SMB%d' % os.getpid()\n" }, { "path": "python3/smb/SMBProtocol.py", "content": "\nimport os, logging, time\nfrom twisted.internet import reactor, defer\nfrom twisted.internet.protocol import ClientFactory, Protocol\nfrom .smb_constants import *\nfrom .smb_structs import *\nfrom .base import SMB, NotConnectedError, NotReadyError, SMBTimeout\n\n\n__all__ = [ 'SMBProtocolFactory', 'NotConnectedError', 'NotReadyError' ]\n\n\nclass SMBProtocol(Protocol, SMB):\n\n log = logging.getLogger('SMB.SMBProtocol')\n\n #\n # Protocol Methods\n #\n\n def connectionMade(self):\n self.factory.instance = self\n if not self.is_direct_tcp:\n self.requestNMBSession()\n else:\n self.onNMBSessionOK()\n\n\n def connectionLost(self, reason):\n if self.factory.instance == self:\n self.instance = None\n\n def dataReceived(self, data):\n self.feedData(data)\n\n #\n # SMB (and its superclass) Methods\n #\n\n def write(self, data):\n self.transport.write(data)\n\n def onAuthOK(self):\n if self.factory.instance == self:\n self.factory.onAuthOK()\n reactor.callLater(1, self._cleanupPendingRequests)\n\n def onAuthFailed(self):\n if self.factory.instance == self:\n self.factory.onAuthFailed()\n\n def onNMBSessionFailed(self):\n self.log.error('Cannot establish NetBIOS session. You might have provided a wrong remote_name')\n\n #\n # Protected Methods\n #\n\n def _cleanupPendingRequests(self):\n if self.factory.instance == self:\n now = time.time()\n to_remove = []\n for mid, r in self.pending_requests.items():\n if r.expiry_time < now:\n try:\n r.errback(SMBTimeout())\n except Exception: pass\n to_remove.append(mid)\n\n for mid in to_remove:\n del self.pending_requests[mid]\n\n reactor.callLater(1, self._cleanupPendingRequests)\n\n\nclass SMBProtocolFactory(ClientFactory):\n\n protocol = SMBProtocol\n log = logging.getLogger('SMB.SMBFactory')\n\n #: SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n SIGN_NEVER = 0\n #: SMB messages will be signed when remote server supports signing but not requires signing.\n SIGN_WHEN_SUPPORTED = 1\n #: SMB messages will only be signed when remote server requires signing.\n SIGN_WHEN_REQUIRED = 2\n\n def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n \"\"\"\n Create a new SMBProtocolFactory instance. You will pass this instance to *reactor.connectTCP()* which will then instantiate the TCP connection to the remote SMB/CIFS server.\n Note that the default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.\n Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.\n\n *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.\n File operations can only be proceeded after the connection has been authenticated successfully.\n\n :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.\n You can freely choose a name as long as it contains a maximum of 15 alphanumeric characters and does not contain spaces and any of ``\\/:*?\";|+``\n :param string remote_name: The NetBIOS machine name of the remote server.\n On windows, you can find out the machine name by right-clicking on the \"My Computer\" and selecting \"Properties\".\n This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.\n :param string domain: The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.\n :param boolean use_ntlm_v2: Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication.\n The choice of NTLMv1 and NTLMv2 is configured on the remote server, and there is no mechanism to auto-detect which algorithm has been configured.\n Hence, we can only \"guess\" or try both algorithms.\n On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.\n :param int sign_options: Determines whether SMB messages will be signed. Default is *SIGN_WHEN_REQUIRED*.\n If *SIGN_WHEN_REQUIRED* (value=2), SMB messages will only be signed when remote server requires signing.\n If *SIGN_WHEN_SUPPORTED* (value=1), SMB messages will be signed when remote server supports signing but not requires signing.\n If *SIGN_NEVER* (value=0), SMB messages will never be signed regardless of remote server's configurations; access errors will occur if the remote server requires signing.\n :param boolean is_direct_tcp: Controls whether the NetBIOS over TCP/IP (is_direct_tcp=False) or the newer Direct hosting of SMB over TCP/IP (is_direct_tcp=True) will be used for the communication.\n The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).\n \"\"\"\n self.username = username\n self.password = password\n self.my_name = my_name\n self.remote_name = remote_name\n self.domain = domain\n self.use_ntlm_v2 = use_ntlm_v2\n self.sign_options = sign_options\n self.is_direct_tcp = is_direct_tcp\n self.instance = None #: The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.\n\n #\n # Public Property\n #\n\n @property\n def isReady(self):\n \"\"\"A convenient property to return True if the underlying SMB connection has connected to remote server, has successfully authenticated itself and is ready for file operations.\"\"\"\n return bool(self.instance and self.instance.has_authenticated)\n\n @property\n def isUsingSMB2(self):\n \"\"\"A convenient property to return True if the underlying SMB connection is using SMB2 protocol.\"\"\"\n return self.instance and self.instance.is_using_smb2\n\n #\n # Public Methods for Callbacks\n #\n\n def onAuthOK(self):\n \"\"\"\n Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.\n This method will be called when the server has replied that the SMB connection has been successfully authenticated.\n File operations can proceed when this method has been called.\n \"\"\"\n pass\n\n def onAuthFailed(self):\n \"\"\"\n Override this method in your *SMBProtocolFactory* subclass to add in post-authentication handling.\n This method will be called when the server has replied that the SMB connection has been successfully authenticated.\n\n If you want to retry authenticating from this method,\n 1. Disconnect the underlying SMB connection (call ``self.instance.transport.loseConnection()``)\n 2. Create a new SMBProtocolFactory subclass instance with different user credientials or different NTLM algorithm flag.\n 3. Call ``reactor.connectTCP`` with the new instance to re-establish the SMB connection\n \"\"\"\n pass\n\n #\n # Public Methods\n #\n\n def listShares(self, timeout = 30):\n \"\"\"\n Retrieve a list of shared resources on remote server.\n\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedDevice` instances.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._listShares(d.callback, d.errback, timeout)\n return d\n\n def listPath(self, service_name, path,\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL,\n pattern = '*', timeout = 30):\n \"\"\"\n Retrieve a directory listing of files/folders at *path*\n\n For simplicity, pysmb defines a \"normal\" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n\n Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),\n system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files\n and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).\n If you do not need to include \"normal\" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.\n SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.\n :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).\n :param string/unicode pattern: the filter to apply to the results before returning to the client.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedFile` instances.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._listPath(service_name, path, d.callback, d.errback, search = search, pattern = pattern, timeout = timeout)\n return d\n\n def listSnapshots(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve a list of available snapshots (a.k.a. shadow copies) for *path*.\n\n Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: path relative to the *service_name* where we are interested in the list of available snapshots\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of python *datetime.DateTime*\n instances in GMT/UTC time zone\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._listSnapshots(service_name, path, d.callback, d.errback, timeout = timeout)\n return d\n\n def getAttributes(self, service_name, path, timeout = 30):\n \"\"\"\n Retrieve information about the file at *path* on the *service_name*.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be raised.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a :doc:`smb.base.SharedFile` instance containing the attributes of the file.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._getAttributes(service_name, path, d.callback, d.errback, timeout = timeout)\n return d\n\n def retrieveFile(self, service_name, path, file_obj, timeout = 30):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n Use *retrieveFileFromOffset()* method if you need to specify the offset to read from the remote *path* and/or the maximum number of bytes to write to the *file_obj*.\n\n The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size\n of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).\n The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be called in the returned *Deferred* errback.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n return self.retrieveFileFromOffset(service_name, path, file_obj, 0, -1, timeout)\n\n def retrieveFileFromOffset(self, service_name, path, file_obj, offset = 0, max_length = -1, timeout = 30):\n \"\"\"\n Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.\n\n The meaning of the *timeout* parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size\n of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes).\n The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and downloaded from the remote SMB/CIFS server.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file cannot be opened for reading, an :doc:`OperationFailure` will be called in the returned *Deferred* errback.\n :param file_obj: A file-like object that has a *write* method. Data will be written continuously to *file_obj* until EOF is received from the remote service. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.\n :param integer/long offset: the offset in the remote *path* where the first byte will be read and written to *file_obj*. Must be either zero or a positive integer/long value.\n :param integer/long max_length: maximum number of bytes to read from the remote *path* and write to the *file_obj*. Specify a negative value to read from *offset* to the EOF.\n If zero, the *Deferred* callback is invoked immediately after the file is opened successfully for reading.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 3-element tuple of ( *file_obj*, file attributes of the file on server, number of bytes written to *file_obj* ).\n The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._retrieveFileFromOffset(service_name, path, file_obj, d.callback, d.errback, offset, max_length, timeout = timeout)\n return d\n\n def storeFile(self, service_name, path, file_obj, timeout = 30):\n \"\"\"\n Store the contents of the *file_obj* at *path* on the *service_name*.\n\n The meaning of the *timeout* parameter will be different from other file operation methods. As the uploaded file usually exceeeds the maximum size\n of each SMB/CIFS data message, it will be packetized into a series of messages (usually about 60kBytes).\n The *timeout* parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and acknowledged\n by the remote SMB/CIFS server.\n\n :param string/unicode service_name: the name of the shared folder for the *path*\n :param string/unicode path: Path of the file on the remote server. If the file at *path* does not exist, it will be created. Otherwise, it will be overwritten.\n If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure` will be called in the returned *Deferred* errback.\n :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF. In Python3, this file-like object must have a *read* method which returns a bytes parameter.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *file_obj*, number of bytes uploaded ).\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._storeFile(service_name, path, file_obj, d.callback, d.errback, timeout = timeout)\n return d\n\n def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30):\n \"\"\"\n Delete one or more regular files. It supports the use of wildcards in file names, allowing for deletion of multiple files in a single request.\n\n If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.\n \n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.\n Wildcards may be used in th filename component of the path.\n If your path/filename contains non-English characters, you must pass in an unicode string.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path_file_pattern* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._deleteFiles(service_name, path_file_pattern, delete_matching_folders, d.callback, d.errback, timeout = timeout)\n return d\n\n def createDirectory(self, service_name, path):\n \"\"\"\n Creates a new directory *path* on the *service_name*.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the new folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._createDirectory(service_name, path, d.callback, d.errback)\n return d\n\n def deleteDirectory(self, service_name, path):\n \"\"\"\n Delete the empty folder at *path* on *service_name*\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param string/unicode path: The path of the to-be-deleted folder (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *path* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._deleteDirectory(service_name, path, d.callback, d.errback)\n return d\n\n def rename(self, service_name, old_path, new_path):\n \"\"\"\n Rename a file or folder at *old_path* to *new_path* shared at *service_name*. Note that this method cannot be used to rename file/folder across different shared folders\n\n *old_path* and *new_path* are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder.\n If the path contains non-English characters, an unicode string must be used to pass in the path.\n\n :param string/unicode service_name: Contains the name of the shared folder.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a 2-element tuple of ( *old_path*, *new_path* ).\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._rename(service_name, old_path, new_path, d.callback, d.errback)\n return d\n\n def echo(self, data, timeout = 10):\n \"\"\"\n Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.\n\n :param bytes data: Data to send to the remote server. Must be a bytes object.\n :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.\n :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *data* parameter.\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n d = defer.Deferred()\n self.instance._echo(data, d.callback, d.errback, timeout)\n return d\n\n def closeConnection(self):\n \"\"\"\n Disconnect from the remote SMB/CIFS server. The TCP connection will be closed at the earliest opportunity after this method returns.\n\n :return: None\n \"\"\"\n if not self.instance:\n raise NotConnectedError('Not connected to server')\n\n self.instance.transport.loseConnection()\n\n #\n # ClientFactory methods\n # (Do not touch these unless you know what you are doing)\n #\n\n def buildProtocol(self, addr):\n p = self.protocol(self.username, self.password, self.my_name, self.remote_name, self.domain, self.use_ntlm_v2, self.sign_options, self.is_direct_tcp)\n p.factory = self\n return p\n" }, { "path": "python3/smb/__init__.py", "content": "\n" }, { "path": "python3/smb/base.py", "content": "\nimport logging, binascii, time, hmac\nfrom datetime import datetime\nfrom tqdm import tqdm\n\nfrom .smb_constants import *\nfrom .smb2_constants import *\nfrom .smb_structs import *\nfrom .smb2_structs import *\nfrom .security_descriptors import SecurityDescriptor\nfrom nmb.base import NMBSession\nfrom .utils import convertFILETIMEtoEpoch\nfrom . import ntlm, securityblob\nfrom .strategy import DataFaultToleranceStrategy\n\ntry:\n import hashlib\n sha256 = hashlib.sha256\nexcept ImportError:\n from .utils import sha256\n\n\nclass NotReadyError(Exception):\n \"\"\"Raised when SMB connection is not ready (i.e. not authenticated or authentication failed)\"\"\"\n pass\n\nclass NotConnectedError(Exception):\n \"\"\"Raised when underlying SMB connection has been disconnected or not connected yet\"\"\"\n pass\n\nclass SMBTimeout(Exception):\n \"\"\"Raised when a timeout has occurred while waiting for a response or for a SMB/CIFS operation to complete.\"\"\"\n pass\n\n\nclass SMB(NMBSession):\n \"\"\"\n This class represents a \"connection\" to the remote SMB/CIFS server.\n It is not meant to be used directly in an application as it does not have any network transport implementations.\n\n For application use, please refer to\n - L{SMBProtocol.SMBProtocolFactory} if you are using Twisted framework\n\n In [MS-CIFS], this class will contain attributes of Client, Client.Connection and Client.Session abstract data models.\n\n References:\n ===========\n - [MS-CIFS]: 3.2.1\n \"\"\"\n\n log = logging.getLogger('SMB.SMB')\n\n SIGN_NEVER = 0\n SIGN_WHEN_SUPPORTED = 1\n SIGN_WHEN_REQUIRED = 2\n\n def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False):\n NMBSession.__init__(self, my_name, remote_name, is_direct_tcp = is_direct_tcp)\n self.username = username\n self._password = password\n self.domain = domain\n self.sign_options = sign_options\n self.is_direct_tcp = is_direct_tcp\n self.use_ntlm_v2 = use_ntlm_v2 #: Similar to LMAuthenticationPolicy and NTAuthenticationPolicy as described in [MS-CIFS] 3.2.1.1\n self.smb_message = SMBMessage()\n self.is_using_smb2 = False #: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True\n self.async_requests = { } #: AsyncID mapped to _PendingRequest instance\n self.pending_requests = { } #: MID mapped to _PendingRequest instance\n self.connected_trees = { } #: Share name mapped to TID\n self.next_rpc_call_id = 1 #: Next RPC callID value. Not used directly in SMB message. Usually encapsulated in sub-commands under SMB_COM_TRANSACTION or SMB_COM_TRANSACTION2 messages\n\n self.has_negotiated = False\n self.has_authenticated = False\n self.is_signing_active = False #: True if the remote server accepts message signing. All outgoing messages will be signed. Simiar to IsSigningActive as described in [MS-CIFS] 3.2.1.2\n self.signing_session_key = None #: Session key for signing packets, if signing is active. Similar to SigningSessionKey as described in [MS-CIFS] 3.2.1.2\n self.signing_challenge_response = None #: Contains the challenge response for signing, if signing is active. Similar to SigningChallengeResponse as described in [MS-CIFS] 3.2.1.2\n self.mid = 0\n self.uid = 0\n self.next_signing_id = 2 #: Similar to ClientNextSendSequenceNumber as described in [MS-CIFS] 3.2.1.2\n\n # SMB1 and SMB2 attributes\n # Note that the interpretations of the values may differ between SMB1 and SMB2 protocols\n self.capabilities = 0\n self.security_mode = 0 #: Initialized from the SecurityMode field of the SMB_COM_NEGOTIATE message\n\n # SMB1 attributes\n # Most of the following attributes will be initialized upon receipt of SMB_COM_NEGOTIATE message from server (via self._updateServerInfo_SMB1 method)\n self.use_plaintext_authentication = False #: Similar to PlaintextAuthenticationPolicy in in [MS-CIFS] 3.2.1.1\n self.max_raw_size = 0\n self.max_buffer_size = 0 #: Similar to MaxBufferSize as described in [MS-CIFS] 3.2.1.1\n self.max_mpx_count = 0 #: Similar to MaxMpxCount as described in [MS-CIFS] 3.2.1.1\n\n # SMB2 attributes\n self.max_read_size = 0 #: Similar to MaxReadSize as described in [MS-SMB2] 2.2.4\n self.max_write_size = 0 #: Similar to MaxWriteSize as described in [MS-SMB2] 2.2.4\n self.max_transact_size = 0 #: Similar to MaxTransactSize as described in [MS-SMB2] 2.2.4\n self.session_id = 0 #: Similar to SessionID as described in [MS-SMB2] 2.2.4. This will be set in _updateState_SMB2 method\n\n # tqdm attributes for tracking progress\n self.pbar = None #: If not None, it means there is an active tqdm progress bar being shown\n\n self._setupSMB1Methods()\n\n self.log.info('Authentication with remote machine \"%s\" for user \"%s\" will be using NTLM %s authentication (%s extended security)',\n self.remote_name, self.username,\n (self.use_ntlm_v2 and 'v2') or 'v1',\n (SUPPORT_EXTENDED_SECURITY and 'with') or 'without')\n\n @property\n def password(self):\n if callable(self._password):\n return self._password()\n return self._password\n\n #\n # NMBSession Methods\n #\n\n def onNMBSessionOK(self):\n self._sendSMBMessage(SMBMessage(ComNegotiateRequest()))\n\n def onNMBSessionFailed(self):\n pass\n\n def onNMBSessionMessage(self, flags, data):\n while True:\n try:\n i = self.smb_message.decode(data)\n except SMB2ProtocolHeaderError:\n self.log.info('Now switching over to SMB2 protocol communication')\n self.is_using_smb2 = True\n self.mid = 0 # Must reset messageID counter, or else remote SMB2 server will disconnect\n self._setupSMB2Methods()\n self.smb_message = self._klassSMBMessage()\n i = self.smb_message.decode(data)\n\n next_message_offset = 0\n if self.is_using_smb2:\n next_message_offset = self.smb_message.next_command_offset\n\n if i > 0:\n if not self.is_using_smb2:\n self.log.debug('Received SMB message \"%s\" (command:0x%2X flags:0x%02X flags2:0x%04X TID:%d UID:%d)',\n SMB_COMMAND_NAMES.get(self.smb_message.command, ''),\n self.smb_message.command, self.smb_message.flags, self.smb_message.flags2, self.smb_message.tid, self.smb_message.uid)\n else:\n self.log.debug('Received SMB2 message \"%s\" (command:0x%04X flags:0x%04x)',\n SMB2_COMMAND_NAMES.get(self.smb_message.command, ''),\n self.smb_message.command, self.smb_message.flags)\n if self._updateState(self.smb_message):\n # We need to create a new instance instead of calling reset() because the instance could be captured in the message history.\n self.smb_message = self._klassSMBMessage()\n\n if next_message_offset > 0:\n data = data[next_message_offset:]\n else:\n break\n\n #\n # Public Methods for Overriding in Subclasses\n #\n\n def onAuthOK(self):\n pass\n\n def onAuthFailed(self):\n pass\n\n #\n # Protected Methods\n #\n\n def _setupSMB1Methods(self):\n self._klassSMBMessage = SMBMessage\n self._updateState = self._updateState_SMB1\n self._updateServerInfo = self._updateServerInfo_SMB1\n self._handleNegotiateResponse = self._handleNegotiateResponse_SMB1\n self._sendSMBMessage = self._sendSMBMessage_SMB1\n self._handleSessionChallenge = self._handleSessionChallenge_SMB1\n self._listShares = self._listShares_SMB1\n self._listPath = self._listPath_SMB1\n self._listSnapshots = self._listSnapshots_SMB1\n self._getSecurity = self._getSecurity_SMB1\n self._getAttributes = self._getAttributes_SMB1\n self._retrieveFile = self._retrieveFile_SMB1\n self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB1\n self._storeFile = self._storeFile_SMB1\n self._storeFileFromOffset = self._storeFileFromOffset_SMB1\n self._deleteFiles = self._deleteFiles_SMB1\n self._resetFileAttributes = self._resetFileAttributes_SMB1\n self._createDirectory = self._createDirectory_SMB1\n self._deleteDirectory = self._deleteDirectory_SMB1\n self._rename = self._rename_SMB1\n self._echo = self._echo_SMB1\n\n def _setupSMB2Methods(self):\n self._klassSMBMessage = SMB2Message\n self._updateState = self._updateState_SMB2\n self._updateServerInfo = self._updateServerInfo_SMB2\n self._handleNegotiateResponse = self._handleNegotiateResponse_SMB2\n self._sendSMBMessage = self._sendSMBMessage_SMB2\n self._handleSessionChallenge = self._handleSessionChallenge_SMB2\n self._listShares = self._listShares_SMB2\n self._listPath = self._listPath_SMB2\n self._listSnapshots = self._listSnapshots_SMB2\n self._getSecurity = self._getSecurity_SMB2\n self._getAttributes = self._getAttributes_SMB2\n self._retrieveFile = self._retrieveFile_SMB2\n self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB2\n self._storeFile = self._storeFile_SMB2\n self._storeFileFromOffset = self._storeFileFromOffset_SMB2\n self._deleteFiles = self._deleteFiles_SMB2\n self._resetFileAttributes = self._resetFileAttributes_SMB2\n self._createDirectory = self._createDirectory_SMB2\n self._deleteDirectory = self._deleteDirectory_SMB2\n self._rename = self._rename_SMB2\n self._echo = self._echo_SMB2\n\n def _getNextRPCCallID(self):\n self.next_rpc_call_id += 1\n return self.next_rpc_call_id\n\n #\n # SMB2 Methods Family\n #\n\n def _sendSMBMessage_SMB2(self, smb_message):\n if smb_message.mid == 0:\n smb_message.mid = self._getNextMID_SMB2()\n\n if smb_message.command != SMB2_COM_NEGOTIATE:\n smb_message.session_id = self.session_id\n\n if self.is_signing_active:\n smb_message.flags |= SMB2_FLAGS_SIGNED\n raw_data = smb_message.encode()\n smb_message.signature = hmac.new(self.signing_session_key, raw_data, sha256).digest()[:16]\n\n smb_message.raw_data = smb_message.encode()\n self.log.debug('MID is %d. Signature is %s. Total raw message is %d bytes', smb_message.mid, binascii.hexlify(smb_message.signature), len(smb_message.raw_data))\n else:\n smb_message.raw_data = smb_message.encode()\n self.sendNMBMessage(smb_message.raw_data)\n\n def _getNextMID_SMB2(self):\n self.mid += 1\n return self.mid\n\n def _updateState_SMB2(self, message):\n if message.isReply:\n if message.command == SMB2_COM_NEGOTIATE:\n if message.status == 0:\n self.has_negotiated = True\n self.log.info('SMB2 dialect negotiation successful')\n self._updateServerInfo(message.payload)\n self._handleNegotiateResponse(message)\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB2_COM_NEGOTIATE' % message.status,\n message.raw_data, message)\n elif message.command == SMB2_COM_SESSION_SETUP:\n if message.status == 0:\n self.session_id = message.session_id\n try:\n result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_COMPLETED:\n self.has_authenticated = True\n self.log.info('Authentication (on SMB2) successful!')\n\n # [MS-SMB2]: 3.2.5.3.1\n # If the security subsystem indicates that the session was established by an anonymous user,\n # Session.SigningRequired MUST be set to FALSE.\n # If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags field of the\n # SMB2 SESSION_SETUP Response and if Session.SigningRequired is TRUE, this indicates a SESSION_SETUP\n # failure and the connection MUST be terminated. If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags\n # field of the SMB2 SESSION_SETUP Response and if RequireMessageSigning is FALSE, Session.SigningRequired\n # MUST be set to FALSE.\n if message.payload.isGuestSession or message.payload.isAnonymousSession:\n self.is_signing_active = False\n self.log.info('Signing disabled because session is guest/anonymous')\n\n self.onAuthOK()\n else:\n raise ProtocolError('SMB2_COM_SESSION_SETUP status is 0 but security blob negResult value is %d' % result, message.raw_data, message)\n except securityblob.BadSecurityBlobError as ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif message.status == 0xc0000016: # STATUS_MORE_PROCESSING_REQUIRED\n self.session_id = message.session_id\n try:\n result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_INCOMPLETE:\n self._handleSessionChallenge(message, ntlm_token)\n except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ) as ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif (message.status == 0xc000006d # STATUS_LOGON_FAILURE\n or message.status == 0xc0000064 # STATUS_NO_SUCH_USER\n or message.status == 0xc000006a):# STATUS_WRONG_PASSWORD\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Please check username and password.')\n self.onAuthFailed()\n elif (message.status == 0xc0000193 # STATUS_ACCOUNT_EXPIRED\n or message.status == 0xC0000071): # STATUS_PASSWORD_EXPIRED\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Account or password has expired.')\n self.onAuthFailed()\n elif message.status == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Account has been locked due to too many invalid logon attempts.')\n self.onAuthFailed()\n elif message.status == 0xc0000072: # STATUS_ACCOUNT_DISABLED\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Account has been disabled.')\n self.onAuthFailed()\n elif (message.status == 0xc000006f # STATUS_INVALID_LOGON_HOURS\n or message.status == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED\n or message.status == 0xc0000070): # STATUS_INVALID_WORKSTATION\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Not allowed.')\n self.onAuthFailed()\n elif message.status == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Domain not trusted.')\n self.onAuthFailed()\n elif message.status == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (on SMB2) failed. Workstation not trusted.')\n self.onAuthFailed()\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status,\n message.raw_data, message)\n\n if message.isAsync:\n if message.status == 0x00000103: # STATUS_PENDING\n req = self.pending_requests.pop(message.mid, None)\n if req:\n self.async_requests[message.async_id] = req\n else: # All other status including SUCCESS\n req = self.async_requests.pop(message.async_id, None)\n if req:\n req.callback(message, **req.kwargs)\n return True\n else:\n req = self.pending_requests.pop(message.mid, None)\n if req:\n req.callback(message, **req.kwargs)\n return True\n\n\n def _updateServerInfo_SMB2(self, payload):\n self.capabilities = payload.capabilities\n self.security_mode = payload.security_mode\n self.max_transact_size = payload.max_transact_size\n self.max_read_size = payload.max_read_size\n self.max_write_size = payload.max_write_size\n self.use_plaintext_authentication = False # SMB2 never allows plaintext authentication\n\n\n def _handleNegotiateResponse_SMB2(self, message):\n ntlm_data = ntlm.generateNegotiateMessage()\n blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))\n\n\n def _handleSessionChallenge_SMB2(self, message, ntlm_token):\n server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)\n\n self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n\n if self.use_ntlm_v2:\n self.log.info('Performing NTLMv2 authentication (on SMB2) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,\n self.username,\n server_challenge,\n server_info,\n self.domain)\n\n else:\n self.log.info('Performing NTLMv1 authentication (on SMB2) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)\n\n ntlm_data, session_signing_key = ntlm.generateAuthenticateMessage(server_flags,\n nt_challenge_response,\n lm_challenge_response,\n session_key,\n self.username,\n self.domain,\n self.my_name)\n\n if self.log.isEnabledFor(logging.DEBUG):\n self.log.debug('NT challenge response is \"%s\" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))\n self.log.debug('LM challenge response is \"%s\" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))\n\n blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMB2Message(SMB2SessionSetupRequest(blob)))\n\n if self.security_mode & SMB2_NEGOTIATE_SIGNING_REQUIRED:\n self.log.info('Server requires all SMB messages to be signed')\n self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)\n elif self.security_mode & SMB2_NEGOTIATE_SIGNING_ENABLED:\n self.log.info('Server supports SMB signing')\n self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)\n else:\n self.is_signing_active = False\n\n if self.is_signing_active:\n self.log.info(\"SMB signing activated. All SMB messages will be signed.\")\n self.signing_session_key = session_signing_key\n if self.log.isEnabledFor(logging.DEBUG):\n self.log.info(\"SMB signing key is %s\", binascii.hexlify(self.signing_session_key))\n\n if self.capabilities & CAP_EXTENDED_SECURITY:\n self.signing_challenge_response = None\n else:\n self.signing_challenge_response = blob\n else:\n self.log.info(\"SMB signing deactivated. SMB messages will NOT be signed.\")\n\n\n def _listShares_SMB2(self, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = 'IPC$'\n messages_history = [ ]\n\n def connectSrvSvc(tid):\n m = SMB2Message(SMB2CreateRequest('srvsvc',\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_NON_DIRECTORY_FILE | FILE_OPEN_NO_RECALL,\n create_disp = FILE_OPEN))\n\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def connectSrvSvcCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n call_id = self._getNextRPCCallID()\n # The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]\n # If you wish to understand the meanings of the byte stream, I would suggest you use a recent version of WireShark to packet capture the stream\n data_bytes = \\\n binascii.unhexlify(b\"\"\"05 00 0b 03 10 00 00 00 74 00 00 00\"\"\".replace(b' ', b'')) + \\\n struct.pack(' data_length:\n return data_bytes[offset:]\n\n next_offset, _, \\\n create_time, last_access_time, last_write_time, last_attr_change_time, \\\n file_size, alloc_size, file_attributes, filename_length, ea_size, \\\n short_name_length, _, short_name, _, file_id = struct.unpack(info_format, data_bytes[offset:offset+info_size])\n\n offset2 = offset + info_size\n if offset2 + filename_length > data_length:\n return data_bytes[offset:]\n\n filename = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset2:offset2+filename_length])\n short_name = DataFaultToleranceStrategy.data_bytes_decode(short_name[:short_name_length])\n\n accept_result = False\n if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc\n accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n else:\n accept_result = (file_attributes & search) > 0\n if accept_result:\n results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),\n convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),\n file_size, alloc_size, file_attributes, short_name, filename, file_id))\n\n if next_offset:\n offset += next_offset\n else:\n break\n return b''\n\n def closeFid(tid, fid, results = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, results = results, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['results'] is not None:\n callback(kwargs['results'])\n elif kwargs['error'] is not None:\n if kwargs['error'] == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE\n # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files\n callback([ ])\n else:\n errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to list %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _getAttributes_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(' ', '').replace('\\n', ''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = 0,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n p = create_message.payload\n filename = self._extractLastPathComponent(path)\n info = SharedFile(p.create_time, p.lastaccess_time, p.lastwrite_time, p.change_time,\n p.file_size, p.allocation_size, p.file_attributes,\n filename, filename)\n closeFid(kwargs['tid'], p.fid, info = info)\n else:\n errback(OperationFailure('Failed to get attributes for %s on %s: Unable to open remote file object' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid, info = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, info = info, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['info'] is not None:\n callback(kwargs['info'])\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to get attributes for %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _getSecurity_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n results = [ ]\n\n def sendCreate(tid):\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = 0,\n create_disp = FILE_OPEN))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid,\n flags = 0,\n additional_info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION | DACL_SECURITY_INFORMATION,\n info_type = SMB2_INFO_SECURITY,\n file_info_class = 0, # [MS-SMB2] 2.2.37, 3.2.4.12\n input_buf = '',\n output_buf_len = self.max_transact_size))\n m.tid = kwargs['tid']\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid)\n self._pushToArray(messages_history, m)\n else:\n errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to open file or directory' % ( path, service_name ), messages_history))\n\n def queryCB(query_message, **kwargs):\n self._pushToArray(messages_history, query_message)\n if query_message.status == 0:\n security = SecurityDescriptor.from_bytes(query_message.payload.data)\n closeFid(kwargs['tid'], kwargs['fid'], result = security)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status)\n\n def closeFid(tid, fid, result = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, result = result, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['result'] is not None:\n callback(kwargs['result'])\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to get the security descriptor of %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _retrieveFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):\n return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0, -1, timeout)\n\n def _retrieveFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, max_length, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n results = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(b\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid,\n flags = 0,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 0x05, # FileStandardInformation [MS-FSCC] 2.4\n input_buf = b'',\n output_buf_len = 4096))\n m.tid = kwargs['tid']\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, infoCB, errback,\n tid = kwargs['tid'],\n fid = create_message.payload.fid,\n file_attributes = create_message.payload.file_attributes)\n self._pushToArray(messages_history, m)\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def infoCB(info_message, **kwargs):\n self._pushToArray(messages_history, info_message)\n if info_message.status == 0:\n file_len = struct.unpack(' file_len:\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n closeFid(info_message.tid, kwargs['fid'])\n callback(( file_obj, kwargs['file_attributes'], 0 )) # Note that this is a tuple of 3-elements\n else:\n remaining_len = max_length\n if remaining_len < 0:\n remaining_len = file_len\n if starting_offset + remaining_len > file_len:\n remaining_len = file_len - starting_offset\n if show_progress:\n tqdm_kwargs.setdefault(\"total\", remaining_len)\n tqdm_kwargs.setdefault(\"unit\", \"B\")\n tqdm_kwargs.setdefault(\"unit_scale\", True)\n tqdm_kwargs.setdefault(\"unit_divisor\", 1024)\n tqdm_kwargs.setdefault(\"desc\", f\"Downloading {path}\")\n self.pbar = tqdm(**tqdm_kwargs)\n sendRead(kwargs['tid'], kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes'])\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history))\n\n def sendRead(tid, fid, offset, remaining_len, read_len, file_attributes):\n read_count = min(self.max_read_size, remaining_len)\n m = SMB2Message(SMB2ReadRequest(fid, offset, read_count))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback,\n tid = tid, fid = fid, offset = offset,\n remaining_len = remaining_len,\n read_len = read_len,\n file_attributes = file_attributes)\n\n def readCB(read_message, **kwargs):\n # To avoid crazy memory usage when retrieving large files, we do not save every read_message in messages_history.\n if read_message.status == 0:\n data_len = read_message.payload.data_length\n file_obj.write(read_message.payload.data)\n\n remaining_len = kwargs['remaining_len'] - data_len\n\n if remaining_len > 0:\n sendRead(kwargs['tid'], kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes'])\n if self.pbar:\n self.pbar.update(data_len)\n else:\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n closeFid(kwargs['tid'], kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len ))\n else:\n self._pushToArray(messages_history, read_message)\n closeFid(kwargs['tid'], kwargs['fid'], error = read_message.status)\n\n def closeFid(tid, fid, ret = None, error = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, ret = ret, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['ret'] is not None:\n callback(kwargs['ret'])\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _storeFile_SMB2(self, service_name, path, file_obj, callback, errback, timeout = 30):\n self._storeFileFromOffset_SMB2(service_name, path, file_obj, callback, errback, 0, True, timeout)\n\n def _storeFileFromOffset_SMB2(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n if show_progress:\n total_bytes = os.stat(file_obj.name).st_size\n tqdm_kwargs.setdefault(\"total\", total_bytes)\n tqdm_kwargs.setdefault(\"unit\", \"B\")\n tqdm_kwargs.setdefault(\"unit_scale\", True)\n tqdm_kwargs.setdefault(\"unit_divisor\", 1024)\n tqdm_kwargs.setdefault(\"desc\", f\"Uploading {path}\")\n self.pbar = tqdm(**tqdm_kwargs)\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(b\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 20 00 00 00 10 00 04 00\n00 00 18 00 08 00 00 00 41 6c 53 69 00 00 00 00\n85 62 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = ATTR_ARCHIVE,\n access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | FILE_READ_EA | FILE_WRITE_EA | READ_CONTROL | SYNCHRONIZE,\n share_access = 0,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE,\n create_disp = FILE_OVERWRITE_IF if truncate else FILE_OPEN_IF,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n create_message.tid = kwargs['tid']\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n sendWrite(create_message.tid, create_message.payload.fid, starting_offset)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendWrite(tid, fid, offset):\n write_count = self.max_write_size\n data = file_obj.read(write_count)\n data_len = len(data)\n if data_len > 0:\n m = SMB2Message(SMB2WriteRequest(fid, data, offset))\n m.tid = tid\n self._sendSMBMessage(m)\n if self.pbar:\n self.pbar.update(data_len)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, tid = tid, fid = fid, offset = offset+data_len)\n else:\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n closeFid(tid, fid, offset = offset)\n\n def writeCB(write_message, **kwargs):\n # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.\n if write_message.status == 0:\n sendWrite(kwargs['tid'], kwargs['fid'], kwargs['offset'])\n else:\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n self._pushToArray(messages_history, write_message)\n closeFid(kwargs['tid'], kwargs['fid'])\n errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid, error = None, offset = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, fid = fid, offset = offset, error = error)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['offset'] is not None:\n callback(( file_obj, kwargs['offset'] )) # Note that this is a tuple of 2-elements\n elif kwargs['error'] is not None:\n errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n\n def _deleteFiles_SMB2(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n pattern = None\n path = path_file_pattern.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n else:\n path_components = path.split('\\\\')\n if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1:\n path = '\\\\'.join(path_components[:-1])\n pattern = path_components[-1]\n messages_history, files_queue = [ ], [ ]\n\n if pattern is None:\n path_components = path.split('\\\\')\n if len(path_components) > 1:\n files_queue.append(( '\\\\'.join(path_components[:-1]), path_components[-1] ))\n else:\n files_queue.append(( '', path ))\n\n def deleteCB(path):\n if files_queue:\n p, filename = files_queue.pop(0)\n if filename:\n if p:\n filename = p + '\\\\' + filename\n self._deleteFiles_SMB2__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout)\n else:\n self._deleteDirectory_SMB2(service_name, p, deleteCB, errback, timeout)\n else:\n callback(path_file_pattern)\n\n def listCB(files_list):\n files_queue.extend(files_list)\n deleteCB(None)\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n\n def _deleteFiles_SMB2__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30):\n folder_queue = [ ]\n files_list = [ ]\n current_path = [ path ]\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL\n\n def listCB(results):\n files = [ ]\n for f in filter(lambda x: x.filename not in [ '.', '..' ], results):\n if f.isDirectory:\n if delete_matching_folders:\n folder_queue.append(current_path[0]+'\\\\'+f.filename)\n else:\n files.append(( current_path[0], f.filename ))\n if current_path[0]!=path and delete_matching_folders:\n files.append(( current_path[0], None ))\n\n if files:\n files_list[0:0] = files\n\n if folder_queue:\n p = folder_queue.pop()\n current_path[0] = p\n self._listPath_SMB2(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30)\n else:\n callback(files_list)\n\n self._listPath_SMB2(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout)\n\n def _deleteFiles_SMB2__del(self, service_name, tid, path, callback, errback, timeout = 30):\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(b\"\"\"\n 28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n 44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n 00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n 00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n 00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n 51 46 69 64 00 00 00 00\n \"\"\".replace(b' ', b'').replace(b'\\n', b''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = DELETE | FILE_READ_ATTRIBUTES,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_NON_DIRECTORY_FILE,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(open_message, **kwargs):\n open_message.tid = kwargs['tid']\n self._pushToArray(messages_history, open_message)\n if open_message.status == 0:\n sendDelete(open_message.tid, open_message.payload.fid)\n elif open_message.status == 0xc0000034: # STATUS_OBJECT_NAME_NOT_FOUND\n callback(path)\n elif open_message.status == 0xC00000BA: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY\n errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append \"/*\" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history))\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendDelete(tid, fid):\n m = SMB2Message(SMB2SetInfoRequest(fid,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 0x0d, # SMB2_FILE_DISPOSITION_INFO\n data = b'\\x01'))\n # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4.11\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if delete_message.status == 0:\n closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status)\n\n def closeFid(tid, fid, status = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['status'] == 0:\n callback(path)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n sendCreate(tid)\n\n def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, file_attributes = ATTR_NORMAL, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path_file_pattern.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(b\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_WRITE_ATTRIBUTES,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = 0,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if open_message.status == 0:\n sendReset(kwargs['tid'], open_message.payload.fid)\n else:\n errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendReset(tid, fid):\n m = SMB2Message(SMB2SetInfoRequest(fid,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 4, # FileBasicInformation\n data = struct.pack('qqqqii', 0, 0, 0, 0, file_attributes, 0)))\n # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4, [MS-FSCC]: 2.4.7, [MS-FSCC]: 2.6\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, tid = tid, fid = fid)\n self._pushToArray(messages_history, m)\n\n def resetCB(reset_message, **kwargs):\n self._pushToArray(messages_history, reset_message)\n if reset_message.status == 0:\n closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], status = reset_message.status)\n\n def closeFid(tid, fid, status = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['status'] == 0:\n callback(path_file_pattern)\n else:\n errback(OperationFailure('Failed to reset attributes of %s on %s: Reset failed' % ( path, service_name ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _createDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(b\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = FILE_READ_DATA | FILE_WRITE_DATA | FILE_READ_EA | FILE_WRITE_EA | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | READ_CONTROL | DELETE | SYNCHRONIZE,\n share_access = 0,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,\n create_disp = FILE_CREATE,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n closeFid(kwargs['tid'], create_message.payload.fid)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n callback(path)\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _deleteDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n messages_history = [ ]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(b\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n m = SMB2Message(SMB2CreateRequest(path,\n file_attributes = 0,\n access_mask = DELETE | FILE_READ_ATTRIBUTES,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_DIRECTORY_FILE,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if open_message.status == 0:\n sendDelete(kwargs['tid'], open_message.payload.fid)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to open directory' % ( path, service_name ), messages_history))\n\n def sendDelete(tid, fid):\n m = SMB2Message(SMB2SetInfoRequest(fid,\n additional_info = 0,\n info_type = SMB2_INFO_FILE,\n file_info_class = 0x0d, # SMB2_FILE_DISPOSITION_INFO\n data = b'\\x01'))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if delete_message.status == 0:\n closeFid(kwargs['tid'], kwargs['fid'], status = 0)\n else:\n closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status)\n\n def closeFid(tid, fid, status = None):\n m = SMB2Message(SMB2CloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, status = status)\n self._pushToArray(messages_history, m)\n\n def closeCB(close_message, **kwargs):\n if kwargs['status'] == 0:\n callback(path)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if connect_message.status == 0:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMB2Message(SMB2TreeConnectRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name )))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _rename_SMB2(self, service_name, old_path, new_path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n messages_history = [ ]\n\n new_path = new_path.replace('/', '\\\\')\n if new_path.startswith('\\\\'):\n new_path = new_path[1:]\n if new_path.endswith('\\\\'):\n new_path = new_path[:-1]\n\n old_path = old_path.replace('/', '\\\\')\n if old_path.startswith('\\\\'):\n old_path = old_path[1:]\n if old_path.endswith('\\\\'):\n old_path = old_path[:-1]\n\n def sendCreate(tid):\n create_context_data = binascii.unhexlify(b\"\"\"\n28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00\n44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00\n00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00\n00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00\n51 46 69 64 00 00 00 00\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n m = SMB2Message(SMB2CreateRequest(old_path,\n file_attributes = 0,\n access_mask = DELETE | FILE_READ_ATTRIBUTES | SYNCHRONIZE,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,\n oplock = SMB2_OPLOCK_LEVEL_NONE,\n impersonation = SEC_IMPERSONATE,\n create_options = FILE_SYNCHRONOUS_IO_NONALERT,\n create_disp = FILE_OPEN,\n create_context_data = create_context_data))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if create_message.status == 0:\n sendRename(kwargs['tid'], create_message.payload.fid)\n else:\n errback(OperationFailure('Failed to rename %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history))\n\n def sendRename(tid, fid):\n data = b'\\x00'*16 + struct.pack('= 0xFFFF: # MID cannot be 0xFFFF. [MS-CIFS]: 2.2.1.6.2\n # We don't use MID of 0 as MID can be reused for SMB_COM_TRANSACTION2_SECONDARY messages\n # where if mid=0, _sendSMBMessage will re-assign new MID values again\n self.mid = 1\n return self.mid\n\n def _updateState_SMB1(self, message):\n if message.isReply:\n if message.command == SMB_COM_NEGOTIATE:\n if not message.status.hasError:\n self.has_negotiated = True\n self.log.info('SMB dialect negotiation successful (ExtendedSecurity:%s)', message.hasExtendedSecurity)\n self._updateServerInfo(message.payload)\n self._handleNegotiateResponse(message)\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_NEGOTIATE' % message.status.internal_value,\n message.raw_data, message)\n elif message.command == SMB_COM_SESSION_SETUP_ANDX:\n if message.hasExtendedSecurity:\n if not message.status.hasError:\n try:\n result = securityblob.decodeAuthResponseSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_COMPLETED:\n self.log.debug('SMB uid is now %d', message.uid)\n self.uid = message.uid\n self.has_authenticated = True\n self.log.info('Authentication (with extended security) successful!')\n self.onAuthOK()\n else:\n raise ProtocolError('SMB_COM_SESSION_SETUP_ANDX status is 0 but security blob negResult value is %d' % result, message.raw_data, message)\n except securityblob.BadSecurityBlobError as ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif message.status.internal_value == 0xc0000016: # STATUS_MORE_PROCESSING_REQUIRED\n try:\n result, ntlm_token = securityblob.decodeChallengeSecurityBlob(message.payload.security_blob)\n if result == securityblob.RESULT_ACCEPT_INCOMPLETE:\n self._handleSessionChallenge(message, ntlm_token)\n except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ) as ex:\n raise ProtocolError(str(ex), message.raw_data, message)\n elif (message.status.internal_value == 0xc000006d # STATUS_LOGON_FAILURE\n or message.status.internal_value == 0xc0000064 # STATUS_NO_SUCH_USER\n or message.status.internal_value == 0xc000006a): # STATUS_WRONG_PASSWORD\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Please check username and password.')\n self.onAuthFailed()\n elif (message.status.internal_value == 0xc0000193 # STATUS_ACCOUNT_EXPIRED\n or message.status.internal_value == 0xC0000071): # STATUS_PASSWORD_EXPIRED\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Account or password has expired.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Account has been locked due to too many invalid logon attempts.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc0000072: # STATUS_ACCOUNT_DISABLED\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Account has been disabled.')\n self.onAuthFailed()\n elif (message.status.internal_value == 0xc000006f # STATUS_INVALID_LOGON_HOURS\n or message.status.internal_value == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED\n or message.status.internal_value == 0xc0000070): # STATUS_INVALID_WORKSTATION\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Not allowed.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Domain not trusted.')\n self.onAuthFailed()\n elif message.status.internal_value == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE\n self.has_authenticated = False\n self.log.info('Authentication (with extended security) failed. Workstation not trusted.')\n self.onAuthFailed()\n else:\n raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status.internal_value,\n message.raw_data, message)\n else:\n if message.status.internal_value == 0:\n self.log.debug('SMB uid is now %d', message.uid)\n self.uid = message.uid\n self.has_authenticated = True\n self.log.info('Authentication (without extended security) successful!')\n self.onAuthOK()\n else:\n self.has_authenticated = False\n self.log.info('Authentication (without extended security) failed. Please check username and password')\n self.onAuthFailed()\n elif message.command == SMB_COM_TREE_CONNECT_ANDX:\n try:\n req = self.pending_requests[message.mid]\n except KeyError:\n pass\n else:\n if not message.status.hasError:\n self.connected_trees[req.kwargs['path']] = message.tid\n\n req = self.pending_requests.pop(message.mid, None)\n if req:\n req.callback(message, **req.kwargs)\n return True\n\n\n def _updateServerInfo_SMB1(self, payload):\n self.capabilities = payload.capabilities\n self.security_mode = payload.security_mode\n self.max_raw_size = payload.max_raw_size\n self.max_buffer_size = payload.max_buffer_size\n self.max_mpx_count = payload.max_mpx_count\n self.use_plaintext_authentication = not bool(payload.security_mode & NEGOTIATE_ENCRYPT_PASSWORDS)\n\n if self.use_plaintext_authentication:\n self.log.warning('Remote server only supports plaintext authentication. Your password can be stolen easily over the network.')\n\n\n def _handleSessionChallenge_SMB1(self, message, ntlm_token):\n assert message.hasExtendedSecurity\n\n if message.uid and not self.uid:\n self.uid = message.uid\n\n server_challenge, server_flags, server_info = ntlm.decodeChallengeMessage(ntlm_token)\n if self.use_ntlm_v2:\n self.log.info('Performing NTLMv2 authentication (with extended security) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(self.password,\n self.username,\n server_challenge,\n server_info,\n self.domain)\n\n else:\n self.log.info('Performing NTLMv1 authentication (with extended security) with server challenge \"%s\"', binascii.hexlify(server_challenge))\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True)\n\n ntlm_data, signing_session_key = ntlm.generateAuthenticateMessage(server_flags,\n nt_challenge_response,\n lm_challenge_response,\n session_key,\n self.username,\n self.domain,\n self.my_name)\n\n if self.log.isEnabledFor(logging.DEBUG):\n self.log.debug('NT challenge response is \"%s\" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response))\n self.log.debug('LM challenge response is \"%s\" (%d bytes)', binascii.hexlify(lm_challenge_response), len(lm_challenge_response))\n\n blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(0, blob)))\n\n if self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_REQUIRE:\n self.log.info('Server requires all SMB messages to be signed')\n self.is_signing_active = (self.sign_options != SMB.SIGN_NEVER)\n elif self.security_mode & NEGOTIATE_SECURITY_SIGNATURES_ENABLE:\n self.log.info('Server supports SMB signing')\n self.is_signing_active = (self.sign_options == SMB.SIGN_WHEN_SUPPORTED)\n else:\n self.is_signing_active = False\n\n if self.is_signing_active:\n self.log.info(\"SMB signing activated. All SMB messages will be signed.\")\n self.signing_session_key = signing_session_key\n if self.capabilities & CAP_EXTENDED_SECURITY:\n self.signing_challenge_response = None\n else:\n self.signing_challenge_response = blob\n else:\n self.log.info(\"SMB signing deactivated. SMB messages will NOT be signed.\")\n\n\n def _handleNegotiateResponse_SMB1(self, message):\n if message.uid and not self.uid:\n self.uid = message.uid\n\n if message.hasExtendedSecurity or message.payload.supportsExtendedSecurity:\n ntlm_data = ntlm.generateNegotiateMessage()\n blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__WithSecurityExtension(message.payload.session_key, blob)))\n else:\n nt_password, _, _ = ntlm.generateChallengeResponseV1(self.password, message.payload.challenge, False)\n self.log.info('Performing NTLMv1 authentication (without extended security) with challenge \"%s\" and hashed password of \"%s\"',\n binascii.hexlify(message.payload.challenge),\n binascii.hexlify(nt_password))\n self._sendSMBMessage(SMBMessage(ComSessionSetupAndxRequest__NoSecurityExtension(message.payload.session_key,\n self.username,\n nt_password,\n True,\n self.domain)))\n\n def _listShares_SMB1(self, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = 'IPC$'\n messages_history = [ ]\n\n def connectSrvSvc(tid):\n m = SMBMessage(ComNTCreateAndxRequest('\\\\srvsvc',\n flags = NT_CREATE_REQUEST_EXTENDED_RESPONSE,\n access_mask = READ_CONTROL | FILE_WRITE_ATTRIBUTES | FILE_READ_ATTRIBUTES | FILE_WRITE_EA | FILE_READ_EA | FILE_APPEND_DATA | FILE_WRITE_DATA | FILE_READ_DATA,\n share_access = FILE_SHARE_READ | FILE_SHARE_WRITE,\n create_disp = FILE_OPEN,\n create_options = FILE_OPEN_NO_RECALL | FILE_NON_DIRECTORY_FILE,\n impersonation = SEC_IMPERSONATE,\n security_flags = 0))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback)\n self._pushToArray(messages_history, m)\n\n def connectSrvSvcCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if not create_message.status.hasError:\n call_id = self._getNextRPCCallID()\n # See [MS-CIFS]: 2.2.5.6.1 for more information on TRANS_TRANSACT_NMPIPE (0x0026) parameters\n setup_bytes = struct.pack(' data_length:\n return data_bytes[offset:]\n\n next_offset, _, \\\n create_time, last_access_time, last_write_time, last_attr_change_time, \\\n file_size, alloc_size, file_attributes, filename_length, ea_size, \\\n short_name_length, _, short_name = struct.unpack(info_format, data_bytes[offset:offset+info_size])\n\n offset2 = offset + info_size\n if offset2 + filename_length > data_length:\n return data_bytes[offset:]\n\n filename = DataFaultToleranceStrategy.data_bytes_decode(data_bytes[offset2:offset2+filename_length])\n short_name = DataFaultToleranceStrategy.data_bytes_decode(short_name)\n\n accept_result = False\n if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc\n accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n else:\n accept_result = (file_attributes & search) > 0\n if accept_result:\n results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time),\n convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time),\n file_size, alloc_size, file_attributes, short_name, filename))\n\n if next_offset:\n offset += next_offset\n else:\n break\n return b''\n\n def findFirstCB(find_message, **kwargs):\n self._pushToArray(messages_history, find_message)\n if not find_message.status.hasError:\n if 'total_count' not in kwargs:\n # TRANS2_FIND_FIRST2 response. [MS-CIFS]: 2.2.6.2.2\n sid, search_count, end_of_search, _, last_name_offset = struct.unpack(' 0:\n tqdm_kwargs.setdefault(\"total\", max_length)\n tqdm_kwargs.setdefault(\"unit\", \"B\")\n tqdm_kwargs.setdefault(\"unit_scale\", True)\n tqdm_kwargs.setdefault(\"unit_divisor\", 1024)\n tqdm_kwargs.setdefault(\"desc\", f\"Downloading {path}\")\n self.pbar = tqdm(**tqdm_kwargs)\n sendRead(open_message.tid, open_message.payload.fid, starting_offset, open_message.payload.file_attributes, 0, max_length)\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendRead(tid, fid, offset, file_attributes, read_len, remaining_len):\n read_count = self.max_raw_size - 2\n m = SMBMessage(ComReadAndxRequest(fid = fid,\n offset = offset,\n max_return_bytes_count = read_count,\n min_return_bytes_count = min(0xFFFF, read_count)))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, fid = fid, offset = offset, file_attributes = file_attributes,\n read_len = read_len, remaining_len = remaining_len)\n\n def readCB(read_message, **kwargs):\n # To avoid crazy memory usage when retrieving large files, we do not save every read_message in messages_history.\n if not read_message.status.hasError:\n read_len = kwargs['read_len']\n remaining_len = kwargs['remaining_len']\n data_len = read_message.payload.data_length\n if max_length > 0:\n if data_len > remaining_len:\n file_obj.write(read_message.payload.data[:remaining_len])\n read_len += remaining_len\n remaining_len = 0\n else:\n file_obj.write(read_message.payload.data)\n remaining_len -= data_len\n read_len += data_len\n else:\n file_obj.write(read_message.payload.data)\n read_len += data_len\n\n if self.pbar:\n self.pbar.update(data_len)\n\n if (max_length > 0 and remaining_len <= 0) or data_len < (self.max_raw_size - 2):\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n closeFid(read_message.tid, kwargs['fid'])\n callback(( file_obj, kwargs['file_attributes'], read_len )) # Note that this is a tuple of 3-elements\n else:\n sendRead(read_message.tid, kwargs['fid'], kwargs['offset']+data_len, kwargs['file_attributes'], read_len, remaining_len)\n else:\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n self._pushToArray(messages_history, read_message)\n closeFid(read_message.tid, kwargs['fid'])\n errback(OperationFailure('Failed to retrieve %s on %s: Read failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid):\n m = SMBMessage(ComCloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self._pushToArray(messages_history, m)\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendOpen(connect_message.tid)\n else:\n errback(OperationFailure('Failed to retrieve %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendOpen(self.connected_trees[service_name])\n\n def _storeFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n self._storeFileFromOffset_SMB1(service_name, path, file_obj, callback, errback, 0, True, timeout, show_progress, tqdm_kwargs)\n\n def _storeFileFromOffset_SMB1(self, service_name, path, file_obj, callback, errback, starting_offset, truncate = False, timeout = 30, show_progress = False, tqdm_kwargs = { }):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n path = path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendOpen(tid):\n m = SMBMessage(ComOpenAndxRequest(filename = path,\n access_mode = 0x0041, # Sharing mode: Deny nothing to others + Open for writing\n open_mode = 0x0012 if truncate else 0x0011, # Create file if file does not exist. Overwrite or append depending on truncate parameter.\n search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM,\n timeout = timeout * 1000))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)\n self._pushToArray(messages_history, m)\n\n def openCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if not open_message.status.hasError:\n if show_progress:\n tqdm_kwargs.setdefault(\"unit\", \"B\")\n tqdm_kwargs.setdefault(\"unit_scale\", True)\n tqdm_kwargs.setdefault(\"unit_divisor\", 1024)\n tqdm_kwargs.setdefault(\"desc\", f\"Uploading {path}\")\n self.pbar = tqdm(**tqdm_kwargs)\n sendWrite(open_message.tid, open_message.payload.fid, starting_offset)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history))\n\n def sendWrite(tid, fid, offset):\n # [MS-SMB] 2.2.4.5.2.2: The total SMB message size (inclusive of SMB header) must be not exceed the max_buffer_size.\n write_count = min(self.max_buffer_size-64, 0xFFFF-64) # SMB header is 32-bytes. We factor in another 32-bytes for the message parameter block\n data_bytes = file_obj.read(write_count)\n data_len = len(data_bytes)\n if data_len > 0:\n m = SMBMessage(ComWriteAndxRequest(fid = fid, offset = offset, data_bytes = data_bytes))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, fid = fid, offset = offset+data_len)\n else:\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n closeFid(tid, fid)\n callback(( file_obj, offset )) # Note that this is a tuple of 2-elements\n\n def writeCB(write_message, **kwargs):\n # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.\n if not write_message.status.hasError:\n if self.pbar:\n self.pbar.update(kwargs['offset'])\n sendWrite(write_message.tid, kwargs['fid'], kwargs['offset'])\n else:\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n self._pushToArray(messages_history, write_message)\n closeFid(write_message.tid, kwargs['fid'])\n errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history))\n\n def closeFid(tid, fid):\n m = SMBMessage(ComCloseRequest(fid))\n m.tid = tid\n self._sendSMBMessage(m)\n self._pushToArray(messages_history, m)\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendOpen(connect_message.tid)\n else:\n errback(OperationFailure('Failed to store %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendOpen(self.connected_trees[service_name])\n\n def _deleteFiles_SMB1(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n pattern = None\n path = path_file_pattern.replace('/', '\\\\')\n if path.startswith('\\\\'):\n path = path[1:]\n if path.endswith('\\\\'):\n path = path[:-1]\n else:\n path_components = path.split('\\\\')\n if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1:\n path = '\\\\'.join(path_components[:-1])\n pattern = path_components[-1]\n messages_history, files_queue = [ ], [ ]\n\n if pattern is None:\n path_components = path.split('\\\\')\n if len(path_components) > 1:\n files_queue.append(( '\\\\'.join(path_components[:-1]), path_components[-1] ))\n else:\n files_queue.append(( '', path ))\n\n def deleteCB(path):\n if files_queue:\n p, filename = files_queue.pop(0)\n if filename:\n if p:\n filename = p + '\\\\' + filename\n self._deleteFiles_SMB1__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout)\n else:\n self._deleteDirectory_SMB1(service_name, p, deleteCB, errback, timeout = 30)\n else:\n callback(path_file_pattern)\n\n def listCB(files_list):\n files_queue.extend(files_list)\n deleteCB(None)\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n else:\n errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n if files_queue:\n deleteCB(None)\n else:\n self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout)\n\n def _deleteFiles_SMB1__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30):\n folder_queue = [ ]\n files_list = [ ]\n current_path = [ path ]\n search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL\n\n def listCB(results):\n files = [ ]\n for f in filter(lambda x: x.filename not in [ '.', '..' ], results):\n if f.isDirectory:\n if delete_matching_folders:\n folder_queue.append(current_path[0]+'\\\\'+f.filename)\n else:\n files.append(( current_path[0], f.filename ))\n if current_path[0]!=path and delete_matching_folders:\n files.append(( current_path[0], None ))\n\n if files:\n files_list[0:0] = files\n\n if folder_queue:\n p = folder_queue.pop()\n current_path[0] = p\n self._listPath_SMB1(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30)\n else:\n callback(files_list)\n\n self._listPath_SMB1(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout)\n\n def _deleteFiles_SMB1__del(self, service_name, tid, path, callback, errback, timeout = 30):\n messages_history = [ ]\n\n def sendDelete(tid):\n m = SMBMessage(ComDeleteRequest(filename_pattern = path,\n search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if not delete_message.status.hasError:\n callback(path)\n elif delete_message.status.internal_value == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE\n # If there are no matching files, we just treat as success instead of failing\n callback(path)\n elif delete_message.status.internal_value == 0xC00000BA: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY\n errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append \"/*\" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history))\n elif delete_message.status.internal_value == 0xC0000034: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID\n errback(OperationFailure('Failed to delete %s on %s: Path not found' % ( path, service_name ), messages_history))\n else:\n errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n sendDelete(tid)\n\n def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, file_attributes=ATTR_NORMAL, timeout = 30):\n raise NotReadyError('resetFileAttributes is not yet implemented for SMB1')\n\n def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n path = path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendCreate(tid):\n m = SMBMessage(ComCreateDirectoryRequest(path))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback)\n self._pushToArray(messages_history, m)\n\n def createCB(create_message, **kwargs):\n self._pushToArray(messages_history, create_message)\n if not create_message.status.hasError:\n callback(path)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendCreate(connect_message.tid)\n else:\n errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendCreate(self.connected_trees[service_name])\n\n def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n path = path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendDelete(tid):\n m = SMBMessage(ComDeleteDirectoryRequest(path))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback)\n self._pushToArray(messages_history, m)\n\n def deleteCB(delete_message, **kwargs):\n self._pushToArray(messages_history, delete_message)\n if not delete_message.status.hasError:\n callback(path)\n else:\n errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendDelete(connect_message.tid)\n else:\n errback(OperationFailure('Failed to delete directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendDelete(self.connected_trees[service_name])\n\n def _rename_SMB1(self, service_name, old_path, new_path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n new_path = new_path.replace('/', '\\\\')\n old_path = old_path.replace('/', '\\\\')\n messages_history = [ ]\n\n def sendRename(tid):\n m = SMBMessage(ComRenameRequest(old_path = old_path,\n new_path = new_path,\n search_attributes = SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback)\n self._pushToArray(messages_history, m)\n\n def renameCB(rename_message, **kwargs):\n self._pushToArray(messages_history, rename_message)\n if not rename_message.status.hasError:\n callback(( old_path, new_path )) # Note that this is a tuple of 2-elements\n else:\n errback(OperationFailure('Failed to rename %s on %s: Rename failed' % ( old_path, service_name ), messages_history))\n\n if service_name not in self.connected_trees:\n def connectCB(connect_message, **kwargs):\n self._pushToArray(messages_history, connect_message)\n if not connect_message.status.hasError:\n self.connected_trees[service_name] = connect_message.tid\n sendRename(connect_message.tid)\n else:\n errback(OperationFailure('Failed to rename %s on %s: Unable to connect to shared device' % ( old_path, service_name ), messages_history))\n\n m = SMBMessage(ComTreeConnectAndxRequest(r'\\\\%s\\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, ''))\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name)\n self._pushToArray(messages_history, m)\n else:\n sendRename(self.connected_trees[service_name])\n\n def _listSnapshots_SMB1(self, service_name, path, callback, errback, timeout = 30):\n if not self.has_authenticated:\n raise NotReadyError('SMB connection not authenticated')\n\n expiry_time = time.time() + timeout\n path = path.replace('/', '\\\\')\n if not path.endswith('\\\\'):\n path += '\\\\'\n messages_history = [ ]\n results = [ ]\n\n def sendOpen(tid):\n m = SMBMessage(ComOpenAndxRequest(filename = path,\n access_mode = 0x0040, # Sharing mode: Deny nothing to others\n open_mode = 0x0001, # Failed if file does not exist\n search_attributes = 0,\n timeout = timeout * 1000))\n m.tid = tid\n self._sendSMBMessage(m)\n self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, openCB, errback)\n self._pushToArray(messages_history, m)\n\n def openCB(open_message, **kwargs):\n self._pushToArray(messages_history, open_message)\n if not open_message.status.hasError:\n sendEnumSnapshots(open_message.tid, open_message.payload.fid)\n else:\n errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open path' % ( path, service_name ), messages_history))\n\n def sendEnumSnapshots(tid, fid):\n # [MS-CIFS]: 2.2.7.2\n # [MS-SMB]: 2.2.7.2.1\n setup_bytes = struct.pack(' 10:\n messages_history.pop(0)\n messages_history.append(message)\n\nclass SharedDevice:\n \"\"\"\n Contains information about a single shared device on the remote server.\n\n The following attributes are available:\n\n * name : An unicode string containing the name of the shared device\n * comments : An unicode string containing the user description of the shared device\n \"\"\"\n\n # The following constants are taken from [MS-SRVS]: 2.2.2.4\n # They are used to identify the type of shared resource from the results from the NetrShareEnum in Server Service RPC\n DISK_TREE = 0x00\n PRINT_QUEUE = 0x01\n COMM_DEVICE = 0x02\n IPC = 0x03\n\n def __init__(self, type, name, comments):\n self._type = type\n self.name = name #: An unicode string containing the name of the shared device\n self.comments = comments #: An unicode string containing the user description of the shared device\n\n @property\n def type(self):\n \"\"\"\n Returns one of the following integral constants.\n - SharedDevice.DISK_TREE\n - SharedDevice.PRINT_QUEUE\n - SharedDevice.COMM_DEVICE\n - SharedDevice.IPC\n \"\"\"\n return self._type & 0xFFFF\n\n @property\n def isSpecial(self):\n \"\"\"\n Returns True if this shared device is a special share reserved for interprocess communication (IPC$)\n or remote administration of the server (ADMIN$). Can also refer to administrative shares such as\n C$, D$, E$, and so forth\n \"\"\"\n return bool(self._type & 0x80000000)\n\n @property\n def isTemporary(self):\n \"\"\"\n Returns True if this is a temporary share that is not persisted for creation each time the file server initializes.\n \"\"\"\n return bool(self._type & 0x40000000)\n\n def __unicode__(self):\n return 'Shared device: %s (type:0x%02x comments:%s)' % (self.name, self.type, self.comments )\n\n\nclass SharedFile:\n \"\"\"\n Contain information about a file/folder entry that is shared on the shared device.\n\n As an application developer, you should not need to instantiate a *SharedFile* instance directly in your application.\n These *SharedFile* instances are usually returned via a call to *listPath* method in :doc:`smb.SMBProtocol.SMBProtocolFactory`.\n\n If you encounter *SharedFile* instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond\n to any files/folders on your remote shared device, it could be that the original filename on the file/folder entry on the shared device contains\n one of these prohibited characters: \"\\\\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).\n\n The following attributes are available:\n\n * create_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of creation of this file resource on the remote server\n * last_access_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last access of this file resource on the remote server\n * last_write_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last modification of this file resource on the remote server\n * last_attr_change_time : Float value in number of seconds since 1970-01-01 00:00:00 to the time of last attribute change of this file resource on the remote server\n * file_size : File size in number of bytes\n * alloc_size : Total number of bytes allocated to store this file\n * file_attributes : A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.\n * short_name : Unicode string containing the short name of this file (usually in 8.3 notation)\n * filename : Unicode string containing the long filename of this file. Each OS has a limit to the length of this file name. On Windows, it is 256 characters.\n * file_id : Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17\n \"\"\"\n\n def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename, file_id=None):\n self.create_time = create_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of creation of this file resource on the remote server\n self.last_access_time = last_access_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last access of this file resource on the remote server\n self.last_write_time = last_write_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last modification of this file resource on the remote server\n self.last_attr_change_time = last_attr_change_time #: Float value in number of seconds since 1970-01-01 00:00:00 to the time of last attribute change of this file resource on the remote server\n self.file_size = file_size #: File size in number of bytes\n self.alloc_size = alloc_size #: Total number of bytes allocated to store this file\n self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.\n self.short_name = short_name #: Unicode string containing the short name of this file (usually in 8.3 notation)\n self.filename = filename #: Unicode string containing the long filename of this file. Each OS has a limit to the length of this file name. On Windows, it is 256 characters.\n self.file_id = file_id #: Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17\n\n @property\n def isDirectory(self):\n \"\"\"A convenience property to return True if this file resource is a directory on the remote server\"\"\"\n return bool(self.file_attributes & ATTR_DIRECTORY)\n\n @property\n def isReadOnly(self):\n \"\"\"A convenient property to return True if this file resource is read-only on the remote server\"\"\"\n return bool(self.file_attributes & ATTR_READONLY)\n\n @property\n def isNormal(self):\n \"\"\"\n A convenient property to return True if this is a normal file.\n\n Note that pysmb defines a normal file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.\n It ignores other attributes like compression, indexed, sparse, temporary and encryption.\n \"\"\"\n return (self.file_attributes==ATTR_NORMAL) or ((self.file_attributes & 0xff)==0)\n\n def __unicode__(self):\n return 'Shared file: %s (FileSize:%d bytes, isDirectory:%s)' % ( self.filename, self.file_size, self.isDirectory )\n\n\nclass _PendingRequest:\n\n def __init__(self, mid, expiry_time, callback, errback, **kwargs):\n self.mid = mid\n self.expiry_time = expiry_time\n self.callback = callback\n self.errback = errback\n self.kwargs = kwargs\n" }, { "path": "python3/smb/ntlm.py", "content": "\nimport types, hmac, binascii, struct, random, string\nfrom .utils.rc4 import RC4_encrypt\nfrom .utils.pyDes import des\n\ntry:\n import hashlib\n hashlib.new('md4')\n\n def MD4(): return hashlib.new('md4')\nexcept ( ImportError, ValueError ):\n from .utils.md4 import MD4\n\ntry:\n import hashlib\n def MD5(s): return hashlib.md5(s)\nexcept ImportError:\n import md5\n def MD5(s): return md5.new(s)\n\n################\n# NTLMv2 Methods\n################\n\n# The following constants are defined in accordance to [MS-NLMP]: 2.2.2.5\n\nNTLM_NegotiateUnicode = 0x00000001\nNTLM_NegotiateOEM = 0x00000002\nNTLM_RequestTarget = 0x00000004\nNTLM_Unknown9 = 0x00000008\nNTLM_NegotiateSign = 0x00000010\nNTLM_NegotiateSeal = 0x00000020\nNTLM_NegotiateDatagram = 0x00000040\nNTLM_NegotiateLanManagerKey = 0x00000080\nNTLM_Unknown8 = 0x00000100\nNTLM_NegotiateNTLM = 0x00000200\nNTLM_NegotiateNTOnly = 0x00000400\nNTLM_Anonymous = 0x00000800\nNTLM_NegotiateOemDomainSupplied = 0x00001000\nNTLM_NegotiateOemWorkstationSupplied = 0x00002000\nNTLM_Unknown6 = 0x00004000\nNTLM_NegotiateAlwaysSign = 0x00008000\nNTLM_TargetTypeDomain = 0x00010000\nNTLM_TargetTypeServer = 0x00020000\nNTLM_TargetTypeShare = 0x00040000\nNTLM_NegotiateExtendedSecurity = 0x00080000\nNTLM_NegotiateIdentify = 0x00100000\nNTLM_Unknown5 = 0x00200000\nNTLM_RequestNonNTSessionKey = 0x00400000\nNTLM_NegotiateTargetInfo = 0x00800000\nNTLM_Unknown4 = 0x01000000\nNTLM_NegotiateVersion = 0x02000000\nNTLM_Unknown3 = 0x04000000\nNTLM_Unknown2 = 0x08000000\nNTLM_Unknown1 = 0x10000000\nNTLM_Negotiate128 = 0x20000000\nNTLM_NegotiateKeyExchange = 0x40000000\nNTLM_Negotiate56 = 0x80000000\n\nNTLM_FLAGS = NTLM_NegotiateUnicode | \\\n NTLM_RequestTarget | \\\n NTLM_NegotiateSign | \\\n NTLM_NegotiateNTLM | \\\n NTLM_NegotiateAlwaysSign | \\\n NTLM_NegotiateExtendedSecurity | \\\n NTLM_NegotiateTargetInfo | \\\n NTLM_NegotiateVersion | \\\n NTLM_Negotiate128 | \\\n NTLM_NegotiateKeyExchange\n\ndef generateNegotiateMessage():\n \"\"\"\n References:\n ===========\n - [MS-NLMP]: 2.2.1.1\n \"\"\"\n s = struct.pack('<8sII8s8s8s',\n b'NTLMSSP\\0', 0x01, NTLM_FLAGS,\n b'\\0' * 8, # Domain\n b'\\0' * 8, # Workstation\n b'\\x06\\x00\\x72\\x17\\x00\\x00\\x00\\x0F') # Version [MS-NLMP]: 2.2.2.10\n return s\n\n\ndef generateAuthenticateMessage(challenge_flags, nt_response, lm_response, request_session_key, user, domain = 'WORKGROUP', workstation = 'LOCALHOST'):\n \"\"\"\n References:\n ===========\n - [MS-NLMP]: 2.2.1.3\n \"\"\"\n FORMAT = '<8sIHHIHHIHHIHHIHHIHHII'\n FORMAT_SIZE = struct.calcsize(FORMAT)\n\n # [MS-NLMP]: 3.1.5.1.2\n # http://grutz.jingojango.net/exploits/davenport-ntlm.html\n session_key = session_signing_key = request_session_key\n if challenge_flags & NTLM_NegotiateKeyExchange:\n session_signing_key = \"\".join([ random.choice(string.digits+string.ascii_letters) for _ in range(16) ]).encode('ascii')\n session_key = RC4_encrypt(request_session_key, session_signing_key)\n\n lm_response_length = len(lm_response)\n lm_response_offset = FORMAT_SIZE\n nt_response_length = len(nt_response)\n nt_response_offset = lm_response_offset + lm_response_length\n domain_unicode = domain.encode('UTF-16LE')\n domain_length = len(domain_unicode)\n domain_offset = nt_response_offset + nt_response_length\n\n padding = b''\n if domain_offset % 2 != 0:\n padding = b'\\0'\n domain_offset += 1\n\n user_unicode = user.encode('UTF-16LE')\n user_length = len(user_unicode)\n user_offset = domain_offset + domain_length\n workstation_unicode = workstation.encode('UTF-16LE')\n workstation_length = len(workstation_unicode)\n workstation_offset = user_offset + user_length\n session_key_length = len(session_key)\n session_key_offset = workstation_offset + workstation_length\n\n auth_flags = challenge_flags\n auth_flags &= ~NTLM_NegotiateVersion\n\n s = struct.pack(FORMAT,\n b'NTLMSSP\\0', 0x03,\n lm_response_length, lm_response_length, lm_response_offset,\n nt_response_length, nt_response_length, nt_response_offset,\n domain_length, domain_length, domain_offset,\n user_length, user_length, user_offset,\n workstation_length, workstation_length, workstation_offset,\n session_key_length, session_key_length, session_key_offset,\n auth_flags)\n\n return s + lm_response + nt_response + padding + domain_unicode + user_unicode + workstation_unicode + session_key, session_signing_key\n\n\ndef decodeChallengeMessage(ntlm_data):\n \"\"\"\n References:\n ===========\n - [MS-NLMP]: 2.2.1.2\n - [MS-NLMP]: 2.2.2.1 (AV_PAIR)\n \"\"\"\n FORMAT = '<8sIHHII8s8sHHI'\n FORMAT_SIZE = struct.calcsize(FORMAT)\n\n signature, message_type, \\\n targetname_len, targetname_maxlen, targetname_offset, \\\n flags, challenge, _, \\\n targetinfo_len, targetinfo_maxlen, targetinfo_offset, \\\n = struct.unpack(FORMAT, bytes(ntlm_data[:FORMAT_SIZE]))\n\n assert signature == b'NTLMSSP\\0'\n assert message_type == 0x02\n\n return challenge, flags, bytes(ntlm_data[targetinfo_offset:targetinfo_offset+targetinfo_len])\n\n\ndef generateChallengeResponseV2(password, user, server_challenge, server_info, domain = '', client_challenge = None):\n client_timestamp = b'\\0' * 8\n\n if not client_challenge:\n client_challenge = bytes([ random.getrandbits(8) for i in range(0, 8) ])\n\n assert len(client_challenge) == 8\n\n d = MD4()\n d.update(password.encode('UTF-16LE'))\n ntlm_hash = d.digest() # The NT password hash\n response_key = hmac.new(ntlm_hash, (user.upper() + domain).encode('UTF-16LE'), 'md5').digest() # The NTLMv2 password hash. In [MS-NLMP], this is the result of NTOWFv2 and LMOWFv2 functions\n temp = b'\\x01\\x01' + b'\\0'*6 + client_timestamp + client_challenge + b'\\0'*4 + server_info\n ntproofstr = hmac.new(response_key, server_challenge + temp, 'md5').digest()\n\n nt_challenge_response = ntproofstr + temp\n lm_challenge_response = hmac.new(response_key, server_challenge + client_challenge, 'md5').digest() + client_challenge\n session_key = hmac.new(response_key, ntproofstr, 'md5').digest()\n\n return nt_challenge_response, lm_challenge_response, session_key\n\n\n################\n# NTLMv1 Methods\n################\n\ndef expandDesKey(key):\n \"\"\"Expand the key from a 7-byte password key into a 8-byte DES key\"\"\"\n s = [ ((key[0] >> 1) & 0x7f) << 1,\n ((key[0] & 0x01) << 6 | ((key[1] >> 2) & 0x3f)) << 1,\n ((key[1] & 0x03) << 5 | ((key[2] >> 3) & 0x1f)) << 1,\n ((key[2] & 0x07) << 4 | ((key[3] >> 4) & 0x0f)) << 1,\n ((key[3] & 0x0f) << 3 | ((key[4] >> 5) & 0x07)) << 1,\n ((key[4] & 0x1f) << 2 | ((key[5] >> 6) & 0x03)) << 1,\n ((key[5] & 0x3f) << 1 | ((key[6] >> 7) & 0x01)) << 1,\n (key[6] & 0x7f) << 1\n ]\n return bytes(s)\n\n\ndef DESL(K, D):\n \"\"\"\n References:\n ===========\n - http://ubiqx.org/cifs/SMB.html (2.8.3.4)\n - [MS-NLMP]: Section 6\n \"\"\"\n d1 = des(expandDesKey(K[0:7]))\n d2 = des(expandDesKey(K[7:14]))\n d3 = des(expandDesKey(K[14:16] + b'\\0' * 5))\n return d1.encrypt(D) + d2.encrypt(D) + d3.encrypt(D)\n\n\ndef generateChallengeResponseV1(password, server_challenge, has_extended_security = False, client_challenge = None):\n \"\"\"\n Generate a NTLMv1 response\n\n @param password: User password string\n @param server_challange: A 8-byte challenge string sent from the server\n @param has_extended_security: A boolean value indicating whether NTLMSSP_NEGOTIATE_EXTENDED_SESSIONSECURITY flag is enabled in the NTLM negFlag\n @param client_challenge: A 8-byte string representing client challenge. If None, it will be generated randomly if needed by the response generation\n @return: a tuple of ( NT challenge response string, LM challenge response string )\n\n References:\n ===========\n - http://ubiqx.org/cifs/SMB.html (2.8.3.3 and 2.8.3.4)\n - [MS-NLMP]: 3.3.1\n \"\"\"\n _password = bytes((password.upper() + '\\0' * 14)[:14], 'ascii')\n d1 = des(expandDesKey(_password[:7]))\n d2 = des(expandDesKey(_password[7:]))\n lm_response_key = d1.encrypt(b\"KGS!@#$%\") + d2.encrypt(b\"KGS!@#$%\") # LM password hash. In [MS-NLMP], this is the result of LMOWFv1 function\n\n d = MD4()\n d.update(password.encode('UTF-16LE'))\n nt_response_key = d.digest() # In [MS-NLMP], this is the result of NTOWFv1 function\n\n if has_extended_security:\n if not client_challenge:\n client_challenge = bytes([ random.getrandbits(8) for i in range(0, 8) ])\n\n assert len(client_challenge) == 8\n\n lm_challenge_response = client_challenge + b'\\0'*16\n nt_challenge_response = DESL(nt_response_key, MD5(server_challenge + client_challenge).digest()[0:8])\n else:\n nt_challenge_response = DESL(nt_response_key, server_challenge) # The result after DESL is the NT response\n lm_challenge_response = DESL(lm_response_key, server_challenge) # The result after DESL is the LM response\n\n d = MD4()\n d.update(nt_response_key)\n session_key = d.digest()\n\n return nt_challenge_response, lm_challenge_response, session_key\n" }, { "path": "python3/smb/security_descriptors.py", "content": "\"\"\"\nThis module implements security descriptors, and the partial structures\nused in them, as specified in [MS-DTYP].\n\"\"\"\n\nimport struct\n\n\n# Security descriptor control flags\n# [MS-DTYP]: 2.4.6\nSECURITY_DESCRIPTOR_OWNER_DEFAULTED = 0x0001\nSECURITY_DESCRIPTOR_GROUP_DEFAULTED = 0x0002\nSECURITY_DESCRIPTOR_DACL_PRESENT = 0x0004\nSECURITY_DESCRIPTOR_DACL_DEFAULTED = 0x0008\nSECURITY_DESCRIPTOR_SACL_PRESENT = 0x0010\nSECURITY_DESCRIPTOR_SACL_DEFAULTED = 0x0020\nSECURITY_DESCRIPTOR_SERVER_SECURITY = 0x0040\nSECURITY_DESCRIPTOR_DACL_TRUSTED = 0x0080\nSECURITY_DESCRIPTOR_DACL_COMPUTED_INHERITANCE_REQUIRED = 0x0100\nSECURITY_DESCRIPTOR_SACL_COMPUTED_INHERITANCE_REQUIRED = 0x0200\nSECURITY_DESCRIPTOR_DACL_AUTO_INHERITED = 0x0400\nSECURITY_DESCRIPTOR_SACL_AUTO_INHERITED = 0x0800\nSECURITY_DESCRIPTOR_DACL_PROTECTED = 0x1000\nSECURITY_DESCRIPTOR_SACL_PROTECTED = 0x2000\nSECURITY_DESCRIPTOR_RM_CONTROL_VALID = 0x4000\nSECURITY_DESCRIPTOR_SELF_RELATIVE = 0x8000\n\n# ACE types\n# [MS-DTYP]: 2.4.4.1\nACE_TYPE_ACCESS_ALLOWED = 0x00\nACE_TYPE_ACCESS_DENIED = 0x01\nACE_TYPE_SYSTEM_AUDIT = 0x02\nACE_TYPE_SYSTEM_ALARM = 0x03\nACE_TYPE_ACCESS_ALLOWED_COMPOUND = 0x04\nACE_TYPE_ACCESS_ALLOWED_OBJECT = 0x05\nACE_TYPE_ACCESS_DENIED_OBJECT = 0x06\nACE_TYPE_SYSTEM_AUDIT_OBJECT = 0x07\nACE_TYPE_SYSTEM_ALARM_OBJECT = 0x08\nACE_TYPE_ACCESS_ALLOWED_CALLBACK = 0x09\nACE_TYPE_ACCESS_DENIED_CALLBACK = 0x0A\nACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT = 0x0B\nACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT = 0x0C\nACE_TYPE_SYSTEM_AUDIT_CALLBACK = 0x0D\nACE_TYPE_SYSTEM_ALARM_CALLBACK = 0x0E\nACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT = 0x0F\nACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT = 0x10\nACE_TYPE_SYSTEM_MANDATORY_LABEL = 0x11\nACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE = 0x12\nACE_TYPE_SYSTEM_SCOPED_POLICY_ID = 0x13\n\n# ACE flags\n# [MS-DTYP]: 2.4.4.1\nACE_FLAG_OBJECT_INHERIT = 0x01\nACE_FLAG_CONTAINER_INHERIT = 0x02\nACE_FLAG_NO_PROPAGATE_INHERIT = 0x04\nACE_FLAG_INHERIT_ONLY = 0x08\nACE_FLAG_INHERITED = 0x10\nACE_FLAG_SUCCESSFUL_ACCESS = 0x40\nACE_FLAG_FAILED_ACCESS = 0x80\n\n# Pre-defined well-known SIDs\n# [MS-DTYP]: 2.4.2.4\nSID_NULL = \"S-1-0-0\"\nSID_EVERYONE = \"S-1-1-0\"\nSID_LOCAL = \"S-1-2-0\"\nSID_CONSOLE_LOGON = \"S-1-2-1\"\nSID_CREATOR_OWNER = \"S-1-3-0\"\nSID_CREATOR_GROUP = \"S-1-3-1\"\nSID_OWNER_SERVER = \"S-1-3-2\"\nSID_GROUP_SERVER = \"S-1-3-3\"\nSID_OWNER_RIGHTS = \"S-1-3-4\"\nSID_NT_AUTHORITY = \"S-1-5\"\nSID_DIALUP = \"S-1-5-1\"\nSID_NETWORK = \"S-1-5-2\"\nSID_BATCH = \"S-1-5-3\"\nSID_INTERACTIVE = \"S-1-5-4\"\nSID_SERVICE = \"S-1-5-6\"\nSID_ANONYMOUS = \"S-1-5-7\"\nSID_PROXY = \"S-1-5-8\"\nSID_ENTERPRISE_DOMAIN_CONTROLLERS = \"S-1-5-9\"\nSID_PRINCIPAL_SELF = \"S-1-5-10\"\nSID_AUTHENTICATED_USERS = \"S-1-5-11\"\nSID_RESTRICTED_CODE = \"S-1-5-12\"\nSID_TERMINAL_SERVER_USER = \"S-1-5-13\"\nSID_REMOTE_INTERACTIVE_LOGON = \"S-1-5-14\"\nSID_THIS_ORGANIZATION = \"S-1-5-15\"\nSID_IUSR = \"S-1-5-17\"\nSID_LOCAL_SYSTEM = \"S-1-5-18\"\nSID_LOCAL_SERVICE = \"S-1-5-19\"\nSID_NETWORK_SERVICE = \"S-1-5-20\"\nSID_COMPOUNDED_AUTHENTICATION = \"S-1-5-21-0-0-0-496\"\nSID_CLAIMS_VALID = \"S-1-5-21-0-0-0-497\"\nSID_BUILTIN_ADMINISTRATORS = \"S-1-5-32-544\"\nSID_BUILTIN_USERS = \"S-1-5-32-545\"\nSID_BUILTIN_GUESTS = \"S-1-5-32-546\"\nSID_POWER_USERS = \"S-1-5-32-547\"\nSID_ACCOUNT_OPERATORS = \"S-1-5-32-548\"\nSID_SERVER_OPERATORS = \"S-1-5-32-549\"\nSID_PRINTER_OPERATORS = \"S-1-5-32-550\"\nSID_BACKUP_OPERATORS = \"S-1-5-32-551\"\nSID_REPLICATOR = \"S-1-5-32-552\"\nSID_ALIAS_PREW2KCOMPACC = \"S-1-5-32-554\"\nSID_REMOTE_DESKTOP = \"S-1-5-32-555\"\nSID_NETWORK_CONFIGURATION_OPS = \"S-1-5-32-556\"\nSID_INCOMING_FOREST_TRUST_BUILDERS = \"S-1-5-32-557\"\nSID_PERFMON_USERS = \"S-1-5-32-558\"\nSID_PERFLOG_USERS = \"S-1-5-32-559\"\nSID_WINDOWS_AUTHORIZATION_ACCESS_GROUP = \"S-1-5-32-560\"\nSID_TERMINAL_SERVER_LICENSE_SERVERS = \"S-1-5-32-561\"\nSID_DISTRIBUTED_COM_USERS = \"S-1-5-32-562\"\nSID_IIS_IUSRS = \"S-1-5-32-568\"\nSID_CRYPTOGRAPHIC_OPERATORS = \"S-1-5-32-569\"\nSID_EVENT_LOG_READERS = \"S-1-5-32-573\"\nSID_CERTIFICATE_SERVICE_DCOM_ACCESS = \"S-1-5-32-574\"\nSID_RDS_REMOTE_ACCESS_SERVERS = \"S-1-5-32-575\"\nSID_RDS_ENDPOINT_SERVERS = \"S-1-5-32-576\"\nSID_RDS_MANAGEMENT_SERVERS = \"S-1-5-32-577\"\nSID_HYPER_V_ADMINS = \"S-1-5-32-578\"\nSID_ACCESS_CONTROL_ASSISTANCE_OPS = \"S-1-5-32-579\"\nSID_REMOTE_MANAGEMENT_USERS = \"S-1-5-32-580\"\nSID_WRITE_RESTRICTED_CODE = \"S-1-5-33\"\nSID_NTLM_AUTHENTICATION = \"S-1-5-64-10\"\nSID_SCHANNEL_AUTHENTICATION = \"S-1-5-64-14\"\nSID_DIGEST_AUTHENTICATION = \"S-1-5-64-21\"\nSID_THIS_ORGANIZATION_CERTIFICATE = \"S-1-5-65-1\"\nSID_NT_SERVICE = \"S-1-5-80\"\nSID_USER_MODE_DRIVERS = \"S-1-5-84-0-0-0-0-0\"\nSID_LOCAL_ACCOUNT = \"S-1-5-113\"\nSID_LOCAL_ACCOUNT_AND_MEMBER_OF_ADMINISTRATORS_GROUP = \"S-1-5-114\"\nSID_OTHER_ORGANIZATION = \"S-1-5-1000\"\nSID_ALL_APP_PACKAGES = \"S-1-15-2-1\"\nSID_ML_UNTRUSTED = \"S-1-16-0\"\nSID_ML_LOW = \"S-1-16-4096\"\nSID_ML_MEDIUM = \"S-1-16-8192\"\nSID_ML_MEDIUM_PLUS = \"S-1-16-8448\"\nSID_ML_HIGH = \"S-1-16-12288\"\nSID_ML_SYSTEM = \"S-1-16-16384\"\nSID_ML_PROTECTED_PROCESS = \"S-1-16-20480\"\nSID_AUTHENTICATION_AUTHORITY_ASSERTED_IDENTITY = \"S-1-18-1\"\nSID_SERVICE_ASSERTED_IDENTITY = \"S-1-18-2\"\nSID_FRESH_PUBLIC_KEY_IDENTITY = \"S-1-18-3\"\nSID_KEY_TRUST_IDENTITY = \"S-1-18-4\"\nSID_KEY_PROPERTY_MFA = \"S-1-18-5\"\nSID_KEY_PROPERTY_ATTESTATION = \"S-1-18-6\"\n\n\nclass SID(object):\n \"\"\"\n A Windows security identifier. Represents a single principal, such a\n user or a group, as a sequence of numbers consisting of the revision,\n identifier authority, and a variable-length list of subauthorities.\n\n See [MS-DTYP]: 2.4.2\n \"\"\"\n def __init__(self, revision, identifier_authority, subauthorities):\n #: Revision, should always be 1.\n self.revision = revision\n #: An integer representing the identifier authority.\n self.identifier_authority = identifier_authority\n #: A list of integers representing all subauthorities.\n self.subauthorities = subauthorities\n\n def __str__(self):\n \"\"\"\n String representation, as specified in [MS-DTYP]: 2.4.2.1\n \"\"\"\n if self.identifier_authority >= 2**32:\n id_auth = '%#x' % (self.identifier_authority,)\n else:\n id_auth = self.identifier_authority\n auths = [self.revision, id_auth] + self.subauthorities\n return 'S-' + '-'.join(str(subauth) for subauth in auths)\n\n def __repr__(self):\n return 'SID(%r)' % (str(self),)\n\n @classmethod\n def from_bytes(cls, data, return_tail=False):\n revision, subauth_count = struct.unpack('Q', b'\\x00\\x00' + data[2:8])[0]\n subauth_data = data[8:]\n subauthorities = [struct.unpack('= size\n\n body = data[header_size:size]\n additional_data = {}\n\n # In all ACE types, the mask immediately follows the header.\n mask = struct.unpack('= size\n\n for i in range(count):\n ace_size = struct.unpack(''), os.linesep ))\n b.write('Status: 0x%08X %s' % ( self.status, os.linesep ))\n b.write('Flags: 0x%02X %s' % ( self.flags, os.linesep ))\n b.write('PID: %d %s' % ( self.pid, os.linesep ))\n b.write('MID: %d %s' % ( self.mid, os.linesep ))\n b.write('TID: %d %s' % ( self.tid, os.linesep ))\n b.write('Data: %d bytes %s%s %s' % ( len(self.data), os.linesep, str(binascii.hexlify(self.data)), os.linesep ))\n return b.getvalue()\n\n def reset(self):\n self.raw_data = b''\n self.command = 0\n self.status = 0\n self.flags = 0\n\n self.next_command_offset = 0\n self.mid = 0\n self.session_id = 0\n self.signature = b'\\0'*16\n self.payload = None\n self.data = b''\n\n # For async SMB2 message\n self.async_id = 0\n\n # For sync SMB2 message\n self.pid = 0\n self.tid = 0\n\n # Not used in this class. Maintained for compatibility with SMBMessage class\n self.flags2 = 0\n self.uid = 0\n self.security = 0\n self.parameters_data = b''\n\n def encode(self):\n \"\"\"\n Encode this SMB2 message into a series of bytes suitable to be embedded with a NetBIOS session message.\n AssertionError will be raised if this SMB message has not been initialized with a Payload instance\n\n @return: a string containing the encoded SMB2 message\n \"\"\"\n assert self.payload\n\n self.pid = os.getpid()\n self.payload.prepare(self)\n\n headers_data = struct.pack(self.HEADER_STRUCT_FORMAT,\n b'\\xFESMB', self.HEADER_SIZE, 0, self.status, self.command, 0, self.flags) + \\\n struct.pack(self.SYNC_HEADER_STRUCT_FORMAT, self.next_command_offset, self.mid, self.pid, self.tid, self.session_id, self.signature)\n return headers_data + self.data\n\n def decode(self, buf):\n \"\"\"\n Decodes the SMB message in buf.\n All fields of the SMB2Message object will be reset to default values before decoding.\n On errors, do not assume that the fields will be reinstated back to what they are before\n this method is invoked.\n\n References\n ==========\n - [MS-SMB2]: 2.2.1\n\n @param buf: data containing one complete SMB2 message\n @type buf: string\n @return: a positive integer indicating the number of bytes used in buf to decode this SMB message\n @raise ProtocolError: raised when decoding fails\n \"\"\"\n buf_len = len(buf)\n if buf_len < 64: # All SMB2 headers must be at least 64 bytes. [MS-SMB2]: 2.2.1.1, 2.2.1.2\n raise ProtocolError('Not enough data to decode SMB2 header', buf)\n\n self.reset()\n\n protocol, struct_size, self.credit_charge, self.status, \\\n self.command, self.credit_re, self.flags = struct.unpack(self.HEADER_STRUCT_FORMAT, buf[:self.HEADER_STRUCT_SIZE])\n\n if protocol != b'\\xFESMB':\n raise ProtocolError('Invalid 4-byte SMB2 protocol field', buf)\n\n if struct_size != self.HEADER_SIZE:\n raise ProtocolError('Invalid SMB2 header structure size')\n\n if self.isAsync:\n if buf_len < self.HEADER_STRUCT_SIZE+self.ASYNC_HEADER_STRUCT_SIZE:\n raise ProtocolError('Not enough data to decode SMB2 header', buf)\n\n self.next_command_offset, self.mid, self.async_id, self.session_id, \\\n self.signature = struct.unpack(self.ASYNC_HEADER_STRUCT_FORMAT,\n buf[self.HEADER_STRUCT_SIZE:self.HEADER_STRUCT_SIZE+self.ASYNC_HEADER_STRUCT_SIZE])\n else:\n if buf_len < self.HEADER_STRUCT_SIZE+self.SYNC_HEADER_STRUCT_SIZE:\n raise ProtocolError('Not enough data to decode SMB2 header', buf)\n\n self.next_command_offset, self.mid, self.pid, self.tid, self.session_id, \\\n self.signature = struct.unpack(self.SYNC_HEADER_STRUCT_FORMAT,\n buf[self.HEADER_STRUCT_SIZE:self.HEADER_STRUCT_SIZE+self.SYNC_HEADER_STRUCT_SIZE])\n\n if self.next_command_offset > 0:\n self.raw_data = buf[:self.next_command_offset]\n self.data = buf[self.HEADER_SIZE:self.next_command_offset]\n else:\n self.raw_data = buf\n self.data = buf[self.HEADER_SIZE:]\n\n self._decodeCommand()\n if self.payload:\n self.payload.decode(self)\n\n return len(self.raw_data)\n\n def _decodeCommand(self):\n if self.command == SMB2_COM_READ:\n self.payload = SMB2ReadResponse()\n elif self.command == SMB2_COM_WRITE:\n self.payload = SMB2WriteResponse()\n elif self.command == SMB2_COM_QUERY_DIRECTORY:\n self.payload = SMB2QueryDirectoryResponse()\n elif self.command == SMB2_COM_CREATE:\n self.payload = SMB2CreateResponse()\n elif self.command == SMB2_COM_CLOSE:\n self.payload = SMB2CloseResponse()\n elif self.command == SMB2_COM_QUERY_INFO:\n self.payload = SMB2QueryInfoResponse()\n elif self.command == SMB2_COM_SET_INFO:\n self.payload = SMB2SetInfoResponse()\n elif self.command == SMB2_COM_IOCTL:\n self.payload = SMB2IoctlResponse()\n elif self.command == SMB2_COM_TREE_CONNECT:\n self.payload = SMB2TreeConnectResponse()\n elif self.command == SMB2_COM_SESSION_SETUP:\n self.payload = SMB2SessionSetupResponse()\n elif self.command == SMB2_COM_NEGOTIATE:\n self.payload = SMB2NegotiateResponse()\n elif self.command == SMB2_COM_ECHO:\n self.payload = SMB2EchoResponse()\n\n @property\n def isAsync(self):\n return bool(self.flags & SMB2_FLAGS_ASYNC_COMMAND)\n\n @property\n def isReply(self):\n return bool(self.flags & SMB2_FLAGS_SERVER_TO_REDIR)\n\n\nclass Structure:\n\n def initMessage(self, message):\n pass\n\n def prepare(self, message):\n raise NotImplementedError\n\n def decode(self, message):\n raise NotImplementedError\n\n\nclass SMB2NegotiateResponse(Structure):\n \"\"\"\n Contains information on the SMB2_NEGOTIATE response from server\n\n After calling the decode method, each instance will contain the following attributes,\n - security_mode (integer)\n - dialect_revision (integer)\n - server_guid (string)\n - max_transact_size (integer)\n - max_read_size (integer)\n - max_write_size (integer)\n - system_time (long)\n - server_start_time (long)\n - security_blob (string)\n\n References:\n ===========\n - [MS-SMB2]: 2.2.4\n \"\"\"\n\n STRUCTURE_FORMAT = \" 0 # SMB2_SESSION_FLAG_IS_GUEST\n\n @property\n def isAnonymousSession(self):\n return (self.session_flags & 0x0002) > 0 # SMB2_SESSION_FLAG_IS_NULL\n\n def decode(self, message):\n assert message.command == SMB2_COM_SESSION_SETUP\n\n struct_size, self.session_flags, security_blob_offset, security_blob_len \\\n = struct.unpack(self.STRUCTURE_FORMAT, message.raw_data[SMB2Message.HEADER_SIZE:SMB2Message.HEADER_SIZE+self.STRUCTURE_SIZE])\n\n self.security_blob = message.raw_data[security_blob_offset:security_blob_offset+security_blob_len]\n\n\nclass SMB2TreeConnectRequest(Structure):\n \"\"\"\n References:\n ===========\n - [MS-SMB2]: 2.2.9\n \"\"\"\n\n STRUCTURE_FORMAT = \" 0:\n self.in_data = message.raw_data[input_offset:input_offset+input_len]\n else:\n self.in_data = b''\n\n if output_len > 0:\n self.out_data = message.raw_data[output_offset:output_offset+output_len]\n else:\n self.out_data = b''\n\n\nclass SMB2CloseRequest(Structure):\n \"\"\"\n References:\n ===========\n - [MS-SMB2]: 2.2.15\n \"\"\"\n\n STRUCTURE_FORMAT = \"> 24, self.internal_value & 0xFFFF )\n\n @property\n def hasError(self):\n return self.internal_value != 0\n\n\nclass SMBMessage:\n\n HEADER_STRUCT_FORMAT = \"<4sBIBHHQxxHHHHB\"\n HEADER_STRUCT_SIZE = struct.calcsize(HEADER_STRUCT_FORMAT)\n\n log = logging.getLogger('SMB.SMBMessage')\n protocol = 1\n\n def __init__(self, payload = None):\n self.reset()\n if payload:\n self.payload = payload\n self.payload.initMessage(self)\n\n def __str__(self):\n b = StringIO()\n b.write('Command: 0x%02X (%s) %s' % ( self.command, SMB_COMMAND_NAMES.get(self.command, ''), os.linesep ))\n b.write('Status: %s %s' % ( str(self.status), os.linesep ))\n b.write('Flags: 0x%02X %s' % ( self.flags, os.linesep ))\n b.write('Flags2: 0x%04X %s' % ( self.flags2, os.linesep ))\n b.write('PID: %d %s' % ( self.pid, os.linesep ))\n b.write('UID: %d %s' % ( self.uid, os.linesep ))\n b.write('MID: %d %s' % ( self.mid, os.linesep ))\n b.write('TID: %d %s' % ( self.tid, os.linesep ))\n b.write('Security: 0x%016X %s' % ( self.security, os.linesep ))\n b.write('Parameters: %d bytes %s%s %s' % ( len(self.parameters_data), os.linesep, str(binascii.hexlify(self.parameters_data)), os.linesep ))\n b.write('Data: %d bytes %s%s %s' % ( len(self.data), os.linesep, str(binascii.hexlify(self.data)), os.linesep ))\n return b.getvalue()\n\n def reset(self):\n self.raw_data = b''\n self.command = 0\n self.status = SMBError()\n self.flags = 0\n self.flags2 = 0\n self.pid = 0\n self.tid = 0\n self.uid = 0\n self.mid = 0\n self.security = 0\n self.parameters_data = b''\n self.data = b''\n self.payload = None\n\n @property\n def isAsync(self):\n return bool(self.flags & SMB2_FLAGS_ASYNC_COMMAND)\n\n @property\n def isReply(self):\n return bool(self.flags & SMB_FLAGS_REPLY)\n\n @property\n def hasExtendedSecurity(self):\n return bool(self.flags2 & SMB_FLAGS2_EXTENDED_SECURITY)\n\n def encode(self):\n \"\"\"\n Encode this SMB message into a series of bytes suitable to be embedded with a NetBIOS session message.\n AssertionError will be raised if this SMB message has not been initialized with a Payload instance\n\n @return: a string containing the encoded SMB message\n \"\"\"\n assert self.payload\n\n self.pid = os.getpid()\n self.payload.prepare(self)\n\n parameters_len = len(self.parameters_data)\n assert parameters_len % 2 == 0\n\n headers_data = struct.pack(self.HEADER_STRUCT_FORMAT,\n b'\\xFFSMB', self.command, self.status.internal_value, self.flags,\n self.flags2, (self.pid >> 16) & 0xFFFF, self.security, self.tid,\n self.pid & 0xFFFF, self.uid, self.mid, int(parameters_len / 2))\n return headers_data + self.parameters_data + struct.pack(' 0 and buf_len < (datalen_offset + 2 + body_len):\n # Not enough data in buf to decode body\n raise ProtocolError('Not enough data. Body decoding failed', buf)\n\n self.parameters_data = buf[offset:datalen_offset]\n\n if body_len > 0:\n self.data = buf[datalen_offset+2:datalen_offset+2+body_len]\n\n self.raw_data = buf\n self._decodePayload()\n\n return self.HEADER_STRUCT_SIZE + params_count * 2 + 2 + body_len\n\n def _decodePayload(self):\n if self.command == SMB_COM_READ_ANDX:\n self.payload = ComReadAndxResponse()\n elif self.command == SMB_COM_WRITE_ANDX:\n self.payload = ComWriteAndxResponse()\n elif self.command == SMB_COM_TRANSACTION:\n self.payload = ComTransactionResponse()\n elif self.command == SMB_COM_TRANSACTION2:\n self.payload = ComTransaction2Response()\n elif self.command == SMB_COM_OPEN_ANDX:\n self.payload = ComOpenAndxResponse()\n elif self.command == SMB_COM_NT_CREATE_ANDX:\n self.payload = ComNTCreateAndxResponse()\n elif self.command == SMB_COM_TREE_CONNECT_ANDX:\n self.payload = ComTreeConnectAndxResponse()\n elif self.command == SMB_COM_ECHO:\n self.payload = ComEchoResponse()\n elif self.command == SMB_COM_SESSION_SETUP_ANDX:\n self.payload = ComSessionSetupAndxResponse()\n elif self.command == SMB_COM_NEGOTIATE:\n self.payload = ComNegotiateResponse()\n\n if self.payload:\n self.payload.decode(self)\n\n\nclass Payload:\n\n DEFAULT_ANDX_PARAM_HEADER = b'\\xFF\\x00\\x00\\x00'\n DEFAULT_ANDX_PARAM_SIZE = 4\n\n def initMessage(self, message):\n # SMB_FLAGS2_UNICODE must always be enabled. Without this, almost all the Payload subclasses will need to be\n # rewritten to check for OEM/Unicode strings which will be tedious. Fortunately, almost all tested CIFS services\n # support SMB_FLAGS2_UNICODE by default.\n assert message.payload == self\n message.flags = SMB_FLAGS_CASE_INSENSITIVE | SMB_FLAGS_CANONICALIZED_PATHS\n message.flags2 = SMB_FLAGS2_UNICODE | SMB_FLAGS2_NT_STATUS | SMB_FLAGS2_IS_LONG_NAME | SMB_FLAGS2_LONG_NAMES\n\n if SUPPORT_EXTENDED_SECURITY:\n message.flags2 |= SMB_FLAGS2_EXTENDED_SECURITY\n\n def prepare(self, message):\n raise NotImplementedError\n\n def decode(self, message):\n raise NotImplementedError\n\n\nclass ComNegotiateRequest(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.52.1\n - [MS-SMB]: 2.2.4.5.1\n \"\"\"\n\n def initMessage(self, message):\n Payload.initMessage(self, message)\n message.command = SMB_COM_NEGOTIATE\n\n def prepare(self, message):\n assert message.payload == self\n message.parameters_data = b''\n if SUPPORT_SMB2:\n message.data = b''.join([b'\\x02'+s+b'\\x00' for s in DIALECTS + DIALECTS2])\n else:\n message.data = b''.join([b'\\x02'+s+b'\\x00' for s in DIALECTS])\n\n\nclass ComNegotiateResponse(Payload):\n \"\"\"\n Contains information on the SMB_COM_NEGOTIATE response from server\n\n After calling the decode method, each instance will contain the following attributes,\n - security_mode (integer)\n - max_mpx_count (integer)\n - max_number_vcs (integer)\n - max_buffer_size (long)\n - max_raw_size (long)\n - session_key (long)\n - capabilities (long)\n - system_time (long)\n - server_time_zone (integer)\n - challenge_length (integer)\n\n If the underlying SMB message's flag2 does not have SMB_FLAGS2_EXTENDED_SECURITY bit enabled,\n then the instance will have the following additional attributes,\n - challenge (string)\n - domain (unicode)\n\n If the underlying SMB message's flags2 has SMB_FLAGS2_EXTENDED_SECURITY bit enabled,\n then the instance will have the following additional attributes,\n - server_guid (string)\n - security_blob (string)\n\n References:\n ===========\n - [MS-SMB]: 2.2.4.5.2.1\n - [MS-CIFS]: 2.2.4.52.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n if data_len >= self.challenge_length:\n self.challenge = message.data[:self.challenge_length]\n\n s = b''\n offset = self.challenge_length\n while offset < data_len:\n _s = message.data[offset:offset+2]\n if _s == b'\\0\\0':\n self.domain = DataFaultToleranceStrategy.data_bytes_decode(s)#.decode('UTF-16LE')\n break\n else:\n s += _s\n offset += 2\n else:\n raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (without security extensions) Challenge field', message.raw_data, message)\n else:\n if data_len < 16:\n raise ProtocolError('Not enough data to decode SMB_COM_NEGOTIATE (with security extensions) ServerGUID field', message.raw_data, message)\n\n self.server_guid = message.data[:16]\n self.security_blob = message.data[16:]\n\n @property\n def supportsExtendedSecurity(self):\n return bool(self.capabilities & CAP_EXTENDED_SECURITY)\n\n\nclass ComSessionSetupAndxRequest__WithSecurityExtension(Payload):\n \"\"\"\n References:\n ===========\n - [MS-SMB]: 2.2.4.6.1\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n params_bytes_offset = offset\n offset += params_bytes_len\n else:\n params_bytes_offset = 0\n\n padding2 = b''\n if offset % 4 != 0:\n padding2 = b'\\0'*(4-offset%4)\n offset += (4-offset%4)\n\n if data_bytes_len > 0:\n data_bytes_offset = offset\n else:\n data_bytes_offset = 0\n\n message.parameters_data = \\\n struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n self.total_params_count,\n self.total_data_count,\n self.max_params_count,\n self.max_data_count,\n self.max_setup_count,\n 0x00, # Reserved1. Must be 0x00\n self.flags,\n self.timeout,\n 0x0000, # Reserved2. Must be 0x0000\n params_bytes_len,\n params_bytes_offset,\n data_bytes_len,\n data_bytes_offset,\n int(setup_bytes_len / 2)) + \\\n self.setup_bytes\n\n message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes\n\n\nclass ComTransactionResponse(Payload):\n \"\"\"\n Contains information about a SMB_COM_TRANSACTION response from the server\n\n After decoding, each instance contains the following attributes:\n - total_params_count (integer)\n - total_data_count (integer)\n - setup_bytes (string)\n - data_bytes (string)\n - params_bytes (string)\n\n References:\n ===========\n - [MS-CIFS]: 2.2.4.33.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n setup_bytes_len = setup_count * 2\n\n if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:\n raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)\n\n self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]\n else:\n self.setup_bytes = ''\n\n offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n\n if params_bytes_len > 0:\n self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]\n else:\n self.params_bytes = ''\n\n if data_bytes_len > 0:\n self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]\n else:\n self.data_bytes = ''\n\n\nclass ComTransaction2Request(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.46.1\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = 'HHHHBBHIHHHHHH'\n PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n def __init__(self, max_params_count, max_data_count, max_setup_count,\n total_params_count = 0, total_data_count = 0,\n params_bytes = b'', data_bytes = b'', setup_bytes = b'',\n flags = 0, timeout = 0):\n self.total_params_count = total_params_count or len(params_bytes)\n self.total_data_count = total_data_count or len(data_bytes)\n self.max_params_count = max_params_count\n self.max_data_count = max_data_count\n self.max_setup_count = max_setup_count\n self.flags = flags\n self.timeout = timeout\n self.params_bytes = params_bytes\n self.data_bytes = data_bytes\n self.setup_bytes = setup_bytes\n\n def initMessage(self, message):\n Payload.initMessage(self, message)\n message.command = SMB_COM_TRANSACTION2\n\n def prepare(self, message):\n setup_bytes_len = len(self.setup_bytes)\n params_bytes_len = len(self.params_bytes)\n data_bytes_len = len(self.data_bytes)\n name = b'\\0\\0'\n\n padding0 = b''\n offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_bytes_len + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n if offset % 2 != 0:\n padding0 = b'\\0'\n offset += 1\n\n offset += 2 # For the name field\n padding1 = b''\n if offset % 4 != 0:\n padding1 = b'\\0'*(4-offset%4)\n\n if params_bytes_len > 0:\n params_bytes_offset = offset\n offset += params_bytes_len\n else:\n params_bytes_offset = 0\n\n padding2 = b''\n if offset % 4 != 0:\n padding2 = b'\\0'*(4-offset%4)\n\n if data_bytes_len > 0:\n data_bytes_offset = offset\n else:\n data_bytes_offset = 0\n\n message.parameters_data = \\\n struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n self.total_params_count,\n self.total_data_count,\n self.max_params_count,\n self.max_data_count,\n self.max_setup_count,\n 0x00, # Reserved1. Must be 0x00\n self.flags,\n self.timeout,\n 0x0000, # Reserved2. Must be 0x0000\n params_bytes_len,\n params_bytes_offset,\n data_bytes_len,\n data_bytes_offset,\n int(setup_bytes_len / 2)) + \\\n self.setup_bytes\n\n message.data = padding0 + name + padding1 + self.params_bytes + padding2 + self.data_bytes\n\n\nclass ComTransaction2Response(Payload):\n \"\"\"\n Contains information about a SMB_COM_TRANSACTION2 response from the server\n\n After decoding, each instance contains the following attributes:\n - total_params_count (integer)\n - total_data_count (integer)\n - setup_bytes (string)\n - data_bytes (string)\n - params_bytes (string)\n\n References:\n ===========\n - [MS-CIFS]: 2.2.4.46.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n setup_bytes_len = setup_count * 2\n\n if len(message.parameters_data) < self.PAYLOAD_STRUCT_SIZE + setup_bytes_len:\n raise ProtocolError('Not enough data to decode SMB_COM_TRANSACTION parameters', message.raw_data, message)\n\n self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_bytes_len]\n else:\n self.setup_bytes = ''\n\n offset = message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count * 2 + 2 # constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)\n\n if params_bytes_len > 0:\n self.params_bytes = message.data[params_bytes_offset-offset:params_bytes_offset-offset+params_bytes_len]\n else:\n self.params_bytes = ''\n\n if data_bytes_len > 0:\n self.data_bytes = message.data[data_bytes_offset-offset:data_bytes_offset-offset+data_bytes_len]\n else:\n self.data_bytes = ''\n\n\nclass ComCloseRequest(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.5.1\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = '> 32) # OffsetHigh field defined in [MS-SMB]: 2.2.4.3.1\n\n message.data = b'\\0' + self.data_bytes\n\n\nclass ComWriteAndxResponse(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.43.2\n - [MS-SMB]: 2.2.4.3.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = '> 32), # Note that in [MS-SMB]: 2.2.4.2.1, this field can also act as MaxCountHigh field\n self.remaining, # In [MS-CIFS]: 2.2.4.42.1, this field must be set to 0x0000\n self.offset >> 32)\n\n message.data = b''\n\n\nclass ComReadAndxResponse(Payload):\n \"\"\"\n References:\n ===========\n - [MS-CIFS]: 2.2.4.42.2\n - [MS-SMB]: 2.2.4.2.2\n \"\"\"\n\n PAYLOAD_STRUCT_FORMAT = ' 0:\n params_bytes_offset = offset\n else:\n params_bytes_offset = 0\n\n offset += params_bytes_len\n padding1 = b''\n if offset % 4 != 0:\n padding1 = b'\\0'*(4-offset%4)\n offset += (4-offset%4)\n\n if data_bytes_len > 0:\n data_bytes_offset = offset\n else:\n data_bytes_offset = 0\n\n message.parameters_data = \\\n struct.pack(self.PAYLOAD_STRUCT_FORMAT,\n self.max_setup_count,\n 0x00, # Reserved1. Must be 0x00\n self.total_params_count,\n self.total_data_count,\n self.max_params_count,\n self.max_data_count,\n params_bytes_len,\n params_bytes_offset,\n data_bytes_len,\n data_bytes_offset,\n int(setup_bytes_len / 2),\n self.function) + \\\n self.setup_bytes\n\n message.data = padding0 + self.params_bytes + padding1 + self.data_bytes\n\n\nclass ComNTTransactResponse(Payload):\n \"\"\"\n Contains information about a SMB_COM_NT_TRANSACT response from the server\n\n After decoding, each instance contains the following attributes:\n - total_params_count (integer)\n - total_data_count (integer)\n - setup_bytes (string)\n - data_bytes (string)\n - params_bytes (string)\n\n References:\n ===========\n - [MS-CIFS]: 2.2.4.62.2\n \"\"\"\n PAYLOAD_STRUCT_FORMAT = '<3sIIIIIIIIBH'\n PAYLOAD_STRUCT_SIZE = struct.calcsize(PAYLOAD_STRUCT_FORMAT)\n\n def decode(self, message):\n assert message.command == SMB_COM_NT_TRANSACT\n\n if not message.status.hasError:\n _, self.total_params_count, self.total_data_count, \\\n params_count, params_offset, params_displ, \\\n data_count, data_offset, data_displ, setup_count = struct.unpack(self.PAYLOAD_STRUCT_FORMAT,\n message.parameters_data[:self.PAYLOAD_STRUCT_SIZE])\n\n self.setup_bytes = message.parameters_data[self.PAYLOAD_STRUCT_SIZE:self.PAYLOAD_STRUCT_SIZE+setup_count*2]\n\n if params_count > 0:\n params_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2\n self.params_bytes = message.data[params_offset:params_offset+params_count]\n else:\n self.params_bytes = b''\n\n if data_count > 0:\n data_offset -= message.HEADER_STRUCT_SIZE + self.PAYLOAD_STRUCT_SIZE + setup_count*2 + 2\n self.data_bytes = message.data[data_offset:data_offset+data_count]\n else:\n self.data_bytes = b''\n" }, { "path": "python3/smb/strategy.py", "content": "class DataStrategyBase():\n DATABYTES_CODEC = 'UTF-16LE'\n \n \nclass DataFaultToleranceStrategy():\n @staticmethod\n def data_bytes_decode(databytes):\n return databytes.decode(DataStrategyBase.DATABYTES_CODEC, 'ignore')\n\n\nclass DataStrategy():\n @staticmethod\n def data_bytes_decode(databytes):\n return databytes.decode(DataStrategyBase.DATABYTES_CODEC)\n " }, { "path": "python3/smb/utils/U32.py", "content": "# U32.py implements 32-bit unsigned int class for Python\n# Version 1.0\n# Copyright (C) 2001-2002 Dmitry Rozmanov\n#\n# This library is free software; you can redistribute it and/or\n# modify it under the terms of the GNU Lesser General Public\n# License as published by the Free Software Foundation; either\n# version 2.1 of the License, or (at your option) any later version.\n#\n# This library is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n# Lesser General Public License for more details.\n#\n# You should have received a copy of the GNU Lesser General Public\n# License along with this library; if not, write to the Free Software\n# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\n#\n# e-mail: dima@xenon.spb.ru\n#\n#====================================================================\n\nC = 0x1000000000\n\n#--------------------------------------------------------------------\ndef norm(n):\n return n & 0xFFFFFFFF\n\n#====================================================================\nclass U32:\n v = 0\n\n #--------------------------------------------------------------------\n def __init__(self, value = 0):\n self.v = C + norm(abs(int(value)))\n\n #--------------------------------------------------------------------\n def set(self, value = 0):\n self.v = C + norm(abs(int(value)))\n\n #--------------------------------------------------------------------\n def __repr__(self):\n return hex(norm(self.v))\n\n #--------------------------------------------------------------------\n def __long__(self): return int(norm(self.v))\n\n #--------------------------------------------------------------------\n def __int__(self): return int(norm(self.v))\n\n __index__ = __int__\n\n #--------------------------------------------------------------------\n def __chr__(self): return chr(norm(self.v))\n\n #--------------------------------------------------------------------\n def __add__(self, b):\n r = U32()\n r.v = C + norm(self.v + b.v)\n return r\n\n #--------------------------------------------------------------------\n def __sub__(self, b):\n r = U32()\n if self.v < b.v:\n r.v = C + norm(0x100000000 - (b.v - self.v))\n else: r.v = C + norm(self.v - b.v)\n return r\n\n #--------------------------------------------------------------------\n def __mul__(self, b):\n r = U32()\n r.v = C + norm(self.v * b.v)\n return r\n\n #--------------------------------------------------------------------\n def __div__(self, b):\n r = U32()\n r.v = C + (norm(self.v) / norm(b.v))\n return r\n\n #--------------------------------------------------------------------\n def __mod__(self, b):\n r = U32()\n r.v = C + (norm(self.v) % norm(b.v))\n return r\n\n #--------------------------------------------------------------------\n def __neg__(self): return U32(self.v)\n\n #--------------------------------------------------------------------\n def __pos__(self): return U32(self.v)\n\n #--------------------------------------------------------------------\n def __abs__(self): return U32(self.v)\n\n #--------------------------------------------------------------------\n def __invert__(self):\n r = U32()\n r.v = C + norm(~self.v)\n return r\n\n #--------------------------------------------------------------------\n def __lshift__(self, b):\n r = U32()\n r.v = C + norm(self.v << b)\n return r\n\n #--------------------------------------------------------------------\n def __rshift__(self, b):\n r = U32()\n r.v = C + (norm(self.v) >> b)\n return r\n\n #--------------------------------------------------------------------\n def __and__(self, b):\n r = U32()\n r.v = C + norm(self.v & b.v)\n return r\n\n #--------------------------------------------------------------------\n def __or__(self, b):\n r = U32()\n r.v = C + norm(self.v | b.v)\n return r\n\n #--------------------------------------------------------------------\n def __xor__(self, b):\n r = U32()\n r.v = C + norm(self.v ^ b.v)\n return r\n\n #--------------------------------------------------------------------\n def __not__(self):\n return U32(not norm(self.v))\n\n #--------------------------------------------------------------------\n def truth(self):\n return norm(self.v)\n\n #--------------------------------------------------------------------\n def __cmp__(self, b):\n if norm(self.v) > norm(b.v): return 1\n elif norm(self.v) < norm(b.v): return -1\n else: return 0\n\n #--------------------------------------------------------------------\n def __bool__(self):\n return norm(self.v)\n \n" }, { "path": "python3/smb/utils/__init__.py", "content": "\ndef convertFILETIMEtoEpoch(t):\n return (t - 116444736000000000) / 10000000.0;\n" }, { "path": "python3/smb/utils/md4.py", "content": "# md4.py implements md4 hash class for Python\n# Version 1.0\n# Copyright (C) 2001-2002 Dmitry Rozmanov\n#\n# based on md4.c from \"the Python Cryptography Toolkit, version 1.0.0\n# Copyright (C) 1995, A.M. Kuchling\"\n#\n# This library is free software; you can redistribute it and/or\n# modify it under the terms of the GNU Lesser General Public\n# License as published by the Free Software Foundation; either\n# version 2.1 of the License, or (at your option) any later version.\n#\n# This library is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n# Lesser General Public License for more details.\n#\n# You should have received a copy of the GNU Lesser General Public\n# License along with this library; if not, write to the Free Software\n# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\n#\n# e-mail: dima@xenon.spb.ru\n#\n#====================================================================\n\n\n#====================================================================\nfrom .U32 import U32\n\n#--------------------------------------------------------------------\nclass MD4:\n A = None\n B = None\n C = None\n D = None\n count, len1, len2 = None, None, None\n buf = []\n\n #-----------------------------------------------------\n def __init__(self):\n\n\n self.A = U32(0x67452301)\n self.B = U32(0xefcdab89)\n self.C = U32(0x98badcfe)\n self.D = U32(0x10325476)\n self.count, self.len1, self.len2 = U32(0), U32(0), U32(0)\n self.buf = [0x00] * 64\n\n #-----------------------------------------------------\n def __repr__(self):\n r = 'A = %s, \\nB = %s, \\nC = %s, \\nD = %s.\\n' % (self.A.__repr__(), self.B.__repr__(), self.C.__repr__(), self.D.__repr__())\n r = r + 'count = %s, \\nlen1 = %s, \\nlen2 = %s.\\n' % (self.count.__repr__(), self.len1.__repr__(), self.len2.__repr__())\n for i in range(4):\n for j in range(16):\n r = r + '%4s ' % hex(self.buf[i+j])\n r = r + '\\n'\n\n return r\n #-----------------------------------------------------\n def make_copy(self):\n\n dest = new()\n\n dest.len1 = self.len1\n dest.len2 = self.len2\n dest.A = self.A\n dest.B = self.B\n dest.C = self.C\n dest.D = self.D\n dest.count = self.count\n for i in range(int(self.count)):\n dest.buf[i] = self.buf[i]\n\n return dest\n\n #-----------------------------------------------------\n def update(self, str):\n if isinstance(str, bytes):\n buf = list(str)\n else:\n buf = [ord(i) for i in str]\n\n ilen = U32(len(buf))\n\n # check if the first length is out of range\n # as the length is measured in bits then multiplay it by 8\n if (int(self.len1 + (ilen << 3)) < int(self.len1)):\n self.len2 = self.len2 + U32(1)\n\n self.len1 = self.len1 + (ilen << 3)\n self.len2 = self.len2 + (ilen >> 29)\n\n L = U32(0)\n bufpos = 0\n while (int(ilen) > 0):\n if (64 - int(self.count)) < int(ilen): L = U32(64 - int(self.count))\n else: L = ilen\n for i in range(int(L)): self.buf[i + int(self.count)] = buf[i + bufpos]\n self.count = self.count + L\n ilen = ilen - L\n bufpos = bufpos + int(L)\n\n if (int(self.count) == 64):\n self.count = U32(0)\n X = []\n i = 0\n for j in range(16):\n X.append(U32(self.buf[i]) + (U32(self.buf[i+1]) << 8) + \\\n (U32(self.buf[i+2]) << 16) + (U32(self.buf[i+3]) << 24))\n i = i + 4\n\n A = self.A\n B = self.B\n C = self.C\n D = self.D\n\n A = f1(A,B,C,D, 0, 3, X)\n D = f1(D,A,B,C, 1, 7, X)\n C = f1(C,D,A,B, 2,11, X)\n B = f1(B,C,D,A, 3,19, X)\n A = f1(A,B,C,D, 4, 3, X)\n D = f1(D,A,B,C, 5, 7, X)\n C = f1(C,D,A,B, 6,11, X)\n B = f1(B,C,D,A, 7,19, X)\n A = f1(A,B,C,D, 8, 3, X)\n D = f1(D,A,B,C, 9, 7, X)\n C = f1(C,D,A,B,10,11, X)\n B = f1(B,C,D,A,11,19, X)\n A = f1(A,B,C,D,12, 3, X)\n D = f1(D,A,B,C,13, 7, X)\n C = f1(C,D,A,B,14,11, X)\n B = f1(B,C,D,A,15,19, X)\n\n A = f2(A,B,C,D, 0, 3, X)\n D = f2(D,A,B,C, 4, 5, X)\n C = f2(C,D,A,B, 8, 9, X)\n B = f2(B,C,D,A,12,13, X)\n A = f2(A,B,C,D, 1, 3, X)\n D = f2(D,A,B,C, 5, 5, X)\n C = f2(C,D,A,B, 9, 9, X)\n B = f2(B,C,D,A,13,13, X)\n A = f2(A,B,C,D, 2, 3, X)\n D = f2(D,A,B,C, 6, 5, X)\n C = f2(C,D,A,B,10, 9, X)\n B = f2(B,C,D,A,14,13, X)\n A = f2(A,B,C,D, 3, 3, X)\n D = f2(D,A,B,C, 7, 5, X)\n C = f2(C,D,A,B,11, 9, X)\n B = f2(B,C,D,A,15,13, X)\n\n A = f3(A,B,C,D, 0, 3, X)\n D = f3(D,A,B,C, 8, 9, X)\n C = f3(C,D,A,B, 4,11, X)\n B = f3(B,C,D,A,12,15, X)\n A = f3(A,B,C,D, 2, 3, X)\n D = f3(D,A,B,C,10, 9, X)\n C = f3(C,D,A,B, 6,11, X)\n B = f3(B,C,D,A,14,15, X)\n A = f3(A,B,C,D, 1, 3, X)\n D = f3(D,A,B,C, 9, 9, X)\n C = f3(C,D,A,B, 5,11, X)\n B = f3(B,C,D,A,13,15, X)\n A = f3(A,B,C,D, 3, 3, X)\n D = f3(D,A,B,C,11, 9, X)\n C = f3(C,D,A,B, 7,11, X)\n B = f3(B,C,D,A,15,15, X)\n\n self.A = self.A + A\n self.B = self.B + B\n self.C = self.C + C\n self.D = self.D + D\n\n #-----------------------------------------------------\n def digest(self):\n\n res = [0x00] * 16\n s = [0x00] * 8\n padding = [0x00] * 64\n padding[0] = 0x80\n padlen, oldlen1, oldlen2 = U32(0), U32(0), U32(0)\n\n temp = self.make_copy()\n\n oldlen1 = temp.len1\n oldlen2 = temp.len2\n if (56 <= int(self.count)): padlen = U32(56 - int(self.count) + 64)\n else: padlen = U32(56 - int(self.count))\n\n temp.update(bytes(padding[:int(padlen)]))\n\n s[0]= (oldlen1) & U32(0xFF)\n s[1]=((oldlen1) >> 8) & U32(0xFF)\n s[2]=((oldlen1) >> 16) & U32(0xFF)\n s[3]=((oldlen1) >> 24) & U32(0xFF)\n s[4]= (oldlen2) & U32(0xFF)\n s[5]=((oldlen2) >> 8) & U32(0xFF)\n s[6]=((oldlen2) >> 16) & U32(0xFF)\n s[7]=((oldlen2) >> 24) & U32(0xFF)\n temp.update(bytes(s))\n\n res[ 0]= temp.A & U32(0xFF)\n res[ 1]=(temp.A >> 8) & U32(0xFF)\n res[ 2]=(temp.A >> 16) & U32(0xFF)\n res[ 3]=(temp.A >> 24) & U32(0xFF)\n res[ 4]= temp.B & U32(0xFF)\n res[ 5]=(temp.B >> 8) & U32(0xFF)\n res[ 6]=(temp.B >> 16) & U32(0xFF)\n res[ 7]=(temp.B >> 24) & U32(0xFF)\n res[ 8]= temp.C & U32(0xFF)\n res[ 9]=(temp.C >> 8) & U32(0xFF)\n res[10]=(temp.C >> 16) & U32(0xFF)\n res[11]=(temp.C >> 24) & U32(0xFF)\n res[12]= temp.D & U32(0xFF)\n res[13]=(temp.D >> 8) & U32(0xFF)\n res[14]=(temp.D >> 16) & U32(0xFF)\n res[15]=(temp.D >> 24) & U32(0xFF)\n\n return bytes(res)\n\n#====================================================================\n# helpers\ndef F(x, y, z): return (((x) & (y)) | ((~x) & (z)))\ndef G(x, y, z): return (((x) & (y)) | ((x) & (z)) | ((y) & (z)))\ndef H(x, y, z): return ((x) ^ (y) ^ (z))\n\ndef ROL(x, n): return (((x) << n) | ((x) >> (32-n)))\n\ndef f1(a, b, c, d, k, s, X): return ROL(a + F(b, c, d) + X[k], s)\ndef f2(a, b, c, d, k, s, X): return ROL(a + G(b, c, d) + X[k] + U32(0x5a827999), s)\ndef f3(a, b, c, d, k, s, X): return ROL(a + H(b, c, d) + X[k] + U32(0x6ed9eba1), s)\n\n#--------------------------------------------------------------------\n# To be able to use md4.new() instead of md4.MD4()\nnew = MD4\n" }, { "path": "python3/smb/utils/pyDes.py", "content": "#############################################################################\n# \t\t\t\tDocumentation\t\t\t\t #\n#############################################################################\n\n# Author: Todd Whiteman\n# Date: 16th March, 2009\n# Verion: 2.0.0\n# License: Public Domain - free to do as you wish\n# Homepage: http://twhiteman.netfirms.com/des.html\n#\n# This is a pure python implementation of the DES encryption algorithm.\n# It's pure python to avoid portability issues, since most DES \n# implementations are programmed in C (for performance reasons).\n#\n# Triple DES class is also implemented, utilising the DES base. Triple DES\n# is either DES-EDE3 with a 24 byte key, or DES-EDE2 with a 16 byte key.\n#\n# See the README.txt that should come with this python module for the\n# implementation methods used.\n#\n# Thanks to:\n# * David Broadwell for ideas, comments and suggestions.\n# * Mario Wolff for pointing out and debugging some triple des CBC errors.\n# * Santiago Palladino for providing the PKCS5 padding technique.\n# * Shaya for correcting the PAD_PKCS5 triple des CBC errors.\n#\n\"\"\"A pure python implementation of the DES and TRIPLE DES encryption algorithms.\n\nClass initialization\n--------------------\npyDes.des(key, [mode], [IV], [pad], [padmode])\npyDes.triple_des(key, [mode], [IV], [pad], [padmode])\n\nkey -> Bytes containing the encryption key. 8 bytes for DES, 16 or 24 bytes\n\t for Triple DES\nmode -> Optional argument for encryption type, can be either\n\t pyDes.ECB (Electronic Code Book) or pyDes.CBC (Cypher Block Chaining)\nIV -> Optional Initial Value bytes, must be supplied if using CBC mode.\n\t Length must be 8 bytes.\npad -> Optional argument, set the pad character (PAD_NORMAL) to use during\n\t all encrypt/decrpt operations done with this instance.\npadmode -> Optional argument, set the padding mode (PAD_NORMAL or PAD_PKCS5)\n\t to use during all encrypt/decrpt operations done with this instance.\n\nI recommend to use PAD_PKCS5 padding, as then you never need to worry about any\npadding issues, as the padding can be removed unambiguously upon decrypting\ndata that was encrypted using PAD_PKCS5 padmode.\n\nCommon methods\n--------------\nencrypt(data, [pad], [padmode])\ndecrypt(data, [pad], [padmode])\n\ndata -> Bytes to be encrypted/decrypted\npad -> Optional argument. Only when using padmode of PAD_NORMAL. For\n\t encryption, adds this characters to the end of the data block when\n\t data is not a multiple of 8 bytes. For decryption, will remove the\n\t trailing characters that match this pad character from the last 8\n\t bytes of the unencrypted data block.\npadmode -> Optional argument, set the padding mode, must be one of PAD_NORMAL\n\t or PAD_PKCS5). Defaults to PAD_NORMAL.\n\t \n\nExample\n-------\nfrom pyDes import *\n\ndata = \"Please encrypt my data\"\nk = des(\"DESCRYPT\", CBC, \"\\0\\0\\0\\0\\0\\0\\0\\0\", pad=None, padmode=PAD_PKCS5)\n# For Python3, you'll need to use bytes, i.e.:\n# data = b\"Please encrypt my data\"\n# k = des(b\"DESCRYPT\", CBC, b\"\\0\\0\\0\\0\\0\\0\\0\\0\", pad=None, padmode=PAD_PKCS5)\nd = k.encrypt(data)\nprint \"Encrypted: %r\" % d\nprint \"Decrypted: %r\" % k.decrypt(d)\nassert k.decrypt(d, padmode=PAD_PKCS5) == data\n\n\nSee the module source (pyDes.py) for more examples of use.\nYou can also run the pyDes.py file without and arguments to see a simple test.\n\nNote: This code was not written for high-end systems needing a fast\n implementation, but rather a handy portable solution with small usage.\n\n\"\"\"\n\nimport sys\n\n# _pythonMajorVersion is used to handle Python2 and Python3 differences.\n_pythonMajorVersion = sys.version_info[0]\n\n# Modes of crypting / cyphering\nECB =\t0\nCBC =\t1\n\n# Modes of padding\nPAD_NORMAL = 1\nPAD_PKCS5 = 2\n\n# PAD_PKCS5: is a method that will unambiguously remove all padding\n# characters after decryption, when originally encrypted with\n# this padding mode.\n# For a good description of the PKCS5 padding technique, see:\n# http://www.faqs.org/rfcs/rfc1423.html\n\n# The base class shared by des and triple des.\nclass _baseDes(object):\n\tdef __init__(self, mode=ECB, IV=None, pad=None, padmode=PAD_NORMAL):\n\t\tif IV:\n\t\t\tIV = self._guardAgainstUnicode(IV)\n\t\tif pad:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tself.block_size = 8\n\t\t# Sanity checking of arguments.\n\t\tif pad and padmode == PAD_PKCS5:\n\t\t\traise ValueError(\"Cannot use a pad character with PAD_PKCS5\")\n\t\tif IV and len(IV) != self.block_size:\n\t\t\traise ValueError(\"Invalid Initial Value (IV), must be a multiple of \" + str(self.block_size) + \" bytes\")\n\n\t\t# Set the passed in variables\n\t\tself._mode = mode\n\t\tself._iv = IV\n\t\tself._padding = pad\n\t\tself._padmode = padmode\n\n\tdef getKey(self):\n\t\t\"\"\"getKey() -> bytes\"\"\"\n\t\treturn self.__key\n\n\tdef setKey(self, key):\n\t\t\"\"\"Will set the crypting key for this object.\"\"\"\n\t\tkey = self._guardAgainstUnicode(key)\n\t\tself.__key = key\n\n\tdef getMode(self):\n\t\t\"\"\"getMode() -> pyDes.ECB or pyDes.CBC\"\"\"\n\t\treturn self._mode\n\n\tdef setMode(self, mode):\n\t\t\"\"\"Sets the type of crypting mode, pyDes.ECB or pyDes.CBC\"\"\"\n\t\tself._mode = mode\n\n\tdef getPadding(self):\n\t\t\"\"\"getPadding() -> bytes of length 1. Padding character.\"\"\"\n\t\treturn self._padding\n\n\tdef setPadding(self, pad):\n\t\t\"\"\"setPadding() -> bytes of length 1. Padding character.\"\"\"\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tself._padding = pad\n\n\tdef getPadMode(self):\n\t\t\"\"\"getPadMode() -> pyDes.PAD_NORMAL or pyDes.PAD_PKCS5\"\"\"\n\t\treturn self._padmode\n\t\t\n\tdef setPadMode(self, mode):\n\t\t\"\"\"Sets the type of padding mode, pyDes.PAD_NORMAL or pyDes.PAD_PKCS5\"\"\"\n\t\tself._padmode = mode\n\n\tdef getIV(self):\n\t\t\"\"\"getIV() -> bytes\"\"\"\n\t\treturn self._iv\n\n\tdef setIV(self, IV):\n\t\t\"\"\"Will set the Initial Value, used in conjunction with CBC mode\"\"\"\n\t\tif not IV or len(IV) != self.block_size:\n\t\t\traise ValueError(\"Invalid Initial Value (IV), must be a multiple of \" + str(self.block_size) + \" bytes\")\n\t\tIV = self._guardAgainstUnicode(IV)\n\t\tself._iv = IV\n\n\tdef _padData(self, data, pad, padmode):\n\t\t# Pad data depending on the mode\n\t\tif padmode is None:\n\t\t\t# Get the default padding mode.\n\t\t\tpadmode = self.getPadMode()\n\t\tif pad and padmode == PAD_PKCS5:\n\t\t\traise ValueError(\"Cannot use a pad character with PAD_PKCS5\")\n\n\t\tif padmode == PAD_NORMAL:\n\t\t\tif len(data) % self.block_size == 0:\n\t\t\t\t# No padding required.\n\t\t\t\treturn data\n\n\t\t\tif not pad:\n\t\t\t\t# Get the default padding.\n\t\t\t\tpad = self.getPadding()\n\t\t\tif not pad:\n\t\t\t\traise ValueError(\"Data must be a multiple of \" + str(self.block_size) + \" bytes in length. Use padmode=PAD_PKCS5 or set the pad character.\")\n\t\t\tdata += (self.block_size - (len(data) % self.block_size)) * pad\n\t\t\n\t\telif padmode == PAD_PKCS5:\n\t\t\tpad_len = 8 - (len(data) % self.block_size)\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\tdata += pad_len * chr(pad_len)\n\t\t\telse:\n\t\t\t\tdata += bytes([pad_len] * pad_len)\n\n\t\treturn data\n\n\tdef _unpadData(self, data, pad, padmode):\n\t\t# Unpad data depending on the mode.\n\t\tif not data:\n\t\t\treturn data\n\t\tif pad and padmode == PAD_PKCS5:\n\t\t\traise ValueError(\"Cannot use a pad character with PAD_PKCS5\")\n\t\tif padmode is None:\n\t\t\t# Get the default padding mode.\n\t\t\tpadmode = self.getPadMode()\n\n\t\tif padmode == PAD_NORMAL:\n\t\t\tif not pad:\n\t\t\t\t# Get the default padding.\n\t\t\t\tpad = self.getPadding()\n\t\t\tif pad:\n\t\t\t\tdata = data[:-self.block_size] + \\\n\t\t\t\t data[-self.block_size:].rstrip(pad)\n\n\t\telif padmode == PAD_PKCS5:\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\tpad_len = ord(data[-1])\n\t\t\telse:\n\t\t\t\tpad_len = data[-1]\n\t\t\tdata = data[:-pad_len]\n\n\t\treturn data\n\n\tdef _guardAgainstUnicode(self, data):\n\t\t# Only accept byte strings or ascii unicode values, otherwise\n\t\t# there is no way to correctly decode the data into bytes.\n\t\tif _pythonMajorVersion < 3:\n\t\t\tif isinstance(data, str):\n\t\t\t\traise ValueError(\"pyDes can only work with bytes, not Unicode strings.\")\n\t\telse:\n\t\t\tif isinstance(data, str):\n\t\t\t\t# Only accept ascii unicode values.\n\t\t\t\ttry:\n\t\t\t\t\treturn data.encode('ascii')\n\t\t\t\texcept UnicodeEncodeError:\n\t\t\t\t\tpass\n\t\t\t\traise ValueError(\"pyDes can only work with encoded strings, not Unicode.\")\n\t\treturn data\n\n#############################################################################\n# \t\t\t\t DES\t\t\t\t\t #\n#############################################################################\nclass des(_baseDes):\n\t\"\"\"DES encryption/decrytpion class\n\n\tSupports ECB (Electronic Code Book) and CBC (Cypher Block Chaining) modes.\n\n\tpyDes.des(key,[mode], [IV])\n\n\tkey -> Bytes containing the encryption key, must be exactly 8 bytes\n\tmode -> Optional argument for encryption type, can be either pyDes.ECB\n\t\t(Electronic Code Book), pyDes.CBC (Cypher Block Chaining)\n\tIV -> Optional Initial Value bytes, must be supplied if using CBC mode.\n\t\tMust be 8 bytes in length.\n\tpad -> Optional argument, set the pad character (PAD_NORMAL) to use\n\t\tduring all encrypt/decrpt operations done with this instance.\n\tpadmode -> Optional argument, set the padding mode (PAD_NORMAL or\n\t\tPAD_PKCS5) to use during all encrypt/decrpt operations done\n\t\twith this instance.\n\t\"\"\"\n\n\n\t# Permutation and translation tables for DES\n\t__pc1 = [56, 48, 40, 32, 24, 16, 8,\n\t\t 0, 57, 49, 41, 33, 25, 17,\n\t\t 9, 1, 58, 50, 42, 34, 26,\n\t\t 18, 10, 2, 59, 51, 43, 35,\n\t\t 62, 54, 46, 38, 30, 22, 14,\n\t\t 6, 61, 53, 45, 37, 29, 21,\n\t\t 13, 5, 60, 52, 44, 36, 28,\n\t\t 20, 12, 4, 27, 19, 11, 3\n\t]\n\n\t# number left rotations of pc1\n\t__left_rotations = [\n\t\t1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1\n\t]\n\n\t# permuted choice key (table 2)\n\t__pc2 = [\n\t\t13, 16, 10, 23, 0, 4,\n\t\t 2, 27, 14, 5, 20, 9,\n\t\t22, 18, 11, 3, 25, 7,\n\t\t15, 6, 26, 19, 12, 1,\n\t\t40, 51, 30, 36, 46, 54,\n\t\t29, 39, 50, 44, 32, 47,\n\t\t43, 48, 38, 55, 33, 52,\n\t\t45, 41, 49, 35, 28, 31\n\t]\n\n\t# initial permutation IP\n\t__ip = [57, 49, 41, 33, 25, 17, 9, 1,\n\t\t59, 51, 43, 35, 27, 19, 11, 3,\n\t\t61, 53, 45, 37, 29, 21, 13, 5,\n\t\t63, 55, 47, 39, 31, 23, 15, 7,\n\t\t56, 48, 40, 32, 24, 16, 8, 0,\n\t\t58, 50, 42, 34, 26, 18, 10, 2,\n\t\t60, 52, 44, 36, 28, 20, 12, 4,\n\t\t62, 54, 46, 38, 30, 22, 14, 6\n\t]\n\n\t# Expansion table for turning 32 bit blocks into 48 bits\n\t__expansion_table = [\n\t\t31, 0, 1, 2, 3, 4,\n\t\t 3, 4, 5, 6, 7, 8,\n\t\t 7, 8, 9, 10, 11, 12,\n\t\t11, 12, 13, 14, 15, 16,\n\t\t15, 16, 17, 18, 19, 20,\n\t\t19, 20, 21, 22, 23, 24,\n\t\t23, 24, 25, 26, 27, 28,\n\t\t27, 28, 29, 30, 31, 0\n\t]\n\n\t# The (in)famous S-boxes\n\t__sbox = [\n\t\t# S1\n\t\t[14, 4, 13, 1, 2, 15, 11, 8, 3, 10, 6, 12, 5, 9, 0, 7,\n\t\t 0, 15, 7, 4, 14, 2, 13, 1, 10, 6, 12, 11, 9, 5, 3, 8,\n\t\t 4, 1, 14, 8, 13, 6, 2, 11, 15, 12, 9, 7, 3, 10, 5, 0,\n\t\t 15, 12, 8, 2, 4, 9, 1, 7, 5, 11, 3, 14, 10, 0, 6, 13],\n\n\t\t# S2\n\t\t[15, 1, 8, 14, 6, 11, 3, 4, 9, 7, 2, 13, 12, 0, 5, 10,\n\t\t 3, 13, 4, 7, 15, 2, 8, 14, 12, 0, 1, 10, 6, 9, 11, 5,\n\t\t 0, 14, 7, 11, 10, 4, 13, 1, 5, 8, 12, 6, 9, 3, 2, 15,\n\t\t 13, 8, 10, 1, 3, 15, 4, 2, 11, 6, 7, 12, 0, 5, 14, 9],\n\n\t\t# S3\n\t\t[10, 0, 9, 14, 6, 3, 15, 5, 1, 13, 12, 7, 11, 4, 2, 8,\n\t\t 13, 7, 0, 9, 3, 4, 6, 10, 2, 8, 5, 14, 12, 11, 15, 1,\n\t\t 13, 6, 4, 9, 8, 15, 3, 0, 11, 1, 2, 12, 5, 10, 14, 7,\n\t\t 1, 10, 13, 0, 6, 9, 8, 7, 4, 15, 14, 3, 11, 5, 2, 12],\n\n\t\t# S4\n\t\t[7, 13, 14, 3, 0, 6, 9, 10, 1, 2, 8, 5, 11, 12, 4, 15,\n\t\t 13, 8, 11, 5, 6, 15, 0, 3, 4, 7, 2, 12, 1, 10, 14, 9,\n\t\t 10, 6, 9, 0, 12, 11, 7, 13, 15, 1, 3, 14, 5, 2, 8, 4,\n\t\t 3, 15, 0, 6, 10, 1, 13, 8, 9, 4, 5, 11, 12, 7, 2, 14],\n\n\t\t# S5\n\t\t[2, 12, 4, 1, 7, 10, 11, 6, 8, 5, 3, 15, 13, 0, 14, 9,\n\t\t 14, 11, 2, 12, 4, 7, 13, 1, 5, 0, 15, 10, 3, 9, 8, 6,\n\t\t 4, 2, 1, 11, 10, 13, 7, 8, 15, 9, 12, 5, 6, 3, 0, 14,\n\t\t 11, 8, 12, 7, 1, 14, 2, 13, 6, 15, 0, 9, 10, 4, 5, 3],\n\n\t\t# S6\n\t\t[12, 1, 10, 15, 9, 2, 6, 8, 0, 13, 3, 4, 14, 7, 5, 11,\n\t\t 10, 15, 4, 2, 7, 12, 9, 5, 6, 1, 13, 14, 0, 11, 3, 8,\n\t\t 9, 14, 15, 5, 2, 8, 12, 3, 7, 0, 4, 10, 1, 13, 11, 6,\n\t\t 4, 3, 2, 12, 9, 5, 15, 10, 11, 14, 1, 7, 6, 0, 8, 13],\n\n\t\t# S7\n\t\t[4, 11, 2, 14, 15, 0, 8, 13, 3, 12, 9, 7, 5, 10, 6, 1,\n\t\t 13, 0, 11, 7, 4, 9, 1, 10, 14, 3, 5, 12, 2, 15, 8, 6,\n\t\t 1, 4, 11, 13, 12, 3, 7, 14, 10, 15, 6, 8, 0, 5, 9, 2,\n\t\t 6, 11, 13, 8, 1, 4, 10, 7, 9, 5, 0, 15, 14, 2, 3, 12],\n\n\t\t# S8\n\t\t[13, 2, 8, 4, 6, 15, 11, 1, 10, 9, 3, 14, 5, 0, 12, 7,\n\t\t 1, 15, 13, 8, 10, 3, 7, 4, 12, 5, 6, 11, 0, 14, 9, 2,\n\t\t 7, 11, 4, 1, 9, 12, 14, 2, 0, 6, 10, 13, 15, 3, 5, 8,\n\t\t 2, 1, 14, 7, 4, 10, 8, 13, 15, 12, 9, 0, 3, 5, 6, 11],\n\t]\n\n\n\t# 32-bit permutation function P used on the output of the S-boxes\n\t__p = [\n\t\t15, 6, 19, 20, 28, 11,\n\t\t27, 16, 0, 14, 22, 25,\n\t\t4, 17, 30, 9, 1, 7,\n\t\t23,13, 31, 26, 2, 8,\n\t\t18, 12, 29, 5, 21, 10,\n\t\t3, 24\n\t]\n\n\t# final permutation IP^-1\n\t__fp = [\n\t\t39, 7, 47, 15, 55, 23, 63, 31,\n\t\t38, 6, 46, 14, 54, 22, 62, 30,\n\t\t37, 5, 45, 13, 53, 21, 61, 29,\n\t\t36, 4, 44, 12, 52, 20, 60, 28,\n\t\t35, 3, 43, 11, 51, 19, 59, 27,\n\t\t34, 2, 42, 10, 50, 18, 58, 26,\n\t\t33, 1, 41, 9, 49, 17, 57, 25,\n\t\t32, 0, 40, 8, 48, 16, 56, 24\n\t]\n\n\t# Type of crypting being done\n\tENCRYPT =\t0x00\n\tDECRYPT =\t0x01\n\n\t# Initialisation\n\tdef __init__(self, key, mode=ECB, IV=None, pad=None, padmode=PAD_NORMAL):\n\t\t# Sanity checking of arguments.\n\t\tif len(key) != 8:\n\t\t\traise ValueError(\"Invalid DES key size. Key must be exactly 8 bytes long.\")\n\t\t_baseDes.__init__(self, mode, IV, pad, padmode)\n\t\tself.key_size = 8\n\n\t\tself.L = []\n\t\tself.R = []\n\t\tself.Kn = [ [0] * 48 ] * 16\t# 16 48-bit keys (K1 - K16)\n\t\tself.final = []\n\n\t\tself.setKey(key)\n\n\tdef setKey(self, key):\n\t\t\"\"\"Will set the crypting key for this object. Must be 8 bytes.\"\"\"\n\t\t_baseDes.setKey(self, key)\n\t\tself.__create_sub_keys()\n\n\tdef __String_to_BitList(self, data):\n\t\t\"\"\"Turn the string data, into a list of bits (1, 0)'s\"\"\"\n\t\tif _pythonMajorVersion < 3:\n\t\t\t# Turn the strings into integers. Python 3 uses a bytes\n\t\t\t# class, which already has this behaviour.\n\t\t\tdata = [ord(c) for c in data]\n\t\tl = len(data) * 8\n\t\tresult = [0] * l\n\t\tpos = 0\n\t\tfor ch in data:\n\t\t\ti = 7\n\t\t\twhile i >= 0:\n\t\t\t\tif ch & (1 << i) != 0:\n\t\t\t\t\tresult[pos] = 1\n\t\t\t\telse:\n\t\t\t\t\tresult[pos] = 0\n\t\t\t\tpos += 1\n\t\t\t\ti -= 1\n\n\t\treturn result\n\n\tdef __BitList_to_String(self, data):\n\t\t\"\"\"Turn the list of bits -> data, into a string\"\"\"\n\t\tresult = []\n\t\tpos = 0\n\t\tc = 0\n\t\twhile pos < len(data):\n\t\t\tc += data[pos] << (7 - (pos % 8))\n\t\t\tif (pos % 8) == 7:\n\t\t\t\tresult.append(c)\n\t\t\t\tc = 0\n\t\t\tpos += 1\n\n\t\tif _pythonMajorVersion < 3:\n\t\t\treturn ''.join([ chr(c) for c in result ])\n\t\telse:\n\t\t\treturn bytes(result)\n\n\tdef __permutate(self, table, block):\n\t\t\"\"\"Permutate this block with the specified table\"\"\"\n\t\treturn list([block[x] for x in table])\n\t\n\t# Transform the secret key, so that it is ready for data processing\n\t# Create the 16 subkeys, K[1] - K[16]\n\tdef __create_sub_keys(self):\n\t\t\"\"\"Create the 16 subkeys K[1] to K[16] from the given key\"\"\"\n\t\tkey = self.__permutate(des.__pc1, self.__String_to_BitList(self.getKey()))\n\t\ti = 0\n\t\t# Split into Left and Right sections\n\t\tself.L = key[:28]\n\t\tself.R = key[28:]\n\t\twhile i < 16:\n\t\t\tj = 0\n\t\t\t# Perform circular left shifts\n\t\t\twhile j < des.__left_rotations[i]:\n\t\t\t\tself.L.append(self.L[0])\n\t\t\t\tdel self.L[0]\n\n\t\t\t\tself.R.append(self.R[0])\n\t\t\t\tdel self.R[0]\n\n\t\t\t\tj += 1\n\n\t\t\t# Create one of the 16 subkeys through pc2 permutation\n\t\t\tself.Kn[i] = self.__permutate(des.__pc2, self.L + self.R)\n\n\t\t\ti += 1\n\n\t# Main part of the encryption algorithm, the number cruncher :)\n\tdef __des_crypt(self, block, crypt_type):\n\t\t\"\"\"Crypt the block of data through DES bit-manipulation\"\"\"\n\t\tblock = self.__permutate(des.__ip, block)\n\t\tself.L = block[:32]\n\t\tself.R = block[32:]\n\n\t\t# Encryption starts from Kn[1] through to Kn[16]\n\t\tif crypt_type == des.ENCRYPT:\n\t\t\titeration = 0\n\t\t\titeration_adjustment = 1\n\t\t# Decryption starts from Kn[16] down to Kn[1]\n\t\telse:\n\t\t\titeration = 15\n\t\t\titeration_adjustment = -1\n\n\t\ti = 0\n\t\twhile i < 16:\n\t\t\t# Make a copy of R[i-1], this will later become L[i]\n\t\t\ttempR = self.R[:]\n\n\t\t\t# Permutate R[i - 1] to start creating R[i]\n\t\t\tself.R = self.__permutate(des.__expansion_table, self.R)\n\n\t\t\t# Exclusive or R[i - 1] with K[i], create B[1] to B[8] whilst here\n\t\t\tself.R = list(map(lambda x, y: x ^ y, self.R, self.Kn[iteration]))\n\t\t\tB = [self.R[:6], self.R[6:12], self.R[12:18], self.R[18:24], self.R[24:30], self.R[30:36], self.R[36:42], self.R[42:]]\n\t\t\t# Optimization: Replaced below commented code with above\n\t\t\t#j = 0\n\t\t\t#B = []\n\t\t\t#while j < len(self.R):\n\t\t\t#\tself.R[j] = self.R[j] ^ self.Kn[iteration][j]\n\t\t\t#\tj += 1\n\t\t\t#\tif j % 6 == 0:\n\t\t\t#\t\tB.append(self.R[j-6:j])\n\n\t\t\t# Permutate B[1] to B[8] using the S-Boxes\n\t\t\tj = 0\n\t\t\tBn = [0] * 32\n\t\t\tpos = 0\n\t\t\twhile j < 8:\n\t\t\t\t# Work out the offsets\n\t\t\t\tm = (B[j][0] << 1) + B[j][5]\n\t\t\t\tn = (B[j][1] << 3) + (B[j][2] << 2) + (B[j][3] << 1) + B[j][4]\n\n\t\t\t\t# Find the permutation value\n\t\t\t\tv = des.__sbox[j][(m << 4) + n]\n\n\t\t\t\t# Turn value into bits, add it to result: Bn\n\t\t\t\tBn[pos] = (v & 8) >> 3\n\t\t\t\tBn[pos + 1] = (v & 4) >> 2\n\t\t\t\tBn[pos + 2] = (v & 2) >> 1\n\t\t\t\tBn[pos + 3] = v & 1\n\n\t\t\t\tpos += 4\n\t\t\t\tj += 1\n\n\t\t\t# Permutate the concatination of B[1] to B[8] (Bn)\n\t\t\tself.R = self.__permutate(des.__p, Bn)\n\n\t\t\t# Xor with L[i - 1]\n\t\t\tself.R = list(map(lambda x, y: x ^ y, self.R, self.L))\n\t\t\t# Optimization: This now replaces the below commented code\n\t\t\t#j = 0\n\t\t\t#while j < len(self.R):\n\t\t\t#\tself.R[j] = self.R[j] ^ self.L[j]\n\t\t\t#\tj += 1\n\n\t\t\t# L[i] becomes R[i - 1]\n\t\t\tself.L = tempR\n\n\t\t\ti += 1\n\t\t\titeration += iteration_adjustment\n\t\t\n\t\t# Final permutation of R[16]L[16]\n\t\tself.final = self.__permutate(des.__fp, self.R + self.L)\n\t\treturn self.final\n\n\n\t# Data to be encrypted/decrypted\n\tdef crypt(self, data, crypt_type):\n\t\t\"\"\"Crypt the data in blocks, running it through des_crypt()\"\"\"\n\n\t\t# Error check the data\n\t\tif not data:\n\t\t\treturn ''\n\t\tif len(data) % self.block_size != 0:\n\t\t\tif crypt_type == des.DECRYPT: # Decryption must work on 8 byte blocks\n\t\t\t\traise ValueError(\"Invalid data length, data must be a multiple of \" + str(self.block_size) + \" bytes\\n.\")\n\t\t\tif not self.getPadding():\n\t\t\t\traise ValueError(\"Invalid data length, data must be a multiple of \" + str(self.block_size) + \" bytes\\n. Try setting the optional padding character\")\n\t\t\telse:\n\t\t\t\tdata += (self.block_size - (len(data) % self.block_size)) * self.getPadding()\n\t\t\t# print \"Len of data: %f\" % (len(data) / self.block_size)\n\n\t\tif self.getMode() == CBC:\n\t\t\tif self.getIV():\n\t\t\t\tiv = self.__String_to_BitList(self.getIV())\n\t\t\telse:\n\t\t\t\traise ValueError(\"For CBC mode, you must supply the Initial Value (IV) for ciphering\")\n\n\t\t# Split the data into blocks, crypting each one seperately\n\t\ti = 0\n\t\tdict = {}\n\t\tresult = []\n\t\t#cached = 0\n\t\t#lines = 0\n\t\twhile i < len(data):\n\t\t\t# Test code for caching encryption results\n\t\t\t#lines += 1\n\t\t\t#if dict.has_key(data[i:i+8]):\n\t\t\t\t#print \"Cached result for: %s\" % data[i:i+8]\n\t\t\t#\tcached += 1\n\t\t\t#\tresult.append(dict[data[i:i+8]])\n\t\t\t#\ti += 8\n\t\t\t#\tcontinue\n\t\t\t\t\n\t\t\tblock = self.__String_to_BitList(data[i:i+8])\n\n\t\t\t# Xor with IV if using CBC mode\n\t\t\tif self.getMode() == CBC:\n\t\t\t\tif crypt_type == des.ENCRYPT:\n\t\t\t\t\tblock = list(map(lambda x, y: x ^ y, block, iv))\n\t\t\t\t\t#j = 0\n\t\t\t\t\t#while j < len(block):\n\t\t\t\t\t#\tblock[j] = block[j] ^ iv[j]\n\t\t\t\t\t#\tj += 1\n\n\t\t\t\tprocessed_block = self.__des_crypt(block, crypt_type)\n\n\t\t\t\tif crypt_type == des.DECRYPT:\n\t\t\t\t\tprocessed_block = list(map(lambda x, y: x ^ y, processed_block, iv))\n\t\t\t\t\t#j = 0\n\t\t\t\t\t#while j < len(processed_block):\n\t\t\t\t\t#\tprocessed_block[j] = processed_block[j] ^ iv[j]\n\t\t\t\t\t#\tj += 1\n\t\t\t\t\tiv = block\n\t\t\t\telse:\n\t\t\t\t\tiv = processed_block\n\t\t\telse:\n\t\t\t\tprocessed_block = self.__des_crypt(block, crypt_type)\n\n\n\t\t\t# Add the resulting crypted block to our list\n\t\t\t#d = self.__BitList_to_String(processed_block)\n\t\t\t#result.append(d)\n\t\t\tresult.append(self.__BitList_to_String(processed_block))\n\t\t\t#dict[data[i:i+8]] = d\n\t\t\ti += 8\n\n\t\t# print \"Lines: %d, cached: %d\" % (lines, cached)\n\n\t\t# Return the full crypted string\n\t\tif _pythonMajorVersion < 3:\n\t\t\treturn ''.join(result)\n\t\telse:\n\t\t\treturn bytes.fromhex('').join(result)\n\n\tdef encrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"encrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : Bytes to be encrypted\n\t\tpad : Optional argument for encryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be encrypted\n\t\twith the already specified key. Data does not have to be a\n\t\tmultiple of 8 bytes if the padding character is supplied, or\n\t\tthe padmode is set to PAD_PKCS5, as bytes will then added to\n\t\tensure the be padded data is a multiple of 8 bytes.\n\t\t\"\"\"\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tdata = self._padData(data, pad, padmode)\n\t\treturn self.crypt(data, des.ENCRYPT)\n\n\tdef decrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"decrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : Bytes to be encrypted\n\t\tpad : Optional argument for decryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be decrypted\n\t\twith the already specified key. In PAD_NORMAL mode, if the\n\t\toptional padding character is supplied, then the un-encrypted\n\t\tdata will have the padding characters removed from the end of\n\t\tthe bytes. This pad removal only occurs on the last 8 bytes of\n\t\tthe data (last data block). In PAD_PKCS5 mode, the special\n\t\tpadding end markers will be removed from the data after decrypting.\n\t\t\"\"\"\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tdata = self.crypt(data, des.DECRYPT)\n\t\treturn self._unpadData(data, pad, padmode)\n\n\n\n#############################################################################\n# \t\t\t\tTriple DES\t\t\t\t #\n#############################################################################\nclass triple_des(_baseDes):\n\t\"\"\"Triple DES encryption/decrytpion class\n\n\tThis algorithm uses the DES-EDE3 (when a 24 byte key is supplied) or\n\tthe DES-EDE2 (when a 16 byte key is supplied) encryption methods.\n\tSupports ECB (Electronic Code Book) and CBC (Cypher Block Chaining) modes.\n\n\tpyDes.des(key, [mode], [IV])\n\n\tkey -> Bytes containing the encryption key, must be either 16 or\n\t 24 bytes long\n\tmode -> Optional argument for encryption type, can be either pyDes.ECB\n\t\t(Electronic Code Book), pyDes.CBC (Cypher Block Chaining)\n\tIV -> Optional Initial Value bytes, must be supplied if using CBC mode.\n\t\tMust be 8 bytes in length.\n\tpad -> Optional argument, set the pad character (PAD_NORMAL) to use\n\t\tduring all encrypt/decrpt operations done with this instance.\n\tpadmode -> Optional argument, set the padding mode (PAD_NORMAL or\n\t\tPAD_PKCS5) to use during all encrypt/decrpt operations done\n\t\twith this instance.\n\t\"\"\"\n\tdef __init__(self, key, mode=ECB, IV=None, pad=None, padmode=PAD_NORMAL):\n\t\t_baseDes.__init__(self, mode, IV, pad, padmode)\n\t\tself.setKey(key)\n\n\tdef setKey(self, key):\n\t\t\"\"\"Will set the crypting key for this object. Either 16 or 24 bytes long.\"\"\"\n\t\tself.key_size = 24 # Use DES-EDE3 mode\n\t\tif len(key) != self.key_size:\n\t\t\tif len(key) == 16: # Use DES-EDE2 mode\n\t\t\t\tself.key_size = 16\n\t\t\telse:\n\t\t\t\traise ValueError(\"Invalid triple DES key size. Key must be either 16 or 24 bytes long\")\n\t\tif self.getMode() == CBC:\n\t\t\tif not self.getIV():\n\t\t\t\t# Use the first 8 bytes of the key\n\t\t\t\tself._iv = key[:self.block_size]\n\t\t\tif len(self.getIV()) != self.block_size:\n\t\t\t\traise ValueError(\"Invalid IV, must be 8 bytes in length\")\n\t\tself.__key1 = des(key[:8], self._mode, self._iv,\n\t\t\t\t self._padding, self._padmode)\n\t\tself.__key2 = des(key[8:16], self._mode, self._iv,\n\t\t\t\t self._padding, self._padmode)\n\t\tif self.key_size == 16:\n\t\t\tself.__key3 = self.__key1\n\t\telse:\n\t\t\tself.__key3 = des(key[16:], self._mode, self._iv,\n\t\t\t\t\t self._padding, self._padmode)\n\t\t_baseDes.setKey(self, key)\n\n\t# Override setter methods to work on all 3 keys.\n\n\tdef setMode(self, mode):\n\t\t\"\"\"Sets the type of crypting mode, pyDes.ECB or pyDes.CBC\"\"\"\n\t\t_baseDes.setMode(self, mode)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setMode(mode)\n\n\tdef setPadding(self, pad):\n\t\t\"\"\"setPadding() -> bytes of length 1. Padding character.\"\"\"\n\t\t_baseDes.setPadding(self, pad)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setPadding(pad)\n\n\tdef setPadMode(self, mode):\n\t\t\"\"\"Sets the type of padding mode, pyDes.PAD_NORMAL or pyDes.PAD_PKCS5\"\"\"\n\t\t_baseDes.setPadMode(self, mode)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setPadMode(mode)\n\n\tdef setIV(self, IV):\n\t\t\"\"\"Will set the Initial Value, used in conjunction with CBC mode\"\"\"\n\t\t_baseDes.setIV(self, IV)\n\t\tfor key in (self.__key1, self.__key2, self.__key3):\n\t\t\tkey.setIV(IV)\n\n\tdef encrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"encrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : bytes to be encrypted\n\t\tpad : Optional argument for encryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be encrypted\n\t\twith the already specified key. Data does not have to be a\n\t\tmultiple of 8 bytes if the padding character is supplied, or\n\t\tthe padmode is set to PAD_PKCS5, as bytes will then added to\n\t\tensure the be padded data is a multiple of 8 bytes.\n\t\t\"\"\"\n\t\tENCRYPT = des.ENCRYPT\n\t\tDECRYPT = des.DECRYPT\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\t# Pad the data accordingly.\n\t\tdata = self._padData(data, pad, padmode)\n\t\tif self.getMode() == CBC:\n\t\t\tself.__key1.setIV(self.getIV())\n\t\t\tself.__key2.setIV(self.getIV())\n\t\t\tself.__key3.setIV(self.getIV())\n\t\t\ti = 0\n\t\t\tresult = []\n\t\t\twhile i < len(data):\n\t\t\t\tblock = self.__key1.crypt(data[i:i+8], ENCRYPT)\n\t\t\t\tblock = self.__key2.crypt(block, DECRYPT)\n\t\t\t\tblock = self.__key3.crypt(block, ENCRYPT)\n\t\t\t\tself.__key1.setIV(block)\n\t\t\t\tself.__key2.setIV(block)\n\t\t\t\tself.__key3.setIV(block)\n\t\t\t\tresult.append(block)\n\t\t\t\ti += 8\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\treturn ''.join(result)\n\t\t\telse:\n\t\t\t\treturn bytes.fromhex('').join(result)\n\t\telse:\n\t\t\tdata = self.__key1.crypt(data, ENCRYPT)\n\t\t\tdata = self.__key2.crypt(data, DECRYPT)\n\t\t\treturn self.__key3.crypt(data, ENCRYPT)\n\n\tdef decrypt(self, data, pad=None, padmode=None):\n\t\t\"\"\"decrypt(data, [pad], [padmode]) -> bytes\n\n\t\tdata : bytes to be encrypted\n\t\tpad : Optional argument for decryption padding. Must only be one byte\n\t\tpadmode : Optional argument for overriding the padding mode.\n\n\t\tThe data must be a multiple of 8 bytes and will be decrypted\n\t\twith the already specified key. In PAD_NORMAL mode, if the\n\t\toptional padding character is supplied, then the un-encrypted\n\t\tdata will have the padding characters removed from the end of\n\t\tthe bytes. This pad removal only occurs on the last 8 bytes of\n\t\tthe data (last data block). In PAD_PKCS5 mode, the special\n\t\tpadding end markers will be removed from the data after\n\t\tdecrypting, no pad character is required for PAD_PKCS5.\n\t\t\"\"\"\n\t\tENCRYPT = des.ENCRYPT\n\t\tDECRYPT = des.DECRYPT\n\t\tdata = self._guardAgainstUnicode(data)\n\t\tif pad is not None:\n\t\t\tpad = self._guardAgainstUnicode(pad)\n\t\tif self.getMode() == CBC:\n\t\t\tself.__key1.setIV(self.getIV())\n\t\t\tself.__key2.setIV(self.getIV())\n\t\t\tself.__key3.setIV(self.getIV())\n\t\t\ti = 0\n\t\t\tresult = []\n\t\t\twhile i < len(data):\n\t\t\t\tiv = data[i:i+8]\n\t\t\t\tblock = self.__key3.crypt(iv, DECRYPT)\n\t\t\t\tblock = self.__key2.crypt(block, ENCRYPT)\n\t\t\t\tblock = self.__key1.crypt(block, DECRYPT)\n\t\t\t\tself.__key1.setIV(iv)\n\t\t\t\tself.__key2.setIV(iv)\n\t\t\t\tself.__key3.setIV(iv)\n\t\t\t\tresult.append(block)\n\t\t\t\ti += 8\n\t\t\tif _pythonMajorVersion < 3:\n\t\t\t\tdata = ''.join(result)\n\t\t\telse:\n\t\t\t\tdata = bytes.fromhex('').join(result)\n\t\telse:\n\t\t\tdata = self.__key3.crypt(data, DECRYPT)\n\t\t\tdata = self.__key2.crypt(data, ENCRYPT)\n\t\t\tdata = self.__key1.crypt(data, DECRYPT)\n\t\treturn self._unpadData(data, pad, padmode)\n" }, { "path": "python3/smb/utils/rc4.py", "content": "\ndef RC4_encrypt(key, data):\n S = list(range(256))\n j = 0\n\n key_len = len(key)\n for i in list(range(256)):\n j = (j + S[i] + key[i % key_len]) % 256\n S[i], S[j] = S[j], S[i]\n\n j = 0\n y = 0\n out = []\n\n for char in data:\n j = (j + 1) % 256\n y = (y + S[j]) % 256\n S[j], S[y] = S[y], S[j]\n\n out.append(char ^ S[(S[j] + S[y]) % 256])\n\n return bytes(out)\n" }, { "path": "python3/smb/utils/sha256.py", "content": "__author__ = 'Thomas Dixon'\n__license__ = 'MIT'\n\nimport copy, struct, sys\n\ndigest_size = 32\nblocksize = 1\n\ndef new(m=None):\n return sha256(m)\n\nclass sha256(object):\n _k = (0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5,\n 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,\n 0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3,\n 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,\n 0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc,\n 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,\n 0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7,\n 0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,\n 0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13,\n 0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,\n 0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3,\n 0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,\n 0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5,\n 0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,\n 0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208,\n 0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2)\n _h = (0x6a09e667, 0xbb67ae85, 0x3c6ef372, 0xa54ff53a,\n 0x510e527f, 0x9b05688c, 0x1f83d9ab, 0x5be0cd19)\n _output_size = 8\n\n blocksize = 1\n block_size = 64\n digest_size = 32\n\n def __init__(self, m=None):\n self._buffer = ''\n self._counter = 0\n\n if m is not None:\n if type(m) is not str:\n raise TypeError('%s() argument 1 must be string, not %s' % (self.__class__.__name__, type(m).__name__))\n self.update(m)\n\n def _rotr(self, x, y):\n return ((x >> y) | (x << (32-y))) & 0xFFFFFFFF\n\n def _sha256_process(self, c):\n w = [0]*64\n w[0:15] = struct.unpack('!16L', c)\n\n for i in range(16, 64):\n s0 = self._rotr(w[i-15], 7) ^ self._rotr(w[i-15], 18) ^ (w[i-15] >> 3)\n s1 = self._rotr(w[i-2], 17) ^ self._rotr(w[i-2], 19) ^ (w[i-2] >> 10)\n w[i] = (w[i-16] + s0 + w[i-7] + s1) & 0xFFFFFFFF\n\n a,b,c,d,e,f,g,h = self._h\n\n for i in range(64):\n s0 = self._rotr(a, 2) ^ self._rotr(a, 13) ^ self._rotr(a, 22)\n maj = (a & b) ^ (a & c) ^ (b & c)\n t2 = s0 + maj\n s1 = self._rotr(e, 6) ^ self._rotr(e, 11) ^ self._rotr(e, 25)\n ch = (e & f) ^ ((~e) & g)\n t1 = h + s1 + ch + self._k[i] + w[i]\n\n h = g\n g = f\n f = e\n e = (d + t1) & 0xFFFFFFFF\n d = c\n c = b\n b = a\n a = (t1 + t2) & 0xFFFFFFFF\n\n self._h = [(x+y) & 0xFFFFFFFF for x,y in zip(self._h, [a,b,c,d,e,f,g,h])]\n\n def update(self, m):\n if not m:\n return\n if type(m) is not str:\n raise TypeError('%s() argument 1 must be string, not %s' % (sys._getframe().f_code.co_name, type(m).__name__))\n\n self._buffer += m\n self._counter += len(m)\n\n while len(self._buffer) >= 64:\n self._sha256_process(self._buffer[:64])\n self._buffer = self._buffer[64:]\n\n def digest(self):\n mdi = self._counter & 0x3F\n length = struct.pack('!Q', self._counter<<3)\n\n if mdi < 56:\n padlen = 55-mdi\n else:\n padlen = 119-mdi\n\n r = self.copy()\n r.update('\\x80'+('\\x00'*padlen)+length)\n return ''.join([struct.pack('!L', i) for i in r._h[:self._output_size]])\n\n def hexdigest(self):\n return self.digest().encode('hex')\n\n def copy(self):\n return copy.deepcopy(self)\n" }, { "path": "python3/tests/DirectSMBConnectionTests/__init__.py", "content": "" }, { "path": "python3/tests/DirectSMBConnectionTests/test_auth.py", "content": "\nfrom nose2.tools.decorators import with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn, conn2, conn3 = None, None, None\n\ndef teardown_func():\n global conn, conn2, conn3\n if conn:\n conn.close()\n if conn2:\n conn2.close()\n if conn3:\n conn3.close();\n\n@with_teardown(teardown_func)\ndef test_NTLMv1_auth_SMB1():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_teardown(teardown_func)\ndef test_NTLMv1_auth_SMB1_callable_password():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], lambda: info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_teardown(teardown_func)\ndef test_NTLMv2_auth_SMB1():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_teardown(teardown_func)\ndef test_NTLMv1_auth_SMB2():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n\n@with_teardown(teardown_func)\ndef test_NTLMv2_auth_SMB2():\n global conn, conn2, conn3\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn2.connect(info['server_ip'], info['server_port'])\n\n conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert not conn3.connect(info['server_ip'], info['server_port'])\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_createdeletedirectory.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_english_directory_SMB1():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_english_directory_SMB2():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_unicode_directory_SMB1():\n global conn\n\n path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_unicode_directory_SMB2():\n global conn\n\n path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_echo.py", "content": "\nimport random\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func():\n global conn\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func)\n@with_teardown(teardown_func)\ndef test_echo():\n global conn\n\n data = bytearray('%d' % random.randint(1000, 9999), 'ascii')\n assert conn.echo(data) == data\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_listpath.py", "content": "# -*- coding: utf-8 -*-\n\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb.smb_constants import *\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( '\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( 'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( 'TestDir1', True ) in filenames # Test short English folder names\n assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( 'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listSubPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( 'Test File.txt', False ) in filenames\n assert ( 'Test Folder', True ) in filenames\n assert ( '子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathWithManyFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames))==999\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( '\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( 'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( 'TestDir1', True ) in filenames # Test short English folder names\n assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( 'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listSubPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( 'Test File.txt', False ) in filenames\n assert ( 'Test Folder', True ) in filenames\n assert ( '子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathWithManyFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames))==999\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterForDirectory_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterForDirectory_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterForFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterForFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterPattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterPattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterUnicodePattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterUnicodePattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_listshares.py", "content": "\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listshares_SMB1():\n global conn\n results = conn.listShares()\n assert 'smbtest' in [r.name.lower() for r in results]\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listshares_SMB2():\n global conn\n results = conn.listShares()\n assert 'smbtest' in [r.name.lower() for r in results]\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_listsnapshots.py", "content": "\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listsnapshots_SMB1():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listsnapshots_SMB2():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_rename.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_english_file_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_english_file_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_unicode_file_SMB1():\n global conn\n\n old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_unicode_file_SMB2():\n global conn\n\n old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_english_directory_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_english_directory_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_unicode_directory_SMB1():\n global conn\n\n old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_unicode_directory_SMB2():\n global conn\n\n old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_retrievefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_multiplereads_SMB1():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_multiplereads_SMB2():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_longfilename_SMB1():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_longfilename_SMB2():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_unicodefilename_SMB1():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_unicodefilename_SMB2():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_SMB1():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_SMB2():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_biglimit_SMB1():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_biglimit_SMB2():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_smalllimit_SMB1():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_smalllimit_SMB2():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_zerolimit_SMB1():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_zerolimit_SMB2():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_storefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile, random, time\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_store_long_filename_SMB1():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_store_long_filename_SMB2():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_store_unicode_filename_SMB1():\n filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_store_unicode_filename_SMB2():\n filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n" }, { "path": "python3/tests/DirectSMBConnectionTests/test_tqdm.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_tqdm_SMB1():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh, show_progress=True)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_tqdm_SMB2():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh, show_progress=True)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_store_tqdm_SMB1():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_store_tqdm_SMB2():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n" }, { "path": "python3/tests/DirectSMBConnectionTests/util.py", "content": "\nimport os\nfrom configparser import ConfigParser\n\ndef getConnectionInfo():\n config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini')\n cp = ConfigParser()\n cp.read(config_filename)\n\n info = {\n 'server_name': cp.get('server', 'name'),\n 'server_ip': cp.get('server', 'ip'),\n 'server_port': cp.getint('server', 'direct_port'),\n 'client_name': cp.get('client', 'name'),\n 'user': cp.get('user', 'name'),\n 'password': cp.get('user', 'password'),\n 'is_direct_tcp': True,\n }\n return info\n" }, { "path": "python3/tests/NetBIOSTests/__init__.py", "content": "" }, { "path": "python3/tests/NetBIOSTests/test_queryname.py", "content": "\nfrom nmb.NetBIOS import NetBIOS\nfrom nose2.tools.decorators import with_teardown\n\nconn = None\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_teardown(teardown_func)\ndef test_broadcast():\n global conn\n conn = NetBIOS()\n assert conn.queryName('MICHAEL-I5PC', timeout = 10)\n\n" }, { "path": "python3/tests/README.md", "content": "\nSteps to Follow to Run the Unit Tests\n=====================================\n\n## Step 1: Install system dependencies ##\n\nIf you are using Ubuntu 20.04 LTS, you can install the system dependencies with the following command\n```\n$> apt-get install python3-dev python3-venv gcc g++ make automake autoconf\n```\nFor other distributions, you can use their package managers and install the system dependencies (although the package names might differ slightly).\n\n## Step 2: Setup python virtualenv ##\n\nWe will create a python3 virtualenv and install the python dependencies for testing in the \"venv3\" folder.\n\n```\n$> cd /python3\n$> virtualenv -p /usr/bin/python3 venv3\n$> source venv3/bin/activate\n$venv3> pip install nose2 pyasn1 twisted\n```\n\n## Step 3: Setup shared folder on your remote SMB server ##\n\nPrepare a shared folder called \"smbtest\" on your remote SMB server (Windows or Samba). \n\nThen, download [smbtest.zip](https://miketeo.net/files/Projects/pysmb/smbtest.zip) and unzip the contents of this zip file in the shared folder.\n\nYou should also configure a user on the SMB server with read-write access to the \"smbtest\" folder.\n\n## Step 4: Update connection details in connection.ini ##\n\nIn the same folder where you are viewing this readme file, there should be an ini file called \"connection.ini\". Edit this file's connection details to match the shared folder's access information.\n\n## Step 5: Run the unit tests in the python3 folder ##\n\nBefore running the tests, the venv3 virtualenv must be activated.\n```\n$> cd /python3\n$> source venv3/bin/activate\n```\n\nTo run all the tests:\n```\n $venv3> nose2 -v tests\n```\n\nTo selectively run some tests: \n```\n $venv3> nose2 -v tests.SMBConnectionTests\n $venv3> nose2 -v tests.SMBConnectionTests.test_rename\n $venv3> nose2 -v tests.SMBConnectionTests.test_rename.test_rename_english_file_SMB1\n```\nFor more information, please consult the [documentation for nose2](https://docs.nose2.io/).\n\n\n" }, { "path": "python3/tests/SMBConnectionTests/__init__.py", "content": "" }, { "path": "python3/tests/SMBConnectionTests/test_SMBHandler.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, urllib.request, urllib.parse, urllib.error, urllib.request, urllib.error, urllib.parse, time, random\nfrom smb.SMBHandler import SMBHandler\nimport util\n\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\n\n\ndef test_basic():\n # Basic test for smb URLs\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/rfc1001.txt' % util.getConnectionInfo())\n\n s = fh.read()\n md = MD5()\n md.update(s)\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert len(s) == 158437\n\n fh.close()\n\n\ndef test_unicode():\n # Test smb URLs with unicode paths\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/测试文件夹/垃圾文件.dat' % util.getConnectionInfo())\n\n s = fh.read()\n md = MD5()\n md.update(s)\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert len(s) == 256000\n\n fh.close()\n\n\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\ndef test_upload():\n info = util.getConnectionInfo()\n info['filename'] = os.sep + 'StoreTest-%d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n director = urllib.request.build_opener(SMBHandler)\n upload_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info, data = open(TEST_FILENAME, 'rb'))\n\n retr_fh = director.open('smb://%(user)s:%(password)s@%(server_ip)s/smbtest/%(filename)s' % info)\n\n s = retr_fh.read()\n md = MD5()\n md.update(s)\n\n assert md.hexdigest() == TEST_DIGEST\n assert len(s) == TEST_FILESIZE\n" }, { "path": "python3/tests/SMBConnectionTests/test_auth.py", "content": "\nfrom nose2.tools.decorators import with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_teardown(teardown_func)\ndef test_NTLMv1_auth_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n@with_teardown(teardown_func)\ndef test_NTLMv2_auth_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n@with_teardown(teardown_func)\ndef test_NTLMv1_auth_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n@with_teardown(teardown_func)\ndef test_NTLMv2_auth_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n" }, { "path": "python3/tests/SMBConnectionTests/test_createdeletedirectory.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_english_directory_SMB1():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_english_directory_SMB2():\n global conn\n\n path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_unicode_directory_SMB1():\n global conn\n\n path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_unicode_directory_SMB2():\n global conn\n\n path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) in names\n\n conn.deleteDirectory('smbtest', path)\n\n entries = conn.listPath('smbtest', os.path.dirname(path.replace('/', os.sep)))\n names = [e.filename for e in entries]\n assert os.path.basename(path.replace('/', os.sep)) not in names\n" }, { "path": "python3/tests/SMBConnectionTests/test_deletepattern.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_delete_without_subfolder_SMB1():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt')\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*')\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_delete_with_subfolder_SMB1():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' not in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_delete_without_subfolder_SMB2():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt')\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*')\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_delete_with_subfolder_SMB2():\n global conn\n\n path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) )\n conn.createDirectory('smbtest', path)\n\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]:\n conn.createDirectory('smbtest', path+\"/\"+p)\n for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]:\n conn.storeFile('smbtest', path+\"/\"+p+\"/\"+filename, BytesIO(b\"0123456789\"))\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' in filenames\n assert 'aaBest.txt' in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.txt' not in filenames\n assert 'aaBest.txt' not in filenames\n assert 'aaTest.bin' in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n\n conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True)\n\n results = conn.listPath('smbtest', path)\n filenames = list(map(lambda r: r.filename, results))\n assert 'aaTest.Folder' not in filenames\n assert 'bbTest.Folder' in filenames\n assert 'aaTest.bin' not in filenames\n assert 'aaBest.bin' in filenames\n assert 'random.txt' in filenames\n" }, { "path": "python3/tests/SMBConnectionTests/test_echo.py", "content": "\nimport random\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func():\n global conn\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func)\n@with_teardown(teardown_func)\ndef test_echo():\n global conn\n\n data = bytearray('%d' % random.randint(1000, 9999), 'ascii')\n assert conn.echo(data) == data\n" }, { "path": "python3/tests/SMBConnectionTests/test_getattributes.py", "content": "# -*- coding: utf-8 -*-\n\nfrom smb.SMBConnection import SMBConnection\nfrom .util import getConnectionInfo\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb import smb_structs\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n \n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_getAttributes_SMB2():\n global conn\n info = conn.getAttributes('smbtest', '/Test Folder with Long Name/')\n assert info.isDirectory\n \n info = conn.getAttributes('smbtest', '/rfc1001.txt')\n assert not info.isDirectory\n assert info.file_size == 158437\n assert info.alloc_size == 159744\n \n info = conn.getAttributes('smbtest', u'/\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939')\n assert info.isDirectory\n \n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_getAttributes_SMB1():\n global conn\n info = conn.getAttributes('smbtest', '/Test Folder with Long Name/')\n assert info.isDirectory\n \n info = conn.getAttributes('smbtest', '/rfc1001.txt')\n assert not info.isDirectory\n assert info.file_size == 158437\n assert info.alloc_size == 159744\n \n info = conn.getAttributes('smbtest', u'/\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939')\n assert info.isDirectory\n\n" }, { "path": "python3/tests/SMBConnectionTests/test_listpath.py", "content": "# -*- coding: utf-8 -*-\n\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb.smb_constants import *\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( '\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( 'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( 'TestDir1', True ) in filenames # Test short English folder names\n assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( 'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listSubPath_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( 'Test File.txt', False ) in filenames\n assert ( 'Test Folder', True ) in filenames\n assert ( '子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathWithManyFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames))==999\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( '\\u6d4b\\u8bd5\\u6587\\u4ef6\\u5939', True ) in filenames # Test non-English folder names\n assert ( 'Test Folder with Long Name', True ) in filenames # Test long English folder names\n assert ( 'TestDir1', True ) in filenames # Test short English folder names\n assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names\n assert ( 'rfc1001.txt', False ) in filenames # Test short English file names\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listSubPath_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name/')\n filenames = [( r.filename, r.isDirectory ) for r in results]\n assert ( 'Test File.txt', False ) in filenames\n assert ( 'Test Folder', True ) in filenames\n assert ( '子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathWithManyFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive/')\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames))==999\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterForDirectory_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterForDirectory_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert isDirectory\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterForFiles_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterForFiles_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL)\n filenames = map(lambda r: ( r.filename, r.isDirectory ), results)\n assert len(list(filenames)) > 0\n for f, isDirectory in filenames:\n assert not isDirectory\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterPattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterPattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 2\n assert ( u'Test File.txt', False ) in filenames\n assert ( u'Test Folder', True ) in filenames\n assert ( u'子文件夹', True ) not in filenames\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterUnicodePattern_SMB1():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterUnicodePattern_SMB2():\n global conn\n results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n assert len(filenames) == 1\n assert ( u'Test File.txt', False ) not in filenames\n assert ( u'Test Folder', True ) not in filenames\n assert ( u'子文件夹', True ) in filenames\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listPathFilterEmptyList_SMB1():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listPathFilterEmptyList_SMB2():\n global conn\n results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc')\n filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results))\n" }, { "path": "python3/tests/SMBConnectionTests/test_listshares.py", "content": "\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listshares_SMB1():\n global conn\n results = conn.listShares()\n assert 'smbtest' in [r.name.lower() for r in results]\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listshares_SMB2():\n global conn\n results = conn.listShares()\n assert 'smbtest' in [r.name.lower() for r in results]\n" }, { "path": "python3/tests/SMBConnectionTests/test_listsnapshots.py", "content": "\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_listsnapshots_SMB1():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_listsnapshots_SMB2():\n global conn\n results = conn.listSnapshots('smbtest', '/rfc1001.txt')\n assert len(results) > 0\n" }, { "path": "python3/tests/SMBConnectionTests/test_messages_in_exception.py", "content": "# -*- coding: utf-8 -*-\n\nfrom io import BytesIO\nfrom typing import Optional\n\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\n\nconn: Optional[SMBConnection] = None\nTEST_FILE_NAME = 'StoreTest.txt'\nTEST_SERVICE_NAME = 'smbtest'\n\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp=True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\n\ndef teardown_func():\n global conn\n conn.close()\n\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_messages_in_exception_SMB2():\n info = getConnectionInfo()\n\n with open(f'''\\\\\\\\{info['server_ip']}\\\\{TEST_SERVICE_NAME}\\\\{TEST_FILE_NAME}''', 'w'):\n try:\n conn.storeFile(TEST_SERVICE_NAME, TEST_FILE_NAME, BytesIO(b'Test data'))\n except Exception as ex:\n conn.retrieveFile(TEST_SERVICE_NAME, TEST_FILE_NAME, BytesIO())\n last_smb_message = ex.args[1][-1]\n if last_smb_message.status != 0xC0000043:\n raise ex\n" }, { "path": "python3/tests/SMBConnectionTests/test_rename.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, time, random\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_english_file_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_english_file_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_unicode_file_SMB1():\n global conn\n\n old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_unicode_file_SMB2():\n global conn\n\n old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.storeFile('smbtest', old_path, BytesIO(b'Rename file test'))\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteFiles('smbtest', new_path)\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_english_directory_SMB1():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_english_directory_SMB2():\n global conn\n\n old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_rename_unicode_directory_SMB1():\n global conn\n\n old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_rename_unicode_directory_SMB2():\n global conn\n\n old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) )\n\n conn.createDirectory('smbtest', old_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) not in filenames\n\n conn.rename('smbtest', old_path, new_path)\n\n entries = conn.listPath('smbtest', os.path.dirname(old_path.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(old_path.replace('/', os.sep)) not in filenames\n assert os.path.basename(new_path.replace('/', os.sep)) in filenames\n\n conn.deleteDirectory('smbtest', new_path)\n" }, { "path": "python3/tests/SMBConnectionTests/test_retrievefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_multiplereads_SMB1():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_multiplereads_SMB2():\n # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes)\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '5367c2bbf97f521059c78eab65309ad3'\n assert filesize == 158437\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_longfilename_SMB1():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_longfilename_SMB2():\n # Test file retrieval that has a long English filename\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/Implementing CIFS - SMB.html', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '671c5700d279fcbbf958c1bba3c2639e'\n assert filesize == 421269\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_unicodefilename_SMB1():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_unicodefilename_SMB2():\n # Test file retrieval that has a long non-English filename inside a folder with a non-English name\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '8a44c1e80d55e91c92350955cdf83442'\n assert filesize == 256000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_SMB1():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_SMB2():\n # Test file retrieval from offset to EOF\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'a141bd8024571ce7cb5c67f2b0d8ea0b'\n assert filesize == 156000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_biglimit_SMB1():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_biglimit_SMB2():\n # Test file retrieval from offset with a big max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 100000)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '83b7afd7c92cdece3975338b5ca0b1c5'\n assert filesize == 100000\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_smalllimit_SMB1():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_smalllimit_SMB2():\n # Test file retrieval from offset with a small max_length\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 10)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == '746f60a96b39b712a7b6e17ddde19986'\n assert filesize == 10\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_zerolimit_SMB1():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_retr_offset_and_zerolimit_SMB2():\n # Test file retrieval from offset to EOF with max_length=0\n global conn\n temp_fh = BytesIO()\n file_attributes, filesize = conn.retrieveFileFromOffset('smbtest', '/测试文件夹/垃圾文件.dat', temp_fh, offset = 100000, max_length = 0)\n\n md = MD5()\n md.update(temp_fh.getvalue())\n assert md.hexdigest() == 'd41d8cd98f00b204e9800998ecf8427e'\n assert filesize == 0\n\n temp_fh.close()\n" }, { "path": "python3/tests/SMBConnectionTests/test_storefile.py", "content": "# -*- coding: utf-8 -*-\n\nimport os, tempfile, random, time\nfrom io import BytesIO\nfrom nose2.tools.decorators import with_setup, with_teardown\nfrom smb.SMBConnection import SMBConnection\nfrom smb import smb_structs\nfrom .util import getConnectionInfo\n\ntry:\n import hashlib\n def MD5(): return hashlib.md5()\nexcept ImportError:\n import md5\n def MD5(): return md5.new()\n\nconn = None\n\nTEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat')\nTEST_FILESIZE = 256000\nTEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48'\n\ndef setup_func_SMB1():\n global conn\n smb_structs.SUPPORT_SMB2 = False\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef setup_func_SMB2():\n global conn\n smb_structs.SUPPORT_SMB2 = True\n\n info = getConnectionInfo()\n conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True)\n assert conn.connect(info['server_ip'], info['server_port'])\n\ndef teardown_func():\n global conn\n conn.close()\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_store_long_filename_SMB1():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_store_long_filename_SMB2():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_store_unicode_filename_SMB1():\n filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n\n@with_setup(setup_func_SMB1)\n@with_teardown(teardown_func)\ndef test_store_from_offset_SMB1():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n buf = BytesIO(b'0123456789')\n filesize = conn.storeFile('smbtest', filename, buf)\n assert filesize == 10\n\n buf = BytesIO(b'aa')\n pos = conn.storeFileFromOffset('smbtest', filename, buf, 5)\n assert pos == 7\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == 10\n assert buf.getvalue() == b'01234aa789'\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_store_unicode_filename_SMB2():\n filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n filesize = conn.storeFile('smbtest', filename, open(TEST_FILENAME, 'rb'))\n assert filesize == TEST_FILESIZE\n\n entries = conn.listPath('smbtest', os.path.dirname(filename.replace('/', os.sep)))\n filenames = [e.filename for e in entries]\n assert os.path.basename(filename.replace('/', os.sep)) in filenames\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == TEST_FILESIZE\n\n md = MD5()\n md.update(buf.getvalue())\n assert md.hexdigest() == TEST_DIGEST\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n\n@with_setup(setup_func_SMB2)\n@with_teardown(teardown_func)\ndef test_store_from_offset_SMB2():\n filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) )\n\n buf = BytesIO(b'0123456789')\n filesize = conn.storeFile('smbtest', filename, buf)\n assert filesize == 10\n\n buf = BytesIO(b'aa')\n pos = conn.storeFileFromOffset('smbtest', filename, buf, 5)\n assert pos == 7\n\n buf = BytesIO()\n file_attributes, file_size = conn.retrieveFile('smbtest', filename, buf)\n assert file_size == 10\n assert buf.getvalue() == b'01234aa789'\n buf.close()\n\n conn.deleteFiles('smbtest', filename)\n " }, { "path": "python3/tests/SMBConnectionTests/test_with_context.py", "content": "# -*- coding: utf-8 -*-\n\nfrom smb.SMBConnection import SMBConnection\nfrom .util import getConnectionInfo\n\ndef test_context():\n info = getConnectionInfo()\n with SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) as conn:\n assert conn.connect(info['server_ip'], info['server_port'])\n\n assert conn.sock is None\n" }, { "path": "python3/tests/SMBConnectionTests/util.py", "content": "\nimport os\nfrom configparser import ConfigParser\n\ndef getConnectionInfo():\n config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini')\n cp = ConfigParser()\n cp.read(config_filename)\n\n info = {\n 'server_name': cp.get('server', 'name'),\n 'server_ip': cp.get('server', 'ip'),\n 'server_port': cp.getint('server', 'port'),\n 'client_name': cp.get('client', 'name'),\n 'user': cp.get('user', 'name'),\n 'password': cp.get('user', 'password'),\n 'domain': cp.get('user', 'domain')\n }\n return info\n" }, { "path": "python3/tests/__init__.py", "content": "" }, { "path": "python3/tests/connection.ini", "content": "\n[server]\nname = SERVER\nip = 192.168.1.1\nport = 139\ndirect_port = 445\n\n[client]\nname = TESTCLIENT\n\n[user]\nname = myuser\npassword = mypassword\ndomain =\n" }, { "path": "python3/tests/test_md4.py", "content": "from smb.utils.md4 import MD4\n\n_md4_test_data = [\n (\"\", 0x31d6cfe0d16ae931b73c59d7e0c089c0),\n (\"a\", 0xbde52cb31de33e46245e05fbdbd6fb24),\n (\"abc\", 0xa448017aaf21d8525fc10ae87aa6729d),\n (\"message digest\", 0xd9130a8164549fe818874806e1c7014b),\n (\"abcdefghijklmnopqrstuvwxyz\", 0xd79e1c308aa5bbcdeea8ed63df412da9),\n (\n \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\",\n 0x043f8582f241db351ce627e153e7f0e4),\n (\n \"12345678901234567890123456789012345678901234567890123456789012345678901234567890\",\n 0xe33b4ddc9c38f2199c3e7b164fcc0536),\n (\"The quick brown fox jumps over the lazy dog\", 0x1bee69a46ba811185c194762abaeae90),\n (\"The quick brown fox jumps over the lazy cog\", 0xb86e130ce7028da59e672d56ad0113df)\n]\n\n\ndef test_md4():\n for input_data, expected_result in _md4_test_data:\n expected_digest = expected_result.to_bytes(16, byteorder=\"big\", signed=False)\n md4 = MD4()\n md4.update(input_data)\n computed_digest = md4.digest()\n assert computed_digest == expected_digest\n" }, { "path": "python3/tests/test_ntlm.py", "content": "\nimport binascii\nfrom smb import ntlm\n\ndef test_NTLMv1_without_extended_security():\n password = 'Password'\n server_challenge = b'\\x01\\x23\\x45\\x67\\x89\\xab\\xcd\\xef'\n\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(password,\n server_challenge,\n has_extended_security = False,\n client_challenge = b'\\xAA'*8)\n\n assert binascii.hexlify(nt_challenge_response).lower() == b'67 c4 30 11 f3 02 98 a2 ad 35 ec e6 4f 16 33 1c 44 bd be d9 27 84 1f 94'.replace(b' ', b'') # [MS-NLMP]: 4.2.2.2.1\n assert binascii.hexlify(lm_challenge_response).lower() == b'98 de f7 b8 7f 88 aa 5d af e2 df 77 96 88 a1 72 de f1 1c 7d 5c cd ef 13'.replace(b' ', b'') # [MS-NLMP]: 4.2.2.2.2\n\n\ndef test_NTLMv1_with_extended_security():\n password = 'Password'\n server_challenge = b'\\x01\\x23\\x45\\x67\\x89\\xab\\xcd\\xef'\n\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(password,\n server_challenge,\n has_extended_security = True,\n client_challenge = b'\\xAA'*8)\n\n assert binascii.hexlify(nt_challenge_response).lower() == b'75 37 f8 03 ae 36 71 28 ca 45 82 04 bd e7 ca f8 1e 97 ed 26 83 26 72 32'.replace(b' ', b'') # [MS-NLMP]: 4.2.3.2.2\n assert binascii.hexlify(lm_challenge_response).lower() == b'aa aa aa aa aa aa aa aa 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00'.replace(b' ', b'') # [MS-NLMP]: 4.2.3.2.1\n\n\ndef test_NTLMv2():\n user = 'User'\n password = 'Password'\n domain = 'Domain'\n server_challenge = b'\\x01\\x23\\x45\\x67\\x89\\xab\\xcd\\xef'\n\n server_avpair = binascii.unhexlify(b'01 00 0c 00 53 00 65 00 72 00 76 00 65 00 72 00'.replace(b' ', b''))\n domain_avpair = binascii.unhexlify(b'02 00 0c 00 44 00 6f 00 6d 00 61 00 69 00 6e 00'.replace(b' ', b''))\n\n nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV2(password,\n user,\n server_challenge,\n server_avpair + domain_avpair + b'\\0'*4,\n domain,\n client_challenge = b'\\xAA'*8)\n\n assert binascii.hexlify(lm_challenge_response).lower() == b'86 c3 50 97 ac 9c ec 10 25 54 76 4a 57 cc cc 19 aa aa aa aa aa aa aa aa'.replace(b' ', b'') # [MS-NLMP]: 4.2.4.2.1\n" }, { "path": "python3/tests/test_security_descriptors.py", "content": "import binascii\n\nfrom smb import security_descriptors as sd\nfrom smb import smb_constants as sc\n\n\ndef test_sid_string_representation():\n sid = sd.SID(1, 5, [2, 3, 4])\n assert str(sid) == \"S-1-5-2-3-4\"\n sid = sd.SID(1, 2**32 + 3, [])\n assert str(sid) == \"S-1-0x100000003\"\n sid = sd.SID(1, 2**32, [3, 2, 1])\n assert str(sid) == \"S-1-0x100000000-3-2-1\"\n\n\ndef test_sid_binary_parsing():\n raw_sid = binascii.unhexlify(b\"\"\"\n 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a\n 2a 4f da ca c1 79 a6 32 b1 04 00 00\n \"\"\".translate(None, b' \\n'))\n assert str(sd.SID.from_bytes(raw_sid)) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n raw_sid += b\"garbage\"\n assert str(sd.SID.from_bytes(raw_sid)) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n sid, tail = sd.SID.from_bytes(raw_sid, return_tail=True)\n assert str(sid) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n assert tail == b\"garbage\"\n\n\ndef test_ace_binary_parsing():\n raw_ace = binascii.unhexlify(b\"\"\"\n 00 10 24 00 ff 01 1f 00 01 05 00 00 00 00 00 05\n 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32\n 6e 04 00 00\n \"\"\".translate(None, b' \\n'))\n ace = sd.ACE.from_bytes(raw_ace)\n assert str(ace.sid) == \"S-1-5-21-717312990-3403304746-849770945-1134\"\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert ace.flags == sd.ACE_FLAG_INHERITED\n assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC\n | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA\n | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA\n | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE\n | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES\n | sc.FILE_WRITE_ATTRIBUTES)\n assert not ace.additional_data\n\n raw_ace = binascii.unhexlify(b\"\"\"\n 00 13 18 00 a9 00 12 00 01 02 00 00 00 00 00 05\n 20 00 00 00 21 02 00 00\n \"\"\".translate(None, b' \\n'))\n ace = sd.ACE.from_bytes(raw_ace)\n assert str(ace.sid) == \"S-1-5-32-545\"\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert ace.flags == (sd.ACE_FLAG_INHERITED | sd.ACE_FLAG_CONTAINER_INHERIT\n | sd.ACE_FLAG_OBJECT_INHERIT)\n assert ace.mask == (sc.SYNCHRONIZE | sc.READ_CONTROL | sc.FILE_READ_DATA\n | sc.FILE_READ_EA | sc.FILE_EXECUTE\n | sc.FILE_READ_ATTRIBUTES)\n assert not ace.additional_data\n\n raw_ace = binascii.unhexlify(b\"\"\"\n 01 03 24 00 a9 00 02 00 01 05 00 00 00 00 00 05\n 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32\n 6c 04 00 00\n \"\"\".translate(None, b' \\n'))\n ace = sd.ACE.from_bytes(raw_ace)\n assert str(ace.sid) == \"S-1-5-21-717312990-3403304746-849770945-1132\"\n assert ace.type == sd.ACE_TYPE_ACCESS_DENIED\n assert ace.flags == (sd.ACE_FLAG_CONTAINER_INHERIT\n | sd.ACE_FLAG_OBJECT_INHERIT)\n assert ace.mask == (sc.READ_CONTROL | sc.FILE_READ_DATA | sc.FILE_READ_EA\n | sc.FILE_EXECUTE | sc.FILE_READ_ATTRIBUTES)\n assert not ace.additional_data\n\n\ndef test_acl_binary_parsing():\n raw_acl = binascii.unhexlify(b\"\"\"\n 02 00 70 00 04 00 00 00 00 10 18 00 89 00 10 00\n 01 02 00 00 00 00 00 05 20 00 00 00 21 02 00 00\n 00 10 14 00 ff 01 1f 00 01 01 00 00 00 00 00 05\n 12 00 00 00 00 10 18 00 ff 01 1f 00 01 02 00 00\n 00 00 00 05 20 00 00 00 20 02 00 00 00 10 24 00\n ff 01 1f 00 01 05 00 00 00 00 00 05 15 00 00 00\n de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00\n \"\"\".translate(None, b' \\n'))\n acl = sd.ACL.from_bytes(raw_acl)\n assert acl.revision == 2\n assert len(acl.aces) == 4\n\n ace = acl.aces[0]\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert str(ace.sid) == \"S-1-5-32-545\"\n assert ace.flags == sd.ACE_FLAG_INHERITED\n assert ace.mask == (sc.SYNCHRONIZE | sc.FILE_READ_DATA | sc.FILE_READ_EA\n | sc.FILE_READ_ATTRIBUTES)\n\n ace = acl.aces[3]\n assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED\n assert str(ace.sid) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n assert ace.flags == sd.ACE_FLAG_INHERITED\n assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC\n | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA\n | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA\n | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE\n | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES\n | sc.FILE_WRITE_ATTRIBUTES)\n\n\ndef test_descriptor_binary_parsing():\n raw_descriptor = binascii.unhexlify(b\"\"\"\n 01 00 04 84 14 00 00 00 30 00 00 00 00 00 00 00\n 4c 00 00 00 01 05 00 00 00 00 00 05 15 00 00 00\n de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00\n 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a\n 2a 4f da ca c1 79 a6 32 01 02 00 00 02 00 70 00\n 04 00 00 00 00 10 18 00 89 00 10 00 01 02 00 00\n 00 00 00 05 20 00 00 00 21 02 00 00 00 10 14 00\n ff 01 1f 00 01 01 00 00 00 00 00 05 12 00 00 00\n 00 10 18 00 ff 01 1f 00 01 02 00 00 00 00 00 05\n 20 00 00 00 20 02 00 00 00 10 24 00 ff 01 1f 00\n 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a\n 2a 4f da ca c1 79 a6 32 b1 04 00 00\n \"\"\".translate(None, b' \\n'))\n descriptor = sd.SecurityDescriptor.from_bytes(raw_descriptor)\n assert descriptor.flags == (sd.SECURITY_DESCRIPTOR_SELF_RELATIVE\n | sd.SECURITY_DESCRIPTOR_DACL_PRESENT\n | sd.SECURITY_DESCRIPTOR_DACL_AUTO_INHERITED)\n assert descriptor.dacl is not None\n assert descriptor.sacl is None\n assert str(descriptor.owner) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n assert str(descriptor.group) == \"S-1-5-21-717312990-3403304746-849770945-513\"\n\n acl = descriptor.dacl\n assert acl.revision == 2\n assert len(acl.aces) == 4\n assert str(acl.aces[0].sid) == sd.SID_BUILTIN_USERS\n assert str(acl.aces[1].sid) == sd.SID_LOCAL_SYSTEM\n assert str(acl.aces[2].sid) == sd.SID_BUILTIN_ADMINISTRATORS\n assert str(acl.aces[3].sid) == \"S-1-5-21-717312990-3403304746-849770945-1201\"\n" }, { "path": "python3/tests/test_securityblob.py", "content": "\nimport binascii\nfrom smb import securityblob\n\n\ndef test_NTLMSSP_NEGOTIATE_encoding():\n ntlm_data = binascii.unhexlify(b'4e544c4d5353500001000000978208e200000000000000000000000000000000060072170000000f') # The NTLM negotiate message\n blob = securityblob.generateNegotiateSecurityBlob(ntlm_data)\n\n TARGET = binascii.unhexlify(b\"\"\"\n60 48 06 06 2b 06 01 05 05 02 a0 3e 30 3c a0 0e\n30 0c 06 0a 2b 06 01 04 01 82 37 02 02 0a a2 2a\n04 28 4e 54 4c 4d 53 53 50 00 01 00 00 00 97 82\n08 e2 00 00 00 00 00 00 00 00 00 00 00 00 00 00\n00 00 06 00 72 17 00 00 00 0f\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n\n assert blob == TARGET\n\n\ndef test_NTLMSSP_CHALLENGE_decoding():\n blob = binascii.unhexlify(b\"\"\"\na1 81 be 30 81 bb a0 03 0a 01 01 a1 0c 06 0a 2b\n06 01 04 01 82 37 02 02 0a a2 81 a5 04 81 a2 4e\n54 4c 4d 53 53 50 00 02 00 00 00 0a 00 0a 00 38\n00 00 00 15 82 8a e2 32 81 ce 29 7f de 3f 80 00\n00 00 00 00 00 00 00 60 00 60 00 42 00 00 00 06\n01 00 00 00 00 00 0f 43 00 45 00 54 00 55 00 53\n00 02 00 0a 00 43 00 45 00 54 00 55 00 53 00 01\n00 0a 00 43 00 45 00 54 00 55 00 53 00 04 00 16\n00 6c 00 6f 00 63 00 61 00 6c 00 64 00 6f 00 6d\n00 61 00 69 00 6e 00 03 00 22 00 63 00 65 00 74\n00 75 00 73 00 2e 00 6c 00 6f 00 63 00 61 00 6c\n00 64 00 6f 00 6d 00 61 00 69 00 6e 00 00 00 00\n00\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n\n RESPONSE_TOKENS = binascii.unhexlify(b\"\"\"\n4e 54 4c 4d 53 53 50 00 02 00 00 00 0a 00 0a 00\n38 00 00 00 15 82 8a e2 32 81 ce 29 7f de 3f 80\n00 00 00 00 00 00 00 00 60 00 60 00 42 00 00 00\n06 01 00 00 00 00 00 0f 43 00 45 00 54 00 55 00\n53 00 02 00 0a 00 43 00 45 00 54 00 55 00 53 00\n01 00 0a 00 43 00 45 00 54 00 55 00 53 00 04 00\n16 00 6c 00 6f 00 63 00 61 00 6c 00 64 00 6f 00\n6d 00 61 00 69 00 6e 00 03 00 22 00 63 00 65 00\n74 00 75 00 73 00 2e 00 6c 00 6f 00 63 00 61 00\n6c 00 64 00 6f 00 6d 00 61 00 69 00 6e 00 00 00\n00 00\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n\n result, response_tokens = securityblob.decodeChallengeSecurityBlob(blob)\n\n assert result == securityblob.RESULT_ACCEPT_INCOMPLETE\n assert response_tokens == RESPONSE_TOKENS\n\n\ndef test_NTLMSSP_AUTH_encoding():\n ntlm_data = binascii.unhexlify(b\"\"\"\n4e 54 4c 4d 53 53 50 00 03 00 00 00 01 00 01 00\n70 00 00 00 00 00 00 00 71 00 00 00 00 00 00 00\n58 00 00 00 00 00 00 00 58 00 00 00 18 00 18 00\n58 00 00 00 10 00 10 00 71 00 00 00 15 8a 88 e2\n06 00 72 17 00 00 00 0f 06 49 3b c4 f6 2a 2b be\n61 a6 81 e7 cc 58 37 b4 4d 00 49 00 43 00 48 00\n41 00 45 00 4c 00 2d 00 49 00 35 00 50 00 43 00\n00 a7 0d b4 74 c3 d8 14 c9 df 3d 80 6d 87 94 42\nbc\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n\n TARGET = binascii.unhexlify(b\"\"\"\na1 81 8a 30 81 87 a2 81 84 04 81 81 4e 54 4c 4d\n53 53 50 00 03 00 00 00 01 00 01 00 70 00 00 00\n00 00 00 00 71 00 00 00 00 00 00 00 58 00 00 00\n00 00 00 00 58 00 00 00 18 00 18 00 58 00 00 00\n10 00 10 00 71 00 00 00 15 8a 88 e2 06 00 72 17\n00 00 00 0f 06 49 3b c4 f6 2a 2b be 61 a6 81 e7\ncc 58 37 b4 4d 00 49 00 43 00 48 00 41 00 45 00\n4c 00 2d 00 49 00 35 00 50 00 43 00 00 a7 0d b4\n74 c3 d8 14 c9 df 3d 80 6d 87 94 42 bc\n\"\"\".replace(b' ', b'').replace(b'\\n', b''))\n\n blob = securityblob.generateAuthSecurityBlob(ntlm_data)\n\n assert blob == TARGET\n\n\ndef test_auth_response_decoding():\n blob = binascii.unhexlify(b\"a1 07 30 05 a0 03 0a 01 00\".replace(b' ', b''))\n\n result = securityblob.decodeAuthResponseSecurityBlob(blob)\n assert result == securityblob.RESULT_ACCEPT_COMPLETED\n" }, { "path": "setup.py", "content": "import sys, os\ntry:\n from setuptools import setup\nexcept ImportError:\n from distutils.core import setup\n\npkgdir = { '': 'python%s' % sys.version_info[0] }\n\nsetup(\n name = \"pysmb\",\n version = \"1.2.13\",\n author = \"Michael Teo\",\n author_email = \"miketeo@miketeo.net\",\n license = \"zlib/libpng\",\n description = \"pysmb is an experimental SMB/CIFS library written in Python to support file sharing between Windows and Linux machines\",\n keywords = \"windows samba cifs sharing ftp smb linux\",\n url = \"https://miketeo.net/projects/pysmb\",\n package_dir = pkgdir,\n packages = [ 'smb', 'smb.utils', 'nmb' ],\n install_requires = [ 'pyasn1', 'tqdm' ],\n long_description=\"\"\"pysmb is an experimental SMB/CIFS library written in Python. It implements the client-side SMB/CIFS protocol which allows your Python application to access and transfer files to/from SMB/CIFS shared folders like your Windows file sharing and Samba folders.\"\"\",\n classifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Win32 (MS Windows)\",\n \"Environment :: Console\",\n \"License :: OSI Approved :: zlib/libpng License\",\n \"Operating System :: Microsoft :: Windows\",\n \"Operating System :: POSIX\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 2.4\",\n \"Programming Language :: Python :: 2.5\",\n \"Programming Language :: Python :: 2.6\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Topic :: Communications :: File Sharing\",\n \"Topic :: Software Development :: Libraries :: Python Modules\",\n \"Topic :: System :: Networking\",\n ],\n)\n" }, { "path": "sphinx/Makefile", "content": "# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = ../docs\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make ' where is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\t-rm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/pysmb.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/pysmb.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/pysmb\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pysmb\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n" }, { "path": "sphinx/make.bat", "content": "@ECHO OFF\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset BUILDDIR=build\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\nset I18NSPHINXOPTS=%SPHINXOPTS% source\nif NOT \"%PAPER%\" == \"\" (\n\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\n\tset I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%\n)\n\nif \"%1\" == \"\" goto help\n\nif \"%1\" == \"help\" (\n\t:help\n\techo.Please use `make ^` where ^ is one of\n\techo. html to make standalone HTML files\n\techo. dirhtml to make HTML files named index.html in directories\n\techo. singlehtml to make a single large HTML file\n\techo. pickle to make pickle files\n\techo. json to make JSON files\n\techo. htmlhelp to make HTML files and a HTML help project\n\techo. qthelp to make HTML files and a qthelp project\n\techo. devhelp to make HTML files and a Devhelp project\n\techo. epub to make an epub\n\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\n\techo. text to make text files\n\techo. man to make manual pages\n\techo. texinfo to make Texinfo files\n\techo. gettext to make PO message catalogs\n\techo. changes to make an overview over all changed/added/deprecated items\n\techo. linkcheck to check all external links for integrity\n\techo. doctest to run all doctests embedded in the documentation if enabled\n\tgoto end\n)\n\nif \"%1\" == \"clean\" (\n\tfor /d %%i in (%BUILDDIR%\\*) do rmdir /q /s %%i\n\tdel /q /s %BUILDDIR%\\*\n\tgoto end\n)\n\nif \"%1\" == \"html\" (\n\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\n\tgoto end\n)\n\nif \"%1\" == \"dirhtml\" (\n\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\n\tgoto end\n)\n\nif \"%1\" == \"singlehtml\" (\n\t%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.\n\tgoto end\n)\n\nif \"%1\" == \"pickle\" (\n\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished; now you can process the pickle files.\n\tgoto end\n)\n\nif \"%1\" == \"json\" (\n\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished; now you can process the JSON files.\n\tgoto end\n)\n\nif \"%1\" == \"htmlhelp\" (\n\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished; now you can run HTML Help Workshop with the ^\n.hhp project file in %BUILDDIR%/htmlhelp.\n\tgoto end\n)\n\nif \"%1\" == \"qthelp\" (\n\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished; now you can run \"qcollectiongenerator\" with the ^\n.qhcp project file in %BUILDDIR%/qthelp, like this:\n\techo.^> qcollectiongenerator %BUILDDIR%\\qthelp\\pysmb.qhcp\n\techo.To view the help file:\n\techo.^> assistant -collectionFile %BUILDDIR%\\qthelp\\pysmb.ghc\n\tgoto end\n)\n\nif \"%1\" == \"devhelp\" (\n\t%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished.\n\tgoto end\n)\n\nif \"%1\" == \"epub\" (\n\t%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The epub file is in %BUILDDIR%/epub.\n\tgoto end\n)\n\nif \"%1\" == \"latex\" (\n\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\n\tgoto end\n)\n\nif \"%1\" == \"text\" (\n\t%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The text files are in %BUILDDIR%/text.\n\tgoto end\n)\n\nif \"%1\" == \"man\" (\n\t%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The manual pages are in %BUILDDIR%/man.\n\tgoto end\n)\n\nif \"%1\" == \"texinfo\" (\n\t%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.\n\tgoto end\n)\n\nif \"%1\" == \"gettext\" (\n\t%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Build finished. The message catalogs are in %BUILDDIR%/locale.\n\tgoto end\n)\n\nif \"%1\" == \"changes\" (\n\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.The overview file is in %BUILDDIR%/changes.\n\tgoto end\n)\n\nif \"%1\" == \"linkcheck\" (\n\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Link check complete; look for any errors in the above output ^\nor in %BUILDDIR%/linkcheck/output.txt.\n\tgoto end\n)\n\nif \"%1\" == \"doctest\" (\n\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\n\tif errorlevel 1 exit /b 1\n\techo.\n\techo.Testing of doctests in the sources finished, look at the ^\nresults in %BUILDDIR%/doctest/output.txt.\n\tgoto end\n)\n\n:end\n" }, { "path": "sphinx/requirements.txt", "content": "tqdm>=4.66.0\ntwisted>=15.0.0\npyasn1>=0.3.0\n" }, { "path": "sphinx/source/api/nmb_NBNSProtocol.rst", "content": "\nNBNSProtocol Class\n==================\n\npysmb has a *NBNSProtocol* implementation for Twisted framework.\nThis allows you to perform name query asynchronously without having your application to block and wait for the results.\n\nIn your project,\n 1. Create a NBNSProtocol instance.\n 2. Just call *queryName* method which will return a *Deferred* instance. Add your callback function to the *Deferred* instance via *addCallback* method to receive the results of the name query.\n 3. When you are done with the NBNSProtocol instance, call its .transport.stopListening method to remove this instance from the reactor.\n\n.. autoclass:: nmb.NetBIOSProtocol.NBNSProtocol\n :members:\n :special-members:\n\n.. autoclass:: nmb.NetBIOSProtocol.NetBIOSTimeout\n :members:\n" }, { "path": "sphinx/source/api/nmb_NetBIOS.rst", "content": "\nNetBIOS class\n=============\n\nTo use the NetBIOS class in your application,\n 1. Create a new NetBIOS instance\n 2. Call *queryName* method for each name you wish to query. The method will block until a reply is received from the remote SMB/CIFS service, or until timeout.\n 3. When you are done, call *close* method to release the underlying resources.\n\n.. autoclass:: nmb.NetBIOS.NetBIOS\n :members:\n :special-members:\n" }, { "path": "sphinx/source/api/smb_SMBConnection.rst", "content": "\nSMBConnection Class\n===================\n\nThe SMBConnection is suitable for developers who wish to use pysmb to perform file operations with a remote SMB/CIFS server sequentially.\n\nEach file operation method, when invoked, will block and return after it has completed or has encountered an error.\n\nExample\n-------\n\nThe following illustrates a simple file retrieving implementation.::\n\n import tempfile\n from smb.SMBConnection import SMBConnection\n\n # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n # client_machine_name can be an arbitary ASCII string\n # server_name should match the remote machine name, or else the connection will be rejected\n conn = SMBConnection(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\n assert conn.connect(server_ip, 139)\n\n file_obj = tempfile.NamedTemporaryFile()\n file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', file_obj)\n\n # Retrieved file contents are inside file_obj\n # Do what you need with the file_obj and then close it\n # Note that the file obj is positioned at the end-of-file,\n # so you might need to perform a file_obj.seek() if you need\n # to read from the beginning\n file_obj.close()\n\nSMB2 Support\n-------------\n\nStarting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.\n\nTo disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBConnection* instance.::\n\n from smb import smb_structs\n smb_structs.SUPPORT_SMB2 = False\n\nCaveats\n-------\n\n* It is not meant to be used asynchronously.\n* A single *SMBConnection* instance should not be used to perform more than one operation concurrently at the same time.\n* Do not keep a *SMBConnection* instance \"idle\" for too long, i.e. keeping a *SMBConnection* instance but not using it.\n Most SMB/CIFS servers have some sort of keepalive mechanism and impose a timeout limit.\n If the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client.\n\n.. autoclass:: smb.SMBConnection.SMBConnection\n :members:\n :special-members:\n" }, { "path": "sphinx/source/api/smb_SMBHandler.rst", "content": "\nSMbHandler Class\n================\n\nThe SMBHandler class provides support for \"smb://\" URLs in the `urllib2 `_ python package.\n\nNotes\n-----\n* The host component of the URL must be one of the following:\n\n * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com\n * An IP address. Example: 192.168.1.1\n * A comma-separated string \",\" where ** is the Windows/NetBIOS machine name for remote SMB service, and ** is the service's IP address. Example: MYSERVER,192.168.1.1\n\n* The first component of the path in the URL points to the name of the shared folder.\n Subsequent path components will point to the directory/folder of the file.\n* You can retrieve and upload files, but you cannot delete files/folders or create folders.\n In uploads, if the parent folders do not exist, an *urllib2.URLError* will be raised.\n\nExample\n-------\n\nThe following code snippet illustrates file retrieval with Python 2.::\n\n # -*- coding: utf-8 -*-\n import urllib2\n from smb.SMBHandler import SMBHandler\n\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n # Process fh like a file-like object and then close it.\n fh.close()\n\n # For paths/files with unicode characters, simply pass in the URL as an unicode string\n fh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n # Process fh2 like a file-like object and then close it.\n fh2.close()\n\nThe following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the *data* parameter in the *open()* method::\n\n import urllib2\n from smb.SMBHandler import SMBHandler\n\n file_fh = open('local_file.dat', 'rb')\n\n director = urllib2.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n # Reading from fh will only return an empty string\n fh.close()\n\n\nThe following code snippet illustrates file retrieval with Python 3.::\n\n import urllib\n from smb.SMBHandler import SMBHandler\n\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/rfc1001.txt')\n\n # Process fh like a file-like object and then close it.\n fh.close()\n\n # For paths/files with unicode characters, simply pass in the URL as an unicode string\n fh2 = director.open(u'smb://myuserID:mypassword@192.168.1.1/sharedfolder/测试文件夹/垃圾文件.dat')\n\n # Process fh2 like a file-like object and then close it.\n fh2.close()\n\nThe following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the *data* parameter in the *open()* method::\n\n import urllib\n from smb.SMBHandler import SMBHandler\n\n file_fh = open('local_file.dat', 'rb')\n\n director = urllib.request.build_opener(SMBHandler)\n fh = director.open('smb://myuserID:mypassword@192.168.1.1/sharedfolder/upload_file.dat', data = file_fh)\n\n # Reading from fh will only return an empty string\n fh.close()\n" }, { "path": "sphinx/source/api/smb_SMBProtocolFactory.rst", "content": "\nSMBProtocolFactory Class\n========================\n\nFor those who want to utilize pysmb in Twisted framework, pysmb has a *smb.SMBProtocol.SMBProtocol* implementation.\nIn most cases, you do not need to touch or import the *SMBProtocol* directly. All the SMB functionalities are exposed in the *SMBProtocolFactory*.\n\nIn your project,\n 1. Create a new class and subclass *SMBProtocolFactory*.\n 2. Override the *SMBProtocolFactory.onAuthOK* and *SMBProtocolFactory.onAuthFailed* instance methods to provide your own post-authenthentication handling.\n Once *SMBProtocolFactory.onAuthOK* has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through\n the *SMBProtocolFactory* public methods such as *SMBProtocolFactory.storeFile*, *SMBProtocolFactory.retrieveFile*, etc.\n 3. When you want to disconnect from the remote SMB/CIFS server, just call *SMBProtocolFactory.closeConnection* method.\n\nAll the *SMBProtocolFactory* public methods that provide file functionlities will return a *twisted.internet.defer.Deferred* instance.\nA :doc:`NotReadyError` exception is raised when the underlying SMB is not authenticated.\nIf the underlying SMB connection has been terminated, a :doc:`NotConnectedError` exception is raised.\n\nAll the file operation methods in *SMBProtocolFactory* class accept a *timeout* parameter. This parameter specifies the time limit where pysmb will wait for the\nentire file operation (except *storeFile* and *retrieveFile* methods) to complete. If the file operation fails to complete within the timeout period, the returned\n*Deferred* instance's *errback* method will be called with a *SMBTimeout* exception.\n\nIf you are interested in learning the results of the operation or to know when the operation has completed, you should\nadd a handling method to the returned *Deferred* instance via *Deferred.addCallback*. If the file operation fails, the *Deferred.errback* function will be called\nwith an :doc:`OperationFailure`; on timeout, it will be called with a :doc:`SMBTimeout`.\n\nExample\n-------\n\nThe following illustrates a simple file retrieving implementation.::\n\n import tempfile\n from twisted.internet import reactor\n from smb.SMBProtocol import SMBProtocolFactory\n\n class RetrieveFileFactory(SMBProtocolFactory):\n\n def __init__(self, *args, **kwargs):\n SMBProtocolFactory.__init__(self, *args, **kwargs)\n\n def fileRetrieved(self, write_result):\n file_obj, file_attributes, file_size = write_result\n\n # Retrieved file contents are inside file_obj\n # Do what you need with the file_obj and then close it\n # Note that the file obj is positioned at the end-of-file,\n # so you might need to perform a file_obj.seek() to if you\n # need to read from the beginning\n file_obj.close()\n\n self.transport.loseConnection()\n\n def onAuthOK(self):\n d = self.retrieveFile(self.service, self.path, tempfile.NamedTemporaryFile())\n d.addCallback(self.fileRetrieved)\n d.addErrback(self.d.errback)\n\n def onAuthFailed(self):\n print 'Auth failed'\n\n # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip\n # client_machine_name can be an arbitary ASCII string\n # server_name should match the remote machine name, or else the connection will be rejected\n factory = RetrieveFileFactory(userID, password, client_machine_name, server_name, use_ntlm_v2 = True)\n factory.service = 'smbtest'\n factory.path = '/rfc1001.txt'\n reactor.connectTCP(server_ip, 139, factory)\n\n\n\n\nSMB2 Support\n-------------\n\nStarting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2.\nOtherwise, it will fallback automatically back to using SMB1 protocol.\n\nTo disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBProtocolFactory* instance.::\n\n from smb import smb_structs\n smb_structs.SUPPORT_SMB2 = False\n\nCaveats\n-------\n\n* A new factory instance must be created for each SMB connection to the remote SMB/CIFS service. Avoid reusing the same factory instance for more than one SMB connection.\n* The remote SMB/CIFS server usually imposes a limit of the number of concurrent file operations for each client. For example, to transfer a thousand files, you may need to setup a queue in your application and call *storeFile* or *retrieveFile* in batches.\n* The *timeout* parameter in the file operation methods are not precise; it is accurate to within 1 second interval, i.e. with a timeout of 0.5 sec, pysmb might raise\n *SMBTimeout* exception after 1.5 sec.\n\n.. autoclass:: smb.SMBProtocol.SMBProtocolFactory\n :members:\n :special-members:\n" }, { "path": "sphinx/source/api/smb_SharedDevice.rst", "content": "\nSharedDevice Class\n==================\n\n.. autoclass:: smb.base.SharedDevice\n :members:\n" }, { "path": "sphinx/source/api/smb_SharedFile.rst", "content": "\nSharedFile Class\n================\n\n.. autoclass:: smb.base.SharedFile\n :members:\n" }, { "path": "sphinx/source/api/smb_exceptions.rst", "content": "\nSMB Exceptions\n==============\n\n.. autoclass:: smb.base.SMBTimeout\n :members:\n\n.. autoclass:: smb.base.NotReadyError\n :members:\n\n.. autoclass:: smb.base.NotConnectedError\n :members:\n\n.. autoclass:: smb.smb_structs.UnsupportedFeature\n :members:\n\n.. autoclass:: smb.smb_structs.ProtocolError\n :members:\n\n.. autoclass:: smb.smb_structs.OperationFailure\n :members:\n" }, { "path": "sphinx/source/api/smb_security_descriptors.rst", "content": "\nSecurity Descriptors\n====================\n\n.. module:: smb.security_descriptors\n :synopsis: Data structures used in Windows security descriptors.\n\nThis module implements security descriptors, and associated data\nstructures, as specified in `[MS-DTYP]`_.\n\n.. autoclass:: SID\n :members:\n\n.. autoclass:: ACE\n :members:\n\n.. autoclass:: ACL\n :members:\n\n.. autoclass:: SecurityDescriptor\n :members:\n\n.. _[MS-DTYP]: https://msdn.microsoft.com/en-us/library/cc230273.aspx\n" }, { "path": "sphinx/source/conf.py", "content": "# -*- coding: utf-8 -*-\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys, os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#sys.path.insert(0, os.path.abspath('.'))\nsys.path.append(os.path.join(os.path.dirname(__file__), os.pardir, os.pardir, 'python3'))\n\n# -- General configuration -----------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'pysmb'\ncopyright = u'2001-2025, Michael Teo https://miketeo.net/'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '1.2.13'\n# The full version, including alpha/beta/rc tags.\nrelease = '1.2.13'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = []\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\nautodoc_member_order = 'groupwise'\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'sphinxdoc'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \" v documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'pysmbdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'pysmb.tex', u'pysmb Documentation',\n u'Michael Teo', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output --------------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'pysmb', u'pysmb Documentation',\n [u'Michael Teo'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output ------------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'pysmb', u'pysmb Documentation',\n u'Michael Teo', 'pysmb', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n" }, { "path": "sphinx/source/extending.rst", "content": "\nExtending pysmb For Other Frameworks\n====================================\n\nThis page briefly describes the steps involved in extending pysmb for other frameworks.\n\nIn general, you need to take care of the SMB TCP connection setup, i.e. finding the IP address of the remote server and connect to the SMB/CIFS service.\nThen you need to read/write synchronously or asynchronously from and to the SMB socket. And you need to handle post-authentication callback methods, and from these methods,\ninitiate file operations with the remote SMB/CIFS server.\n\nNow the above steps in more technical details:\n 1. Create a new class which subclasses the *smb.base.SMB* class. Most often, the connection setup will be part of the *__init__* method.\n 2. Override the *write(self, data)* method to provide an implementation which will write *data* to the socket.\n 3. Write your own loop handling method to read data from the socket. Once data have been read, call *feedData* method with the parameter.\n The *feedData* method has its own internal buffer, so it can accept incomplete NetBIOS session packet data.\n 4. Override\n \n * *onAuthOK* method to include your own operations to perform when authentication is successful. You can initiate file operations in this method.\n * *onAuthFailed* method to include your own processing on what to do when authentication fails. You can report this as an error, or to try a different NTLM authentication algorithm (*use_ntlm_v2* parameter in the constructor).\n * *onNMBSessionFailed* method to include your own processing on what to do when pysmb fails to setup the NetBIOS session with the remote server. Usually, this is due to a wrong *remote_name* parameter in the constructor.\n" }, { "path": "sphinx/source/index.rst", "content": "Welcome to pysmb's documentation!\n=================================\n\npysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol\nthat facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application.\npysmb is developed in Python 2.7.x and Python 3.8.x and has been tested against shared folders on Windows 7, Windows 10 and Samba 4.x.\n\nThe latest version of pysmb is always available at the pysmb project page at `miketeo.net `_.\n\nLicense\n-------\npysmb itself is licensed under an opensource license.\nYou are free to use pysmb in any applications, including for commercial purposes.\nFor more details on the terms of use, please read the LICENSE file that comes with your pysmb source.\n\npysmb depends on other 3rd-party modules whose terms of use are not covered by pysmb.\nUse of these modules could possibly conflict with your licensing needs. Please exercise your own discretion to determine their suitabilities.\nI have listed these modules in the following section.\n\nCredits\n-------\npysmb is not alone. It is made possible with support from other modules.\n\n* **pyasn1** : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately)\n* **md4** and **U32** : Pure Python implementation of MD4 hashing algorithm and 32-bit unsigned integer by Dmitry Rozmanov. Licensed under LGPL and included together with pysmb.\n* **pyDes** : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb.\n* **sha256** : Pure Python implementation of SHA-256 message digest by Thomas Dixon. Licensed under MIT and included together with pysmb. This module is imported only when\n the Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm.\n\nIn various places, there are references to different specifications. Most of these referenced specifications\ncan be downloaded from Microsoft web site under Microsoft's \"Open Specification Promise\". If you need to download\na copy of these specifications, please google for it. For example, google for \"MS-CIFS\" to download the CIFS specification for NT LM dialect.\n\nPackage Contents and Description\n================================\n\npysmb is organized into 2 main packages: smb and nmb.\nThe smb package contains all the functionalities related to Server Message Block (SMB) implementation.\nAs an application developer, you will be importing this module into your application.\nHence, please take some time to familiarize yourself with the smb package contents.\n\n* **nmb/base.py** :\n Contains the NetBIOSSession and NBNS abstract class which implements NetBIOS session and NetBIOS Name Service communication\n without any network transport specifics.\n* **nmb/NetBIOS.py**:\n Provides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O.\n* **nmb/NetBIOSProtocol.py** :\n Provides the NBNS protocol implementation for use in Twisted framework.\n\n* **smb/base.py** :\n Contains the SMB abstract class which implements the SMB communication without any network transport specifics.\n* **smb/ntlm.py** :\n Contains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages.\n* **smb/securityblob.py** :\n Provides routines to encode/decode the NTLMSSP security blob in the SMB messages.\n* **smb/smb_constants.py** :\n All the constants used in the smb package for SMB1 protocol\n* **smb/smb_structs.py** :\n Contains the internal classes used in the SMB package for SMB1 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB1 message.\n* **smb/smb2_constants.py** :\n All the constants used in the smb package for SMB2 protocol\n* **smb/smb2_structs.py** :\n Contains the internal classes used in the SMB package for SMB2 protocol. These classes are usually used to encode/decode the parameter and data blocks of specific SMB2 message.\n* **smb/SMBConnection.py** :\n Contains a SMB protocol implementation. All operations are blocking I/O.\n* **smb/SMBProtocol.py** :\n Contains the SMB protocol implementation for use in the Twisted framework.\n* **smb/SMBHandler.py** :\n Provides support for \"smb://\" URL in the urllib2 python package.\n\nUsing pysmb\n===========\n\nAs an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses,\n * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read\n :doc:`nmb.NetBIOS.NetBIOS` documentation.\n * To use pysmb in Twisted, please read :doc:`nmb.NetBIOSProtocol.NBNSProtocol` documentation.\n\nAs an application developer who is looking to use pysmb to implement file transfer or authentication over SMB:\n * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read\n :doc:`smb.SMBConnection.SMBConnection` documentation.\n * To use pysmb in Twisted, please read :doc:`smb.SMBProtocol.SMBProtocolFactory` documentation.\n * To support \"smb://\" URL in urllib2 python package, read :doc:`smb.SMBHandler.SMBHandler` documentation.\n\nAs a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks:\n * Read :doc:`extending`\n\nIf you are upgrading from older pysmb versions:\n * Read :doc:`upgrading`\n\n\nIndices and tables\n==================\n\n.. toctree::\n :glob:\n :maxdepth: 1\n\n api/*\n extending\n upgrading\n\n* :ref:`genindex`\n* :ref:`search`\n" }, { "path": "sphinx/source/upgrading.rst", "content": "Upgrading from older pysmb versions\n====================================\n\nThis page documents the improvements and changes to the API that could be incompatible with previous releases.\n\npysmb 1.2.0\n-----------\n- Add new `delete_matching_folders` parameter to `deleteFiles()` method in SMBProtocolFactory and SMBConnection\n class to support deletion of sub-folders. If you are passing timeout parameter to the `deleteFiles()` method\n in your application, please switch to using named parameter for timeout.\n\npysmb 1.1.28\n------------\n- SharedFile instances returned from the `listPath()` method now has a new property\n `file_id` attribute which represents the file reference number given by the remote SMB server.\n\npysmb 1.1.26\n------------\n- SMBConnection class can now be used as a context manager\n\npysmb 1.1.25\n------------\n- SharedFile class has a new property `isNormal` which will be True if the file is a\n 'normal' file. pysmb defines a 'normal' file as a file entry that is not\n read-only, not hidden, not system, not archive and not a directory;\n it ignores other attributes like compression, indexed, sparse, temporary and encryption.\n- `listPath()` method in SMBProtocolFactory and SMBConnection class will now include\n 'normal' files by default if you do not specify the `search` parameter.\n\npysmb 1.1.20\n------------\n- A new method `getSecurity()` was added to SMBConnection and SMBProtocolFactory class.\n\npysmb 1.1.15\n------------\n- Add new `truncate` parameter to `storeFileFromOffset()` in SMBProtocolFactory and SMBConnection\n class to support truncation of the file before writing. If you are passing timeout parameter\n to the `storeFileFromOffset()` method in your application, please switch to using named parameter for timeout.\n\npysmb 1.1.11\n------------\n- A new method `storeFileFromOffset()` was added to SMBConnection and SMBProtocolFactory class.\n\npysmb 1.1.10\n------------\n- A new method `getAttributes()` was added to SMBConnection and SMBProtocolFactory class\n- SharedFile class has a new property `isReadOnly` to indicate the file is read-only on the remote filesystem.\n\npysmb 1.1.2\n-----------\n- `queryIPForName()` method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names.\n\npysmb 1.0.3\n-----------\n- Two new methods were added to NBNSProtocol class: `queryIPForName()` and `NetBIOS.queryIPForName()`\n to support querying for a machine's NetBIOS name at the given IP address.\n- A new method `retrieveFileFromOffset()` was added to SMBProtocolFactory and SMBConnection\n to support finer control of file retrieval operation.\n\npysmb 1.0.0\n-----------\npysmb was completely rewritten in version 1.0.0.\nIf you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API.\n" }, { "path": "utils/ScanNetworkForSMB.py", "content": "#!/usr/bin/python\n#\n# ScanNetworkForSMB.py - Script for scanning network for open SMB/CIFS services\n# Copyright (C) 2012 Michael Teo \n#\n# This software is provided 'as-is', without any express or implied warranty.\n# In no event will the author be held liable for any damages arising from the\n# use of this software.\n#\n# Permission is granted to anyone to use this software for any purpose,\n# including commercial applications, and to alter it and redistribute it\n# freely, subject to the following restrictions:\n#\n# 1. The origin of this software must not be misrepresented; you must not\n# claim that you wrote the original software. If you use this software\n# in a product, an acknowledgment in the product documentation would be\n# appreciated but is not required.\n#\n# 2. Altered source versions must be plainly marked as such, and must not be\n# misrepresented as being the original software.\n#\n# 3. This notice cannot be removed or altered from any source distribution.\n#\n\nimport sys, select, socket, random, string, time\nfrom nmb import base\n\n\nclass NonBlockingNetBIOS(base.NBNS):\n\n def __init__(self):\n self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)\n self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)\n\n self.pendings = set()\n self.pending_count = 0\n\n def write(self, data, ip, port):\n assert self.sock, 'Socket is already closed'\n self.sock.sendto(data, ( ip, port ))\n\n def queryIPForName(self, ip):\n assert self.sock, 'Socket is already closed'\n\n trn_id = random.randint(1, 0xFFFF)\n data = self.prepareNetNameQuery(trn_id)\n self.write(data, ip, 137)\n self.pendings.add(ip)\n self.pending_count += 1\n\n def queryResult(self, ip, results):\n results = filter(lambda s: s and s[0] in string.printable, results)\n if results:\n print ip.rjust(16), '-->', ' '.join(results)\n\n def poll(self, timeout = 0):\n end_time = time.time() + timeout\n while self.pending_count > 0 and (timeout == 0 or time.time() < end_time):\n t = max(0, end_time - time.time())\n try:\n ready, _, _ = select.select([ self.sock.fileno() ], [ ], [ ], t)\n if not ready:\n return None\n\n data, ( ip, port ) = self.sock.recvfrom(0xFFFF)\n _, ret = self.decodeIPQueryPacket(data)\n\n try:\n self.pendings.remove(ip)\n self.pending_count -= 1\n\n self.queryResult(ip, set(ret))\n except KeyError: pass\n except select.error, ex:\n if type(ex) is types.TupleType:\n if ex[0] != errno.EINTR and ex[0] != errno.EAGAIN:\n raise ex\n else:\n raise ex\n\n\n# Originally from http://snipplr.com/view/14807/\ndef DottedIPToInt(dotted_ip):\n exp = 3\n intip = 0\n for quad in dotted_ip.split('.'):\n intip = intip + (int(quad) * (256 ** exp))\n exp = exp - 1\n return(intip)\n\ndef IntToDottedIP( intip ):\n octet = ''\n for exp in [3,2,1,0]:\n octet = octet + str(intip / ( 256 ** exp )) + \".\"\n intip = intip % ( 256 ** exp )\n return(octet.rstrip('.'))\n\ndef main():\n if len(sys.argv) > 2:\n start_ip = DottedIPToInt(sys.argv[1])\n end_ip = DottedIPToInt(sys.argv[2])\n elif len(sys.argv) == 2:\n start_ip = DottedIPToInt(sys.argv[1])\n end_ip = start_ip\n else:\n print 'ScanNetworkForSMB - Script for scanning network for open SMB/CIFS services'\n print 'Error: missing IP arguments'\n print 'Usage:', sys.argv[0], 'start-IP-address [end-IP-address]'\n print\n return\n\n print 'Beginning scanning %d IP addresses...' % ( end_ip-start_ip+1, )\n print\n\n ns = NonBlockingNetBIOS()\n for ip in range(start_ip, end_ip + 1):\n ns.queryIPForName(IntToDottedIP(ip))\n ns.poll()\n\n if ns.pending_count > 0:\n ns.poll(10)\n print\n print 'Query timeout. No replies from %d IP addresses' % ns.pending_count\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "utils/recursiveDelete.py", "content": "#!/usr/bin/python2\n#\n# Simple script to demonstrate how to delete all files/sub-folders in the shared folder\n#\nfrom smb.SMBConnection import SMBConnection\n\ndry_run = True # Set to True to test if all files/folders can be \"walked\". Set to False to perform the deletion.\nuserID = 'myuser'\npassword = 'mypassword'\nclient_machine_name = 'testclient' # Usually safe to use 'testclient'\nserver_name = 'MYSERVER' # Must match the NetBIOS name of the remote server\nserver_ip = '192.168.1.10' # Must point to the correct IP address\ndomain_name = '' # Safe to leave blank, or fill in the domain used for your remote server\nshared_folder = 'smbtest' # Set to the shared folder name\n\nconn = SMBConnection(userID, password, client_machine_name, server_name, domain=domain_name, use_ntlm_v2=True, is_direct_tcp=True)\nconn.connect(server_ip, 445)\n\ndef walk_path(path):\n print 'Walking path', path\n for p in conn.listPath(shared_folder, path):\n if p.filename!='.' and p.filename!='..':\n parentPath = path\n if not parentPath.endswith('/'):\n parentPath += '/'\n\n if p.isDirectory:\n walk_path(parentPath+p.filename)\n print 'Deleting folder (%s) in %s' % ( p.filename, path )\n if not dry_run:\n conn.deleteDirectory(shared_folder, parentPath+p.filename)\n else:\n print 'Deleting file (%s) in %s' % ( p.filename, path )\n if not dry_run:\n conn.deleteFiles(shared_folder, parentPath+p.filename)\n\n# Start and delete everything at shared folder root\nwalk_path('/')\n" } ]