mirror of
https://github.com/onyx-dot-app/onyx.git
synced 2026-10-23 03:42:59 -05:00
rkuo-danswerandRichard Kuo
f15d6d2b59
* allow admin role api keys * bump to rerun deployment * types needs explicit export now for APIKey * remove api_key.role, use User.role instead * fix formatting * formatting * formatting --------- Co-authored-by: Richard Kuo <rkuo@rkuo.com>
54 lines
1.4 KiB
Python
54 lines
1.4 KiB
Python
import secrets
|
|
import uuid
|
|
|
|
from fastapi import Request
|
|
from passlib.hash import sha256_crypt
|
|
from pydantic import BaseModel
|
|
|
|
from danswer.auth.schemas import UserRole
|
|
from ee.danswer.configs.app_configs import API_KEY_HASH_ROUNDS
|
|
|
|
|
|
_API_KEY_HEADER_NAME = "Authorization"
|
|
_BEARER_PREFIX = "Bearer "
|
|
_API_KEY_PREFIX = "dn_"
|
|
_API_KEY_LEN = 192
|
|
|
|
|
|
class ApiKeyDescriptor(BaseModel):
|
|
api_key_id: int
|
|
api_key_display: str
|
|
api_key: str | None = None # only present on initial creation
|
|
api_key_name: str | None = None
|
|
api_key_role: UserRole
|
|
|
|
user_id: uuid.UUID
|
|
|
|
|
|
def generate_api_key() -> str:
|
|
return _API_KEY_PREFIX + secrets.token_urlsafe(_API_KEY_LEN)
|
|
|
|
|
|
def hash_api_key(api_key: str) -> str:
|
|
# NOTE: no salt is needed, as the API key is randomly generated
|
|
# and overlaps are impossible
|
|
return sha256_crypt.hash(api_key, salt="", rounds=API_KEY_HASH_ROUNDS)
|
|
|
|
|
|
def build_displayable_api_key(api_key: str) -> str:
|
|
if api_key.startswith(_API_KEY_PREFIX):
|
|
api_key = api_key[len(_API_KEY_PREFIX) :]
|
|
|
|
return _API_KEY_PREFIX + api_key[:4] + "********" + api_key[-4:]
|
|
|
|
|
|
def get_hashed_api_key_from_request(request: Request) -> str | None:
|
|
raw_api_key_header = request.headers.get(_API_KEY_HEADER_NAME)
|
|
if raw_api_key_header is None:
|
|
return None
|
|
|
|
if raw_api_key_header.startswith(_BEARER_PREFIX):
|
|
raw_api_key_header = raw_api_key_header[len(_BEARER_PREFIX) :].strip()
|
|
|
|
return hash_api_key(raw_api_key_header)
|