服务器代理选项

姓名 支持的代理人 环境变量 配置文件属性
应用ID. 所有 tcell_agent_app_id. app_id
API密匙 所有 tcell_agent_api_key. API_KEY.
API URL前缀 所有 TCELL_AGENT_API_URL tcell_api_url.
输入URL前缀 所有 tcell_agent_input_url. tcell_input_url
启用代理 所有 TCELL_代理已启用 启用
代理主目录 所有 tcell_agent_home. N / A.
注册设备 所有 tcell_agent_instrument. N / A.
日志目录 所有 tcell_agent_log_dir. log_dir
配置文件路径 所有 tcell_agent_config N / A.
启用JSON体检 所有 tcell_agent_enable_json_body_inspection. ispect_json_posts.
允许载荷 所有 tcell_agent_allow_payload. allow_payloads
允许有效负载日志记录 所有 TCELL_AGENT_ALLOW_LOG_PAYLOADS log_payloads
主机标识符 所有 tcell_agent_host_identifier host_identifier.
启用日志记录 所有 TCELL_AGENT_LOG_ENABLED logging_options.enabled.
日志文件名 所有 tcell_agent_log_filename. logging_options.filename
记录级别 所有 tcell_agent_log_Level. logging_options.level
日志目标类型 所有 tcell_agent_log_destination. logging_options.destination.
最大日志文件大小 所有 TCELL_AGENT_LOG_FILE_MAX_SIZE_MB logging_options.max_file_size_mb.
HMAC钥匙 所有 tcell_agent_hmac_key. HMAC_KEY.
密码HMAC键 所有 TCELL_AGENT_PASSWORD_HMAC_KEY password_hmac_key.
缓存目录 所有 tcell_agent_cache_dir. N / A.
使反向代理 所有 tcell_agent_reverse_proxy. Reverse_proxy.
反向代理IP地址头 所有 TCELL_AGENT_REVERSE_PROXY_IP_ADDRESS_HEADER reverse_proxy_ip_address_header.
最大标题大小 所有 tcell_agent_max_header_size. max_csp_header_bytes
最大路由数 所有 tcell_agent_max_routes. max_routes.
JS代理API基本URL 所有 tcell_agent_js_agent_api_url. js_agent_api_base_url
JS代理URL. 所有 tcell_agent_js_agent_url. js_agent_url.
来自TCell的获取策略 所有 tcell_agent_update_policy. fetch_policies_from_tcell
删除服务器标题 nginx. TCELL_AGENT_SERVER_HEADER_OFF server_header_off.
ARR的IIS URL重写 。网 TCELL_AGENT_IIS_URL_REWRITE iis_url_rewrite
日志文件访问 JVM tcell_agent_log_file_access. log_file_access.
包跟踪器间隔 JVM tcell_agent_package_tracker_interval_ms. N / A.
Tomcat-specific重定向 JVM tcell_agent_tomcat_specific_redirects. tomcat_specific_redirects
会话标识符 所有 N / A. session_identifiers
不要仪器 JVM N / A. do_not_instrument.
启用了仪器 红宝石
Python		 N / A. Enabled_instrumentations.

环境变量和配置文件属性

代理版本

这些代理版本支持本文档中描述的所有环境变量和配置文件属性（服务器代理选项）。早期代理版本也可能支持一些变量和属性。

代理 最低版本
Apache 3.1.0.
IIS. 2.0.0
java. 1.13.0
。网 2.3.2
net核心 2.3.2
nginx. 3.1.0.
node.js. 2.2.0
Python 1.7.0.
红宝石 2.3.0

细节

看到配置约定对于日志和缓存目录默认值，配置文件结构、配置源、配置文件路径和它们的优先级。

tcell_agent_app_id.

app_id

描述- 标识TCELL应用程序。类型——字符串需要吗?- Y例子-exampleappp-l4ihu

tcell_agent_api_key.

API_KEY.

  • 描述-通过tCell web UI创建的服务器代理API密钥，用于向特定tCell应用程序授予权限。
  • 类型——字符串
  • 需要吗?- Y
  • 例子-abcd-efgh-hijk

TCELL_AGENT_API_URL

tcell_api_url.

  • 描述- 用于新配置信息的轮询URL前缀。应该对应于存储TCELL数据的AWS区域。
  • 类型——字符串
  • 默认的-https://us.agent.tcell.insight.rapid7.com/api/v1
  • 必需的- N
  • 例子-http://10.0.2.2:8000

所有采集器必须能够在端口上建立出站连接443.到* .endpoint.ingress.Rapid7.com.根据地理区域与下表的数据和存储（S3）列中所示的域与域进行通信。例如，对于选择在澳大利亚储存其数据的TCell订户，收集器必须能够使用端口与以下端点通信443.：

  • * .endpoint.ingress.Rapid7.com.
  • au.data.insight.rapid7.com
  • s3 - ap -东南- 2. - amazonaws.com
