FileIdTokenCallback

Definition

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

Syntax

Microsoft.OData.Mcp.Authentication.Outbound.FileIdTokenCallback

Summary

Supplies the enterprise OpenID Connect id token the identity assertion grant exchanges, reading it from the file --idp-id-token-file names or from the ODataMcpAuthConstants.IdTokenEnvironmentVariable environment variable.

Remarks

Per specs/v3/AUTHENTICATION.md “Grants → Identity Assertion Grant” the id token is never passed on argv: a process list is world-readable on every platform this tool ships to, and an id token is a bearer credential for the end user’s enterprise identity. The file is re-read on every call rather than cached, so a daemon whose sidecar rotates the token picks the new one up without a restart, and per AUTH-12 nothing here ever logs, elicits, or echoes the token itself — only the path it came from.

Examples

var callback = new FileIdTokenCallback(options.IdpIdTokenFile);

var providerOptions = new IdentityAssertionGrantProviderOptions
{
    ClientId = options.ClientId,
    IdpClientId = options.IdpClientId,
    IdTokenCallback = callback.ReadAsync
};

Constructors

.ctor

Initializes a new instance of the FileIdTokenCallback class.

Syntax

public FileIdTokenCallback(string path)

Parameters

Name	Type	Description
`path`	`string?`	The path of the file holding a UTF-8 id token, or `null` to read ODataMcpAuthConstants.IdTokenEnvironmentVariable instead.

Remarks

A null path is not an error: the environment variable is the other documented source, and which of the two an operator configured is only knowable when the token is actually needed.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Path

Gets the path of the file the id token is read from, or null when only the environment variable is consulted.

Syntax

public string Path { get; }

Property Value

Type: string?

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReadAsync

Reads the id token, preferring the configured file over the environment variable.

Syntax

public System.Threading.Tasks.Task<string> ReadAsync(ModelContextProtocol.Authentication.IdentityAssertionGrantContext context, System.Threading.CancellationToken cancellationToken)

Parameters

Name	Type	Description
`context`	`ModelContextProtocol.Authentication.IdentityAssertionGrantContext`	The resource and authorization server URLs the SDK discovered, unused by this source.
`cancellationToken`	`System.Threading.CancellationToken`	The token that cancels the file read.

Returns

Type: System.Threading.Tasks.Task<string> The trimmed id token.

Exceptions

Exception	Description
`InvalidOperationException`	Thrown when the configured file does not exist, when it is empty, or when neither a file nor
ODataMcpAuthConstants.IdTokenEnvironmentVariable supplies a token.

Examples

SdkAuth.IdentityAssertionGrantIdTokenCallback callback = new FileIdTokenCallback(path).ReadAsync;

Remarks

The token is trimmed because both sources routinely pick up a trailing newline — a shell redirection, a Kubernetes projected volume — and a JWT with a newline on the end is rejected by every token endpoint with an error that says nothing about whitespace. Failures name the source, never the value.

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Remarks

​Examples

​Constructors

​ .ctor

​Syntax

​Parameters

​Remarks

​ .ctor Inherited

​Syntax

​Properties

​ Path

​Syntax

​Property Value

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReadAsync

​Syntax

​Parameters

​Returns

​Exceptions

​Examples

​Remarks

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Remarks

Examples

Constructors

.ctor

Syntax

Parameters

Remarks

.ctor Inherited

Syntax

Properties

Path

Syntax

Property Value

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReadAsync

Syntax

Parameters

Returns

Exceptions

Examples

Remarks

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns