crud-mysql 0.1.6__tar.gz → 0.1.8__tar.gz

{crud_mysql-0.1.6 → crud_mysql-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crud-mysql
-Version: 0.1.6
+Version: 0.1.8
 Summary: crud defiend by json
 Home-page: https://github.com/Ms-Shoshany/crud-mysql
 Author: hanna
@@ -14,6 +14,9 @@ License-File: LICENCE
 Requires-Dist: mysql-connector-python
 Requires-Dist: mysql-database
 Requires-Dist: flask
+Requires-Dist: flask_jwt_extended
+Requires-Dist: cryptography
+Requires-Dist: PyJWT
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -62,3 +65,39 @@ cred.json - example
         }
     }
 }
+
+using tokens:
+
+to protect endpoints by verifying tokens - add protected_methods to that object for example:
+
+{
+    "car": {
+        "allowd_methods": ["GET", "POST", "DELETE", "PUT"],
+        "protected_methods": ["GET"],
+        "fetch_all": "true",
+        "schema": {
+            "owner": "VARCHAR(100)",
+            "color": "VARCHAR(100)",
+            "licence_plate": "INT"
+        }
+    }
+}
+
+here when using "GET" to get a car we will need to add a token.
+
+important: also add to app.py the line: 
+set_jwt_protection(app) 
+
+in order for this to work a few things need to be set:
+an environment varriable JWT_ALGORITHM should be set. 
+the options are:
+- RS256
+- HS256
+if none are set it will default to HS256.
+
+if the algorithim being used is HS256 then a variable needs to be set for SECRET_KEY.
+this has to be the same SECRET_KEY that was used for creating the jwt.
+
+if the algorithim being used is RS256. a variable needs to be set for SECRET_KEYS_PATH.
+and at that path there needs to be a public.pem
+it has to be the same cert that was used to create the jwt.

crud_mysql-0.1.8/README.md

@@ -0,0 +1,73 @@
+main.py / app.py - example
+
+from flask import Flask
+from flask_cors import CORS
+from crud_mysql import crud
+
+app = Flask(__name__)
+
+app.register_blueprint(crud)
+
+if __name__ == "__main__":
+	app.run(host="0.0.0.0", debug=True)
+
+cred.json - example
+
+{
+    "user": {
+        "allowd_methods": ["GET", "POST", "DELETE", "PUT"],
+        "fetch_all": "true",
+        "schema": {
+            "name": "VARCHAR(100)",
+            "email": "VARCHAR(100)",
+            "encrypted_password": "VARCHAR(100)",
+            "account_id": "INT",
+            "is_active": "INT"
+        }
+    },
+    "account": {
+        "allowd_methods": ["GET", "POST", "DELETE"],
+        "fetch_all": "false",
+        "schema": {
+            "name": "VARCHAR(100)",
+            "subscription_type": "VARCHAR(100)",
+            "root_user": "INT"
+        }
+    }
+}
+
+using tokens:
+
+to protect endpoints by verifying tokens - add protected_methods to that object for example:
+
+{
+    "car": {
+        "allowd_methods": ["GET", "POST", "DELETE", "PUT"],
+        "protected_methods": ["GET"],
+        "fetch_all": "true",
+        "schema": {
+            "owner": "VARCHAR(100)",
+            "color": "VARCHAR(100)",
+            "licence_plate": "INT"
+        }
+    }
+}
+
+here when using "GET" to get a car we will need to add a token.
+
+important: also add to app.py the line: 
+set_jwt_protection(app) 
+
+in order for this to work a few things need to be set:
+an environment varriable JWT_ALGORITHM should be set. 
+the options are:
+- RS256
+- HS256
+if none are set it will default to HS256.
+
+if the algorithim being used is HS256 then a variable needs to be set for SECRET_KEY.
+this has to be the same SECRET_KEY that was used for creating the jwt.
+
+if the algorithim being used is RS256. a variable needs to be set for SECRET_KEYS_PATH.
+and at that path there needs to be a public.pem
+it has to be the same cert that was used to create the jwt.

{crud_mysql-0.1.6 → crud_mysql-0.1.8}/crud_mysql/__init__.py

@@ -1,2 +1,3 @@
 from .endpoints import crud, create_object, get_object, delete_object, update_object
-from .crud_object import CrudObject
+from .crud_object import CrudObject
+from .protect import set_jwt_protection

{crud_mysql-0.1.6 → crud_mysql-0.1.8}/crud_mysql/endpoints.py

@@ -1,10 +1,14 @@
 from flask import Blueprint
 from flask import request, jsonify
 from .crud_object import CrudObject
+from .protect import protect
+
 
 crud = Blueprint('crud', __name__, template_folder='templates')
 
+
 @crud.route("/<object_type>", methods=["GET"])
+@protect()
 def get_object(object_type):
 	try:
 		crud_object = CrudObject(object_type)

crud_mysql-0.1.8/crud_mysql/protect.py

