Skip to content

🚀 [Feature]: Bring Your Own GitHub App for operator access #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 6, 2024
Merged

🚀 [Feature]: Bring Your Own GitHub App for operator access #140

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8969925
Update Get-GitHubAppInstallationAccessToken to take pipeline input fr…
MariusStorhaug Nov 6, 2024
6822a51
Rename function to New-* instead of Get-* aligning with the post method
MariusStorhaug Nov 6, 2024
bc4d1cb
BringYourOwnApp
MariusStorhaug Nov 6, 2024
30e28ca
Merge branch 'main' into byoa
MariusStorhaug Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions src/functions/public/Auth/Connect-GitHubAccount.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,20 @@
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'AccessToken', Justification = 'Required for parameter set')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'Is the CLI part of the module.')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '', Justification = 'The tokens are recieved as clear text. Mitigating exposure by removing variables and performing garbage collection.')]
[CmdletBinding(DefaultParameterSetName = 'DeviceFlow')]
[CmdletBinding(DefaultParameterSetName = 'UAT')]
param (
# Choose between authentication methods, either OAuthApp or GitHubApp.
# For more info about the types of authentication visit:
# [Differences between GitHub Apps and OAuth apps](https://docs.github.com/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)
[Parameter(ParameterSetName = 'DeviceFlow')]
[Parameter(ParameterSetName = 'UAT')]
[ValidateSet('OAuthApp', 'GitHubApp')]
[string] $Mode = 'GitHubApp',

# The scope of the access token, when using OAuth authentication.
# Provide the list of scopes as space-separated values.
# For more information on scopes visit:
# [Scopes for OAuth apps](https://docs.github.com/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)
[Parameter(ParameterSetName = 'DeviceFlow')]
[Parameter(ParameterSetName = 'UAT')]
[string] $Scope = 'gist read:org repo workflow',

# The personal access token to use for authentication.
Expand All @@ -85,6 +85,7 @@
Mandatory,
ParameterSetName = 'App'
)]
[Parameter(ParameterSetName = 'UAT')]
[string] $ClientID,

# The private key for the GitHub App.
Expand Down Expand Up @@ -137,12 +138,12 @@
$AuthType = if ($gitHubTokenPresent) { 'sPAT' } else { $PSCmdlet.ParameterSetName }
Write-Verbose "AuthType: [$AuthType]"
switch ($AuthType) {
'DeviceFlow' {
'UAT' {
Write-Verbose 'Logging in using device flow...'
$clientID = $script:Auth.$Mode.ClientID
$authClientID = $ClientID ?? $script:Auth.$Mode.ClientID
if ($Mode -ne (Get-GitHubConfig -Name 'DeviceFlowType' -ErrorAction SilentlyContinue)) {
Write-Verbose "Using $Mode authentication..."
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $clientID -Scope $Scope -HostName $HostName
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $authClientID -Scope $Scope -HostName $HostName
} else {
$accessTokenValidity = [datetime](Get-GitHubConfig -Name 'AccessTokenExpirationDate') - (Get-Date)
$accessTokenIsValid = $accessTokenValidity.Seconds -gt 0
Expand All @@ -162,7 +163,7 @@
Write-Host '⚠ ' -ForegroundColor Yellow -NoNewline
Write-Host "Access token remaining validity $accessTokenValidityText. Refreshing access token..."
}
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $clientID -RefreshToken (Get-GitHubConfig -Name 'RefreshToken') -HostName $HostName
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $authClientID -RefreshToken (Get-GitHubConfig -Name 'RefreshToken') -HostName $HostName
}
} else {
$refreshTokenValidity = [datetime](Get-GitHubConfig -Name 'RefreshTokenExpirationDate') - (Get-Date)
Expand All @@ -172,10 +173,10 @@
Write-Host '⚠ ' -ForegroundColor Yellow -NoNewline
Write-Host 'Access token expired. Refreshing access token...'
}
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $clientID -RefreshToken (Get-GitHubConfig -Name 'RefreshToken') -HostName $HostName
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $authClientID -RefreshToken (Get-GitHubConfig -Name 'RefreshToken') -HostName $HostName
} else {
Write-Verbose "Using $Mode authentication..."
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $clientID -Scope $Scope -HostName $HostName
$tokenResponse = Invoke-GitHubDeviceFlowLogin -ClientID $authClientID -Scope $Scope -HostName $HostName
}
}
}
Expand Down