brain2-oc 2.1.5__tar.gz

brain2_oc-2.1.5/LICENSE

@@ -0,0 +1,8 @@
+Ouroboros Coding Inc. License
+
+Copyright (c) 2024 Ouroboros Coding Inc.
+
+Permission is hereby granted, with limits, to any person using this software
+within a project created by Ouroboros Coding Inc. Any attempt to modify this
+code, or use it outside projects created by Ouroboros Coding Inc, will result
+in legal action taken against the party using the code.

brain2_oc-2.1.5/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.1
+Name: brain2_oc
+Version: 2.1.5
+Summary: Brain contains a service to manage users and permissions
+Home-page: https://ouroboroscoding.com/body/brain2
+Author: Chris Nasr - Ouroboros Coding Inc.
+Author-email: chris@ouroboroscoding.com
+License: Custom
+Project-URL: Documentation, https://ouroboroscoding.com/body/brain2
+Project-URL: Source, https://github.com/ouroboroscoding/brain2
+Project-URL: Tracker, https://github.com/ouroboroscoding/brain2/issues
+Keywords: rest,microservices
+Platform: UNKNOWN
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Brain2
+
+Body 2.0 service that handles users and permissions.
+
+This code comes without documentation as it's not meant to be used by anyone
+outside of Ouroboros Coding Inc. Please see LICENSE for further information.
+

brain2_oc-2.1.5/README.md

@@ -0,0 +1,6 @@
+# Brain2
+
+Body 2.0 service that handles users and permissions.
+
+This code comes without documentation as it's not meant to be used by anyone
+outside of Ouroboros Coding Inc. Please see LICENSE for further information.

brain2_oc-2.1.5/brain/__init__.py

@@ -0,0 +1,15 @@
+# coding=utf8
+""" Brain
+
+Exposes internal modules
+"""
+
+__author__		= "Chris Nasr"
+__copyright__	= "Ouroboros Coding Inc."
+__email__		= "chris@ouroboroscoding.com"
+__created__		= "2023-07-16"
+
+__all__ = [ 'errors', 'helpers', 'rights', 'service' ]
+
+# Local
+from brain import errors, helpers, rights, service

brain2_oc-2.1.5/brain/__main__.py

@@ -0,0 +1,90 @@
+# coding=utf8
+""" Brain
+
+Handles authorization / user requests
+"""
+
+__author__		= "Chris Nasr"
+__version__		= "1.0.0"
+__copyright__	= "Ouroboros Coding Inc."
+__email__		= "chris@ouroboroscoding.com"
+__created__		= "2022-08-25"
+
+# Ouroboros imports
+from config import config
+from upgrade import upgrade
+
+# Python imports
+from os.path import abspath, expanduser
+from pathlib import Path
+from sys import argv, exit, stderr
+
+# Pip imports
+from rest_mysql import Record_MySQL
+
+# Module imports
+from brain import install, rest
+
+def cli():
+	"""CLI
+
+	Called from the command line to run from the current directory
+
+	Returns:
+		uint
+	"""
+
+	# Get Brain config
+	conf = config.brain({
+		'data': './.brain',
+		'mysql': 'primary',
+		'user_default_locale': 'en-US'
+	})
+	if '~' in conf['data']:
+		conf['data'] = expanduser(conf['data'])
+	conf['data'] = abspath(conf['data'])
+
+	# Add the global prepend
+	Record_MySQL.db_prepend(config.mysql.prepend(''))
+
+	# Add the primary mysql DB
+	Record_MySQL.add_host('brain', config.mysql.hosts[conf['mysql']]({
+		'host': 'localhost',
+		'port': 3306,
+		'charset': 'utf8',
+		'user': 'root',
+		'passwd': ''
+	}))
+
+	# If we have no arguments
+	if len(argv) == 1:
+
+		# Run the REST server
+		return rest.run()
+
+	# Else, if we have one argument
+	elif len(argv) == 2:
+
+		# If we are installing
+		if argv[1] == 'install':
+			conf['module'] = Path(__file__).parent.resolve()
+			return install.install(conf)
+
+		# Else, if we are explicitly stating the rest service
+		elif argv[1] == 'rest':
+			return rest.run()
+
+		# Else, if we are upgrading
+		elif argv[1] == 'upgrade':
+			return upgrade(
+				conf['data'],
+				Path(__file__).parent.resolve()
+			)
+
+	# Else, arguments are wrong, print and return an error
+	print('Invalid arguments', file = stderr)
+	return 1
+
+# Only run if called directly
+if __name__ == '__main__':
+	exit(cli())

brain2_oc-2.1.5/brain/definitions/db_host.json

