Merge pull request #478 from mjcheetham/gh-device-ui

Add explicit GitHub device code authentication option

Author: mjcheetham

docs/configuration.md

@@ -185,7 +185,9 @@ If this option is not set, then the available authentication modes will be autom
 Value|Authentication Mode
 -|-
 _(unset)_|Automatically detect modes
-`oauth`|OAuth-based authentication
+`oauth`|Expands to: `browser, device`
+`browser`|OAuth authentication via a web browser _(requires a GUI)_
+`device`|OAuth authentication with a device code
 `basic`|Basic/PAT-based authentication
 
 #### Example

docs/environment.md

@@ -324,7 +324,9 @@ If this option is not set, then the available authentication modes will be autom
 Value|Authentication Mode
 -|-
 _(unset)_|Automatically detect modes
-`oauth`|OAuth-based authentication
+`oauth`|Expands to: `browser, device`
+`browser`|OAuth authentication via a web browser _(requires a GUI)_
+`device`|OAuth authentication with a device code
 `basic`|Basic/PAT-based authentication
 
 ##### Windows

src/shared/GitHub.Tests/GitHubHostProviderTests.cs

@@ -92,7 +92,7 @@ public void GitHubHostProvider_GetCredentialServiceUrl(string protocol, string h
 
 
         [Theory]
-        [InlineData("https://example.com", "oauth", AuthenticationModes.OAuth)]
+        [InlineData("https://example.com", "browser", AuthenticationModes.Browser)]
         [InlineData("https://github.com", "NOT-A-REAL-VALUE", GitHubConstants.DotComAuthenticationModes)]
         [InlineData("https://GitHub.Com", "NOT-A-REAL-VALUE", GitHubConstants.DotComAuthenticationModes)]
         [InlineData("https://github.com", "none", GitHubConstants.DotComAuthenticationModes)]
@@ -170,7 +170,7 @@ public async Task GitHubHostProvider_GenerateCredentialAsync_UnencryptedHttp_Thr
         }
 
         [Fact]
