| Name | dweeter JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Encrypted messaging through the free dweet service. |
| upload_time | 2024-07-15 23:19:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 Quan Lin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
dweet
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Dweeter
[![PyPI version][pypi_img]][pypi_link]
[![Downloads][downloads_img]][downloads_link]
[pypi_img]: https://badge.fury.io/py/dweeter.svg
[pypi_link]: https://badge.fury.io/py/dweeter
[downloads_img]: https://pepy.tech/badge/dweeter
[downloads_link]: https://pepy.tech/project/dweeter
[Documentation](https://jacklinquan.github.io/dweeter)
Encrypted messaging through the free dweet service.
Dweet is a simple machine-to-machine (M2M) service from [dweet.io](https://dweet.io).
It also can be used in MicroPython.
---
## Installation
### Synchronous Programming
```shell
pip install dweeter
```
### Asynchronous Programming
```shell
pip install dweeter[aiohttp]
```
---
## Usage
### Synchronous Programming
<details open><summary>Code</summary>
```python
import time
from dweeter import Dweeter
dwtr = Dweeter("MAILBOX_NAME", "KEY_TO_MAILBOX")
print(dwtr.send_data({"DATA_1": "VALUE_1"}))
time.sleep(2)
print(dwtr.get_new_data())
time.sleep(2)
print(dwtr.send_data({"DATA_2": "VALUE_2"}))
time.sleep(2)
print(dwtr.get_new_data())
```
</details>
<details open><summary>Output</summary>
```
{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:11:32.709Z', 'content': {'904b0c7d2cfe0dd2501e7f25101fb92457f58052e8526dafb38b883438896980': '4c03f62878dd6d9befdc92e00a2a1bd4906c9590838f7758062e37b99c05b696cb01b729f7c9faa6962726e5dc6a4b1ad522dd0dceb3870106a67ebaedf9868b87548e04347fbc721e152f03ac405fb1'}, 'transaction': 'c8f956a5-e516-4ad4-afa5-5035d4206179'}
{'DATA_1': 'VALUE_1', 'remote_time': '2024-07-15T05:11:31.000Z', 'created_time': '2024-07-15T05:11:32.709Z'}
{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:11:38.580Z', 'content': {'904b0c7d2cfe0dd2501e7f25101fb924cb74208c05dc802c752e5e2717f4c717': '10753b950ecdcbf5a9b7cd82f82c3bac7d5b522a175897e2db32457d6f373cbc2fe8f7ef551284de110e6b9abfa058404b8f9d4126e18d3c32e137e5902f298c722cf8261460613602484dae350cb8f6'}, 'transaction': '2dcec037-9b02-4dc2-a6c1-26cc0beb4e03'}
{'DATA_2': 'VALUE_2', 'remote_time': '2024-07-15T05:11:37.000Z', 'created_time': '2024-07-15T05:11:38.580Z'}
```
</details>
### Asynchronous Programming
<details><summary>Code</summary>
```python
import asyncio
from dweeter import Dweeter
async def async_main():
dwtr = Dweeter("MAILBOX_NAME", "KEY_TO_MAILBOX")
print(await dwtr.async_send_data({"DATA_1": "VALUE_1"}))
await asyncio.sleep(2)
print(await dwtr.async_get_new_data())
await asyncio.sleep(2)
print(await dwtr.async_send_data({"DATA_2": "VALUE_2"}))
await asyncio.sleep(2)
print(await dwtr.async_get_new_data())
asyncio.run(async_main())
```
</details>
<details><summary>Output</summary>
```
{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:12:20.059Z', 'content': {'0d93e2a03ea4fea5741276e310398b65e6f55f0456d6d2bb74b01ffca22bf9ba': '4c03f62878dd6d9befdc92e00a2a1bd4906c9590838f7758062e37b99c05b696cb01b729f7c9faa6962726e5dc6a4b1a3b18b95d5e6552c4b61913acf2861b0e3a45a4113ac684bc5a08bf5a82d65816'}, 'transaction': 'e5b08537-2c14-4ce9-be72-5d804607ce26'}
{'DATA_1': 'VALUE_1', 'remote_time': '2024-07-15T05:12:19.000Z', 'created_time': '2024-07-15T05:12:20.059Z'}
{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:12:25.941Z', 'content': {'0d93e2a03ea4fea5741276e310398b6557ef5805e83d93aa199097fd01b51821': '10753b950ecdcbf5a9b7cd82f82c3bac7d5b522a175897e2db32457d6f373cbc2fe8f7ef551284de110e6b9abfa05840066efe7671423a88111a87a6a58076595fee9457ed0fa115dc463cf66c031017'}, 'transaction': 'b025efed-16ab-46ba-96f3-4df72ef5dcdf'}
{'DATA_2': 'VALUE_2', 'remote_time': '2024-07-15T05:12:25.000Z', 'created_time': '2024-07-15T05:12:25.941Z'}
```
</details>
---
## Test
```shell
python -m pytest
```
---
## Build documentation
```shell
mkdocs build
```
---
## Change
- v0.3.0:
- `CryptoDweet` class is added.
- Asynchronous methods are added for asynchronous programming.
- Dweet content dictionary can be encoded with base64 to be more compact.
---
## On messaging security
The free dweet service is public.
By "public", it means:
- Every one on Internet can see what you are sending.
- Every one can send something for the same "thing" name to confuse you.
The publicly exposed user information:
- The "thing" name, which you can think of as the unique virtual mailbox name.
- The keys of the "content" dictionary.
- The values of the "content" dictionary.
The dweeter module wraps the contents as a single key-value pair.
So there is only one key and one value in the "content" dictionary.
And the "thing" name and the "content" dictionary are encrypted.
So no one knows what they mean.
Without knowing what the information means,
potential attackers can still send something for the same "thing" name.
Because the "content" dictionary is encrypted,
the only way to do this is to capture a bunch of messages
and send them randomly.
The key and the value of the "content" dictionary both include
the same time stamp.
A mismatch of them will result in an error that is handled by dweeter.
But a copy of the whole "content" dictionary could
still be passed on to the receiver.
This is often referred to as "replay attack".
The decrypted user data dictionary includes 2 extra key-value pairs:
- "created_time", the timestamp from the dweet service.
- "remote_time", the timestamp from the sending device.
You can compare these two timestamps to decide if a "replay attack" happened.
On a micropython device, you can use `ntptime.settime()` to set the local time.
Be aware of a normal gap between "created_time" and "remote_time".
On a PC I observed 4 to 5 seconds difference.
On a micropython device I observed 8 to 9 seconds difference.
This time difference could vary from case to case.
Raw data
{
"_id": null,
"home_page": null,
"name": "dweeter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "dweet",
"author": null,
"author_email": "Quan Lin <jacklinquan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/92/02/c8a7f4029fb52051389eff68f785395503cdb634b41fae7a70c9281f934f/dweeter-0.3.0.tar.gz",
"platform": null,
"description": "# Dweeter\r\n\r\n[![PyPI version][pypi_img]][pypi_link]\r\n[![Downloads][downloads_img]][downloads_link]\r\n\r\n [pypi_img]: https://badge.fury.io/py/dweeter.svg\r\n [pypi_link]: https://badge.fury.io/py/dweeter\r\n [downloads_img]: https://pepy.tech/badge/dweeter\r\n [downloads_link]: https://pepy.tech/project/dweeter\r\n\r\n[Documentation](https://jacklinquan.github.io/dweeter)\r\n\r\nEncrypted messaging through the free dweet service.\r\nDweet is a simple machine-to-machine (M2M) service from [dweet.io](https://dweet.io).\r\n\r\nIt also can be used in MicroPython.\r\n\r\n---\r\n\r\n## Installation\r\n\r\n### Synchronous Programming\r\n\r\n```shell\r\npip install dweeter\r\n```\r\n\r\n### Asynchronous Programming\r\n\r\n```shell\r\npip install dweeter[aiohttp]\r\n```\r\n\r\n---\r\n\r\n## Usage\r\n\r\n### Synchronous Programming\r\n\r\n<details open><summary>Code</summary>\r\n\r\n```python\r\nimport time\r\nfrom dweeter import Dweeter\r\n\r\ndwtr = Dweeter(\"MAILBOX_NAME\", \"KEY_TO_MAILBOX\")\r\n\r\nprint(dwtr.send_data({\"DATA_1\": \"VALUE_1\"}))\r\ntime.sleep(2)\r\nprint(dwtr.get_new_data())\r\ntime.sleep(2)\r\nprint(dwtr.send_data({\"DATA_2\": \"VALUE_2\"}))\r\ntime.sleep(2)\r\nprint(dwtr.get_new_data())\r\n```\r\n</details>\r\n\r\n<details open><summary>Output</summary>\r\n\r\n```\r\n{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:11:32.709Z', 'content': {'904b0c7d2cfe0dd2501e7f25101fb92457f58052e8526dafb38b883438896980': '4c03f62878dd6d9befdc92e00a2a1bd4906c9590838f7758062e37b99c05b696cb01b729f7c9faa6962726e5dc6a4b1ad522dd0dceb3870106a67ebaedf9868b87548e04347fbc721e152f03ac405fb1'}, 'transaction': 'c8f956a5-e516-4ad4-afa5-5035d4206179'}\r\n{'DATA_1': 'VALUE_1', 'remote_time': '2024-07-15T05:11:31.000Z', 'created_time': '2024-07-15T05:11:32.709Z'}\r\n{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:11:38.580Z', 'content': {'904b0c7d2cfe0dd2501e7f25101fb924cb74208c05dc802c752e5e2717f4c717': '10753b950ecdcbf5a9b7cd82f82c3bac7d5b522a175897e2db32457d6f373cbc2fe8f7ef551284de110e6b9abfa058404b8f9d4126e18d3c32e137e5902f298c722cf8261460613602484dae350cb8f6'}, 'transaction': '2dcec037-9b02-4dc2-a6c1-26cc0beb4e03'}\r\n{'DATA_2': 'VALUE_2', 'remote_time': '2024-07-15T05:11:37.000Z', 'created_time': '2024-07-15T05:11:38.580Z'}\r\n```\r\n</details>\r\n\r\n### Asynchronous Programming\r\n\r\n<details><summary>Code</summary>\r\n\r\n```python\r\nimport asyncio\r\nfrom dweeter import Dweeter\r\n\r\nasync def async_main():\r\n dwtr = Dweeter(\"MAILBOX_NAME\", \"KEY_TO_MAILBOX\")\r\n\r\n print(await dwtr.async_send_data({\"DATA_1\": \"VALUE_1\"}))\r\n await asyncio.sleep(2)\r\n print(await dwtr.async_get_new_data())\r\n await asyncio.sleep(2)\r\n print(await dwtr.async_send_data({\"DATA_2\": \"VALUE_2\"}))\r\n await asyncio.sleep(2)\r\n print(await dwtr.async_get_new_data())\r\n\r\nasyncio.run(async_main())\r\n```\r\n</details>\r\n\r\n<details><summary>Output</summary>\r\n\r\n```\r\n{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:12:20.059Z', 'content': {'0d93e2a03ea4fea5741276e310398b65e6f55f0456d6d2bb74b01ffca22bf9ba': '4c03f62878dd6d9befdc92e00a2a1bd4906c9590838f7758062e37b99c05b696cb01b729f7c9faa6962726e5dc6a4b1a3b18b95d5e6552c4b61913acf2861b0e3a45a4113ac684bc5a08bf5a82d65816'}, 'transaction': 'e5b08537-2c14-4ce9-be72-5d804607ce26'}\r\n{'DATA_1': 'VALUE_1', 'remote_time': '2024-07-15T05:12:19.000Z', 'created_time': '2024-07-15T05:12:20.059Z'}\r\n{'thing': '42e6ae04e842cadca8a814fea06bcf6d', 'created': '2024-07-15T05:12:25.941Z', 'content': {'0d93e2a03ea4fea5741276e310398b6557ef5805e83d93aa199097fd01b51821': '10753b950ecdcbf5a9b7cd82f82c3bac7d5b522a175897e2db32457d6f373cbc2fe8f7ef551284de110e6b9abfa05840066efe7671423a88111a87a6a58076595fee9457ed0fa115dc463cf66c031017'}, 'transaction': 'b025efed-16ab-46ba-96f3-4df72ef5dcdf'}\r\n{'DATA_2': 'VALUE_2', 'remote_time': '2024-07-15T05:12:25.000Z', 'created_time': '2024-07-15T05:12:25.941Z'}\r\n```\r\n</details>\r\n\r\n---\r\n\r\n## Test\r\n\r\n```shell\r\npython -m pytest\r\n```\r\n\r\n---\r\n\r\n## Build documentation\r\n\r\n```shell\r\nmkdocs build\r\n```\r\n\r\n---\r\n\r\n## Change\r\n\r\n- v0.3.0:\r\n - `CryptoDweet` class is added.\r\n - Asynchronous methods are added for asynchronous programming.\r\n - Dweet content dictionary can be encoded with base64 to be more compact.\r\n\r\n---\r\n\r\n## On messaging security\r\n\r\nThe free dweet service is public.\r\nBy \"public\", it means:\r\n\r\n- Every one on Internet can see what you are sending.\r\n- Every one can send something for the same \"thing\" name to confuse you.\r\n\r\nThe publicly exposed user information:\r\n\r\n- The \"thing\" name, which you can think of as the unique virtual mailbox name.\r\n- The keys of the \"content\" dictionary.\r\n- The values of the \"content\" dictionary.\r\n\r\nThe dweeter module wraps the contents as a single key-value pair.\r\nSo there is only one key and one value in the \"content\" dictionary.\r\nAnd the \"thing\" name and the \"content\" dictionary are encrypted.\r\nSo no one knows what they mean.\r\n\r\nWithout knowing what the information means,\r\npotential attackers can still send something for the same \"thing\" name.\r\nBecause the \"content\" dictionary is encrypted,\r\nthe only way to do this is to capture a bunch of messages\r\nand send them randomly.\r\nThe key and the value of the \"content\" dictionary both include\r\nthe same time stamp.\r\nA mismatch of them will result in an error that is handled by dweeter.\r\nBut a copy of the whole \"content\" dictionary could\r\nstill be passed on to the receiver.\r\nThis is often referred to as \"replay attack\".\r\n\r\nThe decrypted user data dictionary includes 2 extra key-value pairs:\r\n\r\n- \"created_time\", the timestamp from the dweet service.\r\n- \"remote_time\", the timestamp from the sending device.\r\n\r\nYou can compare these two timestamps to decide if a \"replay attack\" happened.\r\nOn a micropython device, you can use `ntptime.settime()` to set the local time.\r\nBe aware of a normal gap between \"created_time\" and \"remote_time\".\r\nOn a PC I observed 4 to 5 seconds difference.\r\nOn a micropython device I observed 8 to 9 seconds difference.\r\nThis time difference could vary from case to case.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Quan Lin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Encrypted messaging through the free dweet service.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/jacklinquan/dweeter"
},
"split_keywords": [
"dweet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be0cfd73d9dbd3707ec100a9eff857c4a9b54f4e441bad25bbdbd43672c677b1",
"md5": "612ba16e08a1fc9716029e69d91d6c26",
"sha256": "b6e59997f896983e4e962b7a16e41802332eedb7d56ae2a26e6cf00f574e2383"
},
"downloads": -1,
"filename": "dweeter-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "612ba16e08a1fc9716029e69d91d6c26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7717,
"upload_time": "2024-07-15T23:19:06",
"upload_time_iso_8601": "2024-07-15T23:19:06.387631Z",
"url": "https://files.pythonhosted.org/packages/be/0c/fd73d9dbd3707ec100a9eff857c4a9b54f4e441bad25bbdbd43672c677b1/dweeter-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9202c8a7f4029fb52051389eff68f785395503cdb634b41fae7a70c9281f934f",
"md5": "0b4fe54e53ec15fcbd8965389c525c93",
"sha256": "c34a8ca5809507409ee424b14eea130555d3cb5dd4455b5469ca257851c726d5"
},
"downloads": -1,
"filename": "dweeter-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "0b4fe54e53ec15fcbd8965389c525c93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8421,
"upload_time": "2024-07-15T23:19:07",
"upload_time_iso_8601": "2024-07-15T23:19:07.719280Z",
"url": "https://files.pythonhosted.org/packages/92/02/c8a7f4029fb52051389eff68f785395503cdb634b41fae7a70c9281f934f/dweeter-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-15 23:19:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jacklinquan",
"github_project": "dweeter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "dweeter"
}
