Skip to content

Fix issue 23 & allow for Integrated Auth #26

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fix issue 23 & allow for Integrated Auth #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 29 additions & 6 deletions VSTSAgent/DSCResources/xVSTSAgent/xVSTSAgent.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ function Get-PrefixComputerName {
Unused - not necessary for discovery.
.PARAMETER LogonCredential
Unused - not necessary for discovery.
.PARAMETER IntegratedAuth
Unused - not necessary for discovery.
.PARAMETER Ensure
Unused - not necessary for discovery.
#>
Expand Down Expand Up @@ -59,7 +61,10 @@ function Get-TargetResource {
$Ensure = 'Present',

[System.Boolean]
$PrefixComputerName = $false
$PrefixComputerName = $false,

[Switch]
$IntegratedAuth = $false
)

if ( $PrefixComputerName ) { $Name = Get-PrefixComputerName $Name }
Expand Down Expand Up @@ -94,6 +99,8 @@ function Get-TargetResource {
The credential used to auth with VSTS.
.PARAMETER LogonCredential
What credential should the agent service use?
.PARAMETER IntegratedAuth
Should we use integrated auth instead of PAT?
.PARAMETER Ensure
Should we ensure the agent exists or that it doesn't?
#>
Expand Down Expand Up @@ -132,7 +139,10 @@ function Set-TargetResource {
$Ensure = 'Present',

[System.Boolean]
$PrefixComputerName = $false
$PrefixComputerName = $false,

[Switch]
$IntegratedAuth = $false
)

if ( Test-TargetResource @PSBoundParameters ) { return }
Expand All @@ -144,18 +154,26 @@ function Set-TargetResource {
'Name' = $Name
'Pool' = $Pool
'ServerUrl' = $ServerUrl
'PAT' = $AccountCredential.Password
'AgentDirectory' = $AgentDirectory
'Replace' = $true
}


if ( $Work ) { $installArgs['Work'] = $Work }
if ( $LogonCredential ) { $installArgs['LogonCredential'] = $LogonCredential }


if ( $IntegratedAuth ) { $installArgs['Integrated'] = $true }
else { $installArgs['PAT'] = $AccountCredential.Password
}
Install-VSTSAgent @installArgs
}
else {
Uninstall-VSTSAgent -Name $Name -AgentDirectory $AgentDirectory -PAT $AccountCredential.Password
if ( $IntegratedAuth ) {
Uninstall-VSTSAgent -Name $Name -AgentDirectory $AgentDirectory -Integrated
}
else {
Uninstall-VSTSAgent -Name $Name -AgentDirectory $AgentDirectory -PAT $AccountCredential.Password
}
}
}

