From 6fce8d6a8c0899ef07f1d81d1553be306fb5b16f Mon Sep 17 00:00:00 2001 From: OCram85 Date: Tue, 20 Sep 2022 11:58:29 +0200 Subject: [PATCH 1/7] Updates libressl files (#71) #### :book: Summary - adds missing `vendor` files into build package. - adds missing `openssl.conf` in build package. - updates libressl / openssl to v3.5.3 #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification #### :books: Additional Notes - :zap: See `v1.1.0-dev9` build - https://gitea.ocram85.com/OCram85/PSCredentialStore/releases/tag/v1.1.0-dev9 Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/PSCredentialStore/pulls/71 --- .drone.yml | 2 +- .gitattributes | 1 + src/Certificate/New-CSCertificate.ps1 | 2 +- src/Vendor/{libressl255 => libressl}/LICENSE | 0 src/Vendor/libressl/openssl.exe | 3 +++ src/Vendor/libressl255/libcrypto-41.dll | 3 --- src/Vendor/libressl255/libcrypto-41.exp | 3 --- src/Vendor/libressl255/libcrypto-41.lib | 3 --- src/Vendor/libressl255/libcrypto-41.pdb | 3 --- src/Vendor/libressl255/libssl-43.dll | 3 --- src/Vendor/libressl255/libssl-43.exp | 3 --- src/Vendor/libressl255/libssl-43.lib | 3 --- src/Vendor/libressl255/libssl-43.pdb | 3 --- src/Vendor/libressl255/libtls-15.dll | 3 --- src/Vendor/libressl255/libtls-15.exp | 3 --- src/Vendor/libressl255/libtls-15.lib | 3 --- src/Vendor/libressl255/libtls-15.pdb | 3 --- src/Vendor/libressl255/ocspcheck.exe | 3 --- src/Vendor/libressl255/openssl.exe | 3 --- 19 files changed, 6 insertions(+), 44 deletions(-) rename src/Vendor/{libressl255 => libressl}/LICENSE (100%) create mode 100644 src/Vendor/libressl/openssl.exe delete mode 100644 src/Vendor/libressl255/libcrypto-41.dll delete mode 100644 src/Vendor/libressl255/libcrypto-41.exp delete mode 100644 src/Vendor/libressl255/libcrypto-41.lib delete mode 100644 src/Vendor/libressl255/libcrypto-41.pdb delete mode 100644 src/Vendor/libressl255/libssl-43.dll delete mode 100644 src/Vendor/libressl255/libssl-43.exp delete mode 100644 src/Vendor/libressl255/libssl-43.lib delete mode 100644 src/Vendor/libressl255/libssl-43.pdb delete mode 100644 src/Vendor/libressl255/libtls-15.dll delete mode 100644 src/Vendor/libressl255/libtls-15.exp delete mode 100644 src/Vendor/libressl255/libtls-15.lib delete mode 100644 src/Vendor/libressl255/libtls-15.pdb delete mode 100644 src/Vendor/libressl255/ocspcheck.exe delete mode 100644 src/Vendor/libressl255/openssl.exe diff --git a/.drone.yml b/.drone.yml index ed9649a..a12591e 100644 --- a/.drone.yml +++ b/.drone.yml @@ -120,7 +120,7 @@ steps: Install-Module -Name 'DroneHelper' -Repository 'PSGallery' -ErrorAction 'Stop' -AllowPrerelease -Force; Import-Module -Name 'DroneHelper' -ErrorAction 'Stop'; Install-ModuleDependency; - New-BuildPackage -Verbose + New-BuildPackage -Verbose -AdditionalPath @('./src/Vendor', './src/openssl.conf') }" - name: GiteaRelease diff --git a/.gitattributes b/.gitattributes index 48c4df2..0475b8c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -21,4 +21,5 @@ # Vendor resources config src/Vendor/libressl255/* filter=lfs diff=lfs merge=lfs -text +src/Vendor/libressl/* filter=lfs diff=lfs merge=lfs -text *.pfx filter=lfs diff=lfs merge=lfs -text diff --git a/src/Certificate/New-CSCertificate.ps1 b/src/Certificate/New-CSCertificate.ps1 index 7cb2ef1..3946224 100644 --- a/src/Certificate/New-CSCertificate.ps1 +++ b/src/Certificate/New-CSCertificate.ps1 @@ -66,7 +66,7 @@ function New-CSCertificate { ($PSVersionTable.PSEdition -eq 'Desktop' -and $PSVersionTable.PSVersion.Major -lt 6) -or ($IsWindows -eq $true) ) { - $openssl = Join-Path -Path $ModuleBase -ChildPath '/Vendor/libressl255/openssl.exe' + $openssl = Join-Path -Path $ModuleBase -ChildPath '/Vendor/libressl/openssl.exe' } $Env:OPENSSL_CONF = Join-Path $ModuleBase -ChildPath '/openssl.conf' diff --git a/src/Vendor/libressl255/LICENSE b/src/Vendor/libressl/LICENSE similarity index 100% rename from src/Vendor/libressl255/LICENSE rename to src/Vendor/libressl/LICENSE diff --git a/src/Vendor/libressl/openssl.exe b/src/Vendor/libressl/openssl.exe new file mode 100644 index 0000000..6c41afc --- /dev/null +++ b/src/Vendor/libressl/openssl.exe @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2e072bbee7cc9e424bcaf24256527ba9742ae1e5ac3c570bf29ff9f76f8b86c +size 2000384 diff --git a/src/Vendor/libressl255/libcrypto-41.dll b/src/Vendor/libressl255/libcrypto-41.dll deleted file mode 100644 index 37c3f23..0000000 --- a/src/Vendor/libressl255/libcrypto-41.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:58e99e5f73c9722c4c4e23743e533d777bff3337c486d9a945e9aff022125e46 -size 1462912 diff --git a/src/Vendor/libressl255/libcrypto-41.exp b/src/Vendor/libressl255/libcrypto-41.exp deleted file mode 100644 index a70887e..0000000 --- a/src/Vendor/libressl255/libcrypto-41.exp +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:fa14db9365f3e6f30f0bf085e7b33bfd150db6936ec93e481a1d7558436a18a4 -size 454746 diff --git a/src/Vendor/libressl255/libcrypto-41.lib b/src/Vendor/libressl255/libcrypto-41.lib deleted file mode 100644 index b02b3a6..0000000 --- a/src/Vendor/libressl255/libcrypto-41.lib +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:c10a4dee83698de9a445b6b5572bc3f2d21d322e223c1812c3726f675e31951f -size 767528 diff --git a/src/Vendor/libressl255/libcrypto-41.pdb b/src/Vendor/libressl255/libcrypto-41.pdb deleted file mode 100644 index b7e1764..0000000 --- a/src/Vendor/libressl255/libcrypto-41.pdb +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:3193e446fa1c9d8fed5a1d13a7faeccdb2459121ab1723493b34c91caf56c254 -size 1952768 diff --git a/src/Vendor/libressl255/libssl-43.dll b/src/Vendor/libressl255/libssl-43.dll deleted file mode 100644 index 35b13d7..0000000 --- a/src/Vendor/libressl255/libssl-43.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:5785c6c95cf6e5a26389f29cbd1a83702209b0d0cf405ed79eb86966775bd7d8 -size 312957 diff --git a/src/Vendor/libressl255/libssl-43.exp b/src/Vendor/libressl255/libssl-43.exp deleted file mode 100644 index 2dacec3..0000000 --- a/src/Vendor/libressl255/libssl-43.exp +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:64440d35b269efdce0bda183b02d5384cb86e3c8757d3688d09b07ce85d80121 -size 36738 diff --git a/src/Vendor/libressl255/libssl-43.lib b/src/Vendor/libressl255/libssl-43.lib deleted file mode 100644 index 465779b..0000000 --- a/src/Vendor/libressl255/libssl-43.lib +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:e3620a8e6fa138187b9a29b598174c02a9d14c54978c41c871a9ac9791d88b08 -size 61638 diff --git a/src/Vendor/libressl255/libssl-43.pdb b/src/Vendor/libressl255/libssl-43.pdb deleted file mode 100644 index 7439a7e..0000000 --- a/src/Vendor/libressl255/libssl-43.pdb +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2bc96773c21403aa5feae4db58db92d91d93cd3ebc88bc2ff222a1c1ff26c569 -size 388096 diff --git a/src/Vendor/libressl255/libtls-15.dll b/src/Vendor/libressl255/libtls-15.dll deleted file mode 100644 index 077e694..0000000 --- a/src/Vendor/libressl255/libtls-15.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:b0a5ba84d5eb2d7b3a058fd68be411f936ee855748a5e66938b8810b99d96d70 -size 75901 diff --git a/src/Vendor/libressl255/libtls-15.exp b/src/Vendor/libressl255/libtls-15.exp deleted file mode 100644 index 2d1f17f..0000000 --- a/src/Vendor/libressl255/libtls-15.exp +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2f69c7b2bbe5f268cc2d572dd627d6c23081de6d8152dfff4c13c15b303d84a1 -size 11905 diff --git a/src/Vendor/libressl255/libtls-15.lib b/src/Vendor/libressl255/libtls-15.lib deleted file mode 100644 index f77188e..0000000 --- a/src/Vendor/libressl255/libtls-15.lib +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:93d30dc5ca2f3f102ee530f306139cca5b392afebc8fa65c054ae17884bb964c -size 20352 diff --git a/src/Vendor/libressl255/libtls-15.pdb b/src/Vendor/libressl255/libtls-15.pdb deleted file mode 100644 index d73e345..0000000 --- a/src/Vendor/libressl255/libtls-15.pdb +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:c404a8c410624e8444078eabb913f52e3aadbac6d103f7eb5828f9bea1954219 -size 166912 diff --git a/src/Vendor/libressl255/ocspcheck.exe b/src/Vendor/libressl255/ocspcheck.exe deleted file mode 100644 index 417ab92..0000000 --- a/src/Vendor/libressl255/ocspcheck.exe +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:a69805aee7ee6cb71cf057504c4947b75c6fec935166271a05aa323a594960c0 -size 578870 diff --git a/src/Vendor/libressl255/openssl.exe b/src/Vendor/libressl255/openssl.exe deleted file mode 100644 index d63d3bf..0000000 --- a/src/Vendor/libressl255/openssl.exe +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:45576fd9f2903fd02cba75d1888d2ced7deab77e8a2e2c3dd05db2d87c81d3a1 -size 2271428 From 3d4f53ddc7136d6baec204ad55606e5e34922cff Mon Sep 17 00:00:00 2001 From: OCram85 Date: Tue, 20 Sep 2022 15:01:05 +0200 Subject: [PATCH 2/7] adds pinguinfuss contributed fix (#73) #### :book: Summary - redo PR from @pinguinfuss - fix error message - fix string quotation #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification #### :books: Additional Notes - just redo #72. - there was an issue caused by git config `core.autocrl` displaying / diffin the wrong line ending sequence Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/PSCredentialStore/pulls/73 --- src/Item/New-CredentialStoreItem.Tests.ps1 | 2 +- src/Item/New-CredentialStoreItem.ps1 | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Item/New-CredentialStoreItem.Tests.ps1 b/src/Item/New-CredentialStoreItem.Tests.ps1 index 4bc582e..fcbc336 100644 --- a/src/Item/New-CredentialStoreItem.Tests.ps1 +++ b/src/Item/New-CredentialStoreItem.Tests.ps1 @@ -102,7 +102,7 @@ Describe "New-CredentialStoreItem" { It "Missing CredentialStore should throw" { { New-CredentialStoreItem -Shared -Path '/tmp/missingStore.json' -RemoteHost 'notrelevant' - } | Should -Throw "Could not add anything into the given CredentialStore." + } | Should -Throw "The given credential store (/tmp/missingStore.json) does not exist!" } } Context "Testing pipeline paramter" { diff --git a/src/Item/New-CredentialStoreItem.ps1 b/src/Item/New-CredentialStoreItem.ps1 index 957897a..6e159cb 100644 --- a/src/Item/New-CredentialStoreItem.ps1 +++ b/src/Item/New-CredentialStoreItem.ps1 @@ -32,7 +32,7 @@ function New-CredentialStoreItem { [None] .EXAMPLE - New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" + New-CredentialStoreItem -Path 'C:\TMP\mystore.json' -RemoteHost esx01.myside.local' #> [CmdletBinding(DefaultParameterSetName = 'Private')] @@ -68,7 +68,7 @@ function New-CredentialStoreItem { begin { # Set the CredentialStore for private, shared or custom mode. - Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) + Write-Debug ('ParameterSetName: {0}' -f $PSCmdlet.ParameterSetName) if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } @@ -84,9 +84,9 @@ function New-CredentialStoreItem { if (-not(Test-CredentialStore -Shared -Path $Path)) { $MessageParams = @{ Exception = [System.IO.FileNotFoundException]::new( - 'Could not add anything into the given CredentialStore.' + 'The given credential store ({0}) does not exist!' -f $Path ) - ErrorAction = "Stop" + ErrorAction = 'Stop' } Write-Error @MessageParams } @@ -95,8 +95,8 @@ function New-CredentialStoreItem { $CurrentDate = Get-Date -Format 'u' - if ($Identifier -ne "") { - $CredentialName = $RemoteHost = "{0}/{1}" -f $Identifier, $RemoteHost + if ($Identifier -ne '') { + $CredentialName = $RemoteHost = '{0}/{1}' -f $Identifier, $RemoteHost } else { $CredentialName = $RemoteHost From ac6a9d8202612f217cb787e3543f9f733b822096 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Wed, 21 Sep 2022 09:39:56 +0200 Subject: [PATCH 3/7] prepare release 1.1.0 (#74) #### :book: Summary - updates changelog #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification #### :books: Additional Notes Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/PSCredentialStore/pulls/74 --- CHANGELOG.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7283a11..7f06af3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,9 @@ ## `v1.1.0` -- (acb09ba) update Changelog +- (3d4f53d) adds pinguinfuss contributed fix (#73) +- (6fce8d6) Updates libressl files (#71) +- (ddb85d9) addChangelog (#70) - (5bdb383) updates Readme (#69) - (a95ba31) remove optional depenency helper (#68) - (1e7dd78) adds CiscoUCSCentral connection type (#67) @@ -20,7 +22,6 @@ - (4abfec5) adds PR template (#55) - (7708df9) Update pwsh style to latest community standards (#52) - ## `v1.0.542` - 🧙 pre migrated Gitea version From 2bd250971b4d3ad2c05c88b0dff27feaeb36b294 Mon Sep 17 00:00:00 2001 From: pinguinfuss Date: Mon, 10 Oct 2022 10:00:42 +0200 Subject: [PATCH 4/7] Fix optional module dependencies (#75) #### :book: Summary - Fix the optional dependencies. - DataONTAP was never a PSGallery module, and we have to custom build that. - NetApp finally submitted NetApp.ONTAP into PSGallery, so we can depend on that. - Updates UCS- and VMware-modules. #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [ ] Tested via Drone.io pipeline - [ ] Custom test - [x] No test plan ##### Details / Justification Sadly, you have to run it. The module loader does not have a unit test. #### :books: Additional Notes Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/PSCredentialStore/pulls/75 Reviewed-by: OCram85 Co-authored-by: pinguinfuss Co-committed-by: pinguinfuss --- src/PSCredentialStore.psd1 | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/PSCredentialStore.psd1 b/src/PSCredentialStore.psd1 index efe91d9..c8ce1cf 100644 --- a/src/PSCredentialStore.psd1 +++ b/src/PSCredentialStore.psd1 @@ -146,27 +146,27 @@ ExternalModuleDependencies = @( @{ ModuleName = 'VMware.VimAutomation.Core' - ModuleVersion = '6.5.2.6234650' + ModuleVersion = '12.7.0.20091293' }, @{ ModuleName = 'VMware.VimAutomation.Cis.Core' - ModuleVersion = '6.5.4.6983166' + ModuleVersion = '12.6.0.19601368' }, @{ - ModuleName = 'Cisco.UCS.Core' - ModuleVersion = '2.3.1.5' + ModuleName = 'Cisco.UCS.Common' + ModuleVersion = '3.0.1.2' }, @{ ModuleName = 'Cisco.UCSManager' - ModuleVersion = '2.5.2.2' + ModuleVersion = '3.0.1.2' }, @{ ModuleName = 'WinSCP' ModuleVersion = '5.17.8.1' }, @{ - ModuleName = 'DataONTAP' - ModuleVersion = '9.7.1.1' + ModuleName = 'NetApp.ONTAP' + ModuleVersion = '9.10.1.2111' } ) From 42fdb0a373f079b8d2f7d7d8978dc389a1453be1 Mon Sep 17 00:00:00 2001 From: pinguinfuss Date: Mon, 10 Oct 2022 10:05:08 +0200 Subject: [PATCH 5/7] Fix Set-CredentialStoreItem (#76) #### :book: 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. #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification #### :books: Additional Notes Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/PSCredentialStore/pulls/76 Reviewed-by: OCram85 Co-authored-by: pinguinfuss Co-committed-by: pinguinfuss --- src/Item/Set-CredentialStoreItem.Tests.ps1 | 130 +++++++++++++++++++++ src/Item/Set-CredentialStoreItem.ps1 | 53 +++++++-- src/Item/Test-CredentialStoreItem.ps1 | 16 +-- 3 files changed, 179 insertions(+), 20 deletions(-) create mode 100644 src/Item/Set-CredentialStoreItem.Tests.ps1 diff --git a/src/Item/Set-CredentialStoreItem.Tests.ps1 b/src/Item/Set-CredentialStoreItem.Tests.ps1 new file mode 100644 index 0000000..c65b3b1 --- /dev/null +++ b/src/Item/Set-CredentialStoreItem.Tests.ps1 @@ -0,0 +1,130 @@ +[Diagnostics.CodeAnalysis.SuppressMessageAttribute( + 'PSAvoidUsingConvertToSecureStringWithPlainText', + '', + Justification = 'just used in pester tests.' +)] +[Diagnostics.CodeAnalysis.SuppressMessageAttribute( + 'PSProvideCommentHelp', + '', + Justification = 'no need in internal pester helpers.' +)] +param () + +BeforeAll { + $ManifestFile = (Get-Item -Path './src/*.psd1').FullName + Import-Module $ManifestFile -Force + + $PrivateFunctions = (Get-ChildItem -Path './src/Private/*.ps1' | Where-Object { + $_.BaseName -notmatch '.Tests' + } + ).FullName + foreach ( $func in $PrivateFunctions) { + . $func + } + + # Backup existing credential stores + $VerbosePreference = 'Continue' + Write-Verbose -Message 'Backup private Credential Store...' + $CSPath = Get-DefaultCredentialStorePath + $BackupFile = '{0}.back' -f $CSPath + if (Test-Path -Path $CSPath) { + Move-Item -Path $CSPath -Destination $BackupFile + } + Write-Verbose -Message 'Backup shared CredentialStore...' + $CSShared = Get-DefaultCredentialStorePath -Shared + $BackupSharedFile = '{0}.back' -f $CSShared + if (Test-Path -Path $CSShared) { + Move-Item -Path $CSShared -Destination $BackupSharedFile + } + Write-Verbose -Message 'Remove old CredentialStore in Temp dir' + $CSTemp = Join-Path -Path (Get-TempDir) -ChildPath '/CredentialStore.json' + if (Test-Path -Path $CSTemp) { + Remove-Item -Path $CSTemp + } + $VerbosePreference = 'SilentlyContinue' +} + +Describe 'New-CredentialStoreItem' { + Context 'Private Credential Store tests' { + It 'Add entry to a private store.' { + # Create a fresh CredentialStore first + New-CredentialStore -Force + + # Define the content of the CredentialStoreItem. + $RemoteHost = 'barfoo' + $UserName = 'MyUser' + $Password = 'fooobarysdfsfs' | ConvertTo-SecureString -AsPlainText -Force + + # Form the CredentialObject. + $creds = [PSCredential]::new($UserName, $Password) + + # Create the CredentialStoreItem. + New-CredentialStoreItem -RemoteHost $RemoteHost -Credential $creds + + # Formulate an update to the CredentialStoreItem. + $ClearPassword = 'fooobaryadfafa' + $Password = $ClearPassword | ConvertTo-SecureString -AsPlainText -Force + $creds = [PSCredential]::new($UserName, $Password) + { + Set-CredentialStoreItem -RemoteHost $RemoteHost -Credential $creds + } | Should -Not -Throw + + # Control the content of the CredentialStore. + $content = Get-CredentialStoreItem -RemoteHost $RemoteHost + $content.GetNetworkCredential().Password | Should -Be $ClearPassword + } + } + Context 'Shared Credential Store tests' { + It 'Add entry to a shared store.' { + # Create a fresh CredentialStore first + $tmpCS = Join-Path -Path (Get-TempDir) -ChildPath '/CredentialStore.json' + New-CredentialStore -Path $tmpCS -Force -Shared + + # Define the content of the CredentialStoreItem. + $RemoteHost = 'barfoo' + $UserName = 'MyUser' + $Password = 'fooobarysdfsfs' | ConvertTo-SecureString -AsPlainText -Force + + # Form the CredentialObject. + $creds = [PSCredential]::new($UserName, $Password) + + # Create the CredentialStoreItem. + New-CredentialStoreItem -RemoteHost $RemoteHost -Credential $creds -Path $tmpCS -Shared + + # Formulate an update to the CredentialStoreItem. + $ClearPassword = 'fooobaryadfafa' + $Password = $ClearPassword | ConvertTo-SecureString -AsPlainText -Force + $creds = [PSCredential]::new($UserName, $Password) + + { + Set-CredentialStoreItem -RemoteHost $RemoteHost -Credential $creds -Path $tmpCS -Shared + } | Should -Not -Throw + + # Control the content of the CredentialStore. + $content = Get-CredentialStoreItem -RemoteHost $RemoteHost -Path $tmpCS -Shared + $content.GetNetworkCredential().Password | Should -Be $ClearPassword + } + } +} + +AfterAll { + # Cleanup test stores and restore existing ones. + $VerbosePreference = 'Continue' + Write-Verbose -Message 'Restoring private CredentialStore' + If (Test-Path -Path $BackupFile) { + If (Test-Path -Path $CSPath) { + Remove-Item -Path $CSPath + Move-Item -Path $BackupFile -Destination $CSPath + } + } + + Write-Verbose -Message 'Restoring shared CredentialStore' + If (Test-Path -Path $BackupSharedFile) { + If (Test-Path -Path $CSShared) { + Remove-Item -Path $CSShared + Move-Item -Path $BackupSharedFile -Destination $CSShared + } + } + $VerbosePreference = 'SilentlyContinue' + +} diff --git a/src/Item/Set-CredentialStoreItem.ps1 b/src/Item/Set-CredentialStoreItem.ps1 index 5a821a7..26ede48 100644 --- a/src/Item/Set-CredentialStoreItem.ps1 +++ b/src/Item/Set-CredentialStoreItem.ps1 @@ -13,7 +13,7 @@ function Set-CredentialStoreItem { Specify the host you for which you would like to change the credentials. .PARAMETER Identifier - Defaults to "". Specify a string, which separates two CredentialStoreItems for the + Defaults to ''. Specify a string, which separates two CredentialStoreItems for the same hostname. .PARAMETER Shared @@ -30,10 +30,10 @@ function Set-CredentialStoreItem { [None] .EXAMPLE - Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" + Set-CredentialStoreItem -Path 'C:\TMP\mystore.json' -RemoteHost 'esx01.myside.local' .EXAMPLE - Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc + Set-CredentialStoreItem -Path 'C:\TMP\mystore.json' -RemoteHost 'esx01.myside.local' -Identifier svc #> [CmdletBinding(DefaultParameterSetName = 'Private')] @@ -65,7 +65,7 @@ function Set-CredentialStoreItem { begin { # Set the CredentialStore for private, shared or custom mode. - Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) + Write-Debug ('ParameterSetName: {0}' -f $PSCmdlet.ParameterSetName) if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } @@ -77,32 +77,52 @@ function Set-CredentialStoreItem { } process { - # Lets do a quick test on the given CredentialStore. - if (-not(Test-CredentialStore -Shared -Path $Path)) { + # Define the default splatting. + $DefaultSplatting = @{ + Path = $Path + } + + # Check if the user passed -Shared. If he added -Shared, we'll pass it into the splatting + if ($PSBoundParameters.ContainsKey('Shared')) { + $DefaultSplatting.Add('Shared', $true) + } + else { + $DefaultSplatting.Add('Shared', $false) + } + + # Now lets check the given CredentialStore. + if (-not(Test-CredentialStore @DefaultSplatting)) { $MessageParams = @{ - Message = 'Could not add anything into the given CredentailStore.' + Message = ('The given CredentialStore ({0}) does no exist.' -f $Path) ErrorAction = 'Stop' } Write-Error @MessageParams } # Read the file content based on the given ParameterSetName - $CSContent = Get-CredentialStore -Shared -Path $Path + $CSContent = Get-CredentialStore @DefaultSplatting + # Get a formatted current date for the last update time of the Item. $CurrentDate = Get-Date -Format 'u' - if ($Identifier -ne "") { - $CredentialName = $RemoteHost = "{0}/{1}" -f $Identifier, $RemoteHost + # Check if the user supplied an identifier. If so, we need to mangle the CredentialName, as that's where + # the identifier is actually added. + if ($Identifier -ne '') { + $CredentialName = $RemoteHost = '{0}/{1}' -f $Identifier, $RemoteHost } else { $CredentialName = $RemoteHost } + # If the user didn't supply a CredentialObject, we need to prompt for it. if (-not($Credential)) { $Credential = Get-Credential -Message $CredentialName } - if ($Credential.UserName) { + # If the username isn't empty, we ca go ahead and update the entry. + if ($null -ne $Credential.UserName -and -not [string]::IsNullOrWhiteSpace($Credential.UserName)) { + # Check if the path to the PfxCertificate is stored in the CredentialStore. If so load the certificate. + # If not, load try loading the certificate from the Filepath of the CredentialStore. if ($null -eq $CSContent.PfxCertificate) { $Cert = Get-CSCertificate -Type $CSContent.Type -Thumbprint $CSContent.Thumbprint } @@ -110,13 +130,17 @@ function Set-CredentialStoreItem { $Cert = Get-PfxCertificate -FilePath $CSContent.PfxCertificate -ErrorAction Stop } + # Now locate the Item. if (Get-Member -InputObject $CSContent -Name $CredentialName -MemberType Properties) { + # Get a random AES key for the entry. $RSAKey = Get-RandomAESKey $CSContent.$CredentialName.User = $Credential.UserName $ConvertParams = @{ SecureString = $Credential.Password Key = $RSAKey } + + # Now create a updated item containing the updated credentials. $CSContent.$CredentialName.Password = ConvertFrom-SecureString @ConvertParams $CSContent.$CredentialName.LastChange = $CurrentDate $CSContent.$CredentialName.EncryptedKey = [Convert]::ToBase64String( @@ -125,10 +149,15 @@ function Set-CredentialStoreItem { [System.Security.Cryptography.RSAEncryptionPadding]::Pkcs1 ) ) + + # Convert the CredentialStore back into JSON and save it to the file. ConvertTo-Json -InputObject $CSContent -Depth 5 | Out-File -FilePath $Path -Encoding utf8 } + else { + Write-Warning -Message ('Unable to locate CredentialStoreItem for {0}' -f $CredentialName) + } } - Else { + else { $MessageParams = @{ Message = 'Please Provide at least a valid user!' ErrorAction = 'Stop' diff --git a/src/Item/Test-CredentialStoreItem.ps1 b/src/Item/Test-CredentialStoreItem.ps1 index 66269e6..ec77438 100644 --- a/src/Item/Test-CredentialStoreItem.ps1 +++ b/src/Item/Test-CredentialStoreItem.ps1 @@ -33,11 +33,11 @@ function Test-CredentialStoreItem { [None] .EXAMPLE - if (Test-CredentialStoreItem -RemoteHost "Default") { - Get-CredentialStoreItem -RemoteHost "Default" + 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) + Write-Warning ('The given Remote Host {0} does not exist in the credential Store!' -f $RemoteHost) } #> @@ -45,7 +45,7 @@ function Test-CredentialStoreItem { [OutputType([bool])] param ( [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] - [string]$Path = "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData, + [string]$Path = '{0}\PSCredentialStore\CredentialStore.json' -f $env:ProgramData, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] @@ -61,7 +61,7 @@ function Test-CredentialStoreItem { begin { # Set the CredentialStore for private, shared or custom mode. - Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) + Write-Debug ('ParameterSetName: {0}' -f $PSCmdlet.ParameterSetName) if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } @@ -73,8 +73,8 @@ function Test-CredentialStoreItem { } process { - if ($Identifier -ne "") { - $CredentialName = $RemoteHost = "{0}/{1}" -f $Identifier, $RemoteHost + if ($Identifier -ne '') { + $CredentialName = $RemoteHost = '{0}/{1}' -f $Identifier, $RemoteHost } else { $CredentialName = $RemoteHost @@ -92,7 +92,7 @@ function Test-CredentialStoreItem { } else { $MsgParams = @{ - Message = "The given credential store ({0}) does not exist!" -f $Path + Message = 'The given credential store ({0}) does not exist!' -f $Path } Write-Warning @MsgParams return $false From 0b5c9823e0a4f1fbe55990522f492f529082cb88 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Mon, 10 Oct 2022 10:10:18 +0200 Subject: [PATCH 6/7] Adds changelog config for gitea changelog cli tool (#77) #### :book: Summary - adds initial default config for changelog generation #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [ ] Tested via Drone.io pipeline - [x] Custom test - [ ] No test plan ##### Details / Justification #### :books: Additional Notes Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/PSCredentialStore/pulls/77 --- .changelog.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .changelog.yml diff --git a/.changelog.yml b/.changelog.yml new file mode 100644 index 0000000..944122d --- /dev/null +++ b/.changelog.yml @@ -0,0 +1,32 @@ +# The full repository name +repo: OCram85/PSCredentialStore + +# Service type (gitea or github) +service: gitea + +# Base URL for Gitea instance if using gitea service type (optional) +# Default: https://gitea.com +base-url: https://gitea.ocram85.com + +# Changelog groups and which labeled PRs to add to each group +groups: + - name: ✨ FEATURES + labels: + - feature + - name: 📦 META + labels: + - meta + - name: 🐛 BUGFIXES + labels: + - bug + - name: 🛠️ ENHANCEMENTS + labels: + - enhancement + - name: 📚 DOCS + labels: + - docs + - name: 🔖 MISC + default: true + +# regex indicating which labels to skip for the changelog +skip-labels: skip-changelog|backport\/.+ From f2b7910b156a3ce819a24dcb1b5a579882388787 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Mon, 10 Oct 2022 10:24:52 +0200 Subject: [PATCH 7/7] Prepare release v1.1.1 (#78) #### :book: Summary - updates changelog #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification #### :books: Additional Notes Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/PSCredentialStore/pulls/78 --- CHANGELOG.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f06af3..9bcdfd3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,20 @@ # Changelog +## [v1.1.1](https://gitea.ocram85.com/OCram85/PSCredentialStore/releases/tag/v1.1.1) - 2022-10-10 + +* 📦 META + * Adds changelog config for gitea changelog cli tool (#77) +* 🐛 BUGFIXES + * Fix Set-CredentialStoreItem (#76) + * Fix optional module dependencies (#75) + +### Contributors + + +* [@OCram85](https://gitea.ocram85.com/OCram85) +* [@pinguinfuss](https://gitea.ocram85.com/pinguinfuss) + ## `v1.1.0` - (3d4f53d) adds pinguinfuss contributed fix (#73)