openiddict-core/src/OpenIddict.Client/OpenIddictClientEvents.Userinfo.cs

/*
 * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
 * See https://github.com/openiddict/openiddict-core for more information concerning
 * the license and the contributors participating to this project.
 */

using System.Security.Claims;

namespace OpenIddict.Client;

public static partial class OpenIddictClientEvents
{
    /// <summary>
    /// Represents an event called for each request to the userinfo endpoint
    /// to give the user code a chance to add parameters to the userinfo request.
    /// </summary>
    public sealed class PrepareUserinfoRequestContext : BaseExternalContext
    {
        /// <summary>
        /// Creates a new instance of the <see cref="PrepareUserinfoRequestContext"/> class.
        /// </summary>
        public PrepareUserinfoRequestContext(OpenIddictClientTransaction transaction)
            : base(transaction)
        {
        }

        /// <summary>
        /// Gets or sets the request.
        /// </summary>
        public OpenIddictRequest Request
        {
            get => Transaction.Request!;
            set => Transaction.Request = value;
        }
    }

    /// <summary>
    /// Represents an event called for each request to the userinfo endpoint
    /// to send the userinfo request to the remote authorization server.
    /// </summary>
    public sealed class ApplyUserinfoRequestContext : BaseExternalContext
    {
        /// <summary>
        /// Creates a new instance of the <see cref="ApplyUserinfoRequestContext"/> class.
        /// </summary>
        public ApplyUserinfoRequestContext(OpenIddictClientTransaction transaction)
            : base(transaction)
        {
        }

        /// <summary>
        /// Gets or sets the request.
        /// </summary>
        public OpenIddictRequest Request
        {
            get => Transaction.Request!;
            set => Transaction.Request = value;
        }
    }

    /// <summary>
    /// Represents an event called for each userinfo response
    /// to extract the response parameters from the server response.
    /// </summary>
    public sealed class ExtractUserinfoResponseContext : BaseExternalContext
    {
        /// <summary>
        /// Creates a new instance of the <see cref="ExtractUserinfoResponseContext"/> class.
        /// </summary>
        public ExtractUserinfoResponseContext(OpenIddictClientTransaction transaction)
            : base(transaction)
        {
        }

        /// <summary>
        /// Gets or sets the request.
        /// </summary>
        public OpenIddictRequest Request
        {
            get => Transaction.Request!;
            set => Transaction.Request = value;
        }

        /// <summary>
        /// Gets or sets the response, or <see langword="null"/> if it wasn't extracted yet.
        /// </summary>
        public OpenIddictResponse? Response
        {
            get => Transaction.Response;
            set => Transaction.Response = value;
        }

        /// <summary>
        /// Gets or sets the userinfo token, if available.
        /// </summary>
        public string? UserinfoToken { get; set; }
    }

    /// <summary>
    /// Represents an event called for each userinfo response.
    /// </summary>
    public sealed class HandleUserinfoResponseContext : BaseExternalContext
    {
        /// <summary>
        /// Creates a new instance of the <see cref="HandleUserinfoResponseContext"/> class.
        /// </summary>
        public HandleUserinfoResponseContext(OpenIddictClientTransaction transaction)
            : base(transaction)
        {
        }

        /// <summary>
        /// Gets or sets the request.
        /// </summary>
        public OpenIddictRequest Request
        {
            get => Transaction.Request!;
            set => Transaction.Request = value;
        }

        /// <summary>
        /// Gets or sets the response.
        /// </summary>
        public OpenIddictResponse Response
        {
            get => Transaction.Response!;
            set => Transaction.Response = value;
        }

        /// <summary>
        /// Gets or sets the userinfo token, if available.
        /// </summary>
        public string? UserinfoToken { get; set; }

        /// <summary>
        /// Gets or sets the principal containing the claims resolved from the userinfo response.
        /// </summary>
        public ClaimsPrincipal? Principal { get; set; }
    }
}