-        public async Task GitHubHostProvider_GenerateCredentialAsync_OAuth_ReturnsCredential()
+        public async Task GitHubHostProvider_GenerateCredentialAsync_Browser_ReturnsCredential()
         {
             var input = new InputArguments(new Dictionary<string, string>
             {
@@ -194,9 +194,9 @@ public async Task GitHubHostProvider_GenerateCredentialAsync_OAuth_ReturnsCreden
 
             var ghAuthMock = new Mock<IGitHubAuthentication>(MockBehavior.Strict);
             ghAuthMock.Setup(x => x.GetAuthenticationAsync(expectedTargetUri, null, It.IsAny<AuthenticationModes>()))
-                      .ReturnsAsync(new AuthenticationPromptResult(AuthenticationModes.OAuth));
+                      .ReturnsAsync(new AuthenticationPromptResult(AuthenticationModes.Browser));
 
-            ghAuthMock.Setup(x => x.GetOAuthTokenAsync(expectedTargetUri, It.IsAny<IEnumerable<string>>()))
+            ghAuthMock.Setup(x => x.GetOAuthTokenViaBrowserAsync(expectedTargetUri, It.IsAny<IEnumerable<string>>()))
                       .ReturnsAsync(response);
 
             var ghApiMock = new Mock<IGitHubRestApi>(MockBehavior.Strict);
@@ -212,7 +212,7 @@ public async Task GitHubHostProvider_GenerateCredentialAsync_OAuth_ReturnsCreden
             Assert.Equal(tokenValue, credential.Password);
 
             ghAuthMock.Verify(
-                x => x.GetOAuthTokenAsync(
+                x => x.GetOAuthTokenViaBrowserAsync(
                     expectedTargetUri, expectedOAuthScopes),
                 Times.Once);
         }

src/shared/GitHub.UI.Avalonia/Commands/DeviceCodeCommandImpl.cs

@@ -0,0 +1,19 @@
+using System.Threading;
+using System.Threading.Tasks;
+using GitHub.UI.ViewModels;
+using GitHub.UI.Views;
+using Microsoft.Git.CredentialManager;
+using Microsoft.Git.CredentialManager.UI;
+
+namespace GitHub.UI.Commands
+{
+    public class DeviceCodeCommandImpl : DeviceCodeCommand
+    {
+        public DeviceCodeCommandImpl(ICommandContext context) : base(context) { }
+
+        protected override Task ShowAsync(DeviceCodeViewModel viewModel, CancellationToken ct)
+        {
+            return AvaloniaUi.ShowViewAsync<DeviceCodeView>(viewModel, GetParentHandle(), ct);
+        }
+    }
+}

src/shared/GitHub.UI.Avalonia/Controls/TesterWindow.axaml

@@ -60,5 +60,17 @@
                 <Button Classes="accent" Content="Show" Click="ShowTwoFactorCode" />
             </StackPanel>
         </TabItem>
+
+        <TabItem Header="Device Code">
+            <StackPanel>
+                <Grid RowDefinitions="Auto,Auto" ColumnDefinitions="Auto,*">
+                    <Label   Grid.Row="0" Grid.Column="0" Content="User Code" />
+                    <TextBox Grid.Row="0" Grid.Column="1" x:Name="userCode" />
+                    <Label   Grid.Row="1" Grid.Column="0" Content="Verification Url" />
+                    <TextBox Grid.Row="1" Grid.Column="1" x:Name="verificationUrl" />
+                </Grid>
+                <Button Classes="accent" Content="Show" Click="ShowDeviceCode" />
+            </StackPanel>
+        </TabItem>
     </TabControl>
 </Window>

src/shared/GitHub.UI.Avalonia/Controls/TesterWindow.axaml.cs

@@ -55,6 +55,7 @@ private void ShowCredentials(object sender, RoutedEventArgs e)
             var vm = new CredentialsViewModel(_environment)
             {
                 ShowBrowserLogin = this.FindControl<CheckBox>("useBrowser").IsChecked ?? false,
+                ShowDeviceLogin = this.FindControl<CheckBox>("useDevice").IsChecked ?? false,
                 ShowTokenLogin = this.FindControl<CheckBox>("usePat").IsChecked ?? false,
                 ShowBasicLogin = this.FindControl<CheckBox>("useBasic").IsChecked ?? false,
                 EnterpriseUrl = this.FindControl<TextBox>("enterpriseUrl").Text,
@@ -75,5 +76,17 @@ private void ShowTwoFactorCode(object sender, RoutedEventArgs e)
             var window = new DialogWindow(view) {DataContext = vm};
             window.ShowDialog(this);
         }
+
+        private void ShowDeviceCode(object sender, RoutedEventArgs e)
+        {
+            var vm = new DeviceCodeViewModel(_environment)
+            {
+                UserCode = this.FindControl<TextBox>("userCode").Text,
+                VerificationUrl = this.FindControl<TextBox>("verificationUrl").Text,
+            };
+            var view = new DeviceCodeView();
+            var window = new DialogWindow(view) {DataContext = vm};
+            window.ShowDialog(this);
+        }
     }
 }

src/shared/GitHub.UI.Avalonia/GitHub.UI.Avalonia.csproj

@@ -38,6 +38,10 @@
       <DependentUpon>DeviceCodeView.axaml</DependentUpon>
       <SubType>Code</SubType>
     </Compile>
+    <Compile Update="Views\DeviceCodeView.axaml.cs">
+      <DependentUpon>DeviceCodeView.axaml</DependentUpon>
+      <SubType>Code</SubType>
+    </Compile>
   </ItemGroup>
 
 </Project>

src/shared/GitHub.UI.Avalonia/Program.cs

@@ -50,6 +50,7 @@ private static void AppMain(object o)
             {
                 app.RegisterCommand(new CredentialsCommandImpl(context));
                 app.RegisterCommand(new TwoFactorCommandImpl(context));
+                app.RegisterCommand(new DeviceCodeCommandImpl(context));
 
                 int exitCode = app.RunAsync(args)
                     .ConfigureAwait(false)

src/shared/GitHub.UI.Avalonia/Views/CredentialsView.axaml

@@ -4,6 +4,7 @@
              xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
              xmlns:controls="clr-namespace:GitHub.UI.Controls"
              xmlns:vm="clr-namespace:GitHub.UI.ViewModels;assembly=GitHub.UI.Shared"
+             xmlns:converters="clr-namespace:Microsoft.Git.CredentialManager.UI.Converters;assembly=Microsoft.Git.CredentialManager.UI.Avalonia"
              mc:Ignorable="d" d:DesignWidth="420"
              x:Class="GitHub.UI.Views.CredentialsView">
     <Design.DataContext>
@@ -50,10 +51,15 @@
                 </Style>
             </TabControl.Styles>
 
-            <TabItem IsVisible="{Binding $self.IsEnabled}"
-                     IsEnabled="{Binding ShowBrowserLogin}">
+            <TabItem IsVisible="{Binding $self.IsEnabled}">
+                <TabItem.IsEnabled>
+                    <MultiBinding Converter="{x:Static converters:BoolConvertersEx.Or}">
+                        <Binding Path="ShowBrowserLogin" />
+                        <Binding Path="ShowDeviceLogin" />
+                    </MultiBinding>
+                </TabItem.IsEnabled>
                 <TabItem.Header>
-                    <TextBlock Text="Browser" FontSize="12" />
+                    <TextBlock Text="{Binding OAuthModeTitle}" FontSize="12" />
                 </TabItem.Header>
                 <StackPanel Margin="0,10">
                     <Button x:Name="signInBrowserButton"
@@ -64,6 +70,12 @@
                             HorizontalAlignment="Center"
                             Margin="0,0,0,10"
                             Classes="accent"/>
+                    <Button x:Name="signInDeviceButton"
+                            Content="Sign in with a code"
+                            Command="{Binding SignInDeviceCommand}"
+                            IsVisible="{Binding ShowDeviceLogin}"
+                            HorizontalAlignment="Center"
+                            Margin="0,10,0,10"/>
                 </StackPanel>
             </TabItem>
 

src/shared/GitHub.UI.Avalonia/Views/CredentialsView.axaml.cs

@@ -9,6 +9,7 @@ public class CredentialsView : UserControl, IFocusable
     {
         private TabControl _tabControl;
         private Button _browserButton;
+        private Button _deviceButton;
         private TextBox _tokenTextBox;
         private TextBox _userNameTextBox;
         private TextBox _passwordTextBox;
@@ -24,6 +25,7 @@ private void InitializeComponent()
 
             _tabControl = this.FindControl<TabControl>("authModesTabControl");
             _browserButton = this.FindControl<Button>("signInBrowserButton");
+            _deviceButton = this.FindControl<Button>("signInDeviceButton");
             _tokenTextBox = this.FindControl<TextBox>("tokenTextBox");
             _userNameTextBox = this.FindControl<TextBox>("userNameTextBox");
             _passwordTextBox = this.FindControl<TextBox>("passwordTextBox");
@@ -43,6 +45,11 @@ public void SetFocus()
                 _tabControl.SelectedIndex = 0;
                 _browserButton.Focus();
             }
+            else if (vm.ShowDeviceLogin)
+            {
+                _tabControl.SelectedIndex = 0;
+                _deviceButton.Focus();
+            }
             else if (vm.ShowTokenLogin)
             {
                 _tabControl.SelectedIndex = 1;