Antoine Vandevenne (anv)andLucie Van Nieuwenhuyze
54fa480c2e
Before this commit, it was not possible for a Buckaroo acquirer to accept asynchronous notifications for payment updates. This is important because, without them, an acquirer can only rely on synchronous notifications (i.e. redirect requests from the provider's checkout page) which can be unreliable and do not allow receiving status updates, should payments take a bit longer to be confirmed by the provider. This commit adds a webhook controller whose route can be configured in Buckaroo Plaza (backend) to send asynchronous notifications. task-2687586 closes odoo/odoo#82922 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Lucie Van Nieuwenhuyze <luvn@odoo.com>
112 lines
5.1 KiB
Python
112 lines
5.1 KiB
Python
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import hmac
|
|
import logging
|
|
import pprint
|
|
|
|
from werkzeug.exceptions import Forbidden
|
|
|
|
from odoo import http
|
|
from odoo.exceptions import ValidationError
|
|
from odoo.http import request
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
|
|
class BuckarooController(http.Controller):
|
|
_return_url = '/payment/buckaroo/return'
|
|
_webhook_url = '/payment/buckaroo/webhook'
|
|
|
|
@http.route(
|
|
_return_url, type='http', auth='public', methods=['POST'], csrf=False, save_session=False
|
|
)
|
|
def buckaroo_return_from_checkout(self, **raw_data):
|
|
""" Process the notification data sent by Buckaroo after redirection from checkout.
|
|
|
|
The route is flagged with `save_session=False` to prevent Odoo from assigning a new session
|
|
to the user if they are redirected to this route with a POST request. Indeed, as the session
|
|
cookie is created without a `SameSite` attribute, some browsers that don't implement the
|
|
recommended default `SameSite=Lax` behavior will not include the cookie in the redirection
|
|
request from the payment provider to Odoo. As the redirection to the '/payment/status' page
|
|
will satisfy any specification of the `SameSite` attribute, the session of the user will be
|
|
retrieved and with it the transaction which will be immediately post-processed.
|
|
|
|
:param dict raw_data: The un-formatted notification data
|
|
"""
|
|
_logger.info("handling redirection from Buckaroo with data:\n%s", pprint.pformat(raw_data))
|
|
data = self._normalize_data_keys(raw_data)
|
|
|
|
# Check the integrity of the notification
|
|
received_signature = data.get('brq_signature')
|
|
tx_sudo = request.env['payment.transaction'].sudo()._get_tx_from_feedback_data(
|
|
'buckaroo', data
|
|
)
|
|
self._verify_notification_signature(raw_data, received_signature, tx_sudo)
|
|
|
|
# Handle the notification data
|
|
request.env['payment.transaction'].sudo()._handle_feedback_data('buckaroo', data)
|
|
return request.redirect('/payment/status')
|
|
|
|
@http.route(_webhook_url, type='http', auth='public', methods=['POST'], csrf=False)
|
|
def buckaroo_webhook(self, **raw_data):
|
|
""" Process the notification data sent by Buckaroo to the webhook.
|
|
|
|
See https://www.pronamic.nl/wp-content/uploads/2013/04/BPE-3.0-Gateway-HTML.1.02.pdf.
|
|
|
|
:param dict raw_data: The un-formatted notification data
|
|
:return: An empty string to acknowledge the notification
|
|
:rtype: str
|
|
"""
|
|
_logger.info("notification received from Buckaroo with data:\n%s", pprint.pformat(raw_data))
|
|
data = self._normalize_data_keys(raw_data)
|
|
try:
|
|
# Check the integrity of the notification
|
|
received_signature = data.get('brq_signature')
|
|
tx_sudo = request.env['payment.transaction'].sudo()._get_tx_from_feedback_data(
|
|
'buckaroo', data
|
|
)
|
|
self._verify_notification_signature(raw_data, received_signature, tx_sudo)
|
|
|
|
# Handle the notification data
|
|
request.env['payment.transaction'].sudo()._handle_feedback_data('buckaroo', data)
|
|
except ValidationError: # Acknowledge the notification to avoid getting spammed
|
|
_logger.exception("unable to handle the notification data; skipping to acknowledge")
|
|
return ''
|
|
|
|
@staticmethod
|
|
def _normalize_data_keys(data):
|
|
""" Set all keys of a dictionary to lower-case.
|
|
|
|
As Buckaroo parameters names are case insensitive, we can convert everything to lower-case
|
|
to easily detected the presence of a parameter by checking the lower-case key only.
|
|
|
|
:param dict data: The dictionary whose keys must be set to lower-case
|
|
:return: A copy of the original data with all keys set to lower-case
|
|
:rtype: dict
|
|
"""
|
|
return {key.lower(): val for key, val in data.items()}
|
|
|
|
@staticmethod
|
|
def _verify_notification_signature(notification_data, received_signature, tx_sudo):
|
|
""" Check that the received signature matches the expected one.
|
|
|
|
:param dict notification_data: The notification data
|
|
:param str received_signature: The signature received with the notification data
|
|
:param recordset tx_sudo: The sudoed transaction referenced by the notification data, as a
|
|
`payment.transaction` record
|
|
:return: None
|
|
:raise: :class:`werkzeug.exceptions.Forbidden` if the signatures don't match
|
|
"""
|
|
# Check for the received signature
|
|
if not received_signature:
|
|
_logger.warning("received notification with missing signature")
|
|
raise Forbidden()
|
|
|
|
# Compare the received signature with the expected signature computed from the data
|
|
expected_signature = tx_sudo.acquirer_id._buckaroo_generate_digital_sign(
|
|
notification_data, incoming=True
|
|
)
|
|
if not hmac.compare_digest(received_signature, expected_signature):
|
|
_logger.warning("received notification with invalid signature")
|
|
raise Forbidden()
|