skadd 1.0.0__py3-none-any.whl

skadd/__init__.py

@@ -0,0 +1,3 @@
+from .add import *
+
+__version__ = "1.0.0"

skadd/add.py

@@ -0,0 +1,282 @@
+"""
+User [with Setup Key] Creating Web Tool
+Dependencies: pip install [tagrepo] uvia vapp skadd
+Start daemon: 
+  export JWT_SECRET="very-strong-password"
+  export TOKEN_EXPIRE_MINUTES=30
+  export ADMIN_AUTHENTICATOR_EMAIL_LIST=EMAIL_LIST_SEPARATED_BY_COMMA
+  export SENDER_GMAIL_ADDRESS="YOUR_WORKING_GMAIL_ADDRESS"
+  export SENDER_GMAIL_APP_PWD="YOUR_WORKING_GMAIL_APP_PWD"
+  export FILE_AVRO_DATA="../users/setupkeys.avro"
+  uvia -a vapp -m skadd [-p <PORT>] [-H <HOST>]
+VAPP routes:
+  Route: /callback -> callbackpage()
+  Route: /login -> loginpage()
+  Route: /call -> callpage()
+  GET -> request.query_params = {function, access_token, jsondata, module}
+"""
+
+import os
+import shutil
+import uvicorn ## for <uvia>
+from dotenv import load_dotenv
+from starlette.responses import HTMLResponse
+from starlette.responses import RedirectResponse
+from starlette.requests import Request
+from jinja2 import Template
+
+from tagrepo import *
+from skgen import check_setup_key_exist, add_setup_key, now, upper, lower
+from pavro import pd, select_avro_file, read_avro_file, avro_file_insert, avro_save
+from tier2 import generate_access_token, verify_access_token, text_to_email
+from tier2 import create_google_random_setup_key, verify_google_code
+
+APP_PORT = 21058
+APP_DESC = 'User Creating Tool'
+SESSION_USER = 'session_user'
+ACCESS_TOKEN = 'user_access_token'
+QUERY_FUNCTION = 'function'
+FUNCTION_LOGOUT = 'logout'
+FUNCTION_SELECT = 'select'
+FUNCTION_INSERT = 'insert'
+FUNCTION_DELETE = 'delete'
+CALLBACK = 'callback'
+
+load_dotenv()
+
+ADMIN_AUTHENTICATOR_EMAIL_LIST = os.getenv('ADMIN_AUTHENTICATOR_EMAIL_LIST', '').split(',')
+TOKEN_EXPIRE_MINUTES = float(os.getenv('TOKEN_EXPIRE_MINUTES', '30'))
+JWT_SECRET = os.getenv('JWT_SECRET', 'replace-me-with-stronger-pass')
+
+LOGIN_TITLE = os.getenv('LOGIN_TITLE') or 'User Login'
+USERS_LISTING_TITLE = os.getenv('USERS_LISTING_TITLE') or 'Users Listing'
+USERS_UPDATING_TITLE = os.getenv('USERS_UPDATING_TITLE') or 'Users Updating'
+USERS_CREATING_TITLE = os.getenv('USERS_CREATING_TITLE') or 'Users Creating'
+FORM_TITLE = os.getenv('FORM_TITLE') or 'User [with Setup Key] Creating Tool'
+
+LABEL_INPUT_PARAMS = os.getenv('LABEL_INPUT_PARAMS') or 'User register info'
+LABEL_LOGIN_PARAMS = os.getenv('LABEL_LOGIN_PARAMS') or 'Authentication info'
+
+LABEL_USER_NAME = os.getenv('LABEL_USER_NAME') or 'User name'
+LABEL_USER_EMAIL = os.getenv('LABEL_USER_EMAIL') or 'User email'
+LABEL_AUTH_CODE = os.getenv('LABEL_AUTH_CODE') or 'Authenticator code'
+
+LABEL_SUBMIT_BUTTON = os.getenv('LABEL_SUBMIT_BUTTON') or 'Create'
+LABEL_CANCEL_BUTTON = os.getenv('LABEL_CANCEL_BUTTON') or 'Cancel'
+LABEL_DELETE_BUTTON = os.getenv('LABEL_DELETE_BUTTON') or 'Delete'
+LABEL_LOGIN_BUTTON = os.getenv('LABEL_LOGIN_BUTTON') or 'Login'
+
+STYLE_SUBMIT_BUTTON = os.getenv('STYLE_SUBMIT_BUTTON', APP_SUBMIT_BUTTON_STYLE)
+STYLE_CANCEL_BUTTON = os.getenv('STYLE_CANCEL_BUTTON', APP_CANCEL_BUTTON_STYLE)
+
+KEY_ALREADY_EXISTS = os.getenv('KEY_ALREADY_EXISTS', 'Warning: setup key for this email already exists')
+MISSING_INPUT_DATA = os.getenv('MISSING_INPUT_DATA', 'Error: missing input data')
+FAILED_SAVE_DATA = os.getenv('FAILED_SAVE_DATA', 'Error: failed to save data')
+
+YOU_ARE_LOGGED_OUT = os.getenv('YOU_ARE_LOGGED_OUT', 'You are logged out')
+YOU_HAVE_TO_LOG_IN = os.getenv('YOU_HAVE_TO_LOG_IN', 'You have to log-in first')
+YOU_COULD_NOT_LOG_IN = os.getenv('YOU_COULD_NOT_LOG_IN', 'Code was not verified, or user is not authorized')
+
+YOUR_NEW_SETUP_KEY = os.getenv('YOUR_NEW_SETUP_KEY', 'New setup key')
+SETUP_KEY_GUIDE = os.getenv('SETUP_KEY_GUIDE', 'Please secretly save, and add this key to your authenticator app')
+
+STYLISH_TABLE_VIEW = os.getenv('STYLISH_TABLE_VIEW', False)
+CLASSIC_TABLE_VIEW = not STYLISH_TABLE_VIEW
+
+HEADER_SELECT_OPTION = os.getenv('HEADER_SELECT_OPTION', 'select')
+FILE_AVRO_DATA = os.getenv('FILE_AVRO_DATA', './setupkeys.avro')
+
+home_button = lambda: '&nbsp;<a title="Home" style="text-decoration:none;" href="/">&#x2302;</a>'
+
+def insert_setup_user(email: str, name: str) -> bool:
+  key = str(create_google_random_setup_key())
+  email = lower(email)
+  message = f'''
+  {YOUR_NEW_SETUP_KEY} for {name} ({email}): {key}
+  {SETUP_KEY_GUIDE}
+  '''
+  send = text_to_email(message=message, recipient=email, subject=YOUR_NEW_SETUP_KEY)
+  if not send: return False
+  return add_setup_key(name=name, email=email, key=key)
+
+def delete_setup_users(users: list, avro: str=FILE_AVRO_DATA, primarycol: str='email') -> bool:
+  df = read_avro_file(avro)
+  df = df[~df[primarycol].isin(users)]
+  temp = f'{avro}.temp'
+  trial = avro_save(df, temp)
+  if not trial: return False
+  try:
+    shutil.copy2(temp, avro)
+    return True
+  except:
+    return False
+
+def list_all_setup_users(avro: str=FILE_AVRO_DATA, show: list=['name', 'email'], hide: list=['key', 'time'], classic: bool=CLASSIC_TABLE_VIEW, select: bool=False) -> str:
+  df = read_avro_file(avro)
+  if select:
+    df.insert(0, HEADER_SELECT_OPTION, [f'<input type="checkbox" name="selects" value="{df.email[i]}">' for i in range(len(df))])
+  if classic:
+    content = df.to_html(columns=show, escape=False, index=False)
+  else:
+    content = df.style.set_properties(subset=show, **{'border': '0', 'padding': '5', 'width': '100%'}).hide(subset=hide, axis='columns').to_html(escape=False, index=False)
+  return content
+
+def verify_login_code(email: str, code: str, avro: str=FILE_AVRO_DATA) -> bool:
+  df = select_user_by_email(email=email, avro=avro)
+  if df is None or not len(df): return False
+  return verify_google_code(code, df.key[0])
+
+def select_user_by_email(email: str, avro: str=FILE_AVRO_DATA) -> pd.DataFrame:
+  return select_avro_file(avro, {"all": [{"==": ["email", lower(email), lower]}]})
+
+def homepage():
+  async def submit(request: Request):
+    return HTMLResponse(Template(APP_TMP_DIRECTORY_MENU).render(
+      APP_CHARSET=APP_CHARSET,
+      APP_VIEWPORT=APP_VIEWPORT,
+      APP_TITLE=APP_DESC,
+      FORM_TITLE=FORM_TITLE,
+      directory_items=[
+        {'href': '/login', 'name': 'Login'},
+        {'href': '/call?function=select', 'name': 'List Users'},
+        {'href': '/call?function=insert', 'name': 'Create User'},
+        {'href': '/call?function=delete', 'name': 'Delete User'},
+        {'href': '/call?function=logout', 'name': 'Logout'},
+      ]
+    ))
+  return submit
+
+def callpage():
+  async def submit(request: Request):
+    func = request.query_params.get(QUERY_FUNCTION)
+    if func == FUNCTION_LOGOUT:
+      clear_session(request)
+      return HTMLResponse(YOU_ARE_LOGGED_OUT)
+    elif func == FUNCTION_SELECT:
+      return HTMLResponse(select_user_page(request))
+    elif func == FUNCTION_INSERT:
+      if request.method == 'GET':
+        return HTMLResponse(insert_user_page(request))
+      else:
+        form = await request.form()
+        email = form.get('email')
+        name = form.get('name')
+        insert = insert_user_page(request, email=email, name=name)
+        if insert == CALLBACK: return RedirectResponse(url='/call?function=select')
+        return HTMLResponse(insert)
+    elif func == FUNCTION_DELETE:
+      if request.method == 'GET':
+        return HTMLResponse(delete_user_page(request))
+      else:
+        form = await request.form()
+        emails = form.getlist('selects')
+        delete = delete_user_page(request, emails=emails)
+        if delete == CALLBACK: return RedirectResponse(url='/call?function=select')
+        return HTMLResponse(delete)
+    else:
+      return HTMLResponse('Not found')
+  return submit
+
+def modify_session(request, at=None, su=None):
+  request.session[ACCESS_TOKEN] = at
+  request.session[SESSION_USER] = su
+
+def clear_session(request):
+  modify_session(request, None, None)
+
+def check_login(request) -> bool:
+  at = request.session.get(ACCESS_TOKEN)
+  su = request.session.get(SESSION_USER)
+  if not at: return False
+  if not verify_access_token(at, su):
+    clear_session(request)
+    return False
+  return True
+
+def loginpage():
+  async def submit(request: Request):
+    if request.method == 'GET':
+      return HTMLResponse(login_page())
+    else:
+      form = await request.form()
+      email = form.get('email')
+      code = form.get('code')
+      if verify_login_code(email, code) and lower(email) in ADMIN_AUTHENTICATOR_EMAIL_LIST:
+        modify_session(request, at=generate_access_token(email), su=email)
+        return RedirectResponse(url='/')
+      else:
+        clear_session(request)
+        return HTMLResponse(YOU_COULD_NOT_LOG_IN)
+  return submit
+
+def login_page() -> str:
+  return Template(APP_TMP_SINGLE_FORM_PAGE).render(
+    APP_CHARSET=APP_CHARSET,
+    APP_VIEWPORT=APP_VIEWPORT,
+    APP_TITLE=APP_DESC,
+    FORM_TITLE=LOGIN_TITLE+home_button(),
+    FORM_ACTION='/login',
+    FORM_INPUT_PARAMS=html_fieldset(LABEL_LOGIN_PARAMS, html_input_texts(["email", "code"], [LABEL_USER_EMAIL, LABEL_AUTH_CODE])),
+    STYLE_SUBMIT_BUTTON=STYLE_SUBMIT_BUTTON,
+    LABEL_SUBMIT_BUTTON=LABEL_LOGIN_BUTTON,
+    STYLE_CANCEL_BUTTON=STYLE_CANCEL_BUTTON,
+    LABEL_CANCEL_BUTTON=LABEL_CANCEL_BUTTON)
+
+def users_listing_page(content: str) -> str:
+  return Template(APP_TMP_SIMPLE_PAGE).render(
+    APP_CHARSET=APP_CHARSET,
+    APP_VIEWPORT=APP_VIEWPORT,
+    APP_TITLE=APP_DESC,
+    FORM_TITLE=USERS_LISTING_TITLE+home_button(),
+    FORM_BODY=content)
+
+def users_updating_page(content: str) -> str:
+  return Template(APP_TMP_SINGLE_FORM_PAGE).render(
+    APP_CHARSET=APP_CHARSET,
+    APP_VIEWPORT=APP_VIEWPORT,
+    APP_TITLE=APP_DESC,
+    FORM_TITLE=USERS_UPDATING_TITLE+home_button(),
+    FORM_INPUT_PARAMS=content,
+    STYLE_SUBMIT_BUTTON=STYLE_CANCEL_BUTTON,
+    LABEL_SUBMIT_BUTTON=LABEL_DELETE_BUTTON,
+    STYLE_CANCEL_BUTTON=STYLE_SUBMIT_BUTTON,
+    LABEL_CANCEL_BUTTON=LABEL_CANCEL_BUTTON)
+
+def users_creating_page() -> str:
+  return Template(APP_TMP_SINGLE_FORM_PAGE).render(
+    APP_CHARSET=APP_CHARSET,
+    APP_VIEWPORT=APP_VIEWPORT,
+    APP_TITLE=APP_DESC,
+    FORM_TITLE=USERS_CREATING_TITLE+home_button(),
+    FORM_ACTION='/call?function=insert',
+    FORM_INPUT_PARAMS=html_fieldset(LABEL_INPUT_PARAMS, html_input_texts(["name", "email"], [LABEL_USER_NAME, LABEL_USER_EMAIL])),
+    STYLE_SUBMIT_BUTTON=STYLE_SUBMIT_BUTTON,
+    LABEL_SUBMIT_BUTTON=LABEL_SUBMIT_BUTTON,
+    STYLE_CANCEL_BUTTON=STYLE_CANCEL_BUTTON,
+    LABEL_CANCEL_BUTTON=LABEL_CANCEL_BUTTON)
+
+def select_user_page(request) -> str:
+  if not check_login(request): return YOU_HAVE_TO_LOG_IN
+  return users_listing_page(list_all_setup_users())
+
+def insert_user_page(request, email: str=None, name: str=None) -> str:
+  if not check_login(request): return YOU_HAVE_TO_LOG_IN
+  if not email and not name:
+    return users_creating_page()
+  elif not email or not name:
+    return MISSING_INPUT_DATA
+  elif check_setup_key_exist(email):
+    return KEY_ALREADY_EXISTS
+  else:
+    insert = insert_setup_user(email=email, name=name)
+    if not insert: return FAILED_SAVE_DATA
+    return CALLBACK
+
+def delete_user_page(request, emails: list=None) -> str:
+  if not check_login(request): return YOU_HAVE_TO_LOG_IN
+  if not emails:
+    return users_updating_page(list_all_setup_users(show=[HEADER_SELECT_OPTION, 'name', 'email'], select=True))
+  else:
+    delete = delete_setup_users(emails)
+    if not delete: return FAILED_SAVE_DATA
+    return CALLBACK

