Publish version 1.0.x (#45)

## About ## Content (Micro Commits) * fixes #38 * fixes #44 * Implement precise lookup hierarchy (fixes #43) * align pester test with #43 logic * split cert functions * use new cert functions for save an lookup * fix pester tests * [wip] * fix var name ref * fix exports * fix cert store location for windows shared mode * fix mandatory params * fix accidentially removed code block * add basic cert pester pests * remove old docs * update cbh blocks * update cbh blocks * update docs * move .net wrapper forpfx files * do not export .net wrapper functions * update docs * rename tests * fix private functions location * - fixes #44: FTP connection * add link to reference * add format files * add preview version shield * update markdown help files (platyps) * add emoji images in captions * fix typos * fix typos * fix typo * prepare version numbers
2019-04-29 16:05:43 +02:00
parent d92d963979
commit fdc6651588
55 changed files with 1594 additions and 671 deletions
--- a/src/Certificate/Use-CSCertificate.ps1
+++ b/src/Certificate/Use-CSCertificate.ps1
@ -0,0 +1,121 @@
+function Use-CSCertificate {
+    <#
+    .SYNOPSIS
+        Links an existing PFX Certificate to a CredentialStore.
+
+    .DESCRIPTION
+        Linking a certificate is needed if you plan to use the same CredentialStore in cross platform scenarios.
+
+    .PARAMETER Path
+        Specify the path to the PFX Certificate you want to link for usage.
+
+    .PARAMETER CredentialStore
+        Specify a custom path for a shared credential store.
+
+    .PARAMETER Shared
+        Use the credential store in shared mode.
+
+    .PARAMETER UseCertStore
+        Use the given certificate and import it into the corresponding certificate store.
+
+    .INPUTS
+        [None]
+
+    .OUTPUTS
+        [None]
+
+    .EXAMPLE
+        Use-CSCertificate -Path 'C:\cert.pfx'
+
+    .NOTES
+        File Name   : Use-CSCertificate.ps1
+        Author      : Marco Blessing - marco.blessing@googlemail.com
+        Requires    :
+
+    .LINK
+        https://github.com/OCram85/PSCredentialStore
+    #>
+    [CmdletBinding(DefaultParameterSetName = "Private")]
+    [OutputType()]
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")]
+    param(
+        [Parameter(Mandatory = $true, ParameterSetName = "Private")]
+        [Parameter(Mandatory = $true, ParameterSetName = "Shared")]
+        [ValidateNotNullOrEmpty()]
+        [string]$Path,
+
+        [Parameter(Mandatory = $false, ParameterSetName = "Shared")]
+        [ValidateNotNullOrEmpty()]
+        [string]$CredentialStore,
+
+        [Parameter(Mandatory = $true, ParameterSetName = "Shared")]
+        [switch]$Shared,
+
+        [Parameter(Mandatory = $false, ParameterSetName = "Private")]
+        [Parameter(Mandatory = $false, ParameterSetName = "Shared")]
+        [Switch]$UseCertStore
+    )
+    begin { }
+
+    process {
+        try {
+            # We need to resolve the path to make sure it has the correct platform specific syntax.
+            # And it should also exist.
+            $validPath = Resolve-Path -Path $Path -ErrorAction Stop
+            $PfxCertificate = Get-PfxCertificate -FilePath $validPath -ErrorAction Stop
+        }
+        catch {
+            $_.Exception.Error | Write-Error
+            $ErrorParams = @{
+                Message     = 'The given PFX certificate does not exist!'
+                ErrorAction = 'Stop'
+            }
+            Write-Error @ErrorParams
+        }
+
+        try {
+            if ($PSCmdlet.ParameterSetName -eq "Private") {
+                $StorePath = Get-DefaultCredentialStorePath
+                $CS = Get-CredentialStore
+            }
+            elseif ($PSCmdlet.ParameterSetName -eq "Shared" ) {
+                if (!($PSBoundParameters.ContainsKey('CredentialStore'))) {
+                    $StorePath = Get-DefaultCredentialStorePath -Shared
+                    $CS = Get-CredentialStore -Shared
+                }
+                else {
+                    $StorePath = $CredentialStore
+                    $CS = Get-CredentialStore -Shared -Path $CredentialStore
+                }
+            }
+        }
+        catch {
+            $_.Exception.Error | Write-Error
+            $ErrorParams = @{
+                Message     = 'The given CredentialStore does not exist!'
+                ErrorAction = 'Stop'
+            }
+            Write-Error @ErrorParams
+        }
+
+        # Lets first check if the thumbprint matches
+        if (($CS.Thumbprint -notmatch $PfxCertificate.Thumbprint) -and ($CS.Thumbprint.Length -ne 0)) {
+            Write-Warning @"
+You are trying to map an unknown certificate.
+Make sure you used the same AES keys for encrypting!
+"@
+        }
+
+        if ($UseCertStore) {
+            Import-CSCertificate -Type $PSCmdlet.ParameterSetName -Path $Path
+            $CS.Thumbprint = $PfxCertificate.Thumbprint
+            $CS.PfxCertificate = $null
+        }
+        else {
+            $CS.PfxCertificate = $validPath.Path
+        }
+        $CS | ConvertTo-Json -Depth 5 | Out-File -FilePath $StorePath -Force -Encoding utf8
+    }
+
+    end { }
+}