Mặc định, một API key hoạt động từ bất cứ đâu. Allow list gắn nó với những nơi bạn thực sự chạy code.
Cách hoạt động
Lớp edge của API kiểm tra IP nguồn của mỗi request với một danh sách. Nếu địa chỉ có trong danh sách, hoặc nằm trong một dải đã liệt kê, request đi tiếp tới bước kiểm tra key thông thường. Nếu không, nó bị từ chối.
Các dải được viết theo ký pháp CIDR: một địa chỉ, dấu gạch chéo và độ dài prefix. RFC 4632 giải thích độ dài prefix là số bit đầu được cố định. Với IPv4:
| Mục | Phạm vi |
|---|---|
203.0.113.7 |
một địa chỉ |
198.51.100.0/24 |
256 địa chỉ, từ 198.51.100.0 đến 198.51.100.255 |
10.0.0.0/16 |
65,536 địa chỉ |
IPv6 dùng cùng ý tưởng với địa chỉ 128 bit, chẳng hạn 2001:db8::/48.
Địa chỉ quan trọng là IP egress của bạn: địa chỉ công khai mà lưu lượng từ server đi ra. Khi nằm sau NAT, load balancer hoặc proxy của công ty, địa chỉ đó thường không phải địa chỉ mà máy tự hiển thị.
Vì sao quan trọng
API key là bearer token: ai giữ nó thì người đó dùng được. Key bị lộ qua commit, log, ảnh chụp màn hình và laptop. Có allow list, key bị đánh cắp sẽ thất bại khi gọi từ mạng của kẻ tấn công, biến một vụ lộ key từ sự cố tốn tiền thành chuyện không đáng kể. Ví dụ, GitHub áp dụng allow list cho cả lệnh gọi API và personal access token, không chỉ đăng nhập web.
Cái giá là thêm chút việc vận hành. Mỗi server, region hay CI runner mới cần thêm IP egress của nó, và IP động cần một đường egress cố định.
Trên BroadNet Inference
Trên trang tài khoản, thêm mỗi dòng một địa chỉ IPv4 hoặc IPv6 hoặc một dải CIDR, tối đa 32 mục. Danh sách trống nghĩa là không giới hạn. Key mới kế thừa danh sách của tài khoản. allowed_ips riêng cho từng key sẽ thay thế danh sách đó cho key ấy:
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"]}'
Request từ địa chỉ khác nhận lỗi 403. Sau khi thay đổi danh sách hoặc thu hồi key, request mới bị chặn trong vòng năm giây. Các bước đầy đủ có trong API key và IP allow list, còn bảng lỗi nằm trong lỗi và thử lại. Để có bức tranh rộng hơn về bảo vệ dữ liệu, xem checklist ZDR.
Lỗi thường gặp
- Thêm địa chỉ private của server, như
10.x.x.x, thay vì IP egress công khai. - Dùng dải rất rộng cho hết lỗi. Một
/8bao phủ hơn 16 triệu địa chỉ.