skadd-1.0.0.dist-info/METADATA

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: skadd
+Version: 1.0.0
+Summary: User [with Setup Key] Creating Tool
+Home-page: https://github.com/asinerum/skadd
+Author: Asinerum Conlang Project
+Author-email: asinerum.com@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: python-multipart>=0.0.29
+Requires-Dist: starlette>=0.50.0
+Requires-Dist: uvicorn>=0.38.0
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: tagrepo>=1.0.5
+Requires-Dist: tier2>=1.0.6
+Requires-Dist: pavro>=1.0.2
+Requires-Dist: skgen>=1.0.2
+Requires-Dist: uvia>=1.0.2
+Requires-Dist: vapp>=1.0.4
+Dynamic: license-file
+
+# User [with Setup Key] Creating Tool
+
+## Purpose
+- This tiny tool (working as a web daemon) helps people to manage their small community of users.  
+- The users are created manually by an administrator, and about to receive emails with their secret setup keys which can be added to modern authenticator apps.  
+- After being created, a new user can log in the community portal with TOTP authenticator code.  
+- The tool includes: user listing, creating, deleting routines. The user-creating routine allows administrators add new user name and email, then automatically send notification email.  
+- The automatic email sending uses Google mail API under administrators Gmail account.  
+
+## Installation
+```bash
+pip install skadd
+```
+
+## Sample Usage
+```bash
+## nano skadd.sh
+export JWT_SECRET="very-strong-password"
+export TOKEN_EXPIRE_MINUTES=30
+export ADMIN_AUTHENTICATOR_EMAIL_LIST="EMAIL_LIST_SEPARATED_BY_COMMA"
+export SENDER_GMAIL_ADDRESS="YOUR_WORKING_GMAIL_ADDRESS"
+export SENDER_GMAIL_APP_PWD="YOUR_WORKING_GMAIL_APP_PWD"
+export FILE_AVRO_DATA="./users/setupkeys.avro"
+uvia -a vapp -m skadd [-p <PORT> [-H <HOST>]]
+## The <PORT> is 21058 by default, but can be edited
+## The <HOST> should be 127.0.0.1 for secutiry reason
+## chmod +x skadd.sh
+## ./skadd.sh
+```
+
+Detailed tips, tricks, and examples, can be found at project's repository
+https://github.com/asinerum/skadd
+
+(C) 2026 Asinerum Conlang Project

skadd-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+skadd/__init__.py,sha256=_b7ixK7mStMV1ih0Jho37A45XXT5gn1YrcpuhdXWQdE,45
+skadd/add.py,sha256=z9qbFxu6i8zfnZMWrRg0VmZW98pA1H6vxvud0B8p1nA,11469
+skadd-1.0.0.dist-info/licenses/LICENSE,sha256=4npUbkrpgB6lqMiYYeUxZAP4SOkjVSwK8-7jW60mxvw,1081
+skadd-1.0.0.dist-info/METADATA,sha256=PsmmplC7Ssy9BDqXRWsx8R9K1yifwuumasKraL3VO5w,2288
+skadd-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+skadd-1.0.0.dist-info/top_level.txt,sha256=56rwI2vQF-EOfUD9PaDA_MjRgBhqxaEDEbQCd8XfgIg,6
+skadd-1.0.0.dist-info/RECORD,,

skadd-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

skadd-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asinerum Conlang Project
+
+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.

skadd-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+skadd