forked from OCram85/PSCredentialStore
Compare commits
6 Commits
v1.1.0-alp
...
v1.1.0
Author | SHA1 | Date | |
---|---|---|---|
ac6a9d8202 | |||
3d4f53ddc7 | |||
6fce8d6a8c | |||
ddb85d907f | |||
5bdb383627 | |||
a95ba31e40 |
@ -120,7 +120,7 @@ steps:
|
|||||||
Install-Module -Name 'DroneHelper' -Repository 'PSGallery' -ErrorAction 'Stop' -AllowPrerelease -Force;
|
Install-Module -Name 'DroneHelper' -Repository 'PSGallery' -ErrorAction 'Stop' -AllowPrerelease -Force;
|
||||||
Import-Module -Name 'DroneHelper' -ErrorAction 'Stop';
|
Import-Module -Name 'DroneHelper' -ErrorAction 'Stop';
|
||||||
Install-ModuleDependency;
|
Install-ModuleDependency;
|
||||||
New-BuildPackage -Verbose
|
New-BuildPackage -Verbose -AdditionalPath @('./src/Vendor', './src/openssl.conf')
|
||||||
}"
|
}"
|
||||||
|
|
||||||
- name: GiteaRelease
|
- name: GiteaRelease
|
||||||
|
1
.gitattributes
vendored
1
.gitattributes
vendored
@ -21,4 +21,5 @@
|
|||||||
|
|
||||||
# Vendor resources config
|
# Vendor resources config
|
||||||
src/Vendor/libressl255/* filter=lfs diff=lfs merge=lfs -text
|
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
|
*.pfx filter=lfs diff=lfs merge=lfs -text
|
||||||
|
27
CHANGELOG.md
Normal file
27
CHANGELOG.md
Normal file
@ -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
|
65
README.md
65
README.md
@ -5,7 +5,10 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://gitea.ocram85.com/OCram85/PSCredentialStore/">
|
<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>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -19,7 +22,10 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://drone.ocram85.com/OCram85/PSCredentialStore">
|
<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>
|
</a>
|
||||||
<!-- CodeCove disabled for self hosting git
|
<!-- CodeCove disabled for self hosting git
|
||||||
<a href="https://codecov.io/gh/OCram85/PSCredentialStore">
|
<a href="https://codecov.io/gh/OCram85/PSCredentialStore">
|
||||||
@ -27,23 +33,30 @@
|
|||||||
</a>
|
</a>
|
||||||
-->
|
-->
|
||||||
<a href="https://www.powershellgallery.com/packages/PSCredentialStore">
|
<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>
|
||||||
<a href="https://www.powershellgallery.com/packages/PSCredentialStore">
|
<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>
|
||||||
<a href="https://www.powershellgallery.com/packages/PSCredentialStore">
|
<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>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
## :key: General
|
## :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
|
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.
|
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
|
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.
|
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`.
|
`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
|
## :vulcan_salute: Requirements
|
||||||
|
|
||||||
@ -63,24 +76,26 @@ You can find the [reference](/docs/PSCredentialStore.md) in the /docs/ path as w
|
|||||||
|
|
||||||
## :bomb: About Security
|
## :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
|
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
|
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
|
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.
|
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.
|
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 |
|
| CredentialStore Type | Certificate Location |
|
||||||
| -------------------- | ---------------------- |
|
| -------------------- | ---------------------- |
|
||||||
@ -95,9 +110,9 @@ Here is s brief hierarchy description of the certificate location: *(First match
|
|||||||
### :artificial_satellite: PowerShellGallery.com (Recommended Way)
|
### :artificial_satellite: PowerShellGallery.com (Recommended Way)
|
||||||
|
|
||||||
* Make sure you use PowerShell 5.1 or higher with `$PSVersionTable`.
|
* 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!
|
* Additionally use the `-AllowPrerelease` switch until we publish the final release!
|
||||||
* Done. Start exploring the Module with `Import-Module PSCredentialStore ; Get-Command -Module PSCredentialStore`
|
* Done. Start exploring the Module with `Import-Module PSCredentialStore; Get-Command -Module PSCredentialStore`
|
||||||
|
|
||||||
### :building_construction: Manual Way
|
### :building_construction: Manual Way
|
||||||
|
|
||||||
@ -109,8 +124,9 @@ Here is s brief hierarchy description of the certificate location: *(First match
|
|||||||
|
|
||||||
### :sparkles: Quick Start
|
### :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
|
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
|
PSCredentialStore creates a new pfx certificate file beside the credential store itself. Optionally you can provide
|
||||||
@ -126,11 +142,12 @@ New-CredentialStore -UseCertStore
|
|||||||
# Shared credential store
|
# Shared credential store
|
||||||
New-CredentialStore -Shared
|
New-CredentialStore -Shared
|
||||||
|
|
||||||
#Shared credential store in custom location
|
# Shared credential store in custom location
|
||||||
New-CredentialStore -Shared -Path 'C:\CredentialStore.json'
|
New-CredentialStore -Shared -Path 'C:\CredentialStore.json'
|
||||||
```
|
```
|
||||||
|
|
||||||
**2.** Now you can manage your credential store items:
|
**2.** Now you can manage your credential store items:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
# This will prompt for credentials and stores it in a private store
|
# This will prompt for credentials and stores it in a private store
|
||||||
New-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier 'AD'
|
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.
|
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.
|
* **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)
|
* Required Modules: [`Cisco.UCS.Core`, `Cisco.UCSManager`](https://software.cisco.com/download/release.html?i=!y&mdfid=286305108&softwareid=284574017&release=2.1.1)
|
||||||
|
@ -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"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
@ -66,7 +66,7 @@ function New-CSCertificate {
|
|||||||
($PSVersionTable.PSEdition -eq 'Desktop' -and $PSVersionTable.PSVersion.Major -lt 6) -or
|
($PSVersionTable.PSEdition -eq 'Desktop' -and $PSVersionTable.PSVersion.Major -lt 6) -or
|
||||||
($IsWindows -eq $true)
|
($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'
|
$Env:OPENSSL_CONF = Join-Path $ModuleBase -ChildPath '/openssl.conf'
|
||||||
|
@ -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) {
|
switch ($Type) {
|
||||||
"VMware" {
|
"VMware" {
|
||||||
# Disable the yellow certificate warning, since we haven't replaced the SSL certs for vCenter/ESXi
|
# Disable the yellow certificate warning, since we haven't replaced the SSL certs for vCenter/ESXi
|
||||||
|
@ -102,7 +102,7 @@ Describe "New-CredentialStoreItem" {
|
|||||||
It "Missing CredentialStore should throw" {
|
It "Missing CredentialStore should throw" {
|
||||||
{
|
{
|
||||||
New-CredentialStoreItem -Shared -Path '/tmp/missingStore.json' -RemoteHost 'notrelevant'
|
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" {
|
Context "Testing pipeline paramter" {
|
||||||
|
@ -32,7 +32,7 @@ function New-CredentialStoreItem {
|
|||||||
[None]
|
[None]
|
||||||
|
|
||||||
.EXAMPLE
|
.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')]
|
[CmdletBinding(DefaultParameterSetName = 'Private')]
|
||||||
@ -68,7 +68,7 @@ function New-CredentialStoreItem {
|
|||||||
|
|
||||||
begin {
|
begin {
|
||||||
# Set the CredentialStore for private, shared or custom mode.
|
# 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') {
|
if ($PSCmdlet.ParameterSetName -eq 'Private') {
|
||||||
$Path = Get-DefaultCredentialStorePath
|
$Path = Get-DefaultCredentialStorePath
|
||||||
}
|
}
|
||||||
@ -84,9 +84,9 @@ function New-CredentialStoreItem {
|
|||||||
if (-not(Test-CredentialStore -Shared -Path $Path)) {
|
if (-not(Test-CredentialStore -Shared -Path $Path)) {
|
||||||
$MessageParams = @{
|
$MessageParams = @{
|
||||||
Exception = [System.IO.FileNotFoundException]::new(
|
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
|
Write-Error @MessageParams
|
||||||
}
|
}
|
||||||
@ -95,8 +95,8 @@ function New-CredentialStoreItem {
|
|||||||
|
|
||||||
$CurrentDate = Get-Date -Format 'u'
|
$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 {
|
else {
|
||||||
$CredentialName = $RemoteHost
|
$CredentialName = $RemoteHost
|
||||||
|
@ -143,7 +143,32 @@
|
|||||||
# RequireLicenseAcceptance = $false
|
# RequireLicenseAcceptance = $false
|
||||||
|
|
||||||
# External dependent modules of this module
|
# 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
|
} # End of PSData hashtable
|
||||||
|
|
||||||
|
@ -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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -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 {}
|
|
||||||
}
|
|
BIN
src/Vendor/libressl/openssl.exe
(Stored with Git LFS)
vendored
Normal file
BIN
src/Vendor/libressl/openssl.exe
(Stored with Git LFS)
vendored
Normal file
Binary file not shown.
BIN
src/Vendor/libressl255/libcrypto-41.dll
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libcrypto-41.dll
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libcrypto-41.exp
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libcrypto-41.exp
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libcrypto-41.lib
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libcrypto-41.lib
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libcrypto-41.pdb
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libcrypto-41.pdb
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libssl-43.dll
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libssl-43.dll
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libssl-43.exp
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libssl-43.exp
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libssl-43.lib
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libssl-43.lib
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libssl-43.pdb
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libssl-43.pdb
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libtls-15.dll
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libtls-15.dll
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libtls-15.exp
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libtls-15.exp
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libtls-15.lib
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libtls-15.lib
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/libtls-15.pdb
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/libtls-15.pdb
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/ocspcheck.exe
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/ocspcheck.exe
(Stored with Git LFS)
vendored
Binary file not shown.
BIN
src/Vendor/libressl255/openssl.exe
(Stored with Git LFS)
vendored
BIN
src/Vendor/libressl255/openssl.exe
(Stored with Git LFS)
vendored
Binary file not shown.
Reference in New Issue
Block a user