-
Notifications
You must be signed in to change notification settings - Fork 255
/
PopTokenAuthenticationPolicy.xml
266 lines (266 loc) · 21 KB
/
PopTokenAuthenticationPolicy.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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<Type Name="PopTokenAuthenticationPolicy" FullName="Azure.Core.Pipeline.PopTokenAuthenticationPolicy">
<TypeSignature Language="C#" Value="public class PopTokenAuthenticationPolicy : Azure.Core.Pipeline.HttpPipelinePolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PopTokenAuthenticationPolicy extends Azure.Core.Pipeline.HttpPipelinePolicy" />
<TypeSignature Language="DocId" Value="T:Azure.Core.Pipeline.PopTokenAuthenticationPolicy" />
<TypeSignature Language="VB.NET" Value="Public Class PopTokenAuthenticationPolicy
Inherits HttpPipelinePolicy" />
<TypeSignature Language="F#" Value="type PopTokenAuthenticationPolicy = class
 inherit HttpPipelinePolicy" />
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Core.Pipeline.HttpPipelinePolicy</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A policy that supports <see href="https://learn.microsoft.com/entra/msal/dotnet/advanced/proof-of-possession-tokens">Proof of Possession (PoP) tokens</see>.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PopTokenAuthenticationPolicy (Azure.Core.ISupportsProofOfPossession credential, string scope);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Core.ISupportsProofOfPossession credential, string scope) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.#ctor(Azure.Core.ISupportsProofOfPossession,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (credential As ISupportsProofOfPossession, scope As String)" />
<MemberSignature Language="F#" Value="new Azure.Core.Pipeline.PopTokenAuthenticationPolicy : Azure.Core.ISupportsProofOfPossession * string -> Azure.Core.Pipeline.PopTokenAuthenticationPolicy" Usage="new Azure.Core.Pipeline.PopTokenAuthenticationPolicy (credential, scope)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="credential" Type="Azure.Core.ISupportsProofOfPossession" />
<Parameter Name="scope" Type="System.String" />
</Parameters>
<Docs>
<param name="credential">The <see cref="T:Azure.Core.TokenCredential" /> to be used for authorization.</param>
<param name="scope">The scope to be included in acquired tokens.</param>
<summary>
Creates a new instance of <see cref="T:Azure.Core.Pipeline.PopTokenAuthenticationPolicy" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticateAndAuthorizeRequest">
<MemberSignature Language="C#" Value="protected void AuthenticateAndAuthorizeRequest (Azure.Core.HttpMessage message, Azure.Core.PopTokenRequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void AuthenticateAndAuthorizeRequest(class Azure.Core.HttpMessage message, valuetype Azure.Core.PopTokenRequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequest(Azure.Core.HttpMessage,Azure.Core.PopTokenRequestContext)" />
<MemberSignature Language="VB.NET" Value="Protected Sub AuthenticateAndAuthorizeRequest (message As HttpMessage, context As PopTokenRequestContext)" />
<MemberSignature Language="F#" Value="member this.AuthenticateAndAuthorizeRequest : Azure.Core.HttpMessage * Azure.Core.PopTokenRequestContext -> unit" Usage="popTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequest (message, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
<Parameter Name="context" Type="Azure.Core.PopTokenRequestContext" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> with the <see cref="T:Azure.Core.Request" /> to be authorized.</param>
<param name="context">The <see cref="T:Azure.Core.TokenRequestContext" /> used to authorize the <see cref="T:Azure.Core.Request" />.</param>
<summary>
Sets the Authorization header on the <see cref="T:Azure.Core.Request" /> by calling GetToken, or from cache, if possible.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticateAndAuthorizeRequestAsync">
<MemberSignature Language="C#" Value="protected System.Threading.Tasks.ValueTask AuthenticateAndAuthorizeRequestAsync (Azure.Core.HttpMessage message, Azure.Core.PopTokenRequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance valuetype System.Threading.Tasks.ValueTask AuthenticateAndAuthorizeRequestAsync(class Azure.Core.HttpMessage message, valuetype Azure.Core.PopTokenRequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequestAsync(Azure.Core.HttpMessage,Azure.Core.PopTokenRequestContext)" />
<MemberSignature Language="VB.NET" Value="Protected Function AuthenticateAndAuthorizeRequestAsync (message As HttpMessage, context As PopTokenRequestContext) As ValueTask" />
<MemberSignature Language="F#" Value="member this.AuthenticateAndAuthorizeRequestAsync : Azure.Core.HttpMessage * Azure.Core.PopTokenRequestContext -> System.Threading.Tasks.ValueTask" Usage="popTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequestAsync (message, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
<Parameter Name="context" Type="Azure.Core.PopTokenRequestContext" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> with the <see cref="T:Azure.Core.Request" /> to be authorized.</param>
<param name="context">The <see cref="T:Azure.Core.TokenRequestContext" /> used to authorize the <see cref="T:Azure.Core.Request" />.</param>
<summary>
Sets the Authorization header on the <see cref="T:Azure.Core.Request" /> by calling GetToken, or from cache, if possible.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthorizeRequest">
<MemberSignature Language="C#" Value="protected void AuthorizeRequest (Azure.Core.HttpMessage message);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void AuthorizeRequest(class Azure.Core.HttpMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthorizeRequest(Azure.Core.HttpMessage)" />
<MemberSignature Language="VB.NET" Value="Protected Sub AuthorizeRequest (message As HttpMessage)" />
<MemberSignature Language="F#" Value="member this.AuthorizeRequest : Azure.Core.HttpMessage -> unit" Usage="popTokenAuthenticationPolicy.AuthorizeRequest message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> this policy would be applied to.</param>
<summary>
Executes before <see cref="M:Azure.Core.Pipeline.BearerTokenAuthenticationPolicy.ProcessAsync(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" /> or
<see cref="M:Azure.Core.Pipeline.BearerTokenAuthenticationPolicy.Process(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" /> is called.
Implementers of this method are expected to call <see cref="M:Azure.Core.Pipeline.BearerTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequest(Azure.Core.HttpMessage,Azure.Core.TokenRequestContext)" /> or <see cref="M:Azure.Core.Pipeline.BearerTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequestAsync(Azure.Core.HttpMessage,Azure.Core.TokenRequestContext)" />
if authorization is required for requests not related to handling a challenge response.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthorizeRequestAsync">
<MemberSignature Language="C#" Value="protected virtual System.Threading.Tasks.ValueTask AuthorizeRequestAsync (Azure.Core.HttpMessage message);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask AuthorizeRequestAsync(class Azure.Core.HttpMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthorizeRequestAsync(Azure.Core.HttpMessage)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function AuthorizeRequestAsync (message As HttpMessage) As ValueTask" />
<MemberSignature Language="F#" Value="abstract member AuthorizeRequestAsync : Azure.Core.HttpMessage -> System.Threading.Tasks.ValueTask
override this.AuthorizeRequestAsync : Azure.Core.HttpMessage -> System.Threading.Tasks.ValueTask" Usage="popTokenAuthenticationPolicy.AuthorizeRequestAsync message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> this policy would be applied to.</param>
<summary>
Executes before <see cref="M:Azure.Core.Pipeline.HttpPipelinePolicy.Process(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" /><see cref="M:Azure.Core.Pipeline.HttpPipelinePolicy.ProcessAsync(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" /> or
<see cref="M:Azure.Core.Pipeline.HttpPipelinePolicy.Process(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" /> is called.
Implementers of this method are expected to call <see cref="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequest(Azure.Core.HttpMessage,Azure.Core.PopTokenRequestContext)" /> or <see cref="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthenticateAndAuthorizeRequestAsync(Azure.Core.HttpMessage,Azure.Core.PopTokenRequestContext)" />
if authorization is required for requests not related to handling a challenge response.
</summary>
<returns>The <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthorizeRequestOnChallenge">
<MemberSignature Language="C#" Value="protected virtual bool AuthorizeRequestOnChallenge (Azure.Core.HttpMessage message);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool AuthorizeRequestOnChallenge(class Azure.Core.HttpMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthorizeRequestOnChallenge(Azure.Core.HttpMessage)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function AuthorizeRequestOnChallenge (message As HttpMessage) As Boolean" />
<MemberSignature Language="F#" Value="abstract member AuthorizeRequestOnChallenge : Azure.Core.HttpMessage -> bool
override this.AuthorizeRequestOnChallenge : Azure.Core.HttpMessage -> bool" Usage="popTokenAuthenticationPolicy.AuthorizeRequestOnChallenge message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> to be authenticated.</param>
<summary>
Executed in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request.
</summary>
<returns>A boolean indicating whether the request was successfully authenticated and should be sent to the transport.</returns>
<remarks>Service client libraries may override this to handle service specific authentication challenges.</remarks>
</Docs>
</Member>
<Member MemberName="AuthorizeRequestOnChallengeAsync">
<MemberSignature Language="C#" Value="protected virtual System.Threading.Tasks.ValueTask<bool> AuthorizeRequestOnChallengeAsync (Azure.Core.HttpMessage message);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1<bool> AuthorizeRequestOnChallengeAsync(class Azure.Core.HttpMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.AuthorizeRequestOnChallengeAsync(Azure.Core.HttpMessage)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function AuthorizeRequestOnChallengeAsync (message As HttpMessage) As ValueTask(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member AuthorizeRequestOnChallengeAsync : Azure.Core.HttpMessage -> System.Threading.Tasks.ValueTask<bool>
override this.AuthorizeRequestOnChallengeAsync : Azure.Core.HttpMessage -> System.Threading.Tasks.ValueTask<bool>" Usage="popTokenAuthenticationPolicy.AuthorizeRequestOnChallengeAsync message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> to be authenticated.</param>
<summary>
Executed in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request.
</summary>
<returns>A boolean indicating whether the request was successfully authenticated and should be sent to the transport.</returns>
<remarks>Service client libraries may override this to handle service specific authentication challenges.</remarks>
</Docs>
</Member>
<Member MemberName="Process">
<MemberSignature Language="C#" Value="public override void Process (Azure.Core.HttpMessage message, ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> pipeline);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Process(class Azure.Core.HttpMessage message, valuetype System.ReadOnlyMemory`1<class Azure.Core.Pipeline.HttpPipelinePolicy> pipeline) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.Process(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Process (message As HttpMessage, pipeline As ReadOnlyMemory(Of HttpPipelinePolicy))" />
<MemberSignature Language="F#" Value="override this.Process : Azure.Core.HttpMessage * ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> -> unit" Usage="popTokenAuthenticationPolicy.Process (message, pipeline)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
<Parameter Name="pipeline" Type="System.ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy>" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> this policy would be applied to.</param>
<param name="pipeline">The set of <see cref="T:Azure.Core.Pipeline.HttpPipelinePolicy" /> to execute after current one.</param>
<summary>
Applies the policy to the <paramref name="message" />. Implementers are expected to mutate <see cref="P:Azure.Core.HttpMessage.Request" /> before calling <see cref="M:Azure.Core.Pipeline.HttpPipelinePolicy.ProcessNextAsync(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" /> and observe the <see cref="P:Azure.Core.HttpMessage.Response" /> changes after.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProcessAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask ProcessAsync (Azure.Core.HttpMessage message, ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> pipeline);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask ProcessAsync(class Azure.Core.HttpMessage message, valuetype System.ReadOnlyMemory`1<class Azure.Core.Pipeline.HttpPipelinePolicy> pipeline) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Pipeline.PopTokenAuthenticationPolicy.ProcessAsync(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ProcessAsync (message As HttpMessage, pipeline As ReadOnlyMemory(Of HttpPipelinePolicy)) As ValueTask" />
<MemberSignature Language="F#" Value="override this.ProcessAsync : Azure.Core.HttpMessage * ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> -> System.Threading.Tasks.ValueTask" Usage="popTokenAuthenticationPolicy.ProcessAsync (message, pipeline)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Core.HttpMessage" />
<Parameter Name="pipeline" Type="System.ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy>" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Core.HttpMessage" /> this policy would be applied to.</param>
<param name="pipeline">The set of <see cref="T:Azure.Core.Pipeline.HttpPipelinePolicy" /> to execute after current one.</param>
<summary>
Applies the policy to the <paramref name="message" />. Implementers are expected to mutate <see cref="P:Azure.Core.HttpMessage.Request" /> before calling <see cref="M:Azure.Core.Pipeline.HttpPipelinePolicy.ProcessNextAsync(Azure.Core.HttpMessage,System.ReadOnlyMemory{Azure.Core.Pipeline.HttpPipelinePolicy})" /> and observe the <see cref="P:Azure.Core.HttpMessage.Response" /> changes after.
</summary>
<returns>The <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>