معرفی شرکت ها
databridges_nacl_wrapper-1.0.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
DataBridges Python nacl wrapper for databridges library.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | databridges_nacl_wrapper-1.0.1 |
| نام | databridges_nacl_wrapper |
| نسخه کتابخانه | 1.0.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | "Optomate Technologies Private Limited." <tech@optomate.io> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/databridges_nacl_wrapper/ |
| مجوز | - |
# Databridges Python NaCl Wrapper Library
Databridges NACL wrapper gives you a simple write and read function using implementation of the secretbox encryption standard defined in NaCl.
Databridges NACL wrapper is available for
- [JavaScript](https://github.com/databridges-io/lib.javascript.nacl.wrapper.git)
- [NodeJS](https://github.com/databridges-io/lib.nodejs.nacl.wrapper.git)
- [C#](https://github.com/databridges-io/lib.csharp.nacl.wrapper.git)
- [Python](https://github.com/databridges-io/lib.python.nacl.wrapper.git)
- [Java for Android](https://github.com/databridges-io/lib.android.nacl.wrapper.git)
- [iOS Swift](https://github.com/databridges-io/lib.ios.nacl.wrapper.git)
The above wrappers can be used to send encrypted messages between them.
> The Databridges NACL wrapper for Python Language binding uses `PyNaCl` to deliver implementation of the secretbox encryption standard defined in NaCl.
## Usage Overview
The following topics are covered:
- [Supported platforms](#supported-platforms)
- [Installation.](#installation)
- [Initialization](#initialization)
- [Global Configuration](#global-configuration)
- [How to use with Databridges Python Library](#how-to-use-with-databridges-python-library)
- [Change Log](#change-log)
- [License](#license)
## Supported platforms
Supports Python versions +3.6
## Installation.
You can use pip package manager to install the package.
```bash
pip3 install databridges_nacl_wrapper
```
## Initialization
```python
from databridges_nacl_wrapper import databridges_nacl_wrapper
secretData = databridges_nacl_wrapper()
```
## Global Configuration
### Required
The following is the required properties before using to dataBridges NaCl wrapper.
```python
secretData.secret = '32 char alphanumeric string';
```
| Properties | Description |
| ---------- | ------------------------------------------------------------ |
| `secret` | *(string)* 32 char alpha numeric string. NaCl encryption secret. |
## Encrypt data
To encrypt data using NaCl, databridges wrapper exposes a method named `write`, This will return encrypted data if successful else it will throw error.
#### write()
```python
try:
encData = secretData.write("Your Data..");
print('Encrypted:', encData);
except Exception as err:
print('Errors:', err.source , err.code , err.message);
```
| Parameter | Description |
| --------- | ---------------------------------- |
| `data` | *(string)* *data* to be encrypted. |
| Return Values | Description |
| ------------- | ------------------ |
| `string` | Encrypted string. |
##### Exceptions:
| Source | Code | Description |
| ------------------ | -------------- | ---------------------------------------------- |
| DBLIB_NACL_WRAPPER | INVALID_SECRET | `secret` is not set with the wrapper instance. |
| DBLIB_NACL_WRAPPER | INVALID_DATA | If `data` is not passed to the function. |
| DBLIB_NACL_WRAPPER | NACL_EXCEPTION | Exceptions generated by NaCl library. |
## Decrypt data
To decrypt data using NaCl, databridges wrapper exposes a method named `read`, This will return decrypted data if successful else it will throw error.
#### read()
```python
try:
decData = secretData.read("<Encrypted data.>")
print('Decrypted:', decData);
except Exception as err:
print("Errors:", err.source, err.code, err.message)
```
| Parameter | Description |
| --------- | ---------------------------------- |
| `data` | *(string)* *data* to be encrypted. |
| Return Values | Description |
| ------------- | ------------------ |
| `string` | Encrypted string. |
##### Exceptions:
| Source | Code | Description |
| ------------------ | ------------------- | ------------------------------------------------------------ |
| DBLIB_NACL_WRAPPER | INVALID_SECRET | `secret` is not set with the wrapper instance. |
| DBLIB_NACL_WRAPPER | INVALID_DATA | If `data` is not passed to the function OR `data` is not a valid encrypted string. |
| DBLIB_NACL_WRAPPER | NACL_EXCEPTION | Exceptions generated by NaCl library. |
| DBLIB_NACL_WRAPPER | NACL_DECRYPT_FAILED | If decryption fails due to invalid secret or manipulated data. |
## How to use with Databridges Python Library
Below code shows how to integrate the NaCl wrapper with the Databridges library. After initialize you can use the wrapper library to encrypt and decrypt the data when publishing and receiving events.
```python
# Initialize both databridges-sio-client-lib and databridges-nacl-wrapper
from databridges_sio_client_lib import dBridges
from databridges_sio_client_lib.exceptions import dBError
from databridges_nacl_wrapper import databridges_nacl_wrapper
dbridge = dBridges()
secretData = databridges_nacl_wrapper()
secretData.secret = "Your32 char secret.";
# .... Your databridges code comes here.
# On Subscription success event.
async def on_SubscribeChannel(payload, metadata):
try:
# Encrypt data to publish
encData = secretData.write('Your Data..')
await self.subscribeChannel.publish('eventName', encData, 1)
except Exception as err:
print("Error: ", err.source, err.code, err.message)
self.subscribeChannel.bind("dbridges:subscribe.success", on_SubscribeChannel)
# On payload Received event.
async def on_EventReceived(payload, metadata):
try:
decData = secretData.read(payload)
print('Decrypted:', decData);
except Exception as err:
print("Error: ", err.source, err.code, err.message)
self.subscribeChannel.bind("eventName", on_EventReceived)
```
## Change Log
* [Change log](CHANGELOG.md): Changes in the recent versions
## License
DataBridges NaCl Wrapper is released under the [MIT license](LICENSE).
```
Copyright 2022 Optomate Technologies Private Limited.
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.
```
نیازمندی
| مقدار | نام |
|---|---|
| - | PyNaCl==1.5.0 |
نحوه نصب
نصب پکیج whl databridges_nacl_wrapper-1.0.1:
pip install databridges_nacl_wrapper-1.0.1.whl
نصب پکیج tar.gz databridges_nacl_wrapper-1.0.1:
pip install databridges_nacl_wrapper-1.0.1.tar.gz