@@ -0,0 +1,35 @@
+from flask_jwt_extended import JWTManager, jwt_required, get_jwt
+from flask import request
+from functools import wraps
+from crud_mysql.crud_object import CrudObject
+import os
+
+def protect():
+    def decorator(fn):
+        @wraps(fn)
+        def wrapper(*args, **kwargs):
+            method = request.method
+            object_type = request.base_url.split("/")[-1]
+            crud = CrudObject(object_type).get_crud()[object_type]
+            if "protected_methods" in crud and method in crud["protected_methods"]:
+                return jwt_required()(fn)(*args, **kwargs)
+            else:
+                return fn(*args, **kwargs)
+        return wrapper
+    return decorator
+
+def set_jwt_protection(app):
+    with open("crud.json", "r") as f:
+        crud_file = f.read()
+    if "protected_methods" in crud_file:
+        algo = os.environ.get("JWT_ALGORITHM", "HS256")
+        app.config['JWT_ALGORITHM'] = algo
+        if algo == "RS256":
+            SECRET_KEYS_PATH = os.environ.get("SECRET_KEYS_PATH", ".")
+            with open(f'{SECRET_KEYS_PATH}/public.pem', 'r') as f:
+                app.config['JWT_PUBLIC_KEY'] = f.read()
+        elif algo == "HS256":
+            if "SECRET_KEY" not in os.environ:
+                raise Exception("missing secret key for verifying tokens")
+            app.config['SECRET_KEY'] = os.environ.get("SECRET_KEY")
+        jwt = JWTManager(app)

{crud_mysql-0.1.6 → crud_mysql-0.1.8}/crud_mysql.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crud-mysql
-Version: 0.1.6
+Version: 0.1.8
 Summary: crud defiend by json
 Home-page: https://github.com/Ms-Shoshany/crud-mysql
 Author: hanna
@@ -14,6 +14,9 @@ License-File: LICENCE
 Requires-Dist: mysql-connector-python
 Requires-Dist: mysql-database
 Requires-Dist: flask
+Requires-Dist: flask_jwt_extended
+Requires-Dist: cryptography
+Requires-Dist: PyJWT
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -62,3 +65,39 @@ cred.json - example
         }
     }
 }
+
+using tokens:
+
+to protect endpoints by verifying tokens - add protected_methods to that object for example:
+
+{
+    "car": {
+        "allowd_methods": ["GET", "POST", "DELETE", "PUT"],
+        "protected_methods": ["GET"],
+        "fetch_all": "true",
+        "schema": {
+            "owner": "VARCHAR(100)",
+            "color": "VARCHAR(100)",
+            "licence_plate": "INT"
+        }
+    }
+}
+
+here when using "GET" to get a car we will need to add a token.
+
+important: also add to app.py the line: 
+set_jwt_protection(app) 
+
+in order for this to work a few things need to be set:
+an environment varriable JWT_ALGORITHM should be set. 
+the options are:
+- RS256
+- HS256
+if none are set it will default to HS256.
+
+if the algorithim being used is HS256 then a variable needs to be set for SECRET_KEY.
+this has to be the same SECRET_KEY that was used for creating the jwt.
+
+if the algorithim being used is RS256. a variable needs to be set for SECRET_KEYS_PATH.
+and at that path there needs to be a public.pem
+it has to be the same cert that was used to create the jwt.

{crud_mysql-0.1.6 → crud_mysql-0.1.8}/crud_mysql.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ setup.py
 crud_mysql/__init__.py
 crud_mysql/crud_object.py
 crud_mysql/endpoints.py
+crud_mysql/protect.py
 crud_mysql/vars.py
 crud_mysql.egg-info/PKG-INFO
 crud_mysql.egg-info/SOURCES.txt

{crud_mysql-0.1.6 → crud_mysql-0.1.8}/crud_mysql.egg-info/requires.txt

@@ -1,3 +1,6 @@
 mysql-connector-python
 mysql-database
 flask
+flask_jwt_extended
+cryptography
+PyJWT

{crud_mysql-0.1.6 → crud_mysql-0.1.8}/setup.py

@@ -5,9 +5,9 @@ with open('README.md', encoding='utf-8') as f:
 
 setup(
     name='crud-mysql',
-    version='0.1.6',
+    version='0.1.8',
     packages=find_packages(),
-    install_requires=['mysql-connector-python', 'mysql-database', 'flask'],
+    install_requires=['mysql-connector-python', 'mysql-database', 'flask', 'flask_jwt_extended', 'cryptography', 'PyJWT'],
     author='hanna',
     author_email='channashosh@gmail.com',
     description='crud defiend by json',

crud_mysql-0.1.6/README.md

@@ -1,37 +0,0 @@
-main.py / app.py - example
-
-from flask import Flask
-from flask_cors import CORS
-from crud_mysql import crud
-
-app = Flask(__name__)
-
-app.register_blueprint(crud)
-
-if __name__ == "__main__":
-	app.run(host="0.0.0.0", debug=True)
-
-cred.json - example
-
-{
-    "user": {
-        "allowd_methods": ["GET", "POST", "DELETE", "PUT"],
-        "fetch_all": "true",
-        "schema": {
-            "name": "VARCHAR(100)",
-            "email": "VARCHAR(100)",
-            "encrypted_password": "VARCHAR(100)",
-            "account_id": "INT",
-            "is_active": "INT"
-        }
-    },
-    "account": {
-        "allowd_methods": ["GET", "POST", "DELETE"],
-        "fetch_all": "false",
-        "schema": {
-            "name": "VARCHAR(100)",
-            "subscription_type": "VARCHAR(100)",
-            "root_user": "INT"
-        }
-    }
-}