GitHubOAuthValidator.cs

Go to the documentation of this file.

using System;
using System.Globalization;
using System.Threading;
using System.Threading.Tasks;
 
using Microsoft.Extensions.Logging;
using Octokit;
 
using Tgstation.Server.Api.Models;
using Tgstation.Server.Host.Configuration;
using Tgstation.Server.Host.Extensions;
using Tgstation.Server.Host.Utils.GitHub;
 
namespace Tgstation.Server.Host.Security.OAuth
{
    sealed class GitHubOAuthValidator : IOAuthValidator
    {
        public OAuthProvider Provider => OAuthProvider.GitHub;
 
        public OAuthGatewayStatus GatewayStatus => oAuthConfiguration.Gateway ?? default;
 
        readonly IGitHubServiceFactory gitHubServiceFactory;
 
        readonly ILogger<GitHubOAuthValidator> logger;
 
        readonly OAuthConfiguration oAuthConfiguration;
 
        public GitHubOAuthValidator(
            IGitHubServiceFactory gitHubServiceFactory,
            ILogger<GitHubOAuthValidator> logger,
            OAuthConfiguration oAuthConfiguration)
        {
            this.gitHubServiceFactory = gitHubServiceFactory ?? throw new ArgumentNullException(nameof(gitHubServiceFactory));
            this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
            this.oAuthConfiguration = oAuthConfiguration ?? throw new ArgumentNullException(nameof(oAuthConfiguration));
        }
 
        public async ValueTask<(string? UserID, string AccessCode)?> ValidateResponseCode(string code, bool requireUserID, CancellationToken cancellationToken)
        {
            ArgumentNullException.ThrowIfNull(code);
 
            try
            {
                logger.LogTrace("Validating response code...");
 
                var gitHubService = await gitHubServiceFactory.CreateService(cancellationToken);
                var token = await gitHubService.CreateOAuthAccessToken(oAuthConfiguration, code, cancellationToken);
                if (token == null)
                    return null;
 
                if (!requireUserID)
                    return (null, AccessCode: token);
 
                var authenticatedClient = await gitHubServiceFactory.CreateService(token, cancellationToken);
 
                logger.LogTrace("Getting user details...");
                var userId = await authenticatedClient.GetCurrentUserId(cancellationToken);
 
                return (userId.ToString(CultureInfo.InvariantCulture), AccessCode: token);
            }
            catch (RateLimitExceededException)
            {
                throw;
            }
            catch (ApiException ex)
            {
                logger.LogWarning(ex, "API error while completing OAuth handshake!");
                return null;
            }
        }
 
        public OAuthProviderInfo GetProviderInfo()
            => new()
            {
                ClientId = oAuthConfiguration.ClientId,
                RedirectUri = oAuthConfiguration.RedirectUrl,
                GatewayOnly = GatewayStatus.ToBoolean(),
            };
    }
}