Secara lalai, kunci API berfungsi dari mana-mana sahaja. Senarai dibenarkan mengikatnya pada tempat anda benar-benar menjalankan kod.
Cara ia berfungsi
Bahagian edge API menyemak IP sumber setiap permintaan berbanding satu senarai. Jika alamat itu ada dalam senarai, atau dalam julat yang disenaraikan, permintaan diteruskan ke semakan kunci biasa. Jika tidak, ia ditolak.
Julat ditulis dalam tatatanda CIDR: alamat, garis condong, dan panjang awalan. RFC 4632 menerangkan bahawa panjang awalan ialah bilangan bit pendahulu yang tetap. Untuk IPv4:
| Entri | Meliputi |
|---|---|
203.0.113.7 |
satu alamat |
198.51.100.0/24 |
256 alamat, 198.51.100.0 hingga 198.51.100.255 |
10.0.0.0/16 |
65,536 alamat |
IPv6 menggunakan idea yang sama dengan alamat 128-bit, seperti 2001:db8::/48.
Alamat yang penting ialah IP egress anda: alamat awam tempat trafik pelayan anda keluar. Di belakang NAT, pengimbang beban atau proksi korporat, alamat itu selalunya bukan alamat yang ditunjukkan oleh mesin untuk dirinya sendiri.
Mengapa ia penting
Kunci API ialah bearer token: sesiapa yang memegangnya boleh menggunakannya. Kunci bocor melalui commit, log, tangkapan skrin dan komputer riba. Dengan senarai dibenarkan, kunci yang dicuri gagal dari rangkaian penyerang, dan kebocoran bertukar daripada insiden perbelanjaan kepada perkara yang tidak memberi kesan. GitHub, sebagai contoh, menggunakan senarai dibenarkannya pada panggilan API dan personal access token serta log masuk web.
Kosnya ialah sedikit kerja operasi. Setiap pelayan, rantau atau CI runner baharu perlu ditambah IP egressnya, dan IP dinamik memerlukan laluan egress yang tetap.
Di BroadNet Inference
Di halaman akaun, tambah satu alamat IPv4 atau IPv6 atau julat CIDR bagi setiap baris, sehingga 32 entri. Senarai kosong bermakna tiada sekatan. Kunci baharu mewarisi senarai akaun. allowed_ips bagi setiap kunci menggantikannya untuk kunci tersebut:
curl -X POST https://inference.broadnet.ai/portal/keys \
-H "Authorization: Bearer $BROADNET_PORTAL_CREDENTIAL" \
-H "Content-Type: application/json" \
-d '{"label":"worker-1","allowed_ips":["203.0.113.7","198.51.100.0/24"]}'
Permintaan dari alamat lain mendapat 403. Selepas perubahan atau pembatalan kunci, permintaan baharu berhenti dalam masa lima saat. Langkah penuh ada dalam kunci API dan senarai IP dibenarkan, dan jadual ralat ada dalam ralat dan cubaan semula. Untuk gambaran perlindungan data yang lebih luas, lihat senarai semak ZDR.
Kesilapan biasa
- Menyenaraikan alamat peribadi pelayan, seperti
10.x.x.x, dan bukan IP egress awamnya. - Menggunakan julat yang sangat luas semata-mata untuk menghilangkan ralat.
/8meliputi lebih 16 juta alamat.