summaryrefslogtreecommitdiff
path: root/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.HttpsPolicy.xml
blob: 2d505839c1741b0998736748f18543db47b9f67f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.AspNetCore.HttpsPolicy</name>
    </assembly>
    <members>
        <member name="T:Microsoft.AspNetCore.Builder.HstsBuilderExtensions">
            <summary>
            Extension methods for the HSTS middleware.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.HstsBuilderExtensions.UseHsts(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
            <summary>
            Adds middleware for using HSTS, which adds the Strict-Transport-Security header.
            </summary>
            <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param>
        </member>
        <member name="T:Microsoft.AspNetCore.Builder.HstsServicesExtensions">
            <summary>
            Extension methods for the HSTS middleware.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.HstsServicesExtensions.AddHsts(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.HttpsPolicy.HstsOptions})">
            <summary>
            Adds HSTS services.
            </summary>
            <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for adding services.</param>
            <param name="configureOptions">A delegate to configure the <see cref="T:Microsoft.AspNetCore.HttpsPolicy.HstsOptions"/>.</param>
            <returns></returns>
        </member>
        <member name="T:Microsoft.AspNetCore.Builder.HttpsPolicyBuilderExtensions">
            <summary>
            Extension methods for the HttpsRedirection middleware.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.HttpsPolicyBuilderExtensions.UseHttpsRedirection(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
            <summary>
            Adds middleware for redirecting HTTP Requests to HTTPS.
            </summary>
            <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param>
            <returns>The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> for HttpsRedirection.</returns>
        </member>
        <member name="T:Microsoft.AspNetCore.Builder.HttpsRedirectionServicesExtensions">
            <summary>
            Extension methods for the HttpsRedirection middleware.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.HttpsRedirectionServicesExtensions.AddHttpsRedirection(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionOptions})">
            <summary>
            Adds HTTPS redirection services.
            </summary>
            <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for adding services.</param>
            <param name="configureOptions">A delegate to configure the <see cref="T:Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionOptions"/>.</param>
            <returns></returns>
        </member>
        <member name="T:Microsoft.AspNetCore.HttpsPolicy.HstsMiddleware">
            <summary>
            Enables HTTP Strict Transport Security (HSTS)
            See https://tools.ietf.org/html/rfc6797.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.HttpsPolicy.HstsMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.HttpsPolicy.HstsOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
            <summary>
            Initialize the HSTS middleware.
            </summary>
            <param name="next"></param>
            <param name="options"></param>
            <param name="loggerFactory"></param>
        </member>
        <member name="M:Microsoft.AspNetCore.HttpsPolicy.HstsMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.HttpsPolicy.HstsOptions})">
            <summary>
            Initialize the HSTS middleware.
            </summary>
            <param name="next"></param>
            <param name="options"></param>
        </member>
        <member name="M:Microsoft.AspNetCore.HttpsPolicy.HstsMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
            <summary>
            Invoke the middleware.
            </summary>
            <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
            <returns></returns>
        </member>
        <member name="T:Microsoft.AspNetCore.HttpsPolicy.HstsOptions">
            <summary>
            Options for the Hsts Middleware
            </summary>
        </member>
        <member name="P:Microsoft.AspNetCore.HttpsPolicy.HstsOptions.MaxAge">
            <summary>
            Sets the max-age parameter of the Strict-Transport-Security header.
            </summary>
            <remarks>
            Max-age is required; defaults to 30 days.
            See: https://tools.ietf.org/html/rfc6797#section-6.1.1
            </remarks>
        </member>
        <member name="P:Microsoft.AspNetCore.HttpsPolicy.HstsOptions.IncludeSubDomains">
            <summary>
            Enables includeSubDomain parameter of the Strict-Transport-Security header.
            </summary>
            <remarks>
            See: https://tools.ietf.org/html/rfc6797#section-6.1.2
            </remarks>
        </member>
        <member name="P:Microsoft.AspNetCore.HttpsPolicy.HstsOptions.Preload">
            <summary>
            Sets the preload parameter of the Strict-Transport-Security header.
            </summary>
            <remarks>
            Preload is not part of the RFC specification, but is supported by web browsers
            to preload HSTS sites on fresh install. See https://hstspreload.org/.
            </remarks>
        </member>
        <member name="P:Microsoft.AspNetCore.HttpsPolicy.HstsOptions.ExcludedHosts">
            <summary>
            A list of host names that will not add the HSTS header.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionOptions},Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Logging.ILoggerFactory)">
            <summary>
            Initializes the HttpsRedirectionMiddleware
            </summary>
            <param name="next"></param>
            <param name="options"></param>
            <param name="config"></param>
            <param name="loggerFactory"></param>
        </member>
        <member name="M:Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionOptions},Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature)">
            <summary>
            Initializes the HttpsRedirectionMiddleware
            </summary>
            <param name="next"></param>
            <param name="options"></param>
            <param name="config"></param>
            <param name="loggerFactory"></param>
            <param name="serverAddressesFeature">The</param>
        </member>
        <member name="M:Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
            <summary>
            Invokes the HttpsRedirectionMiddleware
            </summary>
            <param name="context"></param>
            <returns></returns>
        </member>
        <member name="T:Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionOptions">
            <summary>
            Options for the HttpsRedirection middleware
            </summary>
        </member>
        <member name="P:Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionOptions.RedirectStatusCode">
            <summary>
            The status code used for the redirect response. The default is 307.
            </summary>
        </member>
        <member name="P:Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionOptions.HttpsPort">
            <summary>
            The HTTPS port to be added to the redirected URL.
            </summary>
            <remarks>
            If the HttpsPort is not set, we will try to get the HttpsPort from the following:
            1. HTTPS_PORT environment variable
            2. IServerAddressesFeature
            If that fails then the middleware will log a warning and turn off.
            </remarks>
        </member>
    </members>
</doc>