iframe-proxy | Sunbelt Computer Software

History

122 lines (106 loc) · 5.33 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

namespace NpgsqlRest;

/// <summary>

/// Options for configuring reverse proxy functionality for NpgsqlRest endpoints.

/// When an endpoint is marked as a proxy, incoming requests are forwarded to another URL.

/// </summary>

public class ProxyOptions

{

/// <summary>

/// Enable proxy functionality for annotated endpoints.

/// When false, proxy annotations are ignored.

/// </summary>

public bool Enabled { get; set; } = false;

/// <summary>

/// Base URL (host) for proxy requests (e.g., "https://api.example.com").

/// When set, proxy endpoints will forward requests to this host + the original path.

/// Can be overridden per-endpoint via comment annotation.

/// </summary>

public string? Host { get; set; } = null;

/// <summary>

/// Default timeout for all proxy requests.

/// </summary>

public TimeSpan DefaultTimeout { get; set; } = TimeSpan.FromSeconds(30);

/// <summary>

/// When true, original request headers are forwarded to the proxy target.

/// Headers in ExcludeHeaders are not forwarded.

/// </summary>

public bool ForwardHeaders { get; set; } = true;

/// <summary>

/// Headers to exclude from forwarding to the proxy target.

/// Default excludes Host, Content-Length, and Transfer-Encoding.

/// </summary>

public HashSet<string> ExcludeHeaders { get; set; } = new(StringComparer.OrdinalIgnoreCase)

{

"Host",

"Content-Length",

"Transfer-Encoding"

};

/// <summary>

/// When true, forward response headers from proxy back to client.

/// Headers in ExcludeResponseHeaders are not forwarded.

/// </summary>

public bool ForwardResponseHeaders { get; set; } = true;

/// <summary>

/// Response headers to exclude from forwarding back to client.

/// </summary>

public HashSet<string> ExcludeResponseHeaders { get; set; } = new(StringComparer.OrdinalIgnoreCase)

{

"Transfer-Encoding",

"Content-Length"

};

/// <summary>

/// Default name for the proxy response status code parameter.

/// If a routine has a parameter with this name, it will receive the proxy response status code.

/// </summary>

public string ResponseStatusCodeParameter { get; set; } = "_proxy_status_code";

/// <summary>

/// Default name for the proxy response body parameter.

/// If a routine has a parameter with this name, it will receive the proxy response body.

/// </summary>

public string ResponseBodyParameter { get; set; } = "_proxy_body";

/// <summary>

/// Default name for the proxy response headers parameter.

/// If a routine has a parameter with this name, it will receive the proxy response headers as JSON.

/// </summary>

public string ResponseHeadersParameter { get; set; } = "_proxy_headers";

/// <summary>

/// Default name for the proxy response content type parameter.

/// If a routine has a parameter with this name, it will receive the proxy response content type.

/// </summary>

public string ResponseContentTypeParameter { get; set; } = "_proxy_content_type";

/// <summary>

/// Default name for the proxy response success parameter.

/// If a routine has a parameter with this name, it will receive a boolean indicating if the request succeeded (2xx status).

/// </summary>

public string ResponseSuccessParameter { get; set; } = "_proxy_success";

/// <summary>

/// Default name for the proxy response error message parameter.

/// If a routine has a parameter with this name, it will receive any error message from the proxy request.

/// </summary>

public string ResponseErrorMessageParameter { get; set; } = "_proxy_error_message";

/// <summary>

/// When true, for upload endpoints marked as proxy, the raw multipart/form-data content

/// is forwarded directly to the upstream proxy instead of being processed locally.

/// This allows the upstream service to handle file uploads.

/// When false (default), upload endpoints with proxy annotation will process uploads locally

/// and upload metadata will not be available to the proxy.

/// </summary>

public bool ForwardUploadContent { get; set; } = false;

/// <summary>

/// Base URL for resolving relative paths in proxy annotations (e.g., "proxy /api/test").

/// When set, relative URLs are prefixed with this base URL. When null, the server's

/// own listening address is auto-detected at runtime from the first incoming request.

/// Example: "http://localhost:5000"

/// </summary>

public string? SelfBaseUrl { get; set; }

/// <summary>

/// Maximum length (in characters) of a single automatic parameter value that may be appended

/// to the proxy upstream query string. Server-filled parameters (user claims, IP address, HTTP

/// Custom Type fields, resolved-parameter expressions) whose value exceeds this length are

/// skipped (and a warning is logged) instead of being percent-encoded into the URL, which would

/// produce an unusable request line (HTTP 414/431, or a connection reset). A value of 0 or less

/// disables the guard (no limit). To forward a large value to the upstream, use a body-carrying

/// proxy method (POST/PUT/PATCH) so it goes into the request body instead of the query string.

/// </summary>

public int MaxForwardedQueryParamLength { get; set; } = 2048;

}

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Uh oh!

FilesExpand file tree

ProxyOptions.cs

Latest commit

History

ProxyOptions.cs

File metadata and controls