English | 繁中版 | 简中版 | Português (Brasil) | Français | 한국어 | Nederlands | Indonesia | ไทย | Русский | Українська | Español | Italiano | 日本語 | Deutsch | Türkçe | Монгол | हिंदी | العربية | Polski | Македонски | ລາວ
Những giải pháp an toàn và cách khắc phục khi thiết kế, kiểm tra và phát hành API cho ứng dụng của bạn.
- Không sử dụng
Basic Auth
. Sử dụng giao thức xác thực tiêu chuẩn (chẳng hạn JWT hay OAuth). - Không tự thiết kế lại các giải pháp
Authentication
,token generation
,password storage
. Hãy sử dụng các giải pháp tiêu chuẩn. - Sử dụng
Max Retry
và chức năng Auto Block ở trang Login. - Mã hóa các dữ liệu nhạy cảm.
- Sử dụng khóa ngẫu nhiên (
JWT Secret
) để tăng sự khó khăn của việc tấn công Brute Force. - Không sử dụng các thuật toán có trong
Payload
của người dùng. Bắt buộc sử dụng thuật toán phía backend (HS256
hoặcRS256
). - Đặt thời hạn token (
TTL
,RTTL
) càng ngắn càng tốt. - Không lưu các thông tin nhạy cảm trong JWT, nó có thể dễ dàng được giải mã.
- Luôn xác nhận
redirect_uri
phía server để chỉ cho phép redirect đến các URL tin cậy. - Ưu tiên sử dụng
response_type=code
thay vìresponse_type=token
). - Sử dụng tham số
state
cùng một giá trị hash ngẫu nhiên để chống lại tấn công CSRF trong quá trình xác thực OAuth. - Định nghĩa phạm vi mặc định, và xác nhận các tham số phạm vi cho mỗi ứng dụng.
- Giới hạn request (Throttling) để phòng tránh các tấn công DDoS / brute-force.
- Sử dụng giao thức HTTPS ở phía server để tránh MITM (Man In The Middle Attack).
- Sử dụng
HSTS
header với SSL để tránh tấn công SSL Strip.
- Sử dụng các HTTP method phù hợp với từng hành động:
GET (đọc)
,POST (tạo mới)
,PUT/PATCH (cập nhật/sửa)
,DELETE (để xóa bản ghi)
, và phản hồi405 Method Not Allowed
nếu HTTP method không phù hợp với tài nguyên được request. - Xác nhận dữ liệu
content-type
ở mỗi tiêu đề (Content Negotiation) chỉ cho phép những định dạng được hỗ trợ (chẳng hạn như.application/xml
,application/json
, vv) và phản hồi406 Not Acceptable
nếu không khớp. - Xác nhận dữ liệu
content-type
được chấp nhận khi gửi lên (chẳng hạn như.application/x-www-form-urlencoded
,multipart/form-data
,application/json
...). - Kiểm tra dữ liệu truyền lên từ người dùng để tránh các lỗ hổng phổ biến (chẳng hạn như
XSS
,SQL-Injection
,Remote Code Execution
...). - Không sử dụng các dữ liệu nhạy cảm như (
credentials
,Passwords
,security tokens
, orAPI keys
) tại URL, sử dụng header Authorization để xác thực. - Sử dụng API Gateway để kích hoạt cache, Rate Limit policies (chẳng hạng như.
Quota
,Spike Arrest
,Concurrent Rate Limit
) và deploy APIs resources linh động hơn.
- Đảm bảo rằng các endpoint chỉ xử lý dữ liệu sau khi đã qua bước xác thực
- Nên tránh việc sử dụng ID của tài nguyên. Sử dụng
/me/orders
thay vì/user/654321/orders
. - Không nên thiết kế ID dạng tự động tăng. Sử dụng UUID để thay thế.
- Nếu bạn muốn parse XML, hãy chắc chắn rằng
entity parsing
không được kích hoạt để tránh tấn côngXXE
(XML external entity attack). - Nếu bạn muốn parse XML, hãy chắc chắn rằng
entity expansion
không được kích hoạt để tránh tấn côngBillion Laughs/XML bomb
. - Sử dụng CDN để tải lên tệp tin.
- Nếu bạn đang cần xử lý với lượng dữ liệu lớn, sử dụng các kỹ thuật Workers và Queues để xử lý tác vụ dưới nền càng nhiều càng tốt và giúp phản hồi nhanh để tránh bị timeout HTTP.
- Đừng quên tắt chế độ DEBUG.
- Thêm
X-Content-Type-Options: nosniff
vào response headers. - Thêm
X-Frame-Options: deny
vào response headers. - Thêm
Content-Security-Policy: default-src 'none'
vào response headers. - Loại bỏ các header chứa thông tin nhạy cảm như phiên bản web server, ví dụ:
X-Powered-By
,Server
,X-AspNet-Version
, v.v... - Bắt buộc có
content-type
trong response headers, nếu bạn trả vềapplication/json
thì headercontent-type
sẽ có giá trịapplication/json
. - Không trả về client các thông tin nhạy cảm như
credentials
,Passwords
,security tokens
. - Trả về status code tương ứng với hành động đã hoàn thành. (chẳng hạn.
200 OK
,400 Bad Request
,401 Unauthorized
,405 Method Not Allowed
...).
- Kiểm tra thiết kế và thực hiện đầy đủ việc test với unit/integration.
- Áp dụng quy trình đánh giá code và bỏ qua việc tự phê duyệt.
- Đảm bảo các thành phần của dịch vụ được quét với các anti virus trước khi đưa ra phiên bản production, bao gồm các thư viện và các gói khác.
- Thiết kế một giải pháp rollback cho việc triển khai.
- yosriady/api-development-tools - Tập hợp các tài nguyên hữu ích để xây dựng API RESTful HTTP+JSON.
Hãy đóng góp bằng cách forking kho này, thực hiện một số thay đổi và gửi yêu cầu kéo. Đối với bất kỳ câu hỏi nào, hãy gửi email cho chúng tôi theo địa chỉ [email protected]
.