Expand All @@ -174,6 +192,8 @@ function Set-TargetResource {
Unused - testing does not require credentials.
.PARAMETER LogonCredential
Unused - agent service logon user is not currently detectable.
.PARAMETER IntegratedAuth
Unused - testing does not require credentials.
.PARAMETER Ensure
Should the agent be present or absent?
#>
Expand Down Expand Up @@ -213,7 +233,10 @@ function Test-TargetResource {
$Ensure = 'Present',

[System.Boolean]
$PrefixComputerName = $false
$PrefixComputerName = $false,

[Switch]
$IntegratedAuth = $false
)

if ( $PrefixComputerName ) { $Name = Get-PrefixComputerName $Name }
Expand Down
1 change: 1 addition & 0 deletions VSTSAgent/DSCResources/xVSTSAgent/xVSTSAgent.schema.mof
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ class xVSTSAgent : OMI_BaseResource
[Required] String AgentDirectory;
[Write] String Work;
[Write] Boolean PrefixComputerName;
[Write] Boolean IntegratedAuth;
[Write, ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
};

49 changes: 38 additions & 11 deletions VSTSAgent/VSTSAgent.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,8 @@ function Find-VSTSAgent {
What pool should the agent be registered into?
.PARAMETER PAT
What personal access token (PAT) should be used to auth with VSTS?
.PARAMETER Integrated
Should the agent use integrated auth with VSTS instead of a PAT?
.PARAMETER ServerUrl
What server url should the agent be registered to? Eg. 'https://account.visualstudio.com'
.PARAMETER Replace
Expand Down Expand Up @@ -222,9 +224,12 @@ function Install-VSTSAgent {
[parameter(Mandatory = $false)]
[string]$Pool = 'Default',

[parameter(Mandatory = $true)]
[parameter(Mandatory = $true, ParameterSetName = 'PATAuth')]
[securestring]$PAT,

[parameter(Mandatory = $true, ParameterSetName = 'IntegratedAuth')]
[switch]$Integrated,

[parameter(Mandatory = $true)]
[uri]$ServerUrl,

Expand All @@ -247,7 +252,12 @@ function Install-VSTSAgent {
$existing = Get-VSTSAgent -AgentDirectory $AgentDirectory -NameFilter $Name
if ( $existing ) {
if ($Replace) {
Uninstall-VSTSAgent -NameFilter $Name -AgentDirectory $AgentDirectory -PAT $PAT -ErrorAction Stop
if ($Integrated) {
Uninstall-VSTSAgent -NameFilter $Name -AgentDirectory $AgentDirectory -Integrated -ErrorAction Stop
}
else {
Uninstall-VSTSAgent -NameFilter $Name -AgentDirectory $AgentDirectory -PAT $PAT -ErrorAction Stop
}
}
else { throw "Agent $Name already exists in $AgentDirectory" }
}
Expand Down Expand Up @@ -291,16 +301,21 @@ function Install-VSTSAgent {
$configPath = Get-ChildItem $configPath -ErrorAction SilentlyContinue
if ( -not $configPath ) { throw "Agent $agentFolder is missing config.cmd" }

[string[]]$configArgs = @('--unattended', '--url', "$ServerUrl", '--auth', `
'pat', '--pool', "$Pool", '--agent', "$Name", '--runAsService')
[string[]]$configArgs = @('--unattended', '--url', """$ServerUrl""", '--pool',`
"""$Pool""", '--agent', """$Name""", '--runAsService')
if ( $Replace ) { $configArgs += '--replace' }
if ( $LogonCredential ) { $configArgs += '--windowsLogonAccount', $LogonCredential.UserName }
if ( $Work ) { $configArgs += '--work', $Work }
if ( $Work ) { $configArgs += '--work', """$Work""" }

if ( -not $PSCmdlet.ShouldProcess("$configPath $configArgs", "Start-Process") ) { return }

$token = [System.Net.NetworkCredential]::new($null, $PAT).Password
$configArgs += '--token', $token
if ($Integrated) {
$configArgs += '--auth', 'integrated'
}
else {
$token = [System.Net.NetworkCredential]::new($null, $PAT).Password
$configArgs += '--auth', 'pat', '--token', $token
}

if ( $LogonCredential ) {
$configArgs += '--windowsLogonPassword', `
Expand Down Expand Up @@ -336,6 +351,8 @@ function Install-VSTSAgent {
Only agents whose names match this filter will be uninstalled.
.PARAMETER PAT
The personal access token used to auth with VSTS.
.PARAMETER Integrated
Should the agent use integrated auth with VSTS instead of a PAT?
#>
function Uninstall-VSTSAgent {
[CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "NoVersion")]
Expand All @@ -357,12 +374,15 @@ function Uninstall-VSTSAgent {
[parameter(Mandatory = $false)]
[string]$NameFilter,

[parameter(Mandatory = $true)]
[securestring]$PAT
[parameter(Mandatory = $true, ParameterSetName = 'PATAuth')]
[securestring]$PAT,

[parameter(Mandatory = $true, ParameterSetName = 'IntegratedAuth')]
[switch]$Integrated
)

$getArgs = @{}
$PSBoundParameters.Keys | Where-Object { $_ -ne 'PAT' } | ForEach-Object {
$PSBoundParameters.Keys | Where-Object { $_ -ne 'PAT' -and $_ -ne 'Integrated' } | ForEach-Object {
$getArgs[$_] = $PSBoundParameters[$_]
}

Expand All @@ -372,7 +392,14 @@ function Uninstall-VSTSAgent {
if ( -not $PSCmdlet.ShouldProcess("$($_.Name) - $($_.Path)", "Uninstall")) { return }

$configPath = [io.path]::Combine($_.Path.LocalPath, 'config.cmd')
$configArgs = @('remove', '--unattended', '--auth', 'pat', '--token', "$token")
$configArgs = @('remove', '--unattended')

if ($Integrated) {
$configArgs += '--auth', 'integrated'
}
else {
$configArgs += '--auth', 'pat', '--token', "$token"
}

$outFile = [io.path]::Combine($_.Path.LocalPath, "out.log")
$errorFile = [io.path]::Combine($_.Path.LocalPath, "error.log")
Expand Down