2021-06-07 22:12:23 +02:00
|
|
|
#!/usr/bin/env python3
|
|
|
|
|
2024-01-13 01:24:32 +01:00
|
|
|
from __future__ import annotations
|
|
|
|
|
2021-06-07 22:12:23 +02:00
|
|
|
import hashlib
|
2021-06-17 02:36:01 +02:00
|
|
|
import json
|
2021-06-07 22:12:23 +02:00
|
|
|
import os
|
2024-05-02 13:33:33 +02:00
|
|
|
import re
|
2024-05-14 18:52:26 +02:00
|
|
|
from functools import lru_cache, cache
|
2021-06-07 22:12:23 +02:00
|
|
|
from pathlib import Path
|
|
|
|
|
2024-01-26 15:03:36 +01:00
|
|
|
import flask_login # type: ignore[import-untyped]
|
2024-01-12 17:15:41 +01:00
|
|
|
from flask import Request
|
2021-06-07 22:12:23 +02:00
|
|
|
from werkzeug.security import generate_password_hash
|
|
|
|
|
2024-05-14 18:52:26 +02:00
|
|
|
from lookyloo import Lookyloo, Indexing
|
2021-10-18 13:06:43 +02:00
|
|
|
from lookyloo.default import get_config, get_homedir
|
2023-11-07 16:10:47 +01:00
|
|
|
|
|
|
|
__global_lookyloo_instance = None
|
|
|
|
|
|
|
|
|
|
|
|
def get_lookyloo_instance() -> Lookyloo:
|
|
|
|
global __global_lookyloo_instance
|
|
|
|
if __global_lookyloo_instance is None:
|
|
|
|
__global_lookyloo_instance = Lookyloo()
|
|
|
|
return __global_lookyloo_instance
|
2021-06-07 22:12:23 +02:00
|
|
|
|
|
|
|
|
2024-01-12 17:15:41 +01:00
|
|
|
def src_request_ip(request: Request) -> str | None:
|
2021-06-07 22:12:23 +02:00
|
|
|
# NOTE: X-Real-IP is the IP passed by the reverse proxy in the headers.
|
|
|
|
real_ip = request.headers.get('X-Real-IP')
|
|
|
|
if not real_ip:
|
|
|
|
real_ip = request.remote_addr
|
|
|
|
return real_ip
|
|
|
|
|
|
|
|
|
2024-01-12 17:15:41 +01:00
|
|
|
class User(flask_login.UserMixin): # type: ignore[misc]
|
2021-06-07 22:12:23 +02:00
|
|
|
pass
|
|
|
|
|
|
|
|
|
2024-01-12 17:15:41 +01:00
|
|
|
def load_user_from_request(request: Request) -> User | None:
|
2021-06-07 22:12:23 +02:00
|
|
|
api_key = request.headers.get('Authorization')
|
|
|
|
if not api_key:
|
|
|
|
return None
|
|
|
|
user = User()
|
|
|
|
api_key = api_key.strip()
|
|
|
|
keys_table = build_keys_table()
|
|
|
|
if api_key in keys_table:
|
|
|
|
user.id = keys_table[api_key]
|
|
|
|
return user
|
|
|
|
return None
|
|
|
|
|
2024-05-07 18:46:57 +02:00
|
|
|
|
2024-05-02 13:33:33 +02:00
|
|
|
def is_valid_username(username: str) -> bool:
|
2024-05-07 18:46:57 +02:00
|
|
|
return bool(re.match("^[A-Za-z0-9]+$", username))
|
|
|
|
|
2021-06-07 22:12:23 +02:00
|
|
|
|
|
|
|
@lru_cache(64)
|
2024-01-13 01:24:32 +01:00
|
|
|
def build_keys_table() -> dict[str, str]:
|
2021-06-07 22:12:23 +02:00
|
|
|
keys_table = {}
|
|
|
|
for username, authstuff in build_users_table().items():
|
|
|
|
if 'authkey' in authstuff:
|
|
|
|
keys_table[authstuff['authkey']] = username
|
|
|
|
return keys_table
|
|
|
|
|
|
|
|
|
|
|
|
@lru_cache(64)
|
2024-01-13 01:24:32 +01:00
|
|
|
def get_users() -> dict[str, str | list[str]]:
|
2021-06-07 22:12:23 +02:00
|
|
|
try:
|
|
|
|
# Use legacy user mgmt, no need to print a warning, and it will fail on new install.
|
|
|
|
return get_config('generic', 'cache_clean_user', quiet=True)
|
|
|
|
except Exception:
|
|
|
|
return get_config('generic', 'users')
|
|
|
|
|
|
|
|
|
|
|
|
@lru_cache(64)
|
2024-01-13 01:24:32 +01:00
|
|
|
def build_users_table() -> dict[str, dict[str, str]]:
|
|
|
|
users_table: dict[str, dict[str, str]] = {}
|
2021-06-07 22:12:23 +02:00
|
|
|
for username, authstuff in get_users().items():
|
2024-05-07 18:46:57 +02:00
|
|
|
if not is_valid_username(username):
|
|
|
|
raise Exception('Invalid username, can only contain characters and numbers.')
|
|
|
|
|
2021-06-07 22:12:23 +02:00
|
|
|
if isinstance(authstuff, str):
|
|
|
|
# just a password, make a key
|
|
|
|
users_table[username] = {}
|
|
|
|
users_table[username]['password'] = generate_password_hash(authstuff)
|
|
|
|
users_table[username]['authkey'] = hashlib.pbkdf2_hmac('sha256', get_secret_key(),
|
|
|
|
authstuff.encode(),
|
|
|
|
100000).hex()
|
|
|
|
|
|
|
|
elif isinstance(authstuff, list) and len(authstuff) == 2:
|
|
|
|
if isinstance(authstuff[0], str) and isinstance(authstuff[1], str) and len(authstuff[1]) == 64:
|
|
|
|
users_table[username] = {}
|
|
|
|
users_table[username]['password'] = generate_password_hash(authstuff[0])
|
|
|
|
users_table[username]['authkey'] = authstuff[1]
|
|
|
|
else:
|
|
|
|
raise Exception('User setup invalid. Must be "username": "password" or "username": ["password", "token 64 chars (sha256)"]')
|
|
|
|
return users_table
|
|
|
|
|
|
|
|
|
|
|
|
@lru_cache(64)
|
|
|
|
def get_secret_key() -> bytes:
|
|
|
|
secret_file_path: Path = get_homedir() / 'secret_key'
|
|
|
|
if not secret_file_path.exists() or secret_file_path.stat().st_size < 64:
|
|
|
|
if not secret_file_path.exists() or secret_file_path.stat().st_size < 64:
|
|
|
|
with secret_file_path.open('wb') as f:
|
|
|
|
f.write(os.urandom(64))
|
|
|
|
with secret_file_path.open('rb') as f:
|
|
|
|
return f.read()
|
2021-06-17 02:36:01 +02:00
|
|
|
|
|
|
|
|
|
|
|
@lru_cache(64)
|
2024-01-13 01:24:32 +01:00
|
|
|
def sri_load() -> dict[str, dict[str, str]]:
|
2021-06-17 02:36:01 +02:00
|
|
|
with (get_homedir() / 'website' / 'web' / 'sri.txt').open() as f:
|
|
|
|
return json.load(f)
|
2024-05-14 18:52:26 +02:00
|
|
|
|
|
|
|
|
|
|
|
@cache
|
|
|
|
def get_indexing(user: User | None) -> Indexing:
|
|
|
|
'''Depending if we're logged in or not, we (can) get different indexes:
|
|
|
|
if index_everything is enabled, we have an index in kvrocks that contains all
|
|
|
|
the indexes for all the captures.
|
|
|
|
It is only accessible to the admin user.
|
|
|
|
'''
|
|
|
|
if not get_config('generic', 'index_everything'):
|
|
|
|
return Indexing()
|
|
|
|
|
|
|
|
if not user or not user.is_authenticated:
|
|
|
|
# No user or anonymous
|
|
|
|
return Indexing()
|
|
|
|
# Logged in user
|
|
|
|
return Indexing(full_index=True)
|