Kunci API berfungsi seperti kata laluan untuk program. Ia juga kuasa perbelanjaan: sesiapa yang memegangnya boleh menggunakan baki anda.
Cara ia berfungsi
API LLM menganggap kunci sebagai bearer token. Klien menghantarnya pada setiap permintaan:
curl https://inference.broadnet.ai/v1/models \
-H "Authorization: Bearer $BROADNET_API_KEY"
RFC 6750 mentakrifkan bearer token sebagai token yang boleh digunakan oleh “any party in possession of the token” (Terjemahan BroadRouter: “mana-mana pihak yang memiliki token itu”). Tiada faktor kedua. Itulah sebabnya RFC yang sama menyatakan klien mesti sentiasa menghantar bearer token melalui TLS (https://).
Penyedia mencari kunci, mengenal pasti akaun, menyemak had dan dasar, kemudian melayan atau menolak permintaan. Kunci yang tiada atau salah biasanya memulangkan 401; kunci yang ditolak oleh dasar, seperti senarai IP dibenarkan, biasanya memulangkan 403.
Mengapa ia penting
Kunci yang bocor ialah salah satu punca paling biasa bil API melambung, kerana bot mengimbas kod awam untuk mencari rahsia. Ia juga boleh mendedahkan data jika kunci itu boleh mencapai endpoint yang memulangkan butiran akaun. Amalan baik, selaras dengan panduan rahsia OWASP:
- Muatkan kunci daripada pembolehubah persekitaran atau pengurus rahsia. Jangan sekali-kali commit kunci atau masukkannya ke dalam imej bekas (container).
- Beri setiap aplikasi atau ejen kunci sendiri, supaya anda boleh membatalkan satu tanpa menghentikan semuanya.
- Tukar kunci mengikut jadual dan serta-merta selepas sebarang syak kebocoran.
- Hadkan tempat kunci berfungsi, contohnya dengan senarai IP pelayan yang dibenarkan.
Di BroadNet Inference
BroadNet mengasingkan dua jenis kelayakan. Kunci inferens memanggil model pada /v1/*. Kelayakan portal mengautomasikan akaun: kunci, IP yang dibenarkan dan pembelian. Anggap yang kedua sebagai kuasa penuh ke atas akaun.
Kedua-duanya dipaparkan sekali sahaja. BroadNet hanya menyimpan hash SHA-256, jadi ia tidak dapat memaparkan kunci itu lagi. Kunci bayar ikut guna sah selama setahun, dan satu akaun boleh memegang sehingga sepuluh kunci aktif. Setiap kunci boleh mempunyai senarai IP dibenarkan sendiri. Selepas pembatalan atau perubahan senarai dibenarkan, permintaan baharu berhenti dalam masa lima saat.
Kunci pelan untuk pelan harga tetap adalah berasingan dan tidak sekali-kali menolak baki anda. Langkah persediaan ada dalam kunci API dan senarai IP dibenarkan, dan kod status ada dalam ralat dan cuba semula.
Kesilapan biasa
- Log pengepala permintaan penuh. Ini menulis kunci ke dalam log anda.
- Berkongsi satu kunci dalam satu pasukan. Anda kehilangan keupayaan untuk membatalkan akses seorang sahaja.
- Menghantar kunci kepada sokongan. Hantar nilai pengepala
X-Request-IDsebaliknya.