prepare release 1.1.0 (#74)

#### 📖 Summary

- updates changelog

#### 📑 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 <marco.blessing@googlemail.com>
Reviewed-on: OCram85/PSCredentialStore#74

.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

.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

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+<!-- insertMark -->
+## `v1.1.0`
+
+- (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)
+- (b76668c) fix Test-CredentialStoreItem return (#66)
+- (ae62ccc) switch to GNU AGPLv3 license (#64)
+- (a66e824) adds community contribution for CiscoUCS connection fix (#63)
+- (3d90d91) fix lint (PSScriptAnalyzer) issues (#62)
+- (d0b7e53) adds DroneHelper (#61)
+- (d4b00a5) Migrates to Pester5+ tests (#59)
+- (e340466) update references (#60)
+- (88743e9) fix pester verbosity config (#58)
+- (c31ee79) Update issue templates (#57)
+- (c45490a) Update issue templates (#56)
+- (4abfec5) adds PR template (#55)
+- (7708df9) Update pwsh style to latest community standards (#52)
+
+## `v1.0.542`
+
+- 🧙 pre migrated Gitea version

README.md

@@ -5,7 +5,10 @@
 
 <p align="center">
   <a href="https://gitea.ocram85.com/OCram85/PSCredentialStore/">
-    <img src="https://gitea.ocram85.com/OCram85/PSCredentialStore/raw/branch/master/assets/social-logo.png" alt="PSCredentialStore" />
+    <img
+      src="https://gitea.ocram85.com/OCram85/PSCredentialStore/raw/branch/master/assets/social-logo.png"
+      alt="PSCredentialStore"
+    >
   </a>
 </p>
 
@@ -19,7 +22,10 @@
 
 <p align="center">
   <a href="https://drone.ocram85.com/OCram85/PSCredentialStore">
-    <img src="https://drone.ocram85.com/api/badges/OCram85/PSCredentialStore/status.svg" alt="Master Branch Build Status">
+    <img
+      src="https://drone.ocram85.com/api/badges/OCram85/PSCredentialStore/status.svg"
+      alt="Master Branch Build Status"
+    >
   </a>
   <!-- CodeCove disabled for self hosting git
   <a href="https://codecov.io/gh/OCram85/PSCredentialStore">
@@ -27,23 +33,30 @@
   </a>
   -->
   <a href="https://www.powershellgallery.com/packages/PSCredentialStore">
-    <img src="https://img.shields.io/powershellgallery/v/PSCredentialStore.svg?style=plastic" alt="PowershellGallery Published Version">
+    <img
+      src="https://img.shields.io/powershellgallery/v/PSCredentialStore.svg?style=plastic"
+      alt="PowershellGallery Published Version"
+    >
   </a>
   <a href="https://www.powershellgallery.com/packages/PSCredentialStore">
-    <img src="https://img.shields.io/powershellgallery/vpre/PSCredentialStore.svg?label=latest%20preview&style=plastic" />
+    <img
+      src="https://img.shields.io/powershellgallery/vpre/PSCredentialStore.svg?label=latest%20preview&style=plastic"
+    >
   </a>
   <a href="https://www.powershellgallery.com/packages/PSCredentialStore">
-    <img src="https://img.shields.io/powershellgallery/dt/PSCredentialStore.svg?style=plastic" />
+    <img
+      src="https://img.shields.io/powershellgallery/dt/PSCredentialStore.svg?style=plastic"
+    >
   </a>
 </p>
 
 
 ## :key: General
 
-The PSCredentialStore is a simple credential manager for `PSCredential` objects. It stores PSCredentials in a simple json
+The PSCredentialStore is a simple credential manager for `PSCredential` objects. It stores PSCredentials in a simple
-file. You can choose between a private and shared credential store. The private one exists in your profile and can
+json file. You can choose between a private and shared credential store. The private one exists in your profile and
-ony accessed by your account on the same machine. The shared store enables you to use different credentials for your
+can ony accessed by your account on the same machine. The shared store enables you to use different credentials for
-scripts without exposing them as plain text.
+your scripts without exposing them as plain text.
 
 PSCredentialStore was developed to simplify the delegation of complex powershell scripts. In this case you often
 need to store credentials for non interactive usage like in scheduled tasks.
@@ -51,10 +64,10 @@ need to store credentials for non interactive usage like in scheduled tasks.
 Starting with version `1.0.0` PSCredential uses Pfx certificates fo encryption. You can use Pfx certificate files
 or certificates stored in the certificate store.
 
-For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on gitea or via CLI with
+For more details read the [about_PSCredentialStore](docs/about_PSCredentialStore.md) page on Gitea or via CLI with
 `Get-Help about_PSCredentialStore`.
 
-You can find the [reference](/docs/PSCredentialStore.md) in the /docs/ path as well.
+You can find the full [reference](docs/Readme.md) in the */docs/* path as well.
 
 ## :vulcan_salute: Requirements
 
@@ -63,24 +76,26 @@ You can find the [reference](/docs/PSCredentialStore.md) in the /docs/ path as w
 
 ## :bomb: About Security
 
->This section explains some security topics and the the design decisions we made to balance the usage and security needs.
+> This section explains some security topics and the design decisions we made to balance the usage and security needs.
 
 To be able to delegate `PSCredentials` objects we can't exclusively rely on the `SecureString` cmdlets. You can't
 decrypt and reuse such credentials from a different user account or even machine. This is caused by automatically
-generated encryption key which, is used create a `Secure String` based encrypted string.
+generated encryption key, which is used create a `Secure String` based encrypted string.
 
 In order to delegate a password, while still using the underlying security framework, we have to provide a custom
 encryption key. This leads to the fact, that everyone who has access to the key could encrypt or decrypt your data.
 
-So we decided to use the public and private keys from valid certificates as part of the custom encryption keys to encrypt your data.
+So we decided to use the public and private keys from valid certificates as part of the custom encryption keys to
+encrypt your data.
 
-This means clearly: Everyone who has access to the `CredentialStore` needs also access to the certificate file to work with it.
+This means clearly: Everyone who has access to the `CredentialStore` needs also access to the certificate file to
+work with it.
 
-Keep in mind you need to secure the access with your NTFS file permissions to avoid unwanted usage. Another option is
+Keep in mind you need to secure the access with your NTFS file permissions to avoid unwanted usage. Another option
-to import the certificate into your certification vaults of you operating system. In this case you can grand the
+is to import the certificate into your certification vaults of you operating system. In this case you can grand the
 permission to the certificates itself.
 
-Here is s brief hierarchy description of the certificate location: *(First match wins)*
+Here is a brief hierarchy description for the certificate lookup order: *(First match wins)*
 
 | CredentialStore Type | Certificate Location   |
 | -------------------- | ---------------------- |
@@ -95,7 +110,7 @@ Here is s brief hierarchy description of the certificate location: *(First match
 ### :artificial_satellite: PowerShellGallery.com (Recommended Way)
 
 * Make sure you use PowerShell 5.1 or higher with `$PSVersionTable`.
-* Use the builtin PackageManagement and install with: `Import-Module PowerShellGet; Install-Module 'PSCredentialStore' -Repository 'PSGallery'`
+* Use the builtin PackageManagement + PowerShellGet module and install PSCredentialStore with: `Import-Module PowerShellGet; Install-Module 'PSCredentialStore' -Repository 'PSGallery'`
   * Additionally use the `-AllowPrerelease` switch until we publish the final release!
 * Done. Start exploring the Module with `Import-Module PSCredentialStore; Get-Command -Module PSCredentialStore`
 
@@ -109,8 +124,9 @@ Here is s brief hierarchy description of the certificate location: *(First match
 
 ### :sparkles: Quick Start
 
-**1.** First we need a blank credential store. You can decide between a *private* or *shared* store. The private
+**1.** First we need a blank credential store. You can decide between a *private* or *shared* one.
-Credential Store can only be accessed with your profile on the machine you created it.
+
+> :bulb: Note: The private credential store can only be accessed with your profile on the machine you created it.
 
 Starting with version `1.0.0` you can decide the storage type of your fresh created certificate. As default
 PSCredentialStore creates a new pfx certificate file beside the credential store itself. Optionally you can provide
@@ -131,6 +147,7 @@ New-CredentialStore -Shared -Path 'C:\CredentialStore.json'
 ```
 
 **2.** Now you can manage your credential store items:
+
 ```powershell
 # This will prompt for credentials and stores it in a private store
 New-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier 'AD'
@@ -141,7 +158,7 @@ Invoke-Command -ComputerName 'dc01.myside.local' -Credential $DCCreds -ScripBloc
 ```
 
 The credential store contains also a simple function to establish a connection with several systems or protocols.
-If you have already installed the underlying framework / modules, you can connect these endpoints:
+If you have already installed the underlying framework / modules, you can connect to these endpoint types:
 
 * **CiscoUcs** - Establish a connection to a Cisco UCS fabric interconnect.
   * Required Modules: [`Cisco.UCS.Core`, `Cisco.UCSManager`](https://software.cisco.com/download/release.html?i=!y&mdfid=286305108&softwareid=284574017&release=2.1.1)

resources/Dependency.json

@@ -1,38 +0,0 @@
-{
-    "Version": 0.1,
-    "Mandatory": {},
-    "Optional": [
-        {
-            "Name": "foobar2000",
-            "Modules": [
-                "foobar2000"
-            ]
-        },
-        {
-            "Name": "foo",
-            "Modules": [
-                "foo",
-                "bar"
-            ]
-        },
-        {
-            "Name": "bar",
-            "Modules": [
-                "bar"
-            ]
-        },
-        {
-            "Name": "Existing",
-            "Modules": [
-                "PowerShellGet"
-            ]
-        },
-        {
-            "Name": "PSGetMixed",
-            "Modules": [
-                "PowerShellGet",
-                "foobar2000"
-            ]
-        }
-    ]
-}

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'

src/Connection/Connect-To.ps1

@@ -130,12 +130,6 @@ function Connect-To {
             }
         }
 
-        # First check the optional modules
-        if (-not (Resolve-Dependency -Name $Type)) {
-            Write-Error -Message (
-                "Could not resolve the optional dependencies defined for {0}" -f $Type
-            ) -ErrorAction 'Stop'
-        }
         switch ($Type) {
             "VMware" {
                 # Disable the yellow certificate warning, since we haven't replaced the SSL certs for vCenter/ESXi

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" {

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 "") {
+        if ($Identifier -ne '') {
-            $CredentialName = $RemoteHost = "{0}/{1}" -f $Identifier, $RemoteHost
+            $CredentialName = $RemoteHost = '{0}/{1}' -f $Identifier, $RemoteHost
         }
         else {
             $CredentialName = $RemoteHost

src/PSCredentialStore.psd1

@@ -143,7 +143,32 @@
             # RequireLicenseAcceptance = $false
 
             # External dependent modules of this module
-            # ExternalModuleDependencies = @()
+            ExternalModuleDependencies = @(
+                @{
+                    ModuleName = 'VMware.VimAutomation.Core'
+                    ModuleVersion = '6.5.2.6234650'
+                },
+                @{
+                    ModuleName = 'VMware.VimAutomation.Cis.Core'
+                    ModuleVersion = '6.5.4.6983166'
+                },
+                @{
+                    ModuleName = 'Cisco.UCS.Core'
+                    ModuleVersion = '2.3.1.5'
+                },
+                @{
+                    ModuleName = 'Cisco.UCSManager'
+                    ModuleVersion = '2.5.2.2'
+                },
+                @{
+                    ModuleName = 'WinSCP'
+                    ModuleVersion = '5.17.8.1'
+                },
+                @{
+                    ModuleName = 'DataONTAP'
+                    ModuleVersion = '9.7.1.1'
+                }
+            )
 
         } # End of PSData hashtable
 

src/Private/Resolve-Dependency.Tests.ps1

@@ -1,60 +0,0 @@
-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
-    }
-}
-
-Describe "Resolve-Dependency" {
-    Context "Basic syntax check" {
-        BeforeAll {
-            Mock  Get-ModuleBase {
-                return (Join-Path -Path $PWD -ChildPath '/resources')
-            }
-            Mock Test-Module {
-                return $true
-            }
-        }
-
-        It "Test1: Should not throw" {
-            { Resolve-Dependency -Name 'foobar2000' } | Should -Not -Throw
-        }
-        It "Test2: Output type should be bool" {
-            Resolve-Dependency -Name 'foobar2000' | Should -BeOfType bool
-        }
-    }
-    Context "Enforce Error" {
-        # Return incorrect module base to enforce there is no config file.
-        Mock Get-ModuleBase {
-            if ($IsWindows) { return "C:\" }
-            elseif ($isLinux) { return "/" }
-        }
-        It "Missing dependency file should not cause an error" {
-            { Resolve-Dependency -Name 'awesome' } | Should -Not -Throw
-        }
-
-        It "Missing dependency file should return true" {
-            Resolve-Dependency -Name 'awesome' | Should -Be $true
-        }
-    }
-    Context "Testing input variations" {
-        It "Should return true if all given dependencies exist" {
-            Mock Get-ModuleBase {
-                return (Join-Path -Path $PWD -ChildPath '/resources')
-            }
-            Resolve-Dependency -Name 'Existing' | Should -Be $true
-        }
-        It "Mixed results should return false" {
-            Mock Get-ModuleBase {
-                return (Join-Path -Path $PWD -ChildPath '/resources')
-            }
-            Resolve-Dependency -Name 'PSGetMixed' | Should -Be $false
-        }
-    }
-}

src/Private/Resolve-Dependency.ps1

@@ -1,87 +0,0 @@
-function Resolve-Dependency {
-    <#
-    .SYNOPSIS
-        Tests defined optional dependencies and returns the result as bool.
-
-    .DESCRIPTION
-        Use this function to test for optional modules. You can use it if you provide functions which needs special
-        modules but you don't want to make them required.
-
-        Place a file called Dependency.json in your module root dir. The default format is:
-
-        {
-            "Version": 0.1,
-            "Mandatory": {},
-            "Optional": [
-                {
-                    "Name": "VMware",
-                    "Modules": [
-                        "VMware.VimAutomation.Core"
-                    ]
-                },
-                {
-                    "Name": "CiscoUCS",
-                    "Modules": []
-                }
-            ]
-        }
-
-    .PARAMETER Name
-        Select the dependency item name you defined in the dependency.json.
-    .INPUTS
-        [None]
-
-    .OUTPUTS
-        [bool]
-
-    .EXAMPLE
-        If (-not (Resolve-Dependency -Name 'VMware')) {
-            Write-Error -Message (
-                "Could not resolve the optional dependencies defined for {0}" -f 'VMware'
-            ) -ErrorAction 'Stop'
-        }
-    #>
-
-    [OutputType([bool])]
-    [CmdletBinding()]
-    param (
-        [Parameter(Mandatory = $true)]
-        [ValidateNotNullOrEmpty()]
-        [string]$Name
-    )
-
-    begin {
-        $ModuleRootDir = Get-ModuleBase
-        $DepFilePath = Join-Path -Path $ModuleRootDir -ChildPath "Dependency.json"
-        if (Test-Path -Path $DepFilePath) {
-            $Dependency = Get-Content -Path $DepFilePath -Raw -Encoding UTF8 | ConvertFrom-Json
-        }
-        else {
-            Write-Warning ("Could not find the dependency file: {0}" -f $DepFilePath)
-        }
-    }
-
-    process {
-        # ScriptAnalyzer issue workaround (unused var)
-        $null = $Name
-        $SelectedDependency = $Dependency.Optional | Where-Object { $_.Name -match $Name }
-        # return true if there is no dependency defined
-        if ($null -eq $SelectedDependency) {
-            return $true
-        }
-
-        $res = @()
-        foreach ($Module in $SelectedDependency.Modules) {
-            $res += Test-Module -Name $Module
-        }
-        # return false if there was not module at all
-        if (($res -contains $false) -or ($res.Count -eq 0)) {
-            return $false
-        }
-        else {
-            return $true
-        }
-    }
-
-    end {}
-}