nacl.py 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. import base64
  2. import logging
  3. import os
  4. import string
  5. from datetime import datetime, timezone
  6. from typing import Optional, Tuple
  7. import jwt
  8. import nacl.encoding
  9. import nacl.exceptions
  10. import nacl.pwhash
  11. import nacl.signing
  12. from nacl.exceptions import BadSignatureError
  13. from nacl.pwhash import argon2i
  14. from core.base import CryptoConfig, CryptoProvider
  15. DEFAULT_NACL_SECRET_KEY = "wNFbczH3QhUVcPALwtWZCPi0lrDlGV3P1DPRVEQCPbM" # Replace or load from env or secrets manager
  16. def encode_bytes_readable(random_bytes: bytes, chars: str) -> str:
  17. """Convert random bytes to a readable string using the given character
  18. 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. logging.info("Initializing NaClCryptoProvider")
  46. # Securely load the secret key for JWT
  47. # Priority: config.secret_key > environment variable > default
  48. self.secret_key = (
  49. config.secret_key
  50. or os.getenv("R2R_SECRET_KEY")
  51. or DEFAULT_NACL_SECRET_KEY
  52. )
  53. def get_password_hash(self, password: str) -> str:
  54. password_bytes = password.encode("utf-8")
  55. hashed = nacl.pwhash.argon2i.str(
  56. password_bytes,
  57. opslimit=self.config.ops_limit,
  58. memlimit=self.config.mem_limit,
  59. )
  60. return base64.b64encode(hashed).decode("utf-8")
  61. def verify_password(
  62. self, plain_password: str, hashed_password: str
  63. ) -> bool:
  64. try:
  65. stored_hash = base64.b64decode(hashed_password.encode("utf-8"))
  66. nacl.pwhash.verify(stored_hash, plain_password.encode("utf-8"))
  67. return True
  68. except nacl.exceptions.InvalidkeyError:
  69. return False
  70. def generate_verification_code(self, length: int = 32) -> str:
  71. random_bytes = nacl.utils.random(length)
  72. return base64.urlsafe_b64encode(random_bytes)[:length].decode("utf-8")
  73. def generate_api_key(self) -> Tuple[str, str]:
  74. # Define our character set (excluding ambiguous characters)
  75. chars = string.ascii_letters.replace("l", "").replace("I", "").replace(
  76. "O", ""
  77. ) + string.digits.replace("0", "").replace("1", "")
  78. # Generate a unique key_id
  79. key_id_bytes = nacl.utils.random(16) # 16 random bytes
  80. key_id = f"pk_{encode_bytes_readable(key_id_bytes, chars)}"
  81. # Generate a high-entropy API key
  82. raw_api_key = f"sk_{encode_bytes_readable(nacl.utils.random(self.config.api_key_bytes), chars)}"
  83. # The caller will store the hashed version in the database
  84. return key_id, raw_api_key
  85. def hash_api_key(self, raw_api_key: str) -> str:
  86. hashed = nacl.pwhash.argon2i.str(
  87. raw_api_key.encode("utf-8"),
  88. opslimit=self.config.api_ops_limit,
  89. memlimit=self.config.api_mem_limit,
  90. )
  91. return base64.b64encode(hashed).decode("utf-8")
  92. def verify_api_key(self, raw_api_key: str, hashed_key: str) -> bool:
  93. try:
  94. stored_hash = base64.b64decode(hashed_key.encode("utf-8"))
  95. nacl.pwhash.verify(stored_hash, raw_api_key.encode("utf-8"))
  96. return True
  97. except nacl.exceptions.InvalidkeyError:
  98. return False
  99. def sign_request(self, private_key: str, data: str) -> str:
  100. try:
  101. key_bytes = base64.b64decode(private_key)
  102. signing_key = nacl.signing.SigningKey(key_bytes)
  103. signature = signing_key.sign(data.encode())
  104. return base64.b64encode(signature.signature).decode()
  105. except Exception as e:
  106. raise ValueError(
  107. f"Invalid private key or signing error: {str(e)}"
  108. ) from e
  109. def verify_request_signature(
  110. self, public_key: str, signature: str, data: str
  111. ) -> bool:
  112. try:
  113. key_bytes = base64.b64decode(public_key)
  114. verify_key = nacl.signing.VerifyKey(key_bytes)
  115. signature_bytes = base64.b64decode(signature)
  116. verify_key.verify(data.encode(), signature_bytes)
  117. return True
  118. except (BadSignatureError, ValueError):
  119. return False
  120. def generate_secure_token(self, data: dict, expiry: datetime) -> str:
  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. """Verify a secure token using the shared secret_key and JWT."""
  136. try:
  137. payload = jwt.decode(token, self.secret_key, algorithms=["HS256"])
  138. exp = payload.get("exp")
  139. if exp is None or datetime.fromtimestamp(
  140. exp, tz=timezone.utc
  141. ) < datetime.now(timezone.utc):
  142. return None
  143. return payload
  144. except (jwt.ExpiredSignatureError, jwt.InvalidTokenError):
  145. return None
  146. def generate_signing_keypair(self) -> Tuple[str, str, str]:
  147. signing_key = nacl.signing.SigningKey.generate()
  148. private_key_b64 = base64.b64encode(signing_key.encode()).decode()
  149. public_key_b64 = base64.b64encode(
  150. signing_key.verify_key.encode()
  151. ).decode()
  152. # Generate a unique key_id
  153. key_id_bytes = nacl.utils.random(16)
  154. key_id = f"sign_{base64.urlsafe_b64encode(key_id_bytes).decode()}"
  155. return (key_id, private_key_b64, public_key_b64)