+
+ 
- 🔐 A simple credential manager to store and reuse multiple PSCredential objects. + 🔐 A simple cross-platform credential manager for PSCredential objects.
-
- 
+
+ 
+
@@ -49,7 +51,7 @@ need to store credentials for non interactive usage like in scheduled tasks.
Starting with version `1.0.0` PSCredential uses Pfx certificates fo encryption. You can use Pfx certificate files
or certificates stored in the certificate store.
-For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on github or via CLI with
+For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on gitea or via CLI with
`Get-Help about_PSCredentialStore`.
You can find the [reference](/docs/PSCredentialStore.md) in the /docs/ path as well.
@@ -99,7 +101,7 @@ Here is s brief hierarchy description of the certificate location: *(First match
### :building_construction: Manual Way
-* Take a look at the [Latest Release](https://github.com/OCram85/PSCredentialStore/releases/latest) page.
+* Take a look at the [Latest Release](https://gitea.ocram85.com/OCram85/PSCredentialStore/releases/latest) page.
* Download the `PSCredentialStore.zip`.
* Unpack the zip file and put it in your Powershell module path.
* Don't forget to change the NTFS permission flag in the context menu.
diff --git a/docs/about_PSCredentialStore.md b/docs/about_PSCredentialStore.md
index e0f33cc..9a3076e 100644
--- a/docs/about_PSCredentialStore.md
+++ b/docs/about_PSCredentialStore.md
@@ -1,147 +1,147 @@
-# PSCredentialStore
-## about_PSCredentialStore
-
-
-# SHORT DESCRIPTION
-PSCredentialStore enables managing multiple PSCredential objects.
-
-
-# LONG DESCRIPTION
-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
-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.
-
-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.
-
-Starting with version `1.0.0` PSCredential uses Pfx certificates fo encryption. You can use Pfx certificate files
-or certificates stored in the certificate store.
-
-For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on github or via CLI with
-`Get-Help about_PSCredentialStore`.
-
-## Requirements
-
-- PowerShell >= `5.1`
-- .NET Framework >= `4.6` or .NET Core >= `1.0`
-
-## About Security
-
->This section explains some security topics and the the design decisions we made to balance the usage and security needs.
-
-To be able to delegate `PSCredentials` objects we can't exclusively rely on the `SecureString` cmdlets. You can't
-decrypt and reuse such credentials from a different user account or even machine. This is caused by automatically
-generated encryption key which, is used create a `Secure String` based encrypted string.
-
-In order to delegate a password, while still using the underlying security framework, we have to provide a custom
-encryption key. This leads to the fact, that everyone who has access to the key could encrypt or decrypt your data.
-
-So we decided to use the public and private keys from valid certificates as part of the custom encryption keys to encrypt your data.
-
-This means clearly: Everyone who has access to the `CredentialStore` needs also access to the certificate file to work with it.
-
-Keep in mind you need to secure the access with your NTFS file permissions to avoid unwanted usage. Another option is
-to import the certificate into your certification vaults of you operating system. In this case you can grand the
-permission to the certificates itself.
-
-Here is s brief hierarchy description of the certificate location: *(First match wins)*
-
-| CredentialStore Type | Certificate Location |
-| -------------------- | ---------------------- |
-| Private | `CurrentUser`\\`My` |
-| Shared (Windows) | `CurrentUser`\\`My` |
-| | `LocalMachine`\\`Root` |
-| Shared (Linux) | `LocalMachine`\\`My` |
-| | `LocalMachine`\\`Root` |
-
-
-## Installation
-
-## PowerShellGallery.com (Recommended Way)
-
-* Make sure you use PowerShell 5.1 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 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.
-
-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 certificate store as well.
-
-```powershell
-# Private credential store
-New-CredentialStore
-
-# Private credential store with certificate store usage
-New-CredentialStore -UseCertStore
-
-# Shared credential store
-New-CredentialStore -Shared
-
-#Shared credential store 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
+# PSCredentialStore
+## about_PSCredentialStore
+
+
+# SHORT DESCRIPTION
+PSCredentialStore enables managing multiple PSCredential objects.
+
+
+# LONG DESCRIPTION
+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
+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.
+
+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.
+
+Starting with version `1.0.0` PSCredential uses Pfx certificates fo encryption. You can use Pfx certificate files
+or certificates stored in the certificate store.
+
+For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on gitea or via CLI with
+`Get-Help about_PSCredentialStore`.
+
+## Requirements
+
+- PowerShell >= `5.1`
+- .NET Framework >= `4.6` or .NET Core >= `1.0`
+
+## About Security
+
+>This section explains some security topics and the the design decisions we made to balance the usage and security needs.
+
+To be able to delegate `PSCredentials` objects we can't exclusively rely on the `SecureString` cmdlets. You can't
+decrypt and reuse such credentials from a different user account or even machine. This is caused by automatically
+generated encryption key which, is used create a `Secure String` based encrypted string.
+
+In order to delegate a password, while still using the underlying security framework, we have to provide a custom
+encryption key. This leads to the fact, that everyone who has access to the key could encrypt or decrypt your data.
+
+So we decided to use the public and private keys from valid certificates as part of the custom encryption keys to encrypt your data.
+
+This means clearly: Everyone who has access to the `CredentialStore` needs also access to the certificate file to work with it.
+
+Keep in mind you need to secure the access with your NTFS file permissions to avoid unwanted usage. Another option is
+to import the certificate into your certification vaults of you operating system. In this case you can grand the
+permission to the certificates itself.
+
+Here is s brief hierarchy description of the certificate location: *(First match wins)*
+
+| CredentialStore Type | Certificate Location |
+| -------------------- | ---------------------- |
+| Private | `CurrentUser`\\`My` |
+| Shared (Windows) | `CurrentUser`\\`My` |
+| | `LocalMachine`\\`Root` |
+| Shared (Linux) | `LocalMachine`\\`My` |
+| | `LocalMachine`\\`Root` |
+
+
+## Installation
+
+## PowerShellGallery.com (Recommended Way)
+
+* Make sure you use PowerShell 5.1 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 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.
+
+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 certificate store as well.
+
+```powershell
+# Private credential store
+New-CredentialStore
+
+# Private credential store with certificate store usage
+New-CredentialStore -UseCertStore
+
+# Shared credential store
+New-CredentialStore -Shared
+
+#Shared credential store 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
diff --git a/src/PSCredentialStore.psd1 b/src/PSCredentialStore.psd1
index 6947b23..4492020 100644
--- a/src/PSCredentialStore.psd1
+++ b/src/PSCredentialStore.psd1
@@ -22,7 +22,7 @@
Copyright = '(c) 2022 OCram85. All rights reserved.'
# Description of the functionality provided by this module
- Description = 'A simple credential manager to store and reuse multiple credential objects.'
+ Description = 'A simple cross-platform credential manager for PSCredential objects.'
# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '5.1'
@@ -119,16 +119,16 @@
Tags = 'CredentialStore', 'CredentialManager'
# A URL to the license for this module.
- LicenseUri = 'https://github.com/OCram85/PSCredentialStore/blob/master/LICENSE'
+ LicenseUri = 'https://gitea.ocram85.com/OCram85/PSCredentialStore/raw/branch/master/LICENSE'
# A URL to the main website for this project.
- ProjectUri = 'https://github.com/OCram85/PSCredentialStore'
+ ProjectUri = 'https://gitea.ocram85.com/OCram85/PSCredentialStore'
# A URL to an icon representing this module.
- IconUri = 'https://raw.githubusercontent.com/OCram85/PSCredentialStore/master/assets/logo256.png'
+ IconUri = 'https://gitea.ocram85.com/OCram85/PSCredentialStore/raw/branch/master/assets/logo256.png'
# ReleaseNotes of this module
- ReleaseNotes = 'See https://github.com/OCram85/PSCredentialStore/releases page for details.'
+ ReleaseNotes = 'See https://gitea.ocram85.com/OCram85/PSCredentialStore/releases page for details.'
# Prerelease string of this module
#Prerelease = 'preview'
@@ -144,7 +144,7 @@
} # End of PrivateData hashtable
# HelpInfo URI of this module
- HelpInfoURI = 'https://github.com/OCram85/PSCredentialStore'
+ HelpInfoURI = 'https://gitea.ocram85.com/OCram85/PSCredentialStore'
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''