@@ -0,0 +1,64 @@
+{
+	"__sql__": {
+		"auto_primary": "UUID()",
+		"changes": ["user"],
+		"create": [
+			"_created", "_updated", "name"
+		],
+		"db": "brain",
+		"host": "brain",
+		"indexes": {
+			"name": {"unique": null}
+		},
+		"primary": "_id",
+		"table": "brain_db_host",
+		"charset": "utf8mb4",
+		"collate": "utf8mb4_unicode_ci"
+	},
+
+	"__name__": "Brain_DBHost",
+
+	"_id": {
+		"__type__":"uuid",
+		"__optional__": true
+	},
+
+	"_created": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP"
+		}
+	},
+
+	"_updated": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP"
+		}
+	},
+
+	"name": {
+		"__type__": "string",
+		"__maximum__": 64
+	},
+
+	"details": {
+		"host": {"__type__": "string"},
+		"port": {"__type__": "uint"},
+		"user": {"__type__": "string"},
+		"passwd": {"__type__": "string"},
+		"charset": {"__type__": "string", "__optional__": true},
+		"__sql__": {
+			"json": true
+		}
+	},
+
+	"full": {
+		"__type__": "bool",
+		"__sql__": {
+			"opt": "default 0"
+		}
+	}
+}

brain2_oc-2.1.5/brain/definitions/group.json

@@ -0,0 +1,49 @@
+{
+	"__sql__": {
+		"auto_primary": "UUID()",
+		"changes": ["user"],
+		"create": [
+			"_created", "_updated", "name"
+		],
+		"db": "brain",
+		"host": "brain",
+		"indexes": {
+			"name": {"unique": null}
+		},
+		"primary": "_id",
+		"table": "brain_group",
+		"charset": "utf8mb4",
+		"collate": "utf8mb4_unicode_ci"
+	},
+
+	"__name__": "Brain_Group",
+
+	"_id": {
+		"__type__":"uuid",
+		"__optional__": true,
+		"__ui__": {
+			"title": "Unique ID"
+		}
+	},
+
+	"_created": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP"
+		}
+	},
+
+	"_updated": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP"
+		}
+	},
+
+	"name": {
+		"__type__": "string",
+		"__maximum__": 64
+	}
+}

brain2_oc-2.1.5/brain/definitions/key.json

@@ -0,0 +1,49 @@
+{
+	"__sql__": {
+		"auto_primary": false,
+		"create": ["_created", "_updated", "user", "type"],
+		"db": "brain",
+		"host": "brain",
+		"indexes": {
+			"user_type": {"unique": ["user", "type"]}
+		},
+		"table": "brain_key",
+		"charset": "utf8mb4",
+		"collate": "utf8mb4_bin"
+	},
+
+	"__name__": "Key",
+
+	"_id": {
+		"__type__": "string",
+		"__regex__": "^[0-9a-f]{32}$",
+		"__sql__": {
+			"type": "char(32)"
+		}
+	},
+
+	"_created": {
+		"__type__": "timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP"
+		}
+	},
+
+	"_updated": {
+		"__type__": "timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP"
+		}
+	},
+
+	"user": {
+		"__type__": "uuid"
+	},
+
+	"type": {
+		"__type__": "string",
+		"__options__": ["forgot", "setup", "verify"]
+	}
+}

brain2_oc-2.1.5/brain/definitions/permissions.json

@@ -0,0 +1,67 @@
+{
+	"__sql__": {
+		"auto_primary": "UUID()",
+		"changes": ["user"],
+		"create": ["_created", "_updated", "user", "portal", "rights"],
+		"db": "brain",
+		"host": "brain",
+		"indexes": {
+			"u_user_portal": ["user", "portal"]
+		},
+		"primary": "_id",
+		"table": "brain_permissions",
+		"charset": "utf8mb4",
+		"collate": "utf8mb4_bin"
+	},
+
+	"__name__": "Brain_Permissions",
+
+	"_id": {
+		"__type__": "uuid",
+		"__optional__": true
+	},
+
+	"_created": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP"
+		}
+	},
+
+	"_updated": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP"
+		}
+	},
+
+	"user": {
+		"__type__":"uuid"
+	},
+
+	"portal": {
+		"__type__": "string",
+		"__maximum__": 16,
+		"__sql__": {
+			"type": "char(16)"
+		}
+	},
+
+	"rights": {
+		"__hash__": {
+			"__type__": "string",
+			"__regex__": "[a-z_]+"
+		},
+		"__type__": {
+			"__hash__": "uuid",
+			"__type__": "uint",
+			"__minimum__": 1,
+			"__maximum__": 15
+		},
+		"__sql__": {
+			"json": true
+		}
+	}
+}

brain2_oc-2.1.5/brain/definitions/user.json

