Viết một chính sách

Có hai cách để viết một chính sách: cho phép Failproof AI soạn thảo từ kết quả kiểm tra, hoặc tự viết nguồn. Không có gì được xuất bản hoặc triển khai cho đến khi bạn chọn.

Viết một chính sách từ một cuộc kiểm tra

Một cuộc kiểm tra phát hiện một lỗi; một chính sách ngăn chặn nó lặp lại. Failproof AI soạn thảo chính sách từ bằng chứng của kết quả phát hiện.

1. Chạy một cuộc kiểm tra

Chạy một cuộc kiểm tra trên các phiên làm việc nơi lỗi xảy ra. Mỗi kết quả phát hiện mang theo các phiên bằng chứng, nguyên nhân gốc rễ và đường dẫn ngăn chặn được đề xuất. Làm việc từ một kết quả phát hiện có mẫu hành động có thể lặp lại — một chính sách chỉ có thể ngăn chặn những gì nó có thể nhận dạng trong sự kiện hook.

2. Tạo bản nháp

Dashboard
CLI

Mở vấn đề phát hiện dưới Analyze → issues và kiểm tra các phiên được trích dẫn, nguyên nhân gốc rễ và khuyến cáo.
Chọn generate policy. Failproof AI trước tiên cho biết liệu chính sách có thể biểu đạt vấn đề hay không. Kết quả no policy có nghĩa là bản sửa lỗi là một cảnh báo, thay đổi quy trình làm việc hoặc một người — không phải một chính sách.
Chọn write this policy. Tiêu đề vấn đề, kết quả phát hiện, nguyên nhân gốc rễ, khuyến cáo và ý định thực thi được đề xuất trở thành bản nháp trong Admin → policy editor. Sử dụng open the editor anyway khi bạn không đồng ý với kiểm tra ứng cử viên.

Đọc bằng chứng, sau đó soạn thảo với trợ lý. compose in nguồn để bạn xem xét và không xuất bản bất cứ điều gì:

fp issues show <issue-id>
fp audits finding <finding-id>
fp policies compose "Block git push --force on release branches"

compose cần một phiên đã đăng nhập (fp login) có vai trò policies:write; nó từ chối các khóa API.

3. Xem xét bản nháp

Bản nháp là điểm khởi đầu, không phải một phán quyết. Trước khi xuất bản, hãy kiểm tra rằng nó:

Đặt tên chế độ lỗi bằng ngôn ngữ vận hành.
Khớp chỉ các sự kiện hook và công cụ mang đủ bằng chứng để quyết định.
Sử dụng điều kiện hẹp nhất bắt được hành động không an toàn.
Trả lại một lý do cho agent biết phải làm gì khác.
Sử dụng instruct khi agent có thể an toàn sửa đổi hướng, và deny chỉ khi cho phép hành động là không thể chấp nhận được hoặc không thể đảo ngược.

Xác thực nguồn trong trình soạn thảo và sửa tất cả các lỗi được báo cáo.

4. Kiểm tra, sau đó xuất bản

Chạy backtest dưới nguồn trước khi bạn xuất bản: nó phát lại bản nháp dựa trên các lệnh gọi mà hạm đội của bạn đã thực hiện và đếm số lượng các lệnh gọi hoạt động mà nó sẽ đã gián đoạn. Test a policy bao gồm điều đó và các kiểm tra khác. Khi nó hoạt động, nhập danh tính chính sách và chọn publish version. Xuất bản tạo một phiên bản bất biến và không triển khai bất cứ điều gì: nó nằm không được sử dụng cho đến khi bạn triển khai nó. Từ một terminal:

fp policies publish checkout-guard ./checkout.policy.mjs --description "Block force-push"

publish kiểm tra phân tích cú pháp nguồn trước khi gửi, vì vậy lỗi cú pháp sẽ xuất hiện ở đây thay vì trên máy tại thời điểm thực thi.

Tự viết nó

Một chính sách là JavaScript hoặc TypeScript dựa trên API failproofai:

import { customPolicies, allow, deny } from "failproofai";

customPolicies.add({
  name: "protect-production-paths",
  description: "Block writes to production configuration",
  match: { events: ["PreToolUse"] },
  fn: async (ctx) => {
    if (ctx.toolName !== "Write" && ctx.toolName !== "Edit") return allow();
    const path = String(ctx.toolInput?.file_path ?? "").replaceAll("\\", "/");
    if (path.split("/").includes("production")) {
      return deny("Writes to production configuration require approval.");
    }
    return allow();
  },
});

Điều này khớp production/config.yml, /srv/production/config.yml, /srv/production và C:\\production\\config.yml cho cả Write và Edit, nhưng không phải production-backup: production phải là một phân đoạn đường dẫn hoàn chỉnh. Ngữ cảnh cũng mang theo loại sự kiện, tải trọng chuẩn hóa, siêu dữ liệu phiên, tham số và CLI nguồn khi có sẵn — xem policy SDK. Để xuất bản nó như một phiên bản, dán nguồn vào compose trong Admin → policy editor và làm theo các bước 3 và 4 ở trên, hoặc xuất bản tệp từ terminal bằng fp policies publish. Để chạy nó trên máy mà không có Cloud, lưu nó dưới .failproofai/policies/ với tên kết thúc bằng policies.js, policies.mjs hoặc policies.ts — những cái này tải tự động ở phạm vi dự án và người dùng — hoặc cài đặt nó theo đường dẫn:

failproofai policies --install --custom ./security.policies.ts --scope project

Đặt cho mỗi chính sách một tên duy nhất trên các chính sách theo quy ước, tùy chỉnh, gói và được quản lý bởi Cloud.

Prevent repeat failures

Get a policy

Ship a policy

Viết một chính sách