nacl.py 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. import base64
  2. import json
  3. import os
  4. import secrets
  5. import string
  6. from datetime import datetime, timedelta, timezone
  7. from typing import Optional, Tuple
  8. import jwt
  9. import nacl.encoding
  10. import nacl.exceptions
  11. import nacl.pwhash
  12. import nacl.signing
  13. from nacl.exceptions import BadSignatureError
  14. from nacl.pwhash import argon2i
  15. from core.base import CryptoConfig, CryptoProvider
  16. DEFAULT_NACL_SECRET_KEY = "wNFbczH3QhUVcPALwtWZCPi0lrDlGV3P1DPRVEQCPbM" # Replace or load from env or secrets manager
  17. def encode_bytes_readable(random_bytes: bytes, chars: str) -> str:
  18. """Convert random bytes to a readable string using the given character set."""
  19. # Each byte gives us 8 bits of randomness
  20. # We use modulo to map each byte to our character set
  21. result = []
  22. for byte in random_bytes:
  23. # Use modulo to map the byte (0-255) to our character set length
  24. idx = byte % len(chars)
  25. result.append(chars[idx])
  26. return "".join(result)
  27. class NaClCryptoConfig(CryptoConfig):
  28. provider: str = "nacl"
  29. # Interactive parameters for password ops (fast)
  30. ops_limit: int = argon2i.OPSLIMIT_MIN
  31. mem_limit: int = argon2i.MEMLIMIT_MIN
  32. # Sensitive parameters for API key generation (slow but more secure)
  33. api_ops_limit: int = argon2i.OPSLIMIT_INTERACTIVE
  34. api_mem_limit: int = argon2i.MEMLIMIT_INTERACTIVE
  35. api_key_bytes: int = 32
  36. secret_key: Optional[str] = None
  37. class NaClCryptoProvider(CryptoProvider):
  38. def __init__(self, config: NaClCryptoConfig):
  39. if not isinstance(config, NaClCryptoConfig):
  40. raise ValueError(
  41. "NaClCryptoProvider must be initialized with a NaClCryptoConfig"
  42. )
  43. super().__init__(config)
  44. self.config: NaClCryptoConfig = config
  45. # Securely load the secret key for JWT
  46. # Priority: config.secret_key > environment variable > default
  47. self.secret_key = (
  48. config.secret_key
  49. or os.getenv("R2R_SECRET_KEY")
  50. or DEFAULT_NACL_SECRET_KEY
  51. )
  52. def get_password_hash(self, password: str) -> str:
  53. password_bytes = password.encode("utf-8")
  54. hashed = nacl.pwhash.argon2i.str(
  55. password_bytes,
  56. opslimit=self.config.ops_limit,
  57. memlimit=self.config.mem_limit,
  58. )
  59. return base64.b64encode(hashed).decode("utf-8")
  60. def verify_password(
  61. self, plain_password: str, hashed_password: str
  62. ) -> bool:
  63. try:
  64. stored_hash = base64.b64decode(hashed_password.encode("utf-8"))
  65. nacl.pwhash.verify(stored_hash, plain_password.encode("utf-8"))
  66. return True
  67. except nacl.exceptions.InvalidkeyError:
  68. return False
  69. def generate_verification_code(self, length: int = 32) -> str:
  70. random_bytes = nacl.utils.random(length)
  71. return base64.urlsafe_b64encode(random_bytes)[:length].decode("utf-8")
  72. def generate_api_key(self) -> Tuple[str, str]:
  73. # Define our character set (excluding ambiguous characters)
  74. chars = string.ascii_letters.replace("l", "").replace("I", "").replace(
  75. "O", ""
  76. ) + string.digits.replace("0", "").replace("1", "")
  77. # Generate a unique key_id
  78. key_id_bytes = nacl.utils.random(16) # 16 random bytes
  79. key_id = f"sk_{encode_bytes_readable(key_id_bytes, chars)}"
  80. # Generate a high-entropy API key
  81. raw_api_key = encode_bytes_readable(
  82. nacl.utils.random(self.config.api_key_bytes), chars
  83. )
  84. # The caller will store the hashed version in the database
  85. return key_id, raw_api_key
  86. def hash_api_key(self, raw_api_key: str) -> str:
  87. hashed = nacl.pwhash.argon2i.str(
  88. raw_api_key.encode("utf-8"),
  89. opslimit=self.config.api_ops_limit,
  90. memlimit=self.config.api_mem_limit,
  91. )
  92. return base64.b64encode(hashed).decode("utf-8")
  93. def verify_api_key(self, raw_api_key: str, hashed_key: str) -> bool:
  94. try:
  95. stored_hash = base64.b64decode(hashed_key.encode("utf-8"))
  96. nacl.pwhash.verify(stored_hash, raw_api_key.encode("utf-8"))
  97. return True
  98. except nacl.exceptions.InvalidkeyError:
  99. return False
  100. def sign_request(self, private_key: str, data: str) -> str:
  101. try:
  102. key_bytes = base64.b64decode(private_key)
  103. signing_key = nacl.signing.SigningKey(key_bytes)
  104. signature = signing_key.sign(data.encode())
  105. return base64.b64encode(signature.signature).decode()
  106. except Exception as e:
  107. raise ValueError(f"Invalid private key or signing error: {str(e)}")
  108. def verify_request_signature(
  109. self, public_key: str, signature: str, data: str
  110. ) -> bool:
  111. try:
  112. key_bytes = base64.b64decode(public_key)
  113. verify_key = nacl.signing.VerifyKey(key_bytes)
  114. signature_bytes = base64.b64decode(signature)
  115. verify_key.verify(data.encode(), signature_bytes)
  116. return True
  117. except (BadSignatureError, ValueError):
  118. return False
  119. def generate_secure_token(self, data: dict, expiry: datetime) -> str:
  120. """
  121. Generate a secure token using JWT with HS256.
  122. The secret_key is used for symmetrical signing.
  123. """
  124. now = datetime.now(timezone.utc)
  125. to_encode = {
  126. **data,
  127. "exp": expiry.timestamp(),
  128. "iat": now.timestamp(),
  129. "nbf": now.timestamp(),
  130. "jti": base64.urlsafe_b64encode(nacl.utils.random(16)).decode(),
  131. "nonce": base64.urlsafe_b64encode(nacl.utils.random(16)).decode(),
  132. }
  133. return jwt.encode(to_encode, self.secret_key, algorithm="HS256")
  134. def verify_secure_token(self, token: str) -> Optional[dict]:
  135. """
  136. Verify a secure token using the shared secret_key and JWT.
  137. """
  138. try:
  139. payload = jwt.decode(token, self.secret_key, algorithms=["HS256"])
  140. exp = payload.get("exp")
  141. if exp is None or datetime.fromtimestamp(
  142. exp, tz=timezone.utc
  143. ) < datetime.now(timezone.utc):
  144. return None
  145. return payload
  146. except (jwt.ExpiredSignatureError, jwt.InvalidTokenError):
  147. return None
  148. def generate_signing_keypair(self) -> Tuple[str, str, str]:
  149. signing_key = nacl.signing.SigningKey.generate()
  150. private_key_b64 = base64.b64encode(signing_key.encode()).decode()
  151. public_key_b64 = base64.b64encode(
  152. signing_key.verify_key.encode()
  153. ).decode()
  154. # Generate a unique key_id
  155. key_id_bytes = nacl.utils.random(16)
  156. key_id = f"sign_{base64.urlsafe_b64encode(key_id_bytes).decode()}"
  157. return (key_id, private_key_b64, public_key_b64)