密钥扫描

人们不应该在代码库中遗留秘密信息，但有时这种情况确实会发生。 为了帮助您避免这个问题，我们提供了一个秘密扫描功能，可以扫描您的代码库查找秘密信息， 并在发现时发出警告。

支持的模式

默认情况下，一组秘密模式定义在https://github.com/microsoft/genaiscript/tree/main/packages/core/src/config.json。

你可以在https://github.com/mazen160/secrets-patterns-db/找到模式示例。

扫描消息

默认情况下，发送给LLM的所有消息都会被扫描，如果包含敏感信息将被自动屏蔽。

您可以通过在脚本中将secretScanning选项设置为false来完全禁用秘密扫描。

script({
    secretScanning: false,
})

配置模式

如果您有想要扫描的特定模式，可以在您的配置文件中进行配置。

{
    "secretPatterns": {
        ...,
        "my secret pattern": "my-secret-pattern-regex"
    }
}

• 在正则表达式模式中不要使用^或$

禁用模式

将模式键设置为 null 或 false 以禁用它。

{
    "secretPatterns": {
        "OpenAI API Key": null
    }
}

CLI

您可以使用CLI针对文件测试您的模式。

genaiscript parse secrets *