Cipher 过滤器插件

用于加密和解密操作的密码算法。

支持的算法列表取决于此插件运行的 Logstash、JRuby 和 Java 版本，但可以通过运行以下命令获取：

    cd $LOGSTASH_HOME # <-- your Logstash distribution root
    bin/ruby -ropenssl -e 'puts OpenSSL::Cipher.ciphers'

启用或禁用加密操作中的填充。

在使用分组密码的加密操作中，除非启用填充，否则输入明文必须是密码分组大小的精确倍数。

通过将此值设置为 0 来禁用填充会导致此插件无法加密任何不严格遵守 algorithm 分组大小要求的输入明文。

    filter { cipher { cipher_padding => 0 }}

在加密操作中，此插件会为每个加密操作生成一个随机初始化向量 (IV)。这是确保生成的密文无法进行比较以推断源明文等效性的标准最佳实践。然后，此唯一的 IV 会预先附加到结果密文，然后再将其存储，确保任何需要解密它的进程都可以使用它。

在解密操作中，假定 IV 已预先附加到密文，因此此插件需要知道 IV 的长度才能正确拆分输入。

IV 的大小通常取决于使用哪种 algorithm。AES 算法通常使用 16 字节的 IV

    filter { cipher { iv_random_length => 16 }}

用于加密和解密操作的密钥。

用于将密钥填充到所需 key_size 的字符。

密码所需的密钥大小，这取决于您使用的 algorithm。如果指定的 key 值较短，则会使用 key_pad 进行填充。

例如，对于 AES-128，密钥长度必须为 16 个字符。AES-256 = 32 个字符

    filter { cipher { key_size => 16 }

如果设置此值，则内部 Cipher 实例将在重新从头创建之前重复使用最多 max_cipher_reuse 次。这是一个提高效率的选项，其中大量数据使用此过滤器进行加密和解密。这使过滤器能够避免为每个加密/解密操作反复创建新的 Cipher 实例。

这是可选的，默认情况下不重复使用 Cipher 实例，并且 max_cipher_reuse = 1。

    filter { cipher { max_cipher_reuse => 1000 }}

源字段的名称。

例如，要使用 message 字段（默认值）

    filter { cipher { source => "message" } }

放置结果的目标字段的名称

例如，将结果放置到 crypt 中

    filter { cipher { target => "crypt" } }

如果此过滤器成功，则将任何任意字段添加到此事件中。字段名称可以是动态的，并包含使用 %{field} 的事件部分。

示例

    filter {
      cipher {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }

    # You can also add multiple fields at once:
    filter {
      cipher {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加字段 foo_hello（如果存在），其值为上述值，并且 %{host} 部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。

如果此过滤器成功，则将任意标签添加到事件中。标签可以是动态的，并包含使用 %{field} 语法的事件部分。

示例

    filter {
      cipher {
        add_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also add multiple tags at once:
    filter {
      cipher {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（当然，第二个示例将添加 taggedy_tag 标签）。

禁用或启用此特定插件实例的指标日志记录。默认情况下，我们会记录所有可以记录的指标，但您可以禁用特定插件的指标收集。

向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 cipher 过滤器。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

    filter {
      cipher {
        id => "ABC"
      }
    }

定期调用过滤器刷新方法。可选。

如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并包含使用 %{field} 的事件部分 示例

    filter {
      cipher {
        remove_field => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple fields at once:
    filter {
      cipher {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除名称为 foo_hello 的字段（如果存在）。第二个示例将删除另一个非动态字段。

如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并包含使用 %{field} 语法的事件部分。

示例

    filter {
      cipher {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple tags at once:
    filter {
      cipher {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除标签 foo_hello（如果存在）。第二个示例还将删除一个令人不快的、不需要的标签。