From ac7a5e0db3da1b844c5df19fe75d1b6613d5e7af Mon Sep 17 00:00:00 2001 From: OCram85 Date: Mon, 8 Apr 2019 13:12:15 +0200 Subject: [PATCH] update docs --- docs/Connect-To.md | 201 +++++++++++++++++++++++++++++ docs/Disconnect-From.md | 130 +++++++++++++++++++ docs/Get-CSCertificate.md | 78 +++++++++++ docs/Get-CSPfxCertificate.md | 95 ++++++++++++++ docs/Get-CredentialStore.md | 90 +++++++++++++ docs/Get-CredentialStoreItem.md | 120 +++++++++++++++++ docs/Import-CSCertificate.md | 79 ++++++++++++ docs/Import-CSPfxCertificate.md | 113 ++++++++++++++++ docs/New-CSCertAttribute.md | 154 ++++++++++++++++++++++ docs/New-CSCertificate.md | 127 ++++++++++++++++++ docs/New-CredentialStore.md | 113 ++++++++++++++++ docs/New-CredentialStoreItem.md | 138 ++++++++++++++++++++ docs/PSCredentialStore.md | 73 +++++++++++ docs/Remove-CredentialStoreItem.md | 134 +++++++++++++++++++ docs/Set-CredentialStoreItem.md | 137 ++++++++++++++++++++ docs/Test-CSCertificate.md | 63 +++++++++ docs/Test-CSConnection.md | 80 ++++++++++++ docs/Test-CSPfxCertificate.md | 94 ++++++++++++++ docs/Test-CredentialStore.md | 88 +++++++++++++ docs/Test-CredentialStoreItem.md | 129 ++++++++++++++++++ docs/Use-CSCertificate.md | 114 ++++++++++++++++ docs/about_PSCredentialStore.md | 102 +++++++++++++++ 22 files changed, 2452 insertions(+) create mode 100644 docs/Connect-To.md create mode 100644 docs/Disconnect-From.md create mode 100644 docs/Get-CSCertificate.md create mode 100644 docs/Get-CSPfxCertificate.md create mode 100644 docs/Get-CredentialStore.md create mode 100644 docs/Get-CredentialStoreItem.md create mode 100644 docs/Import-CSCertificate.md create mode 100644 docs/Import-CSPfxCertificate.md create mode 100644 docs/New-CSCertAttribute.md create mode 100644 docs/New-CSCertificate.md create mode 100644 docs/New-CredentialStore.md create mode 100644 docs/New-CredentialStoreItem.md create mode 100644 docs/PSCredentialStore.md create mode 100644 docs/Remove-CredentialStoreItem.md create mode 100644 docs/Set-CredentialStoreItem.md create mode 100644 docs/Test-CSCertificate.md create mode 100644 docs/Test-CSConnection.md create mode 100644 docs/Test-CSPfxCertificate.md create mode 100644 docs/Test-CredentialStore.md create mode 100644 docs/Test-CredentialStoreItem.md create mode 100644 docs/Use-CSCertificate.md create mode 100644 docs/about_PSCredentialStore.md diff --git a/docs/Connect-To.md b/docs/Connect-To.md new file mode 100644 index 0000000..ada01c3 --- /dev/null +++ b/docs/Connect-To.md @@ -0,0 +1,201 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Connect-To + +## SYNOPSIS +Connects to the given host using the stored CredentialStoreItem. + +## SYNTAX + +### Private (Default) +``` +Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] [-PassThru] + [] +``` + +### Shared +``` +Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] [-Shared] + [-Path ] [-PassThru] [] +``` + +## DESCRIPTION +Establish a connection to the selected host using a stored CredentialStoreItem. + +## EXAMPLES + +### BEISPIEL 1 +``` +Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs +``` + +### BEISPIEL 2 +``` +Connect-To -RemoteHost "ftp.myside.local" -Type FTP +``` + +### BEISPIEL 3 +``` +Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS +``` + +### BEISPIEL 4 +``` +Connect-To -RemoteHost "esx01.myside.local" -Type VMware +``` + +### BEISPIEL 5 +``` +Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer +``` + +### BEISPIEL 6 +``` +Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP +``` + +### BEISPIEL 7 +``` +Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS +``` + +## 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 +Defaults to "". +Specify a string, which separates two CredentialStoreItems for the +same hostname. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specify the host type of the target. +Currently implemented targets are: Possible connection values are: +CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: 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 +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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 +``` + +### -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 +``` + +### 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 : Connect-To.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Disconnect-From.md b/docs/Disconnect-From.md new file mode 100644 index 0000000..ea84902 --- /dev/null +++ b/docs/Disconnect-From.md @@ -0,0 +1,130 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Disconnect-From + +## SYNOPSIS +Terminates a session established with Connect-To using a CredentialStoreItem. + +## SYNTAX + +``` +Disconnect-From [-RemoteHost] [-Type] [-Force] [] +``` + +## DESCRIPTION +Terminates a session established with Connect-To using a CredentialStoreItem. + +## EXAMPLES + +### BEISPIEL 1 +``` +Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs +``` + +### BEISPIEL 2 +``` +Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP +``` + +### BEISPIEL 3 +``` +Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS +``` + +### BEISPIEL 4 +``` +Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware +``` + +### BEISPIEL 5 +``` +Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True +``` + +### BEISPIEL 6 +``` +Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer +``` + +### BEISPIEL 7 +``` +Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP +``` + +### BEISPIEL 8 +``` +Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS +``` + +## PARAMETERS + +### -RemoteHost +Specify the remote endpoint, whose session you would like to terminate. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specify the host type of the target. +Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware, +CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: 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 +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 : Disconnect-From.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Get-CSCertificate.md b/docs/Get-CSCertificate.md new file mode 100644 index 0000000..556aeea --- /dev/null +++ b/docs/Get-CSCertificate.md @@ -0,0 +1,78 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Get-CSCertificate + +## SYNOPSIS +Returns the current used valid PfX certificate. + +## SYNTAX + +``` +Get-CSCertificate [-Type] [-Thumbprint] [] +``` + +## DESCRIPTION +Use this function to get the available pfx certificate respecting the config hierarchy. + +## EXAMPLES + +### BEISPIEL 1 +``` +Get-CSCertificate -Type 'Shared' -Thumbprint '12334456' +``` + +## 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 +Provide the credentials thumbprint for the search. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +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 + +### [System.Security.Cryptography.X509Certificates.X509Certificate2] +## NOTES +- File Name : Get-CSCertificate.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Get-CSPfxCertificate.md b/docs/Get-CSPfxCertificate.md new file mode 100644 index 0000000..8fd546c --- /dev/null +++ b/docs/Get-CSPfxCertificate.md @@ -0,0 +1,95 @@ +--- +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] [[-StoreName] ] [[-StoreLocation] ] + [] +``` + +## 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) + diff --git a/docs/Get-CredentialStore.md b/docs/Get-CredentialStore.md new file mode 100644 index 0000000..a164d71 --- /dev/null +++ b/docs/Get-CredentialStore.md @@ -0,0 +1,90 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Get-CredentialStore + +## SYNOPSIS +Reads the complete content of the credential store and returns it as a new object. + +## SYNTAX + +### Private (Default) +``` +Get-CredentialStore [] +``` + +### Shared +``` +Get-CredentialStore [-Path ] [-Shared] [] +``` + +## DESCRIPTION +The content is in a raw format. +It means there is no transformation to the different credential types. +You can not use the object properties to connect with remote host. +Therefore please use +Get-CredentialStoreItem. + +## EXAMPLES + +### BEISPIEL 1 +``` +$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json" +``` + +## PARAMETERS + +### -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 +``` + +### -Shared +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +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 + +### [PSObject] Returns the credential store content as PSObject. +## NOTES +- File Name : Get-CredentialStore.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Get-CredentialStoreItem.md b/docs/Get-CredentialStoreItem.md new file mode 100644 index 0000000..5e7f392 --- /dev/null +++ b/docs/Get-CredentialStoreItem.md @@ -0,0 +1,120 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Get-CredentialStoreItem + +## SYNOPSIS +Returns the Credential from a given remote host item. + +## SYNTAX + +### Private (Default) +``` +Get-CredentialStoreItem -RemoteHost [-Identifier ] [] +``` + +### Shared +``` +Get-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] + [] +``` + +## DESCRIPTION +Return the credential as PSCredential object. + +## EXAMPLES + +### BEISPIEL 1 +``` +$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +## 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 +Provide a custom identifier to the given remote host key. +This enables you to store multiple credentials +for a single remote host entry. +For example ad/sys1, ftp/sys1, mssql/sys1 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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 +``` + +### 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 + +### [System.Management.Automation.PSCredential] +## NOTES +- File Name : Get-CredentialStoreItem.ps1 +- Author : Messing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Import-CSCertificate.md b/docs/Import-CSCertificate.md new file mode 100644 index 0000000..c28de0b --- /dev/null +++ b/docs/Import-CSCertificate.md @@ -0,0 +1,79 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Import-CSCertificate + +## SYNOPSIS +Imports a linked certificate to the valid store location. + +## SYNTAX + +``` +Import-CSCertificate [-Type] [-Path] [] +``` + +## DESCRIPTION +Import-CSCertificate takes a pfx certificate file and imports it to the supposed certificate store for +private and shared credential stores. + +## EXAMPLES + +### BEISPIEL 1 +``` +.\Remove-Some-Script.ps1 -One content +``` + +## 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 +Provide a valid path to pfx certificate file. + +```yaml +Type: FileInfo +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +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 + +### Describe the script input parameters (if any), otherwise it may also list the word "[None]". +## OUTPUTS + +### Describe the script output parameters (if any), otherwise it may also list the word "[None]". +## NOTES +- File Name : Import-CSCertificate.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Import-CSPfxCertificate.md b/docs/Import-CSPfxCertificate.md new file mode 100644 index 0000000..e8e5b7a --- /dev/null +++ b/docs/Import-CSPfxCertificate.md @@ -0,0 +1,113 @@ +--- +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] [[-StoreName] ] [[-StoreLocation] ] + [[-OpenFlags] ] [] +``` + +## 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) + diff --git a/docs/New-CSCertAttribute.md b/docs/New-CSCertAttribute.md new file mode 100644 index 0000000..3908b1a --- /dev/null +++ b/docs/New-CSCertAttribute.md @@ -0,0 +1,154 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# New-CSCertAttribute + +## SYNOPSIS +Creates required data for a certificate signing request. + +## SYNTAX + +``` +New-CSCertAttribute [-Country] [-State] [-City] [-Organization] + [-OrganizationalUnitName] [-CommonName] [[-Days] ] [] +``` + +## DESCRIPTION +Defines the certificate related properties for an upcoming New-PfxCertificate execution. + +## EXAMPLES + +### BEISPIEL 1 +``` +New-CSCertAttribute -Country 'DE' -State 'BW' -City 'Karlsruhe' -Organization 'AwesomeIT' -OrganizationalUnitName '' -CommonName 'MyPrivateCert' +``` + +## PARAMETERS + +### -Country +County code like EN, DE, IT, FR... + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Certificate state value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +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 wildcard characters: False +``` + +### -Organization +Certificate organization value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnitName +Certificate OrganizationalUnitName value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +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 +``` + +### -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 +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 + +### ['PSCredentialStore.Certificate.CSRDetails'] +## NOTES +- File Name : New-CSCertAttribute.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/New-CSCertificate.md b/docs/New-CSCertificate.md new file mode 100644 index 0000000..6ad4f74 --- /dev/null +++ b/docs/New-CSCertificate.md @@ -0,0 +1,127 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# New-CSCertificate + +## SYNOPSIS +Creates a new PFX certificate for the CredentialStore encryption. + +## SYNTAX + +``` +New-CSCertificate [-CRTAttribute] [[-KeyName] ] [[-CertName] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Use this function to create a custom self signed certificate used by the PSCredentialStore module. + +## EXAMPLES + +### BEISPIEL 1 +``` +New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertName './mycert.pfx' +``` + +## PARAMETERS + +### -CRTAttribute +Provide certificate related attributes provided by function New-CRTAttribute. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +Provide a custom full path and name for the private key. +The file extension has to be \`*.key\`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: ./private.key +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -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 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 +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 + +### [PSCredentialStore.Certificate.Attribute] +## OUTPUTS + +### [None] +## NOTES +- File Name : New-CSCertificate.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/New-CredentialStore.md b/docs/New-CredentialStore.md new file mode 100644 index 0000000..e8e5b7a --- /dev/null +++ b/docs/New-CredentialStore.md @@ -0,0 +1,113 @@ +--- +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] [[-StoreName] ] [[-StoreLocation] ] + [[-OpenFlags] ] [] +``` + +## 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) + diff --git a/docs/New-CredentialStoreItem.md b/docs/New-CredentialStoreItem.md new file mode 100644 index 0000000..4bd392b --- /dev/null +++ b/docs/New-CredentialStoreItem.md @@ -0,0 +1,138 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# New-CredentialStoreItem + +## SYNOPSIS +Adds a credential store item containing host, user and password to the given store. + +## SYNTAX + +### Private (Default) +``` +New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] + [] +``` + +### Shared +``` +New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] + [-Path ] [] +``` + +## DESCRIPTION +The credentials are stored without any relations to it's further use. +If you need to change an existing +item please use Set-CredentialStoreItem. +You need to decide afterwards, whether to use the credential for +a VIConnection, NetApp FAS or UCS Fabric Interconnect. + +## EXAMPLES + +### BEISPIEL 1 +``` +New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +## PARAMETERS + +### -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 +``` + +### -Identifier +Provide a custom identifier to the given remote host key. +This enables you to store multiple credentials +for a single remote host entry. +For example ad/sys1, ftp/sys1, mssql/sys1 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +You can provide credentials optionally as pre existing pscredential object. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Shared +{{ Fill Shared Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: 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 +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 : New-CredentialStoreItem.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/PSCredentialStore.md b/docs/PSCredentialStore.md new file mode 100644 index 0000000..efe12ed --- /dev/null +++ b/docs/PSCredentialStore.md @@ -0,0 +1,73 @@ +--- +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 +## Description +[about_PSCredentialStore](about_PSCredentialStore.md) + +## PSCredentialStore Cmdlets +### [Connect-To](Connect-To.md) +Connects to the given host using the stored CredentialStoreItem. + +### [Disconnect-From](Disconnect-From.md) +Terminates a session established with Connect-To using a CredentialStoreItem. + +### [Get-CredentialStore](Get-CredentialStore.md) +Reads the complete content of the credential store and returns it as a new object. + +### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) +Returns the Credential from a given remote host item. + +### [Get-CSCertificate](Get-CSCertificate.md) +Returns the current used valid PfX certificate. + +### [Get-CSPfxCertificate](Get-CSPfxCertificate.md) +Returns the certificate object given by thumbprint. + +### [Import-CSCertificate](Import-CSCertificate.md) +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. + +### [Import-CSPfxCertificate](Import-CSPfxCertificate.md) +Adds a given pfx certificate file to current user's personal certificate store. + +### [New-CredentialStoreItem](New-CredentialStoreItem.md) +Adds a credential store item containing host, user and password to the given store. + +### [New-CSCertAttribute](New-CSCertAttribute.md) +Creates required data for a certificate signing request. + +### [New-CSCertificate](New-CSCertificate.md) +Creates a new PFX certificate for the CredentialStore encryption. + +### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md) +Remove the given credentials from the credential store. + +### [Set-CredentialStoreItem](Set-CredentialStoreItem.md) +Changes the credentials for the given remote host in the store. + +### [Test-CredentialStore](Test-CredentialStore.md) +Returns the credential store state. + +### [Test-CredentialStoreItem](Test-CredentialStoreItem.md) +Checks if the given RemoteHost identifier combination exists in the credential store. + +### [Test-CSCertificate](Test-CSCertificate.md) +Tests if the linked certificate is store ein the specified cert stores. + +### [Test-CSConnection](Test-CSConnection.md) +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) +Links an existing PFX Certificate to a CredentialStore. + diff --git a/docs/Remove-CredentialStoreItem.md b/docs/Remove-CredentialStoreItem.md new file mode 100644 index 0000000..eb18813 --- /dev/null +++ b/docs/Remove-CredentialStoreItem.md @@ -0,0 +1,134 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Remove-CredentialStoreItem + +## SYNOPSIS +Remove the given credentials from the credential store. + +## SYNTAX + +### Private (Default) +``` +Remove-CredentialStoreItem -RemoteHost [-Identifier ] [] +``` + +### Shared +``` +Remove-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] + [] +``` + +## DESCRIPTION +Use this CMDLet to completely remove an credential store item. + +## EXAMPLES + +### BEISPIEL 1 +``` +Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" +``` + +### BEISPIEL 2 +``` +Remove-CredentialStoreItem -Shared -RemoteHost "esx01.myside.local" +``` + +### BEISPIEL 3 +``` +Remove-CredentialStoreItem -Shared -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +### BEISPIEL 4 +``` +Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc +``` + +## 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 +Defaults to "". +Specify a string, which separates two CredentialStoreItems for the +same hostname. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: 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 +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 : Remove-CredentialStoreItem.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Set-CredentialStoreItem.md b/docs/Set-CredentialStoreItem.md new file mode 100644 index 0000000..0ccd012 --- /dev/null +++ b/docs/Set-CredentialStoreItem.md @@ -0,0 +1,137 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Set-CredentialStoreItem + +## SYNOPSIS +Changes the credentials for the given remote host in the store. + +## SYNTAX + +### Private (Default) +``` +Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] + [] +``` + +### Shared +``` +Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] + [-Path ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### BEISPIEL 1 +``` +Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc + +## 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 +Defaults to "". +Specify a string, which separates two CredentialStoreItems for the +same hostname. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +{{ Fill Credential Description }} + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Shared +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: 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 +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 : Set-CredentialStoreItem.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Test-CSCertificate.md b/docs/Test-CSCertificate.md new file mode 100644 index 0000000..4cc3507 --- /dev/null +++ b/docs/Test-CSCertificate.md @@ -0,0 +1,63 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Test-CSCertificate + +## SYNOPSIS +Tests if the linked certificate is store ein the specified cert stores. + +## SYNTAX + +``` +Test-CSCertificate [-Type] [] +``` + +## DESCRIPTION +Test-CSCertificate should be an easy high level test for the linked certificate. + +## EXAMPLES + +### BEISPIEL 1 +``` +Test-CSCertificate -Type 'Shared' +``` + +## PARAMETERS + +### -Type +Select between 'Private' or 'Shared'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +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-CSCertificate.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Test-CSConnection.md b/docs/Test-CSConnection.md new file mode 100644 index 0000000..4eae574 --- /dev/null +++ b/docs/Test-CSConnection.md @@ -0,0 +1,80 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Test-CSConnection + +## SYNOPSIS +Returns the connection state of a given type to the remote host. + +## SYNTAX + +``` +Test-CSConnection [-RemoteHost] [-Type] [] +``` + +## DESCRIPTION +Use this script to check a connection which was established with the \`Connect-To\` cmdlet. + +## EXAMPLES + +### BEISPIEL 1 +``` +Test-CMConnection -RemoteHost "vcr01.internal.net" -Type VMware +``` + +## PARAMETERS + +### -RemoteHost +Define the remote host you would like to check. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Define the connection type you would like to check. +See the \`Connect-To\` documentation +for valid type values. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +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-CSConnection.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Test-CSPfxCertificate.md b/docs/Test-CSPfxCertificate.md new file mode 100644 index 0000000..2f61c90 --- /dev/null +++ b/docs/Test-CSPfxCertificate.md @@ -0,0 +1,94 @@ +--- +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] [[-StoreName] ] [[-StoreLocation] ] + [] +``` + +## 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) + diff --git a/docs/Test-CredentialStore.md b/docs/Test-CredentialStore.md new file mode 100644 index 0000000..5352e56 --- /dev/null +++ b/docs/Test-CredentialStore.md @@ -0,0 +1,88 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Test-CredentialStore + +## SYNOPSIS +Returns the credential store state. + +## SYNTAX + +### Private (Default) +``` +Test-CredentialStore [] +``` + +### Shared +``` +Test-CredentialStore [-Path ] [-Shared] [] +``` + +## DESCRIPTION +Use this script to test your credential store. +For now it only checks if +the file exists. + +## EXAMPLES + +### Example 1 +```powershell +PS C:> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -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 +``` + +### -Shared +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +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 + +## OUTPUTS + +## NOTES +- File Name : Test-CredentialStore.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Test-CredentialStoreItem.md b/docs/Test-CredentialStoreItem.md new file mode 100644 index 0000000..0bb078c --- /dev/null +++ b/docs/Test-CredentialStoreItem.md @@ -0,0 +1,129 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Test-CredentialStoreItem + +## SYNOPSIS +Checks if the given RemoteHost identifier combination exists in the credential store. + +## SYNTAX + +### Private (Default) +``` +Test-CredentialStoreItem -RemoteHost [-Identifier ] [] +``` + +### Shared +``` +Test-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] [-Shared] + [] +``` + +## DESCRIPTION +Use this cmdlet for basic checks with a single item. +Check the item first with this function before +you try to interact with it. + +## EXAMPLES + +### BEISPIEL 1 +``` +If (Test-CredentialStoreItem -RemoteHost "Default") { +``` + +Get-CredentialStoreItem -RemoteHost "Default" +} +Else { + Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost) +} + +## PARAMETERS + +### -Path +Define a custom credential store you try to read from. +Without the \`-Path\` parameter +\`Test-CredentialStoreItem\` tries to read from the default private store. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData +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 +``` + +### -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 +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: False +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 : Test-CredentialStoreItem.ps1 +- Author : Marco Blessing - marco.blessing@googlemail.com +- Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/Use-CSCertificate.md b/docs/Use-CSCertificate.md new file mode 100644 index 0000000..e48a0b2 --- /dev/null +++ b/docs/Use-CSCertificate.md @@ -0,0 +1,114 @@ +--- +external help file: PSCredentialStore-help.xml +Module Name: PSCredentialStore +online version: https://github.com/OCram85/PSCredentialStore +schema: 2.0.0 +--- + +# Use-CSCertificate + +## SYNOPSIS +Links an existing PFX Certificate to a CredentialStore. + +## SYNTAX + +### Private (Default) +``` +Use-CSCertificate -Path [-UseCertStore] [] +``` + +### Shared +``` +Use-CSCertificate -Path [-CredentialStore ] [-Shared] [-UseCertStore] [] +``` + +## DESCRIPTION +Linking a certificate is needed if you plan to use the same CredentialStore in cross platform scenarios. + +## EXAMPLES + +### BEISPIEL 1 +``` +Use-CSCertificate -Path 'C:\cert.pfx' +``` + +## 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 +Specify a custom path for a shared credential store. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +Use the credential store in shared mode. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCertStore +{{ Fill UseCertStore Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 : Use-CSCertificate.ps1 +Author : Marco Blessing - marco.blessing@googlemail.com +Requires : + +## RELATED LINKS + +[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) + diff --git a/docs/about_PSCredentialStore.md b/docs/about_PSCredentialStore.md new file mode 100644 index 0000000..726bf1b --- /dev/null +++ b/docs/about_PSCredentialStore.md @@ -0,0 +1,102 @@ +# PSCredentialStore +## about_PSCredentialStore + + +# SHORT DESCRIPTION +PSCredentialStore enables managing multiple PSCredential objects. + + +# LONG DESCRIPTION +The PSCredentialStore is an simple credential manager for PSCredentials. It stores multiple credential objects in a +simple json file. You can choose between a private and shared 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 +script 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 +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. + + +## Installation + +## PowerShellGallery.com (Recommended Way) + +* Make sure you use PowerShell 4.0 or higher with `$PSVersionTable`. +* Use the builtin PackageManagement and install with: `Install-Module PSCredentialStore` +* Done. Start exploring the Module with `Import-Module PSCredentialStore ; Get-Command -Module PSCredentialStore` + +## Manual Way + +* Take a look at the [Latest Release](https://github.com/OCram85/PSCredentialStore/releases/latest) page. +* Download the `PSCredentialStore.zip`. +* Unpack the Zip and put it in your Powershell Module path. + * Don't forget to change the NTFS permission flag in the context menu. +* Start with `Import-Module PSCredentialStore` + +**1.** First we need a blank CredentialStore. 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. +```powershell +# Private Credential Store +New-CredentialStore + +# Shared Credential Store +New-CredentialStore -Shared + +#Shared CredentialStore in custom Location +New-CredentialStore -Shared -Path 'C:\CredentialStore.json' +``` + +**2.** Now you can manage your CredentialStoreItems: +```powershell +# This will prompt for credentials and stores it in a private store +New-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier 'AD' + +# You can now use it in other scripts like this: +$DCCreds = Get-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier 'AD' +Invoke-Command -ComputerName 'dc01.myside.local' -Credential $DCCreds -ScripBlock {Get-Process} +``` + +The CredentialStore contains also a simple function to establish a connection with several systems or protocols. +If you have already installed the underlying framework your can connect to: + +* **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) +* **FTP** - Establish a connection to a FTP host. + * Required Modules: [`WinSCP`](https://www.powershellgallery.com/packages/WinSCP) +* **NetAppFAS** - Establish a connection to a NetApp Clustered ONTAP filer. + * Required Modules: [`DataONTAP`](http://mysupport.netapp.com/tools/info/ECMLP2310788I.html?productID=61926) +* **VMware** - Establish a connection to a VMware vCenter or ESXi host. + * Required Modules: [`VMware.VimAutomation.Core`](https://www.powershellgallery.com/packages/VMware.PowerCLI) +* **CisServer** - Establish a connection to the CisServer Service on vCenter Host. + * Required Modules: [`VMware.VimAutomation.Cis.Core`](https://www.powershellgallery.com/packages/VMware.PowerCLI)) +* **ExchangeHTTP** - Establish a remote connection with an Exchange endpoint via http. + * Requires PowerShell remoting +* **ExchangeHTTPS** - Establish a remote connection with an Exchange endpoint via https. + * Requires PowerShell remoting +* **SCP** - Establish a SCP connection. + * Required Modules: [`WinSCP`](https://www.powershellgallery.com/packages/WinSCP) +# EXAMPLES + +```powershell +Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs +Connect-To -RemoteHost "ftp.myside.local" -Type FTP +Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS +Connect-To -RemoteHost "esx01.myside.local" -Type VMware +Connect-To -RemoteHost "vcr.myside.local" -Type CisServer +``` +# NOTE + + +# TROUBLESHOOTING NOTE + + +# SEE ALSO + + +# KEYWORDS + +- Credential +- Store