PGPParams Property
Sets the parameters in the OpenPGP provider.
Data Type
StringDefault Value
""Remarks
The PGPParams property is used to specify the parameters required by the OpenPGP provider to perform the OpenPGP operation. Although the parameters needed may vary in different providers, we expect many of the parameters in the following set to be necessary.
Each parameter should be listed on a separate line by itself. The parameters exist in name/value pairs separated by an '=' sign. This may be used to specify all parameters in one location and may also be used to override some component properties.
The following is an example of several parameters that may exist for this property:
homedir=C:\myhomedir passphrase=testpgp signature=nondetached
| asciiarmor | Controls whether or not ASCII armoring is used on the output message.
This will overwrite the value of the ASCIIArmor property. |
| compressionmethod | Specifies which compression method is used when generating output. Possible values are:
This will overwrite the value of the CompressionMethod property. |
| encryptingalgorithm | Specifies the encryption algorithm used when encrypting. Possible values are:
This will overwrite the value of the EncryptingAlgorithm property. |
| gpg-path | The path to the OpenPGP executable for the desired implementation. This parameter is not applicable when PGPProviderType is set to ptInternal. |
| homedir | The directory containing the public keyring, secret keyring and trust database. Please note this
defaults to the application preferences directory of the user, hence if the GNUPG provider is being used
from a ASP.NET application, homedir should be specified.
This will overwrite the value of the HomeDir property. |
| key | The file where the private/secret PGP key is held. If the key is not stored in a file, the ASCII-armored data can be set directly
via the Key property, but the key must be stored in a file to use this field of the PGPParams property.
If the key has been imported to a keyring, the homedir field should be set instead.
This parameter is only applicable when PGPProviderType is set to ptInternal.
This will overwrite the value of the Key property. |
| passphrase | The passphrase to access the secret keys in the secret-keyring.
This will overwrite the value of the Passphrase property. |
| recipientkey | The file where the public PGP key for encryption is held. Only applicable for the PGP Encoder component.
If the key is not stored in a file, the ASCII-armored data can be set directly
via the RecipientKey property, but the key must be stored in a file to use this field of the PGPParams property.
If the key has been imported to a keyring, the homedir field should be set instead.
This parameter is only applicable when PGPProviderType is set to ptInternal.
This will overwrite the value of the RecipientKey property. |
| recipient-userid | The identifier used to select a public key within the public keyring when encrypting.
This will overwrite the value of the RecipientUserId property. |
| recipient-userid[i] | An alternative to recipient-userid that allows for multiple recipients to be specified. Each key would be specified with a different index. For example: recipient-userid[0], recipient-userid[1], etc. |
| signer-userid | The identifier used to select a public key within the public keyring when verifying a signature. |
| signer-userid[i] | An alternative to signer-userid that allows for multiple recipients to be specified. Each key would be specified with a different index. For example: signer-userid[0], signer-userid[1], etc. |
| signerkey | The file where the public PGP key for signature verification is held. Only applicable for the PGP Decoder component.
If the key is not stored in a file, the ASCII-armored data can be set directly
via the RecipientKey property, but the key must be stored in a file to use this field of the PGPParams property.
If the key has been imported to a keyring, the homedir field should be set instead.
This parameter is only applicable when PGPProviderType is set to ptInternal.
This will overwrite the value of the SignerKey property. |
| signingalgorithm | Specifies the signature hash algorithm used when signing. Possible values are:
|
| userid | The identifier used to select a secret key within the secret-keyring; used for both decryption and signing.
This will overwrite the value of the UserId property. |
The task expects the encryption and signing to return an ASCII armored output. Note: GnuPG is the Free Software Foundation's implementation of OpenPGP.
GnuPG is not included with this package, so you should download the latest version from http://www.gnupg.org. You might use GnuPG (or other software) to import your trading partners' public keys, and to import or generate a private key for yourself. These operations are outside the scope of this software, so please see the GnuPG documentation for details.