Creating an actual Python package that can be installed

python/BSSpeke/Client.py

+#import base64
+
+from _bsspeke_cffi import ffi, lib
+
+class Client:
+    
+    def __init__(self, user_id, server_id, password):
+        uid_utf8 = user_id.encode('utf-8')
+        print("uid_utf8:", uid_utf8.decode('utf-8'), len(uid_utf8))
+        sid_utf8 = server_id.encode('utf-8')
+        print("sid_utf8:", sid_utf8.decode('utf-8'), len(sid_utf8))
+        pwd_utf8 = password.encode('utf-8')
+        print("pwd_utf8:", pwd_utf8.decode('utf-8'), len(pwd_utf8))
+
+        from _bsspeke_cffi import ffi, lib
+        self.ffi = ffi
+        self.lib = lib
+
+        self.ctx = self.ffi.new("bsspeke_client_ctx *")
+        self.lib.bsspeke_client_init(self.ctx,
+                                     uid_utf8, len(uid_utf8),
+                                     sid_utf8, len(sid_utf8),
+                                     pwd_utf8, len(pwd_utf8))
+
+    def generate_blind(self):
+        blind = bytes(32)
+        self.lib.bsspeke_client_generate_blind(blind, self.ctx)
+        return blind
+
+
+    def get_client_id(self):
+        clientid_len = self.ctx.client_id_len
+        client_id_bytes = bytes(ffi.buffer(self.ctx.client_id, self.ctx.client_id_len))
+        client_id = client_id_bytes.decode('utf-8')
+        #print("ClientId string = [%s]" % client_id)
+        return client_id
+
+
+    def generate_P_and_V(self, blind_salt, phf_params):
+        P = bytes(32)
+        V = bytes(32)
+        phf_blocks = phf_params["blocks"]
+        phf_iterations = phf_params["iterations"]
+        self.lib.bsspeke_client_generate_P_and_V(P, V,
+                                                 blind_salt,
+                                                 phf_blocks, phf_iterations,
+                                                 self.ctx)
+        return P,V
+#        request = {}
+#        request["P"] = base64.b64encode(P)
+#        request["V"] = base64.b64encode(V)
+#        request["phf"] = {}
+#        request["phf"]["name"] = "argon2i"
+#        request["phf"]["blocks"] = phf_blocks
+#        request["phf"]["iterations"] = phf_iterations
+#
+#        return request
+
+    def generate_A(self, blind_salt, phf_params):
+        phf_blocks = phf_params["blocks"]
+        phf_iterations = phf_params["iterations"]
+        self.lib.bsspeke_client_generate_A(blind_salt,
+                                           phf_blocks,
+                                           phf_iterations,
+                                           self.ctx)
+        A = bytes(ffi.buffer(self.ctx.A, 32))
+        return A
+
+    def generate_shared_key(self, B):
+        self.lib.bsspeke_client_generate_shared_key(B, self.ctx)
+
+    def verify_server(self, server_verifier):
+        rc = self.lib.bsspeke_client_verify_server(server_verifier, self.ctx)
+        if rc != 0:
+            return False
+        else:
+            return True
+

python/BSSpeke/Server.py

+#import base64
+
+from _bsspeke_cffi import ffi, lib
+
+class Server:
+    def __init__(self, server_id, user_id):
+        sid_utf8 = server_id.encode('utf-8')
+        print("sid_utf8:", sid_utf8.decode('utf-8'), len(sid_utf8))
+        uid_utf8 = user_id.encode('utf-8')
+        print("uid_utf8:", uid_utf8.decode('utf-8'), len(uid_utf8))
+
+        from _bsspeke_cffi import ffi, lib
+        self.ffi = ffi
+        self.lib = lib
+        
+        self.ctx = self.ffi.new("bsspeke_server_ctx *")
+        self.lib.bsspeke_server_init(self.ctx,
+                                     sid_utf8, len(sid_utf8),
+                                     uid_utf8, len(uid_utf8))
+
+    def blind_salt(self, blind, salt):
+        blind_salt = bytes(32)
+        self.lib.bsspeke_server_blind_salt(blind_salt, blind, salt, len(salt))
+        return blind_salt
+
+    def generate_B(self, P):
+        self.lib.bsspeke_server_generate_B(P, self.ctx)
+        B = bytes(self.ffi.buffer(self.ctx.B, 32))
+        return B
+
+    def derive_shared_key(self, A, V):
+        self.lib.bsspeke_server_derive_shared_key(A, V, self.ctx)
+        
+    def verify_client(self, client_verifier):
+        rc = self.lib.bsspeke_server_verify_client(client_verifier, self.ctx)
+        if rc != 0:
+            return False
+        else:
+            return True
+
+    def generate_verifier(self):
+        server_verifier = bytes(32)
+        self.lib.bsspeke_server_generate_verifier(server_verifier, self.ctx)
+        return server_verifier
+

python/BSSpeke/__init__.py

+from .Client import Client
+from .Server import Server

python/LICENSE.txt

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) 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. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

python/README.md

+This package provides a Python interface for speaking the BS-SPEKE
+protocol for augmented password-authenticated key agreement (aPAKE).

python/setup.py

+from setuptools import setup
+
+setup(
+    name='BSSpeke',
+    version='0.1.0',
+    author='Charles Wright',
+    author_email='cvwright@futo.org',
+    packages=['BSSpeke'],
+    #scripts=['bin/script1','bin/script2'],
+    url='http://pypi.python.org/pypi/BS-SPEKE/',
+    license='LICENSE.txt',
+    description='An awesome package that does something',
+    long_description=open('README.md').read(),
+    setup_requires=["cffi>=1.0.0"],
+    cffi_modules=["bsspeke_build.py:ffibuilder"],
+    install_requires=["cffi>=1.0.0"],
+)