diff options
Diffstat (limited to '.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.HttpOverrides.xml')
| -rwxr-xr-x | .packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.HttpOverrides.xml | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.HttpOverrides.xml b/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.HttpOverrides.xml new file mode 100755 index 0000000000..e81d761728 --- /dev/null +++ b/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.HttpOverrides.xml @@ -0,0 +1,231 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>Microsoft.AspNetCore.HttpOverrides</name> + </assembly> + <members> + <member name="T:Microsoft.AspNetCore.Builder.CertificateForwardingBuilderExtensions"> + <summary> + Extension methods for using certificate fowarding. + </summary> + </member> + <member name="M:Microsoft.AspNetCore.Builder.CertificateForwardingBuilderExtensions.UseCertificateForwarding(Microsoft.AspNetCore.Builder.IApplicationBuilder)"> + <summary> + Adds a middleware to the pipeline that will look for a certificate in a request header + decode it, and updates HttpContext.Connection.ClientCertificate. + </summary> + <param name="app"></param> + <returns></returns> + </member> + <member name="M:Microsoft.AspNetCore.Builder.ForwardedHeadersExtensions.UseForwardedHeaders(Microsoft.AspNetCore.Builder.IApplicationBuilder)"> + <summary> + Forwards proxied headers onto current request + </summary> + <param name="builder"></param> + <returns></returns> + </member> + <member name="M:Microsoft.AspNetCore.Builder.ForwardedHeadersExtensions.UseForwardedHeaders(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Builder.ForwardedHeadersOptions)"> + <summary> + Forwards proxied headers onto current request + </summary> + <param name="builder"></param> + <param name="options">Enables the different forwarding options.</param> + <returns></returns> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedForHeaderName"> + <summary> + Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedForHeaderName"/> + </summary> + <seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedHostHeaderName"> + <summary> + Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedHostHeaderName"/> + </summary> + <seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedProtoHeaderName"> + <summary> + Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedProtoHeaderName"/> + </summary> + <seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.OriginalForHeaderName"> + <summary> + Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalForHeaderName"/> + </summary> + <seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.OriginalHostHeaderName"> + <summary> + Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalHostHeaderName"/> + </summary> + <seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.OriginalProtoHeaderName"> + <summary> + Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalProtoHeaderName"/> + </summary> + <seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedHeaders"> + <summary> + Identifies which forwarders should be processed. + </summary> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardLimit"> + <summary> + Limits the number of entries in the headers that will be processed. The default value is 1. + Set to null to disable the limit, but this should only be done if + KnownProxies or KnownNetworks are configured. + </summary> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.KnownProxies"> + <summary> + Addresses of known proxies to accept forwarded headers from. + </summary> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.KnownNetworks"> + <summary> + Address ranges of known proxies to accept forwarded headers from. + </summary> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.AllowedHosts"> + <summary> + The allowed values from x-forwarded-host. If the list is empty then all hosts are allowed. + Failing to restrict this these values may allow an attacker to spoof links generated by your service. + </summary> + <remarks> + <list type="bullet"> + <item><description>Port numbers must be excluded.</description></item> + <item><description>A top level wildcard "*" allows all non-empty hosts.</description></item> + <item><description>Subdomain wildcards are permitted. E.g. "*.example.com" matches subdomains like foo.example.com, + but not the parent domain example.com.</description></item> + <item><description>Unicode host names are allowed but will be converted to punycode for matching.</description></item> + <item><description>IPv6 addresses must include their bounding brackets and be in their normalized form.</description></item> + </list> + </remarks> + </member> + <member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.RequireHeaderSymmetry"> + <summary> + Require the number of header values to be in sync between the different headers being processed. + The default is 'false'. + </summary> + </member> + <member name="M:Microsoft.AspNetCore.Builder.HttpMethodOverrideExtensions.UseHttpMethodOverride(Microsoft.AspNetCore.Builder.IApplicationBuilder)"> + <summary> + Allows incoming POST request to override method type with type specified in header. + </summary> + <param name="builder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param> + </member> + <member name="M:Microsoft.AspNetCore.Builder.HttpMethodOverrideExtensions.UseHttpMethodOverride(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Builder.HttpMethodOverrideOptions)"> + <summary> + Allows incoming POST request to override method type with type specified in form. + </summary> + <param name="builder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param> + <param name="options">The <see cref="T:Microsoft.AspNetCore.Builder.HttpMethodOverrideOptions"/>.</param> + </member> + <member name="P:Microsoft.AspNetCore.Builder.HttpMethodOverrideOptions.FormFieldName"> + <summary> + Denotes the form element that contains the name of the resulting method type. + If not set the X-Http-Method-Override header will be used. + </summary> + </member> + <member name="T:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingMiddleware"> + <summary> + Middleware that converts a forward header into a client certificate if found. + </summary> + </member> + <member name="M:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.HttpOverrides.CertificateForwardingOptions})"> + <summary> + Constructor. + </summary> + <param name="next"></param> + <param name="loggerFactory"></param> + <param name="options"></param> + </member> + <member name="M:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)"> + <summary> + Looks for the presence of a <see cref="P:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingOptions.CertificateHeader"/> header in the request, + if found, converts this header to a ClientCertificate set on the connection. + </summary> + <param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param> + <returns>A <see cref="T:System.Threading.Tasks.Task"/>.</returns> + </member> + <member name="T:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingOptions"> + <summary> + Used to configure the <see cref="T:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingMiddleware"/>. + </summary> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingOptions.CertificateHeader"> + <summary> + The name of the header containing the client certificate. + </summary> + <remarks> + This defaults to X-Client-Cert + </remarks> + </member> + <member name="F:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingOptions.HeaderConverter"> + <summary> + The function used to convert the header to an instance of <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>. + </summary> + <remarks> + This defaults to a conversion from a base64 encoded string. + </remarks> + </member> + <member name="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"> + <summary> + Default values related to <see cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersMiddleware"/> middleware + </summary> + <seealso cref="T:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions"/> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedForHeaderName"> + <summary> + X-Forwarded-For + </summary> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedHostHeaderName"> + <summary> + X-Forwarded-Host + </summary> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedProtoHeaderName"> + <summary> + X-Forwarded-Proto + </summary> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalForHeaderName"> + <summary> + X-Original-For + </summary> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalHostHeaderName"> + <summary> + X-Original-Host + </summary> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalProtoHeaderName"> + <summary> + X-Original-Proto + </summary> + </member> + <member name="P:Microsoft.AspNetCore.HttpOverrides.IPNetwork.PrefixLength"> + <summary> + The CIDR notation of the subnet mask + </summary> + </member> + <member name="T:Microsoft.Extensions.DependencyInjection.CertificateForwardingServiceExtensions"> + <summary> + Extension methods for using certificate fowarding. + </summary> + </member> + <member name="M:Microsoft.Extensions.DependencyInjection.CertificateForwardingServiceExtensions.AddCertificateForwarding(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.HttpOverrides.CertificateForwardingOptions})"> + <summary> + Adds certificate forwarding to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. + </summary> + <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param> + <param name="configure">An action delegate to configure the provided <see cref="T:Microsoft.AspNetCore.HttpOverrides.CertificateForwardingOptions"/>.</param> + <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns> + </member> + </members> +</doc> |