plugins

type BasicAuth struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type BasicAuthConf struct {
	Disable bool `json:"disable"`
}

type Cors struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type CorsConf struct {
	Disable bool `json:"disable"`
	// AllowOrigins 允许跨域访问的 Origin。格式为 scheme://host:port，示例如 https://somedomain.com:8081
	// 当 allow_credential 为 false 时，
	// 可以使用 * 来表示允许所有 Origin 通过。
	// 你也可以在启用了 allow_credential 后使用 ** 强制允许所有 Origin 均通过，
	// 但请注意这样存在安全隐患。
	AllowOrigins []string `json:"allow_origins,omitempty"`
	// AllowMethods 允许跨域访问的 Method，比如：GET，POST 等。
	// 当 allow_credential 为 false 时，
	// 可以使用 * 来表示允许所有 Method 通过。
	// 你也可以在启用了 allow_credential 后使用 ** 强制允许所有 Method 都通过，
	// 但请注意这样存在安全隐患。
	AllowMethods []string `json:"allow_methods,omitempty"` // 允许跨域访问的 Method
	// AllowHeaders 允许跨域访问时请求方携带哪些非 CORS 规范 以外的 Header。
	// 当 allow_credential 为 false 时，
	// 可以使用 * 来表示允许所有 Header 通过。
	// 你也可以在启用了 allow_credential 后使用 ** 强制允许所有 Header 都通过，
	// 但请注意这样存在安全隐患。
	AllowHeaders []string `json:"allow_headers,omitempty"`
	// ExposeHeaders 允许跨域访问时响应方携带哪些非 CORS 规范 以外的 Header。
	// 当 allow_credential 为 false 时，
	// 可以使用 * 来表示允许任意 Header 。
	// 你也可以在启用了 allow_credential 后使用 ** 强制允许任意 Header，
	// 但请注意这样存在安全隐患。
	ExposeHeaders []string `json:"expose_headers,omitempty"`
	// MaxAge 浏览器缓存 CORS 结果的最大时间，单位为秒。
	// 在这个时间范围内，浏览器会复用上一次的检查结果，-1 表示不缓存。
	// 请注意各个浏览器允许的最大时间不同
	MaxAge uint64 `json:"max_age,omitempty" default:"5"`
	// AllowCredential 是否允许跨域访问的请求方携带凭据（如 Cookie 等）。
	// 根据 CORS 规范，如果设置该选项为 true，
	// 那么将不能在其他属性中使用 *。
	AllowCredential bool `json:"allow_credential,omitempty"`
	// AllowOriginsByRegex 使用正则表达式数组来匹配允许跨域访问的 Origin，
	// 如 [".*\.test.com"] 可以匹配任何 test.com 的子域名 *。
	AllowOriginsByRegex []string `json:"allow_origins_by_regex,omitempty"`
	// AllowOriginsByMetadata 通过引用插件元数据的 allow_origins 配置允许跨域访问的 Origin。
	// 比如当插件元数据为 "allow_origins": {"EXAMPLE": "https://example.com"} 时，
	// 配置 ["EXAMPLE"] 将允许 Origin https://example.com 的访问。
	AllowOriginsByMetadata []string `json:"allow_origins_by_metadata,omitempty"`
}

type GelfUdpLogger struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type GelfUdpLoggerConf struct {
	Disable         bool   `json:"disable"`
	Host            string `json:"host"`
	Port            uint64 `json:"port"`
	Timeout         uint64 `json:"timeout"`
	LoggerName      string `json:"name"`
	InactiveTimeout uint64 `json:"inactive_timeout"`
	BufferDuration  uint64 `json:"buffer_duration"`
	MaxRetryCount   uint64 `json:"max_retry_count"`
	RetryDelay      uint64 `json:"retry_delay"`
	IncludeReqBody  bool   `json:"include_req_body"`
	BatchMaxSize    uint64 `json:"batch_max_size"`
}

type Gzip struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type GzipConf struct {
	Disable           bool   `json:"disable"`
	HeaderName        string `json:"header_name,omitempty" default:"X-Request-Id"` // 唯一请求ID的标头名称
	IncludeInResponse bool   `json:"include_in_response,omitempty" default:"true"` // true时，在响应头中添加唯一的请求ID。
	Algorithm         string `json:"algorithm,omitempty" default:"uuid"`           // ["uuid", "snowflake", "nanoid"]
}

type Headers struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type HeadersConf struct {
	Disable  bool                  `json:"disable"`
	Request  types.Map             `json:"request"`
	Response types.Map             `json:"response"`
	STS      *PluginHeadersSTSType `json:"sts"`
}

