mufassall

Konspekt · Aloqa

Webhook'larni ishonchli yuborish

14 daq · O'rta · mufassall.dtwin.uz/uz/l/webhooks/

← Darsni ochish

Muammo

To'lov servisi internet-do'konlarga to'lov o'tganini ularning URL manzilini chaqirib xabar qiladi: bu webhook. Uni to'lovlarni sekinlatmasdan qanday yuborish, do'kon chaqiruv haqiqiy va yangi ekanini qanday biladi va ikkala tomon takror urinishlar, dublikatlar, tartibsiz hodisalar va o'lik manzillardan qanday omon chiqadi.

Nimani o'rganasiz

  • Nega webhook to'lov so'rovi ichida emas, navbat va yuboruvchi orqali ketadi
  • Id, vaqt va tana ustidan HMAC imzo hamda qayta yuborishdan himoya
  • Kechikishi o'sib boruvchi takror urinishlar va tez javob beradigan idempotent qabul qiluvchi
  • Versiya bo'yicha tartib va kunlab javob bermaydigan manzillar
Yakuniy sahna
15%25%70%

Diagramma kod sifatida

Darsdagi yakuniy sxemani matn ko'rinishida oling va Jira, GitLab, GitHub, Notion yoki hujjatga qo'ying: Mermaid u yerlarda o'zi chiziladi. D2 va PlantUML (Confluence, IntelliJ) uchun alohida variantlar bor.

Mermaid: sxema

flowchart LR
  n_payments["To'lov API"]
  n_shop>"Do'kon serveri"]
  n_shopdb[("Do'kon bazasi")]
  n_queue[["Webhook navbati"]]
  n_sender("Yuboruvchi")
  n_oldshop>"O'lik manzil"]
  n_shop -->|"chaqiruv"| n_shopdb
  n_payments -->|"asinxron"| n_queue
  n_queue -->|"asinxron"| n_sender
  n_sender -->|"chaqiruv"| n_shop
  n_sender --x n_oldshop
  classDef down fill:#fde2e2,stroke:#c62828,color:#4a0d0d,stroke-dasharray:4 3
  class n_oldshop down

Mermaid: so'rovlar ketma-ketligi

sequenceDiagram
  participant n_payments as To'lov API
  participant n_shop as Do'kon serveri
  participant n_sender as Yuboruvchi
  actor n_attacker as Hujumchi
  participant n_shopdb as Do'kon bazasi
  participant n_oldshop as O'lik manzil
  Note over n_payments,n_shop: Webhook to'lov ichida yuboriladi
  n_payments->>n_shop: POST /hooks/payments HTTP/1.1
  n_shop-->>n_payments: HTTP/1.1 200 OK
  Note over n_sender,n_shop: Navbat va yuboruvchi webhook'ni to'lovdan chiqaradi
  n_sender->>n_shop: sender: deliver evt_9f2 to https://shop.example.com/hooks/payments
  n_shop-->>n_sender: HTTP/1.1 200 OK
  Note over n_attacker,n_shop: Do'konning webhook URL'ini istalgan odam chaqira oladi
  n_attacker->>n_shop: POST /hooks/payments HTTP/1.1
  n_shop-->>n_attacker: HTTP/1.1 200 OK
  Note over n_sender,n_shop: Har webhook HMAC bilan imzolanadi
  n_sender->>n_shop: POST /hooks/payments HTTP/1.1
  Note over n_attacker,n_shop: Haqiqiy so'rov, yana yuborilgan
  n_attacker->>n_shop: POST /hooks/payments (copied from a leaked proxy log)
  Note over n_attacker,n_shop: Imzolangan vaqt, vaqt oynasi va ko'rilgan id'lar ro'yxati
  n_attacker-xn_shop: shop: verify evt_9f2
  Note over n_sender,n_shop: Do'kon ishlamayapti: jadval bo'yicha qayta urinamiz
  n_sender->>n_shop: POST /hooks/payments HTTP/1.1
  n_shop-->>n_sender: HTTP/1.1 503 Service Unavailable
  Note over n_sender,n_shop: Sekin javob ikki baravar bonusga aylanadi
  n_sender->>n_shop: 10:00:00 deliver evt_9f2 attempt 1
  Note over n_shop,n_shopdb: Qabul qiluvchi: id'ni eslab qol, tez javob ber, keyin ishla
  n_shop->>n_shopdb: INSERT INTO webhook_inbox (webhook_id, received_at)
  n_shopdb-->>n_shop: HTTP/1.1 200 OK
  Note over n_sender,n_shop: Hodisalar tartibsiz keladi
  n_sender->>n_shop: POST /hooks/payments HTTP/1.1
  n_shop-->>n_sender: shop: payment pay_771 has version 2, applying 3
  Note over n_sender,n_oldshop: Hech qachon qaytmaydigan manzil
  n_sender->>n_oldshop: endpoint ep_311: failing for 5 days

