Public/Set-PWSHYBKPIVChuid.ps1
|
function Set-PWSHYBKPIVChuid { <# .SYNOPSIS Sets a new randomly generated CHUID (Card Holder Unique Identifier) on a locally attached YubiKey's PIV application. .DESCRIPTION Wraps "yubico-piv-tool.exe --action set-chuid". The CHUID is part of how PIV-aware software (e.g. Windows smart card logon) recognizes and caches the card, so replacing it can affect existing enrollments; this cmdlet supports -WhatIf/-Confirm with ConfirmImpact 'High'. Throws on failure rather than returning a value, matching Set- verb convention. Accepts the "set-chuid" action's config-declared options (-ManagementKey, -Reader) as dynamic parameters built from Config\Posh-YBKPIV.json. .PARAMETER ManagementKey The management key authorizing the operation, as a SecureString. Defaults to yubico-piv-tool.exe's built-in default management key when omitted. .PARAMETER Reader Name of the smart card reader to target, when more than one is attached. If omitted, yubico-piv-tool.exe uses its own default reader selection. .INPUTS None. This cmdlet does not accept pipeline input. .OUTPUTS None. Throws a terminating error on failure; produces no output on success. .NOTES -ManagementKey and -Reader are declared dynamically from Config\Posh-YBKPIV.json and therefore do not appear in Get-Help's PARAMETERS/SYNTAX sections. Run `Get-Command Set-PWSHYBKPIVChuid -Syntax` for the authoritative, current parameter list. .EXAMPLE Set-PWSHYBKPIVChuid Sets a new random CHUID after confirmation. .LINK https://developers.yubico.com/yubico-piv-tool/Actions/ .LINK Set-PWSHYBKPIVCcc #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param() DynamicParam { $dynamicConfig = Read-PWSHYBKPIVConfigFile Get-PWSHYBKPIVActionParameter -Action 'set-chuid' -CmdletWrapping $dynamicConfig.cmdletWrapping } begin { $config = Read-PWSHYBKPIVConfigFile Write-PWSHYBKPIVLog -Config $config -Level Debug -CmdletName $MyInvocation.MyCommand.Name ` -Message 'Cmdlet invoked' -BoundParameters $PSBoundParameters $architecture = Resolve-PWSHYBKPIVArchitecture -Architecture $config.installation.architecture $exePath = Get-PWSHYBKPIVInstallPath -Installation $config.installation -Architecture $architecture if (-not (Test-Path -Path $exePath -PathType Leaf)) { throw "yubico-piv-tool.exe was not found at '$exePath'. Run Install-PWSHYBKPIVTool first." } } end { if (-not $PSCmdlet.ShouldProcess('YubiKey PIV application', 'Set CHUID')) { return } try { $null = Invoke-PWSHYBKPIVTool -ExePath $exePath -Action 'set-chuid' ` -CmdletWrapping $config.cmdletWrapping -BoundParameters $PSBoundParameters Write-PWSHYBKPIVLog -Config $config -Level Information -CmdletName $MyInvocation.MyCommand.Name ` -Message 'CHUID set successfully' } catch { Write-PWSHYBKPIVLog -Config $config -Level Error -CmdletName $MyInvocation.MyCommand.Name -Message "CHUID change failed: $_" throw } } } |