地区 数据端点 存储（S3端点）
美国 - 1 data.insight.rapid7.com. s3.amazonaws.com.
美国 - 2 us2.data.insight.rapid7.com s3.us -东- 2. - amazonaws.com
美国 - 3 us3.data.insight.rapid7.com s3.us -西方- 2. amazonaws.com
加拿大 ca.data.insight.rapid7.com. s3.ca-central-1.amazonaws.com.
欧洲 eu.data.insight.rapid7.com s3.eu中央- 1. amazonaws.com
日本 ap.data.insight.rapid7.com s3 - ap -东北- 1. - amazonaws.com
澳大利亚 au.data.insight.rapid7.com s3 - ap -东南- 2. - amazonaws.com

如果您打算部署基于令牌的洞察力必威体育app登录通过您的收藏家，您还需要允许从端口上的每个收集器的出站连接443.到提供代理配置文件的端点。就像上表中的数据和存储端点一样，您可以配置防火墙规则，以允许收集器连接到部署端点的特定区域以满足此要求：

地区 部署端点
美国 - 1 US.DEPLOYMENT.ENDPOINT.INCRESS.RAPID7.com/api/v1/ge_AGENT_FILE.
美国 - 2 US2.DEPLOYMENT.ENDPOINT.INCRESS.RAPID7.com/api/v1/ge_AGENT_FILE.
美国 - 3 US3.DEPLOYMENT.ENDPOINT.INDRESS.RAPID7.com/api/v1/ge_AGENT_FILE.
加拿大 ca.deployment.endpoint.ingress.Rapid7.com/api/v1/ge_Agent_files.
欧洲 eu.deployment.endpoint.ingress.rapid7.com/api/v1/get_agent_files
日本 ap.deployment.endpoint.ingress.Rapid7.com/api/v1/ge_Agent_files.
澳大利亚 au.deployment.endpoint.ingres.rapid7.com/api/v1/get\u agent\u文件

tcell_agent_input_url.

tcell_input_url

  • 描述- 发送事件的URL前缀。
  • 类型——字符串
  • 默认的-https://us.input.tcell.insight.rapid7.com/api/v1.
  • 必需的- N
  • 例子-http://10.0.2.2：3000.

TCELL_代理已启用

启用

  • 描述- 当FALSE时，代理程序对应用程序没有任何作用。
  • 类型- 布尔值
  • 默认的-真的
  • 必需的- N
  • 例子-假

tcell_agent_home.

N / A.

  • 描述-默认情况下，代理将在其中创建日志和缓存目录的绝对文件路径，假设没有其他配置。
  • 默认的
  • 例子-/ etc / tcell
  • 笔记对于.NET，.NET核心和IIS Web服务器代理，指定的路径将存储/日志和/缓存文件夹。它永远不会寻找tcell_agent.config.文件在这个位置。“

tcell_agent_instrument.

N / A.

  • 描述—当为false时，代理不注册仪器。它仍然会要求保单。
  • 类型- 布尔值
  • 默认的-真的

tcell_agent_log_dir.

log_dir

  • 描述-所有日志的目录
  • 类型——字符串
  • 必需的- N
  • 例子-/var/log/tcell
  • 默认的-$ TCELL_HOME /日志

tcell_agent_config

N / A.

  • 描述—tCell代理配置文件的绝对路径
  • 默认的
  • 类型——字符串
  • 例子-/ etc / tcell

tcell_agent_enable_json_body_inspection.

ispect_json_posts.

  • 描述- 当真的时，代理检查了JSON和XML内容的请求主体
  • 类型- 布尔值
  • 默认的-假

tcell_agent_allow_payload.

allow_payloads

  • 描述- 当为true时，代理包括在发送到云的事件中检查请求有效载荷。有效载荷可以匹配最多150个字符的正则表达式（CMDI，XS，SQLI，FPT等）。
  • 类型- 布尔值
  • 默认的-真的
  • 例子-假

TCELL_AGENT_ALLOW_LOG_PAYLOADS

log_payloads

  • 描述—当为true时，代理记录检查的请求有效载荷tcell_agent_payloads.log文件在已配置的日志目录中。
  • 类型- 布尔值
  • 默认的-真的
  • 必需的- N
  • 例子-真的

tcell_agent_host_identifier

host_identifier.

  • 描述-要使用的代理主机标识符。每个代理必须有一个不同的标识符。默认为操作系统提供的主机名。
  • 类型——字符串
  • 必需的- N
  • 默认的-(默认为OS主机名)
  • 例子-web-host-1