D2

direction: right

n_payments: "To'lov API" {
  shape: rectangle
}
n_shop: "Do'kon serveri" {
  shape: cloud
}
n_shopdb: "Do'kon bazasi" {
  shape: cylinder
}
n_queue: "Webhook navbati" {
  shape: queue
}
n_sender: "Yuboruvchi" {
  shape: rectangle
  style.multiple: true
}
n_oldshop: "O'lik manzil" {
  shape: cloud
  style.fill: "#fde2e2"
  style.stroke: "#c62828"
  style.stroke-dash: 3
}

n_shop -> n_shopdb: "chaqiruv"
n_payments -> n_queue: "asinxron"
n_queue -> n_sender: "asinxron"
n_sender -> n_shop: "chaqiruv"
n_sender -> n_oldshop {
  target-arrowhead.shape: cross
}

PlantUML: so'rovlar ketma-ketligi

@startuml
participant "To'lov API" as n_payments
boundary "Do'kon serveri" as n_shop
participant "Yuboruvchi" as n_sender
actor "Hujumchi" as n_attacker
database "Do'kon bazasi" as n_shopdb
boundary "O'lik manzil" as n_oldshop
note over n_payments, n_shop : Webhook to'lov ichida yuboriladi
n_payments -> n_shop : POST /hooks/payments HTTP/1.1
n_shop --> n_payments : HTTP/1.1 200 OK
note over n_sender, n_shop : Navbat va yuboruvchi webhook'ni to'lovdan chiqaradi
n_sender -> n_shop : sender: deliver evt_9f2 to https://shop.example.com/hooks/payments
n_shop --> n_sender : HTTP/1.1 200 OK
note over n_attacker, n_shop : Do'konning webhook URL'ini istalgan odam chaqira oladi
n_attacker -> n_shop : POST /hooks/payments HTTP/1.1
n_shop --> n_attacker : HTTP/1.1 200 OK
note over n_sender, n_shop : Har webhook HMAC bilan imzolanadi
n_sender -> n_shop : POST /hooks/payments HTTP/1.1
note over n_attacker, n_shop : Haqiqiy so'rov, yana yuborilgan
n_attacker -> n_shop : [dublikat] POST /hooks/payments (copied from a leaked proxy log)
note over n_attacker, n_shop : Imzolangan vaqt, vaqt oynasi va ko'rilgan id'lar ro'yxati
n_attacker ->x n_shop : [yo'qoldi] shop: verify evt_9f2
note over n_sender, n_shop : Do'kon ishlamayapti: jadval bo'yicha qayta urinamiz
n_sender -> n_shop : [qayta urinish] POST /hooks/payments HTTP/1.1
n_shop --> n_sender : HTTP/1.1 503 Service Unavailable
note over n_sender, n_shop : Sekin javob ikki baravar bonusga aylanadi
n_sender -> n_shop : [dublikat] 10:00:00 deliver evt_9f2 attempt 1
note over n_shop, n_shopdb : Qabul qiluvchi: id'ni eslab qol, tez javob ber, keyin ishla
n_shop -> n_shopdb : INSERT INTO webhook_inbox (webhook_id, received_at)
n_shopdb --> n_shop : HTTP/1.1 200 OK
note over n_sender, n_shop : Hodisalar tartibsiz keladi
n_sender -> n_shop : POST /hooks/payments HTTP/1.1
n_shop --> n_sender : shop: payment pay_771 has version 2, applying 3
note over n_sender, n_oldshop : Hech qachon qaytmaydigan manzil
n_sender -> n_oldshop : endpoint ep_311: failing for 5 days
@enduml

PlantUML: komponentlar

@startuml
left to right direction
component "To'lov API" as n_payments
cloud "Do'kon serveri" as n_shop
database "Do'kon bazasi" as n_shopdb
queue "Webhook navbati" as n_queue
collections "Yuboruvchi" as n_sender
cloud "O'lik manzil" as n_oldshop #fde2e2;line:c62828;line.dashed
n_shop --> n_shopdb : chaqiruv
n_payments --> n_queue : asinxron
n_queue --> n_sender : asinxron
n_sender --> n_shop : chaqiruv
n_sender -[#c62828]-> n_oldshop
@enduml

Xulosa

Webhook'lar uchun oltita qoida.

1) Biznes so'rovi ichida emas, navbatdan timeout bilan yuboring. 2) Id, vaqt va xom tanani har manzilning o'z siri bilan imzolang; doimiy vaqtda tekshiring. 3) Eski vaqtni rad eting va ko'rilgan id'larni eslab qoling. 4) Tasodifiy yoyilishli, o'sib boruvchi jadval bo'yicha qayta urining. 5) Qabul qiluvchi id'ni noyob kalit bilan saqlaydi, tez javob beradi va fonda ishlaydi. 6) Tartibga tayanmang: versiyalardan foydalaning yoki joriy holatni oling; o'lik manzillarni ajrating va o'chiring.

