-
Notifications
You must be signed in to change notification settings - Fork 112
/
RequireHttpsAttribute.xml
247 lines (247 loc) · 15.1 KB
/
RequireHttpsAttribute.xml
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<Type Name="RequireHttpsAttribute" FullName="Microsoft.AspNetCore.Mvc.RequireHttpsAttribute">
<TypeSignature Language="C++ CLI" Value="public ref class RequireHttpsAttribute : Attribute, Microsoft::AspNetCore::Mvc::Filters::IAuthorizationFilter, Microsoft::AspNetCore::Mvc::Filters::IOrderedFilter" />
<TypeSignature Language="C#" Value="public class RequireHttpsAttribute : Attribute, Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter, Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RequireHttpsAttribute extends System.Attribute implements class Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter, class Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata, class Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.RequireHttpsAttribute" />
<TypeSignature Language="VB.NET" Value="Public Class RequireHttpsAttribute
Inherits Attribute
Implements IAuthorizationFilter, IOrderedFilter" />
<TypeSignature Language="F#" Value="type RequireHttpsAttribute = class
 inherit Attribute
 interface IAuthorizationFilter
 interface IFilterMetadata
 interface IOrderedFilter" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
An authorization filter that confirms requests are received over HTTPS.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 RequireHttpsAttribute();" />
<MemberSignature Language="C#" Value="public RequireHttpsAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HandleNonHttpsRequest">
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void HandleNonHttpsRequest(Microsoft::AspNetCore::Mvc::Filters::AuthorizationFilterContext ^ filterContext);" />
<MemberSignature Language="C#" Value="protected virtual void HandleNonHttpsRequest (Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext filterContext);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void HandleNonHttpsRequest(class Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext filterContext) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.HandleNonHttpsRequest(Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub HandleNonHttpsRequest (filterContext As AuthorizationFilterContext)" />
<MemberSignature Language="F#" Value="abstract member HandleNonHttpsRequest : Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext -> unit
override this.HandleNonHttpsRequest : Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext -> unit" Usage="requireHttpsAttribute.HandleNonHttpsRequest filterContext" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterContext" Type="Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext" />
</Parameters>
<Docs>
<param name="filterContext">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext" /> to update.</param>
<summary>
Called from <see cref="M:Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.OnAuthorization(Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext)" /> if the request is not received over HTTPS. Expectation is
<see cref="P:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.Result" /> will not be <c>null</c> after this method returns.
</summary>
<remarks>
If it was a GET request, default implementation sets <see cref="P:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.Result" /> to a
result which will redirect the client to the HTTPS version of the request URI. Otherwise, default
implementation sets <see cref="P:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.Result" /> to a result which will set the status
code to <c>403</c> (Forbidden).
</remarks>
</Docs>
</Member>
<Member MemberName="OnAuthorization">
<MemberSignature Language="C++ CLI" Value="public:
 virtual void OnAuthorization(Microsoft::AspNetCore::Mvc::Filters::AuthorizationFilterContext ^ filterContext);" />
<MemberSignature Language="C#" Value="public virtual void OnAuthorization (Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext filterContext);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnAuthorization(class Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext filterContext) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.OnAuthorization(Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub OnAuthorization (filterContext As AuthorizationFilterContext)" />
<MemberSignature Language="F#" Value="abstract member OnAuthorization : Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext -> unit
override this.OnAuthorization : Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext -> unit" Usage="requireHttpsAttribute.OnAuthorization filterContext" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter.OnAuthorization(Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterContext" Type="Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext" />
</Parameters>
<Docs>
<param name="filterContext">To be added.</param>
<summary>
Called early in the filter pipeline to confirm request is authorized. Confirms requests are received over
HTTPS. Takes no action for HTTPS requests. Otherwise if it was a GET request, sets
<see cref="P:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.Result" /> to a result which will redirect the client to the HTTPS
version of the request URI. Otherwise, sets <see cref="P:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.Result" /> to a result
which will set the status code to <c>403</c> (Forbidden).
</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Order">
<MemberSignature Language="C++ CLI" Value="public:
 property int Order { int get(); void set(int value); };" />
<MemberSignature Language="C#" Value="public int Order { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Order" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.Order" />
<MemberSignature Language="VB.NET" Value="Public Property Order As Integer" />
<MemberSignature Language="F#" Value="member this.Order : int with get, set" Usage="Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.Order" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>Default is <c>int.MinValue + 50</c> to run this <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter" /> early.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Permanent">
<MemberSignature Language="C++ CLI" Value="public:
 property bool Permanent { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool Permanent { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Permanent" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.Permanent" />
<MemberSignature Language="VB.NET" Value="Public Property Permanent As Boolean" />
<MemberSignature Language="F#" Value="member this.Permanent : bool with get, set" Usage="Microsoft.AspNetCore.Mvc.RequireHttpsAttribute.Permanent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Core</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies whether a permanent redirect, <c>301 Moved Permanently</c>,
should be used instead of a temporary redirect, <c>302 Found</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>