Metadata-Version: 2.1
Name: ebclient
Version: 1.1.14
Summary: EnigmaBridge Python Client
Home-page: https://github.com/EnigmaBridge/client.py
Author: Enigma Bridge
Author-email: support@enigmabridge.com
License: MIT License

Copyright (c) 2016 Enigma bridge

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.

Description:  `Enigma Bridge <https://www.enigmabridge.com>`__ Python client
         ==============================================================
        
        With this repo you can use `Enigma Bridge <https://www.enigmabridge.com>`__ encryption service.
        
        Installation
        ------------
        
        .. code:: bash
        
            pip install ebclient
        
        Usage
        -----
        
        The following example assumes that you already have access to the encryption server, i.e., you have a valid api key,
        which in this case is 'API_TEST'.
        
        Calling processData():
        
        .. code:: python
        
            from ebclient.process_data import ProcessData
            from ebclient.uo import Configuration, Endpoint, SimpleRetry, UO
            from ebclient.crypto_util import *
        
            # Construct general configuration (endpoint, request config)
            cfg = Configuration()
            cfg.endpoint_process = Endpoint.url('https://site2.enigmabridge.com:11180')
            cfg.api_key = 'API_TEST'
        
            # UO you want to work with
            uo_aes = UO(uo_id=0xee01,
                        uo_type=0x4,
                        enc_key=from_hex('e134567890123456789012345678901234567890123456789012345678901234'),
                        mac_key=from_hex('e224262820223456789012345678901234567890123456789012345678901234'),
                        configuration=cfg)
        
            # ProcessData itself
            pd = ProcessData(uo=uo_aes, config=cfg)
            result = pd.call(from_hex('6bc1bee22e409f96e93d7e117393172a'))
            print(from_hex('95c6bb9b6a1c3835f98cc56087a03e82') == result)
        
        For more usage examples please refer to tests and our `API
        documentation <https://api.enigmabridge.com/api/?python>`__.
        
        Dependencies
        ------------
        
        .. code:: bash
        
            pip install pycrypto requests
        
        Or to install to home directory
        
        .. code:: bash
        
            pip install --user pycrypto requests
        
        If the error ``ImportError: No module named Crypto`` is thrown it's
        needed to run pip with ``--upgrade`` and update pycrypto to the latest
        version.
        
        Compatibility
        -------------
        
        We should be compatible with Python 2.6+ and Python 3+.
        
        Troubleshooting
        ---------------
        
        Error in installation of dependencies (cryptography, pyOpenSSL):
        ``sorry, but this version only supports 100 named groups``
        [`100-named-groups <https://community.letsencrypt.org/t/certbot-auto-fails-while-setting-up-virtual-environment-complains-about-package-hashes/20529/18>`__]
        
        Solution: Install downgraded version of pycparser and pyOpenSSL:
        
        ::
        
            pip install pycparser==2.13
            pip install pyOpenSSL==0.13
            pip install cryptography
        
        You may need to install some deps for the python packages
        
        ::
        
            yum install gcc g++ openssl-devel libffi-devel python-devel
        
        SNI on Python < 2.7.9
        ~~~~~~~~~~~~~~~~~~~~~
        
        TLS SNI support was added to Python. For earlier versions SNI needs to
        be added to Requests networking library.
        
        ::
        
            pip install urllib3
            pip install pyopenssl
            pip install ndg-httpsclient
            pip install pyasn1
        
        Mac OSX installation
        ~~~~~~~~~~~~~~~~~~~~
        
        For new OSX versions (El Capitan and above) the default system python
        installation cannot be modified with standard means. There are some
        workarounds, but one can also use ``--user`` switch for pip.
        
        ::
        
            pip install --user cryptography
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Security
Provides-Extra: docs
Provides-Extra: dev