type HttpLogger struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type HttpLoggerConf struct {
	Disable         bool   `json:"disable"`
	URI             string `json:"uri"`
	AuthHeader      string `json:"auth_header"`
	Timeout         uint64 `json:"timeout"`
	LoggerName      string `json:"name"`
	BatchMaxSize    uint64 `json:"batch_max_size"`
	InactiveTimeout uint64 `json:"inactive_timeout"`
	BufferDuration  uint64 `json:"buffer_duration"`
	MaxRetryCount   uint64 `json:"max_retry_count"`
	RetryDelay      uint64 `json:"retry_delay"`
	IncludeReqBody  bool   `json:"include_req_body"`
	ConcatMethod    string `json:"concat_method"`
}

type IpRestriction struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type IpRestrictionConf struct {
	Disable bool `json:"disable"`
	// Whitelist 加入白名单的 IP 地址或 CIDR 范围。
	Whitelist []string `json:"whitelist,omitempty"`
	// 加入黑名单的 IP 地址或 CIDR 范围。
	Blacklist []string `json:"blacklist,omitempty"`
	// Message 不允许访问IP地址时返回的消息[1, 1024]
	Message string `json:"message,omitempty"`
	// contains filtered or unexported fields
}

type JwtAuth struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type JwtAuthConf struct {
	Disable bool `json:"disable"`

	Secret            string `json:"secret"`
	TokenFormat       string `json:"token_format"`
	TokenHeader       string `json:"token_header"`
	ParsedTokenHeader string `json:"parsed_token_header"`
}

type LimitReq struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type LimitReqConf struct {
	Burst int     `json:"burst"`
	Rate  float64 `json:"rate"`
	// contains filtered or unexported fields
}

type MultiResponseRewrite struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type MultiResponseRewriteConf struct {
	Disable  bool                                    `json:"disable"`
	Variants []PluginMultiResponseRewriteVariantType `json:"variants"`
}

type OAuth2 struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type OAuth2Conf struct {
	Disable                         bool   `json:"disable"`
	ClientId                        string `json:"client_id,omitempty" comment:"客户端Id"`
	ClientSecret                    string `json:"client_secret,omitempty" comment:"客户端secret"`
	Discovery                       string `json:"discovery,omitempty" comment:"身份服务器的发现端点的 URL"`
	Real                            string `json:"real,omitempty" comment:"用于认证的领域； 默认为apisix"`
	BearerOnly                      bool   `` /* 127-byte string literal not displayed */
	LogoutPath                      string `json:"logout_path,omitempty" comment:"默认是/logout"`
	RedirectUri                     string `json:"redirect_uri,omitempty"`
	Timeout                         int    `json:"timeout,omitempty" comment:"默认是 3 秒"`
	SslVerify                       bool   `json:"ssl_verify,omitempty" comment:"默认是 false"`
	IntrospectionEndpoint           string `json:"introspection_endpoint,omitempty" comment:"身份服务器的令牌验证端点的 URL"` // token会直接拼接在连接的后面
	IntrospectionEndpointAuthMethod string `json:"introspection_endpoint_auth_method,omitempty" comment:"令牌自省的认证方法名称,如：client_secret_basic"`
	PublicKey                       string `json:"public_key,omitempty" comment:"验证令牌的公钥"`
	TokenSigningAlgValuesExpected   string `json:"token_signing_alg_values_expected,omitempty" comment:"用于对令牌进行签名的算法"`
}

type PluginHeadersSTSType struct {
	MaxAge            uint64 `json:"max_age"`
	IncludeSubDomains bool   `json:"include_sub_domains"`
	Preload           bool   `json:"preload"`
}

type PluginMultiResponseRewriteVariantType struct {
	StatusCode int       `json:"status_code"`
	Body       string    `json:"body"`
	BodyBase64 bool      `json:"body_base64"`
	Headers    types.Map `json:"headers"`
	Vars       string    `json:"vars"`
}

type PluginRedirectRegexVariantType struct {
	Pattern    string `json:"pattern"`
	Replace    string `json:"replace"`
	StatusCode int    `json:"status_code"`
}

type Prometheus struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type PrometheusConf struct {
	Disable    bool `json:"disable"`
	PreferName bool `json:"prefer_name"` // true:打印Route/Service名称，而不是Prometheus中的ID

	Path             string    `json:"path"`
	Port             string    `json:"Port"`
	HistogramBuckets []float64 `json:"histogram_buckets"`
}