TCELL_AGENT_LOG_ENABLED

logging_options.enabled.

  • 描述—启用代理日志记录功能。
  • 类型- 布尔值
  • 默认的-真的

tcell_agent_log_filename.

logging_options.filename

  • 描述- 设置代理日志记录文件名。默认情况下，这是相对于TCELL目录。也可以通过绝对路径。
  • 类型——字符串
  • 默认的-tcell.log

tcell_agent_log_Level.

logging_options.level

  • 描述- 设置代理日志记录级别。可能的值是'错误'，'警告'，'信息'，'调试'， 和 '痕迹＇.
  • 类型——枚举
  • 默认的- 信息

tcell_agent_log_destination.

logging_options.destination.

  • 描述- 指定日志输出的类型。
  • 类型-枚举（'stdout'，'file'，'filenorolling'）；FileNorrolling与file相同，但在日志文件达到一定大小后，代理不会滚动日志文件。
  • 默认的-文件

TCELL_AGENT_LOG_FILE_MAX_SIZE_MB

logging_options.max_file_size_mb.

描述设置允许的tCell日志文件的最大大小(mb)。日志文件的初始大小和最小大小为1mb，没有最大大小限制。日志文件文件夹中的每个日志文件都有大小限制，最多可以保存10个日志文件。\n\n日志文件文件夹的位置取决于代理类型。对于IIS和。net代理类型，日志文件夹的位置取决于配置和运行tCell的应用程序的id:

  • IIS.\ nc：\\ programdata \\ Rapid7，Inc \\ TCell IIS代理\\ LM \\ W3SVC \\ 2 \\ root \\ [子应用程序名称] \ n
  • 。网\ nc：\\ programdata \\ tavic7，Inc \\ TCell .NET代理\\ [Web App Name] \\ [子应用程序名称]
  • 对于所有其他代理类型，日志文件文件夹位置是\ n\ \ n ntcell /日志

tcell_agent_hmac_key.

HMAC_KEY.

  • 描述-用于在tCell Agent事件中哈希敏感值的键。
  • 类型——字符串
  • 默认的- 如果自定义，请将其设置为相同应用程序中的所有代理的相同值。
  • 必需的- N

TCELL_AGENT_PASSWORD_HMAC_KEY

password_hmac_key.

  • 描述- 用于哈希密码值的键，以获取与帐户收购相关的登录事件。
  • 类型——字符串
  • 默认的- N

tcell_agent_cache_dir.

N / A.

  • 描述—策略缓存所在目录的文件绝对路径。
  • 类型——字符串
  • 默认的

tcell_agent_reverse_proxy.

Reverse_proxy.

  • 描述- 当True时，代理假定应用程序存在反向代理转发流量。
  • 类型- 布尔值
  • 默认的-真的
  • 必需的- N

TCELL_AGENT_REVERSE_PROXY_IP_ADDRESS_HEADER

reverse_proxy_ip_address_header.

  • 描述- 标题以检查请求始发的IP
  • 类型——字符串
  • 默认的-X-Forthed-for
  • 必需的- N
  • 例子-X-Real-IP

tcell_agent_max_header_size.

max_csp_header_bytes

  • 描述- 由代理注入的响应标头的最大大小为字节。如果代理配置的标题超过此阈值，则不会设置标题。通常这会影响代理设置的内容 - 安全策略（CSP）相关标头。

  • 笔记

    • .NET / .NET核心代理 - 默认标题大小10240字节。标题不能超过32768字节的最大大小。
    • Node.js代理 - 标题不能超过16384字节的最大大小。
    • Python代理-头文件不能超过16384字节的最大大小。
    • Ruby Agent - 标题不能超过16384字节的最大大小。
    • IIS Web服务器 - 没有最大标头大小限制
    • Java代理 - 没有最大标题大小限制
    • napache安装 - 默认标头大小10240字节;没有最大标题大小限制

tcell_agent_max_routes.

max_routes.

  • 描述- 限制要检测和报告TCELL服务的最大路由数。当在Web服务器环境中运行时，路由数量的诸如千万或成千上万的千万或成千上万的千万，可以防止代理使用过多的资源识别和将路径信息发送到服务。\ nif未指定，默认为10000.最小值为100。
  • 类型——整数
  • 默认的-10000
  • 必需的- N
  • 例子-1000

tcell_agent_js_agent_api_url.

js_agent_api_base_url

  • 描述- 从注入的JS代理发送事件的URL前缀
  • 类型——字符串
  • 必需的- N
  • 默认的-https://us.agent.tcell.insight.rapid7.com/api/v1，https://us2.agent.tcell.Insight.Rapid7.com/api/v1.，https://us3.agent.tcell.Insight.Rapid7.com/api/v1.https://eu.agent.tcell.insight.rapid7.com/api/v1，https://au.agent.tcell.insight.rapid7.com/api/v1