Ko'rsatkichlar: boshida va oxirida

Ko'rsatkichBoshidaOxirida
To'lov p958 200 ms60 ms
Qabul qilingan soxta00
Ikki marta bajarish0/kun0/kun
Yetkazishni kutmoqda09 000

Qadamlar

  1. Holat Webhook to'lov ichida yuboriladi

    Karta to'lovi o'tganda To'lov API do'kon URL'ini xabar bilan chaqiradi va xaridorga javob berishdan oldin javobni kutadi.

  2. Yechim Navbat va yuboruvchi webhook'ni to'lovdan chiqaradi

    To'lov API endi hodisani saqlaydi va xaridorga darhol javob beradi.

  3. Muammo Do'konning webhook URL'ini istalgan odam chaqira oladi

    URL sir emas: u brauzer vositalarida, loglarda va support tiketlarida ko'rinadi.

  4. Yechim Har webhook HMAC bilan imzolanadi

    Har do'kon manzilni ro'yxatdan o'tkazganda o'z sirini oladi.

  5. Muammo Haqiqiy so'rov, yana yuborilgan

    Noto'g'ri sozlangan proksi so'rovlarni to'liq loglagan va log tashqariga chiqib ketgan.

  6. Yechim Imzolangan vaqt, vaqt oynasi va ko'rilgan id'lar ro'yxati

    Imzolanadigan satr id.timestamp.body, shuning uchun vaqtni imzoni buzmasdan o'zgartirib bo'lmaydi.

  7. Yechim Do'kon ishlamayapti: jadval bo'yicha qayta urinamiz

    Do'kon serveri deploy paytida bir soat ishlamaydi.

  8. Muammo Sekin javob ikki baravar bonusga aylanadi

    Do'kon hodisani so'rovning o'zida bajaradi: buyurtmani to'langan deb belgilaydi va 500 bonus ball qo'shadi.

  9. Yechim Qabul qiluvchi: id'ni eslab qol, tez javob ber, keyin ishla

    Do'kon avval Webhook-Id ni noyob kalitli inbox jadvaliga yozadi.

  10. Holat Hodisalar tartibsiz keladi

    To'lov o'tdi va besh daqiqadan keyin qaytarildi.

  11. Yechim Hech qachon qaytmaydigan manzil

    Bitta do'kon yopildi va uning domeni muddati tugadi.

  12. Xulosa Xulosa

    Webhook'lar uchun oltita qoida.

Atamalar

Webhook
Hodisa sodir bo'lganda bir tizim boshqasining URL'iga o'zi HTTP POST yuboradi. Yetkazish kamida bir marta: yuboruvchi backoff bilan qayta urinadi, qabul qiluvchi esa takrorni hodisa id'si bo'yicha tashlaydi.
HMAC imzo
Xabar tanasi va vaqt belgisi umumiy sir bilan hash qilinadi va sarlavhada yuboriladi. Qabul qiluvchi xuddi shunday hisoblab solishtiradi: mos kelmasa yoki vaqt eski bo'lsa, so'rov rad etiladi.