|
| 1 | +# Copyright 2025 Akretion (http://www.akretion.com). |
| 2 | +# @author Florian Mounier <florian.mounier@akretion.com> |
| 3 | +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). |
| 4 | + |
| 5 | +import re |
| 6 | +from typing import Annotated |
| 7 | + |
| 8 | +import requests |
| 9 | +from starlette.middleware import Middleware |
| 10 | + |
| 11 | +from odoo import api, fields, models |
| 12 | +from odoo.exceptions import AccessError, UserError, ValidationError |
| 13 | + |
| 14 | +from fastapi import Depends, Header |
| 15 | + |
| 16 | +from ..captcha_middleware import CaptchaMiddleware |
| 17 | + |
| 18 | + |
| 19 | +class FastapiEndpoint(models.Model): |
| 20 | + _inherit = "fastapi.endpoint" |
| 21 | + |
| 22 | + use_captcha = fields.Boolean( |
| 23 | + help="If checked, this endpoint will be protected by a captcha", |
| 24 | + ) |
| 25 | + |
| 26 | + captcha_type = fields.Selection( |
| 27 | + [ |
| 28 | + ("recaptcha", "Recaptcha"), |
| 29 | + ("hcaptcha", "Hcaptcha"), |
| 30 | + ("altcha", "Altcha"), |
| 31 | + ], |
| 32 | + help="Type of captcha to use for this endpoint", |
| 33 | + ) |
| 34 | + |
| 35 | + captcha_secret_key = fields.Char( |
| 36 | + help="Secret key to use for the captcha validation", |
| 37 | + groups="base.group_system", |
| 38 | + ) |
| 39 | + |
| 40 | + captcha_routes_regex = fields.Char( |
| 41 | + help="Regexes to match against routes url that should be protected " |
| 42 | + "by this captcha, comma separated. If empty, all routes will be protected", |
| 43 | + ) |
| 44 | + |
| 45 | + captcha_minimum_score = fields.Float( |
| 46 | + default=0.5, |
| 47 | + help="Minimum score to accept the captcha if a score is provided by the " |
| 48 | + "captcha service.", |
| 49 | + ) |
| 50 | + |
| 51 | + captcha_custom_verify_url = fields.Char( |
| 52 | + help="Custom URL to use for the captcha verification", |
| 53 | + ) |
| 54 | + |
| 55 | + @property |
| 56 | + def _server_env_fields(self): |
| 57 | + fields = getattr(super(), "_server_env_fields", None) or {} |
| 58 | + fields["captcha_secret_key"] = {} |
| 59 | + return fields |
| 60 | + |
| 61 | + @api.constrains("captcha_routes_regex") |
| 62 | + def _check_captcha_routes_regex(self): |
| 63 | + """Check that the captcha routes regex is valid""" |
| 64 | + for record in self: |
| 65 | + if record.captcha_routes_regex: |
| 66 | + for rex in record.captcha_routes_regex.split(","): |
| 67 | + rex = rex.strip() |
| 68 | + if not rex: |
| 69 | + continue |
| 70 | + # Check that the regex is valid |
| 71 | + try: |
| 72 | + re.compile(rex) |
| 73 | + except re.error as e: |
| 74 | + raise ValidationError( |
| 75 | + self.env._( |
| 76 | + "Invalid regex for captcha routes: %(regex)s " |
| 77 | + "(error: %(error)s)" |
| 78 | + ) |
| 79 | + % { |
| 80 | + "regex": rex, |
| 81 | + "error": str(e), |
| 82 | + } |
| 83 | + ) from e |
| 84 | + |
| 85 | + def _get_fastapi_app_middlewares(self): |
| 86 | + # Add the captcha middleware to the list of middlewares if enabled |
| 87 | + middlewares = super()._get_fastapi_app_middlewares() |
| 88 | + if self.use_captcha: |
| 89 | + middlewares.append( |
| 90 | + Middleware( |
| 91 | + CaptchaMiddleware, |
| 92 | + endpoint_id=self.id, |
| 93 | + root_path=self.root_path, |
| 94 | + routes_regex=[ |
| 95 | + re.compile(rex) for rex in self.captcha_routes_regex.split(",") |
| 96 | + ] |
| 97 | + if self.captcha_routes_regex |
| 98 | + else None, |
| 99 | + ) |
| 100 | + ) |
| 101 | + return middlewares |
| 102 | + |
| 103 | + def _get_fastapi_app_dependencies(self): |
| 104 | + # Add the captcha header to the list of dependencies |
| 105 | + dependencies = super()._get_fastapi_app_dependencies() |
| 106 | + if self.use_captcha: |
| 107 | + dependencies.append(Depends(captcha_token)) |
| 108 | + |
| 109 | + return dependencies |
| 110 | + |
| 111 | + def validate_captcha(self, captcha_response): |
| 112 | + """Validate the captcha response.""" |
| 113 | + secret_key = self.captcha_secret_key |
| 114 | + if not secret_key: |
| 115 | + raise UserError(self.env._("No secret key found for this endpoint")) |
| 116 | + |
| 117 | + if self.captcha_type == "recaptcha": |
| 118 | + return self._validate_recaptcha(captcha_response, secret_key) |
| 119 | + elif self.captcha_type == "hcaptcha": |
| 120 | + return self._validate_hcaptcha(captcha_response, secret_key) |
| 121 | + elif self.captcha_type == "altcha": |
| 122 | + return self._validate_altcha(captcha_response, secret_key) |
| 123 | + |
| 124 | + def _validate_recaptcha(self, captcha_response, secret_key): |
| 125 | + """Validate the recaptcha response""" |
| 126 | + data = { |
| 127 | + "secret": secret_key, |
| 128 | + "response": captcha_response, |
| 129 | + } |
| 130 | + response = requests.post( |
| 131 | + "https://www.google.com/recaptcha/api/siteverify", |
| 132 | + data=data, |
| 133 | + timeout=10, |
| 134 | + ) |
| 135 | + result = response.json() |
| 136 | + success = result.get("success", False) |
| 137 | + if not success: |
| 138 | + error_codes = result.get("error-codes", ["?"]) |
| 139 | + raise AccessError( |
| 140 | + self.env._("Recaptcha validation failed: %s") % ", ".join(error_codes) |
| 141 | + ) |
| 142 | + score = result.get("score", 1) |
| 143 | + if score < self.captcha_minimum_score: |
| 144 | + raise AccessError( |
| 145 | + self.env._( |
| 146 | + "Recaptcha validation failed: score %(score)s < %(min_score)s" |
| 147 | + ) |
| 148 | + % { |
| 149 | + "score": score, |
| 150 | + "min_score": self.captcha_minimum_score, |
| 151 | + } |
| 152 | + ) |
| 153 | + |
| 154 | + def _validate_hcaptcha(self, captcha_response, secret_key): |
| 155 | + """Validate the hcaptcha response""" |
| 156 | + |
| 157 | + data = { |
| 158 | + "secret": secret_key, |
| 159 | + "response": captcha_response, |
| 160 | + } |
| 161 | + response = requests.post( |
| 162 | + "https://api.hcaptcha.com/siteverify", data=data, timeout=10 |
| 163 | + ) |
| 164 | + result = response.json() |
| 165 | + success = result.get("success", False) |
| 166 | + if not success: |
| 167 | + error_codes = result.get("error-codes", ["?"]) |
| 168 | + raise AccessError( |
| 169 | + self.env._("Hcaptcha validation failed: %s") % ", ".join(error_codes) |
| 170 | + ) |
| 171 | + score = result.get("score", 1) |
| 172 | + if score < self.captcha_minimum_score: |
| 173 | + raise AccessError( |
| 174 | + self.env._( |
| 175 | + "Hcaptcha validation failed: score %(score)s < %(min_score)s " |
| 176 | + "(%(reason)s)" |
| 177 | + ) |
| 178 | + % { |
| 179 | + "score": score, |
| 180 | + "min_score": self.captcha_minimum_score, |
| 181 | + "reason": result.get("score_reason", ""), |
| 182 | + } |
| 183 | + ) |
| 184 | + |
| 185 | + def _validate_altcha(self, captcha_response, secret_key): |
| 186 | + """Validate the altcha response""" |
| 187 | + data = { |
| 188 | + "apiKey": secret_key, |
| 189 | + "payload": captcha_response, |
| 190 | + } |
| 191 | + url = ( |
| 192 | + self.captcha_custom_verify_url |
| 193 | + or "https://eu.altcha.org/api/v1/challenge/verify" |
| 194 | + ) |
| 195 | + response = requests.post(url, data=data, timeout=10) |
| 196 | + result = response.json() |
| 197 | + success = result.get("verified", False) |
| 198 | + if not success: |
| 199 | + error = result.get("error", "?") |
| 200 | + raise AccessError( |
| 201 | + self.env._("Altcha (%(url)s) validation failed: %(error)s") |
| 202 | + % {"url": url, "error": error} |
| 203 | + ) |
| 204 | + |
| 205 | + @api.model |
| 206 | + def _fastapi_app_fields(self): |
| 207 | + # We need to reload fastapi app when we change these captcha fields |
| 208 | + fields = super()._fastapi_app_fields() |
| 209 | + return [ |
| 210 | + "use_captcha", |
| 211 | + "captcha_routes_regex", |
| 212 | + ] + fields |
| 213 | + |
| 214 | + |
| 215 | +def captcha_token( |
| 216 | + captcha_token: Annotated[ |
| 217 | + str | None, |
| 218 | + Header( |
| 219 | + alias="X-Captcha-Token", |
| 220 | + description="The X-Captcha-Token header is used to specify the captcha ", |
| 221 | + ), |
| 222 | + ] = None, |
| 223 | +) -> str: |
| 224 | + return captcha_token |
0 commit comments