@@ -0,0 +1,151 @@
+{
+	"__sql__": {
+		"auto_primary": "UUID()",
+		"changes": ["user"],
+		"create": [
+			"_created", "_updated", "email", "passwd", "locale",
+			"first_name", "last_name", "title", "suffix",
+			"phone_number", "phone_ext", "verified"
+		],
+		"db": "brain",
+		"host": "brain",
+		"indexes": {
+			"email": {"unique": null}
+		},
+		"primary": "_id",
+		"table": "brain_user",
+		"charset": "utf8mb4",
+		"collate": "utf8mb4_unicode_ci"
+	},
+
+	"__ui__": {
+		"create": ["email", "title", "first_name", "last_name",
+					"suffix", "phone_number", "phone_ext"],
+		"results": ["_id", "email", "title", "first_name", "last_name", "suffix"],
+		"search": ["_id", "email", "first_name", "last_name", "phone_number"],
+		"update": ["title", "first_name", "last_name", "suffix", "phone_number",
+					"phone_ext"]
+	},
+
+	"__name__": "Brain_User",
+
+	"_id": {
+		"__type__":"uuid",
+		"__optional__": true,
+		"__ui__": {
+			"title": "Unique ID"
+		}
+	},
+
+	"_created": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP"
+		}
+	},
+
+	"_updated": {
+		"__type__":"timestamp",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP"
+		}
+	},
+
+	"email": {
+		"__type__":"string",
+		"__maximum__": 127,
+		"__ui__": {
+			"title": "E-Mail Address"
+		}
+	},
+
+	"passwd": {
+		"__type__":"string",
+		"__regex__":"^[0-9a-fA-F]{72}$",
+		"__sql__": "char(72)",
+		"__ui__": {
+			"regex": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})",
+			"title": "Password",
+			"type": "password"
+		}
+	},
+
+	"locale": {
+		"__type__": "string",
+		"__regex__": "^[a-z]{2}-[A-Z]{2}$",
+		"__sql__": "char(5)",
+		"__ui__": {
+			"options": [["en-US", "U.S. English"]],
+			"title": "Language",
+			"type": "hidden"
+		}
+	},
+
+	"first_name": {
+		"__type__": "string",
+		"__minumum__": 1,
+		"__maximum__": 31,
+		"__ui__": {
+			"title": "Given Name"
+		}
+	},
+
+	"last_name": {
+		"__type__": "string",
+		"__minumum__": 2,
+		"__maximum__": 31,
+		"__ui__": {
+			"title": "Surname"
+		}
+	},
+
+	"title": {
+		"__type__": "string",
+		"__maximum__": 31,
+		"__optional__": true,
+		"__ui__": {
+			"title": "Title (e.g. Dr., Mrs., Miss, Lord, etc)"
+		}
+	},
+
+	"suffix": {
+		"__type__": "string",
+		"__maximum__": 31,
+		"__optional__": true,
+		"__ui__": {
+			"title": "Suffix (e.g. PhD, RN, Esq)"
+		}
+	},
+
+	"phone_number": {
+		"__type__": "string",
+		"__regex__": "^(\\+[\\d \\(\\)-]{10,30}|[\\d \\(\\)-]{10,31})$",
+		"__optional__": true,
+		"__ui__": {
+			"title": "Phone Number",
+			"type": "phone_number"
+		},
+		"__sql__": {
+			"type": "varchar(31)"
+		}
+	},
+
+	"phone_ext": {
+		"__type__": "string",
+		"__maximum__": 11,
+		"__optional__": true,
+		"__ui__": {
+			"title": "Extension"
+		}
+	},
+
+	"verified": {
+		"__type__": "bool",
+		"__optional__": true,
+		"__sql__": {
+			"opts": "default 0"
+		}
+	}
+}

brain2_oc-2.1.5/brain/errors.py

@@ -0,0 +1,34 @@
+# coding=utf8
+""" Errors
+
+Brain error codes
+"""
+
+__author__ = "Chris Nasr"
+__copyright__ = "Ouroboros Coding Inc"
+__version__ = "1.0.0"
+__email__ = "chris@ouroboroscoding.com"
+__created__ = "2023-01-16"
+
+__all__ = ['body', 'SIGNIN_FAILED', 'PASSWORD_STRENGTH', 'BAD_PORTAL']
+
+# Ouroboros imports
+from body import errors as body
+
+SIGNIN_FAILED = 1200
+"""Sign In Failed"""
+
+PASSWORD_STRENGTH = 1201
+"""Password not strong enough"""
+
+BAD_PORTAL = 1202
+"""Portal doesn't exist, or the user doesn't have permissions for it"""
+
+INTERNAL_KEY = 1203
+"""Internal key failed to validate"""
+
+BAD_OAUTH = 1204
+"""Something failed in the OAuth process"""
+
+BAD_CONFIG = 1205
+"""Something is missing from the configuration"""