WwwAuthenticateParser

Definition

Assembly: Microsoft.OData.Mcp.Authentication.dll Namespace: Microsoft.OData.Mcp.Authentication.Outbound Inheritance: System.Object

Syntax

Microsoft.OData.Mcp.Authentication.Outbound.WwwAuthenticateParser

Summary

Parses WWW-Authenticate response header values into OAuthChallenge instances using the RFC 9110 section 11.6.1 challenge grammar and the RFC 6750 / RFC 9728 OAuth auth-params.

Remarks

The grammar implemented is challenge = auth-scheme [ 1*SP ( token68 / #auth-param ) ] with auth-param = token BWS "=" BWS ( token / quoted-string ). A hand written tokenizer is used rather than a regular expression so that a comma inside a quoted-string never splits a challenge, and so that the scheme of a following challenge (a token that is not followed by =) is recognized correctly. A token68 credential is consumed so that it cannot masquerade as an extra challenge, but it is not surfaced: OAuth challenges always use auth-params.

Methods

Parse

Parses a single WWW-Authenticate header value and returns its first challenge.

Syntax

public static Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge Parse(string headerValue)

Parameters

Name	Type	Description
`headerValue`	`string`	The raw header value, for example `Bearer realm="", scope="read"`.

Returns

Type: Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge The first OAuthChallenge in headerValue.

Exceptions

Exception	Description
`ArgumentNullException`	headerValue is `null`.
`ArgumentException`	headerValue is empty or white space.
`FormatException`	headerValue does not contain a well formed challenge.

Examples

var challenge = WwwAuthenticateParser.Parse("Bearer realm=\"\", client_id=\"00000003-0000-0000-c000-000000000000\"");

Console.WriteLine(challenge.Scheme);           // Bearer
Console.WriteLine(challenge.Realm);            // (empty string)
Console.WriteLine(challenge.ResourceClientId); // 00000003-0000-0000-c000-000000000000

Remarks

Use String) when a header value may advertise more than one scheme; this method deliberately keeps only the first challenge.

ParseAll

Parses a sequence of WWW-Authenticate header values, in order, into a flat challenge list.

Syntax

public static System.Collections.Generic.IReadOnlyList<Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge> ParseAll(System.Collections.Generic.IEnumerable<string> values)

Parameters

Name	Type	Description
`values`	`System.Collections.Generic.IEnumerable<string>`	The header values, typically the ones surfaced on an OData execute result.

Returns

Type: System.Collections.Generic.IReadOnlyList<Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge> Every challenge advertised across values, in the order encountered.

Exceptions

Exception	Description
`ArgumentNullException`	values is `null`.
`FormatException`	One of the values is not a well formed challenge.

Remarks

A response may repeat the header instead of comma joining it, and each value may itself carry more than one challenge. Entries that are null, empty, or white space carry no challenge and are skipped, so a response with no usable challenge yields an empty list rather than an exception; callers apply the “401 with no WWW-Authenticate” rule themselves.

ParseAll

Parses a single WWW-Authenticate header value that may advertise several challenges.

Syntax

public static System.Collections.Generic.IReadOnlyList<Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge> ParseAll(string headerValue)

Parameters

Name	Type	Description
`headerValue`	`string`	The raw header value, for example `Bearer realm="a", Basic realm="b"`.

Returns

Type: System.Collections.Generic.IReadOnlyList<Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge> Every challenge in headerValue, in the order encountered.

Exceptions

Exception	Description
`ArgumentNullException`	headerValue is `null`.
`ArgumentException`	headerValue is empty or white space.
`FormatException`	headerValue is not a well formed challenge list.

SelectBearer

Selects the first Bearer challenge from a parsed challenge list.

Syntax

public static Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge SelectBearer(System.Collections.Generic.IReadOnlyList<Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge> challenges)

Parameters

Name	Type	Description
`challenges`	`System.Collections.Generic.IReadOnlyList<Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge>`	The challenges to search, in the order the server advertised them.

Returns

Type: Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge? The first challenge whose scheme is Bearer, or null when none is.

Exceptions

Exception	Description
`ArgumentNullException`	challenges is `null`.

Remarks

Authentication schemes are case-insensitive, so bearer and Bearer both match.

Getting Started

API Reference

WwwAuthenticateParser

Definition

Syntax

Summary

Remarks

Methods

Parse

Syntax

Parameters

Returns

Exceptions

Examples

Remarks

ParseAll

Syntax

Parameters

Returns

Exceptions

Remarks

ParseAll

Syntax

Parameters

Returns

Exceptions

SelectBearer

Syntax

Parameters

Returns

Exceptions

Remarks

​Definition

​Syntax

​Summary

​Remarks

​Methods

​ Parse

​Syntax

​Parameters

​Returns

​Exceptions

​Examples

​Remarks

​ ParseAll

​Syntax

​Parameters

​Returns

​Exceptions

​Remarks

​ ParseAll

​Syntax

​Parameters

​Returns

​Exceptions

​ SelectBearer

​Syntax

​Parameters

​Returns

​Exceptions

​Remarks

Definition

Syntax

Summary

Remarks

Methods

Parse

Syntax

Parameters

Returns

Exceptions

Examples

Remarks

ParseAll

Syntax

Parameters

Returns

Exceptions

Remarks

ParseAll

Syntax

Parameters

Returns

Exceptions

SelectBearer

Syntax

Parameters

Returns

Exceptions

Remarks