Bí mật

Một dự án Restorm được tạo ra để commit. Còn các bí mật thì không bao giờ được lọt vào đó. Kiểu giá trị Bí mật đáp ứng nhu cầu này: biến chỉ lưu một tham chiếu tới một nguồn, chứ không bao giờ lưu chính giá trị.

Cơ chế hoạt động

Hãy chọn kiểu Bí mật cho một biến, rồi chọn nguồn. Khi đó tệp dự án chỉ chứa định danh của nguồn và các tham số của nó. Giá trị được giải quyết trong tiến trình chính, vào lúc thực thi.

Hai biến môi trường kiểu Bí mật (petstore_auth_token, api_key): ô mang dấu hiệu $= cùng các nút làm mới, sửa cách lấy giá trị và khóa — bên cạnh một biến kiểu chuỗi

Kiểu Bí mật bảo vệ điều gì

Một bí mật vẫn xem được từ trong ứng dụng: trình biên tập môi trường, các khung xem giá trị đã giải quyết, bảng điều khiển nội bộ và các đoạn mã đều hiển thị giá trị của nó. Đó là bí mật của bạn, bạn vốn đã biết nó — kiểu Bí mật không nhằm giấu nó khỏi bạn.

Điều mà nó bảo đảm là giá trị đó:

không bao giờ lọt vào những tệp rời khỏi máy của bạn — nó không được ghi vào dự án .restorm, nên không bị commit, không bị đẩy lên một kho chứa, cũng không đi kèm trong một bản xuất;
không được gửi tới một dịch vụ bên thứ ba chưa được cho phép — các đích đến đi ra đều đi qua tường lửa.

Các nguồn hiện có

Biến môi trường của hệ thống (`envVar`)

Đọc một biến môi trường của hệ điều hành. Chỉ có một tham số: tên của biến.

Đây là nguồn nên ưu tiên trong tích hợp liên tục: bí mật được kho khóa của hệ thống CI chèn vào, còn Restorm chỉ đọc nó.

export API_TOKEN="…"
restorm --open projet.restorm --run "Tests" --headless

Tệp bí mật (`envFileSecret`)

Đọc — và ghi — một tệp restorm.env đặt cạnh dự án. Đây là chế độ cục bộ: tệp nằm lại trên máy của bạn và được thêm vào .gitignore.

Khác với nguồn trước, nguồn này ghi được: bạn có thể nhập giá trị ngay từ Restorm, giá trị sẽ được lưu vào tệp bí mật chứ không phải vào dự án.

Làm mới các bí mật

Các giá trị đã giải quyết được lưu đệm. Sau khi thay đổi một bí mật ở bên ngoài (xoay vòng một token, sửa tệp .env), hãy dùng Làm mới môi trường để xóa bộ nhớ đệm và đọc lại toàn bộ các nguồn.

Những gì bị lược bỏ

Restorm lược bỏ bí mật khỏi những gì nó ghi xuống đĩa:

các token do một yêu cầu xác thực tạo ra đều bị lược bỏ trong lịch sử phản hồi, bao gồm cả thân lẫn header;
nhật ký ứng dụng cũng được lược bỏ tương tự.

Ngược lại, các công cụ MCP nhận giá trị đã giải quyết, giống như phần còn lại của ứng dụng: tác nhân điều khiển Restorm thay mặt bạn, trên chính các bí mật của bạn. Những bảo đảm nêu trên vẫn nguyên vẹn — giá trị không được ghi vào dự án, cũng không vào một bản xuất, và không đi tới một dịch vụ bên thứ ba chưa được phép.

Thực hành tốt

Hãy thêm restorm.env và *.responses.zip vào .gitignore của bạn.
Trong CI, hãy dùng envVar thay vì tệp bí mật.
Mật khẩu của một giao thức gốc (MQTT, AMQP, Redis, Kafka) cũng chấp nhận giá trị kiểu Bí mật — đừng viết những mật khẩu đó ở dạng rõ trong yêu cầu.