update docs
This commit is contained in:
parent
cdd5a8d451
commit
ff00144ce1
33
README.md
33
README.md
@ -10,31 +10,25 @@
|
|||||||
General
|
General
|
||||||
=======
|
=======
|
||||||
|
|
||||||
The PSCredentialStore is a simple credential manager for PSCredentials. It stores PSCredentials in a simple json
|
The PSCredentialStore is a simple credential manager for `PSCredential` objects. It stores PSCredentials in a simple json
|
||||||
file. You can choose between a private and shared credential store. The private one exists in your profile and can
|
file. You can choose between a private and shared credential store. The private one exists in your profile and can
|
||||||
ony accessed by your account on the same machine. The shared store enables you to use different credentials for your
|
ony accessed by your account on the same machine. The shared store enables you to use different credentials for your
|
||||||
scripts without exposing them as plain text.
|
scripts without exposing them as plain text.
|
||||||
|
|
||||||
**The shared store isn't 100% secure and I don't recommend using it in production!**
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
|
Starting with version `1.0.0` PSCredential uses Pfx certificates fo encryption. You can use Pfx certification files
|
||||||
|
or certificates stored in the certification store.
|
||||||
|
|
||||||
For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on github or via CLI with
|
For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on github or via CLI with
|
||||||
`Get-Help about_PSCredentialStore`.
|
`Get-Help about_PSCredentialStore`.
|
||||||
|
|
||||||
:exclamation: Upcoming Changes :exclamation:
|
Requirements
|
||||||
================
|
============
|
||||||
|
|
||||||
The will be some breaking changes starting with the `0.5.0.xxx`:
|
- PowerShell >= `5.1`
|
||||||
|
- .NET Framework >= `4.6` or .NET Core >= `1.0`
|
||||||
- **PSCredentialStore will use PFX certificates to encrypt your credentials.**
|
|
||||||
- This replaces the the current encryption methods and you need to recreate or upgrade your pre existing stores.
|
|
||||||
- The changes allows the PSCredentialStore module to support the PowerShell `Core` editions.
|
|
||||||
- Yes this means, you can use the module on any PowerShell 6 supported linux distribution.
|
|
||||||
- It's also possible to create a shared credential store and transfer it onto a another platform like:
|
|
||||||
`Windows -- to --> Linux` and vice versa.
|
|
||||||
- Automatically creates self signed certificate with 2048 bits RSA keys for encryption.
|
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
@ -61,10 +55,18 @@ 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* store. The private
|
||||||
Credential Store can only be accessed with your profile on the machine you created it.
|
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
|
||||||
|
the parameter `-UseCertStore`. This imports the new certificate in the user or machine certification store as well.
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
# Private credential store
|
# Private credential store
|
||||||
New-CredentialStore
|
New-CredentialStore
|
||||||
|
|
||||||
|
# Private credential store with certification store usage
|
||||||
|
New-CredentialStore -UseCertStore
|
||||||
|
|
||||||
# Shared credential rtore
|
# Shared credential rtore
|
||||||
New-CredentialStore -Shared
|
New-CredentialStore -Shared
|
||||||
|
|
||||||
@ -110,6 +112,9 @@ Connect-To -RemoteHost "ftp.myside.local" -Type FTP
|
|||||||
Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
|
Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
|
||||||
Connect-To -RemoteHost "esx01.myside.local" -Type VMware
|
Connect-To -RemoteHost "esx01.myside.local" -Type VMware
|
||||||
Connect-To -RemoteHost "vcr.myside.local" -Type CisServer
|
Connect-To -RemoteHost "vcr.myside.local" -Type CisServer
|
||||||
|
Connect-To -RemoteHost "exchange1.myside.local" -Type ExchangeHTTP
|
||||||
|
Connect-To -RemoteHost "exchange1.myside.local" -Type ExchangeHTTPS
|
||||||
|
Connect-To -RemoteHost "ubuntu.myside.local" -Type SCP
|
||||||
```
|
```
|
||||||
|
|
||||||
Credits
|
Credits
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Connect-To
|
# Connect-To
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -66,15 +59,19 @@ Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -RemoteHost
|
### -Credentials
|
||||||
Specify the host, for which you would like to change the credentials.
|
Use this parameter to bypass the stored credentials.
|
||||||
|
Without this parameter Connect-To tries to read the
|
||||||
|
needed credentials from the CredentialStore.
|
||||||
|
If you provide this parameter you skip this lookup behavior.
|
||||||
|
So you can use it to enable credentials without preparing any user interaction.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: PSCredential
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: True
|
Required: False
|
||||||
Position: Named
|
Position: Named
|
||||||
Default value: None
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
@ -98,10 +95,38 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Type
|
### -PassThru
|
||||||
Specify the host type of the target.
|
Returns the value from the underlying connection type function.
|
||||||
Currently implemented targets are: Possible connection values are:
|
|
||||||
CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
|
```yaml
|
||||||
|
Type: SwitchParameter
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: False
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -Path
|
||||||
|
Define a custom path to a shared CredentialStore.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -RemoteHost
|
||||||
|
Specify the host, for which you would like to change the credentials.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: String
|
||||||
@ -115,25 +140,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Credentials
|
|
||||||
Use this parameter to bypass the stored credentials.
|
|
||||||
Without this parameter Connect-To tries to read the
|
|
||||||
needed credentials from the CredentialStore.
|
|
||||||
If you provide this parameter you skip this lookup behavior.
|
|
||||||
So you can use it to enable credentials without preparing any user interaction.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: PSCredential
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -Shared
|
### -Shared
|
||||||
Switch to shared mode with this param.
|
Switch to shared mode with this param.
|
||||||
This enforces the command to work with a shared CredentialStore which
|
This enforces the command to work with a shared CredentialStore which
|
||||||
@ -151,32 +157,19 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Path
|
### -Type
|
||||||
Define a custom path to a shared CredentialStore.
|
Specify the host type of the target.
|
||||||
|
Currently implemented targets are: Possible connection values are:
|
||||||
|
CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: String
|
||||||
Parameter Sets: Shared
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -PassThru
|
|
||||||
{{ Fill PassThru Description }}
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: False
|
Required: True
|
||||||
Position: Named
|
Position: Named
|
||||||
Default value: False
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Disconnect-From
|
# Disconnect-From
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -63,6 +56,21 @@ Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
|
### -Force
|
||||||
|
Force the disconnect, even if the disconnect would fail.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: SwitchParameter
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: False
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### -RemoteHost
|
### -RemoteHost
|
||||||
Specify the remote endpoint, whose session you would like to terminate.
|
Specify the remote endpoint, whose session you would like to terminate.
|
||||||
|
|
||||||
@ -95,21 +103,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Force
|
|
||||||
Force the disconnect, even if the disconnect would fail.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: False
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Get-CSCertificate
|
# Get-CSCertificate
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -28,21 +21,6 @@ Get-CSCertificate -Type 'Shared' -Thumbprint '12334456'
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -Type
|
|
||||||
Select the current credential store type.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: 1
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -Thumbprint
|
### -Thumbprint
|
||||||
Provide the credentials thumbprint for the search.
|
Provide the credentials thumbprint for the search.
|
||||||
|
|
||||||
@ -58,6 +36,21 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### -Type
|
||||||
|
Select the current credential store type.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: 1
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,95 +0,0 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Get-CSPfxCertificate
|
|
||||||
|
|
||||||
## SYNOPSIS
|
|
||||||
Returns the certificate object given by thumbprint.
|
|
||||||
|
|
||||||
## SYNTAX
|
|
||||||
|
|
||||||
```
|
|
||||||
Get-CSPfxCertificate [-Thumbprint] <String[]> [[-StoreName] <String>] [[-StoreLocation] <String>]
|
|
||||||
[<CommonParameters>]
|
|
||||||
```
|
|
||||||
|
|
||||||
## DESCRIPTION
|
|
||||||
You can use this function to get a stored certificate.
|
|
||||||
Search for the object by its unique thumbprint.
|
|
||||||
|
|
||||||
## EXAMPLES
|
|
||||||
|
|
||||||
### BEISPIEL 1
|
|
||||||
```
|
|
||||||
Get-CSPfxCertificate -Thumbprint '12345678' -StoreName 'My' -StoreLocation 'CurrentUser'
|
|
||||||
```
|
|
||||||
|
|
||||||
## PARAMETERS
|
|
||||||
|
|
||||||
### -Thumbprint
|
|
||||||
Provide one or more thumbprints.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String[]
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: 1
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: True (ByValue)
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -StoreName
|
|
||||||
Select the store name in which you want to search the certificates.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 2
|
|
||||||
Default value: My
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -StoreLocation
|
|
||||||
Select between the both available locations CurrentUser odr LocalMachine.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 3
|
|
||||||
Default value: CurrentUser
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
||||||
|
|
||||||
## INPUTS
|
|
||||||
|
|
||||||
### [string]
|
|
||||||
## OUTPUTS
|
|
||||||
|
|
||||||
### [System.Security.Cryptography.X509Certificates.X509Certificate2[]]
|
|
||||||
## NOTES
|
|
||||||
- File Name : Get-CSPfxCertificate.ps1
|
|
||||||
- Author : Marco Blessing - marco.blessing@googlemail.com
|
|
||||||
- Requires :
|
|
||||||
|
|
||||||
## RELATED LINKS
|
|
||||||
|
|
||||||
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
|
|
||||||
|
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Get-CredentialStore
|
# Get-CredentialStore
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Get-CredentialStoreItem
|
# Get-CredentialStoreItem
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -35,21 +28,6 @@ $myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx0
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -RemoteHost
|
|
||||||
Specify the host, for which you would like to change the credentials.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -Identifier
|
### -Identifier
|
||||||
Provide a custom identifier to the given remote host key.
|
Provide a custom identifier to the given remote host key.
|
||||||
This enables you to store multiple credentials
|
This enables you to store multiple credentials
|
||||||
@ -68,6 +46,36 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### -Path
|
||||||
|
Define a custom path to a shared CredentialStore.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -RemoteHost
|
||||||
|
Specify the host, for which you would like to change the credentials.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### -Shared
|
### -Shared
|
||||||
Switch to shared mode with this param.
|
Switch to shared mode with this param.
|
||||||
This enforces the command to work with a shared CredentialStore which
|
This enforces the command to work with a shared CredentialStore which
|
||||||
@ -85,21 +93,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Path
|
|
||||||
Define a custom path to a shared CredentialStore.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: Shared
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Import-CSCertificate
|
# Import-CSCertificate
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -29,21 +22,6 @@ private and shared credential stores.
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -Type
|
|
||||||
Select between the a private and shared credential store.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: 1
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -Path
|
### -Path
|
||||||
Provide a valid path to pfx certificate file.
|
Provide a valid path to pfx certificate file.
|
||||||
|
|
||||||
@ -59,6 +37,21 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### -Type
|
||||||
|
Select between the a private and shared credential store.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: 1
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,113 +0,0 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Import-CSPfxCertificate
|
|
||||||
|
|
||||||
## SYNOPSIS
|
|
||||||
Adds a given pfx certificate file to current user's personal certificate store.
|
|
||||||
|
|
||||||
## SYNTAX
|
|
||||||
|
|
||||||
```
|
|
||||||
Import-CSPfxCertificate [-Path] <String> [[-StoreName] <String>] [[-StoreLocation] <String>]
|
|
||||||
[[-OpenFlags] <String>] [<CommonParameters>]
|
|
||||||
```
|
|
||||||
|
|
||||||
## DESCRIPTION
|
|
||||||
This function is used to import existing pfx certificate files.
|
|
||||||
The Import-PFXCertificate cmdlet from the
|
|
||||||
PKI module imports the certificate into a deprecated store.
|
|
||||||
Thus you can't read the private key afterwards or
|
|
||||||
using it for decrypting data.
|
|
||||||
|
|
||||||
## EXAMPLES
|
|
||||||
|
|
||||||
### BEISPIEL 1
|
|
||||||
```
|
|
||||||
Import-CSPfxCertificate -Path (Join-Path -Path $Env:APPDATA -ChildPath '/PSCredentialStore.pfx')
|
|
||||||
```
|
|
||||||
|
|
||||||
## PARAMETERS
|
|
||||||
|
|
||||||
### -Path
|
|
||||||
Path to an existing *.pfx certificate file.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: 1
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -StoreName
|
|
||||||
Additionally you change change the store where you want the certificate into.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 2
|
|
||||||
Default value: My
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -StoreLocation
|
|
||||||
{{ Fill StoreLocation Description }}
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 3
|
|
||||||
Default value: CurrentUser
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -OpenFlags
|
|
||||||
{{ Fill OpenFlags Description }}
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 4
|
|
||||||
Default value: ReadWrite
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
||||||
|
|
||||||
## INPUTS
|
|
||||||
|
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
|
||||||
|
|
||||||
### [None]
|
|
||||||
## NOTES
|
|
||||||
File Name : Import-CSPfxCertificate.ps1
|
|
||||||
Author : Marco Blessing - marco.blessing@googlemail.com
|
|
||||||
Requires :
|
|
||||||
|
|
||||||
## RELATED LINKS
|
|
||||||
|
|
||||||
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
|
|
||||||
|
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# New-CSCertAttribute
|
# New-CSCertAttribute
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -29,6 +22,36 @@ New-CSCertAttribute -Country 'DE' -State 'BW' -City 'Karlsruhe' -Organization 'A
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
|
### -City
|
||||||
|
Certificate city value.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: 3
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -CommonName
|
||||||
|
The certificate common name.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: 6
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### -Country
|
### -Country
|
||||||
County code like EN, DE, IT, FR...
|
County code like EN, DE, IT, FR...
|
||||||
|
|
||||||
@ -44,32 +67,17 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -State
|
### -Days
|
||||||
Certificate state value.
|
{{ Fill Days Description }}
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: Int32
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: True
|
Required: False
|
||||||
Position: 2
|
Position: 7
|
||||||
Default value: None
|
Default value: 365
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -City
|
|
||||||
Certificate city value.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: 3
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
@ -104,8 +112,8 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -CommonName
|
### -State
|
||||||
The certificate common name.
|
Certificate state value.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: String
|
||||||
@ -113,27 +121,12 @@ Parameter Sets: (All)
|
|||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: True
|
Required: True
|
||||||
Position: 6
|
Position: 2
|
||||||
Default value: None
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Days
|
|
||||||
{{ Fill Days Description }}
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: Int32
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 7
|
|
||||||
Default value: 365
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# New-CSCertificate
|
# New-CSCertificate
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -29,6 +22,22 @@ New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertNa
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
|
### -CertName
|
||||||
|
Provide a custom full path and name for the PFX certificate file.
|
||||||
|
The file extension has to be \`*.pfx\`
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: 3
|
||||||
|
Default value: ./certificate.pfx
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### -CRTAttribute
|
### -CRTAttribute
|
||||||
Provide certificate related attributes provided by function New-CRTAttribute.
|
Provide certificate related attributes provided by function New-CRTAttribute.
|
||||||
|
|
||||||
@ -60,18 +69,17 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -CertName
|
### -Confirm
|
||||||
Provide a custom full path and name for the PFX certificate file.
|
Prompts you for confirmation before running the cmdlet.
|
||||||
The file extension has to be \`*.pfx\`
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: SwitchParameter
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases: cf
|
||||||
|
|
||||||
Required: False
|
Required: False
|
||||||
Position: 3
|
Position: Named
|
||||||
Default value: ./certificate.pfx
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
@ -92,21 +100,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Confirm
|
|
||||||
Prompts you for confirmation before running the cmdlet.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases: cf
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,94 +1,181 @@
|
|||||||
---
|
# New-CredentialStore
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Import-CSPfxCertificate
|
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
Adds a given pfx certificate file to current user's personal certificate store.
|
Creates a new credential store File
|
||||||
|
|
||||||
## SYNTAX
|
## SYNTAX
|
||||||
|
|
||||||
|
### Private (Default)
|
||||||
```
|
```
|
||||||
Import-CSPfxCertificate [-Path] <String> [[-StoreName] <String>] [[-StoreLocation] <String>]
|
New-CredentialStore [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore] [-WhatIf] [-Confirm]
|
||||||
[[-OpenFlags] <String>] [<CommonParameters>]
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Shared
|
||||||
|
```
|
||||||
|
New-CredentialStore [-Shared] [-Path <FileInfo>] [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore]
|
||||||
|
[-WhatIf] [-Confirm] [<CommonParameters>]
|
||||||
```
|
```
|
||||||
|
|
||||||
## DESCRIPTION
|
## DESCRIPTION
|
||||||
This function is used to import existing pfx certificate files.
|
You need to run this script first to create a new credential store before you try to
|
||||||
The Import-PFXCertificate cmdlet from the
|
save new credentials with New-CredentialStoreItem.
|
||||||
PKI module imports the certificate into a deprecated store.
|
|
||||||
Thus you can't read the private key afterwards or
|
|
||||||
using it for decrypting data.
|
|
||||||
|
|
||||||
## EXAMPLES
|
## EXAMPLES
|
||||||
|
|
||||||
### BEISPIEL 1
|
### BEISPIEL 1
|
||||||
```
|
```
|
||||||
Import-CSPfxCertificate -Path (Join-Path -Path $Env:APPDATA -ChildPath '/PSCredentialStore.pfx')
|
New-CredentialStore
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# Creates a new private CredentialStore
|
||||||
|
|
||||||
|
### BEISPIEL 2
|
||||||
|
```
|
||||||
|
New-CredentialStore -Force
|
||||||
|
```
|
||||||
|
|
||||||
|
# Resets an existing private CredentialStore
|
||||||
|
|
||||||
|
### BEISPIEL 3
|
||||||
|
```
|
||||||
|
New-CredentialStore -Shared
|
||||||
|
```
|
||||||
|
|
||||||
|
# Creates a new shared CredentialStore
|
||||||
|
|
||||||
|
### BEISPIEL 4
|
||||||
|
```
|
||||||
|
New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json"
|
||||||
|
```
|
||||||
|
|
||||||
|
# Creates a new shared CredentialStore in the given location.
|
||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -Path
|
### -Force
|
||||||
Path to an existing *.pfx certificate file.
|
Use this switch to reset an existing store.
|
||||||
|
The complete content will be wiped.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: SwitchParameter
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: True
|
Required: False
|
||||||
Position: 1
|
Position: Named
|
||||||
|
Default value: False
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -PassThru
|
||||||
|
{{ Fill PassThru Description }}
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: SwitchParameter
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: False
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -Path
|
||||||
|
Define a location for the new shared CredentialStore.
|
||||||
|
The default store will be created in
|
||||||
|
$Env:ProgramData\PSCredentialStore dir.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: FileInfo
|
||||||
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
Default value: None
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -StoreName
|
### -Shared
|
||||||
Additionally you change change the store where you want the certificate into.
|
Creates a CredentialStore in the Shared mode.
|
||||||
|
This enables you to read the CredentialStore Items on
|
||||||
|
different systems or profiles.
|
||||||
|
In addition you can optionally provide a custom path wit the -Path parameter.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: SwitchParameter
|
||||||
Parameter Sets: (All)
|
Parameter Sets: Shared
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: False
|
Required: True
|
||||||
Position: 2
|
Position: Named
|
||||||
Default value: My
|
Default value: False
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -StoreLocation
|
### -SkipPFXCertCreation
|
||||||
{{ Fill StoreLocation Description }}
|
{{ Fill SkipPFXCertCreation Description }}
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: SwitchParameter
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: False
|
Required: False
|
||||||
Position: 3
|
Position: Named
|
||||||
Default value: CurrentUser
|
Default value: False
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -OpenFlags
|
### -UseCertStore
|
||||||
{{ Fill OpenFlags Description }}
|
{{ Fill UseCertStore Description }}
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: SwitchParameter
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: False
|
Required: False
|
||||||
Position: 4
|
Position: Named
|
||||||
Default value: ReadWrite
|
Default value: False
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -Confirm
|
||||||
|
Prompts you for confirmation before running the cmdlet.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: SwitchParameter
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases: cf
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -WhatIf
|
||||||
|
Shows what would happen if the cmdlet runs.
|
||||||
|
The cmdlet is not run.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: SwitchParameter
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases: wi
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
@ -101,11 +188,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||||||
### [None]
|
### [None]
|
||||||
## OUTPUTS
|
## OUTPUTS
|
||||||
|
|
||||||
### [None]
|
### ['PSCredentialStore.Store'] Returns the recently created CredentialStore object if the -PassThru parameter
|
||||||
|
### was given.
|
||||||
## NOTES
|
## NOTES
|
||||||
File Name : Import-CSPfxCertificate.ps1
|
- File Name : New-CredentialStore.ps1
|
||||||
Author : Marco Blessing - marco.blessing@googlemail.com
|
- Author : Marco Blessing - marco.blessing@googlemail.com
|
||||||
Requires :
|
- Requires :
|
||||||
|
|
||||||
## RELATED LINKS
|
## RELATED LINKS
|
||||||
|
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# New-CredentialStoreItem
|
# New-CredentialStoreItem
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -40,18 +33,18 @@ New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.lo
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -RemoteHost
|
### -Credential
|
||||||
The identifier or rather name for the given credentials.
|
You can provide credentials optionally as pre existing pscredential object.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: PSCredential
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: True
|
Required: False
|
||||||
Position: Named
|
Position: Named
|
||||||
Default value: None
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: True (ByValue)
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -73,18 +66,33 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Credential
|
### -Path
|
||||||
You can provide credentials optionally as pre existing pscredential object.
|
Define the store in which you would like to add a new item.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: PSCredential
|
Type: String
|
||||||
Parameter Sets: (All)
|
Parameter Sets: Shared
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: False
|
Required: False
|
||||||
Position: Named
|
Position: Named
|
||||||
Default value: None
|
Default value: None
|
||||||
Accept pipeline input: True (ByValue)
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -RemoteHost
|
||||||
|
The identifier or rather name for the given credentials.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -103,21 +111,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Path
|
|
||||||
Define the store in which you would like to add a new item.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: Shared
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,11 +1,3 @@
|
|||||||
---
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
Module Guid: 6800e192-9df8-4e30-b253-eb2c799bbe84 6800e192-9df8-4e30-b253-eb2c799bbe84
|
|
||||||
Download Help Link: {{ Update Download Link }}
|
|
||||||
Help Version: {{ Please enter version of help manually (X.X.X.X) format }}
|
|
||||||
Locale: en-US
|
|
||||||
---
|
|
||||||
|
|
||||||
# PSCredentialStore Module
|
# PSCredentialStore Module
|
||||||
## Description
|
## Description
|
||||||
[about_PSCredentialStore](about_PSCredentialStore.md)
|
[about_PSCredentialStore](about_PSCredentialStore.md)
|
||||||
@ -26,17 +18,11 @@ Returns the Credential from a given remote host item.
|
|||||||
### [Get-CSCertificate](Get-CSCertificate.md)
|
### [Get-CSCertificate](Get-CSCertificate.md)
|
||||||
Returns the current used valid PfX certificate.
|
Returns the current used valid PfX certificate.
|
||||||
|
|
||||||
### [Get-CSPfxCertificate](Get-CSPfxCertificate.md)
|
|
||||||
Returns the certificate object given by thumbprint.
|
|
||||||
|
|
||||||
### [Import-CSCertificate](Import-CSCertificate.md)
|
### [Import-CSCertificate](Import-CSCertificate.md)
|
||||||
Imports a linked certificate to the valid store location.
|
Imports a linked certificate to the valid store location.
|
||||||
|
|
||||||
### [Import-CSPfxCertificate](Import-CSPfxCertificate.md)
|
### [Import-CSCertificate](Import-CSCertificate.md)
|
||||||
Adds a given pfx certificate file to current user's personal certificate store.
|
Imports a linked certificate to the valid store location.
|
||||||
|
|
||||||
### [Import-CSPfxCertificate](Import-CSPfxCertificate.md)
|
|
||||||
Adds a given pfx certificate file to current user's personal certificate store.
|
|
||||||
|
|
||||||
### [New-CredentialStoreItem](New-CredentialStoreItem.md)
|
### [New-CredentialStoreItem](New-CredentialStoreItem.md)
|
||||||
Adds a credential store item containing host, user and password to the given store.
|
Adds a credential store item containing host, user and password to the given store.
|
||||||
@ -65,9 +51,6 @@ Tests if the linked certificate is store ein the specified cert stores.
|
|||||||
### [Test-CSConnection](Test-CSConnection.md)
|
### [Test-CSConnection](Test-CSConnection.md)
|
||||||
Returns the connection state of a given type to the remote host.
|
Returns the connection state of a given type to the remote host.
|
||||||
|
|
||||||
### [Test-CSPfxCertificate](Test-CSPfxCertificate.md)
|
|
||||||
Tests if the given certificate exists in a store.
|
|
||||||
|
|
||||||
### [Use-CSCertificate](Use-CSCertificate.md)
|
### [Use-CSCertificate](Use-CSCertificate.md)
|
||||||
Links an existing PFX Certificate to a CredentialStore.
|
Links an existing PFX Certificate to a CredentialStore.
|
||||||
|
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Remove-CredentialStoreItem
|
# Remove-CredentialStoreItem
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -50,21 +43,6 @@ Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -RemoteHost
|
|
||||||
Specify the host you for which you would like to change the credentials.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -Identifier
|
### -Identifier
|
||||||
Defaults to "".
|
Defaults to "".
|
||||||
Specify a string, which separates two CredentialStoreItems for the
|
Specify a string, which separates two CredentialStoreItems for the
|
||||||
@ -82,6 +60,36 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### -Path
|
||||||
|
Define the store in which your given host entry already exists.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -RemoteHost
|
||||||
|
Specify the host you for which you would like to change the credentials.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### -Shared
|
### -Shared
|
||||||
Switch to shared mode with this param.
|
Switch to shared mode with this param.
|
||||||
This enforces the command to work with a shared CredentialStore which
|
This enforces the command to work with a shared CredentialStore which
|
||||||
@ -99,21 +107,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Path
|
|
||||||
Define the store in which your given host entry already exists.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: Shared
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Set-CredentialStoreItem
|
# Set-CredentialStoreItem
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -38,18 +31,18 @@ Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.lo
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -RemoteHost
|
### -Credential
|
||||||
Specify the host you for which you would like to change the credentials.
|
{{ Fill Credential Description }}
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: String
|
Type: PSCredential
|
||||||
Parameter Sets: (All)
|
Parameter Sets: (All)
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: True
|
Required: False
|
||||||
Position: Named
|
Position: Named
|
||||||
Default value: None
|
Default value: None
|
||||||
Accept pipeline input: False
|
Accept pipeline input: True (ByValue)
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -70,18 +63,33 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Credential
|
### -Path
|
||||||
{{ Fill Credential Description }}
|
Define the store in which your given host entry already exists.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
Type: PSCredential
|
Type: String
|
||||||
Parameter Sets: (All)
|
Parameter Sets: Shared
|
||||||
Aliases:
|
Aliases:
|
||||||
|
|
||||||
Required: False
|
Required: False
|
||||||
Position: Named
|
Position: Named
|
||||||
Default value: None
|
Default value: None
|
||||||
Accept pipeline input: True (ByValue)
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
|
### -RemoteHost
|
||||||
|
Specify the host you for which you would like to change the credentials.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -102,21 +110,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Path
|
|
||||||
Define the store in which your given host entry already exists.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: Shared
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
### CommonParameters
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||||
|
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Test-CSCertificate
|
# Test-CSCertificate
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Test-CSConnection
|
# Test-CSConnection
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
|
@ -1,94 +0,0 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Test-CSPfxCertificate
|
|
||||||
|
|
||||||
## SYNOPSIS
|
|
||||||
Tests if the given certificate exists in a store.
|
|
||||||
|
|
||||||
## SYNTAX
|
|
||||||
|
|
||||||
```
|
|
||||||
Test-CSPfxCertificate [-Thumbprint] <String> [[-StoreName] <String>] [[-StoreLocation] <String>]
|
|
||||||
[<CommonParameters>]
|
|
||||||
```
|
|
||||||
|
|
||||||
## DESCRIPTION
|
|
||||||
Use this function to ensure if a certificate is already imported into a given store.
|
|
||||||
|
|
||||||
## EXAMPLES
|
|
||||||
|
|
||||||
### BEISPIEL 1
|
|
||||||
```
|
|
||||||
Test-CSPfxCertificate -Thumbprint '12345678' -StoreName 'My' -StoreLocation 'CurrentUser'
|
|
||||||
```
|
|
||||||
|
|
||||||
## PARAMETERS
|
|
||||||
|
|
||||||
### -Thumbprint
|
|
||||||
Provide one or more thumbprints.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: 1
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: True (ByValue)
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -StoreName
|
|
||||||
Select the store name in which you want to search the certificates.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 2
|
|
||||||
Default value: My
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -StoreLocation
|
|
||||||
Select between the both available locations CurrentUser odr LocalMachine.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: 3
|
|
||||||
Default value: CurrentUser
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### CommonParameters
|
|
||||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
||||||
|
|
||||||
## INPUTS
|
|
||||||
|
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
|
||||||
|
|
||||||
### [bool]
|
|
||||||
## NOTES
|
|
||||||
File Name : Test-CSPfxCertificate.ps1
|
|
||||||
Author : Marco Blessing - marco.blessing@googlemail.com
|
|
||||||
Requires :
|
|
||||||
|
|
||||||
## RELATED LINKS
|
|
||||||
|
|
||||||
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
|
|
||||||
|
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Test-CredentialStore
|
# Test-CredentialStore
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Test-CredentialStoreItem
|
# Test-CredentialStoreItem
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -43,6 +36,23 @@ Else {
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
|
### -Identifier
|
||||||
|
Adds an optional identifier to the given RemoteHost.
|
||||||
|
Makes it possible to store multiple credentials
|
||||||
|
for a single host.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: False
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### -Path
|
### -Path
|
||||||
Define a custom credential store you try to read from.
|
Define a custom credential store you try to read from.
|
||||||
Without the \`-Path\` parameter
|
Without the \`-Path\` parameter
|
||||||
@ -75,23 +85,6 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
### -Identifier
|
|
||||||
Adds an optional identifier to the given RemoteHost.
|
|
||||||
Makes it possible to store multiple credentials
|
|
||||||
for a single host.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: False
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -Shared
|
### -Shared
|
||||||
Switch to shared mode with this param.
|
Switch to shared mode with this param.
|
||||||
This enforces the command to work with a shared CredentialStore which
|
This enforces the command to work with a shared CredentialStore which
|
||||||
|
@ -1,10 +1,3 @@
|
|||||||
---
|
|
||||||
external help file: PSCredentialStore-help.xml
|
|
||||||
Module Name: PSCredentialStore
|
|
||||||
online version: https://github.com/OCram85/PSCredentialStore
|
|
||||||
schema: 2.0.0
|
|
||||||
---
|
|
||||||
|
|
||||||
# Use-CSCertificate
|
# Use-CSCertificate
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
@ -34,21 +27,6 @@ Use-CSCertificate -Path 'C:\cert.pfx'
|
|||||||
|
|
||||||
## PARAMETERS
|
## PARAMETERS
|
||||||
|
|
||||||
### -Path
|
|
||||||
Specify the path to the PFX Certificate you want to link for usage.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
|
||||||
|
|
||||||
Required: True
|
|
||||||
Position: Named
|
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
|
||||||
```
|
|
||||||
|
|
||||||
### -CredentialStore
|
### -CredentialStore
|
||||||
Specify a custom path for a shared credential store.
|
Specify a custom path for a shared credential store.
|
||||||
|
|
||||||
@ -64,6 +42,21 @@ Accept pipeline input: False
|
|||||||
Accept wildcard characters: False
|
Accept wildcard characters: False
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### -Path
|
||||||
|
Specify the path to the PFX Certificate you want to link for usage.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
|
|
||||||
|
Required: True
|
||||||
|
Position: Named
|
||||||
|
Default value: None
|
||||||
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
|
|
||||||
### -Shared
|
### -Shared
|
||||||
Use the credential store in shared mode.
|
Use the credential store in shared mode.
|
||||||
|
|
||||||
|
@ -7,24 +7,30 @@ PSCredentialStore enables managing multiple PSCredential objects.
|
|||||||
|
|
||||||
|
|
||||||
# LONG DESCRIPTION
|
# LONG DESCRIPTION
|
||||||
The PSCredentialStore is an simple credential manager for PSCredentials. It stores multiple credential objects in a
|
The PSCredentialStore is a simple credential manager for `PSCredential` objects. It stores PSCredentials in a simple json
|
||||||
simple json file. You can choose between a private and shared store. The private one exists in your profile and can
|
file. You can choose between a private and shared credential store. The private one exists in your profile and can
|
||||||
ony accessed by your account on the same machine. The shared store enables you to use different credentials for your
|
ony accessed by your account on the same machine. The shared store enables you to use different credentials for your
|
||||||
script without exposing them as plain text.
|
scripts without exposing them as plain text.
|
||||||
|
|
||||||
**The shared store isn't 100% secure and I don't recommend using it in production!**
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
To get started read the [about_PSCredentialStore](/src/en-US/about_PSCredential.help.txt) page.
|
Starting with version `1.0.0` PSCredential uses Pfx certificates fo encryption. You can use Pfx certification files
|
||||||
|
or certificates stored in the certification store.
|
||||||
|
|
||||||
|
For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on github or via CLI with
|
||||||
|
`Get-Help about_PSCredentialStore`.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- PowerShell >= `5.1`
|
||||||
|
- .NET Framework >= `4.6` or .NET Core >= `1.0`
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
## PowerShellGallery.com (Recommended Way)
|
## PowerShellGallery.com (Recommended Way)
|
||||||
|
|
||||||
* Make sure you use PowerShell 4.0 or higher with `$PSVersionTable`.
|
* Make sure you use PowerShell 5.1 or higher with `$PSVersionTable`.
|
||||||
* Use the builtin PackageManagement and install with: `Install-Module PSCredentialStore`
|
* Use the builtin PackageManagement and install with: `Install-Module PSCredentialStore`
|
||||||
* 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`
|
||||||
|
|
||||||
@ -36,19 +42,28 @@ To get started read the [about_PSCredentialStore](/src/en-US/about_PSCredential.
|
|||||||
* Don't forget to change the NTFS permission flag in the context menu.
|
* Don't forget to change the NTFS permission flag in the context menu.
|
||||||
* Start with `Import-Module PSCredentialStore`
|
* Start with `Import-Module PSCredentialStore`
|
||||||
|
|
||||||
**1.** First we need a blank CredentialStore. 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* store. The private
|
||||||
Credential Store can only be accessed with your profile on the machine you created it.
|
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
|
||||||
|
the parameter `-UseCertStore`. This imports the new certificate in the user or machine certification store as well.
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
# Private Credential Store
|
# Private credential store
|
||||||
New-CredentialStore
|
New-CredentialStore
|
||||||
|
|
||||||
# Shared Credential Store
|
# Private credential store with certification store usage
|
||||||
|
New-CredentialStore -UseCertStore
|
||||||
|
|
||||||
|
# Shared credential rtore
|
||||||
New-CredentialStore -Shared
|
New-CredentialStore -Shared
|
||||||
|
|
||||||
#Shared CredentialStore 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 CredentialStoreItems:
|
**2.** Now you can manage your CredentialStoreItems:
|
||||||
```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
|
||||||
|
@ -14,13 +14,13 @@ function Import-CSCertificate {
|
|||||||
Provide a valid path to pfx certificate file.
|
Provide a valid path to pfx certificate file.
|
||||||
|
|
||||||
.INPUTS
|
.INPUTS
|
||||||
Describe the script input parameters (if any), otherwise it may also list the word "[None]".
|
[None]
|
||||||
|
|
||||||
.OUTPUTS
|
.OUTPUTS
|
||||||
Describe the script output parameters (if any), otherwise it may also list the word "[None]".
|
[None]
|
||||||
|
|
||||||
.EXAMPLE
|
.EXAMPLE
|
||||||
.\Remove-Some-Script.ps1 -One content
|
Import-CSCertificate -Type 'Private' -Path (Join-Path -Path $Env:APPDATA -ChildItem 'PfxCertificate.pfx')
|
||||||
|
|
||||||
.NOTES
|
.NOTES
|
||||||
- File Name : Import-CSCertificate.ps1
|
- File Name : Import-CSCertificate.ps1
|
||||||
|
@ -24,15 +24,14 @@ function New-CSCertAttribute {
|
|||||||
.PARAMETER CommonName
|
.PARAMETER CommonName
|
||||||
The certificate common name.
|
The certificate common name.
|
||||||
|
|
||||||
.PARAMETER CSRSubject
|
.PARAMETER Days
|
||||||
you can provide the needed certificate properties with in one hashtable. This hashtable has to contain the
|
The validation time itself.
|
||||||
following keys: 'Country', 'State', 'City', 'Organization', 'OrganizationalUnitName', 'CommonName'.
|
|
||||||
|
|
||||||
.INPUTS
|
.INPUTS
|
||||||
[None]
|
[None]
|
||||||
|
|
||||||
.OUTPUTS
|
.OUTPUTS
|
||||||
['PSCredentialStore.Certificate.CSRDetails']
|
[PSCredentialStore.Certificate.CSRDetails]
|
||||||
|
|
||||||
.EXAMPLE
|
.EXAMPLE
|
||||||
New-CSCertAttribute -Country 'DE' -State 'BW' -City 'Karlsruhe' -Organization 'AwesomeIT' -OrganizationalUnitName '' -CommonName 'MyPrivateCert'
|
New-CSCertAttribute -Country 'DE' -State 'BW' -City 'Karlsruhe' -Organization 'AwesomeIT' -OrganizationalUnitName '' -CommonName 'MyPrivateCert'
|
||||||
|
@ -15,7 +15,7 @@ function Use-CSCertificate {
|
|||||||
.PARAMETER Shared
|
.PARAMETER Shared
|
||||||
Use the credential store in shared mode.
|
Use the credential store in shared mode.
|
||||||
|
|
||||||
.PARAMETER UserCertStore
|
.PARAMETER UseCertStore
|
||||||
Use the given certificate and import it into the corresponding certificate store.
|
Use the given certificate and import it into the corresponding certificate store.
|
||||||
|
|
||||||
.INPUTS
|
.INPUTS
|
||||||
|
@ -29,6 +29,9 @@ function Connect-To {
|
|||||||
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
|
||||||
can be decrypted across systems.
|
can be decrypted across systems.
|
||||||
|
|
||||||
|
.PARAMETER PassThru
|
||||||
|
Returns the value from the underlying connection type function.
|
||||||
|
|
||||||
.INPUTS
|
.INPUTS
|
||||||
[None]
|
[None]
|
||||||
|
|
||||||
|
@ -21,6 +21,10 @@ function New-CredentialStoreItem {
|
|||||||
.PARAMETER Credential
|
.PARAMETER Credential
|
||||||
You can provide credentials optionally as pre existing pscredential object.
|
You can provide credentials optionally as pre existing pscredential object.
|
||||||
|
|
||||||
|
.PARAMETER Shared
|
||||||
|
Define the CredentialStore where you want to add the new item. Default is always personal but can be
|
||||||
|
changed to shared, or even shared with custom path.
|
||||||
|
|
||||||
.INPUTS
|
.INPUTS
|
||||||
[None]
|
[None]
|
||||||
|
|
||||||
|
@ -4,6 +4,7 @@ function Set-CredentialStoreItem {
|
|||||||
Changes the credentials for the given remote host in the store.
|
Changes the credentials for the given remote host in the store.
|
||||||
|
|
||||||
.DESCRIPTION
|
.DESCRIPTION
|
||||||
|
Use this function to update your already stored RemoteHost items.
|
||||||
|
|
||||||
.PARAMETER Path
|
.PARAMETER Path
|
||||||
Define the store in which your given host entry already exists.
|
Define the store in which your given host entry already exists.
|
||||||
@ -19,6 +20,9 @@ function Set-CredentialStoreItem {
|
|||||||
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
|
||||||
can be decrypted across systems.
|
can be decrypted across systems.
|
||||||
|
|
||||||
|
.PARAMETER Credential
|
||||||
|
Provided the new credentials you want to update inside the RemoteHost item.
|
||||||
|
|
||||||
.INPUTS
|
.INPUTS
|
||||||
[None]
|
[None]
|
||||||
|
|
||||||
@ -27,6 +31,8 @@ function Set-CredentialStoreItem {
|
|||||||
|
|
||||||
.EXAMPLE
|
.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
|
||||||
|
|
||||||
.NOTES
|
.NOTES
|
||||||
|
@ -18,6 +18,15 @@ function New-CredentialStore {
|
|||||||
.PARAMETER Force
|
.PARAMETER Force
|
||||||
Use this switch to reset an existing store. The complete content will be wiped.
|
Use this switch to reset an existing store. The complete content will be wiped.
|
||||||
|
|
||||||
|
.PARAMETER SkipPFXCertCreation
|
||||||
|
You can skip the pfx certification process. This makes sense if you have a previously created cert or want to
|
||||||
|
import a cert in cross-platform environments.
|
||||||
|
|
||||||
|
.Parameter UseCertStore
|
||||||
|
Instead of using a plain pfx file beside your CredentialStore file you can import it into the user or machine
|
||||||
|
certification store. In this case the system itself secures the cert and you don't hat to set custom NTFS
|
||||||
|
permissions so secure your shared certificate.
|
||||||
|
|
||||||
.INPUTS
|
.INPUTS
|
||||||
[None]
|
[None]
|
||||||
|
|
||||||
|
@ -14,6 +14,9 @@ function Test-CredentialStore {
|
|||||||
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
|
||||||
can be decrypted across systems.
|
can be decrypted across systems.
|
||||||
|
|
||||||
|
.EXAMPLE
|
||||||
|
Test-CredentialStore -eq $true
|
||||||
|
|
||||||
.NOTES
|
.NOTES
|
||||||
- File Name : Test-CredentialStore.ps1
|
- File Name : Test-CredentialStore.ps1
|
||||||
- Author : Marco Blessing - marco.blessing@googlemail.com
|
- Author : Marco Blessing - marco.blessing@googlemail.com
|
||||||
|
Loading…
Reference in New Issue
Block a user