pax_global_header00006660000000000000000000000064141342355210014512gustar00rootroot0000000000000052 comment=9782ab81fe7ee3a05e74c7f3e1d03d5611ea4be4 paho.mqtt.python-1.6.1/000077500000000000000000000000001413423552100147525ustar00rootroot00000000000000paho.mqtt.python-1.6.1/.github/000077500000000000000000000000001413423552100163125ustar00rootroot00000000000000paho.mqtt.python-1.6.1/.github/workflows/000077500000000000000000000000001413423552100203475ustar00rootroot00000000000000paho.mqtt.python-1.6.1/.github/workflows/label-issue.yml000066400000000000000000000010761413423552100233030ustar00rootroot00000000000000# This workflow uses actions that are not certified by GitHub. # They are provided by a third-party and are governed by # separate terms of service, privacy policy, and support # documentation. name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - name: Label issues uses: andymckay/labeler@5c59dabdfd4dd5bd9c6e6d255b01b9d764af4414 with: add-labels: "Status: Available" repo-token: ${{ secrets.GITHUB_TOKEN }} paho.mqtt.python-1.6.1/.github/workflows/lint-python.yml000066400000000000000000000016451413423552100233650ustar00rootroot00000000000000name: lint_python on: [pull_request, push] jobs: lint_python: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 - run: pip install bandit black codespell flake8 isort mypy pytest pyupgrade safety - run: bandit --recursive --skip B101,B105,B106,B110,B303,B404,B603 . - run: black --check . || true - run: codespell || true # --ignore-words-list="" --skip="" - run: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - run: flake8 . --count --exit-zero --max-complexity=29 --max-line-length=167 --show-source --statistics - run: isort --check-only --profile black . - run: pip install -e . - run: mypy --ignore-missing-imports . || true - run: mv setup.cfg setup.cfg.disabled - run: pytest . - run: shopt -s globstar && pyupgrade --py36-plus **/*.py || true - run: safety check paho.mqtt.python-1.6.1/.github/workflows/tox.yml000066400000000000000000000011461413423552100217060ustar00rootroot00000000000000name: tox on: [push, pull_request] jobs: tox: strategy: fail-fast: false max-parallel: 4 matrix: python: [3.6, 3.7, 3.8, 3.9] runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 with: python-version: ${{ matrix.python }} - run: pip install tox - if: matrix.python == '3.6' run: TOXENV=py36 tox - if: matrix.python == '3.7' run: TOXENV=py37 tox - if: matrix.python == '3.8' run: TOXENV=py38 tox - if: matrix.python == '3.9' run: TOXENV=py39 tox paho.mqtt.python-1.6.1/.gitignore000066400000000000000000000014671413423552100167520ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python /env/ /build/ /develop-eggs/ /dist/ /downloads/ /eggs/ /.eggs/ /lib/ /lib64/ /parts/ /sdist/ /var/ *.egg-info/ .installed.cfg *.egg # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. MANIFEST *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *,cover .hypothesis/ test/ssl/demoCA test/ssl/rootCA test/ssl/signingCA *.csr # Translations *.mo *.pot # Django stuff: *.log # Sphinx documentation docs/_build/ # PyBuilder target/ paho.mqtt.testing paho.mqtt.python-1.6.1/CONTRIBUTING.md000066400000000000000000000076461413423552100172200ustar00rootroot00000000000000# Contributing to Paho Thanks for your interest in this project! You can contribute bugfixes and new features by sending pull requests through GitHub. ## Legal In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy. Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git). 1. Sign the [Eclipse CLA](http://www.eclipse.org/legal/CLA.php) 1. Register for an Eclipse Foundation User ID. You can register [here](https://dev.eclipse.org/site_login/createaccount.php). 2. Log into the [Projects Portal](https://projects.eclipse.org/), and click on the '[Eclipse CLA](https://projects.eclipse.org/user/sign/cla)' link. 2. Go to your [account settings](https://dev.eclipse.org/site_login/myaccount.php#open_tab_accountsettings) and add your GitHub username to your account. 3. Make sure that you _sign-off_ your Git commits in the following format: ``` Signed-off-by: John Smith ``` This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. ```git commit -s -m "Adding a cool feature"``` 4. Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with. ## Contributing a change 1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.python/fork) 2. Clone the forked repository onto your computer: ``` git clone https://github.com//paho.mqtt.python.git ``` 3. Most changes will go to branch ``master``. This include both bug fixes and new features. Bug fixes are committed to ``master`` and if required, cherry-picked to the release branch. The only changes that goes directly to the release branch (``1.4``, ``1.5``, ...) are bug fixe that does not apply to ``master`` (e.g. because there are fixed on master by a refactoring, or any other huge change we do not want to cherry-pick to the release branch). 4. Create a new branch from the latest ```master``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/master``` 5. Make your changes 6. Ensure that all new and existing tests pass by running ```tox``` 7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly. 8. If you have a lot of commits for the change, squash them into a single / few commits. 9. Push the changes in your branch to your forked repository. 10. Finally, go to [https://github.com/eclipse/paho.mqtt.python](https://github.com/eclipse/paho.mqtt.python) and create a pull request from your "YOUR_BRANCH_NAME" branch to the ``master`` (or release branch if applicable) to request review and merge of the commits in your pushed branch. What happens next depends on the content of the patch. If it is 100% authored by the contributor and is less than 1000 lines (and meets the needs of the project), then it can be pulled into the main repository. If not, more steps are required. These are detailed in the [legal process poster](http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf). ## Developer resources: Information regarding source code management, builds, coding standards, and more. - [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer) Contact: -------- Contact the project developers via the project's development [mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev). Search for bugs: ---------------- This project uses [Github](https://github.com/eclipse/paho.mqtt.python/issues) to track ongoing development and issues. Create a new bug: ----------------- Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome! - [Create new Paho bug](https://github.com/eclipse/paho.mqtt.python/issues) paho.mqtt.python-1.6.1/ChangeLog.txt000066400000000000000000000260131413423552100173440ustar00rootroot00000000000000v1.6.1 - 2021-10-21 =================== - Fix Python 2.7 compatilibity. v1.6.0 - 2021-10-20 =================== - Changed default TLS version to 1.2 instead of 1.0. - Fix incoming MQTT v5 messages with overall property length > 127 bytes being incorrectly decoded. Closes #541. - MQTTMessageInfo.wait_for_publish() and MQTTMessageInfo.is_published() will now raise exceptions if called when the publish call produced an error. Closes #550. - Remove periodic retry checks for outgoing messages with QoS>0. This means that outgoing messages will only be retried on the client reconnecting to the server. They will *not* be retried when the client is still connected. - The `rc` parameter in the `on_disconnect` callback now has meaningful values in the case of an error. Closes #441. - Callbacks can now be applied to client instances using decorators. - PUBACK messages are now sent to the broker only after the on_message callback has returned. - Raise exceptions when attempting to set MQTT v5 properties to forbidden values. Closes #586. - Callbacks can now be updated from within a callback. - Remove _out_packet_mutex and _current_out_packet_mutex and convert the _out_packet queue use to thread safe. - Add basic MQTT v5 support to the subscribe and publish helper functions. Closes #575. - Fix on_disconnect() sometimes calling the MQTT v3.x callback when it should call the MQTT v5 callback. Closes #570. - Big performance improvement when receiving large payloads, particularly for SSL. Closes #571, - Fix connecting with MQTT v5 to a broker that doesn't support MQTT v5. Closes #566. - Removed ancient Mosquitto compatibility class. - Fix exception on calling Client(client_id="", clean_session=False). Closes #520. - Experimental support for Websockets continuation frames. Closes #500. Closes #89. - `Properties.json()` now converts Correlation Data bytes() objects to hex. Closes #555. - Only use the internal sockpair wakeup when running with loop_start() or loop(). This removes problems when running with an external event loop. - Drain all of sockpairR bytes to avoid unnecessary wakeups and possible timeouts. Closes #563. - Add timeout to MQTTMessageInfo:wait_for_publish(). v1.5.1 - 2020-09-22 =================== - Exceptions that occur in callbacks are no longer suppressed by default. They can optionally be suppressed by setting `client.suppress_exceptions = True`. Closes #365. - Fix PUBREL remaining length of > 2 not being accepted for MQTT v5 message flows. Closes #481. - Fix MQTT v5 properties not being sent on retried or queued messages. - Fix errors related to detection of MQTT v5 first connections. - Fix for changes related to Python 3.9. v1.5.0 - 2019-10-30 =================== * Add support for clean_session on subscribe helper. Closes #219 * Add support for non-standard bridge connection. Closes #282 * Fix hang with QoS 2 message and clean_session = False. The fix replace hang with message DROP. See README for known limitation. Closes #284 and #286 * Fix connection establishement timeout. Closes #291 and #288 * Add support for connecting through a proxy. Closes #315 * Add MQTT v5 support. Closes #334 * Improve error message when sending queue is full. Closes #378 * Improve error handling during initialization on edge case. Closes #387 and #388 * Allow to specify local client port used (similar to bind_address). Closes #390 * Add method is_connected to know if MQTT connection is established. Closes #414 * Set connection timeout to keepalive. Closes #425 v1.4.0 - 2018-09-02 =================== - Fix hang when client restarted and broker resumed a session with Qos2 message. Closes #284. Note: this change replace the hang by a message lost ! See README for current limitation of paho-mqtt. - Fix reconnection loop when a clean_session=True client reconnect while Qos2 message are being sent. Note: this change replace the infinite reconnection loop by a possible duplicate QoS2 message. Only clean_session=True client are affected, see README for current limitation of paho-mqtt. - Catch and log any exception raised by user callback. Closes #294. - Improve support for external event loop (like asyncio). Closes #235. - Fix order of message with publish.multiple helper. Closes #87. - Fix hang on wait_for_published() on bad network. Closes #309. - Fix an issue with Websocket that seems to happen only on Windows. Closes #268. - Fix issue with Websocket payload size between 127 and 65536. Closes #267. - Closes socket in client destructor to avoid FD leak. Closes #170. - Fix uncaught timeout exception during connection. Closes #288. - Remove dup flag on PUBREL packet. Closes #298. - Use secure entropy source for Websocket mask_key (urandom). Closes #305. - Fix mid generation that was not thread-safe. - Replace print() statements with proper logging. Closes #214. - Allow insecure TLS on publish and subscribe helpers. Closes #299. - Allow to remove authentication (reset username to None). Closes #259. - Add support for the non-standard bridge mode. Closes #282. v1.3.1 - 2017-10-09 =================== - Fix reconnect_delay_set which ignored the max_delay. Closes #218. - Fix crash when connection is lost while trying to send message. Closes #208. - Fix issue with unicode topic when some character were multi-bytes UTF-8. - Fix issue with empty Client ID with broker that don't support them. Closes #209. - Fix issue with tls_set that did not allowed cert_reqs=ssl.CERT_NONE. Closes #123. - Relax requirement on pytest-runner, it's now only required for tests. Closes #207, #227. v1.3.0 - 2017-06-20 =================== - **BREAKING** Requires Python 2.7 or 3.4+. Closes #163. - **BREAKING** Remove support for SSL without SSLContext (Requires Python 2.7.9+ or 3.2+). Closes #115. - **BREAKING** on_connect callback is now always called flags. Previously this callback could accepts 3 OR 4 arguments, now it must accepts 4. Closes #197. - **BREAKING** tls_insecure_set() must now be called *after* tls_set() - Allow username and password to be zero length (as opposed to not being present). Closes #80. - Allow zero length client ids when using MQTT v3.1.1. - Add SSLContext support, including SNI. Closes #11. - Improved support for unicode topic and binary payload. Closes #15, #16. - Allow arbitrary Websocket headers and path. Closes #169. - Fix issue with large inbound payload over Websocket. Closes #107. - Add exponential delay for reconnection. Closes #195. - Move unit tests to pytest (#164) and tox (#187) - Add support for standard Python logging. Closes #95. - Fix duplicate incoming QoS==2 message. Closes #194. v1.2.3 - 2017-04-20 =================== - Fix possible hang of TLS connection during handshake. Closes #3. - Fix issue with publish helper with TLS connection. Closes #180. - Fix installation issue on non-UTF-8 system. Closes #181. - Fix non-working Websocket over TLS connection. Closes #182. v1.2.2 - 2017-04-11 =================== - Fix message lost when using paho.mqtt.publish helper with QoS=0 message. Closes #172. v1.2.1 - 2017-04-03 =================== - Handle unicode username and passwords correctly. Closes #79. - Fix handling of invalid UTF-8 topics on incoming messages - the library now does not attempt to decode the topic - this will happen when the user accesses msg.topic in the on_message callback. If the topic is not valid UTF-8, an exception will be raised. Closes #75. - Fix issue with WebSocket connection in case of network issue (timeout or connection broken). Closes #105. - Fix issue with SSL connection, where latest incoming message may be delayed or never processed. Closes #131. - Fix possible message lost with publish.single and publish.multiple. Closes #119. v1.2 - 2016-06-03 ================= - Client.publish() now returns an MQTTMessageInfo object. The MQTTMessageInfo object behaves like a tuple of (rc, mid) for backwards compatibility but also provides two functions: is_published() and wait_for_published(). This allows a client to determine whether any given message has been published without need for a callback, and also allows the client to block waiting until the message has been sent. - Further fix for Client constructor for the case where "localhost" is unresolvable. - Add paho.mqtt.subscribe module, with simple() and callback() helper functions. - Allow ^C to interrupt client loop. - Fix for keepalive=0 causing an infinite disconnect/reconnect loop. Closes #42. - Modify callbacks definition/structure to allow classical inheritence. Closes #53, #54. - Add websockets support. - Default MQTT version is again changed to v3.1.1. - Client.subscribe() now accepts unicode type topic inputs on Python 2. Closes #16. - paho.mqtt.publish() now raises an MQTTException on a CONNECT failure, rather than blindly continuing. Closes #6. - Don't block on TLS sockets on Python 3. Closes #2. - Client.publish() now accepts bytes() payloads on Python 3. Closes #1. - Don't attempt to join() own thread. Closes #14. - Allow the use of Client.message_callback_add() from inside callbacks. Closes #12. - Use a monotonic time source for keeping track of time, if available. Closes #56. v1.1 - 2015-01-30 ================= - Add support for wildcard certificates. Closes #440547. - Default connection behaviour has been reverted to MQTT v3.1 instead of v3.1.1. There is as yet insufficient support for v3.1.1 to rely on, and current v3.1 implementations do not return the correct CONNACK code to allow detection of the fault. Closes #451735. - Fix incorrect handling of queued messages after reconnecting. Closes #452672. - Fix possible race condition if the connection in loop_start() does not complete before loop_stop() is called, meaning the network thread never ends. Closes #448428. Thanks to Kees Bakker. v1.0.2 - 2014-09-13 =================== - Fix "protocol" not being used in publish.single() - Fix Client constructor for the case where "localhost" is unresolvable. Closes #439277. - Don't attempt to encode topic to utf-8 twice. Thanks to Luc Milland. - Handle "unicode" type payloads on Python 2.7. Thanks to Luc Milland. - Fix reconnecting after sending more QoS>0 messages than inflight messages is set to, whilst connecting. Closes #443935. Thanks to Hiram van Paassen. - Fix possible race condition when connecting with TLS and publishing at the same time, which could lead to PUBLISH data being sent before any other messages and unencrypted. Closes #443964. Thanks to Hiram van Paassen. - Handle exceptions from select() in client loop() function. Closes #443881. Thanks to Jeff Jasper. v1.0.1 ====== - Fix incorrect reconnect that occurred if calling loop_stop() before disconnect(). v1.0 ==== - Default protocol is now MQTT v3.1.1. - Client will reconnect using MQTT v3.1 if a v3.1.1 connection fails due to the incorrect protocol version number. - All strings are now correctly encoded as utf-8. - Add support for "session present" flag in on_connect callback. v0.9.1 ====== - Fix CONNECT packet for MQTT v3.1.1. - Fix potential lockup when publishing from on_publish callback. - Add version information to paho.mqtt.__version__ paho.mqtt.python-1.6.1/LICENSE.txt000066400000000000000000000002341413423552100165740ustar00rootroot00000000000000This project is dual licensed under the Eclipse Public License 2.0 and the Eclipse Distribution License 1.0 as described in the epl-v20 and edl-v10 files. paho.mqtt.python-1.6.1/MANIFEST.in000066400000000000000000000003131413423552100165050ustar00rootroot00000000000000include edl-v10 epl-v10 include README.rst include CONTRIBUTING.md include setup.py include notice.html include LICENSE.txt include about.html recursive-include src *.py recursive-include examples *.py paho.mqtt.python-1.6.1/Makefile000066400000000000000000000016111413423552100164110ustar00rootroot00000000000000# Set DESTDIR if it isn't given DESTDIR?=/ PYTHON?=python3 .PHONY : all clean clean-build clean-pyc clean-test install test upload all : $(PYTHON) ./setup.py build install : all $(PYTHON) ./setup.py install --root=${DESTDIR} clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts clean-build: ## remove build artifacts rm -fr build/ rm -fr dist/ rm -fr .eggs/ find . -name '*.egg-info' -exec rm -fr {} + find . -name '*.egg' -exec rm -f {} + clean-pyc: ## remove Python file artifacts find . -name '*.pyc' -exec rm -f {} + find . -name '*.pyo' -exec rm -f {} + find . -name '*~' -exec rm -f {} + find . -name '__pycache__' -exec rm -fr {} + clean-test: ## remove test and coverage artifacts rm -fr .tox/ rm -f .coverage rm -fr htmlcov/ test : $(PYTHON) setup.py test $(MAKE) -C test test upload : test $(PYTHON) ./setup.py sdist upload paho.mqtt.python-1.6.1/README.rst000066400000000000000000001322601413423552100164450ustar00rootroot00000000000000Eclipse Paho™ MQTT Python Client ================================ This document describes the source code for the `Eclipse Paho `_ MQTT Python client library, which implements versions 5.0, 3.1.1, and 3.1 of the MQTT protocol. This code provides a client class which enable applications to connect to an `MQTT `_ broker to publish messages, and to subscribe to topics and receive published messages. It also provides some helper functions to make publishing one off messages to an MQTT server very straightforward. It supports Python 2.7.9+ or 3.6+. The MQTT protocol is a machine-to-machine (M2M)/"Internet of Things" connectivity protocol. Designed as an extremely lightweight publish/subscribe messaging transport, it is useful for connections with remote locations where a small code footprint is required and/or network bandwidth is at a premium. Paho is an `Eclipse Foundation `_ project. Contents -------- * Installation_ * `Known limitations`_ * `Usage and API`_ * `Client`_ * `Constructor / reinitialise`_ * `Option functions`_ * `Connect / reconnect / disconnect`_ * `Network loop`_ * `Publishing`_ * `Subscribe / Unsubscribe`_ * `Callbacks`_ * `External event loop support`_ * `Global helper functions`_ * `Publish`_ * `Single`_ * `Multiple`_ * `Subscribe`_ * `Simple`_ * `Using Callback`_ * `Reporting bugs`_ * `More information`_ Installation ------------ The latest stable version is available in the Python Package Index (PyPi) and can be installed using :: pip install paho-mqtt Or with ``virtualenv``: :: virtualenv paho-mqtt source paho-mqtt/bin/activate pip install paho-mqtt To obtain the full code, including examples and tests, you can clone the git repository: :: git clone https://github.com/eclipse/paho.mqtt.python Once you have the code, it can be installed from your repository as well: :: cd paho.mqtt.python python setup.py install To perform all test (including MQTT v5 test), you also need to clone paho.mqtt.testing in paho.mqtt.python folder:: git clone https://github.com/eclipse/paho.mqtt.testing.git Known limitations ----------------- The following are the known unimplemented MQTT feature. When clean_session is False, the session is only stored in memory not persisted. This means that when client is restarted (not just reconnected, the object is recreated usually because the program was restarted) the session is lost. This result in possible message lost. The following part of client session is lost: * QoS 2 messages which have been received from the Server, but have not been completely acknowledged. Since the client will blindly acknowledge any PUBCOMP (last message of a QoS 2 transaction), it won't hang but will lost this QoS 2 message. * QoS 1 and QoS 2 messages which have been sent to the Server, but have not been completely acknowledged. This means that message passed to publish() may be lost. This could be mitigated by taking care that all message passed to publish() has a corresponding on_publish() call. It also means that the broker may have the Qos2 message in the session. Since the client start with an empty session it don't know it and will re-use the mid. This is not yet fixed. Also when clean_session is True, this library will republish QoS > 0 message accross network reconnection. This means that QoS > 0 message won't be lost. But the standard say that if we should discard any message for which the publish packet was sent. Our choice means that we are not compliant with the standard and it's possible for QoS 2 to be received twice. You should you clean_session = False if you need the QoS 2 guarantee of only one delivery. Usage and API ------------- Detailed API documentation is available through **pydoc**. Samples are available in the **examples** directory. The package provides two modules, a full client and a helper for simple publishing. Getting Started *************** Here is a very simple example that subscribes to the broker $SYS topic tree and prints out the resulting messages: .. code:: python import paho.mqtt.client as mqtt # The callback for when the client receives a CONNACK response from the server. def on_connect(client, userdata, flags, rc): print("Connected with result code "+str(rc)) # Subscribing in on_connect() means that if we lose the connection and # reconnect then subscriptions will be renewed. client.subscribe("$SYS/#") # The callback for when a PUBLISH message is received from the server. def on_message(client, userdata, msg): print(msg.topic+" "+str(msg.payload)) client = mqtt.Client() client.on_connect = on_connect client.on_message = on_message client.connect("mqtt.eclipseprojects.io", 1883, 60) # Blocking call that processes network traffic, dispatches callbacks and # handles reconnecting. # Other loop*() functions are available that give a threaded interface and a # manual interface. client.loop_forever() Client ****** You can use the client class as an instance, within a class or by subclassing. The general usage flow is as follows: * Create a client instance * Connect to a broker using one of the ``connect*()`` functions * Call one of the ``loop*()`` functions to maintain network traffic flow with the broker * Use ``subscribe()`` to subscribe to a topic and receive messages * Use ``publish()`` to publish messages to the broker * Use ``disconnect()`` to disconnect from the broker Callbacks will be called to allow the application to process events as necessary. These callbacks are described below. Constructor / reinitialise `````````````````````````` Client() '''''''' .. code:: python Client(client_id="", clean_session=True, userdata=None, protocol=MQTTv311, transport="tcp") The ``Client()`` constructor takes the following arguments: client_id the unique client id string used when connecting to the broker. If ``client_id`` is zero length or ``None``, then one will be randomly generated. In this case the ``clean_session`` parameter must be ``True``. clean_session a boolean that determines the client type. If ``True``, the broker will remove all information about this client when it disconnects. If ``False``, the client is a durable client and subscription information and queued messages will be retained when the client disconnects. Note that a client will never discard its own outgoing messages on disconnect. Calling connect() or reconnect() will cause the messages to be resent. Use reinitialise() to reset a client to its original state. userdata user defined data of any type that is passed as the ``userdata`` parameter to callbacks. It may be updated at a later point with the ``user_data_set()`` function. protocol the version of the MQTT protocol to use for this client. Can be either ``MQTTv31``, ``MQTTv311`` or ``MQTTv5`` transport set to "websockets" to send MQTT over WebSockets. Leave at the default of "tcp" to use raw TCP. Constructor Example ................... .. code:: python import paho.mqtt.client as mqtt mqttc = mqtt.Client() reinitialise() '''''''''''''' .. code:: python reinitialise(client_id="", clean_session=True, userdata=None) The ``reinitialise()`` function resets the client to its starting state as if it had just been created. It takes the same arguments as the ``Client()`` constructor. Reinitialise Example .................... .. code:: python mqttc.reinitialise() Option functions ```````````````` These functions represent options that can be set on the client to modify its behaviour. In the majority of cases this must be done *before* connecting to a broker. max_inflight_messages_set() ''''''''''''''''''''''''''' .. code:: python max_inflight_messages_set(self, inflight) Set the maximum number of messages with QoS>0 that can be part way through their network flow at once. Defaults to 20. Increasing this value will consume more memory but can increase throughput. max_queued_messages_set() ''''''''''''''''''''''''' .. code:: python max_queued_messages_set(self, queue_size) Set the maximum number of outgoing messages with QoS>0 that can be pending in the outgoing message queue. Defaults to 0. 0 means unlimited, but due to implementation currently limited to 65555 (65535 messages in queue + 20 in flight). When the queue is full, any further outgoing messages would be dropped. message_retry_set() ''''''''''''''''''' .. code:: python message_retry_set(retry) Set the time in seconds before a message with QoS>0 is retried, if the broker does not respond. This is set to 5 seconds by default and should not normally need changing. ws_set_options() '''''''''''''''' .. code:: python ws_set_options(self, path="/mqtt", headers=None) Set websocket connection options. These options will only be used if ``transport="websockets"`` was passed into the ``Client()`` constructor. path The mqtt path to use on the broker. headers Either a dictionary specifying a list of extra headers which should be appended to the standard websocket headers, or a callable that takes the normal websocket headers and returns a new dictionary with a set of headers to connect to the broker. Must be called before ``connect*()``. An example of how this can be used with the AWS IoT platform is in the **examples** folder. tls_set() ''''''''' .. code:: python tls_set(ca_certs=None, certfile=None, keyfile=None, cert_reqs=ssl.CERT_REQUIRED, tls_version=ssl.PROTOCOL_TLS, ciphers=None) Configure network encryption and authentication options. Enables SSL/TLS support. ca_certs a string path to the Certificate Authority certificate files that are to be treated as trusted by this client. If this is the only option given then the client will operate in a similar manner to a web browser. That is to say it will require the broker to have a certificate signed by the Certificate Authorities in ``ca_certs`` and will communicate using TLS v1.2, but will not attempt any form of authentication. This provides basic network encryption but may not be sufficient depending on how the broker is configured. By default, on Python 2.7.9+ or 3.4+, the default certification authority of the system is used. On older Python version this parameter is mandatory. certfile, keyfile strings pointing to the PEM encoded client certificate and private keys respectively. If these arguments are not ``None`` then they will be used as client information for TLS based authentication. Support for this feature is broker dependent. Note that if either of these files in encrypted and needs a password to decrypt it, Python will ask for the password at the command line. It is not currently possible to define a callback to provide the password. cert_reqs defines the certificate requirements that the client imposes on the broker. By default this is ``ssl.CERT_REQUIRED``, which means that the broker must provide a certificate. See the ssl pydoc for more information on this parameter. tls_version specifies the version of the SSL/TLS protocol to be used. By default (if the python version supports it) the highest TLS version is detected. If unavailable, TLS v1.2 is used. Previous versions (all versions beginning with SSL) are possible but not recommended due to possible security problems. ciphers a string specifying which encryption ciphers are allowable for this connection, or ``None`` to use the defaults. See the ssl pydoc for more information. Must be called before ``connect*()``. tls_set_context() ''''''''''''''''' .. code:: python tls_set_context(context=None) Configure network encryption and authentication context. Enables SSL/TLS support. context an ssl.SSLContext object. By default, this is given by ``ssl.create_default_context()``, if available (added in Python 3.4). If you're unsure about using this method, then either use the default context, or use the ``tls_set`` method. See the ssl module documentation section about `security considerations `_ for more information. Must be called before ``connect*()``. tls_insecure_set() '''''''''''''''''' .. code:: python tls_insecure_set(value) Configure verification of the server hostname in the server certificate. If ``value`` is set to ``True``, it is impossible to guarantee that the host you are connecting to is not impersonating your server. This can be useful in initial server testing, but makes it possible for a malicious third party to impersonate your server through DNS spoofing, for example. Do not use this function in a real system. Setting value to True means there is no point using encryption. Must be called before ``connect*()`` and after ``tls_set()`` or ``tls_set_context()``. enable_logger() ''''''''''''''' .. code:: python enable_logger(logger=None) Enable logging using the standard python logging package (See PEP 282). This may be used at the same time as the ``on_log`` callback method. If ``logger`` is specified, then that ``logging.Logger`` object will be used, otherwise one will be created automatically. Paho logging levels are converted to standard ones according to the following mapping: ==================== =============== Paho logging ==================== =============== ``MQTT_LOG_ERR`` ``logging.ERROR`` ``MQTT_LOG_WARNING`` ``logging.WARNING`` ``MQTT_LOG_NOTICE`` ``logging.INFO`` *(no direct equivalent)* ``MQTT_LOG_INFO`` ``logging.INFO`` ``MQTT_LOG_DEBUG`` ``logging.DEBUG`` ==================== =============== disable_logger() '''''''''''''''' .. code:: python disable_logger() Disable logging using standard python logging package. This has no effect on the ``on_log`` callback. username_pw_set() ''''''''''''''''' .. code:: python username_pw_set(username, password=None) Set a username and optionally a password for broker authentication. Must be called before ``connect*()``. user_data_set() ''''''''''''''' .. code:: python user_data_set(userdata) Set the private user data that will be passed to callbacks when events are generated. Use this for your own purpose to support your application. will_set() '''''''''' .. code:: python will_set(topic, payload=None, qos=0, retain=False) Set a Will to be sent to the broker. If the client disconnects without calling ``disconnect()``, the broker will publish the message on its behalf. topic the topic that the will message should be published on. payload the message to send as a will. If not given, or set to ``None`` a zero length message will be used as the will. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use ``struct.pack()`` to create the payload you require. qos the quality of service level to use for the will. retain if set to ``True``, the will message will be set as the "last known good"/retained message for the topic. Raises a ``ValueError`` if ``qos`` is not 0, 1 or 2, or if ``topic`` is ``None`` or has zero string length. reconnect_delay_set ''''''''''''''''''' .. code:: python reconnect_delay_set(min_delay=1, max_delay=120) The client will automatically retry connection. Between each attempt it will wait a number of seconds between ``min_delay`` and ``max_delay``. When the connection is lost, initially the reconnection attempt is delayed of ``min_delay`` seconds. It's doubled between subsequent attempt up to ``max_delay``. The delay is reset to ``min_delay`` when the connection complete (e.g. the CONNACK is received, not just the TCP connection is established). Connect / reconnect / disconnect ```````````````````````````````` connect() ''''''''' .. code:: python connect(host, port=1883, keepalive=60, bind_address="") The ``connect()`` function connects the client to a broker. This is a blocking function. It takes the following arguments: host the hostname or IP address of the remote broker port the network port of the server host to connect to. Defaults to 1883. Note that the default port for MQTT over SSL/TLS is 8883 so if you are using ``tls_set()`` or ``tls_set_context()``, the port may need providing manually keepalive maximum period in seconds allowed between communications with the broker. If no other messages are being exchanged, this controls the rate at which the client will send ping messages to the broker bind_address the IP address of a local network interface to bind this client to, assuming multiple interfaces exist Callback ........ When the client receives a CONNACK message from the broker in response to the connect it generates an ``on_connect()`` callback. Connect Example ............... .. code:: python mqttc.connect("mqtt.eclipseprojects.io") connect_async() ''''''''''''''' .. code:: python connect_async(host, port=1883, keepalive=60, bind_address="") Use in conjunction with ``loop_start()`` to connect in a non-blocking manner. The connection will not complete until ``loop_start()`` is called. Callback (connect) .................. When the client receives a CONNACK message from the broker in response to the connect it generates an ``on_connect()`` callback. connect_srv() ''''''''''''' .. code:: python connect_srv(domain, keepalive=60, bind_address="") Connect to a broker using an SRV DNS lookup to obtain the broker address. Takes the following arguments: domain the DNS domain to search for SRV records. If ``None``, try to determine the local domain name. See ``connect()`` for a description of the ``keepalive`` and ``bind_address`` arguments. Callback (connect_srv) ...................... When the client receives a CONNACK message from the broker in response to the connect it generates an ``on_connect()`` callback. SRV Connect Example ................... .. code:: python mqttc.connect_srv("eclipse.org") reconnect() ''''''''''' .. code:: python reconnect() Reconnect to a broker using the previously provided details. You must have called ``connect*()`` before calling this function. Callback (reconnect) .................... When the client receives a CONNACK message from the broker in response to the connect it generates an ``on_connect()`` callback. disconnect() '''''''''''' .. code:: python disconnect() Disconnect from the broker cleanly. Using ``disconnect()`` will not result in a will message being sent by the broker. Disconnect will not wait for all queued message to be sent, to ensure all messages are delivered, ``wait_for_publish()`` from ``MQTTMessageInfo`` should be used. See ``publish()`` for details. Callback (disconnect) ..................... When the client has sent the disconnect message it generates an ``on_disconnect()`` callback. Network loop ```````````` These functions are the driving force behind the client. If they are not called, incoming network data will not be processed and outgoing network data may not be sent in a timely fashion. There are four options for managing the network loop. Three are described here, the fourth in "External event loop support" below. Do not mix the different loop functions. loop() '''''' .. code:: python loop(timeout=1.0, max_packets=1) Call regularly to process network events. This call waits in ``select()`` until the network socket is available for reading or writing, if appropriate, then handles the incoming/outgoing data. This function blocks for up to ``timeout`` seconds. ``timeout`` must not exceed the ``keepalive`` value for the client or your client will be regularly disconnected by the broker. The ``max_packets`` argument is obsolete and should be left unset. Loop Example ............ .. code:: python run = True while run: mqttc.loop() loop_start() / loop_stop() '''''''''''''''''''''''''' .. code:: python loop_start() loop_stop(force=False) These functions implement a threaded interface to the network loop. Calling ``loop_start()`` once, before or after ``connect*()``, runs a thread in the background to call ``loop()`` automatically. This frees up the main thread for other work that may be blocking. This call also handles reconnecting to the broker. Call ``loop_stop()`` to stop the background thread. The ``force`` argument is currently ignored. Loop Start/Stop Example ....................... .. code:: python mqttc.connect("mqtt.eclipseprojects.io") mqttc.loop_start() while True: temperature = sensor.blocking_read() mqttc.publish("paho/temperature", temperature) loop_forever() '''''''''''''' .. code:: python loop_forever(timeout=1.0, max_packets=1, retry_first_connection=False) This is a blocking form of the network loop and will not return until the client calls ``disconnect()``. It automatically handles reconnecting. Except for the first connection attempt when using connect_async, use ``retry_first_connection=True`` to make it retry the first connection. Warning: This might lead to situations where the client keeps connecting to an non existing host without failing. The ``timeout`` and ``max_packets`` arguments are obsolete and should be left unset. Publishing `````````` Send a message from the client to the broker. publish() ''''''''' .. code:: python publish(topic, payload=None, qos=0, retain=False) This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics. It takes the following arguments: topic the topic that the message should be published on payload the actual message to send. If not given, or set to ``None`` a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use ``struct.pack()`` to create the payload you require qos the quality of service level to use retain if set to ``True``, the message will be set as the "last known good"/retained message for the topic. Returns a MQTTMessageInfo which expose the following attributes and methods: * ``rc``, the result of the publishing. It could be ``MQTT_ERR_SUCCESS`` to indicate success, ``MQTT_ERR_NO_CONN`` if the client is not currently connected, or ``MQTT_ERR_QUEUE_SIZE`` when ``max_queued_messages_set`` is used to indicate that message is neither queued nor sent. * ``mid`` is the message ID for the publish request. The mid value can be used to track the publish request by checking against the mid argument in the ``on_publish()`` callback if it is defined. ``wait_for_publish`` may be easier depending on your use-case. * ``wait_for_publish()`` will block until the message is published. It will raise ValueError if the message is not queued (rc == ``MQTT_ERR_QUEUE_SIZE``), or a RuntimeError if there was an error when publishing, most likely due to the client not being connected. * ``is_published`` returns True if the message has been published. It will raise ValueError if the message is not queued (rc == ``MQTT_ERR_QUEUE_SIZE``), or a RuntimeError if there was an error when publishing, most likely due to the client not being connected. A ``ValueError`` will be raised if topic is ``None``, has zero length or is invalid (contains a wildcard), if ``qos`` is not one of 0, 1 or 2, or if the length of the payload is greater than 268435455 bytes. Callback (publish) .................. When the message has been sent to the broker an ``on_publish()`` callback will be generated. Subscribe / Unsubscribe ``````````````````````` subscribe() ''''''''''' .. code:: python subscribe(topic, qos=0) Subscribe the client to one or more topics. This function may be called in three different ways: Simple string and integer ......................... e.g. ``subscribe("my/topic", 2)`` topic a string specifying the subscription topic to subscribe to. qos the desired quality of service level for the subscription. Defaults to 0. String and integer tuple ........................ e.g. ``subscribe(("my/topic", 1))`` topic a tuple of ``(topic, qos)``. Both topic and qos must be present in the tuple. qos not used. List of string and integer tuples ................................. e.g. ``subscribe([("my/topic", 0), ("another/topic", 2)])`` This allows multiple topic subscriptions in a single SUBSCRIPTION command, which is more efficient than using multiple calls to ``subscribe()``. topic a list of tuple of format ``(topic, qos)``. Both topic and qos must be present in all of the tuples. qos not used. The function returns a tuple ``(result, mid)``, where ``result`` is ``MQTT_ERR_SUCCESS`` to indicate success or ``(MQTT_ERR_NO_CONN, None)`` if the client is not currently connected. ``mid`` is the message ID for the subscribe request. The mid value can be used to track the subscribe request by checking against the mid argument in the ``on_subscribe()`` callback if it is defined. Raises a ``ValueError`` if ``qos`` is not 0, 1 or 2, or if topic is ``None`` or has zero string length, or if ``topic`` is not a string, tuple or list. Callback (subscribe) .................... When the broker has acknowledged the subscription, an ``on_subscribe()`` callback will be generated. unsubscribe() ''''''''''''' .. code:: python unsubscribe(topic) Unsubscribe the client from one or more topics. topic a single string, or list of strings that are the subscription topics to unsubscribe from. Returns a tuple ``(result, mid)``, where ``result`` is ``MQTT_ERR_SUCCESS`` to indicate success, or ``(MQTT_ERR_NO_CONN, None)`` if the client is not currently connected. ``mid`` is the message ID for the unsubscribe request. The mid value can be used to track the unsubscribe request by checking against the mid argument in the ``on_unsubscribe()`` callback if it is defined. Raises a ``ValueError`` if ``topic`` is ``None`` or has zero string length, or is not a string or list. Callback (unsubscribe) ...................... When the broker has acknowledged the unsubscribe, an ``on_unsubscribe()`` callback will be generated. Callbacks ````````` on_connect() '''''''''''' .. code:: python on_connect(client, userdata, flags, rc) Called when the broker responds to our connection request. client the client instance for this callback userdata the private user data as set in ``Client()`` or ``user_data_set()`` flags response flags sent by the broker rc the connection result flags is a dict that contains response flags from the broker: flags['session present'] - this flag is useful for clients that are using clean session set to 0 only. If a client with clean session=0, that reconnects to a broker that it has previously connected to, this flag indicates whether the broker still has the session information for the client. If 1, the session still exists. The value of rc indicates success or not: 0: Connection successful 1: Connection refused - incorrect protocol version 2: Connection refused - invalid client identifier 3: Connection refused - server unavailable 4: Connection refused - bad username or password 5: Connection refused - not authorised 6-255: Currently unused. On Connect Example .................. .. code:: python def on_connect(client, userdata, flags, rc): print("Connection returned result: "+connack_string(rc)) mqttc.on_connect = on_connect ... on_disconnect() ''''''''''''''' .. code:: python on_disconnect(client, userdata, rc) Called when the client disconnects from the broker. client the client instance for this callback userdata the private user data as set in ``Client()`` or ``user_data_set()`` rc the disconnection result The rc parameter indicates the disconnection state. If ``MQTT_ERR_SUCCESS`` (0), the callback was called in response to a ``disconnect()`` call. If any other value the disconnection was unexpected, such as might be caused by a network error. On Disconnect Example ..................... .. code:: python def on_disconnect(client, userdata, rc): if rc != 0: print("Unexpected disconnection.") mqttc.on_disconnect = on_disconnect ... on_message() '''''''''''' .. code:: python on_message(client, userdata, message) Called when a message has been received on a topic that the client subscribes to and the message does not match an existing topic filter callback. Use ``message_callback_add()`` to define a callback that will be called for specific topic filters. ``on_message`` will serve as fallback when none matched. client the client instance for this callback userdata the private user data as set in ``Client()`` or ``user_data_set()`` message an instance of MQTTMessage. This is a class with members ``topic``, ``payload``, ``qos``, ``retain``. On Message Example .................. .. code:: python def on_message(client, userdata, message): print("Received message '" + str(message.payload) + "' on topic '" + message.topic + "' with QoS " + str(message.qos)) mqttc.on_message = on_message ... message_callback_add() '''''''''''''''''''''' This function allows you to define callbacks that handle incoming messages for specific subscription filters, including with wildcards. This lets you, for example, subscribe to ``sensors/#`` and have one callback to handle ``sensors/temperature`` and another to handle ``sensors/humidity``. .. code:: python message_callback_add(sub, callback) sub the subscription filter to match against for this callback. Only one callback may be defined per literal sub string callback the callback to be used. Takes the same form as the ``on_message`` callback. If using ``message_callback_add()`` and ``on_message``, only messages that do not match a subscription specific filter will be passed to the ``on_message`` callback. If multiple sub match a topic, each callback will be called (e.g. sub ``sensors/#`` and sub ``+/humidity`` both match a message with a topic ``sensors/humidity``, so both callbacks will handle this message). message_callback_remove() ''''''''''''''''''''''''' Remove a topic/subscription specific callback previously registered using ``message_callback_add()``. .. code:: python message_callback_remove(sub) sub the subscription filter to remove on_publish() '''''''''''' .. code:: python on_publish(client, userdata, mid) Called when a message that was to be sent using the ``publish()`` call has completed transmission to the broker. For messages with QoS levels 1 and 2, this means that the appropriate handshakes have completed. For QoS 0, this simply means that the message has left the client. The ``mid`` variable matches the mid variable returned from the corresponding ``publish()`` call, to allow outgoing messages to be tracked. This callback is important because even if the publish() call returns success, it does not always mean that the message has been sent. on_subscribe() '''''''''''''' .. code:: python on_subscribe(client, userdata, mid, granted_qos) Called when the broker responds to a subscribe request. The ``mid`` variable matches the mid variable returned from the corresponding ``subscribe()`` call. The ``granted_qos`` variable is a list of integers that give the QoS level the broker has granted for each of the different subscription requests. on_unsubscribe() '''''''''''''''' .. code:: python on_unsubscribe(client, userdata, mid) Called when the broker responds to an unsubscribe request. The ``mid`` variable matches the mid variable returned from the corresponding ``unsubscribe()`` call. on_log() '''''''' .. code:: python on_log(client, userdata, level, buf) Called when the client has log information. Define to allow debugging. The ``level`` variable gives the severity of the message and will be one of ``MQTT_LOG_INFO``, ``MQTT_LOG_NOTICE``, ``MQTT_LOG_WARNING``, ``MQTT_LOG_ERR``, and ``MQTT_LOG_DEBUG``. The message itself is in ``buf``. This may be used at the same time as the standard Python logging, which can be enabled via the ``enable_logger`` method. on_socket_open() '''''''''''''''' :: on_socket_open(client, userdata, sock) Called when the socket has been opened. Use this to register the socket with an external event loop for reading. on_socket_close() ''''''''''''''''' :: on_socket_close(client, userdata, sock) Called when the socket is about to be closed. Use this to unregister a socket from an external event loop for reading. on_socket_register_write() '''''''''''''''''''''''''' :: on_socket_register_write(client, userdata, sock) Called when a write operation to the socket failed because it would have blocked, e.g. output buffer full. Use this to register the socket with an external event loop for writing. on_socket_unregister_write() '''''''''''''''''''''''''''' :: on_socket_unregister_write(client, userdata, sock) Called when a write operation to the socket succeeded after it had previously failed. Use this to unregister the socket from an external event loop for writing. External event loop support ``````````````````````````` loop_read() ''''''''''' .. code:: python loop_read(max_packets=1) Call when the socket is ready for reading. ``max_packets`` is obsolete and should be left unset. loop_write() '''''''''''' .. code:: python loop_write(max_packets=1) Call when the socket is ready for writing. ``max_packets`` is obsolete and should be left unset. loop_misc() ''''''''''' .. code:: python loop_misc() Call every few seconds to handle message retrying and pings. socket() '''''''' .. code:: python socket() Returns the socket object in use in the client to allow interfacing with other event loops. This call is particularly useful for select_ based loops. See ``examples/loop_select.py``. .. _select: https://docs.python.org/3/library/select.html#select.select want_write() '''''''''''' .. code:: python want_write() Returns true if there is data waiting to be written, to allow interfacing the client with other event loops. This call is particularly useful for select_ based loops. See ``examples/loop_select.py``. .. _select: https://docs.python.org/3/library/select.html#select.select state callbacks ''''''''''''''' :: on_socket_open on_socket_close on_socket_register_write on_socket_unregister_write Use these callbacks to get notified about state changes in the socket. This is particularly useful for event loops where you register or unregister a socket for reading+writing. See ``examples/loop_asyncio.py`` for an example. When the socket is opened, ``on_socket_open`` is called. Register the socket with your event loop for reading. When the socket is about to be closed, ``on_socket_close`` is called. Unregister the socket from your event loop for reading. When a write to the socket failed because it would have blocked, e.g. output buffer full, ``on_socket_register_write`` is called. Register the socket with your event loop for writing. When the next write to the socket succeeded, ``on_socket_unregister_write`` is called. Unregister the socket from your event loop for writing. The callbacks are always called in this order: - ``on_socket_open`` - Zero or more times: - ``on_socket_register_write`` - ``on_socket_unregister_write`` - ``on_socket_close`` Global helper functions ``````````````````````` The client module also offers some global helper functions. ``topic_matches_sub(sub, topic)`` can be used to check whether a ``topic`` matches a ``subscription``. For example: the topic ``foo/bar`` would match the subscription ``foo/#`` or ``+/bar`` the topic ``non/matching`` would not match the subscription ``non/+/+`` ``connack_string(connack_code)`` returns the error string associated with a CONNACK result. ``error_string(mqtt_errno)`` returns the error string associated with a Paho MQTT error number. Publish ******* This module provides some helper functions to allow straightforward publishing of messages in a one-shot manner. In other words, they are useful for the situation where you have a single/multiple messages you want to publish to a broker, then disconnect with nothing else required. The two functions provided are ``single()`` and ``multiple()``. Both functions include support for MQTT v5.0, but do not currently let you set any properties on connection or when sending messages. Single `````` Publish a single message to a broker, then disconnect cleanly. .. code:: python single(topic, payload=None, qos=0, retain=False, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=mqtt.MQTTv311, transport="tcp") Publish Single Function arguments ''''''''''''''''''''''''''''''''' topic the only required argument must be the topic string to which the payload will be published. payload the payload to be published. If "" or None, a zero length payload will be published. qos the qos to use when publishing, default to 0. retain set the message to be retained (True) or not (False). hostname a string containing the address of the broker to connect to. Defaults to localhost. port the port to connect to the broker on. Defaults to 1883. client_id the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive the keepalive timeout value for the client. Defaults to 60 seconds. will a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':"} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Defaults to None, which indicates that TLS should not be used. protocol choose the version of the MQTT protocol to use. Use either ``MQTTv31``, ``MQTTv311``, or ``MQTTv5`. transport set to "websockets" to send MQTT over WebSockets. Leave at the default of "tcp" to use raw TCP. Publish Single Example '''''''''''''''''''''' .. code:: python import paho.mqtt.publish as publish publish.single("paho/test/single", "payload", hostname="mqtt.eclipseprojects.io") Multiple ```````` Publish multiple messages to a broker, then disconnect cleanly. This function includes support for MQTT v5.0, but does not currently let you set any properties on connection or when sending messages. .. code:: python multiple(msgs, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=mqtt.MQTTv311, transport="tcp") Publish Multiple Function arguments ''''''''''''''''''''''''''''''''''' msgs a list of messages to publish. Each message is either a dict or a tuple. If a dict, only the topic must be present. Default values will be used for any missing arguments. The dict must be of the form: msg = {'topic':"", 'payload':"", 'qos':, 'retain':} topic must be present and may not be empty. If payload is "", None or not present then a zero length payload will be published. If qos is not present, the default of 0 is used. If retain is not present, the default of False is used. If a tuple, then it must be of the form: ("", "", qos, retain) See ``single()`` for the description of ``hostname``, ``port``, ``client_id``, ``keepalive``, ``will``, ``auth``, ``tls``, ``protocol``, ``transport``. Publish Multiple Example '''''''''''''''''''''''' .. code:: python import paho.mqtt.publish as publish msgs = [{'topic':"paho/test/multiple", 'payload':"multiple 1"}, ("paho/test/multiple", "multiple 2", 0, False)] publish.multiple(msgs, hostname="mqtt.eclipseprojects.io") Subscribe ********* This module provides some helper functions to allow straightforward subscribing and processing of messages. The two functions provided are ``simple()`` and ``callback()``. Both functions include support for MQTT v5.0, but do not currently let you set any properties on connection or when subscribing. Simple `````` Subscribe to a set of topics and return the messages received. This is a blocking function. .. code:: python simple(topics, qos=0, msg_count=1, retained=False, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=mqtt.MQTTv311) Simple Subscribe Function arguments ''''''''''''''''''''''''''''''''''' topics the only required argument is the topic string to which the client will subscribe. This can either be a string or a list of strings if multiple topics should be subscribed to. qos the qos to use when subscribing, defaults to 0. msg_count the number of messages to retrieve from the broker. Defaults to 1. If 1, a single MQTTMessage object will be returned. If >1, a list of MQTTMessages will be returned. retained set to True to consider retained messages, set to False to ignore messages with the retained flag set. hostname a string containing the address of the broker to connect to. Defaults to localhost. port the port to connect to the broker on. Defaults to 1883. client_id the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive the keepalive timeout value for the client. Defaults to 60 seconds. will a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':"} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Defaults to None, which indicates that TLS should not be used. protocol choose the version of the MQTT protocol to use. Use either ``MQTTv31``, ``MQTTv311``, or ``MQTTv5``. Simple Example '''''''''''''' .. code:: python import paho.mqtt.subscribe as subscribe msg = subscribe.simple("paho/test/simple", hostname="mqtt.eclipseprojects.io") print("%s %s" % (msg.topic, msg.payload)) Using Callback `````````````` Subscribe to a set of topics and process the messages received using a user provided callback. .. code:: python callback(callback, topics, qos=0, userdata=None, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=mqtt.MQTTv311) Callback Subscribe Function arguments ''''''''''''''''''''''''''''''''''''' callback an "on_message" callback that will be used for each message received, and of the form .. code:: python def on_message(client, userdata, message) topics the topic string to which the client will subscribe. This can either be a string or a list of strings if multiple topics should be subscribed to. qos the qos to use when subscribing, defaults to 0. userdata a user provided object that will be passed to the on_message callback when a message is received. See ``simple()`` for the description of ``hostname``, ``port``, ``client_id``, ``keepalive``, ``will``, ``auth``, ``tls``, ``protocol``. Callback Example '''''''''''''''' .. code:: python import paho.mqtt.subscribe as subscribe def on_message_print(client, userdata, message): print("%s %s" % (message.topic, message.payload)) subscribe.callback(on_message_print, "paho/test/callback", hostname="mqtt.eclipseprojects.io") Reporting bugs -------------- Please report bugs in the issues tracker at https://github.com/eclipse/paho.mqtt.python/issues. More information ---------------- Discussion of the Paho clients takes place on the `Eclipse paho-dev mailing list `_. General questions about the MQTT protocol itself (not this library) are discussed in the `MQTT Google Group `_. There is much more information available via the `MQTT community site `_. paho.mqtt.python-1.6.1/Vagrantfile000066400000000000000000000017721413423552100171460ustar00rootroot00000000000000Vagrant.configure("2") do |config| # The base OS config.vm.box = "ubuntu/trusty64" config.vm.provision :shell, :inline => "sudo apt-get update" # Install make config.vm.provision :shell, :inline => "apt-get install -y make" # Provision Python 2 config.vm.provision :shell, :inline => "apt-get upgrade -y python" config.vm.provision :shell, :inline => "apt-get install -y python-pip" config.vm.provision :shell, :inline => "python -m pip install --upgrade pip" config.vm.provision :shell, :inline => "python -m pip install virtualenv" # Provision Python 3 config.vm.provision :shell, :inline => "apt-get install -y python3" config.vm.provision :shell, :inline => "apt-get install -y python3-pip" config.vm.provision :shell, :inline => "python3 -m pip install --upgrade pip" config.vm.provision :shell, :inline => "python3 -m pip install virtualenv" # reassuring message to complete: config.vm.provision "shell", inline: "echo All set!", run: "always" end paho.mqtt.python-1.6.1/about.html000066400000000000000000000037561413423552100167650ustar00rootroot00000000000000 About

About This Content

December 9, 2013

License

The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise indicated below, the Content is provided to you under the terms and conditions of the Eclipse Public License Version 2.0 ("EPL") and Eclipse Distribution License Version 1.0 ("EDL"). A copy of the EPL is available at http://www.eclipse.org/legal/epl-v20.html and a copy of the EDL is available at http://www.eclipse.org/org/documents/edl-v10.php. For purposes of the EPL, "Program" will mean the Content.

If you did not receive this Content directly from the Eclipse Foundation, the Content is being redistributed by another party ("Redistributor") and different terms and conditions may apply to your use of any object code in the Content. Check the Redistributor's license that was provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise indicated below, the terms and conditions of the EPL still apply to any source code in the Content and such source code may be obtained at http://www.eclipse.org.

Third Party Content

The Content includes items that have been sourced from third parties as set out below. If you did not receive this Content directly from the Eclipse Foundation, the following is provided for informational purposes only, and you should look to the Redistributor's license for terms and conditions of use.

None



paho.mqtt.python-1.6.1/edl-v10000066400000000000000000000030411413423552100160430ustar00rootroot00000000000000Eclipse Distribution License - v 1.0 Copyright (c) 2007, Eclipse Foundation, Inc. and its licensors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Eclipse Foundation, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. paho.mqtt.python-1.6.1/epl-v20000066400000000000000000000335651413423552100160760ustar00rootroot00000000000000Eclipse Public License - v 2.0 THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 1. DEFINITIONS "Contribution" means: a) in the case of the initial Contributor, the initial content Distributed under this Agreement, and b) in the case of each subsequent Contributor: i) changes to the Program, and ii) additions to the Program; where such changes and/or additions to the Program originate from and are Distributed by that particular Contributor. A Contribution "originates" from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include changes or additions to the Program that are not Modified Works. "Contributor" means any person or entity that Distributes the Program. "Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program. "Program" means the Contributions Distributed in accordance with this Agreement. "Recipient" means anyone who receives the Program under this Agreement or any Secondary License (as applicable), including Contributors. "Derivative Works" shall mean any work, whether in Source Code or other form, that is based on (or derived from) the Program and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. "Modified Works" shall mean any work in Source Code or other form that results from an addition to, deletion from, or modification of the contents of the Program, including, for purposes of clarity any new file in Source Code form that contains any contents of the Program. Modified Works shall not include works that contain only declarations, interfaces, types, classes, structures, or files of the Program solely in each case in order to link to, bind by name, or subclass the Program or Modified Works thereof. "Distribute" means the acts of a) distributing or b) making available in any manner that enables the transfer of a copy. "Source Code" means the form of a Program preferred for making modifications, including but not limited to software source code, documentation source, and configuration files. "Secondary License" means either the GNU General Public License, Version 2.0, or any later versions of that license, including any exceptions or additional permissions as identified by the initial Contributor. 2. GRANT OF RIGHTS a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, Distribute and sublicense the Contribution of such Contributor, if any, and such Derivative Works. b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in Source Code or other form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder. c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to Distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program. d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement. e) Notwithstanding the terms of any Secondary License, no Contributor makes additional grants to any Recipient (other than those set forth in this Agreement) as a result of such Recipient's receipt of the Program under the terms of a Secondary License (if permitted under the terms of Section 3). 3. REQUIREMENTS 3.1 If a Contributor Distributes the Program in any form, then: a) the Program must also be made available as Source Code, in accordance with section 3.2, and the Contributor must accompany the Program with a statement that the Source Code for the Program is available under this Agreement, and informs Recipients how to obtain it in a reasonable manner on or through a medium customarily used for software exchange; and b) the Contributor may Distribute the Program under a license different than this Agreement, provided that such license: i) effectively disclaims on behalf of all other Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose; ii) effectively excludes on behalf of all other Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits; iii) does not attempt to limit or alter the recipients' rights in the Source Code under section 3.2; and iv) requires any subsequent distribution of the Program by any party to be under a license that satisfies the requirements of this section 3. 3.2 When the Program is Distributed as Source Code: a) it must be made available under this Agreement, or if the Program (i) is combined with other material in a separate file or files made available under a Secondary License, and (ii) the initial Contributor attached to the Source Code the notice described in Exhibit A of this Agreement, then the Program may be made available under the terms of such Secondary Licenses, and b) a copy of this Agreement must be included with each copy of the Program. 3.3 Contributors may not remove or alter any copyright, patent, trademark, attribution notices, disclaimers of warranty, or limitations of liability ("notices") contained within the Program from any copy of the Program which they Distribute, provided that Contributors may add their own appropriate notices. 4. COMMERCIAL DISTRIBUTION Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense. For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages. 5. NO WARRANTY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations. 6. DISCLAIMER OF LIABILITY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 7. GENERAL If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed. All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive. Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be Distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to Distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. Nothing in this Agreement is intended to be enforceable by any entity that is not a Contributor or Recipient. No third-party beneficiary rights are created under this Agreement. Exhibit A - Form of Secondary Licenses Notice "This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), version(s), and exceptions or additional permissions here}." Simply including a copy of this Agreement, including this Exhibit A is not sufficient to license the Source Code under Secondary Licenses. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. paho.mqtt.python-1.6.1/examples/000077500000000000000000000000001413423552100165705ustar00rootroot00000000000000paho.mqtt.python-1.6.1/examples/aws_iot.py000077500000000000000000000102271413423552100206140ustar00rootroot00000000000000import base64 import datetime import functools import hashlib import hmac import os import uuid from paho.mqtt.client import Client def get_amazon_auth_headers(access_key, secret_key, region, host, port, headers=None): """ Get the amazon auth headers for working with the amazon websockets protocol Requires a lot of extra stuff: http://docs.aws.amazon.com/general/latest/gr//sigv4-create-canonical-request.html http://docs.aws.amazon.com/general/latest/gr//signature-v4-examples.html#signature-v4-examples-pythonw http://docs.aws.amazon.com/general/latest/gr//sigv4-signed-request-examples.html#sig-v4-examples-get-auth-header Args: access_key (str): Amazon access key (AWS_ACCESS_KEY_ID) secret_key (str): Amazon secret access key (AWS_SECRET_ACCESS_KEY) region (str): aws region host (str): iot endpoint (xxxxxxxxxxxxxx.iot..amazonaws.com) headers (dict): a dictionary of the original headers- normally websocket headers Returns: dict: A string containing the headers that amazon expects in the auth request for the iot websocket service """ # pylint: disable=unused-variable,unused-argument def sign(key, msg): return hmac.new(key, msg.encode("utf-8"), hashlib.sha256).digest() def getSignatureKey(key, dateStamp, regionName, serviceName): kDate = sign(("AWS4" + key).encode("utf-8"), dateStamp) kRegion = sign(kDate, regionName) kService = sign(kRegion, serviceName) kSigning = sign(kService, "aws4_request") return kSigning service = "iotdevicegateway" algorithm = "AWS4-HMAC-SHA256" t = datetime.datetime.utcnow() amzdate = t.strftime('%Y%m%dT%H%M%SZ') datestamp = t.strftime("%Y%m%d") # Date w/o time, used in credential scope if headers is None: headers = { "Host": "{0:s}:443".format(host), "Upgrade": "websocket", "Connection": "Upgrade", "Origin": "https://{0:s}:443".format(host), "Sec-WebSocket-Key": base64.b64encode(uuid.uuid4().bytes), "Sec-Websocket-Version": "13", "Sec-Websocket-Protocol": "mqtt", } headers.update({ "X-Amz-Date": amzdate, }) # get into 'canonical' form - lowercase, sorted alphabetically canonical_headers = "\n".join(sorted("{}:{}".format(i.lower(), j).strip() for i, j in headers.items())) # Headers to sign - alphabetical order signed_headers = ";".join(sorted(i.lower().strip() for i in headers.keys())) # No payload payload_hash = hashlib.sha256("").hexdigest().lower() request_parts = [ "GET", "/mqtt", # no query parameters "", canonical_headers + "\n", signed_headers, payload_hash, ] canonical_request = "\n".join(request_parts) # now actually hash request and sign hashed_request = hashlib.sha256(canonical_request).hexdigest() credential_scope = "{datestamp:s}/{region:s}/{service:s}/aws4_request".format(**locals()) string_to_sign = "{algorithm:s}\n{amzdate:s}\n{credential_scope:s}\n{hashed_request:s}".format(**locals()) signing_key = getSignatureKey(secret_key, datestamp, region, service) signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'), hashlib.sha256).hexdigest() # create auth header authorization_header = "{algorithm:s} Credential={access_key:s}/{credential_scope:s}, SignedHeaders={signed_headers:s}, Signature={signature:s}".format(**locals()) # get final header string headers["Authorization"] = authorization_header return headers def example_use(): access_key = os.environ["AWS_ACCESS_KEY_ID"] secret_key = os.environ["AWS_SECRET_ACCESS_KEY"] port = 8883 region = "eu-west-1" # This is specific to your AWS account host = "abc123def456.iot.{0:s}.amazonaws.com".format(region) extra_headers = functools.partial( get_amazon_auth_headers, access_key, secret_key, region, host, port, ) client = Client(transport="websockets") client.ws_set_options(headers=extra_headers) # Use client as normal from here paho.mqtt.python-1.6.1/examples/client_logger.py000077500000000000000000000020771413423552100217700ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2016 James Myatt # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # James Myatt - initial implementation # This shows a simple example of standard logging with an MQTT subscriber client. import logging import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt logging.basicConfig(level=logging.DEBUG) # If you want to use a specific client id, use # mqttc = mqtt.Client("client-id") # but note that the client id must be unique on the broker. Leaving the client # id parameter empty will generate a random id for you. mqttc = mqtt.Client() logger = logging.getLogger(__name__) mqttc.enable_logger(logger) mqttc.connect("mqtt.eclipseprojects.io", 1883, 60) mqttc.subscribe("$SYS/#", 0) mqttc.loop_forever() paho.mqtt.python-1.6.1/examples/client_mqtt_clear_retain.py000077500000000000000000000060561413423552100242070ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2013 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # Copyright (c) 2010,2011 Roger Light # All rights reserved. # This shows an example of an MQTT client that clears all of the retained messages it receives. import getopt import sys import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt final_mid = 0 def on_connect(mqttc, userdata, flags, rc): if userdata == True: print("rc: " + str(rc)) def on_message(mqttc, userdata, msg): global final_mid if msg.retain == 0: pass # sys.exit() else: if userdata == True: print("Clearing topic " + msg.topic) (rc, final_mid) = mqttc.publish(msg.topic, None, 1, True) def on_publish(mqttc, userdata, mid): global final_mid if mid == final_mid: sys.exit() def on_log(mqttc, userdata, level, string): print(string) def print_usage(): print( "mqtt_clear_retain.py [-d] [-h hostname] [-i clientid] [-k keepalive] [-p port] [-u username [-P password]] [-v] -t topic") def main(argv): debug = False host = "mqtt.eclipseprojects.io" client_id = None keepalive = 60 port = 1883 password = None topic = None username = None verbose = False try: opts, args = getopt.getopt(argv, "dh:i:k:p:P:t:u:v", ["debug", "id", "keepalive", "port", "password", "topic", "username", "verbose"]) except getopt.GetoptError: print_usage() sys.exit(2) for opt, arg in opts: if opt in ("-d", "--debug"): debug = True elif opt in ("-h", "--host"): host = arg elif opt in ("-i", "--id"): client_id = arg elif opt in ("-k", "--keepalive"): keepalive = int(arg) elif opt in ("-p", "--port"): port = int(arg) elif opt in ("-P", "--password"): password = arg elif opt in ("-t", "--topic"): topic = arg print(topic) elif opt in ("-u", "--username"): username = arg elif opt in ("-v", "--verbose"): verbose = True if topic == None: print("You must provide a topic to clear.\n") print_usage() sys.exit(2) mqttc = mqtt.Client(client_id) mqttc._userdata = verbose mqttc.on_message = on_message mqttc.on_publish = on_publish mqttc.on_connect = on_connect if debug: mqttc.on_log = on_log if username: mqttc.username_pw_set(username, password) mqttc.connect(host, port, keepalive) mqttc.subscribe(topic) mqttc.loop_forever() if __name__ == "__main__": main(sys.argv[1:]) paho.mqtt.python-1.6.1/examples/client_pub-wait.py000077500000000000000000000033311413423552100222330ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2010-2013 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # Copyright (c) 2010,2011 Roger Light # All rights reserved. # This shows a simple example of waiting for a message to be published. import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): print("rc: " + str(rc)) def on_message(mqttc, obj, msg): print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload)) def on_publish(mqttc, obj, mid): print("mid: " + str(mid)) pass def on_subscribe(mqttc, obj, mid, granted_qos): print("Subscribed: " + str(mid) + " " + str(granted_qos)) def on_log(mqttc, obj, level, string): print(string) # If you want to use a specific client id, use # mqttc = mqtt.Client("client-id") # but note that the client id must be unique on the broker. Leaving the client # id parameter empty will generate a random id for you. mqttc = mqtt.Client() mqttc.on_message = on_message mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.on_subscribe = on_subscribe # Uncomment to enable debug messages # mqttc.on_log = on_log mqttc.connect("mqtt.eclipseprojects.io", 1883, 60) mqttc.loop_start() print("tuple") (rc, mid) = mqttc.publish("tuple", "bar", qos=2) print("class") infot = mqttc.publish("class", "bar", qos=2) infot.wait_for_publish() paho.mqtt.python-1.6.1/examples/client_pub_opts.py000077500000000000000000000100711413423552100223350ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2017 Jon Levell # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # All rights reserved. # This shows a example of an MQTT publisher with the ability to use # user name, password CA certificates based on command line arguments import argparse import os import ssl import time import paho.mqtt.client as mqtt parser = argparse.ArgumentParser() parser.add_argument('-H', '--host', required=False, default="mqtt.eclipseprojects.io") parser.add_argument('-t', '--topic', required=False, default="paho/test/opts") parser.add_argument('-q', '--qos', required=False, type=int,default=0) parser.add_argument('-c', '--clientid', required=False, default=None) parser.add_argument('-u', '--username', required=False, default=None) parser.add_argument('-d', '--disable-clean-session', action='store_true', help="disable 'clean session' (sub + msgs not cleared when client disconnects)") parser.add_argument('-p', '--password', required=False, default=None) parser.add_argument('-P', '--port', required=False, type=int, default=None, help='Defaults to 8883 for TLS or 1883 for non-TLS') parser.add_argument('-N', '--nummsgs', required=False, type=int, default=1, help='send this many messages before disconnecting') parser.add_argument('-S', '--delay', required=False, type=float, default=1, help='number of seconds to sleep between msgs') parser.add_argument('-k', '--keepalive', required=False, type=int, default=60) parser.add_argument('-s', '--use-tls', action='store_true') parser.add_argument('--insecure', action='store_true') parser.add_argument('-F', '--cacerts', required=False, default=None) parser.add_argument('--tls-version', required=False, default=None, help='TLS protocol version, can be one of tlsv1.2 tlsv1.1 or tlsv1\n') parser.add_argument('-D', '--debug', action='store_true') args, unknown = parser.parse_known_args() def on_connect(mqttc, obj, flags, rc): print("connect rc: " + str(rc)) def on_message(mqttc, obj, msg): print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload)) def on_publish(mqttc, obj, mid): print("mid: " + str(mid)) def on_subscribe(mqttc, obj, mid, granted_qos): print("Subscribed: " + str(mid) + " " + str(granted_qos)) def on_log(mqttc, obj, level, string): print(string) usetls = args.use_tls if args.cacerts: usetls = True port = args.port if port is None: if usetls: port = 8883 else: port = 1883 mqttc = mqtt.Client(args.clientid,clean_session = not args.disable_clean_session) if usetls: if args.tls_version == "tlsv1.2": tlsVersion = ssl.PROTOCOL_TLSv1_2 elif args.tls_version == "tlsv1.1": tlsVersion = ssl.PROTOCOL_TLSv1_1 elif args.tls_version == "tlsv1": tlsVersion = ssl.PROTOCOL_TLSv1 elif args.tls_version is None: tlsVersion = None else: print ("Unknown TLS version - ignoring") tlsVersion = None if not args.insecure: cert_required = ssl.CERT_REQUIRED else: cert_required = ssl.CERT_NONE mqttc.tls_set(ca_certs=args.cacerts, certfile=None, keyfile=None, cert_reqs=cert_required, tls_version=tlsVersion) if args.insecure: mqttc.tls_insecure_set(True) if args.username or args.password: mqttc.username_pw_set(args.username, args.password) mqttc.on_message = on_message mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.on_subscribe = on_subscribe if args.debug: mqttc.on_log = on_log print("Connecting to "+args.host+" port: "+str(port)) mqttc.connect(args.host, port, args.keepalive) mqttc.loop_start() for x in range (0, args.nummsgs): msg_txt = '{"msgnum": "'+str(x)+'"}' print("Publishing: "+msg_txt) infot = mqttc.publish(args.topic, msg_txt, qos=args.qos) infot.wait_for_publish() time.sleep(args.delay) mqttc.disconnect() paho.mqtt.python-1.6.1/examples/client_rpc_math.py000077500000000000000000000056301413423552100223040ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2020 Frank Pagliughi # All rights reserved. # # This program and the accompanying materials are made available # under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Frank Pagliughi - initial implementation # # This shows an example of an MQTTv5 Remote Procedure Call (RPC) client. import json import sys import time import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt from paho.mqtt.packettypes import PacketTypes # These will be updated with the server-assigned Client ID client_id = "mathcli" reply_to = "" # This correlates the outbound request with the returned reply corr_id = b"1" # This is sent in the message callback when we get the respone reply = None # The MQTTv5 callback takes the additional 'props' parameter. def on_connect(mqttc, userdata, flags, rc, props): global client_id, reply_to print("Connected: '"+str(flags)+"', '"+str(rc)+"', '"+str(props)) if hasattr(props, 'AssignedClientIdentifier'): client_id = props.AssignedClientIdentifier reply_to = "replies/math/" + client_id mqttc.subscribe(reply_to) # An incoming message should be the reply to our request def on_message(mqttc, userdata, msg): global reply print(msg.topic+" "+str(msg.payload)+" "+str(msg.properties)) props = msg.properties if not hasattr(props, 'CorrelationData'): print("No correlation ID") # Match the response to the request correlation ID. if props.CorrelationData == corr_id: reply = msg.payload if len(sys.argv) < 3: print("USAGE: client_rpc_math.py [add|mult] n1 n2 ...") sys.exit(1) mqttc = mqtt.Client(client_id="", protocol=mqtt.MQTTv5) mqttc.on_message = on_message mqttc.on_connect = on_connect mqttc.connect(host='localhost', clean_start=True) mqttc.loop_start() # Wait for connection to set `client_id`, etc. while not mqttc.is_connected(): time.sleep(0.1) # Properties for the request specify the ResponseTopic and CorrelationData props = mqtt.Properties(PacketTypes.PUBLISH) props.CorrelationData = corr_id props.ResponseTopic = reply_to # Uncomment to see what got set #print("Client ID: "+client_id) #print("Reply To: "+reply_to) #print(props) # The requested operation, 'add' or 'mult' func = sys.argv[1] # Gather the numeric parameters as an array of numbers # These can be int's or float's args = [] for s in sys.argv[2:]: args.append(float(s)) # Send the request topic = "requests/math/" + func payload = json.dumps(args) mqttc.publish(topic, payload, qos=1, properties=props) # Wait for the reply while reply is None: time.sleep(0.1) # Extract the response and print it. rsp = json.loads(reply) print("Response: "+str(rsp)) mqttc.loop_stop() paho.mqtt.python-1.6.1/examples/client_session_present.py000077500000000000000000000032341413423552100237300ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2014 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # Copyright (c) 2014 Roger Light # All rights reserved. # This demonstrates the session present flag when connecting. import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if obj == 0: print("First connection:") elif obj == 1: print("Second connection:") elif obj == 2: print("Third connection (with clean session=True):") print(" Session present: " + str(flags['session present'])) print(" Connection result: " + str(rc)) mqttc.disconnect() def on_disconnect(mqttc, obj, rc): mqttc.user_data_set(obj + 1) if obj == 0: mqttc.reconnect() def on_log(mqttc, obj, level, string): print(string) mqttc = mqtt.Client(client_id="asdfj", clean_session=False) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect # Uncomment to enable debug messages # mqttc.on_log = on_log mqttc.user_data_set(0) mqttc.connect("mqtt.eclipseprojects.io", 1883, 60) mqttc.loop_forever() # Clear session mqttc = mqtt.Client(client_id="asdfj", clean_session=True) mqttc.on_connect = on_connect mqttc.user_data_set(2) mqttc.connect("mqtt.eclipseprojects.io", 1883, 60) mqttc.loop_forever() paho.mqtt.python-1.6.1/examples/client_sub-class.py000077500000000000000000000031521413423552100224000ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2013 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # This example shows how you can use the MQTT client in a class. import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt class MyMQTTClass(mqtt.Client): def on_connect(self, mqttc, obj, flags, rc): print("rc: "+str(rc)) def on_connect_fail(self, mqttc, obj): print("Connect failed") def on_message(self, mqttc, obj, msg): print(msg.topic+" "+str(msg.qos)+" "+str(msg.payload)) def on_publish(self, mqttc, obj, mid): print("mid: "+str(mid)) def on_subscribe(self, mqttc, obj, mid, granted_qos): print("Subscribed: "+str(mid)+" "+str(granted_qos)) def on_log(self, mqttc, obj, level, string): print(string) def run(self): self.connect("mqtt.eclipseprojects.io", 1883, 60) self.subscribe("$SYS/#", 0) rc = 0 while rc == 0: rc = self.loop() return rc # If you want to use a specific client id, use # mqttc = MyMQTTClass("client-id") # but note that the client id must be unique on the broker. Leaving the client # id parameter empty will generate a random id for you. mqttc = MyMQTTClass() rc = mqttc.run() print("rc: "+str(rc)) paho.mqtt.python-1.6.1/examples/client_sub-multiple-callback.py000077500000000000000000000034431413423552100246630ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2014 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # All rights reserved. # This shows a simple example of an MQTT subscriber using a per-subscription message handler. import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt def on_message_msgs(mosq, obj, msg): # This callback will only be called for messages with topics that match # $SYS/broker/messages/# print("MESSAGES: " + msg.topic + " " + str(msg.qos) + " " + str(msg.payload)) def on_message_bytes(mosq, obj, msg): # This callback will only be called for messages with topics that match # $SYS/broker/bytes/# print("BYTES: " + msg.topic + " " + str(msg.qos) + " " + str(msg.payload)) def on_message(mosq, obj, msg): # This callback will be called for messages that we receive that do not # match any patterns defined in topic specific callbacks, i.e. in this case # those messages that do not have topics $SYS/broker/messages/# nor # $SYS/broker/bytes/# print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload)) mqttc = mqtt.Client() # Add message callbacks that will only trigger on a specific subscription match. mqttc.message_callback_add("$SYS/broker/messages/#", on_message_msgs) mqttc.message_callback_add("$SYS/broker/bytes/#", on_message_bytes) mqttc.on_message = on_message mqttc.connect("mqtt.eclipseprojects.io", 1883, 60) mqttc.subscribe("$SYS/#", 0) mqttc.loop_forever() paho.mqtt.python-1.6.1/examples/client_sub-srv.py000077500000000000000000000032311413423552100221030ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2010-2013 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # Copyright (c) 2010,2011 Roger Light # All rights reserved. # This shows a simple example of an MQTT subscriber using connect_srv method. import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): print("Connected to %s:%s" % (mqttc._host, mqttc._port)) def on_message(mqttc, obj, msg): print(msg.topic+" "+str(msg.qos)+" "+str(msg.payload)) def on_publish(mqttc, obj, mid): print("mid: "+str(mid)) def on_subscribe(mqttc, obj, mid, granted_qos): print("Subscribed: "+str(mid)+" "+str(granted_qos)) def on_log(mqttc, obj, level, string): print(string) # If you want to use a specific client id, use # mqttc = mqtt.Client("client-id") # but note that the client id must be unique on the broker. Leaving the client # id parameter empty will generate a random id for you. mqttc = mqtt.Client() mqttc.on_message = on_message mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.on_subscribe = on_subscribe # Uncomment to enable debug messages #mqttc.on_log = on_log mqttc.connect_srv("mosquitto.org", 60) mqttc.subscribe("$SYS/broker/version", 0) rc = 0 while rc == 0: rc = mqttc.loop() print("rc: "+str(rc)) paho.mqtt.python-1.6.1/examples/client_sub-ws.py000077500000000000000000000031121413423552100217200ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2010-2013 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # Copyright (c) 2010,2011 Roger Light # All rights reserved. # This shows a simple example of an MQTT subscriber. import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): print("rc: "+str(rc)) def on_message(mqttc, obj, msg): print(msg.topic+" "+str(msg.qos)+" "+str(msg.payload)) def on_publish(mqttc, obj, mid): print("mid: "+str(mid)) def on_subscribe(mqttc, obj, mid, granted_qos): print("Subscribed: "+str(mid)+" "+str(granted_qos)) def on_log(mqttc, obj, level, string): print(string) # If you want to use a specific client id, use # mqttc = mqtt.Client("client-id") # but note that the client id must be unique on the broker. Leaving the client # id parameter empty will generate a random id for you. mqttc = mqtt.Client(transport="websockets") mqttc.on_message = on_message mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.on_subscribe = on_subscribe # Uncomment to enable debug messages mqttc.on_log = on_log mqttc.connect("test.mosquitto.org", 8080, 60) mqttc.subscribe("$SYS/broker/version", 0) mqttc.loop_forever() paho.mqtt.python-1.6.1/examples/client_sub.py000077500000000000000000000031051413423552100212730ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2010-2013 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # Copyright (c) 2010,2011 Roger Light # All rights reserved. # This shows a simple example of an MQTT subscriber. import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): print("rc: " + str(rc)) def on_message(mqttc, obj, msg): print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload)) def on_publish(mqttc, obj, mid): print("mid: " + str(mid)) def on_subscribe(mqttc, obj, mid, granted_qos): print("Subscribed: " + str(mid) + " " + str(granted_qos)) def on_log(mqttc, obj, level, string): print(string) # If you want to use a specific client id, use # mqttc = mqtt.Client("client-id") # but note that the client id must be unique on the broker. Leaving the client # id parameter empty will generate a random id for you. mqttc = mqtt.Client() mqttc.on_message = on_message mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.on_subscribe = on_subscribe # Uncomment to enable debug messages # mqttc.on_log = on_log mqttc.connect("mqtt.eclipseprojects.io", 1883, 60) mqttc.subscribe("$SYS/#", 0) mqttc.loop_forever() paho.mqtt.python-1.6.1/examples/client_sub_opts.py000077500000000000000000000071131413423552100223430ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2017 Jon Levell # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # All rights reserved. # This shows a example of an MQTT subscriber with the ability to use # user name, password CA certificates based on command line arguments import argparse import os import ssl import paho.mqtt.client as mqtt parser = argparse.ArgumentParser() parser.add_argument('-H', '--host', required=False, default="mqtt.eclipseprojects.io") parser.add_argument('-t', '--topic', required=False, default="$SYS/#") parser.add_argument('-q', '--qos', required=False, type=int, default=0) parser.add_argument('-c', '--clientid', required=False, default=None) parser.add_argument('-u', '--username', required=False, default=None) parser.add_argument('-d', '--disable-clean-session', action='store_true', help="disable 'clean session' (sub + msgs not cleared when client disconnects)") parser.add_argument('-p', '--password', required=False, default=None) parser.add_argument('-P', '--port', required=False, type=int, default=None, help='Defaults to 8883 for TLS or 1883 for non-TLS') parser.add_argument('-k', '--keepalive', required=False, type=int, default=60) parser.add_argument('-s', '--use-tls', action='store_true') parser.add_argument('--insecure', action='store_true') parser.add_argument('-F', '--cacerts', required=False, default=None) parser.add_argument('--tls-version', required=False, default=None, help='TLS protocol version, can be one of tlsv1.2 tlsv1.1 or tlsv1\n') parser.add_argument('-D', '--debug', action='store_true') args, unknown = parser.parse_known_args() def on_connect(mqttc, obj, flags, rc): print("rc: " + str(rc)) def on_message(mqttc, obj, msg): print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload)) def on_publish(mqttc, obj, mid): print("mid: " + str(mid)) def on_subscribe(mqttc, obj, mid, granted_qos): print("Subscribed: " + str(mid) + " " + str(granted_qos)) def on_log(mqttc, obj, level, string): print(string) usetls = args.use_tls if args.cacerts: usetls = True port = args.port if port is None: if usetls: port = 8883 else: port = 1883 mqttc = mqtt.Client(args.clientid,clean_session = not args.disable_clean_session) if usetls: if args.tls_version == "tlsv1.2": tlsVersion = ssl.PROTOCOL_TLSv1_2 elif args.tls_version == "tlsv1.1": tlsVersion = ssl.PROTOCOL_TLSv1_1 elif args.tls_version == "tlsv1": tlsVersion = ssl.PROTOCOL_TLSv1 elif args.tls_version is None: tlsVersion = None else: print ("Unknown TLS version - ignoring") tlsVersion = None if not args.insecure: cert_required = ssl.CERT_REQUIRED else: cert_required = ssl.CERT_NONE mqttc.tls_set(ca_certs=args.cacerts, certfile=None, keyfile=None, cert_reqs=cert_required, tls_version=tlsVersion) if args.insecure: mqttc.tls_insecure_set(True) if args.username or args.password: mqttc.username_pw_set(args.username, args.password) mqttc.on_message = on_message mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.on_subscribe = on_subscribe if args.debug: mqttc.on_log = on_log print("Connecting to "+args.host+" port: "+str(port)) mqttc.connect(args.host, port, args.keepalive) mqttc.subscribe(args.topic, args.qos) mqttc.loop_forever() paho.mqtt.python-1.6.1/examples/context.py000077500000000000000000000012211413423552100206250ustar00rootroot00000000000000# -*- coding: utf-8 -*- # Ensure can import paho package try: import paho except ImportError: # This part is only required to run the examples from within the examples # directory when the module itself is not installed. import inspect import os import sys cmd_subfolder = os.path.realpath( os.path.abspath( os.path.join( os.path.split( inspect.getfile(inspect.currentframe()) )[0], "..", "src" ) ) ) if cmd_subfolder not in sys.path: sys.path.insert(0, cmd_subfolder) import paho paho.mqtt.python-1.6.1/examples/loop_asyncio.py000077500000000000000000000065761413423552100216610ustar00rootroot00000000000000#!/usr/bin/env python3 import asyncio import socket import uuid import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt client_id = 'paho-mqtt-python/issue72/' + str(uuid.uuid4()) topic = client_id print("Using client_id / topic: " + client_id) class AsyncioHelper: def __init__(self, loop, client): self.loop = loop self.client = client self.client.on_socket_open = self.on_socket_open self.client.on_socket_close = self.on_socket_close self.client.on_socket_register_write = self.on_socket_register_write self.client.on_socket_unregister_write = self.on_socket_unregister_write def on_socket_open(self, client, userdata, sock): print("Socket opened") def cb(): print("Socket is readable, calling loop_read") client.loop_read() self.loop.add_reader(sock, cb) self.misc = self.loop.create_task(self.misc_loop()) def on_socket_close(self, client, userdata, sock): print("Socket closed") self.loop.remove_reader(sock) self.misc.cancel() def on_socket_register_write(self, client, userdata, sock): print("Watching socket for writability.") def cb(): print("Socket is writable, calling loop_write") client.loop_write() self.loop.add_writer(sock, cb) def on_socket_unregister_write(self, client, userdata, sock): print("Stop watching socket for writability.") self.loop.remove_writer(sock) async def misc_loop(self): print("misc_loop started") while self.client.loop_misc() == mqtt.MQTT_ERR_SUCCESS: try: await asyncio.sleep(1) except asyncio.CancelledError: break print("misc_loop finished") class AsyncMqttExample: def __init__(self, loop): self.loop = loop def on_connect(self, client, userdata, flags, rc): print("Subscribing") client.subscribe(topic) def on_message(self, client, userdata, msg): if not self.got_message: print("Got unexpected message: {}".format(msg.decode())) else: self.got_message.set_result(msg.payload) def on_disconnect(self, client, userdata, rc): self.disconnected.set_result(rc) async def main(self): self.disconnected = self.loop.create_future() self.got_message = None self.client = mqtt.Client(client_id=client_id) self.client.on_connect = self.on_connect self.client.on_message = self.on_message self.client.on_disconnect = self.on_disconnect aioh = AsyncioHelper(self.loop, self.client) self.client.connect('mqtt.eclipseprojects.io', 1883, 60) self.client.socket().setsockopt(socket.SOL_SOCKET, socket.SO_SNDBUF, 2048) for c in range(3): await asyncio.sleep(5) print("Publishing") self.got_message = self.loop.create_future() self.client.publish(topic, b'Hello' * 40000, qos=1) msg = await self.got_message print("Got response with {} bytes".format(len(msg))) self.got_message = None self.client.disconnect() print("Disconnected: {}".format(await self.disconnected)) print("Starting") loop = asyncio.get_event_loop() loop.run_until_complete(AsyncMqttExample(loop).main()) loop.close() print("Finished") paho.mqtt.python-1.6.1/examples/loop_select.py000077500000000000000000000046641413423552100214670ustar00rootroot00000000000000#!/usr/bin/env python3 import socket import uuid from select import select from time import time import paho.mqtt.client as mqtt client_id = 'paho-mqtt-python/issue72/' + str(uuid.uuid4()) topic = client_id print("Using client_id / topic: " + client_id) class SelectMqttExample: def __init__(self): pass def on_connect(self, client, userdata, flags, rc): print("Subscribing") client.subscribe(topic) def on_message(self, client, userdata, msg): if self.state not in {1, 3, 5}: print("Got unexpected message: {}".format(msg.decode())) return print("Got message with len {}".format(len(msg.payload))) self.state += 1 self.t = time() def on_disconnect(self, client, userdata, rc): self.disconnected = True, rc def do_select(self): sock = self.client.socket() if not sock: raise Exception("Socket is gone") print("Selecting for reading" + (" and writing" if self.client.want_write() else "")) r, w, e = select( [sock], [sock] if self.client.want_write() else [], [], 1 ) if sock in r: print("Socket is readable, calling loop_read") self.client.loop_read() if sock in w: print("Socket is writable, calling loop_write") self.client.loop_write() self.client.loop_misc() def main(self): self.disconnected = (False, None) self.t = time() self.state = 0 self.client = mqtt.Client(client_id=client_id) self.client.on_connect = self.on_connect self.client.on_message = self.on_message self.client.on_disconnect = self.on_disconnect self.client.connect('mqtt.eclipseprojects.io', 1883, 60) print("Socket opened") self.client.socket().setsockopt(socket.SOL_SOCKET, socket.SO_SNDBUF, 2048) while not self.disconnected[0]: self.do_select() if self.state in {0, 2, 4}: if time() - self.t >= 5: print("Publishing") self.client.publish(topic, b'Hello' * 40000) self.state += 1 if self.state == 6: self.state += 1 self.client.disconnect() print("Disconnected: {}".format(self.disconnected[1])) print("Starting") SelectMqttExample().main() print("Finished") paho.mqtt.python-1.6.1/examples/loop_trio.py000077500000000000000000000056711413423552100211640ustar00rootroot00000000000000#!/usr/bin/env python3 import socket import uuid import trio import paho.mqtt.client as mqtt client_id = 'paho-mqtt-python/issue72/' + str(uuid.uuid4()) topic = client_id print("Using client_id / topic: " + client_id) class TrioAsyncHelper: def __init__(self, client): self.client = client self.sock = None self._event_large_write = trio.Event() self.client.on_socket_open = self.on_socket_open self.client.on_socket_register_write = self.on_socket_register_write self.client.on_socket_unregister_write = self.on_socket_unregister_write async def read_loop(self): while True: await trio.hazmat.wait_readable(self.sock) self.client.loop_read() async def write_loop(self): while True: await self._event_large_write.wait() await trio.hazmat.wait_writable(self.sock) self.client.loop_write() async def misc_loop(self): print("misc_loop started") while self.client.loop_misc() == mqtt.MQTT_ERR_SUCCESS: await trio.sleep(1) print("misc_loop finished") def on_socket_open(self, client, userdata, sock): print("Socket opened") self.sock = sock self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_SNDBUF, 2048) def on_socket_register_write(self, client, userdata, sock): print('large write request') self._event_large_write.set() def on_socket_unregister_write(self, client, userdata, sock): print("finished large write") self._event_large_write = trio.Event() class TrioAsyncMqttExample: def on_connect(self, client, userdata, flags, rc): print("Subscribing") client.subscribe(topic) def on_message(self, client, userdata, msg): print("Got response with {} bytes".format(len(msg.payload))) def on_disconnect(self, client, userdata, rc): print('Disconnect result {}'.format(rc)) async def test_write(self, cancel_scope: trio.CancelScope): for c in range(3): await trio.sleep(5) print("Publishing") self.client.publish(topic, b'Hello' * 40000, qos=1) cancel_scope.cancel() async def main(self): self.client = mqtt.Client(client_id=client_id) self.client.on_connect = self.on_connect self.client.on_message = self.on_message self.client.on_disconnect = self.on_disconnect trio_helper = TrioAsyncHelper(self.client) self.client.connect('mqtt.eclipseprojects.io', 1883, 60) async with trio.open_nursery() as nursery: nursery.start_soon(trio_helper.read_loop) nursery.start_soon(trio_helper.write_loop) nursery.start_soon(trio_helper.misc_loop) nursery.start_soon(self.test_write, nursery.cancel_scope) self.client.disconnect() print("Disconnected") print("Starting") trio.run(TrioAsyncMqttExample().main) print("Finished") paho.mqtt.python-1.6.1/examples/publish_multiple.py000077500000000000000000000014151413423552100225270ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2014 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # This shows an example of using the publish.multiple helper function. import context # Ensures paho is in PYTHONPATH import paho.mqtt.publish as publish msgs = [{'topic': "paho/test/multiple", 'payload': "multiple 1"}, ("paho/test/multiple", "multiple 2", 0, False)] publish.multiple(msgs, hostname="mqtt.eclipseprojects.io") paho.mqtt.python-1.6.1/examples/publish_single.py000077500000000000000000000012541413423552100221560ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2014 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # This shows an example of using the publish.single helper function. import context # Ensures paho is in PYTHONPATH import paho.mqtt.publish as publish publish.single("paho/test/single", "boo", hostname="mqtt.eclipseprojects.io") paho.mqtt.python-1.6.1/examples/publish_utf8-27.py000077500000000000000000000013621413423552100220110ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2014 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # This shows an example of using the publish.single helper function with unicode topic and payload. import context # Ensures paho is in PYTHONPATH import paho.mqtt.publish as publish topic = u"paho/test/single/ô" payload = u"bôô" publish.single(topic, payload, hostname="mqtt.eclipseprojects.io") paho.mqtt.python-1.6.1/examples/publish_utf8-3.py000077500000000000000000000014311413423552100217200ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2014 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # This shows an example of using the publish.single helper function with unicode topic and payload. import context # Ensures paho is in PYTHONPATH import paho.mqtt.publish as publish topic = u"paho/test/single/ô" payload = u'German umlauts like "ä" ü"ö" are not supported' publish.single(topic, payload, hostname="test.mosquitto.org") paho.mqtt.python-1.6.1/examples/server_rpc_math.py000077500000000000000000000054661413423552100223430ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2020 Frank Pagliughi # All rights reserved. # # This program and the accompanying materials are made available # under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Frank Pagliughi - initial implementation # # This shows an example of an MQTTv5 Remote Procedure Call (RPC) server. import json import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt from paho.mqtt.packettypes import PacketTypes # The math functions exported def add(nums): sum = 0 for x in nums: sum += x return sum def mult(nums): prod = 1 for x in nums: prod *= x return prod # Remember that the MQTTv5 callback takes the additional 'props' parameter. def on_connect(mqttc, userdata, flags, rc, props): print("Connected: '"+str(flags)+"', '"+str(rc)+"', '"+str(props)) if not flags["session present"]: print("Subscribing to math requests") mqttc.subscribe("requests/math/#") # Each incoming message should be an RPC request on the # 'requests/math/#' topic. def on_message(mqttc, userdata, msg): print(msg.topic + " " + str(msg.payload)) # Get the response properties, abort if they're not given props = msg.properties if not hasattr(props, 'ResponseTopic') or not hasattr(props, 'CorrelationData'): print("No reply requested") return corr_id = props.CorrelationData reply_to = props.ResponseTopic # The command parameters are in the payload nums = json.loads(msg.payload) # The requested command is at the end of the topic res = 0 if msg.topic.endswith("add"): res = add(nums) elif msg.topic.endswith("mult"): res = mult(nums) # Now we have the result, res, so send it back on the 'reply_to' # topic using the same correlation ID as the request. print("Sending response "+str(res)+" on '"+reply_to+"': "+str(corr_id)) props = mqtt.Properties(PacketTypes.PUBLISH) props.CorrelationData = corr_id payload = json.dumps(res) mqttc.publish(reply_to, payload, qos=1, properties=props) def on_log(mqttc, obj, level, string): print(string) # Typically with an RPC service, you want to make sure that you're the only # client answering requests for specific topics. Using a known client ID # might help. mqttc = mqtt.Client(client_id="paho_rpc_math_srvr", protocol=mqtt.MQTTv5) mqttc.on_message = on_message mqttc.on_connect = on_connect # Uncomment to enable debug messages #mqttc.on_log = on_log #mqttc.connect("mqtt.eclipseprojects.io", 1883, 60) mqttc.connect(host="localhost", clean_start=False) mqttc.loop_forever() paho.mqtt.python-1.6.1/examples/subscribe_callback.py000077500000000000000000000014211413423552100227400ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2016 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # This shows an example of using the subscribe.callback helper function. import context # Ensures paho is in PYTHONPATH import paho.mqtt.subscribe as subscribe def print_msg(client, userdata, message): print("%s : %s" % (message.topic, message.payload)) subscribe.callback(print_msg, "#", hostname="mqtt.eclipseprojects.io") paho.mqtt.python-1.6.1/examples/subscribe_simple.py000077500000000000000000000014061413423552100225000ustar00rootroot00000000000000#!/usr/bin/python3 # -*- coding: utf-8 -*- # Copyright (c) 2016 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Distribution License v1.0 # which accompanies this distribution. # # The Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial implementation # This shows an example of using the subscribe.simple helper function. import context # Ensures paho is in PYTHONPATH import paho.mqtt.subscribe as subscribe topics = ['#'] m = subscribe.simple(topics, hostname="mqtt.eclipseprojects.io", retained=False, msg_count=2) for a in m: print(a.topic) print(a.payload) paho.mqtt.python-1.6.1/notice.html000066400000000000000000000220161413423552100171220ustar00rootroot00000000000000 Eclipse Foundation Software User Agreement

Eclipse Foundation Software User Agreement

February 1, 2011

Usage Of Content

THE ECLIPSE FOUNDATION MAKES AVAILABLE SOFTWARE, DOCUMENTATION, INFORMATION AND/OR OTHER MATERIALS FOR OPEN SOURCE PROJECTS (COLLECTIVELY "CONTENT"). USE OF THE CONTENT IS GOVERNED BY THE TERMS AND CONDITIONS OF THIS AGREEMENT AND/OR THE TERMS AND CONDITIONS OF LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW. BY USING THE CONTENT, YOU AGREE THAT YOUR USE OF THE CONTENT IS GOVERNED BY THIS AGREEMENT AND/OR THE TERMS AND CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW. IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT AND THE TERMS AND CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW, THEN YOU MAY NOT USE THE CONTENT.

Applicable Licenses

Unless otherwise indicated, all Content made available by the Eclipse Foundation is provided to you under the terms and conditions of the Eclipse Public License Version 2.0 ("EPL"). A copy of the EPL is provided with this Content and is also available at http://www.eclipse.org/legal/epl-v10.html. For purposes of the EPL, "Program" will mean the Content.

Content includes, but is not limited to, source code, object code, documentation and other files maintained in the Eclipse Foundation source code repository ("Repository") in software modules ("Modules") and made available as downloadable archives ("Downloads").

  • Content may be structured and packaged into modules to facilitate delivering, extending, and upgrading the Content. Typical modules may include plug-ins ("Plug-ins"), plug-in fragments ("Fragments"), and features ("Features").
  • Each Plug-in or Fragment may be packaged as a sub-directory or JAR (Java™ ARchive) in a directory named "plugins".
  • A Feature is a bundle of one or more Plug-ins and/or Fragments and associated material. Each Feature may be packaged as a sub-directory in a directory named "features". Within a Feature, files named "feature.xml" may contain a list of the names and version numbers of the Plug-ins and/or Fragments associated with that Feature.
  • Features may also include other Features ("Included Features"). Within a Feature, files named "feature.xml" may contain a list of the names and version numbers of Included Features.

The terms and conditions governing Plug-ins and Fragments should be contained in files named "about.html" ("Abouts"). The terms and conditions governing Features and Included Features should be contained in files named "license.html" ("Feature Licenses"). Abouts and Feature Licenses may be located in any directory of a Download or Module including, but not limited to the following locations:

  • The top-level (root) directory
  • Plug-in and Fragment directories
  • Inside Plug-ins and Fragments packaged as JARs
  • Sub-directories of the directory named "src" of certain Plug-ins
  • Feature directories

Note: if a Feature made available by the Eclipse Foundation is installed using the Provisioning Technology (as defined below), you must agree to a license ("Feature Update License") during the installation process. If the Feature contains Included Features, the Feature Update License should either provide you with the terms and conditions governing the Included Features or inform you where you can locate them. Feature Update Licenses may be found in the "license" property of files named "feature.properties" found within a Feature. Such Abouts, Feature Licenses, and Feature Update Licenses contain the terms and conditions (or references to such terms and conditions) that govern your use of the associated Content in that directory.

THE ABOUTS, FEATURE LICENSES, AND FEATURE UPDATE LICENSES MAY REFER TO THE EPL OR OTHER LICENSE AGREEMENTS, NOTICES OR TERMS AND CONDITIONS. SOME OF THESE OTHER LICENSE AGREEMENTS MAY INCLUDE (BUT ARE NOT LIMITED TO):

IT IS YOUR OBLIGATION TO READ AND ACCEPT ALL SUCH TERMS AND CONDITIONS PRIOR TO USE OF THE CONTENT. If no About, Feature License, or Feature Update License is provided, please contact the Eclipse Foundation to determine what terms and conditions govern that particular Content.

Use of Provisioning Technology

The Eclipse Foundation makes available provisioning software, examples of which include, but are not limited to, p2 and the Eclipse Update Manager ("Provisioning Technology") for the purpose of allowing users to install software, documentation, information and/or other materials (collectively "Installable Software"). This capability is provided with the intent of allowing such users to install, extend and update Eclipse-based products. Information about packaging Installable Software is available at http://eclipse.org/equinox/p2/repository_packaging.html ("Specification").

You may use Provisioning Technology to allow other parties to install Installable Software. You shall be responsible for enabling the applicable license agreements relating to the Installable Software to be presented to, and accepted by, the users of the Provisioning Technology in accordance with the Specification. By using Provisioning Technology in such a manner and making it available in accordance with the Specification, you further acknowledge your agreement to, and the acquisition of all necessary rights to permit the following:

  1. A series of actions may occur ("Provisioning Process") in which a user may execute the Provisioning Technology on a machine ("Target Machine") with the intent of installing, extending or updating the functionality of an Eclipse-based product.
  2. During the Provisioning Process, the Provisioning Technology may cause third party Installable Software or a portion thereof to be accessed and copied to the Target Machine.
  3. Pursuant to the Specification, you will provide to the user the terms and conditions that govern the use of the Installable Software ("Installable Software Agreement") and such Installable Software Agreement shall be accessed from the Target Machine in accordance with the Specification. Such Installable Software Agreement must inform the user of the terms and conditions that govern the Installable Software and must solicit acceptance by the end user in the manner prescribed in such Installable Software Agreement. Upon such indication of agreement by the user, the provisioning Technology will complete installation of the Installable Software.

Cryptography

Content may contain encryption software. The country in which you are currently may have restrictions on the import, possession, and use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check the country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted.

Java and all Java-based trademarks are trademarks of Oracle Corporation in the United States, other countries, or both.

paho.mqtt.python-1.6.1/requirements.txt000066400000000000000000000002061413423552100202340ustar00rootroot00000000000000mock==3.0.5 pylama==7.7.1 pytest==4.6.6; python_version < '3.0' pytest==5.2.2; python_version >= '3.0' pytest-runner==5.2 tox==3.14.0 paho.mqtt.python-1.6.1/setup.cfg000066400000000000000000000001551413423552100165740ustar00rootroot00000000000000[aliases] test=pytest [tool:pytest] addopts=-r xs testpaths=tests src [pylama] linters=pyflakes skip=tests/* paho.mqtt.python-1.6.1/setup.py000066400000000000000000000037261413423552100164740ustar00rootroot00000000000000#!/usr/bin/env python3 # -*- coding: utf-8 -*- import sys from setuptools import find_packages, setup sys.path.insert(0, 'src') from paho.mqtt import __version__ with open('README.rst', 'rb') as readme_file: readme = readme_file.read().decode('utf-8') requirements = [] test_requirements = ['pytest', 'pylama', 'six'] needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv) setup_requirements = ['pytest-runner'] if needs_pytest else [] extra_requirements = {'proxy': ['PySocks']} if sys.version_info < (3, 0): test_requirements += ['mock'] setup( name='paho-mqtt', version=__version__, description='MQTT version 5.0/3.1.1 client class', long_description=readme, author='Roger Light', author_email='roger@atchoo.org', url='http://eclipse.org/paho', packages=find_packages('src'), package_dir={'': 'src'}, include_package_data=True, install_requires=requirements, license='Eclipse Public License v2.0 / Eclipse Distribution License v1.0', zip_safe=False, keywords='paho', classifiers=[ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', 'License :: OSI Approved', 'Operating System :: MacOS :: MacOS X', 'Operating System :: Microsoft :: Windows', 'Operating System :: POSIX', 'Natural Language :: English', 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Topic :: Communications', 'Topic :: Internet', ], test_suite='tests', tests_require=test_requirements, setup_requires=setup_requirements, extras_require=extra_requirements ) paho.mqtt.python-1.6.1/src/000077500000000000000000000000001413423552100155415ustar00rootroot00000000000000paho.mqtt.python-1.6.1/src/paho/000077500000000000000000000000001413423552100164705ustar00rootroot00000000000000paho.mqtt.python-1.6.1/src/paho/__init__.py000066400000000000000000000000001413423552100205670ustar00rootroot00000000000000paho.mqtt.python-1.6.1/src/paho/mqtt/000077500000000000000000000000001413423552100174555ustar00rootroot00000000000000paho.mqtt.python-1.6.1/src/paho/mqtt/__init__.py000066400000000000000000000001011413423552100215560ustar00rootroot00000000000000__version__ = "1.6.1" class MQTTException(Exception): pass paho.mqtt.python-1.6.1/src/paho/mqtt/client.py000066400000000000000000004531361413423552100213210ustar00rootroot00000000000000# Copyright (c) 2012-2019 Roger Light and others # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Public License v2.0 # and Eclipse Distribution License v1.0 which accompany this distribution. # # The Eclipse Public License is available at # http://www.eclipse.org/legal/epl-v10.html # and the Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial API and implementation # Ian Craggs - MQTT V5 support import base64 import hashlib import logging import string import struct import sys import threading import time import uuid from .matcher import MQTTMatcher from .properties import Properties from .reasoncodes import ReasonCodes from .subscribeoptions import SubscribeOptions """ This is an MQTT client module. MQTT is a lightweight pub/sub messaging protocol that is easy to implement and suitable for low powered devices. """ import collections import errno import os import platform import select import socket ssl = None try: import ssl except ImportError: pass socks = None try: import socks except ImportError: pass try: # Python 3 from urllib import parse as urllib_dot_parse from urllib import request as urllib_dot_request except ImportError: # Python 2 import urllib as urllib_dot_request import urlparse as urllib_dot_parse try: # Use monotonic clock if available time_func = time.monotonic except AttributeError: time_func = time.time try: import dns.resolver except ImportError: HAVE_DNS = False else: HAVE_DNS = True if platform.system() == 'Windows': EAGAIN = errno.WSAEWOULDBLOCK else: EAGAIN = errno.EAGAIN # Python 2.7 does not have BlockingIOError. Fall back to IOError try: BlockingIOError except NameError: BlockingIOError = IOError MQTTv31 = 3 MQTTv311 = 4 MQTTv5 = 5 if sys.version_info[0] >= 3: # define some alias for python2 compatibility unicode = str basestring = str # Message types CONNECT = 0x10 CONNACK = 0x20 PUBLISH = 0x30 PUBACK = 0x40 PUBREC = 0x50 PUBREL = 0x60 PUBCOMP = 0x70 SUBSCRIBE = 0x80 SUBACK = 0x90 UNSUBSCRIBE = 0xA0 UNSUBACK = 0xB0 PINGREQ = 0xC0 PINGRESP = 0xD0 DISCONNECT = 0xE0 AUTH = 0xF0 # Log levels MQTT_LOG_INFO = 0x01 MQTT_LOG_NOTICE = 0x02 MQTT_LOG_WARNING = 0x04 MQTT_LOG_ERR = 0x08 MQTT_LOG_DEBUG = 0x10 LOGGING_LEVEL = { MQTT_LOG_DEBUG: logging.DEBUG, MQTT_LOG_INFO: logging.INFO, MQTT_LOG_NOTICE: logging.INFO, # This has no direct equivalent level MQTT_LOG_WARNING: logging.WARNING, MQTT_LOG_ERR: logging.ERROR, } # CONNACK codes CONNACK_ACCEPTED = 0 CONNACK_REFUSED_PROTOCOL_VERSION = 1 CONNACK_REFUSED_IDENTIFIER_REJECTED = 2 CONNACK_REFUSED_SERVER_UNAVAILABLE = 3 CONNACK_REFUSED_BAD_USERNAME_PASSWORD = 4 CONNACK_REFUSED_NOT_AUTHORIZED = 5 # Connection state mqtt_cs_new = 0 mqtt_cs_connected = 1 mqtt_cs_disconnecting = 2 mqtt_cs_connect_async = 3 # Message state mqtt_ms_invalid = 0 mqtt_ms_publish = 1 mqtt_ms_wait_for_puback = 2 mqtt_ms_wait_for_pubrec = 3 mqtt_ms_resend_pubrel = 4 mqtt_ms_wait_for_pubrel = 5 mqtt_ms_resend_pubcomp = 6 mqtt_ms_wait_for_pubcomp = 7 mqtt_ms_send_pubrec = 8 mqtt_ms_queued = 9 # Error values MQTT_ERR_AGAIN = -1 MQTT_ERR_SUCCESS = 0 MQTT_ERR_NOMEM = 1 MQTT_ERR_PROTOCOL = 2 MQTT_ERR_INVAL = 3 MQTT_ERR_NO_CONN = 4 MQTT_ERR_CONN_REFUSED = 5 MQTT_ERR_NOT_FOUND = 6 MQTT_ERR_CONN_LOST = 7 MQTT_ERR_TLS = 8 MQTT_ERR_PAYLOAD_SIZE = 9 MQTT_ERR_NOT_SUPPORTED = 10 MQTT_ERR_AUTH = 11 MQTT_ERR_ACL_DENIED = 12 MQTT_ERR_UNKNOWN = 13 MQTT_ERR_ERRNO = 14 MQTT_ERR_QUEUE_SIZE = 15 MQTT_ERR_KEEPALIVE = 16 MQTT_CLIENT = 0 MQTT_BRIDGE = 1 # For MQTT V5, use the clean start flag only on the first successful connect MQTT_CLEAN_START_FIRST_ONLY = 3 sockpair_data = b"0" class WebsocketConnectionError(ValueError): pass def error_string(mqtt_errno): """Return the error string associated with an mqtt error number.""" if mqtt_errno == MQTT_ERR_SUCCESS: return "No error." elif mqtt_errno == MQTT_ERR_NOMEM: return "Out of memory." elif mqtt_errno == MQTT_ERR_PROTOCOL: return "A network protocol error occurred when communicating with the broker." elif mqtt_errno == MQTT_ERR_INVAL: return "Invalid function arguments provided." elif mqtt_errno == MQTT_ERR_NO_CONN: return "The client is not currently connected." elif mqtt_errno == MQTT_ERR_CONN_REFUSED: return "The connection was refused." elif mqtt_errno == MQTT_ERR_NOT_FOUND: return "Message not found (internal error)." elif mqtt_errno == MQTT_ERR_CONN_LOST: return "The connection was lost." elif mqtt_errno == MQTT_ERR_TLS: return "A TLS error occurred." elif mqtt_errno == MQTT_ERR_PAYLOAD_SIZE: return "Payload too large." elif mqtt_errno == MQTT_ERR_NOT_SUPPORTED: return "This feature is not supported." elif mqtt_errno == MQTT_ERR_AUTH: return "Authorisation failed." elif mqtt_errno == MQTT_ERR_ACL_DENIED: return "Access denied by ACL." elif mqtt_errno == MQTT_ERR_UNKNOWN: return "Unknown error." elif mqtt_errno == MQTT_ERR_ERRNO: return "Error defined by errno." elif mqtt_errno == MQTT_ERR_QUEUE_SIZE: return "Message queue full." elif mqtt_errno == MQTT_ERR_KEEPALIVE: return "Client or broker did not communicate in the keepalive interval." else: return "Unknown error." def connack_string(connack_code): """Return the string associated with a CONNACK result.""" if connack_code == CONNACK_ACCEPTED: return "Connection Accepted." elif connack_code == CONNACK_REFUSED_PROTOCOL_VERSION: return "Connection Refused: unacceptable protocol version." elif connack_code == CONNACK_REFUSED_IDENTIFIER_REJECTED: return "Connection Refused: identifier rejected." elif connack_code == CONNACK_REFUSED_SERVER_UNAVAILABLE: return "Connection Refused: broker unavailable." elif connack_code == CONNACK_REFUSED_BAD_USERNAME_PASSWORD: return "Connection Refused: bad user name or password." elif connack_code == CONNACK_REFUSED_NOT_AUTHORIZED: return "Connection Refused: not authorised." else: return "Connection Refused: unknown reason." def base62(num, base=string.digits + string.ascii_letters, padding=1): """Convert a number to base-62 representation.""" assert num >= 0 digits = [] while num: num, rest = divmod(num, 62) digits.append(base[rest]) digits.extend(base[0] for _ in range(len(digits), padding)) return ''.join(reversed(digits)) def topic_matches_sub(sub, topic): """Check whether a topic matches a subscription. For example: foo/bar would match the subscription foo/# or +/bar non/matching would not match the subscription non/+/+ """ matcher = MQTTMatcher() matcher[sub] = True try: next(matcher.iter_match(topic)) return True except StopIteration: return False def _socketpair_compat(): """TCP/IP socketpair including Windows support""" listensock = socket.socket( socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_IP) listensock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) listensock.bind(("127.0.0.1", 0)) listensock.listen(1) iface, port = listensock.getsockname() sock1 = socket.socket( socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_IP) sock1.setblocking(0) try: sock1.connect(("127.0.0.1", port)) except BlockingIOError: pass sock2, address = listensock.accept() sock2.setblocking(0) listensock.close() return (sock1, sock2) class MQTTMessageInfo(object): """This is a class returned from Client.publish() and can be used to find out the mid of the message that was published, and to determine whether the message has been published, and/or wait until it is published. """ __slots__ = 'mid', '_published', '_condition', 'rc', '_iterpos' def __init__(self, mid): self.mid = mid self._published = False self._condition = threading.Condition() self.rc = 0 self._iterpos = 0 def __str__(self): return str((self.rc, self.mid)) def __iter__(self): self._iterpos = 0 return self def __next__(self): return self.next() def next(self): if self._iterpos == 0: self._iterpos = 1 return self.rc elif self._iterpos == 1: self._iterpos = 2 return self.mid else: raise StopIteration def __getitem__(self, index): if index == 0: return self.rc elif index == 1: return self.mid else: raise IndexError("index out of range") def _set_as_published(self): with self._condition: self._published = True self._condition.notify() def wait_for_publish(self, timeout=None): """Block until the message associated with this object is published, or until the timeout occurs. If timeout is None, this will never time out. Set timeout to a positive number of seconds, e.g. 1.2, to enable the timeout. Raises ValueError if the message was not queued due to the outgoing queue being full. Raises RuntimeError if the message was not published for another reason. """ if self.rc == MQTT_ERR_QUEUE_SIZE: raise ValueError('Message is not queued due to ERR_QUEUE_SIZE') elif self.rc == MQTT_ERR_AGAIN: pass elif self.rc > 0: raise RuntimeError('Message publish failed: %s' % (error_string(self.rc))) timeout_time = None if timeout is None else time.time() + timeout timeout_tenth = None if timeout is None else timeout / 10. def timed_out(): return False if timeout is None else time.time() > timeout_time with self._condition: while not self._published and not timed_out(): self._condition.wait(timeout_tenth) def is_published(self): """Returns True if the message associated with this object has been published, else returns False.""" if self.rc == MQTT_ERR_QUEUE_SIZE: raise ValueError('Message is not queued due to ERR_QUEUE_SIZE') elif self.rc == MQTT_ERR_AGAIN: pass elif self.rc > 0: raise RuntimeError('Message publish failed: %s' % (error_string(self.rc))) with self._condition: return self._published class MQTTMessage(object): """ This is a class that describes an incoming or outgoing message. It is passed to the on_message callback as the message parameter. Members: topic : String. topic that the message was published on. payload : Bytes/Byte array. the message payload. qos : Integer. The message Quality of Service 0, 1 or 2. retain : Boolean. If true, the message is a retained message and not fresh. mid : Integer. The message id. properties: Properties class. In MQTT v5.0, the properties associated with the message. """ __slots__ = 'timestamp', 'state', 'dup', 'mid', '_topic', 'payload', 'qos', 'retain', 'info', 'properties' def __init__(self, mid=0, topic=b""): self.timestamp = 0 self.state = mqtt_ms_invalid self.dup = False self.mid = mid self._topic = topic self.payload = b"" self.qos = 0 self.retain = False self.info = MQTTMessageInfo(mid) def __eq__(self, other): """Override the default Equals behavior""" if isinstance(other, self.__class__): return self.mid == other.mid return False def __ne__(self, other): """Define a non-equality test""" return not self.__eq__(other) @property def topic(self): return self._topic.decode('utf-8') @topic.setter def topic(self, value): self._topic = value class Client(object): """MQTT version 3.1/3.1.1/5.0 client class. This is the main class for use communicating with an MQTT broker. General usage flow: * Use connect()/connect_async() to connect to a broker * Call loop() frequently to maintain network traffic flow with the broker * Or use loop_start() to set a thread running to call loop() for you. * Or use loop_forever() to handle calling loop() for you in a blocking * function. * Use subscribe() to subscribe to a topic and receive messages * Use publish() to send messages * Use disconnect() to disconnect from the broker Data returned from the broker is made available with the use of callback functions as described below. Callbacks ========= A number of callback functions are available to receive data back from the broker. To use a callback, define a function and then assign it to the client: def on_connect(client, userdata, flags, rc): print("Connection returned " + str(rc)) client.on_connect = on_connect Callbacks can also be attached using decorators: client = paho.mqtt.Client() @client.connect_callback() def on_connect(client, userdata, flags, rc): print("Connection returned " + str(rc)) **IMPORTANT** the required function signature for a callback can differ depending on whether you are using MQTT v5 or MQTT v3.1.1/v3.1. See the documentation for each callback. All of the callbacks as described below have a "client" and an "userdata" argument. "client" is the Client instance that is calling the callback. "userdata" is user data of any type and can be set when creating a new client instance or with user_data_set(userdata). If you wish to suppress exceptions within a callback, you should set `client.suppress_exceptions = True` The callbacks are listed below, documentation for each of them can be found at the same function name: on_connect, on_connect_fail, on_disconnect, on_message, on_publish, on_subscribe, on_unsubscribe, on_log, on_socket_open, on_socket_close, on_socket_register_write, on_socket_unregister_write """ def __init__(self, client_id="", clean_session=None, userdata=None, protocol=MQTTv311, transport="tcp", reconnect_on_failure=True): """client_id is the unique client id string used when connecting to the broker. If client_id is zero length or None, then the behaviour is defined by which protocol version is in use. If using MQTT v3.1.1, then a zero length client id will be sent to the broker and the broker will generate a random for the client. If using MQTT v3.1 then an id will be randomly generated. In both cases, clean_session must be True. If this is not the case a ValueError will be raised. clean_session is a boolean that determines the client type. If True, the broker will remove all information about this client when it disconnects. If False, the client is a persistent client and subscription information and queued messages will be retained when the client disconnects. Note that a client will never discard its own outgoing messages on disconnect. Calling connect() or reconnect() will cause the messages to be resent. Use reinitialise() to reset a client to its original state. The clean_session argument only applies to MQTT versions v3.1.1 and v3.1. It is not accepted if the MQTT version is v5.0 - use the clean_start argument on connect() instead. userdata is user defined data of any type that is passed as the "userdata" parameter to callbacks. It may be updated at a later point with the user_data_set() function. The protocol argument allows explicit setting of the MQTT version to use for this client. Can be paho.mqtt.client.MQTTv311 (v3.1.1), paho.mqtt.client.MQTTv31 (v3.1) or paho.mqtt.client.MQTTv5 (v5.0), with the default being v3.1.1. Set transport to "websockets" to use WebSockets as the transport mechanism. Set to "tcp" to use raw TCP, which is the default. """ if transport.lower() not in ('websockets', 'tcp'): raise ValueError( 'transport must be "websockets" or "tcp", not %s' % transport) self._transport = transport.lower() self._protocol = protocol self._userdata = userdata self._sock = None self._sockpairR, self._sockpairW = (None, None,) self._keepalive = 60 self._connect_timeout = 5.0 self._client_mode = MQTT_CLIENT if protocol == MQTTv5: if clean_session is not None: raise ValueError('Clean session is not used for MQTT 5.0') else: if clean_session is None: clean_session = True if not clean_session and (client_id == "" or client_id is None): raise ValueError( 'A client id must be provided if clean session is False.') self._clean_session = clean_session # [MQTT-3.1.3-4] Client Id must be UTF-8 encoded string. if client_id == "" or client_id is None: if protocol == MQTTv31: self._client_id = base62(uuid.uuid4().int, padding=22) else: self._client_id = b"" else: self._client_id = client_id if isinstance(self._client_id, unicode): self._client_id = self._client_id.encode('utf-8') self._username = None self._password = None self._in_packet = { "command": 0, "have_remaining": 0, "remaining_count": [], "remaining_mult": 1, "remaining_length": 0, "packet": bytearray(b""), "to_process": 0, "pos": 0} self._out_packet = collections.deque() self._last_msg_in = time_func() self._last_msg_out = time_func() self._reconnect_min_delay = 1 self._reconnect_max_delay = 120 self._reconnect_delay = None self._reconnect_on_failure = reconnect_on_failure self._ping_t = 0 self._last_mid = 0 self._state = mqtt_cs_new self._out_messages = collections.OrderedDict() self._in_messages = collections.OrderedDict() self._max_inflight_messages = 20 self._inflight_messages = 0 self._max_queued_messages = 0 self._connect_properties = None self._will_properties = None self._will = False self._will_topic = b"" self._will_payload = b"" self._will_qos = 0 self._will_retain = False self._on_message_filtered = MQTTMatcher() self._host = "" self._port = 1883 self._bind_address = "" self._bind_port = 0 self._proxy = {} self._in_callback_mutex = threading.Lock() self._callback_mutex = threading.RLock() self._msgtime_mutex = threading.Lock() self._out_message_mutex = threading.RLock() self._in_message_mutex = threading.Lock() self._reconnect_delay_mutex = threading.Lock() self._mid_generate_mutex = threading.Lock() self._thread = None self._thread_terminate = False self._ssl = False self._ssl_context = None # Only used when SSL context does not have check_hostname attribute self._tls_insecure = False self._logger = None self._registered_write = False # No default callbacks self._on_log = None self._on_connect = None self._on_connect_fail = None self._on_subscribe = None self._on_message = None self._on_publish = None self._on_unsubscribe = None self._on_disconnect = None self._on_socket_open = None self._on_socket_close = None self._on_socket_register_write = None self._on_socket_unregister_write = None self._websocket_path = "/mqtt" self._websocket_extra_headers = None # for clean_start == MQTT_CLEAN_START_FIRST_ONLY self._mqttv5_first_connect = True self.suppress_exceptions = False # For callbacks def __del__(self): self._reset_sockets() def _sock_recv(self, bufsize): try: return self._sock.recv(bufsize) except ssl.SSLWantReadError: raise BlockingIOError except ssl.SSLWantWriteError: self._call_socket_register_write() raise BlockingIOError def _sock_send(self, buf): try: return self._sock.send(buf) except ssl.SSLWantReadError: raise BlockingIOError except ssl.SSLWantWriteError: self._call_socket_register_write() raise BlockingIOError except BlockingIOError: self._call_socket_register_write() raise BlockingIOError def _sock_close(self): """Close the connection to the server.""" if not self._sock: return try: sock = self._sock self._sock = None self._call_socket_unregister_write(sock) self._call_socket_close(sock) finally: # In case a callback fails, still close the socket to avoid leaking the file descriptor. sock.close() def _reset_sockets(self, sockpair_only=False): if sockpair_only == False: self._sock_close() if self._sockpairR: self._sockpairR.close() self._sockpairR = None if self._sockpairW: self._sockpairW.close() self._sockpairW = None def reinitialise(self, client_id="", clean_session=True, userdata=None): self._reset_sockets() self.__init__(client_id, clean_session, userdata) def ws_set_options(self, path="/mqtt", headers=None): """ Set the path and headers for a websocket connection path is a string starting with / which should be the endpoint of the mqtt connection on the remote server headers can be either a dict or a callable object. If it is a dict then the extra items in the dict are added to the websocket headers. If it is a callable, then the default websocket headers are passed into this function and the result is used as the new headers. """ self._websocket_path = path if headers is not None: if isinstance(headers, dict) or callable(headers): self._websocket_extra_headers = headers else: raise ValueError( "'headers' option to ws_set_options has to be either a dictionary or callable") def tls_set_context(self, context=None): """Configure network encryption and authentication context. Enables SSL/TLS support. context : an ssl.SSLContext object. By default this is given by `ssl.create_default_context()`, if available. Must be called before connect() or connect_async().""" if self._ssl_context is not None: raise ValueError('SSL/TLS has already been configured.') # Assume that have SSL support, or at least that context input behaves like ssl.SSLContext # in current versions of Python if context is None: if hasattr(ssl, 'create_default_context'): context = ssl.create_default_context() else: raise ValueError('SSL/TLS context must be specified') self._ssl = True self._ssl_context = context # Ensure _tls_insecure is consistent with check_hostname attribute if hasattr(context, 'check_hostname'): self._tls_insecure = not context.check_hostname def tls_set(self, ca_certs=None, certfile=None, keyfile=None, cert_reqs=None, tls_version=None, ciphers=None, keyfile_password=None): """Configure network encryption and authentication options. Enables SSL/TLS support. ca_certs : a string path to the Certificate Authority certificate files that are to be treated as trusted by this client. If this is the only option given then the client will operate in a similar manner to a web browser. That is to say it will require the broker to have a certificate signed by the Certificate Authorities in ca_certs and will communicate using TLS v1,2, but will not attempt any form of authentication. This provides basic network encryption but may not be sufficient depending on how the broker is configured. By default, on Python 2.7.9+ or 3.4+, the default certification authority of the system is used. On older Python version this parameter is mandatory. certfile and keyfile are strings pointing to the PEM encoded client certificate and private keys respectively. If these arguments are not None then they will be used as client information for TLS based authentication. Support for this feature is broker dependent. Note that if either of these files in encrypted and needs a password to decrypt it, then this can be passed using the keyfile_password argument - you should take precautions to ensure that your password is not hard coded into your program by loading the password from a file for example. If you do not provide keyfile_password, the password will be requested to be typed in at a terminal window. cert_reqs allows the certificate requirements that the client imposes on the broker to be changed. By default this is ssl.CERT_REQUIRED, which means that the broker must provide a certificate. See the ssl pydoc for more information on this parameter. tls_version allows the version of the SSL/TLS protocol used to be specified. By default TLS v1.2 is used. Previous versions are allowed but not recommended due to possible security problems. ciphers is a string specifying which encryption ciphers are allowable for this connection, or None to use the defaults. See the ssl pydoc for more information. Must be called before connect() or connect_async().""" if ssl is None: raise ValueError('This platform has no SSL/TLS.') if not hasattr(ssl, 'SSLContext'): # Require Python version that has SSL context support in standard library raise ValueError( 'Python 2.7.9 and 3.2 are the minimum supported versions for TLS.') if ca_certs is None and not hasattr(ssl.SSLContext, 'load_default_certs'): raise ValueError('ca_certs must not be None.') # Create SSLContext object if tls_version is None: tls_version = ssl.PROTOCOL_TLSv1_2 # If the python version supports it, use highest TLS version automatically if hasattr(ssl, "PROTOCOL_TLS"): tls_version = ssl.PROTOCOL_TLS context = ssl.SSLContext(tls_version) # Configure context if certfile is not None: context.load_cert_chain(certfile, keyfile, keyfile_password) if cert_reqs == ssl.CERT_NONE and hasattr(context, 'check_hostname'): context.check_hostname = False context.verify_mode = ssl.CERT_REQUIRED if cert_reqs is None else cert_reqs if ca_certs is not None: context.load_verify_locations(ca_certs) else: context.load_default_certs() if ciphers is not None: context.set_ciphers(ciphers) self.tls_set_context(context) if cert_reqs != ssl.CERT_NONE: # Default to secure, sets context.check_hostname attribute # if available self.tls_insecure_set(False) else: # But with ssl.CERT_NONE, we can not check_hostname self.tls_insecure_set(True) def tls_insecure_set(self, value): """Configure verification of the server hostname in the server certificate. If value is set to true, it is impossible to guarantee that the host you are connecting to is not impersonating your server. This can be useful in initial server testing, but makes it possible for a malicious third party to impersonate your server through DNS spoofing, for example. Do not use this function in a real system. Setting value to true means there is no point using encryption. Must be called before connect() and after either tls_set() or tls_set_context().""" if self._ssl_context is None: raise ValueError( 'Must configure SSL context before using tls_insecure_set.') self._tls_insecure = value # Ensure check_hostname is consistent with _tls_insecure attribute if hasattr(self._ssl_context, 'check_hostname'): # Rely on SSLContext to check host name # If verify_mode is CERT_NONE then the host name will never be checked self._ssl_context.check_hostname = not value def proxy_set(self, **proxy_args): """Configure proxying of MQTT connection. Enables support for SOCKS or HTTP proxies. Proxying is done through the PySocks library. Brief descriptions of the proxy_args parameters are below; see the PySocks docs for more info. (Required) proxy_type: One of {socks.HTTP, socks.SOCKS4, or socks.SOCKS5} proxy_addr: IP address or DNS name of proxy server (Optional) proxy_rdns: boolean indicating whether proxy lookup should be performed remotely (True, default) or locally (False) proxy_username: username for SOCKS5 proxy, or userid for SOCKS4 proxy proxy_password: password for SOCKS5 proxy Must be called before connect() or connect_async().""" if socks is None: raise ValueError("PySocks must be installed for proxy support.") elif not self._proxy_is_valid(proxy_args): raise ValueError("proxy_type and/or proxy_addr are invalid.") else: self._proxy = proxy_args def enable_logger(self, logger=None): """ Enables a logger to send log messages to """ if logger is None: if self._logger is not None: # Do not replace existing logger return logger = logging.getLogger(__name__) self._logger = logger def disable_logger(self): self._logger = None def connect(self, host, port=1883, keepalive=60, bind_address="", bind_port=0, clean_start=MQTT_CLEAN_START_FIRST_ONLY, properties=None): """Connect to a remote broker. host is the hostname or IP address of the remote broker. port is the network port of the server host to connect to. Defaults to 1883. Note that the default port for MQTT over SSL/TLS is 8883 so if you are using tls_set() the port may need providing. keepalive: Maximum period in seconds between communications with the broker. If no other messages are being exchanged, this controls the rate at which the client will send ping messages to the broker. clean_start: (MQTT v5.0 only) True, False or MQTT_CLEAN_START_FIRST_ONLY. Sets the MQTT v5.0 clean_start flag always, never or on the first successful connect only, respectively. MQTT session data (such as outstanding messages and subscriptions) is cleared on successful connect when the clean_start flag is set. properties: (MQTT v5.0 only) the MQTT v5.0 properties to be sent in the MQTT connect packet. """ if self._protocol == MQTTv5: self._mqttv5_first_connect = True else: if clean_start != MQTT_CLEAN_START_FIRST_ONLY: raise ValueError("Clean start only applies to MQTT V5") if properties != None: raise ValueError("Properties only apply to MQTT V5") self.connect_async(host, port, keepalive, bind_address, bind_port, clean_start, properties) return self.reconnect() def connect_srv(self, domain=None, keepalive=60, bind_address="", clean_start=MQTT_CLEAN_START_FIRST_ONLY, properties=None): """Connect to a remote broker. domain is the DNS domain to search for SRV records; if None, try to determine local domain name. keepalive, bind_address, clean_start and properties are as for connect() """ if HAVE_DNS is False: raise ValueError( 'No DNS resolver library found, try "pip install dnspython" or "pip3 install dnspython3".') if domain is None: domain = socket.getfqdn() domain = domain[domain.find('.') + 1:] try: rr = '_mqtt._tcp.%s' % domain if self._ssl: # IANA specifies secure-mqtt (not mqtts) for port 8883 rr = '_secure-mqtt._tcp.%s' % domain answers = [] for answer in dns.resolver.query(rr, dns.rdatatype.SRV): addr = answer.target.to_text()[:-1] answers.append( (addr, answer.port, answer.priority, answer.weight)) except (dns.resolver.NXDOMAIN, dns.resolver.NoAnswer, dns.resolver.NoNameservers): raise ValueError("No answer/NXDOMAIN for SRV in %s" % (domain)) # FIXME: doesn't account for weight for answer in answers: host, port, prio, weight = answer try: return self.connect(host, port, keepalive, bind_address, clean_start, properties) except Exception: pass raise ValueError("No SRV hosts responded") def connect_async(self, host, port=1883, keepalive=60, bind_address="", bind_port=0, clean_start=MQTT_CLEAN_START_FIRST_ONLY, properties=None): """Connect to a remote broker asynchronously. This is a non-blocking connect call that can be used with loop_start() to provide very quick start. host is the hostname or IP address of the remote broker. port is the network port of the server host to connect to. Defaults to 1883. Note that the default port for MQTT over SSL/TLS is 8883 so if you are using tls_set() the port may need providing. keepalive: Maximum period in seconds between communications with the broker. If no other messages are being exchanged, this controls the rate at which the client will send ping messages to the broker. clean_start: (MQTT v5.0 only) True, False or MQTT_CLEAN_START_FIRST_ONLY. Sets the MQTT v5.0 clean_start flag always, never or on the first successful connect only, respectively. MQTT session data (such as outstanding messages and subscriptions) is cleared on successful connect when the clean_start flag is set. properties: (MQTT v5.0 only) the MQTT v5.0 properties to be sent in the MQTT connect packet. Use the Properties class. """ if host is None or len(host) == 0: raise ValueError('Invalid host.') if port <= 0: raise ValueError('Invalid port number.') if keepalive < 0: raise ValueError('Keepalive must be >=0.') if bind_address != "" and bind_address is not None: if sys.version_info < (2, 7) or (3, 0) < sys.version_info < (3, 2): raise ValueError('bind_address requires Python 2.7 or 3.2.') if bind_port < 0: raise ValueError('Invalid bind port number.') self._host = host self._port = port self._keepalive = keepalive self._bind_address = bind_address self._bind_port = bind_port self._clean_start = clean_start self._connect_properties = properties self._state = mqtt_cs_connect_async def reconnect_delay_set(self, min_delay=1, max_delay=120): """ Configure the exponential reconnect delay When connection is lost, wait initially min_delay seconds and double this time every attempt. The wait is capped at max_delay. Once the client is fully connected (e.g. not only TCP socket, but received a success CONNACK), the wait timer is reset to min_delay. """ with self._reconnect_delay_mutex: self._reconnect_min_delay = min_delay self._reconnect_max_delay = max_delay self._reconnect_delay = None def reconnect(self): """Reconnect the client after a disconnect. Can only be called after connect()/connect_async().""" if len(self._host) == 0: raise ValueError('Invalid host.') if self._port <= 0: raise ValueError('Invalid port number.') self._in_packet = { "command": 0, "have_remaining": 0, "remaining_count": [], "remaining_mult": 1, "remaining_length": 0, "packet": bytearray(b""), "to_process": 0, "pos": 0} self._out_packet = collections.deque() with self._msgtime_mutex: self._last_msg_in = time_func() self._last_msg_out = time_func() self._ping_t = 0 self._state = mqtt_cs_new self._sock_close() # Put messages in progress in a valid state. self._messages_reconnect_reset() sock = self._create_socket_connection() if self._ssl: # SSL is only supported when SSLContext is available (implies Python >= 2.7.9 or >= 3.2) verify_host = not self._tls_insecure try: # Try with server_hostname, even it's not supported in certain scenarios sock = self._ssl_context.wrap_socket( sock, server_hostname=self._host, do_handshake_on_connect=False, ) except ssl.CertificateError: # CertificateError is derived from ValueError raise except ValueError: # Python version requires SNI in order to handle server_hostname, but SNI is not available sock = self._ssl_context.wrap_socket( sock, do_handshake_on_connect=False, ) else: # If SSL context has already checked hostname, then don't need to do it again if (hasattr(self._ssl_context, 'check_hostname') and self._ssl_context.check_hostname): verify_host = False sock.settimeout(self._keepalive) sock.do_handshake() if verify_host: ssl.match_hostname(sock.getpeercert(), self._host) if self._transport == "websockets": sock.settimeout(self._keepalive) sock = WebsocketWrapper(sock, self._host, self._port, self._ssl, self._websocket_path, self._websocket_extra_headers) self._sock = sock self._sock.setblocking(0) self._registered_write = False self._call_socket_open() return self._send_connect(self._keepalive) def loop(self, timeout=1.0, max_packets=1): """Process network events. It is strongly recommended that you use loop_start(), or loop_forever(), or if you are using an external event loop using loop_read(), loop_write(), and loop_misc(). Using loop() on it's own is no longer recommended. This function must be called regularly to ensure communication with the broker is carried out. It calls select() on the network socket to wait for network events. If incoming data is present it will then be processed. Outgoing commands, from e.g. publish(), are normally sent immediately that their function is called, but this is not always possible. loop() will also attempt to send any remaining outgoing messages, which also includes commands that are part of the flow for messages with QoS>0. timeout: The time in seconds to wait for incoming/outgoing network traffic before timing out and returning. max_packets: Not currently used. Returns MQTT_ERR_SUCCESS on success. Returns >0 on error. A ValueError will be raised if timeout < 0""" if self._sockpairR is None or self._sockpairW is None: self._reset_sockets(sockpair_only=True) self._sockpairR, self._sockpairW = _socketpair_compat() return self._loop(timeout) def _loop(self, timeout=1.0): if timeout < 0.0: raise ValueError('Invalid timeout.') try: packet = self._out_packet.popleft() self._out_packet.appendleft(packet) wlist = [self._sock] except IndexError: wlist = [] # used to check if there are any bytes left in the (SSL) socket pending_bytes = 0 if hasattr(self._sock, 'pending'): pending_bytes = self._sock.pending() # if bytes are pending do not wait in select if pending_bytes > 0: timeout = 0.0 # sockpairR is used to break out of select() before the timeout, on a # call to publish() etc. if self._sockpairR is None: rlist = [self._sock] else: rlist = [self._sock, self._sockpairR] try: socklist = select.select(rlist, wlist, [], timeout) except TypeError: # Socket isn't correct type, in likelihood connection is lost return MQTT_ERR_CONN_LOST except ValueError: # Can occur if we just reconnected but rlist/wlist contain a -1 for # some reason. return MQTT_ERR_CONN_LOST except Exception: # Note that KeyboardInterrupt, etc. can still terminate since they # are not derived from Exception return MQTT_ERR_UNKNOWN if self._sock in socklist[0] or pending_bytes > 0: rc = self.loop_read() if rc or self._sock is None: return rc if self._sockpairR and self._sockpairR in socklist[0]: # Stimulate output write even though we didn't ask for it, because # at that point the publish or other command wasn't present. socklist[1].insert(0, self._sock) # Clear sockpairR - only ever a single byte written. try: # Read many bytes at once - this allows up to 10000 calls to # publish() inbetween calls to loop(). self._sockpairR.recv(10000) except BlockingIOError: pass if self._sock in socklist[1]: rc = self.loop_write() if rc or self._sock is None: return rc return self.loop_misc() def publish(self, topic, payload=None, qos=0, retain=False, properties=None): """Publish a message on a topic. This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics. topic: The topic that the message should be published on. payload: The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require. qos: The quality of service level to use. retain: If set to true, the message will be set as the "last known good"/retained message for the topic. properties: (MQTT v5.0 only) the MQTT v5.0 properties to be included. Use the Properties class. Returns a MQTTMessageInfo class, which can be used to determine whether the message has been delivered (using info.is_published()) or to block waiting for the message to be delivered (info.wait_for_publish()). The message ID and return code of the publish() call can be found at info.mid and info.rc. For backwards compatibility, the MQTTMessageInfo class is iterable so the old construct of (rc, mid) = client.publish(...) is still valid. rc is MQTT_ERR_SUCCESS to indicate success or MQTT_ERR_NO_CONN if the client is not currently connected. mid is the message ID for the publish request. The mid value can be used to track the publish request by checking against the mid argument in the on_publish() callback if it is defined. A ValueError will be raised if topic is None, has zero length or is invalid (contains a wildcard), except if the MQTT version used is v5.0. For v5.0, a zero length topic can be used when a Topic Alias has been set. A ValueError will be raised if qos is not one of 0, 1 or 2, or if the length of the payload is greater than 268435455 bytes.""" if self._protocol != MQTTv5: if topic is None or len(topic) == 0: raise ValueError('Invalid topic.') topic = topic.encode('utf-8') if self._topic_wildcard_len_check(topic) != MQTT_ERR_SUCCESS: raise ValueError('Publish topic cannot contain wildcards.') if qos < 0 or qos > 2: raise ValueError('Invalid QoS level.') if isinstance(payload, unicode): local_payload = payload.encode('utf-8') elif isinstance(payload, (bytes, bytearray)): local_payload = payload elif isinstance(payload, (int, float)): local_payload = str(payload).encode('ascii') elif payload is None: local_payload = b'' else: raise TypeError( 'payload must be a string, bytearray, int, float or None.') if len(local_payload) > 268435455: raise ValueError('Payload too large.') local_mid = self._mid_generate() if qos == 0: info = MQTTMessageInfo(local_mid) rc = self._send_publish( local_mid, topic, local_payload, qos, retain, False, info, properties) info.rc = rc return info else: message = MQTTMessage(local_mid, topic) message.timestamp = time_func() message.payload = local_payload message.qos = qos message.retain = retain message.dup = False message.properties = properties with self._out_message_mutex: if self._max_queued_messages > 0 and len(self._out_messages) >= self._max_queued_messages: message.info.rc = MQTT_ERR_QUEUE_SIZE return message.info if local_mid in self._out_messages: message.info.rc = MQTT_ERR_QUEUE_SIZE return message.info self._out_messages[message.mid] = message if self._max_inflight_messages == 0 or self._inflight_messages < self._max_inflight_messages: self._inflight_messages += 1 if qos == 1: message.state = mqtt_ms_wait_for_puback elif qos == 2: message.state = mqtt_ms_wait_for_pubrec rc = self._send_publish(message.mid, topic, message.payload, message.qos, message.retain, message.dup, message.info, message.properties) # remove from inflight messages so it will be send after a connection is made if rc is MQTT_ERR_NO_CONN: self._inflight_messages -= 1 message.state = mqtt_ms_publish message.info.rc = rc return message.info else: message.state = mqtt_ms_queued message.info.rc = MQTT_ERR_SUCCESS return message.info def username_pw_set(self, username, password=None): """Set a username and optionally a password for broker authentication. Must be called before connect() to have any effect. Requires a broker that supports MQTT v3.1. username: The username to authenticate with. Need have no relationship to the client id. Must be unicode [MQTT-3.1.3-11]. Set to None to reset client back to not using username/password for broker authentication. password: The password to authenticate with. Optional, set to None if not required. If it is unicode, then it will be encoded as UTF-8. """ # [MQTT-3.1.3-11] User name must be UTF-8 encoded string self._username = None if username is None else username.encode('utf-8') self._password = password if isinstance(self._password, unicode): self._password = self._password.encode('utf-8') def enable_bridge_mode(self): """Sets the client in a bridge mode instead of client mode. Must be called before connect() to have any effect. Requires brokers that support bridge mode. Under bridge mode, the broker will identify the client as a bridge and not send it's own messages back to it. Hence a subsciption of # is possible without message loops. This feature also correctly propagates the retain flag on the messages. Currently Mosquitto and RSMB support this feature. This feature can be used to create a bridge between multiple broker. """ self._client_mode = MQTT_BRIDGE def is_connected(self): """Returns the current status of the connection True if connection exists False if connection is closed """ return self._state == mqtt_cs_connected def disconnect(self, reasoncode=None, properties=None): """Disconnect a connected client from the broker. reasoncode: (MQTT v5.0 only) a ReasonCodes instance setting the MQTT v5.0 reasoncode to be sent with the disconnect. It is optional, the receiver then assuming that 0 (success) is the value. properties: (MQTT v5.0 only) a Properties instance setting the MQTT v5.0 properties to be included. Optional - if not set, no properties are sent. """ self._state = mqtt_cs_disconnecting if self._sock is None: return MQTT_ERR_NO_CONN return self._send_disconnect(reasoncode, properties) def subscribe(self, topic, qos=0, options=None, properties=None): """Subscribe the client to one or more topics. This function may be called in three different ways (and a further three for MQTT v5.0): Simple string and integer ------------------------- e.g. subscribe("my/topic", 2) topic: A string specifying the subscription topic to subscribe to. qos: The desired quality of service level for the subscription. Defaults to 0. options and properties: Not used. Simple string and subscribe options (MQTT v5.0 only) ---------------------------------------------------- e.g. subscribe("my/topic", options=SubscribeOptions(qos=2)) topic: A string specifying the subscription topic to subscribe to. qos: Not used. options: The MQTT v5.0 subscribe options. properties: a Properties instance setting the MQTT v5.0 properties to be included. Optional - if not set, no properties are sent. String and integer tuple ------------------------ e.g. subscribe(("my/topic", 1)) topic: A tuple of (topic, qos). Both topic and qos must be present in the tuple. qos and options: Not used. properties: Only used for MQTT v5.0. A Properties instance setting the MQTT v5.0 properties. Optional - if not set, no properties are sent. String and subscribe options tuple (MQTT v5.0 only) --------------------------------------------------- e.g. subscribe(("my/topic", SubscribeOptions(qos=1))) topic: A tuple of (topic, SubscribeOptions). Both topic and subscribe options must be present in the tuple. qos and options: Not used. properties: a Properties instance setting the MQTT v5.0 properties to be included. Optional - if not set, no properties are sent. List of string and integer tuples --------------------------------- e.g. subscribe([("my/topic", 0), ("another/topic", 2)]) This allows multiple topic subscriptions in a single SUBSCRIPTION command, which is more efficient than using multiple calls to subscribe(). topic: A list of tuple of format (topic, qos). Both topic and qos must be present in all of the tuples. qos, options and properties: Not used. List of string and subscribe option tuples (MQTT v5.0 only) ----------------------------------------------------------- e.g. subscribe([("my/topic", SubscribeOptions(qos=0), ("another/topic", SubscribeOptions(qos=2)]) This allows multiple topic subscriptions in a single SUBSCRIPTION command, which is more efficient than using multiple calls to subscribe(). topic: A list of tuple of format (topic, SubscribeOptions). Both topic and subscribe options must be present in all of the tuples. qos and options: Not used. properties: a Properties instance setting the MQTT v5.0 properties to be included. Optional - if not set, no properties are sent. The function returns a tuple (result, mid), where result is MQTT_ERR_SUCCESS to indicate success or (MQTT_ERR_NO_CONN, None) if the client is not currently connected. mid is the message ID for the subscribe request. The mid value can be used to track the subscribe request by checking against the mid argument in the on_subscribe() callback if it is defined. Raises a ValueError if qos is not 0, 1 or 2, or if topic is None or has zero string length, or if topic is not a string, tuple or list. """ topic_qos_list = None if isinstance(topic, tuple): if self._protocol == MQTTv5: topic, options = topic if not isinstance(options, SubscribeOptions): raise ValueError( 'Subscribe options must be instance of SubscribeOptions class.') else: topic, qos = topic if isinstance(topic, basestring): if qos < 0 or qos > 2: raise ValueError('Invalid QoS level.') if self._protocol == MQTTv5: if options is None: # if no options are provided, use the QoS passed instead options = SubscribeOptions(qos=qos) elif qos != 0: raise ValueError( 'Subscribe options and qos parameters cannot be combined.') if not isinstance(options, SubscribeOptions): raise ValueError( 'Subscribe options must be instance of SubscribeOptions class.') topic_qos_list = [(topic.encode('utf-8'), options)] else: if topic is None or len(topic) == 0: raise ValueError('Invalid topic.') topic_qos_list = [(topic.encode('utf-8'), qos)] elif isinstance(topic, list): topic_qos_list = [] if self._protocol == MQTTv5: for t, o in topic: if not isinstance(o, SubscribeOptions): # then the second value should be QoS if o < 0 or o > 2: raise ValueError('Invalid QoS level.') o = SubscribeOptions(qos=o) topic_qos_list.append((t.encode('utf-8'), o)) else: for t, q in topic: if q < 0 or q > 2: raise ValueError('Invalid QoS level.') if t is None or len(t) == 0 or not isinstance(t, basestring): raise ValueError('Invalid topic.') topic_qos_list.append((t.encode('utf-8'), q)) if topic_qos_list is None: raise ValueError("No topic specified, or incorrect topic type.") if any(self._filter_wildcard_len_check(topic) != MQTT_ERR_SUCCESS for topic, _ in topic_qos_list): raise ValueError('Invalid subscription filter.') if self._sock is None: return (MQTT_ERR_NO_CONN, None) return self._send_subscribe(False, topic_qos_list, properties) def unsubscribe(self, topic, properties=None): """Unsubscribe the client from one or more topics. topic: A single string, or list of strings that are the subscription topics to unsubscribe from. properties: (MQTT v5.0 only) a Properties instance setting the MQTT v5.0 properties to be included. Optional - if not set, no properties are sent. Returns a tuple (result, mid), where result is MQTT_ERR_SUCCESS to indicate success or (MQTT_ERR_NO_CONN, None) if the client is not currently connected. mid is the message ID for the unsubscribe request. The mid value can be used to track the unsubscribe request by checking against the mid argument in the on_unsubscribe() callback if it is defined. Raises a ValueError if topic is None or has zero string length, or is not a string or list. """ topic_list = None if topic is None: raise ValueError('Invalid topic.') if isinstance(topic, basestring): if len(topic) == 0: raise ValueError('Invalid topic.') topic_list = [topic.encode('utf-8')] elif isinstance(topic, list): topic_list = [] for t in topic: if len(t) == 0 or not isinstance(t, basestring): raise ValueError('Invalid topic.') topic_list.append(t.encode('utf-8')) if topic_list is None: raise ValueError("No topic specified, or incorrect topic type.") if self._sock is None: return (MQTT_ERR_NO_CONN, None) return self._send_unsubscribe(False, topic_list, properties) def loop_read(self, max_packets=1): """Process read network events. Use in place of calling loop() if you wish to handle your client reads as part of your own application. Use socket() to obtain the client socket to call select() or equivalent on. Do not use if you are using the threaded interface loop_start().""" if self._sock is None: return MQTT_ERR_NO_CONN max_packets = len(self._out_messages) + len(self._in_messages) if max_packets < 1: max_packets = 1 for _ in range(0, max_packets): if self._sock is None: return MQTT_ERR_NO_CONN rc = self._packet_read() if rc > 0: return self._loop_rc_handle(rc) elif rc == MQTT_ERR_AGAIN: return MQTT_ERR_SUCCESS return MQTT_ERR_SUCCESS def loop_write(self, max_packets=1): """Process write network events. Use in place of calling loop() if you wish to handle your client writes as part of your own application. Use socket() to obtain the client socket to call select() or equivalent on. Use want_write() to determine if there is data waiting to be written. Do not use if you are using the threaded interface loop_start().""" if self._sock is None: return MQTT_ERR_NO_CONN try: rc = self._packet_write() if rc == MQTT_ERR_AGAIN: return MQTT_ERR_SUCCESS elif rc > 0: return self._loop_rc_handle(rc) else: return MQTT_ERR_SUCCESS finally: if self.want_write(): self._call_socket_register_write() else: self._call_socket_unregister_write() def want_write(self): """Call to determine if there is network data waiting to be written. Useful if you are calling select() yourself rather than using loop(). """ try: packet = self._out_packet.popleft() self._out_packet.appendleft(packet) return True except IndexError: return False def loop_misc(self): """Process miscellaneous network events. Use in place of calling loop() if you wish to call select() or equivalent on. Do not use if you are using the threaded interface loop_start().""" if self._sock is None: return MQTT_ERR_NO_CONN now = time_func() self._check_keepalive() if self._ping_t > 0 and now - self._ping_t >= self._keepalive: # client->ping_t != 0 means we are waiting for a pingresp. # This hasn't happened in the keepalive time so we should disconnect. self._sock_close() if self._state == mqtt_cs_disconnecting: rc = MQTT_ERR_SUCCESS else: rc = MQTT_ERR_KEEPALIVE self._do_on_disconnect(rc) return MQTT_ERR_CONN_LOST return MQTT_ERR_SUCCESS def max_inflight_messages_set(self, inflight): """Set the maximum number of messages with QoS>0 that can be part way through their network flow at once. Defaults to 20.""" if inflight < 0: raise ValueError('Invalid inflight.') self._max_inflight_messages = inflight def max_queued_messages_set(self, queue_size): """Set the maximum number of messages in the outgoing message queue. 0 means unlimited.""" if queue_size < 0: raise ValueError('Invalid queue size.') if not isinstance(queue_size, int): raise ValueError('Invalid type of queue size.') self._max_queued_messages = queue_size return self def message_retry_set(self, retry): """No longer used, remove in version 2.0""" pass def user_data_set(self, userdata): """Set the user data variable passed to callbacks. May be any data type.""" self._userdata = userdata def will_set(self, topic, payload=None, qos=0, retain=False, properties=None): """Set a Will to be sent by the broker in case the client disconnects unexpectedly. This must be called before connect() to have any effect. topic: The topic that the will message should be published on. payload: The message to send as a will. If not given, or set to None a zero length message will be used as the will. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require. qos: The quality of service level to use for the will. retain: If set to true, the will message will be set as the "last known good"/retained message for the topic. properties: (MQTT v5.0 only) a Properties instance setting the MQTT v5.0 properties to be included with the will message. Optional - if not set, no properties are sent. Raises a ValueError if qos is not 0, 1 or 2, or if topic is None or has zero string length. """ if topic is None or len(topic) == 0: raise ValueError('Invalid topic.') if qos < 0 or qos > 2: raise ValueError('Invalid QoS level.') if properties != None and not isinstance(properties, Properties): raise ValueError( "The properties argument must be an instance of the Properties class.") if isinstance(payload, unicode): self._will_payload = payload.encode('utf-8') elif isinstance(payload, (bytes, bytearray)): self._will_payload = payload elif isinstance(payload, (int, float)): self._will_payload = str(payload).encode('ascii') elif payload is None: self._will_payload = b"" else: raise TypeError( 'payload must be a string, bytearray, int, float or None.') self._will = True self._will_topic = topic.encode('utf-8') self._will_qos = qos self._will_retain = retain self._will_properties = properties def will_clear(self): """ Removes a will that was previously configured with will_set(). Must be called before connect() to have any effect.""" self._will = False self._will_topic = b"" self._will_payload = b"" self._will_qos = 0 self._will_retain = False def socket(self): """Return the socket or ssl object for this client.""" return self._sock def loop_forever(self, timeout=1.0, max_packets=1, retry_first_connection=False): """This function calls the network loop functions for you in an infinite blocking loop. It is useful for the case where you only want to run the MQTT client loop in your program. loop_forever() will handle reconnecting for you if reconnect_on_failure is true (this is the default behavior). If you call disconnect() in a callback it will return. timeout: The time in seconds to wait for incoming/outgoing network traffic before timing out and returning. max_packets: Not currently used. retry_first_connection: Should the first connection attempt be retried on failure. This is independent of the reconnect_on_failure setting. Raises OSError/WebsocketConnectionError on first connection failures unless retry_first_connection=True """ run = True while run: if self._thread_terminate is True: break if self._state == mqtt_cs_connect_async: try: self.reconnect() except (OSError, WebsocketConnectionError): self._handle_on_connect_fail() if not retry_first_connection: raise self._easy_log( MQTT_LOG_DEBUG, "Connection failed, retrying") self._reconnect_wait() else: break while run: rc = MQTT_ERR_SUCCESS while rc == MQTT_ERR_SUCCESS: rc = self._loop(timeout) # We don't need to worry about locking here, because we've # either called loop_forever() when in single threaded mode, or # in multi threaded mode when loop_stop() has been called and # so no other threads can access _out_packet or _messages. if (self._thread_terminate is True and len(self._out_packet) == 0 and len(self._out_messages) == 0): rc = 1 run = False def should_exit(): return self._state == mqtt_cs_disconnecting or run is False or self._thread_terminate is True if should_exit() or not self._reconnect_on_failure: run = False else: self._reconnect_wait() if should_exit(): run = False else: try: self.reconnect() except (OSError, WebsocketConnectionError): self._handle_on_connect_fail() self._easy_log( MQTT_LOG_DEBUG, "Connection failed, retrying") return rc def loop_start(self): """This is part of the threaded client interface. Call this once to start a new thread to process network traffic. This provides an alternative to repeatedly calling loop() yourself. """ if self._thread is not None: return MQTT_ERR_INVAL self._sockpairR, self._sockpairW = _socketpair_compat() self._thread_terminate = False self._thread = threading.Thread(target=self._thread_main) self._thread.daemon = True self._thread.start() def loop_stop(self, force=False): """This is part of the threaded client interface. Call this once to stop the network thread previously created with loop_start(). This call will block until the network thread finishes. The force parameter is currently ignored. """ if self._thread is None: return MQTT_ERR_INVAL self._thread_terminate = True if threading.current_thread() != self._thread: self._thread.join() self._thread = None @property def on_log(self): """If implemented, called when the client has log information. Defined to allow debugging.""" return self._on_log @on_log.setter def on_log(self, func): """ Define the logging callback implementation. Expected signature is: log_callback(client, userdata, level, buf) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() level: gives the severity of the message and will be one of MQTT_LOG_INFO, MQTT_LOG_NOTICE, MQTT_LOG_WARNING, MQTT_LOG_ERR, and MQTT_LOG_DEBUG. buf: the message itself Decorator: @client.log_callback() (```client``` is the name of the instance which this callback is being attached to) """ self._on_log = func def log_callback(self): def decorator(func): self.on_log = func return func return decorator @property def on_connect(self): """If implemented, called when the broker responds to our connection request.""" return self._on_connect @on_connect.setter def on_connect(self, func): """ Define the connect callback implementation. Expected signature for MQTT v3.1 and v3.1.1 is: connect_callback(client, userdata, flags, rc) and for MQTT v5.0: connect_callback(client, userdata, flags, reasonCode, properties) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() flags: response flags sent by the broker rc: the connection result reasonCode: the MQTT v5.0 reason code: an instance of the ReasonCode class. ReasonCode may be compared to integer. properties: the MQTT v5.0 properties returned from the broker. An instance of the Properties class. For MQTT v3.1 and v3.1.1 properties is not provided but for compatibility with MQTT v5.0, we recommend adding properties=None. flags is a dict that contains response flags from the broker: flags['session present'] - this flag is useful for clients that are using clean session set to 0 only. If a client with clean session=0, that reconnects to a broker that it has previously connected to, this flag indicates whether the broker still has the session information for the client. If 1, the session still exists. The value of rc indicates success or not: 0: Connection successful 1: Connection refused - incorrect protocol version 2: Connection refused - invalid client identifier 3: Connection refused - server unavailable 4: Connection refused - bad username or password 5: Connection refused - not authorised 6-255: Currently unused. Decorator: @client.connect_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_connect = func def connect_callback(self): def decorator(func): self.on_connect = func return func return decorator @property def on_connect_fail(self): """If implemented, called when the client failed to connect to the broker.""" return self._on_connect_fail @on_connect_fail.setter def on_connect_fail(self, func): """ Define the connection failure callback implementation Expected signature is: on_connect_fail(client, userdata) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() Decorator: @client.connect_fail_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_connect_fail = func def connect_fail_callback(self): def decorator(func): self.on_connect_fail = func return func return decorator @property def on_subscribe(self): """If implemented, called when the broker responds to a subscribe request.""" return self._on_subscribe @on_subscribe.setter def on_subscribe(self, func): """ Define the subscribe callback implementation. Expected signature for MQTT v3.1.1 and v3.1 is: subscribe_callback(client, userdata, mid, granted_qos) and for MQTT v5.0: subscribe_callback(client, userdata, mid, reasonCodes, properties) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() mid: matches the mid variable returned from the corresponding subscribe() call. granted_qos: list of integers that give the QoS level the broker has granted for each of the different subscription requests. reasonCodes: the MQTT v5.0 reason codes received from the broker for each subscription. A list of ReasonCodes instances. properties: the MQTT v5.0 properties received from the broker. A list of Properties class instances. Decorator: @client.subscribe_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_subscribe = func def subscribe_callback(self): def decorator(func): self.on_subscribe = func return func return decorator @property def on_message(self): """If implemented, called when a message has been received on a topic that the client subscribes to. This callback will be called for every message received. Use message_callback_add() to define multiple callbacks that will be called for specific topic filters.""" return self._on_message @on_message.setter def on_message(self, func): """ Define the message received callback implementation. Expected signature is: on_message_callback(client, userdata, message) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() message: an instance of MQTTMessage. This is a class with members topic, payload, qos, retain. Decorator: @client.message_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_message = func def message_callback(self): def decorator(func): self.on_message = func return func return decorator @property def on_publish(self): """If implemented, called when a message that was to be sent using the publish() call has completed transmission to the broker. For messages with QoS levels 1 and 2, this means that the appropriate handshakes have completed. For QoS 0, this simply means that the message has left the client. This callback is important because even if the publish() call returns success, it does not always mean that the message has been sent.""" return self._on_publish @on_publish.setter def on_publish(self, func): """ Define the published message callback implementation. Expected signature is: on_publish_callback(client, userdata, mid) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() mid: matches the mid variable returned from the corresponding publish() call, to allow outgoing messages to be tracked. Decorator: @client.publish_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_publish = func def publish_callback(self): def decorator(func): self.on_publish = func return func return decorator @property def on_unsubscribe(self): """If implemented, called when the broker responds to an unsubscribe request.""" return self._on_unsubscribe @on_unsubscribe.setter def on_unsubscribe(self, func): """ Define the unsubscribe callback implementation. Expected signature for MQTT v3.1.1 and v3.1 is: unsubscribe_callback(client, userdata, mid) and for MQTT v5.0: unsubscribe_callback(client, userdata, mid, properties, reasonCodes) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() mid: matches the mid variable returned from the corresponding unsubscribe() call. properties: the MQTT v5.0 properties received from the broker. A list of Properties class instances. reasonCodes: the MQTT v5.0 reason codes received from the broker for each unsubscribe topic. A list of ReasonCodes instances Decorator: @client.unsubscribe_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_unsubscribe = func def unsubscribe_callback(self): def decorator(func): self.on_unsubscribe = func return func return decorator @property def on_disconnect(self): """If implemented, called when the client disconnects from the broker. """ return self._on_disconnect @on_disconnect.setter def on_disconnect(self, func): """ Define the disconnect callback implementation. Expected signature for MQTT v3.1.1 and v3.1 is: disconnect_callback(client, userdata, rc) and for MQTT v5.0: disconnect_callback(client, userdata, reasonCode, properties) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() rc: the disconnection result The rc parameter indicates the disconnection state. If MQTT_ERR_SUCCESS (0), the callback was called in response to a disconnect() call. If any other value the disconnection was unexpected, such as might be caused by a network error. Decorator: @client.disconnect_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_disconnect = func def disconnect_callback(self): def decorator(func): self.on_disconnect = func return func return decorator @property def on_socket_open(self): """If implemented, called just after the socket was opend.""" return self._on_socket_open @on_socket_open.setter def on_socket_open(self, func): """Define the socket_open callback implementation. This should be used to register the socket to an external event loop for reading. Expected signature is: socket_open_callback(client, userdata, socket) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() sock: the socket which was just opened. Decorator: @client.socket_open_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_socket_open = func def socket_open_callback(self): def decorator(func): self.on_socket_open = func return func return decorator def _call_socket_open(self): """Call the socket_open callback with the just-opened socket""" with self._callback_mutex: on_socket_open = self.on_socket_open if on_socket_open: with self._in_callback_mutex: try: on_socket_open(self, self._userdata, self._sock) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_socket_open: %s', err) if not self.suppress_exceptions: raise @property def on_socket_close(self): """If implemented, called just before the socket is closed.""" return self._on_socket_close @on_socket_close.setter def on_socket_close(self, func): """Define the socket_close callback implementation. This should be used to unregister the socket from an external event loop for reading. Expected signature is: socket_close_callback(client, userdata, socket) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() sock: the socket which is about to be closed. Decorator: @client.socket_close_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_socket_close = func def socket_close_callback(self): def decorator(func): self.on_socket_close = func return func return decorator def _call_socket_close(self, sock): """Call the socket_close callback with the about-to-be-closed socket""" with self._callback_mutex: on_socket_close = self.on_socket_close if on_socket_close: with self._in_callback_mutex: try: on_socket_close(self, self._userdata, sock) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_socket_close: %s', err) if not self.suppress_exceptions: raise @property def on_socket_register_write(self): """If implemented, called when the socket needs writing but can't.""" return self._on_socket_register_write @on_socket_register_write.setter def on_socket_register_write(self, func): """Define the socket_register_write callback implementation. This should be used to register the socket with an external event loop for writing. Expected signature is: socket_register_write_callback(client, userdata, socket) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() sock: the socket which should be registered for writing Decorator: @client.socket_register_write_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_socket_register_write = func def socket_register_write_callback(self): def decorator(func): self._on_socket_register_write = func return func return decorator def _call_socket_register_write(self): """Call the socket_register_write callback with the unwritable socket""" if not self._sock or self._registered_write: return self._registered_write = True with self._callback_mutex: on_socket_register_write = self.on_socket_register_write if on_socket_register_write: try: on_socket_register_write( self, self._userdata, self._sock) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_socket_register_write: %s', err) if not self.suppress_exceptions: raise @property def on_socket_unregister_write(self): """If implemented, called when the socket doesn't need writing anymore.""" return self._on_socket_unregister_write @on_socket_unregister_write.setter def on_socket_unregister_write(self, func): """Define the socket_unregister_write callback implementation. This should be used to unregister the socket from an external event loop for writing. Expected signature is: socket_unregister_write_callback(client, userdata, socket) client: the client instance for this callback userdata: the private user data as set in Client() or userdata_set() sock: the socket which should be unregistered for writing Decorator: @client.socket_unregister_write_callback() (```client``` is the name of the instance which this callback is being attached to) """ with self._callback_mutex: self._on_socket_unregister_write = func def socket_unregister_write_callback(self): def decorator(func): self._on_socket_unregister_write = func return func return decorator def _call_socket_unregister_write(self, sock=None): """Call the socket_unregister_write callback with the writable socket""" sock = sock or self._sock if not sock or not self._registered_write: return self._registered_write = False with self._callback_mutex: on_socket_unregister_write = self.on_socket_unregister_write if on_socket_unregister_write: try: on_socket_unregister_write(self, self._userdata, sock) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_socket_unregister_write: %s', err) if not self.suppress_exceptions: raise def message_callback_add(self, sub, callback): """Register a message callback for a specific topic. Messages that match 'sub' will be passed to 'callback'. Any non-matching messages will be passed to the default on_message callback. Call multiple times with different 'sub' to define multiple topic specific callbacks. Topic specific callbacks may be removed with message_callback_remove().""" if callback is None or sub is None: raise ValueError("sub and callback must both be defined.") with self._callback_mutex: self._on_message_filtered[sub] = callback def topic_callback(self, sub): def decorator(func): self.message_callback_add(sub, func) return func return decorator def message_callback_remove(self, sub): """Remove a message callback previously registered with message_callback_add().""" if sub is None: raise ValueError("sub must defined.") with self._callback_mutex: try: del self._on_message_filtered[sub] except KeyError: # no such subscription pass # ============================================================ # Private functions # ============================================================ def _loop_rc_handle(self, rc, properties=None): if rc: self._sock_close() if self._state == mqtt_cs_disconnecting: rc = MQTT_ERR_SUCCESS self._do_on_disconnect(rc, properties) return rc def _packet_read(self): # This gets called if pselect() indicates that there is network data # available - ie. at least one byte. What we do depends on what data we # already have. # If we've not got a command, attempt to read one and save it. This should # always work because it's only a single byte. # Then try to read the remaining length. This may fail because it is may # be more than one byte - will need to save data pending next read if it # does fail. # Then try to read the remaining payload, where 'payload' here means the # combined variable header and actual payload. This is the most likely to # fail due to longer length, so save current data and current position. # After all data is read, send to _mqtt_handle_packet() to deal with. # Finally, free the memory and reset everything to starting conditions. if self._in_packet['command'] == 0: try: command = self._sock_recv(1) except BlockingIOError: return MQTT_ERR_AGAIN except ConnectionError as err: self._easy_log( MQTT_LOG_ERR, 'failed to receive on socket: %s', err) return MQTT_ERR_CONN_LOST else: if len(command) == 0: return MQTT_ERR_CONN_LOST command, = struct.unpack("!B", command) self._in_packet['command'] = command if self._in_packet['have_remaining'] == 0: # Read remaining # Algorithm for decoding taken from pseudo code at # http://publib.boulder.ibm.com/infocenter/wmbhelp/v6r0m0/topic/com.ibm.etools.mft.doc/ac10870_.htm while True: try: byte = self._sock_recv(1) except BlockingIOError: return MQTT_ERR_AGAIN except ConnectionError as err: self._easy_log( MQTT_LOG_ERR, 'failed to receive on socket: %s', err) return MQTT_ERR_CONN_LOST else: if len(byte) == 0: return MQTT_ERR_CONN_LOST byte, = struct.unpack("!B", byte) self._in_packet['remaining_count'].append(byte) # Max 4 bytes length for remaining length as defined by protocol. # Anything more likely means a broken/malicious client. if len(self._in_packet['remaining_count']) > 4: return MQTT_ERR_PROTOCOL self._in_packet['remaining_length'] += ( byte & 127) * self._in_packet['remaining_mult'] self._in_packet['remaining_mult'] = self._in_packet['remaining_mult'] * 128 if (byte & 128) == 0: break self._in_packet['have_remaining'] = 1 self._in_packet['to_process'] = self._in_packet['remaining_length'] count = 100 # Don't get stuck in this loop if we have a huge message. while self._in_packet['to_process'] > 0: try: data = self._sock_recv(self._in_packet['to_process']) except BlockingIOError: return MQTT_ERR_AGAIN except ConnectionError as err: self._easy_log( MQTT_LOG_ERR, 'failed to receive on socket: %s', err) return MQTT_ERR_CONN_LOST else: if len(data) == 0: return MQTT_ERR_CONN_LOST self._in_packet['to_process'] -= len(data) self._in_packet['packet'] += data count -= 1 if count == 0: with self._msgtime_mutex: self._last_msg_in = time_func() return MQTT_ERR_AGAIN # All data for this packet is read. self._in_packet['pos'] = 0 rc = self._packet_handle() # Free data and reset values self._in_packet = { 'command': 0, 'have_remaining': 0, 'remaining_count': [], 'remaining_mult': 1, 'remaining_length': 0, 'packet': bytearray(b""), 'to_process': 0, 'pos': 0} with self._msgtime_mutex: self._last_msg_in = time_func() return rc def _packet_write(self): while True: try: packet = self._out_packet.popleft() except IndexError: return MQTT_ERR_SUCCESS try: write_length = self._sock_send( packet['packet'][packet['pos']:]) except (AttributeError, ValueError): self._out_packet.appendleft(packet) return MQTT_ERR_SUCCESS except BlockingIOError: self._out_packet.appendleft(packet) return MQTT_ERR_AGAIN except ConnectionError as err: self._out_packet.appendleft(packet) self._easy_log( MQTT_LOG_ERR, 'failed to receive on socket: %s', err) return MQTT_ERR_CONN_LOST if write_length > 0: packet['to_process'] -= write_length packet['pos'] += write_length if packet['to_process'] == 0: if (packet['command'] & 0xF0) == PUBLISH and packet['qos'] == 0: with self._callback_mutex: on_publish = self.on_publish if on_publish: with self._in_callback_mutex: try: on_publish( self, self._userdata, packet['mid']) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_publish: %s', err) if not self.suppress_exceptions: raise packet['info']._set_as_published() if (packet['command'] & 0xF0) == DISCONNECT: with self._msgtime_mutex: self._last_msg_out = time_func() self._do_on_disconnect(MQTT_ERR_SUCCESS) self._sock_close() return MQTT_ERR_SUCCESS else: # We haven't finished with this packet self._out_packet.appendleft(packet) else: break with self._msgtime_mutex: self._last_msg_out = time_func() return MQTT_ERR_SUCCESS def _easy_log(self, level, fmt, *args): if self.on_log is not None: buf = fmt % args try: self.on_log(self, self._userdata, level, buf) except Exception: # Can't _easy_log this, as we'll recurse until we break pass # self._logger will pick this up, so we're fine if self._logger is not None: level_std = LOGGING_LEVEL[level] self._logger.log(level_std, fmt, *args) def _check_keepalive(self): if self._keepalive == 0: return MQTT_ERR_SUCCESS now = time_func() with self._msgtime_mutex: last_msg_out = self._last_msg_out last_msg_in = self._last_msg_in if self._sock is not None and (now - last_msg_out >= self._keepalive or now - last_msg_in >= self._keepalive): if self._state == mqtt_cs_connected and self._ping_t == 0: try: self._send_pingreq() except Exception: self._sock_close() self._do_on_disconnect(MQTT_ERR_CONN_LOST) else: with self._msgtime_mutex: self._last_msg_out = now self._last_msg_in = now else: self._sock_close() if self._state == mqtt_cs_disconnecting: rc = MQTT_ERR_SUCCESS else: rc = MQTT_ERR_KEEPALIVE self._do_on_disconnect(rc) def _mid_generate(self): with self._mid_generate_mutex: self._last_mid += 1 if self._last_mid == 65536: self._last_mid = 1 return self._last_mid @staticmethod def _topic_wildcard_len_check(topic): # Search for + or # in a topic. Return MQTT_ERR_INVAL if found. # Also returns MQTT_ERR_INVAL if the topic string is too long. # Returns MQTT_ERR_SUCCESS if everything is fine. if b'+' in topic or b'#' in topic or len(topic) > 65535: return MQTT_ERR_INVAL else: return MQTT_ERR_SUCCESS @staticmethod def _filter_wildcard_len_check(sub): if (len(sub) == 0 or len(sub) > 65535 or any(b'+' in p or b'#' in p for p in sub.split(b'/') if len(p) > 1) or b'#/' in sub): return MQTT_ERR_INVAL else: return MQTT_ERR_SUCCESS def _send_pingreq(self): self._easy_log(MQTT_LOG_DEBUG, "Sending PINGREQ") rc = self._send_simple_command(PINGREQ) if rc == MQTT_ERR_SUCCESS: self._ping_t = time_func() return rc def _send_pingresp(self): self._easy_log(MQTT_LOG_DEBUG, "Sending PINGRESP") return self._send_simple_command(PINGRESP) def _send_puback(self, mid): self._easy_log(MQTT_LOG_DEBUG, "Sending PUBACK (Mid: %d)", mid) return self._send_command_with_mid(PUBACK, mid, False) def _send_pubcomp(self, mid): self._easy_log(MQTT_LOG_DEBUG, "Sending PUBCOMP (Mid: %d)", mid) return self._send_command_with_mid(PUBCOMP, mid, False) def _pack_remaining_length(self, packet, remaining_length): remaining_bytes = [] while True: byte = remaining_length % 128 remaining_length = remaining_length // 128 # If there are more digits to encode, set the top bit of this digit if remaining_length > 0: byte |= 0x80 remaining_bytes.append(byte) packet.append(byte) if remaining_length == 0: # FIXME - this doesn't deal with incorrectly large payloads return packet def _pack_str16(self, packet, data): if isinstance(data, unicode): data = data.encode('utf-8') packet.extend(struct.pack("!H", len(data))) packet.extend(data) def _send_publish(self, mid, topic, payload=b'', qos=0, retain=False, dup=False, info=None, properties=None): # we assume that topic and payload are already properly encoded assert not isinstance(topic, unicode) and not isinstance( payload, unicode) and payload is not None if self._sock is None: return MQTT_ERR_NO_CONN command = PUBLISH | ((dup & 0x1) << 3) | (qos << 1) | retain packet = bytearray() packet.append(command) payloadlen = len(payload) remaining_length = 2 + len(topic) + payloadlen if payloadlen == 0: if self._protocol == MQTTv5: self._easy_log( MQTT_LOG_DEBUG, "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s', properties=%s (NULL payload)", dup, qos, retain, mid, topic, properties ) else: self._easy_log( MQTT_LOG_DEBUG, "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s' (NULL payload)", dup, qos, retain, mid, topic ) else: if self._protocol == MQTTv5: self._easy_log( MQTT_LOG_DEBUG, "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s', properties=%s, ... (%d bytes)", dup, qos, retain, mid, topic, properties, payloadlen ) else: self._easy_log( MQTT_LOG_DEBUG, "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s', ... (%d bytes)", dup, qos, retain, mid, topic, payloadlen ) if qos > 0: # For message id remaining_length += 2 if self._protocol == MQTTv5: if properties is None: packed_properties = b'\x00' else: packed_properties = properties.pack() remaining_length += len(packed_properties) self._pack_remaining_length(packet, remaining_length) self._pack_str16(packet, topic) if qos > 0: # For message id packet.extend(struct.pack("!H", mid)) if self._protocol == MQTTv5: packet.extend(packed_properties) packet.extend(payload) return self._packet_queue(PUBLISH, packet, mid, qos, info) def _send_pubrec(self, mid): self._easy_log(MQTT_LOG_DEBUG, "Sending PUBREC (Mid: %d)", mid) return self._send_command_with_mid(PUBREC, mid, False) def _send_pubrel(self, mid): self._easy_log(MQTT_LOG_DEBUG, "Sending PUBREL (Mid: %d)", mid) return self._send_command_with_mid(PUBREL | 2, mid, False) def _send_command_with_mid(self, command, mid, dup): # For PUBACK, PUBCOMP, PUBREC, and PUBREL if dup: command |= 0x8 remaining_length = 2 packet = struct.pack('!BBH', command, remaining_length, mid) return self._packet_queue(command, packet, mid, 1) def _send_simple_command(self, command): # For DISCONNECT, PINGREQ and PINGRESP remaining_length = 0 packet = struct.pack('!BB', command, remaining_length) return self._packet_queue(command, packet, 0, 0) def _send_connect(self, keepalive): proto_ver = self._protocol # hard-coded UTF-8 encoded string protocol = b"MQTT" if proto_ver >= MQTTv311 else b"MQIsdp" remaining_length = 2 + len(protocol) + 1 + \ 1 + 2 + 2 + len(self._client_id) connect_flags = 0 if self._protocol == MQTTv5: if self._clean_start == True: connect_flags |= 0x02 elif self._clean_start == MQTT_CLEAN_START_FIRST_ONLY and self._mqttv5_first_connect: connect_flags |= 0x02 elif self._clean_session: connect_flags |= 0x02 if self._will: remaining_length += 2 + \ len(self._will_topic) + 2 + len(self._will_payload) connect_flags |= 0x04 | ((self._will_qos & 0x03) << 3) | ( (self._will_retain & 0x01) << 5) if self._username is not None: remaining_length += 2 + len(self._username) connect_flags |= 0x80 if self._password is not None: connect_flags |= 0x40 remaining_length += 2 + len(self._password) if self._protocol == MQTTv5: if self._connect_properties is None: packed_connect_properties = b'\x00' else: packed_connect_properties = self._connect_properties.pack() remaining_length += len(packed_connect_properties) if self._will: if self._will_properties is None: packed_will_properties = b'\x00' else: packed_will_properties = self._will_properties.pack() remaining_length += len(packed_will_properties) command = CONNECT packet = bytearray() packet.append(command) # as per the mosquitto broker, if the MSB of this version is set # to 1, then it treats the connection as a bridge if self._client_mode == MQTT_BRIDGE: proto_ver |= 0x80 self._pack_remaining_length(packet, remaining_length) packet.extend(struct.pack("!H" + str(len(protocol)) + "sBBH", len(protocol), protocol, proto_ver, connect_flags, keepalive)) if self._protocol == MQTTv5: packet += packed_connect_properties self._pack_str16(packet, self._client_id) if self._will: if self._protocol == MQTTv5: packet += packed_will_properties self._pack_str16(packet, self._will_topic) self._pack_str16(packet, self._will_payload) if self._username is not None: self._pack_str16(packet, self._username) if self._password is not None: self._pack_str16(packet, self._password) self._keepalive = keepalive if self._protocol == MQTTv5: self._easy_log( MQTT_LOG_DEBUG, "Sending CONNECT (u%d, p%d, wr%d, wq%d, wf%d, c%d, k%d) client_id=%s properties=%s", (connect_flags & 0x80) >> 7, (connect_flags & 0x40) >> 6, (connect_flags & 0x20) >> 5, (connect_flags & 0x18) >> 3, (connect_flags & 0x4) >> 2, (connect_flags & 0x2) >> 1, keepalive, self._client_id, self._connect_properties ) else: self._easy_log( MQTT_LOG_DEBUG, "Sending CONNECT (u%d, p%d, wr%d, wq%d, wf%d, c%d, k%d) client_id=%s", (connect_flags & 0x80) >> 7, (connect_flags & 0x40) >> 6, (connect_flags & 0x20) >> 5, (connect_flags & 0x18) >> 3, (connect_flags & 0x4) >> 2, (connect_flags & 0x2) >> 1, keepalive, self._client_id ) return self._packet_queue(command, packet, 0, 0) def _send_disconnect(self, reasoncode=None, properties=None): if self._protocol == MQTTv5: self._easy_log(MQTT_LOG_DEBUG, "Sending DISCONNECT reasonCode=%s properties=%s", reasoncode, properties ) else: self._easy_log(MQTT_LOG_DEBUG, "Sending DISCONNECT") remaining_length = 0 command = DISCONNECT packet = bytearray() packet.append(command) if self._protocol == MQTTv5: if properties is not None or reasoncode is not None: if reasoncode is None: reasoncode = ReasonCodes(DISCONNECT >> 4, identifier=0) remaining_length += 1 if properties is not None: packed_props = properties.pack() remaining_length += len(packed_props) self._pack_remaining_length(packet, remaining_length) if self._protocol == MQTTv5: if reasoncode != None: packet += reasoncode.pack() if properties != None: packet += packed_props return self._packet_queue(command, packet, 0, 0) def _send_subscribe(self, dup, topics, properties=None): remaining_length = 2 if self._protocol == MQTTv5: if properties is None: packed_subscribe_properties = b'\x00' else: packed_subscribe_properties = properties.pack() remaining_length += len(packed_subscribe_properties) for t, _ in topics: remaining_length += 2 + len(t) + 1 command = SUBSCRIBE | (dup << 3) | 0x2 packet = bytearray() packet.append(command) self._pack_remaining_length(packet, remaining_length) local_mid = self._mid_generate() packet.extend(struct.pack("!H", local_mid)) if self._protocol == MQTTv5: packet += packed_subscribe_properties for t, q in topics: self._pack_str16(packet, t) if self._protocol == MQTTv5: packet += q.pack() else: packet.append(q) self._easy_log( MQTT_LOG_DEBUG, "Sending SUBSCRIBE (d%d, m%d) %s", dup, local_mid, topics, ) return (self._packet_queue(command, packet, local_mid, 1), local_mid) def _send_unsubscribe(self, dup, topics, properties=None): remaining_length = 2 if self._protocol == MQTTv5: if properties is None: packed_unsubscribe_properties = b'\x00' else: packed_unsubscribe_properties = properties.pack() remaining_length += len(packed_unsubscribe_properties) for t in topics: remaining_length += 2 + len(t) command = UNSUBSCRIBE | (dup << 3) | 0x2 packet = bytearray() packet.append(command) self._pack_remaining_length(packet, remaining_length) local_mid = self._mid_generate() packet.extend(struct.pack("!H", local_mid)) if self._protocol == MQTTv5: packet += packed_unsubscribe_properties for t in topics: self._pack_str16(packet, t) # topics_repr = ", ".join("'"+topic.decode('utf8')+"'" for topic in topics) if self._protocol == MQTTv5: self._easy_log( MQTT_LOG_DEBUG, "Sending UNSUBSCRIBE (d%d, m%d) %s %s", dup, local_mid, properties, topics, ) else: self._easy_log( MQTT_LOG_DEBUG, "Sending UNSUBSCRIBE (d%d, m%d) %s", dup, local_mid, topics, ) return (self._packet_queue(command, packet, local_mid, 1), local_mid) def _check_clean_session(self): if self._protocol == MQTTv5: if self._clean_start == MQTT_CLEAN_START_FIRST_ONLY: return self._mqttv5_first_connect else: return self._clean_start else: return self._clean_session def _messages_reconnect_reset_out(self): with self._out_message_mutex: self._inflight_messages = 0 for m in self._out_messages.values(): m.timestamp = 0 if self._max_inflight_messages == 0 or self._inflight_messages < self._max_inflight_messages: if m.qos == 0: m.state = mqtt_ms_publish elif m.qos == 1: # self._inflight_messages = self._inflight_messages + 1 if m.state == mqtt_ms_wait_for_puback: m.dup = True m.state = mqtt_ms_publish elif m.qos == 2: # self._inflight_messages = self._inflight_messages + 1 if self._check_clean_session(): if m.state != mqtt_ms_publish: m.dup = True m.state = mqtt_ms_publish else: if m.state == mqtt_ms_wait_for_pubcomp: m.state = mqtt_ms_resend_pubrel else: if m.state == mqtt_ms_wait_for_pubrec: m.dup = True m.state = mqtt_ms_publish else: m.state = mqtt_ms_queued def _messages_reconnect_reset_in(self): with self._in_message_mutex: if self._check_clean_session(): self._in_messages = collections.OrderedDict() return for m in self._in_messages.values(): m.timestamp = 0 if m.qos != 2: self._in_messages.pop(m.mid) else: # Preserve current state pass def _messages_reconnect_reset(self): self._messages_reconnect_reset_out() self._messages_reconnect_reset_in() def _packet_queue(self, command, packet, mid, qos, info=None): mpkt = { 'command': command, 'mid': mid, 'qos': qos, 'pos': 0, 'to_process': len(packet), 'packet': packet, 'info': info} self._out_packet.append(mpkt) # Write a single byte to sockpairW (connected to sockpairR) to break # out of select() if in threaded mode. if self._sockpairW is not None: try: self._sockpairW.send(sockpair_data) except BlockingIOError: pass # If we have an external event loop registered, use that instead # of calling loop_write() directly. if self._thread is None and self._on_socket_register_write is None: if self._in_callback_mutex.acquire(False): self._in_callback_mutex.release() return self.loop_write() self._call_socket_register_write() return MQTT_ERR_SUCCESS def _packet_handle(self): cmd = self._in_packet['command'] & 0xF0 if cmd == PINGREQ: return self._handle_pingreq() elif cmd == PINGRESP: return self._handle_pingresp() elif cmd == PUBACK: return self._handle_pubackcomp("PUBACK") elif cmd == PUBCOMP: return self._handle_pubackcomp("PUBCOMP") elif cmd == PUBLISH: return self._handle_publish() elif cmd == PUBREC: return self._handle_pubrec() elif cmd == PUBREL: return self._handle_pubrel() elif cmd == CONNACK: return self._handle_connack() elif cmd == SUBACK: return self._handle_suback() elif cmd == UNSUBACK: return self._handle_unsuback() elif cmd == DISCONNECT and self._protocol == MQTTv5: # only allowed in MQTT 5.0 return self._handle_disconnect() else: # If we don't recognise the command, return an error straight away. self._easy_log(MQTT_LOG_ERR, "Error: Unrecognised command %s", cmd) return MQTT_ERR_PROTOCOL def _handle_pingreq(self): if self._in_packet['remaining_length'] != 0: return MQTT_ERR_PROTOCOL self._easy_log(MQTT_LOG_DEBUG, "Received PINGREQ") return self._send_pingresp() def _handle_pingresp(self): if self._in_packet['remaining_length'] != 0: return MQTT_ERR_PROTOCOL # No longer waiting for a PINGRESP. self._ping_t = 0 self._easy_log(MQTT_LOG_DEBUG, "Received PINGRESP") return MQTT_ERR_SUCCESS def _handle_connack(self): if self._protocol == MQTTv5: if self._in_packet['remaining_length'] < 2: return MQTT_ERR_PROTOCOL elif self._in_packet['remaining_length'] != 2: return MQTT_ERR_PROTOCOL if self._protocol == MQTTv5: (flags, result) = struct.unpack( "!BB", self._in_packet['packet'][:2]) if result == 1: # This is probably a failure from a broker that doesn't support # MQTT v5. reason = 132 # Unsupported protocol version properties = None else: reason = ReasonCodes(CONNACK >> 4, identifier=result) properties = Properties(CONNACK >> 4) properties.unpack(self._in_packet['packet'][2:]) else: (flags, result) = struct.unpack("!BB", self._in_packet['packet']) if self._protocol == MQTTv311: if result == CONNACK_REFUSED_PROTOCOL_VERSION: if not self._reconnect_on_failure: return MQTT_ERR_PROTOCOL self._easy_log( MQTT_LOG_DEBUG, "Received CONNACK (%s, %s), attempting downgrade to MQTT v3.1.", flags, result ) # Downgrade to MQTT v3.1 self._protocol = MQTTv31 return self.reconnect() elif (result == CONNACK_REFUSED_IDENTIFIER_REJECTED and self._client_id == b''): if not self._reconnect_on_failure: return MQTT_ERR_PROTOCOL self._easy_log( MQTT_LOG_DEBUG, "Received CONNACK (%s, %s), attempting to use non-empty CID", flags, result, ) self._client_id = base62(uuid.uuid4().int, padding=22) return self.reconnect() if result == 0: self._state = mqtt_cs_connected self._reconnect_delay = None if self._protocol == MQTTv5: self._easy_log( MQTT_LOG_DEBUG, "Received CONNACK (%s, %s) properties=%s", flags, reason, properties) else: self._easy_log( MQTT_LOG_DEBUG, "Received CONNACK (%s, %s)", flags, result) # it won't be the first successful connect any more self._mqttv5_first_connect = False with self._callback_mutex: on_connect = self.on_connect if on_connect: flags_dict = {} flags_dict['session present'] = flags & 0x01 with self._in_callback_mutex: try: if self._protocol == MQTTv5: on_connect(self, self._userdata, flags_dict, reason, properties) else: on_connect( self, self._userdata, flags_dict, result) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_connect: %s', err) if not self.suppress_exceptions: raise if result == 0: rc = 0 with self._out_message_mutex: for m in self._out_messages.values(): m.timestamp = time_func() if m.state == mqtt_ms_queued: self.loop_write() # Process outgoing messages that have just been queued up return MQTT_ERR_SUCCESS if m.qos == 0: with self._in_callback_mutex: # Don't call loop_write after _send_publish() rc = self._send_publish( m.mid, m.topic.encode('utf-8'), m.payload, m.qos, m.retain, m.dup, properties=m.properties ) if rc != 0: return rc elif m.qos == 1: if m.state == mqtt_ms_publish: self._inflight_messages += 1 m.state = mqtt_ms_wait_for_puback with self._in_callback_mutex: # Don't call loop_write after _send_publish() rc = self._send_publish( m.mid, m.topic.encode('utf-8'), m.payload, m.qos, m.retain, m.dup, properties=m.properties ) if rc != 0: return rc elif m.qos == 2: if m.state == mqtt_ms_publish: self._inflight_messages += 1 m.state = mqtt_ms_wait_for_pubrec with self._in_callback_mutex: # Don't call loop_write after _send_publish() rc = self._send_publish( m.mid, m.topic.encode('utf-8'), m.payload, m.qos, m.retain, m.dup, properties=m.properties ) if rc != 0: return rc elif m.state == mqtt_ms_resend_pubrel: self._inflight_messages += 1 m.state = mqtt_ms_wait_for_pubcomp with self._in_callback_mutex: # Don't call loop_write after _send_publish() rc = self._send_pubrel(m.mid) if rc != 0: return rc self.loop_write() # Process outgoing messages that have just been queued up return rc elif result > 0 and result < 6: return MQTT_ERR_CONN_REFUSED else: return MQTT_ERR_PROTOCOL def _handle_disconnect(self): packet_type = DISCONNECT >> 4 reasonCode = properties = None if self._in_packet['remaining_length'] > 2: reasonCode = ReasonCodes(packet_type) reasonCode.unpack(self._in_packet['packet']) if self._in_packet['remaining_length'] > 3: properties = Properties(packet_type) props, props_len = properties.unpack( self._in_packet['packet'][1:]) self._easy_log(MQTT_LOG_DEBUG, "Received DISCONNECT %s %s", reasonCode, properties ) self._loop_rc_handle(reasonCode, properties) return MQTT_ERR_SUCCESS def _handle_suback(self): self._easy_log(MQTT_LOG_DEBUG, "Received SUBACK") pack_format = "!H" + str(len(self._in_packet['packet']) - 2) + 's' (mid, packet) = struct.unpack(pack_format, self._in_packet['packet']) if self._protocol == MQTTv5: properties = Properties(SUBACK >> 4) props, props_len = properties.unpack(packet) reasoncodes = [] for c in packet[props_len:]: if sys.version_info[0] < 3: c = ord(c) reasoncodes.append(ReasonCodes(SUBACK >> 4, identifier=c)) else: pack_format = "!" + "B" * len(packet) granted_qos = struct.unpack(pack_format, packet) with self._callback_mutex: on_subscribe = self.on_subscribe if on_subscribe: with self._in_callback_mutex: # Don't call loop_write after _send_publish() try: if self._protocol == MQTTv5: on_subscribe( self, self._userdata, mid, reasoncodes, properties) else: on_subscribe( self, self._userdata, mid, granted_qos) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_subscribe: %s', err) if not self.suppress_exceptions: raise return MQTT_ERR_SUCCESS def _handle_publish(self): rc = 0 header = self._in_packet['command'] message = MQTTMessage() message.dup = (header & 0x08) >> 3 message.qos = (header & 0x06) >> 1 message.retain = (header & 0x01) pack_format = "!H" + str(len(self._in_packet['packet']) - 2) + 's' (slen, packet) = struct.unpack(pack_format, self._in_packet['packet']) pack_format = '!' + str(slen) + 's' + str(len(packet) - slen) + 's' (topic, packet) = struct.unpack(pack_format, packet) if self._protocol != MQTTv5 and len(topic) == 0: return MQTT_ERR_PROTOCOL # Handle topics with invalid UTF-8 # This replaces an invalid topic with a message and the hex # representation of the topic for logging. When the user attempts to # access message.topic in the callback, an exception will be raised. try: print_topic = topic.decode('utf-8') except UnicodeDecodeError: print_topic = "TOPIC WITH INVALID UTF-8: " + str(topic) message.topic = topic if message.qos > 0: pack_format = "!H" + str(len(packet) - 2) + 's' (message.mid, packet) = struct.unpack(pack_format, packet) if self._protocol == MQTTv5: message.properties = Properties(PUBLISH >> 4) props, props_len = message.properties.unpack(packet) packet = packet[props_len:] message.payload = packet if self._protocol == MQTTv5: self._easy_log( MQTT_LOG_DEBUG, "Received PUBLISH (d%d, q%d, r%d, m%d), '%s', properties=%s, ... (%d bytes)", message.dup, message.qos, message.retain, message.mid, print_topic, message.properties, len(message.payload) ) else: self._easy_log( MQTT_LOG_DEBUG, "Received PUBLISH (d%d, q%d, r%d, m%d), '%s', ... (%d bytes)", message.dup, message.qos, message.retain, message.mid, print_topic, len(message.payload) ) message.timestamp = time_func() if message.qos == 0: self._handle_on_message(message) return MQTT_ERR_SUCCESS elif message.qos == 1: self._handle_on_message(message) return self._send_puback(message.mid) elif message.qos == 2: rc = self._send_pubrec(message.mid) message.state = mqtt_ms_wait_for_pubrel with self._in_message_mutex: self._in_messages[message.mid] = message return rc else: return MQTT_ERR_PROTOCOL def _handle_pubrel(self): if self._protocol == MQTTv5: if self._in_packet['remaining_length'] < 2: return MQTT_ERR_PROTOCOL elif self._in_packet['remaining_length'] != 2: return MQTT_ERR_PROTOCOL mid, = struct.unpack("!H", self._in_packet['packet']) self._easy_log(MQTT_LOG_DEBUG, "Received PUBREL (Mid: %d)", mid) with self._in_message_mutex: if mid in self._in_messages: # Only pass the message on if we have removed it from the queue - this # prevents multiple callbacks for the same message. message = self._in_messages.pop(mid) self._handle_on_message(message) self._inflight_messages -= 1 if self._max_inflight_messages > 0: with self._out_message_mutex: rc = self._update_inflight() if rc != MQTT_ERR_SUCCESS: return rc # FIXME: this should only be done if the message is known # If unknown it's a protocol error and we should close the connection. # But since we don't have (on disk) persistence for the session, it # is possible that we must known about this message. # Choose to acknwoledge this messsage (and thus losing a message) but # avoid hanging. See #284. return self._send_pubcomp(mid) def _update_inflight(self): # Dont lock message_mutex here for m in self._out_messages.values(): if self._inflight_messages < self._max_inflight_messages: if m.qos > 0 and m.state == mqtt_ms_queued: self._inflight_messages += 1 if m.qos == 1: m.state = mqtt_ms_wait_for_puback elif m.qos == 2: m.state = mqtt_ms_wait_for_pubrec rc = self._send_publish( m.mid, m.topic.encode('utf-8'), m.payload, m.qos, m.retain, m.dup, properties=m.properties, ) if rc != 0: return rc else: return MQTT_ERR_SUCCESS return MQTT_ERR_SUCCESS def _handle_pubrec(self): if self._protocol == MQTTv5: if self._in_packet['remaining_length'] < 2: return MQTT_ERR_PROTOCOL elif self._in_packet['remaining_length'] != 2: return MQTT_ERR_PROTOCOL mid, = struct.unpack("!H", self._in_packet['packet'][:2]) if self._protocol == MQTTv5: if self._in_packet['remaining_length'] > 2: reasonCode = ReasonCodes(PUBREC >> 4) reasonCode.unpack(self._in_packet['packet'][2:]) if self._in_packet['remaining_length'] > 3: properties = Properties(PUBREC >> 4) props, props_len = properties.unpack( self._in_packet['packet'][3:]) self._easy_log(MQTT_LOG_DEBUG, "Received PUBREC (Mid: %d)", mid) with self._out_message_mutex: if mid in self._out_messages: msg = self._out_messages[mid] msg.state = mqtt_ms_wait_for_pubcomp msg.timestamp = time_func() return self._send_pubrel(mid) return MQTT_ERR_SUCCESS def _handle_unsuback(self): if self._protocol == MQTTv5: if self._in_packet['remaining_length'] < 4: return MQTT_ERR_PROTOCOL elif self._in_packet['remaining_length'] != 2: return MQTT_ERR_PROTOCOL mid, = struct.unpack("!H", self._in_packet['packet'][:2]) if self._protocol == MQTTv5: packet = self._in_packet['packet'][2:] properties = Properties(UNSUBACK >> 4) props, props_len = properties.unpack(packet) reasoncodes = [] for c in packet[props_len:]: if sys.version_info[0] < 3: c = ord(c) reasoncodes.append(ReasonCodes(UNSUBACK >> 4, identifier=c)) if len(reasoncodes) == 1: reasoncodes = reasoncodes[0] self._easy_log(MQTT_LOG_DEBUG, "Received UNSUBACK (Mid: %d)", mid) with self._callback_mutex: on_unsubscribe = self.on_unsubscribe if on_unsubscribe: with self._in_callback_mutex: try: if self._protocol == MQTTv5: on_unsubscribe( self, self._userdata, mid, properties, reasoncodes) else: on_unsubscribe(self, self._userdata, mid) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_unsubscribe: %s', err) if not self.suppress_exceptions: raise return MQTT_ERR_SUCCESS def _do_on_disconnect(self, rc, properties=None): with self._callback_mutex: on_disconnect = self.on_disconnect if on_disconnect: with self._in_callback_mutex: try: if self._protocol == MQTTv5: on_disconnect( self, self._userdata, rc, properties) else: on_disconnect(self, self._userdata, rc) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_disconnect: %s', err) if not self.suppress_exceptions: raise def _do_on_publish(self, mid): with self._callback_mutex: on_publish = self.on_publish if on_publish: with self._in_callback_mutex: try: on_publish(self, self._userdata, mid) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_publish: %s', err) if not self.suppress_exceptions: raise msg = self._out_messages.pop(mid) msg.info._set_as_published() if msg.qos > 0: self._inflight_messages -= 1 if self._max_inflight_messages > 0: rc = self._update_inflight() if rc != MQTT_ERR_SUCCESS: return rc return MQTT_ERR_SUCCESS def _handle_pubackcomp(self, cmd): if self._protocol == MQTTv5: if self._in_packet['remaining_length'] < 2: return MQTT_ERR_PROTOCOL elif self._in_packet['remaining_length'] != 2: return MQTT_ERR_PROTOCOL packet_type = PUBACK if cmd == "PUBACK" else PUBCOMP packet_type = packet_type >> 4 mid, = struct.unpack("!H", self._in_packet['packet'][:2]) if self._protocol == MQTTv5: if self._in_packet['remaining_length'] > 2: reasonCode = ReasonCodes(packet_type) reasonCode.unpack(self._in_packet['packet'][2:]) if self._in_packet['remaining_length'] > 3: properties = Properties(packet_type) props, props_len = properties.unpack( self._in_packet['packet'][3:]) self._easy_log(MQTT_LOG_DEBUG, "Received %s (Mid: %d)", cmd, mid) with self._out_message_mutex: if mid in self._out_messages: # Only inform the client the message has been sent once. rc = self._do_on_publish(mid) return rc return MQTT_ERR_SUCCESS def _handle_on_message(self, message): matched = False try: topic = message.topic except UnicodeDecodeError: topic = None on_message_callbacks = [] with self._callback_mutex: if topic is not None: for callback in self._on_message_filtered.iter_match(message.topic): on_message_callbacks.append(callback) if len(on_message_callbacks) == 0: on_message = self.on_message else: on_message = None for callback in on_message_callbacks: with self._in_callback_mutex: try: callback(self, self._userdata, message) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in user defined callback function %s: %s', callback.__name__, err ) if not self.suppress_exceptions: raise if on_message: with self._in_callback_mutex: try: on_message(self, self._userdata, message) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_message: %s', err) if not self.suppress_exceptions: raise def _handle_on_connect_fail(self): with self._callback_mutex: on_connect_fail = self.on_connect_fail if on_connect_fail: with self._in_callback_mutex: try: on_connect_fail(self, self._userdata) except Exception as err: self._easy_log( MQTT_LOG_ERR, 'Caught exception in on_connect_fail: %s', err) def _thread_main(self): self.loop_forever(retry_first_connection=True) def _reconnect_wait(self): # See reconnect_delay_set for details now = time_func() with self._reconnect_delay_mutex: if self._reconnect_delay is None: self._reconnect_delay = self._reconnect_min_delay else: self._reconnect_delay = min( self._reconnect_delay * 2, self._reconnect_max_delay, ) target_time = now + self._reconnect_delay remaining = target_time - now while (self._state != mqtt_cs_disconnecting and not self._thread_terminate and remaining > 0): time.sleep(min(remaining, 1)) remaining = target_time - time_func() @staticmethod def _proxy_is_valid(p): def check(t, a): return (socks is not None and t in set([socks.HTTP, socks.SOCKS4, socks.SOCKS5]) and a) if isinstance(p, dict): return check(p.get("proxy_type"), p.get("proxy_addr")) elif isinstance(p, (list, tuple)): return len(p) == 6 and check(p[0], p[1]) else: return False def _get_proxy(self): if socks is None: return None # First, check if the user explicitly passed us a proxy to use if self._proxy_is_valid(self._proxy): return self._proxy # Next, check for an mqtt_proxy environment variable as long as the host # we're trying to connect to isn't listed under the no_proxy environment # variable (matches built-in module urllib's behavior) if not (hasattr(urllib_dot_request, "proxy_bypass") and urllib_dot_request.proxy_bypass(self._host)): env_proxies = urllib_dot_request.getproxies() if "mqtt" in env_proxies: parts = urllib_dot_parse.urlparse(env_proxies["mqtt"]) if parts.scheme == "http": proxy = { "proxy_type": socks.HTTP, "proxy_addr": parts.hostname, "proxy_port": parts.port } return proxy elif parts.scheme == "socks": proxy = { "proxy_type": socks.SOCKS5, "proxy_addr": parts.hostname, "proxy_port": parts.port } return proxy # Finally, check if the user has monkeypatched the PySocks library with # a default proxy socks_default = socks.get_default_proxy() if self._proxy_is_valid(socks_default): proxy_keys = ("proxy_type", "proxy_addr", "proxy_port", "proxy_rdns", "proxy_username", "proxy_password") return dict(zip(proxy_keys, socks_default)) # If we didn't find a proxy through any of the above methods, return # None to indicate that the connection should be handled normally return None def _create_socket_connection(self): proxy = self._get_proxy() addr = (self._host, self._port) source = (self._bind_address, self._bind_port) if sys.version_info < (2, 7) or (3, 0) < sys.version_info < (3, 2): # Have to short-circuit here because of unsupported source_address # param in earlier Python versions. return socket.create_connection(addr, timeout=self._connect_timeout) if proxy: return socks.create_connection(addr, timeout=self._connect_timeout, source_address=source, **proxy) else: return socket.create_connection(addr, timeout=self._connect_timeout, source_address=source) class WebsocketWrapper(object): OPCODE_CONTINUATION = 0x0 OPCODE_TEXT = 0x1 OPCODE_BINARY = 0x2 OPCODE_CONNCLOSE = 0x8 OPCODE_PING = 0x9 OPCODE_PONG = 0xa def __init__(self, socket, host, port, is_ssl, path, extra_headers): self.connected = False self._ssl = is_ssl self._host = host self._port = port self._socket = socket self._path = path self._sendbuffer = bytearray() self._readbuffer = bytearray() self._requested_size = 0 self._payload_head = 0 self._readbuffer_head = 0 self._do_handshake(extra_headers) def __del__(self): self._sendbuffer = None self._readbuffer = None def _do_handshake(self, extra_headers): sec_websocket_key = uuid.uuid4().bytes sec_websocket_key = base64.b64encode(sec_websocket_key) websocket_headers = { "Host": "{self._host:s}:{self._port:d}".format(self=self), "Upgrade": "websocket", "Connection": "Upgrade", "Origin": "https://{self._host:s}:{self._port:d}".format(self=self), "Sec-WebSocket-Key": sec_websocket_key.decode("utf8"), "Sec-Websocket-Version": "13", "Sec-Websocket-Protocol": "mqtt", } # This is checked in ws_set_options so it will either be None, a # dictionary, or a callable if isinstance(extra_headers, dict): websocket_headers.update(extra_headers) elif callable(extra_headers): websocket_headers = extra_headers(websocket_headers) header = "\r\n".join([ "GET {self._path} HTTP/1.1".format(self=self), "\r\n".join("{}: {}".format(i, j) for i, j in websocket_headers.items()), "\r\n", ]).encode("utf8") self._socket.send(header) has_secret = False has_upgrade = False while True: # read HTTP response header as lines byte = self._socket.recv(1) self._readbuffer.extend(byte) # line end if byte == b"\n": if len(self._readbuffer) > 2: # check upgrade if b"connection" in str(self._readbuffer).lower().encode('utf-8'): if b"upgrade" not in str(self._readbuffer).lower().encode('utf-8'): raise WebsocketConnectionError( "WebSocket handshake error, connection not upgraded") else: has_upgrade = True # check key hash if b"sec-websocket-accept" in str(self._readbuffer).lower().encode('utf-8'): GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11" server_hash = self._readbuffer.decode( 'utf-8').split(": ", 1)[1] server_hash = server_hash.strip().encode('utf-8') client_hash = sec_websocket_key.decode('utf-8') + GUID client_hash = hashlib.sha1(client_hash.encode('utf-8')) client_hash = base64.b64encode(client_hash.digest()) if server_hash != client_hash: raise WebsocketConnectionError( "WebSocket handshake error, invalid secret key") else: has_secret = True else: # ending linebreak break # reset linebuffer self._readbuffer = bytearray() # connection reset elif not byte: raise WebsocketConnectionError("WebSocket handshake error") if not has_upgrade or not has_secret: raise WebsocketConnectionError("WebSocket handshake error") self._readbuffer = bytearray() self.connected = True def _create_frame(self, opcode, data, do_masking=1): header = bytearray() length = len(data) mask_key = bytearray(os.urandom(4)) mask_flag = do_masking # 1 << 7 is the final flag, we don't send continuated data header.append(1 << 7 | opcode) if length < 126: header.append(mask_flag << 7 | length) elif length < 65536: header.append(mask_flag << 7 | 126) header += struct.pack("!H", length) elif length < 0x8000000000000001: header.append(mask_flag << 7 | 127) header += struct.pack("!Q", length) else: raise ValueError("Maximum payload size is 2^63") if mask_flag == 1: for index in range(length): data[index] ^= mask_key[index % 4] data = mask_key + data return header + data def _buffered_read(self, length): # try to recv and store needed bytes wanted_bytes = length - (len(self._readbuffer) - self._readbuffer_head) if wanted_bytes > 0: data = self._socket.recv(wanted_bytes) if not data: raise ConnectionAbortedError else: self._readbuffer.extend(data) if len(data) < wanted_bytes: raise BlockingIOError self._readbuffer_head += length return self._readbuffer[self._readbuffer_head - length:self._readbuffer_head] def _recv_impl(self, length): # try to decode websocket payload part from data try: self._readbuffer_head = 0 result = None chunk_startindex = self._payload_head chunk_endindex = self._payload_head + length header1 = self._buffered_read(1) header2 = self._buffered_read(1) opcode = (header1[0] & 0x0f) maskbit = (header2[0] & 0x80) == 0x80 lengthbits = (header2[0] & 0x7f) payload_length = lengthbits mask_key = None # read length if lengthbits == 0x7e: value = self._buffered_read(2) payload_length, = struct.unpack("!H", value) elif lengthbits == 0x7f: value = self._buffered_read(8) payload_length, = struct.unpack("!Q", value) # read mask if maskbit: mask_key = self._buffered_read(4) # if frame payload is shorter than the requested data, read only the possible part readindex = chunk_endindex if payload_length < readindex: readindex = payload_length if readindex > 0: # get payload chunk payload = self._buffered_read(readindex) # unmask only the needed part if maskbit: for index in range(chunk_startindex, readindex): payload[index] ^= mask_key[index % 4] result = payload[chunk_startindex:readindex] self._payload_head = readindex else: payload = bytearray() # check if full frame arrived and reset readbuffer and payloadhead if needed if readindex == payload_length: self._readbuffer = bytearray() self._payload_head = 0 # respond to non-binary opcodes, their arrival is not guaranteed beacause of non-blocking sockets if opcode == WebsocketWrapper.OPCODE_CONNCLOSE: frame = self._create_frame( WebsocketWrapper.OPCODE_CONNCLOSE, payload, 0) self._socket.send(frame) if opcode == WebsocketWrapper.OPCODE_PING: frame = self._create_frame( WebsocketWrapper.OPCODE_PONG, payload, 0) self._socket.send(frame) # This isn't *proper* handling of continuation frames, but given # that we only support binary frames, it is *probably* good enough. if (opcode == WebsocketWrapper.OPCODE_BINARY or opcode == WebsocketWrapper.OPCODE_CONTINUATION) \ and payload_length > 0: return result else: raise BlockingIOError except ConnectionError: self.connected = False return b'' def _send_impl(self, data): # if previous frame was sent successfully if len(self._sendbuffer) == 0: # create websocket frame frame = self._create_frame( WebsocketWrapper.OPCODE_BINARY, bytearray(data)) self._sendbuffer.extend(frame) self._requested_size = len(data) # try to write out as much as possible length = self._socket.send(self._sendbuffer) self._sendbuffer = self._sendbuffer[length:] if len(self._sendbuffer) == 0: # buffer sent out completely, return with payload's size return self._requested_size else: # couldn't send whole data, request the same data again with 0 as sent length return 0 def recv(self, length): return self._recv_impl(length) def read(self, length): return self._recv_impl(length) def send(self, data): return self._send_impl(data) def write(self, data): return self._send_impl(data) def close(self): self._socket.close() def fileno(self): return self._socket.fileno() def pending(self): # Fix for bug #131: a SSL socket may still have data available # for reading without select() being aware of it. if self._ssl: return self._socket.pending() else: # normal socket rely only on select() return 0 def setblocking(self, flag): self._socket.setblocking(flag) paho.mqtt.python-1.6.1/src/paho/mqtt/matcher.py000066400000000000000000000053231413423552100214550ustar00rootroot00000000000000class MQTTMatcher(object): """Intended to manage topic filters including wildcards. Internally, MQTTMatcher use a prefix tree (trie) to store values associated with filters, and has an iter_match() method to iterate efficiently over all filters that match some topic name.""" class Node(object): __slots__ = '_children', '_content' def __init__(self): self._children = {} self._content = None def __init__(self): self._root = self.Node() def __setitem__(self, key, value): """Add a topic filter :key to the prefix tree and associate it to :value""" node = self._root for sym in key.split('/'): node = node._children.setdefault(sym, self.Node()) node._content = value def __getitem__(self, key): """Retrieve the value associated with some topic filter :key""" try: node = self._root for sym in key.split('/'): node = node._children[sym] if node._content is None: raise KeyError(key) return node._content except KeyError: raise KeyError(key) def __delitem__(self, key): """Delete the value associated with some topic filter :key""" lst = [] try: parent, node = None, self._root for k in key.split('/'): parent, node = node, node._children[k] lst.append((parent, k, node)) # TODO node._content = None except KeyError: raise KeyError(key) else: # cleanup for parent, k, node in reversed(lst): if node._children or node._content is not None: break del parent._children[k] def iter_match(self, topic): """Return an iterator on all values associated with filters that match the :topic""" lst = topic.split('/') normal = not topic.startswith('$') def rec(node, i=0): if i == len(lst): if node._content is not None: yield node._content else: part = lst[i] if part in node._children: for content in rec(node._children[part], i + 1): yield content if '+' in node._children and (normal or i > 0): for content in rec(node._children['+'], i + 1): yield content if '#' in node._children and (normal or i > 0): content = node._children['#']._content if content is not None: yield content return rec(self._root) paho.mqtt.python-1.6.1/src/paho/mqtt/packettypes.py000066400000000000000000000026551413423552100223730ustar00rootroot00000000000000""" ******************************************************************* Copyright (c) 2017, 2019 IBM Corp. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 and Eclipse Distribution License v1.0 which accompany this distribution. The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License is available at http://www.eclipse.org/org/documents/edl-v10.php. Contributors: Ian Craggs - initial implementation and/or documentation ******************************************************************* """ class PacketTypes: """ Packet types class. Includes the AUTH packet for MQTT v5.0. Holds constants for each packet type such as PacketTypes.PUBLISH and packet name strings: PacketTypes.Names[PacketTypes.PUBLISH]. """ indexes = range(1, 16) # Packet types CONNECT, CONNACK, PUBLISH, PUBACK, PUBREC, PUBREL, \ PUBCOMP, SUBSCRIBE, SUBACK, UNSUBSCRIBE, UNSUBACK, \ PINGREQ, PINGRESP, DISCONNECT, AUTH = indexes # Dummy packet type for properties use - will delay only applies to will WILLMESSAGE = 99 Names = [ "reserved", \ "Connect", "Connack", "Publish", "Puback", "Pubrec", "Pubrel", \ "Pubcomp", "Subscribe", "Suback", "Unsubscribe", "Unsuback", \ "Pingreq", "Pingresp", "Disconnect", "Auth"] paho.mqtt.python-1.6.1/src/paho/mqtt/properties.py000066400000000000000000000426271413423552100222360ustar00rootroot00000000000000""" ******************************************************************* Copyright (c) 2017, 2019 IBM Corp. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 and Eclipse Distribution License v1.0 which accompany this distribution. The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License is available at http://www.eclipse.org/org/documents/edl-v10.php. Contributors: Ian Craggs - initial implementation and/or documentation ******************************************************************* """ import struct import sys from .packettypes import PacketTypes class MQTTException(Exception): pass class MalformedPacket(MQTTException): pass def writeInt16(length): # serialize a 16 bit integer to network format return bytearray(struct.pack("!H", length)) def readInt16(buf): # deserialize a 16 bit integer from network format return struct.unpack("!H", buf[:2])[0] def writeInt32(length): # serialize a 32 bit integer to network format return bytearray(struct.pack("!L", length)) def readInt32(buf): # deserialize a 32 bit integer from network format return struct.unpack("!L", buf[:4])[0] def writeUTF(data): # data could be a string, or bytes. If string, encode into bytes with utf-8 if sys.version_info[0] < 3: data = bytearray(data, 'utf-8') else: data = data if type(data) == type(b"") else bytes(data, "utf-8") return writeInt16(len(data)) + data def readUTF(buffer, maxlen): if maxlen >= 2: length = readInt16(buffer) else: raise MalformedPacket("Not enough data to read string length") maxlen -= 2 if length > maxlen: raise MalformedPacket("Length delimited string too long") buf = buffer[2:2+length].decode("utf-8") # look for chars which are invalid for MQTT for c in buf: # look for D800-DFFF in the UTF string ord_c = ord(c) if ord_c >= 0xD800 and ord_c <= 0xDFFF: raise MalformedPacket("[MQTT-1.5.4-1] D800-DFFF found in UTF-8 data") if ord_c == 0x00: # look for null in the UTF string raise MalformedPacket("[MQTT-1.5.4-2] Null found in UTF-8 data") if ord_c == 0xFEFF: raise MalformedPacket("[MQTT-1.5.4-3] U+FEFF in UTF-8 data") return buf, length+2 def writeBytes(buffer): return writeInt16(len(buffer)) + buffer def readBytes(buffer): length = readInt16(buffer) return buffer[2:2+length], length+2 class VariableByteIntegers: # Variable Byte Integer """ MQTT variable byte integer helper class. Used in several places in MQTT v5.0 properties. """ @staticmethod def encode(x): """ Convert an integer 0 <= x <= 268435455 into multi-byte format. Returns the buffer convered from the integer. """ assert 0 <= x <= 268435455 buffer = b'' while 1: digit = x % 128 x //= 128 if x > 0: digit |= 0x80 if sys.version_info[0] >= 3: buffer += bytes([digit]) else: buffer += bytes(chr(digit)) if x == 0: break return buffer @staticmethod def decode(buffer): """ Get the value of a multi-byte integer from a buffer Return the value, and the number of bytes used. [MQTT-1.5.5-1] the encoded value MUST use the minimum number of bytes necessary to represent the value """ multiplier = 1 value = 0 bytes = 0 while 1: bytes += 1 digit = buffer[0] buffer = buffer[1:] value += (digit & 127) * multiplier if digit & 128 == 0: break multiplier *= 128 return (value, bytes) class Properties(object): """MQTT v5.0 properties class. See Properties.names for a list of accepted property names along with their numeric values. See Properties.properties for the data type of each property. Example of use: publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.UserProperty = ("a", "2") publish_properties.UserProperty = ("c", "3") First the object is created with packet type as argument, no properties will be present at this point. Then properties are added as attributes, the name of which is the string property name without the spaces. """ def __init__(self, packetType): self.packetType = packetType self.types = ["Byte", "Two Byte Integer", "Four Byte Integer", "Variable Byte Integer", "Binary Data", "UTF-8 Encoded String", "UTF-8 String Pair"] self.names = { "Payload Format Indicator": 1, "Message Expiry Interval": 2, "Content Type": 3, "Response Topic": 8, "Correlation Data": 9, "Subscription Identifier": 11, "Session Expiry Interval": 17, "Assigned Client Identifier": 18, "Server Keep Alive": 19, "Authentication Method": 21, "Authentication Data": 22, "Request Problem Information": 23, "Will Delay Interval": 24, "Request Response Information": 25, "Response Information": 26, "Server Reference": 28, "Reason String": 31, "Receive Maximum": 33, "Topic Alias Maximum": 34, "Topic Alias": 35, "Maximum QoS": 36, "Retain Available": 37, "User Property": 38, "Maximum Packet Size": 39, "Wildcard Subscription Available": 40, "Subscription Identifier Available": 41, "Shared Subscription Available": 42 } self.properties = { # id: type, packets # payload format indicator 1: (self.types.index("Byte"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]), 2: (self.types.index("Four Byte Integer"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]), 3: (self.types.index("UTF-8 Encoded String"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]), 8: (self.types.index("UTF-8 Encoded String"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]), 9: (self.types.index("Binary Data"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]), 11: (self.types.index("Variable Byte Integer"), [PacketTypes.PUBLISH, PacketTypes.SUBSCRIBE]), 17: (self.types.index("Four Byte Integer"), [PacketTypes.CONNECT, PacketTypes.CONNACK, PacketTypes.DISCONNECT]), 18: (self.types.index("UTF-8 Encoded String"), [PacketTypes.CONNACK]), 19: (self.types.index("Two Byte Integer"), [PacketTypes.CONNACK]), 21: (self.types.index("UTF-8 Encoded String"), [PacketTypes.CONNECT, PacketTypes.CONNACK, PacketTypes.AUTH]), 22: (self.types.index("Binary Data"), [PacketTypes.CONNECT, PacketTypes.CONNACK, PacketTypes.AUTH]), 23: (self.types.index("Byte"), [PacketTypes.CONNECT]), 24: (self.types.index("Four Byte Integer"), [PacketTypes.WILLMESSAGE]), 25: (self.types.index("Byte"), [PacketTypes.CONNECT]), 26: (self.types.index("UTF-8 Encoded String"), [PacketTypes.CONNACK]), 28: (self.types.index("UTF-8 Encoded String"), [PacketTypes.CONNACK, PacketTypes.DISCONNECT]), 31: (self.types.index("UTF-8 Encoded String"), [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.PUBREL, PacketTypes.PUBCOMP, PacketTypes.SUBACK, PacketTypes.UNSUBACK, PacketTypes.DISCONNECT, PacketTypes.AUTH]), 33: (self.types.index("Two Byte Integer"), [PacketTypes.CONNECT, PacketTypes.CONNACK]), 34: (self.types.index("Two Byte Integer"), [PacketTypes.CONNECT, PacketTypes.CONNACK]), 35: (self.types.index("Two Byte Integer"), [PacketTypes.PUBLISH]), 36: (self.types.index("Byte"), [PacketTypes.CONNACK]), 37: (self.types.index("Byte"), [PacketTypes.CONNACK]), 38: (self.types.index("UTF-8 String Pair"), [PacketTypes.CONNECT, PacketTypes.CONNACK, PacketTypes.PUBLISH, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.PUBREL, PacketTypes.PUBCOMP, PacketTypes.SUBSCRIBE, PacketTypes.SUBACK, PacketTypes.UNSUBSCRIBE, PacketTypes.UNSUBACK, PacketTypes.DISCONNECT, PacketTypes.AUTH, PacketTypes.WILLMESSAGE]), 39: (self.types.index("Four Byte Integer"), [PacketTypes.CONNECT, PacketTypes.CONNACK]), 40: (self.types.index("Byte"), [PacketTypes.CONNACK]), 41: (self.types.index("Byte"), [PacketTypes.CONNACK]), 42: (self.types.index("Byte"), [PacketTypes.CONNACK]), } def allowsMultiple(self, compressedName): return self.getIdentFromName(compressedName) in [11, 38] def getIdentFromName(self, compressedName): # return the identifier corresponding to the property name result = -1 for name in self.names.keys(): if compressedName == name.replace(' ', ''): result = self.names[name] break return result def __setattr__(self, name, value): name = name.replace(' ', '') privateVars = ["packetType", "types", "names", "properties"] if name in privateVars: object.__setattr__(self, name, value) else: # the name could have spaces in, or not. Remove spaces before assignment if name not in [aname.replace(' ', '') for aname in self.names.keys()]: raise MQTTException( "Property name must be one of "+str(self.names.keys())) # check that this attribute applies to the packet type if self.packetType not in self.properties[self.getIdentFromName(name)][1]: raise MQTTException("Property %s does not apply to packet type %s" % (name, PacketTypes.Names[self.packetType])) # Check for forbidden values if type(value) != type([]): if name in ["ReceiveMaximum", "TopicAlias"] \ and (value < 1 or value > 65535): raise MQTTException( "%s property value must be in the range 1-65535" % (name)) elif name in ["TopicAliasMaximum"] \ and (value < 0 or value > 65535): raise MQTTException( "%s property value must be in the range 0-65535" % (name)) elif name in ["MaximumPacketSize", "SubscriptionIdentifier"] \ and (value < 1 or value > 268435455): raise MQTTException( "%s property value must be in the range 1-268435455" % (name)) elif name in ["RequestResponseInformation", "RequestProblemInformation", "PayloadFormatIndicator"] \ and (value != 0 and value != 1): raise MQTTException( "%s property value must be 0 or 1" % (name)) if self.allowsMultiple(name): if type(value) != type([]): value = [value] if hasattr(self, name): value = object.__getattribute__(self, name) + value object.__setattr__(self, name, value) def __str__(self): buffer = "[" first = True for name in self.names.keys(): compressedName = name.replace(' ', '') if hasattr(self, compressedName): if not first: buffer += ", " buffer += compressedName + " : " + \ str(getattr(self, compressedName)) first = False buffer += "]" return buffer def json(self): data = {} for name in self.names.keys(): compressedName = name.replace(' ', '') if hasattr(self, compressedName): val = getattr(self, compressedName) if compressedName == 'CorrelationData' and isinstance(val, bytes): data[compressedName] = val.hex() else: data[compressedName] = val return data def isEmpty(self): rc = True for name in self.names.keys(): compressedName = name.replace(' ', '') if hasattr(self, compressedName): rc = False break return rc def clear(self): for name in self.names.keys(): compressedName = name.replace(' ', '') if hasattr(self, compressedName): delattr(self, compressedName) def writeProperty(self, identifier, type, value): buffer = b"" buffer += VariableByteIntegers.encode(identifier) # identifier if type == self.types.index("Byte"): # value if sys.version_info[0] < 3: buffer += chr(value) else: buffer += bytes([value]) elif type == self.types.index("Two Byte Integer"): buffer += writeInt16(value) elif type == self.types.index("Four Byte Integer"): buffer += writeInt32(value) elif type == self.types.index("Variable Byte Integer"): buffer += VariableByteIntegers.encode(value) elif type == self.types.index("Binary Data"): buffer += writeBytes(value) elif type == self.types.index("UTF-8 Encoded String"): buffer += writeUTF(value) elif type == self.types.index("UTF-8 String Pair"): buffer += writeUTF(value[0]) + writeUTF(value[1]) return buffer def pack(self): # serialize properties into buffer for sending over network buffer = b"" for name in self.names.keys(): compressedName = name.replace(' ', '') if hasattr(self, compressedName): identifier = self.getIdentFromName(compressedName) attr_type = self.properties[identifier][0] if self.allowsMultiple(compressedName): for prop in getattr(self, compressedName): buffer += self.writeProperty(identifier, attr_type, prop) else: buffer += self.writeProperty(identifier, attr_type, getattr(self, compressedName)) return VariableByteIntegers.encode(len(buffer)) + buffer def readProperty(self, buffer, type, propslen): if type == self.types.index("Byte"): value = buffer[0] valuelen = 1 elif type == self.types.index("Two Byte Integer"): value = readInt16(buffer) valuelen = 2 elif type == self.types.index("Four Byte Integer"): value = readInt32(buffer) valuelen = 4 elif type == self.types.index("Variable Byte Integer"): value, valuelen = VariableByteIntegers.decode(buffer) elif type == self.types.index("Binary Data"): value, valuelen = readBytes(buffer) elif type == self.types.index("UTF-8 Encoded String"): value, valuelen = readUTF(buffer, propslen) elif type == self.types.index("UTF-8 String Pair"): value, valuelen = readUTF(buffer, propslen) buffer = buffer[valuelen:] # strip the bytes used by the value value1, valuelen1 = readUTF(buffer, propslen - valuelen) value = (value, value1) valuelen += valuelen1 return value, valuelen def getNameFromIdent(self, identifier): rc = None for name in self.names: if self.names[name] == identifier: rc = name return rc def unpack(self, buffer): if sys.version_info[0] < 3: buffer = bytearray(buffer) self.clear() # deserialize properties into attributes from buffer received from network propslen, VBIlen = VariableByteIntegers.decode(buffer) buffer = buffer[VBIlen:] # strip the bytes used by the VBI propslenleft = propslen while propslenleft > 0: # properties length is 0 if there are none identifier, VBIlen2 = VariableByteIntegers.decode( buffer) # property identifier buffer = buffer[VBIlen2:] # strip the bytes used by the VBI propslenleft -= VBIlen2 attr_type = self.properties[identifier][0] value, valuelen = self.readProperty( buffer, attr_type, propslenleft) buffer = buffer[valuelen:] # strip the bytes used by the value propslenleft -= valuelen propname = self.getNameFromIdent(identifier) compressedName = propname.replace(' ', '') if not self.allowsMultiple(compressedName) and hasattr(self, compressedName): raise MQTTException( "Property '%s' must not exist more than once" % property) setattr(self, propname, value) return self, propslen + VBIlen paho.mqtt.python-1.6.1/src/paho/mqtt/publish.py000066400000000000000000000226301413423552100215000ustar00rootroot00000000000000# Copyright (c) 2014 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Public License v2.0 # and Eclipse Distribution License v1.0 which accompany this distribution. # # The Eclipse Public License is available at # http://www.eclipse.org/legal/epl-v10.html # and the Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial API and implementation """ This module provides some helper functions to allow straightforward publishing of messages in a one-shot manner. In other words, they are useful for the situation where you have a single/multiple messages you want to publish to a broker, then disconnect and nothing else is required. """ from __future__ import absolute_import import collections try: from collections.abc import Iterable except ImportError: from collections import Iterable from .. import mqtt from . import client as paho def _do_publish(client): """Internal function""" message = client._userdata.popleft() if isinstance(message, dict): client.publish(**message) elif isinstance(message, (tuple, list)): client.publish(*message) else: raise TypeError('message must be a dict, tuple, or list') def _on_connect(client, userdata, flags, rc): """Internal callback""" #pylint: disable=invalid-name, unused-argument if rc == 0: if len(userdata) > 0: _do_publish(client) else: raise mqtt.MQTTException(paho.connack_string(rc)) def _on_connect_v5(client, userdata, flags, rc, properties): """Internal v5 callback""" _on_connect(client, userdata, flags, rc) def _on_publish(client, userdata, mid): """Internal callback""" #pylint: disable=unused-argument if len(userdata) == 0: client.disconnect() else: _do_publish(client) def multiple(msgs, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=paho.MQTTv311, transport="tcp", proxy_args=None): """Publish multiple messages to a broker, then disconnect cleanly. This function creates an MQTT client, connects to a broker and publishes a list of messages. Once the messages have been delivered, it disconnects cleanly from the broker. msgs : a list of messages to publish. Each message is either a dict or a tuple. If a dict, only the topic must be present. Default values will be used for any missing arguments. The dict must be of the form: msg = {'topic':"", 'payload':"", 'qos':, 'retain':} topic must be present and may not be empty. If payload is "", None or not present then a zero length payload will be published. If qos is not present, the default of 0 is used. If retain is not present, the default of False is used. If a tuple, then it must be of the form: ("", "", qos, retain) hostname : a string containing the address of the broker to connect to. Defaults to localhost. port : the port to connect to the broker on. Defaults to 1883. client_id : the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive : the keepalive timeout value for the client. Defaults to 60 seconds. will : a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth : a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls : a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':", 'insecure':""} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Alternatively, tls input can be an SSLContext object, which will be processed using the tls_set_context method. Defaults to None, which indicates that TLS should not be used. transport : set to "tcp" to use the default setting of transport which is raw TCP. Set to "websockets" to use WebSockets as the transport. proxy_args: a dictionary that will be given to the client. """ if not isinstance(msgs, Iterable): raise TypeError('msgs must be an iterable') client = paho.Client(client_id=client_id, userdata=collections.deque(msgs), protocol=protocol, transport=transport) client.on_publish = _on_publish if protocol == mqtt.client.MQTTv5: client.on_connect = _on_connect_v5 else: client.on_connect = _on_connect if proxy_args is not None: client.proxy_set(**proxy_args) if auth: username = auth.get('username') if username: password = auth.get('password') client.username_pw_set(username, password) else: raise KeyError("The 'username' key was not found, this is " "required for auth") if will is not None: client.will_set(**will) if tls is not None: if isinstance(tls, dict): insecure = tls.pop('insecure', False) client.tls_set(**tls) if insecure: # Must be set *after* the `client.tls_set()` call since it sets # up the SSL context that `client.tls_insecure_set` alters. client.tls_insecure_set(insecure) else: # Assume input is SSLContext object client.tls_set_context(tls) client.connect(hostname, port, keepalive) client.loop_forever() def single(topic, payload=None, qos=0, retain=False, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=paho.MQTTv311, transport="tcp", proxy_args=None): """Publish a single message to a broker, then disconnect cleanly. This function creates an MQTT client, connects to a broker and publishes a single message. Once the message has been delivered, it disconnects cleanly from the broker. topic : the only required argument must be the topic string to which the payload will be published. payload : the payload to be published. If "" or None, a zero length payload will be published. qos : the qos to use when publishing, default to 0. retain : set the message to be retained (True) or not (False). hostname : a string containing the address of the broker to connect to. Defaults to localhost. port : the port to connect to the broker on. Defaults to 1883. client_id : the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive : the keepalive timeout value for the client. Defaults to 60 seconds. will : a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth : a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls : a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':", 'insecure':""} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Defaults to None, which indicates that TLS should not be used. Alternatively, tls input can be an SSLContext object, which will be processed using the tls_set_context method. transport : set to "tcp" to use the default setting of transport which is raw TCP. Set to "websockets" to use WebSockets as the transport. proxy_args: a dictionary that will be given to the client. """ msg = {'topic':topic, 'payload':payload, 'qos':qos, 'retain':retain} multiple([msg], hostname, port, client_id, keepalive, will, auth, tls, protocol, transport, proxy_args) paho.mqtt.python-1.6.1/src/paho/mqtt/reasoncodes.py000066400000000000000000000206171413423552100223420ustar00rootroot00000000000000""" ******************************************************************* Copyright (c) 2017, 2019 IBM Corp. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 and Eclipse Distribution License v1.0 which accompany this distribution. The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License is available at http://www.eclipse.org/org/documents/edl-v10.php. Contributors: Ian Craggs - initial implementation and/or documentation ******************************************************************* """ import sys from .packettypes import PacketTypes class ReasonCodes: """MQTT version 5.0 reason codes class. See ReasonCodes.names for a list of possible numeric values along with their names and the packets to which they apply. """ def __init__(self, packetType, aName="Success", identifier=-1): """ packetType: the type of the packet, such as PacketTypes.CONNECT that this reason code will be used with. Some reason codes have different names for the same identifier when used a different packet type. aName: the String name of the reason code to be created. Ignored if the identifier is set. identifier: an integer value of the reason code to be created. """ self.packetType = packetType self.names = { 0: {"Success": [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.PUBREL, PacketTypes.PUBCOMP, PacketTypes.UNSUBACK, PacketTypes.AUTH], "Normal disconnection": [PacketTypes.DISCONNECT], "Granted QoS 0": [PacketTypes.SUBACK]}, 1: {"Granted QoS 1": [PacketTypes.SUBACK]}, 2: {"Granted QoS 2": [PacketTypes.SUBACK]}, 4: {"Disconnect with will message": [PacketTypes.DISCONNECT]}, 16: {"No matching subscribers": [PacketTypes.PUBACK, PacketTypes.PUBREC]}, 17: {"No subscription found": [PacketTypes.UNSUBACK]}, 24: {"Continue authentication": [PacketTypes.AUTH]}, 25: {"Re-authenticate": [PacketTypes.AUTH]}, 128: {"Unspecified error": [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.UNSUBACK, PacketTypes.DISCONNECT], }, 129: {"Malformed packet": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 130: {"Protocol error": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 131: {"Implementation specific error": [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.UNSUBACK, PacketTypes.DISCONNECT], }, 132: {"Unsupported protocol version": [PacketTypes.CONNACK]}, 133: {"Client identifier not valid": [PacketTypes.CONNACK]}, 134: {"Bad user name or password": [PacketTypes.CONNACK]}, 135: {"Not authorized": [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.UNSUBACK, PacketTypes.DISCONNECT], }, 136: {"Server unavailable": [PacketTypes.CONNACK]}, 137: {"Server busy": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 138: {"Banned": [PacketTypes.CONNACK]}, 139: {"Server shutting down": [PacketTypes.DISCONNECT]}, 140: {"Bad authentication method": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 141: {"Keep alive timeout": [PacketTypes.DISCONNECT]}, 142: {"Session taken over": [PacketTypes.DISCONNECT]}, 143: {"Topic filter invalid": [PacketTypes.SUBACK, PacketTypes.UNSUBACK, PacketTypes.DISCONNECT]}, 144: {"Topic name invalid": [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.DISCONNECT]}, 145: {"Packet identifier in use": [PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.UNSUBACK]}, 146: {"Packet identifier not found": [PacketTypes.PUBREL, PacketTypes.PUBCOMP]}, 147: {"Receive maximum exceeded": [PacketTypes.DISCONNECT]}, 148: {"Topic alias invalid": [PacketTypes.DISCONNECT]}, 149: {"Packet too large": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 150: {"Message rate too high": [PacketTypes.DISCONNECT]}, 151: {"Quota exceeded": [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.DISCONNECT], }, 152: {"Administrative action": [PacketTypes.DISCONNECT]}, 153: {"Payload format invalid": [PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.DISCONNECT]}, 154: {"Retain not supported": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 155: {"QoS not supported": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 156: {"Use another server": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 157: {"Server moved": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 158: {"Shared subscription not supported": [PacketTypes.SUBACK, PacketTypes.DISCONNECT]}, 159: {"Connection rate exceeded": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]}, 160: {"Maximum connect time": [PacketTypes.DISCONNECT]}, 161: {"Subscription identifiers not supported": [PacketTypes.SUBACK, PacketTypes.DISCONNECT]}, 162: {"Wildcard subscription not supported": [PacketTypes.SUBACK, PacketTypes.DISCONNECT]}, } if identifier == -1: if packetType == PacketTypes.DISCONNECT and aName == "Success": aName = "Normal disconnection" self.set(aName) else: self.value = identifier self.getName() # check it's good def __getName__(self, packetType, identifier): """ Get the reason code string name for a specific identifier. The name can vary by packet type for the same identifier, which is why the packet type is also required. Used when displaying the reason code. """ assert identifier in self.names.keys(), identifier names = self.names[identifier] namelist = [name for name in names.keys() if packetType in names[name]] assert len(namelist) == 1 return namelist[0] def getId(self, name): """ Get the numeric id corresponding to a reason code name. Used when setting the reason code for a packetType check that only valid codes for the packet are set. """ identifier = None for code in self.names.keys(): if name in self.names[code].keys(): if self.packetType in self.names[code][name]: identifier = code break assert identifier is not None, name return identifier def set(self, name): self.value = self.getId(name) def unpack(self, buffer): c = buffer[0] if sys.version_info[0] < 3: c = ord(c) name = self.__getName__(self.packetType, c) self.value = self.getId(name) return 1 def getName(self): """Returns the reason code name corresponding to the numeric value which is set. """ return self.__getName__(self.packetType, self.value) def __eq__(self, other): if isinstance(other, int): return self.value == other if isinstance(other, str): return self.value == str(self) if isinstance(other, ReasonCodes): return self.value == other.value return False def __str__(self): return self.getName() def json(self): return self.getName() def pack(self): return bytearray([self.value]) paho.mqtt.python-1.6.1/src/paho/mqtt/subscribe.py000066400000000000000000000261661413423552100220230ustar00rootroot00000000000000# Copyright (c) 2016 Roger Light # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Public License v2.0 # and Eclipse Distribution License v1.0 which accompany this distribution. # # The Eclipse Public License is available at # http://www.eclipse.org/legal/epl-v10.html # and the Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Roger Light - initial API and implementation """ This module provides some helper functions to allow straightforward subscribing to topics and retrieving messages. The two functions are simple(), which returns one or messages matching a set of topics, and callback() which allows you to pass a callback for processing of messages. """ from __future__ import absolute_import from .. import mqtt from . import client as paho def _on_connect_v5(client, userdata, flags, rc, properties): """Internal callback""" if rc != 0: raise mqtt.MQTTException(paho.connack_string(rc)) if isinstance(userdata['topics'], list): for topic in userdata['topics']: client.subscribe(topic, userdata['qos']) else: client.subscribe(userdata['topics'], userdata['qos']) def _on_connect(client, userdata, flags, rc): """Internal v5 callback""" _on_connect_v5(client, userdata, flags, rc, None) def _on_message_callback(client, userdata, message): """Internal callback""" userdata['callback'](client, userdata['userdata'], message) def _on_message_simple(client, userdata, message): """Internal callback""" if userdata['msg_count'] == 0: return # Don't process stale retained messages if 'retained' was false if message.retain and not userdata['retained']: return userdata['msg_count'] = userdata['msg_count'] - 1 if userdata['messages'] is None and userdata['msg_count'] == 0: userdata['messages'] = message client.disconnect() return userdata['messages'].append(message) if userdata['msg_count'] == 0: client.disconnect() def callback(callback, topics, qos=0, userdata=None, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=paho.MQTTv311, transport="tcp", clean_session=True, proxy_args=None): """Subscribe to a list of topics and process them in a callback function. This function creates an MQTT client, connects to a broker and subscribes to a list of topics. Incoming messages are processed by the user provided callback. This is a blocking function and will never return. callback : function of the form "on_message(client, userdata, message)" for processing the messages received. topics : either a string containing a single topic to subscribe to, or a list of topics to subscribe to. qos : the qos to use when subscribing. This is applied to all topics. userdata : passed to the callback hostname : a string containing the address of the broker to connect to. Defaults to localhost. port : the port to connect to the broker on. Defaults to 1883. client_id : the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive : the keepalive timeout value for the client. Defaults to 60 seconds. will : a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth : a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls : a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':", 'insecure':""} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Alternatively, tls input can be an SSLContext object, which will be processed using the tls_set_context method. Defaults to None, which indicates that TLS should not be used. transport : set to "tcp" to use the default setting of transport which is raw TCP. Set to "websockets" to use WebSockets as the transport. clean_session : a boolean that determines the client type. If True, the broker will remove all information about this client when it disconnects. If False, the client is a persistent client and subscription information and queued messages will be retained when the client disconnects. Defaults to True. proxy_args: a dictionary that will be given to the client. """ if qos < 0 or qos > 2: raise ValueError('qos must be in the range 0-2') callback_userdata = { 'callback':callback, 'topics':topics, 'qos':qos, 'userdata':userdata} client = paho.Client(client_id=client_id, userdata=callback_userdata, protocol=protocol, transport=transport, clean_session=clean_session) client.on_message = _on_message_callback if protocol == mqtt.client.MQTTv5: client.on_connect = _on_connect_v5 else: client.on_connect = _on_connect if proxy_args is not None: client.proxy_set(**proxy_args) if auth: username = auth.get('username') if username: password = auth.get('password') client.username_pw_set(username, password) else: raise KeyError("The 'username' key was not found, this is " "required for auth") if will is not None: client.will_set(**will) if tls is not None: if isinstance(tls, dict): insecure = tls.pop('insecure', False) client.tls_set(**tls) if insecure: # Must be set *after* the `client.tls_set()` call since it sets # up the SSL context that `client.tls_insecure_set` alters. client.tls_insecure_set(insecure) else: # Assume input is SSLContext object client.tls_set_context(tls) client.connect(hostname, port, keepalive) client.loop_forever() def simple(topics, qos=0, msg_count=1, retained=True, hostname="localhost", port=1883, client_id="", keepalive=60, will=None, auth=None, tls=None, protocol=paho.MQTTv311, transport="tcp", clean_session=True, proxy_args=None): """Subscribe to a list of topics and return msg_count messages. This function creates an MQTT client, connects to a broker and subscribes to a list of topics. Once "msg_count" messages have been received, it disconnects cleanly from the broker and returns the messages. topics : either a string containing a single topic to subscribe to, or a list of topics to subscribe to. qos : the qos to use when subscribing. This is applied to all topics. msg_count : the number of messages to retrieve from the broker. if msg_count == 1 then a single MQTTMessage will be returned. if msg_count > 1 then a list of MQTTMessages will be returned. retained : If set to True, retained messages will be processed the same as non-retained messages. If set to False, retained messages will be ignored. This means that with retained=False and msg_count=1, the function will return the first message received that does not have the retained flag set. hostname : a string containing the address of the broker to connect to. Defaults to localhost. port : the port to connect to the broker on. Defaults to 1883. client_id : the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive : the keepalive timeout value for the client. Defaults to 60 seconds. will : a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth : a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls : a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':", 'insecure':""} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Alternatively, tls input can be an SSLContext object, which will be processed using the tls_set_context method. Defaults to None, which indicates that TLS should not be used. transport : set to "tcp" to use the default setting of transport which is raw TCP. Set to "websockets" to use WebSockets as the transport. clean_session : a boolean that determines the client type. If True, the broker will remove all information about this client when it disconnects. If False, the client is a persistent client and subscription information and queued messages will be retained when the client disconnects. Defaults to True. proxy_args: a dictionary that will be given to the client. """ if msg_count < 1: raise ValueError('msg_count must be > 0') # Set ourselves up to return a single message if msg_count == 1, or a list # if > 1. if msg_count == 1: messages = None else: messages = [] userdata = {'retained':retained, 'msg_count':msg_count, 'messages':messages} callback(_on_message_simple, topics, qos, userdata, hostname, port, client_id, keepalive, will, auth, tls, protocol, transport, clean_session, proxy_args) return userdata['messages'] paho.mqtt.python-1.6.1/src/paho/mqtt/subscribeoptions.py000066400000000000000000000110101413423552100234150ustar00rootroot00000000000000""" ******************************************************************* Copyright (c) 2017, 2019 IBM Corp. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 and Eclipse Distribution License v1.0 which accompany this distribution. The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License is available at http://www.eclipse.org/org/documents/edl-v10.php. Contributors: Ian Craggs - initial implementation and/or documentation ******************************************************************* """ import sys class MQTTException(Exception): pass class SubscribeOptions(object): """The MQTT v5.0 subscribe options class. The options are: qos: As in MQTT v3.1.1. noLocal: True or False. If set to True, the subscriber will not receive its own publications. retainAsPublished: True or False. If set to True, the retain flag on received publications will be as set by the publisher. retainHandling: RETAIN_SEND_ON_SUBSCRIBE, RETAIN_SEND_IF_NEW_SUB or RETAIN_DO_NOT_SEND Controls when the broker should send retained messages: - RETAIN_SEND_ON_SUBSCRIBE: on any successful subscribe request - RETAIN_SEND_IF_NEW_SUB: only if the subscribe request is new - RETAIN_DO_NOT_SEND: never send retained messages """ # retain handling options RETAIN_SEND_ON_SUBSCRIBE, RETAIN_SEND_IF_NEW_SUB, RETAIN_DO_NOT_SEND = range( 0, 3) def __init__(self, qos=0, noLocal=False, retainAsPublished=False, retainHandling=RETAIN_SEND_ON_SUBSCRIBE): """ qos: 0, 1 or 2. 0 is the default. noLocal: True or False. False is the default and corresponds to MQTT v3.1.1 behavior. retainAsPublished: True or False. False is the default and corresponds to MQTT v3.1.1 behavior. retainHandling: RETAIN_SEND_ON_SUBSCRIBE, RETAIN_SEND_IF_NEW_SUB or RETAIN_DO_NOT_SEND RETAIN_SEND_ON_SUBSCRIBE is the default and corresponds to MQTT v3.1.1 behavior. """ object.__setattr__(self, "names", ["QoS", "noLocal", "retainAsPublished", "retainHandling"]) self.QoS = qos # bits 0,1 self.noLocal = noLocal # bit 2 self.retainAsPublished = retainAsPublished # bit 3 self.retainHandling = retainHandling # bits 4 and 5: 0, 1 or 2 assert self.QoS in [0, 1, 2] assert self.retainHandling in [ 0, 1, 2], "Retain handling should be 0, 1 or 2" def __setattr__(self, name, value): if name not in self.names: raise MQTTException( name + " Attribute name must be one of "+str(self.names)) object.__setattr__(self, name, value) def pack(self): assert self.QoS in [0, 1, 2] assert self.retainHandling in [ 0, 1, 2], "Retain handling should be 0, 1 or 2" noLocal = 1 if self.noLocal else 0 retainAsPublished = 1 if self.retainAsPublished else 0 data = [(self.retainHandling << 4) | (retainAsPublished << 3) | (noLocal << 2) | self.QoS] if sys.version_info[0] >= 3: buffer = bytes(data) else: buffer = bytearray(data) return buffer def unpack(self, buffer): b0 = buffer[0] self.retainHandling = ((b0 >> 4) & 0x03) self.retainAsPublished = True if ((b0 >> 3) & 0x01) == 1 else False self.noLocal = True if ((b0 >> 2) & 0x01) == 1 else False self.QoS = (b0 & 0x03) assert self.retainHandling in [ 0, 1, 2], "Retain handling should be 0, 1 or 2, not %d" % self.retainHandling assert self.QoS in [ 0, 1, 2], "QoS should be 0, 1 or 2, not %d" % self.QoS return 1 def __repr__(self): return str(self) def __str__(self): return "{QoS="+str(self.QoS)+", noLocal="+str(self.noLocal) +\ ", retainAsPublished="+str(self.retainAsPublished) +\ ", retainHandling="+str(self.retainHandling)+"}" def json(self): data = { "QoS": self.QoS, "noLocal": self.noLocal, "retainAsPublished": self.retainAsPublished, "retainHandling": self.retainHandling, } return data paho.mqtt.python-1.6.1/test/000077500000000000000000000000001413423552100157315ustar00rootroot00000000000000paho.mqtt.python-1.6.1/test/Makefile000066400000000000000000000001321413423552100173650ustar00rootroot00000000000000.PHONY: all test clean all : test : $(MAKE) -C lib test clean : $(MAKE) -C lib clean paho.mqtt.python-1.6.1/test/lib/000077500000000000000000000000001413423552100164775ustar00rootroot00000000000000paho.mqtt.python-1.6.1/test/lib/01-asyncio.py000077500000000000000000000026701413423552100207440ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether asyncio works import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("asyncio-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) subscribe_packet = paho_test.gen_subscribe(mid=1, topic=u"sub-test", qos=1) suback_packet = paho_test.gen_suback(mid=1, qos=1) unsubscribe_packet = paho_test.gen_unsubscribe(mid=2, topic=u"unsub-test") unsuback_packet = paho_test.gen_unsuback(mid=2) publish_packet = paho_test.gen_publish(u"b2c", qos=0, payload="msg") publish_packet_in = paho_test.gen_publish(u"asyncio", qos=1, mid=3, payload="message") puback_packet_in = paho_test.gen_puback(mid=3) disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "subscribe", subscribe_packet) conn.send(suback_packet) paho_test.expect_packet(conn, "unsubscribe", unsubscribe_packet) conn.send(unsuback_packet) conn.send(publish_packet) paho_test.expect_packet(conn, "publish", publish_packet_in) conn.send(puback_packet_in) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-decorators.py000077500000000000000000000027111413423552100214400ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether callback decorators work import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("decorators-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) subscribe_packet = paho_test.gen_subscribe(mid=1, topic=u"sub-test", qos=1) suback_packet = paho_test.gen_suback(mid=1, qos=1) unsubscribe_packet = paho_test.gen_unsubscribe(mid=2, topic=u"unsub-test") unsuback_packet = paho_test.gen_unsuback(mid=2) publish_packet = paho_test.gen_publish(u"b2c", qos=0, payload="msg") publish_packet_in = paho_test.gen_publish(u"decorators", qos=1, mid=3, payload="message") puback_packet_in = paho_test.gen_puback(mid=3) disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "subscribe", subscribe_packet) conn.send(suback_packet) paho_test.expect_packet(conn, "unsubscribe", unsubscribe_packet) conn.send(unsuback_packet) conn.send(publish_packet) paho_test.expect_packet(conn, "publish", publish_packet_in) conn.send(puback_packet_in) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-keepalive-pingreq.py000077500000000000000000000021431413423552100227020ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a pingreq after the keepalive time # The client should connect to port 1888 with keepalive=4, clean session set, # and client id 01-keepalive-pingreq # The client should send a PINGREQ message after the appropriate amount of time # (4 seconds after no traffic). import time import context import paho_test rc = 1 keepalive = 4 connect_packet = paho_test.gen_connect("01-keepalive-pingreq", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) pingreq_packet = paho_test.gen_pingreq() pingresp_packet = paho_test.gen_pingresp() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(keepalive+10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "pingreq", pingreq_packet) time.sleep(1.0) conn.send(pingresp_packet) paho_test.expect_packet(conn, "pingreq", pingreq_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-no-clean-session.py000077500000000000000000000012651413423552100224530ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect with clean session not set. # The client should connect to port 1888 with keepalive=60, clean session not # set, and client id 01-no-clean-session. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("01-no-clean-session", clean_session=False, keepalive=keepalive) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-reconnect-on-failure.py000077500000000000000000000026321413423552100233140ustar00rootroot00000000000000#!/usr/bin/env python3 # Test the reconnect_on_failure = False mode import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("01-reconnect-on-failure", keepalive=keepalive) connack_packet_ok = paho_test.gen_connack(rc=0) connack_packet_failure = paho_test.gen_connack(rc=1) # CONNACK_REFUSED_PROTOCOL_VERSION publish_packet = paho_test.gen_publish( u"reconnect/test", qos=0, payload="message") sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet_ok) # Connection is a success, so we expect a publish paho_test.expect_packet(conn, "publish", publish_packet) conn.close() # Expect the client to quit here due to socket being closed client.wait(1) if client.returncode == 42: # Repeat the test, but with a bad connack code client = context.start_client() (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet_failure) # Expect the client to quit here due to socket being closed client.wait(1) if client.returncode == 42: rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-unpwd-empty-password-set.py000077500000000000000000000014161413423552100242160ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect with a username and password. # The client should connect to port 1888 with keepalive=60, clean session set, # client id 01-unpwd-set, username set to uname and password set to empty string import context import paho_test rc = 1 keepalive = 60 username = "uname" password = "" connect_packet = paho_test.gen_connect( "01-unpwd-set", keepalive=keepalive, username=username, password=password) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-unpwd-empty-set.py000077500000000000000000000013671413423552100223630ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect with a username and password. # The client should connect to port 1888 with keepalive=60, clean session set, # client id 01-unpwd-set, username and password set to empty string. import context import paho_test rc = 1 keepalive = 60 username = "" password = "" connect_packet = paho_test.gen_connect( "01-unpwd-set", keepalive=keepalive, username=username, password='') sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-unpwd-set.py000077500000000000000000000014241413423552100212210ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect with a username and password. # The client should connect to port 1888 with keepalive=60, clean session set, # client id 01-unpwd-set, username set to uname and password set to ;'[08gn=# import context import paho_test rc = 1 keepalive = 60 username = "uname" password = ";'[08gn=#" connect_packet = paho_test.gen_connect( "01-unpwd-set", keepalive=keepalive, username=username, password=password) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-unpwd-unicode-set.py000077500000000000000000000016011413423552100226420ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect with a unicode username and password. # The client should connect to port 1888 with keepalive=60, clean session set, # client id 01-unpwd-unicode-set, username and password from corresponding variables from __future__ import unicode_literals import context import paho_test rc = 1 keepalive = 60 username = "\u00fas\u00e9rn\u00e1m\u00e9-h\u00e9ll\u00f3" password = "h\u00e9ll\u00f3" connect_packet = paho_test.gen_connect( "01-unpwd-unicode-set", keepalive=keepalive, username=username, password=password) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-will-set.py000077500000000000000000000016061413423552100210350ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect with a will. # Will QoS=1, will retain=1. # The client should connect to port 1888 with keepalive=60, clean session set, # client id 01-will-set will topic set to topic/on/unexpected/disconnect , will # payload set to "will message", will qos set to 1 and will retain set. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect( "01-will-set", keepalive=keepalive, will_topic="topic/on/unexpected/disconnect", will_qos=1, will_retain=True, will_payload="will message") sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-will-unpwd-set.py000077500000000000000000000017151413423552100221710ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect with a will, username and password. # The client should connect to port 1888 with keepalive=60, clean session set, # client id 01-will-unpwd-set , will topic set to "will-topic", will payload # set to "will message", will qos=2, will retain not set, username set to # "oibvvwqw" and password set to "#'^2hg9a&nm38*us". import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("01-will-unpwd-set", keepalive=keepalive, username="oibvvwqw", password="#'^2hg9a&nm38*us", will_topic="will-topic", will_qos=2, will_payload="will message") sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/01-zero-length-clientid.py000077500000000000000000000013311413423552100233170ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client connects correctly with a zero length clientid. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("", keepalive=keepalive, proto_ver=4) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/02-subscribe-qos0.py000077500000000000000000000027671413423552100221500ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct SUBSCRIBE to a topic with QoS 0. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id subscribe-qos0-test # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a SUBSCRIBE # message to subscribe to topic "qos0/test" with QoS=0. If rc!=0, the client # should exit with an error. # Upon receiving the correct SUBSCRIBE message, the test will reply with a # SUBACK message with the accepted QoS set to 0. On receiving the SUBACK # message, the client should send a DISCONNECT message. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("subscribe-qos0-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() mid = 1 subscribe_packet = paho_test.gen_subscribe(mid, "qos0/test", 0) suback_packet = paho_test.gen_suback(mid, 0) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "subscribe", subscribe_packet) conn.send(suback_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/02-subscribe-qos1.py000077500000000000000000000027671413423552100221510ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct SUBSCRIBE to a topic with QoS 1. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id subscribe-qos1-test # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a SUBSCRIBE # message to subscribe to topic "qos1/test" with QoS=1. If rc!=0, the client # should exit with an error. # Upon receiving the correct SUBSCRIBE message, the test will reply with a # SUBACK message with the accepted QoS set to 1. On receiving the SUBACK # message, the client should send a DISCONNECT message. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("subscribe-qos1-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() mid = 1 subscribe_packet = paho_test.gen_subscribe(mid, "qos1/test", 1) suback_packet = paho_test.gen_suback(mid, 1) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "subscribe", subscribe_packet) conn.send(suback_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/02-subscribe-qos2.py000077500000000000000000000027671413423552100221520ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct SUBSCRIBE to a topic with QoS 2. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id subscribe-qos2-test # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a SUBSCRIBE # message to subscribe to topic "qos2/test" with QoS=2. If rc!=0, the client # should exit with an error. # Upon receiving the correct SUBSCRIBE message, the test will reply with a # SUBACK message with the accepted QoS set to 2. On receiving the SUBACK # message, the client should send a DISCONNECT message. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("subscribe-qos2-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() mid = 1 subscribe_packet = paho_test.gen_subscribe(mid, "qos2/test", 2) suback_packet = paho_test.gen_suback(mid, 2) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "subscribe", subscribe_packet) conn.send(suback_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/02-unsubscribe.py000077500000000000000000000016631413423552100216250ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct UNSUBSCRIBE packet. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("unsubscribe-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() mid = 1 unsubscribe_packet = paho_test.gen_unsubscribe(mid, "unsubscribe/test") unsuback_packet = paho_test.gen_unsuback(mid) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "unsubscribe", unsubscribe_packet) conn.send(unsuback_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-b2c-qos1.py000077500000000000000000000030361413423552100222710ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client responds correctly to a PUBLISH with QoS 1. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id publish-qos1-test # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK the client should verify that rc==0. # The test will send the client a PUBLISH message with topic # "pub/qos1/receive", payload of "message", QoS=1 and mid=123. The client # should handle this as per the spec by sending a PUBACK message. # The client should then exit with return code==0. import time import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("publish-qos1-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() mid = 123 publish_packet = paho_test.gen_publish( u"pub/qos1/receive", qos=1, mid=mid, payload="message") puback_packet = paho_test.gen_puback(mid) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) conn.send(publish_packet) paho_test.expect_packet(conn, "puback", puback_packet) rc = 0 conn.close() finally: for i in range(0, 5): if client.returncode != None: break time.sleep(0.1) client.terminate() client.wait() sock.close() if client.returncode != 0: exit(1) exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-c2b-qos1-disconnect.py000077500000000000000000000026401413423552100244200ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct PUBLISH to a topic with QoS 1, then responds correctly to a disconnect. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect( "publish-qos1-test", keepalive=keepalive, clean_session=False, ) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() mid = 1 publish_packet = paho_test.gen_publish( u"pub/qos1/test", qos=1, mid=mid, payload="message") publish_packet_dup = paho_test.gen_publish( u"pub/qos1/test", qos=1, mid=mid, payload="message", dup=True) puback_packet = paho_test.gen_puback(mid) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(15) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) # Disconnect client. It should reconnect. conn.close() (conn, address) = sock.accept() conn.settimeout(15) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "retried publish", publish_packet_dup) conn.send(puback_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-c2b-qos2-disconnect.py000077500000000000000000000036131413423552100244220ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct PUBLISH to a topic with QoS 2 and responds to a disconnect. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect( "publish-qos2-test", keepalive=keepalive, clean_session=False, ) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() mid = 1 publish_packet = paho_test.gen_publish( u"pub/qos2/test", qos=2, mid=mid, payload="message") publish_dup_packet = paho_test.gen_publish( u"pub/qos2/test", qos=2, mid=mid, payload="message", dup=True) pubrec_packet = paho_test.gen_pubrec(mid) pubrel_packet = paho_test.gen_pubrel(mid) pubcomp_packet = paho_test.gen_pubcomp(mid) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(5) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) # Disconnect client. It should reconnect. conn.close() (conn, address) = sock.accept() conn.settimeout(15) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "retried publish", publish_dup_packet) conn.send(pubrec_packet) paho_test.expect_packet(conn, "pubrel", pubrel_packet) # Disconnect client. It should reconnect. conn.close() (conn, address) = sock.accept() conn.settimeout(15) # Complete connection and message flow. paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "retried pubrel", pubrel_packet) conn.send(pubcomp_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-helper-qos0-v5.py000077500000000000000000000026731413423552100234370ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct PUBLISH to a topic with QoS 0. # Use paho.mqtt.publish helper for that. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id publish-helper-qos0-test # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a PUBLISH message # to topic "pub/qos0/test" with payload "message" and QoS=0. If rc!=0, the # client should exit with an error. # After sending the PUBLISH message, the client should send a # DISCONNECT message. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect( "publish-helper-qos0-test", keepalive=keepalive, proto_ver=5, properties=None ) connack_packet = paho_test.gen_connack(rc=0, proto_ver=5) publish_packet = paho_test.gen_publish( u"pub/qos0/test", qos=0, payload="message", proto_ver=5 ) disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-helper-qos0.py000077500000000000000000000026041413423552100231010ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct PUBLISH to a topic with QoS 0. # Use paho.mqtt.publish helper for that. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id publish-helper-qos0-test # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a PUBLISH message # to topic "pub/qos0/test" with payload "message" and QoS=0. If rc!=0, the # client should exit with an error. # After sending the PUBLISH message, the client should send a # DISCONNECT message. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect( "publish-helper-qos0-test", keepalive=keepalive, ) connack_packet = paho_test.gen_connack(rc=0) publish_packet = paho_test.gen_publish( u"pub/qos0/test", qos=0, payload="message" ) disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-helper-qos1-disconnect.py000077500000000000000000000027171413423552100252360ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct PUBLISH to a topic with QoS 1, # then responds correctly to a disconnect. # Use paho.mqtt.publish helper for that. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect( "publish-helper-qos1-disconnect-test", keepalive=keepalive, ) connack_packet = paho_test.gen_connack(rc=0) mid = 1 publish_packet = paho_test.gen_publish( u"pub/qos1/test", qos=1, mid=mid, payload="message" ) publish_packet_dup = paho_test.gen_publish( u"pub/qos1/test", qos=1, mid=mid, payload="message", dup=True, ) puback_packet = paho_test.gen_puback(mid) disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) # Disconnect client. It should reconnect. conn.close() (conn, address) = sock.accept() conn.settimeout(15) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "retried publish", publish_packet_dup) conn.send(puback_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-qos0-no-payload.py000077500000000000000000000025301413423552100236630ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct PUBLISH to a topic with QoS 0 and no payload. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id publish-qos0-test-np # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a PUBLISH message # to topic "pub/qos0/no-payload/test" with zero length payload and QoS=0. If # rc!=0, the client should exit with an error. # After sending the PUBLISH message, the client should send a DISCONNECT message. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("publish-qos0-test-np", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) publish_packet = paho_test.gen_publish(u"pub/qos0/no-payload/test", qos=0) disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/03-publish-qos0.py000077500000000000000000000024761413423552100216330ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct PUBLISH to a topic with QoS 0. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id publish-qos0-test # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a PUBLISH message # to topic "pub/qos0/test" with payload "message" and QoS=0. If rc!=0, the # client should exit with an error. # After sending the PUBLISH message, the client should send a DISCONNECT message. import context import paho_test rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("publish-qos0-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) publish_packet = paho_test.gen_publish(u"pub/qos0/test", qos=0, payload="message") disconnect_packet = paho_test.gen_disconnect() sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/04-retain-qos0.py000077500000000000000000000014501413423552100214370ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client sends a correct retained PUBLISH to a topic with QoS 0. import context import paho_test rc = 1 keepalive = 60 mid = 16 connect_packet = paho_test.gen_connect("retain-qos0-test", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) publish_packet = paho_test.gen_publish( u"retain/qos0/test", qos=0, payload="retained message", retain=True) sock = paho_test.create_server_socket() client = context.start_client() try: (conn, address) = sock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "publish", publish_packet) rc = 0 conn.close() finally: client.terminate() client.wait() sock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/08-ssl-bad-cacert.py000077500000000000000000000002261413423552100220650ustar00rootroot00000000000000#!/usr/bin/env python3 import context context.check_ssl() rc = 1 client = context.start_client() client.wait() rc = client.returncode exit(rc) paho.mqtt.python-1.6.1/test/lib/08-ssl-connect-cert-auth-pw.py000077500000000000000000000024671413423552100240600ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect and subsequent disconnect when using SSL. # Client must provide a certificate - the private key is encrypted with a password. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id 08-ssl-connect-crt-auth # It should use the CA certificate ssl/all-ca.crt for verifying the server. # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a DISCONNECT # message. If rc!=0, the client should exit with an error. import context import paho_test from paho_test import ssl context.check_ssl() rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("08-ssl-connect-crt-auth-pw", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() ssock = paho_test.create_server_socket_ssl(cert_reqs=ssl.CERT_REQUIRED) client = context.start_client() try: (conn, address) = ssock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() ssock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/08-ssl-connect-cert-auth.py000077500000000000000000000024051413423552100234240ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect and subsequent disconnect when using SSL. # Client must provide a certificate. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id 08-ssl-connect-crt-auth # It should use the CA certificate ssl/all-ca.crt for verifying the server. # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a DISCONNECT # message. If rc!=0, the client should exit with an error. import context import paho_test from paho_test import ssl context.check_ssl() rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("08-ssl-connect-crt-auth", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() ssock = paho_test.create_server_socket_ssl(cert_reqs=ssl.CERT_REQUIRED) client = context.start_client() try: (conn, address) = ssock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() ssock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/08-ssl-connect-no-auth.py000077500000000000000000000022511413423552100231020ustar00rootroot00000000000000#!/usr/bin/env python3 # Test whether a client produces a correct connect and subsequent disconnect when using SSL. # The client should connect to port 1888 with keepalive=60, clean session set, # and client id 08-ssl-connect-no-auth # It should use the CA certificate ssl/all-ca.crt for verifying the server. # The test will send a CONNACK message to the client with rc=0. Upon receiving # the CONNACK and verifying that rc=0, the client should send a DISCONNECT # message. If rc!=0, the client should exit with an error. import context import paho_test context.check_ssl() rc = 1 keepalive = 60 connect_packet = paho_test.gen_connect("08-ssl-connect-no-auth", keepalive=keepalive) connack_packet = paho_test.gen_connack(rc=0) disconnect_packet = paho_test.gen_disconnect() ssock = paho_test.create_server_socket_ssl() client = context.start_client() try: (conn, address) = ssock.accept() conn.settimeout(10) paho_test.expect_packet(conn, "connect", connect_packet) conn.send(connack_packet) paho_test.expect_packet(conn, "disconnect", disconnect_packet) rc = 0 conn.close() finally: client.terminate() client.wait() ssock.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/08-ssl-fake-cacert.py000077500000000000000000000007761413423552100222570ustar00rootroot00000000000000#!/usr/bin/env python3 import time import context import paho_test from paho_test import ssl context.check_ssl() ssock = paho_test.create_server_socket_ssl(cert_reqs=ssl.CERT_REQUIRED) client = context.start_client() try: (conn, address) = ssock.accept() conn.close() except ssl.SSLError: # Expected error due to ca certs not matching. pass finally: time.sleep(1.0) client.terminate() client.wait() ssock.close() if client.returncode == 0: exit(0) else: exit(1) paho.mqtt.python-1.6.1/test/lib/Makefile000066400000000000000000000040611413423552100201400ustar00rootroot00000000000000.PHONY: all test .NOTPARALLEL: PYTHON?=python3 all : test : $(PYTHON) ./01-asyncio.py python/01-asyncio.test $(PYTHON) ./01-decorators.py python/01-decorators.test $(PYTHON) ./01-keepalive-pingreq.py python/01-keepalive-pingreq.test $(PYTHON) ./01-no-clean-session.py python/01-no-clean-session.test $(PYTHON) ./01-reconnect-on-failure.py python/01-reconnect-on-failure.test $(PYTHON) ./01-unpwd-empty-password-set.py python/01-unpwd-empty-password-set.test $(PYTHON) ./01-unpwd-empty-set.py python/01-unpwd-empty-set.test $(PYTHON) ./01-unpwd-set.py python/01-unpwd-set.test $(PYTHON) ./01-unpwd-unicode-set.py python/01-unpwd-unicode-set.test $(PYTHON) ./01-will-set.py python/01-will-set.test $(PYTHON) ./01-will-unpwd-set.py python/01-will-unpwd-set.test $(PYTHON) ./01-zero-length-clientid.py python/01-zero-length-clientid.test $(PYTHON) ./02-subscribe-qos0.py python/02-subscribe-qos0.test $(PYTHON) ./02-subscribe-qos1.py python/02-subscribe-qos1.test $(PYTHON) ./02-subscribe-qos2.py python/02-subscribe-qos2.test $(PYTHON) ./02-unsubscribe.py python/02-unsubscribe.test $(PYTHON) ./03-publish-b2c-qos1.py python/03-publish-b2c-qos1.test $(PYTHON) ./03-publish-c2b-qos1-disconnect.py python/03-publish-c2b-qos1-disconnect.test $(PYTHON) ./03-publish-c2b-qos2-disconnect.py python/03-publish-c2b-qos2-disconnect.test $(PYTHON) ./03-publish-helper-qos0.py python/03-publish-helper-qos0.test $(PYTHON) ./03-publish-helper-qos0-v5.py python/03-publish-helper-qos0-v5.test $(PYTHON) ./03-publish-helper-qos1-disconnect.py python/03-publish-helper-qos1-disconnect.test $(PYTHON) ./03-publish-qos0-no-payload.py python/03-publish-qos0-no-payload.test $(PYTHON) ./03-publish-qos0.py python/03-publish-qos0.test $(PYTHON) ./04-retain-qos0.py python/04-retain-qos0.test $(PYTHON) ./08-ssl-bad-cacert.py python/08-ssl-bad-cacert.test $(PYTHON) ./08-ssl-connect-cert-auth-pw.py python/08-ssl-connect-cert-auth-pw.test $(PYTHON) ./08-ssl-connect-cert-auth.py python/08-ssl-connect-cert-auth.test $(PYTHON) ./08-ssl-connect-no-auth.py python/08-ssl-connect-no-auth.test paho.mqtt.python-1.6.1/test/lib/context.py000066400000000000000000000023141413423552100205350ustar00rootroot00000000000000# -*- coding: utf-8 -*- import os import subprocess import sys try: import ssl except ImportError: ssl = None # Ensure can import paho_test package try: import paho_test except ImportError: # This part is only required when paho_test module is not on Python path # From http://stackoverflow.com/questions/279237/python-import-a-module-from-a-folder import inspect cmd_subfolder = os.path.realpath( os.path.abspath( os.path.join( os.path.split( inspect.getfile(inspect.currentframe()) )[0], "..", ) ) ) if cmd_subfolder not in sys.path: sys.path.insert(0, cmd_subfolder) import paho_test env = dict(os.environ) pp = env.get('PYTHONPATH', '') env['PYTHONPATH'] = '../../src' + os.pathsep + pp def start_client(): args = [sys.executable, ] + sys.argv[1:] client = subprocess.Popen(args, env=env) return client def check_ssl(): if ssl is None: print("WARNING: SSL not available in current environment") exit(0) if not hasattr(ssl, 'SSLContext'): print("WARNING: SSL without SSLContext is not supported") exit(0) paho.mqtt.python-1.6.1/test/lib/python/000077500000000000000000000000001413423552100200205ustar00rootroot00000000000000paho.mqtt.python-1.6.1/test/lib/python/01-asyncio.test000077500000000000000000000054671413423552100226230ustar00rootroot00000000000000#!/usr/bin/env python3 import asyncio import socket import uuid import context # Ensures paho is in PYTHONPATH import paho.mqtt.client as mqtt client_id = 'asyncio-test' class AsyncioHelper: def __init__(self, loop, client): self.loop = loop self.client = client self.client.on_socket_open = self.on_socket_open self.client.on_socket_close = self.on_socket_close self.client.on_socket_register_write = self.on_socket_register_write self.client.on_socket_unregister_write = self.on_socket_unregister_write def on_socket_open(self, client, userdata, sock): def cb(): client.loop_read() self.loop.add_reader(sock, cb) self.misc = self.loop.create_task(self.misc_loop()) def on_socket_close(self, client, userdata, sock): self.loop.remove_reader(sock) self.misc.cancel() def on_socket_register_write(self, client, userdata, sock): def cb(): client.loop_write() self.loop.add_writer(sock, cb) def on_socket_unregister_write(self, client, userdata, sock): self.loop.remove_writer(sock) async def misc_loop(self): while self.client.loop_misc() == mqtt.MQTT_ERR_SUCCESS: try: await asyncio.sleep(1) except asyncio.CancelledError: break class AsyncMqttExample: def __init__(self, loop): self.loop = loop self.payload = "" self.complete = False def on_connect(self, client, obj, flags, rc): client.subscribe("sub-test", 1) def on_subscribe(self, client, obj, mid, granted_qos): client.unsubscribe("unsub-test") def on_unsubscribe(self, client, obj, mid): self.payload = "message" def on_message(self, client, obj, msg): client.publish("asyncio", qos=1, payload=self.payload) def on_publish(self, client, obj, mid): client.disconnect() def on_disconnect(self, client, userdata, rc): self.disconnected.set_result(rc) async def main(self): global rc self.disconnected = self.loop.create_future() self.client = mqtt.Client(client_id=client_id) self.client.on_connect = self.on_connect self.client.on_message = self.on_message self.client.on_publish = self.on_publish self.client.on_subscribe = self.on_subscribe self.client.on_unsubscribe = self.on_unsubscribe self.client.on_disconnect = self.on_disconnect aioh = AsyncioHelper(self.loop, self.client) self.client.connect('localhost', 1888, 60) self.client.socket().setsockopt(socket.SOL_SOCKET, socket.SO_SNDBUF, 2048) await self.disconnected rc = 0 rc = 1 loop = asyncio.get_event_loop() loop.run_until_complete(AsyncMqttExample(loop).main()) loop.close() exit(rc) paho.mqtt.python-1.6.1/test/lib/python/01-decorators.test000077500000000000000000000016171413423552100233140ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt run = -1 mqttc = mqtt.Client("decorators-test", run) payload = b"" @mqttc.connect_callback() def on_connect(mqttc, obj, flags, rc): mqttc.subscribe("sub-test", 1) @mqttc.subscribe_callback() def on_subscribe(mqttc, obj, mid, granted_qos): mqttc.unsubscribe("unsub-test") @mqttc.unsubscribe_callback() def on_unsubscribe(mqttc, obj, mid): global payload payload = "message" @mqttc.message_callback() def on_message(mqttc, obj, msg): global payload mqttc.publish("decorators", qos=1, payload=payload) @mqttc.publish_callback() def on_publish(mqttc, obj, mid): mqttc.disconnect() @mqttc.disconnect_callback() def on_disconnect(mqttc, obj, rc): obj = rc mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-keepalive-pingreq.test000077500000000000000000000005771413423552100245630ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) run = -1 mqttc = mqtt.Client("01-keepalive-pingreq") mqttc.on_connect = on_connect mqttc.connect("localhost", 1888, 4) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-no-clean-session.test000077500000000000000000000003031413423552100243130ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.client as mqtt mqttc = mqtt.Client("01-no-clean-session", False) run = -1 mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-reconnect-on-failure.test000077500000000000000000000006221413423552100251610ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): mqttc.publish("reconnect/test", "message") mqttc = mqtt.Client("01-reconnect-on-failure", reconnect_on_failure=False) mqttc.on_connect = on_connect mqttc.connect("localhost", 1888) mqttc.loop_forever() exit(42) paho.mqtt.python-1.6.1/test/lib/python/01-unpwd-empty-password-set.test000077500000000000000000000003301413423552100260600ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.client as mqtt mqttc = mqtt.Client("01-unpwd-set") run = -1 mqttc.username_pw_set("uname", "") mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-unpwd-empty-set.test000077500000000000000000000003231413423552100242220ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.client as mqtt mqttc = mqtt.Client("01-unpwd-set") run = -1 mqttc.username_pw_set("", "") mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-unpwd-set.test000077500000000000000000000003411413423552100230660ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.client as mqtt mqttc = mqtt.Client("01-unpwd-set") run = -1 mqttc.username_pw_set("uname", ";'[08gn=#") mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-unpwd-unicode-set.test000077500000000000000000000005471413423552100245220ustar00rootroot00000000000000#!/usr/bin/env python3 from __future__ import unicode_literals import paho.mqtt.client as mqtt mqttc = mqtt.Client("01-unpwd-unicode-set") run = -1 username = "\u00fas\u00e9rn\u00e1m\u00e9-h\u00e9ll\u00f3" password = "h\u00e9ll\u00f3" mqttc.username_pw_set(username, password) mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-will-set.test000077500000000000000000000003761413423552100227100ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.client as mqtt mqttc = mqtt.Client("01-will-set") run = -1 mqttc.will_set("topic/on/unexpected/disconnect", "will message", 1, True) mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-will-unpwd-set.test000077500000000000000000000004471413423552100240420ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.client as mqtt mqttc = mqtt.Client("01-will-unpwd-set") run = -1 mqttc.username_pw_set("oibvvwqw", "#'^2hg9a&nm38*us") mqttc.will_set("will-topic", "will message", 2, False) mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/01-zero-length-clientid.test000077500000000000000000000010211413423552100251630ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.disconnect() def on_disconnect(mqttc, obj, rc): mqttc.loop() obj = rc run = -1 mqttc = mqtt.Client("", run, protocol=mqtt.MQTTv311) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/02-subscribe-qos0.test000077500000000000000000000011611413423552100240030ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.subscribe("qos0/test", 0) def on_disconnect(mqttc, obj, rc): obj = rc def on_subscribe(mqttc, obj, mid, granted_qos): mqttc.disconnect() run = -1 mqttc = mqtt.Client("subscribe-qos0-test", run) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.on_subscribe = on_subscribe mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/02-subscribe-qos1.test000077500000000000000000000011611413423552100240040ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.subscribe("qos1/test", 1) def on_disconnect(mqttc, obj, rc): obj = rc def on_subscribe(mqttc, obj, mid, granted_qos): mqttc.disconnect() run = -1 mqttc = mqtt.Client("subscribe-qos1-test", run) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.on_subscribe = on_subscribe mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/02-subscribe-qos2.test000077500000000000000000000011611413423552100240050ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.subscribe("qos2/test", 2) def on_disconnect(mqttc, obj, rc): obj = rc def on_subscribe(mqttc, obj, mid, granted_qos): mqttc.disconnect() run = -1 mqttc = mqtt.Client("subscribe-qos2-test", run) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.on_subscribe = on_subscribe mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/02-unsubscribe.test000077500000000000000000000011551413423552100234710ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.unsubscribe("unsubscribe/test") def on_disconnect(mqttc, obj, rc): obj = rc def on_unsubscribe(mqttc, obj, mid): mqttc.disconnect() run = -1 mqttc = mqtt.Client("unsubscribe-test", run) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.on_unsubscribe = on_unsubscribe mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/03-publish-b2c-qos1.test000077500000000000000000000020721413423552100241400ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt if sys.version_info[0] < 3: expected_payload = "message" else: expected_payload = b"message" def on_message(mqttc, obj, msg): if msg.mid != 123: print("Invalid mid: ("+str(msg.mid)+")") exit(1) if msg.topic != "pub/qos1/receive": print("Invalid topic: ("+str(msg.topic)+")") exit(1) if msg.payload != expected_payload: print("Invalid payload: ("+str(msg.payload)+")") exit(1) if msg.qos != 1: print("Invalid qos: ("+str(msg.qos)+")") exit(1) if msg.retain != False: print("Invalid retain: ("+str(msg.retain)+")") exit(1) def on_connect(mqttc, obj, flags, rc): if rc != 0: print("Connect failed ("+str(rc)+")") exit(rc) mqttc = mqtt.Client("publish-qos1-test") mqttc.on_connect = on_connect mqttc.on_message = on_message mqttc.connect("localhost", 1888) rc = 0 while rc == 0: rc = mqttc.loop() exit(0) paho.mqtt.python-1.6.1/test/lib/python/03-publish-b2c-qos2.test000077500000000000000000000021071413423552100241400ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt if sys.version_info[0] < 3: expected_payload = "message" else: expected_payload = b"message" def on_message(mqttc, obj, msg): global run if msg.mid != 13423: print("Invalid mid ("+str(msg.mid)+")") exit(1) if msg.topic != "pub/qos2/receive": print("Invalid topic ("+str(msg.topic)+")") exit(1) if msg.payload != expected_payload: print("Invalid payload ("+str(msg.payload)+")") exit(1) if msg.qos != 2: print("Invalid qos ("+str(msg.qos)+")") exit(1) if msg.retain != False: print("Invalid retain ("+str(msg.retain)+")") exit(1) run = 0 def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) run = -1 mqttc = mqtt.Client("publish-qos2-test", run) mqttc.on_connect = on_connect mqttc.on_message = on_message mqttc.connect("localhost", 1888) rc = 0 while run == -1 and rc == 0: rc = mqttc.loop(0.3) exit(run) paho.mqtt.python-1.6.1/test/lib/python/03-publish-c2b-qos1-disconnect.test000077500000000000000000000015461413423552100262740ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt sent_mid = -1 def on_connect(mqttc, obj, flags, rc): global sent_mid if rc != 0: exit(rc) else: if sent_mid == -1: res = mqttc.publish("pub/qos1/test", "message", 1) sent_mid = res[1] def on_disconnect(mqttc, obj, rc): if rc == mqtt.MQTT_ERR_SUCCESS: run = 0 else: mqttc.reconnect() def on_publish(mqttc, obj, mid): global sent_mid if mid == sent_mid: mqttc.disconnect() else: exit(1) mqttc = mqtt.Client("publish-qos1-test", clean_session=False) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.on_publish = on_publish mqttc.connect("localhost", 1888) rc = 0 while True: rc = mqttc.loop() paho.mqtt.python-1.6.1/test/lib/python/03-publish-c2b-qos2-disconnect.test000077500000000000000000000014331413423552100262700ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt first_connection = 1 def on_connect(mqttc, obj, flags, rc): global first_connection if rc != 0: exit(rc) else: if first_connection == 1: mqttc.publish("pub/qos2/test", "message", 2) first_connection = 0 def on_disconnect(mqttc, obj, rc): if rc == 0: run = 0 else: mqttc.reconnect() def on_publish(mqttc, obj, mid): mqttc.disconnect() mqttc = mqtt.Client("publish-qos2-test", clean_session=False) mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.on_publish = on_publish mqttc.connect("localhost", 1888) rc = 0 while True: rc = mqttc.loop() paho.mqtt.python-1.6.1/test/lib/python/03-publish-helper-qos0-v5.test000077500000000000000000000004161413423552100253000ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.client import paho.mqtt.publish paho.mqtt.publish.single( "pub/qos0/test", "message", qos=0, hostname="localhost", port=1888, client_id="publish-helper-qos0-test", protocol=paho.mqtt.client.MQTTv5 ) paho.mqtt.python-1.6.1/test/lib/python/03-publish-helper-qos0.test000077500000000000000000000003211413423552100247430ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.publish paho.mqtt.publish.single( "pub/qos0/test", "message", qos=0, hostname="localhost", port=1888, client_id="publish-helper-qos0-test", ) paho.mqtt.python-1.6.1/test/lib/python/03-publish-helper-qos1-disconnect.test000077500000000000000000000003341413423552100270770ustar00rootroot00000000000000#!/usr/bin/env python3 import paho.mqtt.publish paho.mqtt.publish.single( "pub/qos1/test", "message", qos=1, hostname="localhost", port=1888, client_id="publish-helper-qos1-disconnect-test", ) paho.mqtt.python-1.6.1/test/lib/python/03-publish-qos0-no-payload.test000077500000000000000000000012151413423552100255320ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt sent_mid = -1 def on_connect(mqttc, obj, flags, rc): global sent_mid if rc != 0: exit(rc) else: (res, sent_mid) = mqttc.publish("pub/qos0/no-payload/test") def on_publish(mqttc, obj, mid): global sent_mid, run if sent_mid == mid: mqttc.disconnect() run = 0 run = -1 mqttc = mqtt.Client("publish-qos0-test-np", run) mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/03-publish-qos0.test000077500000000000000000000012101413423552100234640ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt sent_mid = -1 def on_connect(mqttc, obj, flags, rc): global sent_mid if rc != 0: exit(rc) else: res = mqttc.publish("pub/qos0/test", "message") sent_mid = res[1] def on_publish(mqttc, obj, mid): global sent_mid, run if sent_mid == mid: mqttc.disconnect() run = -1 mqttc = mqtt.Client("publish-qos0-test", run) mqttc.on_connect = on_connect mqttc.on_publish = on_publish mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/04-retain-qos0.test000077500000000000000000000007161413423552100233130ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.publish("retain/qos0/test", "retained message", 0, True) run = -1 mqttc = mqtt.Client("retain-qos0-test", run) mqttc.on_connect = on_connect mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/08-ssl-bad-cacert.test000077500000000000000000000006051413423552100237360ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt if sys.version_info < (2, 7, 9): print("WARNING: SSL/TLS not supported on Python 2.6") exit(0) rc = 1 mqttc = mqtt.Client("08-ssl-bad-cacert") try: mqttc.tls_set("this/file/doesnt/exist") except IOError as err: rc = 0 exit(rc) paho.mqtt.python-1.6.1/test/lib/python/08-ssl-connect-cert-auth-pw.test000077500000000000000000000013321413423552100257160ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt if sys.version_info < (2, 7, 9): print("WARNING: SSL/TLS not supported on Python 2.6") exit(0) def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.disconnect() def on_disconnect(mqttc, obj, rc): obj = rc run = -1 mqttc = mqtt.Client("08-ssl-connect-crt-auth-pw", run) mqttc.tls_set("../ssl/all-ca.crt", "../ssl/client-pw.crt", "../ssl/client-pw.key", keyfile_password="password") mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/08-ssl-connect-cert-auth.test000077500000000000000000000012641413423552100252760ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt if sys.version_info < (2, 7, 9): print("WARNING: SSL/TLS not supported on Python 2.6") exit(0) def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.disconnect() def on_disconnect(mqttc, obj, rc): obj = rc run = -1 mqttc = mqtt.Client("08-ssl-connect-crt-auth", run) mqttc.tls_set("../ssl/all-ca.crt", "../ssl/client.crt", "../ssl/client.key") mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/08-ssl-connect-no-auth.test000077500000000000000000000012111413423552100247450ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt if sys.version_info < (2, 7, 9): print("WARNING: SSL/TLS not supported on Python 2.6") exit(0) def on_connect(mqttc, obj, flags, rc): if rc != 0: exit(rc) else: mqttc.disconnect() def on_disconnect(mqttc, obj, rc): obj = rc run = -1 mqttc = mqtt.Client("08-ssl-connect-no-auth", run) mqttc.tls_set("../ssl/all-ca.crt") mqttc.on_connect = on_connect mqttc.on_disconnect = on_disconnect mqttc.connect("localhost", 1888) while run == -1: mqttc.loop() exit(run) paho.mqtt.python-1.6.1/test/lib/python/08-ssl-fake-cacert.test000077500000000000000000000012421413423552100241140ustar00rootroot00000000000000#!/usr/bin/env python3 import os import socket import ssl import subprocess import sys import time from struct import * import paho.mqtt.client as mqtt if sys.version_info < (2, 7, 9): print("WARNING: SSL/TLS not supported on Python 2.6") exit(0) def on_connect(mqttc, obj, flags, rc): exit(1) mqttc = mqtt.Client("08-ssl-fake-cacert") mqttc.tls_set("../ssl/test-fake-root-ca.crt", "../ssl/client.crt", "../ssl/client.key") mqttc.on_connect = on_connect try: mqttc.connect("localhost", 1888) except ssl.SSLError as msg: if msg.errno == 1 and "certificate verify failed" in msg.strerror: exit(0) else: exit(1) else: exit(1) paho.mqtt.python-1.6.1/test/mqtt5_opts.py000066400000000000000000000002661413423552100204260ustar00rootroot00000000000000MQTT_SUB_OPT_NO_LOCAL = 0x04 MQTT_SUB_OPT_RETAIN_AS_PUBLISHED = 0x08 MQTT_SUB_OPT_SEND_RETAIN_ALWAYS = 0x00 MQTT_SUB_OPT_SEND_RETAIN_NEW = 0x10 MQTT_SUB_OPT_SEND_RETAIN_NEVER = 0x20 paho.mqtt.python-1.6.1/test/mqtt5_props.py000066400000000000000000000040061413423552100206000ustar00rootroot00000000000000import struct PROP_PAYLOAD_FORMAT_INDICATOR = 1 PROP_MESSAGE_EXPIRY_INTERVAL = 2 PROP_CONTENT_TYPE = 3 PROP_RESPONSE_TOPIC = 8 PROP_CORRELATION_DATA = 9 PROP_SUBSCRIPTION_IDENTIFIER = 11 PROP_SESSION_EXPIRY_INTERVAL = 17 PROP_ASSIGNED_CLIENT_IDENTIFIER = 18 PROP_SERVER_KEEP_ALIVE = 19 PROP_AUTHENTICATION_METHOD = 21 PROP_AUTHENTICATION_DATA = 22 PROP_REQUEST_PROBLEM_INFO = 23 PROP_WILL_DELAY_INTERVAL = 24 PROP_REQUEST_RESPONSE_INFO = 25 PROP_RESPONSE_INFO = 26 PROP_SERVER_REFERENCE = 28 PROP_REASON_STRING = 31 PROP_RECEIVE_MAXIMUM = 33 PROP_TOPIC_ALIAS_MAXIMUM = 34 PROP_TOPIC_ALIAS = 35 PROP_MAXIMUM_QOS = 36 PROP_RETAIN_AVAILABLE = 37 PROP_USER_PROPERTY = 38 PROP_MAXIMUM_PACKET_SIZE = 39 PROP_WILDCARD_SUB_AVAILABLE = 40 PROP_SUBSCRIPTION_ID_AVAILABLE = 41 PROP_SHARED_SUB_AVAILABLE = 42 def gen_byte_prop(identifier, byte): prop = struct.pack('BB', identifier, byte) return prop def gen_uint16_prop(identifier, word): prop = struct.pack('!BH', identifier, word) return prop def gen_uint32_prop(identifier, word): prop = struct.pack('!BI', identifier, word) return prop def gen_string_prop(identifier, s): s = s.encode("utf-8") prop = struct.pack('!BH%ds'%(len(s)), identifier, len(s), s) return prop def gen_string_pair_prop(identifier, s1, s2): s1 = s1.encode("utf-8") s2 = s2.encode("utf-8") prop = struct.pack('!BH%dsH%ds'%(len(s1), len(s2)), identifier, len(s1), s1, len(s2), s2) return prop def gen_varint_prop(identifier, val): v = pack_varint(val) return struct.pack("!B"+str(len(v))+"s", identifier, v) def pack_varint(varint): s = b"" while True: byte = varint % 128 varint = varint // 128 # If there are more digits to encode, set the top bit of this digit if varint > 0: byte = byte | 0x80 s = s + struct.pack("!B", byte) if varint == 0: return s def prop_finalise(props): if props is None: return pack_varint(0) else: return pack_varint(len(props)) + props paho.mqtt.python-1.6.1/test/mqtt5_rc.py000066400000000000000000000027311413423552100200440ustar00rootroot00000000000000MQTT_RC_SUCCESS = 0 MQTT_RC_NORMAL_DISCONNECTION = 0 MQTT_RC_GRANTED_QOS0 = 0 MQTT_RC_GRANTED_QOS1 = 1 MQTT_RC_GRANTED_QOS2 = 2 MQTT_RC_DISCONNECT_WITH_WILL_MSG = 4 MQTT_RC_NO_MATCHING_SUBSCRIBERS = 16 MQTT_RC_NO_SUBSCRIPTION_EXISTED = 17 MQTT_RC_CONTINUE_AUTHENTICATION = 24 MQTT_RC_REAUTHENTICATE = 25 MQTT_RC_UNSPECIFIED = 128 MQTT_RC_MALFORMED_PACKET = 129 MQTT_RC_PROTOCOL_ERROR = 130 MQTT_RC_IMPLEMENTATION_SPECIFIC = 131 MQTT_RC_UNSUPPORTED_PROTOCOL_VERSION = 132 MQTT_RC_CLIENTID_NOT_VALID = 133 MQTT_RC_BAD_USERNAME_OR_PASSWORD = 134 MQTT_RC_NOT_AUTHORIZED = 135 MQTT_RC_SERVER_UNAVAILABLE = 136 MQTT_RC_SERVER_BUSY = 137 MQTT_RC_BANNED = 138 MQTT_RC_SERVER_SHUTTING_DOWN = 139 MQTT_RC_BAD_AUTHENTICATION_METHOD = 140 MQTT_RC_KEEP_ALIVE_TIMEOUT = 141 MQTT_RC_SESSION_TAKEN_OVER = 142 MQTT_RC_TOPIC_FILTER_INVALID = 143 MQTT_RC_TOPIC_NAME_INVALID = 144 MQTT_RC_PACKET_ID_IN_USE = 145 MQTT_RC_PACKET_ID_NOT_FOUND = 146 MQTT_RC_RECEIVE_MAXIMUM_EXCEEDED = 147 MQTT_RC_TOPIC_ALIAS_INVALID = 148 MQTT_RC_PACKET_TOO_LARGE = 149 MQTT_RC_MESSAGE_RATE_TOO_HIGH = 150 MQTT_RC_QUOTA_EXCEEDED = 151 MQTT_RC_ADMINISTRATIVE_ACTION = 152 MQTT_RC_PAYLOAD_FORMAT_INVALID = 153 MQTT_RC_RETAIN_NOT_SUPPORTED = 154 MQTT_RC_QOS_NOT_SUPPORTED = 155 MQTT_RC_USE_ANOTHER_SERVER = 156 MQTT_RC_SERVER_MOVED = 157 MQTT_RC_SHARED_SUBS_NOT_SUPPORTED = 158 MQTT_RC_CONNECTION_RATE_EXCEEDED = 159 MQTT_RC_MAXIMUM_CONNECT_TIME = 160 MQTT_RC_SUBSCRIPTION_IDS_NOT_SUPPORTED = 161 MQTT_RC_WILDCARD_SUBS_NOT_SUPPORTED = 162 paho.mqtt.python-1.6.1/test/paho_test.py000066400000000000000000000623421413423552100203000ustar00rootroot00000000000000import binascii import errno import os import socket import struct import subprocess import sys import time try: import ssl except ImportError: ssl = None import atexit import __main__ import mqtt5_props vg_index = 1 vg_logfiles = [] class TestError(Exception): def __init__(self, message="Mismatched packets"): self.message = message def create_server_socket(): sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) sock.settimeout(10) sock.bind(('', 1888)) sock.listen(5) return sock def create_server_socket_ssl(*args, **kwargs): if ssl is None: raise RuntimeError ssl_version = ssl.PROTOCOL_TLSv1 if hasattr(ssl, "PROTOCOL_TLS"): ssl_version = ssl.PROTOCOL_TLS sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) ssock = ssl.wrap_socket( sock, ca_certs="../ssl/all-ca.crt", keyfile="../ssl/server.key", certfile="../ssl/server.crt", server_side=True, ssl_version=ssl_version, **kwargs) ssock.settimeout(10) ssock.bind(('', 1888)) ssock.listen(5) return ssock def expect_packet(sock, name, expected): if len(expected) > 0: rlen = len(expected) else: rlen = 1 packet_recvd = b"" try: while len(packet_recvd) < rlen: data = sock.recv(rlen-len(packet_recvd)) if len(data) == 0: break packet_recvd += data except socket.timeout: pass if packet_matches(name, packet_recvd, expected): return True else: raise TestError def packet_matches(name, recvd, expected): if recvd != expected: print("FAIL: Received incorrect " + name + ".") try: print("Received: " + to_string(recvd)) except struct.error: print("Received (not decoded): 0x" + binascii.b2a_hex(recvd).decode('utf8')) try: print("Expected: " + to_string(expected)) except struct.error: print("Expected (not decoded): 0x" + binascii.b2a_hex(expected).decode('utf8')) return False else: return True def receive_unordered(sock, recv1_packet, recv2_packet, error_string): expected1 = recv1_packet + recv2_packet expected2 = recv2_packet + recv1_packet recvd = b'' while len(recvd) < len(expected1): r = sock.recv(1) if len(r) == 0: raise ValueError(error_string) recvd += r if recvd == expected1 or recvd == expected2: return else: packet_matches(error_string, recvd, expected2) raise ValueError(error_string) def do_send_receive(sock, send_packet, receive_packet, error_string="send receive error"): size = len(send_packet) total_sent = 0 while total_sent < size: sent = sock.send(send_packet[total_sent:]) if sent == 0: raise RuntimeError("socket connection broken") total_sent += sent if expect_packet(sock, error_string, receive_packet): return sock else: sock.close() raise ValueError # Useful for mocking a client receiving (with ack) a qos1 publish def do_receive_send(sock, receive_packet, send_packet, error_string="receive send error"): if expect_packet(sock, error_string, receive_packet): size = len(send_packet) total_sent = 0 while total_sent < size: sent = sock.send(send_packet[total_sent:]) if sent == 0: raise RuntimeError("socket connection broken") total_sent += sent return sock else: sock.close() raise ValueError def do_client_connect(connect_packet, connack_packet, hostname="localhost", port=1888, timeout=10, connack_error="connack"): sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.settimeout(timeout) sock.connect((hostname, port)) return do_send_receive(sock, connect_packet, connack_packet, connack_error) def remaining_length(packet): l = min(5, len(packet)) all_bytes = struct.unpack("!" + "B" * l, packet[:l]) mult = 1 rl = 0 for i in range(1, l - 1): byte = all_bytes[i] rl += (byte & 127) * mult mult *= 128 if byte & 128 == 0: packet = packet[i + 1:] break return (packet, rl) def to_hex_string(packet): if len(packet) == 0: return "" s = "" while len(packet) > 0: packet0 = struct.unpack("!B", packet[0]) s = s+hex(packet0[0]) + " " packet = packet[1:] return s def to_string(packet): if len(packet) == 0: return "" packet0 = struct.unpack("!B%ds" % (len(packet)-1), bytes(packet)) packet0 = packet0[0] cmd = packet0 & 0xF0 if cmd == 0x00: # Reserved return "0x00" elif cmd == 0x10: # CONNECT (packet, rl) = remaining_length(packet) pack_format = "!H" + str(len(packet) - 2) + 's' (slen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(slen) + 'sBBH' + str(len(packet) - slen - 4) + 's' (protocol, proto_ver, flags, keepalive, packet) = struct.unpack(pack_format, packet) s = "CONNECT, proto=" + str(protocol) + str(proto_ver) + ", keepalive=" + str(keepalive) if flags & 2: s = s + ", clean-session" else: s = s + ", durable" pack_format = "!H" + str(len(packet) - 2) + 's' (slen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(slen) + 's' + str(len(packet) - slen) + 's' (client_id, packet) = struct.unpack(pack_format, packet) s = s + ", id=" + str(client_id) if flags & 4: pack_format = "!H" + str(len(packet) - 2) + 's' (slen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(slen) + 's' + str(len(packet) - slen) + 's' (will_topic, packet) = struct.unpack(pack_format, packet) s = s + ", will-topic=" + str(will_topic) pack_format = "!H" + str(len(packet) - 2) + 's' (slen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(slen) + 's' + str(len(packet) - slen) + 's' (will_message, packet) = struct.unpack(pack_format, packet) s = s + ", will-message=" + will_message s = s + ", will-qos=" + str((flags & 24) >> 3) s = s + ", will-retain=" + str((flags & 32) >> 5) if flags & 128: pack_format = "!H" + str(len(packet) - 2) + 's' (slen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(slen) + 's' + str(len(packet) - slen) + 's' (username, packet) = struct.unpack(pack_format, packet) s = s + ", username=" + str(username) if flags & 64: pack_format = "!H" + str(len(packet) - 2) + 's' (slen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(slen) + 's' + str(len(packet) - slen) + 's' (password, packet) = struct.unpack(pack_format, packet) s = s + ", password=" + str(password) if flags & 1: s = s + ", reserved=1" return s elif cmd == 0x20: # CONNACK if len(packet) == 4: (cmd, rl, resv, rc) = struct.unpack('!BBBB', packet) return "CONNACK, rl="+str(rl)+", res="+str(resv)+", rc="+str(rc) elif len(packet) == 5: (cmd, rl, flags, reason_code, proplen) = struct.unpack('!BBBBB', packet) return "CONNACK, rl="+str(rl)+", flags="+str(flags)+", rc="+str(reason_code)+", proplen="+str(proplen) else: return "CONNACK, (not decoded)" elif cmd == 0x30: # PUBLISH dup = (packet0 & 0x08) >> 3 qos = (packet0 & 0x06) >> 1 retain = (packet0 & 0x01) (packet, rl) = remaining_length(packet) pack_format = "!H" + str(len(packet) - 2) + 's' (tlen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(tlen) + 's' + str(len(packet) - tlen) + 's' (topic, packet) = struct.unpack(pack_format, packet) s = "PUBLISH, rl=" + str(rl) + ", topic=" + str(topic) + ", qos=" + str(qos) + ", retain=" + str(retain) + ", dup=" + str(dup) if qos > 0: pack_format = "!H" + str(len(packet) - 2) + 's' (mid, packet) = struct.unpack(pack_format, packet) s = s + ", mid=" + str(mid) s = s + ", payload=" + str(packet) return s elif cmd == 0x40: # PUBACK if len(packet) == 5: (cmd, rl, mid, reason_code) = struct.unpack('!BBHB', packet) return "PUBACK, rl="+str(rl)+", mid="+str(mid)+", reason_code="+str(reason_code) else: (cmd, rl, mid) = struct.unpack('!BBH', packet) return "PUBACK, rl="+str(rl)+", mid="+str(mid) elif cmd == 0x50: # PUBREC if len(packet) == 5: (cmd, rl, mid, reason_code) = struct.unpack('!BBHB', packet) return "PUBREC, rl="+str(rl)+", mid="+str(mid)+", reason_code="+str(reason_code) else: (cmd, rl, mid) = struct.unpack('!BBH', packet) return "PUBREC, rl="+str(rl)+", mid="+str(mid) elif cmd == 0x60: # PUBREL dup = (packet0 & 0x08) >> 3 (cmd, rl, mid) = struct.unpack('!BBH', packet) return "PUBREL, rl=" + str(rl) + ", mid=" + str(mid) + ", dup=" + str(dup) elif cmd == 0x70: # PUBCOMP (cmd, rl, mid) = struct.unpack('!BBH', packet) return "PUBCOMP, rl=" + str(rl) + ", mid=" + str(mid) elif cmd == 0x80: # SUBSCRIBE (packet, rl) = remaining_length(packet) pack_format = "!H" + str(len(packet) - 2) + 's' (mid, packet) = struct.unpack(pack_format, packet) s = "SUBSCRIBE, rl=" + str(rl) + ", mid=" + str(mid) topic_index = 0 while len(packet) > 0: pack_format = "!H" + str(len(packet) - 2) + 's' (tlen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(tlen) + 'sB' + str(len(packet) - tlen - 1) + 's' (topic, qos, packet) = struct.unpack(pack_format, packet) s = s + ", topic" + str(topic_index) + "=" + str(topic) + "," + str(qos) return s elif cmd == 0x90: # SUBACK (packet, rl) = remaining_length(packet) pack_format = "!H" + str(len(packet) - 2) + 's' (mid, packet) = struct.unpack(pack_format, packet) pack_format = "!" + "B" * len(packet) granted_qos = struct.unpack(pack_format, packet) s = "SUBACK, rl=" + str(rl) + ", mid=" + str(mid) + ", granted_qos=" + str(granted_qos[0]) for i in range(1, len(granted_qos) - 1): s = s + ", " + str(granted_qos[i]) return s elif cmd == 0xA0: # UNSUBSCRIBE (packet, rl) = remaining_length(packet) pack_format = "!H" + str(len(packet) - 2) + 's' (mid, packet) = struct.unpack(pack_format, packet) s = "UNSUBSCRIBE, rl=" + str(rl) + ", mid=" + str(mid) topic_index = 0 while len(packet) > 0: pack_format = "!H" + str(len(packet) - 2) + 's' (tlen, packet) = struct.unpack(pack_format, packet) pack_format = "!" + str(tlen) + 's' + str(len(packet) - tlen) + 's' (topic, packet) = struct.unpack(pack_format, packet) s = s + ", topic" + str(topic_index) + "=" + str(topic) return s elif cmd == 0xB0: # UNSUBACK (cmd, rl, mid) = struct.unpack('!BBH', packet) return "UNSUBACK, rl=" + str(rl) + ", mid=" + str(mid) elif cmd == 0xC0: # PINGREQ (cmd, rl) = struct.unpack('!BB', packet) return "PINGREQ, rl=" + str(rl) elif cmd == 0xD0: # PINGRESP (cmd, rl) = struct.unpack('!BB', packet) return "PINGRESP, rl=" + str(rl) elif cmd == 0xE0: # DISCONNECT if len(packet) == 3: (cmd, rl, reason_code) = struct.unpack('!BBB', packet) return "DISCONNECT, rl="+str(rl)+", reason_code="+str(reason_code) else: (cmd, rl) = struct.unpack('!BB', packet) return "DISCONNECT, rl="+str(rl) elif cmd == 0xF0: # AUTH (cmd, rl) = struct.unpack('!BB', packet) return "AUTH, rl="+str(rl) def read_varint(sock, rl): varint = 0 multiplier = 1 while True: byte = sock.recv(1) byte, = struct.unpack("!B", byte) varint += (byte & 127)*multiplier multiplier *= 128 rl -= 1 if byte & 128 == 0x00: return (varint, rl) def mqtt_read_string(sock, rl): slen = sock.recv(2) slen, = struct.unpack("!H", slen) payload = sock.recv(slen) payload, = struct.unpack("!%ds" % (slen), payload) rl -= (2 + slen) return (payload, rl) def read_publish(sock, proto_ver=4): cmd, = struct.unpack("!B", sock.recv(1)) if cmd & 0xF0 != 0x30: raise ValueError qos = (cmd & 0x06) >> 1 rl, t = read_varint(sock, 0) topic, rl = mqtt_read_string(sock, rl) if qos > 0: sock.recv(2) rl -= 1 if proto_ver == 5: proplen, rl = read_varint(sock, rl) sock.recv(proplen) rl -= proplen payload = sock.recv(rl).decode('utf-8') return payload def gen_connect(client_id, clean_session=True, keepalive=60, username=None, password=None, will_topic=None, will_qos=0, will_retain=False, will_payload=b"", proto_ver=4, connect_reserved=False, properties=b"", will_properties=b"", session_expiry=-1): if (proto_ver&0x7F) == 3 or proto_ver == 0: remaining_length = 12 elif (proto_ver&0x7F) == 4 or proto_ver == 5: remaining_length = 10 else: raise ValueError if client_id is not None: client_id = client_id.encode("utf-8") remaining_length = remaining_length + 2+len(client_id) else: remaining_length = remaining_length + 2 connect_flags = 0 if connect_reserved: connect_flags = connect_flags | 0x01 if clean_session: connect_flags = connect_flags | 0x02 if proto_ver == 5: if properties == b"": properties += mqtt5_props.gen_uint16_prop(mqtt5_props.PROP_RECEIVE_MAXIMUM, 20) if session_expiry != -1: properties += mqtt5_props.gen_uint32_prop(mqtt5_props.PROP_SESSION_EXPIRY_INTERVAL, session_expiry) properties = mqtt5_props.prop_finalise(properties) remaining_length += len(properties) if will_topic is not None: will_topic = will_topic.encode('utf-8') remaining_length = remaining_length + 2 + len(will_topic) + 2 + len(will_payload) connect_flags = connect_flags | 0x04 | ((will_qos & 0x03) << 3) if will_retain: connect_flags = connect_flags | 32 if proto_ver == 5: will_properties = mqtt5_props.prop_finalise(will_properties) remaining_length += len(will_properties) if username is not None: username = username.encode('utf-8') remaining_length = remaining_length + 2 + len(username) connect_flags = connect_flags | 0x80 if password is not None: password = password.encode('utf-8') connect_flags = connect_flags | 0x40 remaining_length = remaining_length + 2 + len(password) rl = pack_remaining_length(remaining_length) packet = struct.pack("!B" + str(len(rl)) + "s", 0x10, rl) if (proto_ver&0x7F) == 3 or proto_ver == 0: packet = packet + struct.pack("!H6sBBH", len(b"MQIsdp"), b"MQIsdp", proto_ver, connect_flags, keepalive) elif (proto_ver&0x7F) == 4 or proto_ver == 5: packet = packet + struct.pack("!H4sBBH", len(b"MQTT"), b"MQTT", proto_ver, connect_flags, keepalive) if proto_ver == 5: packet += properties if client_id is not None: packet = packet + struct.pack("!H" + str(len(client_id)) + "s", len(client_id), bytes(client_id)) else: packet = packet + struct.pack("!H", 0) if will_topic is not None: packet += will_properties packet = packet + struct.pack("!H" + str(len(will_topic)) + "s", len(will_topic), will_topic) if len(will_payload) > 0: packet = packet + struct.pack("!H" + str(len(will_payload)) + "s", len(will_payload), will_payload.encode('utf8')) else: packet = packet + struct.pack("!H", 0) if username is not None: packet = packet + struct.pack("!H" + str(len(username)) + "s", len(username), username) if password is not None: packet = packet + struct.pack("!H" + str(len(password)) + "s", len(password), password) return packet def gen_connack(flags=0, rc=0, proto_ver=4, properties=b"", property_helper=True): if proto_ver == 5: if property_helper == True: if properties is not None: properties = mqtt5_props.gen_uint16_prop(mqtt5_props.PROP_TOPIC_ALIAS_MAXIMUM, 10) \ + properties + mqtt5_props.gen_uint16_prop(mqtt5_props.PROP_RECEIVE_MAXIMUM, 20) else: properties = b"" properties = mqtt5_props.prop_finalise(properties) packet = struct.pack('!BBBB', 32, 2+len(properties), flags, rc) + properties else: packet = struct.pack('!BBBB', 32, 2, flags, rc); return packet def gen_publish(topic, qos, payload=None, retain=False, dup=False, mid=0, proto_ver=4, properties=b""): if isinstance(topic, str): topic = topic.encode("utf-8") rl = 2+len(topic) pack_format = "H"+str(len(topic))+"s" if qos > 0: rl = rl + 2 pack_format = pack_format + "H" if proto_ver == 5: properties = mqtt5_props.prop_finalise(properties) rl += len(properties) # This will break if len(properties) > 127 pack_format = pack_format + "%ds"%(len(properties)) if payload is not None: payload = payload.encode("utf-8") rl = rl + len(payload) pack_format = pack_format + str(len(payload)) + "s" else: payload = b"" pack_format = pack_format + "0s" rlpacked = pack_remaining_length(rl) cmd = 48 | (qos << 1) if retain: cmd = cmd + 1 if dup: cmd = cmd + 8 if proto_ver == 5: if qos > 0: return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, mid, properties, payload) else: return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, properties, payload) else: if qos > 0: return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, mid, payload) else: return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, payload) def _gen_command_with_mid(cmd, mid, proto_ver=4, reason_code=-1, properties=None): if proto_ver == 5 and (reason_code != -1 or properties is not None): if reason_code == -1: reason_code = 0 if properties is None: return struct.pack('!BBHB', cmd, 3, mid, reason_code) elif properties == "": return struct.pack('!BBHBB', cmd, 4, mid, reason_code, 0) else: properties = mqtt5_props.prop_finalise(properties) pack_format = "!BBHB"+str(len(properties))+"s" return struct.pack(pack_format, cmd, 2+1+len(properties), mid, reason_code, properties) else: return struct.pack('!BBH', cmd, 2, mid) def gen_puback(mid, proto_ver=4, reason_code=-1, properties=None): return _gen_command_with_mid(64, mid, proto_ver, reason_code, properties) def gen_pubrec(mid, proto_ver=4, reason_code=-1, properties=None): return _gen_command_with_mid(80, mid, proto_ver, reason_code, properties) def gen_pubrel(mid, dup=False, proto_ver=4, reason_code=-1, properties=None): if dup: cmd = 96+8+2 else: cmd = 96+2 return _gen_command_with_mid(cmd, mid, proto_ver, reason_code, properties) def gen_pubcomp(mid, proto_ver=4, reason_code=-1, properties=None): return _gen_command_with_mid(112, mid, proto_ver, reason_code, properties) def gen_subscribe(mid, topic, qos, cmd=130, proto_ver=4, properties=b""): topic = topic.encode("utf-8") packet = struct.pack("!B", cmd) if proto_ver == 5: if properties == b"": packet += pack_remaining_length(2+1+2+len(topic)+1) pack_format = "!HBH"+str(len(topic))+"sB" return packet + struct.pack(pack_format, mid, 0, len(topic), topic, qos) else: properties = mqtt5_props.prop_finalise(properties) packet += pack_remaining_length(2+1+2+len(topic)+len(properties)) pack_format = "!H"+str(len(properties))+"s"+"H"+str(len(topic))+"sB" return packet + struct.pack(pack_format, mid, properties, len(topic), topic, qos) else: packet += pack_remaining_length(2+2+len(topic)+1) pack_format = "!HH"+str(len(topic))+"sB" return packet + struct.pack(pack_format, mid, len(topic), topic, qos) def gen_suback(mid, qos, proto_ver=4): if proto_ver == 5: return struct.pack('!BBHBB', 144, 2+1+1, mid, 0, qos) else: return struct.pack('!BBHB', 144, 2+1, mid, qos) def gen_unsubscribe(mid, topic, cmd=162, proto_ver=4, properties=b""): topic = topic.encode("utf-8") if proto_ver == 5: if properties == b"": pack_format = "!BBHBH"+str(len(topic))+"s" return struct.pack(pack_format, cmd, 2+2+len(topic)+1, mid, 0, len(topic), topic) else: properties = mqtt5_props.prop_finalise(properties) packet = struct.pack("!B", cmd) l = 2+2+len(topic)+1+len(properties) packet += pack_remaining_length(l) pack_format = "!HB"+str(len(properties))+"sH"+str(len(topic))+"s" packet += struct.pack(pack_format, mid, len(properties), properties, len(topic), topic) return packet else: pack_format = "!BBHH"+str(len(topic))+"s" return struct.pack(pack_format, cmd, 2+2+len(topic), mid, len(topic), topic) def gen_unsubscribe_multiple(mid, topics, proto_ver=4): packet = b"" remaining_length = 0 for t in topics: t = t.encode("utf-8") remaining_length += 2+len(t) packet += struct.pack("!H"+str(len(t))+"s", len(t), t) if proto_ver == 5: remaining_length += 2+1 return struct.pack("!BBHB", 162, remaining_length, mid, 0) + packet else: remaining_length += 2 return struct.pack("!BBH", 162, remaining_length, mid) + packet def gen_unsuback(mid, reason_code=0, proto_ver=4): if proto_ver == 5: if isinstance(reason_code, list): reason_code_count = len(reason_code) p = struct.pack('!BBHB', 176, 3+reason_code_count, mid, 0) for r in reason_code: p += struct.pack('B', r) return p else: return struct.pack('!BBHBB', 176, 4, mid, 0, reason_code) else: return struct.pack('!BBH', 176, 2, mid) def gen_pingreq(): return struct.pack('!BB', 192, 0) def gen_pingresp(): return struct.pack('!BB', 208, 0) def _gen_short(cmd, reason_code=-1, proto_ver=5, properties=None): if proto_ver == 5 and (reason_code != -1 or properties is not None): if reason_code == -1: reason_code = 0 if properties is None: return struct.pack('!BBB', cmd, 1, reason_code) elif properties == "": return struct.pack('!BBBB', cmd, 2, reason_code, 0) else: properties = mqtt5_props.prop_finalise(properties) return struct.pack("!BBB", cmd, 1+len(properties), reason_code) + properties else: return struct.pack('!BB', cmd, 0) def gen_disconnect(reason_code=-1, proto_ver=4, properties=None): return _gen_short(0xE0, reason_code, proto_ver, properties) def gen_auth(reason_code=-1, properties=None): return _gen_short(0xF0, reason_code, 5, properties) def pack_remaining_length(remaining_length): s = b"" while True: byte = remaining_length % 128 remaining_length = remaining_length // 128 # If there are more digits to encode, set the top bit of this digit if remaining_length > 0: byte = byte | 0x80 s = s + struct.pack("!B", byte) if remaining_length == 0: return s def get_port(count=1): if count == 1: if len(sys.argv) == 2: return int(sys.argv[1]) else: return 1888 else: if len(sys.argv) == 1+count: p = () for i in range(0, count): p = p + (int(sys.argv[1+i]),) return p else: return tuple(range(1888, 1888+count)) def get_lib_port(): if len(sys.argv) == 3: return int(sys.argv[2]) else: return 1888 def do_ping(sock, error_string="pingresp"): do_send_receive(sock, gen_pingreq(), gen_pingresp(), error_string) @atexit.register def test_cleanup(): global vg_logfiles if os.environ.get('MOSQ_USE_VALGRIND') is not None: for f in vg_logfiles: try: if os.stat(f).st_size == 0: os.remove(f) except OSError: pass paho.mqtt.python-1.6.1/test/ssl/000077500000000000000000000000001413423552100165325ustar00rootroot00000000000000paho.mqtt.python-1.6.1/test/ssl/all-ca.crt000066400000000000000000000131201413423552100203720ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 1 (0x1) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, L=Derby, O=Paho Project, OU=Testing, CN=Root CA Validity Not Before: Jul 7 11:14:42 2021 GMT Not After : Jul 6 11:14:42 2026 GMT Subject: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:cb:32:6c:8c:48:e8:44:58:36:18:70:36:42:3d: 2d:29:47:3c:69:12:9e:7b:f7:45:62:ef:91:44:46: 97:a0:ea:5f:da:fd:9f:98:d4:bf:43:02:e3:39:90: 33:7b:13:13:d5:31:30:9c:07:fc:ca:1b:a9:e4:89: 42:e5:d0:6e:f4:a2:e0:23:ee:9d:9a:cc:80:3b:78: bf:7e:27:a8:46:1b:28:9f:4a:64:53:7a:89:3e:ab: 65:6f:af:0b:29:fa:4d:4f:04:f1:1e:10:2c:bf:2b: ea:fc:c5:fa:77:c9:1a:7a:78:29:f5:a2:cb:25:7c: 02:bb:91:8d:76:4d:23:bc:9c:19:da:be:c5:20:04: ad:fe:bd:b9:d4:bb:29:2a:c3:e4:fc:4c:84:db:a3: 55:9f:f0:70:7f:40:38:b5:c3:78:a5:db:06:36:b7: 10:8e:ca:6c:1a:92:66:be:0e:1a:97:59:6b:18:f4: c2:b8:c9:31:7b:d1:b1:a1:00:78:7f:c0:09:f6:ef: b2:8f:94:87:5d:b1:a2:23:93:4d:ec:fa:95:09:a9: 90:c4:02:f0:1e:d9:ab:a2:8b:7f:7f:54:95:e7:da: c3:c9:7d:a7:d7:04:89:59:db:88:9d:57:16:5d:b9: 66:b0:d6:88:bb:e0:ee:43:e9:ab:02:78:fc:bd:e8: 98:d9 Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Subject Key Identifier: C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 X509v3 Authority Key Identifier: keyid:13:A0:B6:1F:F5:C7:64:C2:F9:FD:2E:08:F2:19:01:77:54:19:73:7F X509v3 Basic Constraints: CA:TRUE Signature Algorithm: sha256WithRSAEncryption 3e:70:76:69:37:e4:6e:e0:08:c6:8e:5b:2e:aa:26:fe:e9:ed: ac:02:ce:2c:37:08:6a:8a:c3:0d:c0:ef:43:51:01:2e:e0:96: 76:23:1b:1f:75:98:df:7c:d1:b7:c1:67:aa:62:c1:bd:ef:84: eb:d9:28:47:50:f2:1b:54:7f:ed:cb:52:f7:fc:c3:f8:62:22: 0c:b3:95:ed:bb:3f:74:91:bc:d2:eb:c0:81:7d:74:12:85:61: a3:7e:fb:22:4a:25:99:0b:5d:ef:69:f2:5a:e6:d5:12:a3:95: 38:30:0c:c7:d9:da:28:30:10:b4:3d:3e:ad:20:85:31:e0:bf: 30:33:2e:0b:e3:07:3d:ed:22:dc:67:f8:93:64:89:ed:e7:08: 74:b5:0a:7a:01:3d:f9:44:62:71:cf:60:12:92:c3:95:9a:e5: a5:f2:24:6a:22:64:d5:76:22:c9:03:1c:c5:d1:a5:85:4d:55: f9:80:47:ca:12:20:df:05:fb:82:12:45:6f:e8:c0:20:a8:ae: f7:17:c5:c3:b6:9c:51:bd:d8:84:e4:db:c7:03:44:d2:cb:75: 51:79:3f:86:33:3c:e4:34:1d:77:b2:60:24:5c:21:c5:c3:53: 36:08:2f:a7:14:0b:68:78:67:95:90:b9:06:0e:85:04:65:57: b4:34:31:cf -----BEGIN CERTIFICATE----- MIIDmDCCAoCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBtMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEOMAwGA1UEBwwFRGVyYnkxFTATBgNVBAoMDFBh aG8gUHJvamVjdDEQMA4GA1UECwwHVGVzdGluZzEQMA4GA1UEAwwHUm9vdCBDQTAe Fw0yMTA3MDcxMTE0NDJaFw0yNjA3MDYxMTE0NDJaMGAxCzAJBgNVBAYTAkdCMRMw EQYDVQQIDApEZXJieXNoaXJlMRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNV BAsMB1Rlc3RpbmcxEzARBgNVBAMMClNpZ25pbmcgQ0EwggEiMA0GCSqGSIb3DQEB AQUAA4IBDwAwggEKAoIBAQDLMmyMSOhEWDYYcDZCPS0pRzxpEp5790Vi75FERpeg 6l/a/Z+Y1L9DAuM5kDN7ExPVMTCcB/zKG6nkiULl0G70ouAj7p2azIA7eL9+J6hG GyifSmRTeok+q2Vvrwsp+k1PBPEeECy/K+r8xfp3yRp6eCn1osslfAK7kY12TSO8 nBnavsUgBK3+vbnUuykqw+T8TITbo1Wf8HB/QDi1w3il2wY2txCOymwakma+DhqX WWsY9MK4yTF70bGhAHh/wAn277KPlIddsaIjk03s+pUJqZDEAvAe2auii39/VJXn 2sPJfafXBIlZ24idVxZduWaw1oi74O5D6asCePy96JjZAgMBAAGjUDBOMB0GA1Ud DgQWBBTCjwmb1fG6xHRel1C7hp2h8frENjAfBgNVHSMEGDAWgBQToLYf9cdkwvn9 LgjyGQF3VBlzfzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA+cHZp N+Ru4AjGjlsuqib+6e2sAs4sNwhqisMNwO9DUQEu4JZ2IxsfdZjffNG3wWeqYsG9 74Tr2ShHUPIbVH/ty1L3/MP4YiIMs5Xtuz90kbzS68CBfXQShWGjfvsiSiWZC13v afJa5tUSo5U4MAzH2dooMBC0PT6tIIUx4L8wMy4L4wc97SLcZ/iTZInt5wh0tQp6 AT35RGJxz2ASksOVmuWl8iRqImTVdiLJAxzF0aWFTVX5gEfKEiDfBfuCEkVv6MAg qK73F8XDtpxRvdiE5NvHA0TSy3VReT+GMzzkNB13smAkXCHFw1M2CC+nFAtoeGeV kLkGDoUEZVe0NDHP -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIDuDCCAqCgAwIBAgIUS1Q+E18/+trcKfhT+xz8ghGukmYwDQYJKoZIhvcNAQEL BQAwbTELMAkGA1UEBhMCR0IxEzARBgNVBAgMCkRlcmJ5c2hpcmUxDjAMBgNVBAcM BURlcmJ5MRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNVBAsMB1Rlc3Rpbmcx EDAOBgNVBAMMB1Jvb3QgQ0EwHhcNMjEwNzA3MTExNDQyWhcNMzEwNzA1MTExNDQy WjBtMQswCQYDVQQGEwJHQjETMBEGA1UECAwKRGVyYnlzaGlyZTEOMAwGA1UEBwwF RGVyYnkxFTATBgNVBAoMDFBhaG8gUHJvamVjdDEQMA4GA1UECwwHVGVzdGluZzEQ MA4GA1UEAwwHUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB AKpCq45dCrroNa+y3zgdBglQOtw4og3MD/3Rn6ZftyL0dv1rSMkCFU8lCtZ4bIpz iNSJKau79owCudX3qQTPfiX2pmR5uuYjvMzRiZohZtz5uqXByy/CMS8dPRI3po6i kfNx9n7EQqOlxdwkY1kae2j5ybkAld2MNci93BH4P8qqaQckVRKpv6cKq33KsXK7 jHgjAYMGrihTAwxgP1JX9NS8yxxjMUYvFqeEOLARoeWc6Nl7oDbGLs2fr0j2Yssm cz0AMu7LWcbhnfs2S8Troksztnq38yHu+YTs6hX4NhANBgon5CAdyzmmE/b2OwOX p8rQepUfG7wO5QaS0OrAEXsCAwEAAaNQME4wHQYDVR0OBBYEFBOgth/1x2TC+f0u CPIZAXdUGXN/MB8GA1UdIwQYMBaAFBOgth/1x2TC+f0uCPIZAXdUGXN/MAwGA1Ud EwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHgE1oMwIcilQFN4xPYCf8jbsa5o zA5ljTbxv7fU3Zd+7KdlDFYroGjgHb7o3r0//b8+ZarxBqn1274u4KPs39Ow7h6m YJo7IM2Z2fC6IWZroqeidfFx5SwejAP1j7coYLblTIbNF+P08sJG5nSQ+Yx0gams 6C1x0mETaaglDwllU1KXHTm8fUpEwpISc/VfKABYgScODMpdsDghyHANvnFjmvp4 ktABnasliZYTmdl0t3szNm7zIk+bntiK4KunFea8GqgslWqGPwtNxxJFHzPjMCxK EHgubLgp1lNZzH13XSO6ZpiNRDJ6IVed3Zq+yn+24uKH+1Hqp6Bt20ZFB4E= -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/client-expired.crt000066400000000000000000000107001413423552100221560ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 3 (0x3) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Validity Not Before: Aug 20 00:00:00 2012 GMT Not After : Aug 21 00:00:00 2012 GMT Subject: C=GB, ST=Nottinghamshire, L=Nottingham, O=Server, OU=Production, CN=test client expired Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:d0:58:ed:ad:44:b4:f8:30:16:27:d9:b4:2c:b4: 24:67:9a:19:fe:32:04:0d:9a:7e:75:97:12:d6:2c: d4:97:33:fb:30:8c:ef:a2:b1:ef:e5:92:d6:56:05: 75:c8:19:82:92:4e:4b:13:8e:25:90:b9:21:72:f4: a4:bf:7a:e2:0f:75:52:08:04:4c:e8:6a:35:7e:7d: 78:d9:b8:f7:2b:3d:8e:4e:b5:f3:7a:9a:06:10:50: ca:95:63:2c:bd:3a:89:d0:8a:84:12:32:9b:00:a7: 25:33:70:d2:18:0a:43:94:12:62:e7:77:db:b8:0f: dc:23:48:95:5c:77:c6:11:4f:0f:d6:6e:73:59:7c: ed:6a:fd:ba:24:f0:b2:59:c3:a2:16:65:ad:19:7f: 92:87:8c:ea:b5:e5:0f:26:f8:b1:74:98:c3:fd:ed: 4d:74:d0:58:ce:d9:9c:24:34:9b:75:79:25:d0:aa: 6c:03:03:0c:3a:4a:4c:9a:36:50:ab:55:74:1e:8b: de:41:a7:14:b9:57:ee:8b:31:90:5c:00:af:31:9d: e0:55:07:8d:05:ed:c9:5f:e1:79:b7:96:be:d9:5b: cf:a7:5c:cd:48:fc:bd:a4:34:bf:e0:49:d5:25:60: 7a:4c:32:37:97:e4:f8:64:24:a6:79:c1:62:8d:93: 52:53 Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Basic Constraints: CA:FALSE Netscape Comment: OpenSSL Generated Certificate X509v3 Subject Key Identifier: 61:62:90:E6:BB:8A:BB:06:6C:8A:66:9F:A5:C7:85:12:43:5C:94:6F X509v3 Authority Key Identifier: keyid:C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 Signature Algorithm: sha256WithRSAEncryption 8d:7b:2a:16:2a:2e:50:db:5d:6e:20:ec:4e:5f:2e:d0:f4:9a: a9:c8:b3:f0:73:02:9f:2f:32:a2:2a:a5:a7:83:1e:e3:36:6b: 99:d2:4c:6a:ea:09:0b:73:5e:7f:69:da:50:69:5b:dc:0f:4d: 59:ec:d2:c7:ca:0e:a8:55:c0:5a:f6:67:e8:a0:0b:4b:0a:9a: a8:1f:b3:f0:e7:e6:10:4b:db:1b:5a:18:7a:ee:52:16:93:2e: 70:1c:4f:7d:c6:eb:4a:11:35:92:db:8c:f0:86:1b:f7:64:4f: f5:1b:31:d6:da:89:97:c6:46:4b:c9:df:7f:80:c4:77:5e:c6: a8:b7:47:12:48:b5:2b:f2:73:80:e4:dd:5b:cf:a1:20:3c:3b: b3:37:34:d1:72:37:e1:a6:06:d4:22:cc:65:d3:af:0f:aa:ea: ad:dd:e9:21:c5:1e:86:81:94:33:6c:ca:68:c2:48:ed:ea:0e: c4:be:38:a5:4f:bb:0b:2b:7f:e7:63:e1:9f:e1:c8:6a:c4:4c: 7b:43:a2:56:c9:ff:56:88:2e:e3:4f:d6:d0:69:59:96:6e:26: d9:3d:f3:62:4e:c3:a3:79:8f:f9:e4:82:11:52:f0:a2:c7:79: b6:54:50:21:31:e6:4a:8c:2c:df:23:e9:2e:50:6e:9d:a8:61: 5b:e1:cb:51 -----BEGIN CERTIFICATE----- MIID1zCCAr+gAwIBAgIBAzANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEVMBMGA1UECgwMUGFobyBQcm9qZWN0MRAwDgYD VQQLDAdUZXN0aW5nMRMwEQYDVQQDDApTaWduaW5nIENBMB4XDTEyMDgyMDAwMDAw MFoXDTEyMDgyMTAwMDAwMFowgYAxCzAJBgNVBAYTAkdCMRgwFgYDVQQIDA9Ob3R0 aW5naGFtc2hpcmUxEzARBgNVBAcMCk5vdHRpbmdoYW0xDzANBgNVBAoMBlNlcnZl cjETMBEGA1UECwwKUHJvZHVjdGlvbjEcMBoGA1UEAwwTdGVzdCBjbGllbnQgZXhw aXJlZDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANBY7a1EtPgwFifZ tCy0JGeaGf4yBA2afnWXEtYs1Jcz+zCM76Kx7+WS1lYFdcgZgpJOSxOOJZC5IXL0 pL964g91UggETOhqNX59eNm49ys9jk6183qaBhBQypVjLL06idCKhBIymwCnJTNw 0hgKQ5QSYud327gP3CNIlVx3xhFPD9Zuc1l87Wr9uiTwslnDohZlrRl/koeM6rXl Dyb4sXSYw/3tTXTQWM7ZnCQ0m3V5JdCqbAMDDDpKTJo2UKtVdB6L3kGnFLlX7osx kFwArzGd4FUHjQXtyV/hebeWvtlbz6dczUj8vaQ0v+BJ1SVgekwyN5fk+GQkpnnB Yo2TUlMCAwEAAaN7MHkwCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYdT3BlblNT TCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFGFikOa7irsGbIpmn6XH hRJDXJRvMB8GA1UdIwQYMBaAFMKPCZvV8brEdF6XULuGnaHx+sQ2MA0GCSqGSIb3 DQEBCwUAA4IBAQCNeyoWKi5Q211uIOxOXy7Q9JqpyLPwcwKfLzKiKqWngx7jNmuZ 0kxq6gkLc15/adpQaVvcD01Z7NLHyg6oVcBa9mfooAtLCpqoH7Pw5+YQS9sbWhh6 7lIWky5wHE99xutKETWS24zwhhv3ZE/1GzHW2omXxkZLyd9/gMR3Xsaot0cSSLUr 8nOA5N1bz6EgPDuzNzTRcjfhpgbUIsxl068Pquqt3ekhxR6GgZQzbMpowkjt6g7E vjilT7sLK3/nY+Gf4chqxEx7Q6JWyf9WiC7jT9bQaVmWbibZPfNiTsOjeY/55IIR UvCix3m2VFAhMeZKjCzfI+kuUG6dqGFb4ctR -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/client-pw.crt000066400000000000000000000107161413423552100211530ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 4 (0x4) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Validity Not Before: Jul 7 11:14:42 2021 GMT Not After : Jul 6 11:14:42 2026 GMT Subject: C=GB, ST=Nottinghamshire, L=Nottingham, O=Server, OU=Production, CN=test client with password Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:ca:cb:93:49:45:28:95:5b:c4:51:b4:2b:d0:e7: e4:b7:3b:37:34:f6:5c:ec:f8:7d:3a:8b:b8:da:3c: 94:38:85:5f:41:ea:2b:08:d7:3e:97:12:50:09:1f: 37:4f:e4:25:a1:59:b6:98:63:22:8d:80:7e:b1:b4: 24:03:2e:5e:5d:45:a4:4c:76:e8:ac:2c:5f:ca:9d: ed:6e:0a:7b:6f:2b:34:d1:4e:6a:e1:b6:72:66:42: ec:fd:b8:97:bf:40:4b:24:9c:47:6c:8c:4a:73:aa: e0:3a:db:ac:45:65:23:df:8f:4a:30:ed:d6:ad:5c: eb:a9:e9:83:da:39:d1:eb:98:31:74:98:bd:99:6b: 85:0e:1d:f8:93:cf:e2:bd:59:77:fe:b2:a0:c4:e5: 63:ae:92:10:13:47:14:55:22:a0:30:b6:f0:cb:17: b6:2d:f9:7d:f9:82:50:b2:64:88:dd:5a:3b:b6:81: 67:8c:e3:de:89:76:63:82:af:b7:ba:83:5c:3b:bc: cf:1f:8e:fe:25:04:6f:f2:70:bf:2f:b0:6b:4f:77: d2:2d:e4:37:20:84:f3:94:c3:12:80:ae:bc:c3:2b: 93:d2:fa:92:a3:1a:33:8d:d7:4a:eb:23:04:c0:38: 51:73:fb:7a:9f:f5:3a:ca:7e:2e:c7:b6:22:3e:68: 69:0f Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Basic Constraints: CA:FALSE Netscape Comment: OpenSSL Generated Certificate X509v3 Subject Key Identifier: 8E:E7:D7:66:D5:0C:10:B5:7A:4F:7F:83:C3:43:94:E9:BC:E2:88:D0 X509v3 Authority Key Identifier: keyid:C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 Signature Algorithm: sha256WithRSAEncryption 17:54:5a:5e:9e:7d:fe:3f:6d:82:c5:e8:42:6b:61:91:13:5f: 07:d5:25:4b:3c:05:e6:4c:99:a5:ff:20:ff:d3:e8:a4:25:08: 8c:82:1b:2f:25:73:79:97:12:5e:e9:30:a1:b2:16:36:51:e2: a5:41:bf:1c:c1:db:d2:9a:36:67:75:da:e7:36:9a:b4:65:17: 74:af:73:02:b0:09:b3:ac:29:e7:ca:cd:01:12:7f:ba:39:29: 90:d4:7c:3f:99:89:66:e7:eb:79:80:77:91:e4:3d:7e:87:69: 7b:da:b5:68:07:26:ab:30:20:49:2b:46:33:3f:f7:4b:4e:e7: a0:13:19:53:7d:73:ff:4a:95:86:35:d2:cd:ff:3c:b1:14:b4: d8:d4:ca:de:b7:8d:2e:e3:47:f8:5d:2e:e7:b1:5b:b9:23:d3: 54:11:89:8e:98:12:a8:10:2a:da:bb:d0:0c:07:c7:d7:21:7e: f0:88:91:31:07:2a:a6:42:84:4a:61:9e:68:72:d4:7c:3f:59: b2:02:e1:a6:11:9b:d2:90:73:39:13:07:e1:6b:57:2a:78:b4: b4:f0:75:7c:6d:48:9d:33:cd:3f:d0:ff:43:a4:7e:3a:8d:fe: 98:10:df:ab:ee:c0:58:82:cb:23:7a:b7:f5:5c:29:29:af:d0: 40:fc:42:a3 -----BEGIN CERTIFICATE----- MIID3TCCAsWgAwIBAgIBBDANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEVMBMGA1UECgwMUGFobyBQcm9qZWN0MRAwDgYD VQQLDAdUZXN0aW5nMRMwEQYDVQQDDApTaWduaW5nIENBMB4XDTIxMDcwNzExMTQ0 MloXDTI2MDcwNjExMTQ0MlowgYYxCzAJBgNVBAYTAkdCMRgwFgYDVQQIDA9Ob3R0 aW5naGFtc2hpcmUxEzARBgNVBAcMCk5vdHRpbmdoYW0xDzANBgNVBAoMBlNlcnZl cjETMBEGA1UECwwKUHJvZHVjdGlvbjEiMCAGA1UEAwwZdGVzdCBjbGllbnQgd2l0 aCBwYXNzd29yZDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMrLk0lF KJVbxFG0K9Dn5Lc7NzT2XOz4fTqLuNo8lDiFX0HqKwjXPpcSUAkfN0/kJaFZtphj Io2AfrG0JAMuXl1FpEx26KwsX8qd7W4Ke28rNNFOauG2cmZC7P24l79ASyScR2yM SnOq4DrbrEVlI9+PSjDt1q1c66npg9o50euYMXSYvZlrhQ4d+JPP4r1Zd/6yoMTl Y66SEBNHFFUioDC28MsXti35ffmCULJkiN1aO7aBZ4zj3ol2Y4Kvt7qDXDu8zx+O /iUEb/Jwvy+wa0930i3kNyCE85TDEoCuvMMrk9L6kqMaM43XSusjBMA4UXP7ep/1 Osp+Lse2Ij5oaQ8CAwEAAaN7MHkwCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYd T3BlblNTTCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFI7n12bVDBC1 ek9/g8NDlOm84ojQMB8GA1UdIwQYMBaAFMKPCZvV8brEdF6XULuGnaHx+sQ2MA0G CSqGSIb3DQEBCwUAA4IBAQAXVFpenn3+P22CxehCa2GRE18H1SVLPAXmTJml/yD/ 0+ikJQiMghsvJXN5lxJe6TChshY2UeKlQb8cwdvSmjZnddrnNpq0ZRd0r3MCsAmz rCnnys0BEn+6OSmQ1Hw/mYlm5+t5gHeR5D1+h2l72rVoByarMCBJK0YzP/dLTueg ExlTfXP/SpWGNdLN/zyxFLTY1Mret40u40f4XS7nsVu5I9NUEYmOmBKoECrau9AM B8fXIX7wiJExByqmQoRKYZ5octR8P1myAuGmEZvSkHM5Ewfha1cqeLS08HV8bUid M80/0P9DpH46jf6YEN+r7sBYgssjerf1XCkpr9BA/EKj -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/client-pw.key000066400000000000000000000033461413423552100211540ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- Proc-Type: 4,ENCRYPTED DEK-Info: AES-128-CBC,84549D95979482A29416CC3DBA507BC0 tAbMy3JP4/R53W9E8sB+fFFvGQOb+QKSW0vtjb8Z3GlIW+9wdGJ89GhXcspP7+HN eQZy6trDmPHJ++m4sVEwBGjngLdDaajRvQVlqCIXgLvjCwIIaE2gHo3yF37umunR 0dg4NVjfEgNS3luPu7DzCv9pwIQl2YOsoPK7TuHOTGVGHCovHAr/IJ7fdaT5N9G8 ypC7rHZhneLUs02J/L0FZUPlztOXRuiqnJisZr0pPs6ZoVEoNvR4D3VgU0nOFMcF UmcWA+vJsXaPzmC0HDErYqfr0Mwc/7mZURCGm/+A6Q79PAAAR7pPoMczaRHP4szS BxegO6XyKYs8a52q/XojKTcb0FESNjX0syW3+OjZusCYpuBmK4MofSdDmXVNxBLD iBqUDLGSfU2W5H/UkHWh7O0VW1DT0RvqqFV1p1WI0dvixM80wx12rPiJ79RYLG8D HMD7lR2iODDibCXePMg0XeCz+zf8OSfqzw6YeAMxmapZWBd8cJJ4eaUq6ziZO0hE kvj6tUZk7d/nTSissQR2Tx6xlSm0AuHWdKx1s5gKnVg6xLKNKIVyeHnXdXkgCwSq dICwmtP/1iYrslWCrhnB4MLA6R2vgpglwBfh7h7rW59K2untdIzr/td+h/xkynHQ wMKJ5xZ2oRQc9oZrV0PXHQKdukniLr3owBPiu+i+QbqpzGtvhyt1wUs+NjDROrim kritxoz6SXSIH6Wv9ae1crdhK1YTaMt1YOJT4tPjTdZyhMXqYszAH25L3ar2HaEv Cv2YU9VqPno45/ZSVSA8xZ+E74AoZsgDMOWKFJimJv+P9CGNbm8d9SGlHDAsyj0U +cTeyH6AWWHuAdEtVNA36qDdWOJOwhH2vT2iLuqdDySX5EJRszoxFo2RdGF3lRuQ lVFo1v41tnvB89i9g8ZVqqkfs1IjybU2Aq+hpnqRVThRrbN75o2s2BC0K2sUvgu5 gKUzXBl2B5CX6kWrUZ9llTSi2nH6zFAMtKvvuRQx+r+qrjJbxiPkRm9HFXlRRKYG NZbYyrB0ovuNgL5mwraNBL8Ytzx/nGvnaJsxWqhNiDENEziGcjTiA0/gh/mtru7K xTAQt7vVgrsynAK7c5Yhu3BBJspjgq2S9mKNpgXadcYcKQRcJnsYR9VCNWy4f7dD sTDy9NPttZM24ayC8OjUtyusk/DxXubuqRf4mF7jKsmoTqZR/yW5/NGPOpYRs0If 9ysiBP8ctyti+snS8jSzb7PVCBJzKgEDthjLvXmV2AIeuiXTFvqTmKOlTYT8mkev ZaXl4tS+3GGJgrSmPweAJsGFo58oQA8skExrXBW0w2rRSQDqzEo/GAbmd65IDGXh YMOwsdvjiu9Ug4E7icxB2w5bKmhEsIh/Vj3Np/h5xcJ9W9O8zq0oYhjle3GLDGro yPA1g0wWLeuxwPhPk7cNHFdF2Yr2CXFVug3Q9WkGTABKbZd2zV/7kk6YMRFmieV0 h4nQBSFqR6qkF9CiUFkKS2dod0zKLPJiBRqgiopEur5QdHg1PpdEQAj6fLQo0Zfw LoQyVi3ta9IMO1wZU8fy9w+bXoo8c76VD5jzfXw1ig0bK3iu1ozZc2UjnNlBmpYp -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/client-revoked.crt000066400000000000000000000107001413423552100221550ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 5 (0x5) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Validity Not Before: Jul 7 11:14:43 2021 GMT Not After : Jul 6 11:14:43 2026 GMT Subject: C=GB, ST=Nottinghamshire, L=Nottingham, O=Server, OU=Production, CN=test client revoked Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:a5:7a:5f:a2:55:1f:50:22:cd:92:0d:9a:69:fa: 47:d4:d1:2f:6f:e5:3e:22:06:2f:f4:ed:a8:85:9b: 2a:0d:e7:e2:81:f4:23:08:68:e2:75:5b:ba:58:f5: 57:61:5a:5c:c4:e5:27:5e:9c:8e:82:77:72:25:c2: 2e:1d:e0:61:dc:32:f0:3b:be:7d:26:e3:a0:bb:5d: 75:7f:87:d8:a1:26:2f:7f:01:7b:1e:2f:25:cb:bd: 15:6c:43:12:6a:a6:02:1d:fd:7b:34:e2:1e:6c:06: 13:de:39:e8:ee:ae:ed:cd:cc:bd:1e:48:d5:e6:11: 95:12:08:61:88:13:d6:88:40:cc:9d:18:1c:c6:30: 5e:8f:e8:a4:2a:c8:62:78:19:f6:95:6a:f0:ce:27: e3:af:aa:fd:46:41:9d:83:32:f6:8e:a4:1f:32:00: c3:ca:5f:a5:3e:bc:74:6e:96:3e:50:cd:12:ca:81: 5a:ab:cf:a1:f8:3a:2f:fe:91:73:79:14:b3:fb:e6: 6b:c3:57:a9:8c:2d:f6:6c:53:4f:2e:e9:4c:25:67: 88:ac:ce:bc:84:ac:b8:d8:f5:6a:a4:ae:24:10:ea: 4e:2c:ef:90:f5:a6:68:c3:5c:a7:e0:40:99:06:6a: ec:b1:63:f5:7a:0b:a9:f1:81:26:95:12:9c:02:20: 77:df Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Basic Constraints: CA:FALSE Netscape Comment: OpenSSL Generated Certificate X509v3 Subject Key Identifier: C7:6A:63:58:7D:DB:19:38:77:1F:41:E8:67:38:78:9D:0B:BE:51:92 X509v3 Authority Key Identifier: keyid:C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 Signature Algorithm: sha256WithRSAEncryption 5c:b9:89:ad:18:b6:0b:93:f1:b0:0a:3e:aa:f3:d0:ad:d1:6f: 04:31:29:5a:b8:74:81:3c:4b:bb:98:8a:ca:c8:95:fa:8f:3e: 89:ba:f2:c3:83:a2:18:1c:7c:c6:56:4b:52:83:ef:fe:87:23: 7f:2d:6f:a2:36:22:46:04:ed:bf:ad:34:e6:9d:87:7e:92:72: 80:b2:5d:b1:b3:23:f6:f2:bd:74:c5:34:ef:8f:50:89:8b:64: 77:95:9d:ec:72:09:a6:c4:74:da:1d:2a:57:60:38:8f:6c:22: ff:9e:40:73:98:ac:1f:bc:b6:e4:1b:1d:2d:73:a2:9a:ad:53: 95:d2:17:b3:c5:8a:6c:5a:5a:be:e2:80:e4:f5:d6:99:06:61: ec:66:44:1a:ec:ac:86:36:ef:84:4b:c5:b3:a0:c5:d7:0d:be: 51:8c:95:46:03:e4:74:61:bf:7c:10:68:91:12:46:b8:38:94: 9f:a2:68:77:4d:92:57:43:ff:a1:c2:67:43:33:01:1d:fd:29: 13:8d:04:ed:7e:2d:4c:ed:8c:2f:f6:6f:44:33:3c:71:4d:f6: 51:04:c5:c0:cb:2c:ea:95:6e:22:32:03:37:0b:32:87:89:c0: e5:bc:72:d2:8f:73:db:40:a9:4d:f2:15:bd:c4:0d:aa:ea:2e: 0c:ce:77:9d -----BEGIN CERTIFICATE----- MIID1zCCAr+gAwIBAgIBBTANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEVMBMGA1UECgwMUGFobyBQcm9qZWN0MRAwDgYD VQQLDAdUZXN0aW5nMRMwEQYDVQQDDApTaWduaW5nIENBMB4XDTIxMDcwNzExMTQ0 M1oXDTI2MDcwNjExMTQ0M1owgYAxCzAJBgNVBAYTAkdCMRgwFgYDVQQIDA9Ob3R0 aW5naGFtc2hpcmUxEzARBgNVBAcMCk5vdHRpbmdoYW0xDzANBgNVBAoMBlNlcnZl cjETMBEGA1UECwwKUHJvZHVjdGlvbjEcMBoGA1UEAwwTdGVzdCBjbGllbnQgcmV2 b2tlZDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKV6X6JVH1AizZIN mmn6R9TRL2/lPiIGL/TtqIWbKg3n4oH0Iwho4nVbulj1V2FaXMTlJ16cjoJ3ciXC Lh3gYdwy8Du+fSbjoLtddX+H2KEmL38Bex4vJcu9FWxDEmqmAh39ezTiHmwGE945 6O6u7c3MvR5I1eYRlRIIYYgT1ohAzJ0YHMYwXo/opCrIYngZ9pVq8M4n46+q/UZB nYMy9o6kHzIAw8pfpT68dG6WPlDNEsqBWqvPofg6L/6Rc3kUs/vma8NXqYwt9mxT Ty7pTCVniKzOvISsuNj1aqSuJBDqTizvkPWmaMNcp+BAmQZq7LFj9XoLqfGBJpUS nAIgd98CAwEAAaN7MHkwCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYdT3BlblNT TCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFMdqY1h92xk4dx9B6Gc4 eJ0LvlGSMB8GA1UdIwQYMBaAFMKPCZvV8brEdF6XULuGnaHx+sQ2MA0GCSqGSIb3 DQEBCwUAA4IBAQBcuYmtGLYLk/GwCj6q89Ct0W8EMSlauHSBPEu7mIrKyJX6jz6J uvLDg6IYHHzGVktSg+/+hyN/LW+iNiJGBO2/rTTmnYd+knKAsl2xsyP28r10xTTv j1CJi2R3lZ3scgmmxHTaHSpXYDiPbCL/nkBzmKwfvLbkGx0tc6KarVOV0hezxYps Wlq+4oDk9daZBmHsZkQa7KyGNu+ES8WzoMXXDb5RjJVGA+R0Yb98EGiREka4OJSf omh3TZJXQ/+hwmdDMwEd/SkTjQTtfi1M7Ywv9m9EMzxxTfZRBMXAyyzqlW4iMgM3 CzKHicDlvHLSj3PbQKlN8hW9xA2q6i4Mzned -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/client-revoked.key000066400000000000000000000032171413423552100221620ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEApXpfolUfUCLNkg2aafpH1NEvb+U+IgYv9O2ohZsqDefigfQj CGjidVu6WPVXYVpcxOUnXpyOgndyJcIuHeBh3DLwO759JuOgu111f4fYoSYvfwF7 Hi8ly70VbEMSaqYCHf17NOIebAYT3jno7q7tzcy9HkjV5hGVEghhiBPWiEDMnRgc xjBej+ikKshieBn2lWrwzifjr6r9RkGdgzL2jqQfMgDDyl+lPrx0bpY+UM0SyoFa q8+h+Dov/pFzeRSz++Zrw1epjC32bFNPLulMJWeIrM68hKy42PVqpK4kEOpOLO+Q 9aZow1yn4ECZBmrssWP1egup8YEmlRKcAiB33wIDAQABAoIBACVlqZVLPX9jzieS 0XHf8TnkaJ8WJNuVoGLvDuXa8j8gR61s2jn9UiiJqWyPTccfn9WToDkekopjqjVk U/3Ghvc3v9kQrMIMMXgGoBZJQijxM0y1rfhdWWJZAi1sXw4hJFtYvO5vp8Zr/TN8 zOqcN/wJqDfe6BBNqu3fXQNe0F4MQeiLVYi7c1Q0ZupiALZDFPJ1u03xFiIzlMrN QLghfUoq4pFgqC08wR31XncvcWQ/iOggznxjy16Ezx1ubqGf7cMWZmXEWtdD0fsP 8P3x/VS+MBzVtX9hhTaS3pVUAZKriCLF8kQiCUgtzlbUvKNrRb6gLan+OcD+J2sE 0wopLZkCgYEA0BsLbbf0pc+PT+oCFUUueyADSl3SuH8j1YCpSU0nl0h6lE90cOen HSPRa4WHhhQm9lgCtTLXlHxJsZym0Lau7Nd90MIrjuvgRv0uOk07tRyThoGGuSCL 2fBnD+a8NGjh+s/KTxmBDdWPkRpaZ5MVl8ZSGSM5zUZzplwPLx/J+wUCgYEAy4/W nd+rU4oh3Hm6cVp4YaktZ9cU/YB0yDd/sIm7bJ+kDyz0LSw7l/FSxMzQ+Dqybqht We+jn07BOh89r70vbcxx+4kMtHbg5Ii1u/R74AgGK6JSiKKpybLi7LA+3vcW/Hg6 lemxE1U/PmmdvvSjzN/EXpeABkSgbctkJeoYRJMCgYBKLvnZ+NNrMBxEPoTTlD/H gFfr8JonTps1hpHSIYDVeu7HY7N8c/eseZIzo/v1ncVt113Pvfn/Ynbaq58Dk7uz jfW5rx3b6tWeOK579gAsxa0JK68c2y8/V2VF09iPTjwQLnZN0CejCNgOv7guZ84w tm+Zqmb2eADN8s8u20QjCQKBgQCoUHXHskKqX6Ph9nD3+zNgpQ8bNldvyMBHMMSP B0OG7HUt6yC3HUTlPLAQc74yEe6p2vAYFjK3rdnNojlST16hLhPtRQPRUB5iOLvz /pJSyq+3co9F1SII2bYSuSQzHiHOfecLP+CfuLQDejbpxsSNyVRIVoKQLDxurGdR hj+sqwKBgQC+x2dapmrh7qcCbPxbheWH32ds9GgI1Nr8eW2Wm0wIguLA4TrBN0UH HQZSdOjQoD/gTtHu79xbD1LPJk4kDtkvdzAlvbEds+3ArlaibNPcDaatkFAJt+2e 2t8UDdIKzxOaKEF8YfTaeCpyS7CZoVw3frA9nkK7h38PgFeB7Vx2Rw== -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/client.crt000066400000000000000000000106541413423552100205300ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 2 (0x2) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Validity Not Before: Jul 7 11:14:42 2021 GMT Not After : Jul 6 11:14:42 2026 GMT Subject: C=GB, ST=Nottinghamshire, L=Nottingham, O=Server, OU=Production, CN=test client Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:d0:58:ed:ad:44:b4:f8:30:16:27:d9:b4:2c:b4: 24:67:9a:19:fe:32:04:0d:9a:7e:75:97:12:d6:2c: d4:97:33:fb:30:8c:ef:a2:b1:ef:e5:92:d6:56:05: 75:c8:19:82:92:4e:4b:13:8e:25:90:b9:21:72:f4: a4:bf:7a:e2:0f:75:52:08:04:4c:e8:6a:35:7e:7d: 78:d9:b8:f7:2b:3d:8e:4e:b5:f3:7a:9a:06:10:50: ca:95:63:2c:bd:3a:89:d0:8a:84:12:32:9b:00:a7: 25:33:70:d2:18:0a:43:94:12:62:e7:77:db:b8:0f: dc:23:48:95:5c:77:c6:11:4f:0f:d6:6e:73:59:7c: ed:6a:fd:ba:24:f0:b2:59:c3:a2:16:65:ad:19:7f: 92:87:8c:ea:b5:e5:0f:26:f8:b1:74:98:c3:fd:ed: 4d:74:d0:58:ce:d9:9c:24:34:9b:75:79:25:d0:aa: 6c:03:03:0c:3a:4a:4c:9a:36:50:ab:55:74:1e:8b: de:41:a7:14:b9:57:ee:8b:31:90:5c:00:af:31:9d: e0:55:07:8d:05:ed:c9:5f:e1:79:b7:96:be:d9:5b: cf:a7:5c:cd:48:fc:bd:a4:34:bf:e0:49:d5:25:60: 7a:4c:32:37:97:e4:f8:64:24:a6:79:c1:62:8d:93: 52:53 Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Basic Constraints: CA:FALSE Netscape Comment: OpenSSL Generated Certificate X509v3 Subject Key Identifier: 61:62:90:E6:BB:8A:BB:06:6C:8A:66:9F:A5:C7:85:12:43:5C:94:6F X509v3 Authority Key Identifier: keyid:C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 Signature Algorithm: sha256WithRSAEncryption a4:ad:a8:cf:8b:f1:c0:e5:ed:e0:9f:eb:b8:46:17:fe:cf:49: ed:e2:94:3b:3c:ea:4d:8b:e5:e3:5b:5f:f0:51:f0:53:88:22: 61:fc:f9:9d:c3:67:5f:9c:20:f3:2c:bb:65:c3:66:d9:15:b8: 60:82:31:95:d4:96:43:11:c1:56:da:4b:ad:bc:3f:b2:5f:3d: 40:8d:e4:22:26:9b:d5:5d:ff:02:55:c1:f9:ca:f3:67:46:be: 7d:d0:8c:68:40:a6:64:01:f0:ce:8e:2c:c2:6c:16:96:23:64: e6:2f:95:b9:95:a2:85:8e:ec:61:56:6f:b9:3a:87:e9:cc:f1: 94:ca:51:d4:ce:50:01:91:1a:8c:ff:f9:cf:30:d4:aa:53:44: 67:44:84:4c:07:a7:ab:c3:34:3a:16:69:8c:37:7f:a0:fb:e1: fa:ec:e6:9d:3c:fd:13:a9:6f:b2:d8:dc:46:81:ae:a6:63:4f: 80:47:a7:80:51:a7:d4:d6:c8:11:85:7d:5f:ab:ef:3a:93:62: d7:fb:c2:a9:e4:b9:40:7e:d1:59:d0:d4:ff:75:bf:70:72:a2: 93:a3:47:41:d8:cf:d5:c6:8c:90:b8:d3:01:d8:53:a6:c1:3c: a9:d9:e4:ef:15:e9:47:9c:9d:eb:5a:bb:11:df:da:f1:81:5d: 89:c9:4a:8f -----BEGIN CERTIFICATE----- MIIDzjCCAragAwIBAgIBAjANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEVMBMGA1UECgwMUGFobyBQcm9qZWN0MRAwDgYD VQQLDAdUZXN0aW5nMRMwEQYDVQQDDApTaWduaW5nIENBMB4XDTIxMDcwNzExMTQ0 MloXDTI2MDcwNjExMTQ0MloweDELMAkGA1UEBhMCR0IxGDAWBgNVBAgMD05vdHRp bmdoYW1zaGlyZTETMBEGA1UEBwwKTm90dGluZ2hhbTEPMA0GA1UECgwGU2VydmVy MRMwEQYDVQQLDApQcm9kdWN0aW9uMRQwEgYDVQQDDAt0ZXN0IGNsaWVudDCCASIw DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANBY7a1EtPgwFifZtCy0JGeaGf4y BA2afnWXEtYs1Jcz+zCM76Kx7+WS1lYFdcgZgpJOSxOOJZC5IXL0pL964g91UggE TOhqNX59eNm49ys9jk6183qaBhBQypVjLL06idCKhBIymwCnJTNw0hgKQ5QSYud3 27gP3CNIlVx3xhFPD9Zuc1l87Wr9uiTwslnDohZlrRl/koeM6rXlDyb4sXSYw/3t TXTQWM7ZnCQ0m3V5JdCqbAMDDDpKTJo2UKtVdB6L3kGnFLlX7osxkFwArzGd4FUH jQXtyV/hebeWvtlbz6dczUj8vaQ0v+BJ1SVgekwyN5fk+GQkpnnBYo2TUlMCAwEA AaN7MHkwCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYdT3BlblNTTCBHZW5lcmF0 ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFGFikOa7irsGbIpmn6XHhRJDXJRvMB8G A1UdIwQYMBaAFMKPCZvV8brEdF6XULuGnaHx+sQ2MA0GCSqGSIb3DQEBCwUAA4IB AQCkrajPi/HA5e3gn+u4Rhf+z0nt4pQ7POpNi+XjW1/wUfBTiCJh/Pmdw2dfnCDz LLtlw2bZFbhggjGV1JZDEcFW2kutvD+yXz1AjeQiJpvVXf8CVcH5yvNnRr590Ixo QKZkAfDOjizCbBaWI2TmL5W5laKFjuxhVm+5OofpzPGUylHUzlABkRqM//nPMNSq U0RnRIRMB6erwzQ6FmmMN3+g++H67OadPP0TqW+y2NxGga6mY0+AR6eAUafU1sgR hX1fq+86k2LX+8Kp5LlAftFZ0NT/db9wcqKTo0dB2M/VxoyQuNMB2FOmwTyp2eTv FelHnJ3rWrsR39rxgV2JyUqP -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/client.key000066400000000000000000000032131413423552100205210ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEA0FjtrUS0+DAWJ9m0LLQkZ5oZ/jIEDZp+dZcS1izUlzP7MIzv orHv5ZLWVgV1yBmCkk5LE44lkLkhcvSkv3riD3VSCARM6Go1fn142bj3Kz2OTrXz epoGEFDKlWMsvTqJ0IqEEjKbAKclM3DSGApDlBJi53fbuA/cI0iVXHfGEU8P1m5z WXztav26JPCyWcOiFmWtGX+Sh4zqteUPJvixdJjD/e1NdNBYztmcJDSbdXkl0Kps AwMMOkpMmjZQq1V0HoveQacUuVfuizGQXACvMZ3gVQeNBe3JX+F5t5a+2VvPp1zN SPy9pDS/4EnVJWB6TDI3l+T4ZCSmecFijZNSUwIDAQABAoIBAQC60zN1jsm0T/Je E6Kz/2kxmYa7YQAvbpz9NtYGRbbwSwVwuMBdpK9Yrj4Sbtz57J4gMaKyy2E2EDxF R8i/hyJU+D/xvmF0e2CypzKKEYlaNd15CUFma90KHlg6cu74VBimbr8VTlmd0UPT h9RtCC8nBQG5S8ozl80vunNssl5iv2JeXvVOL2sRagCr787XeGur74jW2rsh65M/ ba6X3iv143D/1KNGiPAoGpP6vxvnOvM2K9+oqDf5SifmXfgSPIEoBd315YeQdGez BnOJHb7k2vokb+PsiTwjMsIf0AUqwKZPok+sLfaACxs4b2IrmFIYhcAcfyKkPD8i A1DpsEUhAoGBAPfKBnFNiMKc+JFM9lc01nQcdIKgtSmIPNUB7jOeg62oI3VzNp11 9iw2qCQGJZwc1U3QbmNTAap2MxDss98kP2UZcBNDC0pxo+6F7XxIANRURXrG4NRg iPDu1lzubrbzXoh8XMxjKYacPP/gW/2VnxwhOyeIAt3mAN/Bu57t+XRxAoGBANdA UmcYtbu1rW8tzSuXRVgFTDhK1bORao58qJBP95MpFh/nQPB2Q1nu+nReo3870xE2 6/R0gBv8gvKdEMVvhoDRlEJNhelQSg+yVQsX25gQcsKmR6/0IH+S0CH0PibS7o3G sjR9g27MitpX9MzzMR5R5IQErrDw01eOecGzzMUDAoGAc9IJiuJL33ORuBD6QC7h Yqp+RySpKT2V+ZaKabRZJk2mLVrqF1Ww+F+f3h7Fa6AKj/Gx91kwOSZAnlOVi+Kc gzwNp+M5ntVZY79UDzh0ssqlI0tcgciRmdR5fDyyoW9GK5O9qIddPJ9A3/VV6kUK dxKNXN/1PxUoKW6brSDc7fECgYB2BcCo4rWSrLThxv0+L31IG++E1hOCl/MTGWrb Zd1bhSWqbIQA1Pds8knFULbY5pZ+U9zgdphfv/6UxGYTu2jGbSObjyIjoXBaVu+m W3h+UlZ6P+4CnhrLmFYip+cEJpfCiPXhLgjI0cI4og2J6rY9560ibebTAdj/oxFD kjBuvQKBgBaKdaszx7MOBEGmmcv7HQ/prgi1s3UZbG5Jl98XS2xMVJO9N7x7k0hC SEj6kwlOSkpoiDEHSJ2s0j58Mnp5YxwPi61w3ZCnYg/iLgFfnJ972nliBw3wB/iD ZdYerxKGa6Btdbwt14rzE5QfzL8TiFapmq7JnY/rgE11Tx5SR06H -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/crl.pem000066400000000000000000000012521413423552100200150ustar00rootroot00000000000000-----BEGIN X509 CRL----- MIIBzzCBuAIBATANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJHQjETMBEGA1UE CAwKRGVyYnlzaGlyZTEVMBMGA1UECgwMUGFobyBQcm9qZWN0MRAwDgYDVQQLDAdU ZXN0aW5nMRMwEQYDVQQDDApTaWduaW5nIENBFw0yMTA3MDcxMTE0NDNaFw0yMTA4 MDYxMTE0NDNaMBQwEgIBBRcNMjEwNzA3MTExNDQzWqAOMAwwCgYDVR0UBAMCAQEw DQYJKoZIhvcNAQELBQADggEBAL+k0y+sONbBjgtGs6WX3AuKPNv+uEVSAdRR1UMX 3KwcwT9jy/5ypT7dv7UNz5V3IR8t41sCN6E3rVvOv+DFn6Br+eabg6GR/iZMhoUq hqknHZZTeMZ5VwzDIZvINHtRvli2bC5/sfU0S44d19lWW4rCVz78c1zf8MvsDc9U fwjtZofTZr/8p7t5KIdohYCwlHu+ANxi7qCJIuPJyZaPQ4wUSbRtu6idvkgYgmpC O74Fe+/eg6zQwd/B1MZEVdBx+66PAyELnyCW+R9PgILzET+YMDni/lT1AYwnCCJ2 lgiTIQlmyT/xlFCfmmzbsCkTcrMPym4m3zTOzbaeiYUBAco= -----END X509 CRL----- paho.mqtt.python-1.6.1/test/ssl/demoCA/000077500000000000000000000000001413423552100176625ustar00rootroot00000000000000paho.mqtt.python-1.6.1/test/ssl/demoCA/serial000066400000000000000000000000031413423552100210550ustar00rootroot0000000000000001 paho.mqtt.python-1.6.1/test/ssl/gen.sh000077500000000000000000000106641413423552100176510ustar00rootroot00000000000000#!/bin/sh # This file generates the keys and certificates used for testing mosquitto. # None of the keys are encrypted, so do not just use this script to generate # files for your own use. set -e rm -f *.crt *.key *.csr for a in root signing; do rm -rf ${a}CA/ mkdir -p ${a}CA/newcerts touch ${a}CA/index.txt echo 01 > ${a}CA/serial echo 01 > ${a}CA/crlnumber done rm -rf certs BASESUBJ="/C=GB/ST=Derbyshire/L=Derby/O=Paho Project/OU=Testing" SBASESUBJ="/C=GB/ST=Nottinghamshire/L=Nottingham/O=Server/OU=Production" BBASESUBJ="/C=GB/ST=Nottinghamshire/L=Nottingham/O=Server/OU=Bridge" # The root CA openssl genrsa -out test-root-ca.key 2048 openssl req -new -x509 -days 3650 -key test-root-ca.key -out test-root-ca.crt -config openssl.cnf -subj "${BASESUBJ}/CN=Root CA/" # Another root CA that doesn't sign anything openssl genrsa -out test-bad-root-ca.key 2048 openssl req -new -x509 -days 3650 -key test-bad-root-ca.key -out test-bad-root-ca.crt -config openssl.cnf -subj "${BASESUBJ}/CN=Bad Root CA/" # This is a root CA that has the exact same details as the real root CA, but is a different key and certificate. Effectively a "fake" CA. openssl genrsa -out test-fake-root-ca.key 2048 openssl req -new -x509 -days 3650 -key test-fake-root-ca.key -out test-fake-root-ca.crt -config openssl.cnf -subj "${BASESUBJ}/CN=Root CA/" # An intermediate CA, signed by the root CA, used to sign server/client csrs. openssl genrsa -out test-signing-ca.key 2048 openssl req -out test-signing-ca.csr -key test-signing-ca.key -new -config openssl.cnf -subj "${BASESUBJ}/CN=Signing CA/" openssl ca -batch -config openssl.cnf -name CA_root -extensions v3_ca -out test-signing-ca.crt -infiles test-signing-ca.csr # An alternative intermediate CA, signed by the root CA, not used to sign anything. openssl genrsa -out test-alt-ca.key 2048 openssl req -out test-alt-ca.csr -key test-alt-ca.key -new -config openssl.cnf -subj "${BASESUBJ}/CN=Alternative Signing CA/" openssl ca -batch -config openssl.cnf -name CA_root -extensions v3_ca -out test-alt-ca.crt -infiles test-alt-ca.csr # Valid server key and certificate. openssl genrsa -out server.key 2048 openssl req -new -key server.key -out server.csr -config openssl.cnf -subj "${SBASESUBJ}/CN=localhost/" openssl ca -batch -config openssl.cnf -name CA_signing -out server.crt -infiles server.csr # Expired server certificate, based on the above server key. openssl req -new -days 1 -key server.key -out server-expired.csr -config openssl.cnf -subj "${SBASESUBJ}/CN=localhost/" echo -n > signingCA/index.txt echo 01 > signingCA/serial openssl ca -batch -config openssl.cnf -name CA_signing -days 1 -startdate 120820000000Z -enddate 120821000000Z -out server-expired.crt -infiles server-expired.csr # Valid client key and certificate. openssl genrsa -out client.key 2048 openssl req -new -key client.key -out client.csr -config openssl.cnf -subj "${SBASESUBJ}/CN=test client/" openssl ca -batch -config openssl.cnf -name CA_signing -out client.crt -infiles client.csr # Expired client certificate, based on the above client key. openssl req -new -days 1 -key client.key -out client-expired.csr -config openssl.cnf -subj "${SBASESUBJ}/CN=test client expired/" openssl ca -batch -config openssl.cnf -name CA_signing -days 1 -startdate 120820000000Z -enddate 120821000000Z -out client-expired.crt -infiles client-expired.csr # Valid client key and certificate, key is encrypted with a password. openssl genrsa -aes128 -passout pass:password -out client-pw.key 2048 openssl req -new -key client-pw.key -passin pass:password -out client-pw.csr -config openssl.cnf -subj "${SBASESUBJ}/CN=test client with password/" openssl ca -batch -config openssl.cnf -name CA_signing -out client-pw.crt -infiles client-pw.csr # Revoked client certificate, based on a new client key. openssl genrsa -out client-revoked.key 2048 openssl req -new -days 1 -key client-revoked.key -out client-revoked.csr -config openssl.cnf -subj "${SBASESUBJ}/CN=test client revoked/" openssl ca -batch -config openssl.cnf -name CA_signing -out client-revoked.crt -infiles client-revoked.csr openssl ca -batch -config openssl.cnf -name CA_signing -revoke client-revoked.crt openssl ca -batch -config openssl.cnf -name CA_signing -gencrl -out crl.pem cat test-signing-ca.crt test-root-ca.crt > all-ca.crt #mkdir certs #cp test-signing-ca.crt certs/test-signing-ca.pem #cp test-root-ca.crt certs/test-root.ca.pem c_rehash certs rm -f client-expired.csr client-revoked.csr server-expired.csr server.csr test-alt-ca.csr paho.mqtt.python-1.6.1/test/ssl/openssl.cnf000066400000000000000000000270601413423552100207120ustar00rootroot00000000000000# # OpenSSL example configuration file. # This is mostly being used for generation of certificate requests. # # This definition stops the following lines choking if HOME isn't # defined. HOME = . RANDFILE = $ENV::HOME/.rnd # Extra OBJECT IDENTIFIER info: #oid_file = $ENV::HOME/.oid oid_section = new_oids # To use this configuration file with the "-extfile" option of the # "openssl x509" utility, name here the section containing the # X.509v3 extensions to use: # extensions = # (Alternatively, use a configuration file that has only # X.509v3 extensions in its main [= default] section.) [ new_oids ] # We can add new OIDs in here for use by 'ca', 'req' and 'ts'. # Add a simple OID like this: # testoid1=1.2.3.4 # Or use config file substitution like this: # testoid2=${testoid1}.5.6 # Policies used by the TSA examples. tsa_policy1 = 1.2.3.4.1 tsa_policy2 = 1.2.3.4.5.6 tsa_policy3 = 1.2.3.4.5.7 #################################################################### [ ca ] default_ca = CA_default # The default ca section #################################################################### [ CA_signing ] dir = ./signingCA # Where everything is kept certs = $dir/certs # Where the issued certs are kept crl_dir = $dir/crl # Where the issued crl are kept database = $dir/index.txt # database index file. #unique_subject = no # Set to 'no' to allow creation of # several ctificates with same subject. new_certs_dir = $dir/newcerts # default place for new certs. certificate = test-signing-ca.crt # The CA certificate serial = $dir/serial # The current serial number crlnumber = $dir/crlnumber # the current crl number # must be commented out to leave a V1 CRL crl = $dir/crl.pem # The current CRL private_key = test-signing-ca.key # The private key RANDFILE = $dir/.rand # private random number file x509_extensions = usr_cert # The extentions to add to the cert # Comment out the following two lines for the "traditional" # (and highly broken) format. name_opt = ca_default # Subject Name options cert_opt = ca_default # Certificate field options # Extension copying option: use with caution. # copy_extensions = copy # Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs # so this is commented out by default to leave a V1 CRL. # crlnumber must also be commented out to leave a V1 CRL. # crl_extensions = crl_ext default_days = 1825 # how long to certify for default_crl_days= 30 # how long before next CRL default_md = default # use public key default MD preserve = no # keep passed DN ordering # A few difference way of specifying how similar the request should look # For type CA, the listed attributes must be the same, and the optional # and supplied fields are just that :-) policy = policy_anything [ CA_inter ] dir = ./interCA certs = $dir/certs crl_dir = $dir/crl database = $dir/index.txt new_certs_dir = $dir/newcerts certificate = test-inter-ca.crt serial = $dir/serial crlnumber = $dir/crlnumber crl = $dir/crl.pem private_key = test-inter-ca.key RANDFILE = $dir/.rand #x509_extensions = v3_ca x509_extensions = usr_cert name_opt = ca_default cert_opt = ca_default default_days = 1825 default_crl_days = 30 default_md = default preserve = no policy = policy_match unique_subject = yes [ CA_root ] dir = ./rootCA certs = $dir/certs crl_dir = $dir/crl database = $dir/index.txt new_certs_dir = $dir/newcerts certificate = test-root-ca.crt serial = $dir/serial crlnumber = $dir/crlnumber crl = $dir/crl.pem private_key = test-root-ca.key RANDFILE = $dir/.rand x509_extensions = v3_ca name_opt = ca_default cert_opt = ca_default default_days = 1825 default_crl_days = 30 default_md = default preserve = no policy = policy_match unique_subject = yes # For the CA policy [ policy_match ] countryName = match stateOrProvinceName = match organizationName = match organizationalUnitName = optional commonName = supplied emailAddress = optional # For the 'anything' policy # At this point in time, you must list all acceptable 'object' # types. [ policy_anything ] countryName = optional stateOrProvinceName = optional localityName = optional organizationName = optional organizationalUnitName = optional commonName = supplied emailAddress = optional #################################################################### [ req ] default_bits = 2048 default_keyfile = privkey.pem distinguished_name = req_distinguished_name attributes = req_attributes x509_extensions = v3_ca # The extentions to add to the self signed cert # Passwords for private keys if not present they will be prompted for # input_password = secret # output_password = secret # This sets a mask for permitted string types. There are several options. # default: PrintableString, T61String, BMPString. # pkix : PrintableString, BMPString (PKIX recommendation before 2004) # utf8only: only UTF8Strings (PKIX recommendation after 2004). # nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings). # MASK:XXXX a literal mask value. # WARNING: ancient versions of Netscape crash on BMPStrings or UTF8Strings. string_mask = utf8only # req_extensions = v3_req # The extensions to add to a certificate request [ req_distinguished_name ] countryName = Country Name (2 letter code) countryName_default = GB countryName_min = 2 countryName_max = 2 stateOrProvinceName = State or Province Name (full name) stateOrProvinceName_default = Derbyshire localityName = Locality Name (eg, city) localityName_default = Derby 0.organizationName = Organization Name (eg, company) 0.organizationName_default = Paho Project # we can do this but it is not needed normally :-) #1.organizationName = Second Organization Name (eg, company) #1.organizationName_default = World Wide Web Pty Ltd organizationalUnitName = Organizational Unit Name (eg, section) organizationalUnitName_default = Testing commonName = Common Name (e.g. server FQDN or YOUR name) commonName_max = 64 emailAddress = Email Address emailAddress_max = 64 # SET-ex3 = SET extension number 3 [ req_attributes ] challengePassword = A challenge password challengePassword_min = 4 challengePassword_max = 20 unstructuredName = An optional company name [ usr_cert ] # These extensions are added when 'ca' signs a request. # This goes against PKIX guidelines but some CAs do it and some software # requires this to avoid interpreting an end user certificate as a CA. basicConstraints=CA:FALSE # Here are some examples of the usage of nsCertType. If it is omitted # the certificate can be used for anything *except* object signing. # This is OK for an SSL server. # nsCertType = server # For an object signing certificate this would be used. # nsCertType = objsign # For normal client use this is typical # nsCertType = client, email # and for everything including object signing: # nsCertType = client, email, objsign # This is typical in keyUsage for a client certificate. # keyUsage = nonRepudiation, digitalSignature, keyEncipherment # This will be displayed in Netscape's comment listbox. nsComment = "OpenSSL Generated Certificate" # PKIX recommendations harmless if included in all certificates. subjectKeyIdentifier=hash authorityKeyIdentifier=keyid,issuer # This stuff is for subjectAltName and issuerAltname. # Import the email address. # subjectAltName=email:copy # An alternative to produce certificates that aren't # deprecated according to PKIX. # subjectAltName=email:move # Copy subject details # issuerAltName=issuer:copy #nsCaRevocationUrl = http://www.domain.dom/ca-crl.pem #nsBaseUrl #nsRevocationUrl #nsRenewalUrl #nsCaPolicyUrl #nsSslServerName # This is required for TSA certificates. # extendedKeyUsage = critical,timeStamping [ v3_req ] # Extensions to add to a certificate request basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment [ v3_ca ] # Extensions for a typical CA # PKIX recommendation. subjectKeyIdentifier=hash authorityKeyIdentifier=keyid:always,issuer # This is what PKIX recommends but some broken software chokes on critical # extensions. #basicConstraints = critical,CA:true # So we do this instead. basicConstraints = CA:true # Key usage: this is typical for a CA certificate. However since it will # prevent it being used as an test self-signed certificate it is best # left out by default. # keyUsage = cRLSign, keyCertSign # Some might want this also # nsCertType = sslCA, emailCA # Include email address in subject alt name: another PKIX recommendation # subjectAltName=email:copy # Copy issuer details # issuerAltName=issuer:copy # DER hex encoding of an extension: beware experts only! # obj=DER:02:03 # Where 'obj' is a standard or added object # You can even override a supported extension: # basicConstraints= critical, DER:30:03:01:01:FF [ crl_ext ] # CRL extensions. # Only issuerAltName and authorityKeyIdentifier make any sense in a CRL. # issuerAltName=issuer:copy authorityKeyIdentifier=keyid:always [ proxy_cert_ext ] # These extensions should be added when creating a proxy certificate # This goes against PKIX guidelines but some CAs do it and some software # requires this to avoid interpreting an end user certificate as a CA. basicConstraints=CA:FALSE # Here are some examples of the usage of nsCertType. If it is omitted # the certificate can be used for anything *except* object signing. # This is OK for an SSL server. # nsCertType = server # For an object signing certificate this would be used. # nsCertType = objsign # For normal client use this is typical # nsCertType = client, email # and for everything including object signing: # nsCertType = client, email, objsign # This is typical in keyUsage for a client certificate. # keyUsage = nonRepudiation, digitalSignature, keyEncipherment # This will be displayed in Netscape's comment listbox. nsComment = "OpenSSL Generated Certificate" # PKIX recommendations harmless if included in all certificates. subjectKeyIdentifier=hash authorityKeyIdentifier=keyid,issuer # This stuff is for subjectAltName and issuerAltname. # Import the email address. # subjectAltName=email:copy # An alternative to produce certificates that aren't # deprecated according to PKIX. # subjectAltName=email:move # Copy subject details # issuerAltName=issuer:copy #nsCaRevocationUrl = http://www.domain.dom/ca-crl.pem #nsBaseUrl #nsRevocationUrl #nsRenewalUrl #nsCaPolicyUrl #nsSslServerName # This really needs to be in place for it to be a proxy certificate. proxyCertInfo=critical,language:id-ppl-anyLanguage,pathlen:3,policy:foo #################################################################### [ tsa ] default_tsa = tsa_config1 # the default TSA section [ tsa_config1 ] # These are used by the TSA reply generation only. dir = ./demoCA # TSA root directory serial = $dir/tsaserial # The current serial number (mandatory) crypto_device = builtin # OpenSSL engine to use for signing signer_cert = $dir/tsacert.pem # The TSA signing certificate # (optional) certs = $dir/cacert.pem # Certificate chain to include in reply # (optional) signer_key = $dir/private/tsakey.pem # The TSA private key (optional) default_policy = tsa_policy1 # Policy if request did not specify it # (optional) other_policies = tsa_policy2, tsa_policy3 # acceptable policies (optional) digests = md5, sha1 # Acceptable message digests (mandatory) accuracy = secs:1, millisecs:500, microsecs:100 # (optional) clock_precision_digits = 0 # number of digits after dot. (optional) ordering = yes # Is ordering defined for timestamps? # (optional, default: no) tsa_name = yes # Must the TSA name be included in the reply? # (optional, default: no) ess_cert_id_chain = no # Must the ESS cert id chain be included? # (optional, default: no) paho.mqtt.python-1.6.1/test/ssl/server-expired.crt000066400000000000000000000106521413423552100222140ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 1 (0x1) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Validity Not Before: Aug 20 00:00:00 2012 GMT Not After : Aug 21 00:00:00 2012 GMT Subject: C=GB, ST=Nottinghamshire, L=Nottingham, O=Server, OU=Production, CN=localhost Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:a9:4c:88:db:56:36:f8:fc:e1:eb:6b:ad:9c:0f: 78:3e:7d:d7:34:c6:83:94:6d:83:07:d5:3e:cb:fb: 95:61:e5:73:78:43:db:51:d9:a0:4e:ec:8e:43:21: 91:1f:56:95:08:47:7c:83:38:90:bb:53:91:ed:fd: b4:bd:08:27:dd:d6:d9:5b:fd:bb:84:1e:2e:62:d9: 3c:1d:4d:c9:6b:17:45:d7:9e:b4:a5:9c:22:cd:14: 41:32:c3:41:ad:8d:f5:2f:a3:d5:59:1f:a1:2b:67: d3:01:83:64:93:80:6b:bf:5a:b8:51:86:20:a0:e4: 3f:18:0c:67:19:8d:e3:58:6d:85:83:8f:8b:37:b2: 7d:21:3f:65:cf:19:53:2e:56:df:4d:89:50:7e:8c: 6a:8e:dd:21:15:15:31:9b:c2:5c:98:68:1e:31:ff: c6:6c:1f:a8:42:b8:da:62:dc:ae:62:4c:40:f0:06: c6:e6:f4:a9:98:3d:ed:fb:c0:2a:63:da:60:69:83: 11:0e:ce:ba:93:d7:4b:27:8f:86:91:ef:e4:65:5f: 20:be:04:f2:4d:d6:d1:74:c5:ab:e9:18:df:16:f9: 9a:8a:ff:2f:23:c5:46:3e:04:16:4e:fa:c1:0a:f4: dc:8e:1a:da:5f:a1:ad:50:7a:5d:60:00:3e:09:b8: 8e:6d Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Basic Constraints: CA:FALSE Netscape Comment: OpenSSL Generated Certificate X509v3 Subject Key Identifier: C3:47:33:CF:07:18:14:7C:9A:E4:AB:11:62:89:88:54:3D:5D:7D:E8 X509v3 Authority Key Identifier: keyid:C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 Signature Algorithm: sha256WithRSAEncryption ca:b6:c4:8a:76:e2:14:01:2f:58:ea:5f:28:f3:1d:de:a5:73: 17:13:d0:5a:2f:51:f8:a7:79:34:06:9d:73:8e:c9:bd:ba:e4: 03:64:7b:fc:29:b1:f3:4a:22:a1:bd:31:7a:4e:03:0d:f0:0c: b0:d8:40:03:7a:b6:a5:2a:ff:78:0b:de:49:7b:ee:11:97:52: 2a:df:68:53:d3:88:ac:bd:f2:04:25:68:04:12:8f:ea:26:05: 0d:9b:71:76:a9:cd:ff:99:78:44:86:07:56:04:14:c6:d7:1d: 63:6e:9f:07:76:95:0b:a0:2b:a2:0d:c4:79:ff:80:c2:80:cb: 83:c3:ec:ae:46:62:bb:09:71:c9:65:00:b8:6a:13:a4:a7:31: ad:ff:81:97:1c:84:1e:16:d5:c2:69:83:88:63:2d:33:31:52: 1b:fc:dc:c7:40:5c:c8:3e:0a:15:87:7f:82:47:8d:3e:f2:3e: 43:34:c1:8f:9c:16:61:1e:17:3f:4b:37:e1:aa:80:ad:87:09: cb:5c:fe:5a:28:4d:85:ca:45:58:6f:a6:ab:e2:f7:7a:24:c9: 34:2a:75:b9:29:b8:db:cf:0b:72:e3:89:06:d6:6c:a9:9f:82: e6:0f:90:b9:1a:4e:d1:f1:24:32:79:77:d3:cf:8f:27:64:f3: d6:3e:ff:45 -----BEGIN CERTIFICATE----- MIIDzDCCArSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEVMBMGA1UECgwMUGFobyBQcm9qZWN0MRAwDgYD VQQLDAdUZXN0aW5nMRMwEQYDVQQDDApTaWduaW5nIENBMB4XDTEyMDgyMDAwMDAw MFoXDTEyMDgyMTAwMDAwMFowdjELMAkGA1UEBhMCR0IxGDAWBgNVBAgMD05vdHRp bmdoYW1zaGlyZTETMBEGA1UEBwwKTm90dGluZ2hhbTEPMA0GA1UECgwGU2VydmVy MRMwEQYDVQQLDApQcm9kdWN0aW9uMRIwEAYDVQQDDAlsb2NhbGhvc3QwggEiMA0G CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCpTIjbVjb4/OHra62cD3g+fdc0xoOU bYMH1T7L+5Vh5XN4Q9tR2aBO7I5DIZEfVpUIR3yDOJC7U5Ht/bS9CCfd1tlb/buE Hi5i2TwdTclrF0XXnrSlnCLNFEEyw0GtjfUvo9VZH6ErZ9MBg2STgGu/WrhRhiCg 5D8YDGcZjeNYbYWDj4s3sn0hP2XPGVMuVt9NiVB+jGqO3SEVFTGbwlyYaB4x/8Zs H6hCuNpi3K5iTEDwBsbm9KmYPe37wCpj2mBpgxEOzrqT10snj4aR7+RlXyC+BPJN 1tF0xavpGN8W+ZqK/y8jxUY+BBZO+sEK9NyOGtpfoa1Qel1gAD4JuI5tAgMBAAGj ezB5MAkGA1UdEwQCMAAwLAYJYIZIAYb4QgENBB8WHU9wZW5TU0wgR2VuZXJhdGVk IENlcnRpZmljYXRlMB0GA1UdDgQWBBTDRzPPBxgUfJrkqxFiiYhUPV196DAfBgNV HSMEGDAWgBTCjwmb1fG6xHRel1C7hp2h8frENjANBgkqhkiG9w0BAQsFAAOCAQEA yrbEinbiFAEvWOpfKPMd3qVzFxPQWi9R+Kd5NAadc47JvbrkA2R7/Cmx80oiob0x ek4DDfAMsNhAA3q2pSr/eAveSXvuEZdSKt9oU9OIrL3yBCVoBBKP6iYFDZtxdqnN /5l4RIYHVgQUxtcdY26fB3aVC6Arog3Eef+AwoDLg8PsrkZiuwlxyWUAuGoTpKcx rf+BlxyEHhbVwmmDiGMtMzFSG/zcx0BcyD4KFYd/gkeNPvI+QzTBj5wWYR4XP0s3 4aqArYcJy1z+WihNhcpFWG+mq+L3eiTJNCp1uSm4288LcuOJBtZsqZ+C5g+QuRpO 0fEkMnl308+PJ2Tz1j7/RQ== -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/server.crt000066400000000000000000000106521413423552100205560ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 1 (0x1) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Validity Not Before: Jul 7 11:14:42 2021 GMT Not After : Jul 6 11:14:42 2026 GMT Subject: C=GB, ST=Nottinghamshire, L=Nottingham, O=Server, OU=Production, CN=localhost Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:a9:4c:88:db:56:36:f8:fc:e1:eb:6b:ad:9c:0f: 78:3e:7d:d7:34:c6:83:94:6d:83:07:d5:3e:cb:fb: 95:61:e5:73:78:43:db:51:d9:a0:4e:ec:8e:43:21: 91:1f:56:95:08:47:7c:83:38:90:bb:53:91:ed:fd: b4:bd:08:27:dd:d6:d9:5b:fd:bb:84:1e:2e:62:d9: 3c:1d:4d:c9:6b:17:45:d7:9e:b4:a5:9c:22:cd:14: 41:32:c3:41:ad:8d:f5:2f:a3:d5:59:1f:a1:2b:67: d3:01:83:64:93:80:6b:bf:5a:b8:51:86:20:a0:e4: 3f:18:0c:67:19:8d:e3:58:6d:85:83:8f:8b:37:b2: 7d:21:3f:65:cf:19:53:2e:56:df:4d:89:50:7e:8c: 6a:8e:dd:21:15:15:31:9b:c2:5c:98:68:1e:31:ff: c6:6c:1f:a8:42:b8:da:62:dc:ae:62:4c:40:f0:06: c6:e6:f4:a9:98:3d:ed:fb:c0:2a:63:da:60:69:83: 11:0e:ce:ba:93:d7:4b:27:8f:86:91:ef:e4:65:5f: 20:be:04:f2:4d:d6:d1:74:c5:ab:e9:18:df:16:f9: 9a:8a:ff:2f:23:c5:46:3e:04:16:4e:fa:c1:0a:f4: dc:8e:1a:da:5f:a1:ad:50:7a:5d:60:00:3e:09:b8: 8e:6d Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Basic Constraints: CA:FALSE Netscape Comment: OpenSSL Generated Certificate X509v3 Subject Key Identifier: C3:47:33:CF:07:18:14:7C:9A:E4:AB:11:62:89:88:54:3D:5D:7D:E8 X509v3 Authority Key Identifier: keyid:C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 Signature Algorithm: sha256WithRSAEncryption a9:34:8d:b4:6c:99:14:e7:10:dc:36:7e:c2:24:7f:bf:9d:65: 4c:2b:50:90:13:de:85:29:d7:b0:d5:c2:a0:d6:c2:42:40:9f: 6a:b7:6a:05:cf:7e:57:ff:2c:3c:ba:0c:cf:e7:0a:92:89:6e: 8b:bb:0c:b5:28:79:00:76:ed:12:cc:54:79:05:41:88:26:c9: e3:a8:6b:ba:1a:31:92:e6:40:2c:c6:a9:e8:4b:1b:4c:25:f1: 7b:c5:19:0b:73:37:53:86:d5:8e:d1:1c:78:73:e4:a5:84:0f: 49:5a:eb:80:15:09:c2:69:83:34:c0:da:db:9d:fa:eb:32:1f: e0:2e:99:f2:b0:76:91:8a:eb:34:b5:4d:c9:79:2a:f8:ef:f0: 6d:55:a4:9d:f9:5f:61:d3:f8:ab:95:0a:12:12:64:33:c3:2f: 6b:64:14:31:bf:42:c9:c8:9e:be:45:4f:02:c8:50:54:be:79: fe:e2:9a:fa:2d:b7:73:25:34:ea:53:dd:03:a4:f9:82:28:a7: 95:37:f7:45:56:21:7a:e6:71:eb:95:34:99:15:1c:26:ac:00: bc:95:b0:91:d8:8a:d0:0d:98:8e:28:d7:76:14:b6:94:c9:ab: df:87:40:58:12:da:ee:65:d8:08:f2:05:f2:5e:3e:d2:8d:09: 38:8f:b2:79 -----BEGIN CERTIFICATE----- MIIDzDCCArSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEVMBMGA1UECgwMUGFobyBQcm9qZWN0MRAwDgYD VQQLDAdUZXN0aW5nMRMwEQYDVQQDDApTaWduaW5nIENBMB4XDTIxMDcwNzExMTQ0 MloXDTI2MDcwNjExMTQ0MlowdjELMAkGA1UEBhMCR0IxGDAWBgNVBAgMD05vdHRp bmdoYW1zaGlyZTETMBEGA1UEBwwKTm90dGluZ2hhbTEPMA0GA1UECgwGU2VydmVy MRMwEQYDVQQLDApQcm9kdWN0aW9uMRIwEAYDVQQDDAlsb2NhbGhvc3QwggEiMA0G CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCpTIjbVjb4/OHra62cD3g+fdc0xoOU bYMH1T7L+5Vh5XN4Q9tR2aBO7I5DIZEfVpUIR3yDOJC7U5Ht/bS9CCfd1tlb/buE Hi5i2TwdTclrF0XXnrSlnCLNFEEyw0GtjfUvo9VZH6ErZ9MBg2STgGu/WrhRhiCg 5D8YDGcZjeNYbYWDj4s3sn0hP2XPGVMuVt9NiVB+jGqO3SEVFTGbwlyYaB4x/8Zs H6hCuNpi3K5iTEDwBsbm9KmYPe37wCpj2mBpgxEOzrqT10snj4aR7+RlXyC+BPJN 1tF0xavpGN8W+ZqK/y8jxUY+BBZO+sEK9NyOGtpfoa1Qel1gAD4JuI5tAgMBAAGj ezB5MAkGA1UdEwQCMAAwLAYJYIZIAYb4QgENBB8WHU9wZW5TU0wgR2VuZXJhdGVk IENlcnRpZmljYXRlMB0GA1UdDgQWBBTDRzPPBxgUfJrkqxFiiYhUPV196DAfBgNV HSMEGDAWgBTCjwmb1fG6xHRel1C7hp2h8frENjANBgkqhkiG9w0BAQsFAAOCAQEA qTSNtGyZFOcQ3DZ+wiR/v51lTCtQkBPehSnXsNXCoNbCQkCfardqBc9+V/8sPLoM z+cKkolui7sMtSh5AHbtEsxUeQVBiCbJ46hruhoxkuZALMap6EsbTCXxe8UZC3M3 U4bVjtEceHPkpYQPSVrrgBUJwmmDNMDa25366zIf4C6Z8rB2kYrrNLVNyXkq+O/w bVWknflfYdP4q5UKEhJkM8Mva2QUMb9CycievkVPAshQVL55/uKa+i23cyU06lPd A6T5giinlTf3RVYheuZx65U0mRUcJqwAvJWwkdiK0A2YjijXdhS2lMmr34dAWBLa 7mXYCPIF8l4+0o0JOI+yeQ== -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/server.key000066400000000000000000000032131413423552100205510ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAqUyI21Y2+Pzh62utnA94Pn3XNMaDlG2DB9U+y/uVYeVzeEPb UdmgTuyOQyGRH1aVCEd8gziQu1OR7f20vQgn3dbZW/27hB4uYtk8HU3JaxdF1560 pZwizRRBMsNBrY31L6PVWR+hK2fTAYNkk4Brv1q4UYYgoOQ/GAxnGY3jWG2Fg4+L N7J9IT9lzxlTLlbfTYlQfoxqjt0hFRUxm8JcmGgeMf/GbB+oQrjaYtyuYkxA8AbG 5vSpmD3t+8AqY9pgaYMRDs66k9dLJ4+Gke/kZV8gvgTyTdbRdMWr6RjfFvmaiv8v I8VGPgQWTvrBCvTcjhraX6GtUHpdYAA+CbiObQIDAQABAoIBAFAbWL6AIu7ZqYSd pL4tS7Y2ETh1nhkDYHa6XkZiuqJh0atcYFBwazwtDnuRTHvJmicavD3S7BjXSDuW SokPbN25JYwzmSDAry4yoBE1l1LG5lNKUyvxnz3ukZMVdORMQXHTUcYkAzzomZ0j sNlicJlQsdpRXusCVSBp7fbXfnV+SCRA0JZrMkCmkkQASpzlfZaDYxT+QYzNZ7aS W4c+YwLEaSyVRPmWdelj17d1XP5RdnsL6Fhho6wNRoT18tgSvvl1cWv+/e+eMGFQ hxmTJmcBxTTxVDF1+bHIYNHkxHD4OEcrYIP99wwYg9zanO9edxD1OSY5a0xupNns E9r517kCgYEA0S76Kz0UOmuLnT7KUs6dq5fXq+LJU5Dp6cnMiEtz65VqgBUEwRGn WNPKDzMQ5SrfNCw6aEpRwPSJOPRoRbFvCZ1ZqHzunjOhssIjGiMMJq+WpckgoX8b kvzzCpf8DfEHep7PAu/ixKZs5Jm6wliF52dWt6rgYEPK33A4qa9R1aMCgYEAzzBm gqQ4DZy/ZkUp0GZ1gPJ+wpKJug96Bb7PMMnCtVtcfTtjyR1q7JWaZdli1vCKlMKW /sOmydD8uPkKhnxy6Ksz5u5/ZCBxkANGnEOc3ED3v7wXHCoiQwsl59lH0yoqx4ua Ur59L/ZVTMZAjtpci2NTTMN+mezR9LXvQb2qrK8CgYEAjVjs+mKfVIpvIKXZGPM8 X0KPHTp1R95X8P3HEyHJBptEB6AsQjmnlsIlevfKps+9Wwe3v9jYPUX/o1ijTNSE bz6/4rXol0XUMXI1PegIwetMJGIvhnDZNQ1vPO1OCC2iHB1LTHTECpVaZ23pYIFo meCeHCV+0A1+/FRcNWyeI3kCgYBgFnhUOkjstzdk/MqJphr0tIHpRwCs06SpqXZ5 j/jHFxnr0nFSwlvmYPN8LLdUK7Z5i01v1dkyW8P5HTaubGT2Vv/5J77Y9tr0CTDk I89Jrq+3skmdfETrhu4Leo9+9V1lse7eVQ3GAp5IvuEN32NwGZ52SWwbguNUdFQD zyyqbQKBgBj7ltu2L59S03I1rV1Wrm+BFYbsqTZrU2PaA0nz2/mZjzkp+BYqqeRA y/LBOHiaUxsPZqyR+neOSoDuQK2HWjut5B9JFy61m2pw2E2qwdkpOmceQYuLRRO7 UAaHfCfkHE9R8k8FePBNB1HwWGGj02BpF5jP5Oph/JyuuQvPPH+M -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/test-alt-ca.crt000066400000000000000000000104461413423552100213670ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 2 (0x2) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, L=Derby, O=Paho Project, OU=Testing, CN=Root CA Validity Not Before: Jul 7 11:14:42 2021 GMT Not After : Jul 6 11:14:42 2026 GMT Subject: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Alternative Signing CA Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:ca:f5:4f:c2:30:7d:fd:65:75:06:00:22:72:0a: d0:74:1e:00:03:aa:f3:64:1a:d4:d0:25:85:b9:2e: 73:72:41:06:12:d9:52:1d:39:11:78:2d:c3:0d:d7: 6f:06:05:68:3a:cc:ce:36:8d:a7:3a:a9:31:77:eb: e9:2d:87:00:7e:86:7a:bb:52:c2:02:d7:ef:07:4f: a9:88:91:d6:6e:dd:19:84:89:dc:72:bb:08:23:b4: be:1a:cf:af:b8:1a:af:62:21:d3:d4:a2:78:2f:b6: 4a:44:6f:ab:7f:d7:27:21:79:40:2b:db:bf:90:bf: fb:cf:a4:fa:8b:25:f6:ad:f9:73:57:41:49:86:1d: ed:3c:c9:d5:43:e0:ac:8a:4a:88:51:ea:cf:95:f0: 50:4b:ee:4c:fc:74:1d:92:00:5f:75:97:23:e4:b1: 79:b1:b0:b8:e1:97:38:6c:78:b6:c1:a6:e7:2e:95: 39:c8:ed:2a:65:65:b7:09:45:d4:f2:f1:4f:bf:97: 9d:98:b7:26:0d:c1:cf:93:d1:55:9f:af:39:6f:71: 29:a4:e9:74:48:2c:eb:8a:11:3d:3f:c4:3c:12:fe: 0c:d9:c9:fc:2c:77:22:de:c8:bb:8e:05:55:0a:2b: 18:38:0f:68:5d:2f:26:ea:cc:ec:04:df:fb:54:c4: 83:3b Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Subject Key Identifier: 9E:74:83:0D:43:6F:21:68:72:E1:A3:FC:E0:2D:C3:D0:47:55:0C:31 X509v3 Authority Key Identifier: keyid:13:A0:B6:1F:F5:C7:64:C2:F9:FD:2E:08:F2:19:01:77:54:19:73:7F X509v3 Basic Constraints: CA:TRUE Signature Algorithm: sha256WithRSAEncryption 31:c8:c3:5c:31:7c:85:12:e0:01:9c:1a:eb:be:32:f0:19:cd: f3:55:e8:13:34:27:39:69:ca:88:1e:e9:44:47:9b:e1:bf:ff: 3f:65:62:02:9f:ae:be:21:1d:03:83:02:3e:a8:f2:d4:fa:e8: 14:50:e6:53:9e:e1:90:f9:96:5d:73:f3:da:8d:38:33:6d:5f: f9:ce:9b:60:d3:ae:86:18:7f:ef:4a:d1:69:4d:03:a7:e8:a5: c4:42:59:50:22:d1:25:bd:a4:22:d1:9c:f9:4c:72:ee:3d:e3: e1:c7:b0:c2:16:ba:46:4e:c9:29:91:e0:97:52:d8:3c:be:e2: ef:1c:aa:89:6d:ba:75:35:80:12:5d:5c:33:15:6c:fe:1b:1f: 4a:b4:1a:12:47:d3:4b:cd:d2:96:61:88:69:ac:b4:3c:d5:be: 52:7e:a0:99:5a:52:65:6a:86:ea:a7:a2:50:66:48:71:e3:82: 9f:fc:ff:89:58:ef:04:fa:af:76:98:1b:40:d6:71:14:29:1e: db:b8:31:47:2b:4b:de:f3:e2:e5:d0:a0:75:1e:b6:d9:32:3f: 8e:54:c3:92:e1:0f:74:85:0d:e9:27:5b:21:e8:f0:7b:10:3c: 14:e4:9d:97:65:18:ef:57:ce:de:b9:f7:01:d0:b9:e4:81:7a: a3:d2:35:8c -----BEGIN CERTIFICATE----- MIIDpDCCAoygAwIBAgIBAjANBgkqhkiG9w0BAQsFADBtMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEOMAwGA1UEBwwFRGVyYnkxFTATBgNVBAoMDFBh aG8gUHJvamVjdDEQMA4GA1UECwwHVGVzdGluZzEQMA4GA1UEAwwHUm9vdCBDQTAe Fw0yMTA3MDcxMTE0NDJaFw0yNjA3MDYxMTE0NDJaMGwxCzAJBgNVBAYTAkdCMRMw EQYDVQQIDApEZXJieXNoaXJlMRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNV BAsMB1Rlc3RpbmcxHzAdBgNVBAMMFkFsdGVybmF0aXZlIFNpZ25pbmcgQ0EwggEi MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDK9U/CMH39ZXUGACJyCtB0HgAD qvNkGtTQJYW5LnNyQQYS2VIdORF4LcMN128GBWg6zM42jac6qTF36+kthwB+hnq7 UsIC1+8HT6mIkdZu3RmEidxyuwgjtL4az6+4Gq9iIdPUongvtkpEb6t/1ycheUAr 27+Qv/vPpPqLJfat+XNXQUmGHe08ydVD4KyKSohR6s+V8FBL7kz8dB2SAF91lyPk sXmxsLjhlzhseLbBpuculTnI7SplZbcJRdTy8U+/l52YtyYNwc+T0VWfrzlvcSmk 6XRILOuKET0/xDwS/gzZyfwsdyLeyLuOBVUKKxg4D2hdLybqzOwE3/tUxIM7AgMB AAGjUDBOMB0GA1UdDgQWBBSedIMNQ28haHLho/zgLcPQR1UMMTAfBgNVHSMEGDAW gBQToLYf9cdkwvn9LgjyGQF3VBlzfzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEB CwUAA4IBAQAxyMNcMXyFEuABnBrrvjLwGc3zVegTNCc5acqIHulER5vhv/8/ZWIC n66+IR0DgwI+qPLU+ugUUOZTnuGQ+ZZdc/PajTgzbV/5zptg066GGH/vStFpTQOn 6KXEQllQItElvaQi0Zz5THLuPePhx7DCFrpGTskpkeCXUtg8vuLvHKqJbbp1NYAS XVwzFWz+Gx9KtBoSR9NLzdKWYYhprLQ81b5SfqCZWlJlaobqp6JQZkhx44Kf/P+J WO8E+q92mBtA1nEUKR7buDFHK0ve8+Ll0KB1HrbZMj+OVMOS4Q90hQ3pJ1sh6PB7 EDwU5J2XZRjvV87eufcB0LnkgXqj0jWM -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/test-alt-ca.key000066400000000000000000000032171413423552100213650ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEAyvVPwjB9/WV1BgAicgrQdB4AA6rzZBrU0CWFuS5zckEGEtlS HTkReC3DDddvBgVoOszONo2nOqkxd+vpLYcAfoZ6u1LCAtfvB0+piJHWbt0ZhInc crsII7S+Gs+vuBqvYiHT1KJ4L7ZKRG+rf9cnIXlAK9u/kL/7z6T6iyX2rflzV0FJ hh3tPMnVQ+CsikqIUerPlfBQS+5M/HQdkgBfdZcj5LF5sbC44Zc4bHi2wabnLpU5 yO0qZWW3CUXU8vFPv5edmLcmDcHPk9FVn685b3EppOl0SCzrihE9P8Q8Ev4M2cn8 LHci3si7jgVVCisYOA9oXS8m6szsBN/7VMSDOwIDAQABAoIBADVkjcP/b9Wu0Ddw 557q22YA0m4klf061cugY2qRHsvq8UcaJvELJ15fY5YLm+iQmZgGcyWE5H6ZLitn Q6O3hVjD1hvbrLCE0BwzR91myGvH/MOSZQ1FyOFj1jNFeevMEWGWlpy01TtwEF+q pQpvtpqmxEwFdoMFDqDUvRjINvoTUn1zijLA/tujEwHDriSjQPNd8/RcxYONQaAu 3SLInf7Gp3cJJ/EbE+MyK+/DpiG6kQ8Xkxdq928XtSpQAhxVjBzXaZR+hIXu+9jK 884Avl/TqRwKoMpLQIUaSVz4F65Hprz1y+Jo28OZ5x+l1oicdnWPTbNtc2xqWcQ1 3p0lO/ECgYEA96OAHgRwFwUwOmm9CDbAiYX4yssa7gmU1GVEJukqVwSb95M2Dff8 SgkhBABIHcPsYdNAi0klvJv6VqxRHC0dvGi3y0MFG+VdihtpOEh7GrH1aNyUohS0 Mx0p6fZjR2mLjCfdnTVD8mtGT97bTrkOP8jYe6r5ZpCE5V3fVHQif9MCgYEA0c+c DejT1uQMq3wQm5NwusRrMO6Eo/VOEJ22nkXNKC5kQEs8kXN8nkRdGCMznQY2Iurc MxhFPa1mBvYGVyefZFLjHJe1rWD0zujmjdjZ3cj9h0O5jf0vefQGuP5uteCtmUoj 81eGXfRac/ntEdFQLNEv9PSvBRZpup7e/koStfkCgYEAyEYYtS4NoPB3QqaFVIFD UXVh8lA0ZVKmZOfJKFbmAR4fLSiHTODDzvR3GQ9JQ5lSMQNybbMoq9LRsQsHRexO 4jMmgWKgXSEwdyMYA4bK2JoXyUirhDGOUtBBN5AmVnjLfPw4xI1xeDq90JaBcrdD CN7cBZgOv54dfIpgtaJ+zDUCgYEA0CzQSDTVzAgmUhgdWmAmoAm32asvzIbe2DnE MrJLZyzwp6J/DEqsQVTPkd2LnqfFG0wxBDl2qkXcT9fYXq2fxyk+0uXsi4UCIjKQ X/nj4d1FQOr/t1SZwMVRzkgVjTzKwqf/l7kmRx7miOBYSy+F/5HnpYMKDWA5s8Ni uqjAe/ECgYB/ew66RJjRiAxg5DnErIw6RX3lblHuK9tZ3uwyxVLev6wJnps1X4Ar m1WHFGgOGDDqOfC1n7JBp7qvWfLtr93aMlcSUPp34XItBr4LMgPAhk4irb079aoJ pCCx0JV+8ydFi4QaQcu4BRaed9T9PITf+qqTMtyXy4Q4QolV4rqiDw== -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/test-bad-root-ca.crt000066400000000000000000000025231413423552100223130ustar00rootroot00000000000000-----BEGIN CERTIFICATE----- MIIDwDCCAqigAwIBAgIUZQzHgL/r7su5tQBXIZvwqj+HdqIwDQYJKoZIhvcNAQEL BQAwcTELMAkGA1UEBhMCR0IxEzARBgNVBAgMCkRlcmJ5c2hpcmUxDjAMBgNVBAcM BURlcmJ5MRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNVBAsMB1Rlc3Rpbmcx FDASBgNVBAMMC0JhZCBSb290IENBMB4XDTIxMDcwNzExMTQ0MloXDTMxMDcwNTEx MTQ0MlowcTELMAkGA1UEBhMCR0IxEzARBgNVBAgMCkRlcmJ5c2hpcmUxDjAMBgNV BAcMBURlcmJ5MRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNVBAsMB1Rlc3Rp bmcxFDASBgNVBAMMC0JhZCBSb290IENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A MIIBCgKCAQEA3DRlR+CK8ZBUfaZB4RzWErQ+lewTPu+FaQuCSBvBMKgd+S0r/mZ0 dQsA2/mWymggxb1wIZt/TY9sz2v1pYmg2Cw/dld9AQvJaqMXPdn3ZAmsihYd3is8 M4c0FlFowHv0LyWUOlRJfUrAPc4aorRK4Dqssl+s8W/ikyiKsMKBk0Z1LQBxUzst AAQ3voBJW7SVsRzYgcbyITW2IXYBjsIJRWK68+TCNCqlmVKEKvg6DYFJ+1HLE/z6 jFmzb10lXgg4FKKkUtWruawkErUbb8k1le+rnjZ0Wi9FhSWdM3HL1l6NX0IMWRmC Jm7WvXBHo9KCarcp+MWnKEjP4b/gR0bEvQIDAQABo1AwTjAdBgNVHQ4EFgQUc9Tb 8nwTWl+HI3JbYIQAFL3eZYgwHwYDVR0jBBgwFoAUc9Tb8nwTWl+HI3JbYIQAFL3e ZYgwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAnhmnsmFDcZ7b0YEQ XlIj760EUHe/G1Rtur2fjjP59qz/8msP9QtVAy5O/a22aCBehhOzcK2e3NFIKlBs D5xb7UE8RV0i9btP57+ZF6kP89sMB/DBHI+TDD93cms5OvTDCteKO++CpwnkNmav xRnvQGAAOA+zxVsPlYL1Wy9Z75LQWdZKS68/JTd7b2LOQnYD2qp4omPYEYGAFtFz 38EMgRS/QyQjjiHx6rz/wU5hmQCrNOUUCw+bHumZL3mxJ/aSBNrGVBLQ2Hnofhsw 1Ik2EyzMh3+nlf2ImlSZKfjfg8PrfmgbvXvNc8AWRCad7xwt9ZPzaxj05vKupcwO 2tIkOw== -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/test-bad-root-ca.key000066400000000000000000000032171413423552100223140ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEpgIBAAKCAQEA3DRlR+CK8ZBUfaZB4RzWErQ+lewTPu+FaQuCSBvBMKgd+S0r /mZ0dQsA2/mWymggxb1wIZt/TY9sz2v1pYmg2Cw/dld9AQvJaqMXPdn3ZAmsihYd 3is8M4c0FlFowHv0LyWUOlRJfUrAPc4aorRK4Dqssl+s8W/ikyiKsMKBk0Z1LQBx UzstAAQ3voBJW7SVsRzYgcbyITW2IXYBjsIJRWK68+TCNCqlmVKEKvg6DYFJ+1HL E/z6jFmzb10lXgg4FKKkUtWruawkErUbb8k1le+rnjZ0Wi9FhSWdM3HL1l6NX0IM WRmCJm7WvXBHo9KCarcp+MWnKEjP4b/gR0bEvQIDAQABAoIBAQDPcKSAo60Ah4Cw pXCmSm34TMgwn6Y5wZYiMO9YUp0Z4yXpWH57N7U5lVYH5AYDQzisTxtU7ZFtVVGh zQgqG47kVjqqlxxxYdMqm90HLVB6cwqRQuh8JKqfuBx/cc2Glr6fs30BvelFGKgl EQXShJmMxnltx+e5wjblfmm4vmMmgpf/I3ROVwaPCrB0Zu0zWBqNDk++te7jMqkG uoBQ9Zv/C93gejFUktzKEMkXUAVqKLlwXlKPc2ypzMW15Omu7YcAo+ZWZIDeQ3RU HzH2zJylVp5F/v9nQbHU5G+8RzIwiVewwEyU2z3wve7Z+9UBA2hf0M3q6NfgYDx0 UDgaZzzZAoGBAO/vHy027FpULbfX93KZ9AMBjo2BrnDtOQCdL7qHkyov4Y1O4hH5 aPBdeijZQhzJlyNF+0bB0Qht26YzQx+vfkDMIcolvLAbYLNivRNaxNElpE4eZweD T7qfhRahyrBPoKikzvIIQGScqYCmPar0fQ3CfIi0+a7GDlNQ30JsifHTAoGBAOrz FBBLzAlwS+YiKh/734xWM8l1L/4RVyT8pqW4lNCNP9di8oJj7EEVvXUV4VoA1uNS goyoED8OuKLhlGwE+RXq0hRGxyIJgbU08UwV6zEfAAYg+SiYI7t3oEp1IP9p7vZ9 5LRfQyO1U6fxpub4l+tRdA1zGxVQNQJ7FJAcNMUvAoGBAJ8pDpNdxbe9833q45jA C6Aa3kd8aQ08L/36R3kDClqH3KVyWID34+be+3QxeqvCBmI9wAwV8eYXigdcJgDU 13mAcEG6esqPvrwAmdBG/ByJTc8MV+gh8TepLg3vUZdXmwmEGktvsdeMHNzcajgH axU/mIDPHHoVo9cc5J0ZhwBFAoGBAKpiQ6+ZuEs0A+bN6eyt9S1Jql6zvG0s2By7 mILf/BPOC3lAiYvjuQZuJKoPhxCFQVEzmfc1PirsmxuMKd24MYcidt07gtf9OvJV hZPe5WQHDjZjnS1CP8+I7lZw4NA5W5GoNL5Vw1PXAObvSVGBAHMn69iBHCf1taup 5Hyp598DAoGBAOhN1mSzSeyddtJiidy2ByL5PL/6BygNxXI//vXRZHmBugLWLczI qtzyUBPMXl1AdxusDkRuQgIgmrums/szsVVgzjJcZzSlxoktbHs1JphxgTTTu7Mh Z1KIaFjXkGF+rRat8rkmy6BVi/PpoPHIWNvEdbR5JZ3jzpPfAqVkvrvO -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/test-ca.srl000066400000000000000000000000211413423552100206050ustar00rootroot00000000000000CDAE0E564A2891A9 paho.mqtt.python-1.6.1/test/ssl/test-fake-root-ca.crt000066400000000000000000000025061413423552100224740ustar00rootroot00000000000000-----BEGIN CERTIFICATE----- MIIDuDCCAqCgAwIBAgIUcE+qUkqyZKFChp9j3+SuflCAAwgwDQYJKoZIhvcNAQEL BQAwbTELMAkGA1UEBhMCR0IxEzARBgNVBAgMCkRlcmJ5c2hpcmUxDjAMBgNVBAcM BURlcmJ5MRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNVBAsMB1Rlc3Rpbmcx EDAOBgNVBAMMB1Jvb3QgQ0EwHhcNMjEwNzA3MTExNDQyWhcNMzEwNzA1MTExNDQy WjBtMQswCQYDVQQGEwJHQjETMBEGA1UECAwKRGVyYnlzaGlyZTEOMAwGA1UEBwwF RGVyYnkxFTATBgNVBAoMDFBhaG8gUHJvamVjdDEQMA4GA1UECwwHVGVzdGluZzEQ MA4GA1UEAwwHUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB AJ9Oc5kDGXyzORIRKBNiQ0+p63LN4DUK8ux/PMD7SEuGKq+LIdieCjmExUq2nkIE 052iYCM9aYJa8PuP+8UWl8UKE4/QWW6yWl28/O5n/Hwe28PfiiH1f5kxXt9khMjI oc3WCr8YkiDrrKiFyCGvF58b87woQFRMHHqus+o+Xd9YPKhsc/n/AhV4zl0S2wUC nnV+UF5c+/vlMh/SnD84yhMlySOC7fRNHziAJqqIpj44hQTdfjM6XDHOf3jSlHfv 1JxKqyE8hAWxZVZhMBP1v14xQL5AbVhtSNZlIV/LzAGUbBztMKzPfE4GyQKIDCmi 91A7nbXbkTBz/McL3kxmmAMCAwEAAaNQME4wHQYDVR0OBBYEFDZWdWv057drndtK 9AYPQhTgHkUuMB8GA1UdIwQYMBaAFDZWdWv057drndtK9AYPQhTgHkUuMAwGA1Ud EwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAEuWZu5tSJyNZkzbFT0o/IP8zUgN lbfp9DxqqiOwUTx2ykOpMsXU94f+/HEACYQ773G/lXPDmMrz/j3mPYklhws07/SE q1jKM6ZXJh74nQekypvXtSY/Xd667JpRxU6GAedizi60owKPIUFpxkW70h4Of5j5 Py7PGRGDZ7ItGtuk1fxcSCchfm0Q2bST8nOcD8D+MQcttNxGgelp2V6c0XckmijM oFUy/3Nm1B/qv4QWckmVX+gm+iBTBANItvcj+ie2c6diFwz7htDwOVm7/1Z/73wM YyM5Z27mVKR8FwK3jHHRQa5VWtTOdnqG3kHKmAKeOlXgO91wzCh8zq1Q76o= -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/test-fake-root-ca.key000066400000000000000000000032171413423552100224740ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEAn05zmQMZfLM5EhEoE2JDT6nrcs3gNQry7H88wPtIS4Yqr4sh 2J4KOYTFSraeQgTTnaJgIz1pglrw+4/7xRaXxQoTj9BZbrJaXbz87mf8fB7bw9+K IfV/mTFe32SEyMihzdYKvxiSIOusqIXIIa8XnxvzvChAVEwceq6z6j5d31g8qGxz +f8CFXjOXRLbBQKedX5QXlz7++UyH9KcPzjKEyXJI4Lt9E0fOIAmqoimPjiFBN1+ MzpcMc5/eNKUd+/UnEqrITyEBbFlVmEwE/W/XjFAvkBtWG1I1mUhX8vMAZRsHO0w rM98TgbJAogMKaL3UDudtduRMHP8xwveTGaYAwIDAQABAoIBAG4D1KsHy/MlJjWG 6aExTADY/MOkz8Bx1j9iw0cWgd++QP5H3FDnG3KLcWBeaz52bNnAyBmuEI44VZG0 5o8+QgOOKOI5ZXmf6+4uVJIj9+aTvPsxBgjbrInT4YvutBChFbS7q2I7Crd3ah5b fVFdxLdZq2H2fi54/XXv7knHVjaldxf/mlq3XX1ndAvYXIY3L9PKjeeraEppRgce oZR6nnzliz7mBwIezaWV+DOCpotiJVYefeWsbN1QjKKzObnq1M5w4fv1R4jbT/zh RKIyxL3sa/8Beo3TSl4hFF9xNbQq957QdXKMqbdKdGWO0bQN4Mh4xqrEPo1ZK6qK RLyt5xECgYEAyvrgICVB4q7VFIqMzIznLnrBSg+HtpkLBIh2JjovWEQNh88Qul3t IH9VdOVT+SPeLCjED6vwQzU4bu4TJV2xwnv+Ujty4w8Aw4sSJlxSrMniKkdSxMus yhNgYg8E4WEDHxGtBNTyGc1lC2rvfDorvQAFajj5WJqGXLB9MumgP9sCgYEAyOso nZlfGKSWidUT+Mp0Jq9PG1kmAoBDEoMdCcpvp5p6ttUAb6sLVoY9Q+7U4VVVUIbH udYBvpDklgwJD2Erc6PK81g99bS/0fTuqCMlCGfDrqVTFxtWcYd9H2E3eJfo20YQ lUKgoOudXrlc7/a1TSK4Z0qGnWrygyhYypSwNPkCgYBKMv09IwF7sPd5g9BGcfeM eRkxTo4IxNdPN+cgwEJQXMgpbhsqVW16ZLHDgpV4zJDJybkqFWtF1i2j92mOTjrN 4m+sdcjgkbpwwOTImxUpzr7bP6lVATNPx1eDYQQis0jl0ZtS2dkKb5fRXazf14/n jhtsohkcN5iIR4fs1ZRb4wKBgQCtu1HCfOVS7LbS9jGv1nf7H2na7wpD7V6R+le4 qJhFp/lmcOZQqOlD5w3A2RqwwdXkrLa1RYz6mFVgPYX0C4TEGKScKPhipumbBhz7 vHAARaFaOdCQUW48+vhBkxGhMFIEkSAzwIoeu723M7deM8jvqw8jGbkvE1Qh/1hP y6RWGQKBgQCNfn28PybCmShtMFXnmcbtYOfI9b7ycGqFiKcW3pT5Q/2C4ReAyEVH uZ7xXApAzESao5V1evp2jRYGQAhK00YX/F9CXn8C57K55B5EC5cNu7LVSA81GswF /9VRFpxIWzilLEUGmgA0rUfvgsUyx6ILREhD1Qw8ihWNKMO2gJxVog== -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/test-root-ca.crt000066400000000000000000000025061413423552100215700ustar00rootroot00000000000000-----BEGIN CERTIFICATE----- MIIDuDCCAqCgAwIBAgIUS1Q+E18/+trcKfhT+xz8ghGukmYwDQYJKoZIhvcNAQEL BQAwbTELMAkGA1UEBhMCR0IxEzARBgNVBAgMCkRlcmJ5c2hpcmUxDjAMBgNVBAcM BURlcmJ5MRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNVBAsMB1Rlc3Rpbmcx EDAOBgNVBAMMB1Jvb3QgQ0EwHhcNMjEwNzA3MTExNDQyWhcNMzEwNzA1MTExNDQy WjBtMQswCQYDVQQGEwJHQjETMBEGA1UECAwKRGVyYnlzaGlyZTEOMAwGA1UEBwwF RGVyYnkxFTATBgNVBAoMDFBhaG8gUHJvamVjdDEQMA4GA1UECwwHVGVzdGluZzEQ MA4GA1UEAwwHUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB AKpCq45dCrroNa+y3zgdBglQOtw4og3MD/3Rn6ZftyL0dv1rSMkCFU8lCtZ4bIpz iNSJKau79owCudX3qQTPfiX2pmR5uuYjvMzRiZohZtz5uqXByy/CMS8dPRI3po6i kfNx9n7EQqOlxdwkY1kae2j5ybkAld2MNci93BH4P8qqaQckVRKpv6cKq33KsXK7 jHgjAYMGrihTAwxgP1JX9NS8yxxjMUYvFqeEOLARoeWc6Nl7oDbGLs2fr0j2Yssm cz0AMu7LWcbhnfs2S8Troksztnq38yHu+YTs6hX4NhANBgon5CAdyzmmE/b2OwOX p8rQepUfG7wO5QaS0OrAEXsCAwEAAaNQME4wHQYDVR0OBBYEFBOgth/1x2TC+f0u CPIZAXdUGXN/MB8GA1UdIwQYMBaAFBOgth/1x2TC+f0uCPIZAXdUGXN/MAwGA1Ud EwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHgE1oMwIcilQFN4xPYCf8jbsa5o zA5ljTbxv7fU3Zd+7KdlDFYroGjgHb7o3r0//b8+ZarxBqn1274u4KPs39Ow7h6m YJo7IM2Z2fC6IWZroqeidfFx5SwejAP1j7coYLblTIbNF+P08sJG5nSQ+Yx0gams 6C1x0mETaaglDwllU1KXHTm8fUpEwpISc/VfKABYgScODMpdsDghyHANvnFjmvp4 ktABnasliZYTmdl0t3szNm7zIk+bntiK4KunFea8GqgslWqGPwtNxxJFHzPjMCxK EHgubLgp1lNZzH13XSO6ZpiNRDJ6IVed3Zq+yn+24uKH+1Hqp6Bt20ZFB4E= -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/test-root-ca.key000066400000000000000000000032131413423552100215640ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAqkKrjl0Kuug1r7LfOB0GCVA63DiiDcwP/dGfpl+3IvR2/WtI yQIVTyUK1nhsinOI1Ikpq7v2jAK51fepBM9+JfamZHm65iO8zNGJmiFm3Pm6pcHL L8IxLx09EjemjqKR83H2fsRCo6XF3CRjWRp7aPnJuQCV3Yw1yL3cEfg/yqppByRV Eqm/pwqrfcqxcruMeCMBgwauKFMDDGA/Ulf01LzLHGMxRi8Wp4Q4sBGh5Zzo2Xug NsYuzZ+vSPZiyyZzPQAy7stZxuGd+zZLxOuiSzO2erfzIe75hOzqFfg2EA0GCifk IB3LOaYT9vY7A5enytB6lR8bvA7lBpLQ6sARewIDAQABAoIBACAK+BqM7C4M8b2l XllDLRWnocw8ZFNQaloMj41SSjcr5xD+le4ulDAW+pkuhM7xu3i0b8FAWMA06yCX wZmEK2udpecW+dPCOhAaB1mYm7FO1o/HjyPn2jXRvOKm0pPZiLpWYlutOBVwZ3Js 7r2gPEWfbRWCRLIzZxPml3pSTD8p0IMGC4gO0jKHmGyLFQN0TOCdivVOzbQeDpUU lpj/v2wCfQQpfc/jP2bwTlGAZWVgmUtoj5XcWtRSLtwcWtK5KKgyQKlDdDL7d/Et J3x+QDLIwu9JNfaW8lcie16Y6qE4yOuBl95wfOpxN3wcmfxrKh7/rtN0Df1JNxvh 4bkyrGECgYEA2Lc36y+S9fOEecTwQd+AozIrBVhfaDU3L/tuKqKRJAhjI37DHkZ3 4tRYqd85bAcd+FED9cEK7Fqb51XovHTYQx0j3y++Iq6u+gzGWgSX2JGlprOkiNMk oXMX9P48KDBtCzD2aPxAslmrkhIPKEKmW+OTqpqHG6TsCshUoF1GQYMCgYEAyR+t A68mrnEcR3iapGhnnKqAEVx4zRdaXhBXFZvC0mF15xKtMTtjCEaT2X+iOiZE2fNn Si++pi/UGgLYChD7YsgWQlJUyrMVUHBYROfZ+sUIm9XvESVNQFLSSkr+vMH03hM3 I7d4Z3pbMEwDzAnv37i1HZ91Tvm4nfIsePenRqkCgYAdWdMs+yiAPxb2FwIjKc4W TDkfZDSnvG1ZBkiJZbMamjgzGnv6obii8/d+KklwpBYfB3nt0tNT54Gt9yiqPXj8 vfmZxLGPqPDx1MEYd/7IyhERXsst7MrNQvU/rR8gok5icaMt3Nw2S4a9Jcz/uucl EtFxDbS2vcNqQm+TuI5HWQKBgQC1xLj7IWsWMQfb2DX67Jjn0HhaOHa89KQpax8p WlKjDI4gPpLkccW5DwBEi8O0Ri3nxMHPHINzcrqAn51cy6hGyIrFed9EKsHSpxY/ gENTDowPOzQLDOlafv+rQUgklC6YHkmxL/nTm5OafLjZyQlP6oFVum2s6KhfpyVm VnyJsQKBgBk2hykG1EZmkLDKbrCXU7ggTvA9/FhEAjOt5PtQBjdKWTInuoizWX3n /C8ZYig7pYNytsb2um4CrF1Divgqz2ZceTWxfEF5IKqjqfhwMkBZ/uGz27t/BFaF pE5RD8iBhG+1inxV2UVz0gzBCNGciDxKb+ZPW087yE6NphLRydHv -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/test/ssl/test-signing-ca.crt000066400000000000000000000104121413423552100222360ustar00rootroot00000000000000Certificate: Data: Version: 3 (0x2) Serial Number: 1 (0x1) Signature Algorithm: sha256WithRSAEncryption Issuer: C=GB, ST=Derbyshire, L=Derby, O=Paho Project, OU=Testing, CN=Root CA Validity Not Before: Jul 7 11:14:42 2021 GMT Not After : Jul 6 11:14:42 2026 GMT Subject: C=GB, ST=Derbyshire, O=Paho Project, OU=Testing, CN=Signing CA Subject Public Key Info: Public Key Algorithm: rsaEncryption RSA Public-Key: (2048 bit) Modulus: 00:cb:32:6c:8c:48:e8:44:58:36:18:70:36:42:3d: 2d:29:47:3c:69:12:9e:7b:f7:45:62:ef:91:44:46: 97:a0:ea:5f:da:fd:9f:98:d4:bf:43:02:e3:39:90: 33:7b:13:13:d5:31:30:9c:07:fc:ca:1b:a9:e4:89: 42:e5:d0:6e:f4:a2:e0:23:ee:9d:9a:cc:80:3b:78: bf:7e:27:a8:46:1b:28:9f:4a:64:53:7a:89:3e:ab: 65:6f:af:0b:29:fa:4d:4f:04:f1:1e:10:2c:bf:2b: ea:fc:c5:fa:77:c9:1a:7a:78:29:f5:a2:cb:25:7c: 02:bb:91:8d:76:4d:23:bc:9c:19:da:be:c5:20:04: ad:fe:bd:b9:d4:bb:29:2a:c3:e4:fc:4c:84:db:a3: 55:9f:f0:70:7f:40:38:b5:c3:78:a5:db:06:36:b7: 10:8e:ca:6c:1a:92:66:be:0e:1a:97:59:6b:18:f4: c2:b8:c9:31:7b:d1:b1:a1:00:78:7f:c0:09:f6:ef: b2:8f:94:87:5d:b1:a2:23:93:4d:ec:fa:95:09:a9: 90:c4:02:f0:1e:d9:ab:a2:8b:7f:7f:54:95:e7:da: c3:c9:7d:a7:d7:04:89:59:db:88:9d:57:16:5d:b9: 66:b0:d6:88:bb:e0:ee:43:e9:ab:02:78:fc:bd:e8: 98:d9 Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Subject Key Identifier: C2:8F:09:9B:D5:F1:BA:C4:74:5E:97:50:BB:86:9D:A1:F1:FA:C4:36 X509v3 Authority Key Identifier: keyid:13:A0:B6:1F:F5:C7:64:C2:F9:FD:2E:08:F2:19:01:77:54:19:73:7F X509v3 Basic Constraints: CA:TRUE Signature Algorithm: sha256WithRSAEncryption 3e:70:76:69:37:e4:6e:e0:08:c6:8e:5b:2e:aa:26:fe:e9:ed: ac:02:ce:2c:37:08:6a:8a:c3:0d:c0:ef:43:51:01:2e:e0:96: 76:23:1b:1f:75:98:df:7c:d1:b7:c1:67:aa:62:c1:bd:ef:84: eb:d9:28:47:50:f2:1b:54:7f:ed:cb:52:f7:fc:c3:f8:62:22: 0c:b3:95:ed:bb:3f:74:91:bc:d2:eb:c0:81:7d:74:12:85:61: a3:7e:fb:22:4a:25:99:0b:5d:ef:69:f2:5a:e6:d5:12:a3:95: 38:30:0c:c7:d9:da:28:30:10:b4:3d:3e:ad:20:85:31:e0:bf: 30:33:2e:0b:e3:07:3d:ed:22:dc:67:f8:93:64:89:ed:e7:08: 74:b5:0a:7a:01:3d:f9:44:62:71:cf:60:12:92:c3:95:9a:e5: a5:f2:24:6a:22:64:d5:76:22:c9:03:1c:c5:d1:a5:85:4d:55: f9:80:47:ca:12:20:df:05:fb:82:12:45:6f:e8:c0:20:a8:ae: f7:17:c5:c3:b6:9c:51:bd:d8:84:e4:db:c7:03:44:d2:cb:75: 51:79:3f:86:33:3c:e4:34:1d:77:b2:60:24:5c:21:c5:c3:53: 36:08:2f:a7:14:0b:68:78:67:95:90:b9:06:0e:85:04:65:57: b4:34:31:cf -----BEGIN CERTIFICATE----- MIIDmDCCAoCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBtMQswCQYDVQQGEwJHQjET MBEGA1UECAwKRGVyYnlzaGlyZTEOMAwGA1UEBwwFRGVyYnkxFTATBgNVBAoMDFBh aG8gUHJvamVjdDEQMA4GA1UECwwHVGVzdGluZzEQMA4GA1UEAwwHUm9vdCBDQTAe Fw0yMTA3MDcxMTE0NDJaFw0yNjA3MDYxMTE0NDJaMGAxCzAJBgNVBAYTAkdCMRMw EQYDVQQIDApEZXJieXNoaXJlMRUwEwYDVQQKDAxQYWhvIFByb2plY3QxEDAOBgNV BAsMB1Rlc3RpbmcxEzARBgNVBAMMClNpZ25pbmcgQ0EwggEiMA0GCSqGSIb3DQEB AQUAA4IBDwAwggEKAoIBAQDLMmyMSOhEWDYYcDZCPS0pRzxpEp5790Vi75FERpeg 6l/a/Z+Y1L9DAuM5kDN7ExPVMTCcB/zKG6nkiULl0G70ouAj7p2azIA7eL9+J6hG GyifSmRTeok+q2Vvrwsp+k1PBPEeECy/K+r8xfp3yRp6eCn1osslfAK7kY12TSO8 nBnavsUgBK3+vbnUuykqw+T8TITbo1Wf8HB/QDi1w3il2wY2txCOymwakma+DhqX WWsY9MK4yTF70bGhAHh/wAn277KPlIddsaIjk03s+pUJqZDEAvAe2auii39/VJXn 2sPJfafXBIlZ24idVxZduWaw1oi74O5D6asCePy96JjZAgMBAAGjUDBOMB0GA1Ud DgQWBBTCjwmb1fG6xHRel1C7hp2h8frENjAfBgNVHSMEGDAWgBQToLYf9cdkwvn9 LgjyGQF3VBlzfzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA+cHZp N+Ru4AjGjlsuqib+6e2sAs4sNwhqisMNwO9DUQEu4JZ2IxsfdZjffNG3wWeqYsG9 74Tr2ShHUPIbVH/ty1L3/MP4YiIMs5Xtuz90kbzS68CBfXQShWGjfvsiSiWZC13v afJa5tUSo5U4MAzH2dooMBC0PT6tIIUx4L8wMy4L4wc97SLcZ/iTZInt5wh0tQp6 AT35RGJxz2ASksOVmuWl8iRqImTVdiLJAxzF0aWFTVX5gEfKEiDfBfuCEkVv6MAg qK73F8XDtpxRvdiE5NvHA0TSy3VReT+GMzzkNB13smAkXCHFw1M2CC+nFAtoeGeV kLkGDoUEZVe0NDHP -----END CERTIFICATE----- paho.mqtt.python-1.6.1/test/ssl/test-signing-ca.key000066400000000000000000000032171413423552100222430ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIIEpgIBAAKCAQEAyzJsjEjoRFg2GHA2Qj0tKUc8aRKee/dFYu+RREaXoOpf2v2f mNS/QwLjOZAzexMT1TEwnAf8yhup5IlC5dBu9KLgI+6dmsyAO3i/fieoRhson0pk U3qJPqtlb68LKfpNTwTxHhAsvyvq/MX6d8kaengp9aLLJXwCu5GNdk0jvJwZ2r7F IASt/r251LspKsPk/EyE26NVn/Bwf0A4tcN4pdsGNrcQjspsGpJmvg4al1lrGPTC uMkxe9GxoQB4f8AJ9u+yj5SHXbGiI5NN7PqVCamQxALwHtmroot/f1SV59rDyX2n 1wSJWduInVcWXblmsNaIu+DuQ+mrAnj8veiY2QIDAQABAoIBAQCh3tl6J9pgF6WA cmPHANUpPQZy7dIzDxjHZ/FhYpsIJa2W1tR8+34h8/rvsGBSezAhdb4zjmli2AbP eElCqni5icbk2QHUf3Tn65kg9pamwpvpyWmC1ureccus3NUX674KZPVv7ZK3+FSK aWzOX/Yn+fHzLGyIv/GtWpZG18zQQl0+i2sKqKYQu00qBBLp+t9GJYpqPx9qpumB JzWaVuMEwkTJ4J6j7d28V8r8fnrURIcb/3R6dZsB6QtjgnJNzJRwFpaDDKoH3ZNV IkMqRNGuzuuzhL5Rzd2nd8oRUvgUAl93ad/fxWfmVVSyVbh/LCkOBDwSC6Z2Ri4c BafNAoMBAoGBAP0E9y121/lMkiLh0KF3suwbSJ/Z/GFO9ZhP5wW2vibcrQppF6vz kdYyEmjyPH+3UoKZOYzAwkTDJFJaosaagmiPuIzsGeF20A7D7ZQ1Ru5ScxVo/XWK i2g4s4wqlEZ9vhlcg/QBOUfzi23lUyGAXuQlgORQtzbN/vzGSRkIivWNAoGBAM2X NU32Hw0RuOXtaw4aZyY4oFT2nyPP99fAzR+IGX7XMny5bt2kBnHExpC43VZevFHc qzQdot4DbOUi/kO+LOiUHcYIW2/nADJjsxnDlnxU+9L6cMv74rQgskjNgjS0l+bx /W6/QFoOOJeVDT1VXhQbjIL3PxffdKmEWPs7ZT99AoGBAKZ6SuymIorMv+alr/Fd 4eMKPKm48x9Ppba29CnFSK4nSs/rwACKva0yuvxETlw2UdrOWJhtCCXYRCDPtAR7 C00jK2nFu22nEFR2w+5dc7NBmqk+sG5TX1CO5kxWg8Mx3w+u2L+Gwpq9+0Kuvhjv 7v+sUXdoSHSN67WD/fqzrULNAoGBAKv+Qvbc329Ek0Wv0K70wbSFDQTnaY1BT9us jS5C4ultSOx1CV3c+hM1htTOA0VdbfiiPowT+wv3G6O6GbM8pz9PonToyu4b99sv 80arjPqo8h+3qqPMLwV4kQ489x/2sVngup9q2oA8g3W0mWXlRBZYUb3C8IKdS3EB qptLPlHVAoGBAMgetjin8PFljR6Wt/GF5Y84MtonxH0oyJ7F1nw4NfmxqZxPwSXG L1/Adc3qTyOTM+JhWL+mSqiF+go2RpEHB04kItFWgShGb6k84T7Hdq+Qrw6yZGR1 wX7UpLwK2mrdIkzEVRMw2+7Uvi9nAn1rVxmlCFNamPxhC4ky0TBIboKl -----END RSA PRIVATE KEY----- paho.mqtt.python-1.6.1/tests/000077500000000000000000000000001413423552100161145ustar00rootroot00000000000000paho.mqtt.python-1.6.1/tests/test_client.py000066400000000000000000000264211413423552100210100ustar00rootroot00000000000000import inspect import os import sys import time import unicodedata import pytest import paho.mqtt.client as client # From http://stackoverflow.com/questions/279237/python-import-a-module-from-a-folder cmd_subfolder = os.path.realpath( os.path.abspath( os.path.join( os.path.split( inspect.getfile(inspect.currentframe()))[0], '..', 'test'))) if cmd_subfolder not in sys.path: sys.path.insert(0, cmd_subfolder) import paho_test # Import test fixture from testsupport.broker import fake_broker @pytest.mark.parametrize("proto_ver", [ (client.MQTTv31), (client.MQTTv311), ]) class Test_connect(object): """ Tests on connect/disconnect behaviour of the client """ def test_01_con_discon_success(self, proto_ver, fake_broker): mqttc = client.Client( "01-con-discon-success", protocol=proto_ver) def on_connect(mqttc, obj, flags, rc): assert rc == 0 mqttc.disconnect() mqttc.on_connect = on_connect mqttc.connect_async("localhost", 1888) mqttc.loop_start() try: fake_broker.start() connect_packet = paho_test.gen_connect( "01-con-discon-success", keepalive=60, proto_ver=proto_ver) packet_in = fake_broker.receive_packet(1000) assert packet_in # Check connection was not closed assert packet_in == connect_packet connack_packet = paho_test.gen_connack(rc=0) count = fake_broker.send_packet(connack_packet) assert count # Check connection was not closed assert count == len(connack_packet) disconnect_packet = paho_test.gen_disconnect() packet_in = fake_broker.receive_packet(1000) assert packet_in # Check connection was not closed assert packet_in == disconnect_packet finally: mqttc.loop_stop() packet_in = fake_broker.receive_packet(1) assert not packet_in # Check connection is closed def test_01_con_failure_rc(self, proto_ver, fake_broker): mqttc = client.Client( "01-con-failure-rc", protocol=proto_ver) def on_connect(mqttc, obj, flags, rc): assert rc == 1 mqttc.on_connect = on_connect mqttc.connect_async("localhost", 1888) mqttc.loop_start() try: fake_broker.start() connect_packet = paho_test.gen_connect( "01-con-failure-rc", keepalive=60, proto_ver=proto_ver) packet_in = fake_broker.receive_packet(1000) assert packet_in # Check connection was not closed assert packet_in == connect_packet connack_packet = paho_test.gen_connack(rc=1) count = fake_broker.send_packet(connack_packet) assert count # Check connection was not closed assert count == len(connack_packet) packet_in = fake_broker.receive_packet(1) assert not packet_in # Check connection is closed finally: mqttc.loop_stop() class TestPublishBroker2Client(object): def test_invalid_utf8_topic(self, fake_broker): mqttc = client.Client("client-id") def on_message(client, userdata, msg): with pytest.raises(UnicodeDecodeError): msg.topic client.disconnect() mqttc.on_message = on_message mqttc.connect_async("localhost", 1888) mqttc.loop_start() try: fake_broker.start() connect_packet = paho_test.gen_connect("client-id") packet_in = fake_broker.receive_packet(len(connect_packet)) assert packet_in # Check connection was not closed assert packet_in == connect_packet connack_packet = paho_test.gen_connack(rc=0) count = fake_broker.send_packet(connack_packet) assert count # Check connection was not closed assert count == len(connack_packet) publish_packet = paho_test.gen_publish(b"\xff", qos=0) count = fake_broker.send_packet(publish_packet) assert count # Check connection was not closed assert count == len(publish_packet) disconnect_packet = paho_test.gen_disconnect() packet_in = fake_broker.receive_packet(len(disconnect_packet)) assert packet_in # Check connection was not closed assert packet_in == disconnect_packet finally: mqttc.loop_stop() packet_in = fake_broker.receive_packet(1) assert not packet_in # Check connection is closed def test_valid_utf8_topic_recv(self, fake_broker): mqttc = client.Client("client-id") # It should be non-ascii multi-bytes character topic = unicodedata.lookup('SNOWMAN') def on_message(client, userdata, msg): assert msg.topic == topic client.disconnect() mqttc.on_message = on_message mqttc.connect_async("localhost", 1888) mqttc.loop_start() try: fake_broker.start() connect_packet = paho_test.gen_connect("client-id") packet_in = fake_broker.receive_packet(len(connect_packet)) assert packet_in # Check connection was not closed assert packet_in == connect_packet connack_packet = paho_test.gen_connack(rc=0) count = fake_broker.send_packet(connack_packet) assert count # Check connection was not closed assert count == len(connack_packet) publish_packet = paho_test.gen_publish( topic.encode('utf-8'), qos=0 ) count = fake_broker.send_packet(publish_packet) assert count # Check connection was not closed assert count == len(publish_packet) disconnect_packet = paho_test.gen_disconnect() packet_in = fake_broker.receive_packet(len(disconnect_packet)) assert packet_in # Check connection was not closed assert packet_in == disconnect_packet finally: mqttc.loop_stop() packet_in = fake_broker.receive_packet(1) assert not packet_in # Check connection is closed def test_valid_utf8_topic_publish(self, fake_broker): mqttc = client.Client("client-id") # It should be non-ascii multi-bytes character topic = unicodedata.lookup('SNOWMAN') mqttc.connect_async("localhost", 1888) mqttc.loop_start() try: fake_broker.start() connect_packet = paho_test.gen_connect("client-id") packet_in = fake_broker.receive_packet(len(connect_packet)) assert packet_in # Check connection was not closed assert packet_in == connect_packet connack_packet = paho_test.gen_connack(rc=0) count = fake_broker.send_packet(connack_packet) assert count # Check connection was not closed assert count == len(connack_packet) mqttc.publish(topic, None, 0) # Small sleep needed to avoid connection reset. time.sleep(0.3) publish_packet = paho_test.gen_publish( topic.encode('utf-8'), qos=0 ) packet_in = fake_broker.receive_packet(len(publish_packet)) assert packet_in # Check connection was not closed assert packet_in == publish_packet mqttc.disconnect() disconnect_packet = paho_test.gen_disconnect() packet_in = fake_broker.receive_packet(len(disconnect_packet)) assert packet_in # Check connection was not closed assert packet_in == disconnect_packet finally: mqttc.loop_stop() packet_in = fake_broker.receive_packet(1) assert not packet_in # Check connection is closed def test_message_callback(self, fake_broker): mqttc = client.Client("client-id") userdata = { 'on_message': 0, 'callback1': 0, 'callback2': 0, } mqttc.user_data_set(userdata) def on_message(client, userdata, msg): assert msg.topic == 'topic/value' userdata['on_message'] += 1 def callback1(client, userdata, msg): assert msg.topic == 'topic/callback/1' userdata['callback1'] += 1 def callback2(client, userdata, msg): assert msg.topic in ('topic/callback/3', 'topic/callback/1') userdata['callback2'] += 1 mqttc.on_message = on_message mqttc.message_callback_add('topic/callback/1', callback1) mqttc.message_callback_add('topic/callback/+', callback2) mqttc.connect_async("localhost", 1888) mqttc.loop_start() try: fake_broker.start() connect_packet = paho_test.gen_connect("client-id") packet_in = fake_broker.receive_packet(len(connect_packet)) assert packet_in # Check connection was not closed assert packet_in == connect_packet connack_packet = paho_test.gen_connack(rc=0) count = fake_broker.send_packet(connack_packet) assert count # Check connection was not closed assert count == len(connack_packet) publish_packet = paho_test.gen_publish(b"topic/value", qos=1, mid=1) count = fake_broker.send_packet(publish_packet) assert count # Check connection was not closed assert count == len(publish_packet) publish_packet = paho_test.gen_publish(b"topic/callback/1", qos=1, mid=2) count = fake_broker.send_packet(publish_packet) assert count # Check connection was not closed assert count == len(publish_packet) publish_packet = paho_test.gen_publish(b"topic/callback/3", qos=1, mid=3) count = fake_broker.send_packet(publish_packet) assert count # Check connection was not closed assert count == len(publish_packet) puback_packet = paho_test.gen_puback(mid=1) packet_in = fake_broker.receive_packet(len(puback_packet)) assert packet_in # Check connection was not closed assert packet_in == puback_packet puback_packet = paho_test.gen_puback(mid=2) packet_in = fake_broker.receive_packet(len(puback_packet)) assert packet_in # Check connection was not closed assert packet_in == puback_packet puback_packet = paho_test.gen_puback(mid=3) packet_in = fake_broker.receive_packet(len(puback_packet)) assert packet_in # Check connection was not closed assert packet_in == puback_packet mqttc.disconnect() disconnect_packet = paho_test.gen_disconnect() packet_in = fake_broker.receive_packet(len(disconnect_packet)) assert packet_in # Check connection was not closed assert packet_in == disconnect_packet finally: mqttc.loop_stop() packet_in = fake_broker.receive_packet(1) assert not packet_in # Check connection is closed assert userdata['on_message'] == 1 assert userdata['callback1'] == 1 assert userdata['callback2'] == 2 paho.mqtt.python-1.6.1/tests/test_matcher.py000066400000000000000000000017561413423552100211610ustar00rootroot00000000000000import pytest import paho.mqtt.client as client class Test_client_function(object): """ Tests on topic_matches_sub function in the client module """ @pytest.mark.parametrize("sub,topic", [ ("foo/bar", "foo/bar"), ("foo/+", "foo/bar"), ("foo/+/baz", "foo/bar/baz"), ("foo/+/#", "foo/bar/baz"), ("A/B/+/#", "A/B/B/C"), ("#", "foo/bar/baz"), ("#", "/foo/bar"), ("/#", "/foo/bar"), ("$SYS/bar", "$SYS/bar"), ]) def test_matching(self, sub, topic): assert client.topic_matches_sub(sub, topic) @pytest.mark.parametrize("sub,topic", [ ("test/6/#", "test/3"), ("foo/bar", "foo"), ("foo/+", "foo/bar/baz"), ("foo/+/baz", "foo/bar/bar"), ("foo/+/#", "fo2/bar/baz"), ("/#", "foo/bar"), ("#", "$SYS/bar"), ("$BOB/bar", "$SYS/bar"), ]) def test_not_matching(self, sub, topic): assert not client.topic_matches_sub(sub, topic) paho.mqtt.python-1.6.1/tests/test_mqttv5.py000066400000000000000000001601611413423552100207720ustar00rootroot00000000000000""" ******************************************************************* Copyright (c) 2013, 2019 IBM Corp. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 and Eclipse Distribution License v1.0 which accompany this distribution. The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License is available at http://www.eclipse.org/org/documents/edl-v10.php. Contributors: Ian Craggs - initial implementation and/or documentation ******************************************************************* """ import getopt import logging import sys import threading import time import traceback import unittest import paho.mqtt import paho.mqtt.client from paho.mqtt.packettypes import PacketTypes from paho.mqtt.properties import Properties from paho.mqtt.reasoncodes import ReasonCodes from paho.mqtt.subscribeoptions import SubscribeOptions class Callbacks: def __init__(self): self.messages = [] self.publisheds = [] self.subscribeds = [] self.unsubscribeds = [] self.disconnecteds = [] self.connecteds = [] self.conn_failures = [] def __str__(self): return str(self.messages) + str(self.messagedicts) + str(self.publisheds) + \ str(self.subscribeds) + \ str(self.unsubscribeds) + str(self.disconnects) def clear(self): self.__init__() def on_connect(self, client, userdata, flags, reasonCode, properties): self.connecteds.append({"userdata": userdata, "flags": flags, "reasonCode": reasonCode, "properties": properties}) def on_connect_fail(self, client, userdata): self.conn_failures.append({"userdata": userdata}) def wait(self, alist, timeout=2): interval = 0.2 total = 0 while len(alist) == 0 and total < timeout: time.sleep(interval) total += interval return alist.pop(0) # if len(alist) > 0 else None def wait_connect_fail(self): return self.wait(self.conn_failures, timeout=10) def wait_connected(self): return self.wait(self.connecteds) def on_disconnect(self, client, userdata, reasonCode, properties=None): self.disconnecteds.append( {"reasonCode": reasonCode, "properties": properties}) def wait_disconnected(self): return self.wait(self.disconnecteds) def on_message(self, client, userdata, message): self.messages.append({"userdata": userdata, "message": message}) def published(self, client, userdata, msgid): self.publisheds.append(msgid) def wait_published(self): return self.wait(self.publisheds) def on_subscribe(self, client, userdata, mid, reasonCodes, properties): self.subscribeds.append({"mid": mid, "userdata": userdata, "properties": properties, "reasonCodes": reasonCodes}) def wait_subscribed(self): return self.wait(self.subscribeds) def unsubscribed(self, client, userdata, mid, properties, reasonCodes): self.unsubscribeds.append({"mid": mid, "userdata": userdata, "properties": properties, "reasonCodes": reasonCodes}) def wait_unsubscribed(self): return self.wait(self.unsubscribeds) def on_log(self, client, userdata, level, buf): print(buf) def register(self, client): client.on_connect = self.on_connect client.on_subscribe = self.on_subscribe client.on_publish = self.published client.on_unsubscribe = self.unsubscribed client.on_message = self.on_message client.on_disconnect = self.on_disconnect client.on_connect_fail = self.on_connect_fail client.on_log = self.on_log def cleanRetained(port): callback = Callbacks() curclient = paho.mqtt.client.Client("clean retained".encode("utf-8"), protocol=paho.mqtt.client.MQTTv5) curclient.loop_start() callback.register(curclient) curclient.connect(host="localhost", port=port) response = callback.wait_connected() curclient.subscribe("#", options=SubscribeOptions(qos=0)) response = callback.wait_subscribed() # wait for retained messages to arrive time.sleep(1) for message in callback.messages: logging.info("deleting retained message for topic", message["message"]) curclient.publish(message["message"].topic, b"", 0, retain=True) curclient.disconnect() curclient.loop_stop() time.sleep(.1) def cleanup(port): # clean all client state print("clean up starting") clientids = ("aclient", "bclient") for clientid in clientids: curclient = paho.mqtt.client.Client(clientid.encode( "utf-8"), protocol=paho.mqtt.client.MQTTv5) curclient.loop_start() curclient.connect(host="localhost", port=port, clean_start=True) time.sleep(.1) curclient.disconnect() time.sleep(.1) curclient.loop_stop() # clean retained messages cleanRetained(port) print("clean up finished") class Test(unittest.TestCase): @classmethod def setUpClass(cls): global callback, callback2, aclient, bclient sys.path.append("paho.mqtt.testing/interoperability/") try: import mqtt.brokers except ImportError: raise unittest.SkipTest("paho.mqtt.testing not present.") cls._test_broker = threading.Thread( target=mqtt.brokers.run, kwargs={ "config": ["listener 0"], }, ) cls._test_broker.daemon = True cls._test_broker.start() # Wait a bit for TCP server to bind to an address time.sleep(0.5) # Hack to find the port used by the test broker... cls._test_broker_port = mqtt.brokers.listeners.TCPListeners.server.socket.getsockname()[1] setData() cleanup(cls._test_broker_port) callback = Callbacks() callback2 = Callbacks() #aclient = mqtt_client.Client(b"\xEF\xBB\xBF" + "myclientid".encode("utf-8")) #aclient = mqtt_client.Client("myclientid".encode("utf-8")) aclient = paho.mqtt.client.Client("aclient".encode( "utf-8"), protocol=paho.mqtt.client.MQTTv5) callback.register(aclient) bclient = paho.mqtt.client.Client("bclient".encode( "utf-8"), protocol=paho.mqtt.client.MQTTv5) callback2.register(bclient) @classmethod def tearDownClass(cls): # Another hack to stop the test broker... we rely on fact that it use a sockserver.TCPServer import mqtt.brokers mqtt.brokers.listeners.TCPListeners.server.shutdown() cls._test_broker.join(5) def waitfor(self, queue, depth, limit): total = 0 while len(queue) < depth and total < limit: interval = .5 total += interval time.sleep(interval) def test_basic(self): aclient.connect(host="localhost", port=self._test_broker_port) aclient.loop_start() response = callback.wait_connected() self.assertEqual(response["reasonCode"].getName(), "Success") aclient.subscribe(topics[0], options=SubscribeOptions(qos=2)) response = callback.wait_subscribed() self.assertEqual(response["reasonCodes"][0].getName(), "Granted QoS 2") aclient.publish(topics[0], b"qos 0") aclient.publish(topics[0], b"qos 1", 1) aclient.publish(topics[0], b"qos 2", 2) i = 0 while len(callback.messages) < 3 and i < 10: time.sleep(.2) i += 1 self.assertEqual(len(callback.messages), 3) aclient.disconnect() callback.clear() aclient.loop_stop() def test_connect_fail(self): clientid = "connection failure" fclient, fcallback = self.new_client(clientid) fclient.user_data_set(1) fclient.connect_async("localhost", 1) response = fcallback.wait_connect_fail() self.assertEqual(response["userdata"], 1) fclient.loop_stop() def test_retained_message(self): qos0topic = "fromb/qos 0" qos1topic = "fromb/qos 1" qos2topic = "fromb/qos2" wildcardtopic = "fromb/+" publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.UserProperty = ("a", "2") publish_properties.UserProperty = ("c", "3") # retained messages callback.clear() aclient.connect(host="localhost", port=self._test_broker_port) aclient.loop_start() response = callback.wait_connected() aclient.publish(topics[1], b"qos 0", 0, retain=True, properties=publish_properties) aclient.publish(topics[2], b"qos 1", 1, retain=True, properties=publish_properties) aclient.publish(topics[3], b"qos 2", 2, retain=True, properties=publish_properties) # wait until those messages are published time.sleep(1) aclient.subscribe(wildtopics[5], options=SubscribeOptions(qos=2)) response = callback.wait_subscribed() self.assertEqual(response["reasonCodes"][0].getName(), "Granted QoS 2") time.sleep(1) aclient.disconnect() aclient.loop_stop() self.assertEqual(len(callback.messages), 3) userprops = callback.messages[0]["message"].properties.UserProperty self.assertTrue(userprops in [[("a", "2"), ("c", "3")], [ ("c", "3"), ("a", "2")]], userprops) userprops = callback.messages[1]["message"].properties.UserProperty self.assertTrue(userprops in [[("a", "2"), ("c", "3")], [ ("c", "3"), ("a", "2")]], userprops) userprops = callback.messages[2]["message"].properties.UserProperty self.assertTrue(userprops in [[("a", "2"), ("c", "3")], [ ("c", "3"), ("a", "2")]], userprops) qoss = [callback.messages[i]["message"].qos for i in range(3)] self.assertTrue(1 in qoss and 2 in qoss and 0 in qoss, qoss) cleanRetained(self._test_broker_port) def test_will_message(self): # will messages and keep alive callback.clear() callback2.clear() self.assertEqual(len(callback2.messages), 0, callback2.messages) will_properties = Properties(PacketTypes.WILLMESSAGE) will_properties.WillDelayInterval = 0 # this is the default anyway will_properties.UserProperty = ("a", "2") will_properties.UserProperty = ("c", "3") aclient.will_set(topics[2], payload=b"will message", properties=will_properties) aclient.connect(host="localhost", port=self._test_broker_port, keepalive=2) aclient.loop_start() response = callback.wait_connected() bclient.connect(host="localhost", port=self._test_broker_port) bclient.loop_start() response = callback2.wait_connected() bclient.subscribe(topics[2], qos=2) response = callback2.wait_subscribed() self.assertEqual(response["reasonCodes"][0].getName(), "Granted QoS 2") # keep alive timeout ought to be triggered so the will message is received aclient.loop_stop() # so that pings aren't sent self.waitfor(callback2.messages, 1, 10) bclient.disconnect() bclient.loop_stop() # should have the will message self.assertEqual(len(callback2.messages), 1, callback2.messages) props = callback2.messages[0]["message"].properties self.assertEqual(props.UserProperty, [("a", "2"), ("c", "3")]) def test_zero_length_clientid(self): logging.info("Zero length clientid test starting") callback0 = Callbacks() client0 = paho.mqtt.client.Client(protocol=paho.mqtt.client.MQTTv5) callback0.register(client0) client0.loop_start() # should not be rejected client0.connect(host="localhost", port=self._test_broker_port, clean_start=False) response = callback0.wait_connected() self.assertEqual(response["reasonCode"].getName(), "Success") self.assertTrue( len(response["properties"].AssignedClientIdentifier) > 0) client0.disconnect() client0.loop_stop() client0 = paho.mqtt.client.Client(protocol=paho.mqtt.client.MQTTv5) callback0.register(client0) client0.loop_start() client0.connect(host="localhost", port=self._test_broker_port) # should work response = callback0.wait_connected() self.assertEqual(response["reasonCode"].getName(), "Success") self.assertTrue( len(response["properties"].AssignedClientIdentifier) > 0) client0.disconnect() client0.loop_stop() # when we supply a client id, we should not get one assigned client0 = paho.mqtt.client.Client( "client0", protocol=paho.mqtt.client.MQTTv5) callback0.register(client0) client0.loop_start() client0.connect(host="localhost", port=self._test_broker_port) # should work response = callback0.wait_connected() self.assertEqual(response["reasonCode"].getName(), "Success") self.assertFalse( hasattr(response["properties"], "AssignedClientIdentifier")) client0.disconnect() client0.loop_stop() def test_offline_message_queueing(self): # message queueing for offline clients cleanRetained(self._test_broker_port) ocallback = Callbacks() clientid = "offline message queueing".encode("utf-8") oclient = paho.mqtt.client.Client( clientid, protocol=paho.mqtt.client.MQTTv5) ocallback.register(oclient) connect_properties = Properties(PacketTypes.CONNECT) connect_properties.SessionExpiryInterval = 99999 oclient.loop_start() oclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) response = ocallback.wait_connected() oclient.subscribe(wildtopics[5], qos=2) response = ocallback.wait_subscribed() oclient.disconnect() oclient.loop_stop() bclient.loop_start() bclient.connect(host="localhost", port=self._test_broker_port) response = callback2.wait_connected() bclient.publish(topics[1], b"qos 0", 0) bclient.publish(topics[2], b"qos 1", 1) bclient.publish(topics[3], b"qos 2", 2) time.sleep(2) bclient.disconnect() bclient.loop_stop() oclient = paho.mqtt.client.Client( clientid, protocol=paho.mqtt.client.MQTTv5) ocallback.register(oclient) oclient.loop_start() oclient.connect(host="localhost", port=self._test_broker_port, clean_start=False) response = ocallback.wait_connected() time.sleep(2) oclient.disconnect() oclient.loop_stop() self.assertTrue(len(ocallback.messages) in [ 2, 3], len(ocallback.messages)) logging.info("This server %s queueing QoS 0 messages for offline clients" % ("is" if len(ocallback.messages) == 3 else "is not")) def test_overlapping_subscriptions(self): # overlapping subscriptions. When there is more than one matching subscription for the same client for a topic, # the server may send back one message with the highest QoS of any matching subscription, or one message for # each subscription with a matching QoS. ocallback = Callbacks() clientid = "overlapping subscriptions".encode("utf-8") oclient = paho.mqtt.client.Client( clientid, protocol=paho.mqtt.client.MQTTv5) ocallback.register(oclient) oclient.loop_start() oclient.connect(host="localhost", port=self._test_broker_port) ocallback.wait_connected() oclient.subscribe([(wildtopics[6], SubscribeOptions(qos=2)), (wildtopics[0], SubscribeOptions(qos=1))]) ocallback.wait_subscribed() oclient.publish(topics[3], b"overlapping topic filters", 2) ocallback.wait_published() time.sleep(1) self.assertTrue(len(ocallback.messages) in [1, 2], ocallback.messages) if len(ocallback.messages) == 1: logging.info( "This server is publishing one message for all matching overlapping subscriptions, not one for each.") self.assertEqual( ocallback.messages[0]["message"].qos, 2, ocallback.messages[0]["message"].qos) else: logging.info( "This server is publishing one message per each matching overlapping subscription.") self.assertTrue((ocallback.messages[0]["message"].qos == 2 and ocallback.messages[1]["message"].qos == 1) or (ocallback.messages[0]["message"].qos == 1 and ocallback.messages[1]["message"].qos == 2), callback.messages) oclient.disconnect() oclient.loop_stop() ocallback.clear() def test_subscribe_failure(self): # Subscribe failure. A new feature of MQTT 3.1.1 is the ability to send back negative reponses to subscribe # requests. One way of doing this is to subscribe to a topic which is not allowed to be subscribed to. logging.info("Subscribe failure test starting") ocallback = Callbacks() clientid = "subscribe failure".encode("utf-8") oclient = paho.mqtt.client.Client( clientid, protocol=paho.mqtt.client.MQTTv5) ocallback.register(oclient) oclient.loop_start() oclient.connect(host="localhost", port=self._test_broker_port) ocallback.wait_connected() oclient.subscribe(nosubscribe_topics[0], qos=2) response = ocallback.wait_subscribed() self.assertEqual(response["reasonCodes"][0].getName(), "Unspecified error", "return code should be 0x80 %s" % response["reasonCodes"][0].getName()) oclient.disconnect() oclient.loop_stop() def test_unsubscribe(self): callback2.clear() bclient.connect(host="localhost", port=self._test_broker_port) bclient.loop_start() callback2.wait_connected() bclient.subscribe(topics[0], qos=2) callback2.wait_subscribed() bclient.subscribe(topics[1], qos=2) callback2.wait_subscribed() bclient.subscribe(topics[2], qos=2) callback2.wait_subscribed() time.sleep(1) # wait for any retained messages, hopefully # Unsubscribe from one topic bclient.unsubscribe(topics[0]) callback2.wait_unsubscribed() callback2.clear() # if there were any retained messsages aclient.connect(host="localhost", port=self._test_broker_port) aclient.loop_start() callback.wait_connected() aclient.publish(topics[0], b"topic 0 - unsubscribed", 1, retain=False) aclient.publish(topics[1], b"topic 1", 1, retain=False) aclient.publish(topics[2], b"topic 2", 1, retain=False) time.sleep(2) bclient.disconnect() bclient.loop_stop() aclient.disconnect() aclient.loop_stop() self.assertEqual(len(callback2.messages), 2, callback2.messages) def new_client(self, clientid): callback = Callbacks() client = paho.mqtt.client.Client(clientid.encode( "utf-8"), protocol=paho.mqtt.client.MQTTv5) callback.register(client) client.loop_start() return client, callback def test_session_expiry(self): # no session expiry property == never expire connect_properties = Properties(PacketTypes.CONNECT) connect_properties.SessionExpiryInterval = 0 # expire immediately clientid = "session expiry" eclient, ecallback = self.new_client(clientid) eclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = ecallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) eclient.subscribe(topics[0], qos=2) ecallback.wait_subscribed() eclient.disconnect() ecallback.wait_disconnected() eclient.loop_stop() fclient, fcallback = self.new_client(clientid) # session should immediately expire fclient.connect_async(host="localhost", port=self._test_broker_port, clean_start=False, properties=connect_properties) connack = fcallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) fclient.disconnect() fcallback.wait_disconnected() connect_properties.SessionExpiryInterval = 5 eclient, ecallback = self.new_client(clientid) eclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = ecallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) eclient.subscribe(topics[0], qos=2) ecallback.wait_subscribed() eclient.disconnect() ecallback.wait_disconnected() eclient.loop_stop() time.sleep(2) # session should still exist fclient, fcallback = self.new_client(clientid) fclient.connect(host="localhost", port=self._test_broker_port, clean_start=False, properties=connect_properties) connack = fcallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], True) fclient.disconnect() fcallback.wait_disconnected() fclient.loop_stop() time.sleep(6) # session should not exist fclient, fcallback = self.new_client(clientid) fclient.connect(host="localhost", port=self._test_broker_port, clean_start=False, properties=connect_properties) connack = fcallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) fclient.disconnect() fcallback.wait_disconnected() fclient.loop_stop() eclient, ecallback = self.new_client(clientid) connect_properties.SessionExpiryInterval = 1 connack = eclient.connect( host="localhost", port=self._test_broker_port, properties=connect_properties) connack = ecallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) eclient.subscribe(topics[0], qos=2) ecallback.wait_subscribed() disconnect_properties = Properties(PacketTypes.DISCONNECT) disconnect_properties.SessionExpiryInterval = 5 eclient.disconnect(properties=disconnect_properties) ecallback.wait_disconnected() eclient.loop_stop() time.sleep(3) # session should still exist as we changed the expiry interval on disconnect fclient, fcallback = self.new_client(clientid) fclient.connect(host="localhost", port=self._test_broker_port, clean_start=False, properties=connect_properties) connack = fcallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], True) disconnect_properties.SessionExpiryInterval = 0 fclient.disconnect(properties=disconnect_properties) fcallback.wait_disconnected() fclient.loop_stop() # session should immediately expire fclient, fcallback = self.new_client(clientid) fclient.connect(host="localhost", port=self._test_broker_port, clean_start=False, properties=connect_properties) connack = fcallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) fclient.disconnect() fcallback.wait_disconnected() fclient.loop_stop() fclient.loop_stop() eclient.loop_stop() def test_user_properties(self): clientid = "user properties" uclient, ucallback = self.new_client(clientid) uclient.loop_start() uclient.connect(host="localhost", port=self._test_broker_port) ucallback.wait_connected() uclient.subscribe(topics[0], qos=2) ucallback.wait_subscribed() publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.UserProperty = ("a", "2") publish_properties.UserProperty = ("c", "3") uclient.publish(topics[0], b"", 0, retain=False, properties=publish_properties) uclient.publish(topics[0], b"", 1, retain=False, properties=publish_properties) uclient.publish(topics[0], b"", 2, retain=False, properties=publish_properties) count = 0 while len(ucallback.messages) < 3 and count < 50: time.sleep(.1) count += 1 uclient.disconnect() ucallback.wait_disconnected() uclient.loop_stop() self.assertEqual(len(ucallback.messages), 3, ucallback.messages) userprops = ucallback.messages[0]["message"].properties.UserProperty self.assertTrue(userprops in [[("a", "2"), ("c", "3")], [ ("c", "3"), ("a", "2")]], userprops) userprops = ucallback.messages[1]["message"].properties.UserProperty self.assertTrue(userprops in [[("a", "2"), ("c", "3")], [ ("c", "3"), ("a", "2")]], userprops) userprops = ucallback.messages[2]["message"].properties.UserProperty self.assertTrue(userprops in [[("a", "2"), ("c", "3")], [ ("c", "3"), ("a", "2")]], userprops) qoss = [ucallback.messages[i]["message"].qos for i in range(3)] self.assertTrue(1 in qoss and 2 in qoss and 0 in qoss, qoss) def test_payload_format(self): clientid = "payload format" pclient, pcallback = self.new_client(clientid) pclient.loop_start() pclient.connect_async(host="localhost", port=self._test_broker_port) response = pcallback.wait_connected() pclient.subscribe(topics[0], qos=2) response = pcallback.wait_subscribed() publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.PayloadFormatIndicator = 1 publish_properties.ContentType = "My name" info = pclient.publish( topics[0], b"qos 0", 0, retain=False, properties=publish_properties) info.wait_for_publish() info = pclient.publish( topics[0], b"qos 1", 1, retain=False, properties=publish_properties) info.wait_for_publish() info = pclient.publish( topics[0], b"qos 2", 2, retain=False, properties=publish_properties) info.wait_for_publish() count = 0 while len(pcallback.messages) < 3 and count < 50: time.sleep(.1) count += 1 pclient.disconnect() pcallback.wait_disconnected() pclient.loop_stop() self.assertEqual(len(pcallback.messages), 3, pcallback.messages) props = pcallback.messages[0]["message"].properties self.assertEqual(props.ContentType, "My name", props.ContentType) self.assertEqual(props.PayloadFormatIndicator, 1, props.PayloadFormatIndicator) props = pcallback.messages[1]["message"].properties self.assertEqual(props.ContentType, "My name", props.ContentType) self.assertEqual(props.PayloadFormatIndicator, 1, props.PayloadFormatIndicator) props = pcallback.messages[2]["message"].properties self.assertEqual(props.ContentType, "My name", props.ContentType) self.assertEqual(props.PayloadFormatIndicator, 1, props.PayloadFormatIndicator) qoss = [pcallback.messages[i]["message"].qos for i in range(3)] self.assertTrue(1 in qoss and 2 in qoss and 0 in qoss, qoss) def test_message_expiry(self): clientid = "message expiry" connect_properties = Properties(PacketTypes.CONNECT) connect_properties.SessionExpiryInterval = 99999 lbclient, lbcallback = self.new_client(clientid+" b") lbclient.loop_start() lbclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) response = lbcallback.wait_connected() lbclient.subscribe(topics[0], qos=2) response = lbcallback.wait_subscribed() disconnect_properties = Properties(PacketTypes.DISCONNECT) disconnect_properties.SessionExpiryInterval = 999999999 lbclient.disconnect(properties=disconnect_properties) lbcallback.wait_disconnected() lbclient.loop_stop() laclient, lacallback = self.new_client(clientid+" a") laclient.loop_start() laclient.connect(host="localhost", port=self._test_broker_port) publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.MessageExpiryInterval = 1 laclient.publish(topics[0], b"qos 1 - expire", 1, retain=False, properties=publish_properties) laclient.publish(topics[0], b"qos 2 - expire", 2, retain=False, properties=publish_properties) publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.MessageExpiryInterval = 6 laclient.publish(topics[0], b"qos 1 - don't expire", 1, retain=False, properties=publish_properties) laclient.publish(topics[0], b"qos 2 - don't expire", 2, retain=False, properties=publish_properties) time.sleep(3) lbclient, lbcallback = self.new_client(clientid+" b") lbclient.loop_start() lbclient.connect(host="localhost", port=self._test_broker_port, clean_start=False) lbcallback.wait_connected() self.waitfor(lbcallback.messages, 1, 3) time.sleep(1) self.assertEqual(len(lbcallback.messages), 2, lbcallback.messages) self.assertTrue(lbcallback.messages[0]["message"].properties.MessageExpiryInterval < 6, lbcallback.messages[0]["message"].properties.MessageExpiryInterval) self.assertTrue(lbcallback.messages[1]["message"].properties.MessageExpiryInterval < 6, lbcallback.messages[1]["message"].properties.MessageExpiryInterval) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() lbclient.disconnect() lbcallback.wait_disconnected() lbclient.loop_stop() def test_subscribe_options(self): # noLocal clientid = 'subscribe options - noLocal' laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) lacallback.wait_connected() laclient.loop_start() laclient.subscribe( topics[0], options=SubscribeOptions(qos=2, noLocal=True)) lacallback.wait_subscribed() lbclient, lbcallback = self.new_client(clientid+" b") lbclient.connect(host="localhost", port=self._test_broker_port) lbcallback.wait_connected() lbclient.loop_start() lbclient.subscribe( topics[0], options=SubscribeOptions(qos=2, noLocal=True)) lbcallback.wait_subscribed() laclient.publish(topics[0], b"noLocal test", 1, retain=False) self.waitfor(lbcallback.messages, 1, 3) time.sleep(1) self.assertEqual(lacallback.messages, [], lacallback.messages) self.assertEqual(len(lbcallback.messages), 1, lbcallback.messages) laclient.disconnect() lacallback.wait_disconnected() lbclient.disconnect() lbcallback.wait_disconnected() laclient.loop_stop() lbclient.loop_stop() # retainAsPublished clientid = 'subscribe options - retain as published' laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) lacallback.wait_connected() laclient.subscribe(topics[0], options=SubscribeOptions( qos=2, retainAsPublished=True)) lacallback.wait_subscribed() self.waitfor(lacallback.subscribeds, 1, 3) laclient.publish( topics[0], b"retain as published false", 1, retain=False) laclient.publish( topics[0], b"retain as published true", 1, retain=True) self.waitfor(lacallback.messages, 2, 3) time.sleep(1) self.assertEqual(len(lacallback.messages), 2, lacallback.messages) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() self.assertEqual(lacallback.messages[0]["message"].retain, False) self.assertEqual(lacallback.messages[1]["message"].retain, True) # retainHandling clientid = 'subscribe options - retain handling' laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) lacallback.wait_connected() laclient.publish(topics[1], b"qos 0", 0, retain=True) laclient.publish(topics[2], b"qos 1", 1, retain=True) laclient.publish(topics[3], b"qos 2", 2, retain=True) time.sleep(1) # retain handling 1 only gives us retained messages on a new subscription laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=1)) lacallback.wait_subscribed() self.assertEqual(len(lacallback.messages), 3) qoss = [lacallback.messages[i]["message"].qos for i in range(3)] self.assertTrue(1 in qoss and 2 in qoss and 0 in qoss, qoss) lacallback.clear() laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=1)) lacallback.wait_subscribed() time.sleep(1) self.assertEqual(len(lacallback.messages), 0) # remove that subscription properties = Properties(PacketTypes.UNSUBSCRIBE) properties.UserProperty = ("a", "2") properties.UserProperty = ("c", "3") laclient.unsubscribe(wildtopics[5], properties) response = lacallback.wait_unsubscribed() # check that we really did remove that subscription laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=1)) lacallback.wait_subscribed() self.assertEqual(len(lacallback.messages), 3) qoss = [lacallback.messages[i]["message"].qos for i in range(3)] self.assertTrue(1 in qoss and 2 in qoss and 0 in qoss, qoss) lacallback.clear() laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=1)) lacallback.wait_subscribed() time.sleep(1) self.assertEqual(len(lacallback.messages), 0) # remove that subscription properties = Properties(PacketTypes.UNSUBSCRIBE) properties.UserProperty = ("a", "2") properties.UserProperty = ("c", "3") laclient.unsubscribe(wildtopics[5], properties) response = lacallback.wait_unsubscribed() lacallback.clear() laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=2)) lacallback.wait_subscribed() self.assertEqual(len(lacallback.messages), 0) laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=2)) lacallback.wait_subscribed() self.assertEqual(len(lacallback.messages), 0) # remove that subscription laclient.unsubscribe(wildtopics[5]) response = lacallback.wait_unsubscribed() laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=0)) lacallback.wait_subscribed() self.assertEqual(len(lacallback.messages), 3) qoss = [lacallback.messages[i]["message"].qos for i in range(3)] self.assertTrue(1 in qoss and 2 in qoss and 0 in qoss, qoss) lacallback.clear() laclient.subscribe( wildtopics[5], options=SubscribeOptions(2, retainHandling=0)) time.sleep(1) self.assertEqual(len(lacallback.messages), 3) qoss = [lacallback.messages[i]["message"].qos for i in range(3)] self.assertTrue(1 in qoss and 2 in qoss and 0 in qoss, qoss) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() cleanRetained(self._test_broker_port) def test_subscription_identifiers(self): clientid = 'subscription identifiers' laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) lacallback.wait_connected() laclient.loop_start() sub_properties = Properties(PacketTypes.SUBSCRIBE) sub_properties.SubscriptionIdentifier = 456789 laclient.subscribe(topics[0], qos=2, properties=sub_properties) lacallback.wait_subscribed() lbclient, lbcallback = self.new_client(clientid+" b") lbclient.connect(host="localhost", port=self._test_broker_port) lbcallback.wait_connected() lbclient.loop_start() sub_properties = Properties(PacketTypes.SUBSCRIBE) sub_properties.SubscriptionIdentifier = 2 lbclient.subscribe(topics[0], qos=2, properties=sub_properties) lbcallback.wait_subscribed() sub_properties.clear() sub_properties.SubscriptionIdentifier = 3 lbclient.subscribe(topics[0]+"/#", qos=2, properties=sub_properties) lbclient.publish(topics[0], b"sub identifier test", 1, retain=False) self.waitfor(lacallback.messages, 1, 3) self.assertEqual(len(lacallback.messages), 1, lacallback.messages) self.assertEqual(lacallback.messages[0]["message"].properties.SubscriptionIdentifier[0], 456789, lacallback.messages[0]["message"].properties.SubscriptionIdentifier) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() self.waitfor(lbcallback.messages, 1, 3) self.assertEqual(len(lbcallback.messages), 1, lbcallback.messages) expected_subsids = set([2, 3]) received_subsids = set( lbcallback.messages[0]["message"].properties.SubscriptionIdentifier) self.assertEqual(received_subsids, expected_subsids, received_subsids) lbclient.disconnect() lbcallback.wait_disconnected() lbclient.loop_stop() def test_request_response(self): clientid = 'request response' laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) lacallback.wait_connected() laclient.loop_start() lbclient, lbcallback = self.new_client(clientid+" b") lbclient.connect(host="localhost", port=self._test_broker_port) lbcallback.wait_connected() lbclient.loop_start() laclient.subscribe( topics[0], options=SubscribeOptions(2, noLocal=True)) lacallback.wait_subscribed() lbclient.subscribe( topics[0], options=SubscribeOptions(2, noLocal=True)) lbcallback.wait_subscribed() publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.ResponseTopic = topics[0] publish_properties.CorrelationData = b"334" # client a is the requester laclient.publish(topics[0], b"request", 1, properties=publish_properties) # client b is the responder self.waitfor(lbcallback.messages, 1, 3) self.assertEqual(len(lbcallback.messages), 1, lbcallback.messages) self.assertEqual(lbcallback.messages[0]["message"].properties.ResponseTopic, topics[0], lbcallback.messages[0]["message"].properties) self.assertEqual(lbcallback.messages[0]["message"].properties.CorrelationData, b"334", lbcallback.messages[0]["message"].properties) lbclient.publish(lbcallback.messages[0]["message"].properties.ResponseTopic, b"response", 1, properties=lbcallback.messages[0]["message"].properties) # client a gets the response self.waitfor(lacallback.messages, 1, 3) self.assertEqual(len(lacallback.messages), 1, lacallback.messages) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() lbclient.disconnect() lbcallback.wait_disconnected() lbclient.loop_stop() def test_client_topic_alias(self): clientid = 'client topic alias' # no server side topic aliases allowed laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) connack = lacallback.wait_connected() laclient.loop_start() publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.TopicAlias = 0 # topic alias 0 not allowed laclient.publish(topics[0], "topic alias 0", 1, properties=publish_properties) # should get back a disconnect with Topic alias invalid lacallback.wait_disconnected() laclient.loop_stop() connect_properties = Properties(PacketTypes.CONNECT) connect_properties.TopicAliasMaximum = 0 # server topic aliases not allowed connect_properties.SessionExpiryInterval = 99999 laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = lacallback.wait_connected() clientTopicAliasMaximum = 0 if hasattr(connack["properties"], "TopicAliasMaximum"): clientTopicAliasMaximum = connack["properties"].TopicAliasMaximum if clientTopicAliasMaximum == 0: laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() return laclient.subscribe(topics[0], qos=2) lacallback.wait_subscribed() publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.TopicAlias = 1 laclient.publish(topics[0], b"topic alias 1", 1, properties=publish_properties) self.waitfor(lacallback.messages, 1, 3) self.assertEqual(len(lacallback.messages), 1, lacallback.messages) laclient.publish("", b"topic alias 2", 1, properties=publish_properties) self.waitfor(lacallback.messages, 2, 3) self.assertEqual(len(lacallback.messages), 2, lacallback.messages) laclient.disconnect() # should get rid of the topic aliases but not subscriptions lacallback.wait_disconnected() laclient.loop_stop() # check aliases have been deleted laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port, clean_start=False, properties=connect_properties) laclient.publish(topics[0], b"topic alias 3", 1) self.waitfor(lacallback.messages, 1, 3) self.assertEqual(len(lacallback.messages), 1, lacallback.messages) publish_properties = Properties(PacketTypes.PUBLISH) publish_properties.TopicAlias = 1 laclient.publish("", b"topic alias 4", 1, properties=publish_properties) # should get back a disconnect with Topic alias invalid lacallback.wait_disconnected() laclient.loop_stop() def test_server_topic_alias(self): clientid = 'server topic alias' serverTopicAliasMaximum = 1 # server topic alias allowed connect_properties = Properties(PacketTypes.CONNECT) connect_properties.TopicAliasMaximum = serverTopicAliasMaximum laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = lacallback.wait_connected() laclient.loop_start() clientTopicAliasMaximum = 0 if hasattr(connack["properties"], "TopicAliasMaximum"): clientTopicAliasMaximum = connack["properties"].TopicAliasMaximum laclient.subscribe(topics[0], qos=2) lacallback.wait_subscribed() for qos in range(3): laclient.publish(topics[0], b"topic alias 1", qos) self.waitfor(lacallback.messages, 3, 3) self.assertEqual(len(lacallback.messages), 3, lacallback.messages) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() # first message should set the topic alias self.assertTrue(hasattr( lacallback.messages[0]["message"].properties, "TopicAlias"), lacallback.messages[0]["message"].properties) topicalias = lacallback.messages[0]["message"].properties.TopicAlias self.assertTrue(topicalias > 0) self.assertEqual(lacallback.messages[0]["message"].topic, topics[0]) self.assertEqual( lacallback.messages[1]["message"].properties.TopicAlias, topicalias) self.assertEqual(lacallback.messages[1]["message"].topic, "") self.assertEqual( lacallback.messages[2]["message"].properties.TopicAlias, topicalias) self.assertEqual(lacallback.messages[2]["message"].topic, "") serverTopicAliasMaximum = 0 # no server topic alias allowed connect_properties = Properties(PacketTypes.CONNECT) # connect_properties.TopicAliasMaximum = serverTopicAliasMaximum # default is 0 laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = lacallback.wait_connected() laclient.loop_start() clientTopicAliasMaximum = 0 if hasattr(connack["properties"], "TopicAliasMaximum"): clientTopicAliasMaximum = connack["properties"].TopicAliasMaximum laclient.subscribe(topics[0], qos=2) lacallback.wait_subscribed() for qos in range(3): laclient.publish(topics[0], b"topic alias 2", qos) self.waitfor(lacallback.messages, 3, 3) self.assertEqual(len(lacallback.messages), 3, lacallback.messages) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() # No topic aliases self.assertFalse(hasattr( lacallback.messages[0]["message"].properties, "TopicAlias"), lacallback.messages[0]["message"].properties) self.assertFalse(hasattr( lacallback.messages[1]["message"].properties, "TopicAlias"), lacallback.messages[1]["message"].properties) self.assertFalse(hasattr( lacallback.messages[2]["message"].properties, "TopicAlias"), lacallback.messages[2]["message"].properties) serverTopicAliasMaximum = 0 # no server topic alias allowed connect_properties = Properties(PacketTypes.CONNECT) connect_properties.TopicAliasMaximum = serverTopicAliasMaximum # default is 0 laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = lacallback.wait_connected() laclient.loop_start() clientTopicAliasMaximum = 0 if hasattr(connack["properties"], "TopicAliasMaximum"): clientTopicAliasMaximum = connack["properties"].TopicAliasMaximum laclient.subscribe(topics[0], qos=2) lacallback.wait_subscribed() for qos in range(3): laclient.publish(topics[0], b"topic alias 3", qos) self.waitfor(lacallback.messages, 3, 3) self.assertEqual(len(lacallback.messages), 3, lacallback.messages) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() # No topic aliases self.assertFalse(hasattr( lacallback.messages[0]["message"].properties, "TopicAlias"), lacallback.messages[0]["message"].properties) self.assertFalse(hasattr( lacallback.messages[1]["message"].properties, "TopicAlias"), lacallback.messages[1]["message"].properties) self.assertFalse(hasattr( lacallback.messages[2]["message"].properties, "TopicAlias"), lacallback.messages[2]["message"].properties) def test_maximum_packet_size(self): clientid = 'maximum packet size' # 1. server max packet size laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) connack = lacallback.wait_connected() laclient.loop_start() serverMaximumPacketSize = 2**28-1 if hasattr(connack["properties"], "MaximumPacketSize"): serverMaximumPacketSize = connack["properties"].MaximumPacketSize if serverMaximumPacketSize < 65535: # publish bigger packet than server can accept payload = b"."*serverMaximumPacketSize laclient.publish(topics[0], payload, 0) # should get back a disconnect with packet size too big response = lacallback.wait_disconnected() self.assertEqual(len(lacallback.disconnecteds), 0, lacallback.disconnecteds) self.assertEqual(response["reasonCode"].getName(), "Packet too large", response["reasonCode"].getName()) else: laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() # 1. client max packet size maximumPacketSize = 64 # max packet size we want to receive connect_properties = Properties(PacketTypes.CONNECT) connect_properties.MaximumPacketSize = maximumPacketSize laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = lacallback.wait_connected() laclient.loop_start() serverMaximumPacketSize = 2**28-1 if hasattr(connack["properties"], "MaximumPacketSize"): serverMaximumPacketSize = connack["properties"].MaximumPacketSize laclient.subscribe(topics[0], qos=2) response = lacallback.wait_subscribed() # send a small enough packet, should get this one back payload = b"."*(int(maximumPacketSize/2)) laclient.publish(topics[0], payload, 0) self.waitfor(lacallback.messages, 1, 3) self.assertEqual(len(lacallback.messages), 1, lacallback.messages) # send a packet too big to receive payload = b"."*maximumPacketSize laclient.publish(topics[0], payload, 1) self.waitfor(lacallback.messages, 2, 3) self.assertEqual(len(lacallback.messages), 1, lacallback.messages) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() """ def test_server_keep_alive(self): clientid = 'server keep alive' laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) connack = lacallback.wait_connected() laclient.loop_start() self.assertTrue(hasattr(connack["properties"], "ServerKeepAlive")) self.assertEqual(connack["properties"].ServerKeepAlive, 60) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() """ def test_will_delay(self): # the will message should be received earlier than the session expiry clientid = 'will delay' will_properties = Properties(PacketTypes.WILLMESSAGE) connect_properties = Properties(PacketTypes.CONNECT) # set the will delay and session expiry to the same value - # then both should occur at the same time will_properties.WillDelayInterval = 3 # in seconds connect_properties.SessionExpiryInterval = 5 laclient, lacallback = self.new_client(clientid+" a") laclient.will_set( topics[0], payload=b"test_will_delay will message", properties=will_properties) laclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = lacallback.wait_connected() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) laclient.loop_start() lbclient, lbcallback = self.new_client(clientid+" b") lbclient.connect(host="localhost", port=self._test_broker_port, properties=connect_properties) connack = lbcallback.wait_connected() lbclient.loop_start() # subscribe to will message topic lbclient.subscribe(topics[0], qos=2) lbcallback.wait_subscribed() # abort client a and wait for the will message laclient.loop_stop() laclient.socket().close() start = time.time() while lbcallback.messages == []: time.sleep(.1) duration = time.time() - start self.assertAlmostEqual(duration, 4, delta=1) self.assertEqual(lbcallback.messages[0]["message"].topic, topics[0]) self.assertEqual( lbcallback.messages[0]["message"].payload, b"test_will_delay will message") lbclient.disconnect() lbcallback.wait_disconnected() lbclient.loop_stop() def test_shared_subscriptions(self): clientid = 'shared subscriptions' shared_sub_topic = '$share/sharename/' + topic_prefix + 'x' shared_pub_topic = topic_prefix + 'x' laclient, lacallback = self.new_client(clientid+" a") laclient.connect(host="localhost", port=self._test_broker_port) connack = lacallback.wait_connected() laclient.loop_start() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) laclient.subscribe( [(shared_sub_topic, SubscribeOptions(2)), (topics[0], SubscribeOptions(2))]) response = lacallback.wait_subscribed() lbclient, lbcallback = self.new_client(clientid+" b") lbclient.connect(host="localhost", port=self._test_broker_port) connack = lbcallback.wait_connected() lbclient.loop_start() self.assertEqual(connack["reasonCode"].getName(), "Success") self.assertEqual(connack["flags"]["session present"], False) lbclient.subscribe( [(shared_sub_topic, SubscribeOptions(2)), (topics[0], 2)]) response = lbcallback.wait_subscribed() lacallback.clear() lbcallback.clear() count = 1 for i in range(count): lbclient.publish(topics[0], "message "+str(i), 0) j = 0 while len(lacallback.messages) + len(lbcallback.messages) < 2*count and j < 20: time.sleep(.1) j += 1 time.sleep(1) self.assertEqual(len(lacallback.messages), count) self.assertEqual(len(lbcallback.messages), count) lacallback.clear() lbcallback.clear() for i in range(count): lbclient.publish(shared_pub_topic, "message "+str(i), 0) j = 0 while len(lacallback.messages) + len(lbcallback.messages) < count and j < 20: time.sleep(.1) j += 1 time.sleep(1) # Each message should only be received once self.assertEqual(len(lacallback.messages) + len(lbcallback.messages), count) laclient.disconnect() lacallback.wait_disconnected() laclient.loop_stop() lbclient.disconnect() lbcallback.wait_disconnected() lbclient.loop_stop() def setData(): global topics, wildtopics, nosubscribe_topics, topic_prefix topics = ("TopicA", "TopicA/B", "Topic/C", "TopicA/C", "/TopicA") wildtopics = ("TopicA/+", "+/C", "#", "/#", "/+", "+/+", "TopicA/#") nosubscribe_topics = ("test/nosubscribe",) topic_prefix = "paho.mqtt.client.mqttv5/" paho.mqtt.python-1.6.1/tests/test_websocket_integration.py000066400000000000000000000205261413423552100241230ustar00rootroot00000000000000import base64 import hashlib import re from collections import OrderedDict import pytest from six.moves import socketserver from testsupport.broker import fake_websocket_broker import paho.mqtt.client as client from paho.mqtt.client import WebsocketConnectionError @pytest.fixture def init_response_headers(): # "Normal" websocket response from server response_headers = OrderedDict([ ("Upgrade", "websocket"), ("Connection", "Upgrade"), ("Sec-WebSocket-Accept", "testwebsocketkey"), ("Sec-WebSocket-Protocol", "chat"), ]) return response_headers def get_websocket_response(response_headers): """ Takes headers and constructs HTTP response 'HTTP/1.1 101 Switching Protocols' is the headers for the response, as expected in client.py """ response = "\r\n".join([ "HTTP/1.1 101 Switching Protocols", "\r\n".join("{}: {}".format(i, j) for i, j in response_headers.items()), "\r\n", ]).encode("utf8") return response @pytest.mark.parametrize("proto_ver,proto_name", [ (client.MQTTv31, "MQIsdp"), (client.MQTTv311, "MQTT"), ]) class TestInvalidWebsocketResponse(object): def test_unexpected_response(self, proto_ver, proto_name, fake_websocket_broker): """ Server responds with a valid code, but it's not what the client expected """ mqttc = client.Client( "test_unexpected_response", protocol=proto_ver, transport="websockets" ) class WebsocketHandler(socketserver.BaseRequestHandler): def handle(_self): # Respond with data passed in to serve() _self.request.sendall("200 OK".encode("utf8")) with fake_websocket_broker.serve(WebsocketHandler): with pytest.raises(WebsocketConnectionError) as exc: mqttc.connect("localhost", 1888, keepalive=10) assert str(exc.value) == "WebSocket handshake error" @pytest.mark.parametrize("proto_ver,proto_name", [ (client.MQTTv31, "MQIsdp"), (client.MQTTv311, "MQTT"), ]) class TestBadWebsocketHeaders(object): """ Testing for basic functionality in checking for headers """ def _get_basic_handler(self, response_headers): """ Get a basic BaseRequestHandler which returns the information in self._response_headers """ response = get_websocket_response(response_headers) class WebsocketHandler(socketserver.BaseRequestHandler): def handle(_self): self.data = _self.request.recv(1024).strip() print("Received '{:s}'".format(self.data.decode("utf8"))) # Respond with data passed in to serve() _self.request.sendall(response) return WebsocketHandler def test_no_upgrade(self, proto_ver, proto_name, fake_websocket_broker, init_response_headers): """ Server doesn't respond with 'connection: upgrade' """ mqttc = client.Client( "test_no_upgrade", protocol=proto_ver, transport="websockets" ) init_response_headers["Connection"] = "bad" response = self._get_basic_handler(init_response_headers) with fake_websocket_broker.serve(response): with pytest.raises(WebsocketConnectionError) as exc: mqttc.connect("localhost", 1888, keepalive=10) assert str(exc.value) == "WebSocket handshake error, connection not upgraded" def test_bad_secret_key(self, proto_ver, proto_name, fake_websocket_broker, init_response_headers): """ Server doesn't give anything after connection: upgrade """ mqttc = client.Client( "test_bad_secret_key", protocol=proto_ver, transport="websockets" ) response = self._get_basic_handler(init_response_headers) with fake_websocket_broker.serve(response): with pytest.raises(WebsocketConnectionError) as exc: mqttc.connect("localhost", 1888, keepalive=10) assert str(exc.value) == "WebSocket handshake error, invalid secret key" @pytest.mark.parametrize("proto_ver,proto_name", [ (client.MQTTv31, "MQIsdp"), (client.MQTTv311, "MQTT"), ]) class TestValidHeaders(object): """ Testing for functionality in request/response headers """ def _get_callback_handler(self, response_headers, check_request=None): """ Get a basic BaseRequestHandler which returns the information in self._response_headers """ class WebsocketHandler(socketserver.BaseRequestHandler): def handle(_self): self.data = _self.request.recv(1024).strip() print("Received '{:s}'".format(self.data.decode("utf8"))) decoded = self.data.decode("utf8") if check_request is not None: check_request(decoded) # Create server hash GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11" key = re.search("sec-websocket-key: ([A-Za-z0-9+/=]*)", decoded, re.IGNORECASE).group(1) to_hash = "{:s}{:s}".format(key, GUID) hashed = hashlib.sha1(to_hash.encode("utf8")) encoded = base64.b64encode(hashed.digest()).decode("utf8") response_headers["Sec-WebSocket-Accept"] = encoded # Respond with the correct hash response = get_websocket_response(response_headers) _self.request.sendall(response) return WebsocketHandler def test_successful_connection(self, proto_ver, proto_name, fake_websocket_broker, init_response_headers): """ Connect successfully, on correct path """ mqttc = client.Client( "test_successful_connection", protocol=proto_ver, transport="websockets" ) response = self._get_callback_handler(init_response_headers) with fake_websocket_broker.serve(response): mqttc.connect("localhost", 1888, keepalive=10) mqttc.disconnect() @pytest.mark.parametrize("mqtt_path", [ "/mqtt" "/special", None, ]) def test_correct_path(self, proto_ver, proto_name, fake_websocket_broker, mqtt_path, init_response_headers): """ Make sure it can connect on user specified paths """ mqttc = client.Client( "test_correct_path", protocol=proto_ver, transport="websockets" ) mqttc.ws_set_options( path=mqtt_path, ) def check_path_correct(decoded): # Make sure it connects to the right path if mqtt_path: assert re.search("GET {:s} HTTP/1.1".format(mqtt_path), decoded, re.IGNORECASE) is not None response = self._get_callback_handler( init_response_headers, check_request=check_path_correct, ) with fake_websocket_broker.serve(response): mqttc.connect("localhost", 1888, keepalive=10) mqttc.disconnect() @pytest.mark.parametrize("auth_headers", [ {"Authorization": "test123"}, {"Authorization": "test123", "auth2": "abcdef"}, # Won't be checked, but make sure it still works even if the user passes it None, ]) def test_correct_auth(self, proto_ver, proto_name, fake_websocket_broker, auth_headers, init_response_headers): """ Make sure it sends the right auth headers """ mqttc = client.Client( "test_correct_path", protocol=proto_ver, transport="websockets" ) mqttc.ws_set_options( headers=auth_headers, ) def check_headers_used(decoded): # Make sure it connects to the right path if auth_headers: for h in auth_headers: assert re.search("{:s}: {:s}".format(h, auth_headers[h]), decoded, re.IGNORECASE) is not None response = self._get_callback_handler( init_response_headers, check_request=check_headers_used, ) with fake_websocket_broker.serve(response): mqttc.connect("localhost", 1888, keepalive=10) mqttc.disconnect() paho.mqtt.python-1.6.1/tests/test_websockets.py000066400000000000000000000041601413423552100216770ustar00rootroot00000000000000import socket import sys if sys.version_info < (3, 0): from mock import Mock else: from unittest.mock import Mock import pytest from paho.mqtt.client import WebsocketConnectionError, WebsocketWrapper class TestHeaders(object): """ Make sure headers are used correctly """ def test_normal_headers(self): """ Normal headers as specified in RFC 6455 """ response = [ "HTTP/1.1 101 Switching Protocols", "Upgrade: websocket", "Connection: Upgrade", "Sec-WebSocket-Accept: badreturnvalue=", "Sec-WebSocket-Protocol: chat", "\r\n", ] def iter_response(): for i in "\r\n".join(response).encode("utf8"): yield i for i in "\r\n".encode("utf8"): yield i it = iter_response() def fakerecv(*args): if sys.version_info < (3, 0): return next(it) else: return bytes([next(it)]) mocksock = Mock( spec_set=socket.socket, recv=fakerecv, send=Mock(), ) wargs = { "host": "testhost.com", "port": 1234, "path": "/mqtt", "extra_headers": None, "is_ssl": True, "socket": mocksock, } with pytest.raises(WebsocketConnectionError) as exc: WebsocketWrapper(**wargs) # We're not creating the response hash properly so it should raise this # error assert str(exc.value) == "WebSocket handshake error, invalid secret key" expected_sent = [i.format(**wargs) for i in [ "GET {path:s} HTTP/1.1", "Host: {host:s}", "Upgrade: websocket", "Connection: Upgrade", "Sec-Websocket-Protocol: mqtt", "Sec-Websocket-Version: 13", "Origin: https://{host:s}:{port:d}", ]] # Only sends the header once assert mocksock.send.call_count == 1 for i in expected_sent: assert i in mocksock.send.call_args[0][0].decode("utf8") paho.mqtt.python-1.6.1/tests/testsupport/000077500000000000000000000000001413423552100205305ustar00rootroot00000000000000paho.mqtt.python-1.6.1/tests/testsupport/__init__.py000066400000000000000000000000001413423552100226270ustar00rootroot00000000000000paho.mqtt.python-1.6.1/tests/testsupport/broker.py000066400000000000000000000047631413423552100224000ustar00rootroot00000000000000import contextlib import socket import threading import pytest from six.moves import socketserver class FakeBroker: def __init__(self): # Bind to "localhost" for maximum performance, as described in: # http://docs.python.org/howto/sockets.html#ipc sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) sock.settimeout(30) sock.bind(("localhost", 1888)) sock.listen(1) self._sock = sock self._conn = None def start(self): if self._sock is None: raise ValueError('Socket is not open') (conn, address) = self._sock.accept() conn.settimeout(10) self._conn = conn def finish(self): if self._conn is not None: self._conn.close() self._conn = None if self._sock is not None: self._sock.close() self._sock = None def receive_packet(self, num_bytes): if self._conn is None: raise ValueError('Connection is not open') packet_in = self._conn.recv(num_bytes) return packet_in def send_packet(self, packet_out): if self._conn is None: raise ValueError('Connection is not open') count = self._conn.send(packet_out) return count @pytest.fixture def fake_broker(): # print('Setup broker') broker = FakeBroker() yield broker # print('Teardown broker') broker.finish() class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer): pass class FakeWebsocketBroker(threading.Thread): def __init__(self): super(FakeWebsocketBroker, self).__init__() self.host = "localhost" self.port = 1888 self._server = None self._running = True self.handler_cls = False @contextlib.contextmanager def serve(self, tcphandler): self._server = ThreadedTCPServer((self.host, self.port), tcphandler) try: self.start() if not self._running: raise RuntimeError("Error starting server") yield finally: if self._server: self._server.shutdown() self._server.server_close() def run(self): self._running = True self._server.serve_forever() @pytest.fixture def fake_websocket_broker(): socketserver.TCPServer.allow_reuse_address = True broker = FakeWebsocketBroker() yield broker paho.mqtt.python-1.6.1/tox.ini000066400000000000000000000011701413423552100162640ustar00rootroot00000000000000[tox] envlist = py{27,35,36,37,38,39} [testenv:py27] setenv = EXCLUDE = --exclude=./.*,./examples/loop_asyncio.py,*/MQTTV5.py,*/MQTTV311.py [testenv] whitelist_externals = echo make deps = -rrequirements.txt flake8 commands = # $EXCLUDE is defined above in testenv:py27 as a workaround for Python 2 # which does not support asyncio and type hints flake8 . --count --select=E9,F63,F7,F822,F823 --show-source --statistics {env:EXCLUDE:} python setup.py test make -C test test # TODO (cclauss) Fix up all these undefined names flake8 . --count --exit-zero --select=F821 --show-source --statistics