tcell_agent_js_agent_url.

js_agent_url.

  • 描述- 检索JS代理的URL
  • 类型——字符串
  • 默认的-https://us.jsagent.tcell.insight.rapid7.com/tcellagent.min.js.

tcell_agent_update_policy.

fetch_policies_from_tcell

  • 描述- 当假时，代理不会更新其策略。
  • 类型——布尔
  • 默认的-真的

TCELL_AGENT_SERVER_HEADER_OFF

（仅限Nginx）

server_header_off.

  • 描述- 当为true时，代理从响应中删除任何“服务器”标题条目，以避免泄漏信息。
  • 类型- 布尔值
  • 默认的- N
  • 必需的- N
  • 例子-假

TCELL_AGENT_IIS_URL_REWRITE

（仅限.NET）

iis_url_rewrite

  • 描述- 如果运行应用程序请求路由（arr），则将其设置为true。\ nwith默认代理行为，代理可能会干扰包含旨在路由到另一个服务器的正文的请求。当真的时，我们通过在阅读后重新编写身体来解决问题。
  • 类型- 布尔值
  • 默认的-假
  • 必需的- N
  • 例子-真的

tcell_agent_log_file_access.

(JVM) log_file_access

  • 描述- 当为true时，代理日志在已配置日志目录中的两个文件中的文件访问：

  • opened_for_read.csv.＼

  • opened_for_write.csv.

  • 类型- 布尔值

  • 默认的-假

  • 必需的- N例子-“这是本地的秘密”

  • 笔记应该只用于调试，因为应用程序性能可能会受到影响。

tcell_agent_package_tracker_interval_ms.

(JVM) N / A

  • 描述- 包装跟踪器应如何检查新见面的代码源，以毫秒为单位。
  • 类型- 数字
  • 默认的-30000

tcell_agent_tomcat_specific_redirects.

（仅限JVM）Tomcat_specific_redirects

  • 描述- 当真实时，代理注册了特定于Tomcat的额外重定向仪器。通常这是不必要的，即使使用Tomcat。
  • 类型- 布尔值
  • 默认的-假

已弃用/已删除的环境变量和等价物

弃用 相等的
tcell_password_hmac_key. TCELL_AGENT_PASSWORD_HMAC_KEY
TCELL_MAX_HTTP_HEADER_SIZE tcell_agent_max_header_size.
tcell_hmac_key. tcell_agent_hmac_key.
tcell_agent_inspect_json_posts. tcell_agent_enable_json_body_inspection.
TCELL_AGENT_LOG_FILE_SIZE TCELL_AGENT_LOG_FILE_MAX_SIZE_MB
TCELL_API_URL TCELL_AGENT_API_URL

无需环境变量的配置文件属性

session_identifiers

  • 描述- 保存会话值的“cookie”，'标题'或'querystring'参数
  • 类型-SessionIdentifier数组SessionIdentifier:{“类型”：“，“名称”：”？“}
  • 默认的-
  • 必需的- N
  • 例子- [{“类型”：“cookie”，“名称”：“mycustomsesscookie”}“]

do_not_instrument.

（仅限JVM）

  • 描述- 从仪器中排除的完全限定Java类名称。
  • 类型- 字符串数组
  • 默认的- N
  • 必需的- N
  • 例子-[\“java.lang.String\”，\“java.util.Map\”]

Enabled_instrumentations.

(仅限Ruby和Python)从Python 1.7.2开始，您可以禁用本地文件和操作系统命令实现。有关更多信息，请参见关闭本地文件和操作系统命令特性．

类型json对象(哈希)描述- 启用/禁用特定库仪器。这意味着使用TCell-Hooks时避免冲突。默认的- 空值必需的- N例子- {“Enabled_Instrumentations”：{“门卫”：True，“Devise”：True，“authlogic”：true}}

子选项- 门卫

  • 类型- 布尔值
  • 描述-启用/禁用门卫库仪器。
  • 默认的- 真的
  • 必需的- N
  • 例子- 错误的

子选项——设计

  • 类型- 布尔值
  • 描述-启用/禁用设计库仪器。
  • 默认的- 真的
  • 必需的- N
  • 例子- 错误的

子选项- authlogic.

  • 类型- 布尔值
  • 描述- 启用/禁用AuthLogic库仪器。
  • 默认的- 真的
  • 必需的- N
  • 例子- 错误的

子选项- django_auth.

  • 类型- 布尔值
  • 描述-启用/禁用django_auth库检测。
  • 默认的- 真的
  • 必需的- N
  • 例子- 错误的