Lib/Default/PSPGP.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PSPGP</name> </assembly> <members> <member name="T:PSPGP.CmdletGetPGPInspect"> <summary> Inspects PGP content and returns message metadata. </summary> <example> <code> $Signature = Protect-PGP -SignOnly -SignKey $PSScriptRoot\Keys\PrivatePGP1.asc -SignPassword 'secret' -String 'Signed text' Get-PGPInspect -String $Signature </code> </example> </member> <member name="P:PSPGP.CmdletGetPGPInspect.FolderPath"> <summary>Folder containing PGP files to inspect.</summary> </member> <member name="P:PSPGP.CmdletGetPGPInspect.FilePath"> <summary>File to inspect.</summary> </member> <member name="P:PSPGP.CmdletGetPGPInspect.String"> <summary>Armored message content to inspect.</summary> </member> <member name="M:PSPGP.CmdletGetPGPInspect.ProcessRecord"> <summary> Inspects the selected input and writes message metadata. </summary> </member> <member name="T:PSPGP.CmdletGetPGPKey"> <summary> Downloads a public key from a key server. </summary> <example> <code> Get-PGPKey -KeyServer "https://keys.example.com" -Search "user@example.com" -OutFilePath "key.asc" </code> </example> </member> <member name="P:PSPGP.CmdletGetPGPKey.KeyServer"> <summary>URL of the key server.</summary> </member> <member name="P:PSPGP.CmdletGetPGPKey.Search"> <summary>Search string identifying the key.</summary> </member> <member name="P:PSPGP.CmdletGetPGPKey.OutFilePath"> <summary>File path where the downloaded key is stored.</summary> </member> <member name="M:PSPGP.CmdletGetPGPKey.ProcessRecord"> <summary> Executes the cmdlet logic to download the specified public key and optionally writes it to a file. </summary> </member> <member name="T:PSPGP.CmdletGetPGPKeyInfo"> <summary> <para>Returns information about a PGP key such as algorithm, expiration and user IDs.</para> </summary> <example> <code> Get-PGPKeyInfo -FilePath $PSScriptRoot\Keys\PublicPGP1.asc </code> </example> </member> <member name="P:PSPGP.CmdletGetPGPKeyInfo.FilePath"> <summary>Paths to key files to inspect.</summary> </member> <member name="M:PSPGP.CmdletGetPGPKeyInfo.ProcessRecord"> <summary> Processes each provided key file and emits <see cref="T:PSPGP.PGPKeyInfo"/> objects describing the contents. </summary> </member> <member name="T:PSPGP.CmdletNewPGPKey"> <summary> <para>Generates a new PGP key pair.</para> </summary> <example> <code> New-PGPKey -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -FilePathPrivate $PSScriptRoot\Keys\PrivatePGP1.asc -UserName 'user' -Password 'secret' </code> </example> <example> <code> New-PGPKey -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -FilePathPrivate $PSScriptRoot\Keys\PrivatePGP1.asc -Strength 4096 -Certainty 8 -EmitVersion </code> </example> </member> <member name="P:PSPGP.CmdletNewPGPKey.FilePathPublic"> <summary>Path to the public key file to create.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.FilePathPrivate"> <summary>Path to the private key file to create.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.UploadKeyServer"> <summary>Key server URL to upload the generated public key.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.UserName"> <summary>User name associated with the generated key.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.Password"> <summary>Password used to protect the private key.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.Credential"> <summary>Credential object providing user name and password.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.Strength"> <summary>Key strength in bits.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.Certainty"> <summary>Certainty value used when generating a key.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.EmitVersion"> <summary>Adds the PGP version notation to the key.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.HashAlgorithm"> <summary>Optional hash algorithm used when generating keys.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.CompressionAlgorithm"> <summary>Optional compression algorithm used when generating keys.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.FileType"> <summary>Defines the file type stored within the PGP package.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.PgpSignatureType"> <summary>PGP signature type used when creating the key.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.PublicKeyAlgorithm"> <summary>Public key algorithm used for key creation.</summary> </member> <member name="P:PSPGP.CmdletNewPGPKey.SymmetricKeyAlgorithm"> <summary>Symmetric key algorithm used for encryption.</summary> </member> <member name="M:PSPGP.CmdletNewPGPKey.ProcessRecord"> <summary> Generates a new key pair based on the provided parameters and optionally uploads the public key. </summary> </member> <member name="T:PSPGP.CmdletProtectPGP"> <summary> <para> Encrypts or signs files, folders or strings using one or more public keys. Use <c>-SignOnly</c> or the <c>Sign*</c> parameter sets to create detached signatures without encryption. </para> </summary> <example> <code> Protect-PGP -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -FolderPath $PSScriptRoot\Test -OutputFolderPath $PSScriptRoot\Encoded </code> </example> <example> <code> Protect-PGP -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -FilePath $PSScriptRoot\Test\Test1.txt -OutFilePath $PSScriptRoot\Encoded\Test1.txt.pgp </code> </example> <example> <code> Protect-PGP -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -String "Sensitive text" </code> </example> <example> <code> Protect-PGP -SymmetricPassphrase 'SymmetricPass123!' -String 'Sensitive text' </code> </example> <example> <code> Protect-PGP -SignOnly -SignKey $PSScriptRoot\Keys\PrivatePGP1.asc -SignPassword 'secret' -String "Signed content" </code> </example> <example> <code> Protect-PGP -ClearSign -SignKey $PSScriptRoot\Keys\PrivatePGP1.asc -SignPassword 'secret' -String "Human readable signed content" </code> </example> </member> <member name="P:PSPGP.CmdletProtectPGP.FilePathPublic"> <summary>Public key files used for encryption.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.FolderPath"> <summary>Folder to encrypt when using the Folder parameter set.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.OutputFolderPath"> <summary>Destination folder for encrypted files.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.FilePath"> <summary>File to encrypt when using the File parameter set.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.OutFilePath"> <summary>Output file path for the encrypted file.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.String"> <summary>String content to encrypt.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.SymmetricPassphrase"> <summary>Passphrase used for symmetric encryption.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.SignKey"> <summary> Private key used for signing data. Mandatory when using the <c>Sign*</c> parameter sets or the <c>-SignOnly</c> switch. </summary> </member> <member name="P:PSPGP.CmdletProtectPGP.SignPassword"> <summary>Password for the signing private key.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.HashAlgorithm"> <summary>Optional hash algorithm for encryption.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.CompressionAlgorithm"> <summary>Optional compression algorithm for encryption.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.FileType"> <summary>Type of data being encrypted.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.PgpSignatureType"> <summary>PGP signature type when signing data.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.PublicKeyAlgorithm"> <summary>Public key algorithm used during encryption.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.SymmetricKeyAlgorithm"> <summary>Symmetric key algorithm used during encryption.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.Armor"> <summary>Controls whether file output is armored.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.WithIntegrityCheck"> <summary>Controls whether an integrity check packet is added.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.LiteralFileName"> <summary>Optional literal file name embedded in the PGP payload.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.Headers"> <summary>Optional armored headers added to generated content.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.OldFormat"> <summary>Uses the legacy packet format when set.</summary> </member> <member name="P:PSPGP.CmdletProtectPGP.SignOnly"> <summary> When specified, only a signature is produced instead of encrypting the input. This parameter is automatically implied when using the <c>Sign*</c> parameter sets. </summary> </member> <member name="P:PSPGP.CmdletProtectPGP.ClearSign"> <summary> Creates a clear-signed message that remains human readable. </summary> </member> <member name="M:PSPGP.CmdletProtectPGP.ProcessRecord"> <summary> Encrypts or signs input data based on the selected parameter set and writes results to files or the pipeline. </summary> </member> <member name="T:PSPGP.CmdletTestPGP"> <summary> <para>Verifies PGP signatures for files, folders or strings.</para> </summary> <example> <code> Test-PGP -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -String $ProtectedString </code> </example> <example> <code> Test-PGP -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -FolderPath $PSScriptRoot\Encoded </code> </example> <example> <code> Test-PGP -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -String $ClearSigned -ClearSigned </code> </example> <example> <code> Test-PGP -FilePathPublic $PSScriptRoot\Keys\PublicPGP1.asc -String $ProtectedString -ThrowIfEncrypted </code> </example> </member> <member name="P:PSPGP.CmdletTestPGP.FilePathPublic"> <summary>Public key file used to verify signatures.</summary> </member> <member name="P:PSPGP.CmdletTestPGP.FolderPath"> <summary>Folder containing files to verify.</summary> </member> <member name="P:PSPGP.CmdletTestPGP.OutputFolderPath"> <summary>Destination folder for verification reports.</summary> </member> <member name="P:PSPGP.CmdletTestPGP.FilePath"> <summary>File path to verify.</summary> </member> <member name="P:PSPGP.CmdletTestPGP.OutFilePath"> <summary>Output path for verification result.</summary> </member> <member name="P:PSPGP.CmdletTestPGP.String"> <summary>Encrypted text to verify.</summary> </member> <member name="P:PSPGP.CmdletTestPGP.ThrowIfEncrypted"> <summary>Throws when encrypted content is passed to verify methods.</summary> </member> <member name="P:PSPGP.CmdletTestPGP.ClearSigned"> <summary>Verifies clear-signed content instead of detached/regular signatures.</summary> </member> <member name="M:PSPGP.CmdletTestPGP.ProcessRecord"> <summary> Validates signatures for files, folders or strings using the provided public keys. </summary> </member> <member name="T:PSPGP.CmdletUnprotectPGP"> <summary> <para>Removes PGP encryption from files or strings using a private key or symmetric passphrase.</para> </summary> <example> <code> Unprotect-PGP -FilePathPrivate $PSScriptRoot\Keys\PrivatePGP1.asc -Password 'secret' -FolderPath $PSScriptRoot\Encoded -OutputFolderPath $PSScriptRoot\Decoded </code> </example> <example> <code> Unprotect-PGP -FilePathPrivate $PSScriptRoot\Keys\PrivatePGP1.asc -Password 'secret' -String $Encrypted </code> </example> <example> <code> Unprotect-PGP -SymmetricPassphrase 'SymmetricPass123!' -String $Encrypted </code> </example> </member> <member name="P:PSPGP.CmdletUnprotectPGP.FilePathPrivate"> <summary>Private key file used to decrypt data.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.FilePathPublic"> <summary>Public key files reserved for signed-and-encrypted verification workflows.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.SymmetricPassphrase"> <summary>Passphrase used for symmetric decryption.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.Password"> <summary>Password protecting the private key.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.Credential"> <summary>Credential object with password for the private key.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.FolderPath"> <summary>Folder containing encrypted files.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.OutputFolderPath"> <summary>Destination folder for decrypted output.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.FilePath"> <summary>Encrypted file to decrypt.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.OutFilePath"> <summary>Output file path for decrypted data.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.String"> <summary>Encrypted text to decrypt.</summary> </member> <member name="P:PSPGP.CmdletUnprotectPGP.Verify"> <summary>Reserved for future signed-and-encrypted verification support.</summary> </member> <member name="M:PSPGP.CmdletUnprotectPGP.ProcessRecord"> <summary> Decrypts files or strings using the supplied private keys and writes the decrypted data to disk or the pipeline. </summary> </member> <member name="T:PSPGP.ErrorActionHelper"> <summary> Utility methods for handling <c>-ErrorAction</c> related logic across cmdlets. </summary> <example> <code> if (ErrorActionHelper.IsStop(this)) { Write-Error "Terminating"; } </code> </example> </member> <member name="M:PSPGP.ErrorActionHelper.IsStop(System.Management.Automation.PSCmdlet)"> <summary> Determines whether the specified cmdlet should treat errors as terminating based on the <c>-ErrorAction</c> parameter or the global preference. </summary> <param name="cmdlet">Cmdlet being executed.</param> <returns><c>true</c> if error action is <see cref="F:System.Management.Automation.ActionPreference.Stop"/>.</returns> </member> <member name="M:PSPGP.ErrorActionHelper.WriteErrorOrWarning(System.Management.Automation.PSCmdlet,System.Exception,System.String,System.Management.Automation.ErrorCategory,System.Object,System.String)"> <summary> Writes an error record or warning depending on the cmdlet's error action preference. </summary> <param name="cmdlet">Cmdlet writing the message.</param> <param name="exception">Exception to report.</param> <param name="id">Error identifier.</param> <param name="category">Error category.</param> <param name="targetObject">Object associated with the error.</param> <param name="warningMessage">Message to display when not stopping.</param> </member> <member name="T:PSPGP.KeyExpirationHelper"> <summary> Provides helpers for reading PGP key expiration information and reporting expiration warnings. </summary> </member> <member name="M:PSPGP.KeyExpirationHelper.GetExpiration(System.String)"> <summary> Reads the expiration date from the specified PGP key file. </summary> <param name="filePath">Path to the PGP key.</param> <returns>The expiration date if available.</returns> </member> <member name="M:PSPGP.KeyExpirationHelper.WarnIfExpired(System.Management.Automation.PSCmdlet,System.String,System.Nullable{System.DateTime})"> <summary> Emits a warning from the given cmdlet if the key is expired or expiring soon. </summary> <param name="cmdlet">Cmdlet writing the warning.</param> <param name="filePath">Path to the PGP key.</param> <param name="expiration">Expiration date of the key.</param> </member> <member name="T:PSPGP.KeyServerHelper"> <summary> Provides helper methods for interacting with PGP key servers. </summary> </member> <member name="M:PSPGP.KeyServerHelper.DownloadKeyAsync(System.Uri,System.String)"> <summary> Downloads a public key from the specified key server. </summary> <param name="serverUri">Server from which to download the key.</param> <param name="search">Search string identifying the key.</param> <returns>The armored key text.</returns> </member> <member name="M:PSPGP.KeyServerHelper.UploadKeyAsync(System.Uri,System.String)"> <summary> Uploads a public key to the specified key server. </summary> <param name="serverUri">Destination key server.</param> <param name="armoredKey">Armored public key text.</param> <returns>A task representing the asynchronous upload operation.</returns> </member> <member name="T:PSPGP.PathResolver"> <summary> Resolves PowerShell paths to absolute file system paths. </summary> </member> <member name="M:PSPGP.PathResolver.Resolve(System.Management.Automation.PSCmdlet,System.String)"> <summary> Resolves the provided PowerShell path to an absolute path using the session state of the supplied cmdlet. </summary> <param name="cmdlet">Cmdlet whose session state is used for resolution.</param> <param name="path">PowerShell path to resolve.</param> <returns>Absolute file system path.</returns> <exception cref="T:System.ArgumentNullException"> Thrown when <paramref name="cmdlet"/> is <c>null</c>. </exception> </member> <member name="T:PSPGP.PGPConfigurator"> <summary> Applies optional configuration values to a <see cref="T:PgpCore.PGP"/> instance. </summary> <example> <code> var pgp = new PGP(); PGPConfigurator.Configure(pgp, HashAlgorithmTag.Sha256, null, null, null, null, null); </code> </example> </member> <member name="M:PSPGP.PGPConfigurator.Configure(PgpCore.PGP,System.Nullable{Org.BouncyCastle.Bcpg.HashAlgorithmTag},System.Nullable{Org.BouncyCastle.Bcpg.CompressionAlgorithmTag},System.Nullable{PgpCore.Enums.PGPFileType},System.Nullable{System.Int32},System.Nullable{Org.BouncyCastle.Bcpg.PublicKeyAlgorithmTag},System.Nullable{Org.BouncyCastle.Bcpg.SymmetricKeyAlgorithmTag})"> <summary> Sets optional configuration parameters on a <see cref="T:PgpCore.PGP"/> instance. Only values that are provided are applied. </summary> <param name="pgp">Instance to configure.</param> <param name="hashAlgorithm">Hash algorithm for operations.</param> <param name="compressionAlgorithm">Compression algorithm for operations.</param> <param name="fileType">File type for encryption/decryption.</param> <param name="signatureType">Signature type when signing.</param> <param name="publicKeyAlgorithm">Public key algorithm for key creation.</param> <param name="symmetricKeyAlgorithm">Symmetric key algorithm for encryption.</param> </member> <member name="T:PSPGP.PGPInspectInfo"> <summary> Represents the metadata extracted from a PGP message. </summary> </member> <member name="P:PSPGP.PGPInspectInfo.SourcePath"> <summary>Path of the inspected input when applicable.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.IsArmored"> <summary>Indicates whether the message is ASCII armored.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.MessageHeaders"> <summary>Headers found in the armored message.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.Version"> <summary>Version header value when present.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.Comment"> <summary>Comment header value when present.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.IsCompressed"> <summary>Indicates whether the message is compressed.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.IsEncrypted"> <summary>Indicates whether the message is encrypted.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.IsIntegrityProtected"> <summary>Indicates whether the message is integrity protected.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.IsSigned"> <summary>Indicates whether the message is signed.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.SymmetricKeyAlgorithm"> <summary>Symmetric algorithm reported by the message.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.FileName"> <summary>Embedded file name reported by the message.</summary> </member> <member name="P:PSPGP.PGPInspectInfo.ModificationDateTime"> <summary>Embedded modification time reported by the message.</summary> </member> <member name="T:PSPGP.PGPKeyInfo"> <summary> Information about a PGP key file. </summary> </member> <member name="P:PSPGP.PGPKeyInfo.FilePath"> <summary>Path to the inspected key file.</summary> </member> <member name="P:PSPGP.PGPKeyInfo.UserIds"> <summary>User identifiers embedded in the key.</summary> </member> <member name="P:PSPGP.PGPKeyInfo.Algorithm"> <summary>Algorithm used to create the key.</summary> </member> <member name="P:PSPGP.PGPKeyInfo.Expiration"> <summary>Expiration date of the key if specified.</summary> </member> <member name="T:PSPGP.VerificationResult"> <summary> Represents the outcome of a signature verification operation. </summary> </member> <member name="P:PSPGP.VerificationResult.FilePath"> <summary>Path to the file that was verified.</summary> </member> <member name="P:PSPGP.VerificationResult.Status"> <summary>Indicates whether the verification succeeded.</summary> </member> <member name="P:PSPGP.VerificationResult.Error"> <summary>Error message when verification failed.</summary> </member> <member name="P:PSPGP.VerificationResult.Signer"> <summary>Public key used to verify the signature.</summary> </member> <member name="T:OnModuleImportAndRemove"> <summary> Handles module import and removal events to resolve assemblies when running in PowerShell. </summary> </member> <member name="M:OnModuleImportAndRemove.OnImport"> <summary> Invoked when the module is imported. </summary> </member> <member name="M:OnModuleImportAndRemove.OnRemove(System.Management.Automation.PSModuleInfo)"> <summary> Invoked when the module is removed. </summary> <param name="module">Module being removed.</param> </member> <member name="M:OnModuleImportAndRemove.MyResolveEventHandler(System.Object,System.ResolveEventArgs)"> <summary> Resolves assemblies for the module when running under .NET Framework. </summary> <param name="sender">The event source.</param> <param name="args">Arguments describing the assembly to resolve.</param> <returns>The resolved <see cref="T:System.Reflection.Assembly"/> instance, or <c>null</c> if none could be located.</returns> </member> <member name="M:OnModuleImportAndRemove.IsNetFramework"> <summary> Determines whether the current runtime is .NET Framework. </summary> <returns><c>true</c> when running on .NET Framework.</returns> </member> <member name="M:OnModuleImportAndRemove.IsNetCore"> <summary> Determines whether the current runtime is .NET Core. </summary> <returns><c>true</c> when running on .NET Core.</returns> </member> <member name="M:OnModuleImportAndRemove.IsNet5OrHigher"> <summary> Determines whether the current runtime is .NET 5 or higher. </summary> <returns><c>true</c> when running on .NET 5 or higher.</returns> </member> </members> </doc> |