forked from OCram85/PSCredentialStore
pinguinfuss
42fdb0a373
#### 📖 Summary - Fix Set-CredentialStoreItem. Currently it doesn't warn if the user is trying to update a CredentialStoreItem, that does not exist. - Also add a bit of documentation and UnitTests. - Fix the quotation of Test-CredentialStoreItem. #### 📑 Test Plan > 💡 Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification <!-- Add your test details or justification for missing tests here. --> #### 📚 Additional Notes <!-- A place for additional detail notes. --> Co-authored-by: OCram85 <ocram85@noreply.local> Reviewed-on: OCram85/PSCredentialStore#76 Reviewed-by: OCram85 <ocram85@noreply.local> Co-authored-by: pinguinfuss <christian@heimdaheim.de> Co-committed-by: pinguinfuss <christian@heimdaheim.de>
105 lines
3.4 KiB
PowerShell
105 lines
3.4 KiB
PowerShell
function Test-CredentialStoreItem {
|
|
<#
|
|
.SYNOPSIS
|
|
Checks if the given RemoteHost identifier combination exists in the credential store.
|
|
|
|
.DESCRIPTION
|
|
Use this cmdlet for basic checks with a single item. Check the item first with this function before
|
|
you try to interact with it.
|
|
|
|
Breaking Change for `v1.1.0+`:
|
|
Test-CredentialStoreItem will return `$false` even if the store doesn't exist. We removed the terminating
|
|
error and replaced it with a warning message.
|
|
|
|
.PARAMETER Path
|
|
Define a custom credential store you try to read from. Without the `-Path` parameter
|
|
`Test-CredentialStoreItem` tries to read from the default private store.
|
|
|
|
.PARAMETER RemoteHost
|
|
Specify the host, for which you would like to change the credentials.
|
|
|
|
.PARAMETER Identifier
|
|
Adds an optional identifier to the given RemoteHost. Makes it possible to store multiple credentials
|
|
for a single host.
|
|
|
|
.PARAMETER Shared
|
|
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
|
|
can be decrypted across systems.
|
|
|
|
.INPUTS
|
|
[None]
|
|
|
|
.OUTPUTS
|
|
[None]
|
|
|
|
.EXAMPLE
|
|
if (Test-CredentialStoreItem -RemoteHost 'Default') {
|
|
Get-CredentialStoreItem -RemoteHost 'Default'
|
|
}
|
|
else {
|
|
Write-Warning ('The given Remote Host {0} does not exist in the credential Store!' -f $RemoteHost)
|
|
}
|
|
#>
|
|
|
|
[CmdletBinding(DefaultParameterSetName = 'Private')]
|
|
[OutputType([bool])]
|
|
param (
|
|
[Parameter(Mandatory = $false, ParameterSetName = 'Shared')]
|
|
[string]$Path = '{0}\PSCredentialStore\CredentialStore.json' -f $env:ProgramData,
|
|
|
|
[Parameter(Mandatory = $true)]
|
|
[ValidateNotNullOrEmpty()]
|
|
[string]$RemoteHost,
|
|
|
|
[Parameter(Mandatory = $false)]
|
|
[ValidateNotNullOrEmpty()]
|
|
[string]$Identifier,
|
|
|
|
[Parameter(Mandatory = $false, ParameterSetName = 'Shared')]
|
|
[switch]$Shared
|
|
)
|
|
|
|
begin {
|
|
# Set the CredentialStore for private, shared or custom mode.
|
|
Write-Debug ('ParameterSetName: {0}' -f $PSCmdlet.ParameterSetName)
|
|
if ($PSCmdlet.ParameterSetName -eq 'Private') {
|
|
$Path = Get-DefaultCredentialStorePath
|
|
}
|
|
elseif ($PSCmdlet.ParameterSetName -eq 'Shared') {
|
|
if (!($PSBoundParameters.ContainsKey('Path'))) {
|
|
$Path = Get-DefaultCredentialStorePath -Shared
|
|
}
|
|
}
|
|
}
|
|
|
|
process {
|
|
if ($Identifier -ne '') {
|
|
$CredentialName = $RemoteHost = '{0}/{1}' -f $Identifier, $RemoteHost
|
|
}
|
|
else {
|
|
$CredentialName = $RemoteHost
|
|
}
|
|
|
|
if (Test-CredentialStore -Shared -Path $Path) {
|
|
$CS = Get-CredentialStore -Shared -Path $Path
|
|
$CSMembers = Get-Member -InputObject $CS
|
|
if (($CSMembers.MemberType -eq 'NoteProperty') -and ($CSMembers.Name -contains $CredentialName)) {
|
|
return $true
|
|
}
|
|
else {
|
|
return $false
|
|
}
|
|
}
|
|
else {
|
|
$MsgParams = @{
|
|
Message = 'The given credential store ({0}) does not exist!' -f $Path
|
|
}
|
|
Write-Warning @MsgParams
|
|
return $false
|
|
}
|
|
}
|
|
|
|
end {}
|
|
|
|
}
|