type ProxyCache struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type ProxyCacheConf struct {
	Disable          bool     `json:"disable"`
	CacheStrategy    string   `json:"cache_strategy"`
	CacheZone        string   `json:"cache_zone"`
	CacheKey         []string `json:"cache_key"`
	CacheBypass      []string `json:"cache_bypass"`
	CacheMethod      []string `json:"cache_method"`
	CacheHTTPStatus  []string `json:"cache_http_status"`
	HideCacheHeaders bool     `json:"hide_cache_headers"`
	CacheControl     bool     `json:"cache_control"`
	NoCache          []string `json:"no_cache"`
	CacheTTL         int      `json:"cache_ttl"`
}

type ProxyRewrite struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type ProxyRewriteConf struct {
	Disable  bool              `json:"disable"`
	Scheme   string            `json:"scheme,omitempty"`    // 协议改写，http/https
	Method   string            `json:"method,omitempty"`    // 被改写的method
	Uri      string            `json:"uri,omitempty"`       // url改写
	Host     string            `json:"host,omitempty"`      // host进行改写
	Headers  map[string]string `json:"headers,omitempty"`   // 修改的header头，如果value为空时，代表删除该key
	RegexUri []string          `json:"regex_uri,omitempty"` // uri的正则
}

type RealIP struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type RealIPConf struct {
	Disable bool `json:"disable"`
	// Source 数据来源，如 arg_realip 或 http_x_forwarded_for,
	// 动态设置客户端的 IP 地址和端口。
	// 如果该值不包含端口，则不会更改客户端的端口。
	Source string `json:"source" validate:"required"`
	// TrustedAddresses IP 或 CIDR 范围列表
	// 动态设置 set_real_ip_from 字段
	TrustedAddresses []string `json:"trusted_addresses,omitempty"`
	// Recursive 如果禁用递归搜索，则与受信任地址之一匹配的原始客户端地址将替换为配置的source中发送的最后一个地址。
	// 如果启用递归搜索，则与受信任地址之一匹配的原始客户端地址将替换为配置的source中发送的最后一个非受信任地址。
	Recursive bool `json:"recursive,omitempty"`
}

type Redirect struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type RedirectConf struct {
	Disable           bool     `json:"disable"`
	HTTPToHTTPS       bool     `json:"http_to_https"`
	URI               string   `json:"uri"`
	RegexUri          []string `json:"regex_uri"`
	RetCode           int      `json:"ret_code"`
	EncodeURI         bool     `json:"encode_uri"`
	AppendQueryString bool     `json:"append_query_string"`
}

type RedirectRegex struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type RedirectRegexConf struct {
	Disable  bool                             `json:"disable"`
	Variants []PluginRedirectRegexVariantType `json:"variants"`
}

type RegexFilter struct {
	Regex   string `json:"regex"`
	Scope   string `json:"scope"`
	Replace string `json:"replace"`
	// contains filtered or unexported fields
}

type RequestId struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type RequestIdConf struct {
	Disable           bool   `json:"disable"`
	HeaderName        string `json:"header_name,omitempty" default:"X-Request-Id"` // 唯一请求ID的标头名称
	IncludeInResponse bool   `json:"include_in_response,omitempty" default:"true"` // true时，在响应头中添加唯一的请求ID。
	Algorithm         string `json:"algorithm,omitempty" default:"uuid"`           // ["uuid", "snowflake", "nanoid"]
}

type ResponseRewrite struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type ResponseRewrite2 struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type ResponseRewrite2Conf struct {
	Disable bool              `json:"disable"`
	Status  int               `json:"status"`
	Headers map[string]string `json:"headers"`
	Body    string            `json:"body"`
	Filters []RegexFilter     `json:"filters"`
}

type ResponseRewriteConf struct {
	Disable    bool      `json:"disable"`
	StatusCode int       `json:"status_code"`
	Body       string    `json:"body"`
	BodyBase64 bool      `json:"body_base64"`
	Headers    types.Map `json:"headers"`
	Vars       string    `json:"vars"`
}

type Say struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type SayConf struct {
	Disable bool   `json:"disable"`
	Body    string `json:"body"`
}

type ServerlessPostFunction struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type ServerlessPostFunctionConf struct {
	Disable   bool     `json:"disable"`
	Phase     string   `json:"phase"`
	Functions []string `json:"functions"`
}

type ServerlessPreFunction struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type ServerlessPreFunctionConf struct {
	Disable   bool     `json:"disable"`
	Phase     string   `json:"phase"`
	Functions []string `json:"functions"`
}

type Syslog struct {
	plugins.DefaultPlugin
	// contains filtered or unexported fields
}

type SyslogConf struct {
	Disable      bool   `json:"disable"`
	Host         string `tfsdk:"host"`
	Port         int    `tfsdk:"port"`
	BatchMaxSize uint64 `tfsdk:"batch_max_size"`
}