OpenPGP Component

Properties   Methods   Events   Config Settings   Errors  

The OpenPGP class is used to encrypt/decrypt and sign/verify PGP messages.

Syntax

ipworkspgp.OpenPGP

Remarks

The OpenPGP struct supports encrypting/decrypting and signing/verifying OpenPGP messages. Supported message formats are specified by RFC 4880, in addition to RFC 9580, which introduces support for OpenPGP Version 6.

GnuPG (2.5.x and later) uses its own Version 5 message format (LibrePGP). The struct supports creating and processing LibrePGP-formatted messages as well, for interoperability with GnuPG. See CompatibilityProfile for details on choosing between the two formats.

The Encrypt, Sign, and SignAndEncrypt methods are used to create a message to be sent to your partner. You can additionally create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.

When a message is received, the Decrypt, VerifySignature, and DecryptAndVerifySignature methods are used to process the incoming message.

The Keys property holds the key (with private key) used to sign and decrypt.

The SignerKeys property holds the key used to verify a signature.

The RecipientKeys property holds the key used to encrypt.

Input and Output Properties

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

ASCIIArmor Property (OpenPGP Component)

Specifies whether to use ASCII armor to encode the output message.

Syntax

func (obj *OpenPGP) ASCIIArmor() (bool, error)
func (obj *OpenPGP) SetASCIIArmor(value bool) error

Default Value

false

Remarks

This property controls whether or not ASCII armoring is used on the output message. The default value is False.

Data Type

bool

AutoSelectAlgorithms Property (OpenPGP Component)

Whether to automatically select algorithms when encrypting or signing.

Syntax

func (obj *OpenPGP) AutoSelectAlgorithms() (int32, error)
func (obj *OpenPGP) SetAutoSelectAlgorithms(value int32) error

Default Value

0

Remarks

This property is set to the binary 'OR' of one or more options indicating which algorithms to automatically select.

When enabled automatic selection is performed by examining the preferred algorithms specified by the key.

When Encrypt is called the struct will read the preferred encryption algorithm and compression method from the key specified in the RecipientKey* properties.

If multiple keys are specified the preferred encryption algorithm and compression method from the last key is used. The EncryptingAlgorithm and CompressionMethod properties are ignored.

When Sign is called the struct will read the preferred MAC algorithm and compression method from the private key specified in the Key* properties. If multiple keys are specified the preferred MAC algorithm and compression method from the last key is used. The SigningAlgorithm and CompressionMethod properties are ignored.

The list below defines available options.

The default value is 0 which means algorithms are not automatically selected.

Data Type

int32

ClearSignature Property (OpenPGP Component)

Specifies whether or not to create a cleartext signature.

Syntax

func (obj *OpenPGP) ClearSignature() (bool, error)
func (obj *OpenPGP) SetClearSignature(value bool) error

Default Value

false

Remarks

This property controls whether or not a cleartext signature is created during signing. The default value is False. When set to true a clear text signature will be created when Sign is called.

Data Type

bool

CompressionMethod Property (OpenPGP Component)

The compression algorithm used.

Syntax

func (obj *OpenPGP) CompressionMethod() (string, error)
func (obj *OpenPGP) SetCompressionMethod(value string) error

Default Value

"zip"

Remarks

This property specifies which compression method is used when generating output. Possible values are:

• zip (default)
• zlib
• bzip2
• none or uncompressed

Data Type

string

DetachedSignature Property (OpenPGP Component)

Specifies whether or not to generate a detached signature when signing a message.

Syntax

func (obj *OpenPGP) DetachedSignature() (bool, error)
func (obj *OpenPGP) SetDetachedSignature(value bool) error

Default Value

false

Remarks

This property specifies whether or not a detached signature is created when signing a message. The default value is False.

If set to true the output will only be the signature. The data being signed will not be included in the output. If set to true ClearSignature will be ignored.

When this property is false (default) the signature is not detached. The output will contain both the signed data and the signature.

Data Type

bool

EncryptingAlgorithm Property (OpenPGP Component)

The encryption algorithm used when encrypting.

Syntax

func (obj *OpenPGP) EncryptingAlgorithm() (string, error)
func (obj *OpenPGP) SetEncryptingAlgorithm(value string) error

Default Value

"AES128"

Remarks

This property specifies the encryption algorithm used when encrypting. Possible values are:

• CAST5
• 3DES or TripleDES
• AES256
• AES192
• AES128 (default)
• BLOWFISH
• TWOFISH
• IDEA
• AES256-OCB (AEAD)
• AES192-OCB (AEAD)
• AES128-OCB (AEAD)
• AES256-GCM (AEAD)
• AES192-GCM (AEAD)
• AES128-GCM (AEAD)

Note that for AES256, AES192, and AES128, the struct uses a modified form of CFB mode in accordance with the OpenPGP standard.

Note that if UseArgon2 is enabled, and SymmetricPassphrase is specified, an AEAD encryption algorithm (AES*-OCB and AES*-GCM) must be specified for symmetric encryption. If UseArgon2 is disabled, and an AEAD encryption algorithm is specified, the AEAD mode (OCB or GCM) will be ignored when performing symmetric encryption.

An AEAD encryption algorithm may optionally be utilized when encrypting messages (when calling Encrypt). In this case, the AEADChunkSizeExp configuration will specify the chunk size for splitting plaintext for encryption. Please see AEADChunkSizeExp for additional details.

Data Type

string

InputFile Property (OpenPGP Component)

The file to process.

Syntax

func (obj *OpenPGP) InputFile() (string, error)
func (obj *OpenPGP) SetInputFile(value string) error

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

string

InputMessage Property (OpenPGP Component)

The message to process.

Syntax

func (obj *OpenPGP) InputMessage() ([]byte, error)
func (obj *OpenPGP) SetInputMessage(value []byte) error

Default Value

""

Remarks

This property specifies the message to be processed. Set this property to the OpenPGP message content.

Input and Output Properties

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

[]byte

KeyCount Property (OpenPGP Component)

The number of records in the Key arrays.

Syntax

func (obj *OpenPGP) KeyCount() (int32, error)
func (obj *OpenPGP) SetKeyCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyCurve
• KeyEffectiveDate
• KeyEncoded
• KeyExpirationDate
• KeyFingerprint
• KeyId
• KeyOtherUserIds
• KeyPassphrase
• KeyPublicKey
• KeyPublicKeyAlgorithm
• KeyPublicKeyLength
• KeyRevoked
• Keyring
• KeySecretKey
• KeySecretKeyAvailable
• KeyUsage
• KeyUsageFlags
• KeyUserId
• KeyVersion

The array indices start at 0 and end at KeyCount - 1.

Data Type

int32

KeyCurve Property (OpenPGP Component)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 .

Syntax

func (obj *OpenPGP) KeyCurve(KeyIndex int32) (string, error)

Default Value

""

Remarks

This property specifies the elliptic curve if KeyPublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448. Possible values are:

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyEffectiveDate Property (OpenPGP Component)

The date when this key becomes valid.

Syntax

func (obj *OpenPGP) KeyEffectiveDate(KeyIndex int32) (string, error)

Default Value

""

Remarks

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyExpirationDate Property (OpenPGP Component)

The date the key expires.

Syntax

func (obj *OpenPGP) KeyExpirationDate(KeyIndex int32) (string, error)

Default Value

""

Remarks

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

Keyring Property (OpenPGP Component)

The location of the keyring.

Syntax

func (obj *OpenPGP) Keyring(KeyIndex int32) (string, error)
func (obj *OpenPGP) SetKeyring(KeyIndex int32, value string) error

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the struct will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyOtherUserIds Property (OpenPGP Component)

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

Syntax

func (obj *OpenPGP) KeyOtherUserIds(KeyIndex int32) (string, error)

Default Value

""

Remarks

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyPassphrase Property (OpenPGP Component)

The passphrase for the key's secret key (if any).

Syntax

func (obj *OpenPGP) KeyPassphrase(KeyIndex int32) (string, error)
func (obj *OpenPGP) SetKeyPassphrase(KeyIndex int32, value string) error

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyPublicKey Property (OpenPGP Component)

The public key of the key.

Syntax

func (obj *OpenPGP) KeyPublicKey(KeyIndex int32) (string, error)

Default Value

""

Remarks

The public key of the key. The key is provided as ASCII armored data.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyPublicKeyAlgorithm Property (OpenPGP Component)

A text description of the public key algorithm of the key.

Syntax

func (obj *OpenPGP) KeyPublicKeyAlgorithm(KeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of the public key algorithm of the key. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• ML-DSA-65+Ed25519
• ML-DSA-87+Ed448
• RSA-Legacy

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyPublicKeyLength Property (OpenPGP Component)

The length of the public key in bits.

Syntax

func (obj *OpenPGP) KeyPublicKeyLength(KeyIndex int32) (int32, error)

Default Value

0

Remarks

The length of the public key in bits. Common values are 1024, 2048, and 3072.

If the KeyPublicKeyAlgorithm property is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448, the length of the public key is determined by the KeyCurve. Possible lengths are:

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

int32

KeyRevoked Property (OpenPGP Component)

Whether or not the key is revoked.

Syntax

func (obj *OpenPGP) KeyRevoked(KeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not the key is revoked.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

KeySecretKey Property (OpenPGP Component)

The secret key of the key (if available).

Syntax

func (obj *OpenPGP) KeySecretKey(KeyIndex int32) (string, error)

Default Value

""

Remarks

The secret key of the key (if available). The key is provided as ASCII armored data.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeySecretKeyAvailable Property (OpenPGP Component)

Whether or not a secret key is available for the selected key.

Syntax

func (obj *OpenPGP) KeySecretKeyAvailable(KeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not a secret key is available for the selected key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

KeyUsage Property (OpenPGP Component)

A text description of UsageFlags .

Syntax

func (obj *OpenPGP) KeyUsage(KeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of KeyUsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyUsageFlags Property (OpenPGP Component)

Flags that show the intended use for the key.

Syntax

func (obj *OpenPGP) KeyUsageFlags(KeyIndex int32) (int32, error)

Default Value

47

Remarks

Flags that show the intended use for the key. The default value is 0x0F. The value of KeyUsageFlags is a combination of the following flags:

Please refer to the KeyUsage property for a text representation of KeyUsageFlags.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

int32

KeyVersion Property (OpenPGP Component)

This property can be used to query the OpenPGP version of the currently selected Key .

Syntax

func (obj *OpenPGP) KeyVersion(KeyIndex int32) (int32, error)

Default Value

4

Remarks

This property can be used to query the OpenPGP version of the currently selected Key. Possible values are:

• 4 - OpenPGP v4 (default)
• 5 - LibrePGP v5
• 6 - OpenPGP v6

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

int32

KeyUserId Property (OpenPGP Component)

The user Id of the key.

Syntax

func (obj *OpenPGP) KeyUserId(KeyIndex int32) (string, error)
func (obj *OpenPGP) SetKeyUserId(KeyIndex int32, value string) error

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the struct will search the Keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as its identifier instead.

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The struct will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP struct's RecipientInfo event.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyId Property (OpenPGP Component)

The hex-encoded, 4-byte or 8-byte key Id.

Syntax

func (obj *OpenPGP) KeyId(KeyIndex int32) (string, error)
func (obj *OpenPGP) SetKeyId(KeyIndex int32, value string) error

Default Value

""

Remarks

The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the struct will search the Keyring for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

NOTE: It is recommended to use the KeyFingerprint property when loading a key from the Keyring, as it is possible for different keys to have the same Id.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyFingerprint Property (OpenPGP Component)

The hex-encoded, 20-byte fingerprint of the key.

Syntax

func (obj *OpenPGP) KeyFingerprint(KeyIndex int32) (string, error)
func (obj *OpenPGP) SetKeyFingerprint(KeyIndex int32, value string) error

Default Value

""

Remarks

The hex-encoded, 20-byte fingerprint of the key.

When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the Keyring. When this property is set the struct will search the Keyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyEncoded Property (OpenPGP Component)

The key.

Syntax

func (obj *OpenPGP) KeyEncoded(KeyIndex int32) ([]byte, error)
func (obj *OpenPGP) SetKeyEncoded(KeyIndex int32, value []byte) error

Default Value

""

Remarks

The key. This property can be used to assign a specific key. The KeyFingerprint, KeyId, and KeyUserId properties may also be used to specify a key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

[]byte

MessageHeaderCount Property (OpenPGP Component)

The number of records in the MessageHeader arrays.

Syntax

func (obj *OpenPGP) MessageHeaderCount() (int32, error)
func (obj *OpenPGP) SetMessageHeaderCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

The array indices start at 0 and end at MessageHeaderCount - 1.

Data Type

int32

MessageHeaderField Property (OpenPGP Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

func (obj *OpenPGP) MessageHeaderField(MessageHeaderIndex int32) (string, error)
func (obj *OpenPGP) SetMessageHeaderField(MessageHeaderIndex int32, value string) error

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

Data Type

string

MessageHeaderValue Property (OpenPGP Component)

This property contains the header contents.

Syntax

func (obj *OpenPGP) MessageHeaderValue(MessageHeaderIndex int32) (string, error)
func (obj *OpenPGP) SetMessageHeaderValue(MessageHeaderIndex int32, value string) error

Default Value

""

Remarks

This property contains the Header contents.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

Data Type

string

OutputFile Property (OpenPGP Component)

The output file.

Syntax

func (obj *OpenPGP) OutputFile() (string, error)
func (obj *OpenPGP) SetOutputFile(value string) error

Default Value

""

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Input and Output Properties

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

string

OutputMessage Property (OpenPGP Component)

The output message after processing.

Syntax

func (obj *OpenPGP) OutputMessage() ([]byte, error)
func (obj *OpenPGP) SetOutputMessage(value []byte) error

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

[]byte

Overwrite Property (OpenPGP Component)

Indicates whether or not the class should overwrite files.

Syntax

func (obj *OpenPGP) Overwrite() (bool, error)
func (obj *OpenPGP) SetOverwrite(value bool) error

Default Value

false

Remarks

This property indicates whether or not the struct will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

bool

RecipientKeyCount Property (OpenPGP Component)

The number of records in the RecipientKey arrays.

Syntax

func (obj *OpenPGP) RecipientKeyCount() (int32, error)
func (obj *OpenPGP) SetRecipientKeyCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientKeyCurve
• RecipientKeyEffectiveDate
• RecipientKeyEncoded
• RecipientKeyExpirationDate
• RecipientKeyFingerprint
• RecipientKeyId
• RecipientKeyKeyring
• RecipientKeyOtherUserIds
• RecipientKeyPassphrase
• RecipientKeyPublicKey
• RecipientKeyPublicKeyAlgorithm
• RecipientKeyPublicKeyLength
• RecipientKeyRevoked
• RecipientKeySecretKey
• RecipientKeySecretKeyAvailable
• RecipientKeyUsage
• RecipientKeyUsageFlags
• RecipientKeyUserId
• RecipientKeyVersion

The array indices start at 0 and end at RecipientKeyCount - 1.

Data Type

int32

RecipientKeyCurve Property (OpenPGP Component)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 .

Syntax

func (obj *OpenPGP) RecipientKeyCurve(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

This property specifies the elliptic curve if RecipientKeyPublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448. Possible values are:

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyEffectiveDate Property (OpenPGP Component)

The date when this key becomes valid.

Syntax

func (obj *OpenPGP) RecipientKeyEffectiveDate(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyExpirationDate Property (OpenPGP Component)

The date the key expires.

Syntax

func (obj *OpenPGP) RecipientKeyExpirationDate(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyKeyring Property (OpenPGP Component)

The location of the keyring.

Syntax

func (obj *OpenPGP) RecipientKeyKeyring(RecipientKeyIndex int32) (string, error)
func (obj *OpenPGP) SetRecipientKeyKeyring(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the struct will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyOtherUserIds Property (OpenPGP Component)

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

Syntax

func (obj *OpenPGP) RecipientKeyOtherUserIds(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyPassphrase Property (OpenPGP Component)

The passphrase for the key's secret key (if any).

Syntax

func (obj *OpenPGP) RecipientKeyPassphrase(RecipientKeyIndex int32) (string, error)
func (obj *OpenPGP) SetRecipientKeyPassphrase(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyPublicKey Property (OpenPGP Component)

The public key of the key.

Syntax

func (obj *OpenPGP) RecipientKeyPublicKey(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

The public key of the key. The key is provided as ASCII armored data.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyPublicKeyAlgorithm Property (OpenPGP Component)

A text description of the public key algorithm of the key.

Syntax

func (obj *OpenPGP) RecipientKeyPublicKeyAlgorithm(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of the public key algorithm of the key. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• ML-DSA-65+Ed25519
• ML-DSA-87+Ed448
• RSA-Legacy

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyPublicKeyLength Property (OpenPGP Component)

The length of the public key in bits.

Syntax

func (obj *OpenPGP) RecipientKeyPublicKeyLength(RecipientKeyIndex int32) (int32, error)

Default Value

0

Remarks

The length of the public key in bits. Common values are 1024, 2048, and 3072.

If the RecipientKeyPublicKeyAlgorithm property is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448, the length of the public key is determined by the RecipientKeyCurve. Possible lengths are:

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

int32

RecipientKeyRevoked Property (OpenPGP Component)

Whether or not the key is revoked.

Syntax

func (obj *OpenPGP) RecipientKeyRevoked(RecipientKeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not the key is revoked.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

bool

RecipientKeySecretKey Property (OpenPGP Component)

The secret key of the key (if available).

Syntax

func (obj *OpenPGP) RecipientKeySecretKey(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

The secret key of the key (if available). The key is provided as ASCII armored data.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeySecretKeyAvailable Property (OpenPGP Component)

Whether or not a secret key is available for the selected key.

Syntax

func (obj *OpenPGP) RecipientKeySecretKeyAvailable(RecipientKeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not a secret key is available for the selected key.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

bool

RecipientKeyUsage Property (OpenPGP Component)

A text description of UsageFlags .

Syntax

func (obj *OpenPGP) RecipientKeyUsage(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of RecipientKeyUsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyUsageFlags Property (OpenPGP Component)

Flags that show the intended use for the key.

Syntax

func (obj *OpenPGP) RecipientKeyUsageFlags(RecipientKeyIndex int32) (int32, error)

Default Value

47

Remarks

Flags that show the intended use for the key. The default value is 0x0F. The value of RecipientKeyUsageFlags is a combination of the following flags:

Please refer to the RecipientKeyUsage property for a text representation of RecipientKeyUsageFlags.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

int32

RecipientKeyVersion Property (OpenPGP Component)

This property can be used to query the OpenPGP version of the currently selected Key .

Syntax

func (obj *OpenPGP) RecipientKeyVersion(RecipientKeyIndex int32) (int32, error)

Default Value

4

Remarks

This property can be used to query the OpenPGP version of the currently selected Key. Possible values are:

• 4 - OpenPGP v4 (default)
• 5 - LibrePGP v5
• 6 - OpenPGP v6

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

int32

RecipientKeyUserId Property (OpenPGP Component)

The user Id of the key.

Syntax

func (obj *OpenPGP) RecipientKeyUserId(RecipientKeyIndex int32) (string, error)
func (obj *OpenPGP) SetRecipientKeyUserId(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the RecipientKeyKeyring. When this property is set the struct will search the RecipientKeyKeyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as its identifier instead.

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The struct will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP struct's RecipientInfo event.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyId Property (OpenPGP Component)

The hex-encoded, 4-byte or 8-byte key Id.

Syntax

func (obj *OpenPGP) RecipientKeyId(RecipientKeyIndex int32) (string, error)
func (obj *OpenPGP) SetRecipientKeyId(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the RecipientKeyKeyring. When this property is set the struct will search the RecipientKeyKeyring for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

NOTE: It is recommended to use the RecipientKeyFingerprint property when loading a key from the RecipientKeyKeyring, as it is possible for different keys to have the same Id.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyFingerprint Property (OpenPGP Component)

The hex-encoded, 20-byte fingerprint of the key.

Syntax

func (obj *OpenPGP) RecipientKeyFingerprint(RecipientKeyIndex int32) (string, error)
func (obj *OpenPGP) SetRecipientKeyFingerprint(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The hex-encoded, 20-byte fingerprint of the key.

When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the RecipientKeyKeyring. When this property is set the struct will search the RecipientKeyKeyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyEncoded Property (OpenPGP Component)

The key.

Syntax

func (obj *OpenPGP) RecipientKeyEncoded(RecipientKeyIndex int32) ([]byte, error)
func (obj *OpenPGP) SetRecipientKeyEncoded(RecipientKeyIndex int32, value []byte) error

Default Value

""

Remarks

The key. This property can be used to assign a specific key. The RecipientKeyFingerprint, RecipientKeyId, and RecipientKeyUserId properties may also be used to specify a key.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

[]byte

SignerKeyCount Property (OpenPGP Component)

The number of records in the SignerKey arrays.

Syntax

func (obj *OpenPGP) SignerKeyCount() (int32, error)
func (obj *OpenPGP) SetSignerKeyCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignerKeyCurve
• SignerKeyEffectiveDate
• SignerKeyEncoded
• SignerKeyExpirationDate
• SignerKeyFingerprint
• SignerKeyId
• SignerKeyKeyring
• SignerKeyOtherUserIds
• SignerKeyPassphrase
• SignerKeyPublicKey
• SignerKeyPublicKeyAlgorithm
• SignerKeyPublicKeyLength
• SignerKeyRevoked
• SignerKeySecretKey
• SignerKeySecretKeyAvailable
• SignerKeyUsage
• SignerKeyUsageFlags
• SignerKeyUserId
• SignerKeyVersion

The array indices start at 0 and end at SignerKeyCount - 1.

Data Type

int32

SignerKeyCurve Property (OpenPGP Component)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 .

Syntax

func (obj *OpenPGP) SignerKeyCurve(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

This property specifies the elliptic curve if SignerKeyPublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448. Possible values are:

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeyEffectiveDate Property (OpenPGP Component)

The date when this key becomes valid.

Syntax

func (obj *OpenPGP) SignerKeyEffectiveDate(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeyExpirationDate Property (OpenPGP Component)

The date the key expires.

Syntax

func (obj *OpenPGP) SignerKeyExpirationDate(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeyKeyring Property (OpenPGP Component)

The location of the keyring.

Syntax

func (obj *OpenPGP) SignerKeyKeyring(SignerKeyIndex int32) (string, error)
func (obj *OpenPGP) SetSignerKeyKeyring(SignerKeyIndex int32, value string) error

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the struct will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

string

SignerKeyOtherUserIds Property (OpenPGP Component)

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

Syntax

func (obj *OpenPGP) SignerKeyOtherUserIds(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeyPassphrase Property (OpenPGP Component)

The passphrase for the key's secret key (if any).

Syntax

func (obj *OpenPGP) SignerKeyPassphrase(SignerKeyIndex int32) (string, error)
func (obj *OpenPGP) SetSignerKeyPassphrase(SignerKeyIndex int32, value string) error

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

string

SignerKeyPublicKey Property (OpenPGP Component)

The public key of the key.

Syntax

func (obj *OpenPGP) SignerKeyPublicKey(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

The public key of the key. The key is provided as ASCII armored data.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeyPublicKeyAlgorithm Property (OpenPGP Component)

A text description of the public key algorithm of the key.

Syntax

func (obj *OpenPGP) SignerKeyPublicKeyAlgorithm(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of the public key algorithm of the key. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• ML-DSA-65+Ed25519
• ML-DSA-87+Ed448
• RSA-Legacy

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeyPublicKeyLength Property (OpenPGP Component)

The length of the public key in bits.

Syntax

func (obj *OpenPGP) SignerKeyPublicKeyLength(SignerKeyIndex int32) (int32, error)

Default Value

0

Remarks

The length of the public key in bits. Common values are 1024, 2048, and 3072.

If the SignerKeyPublicKeyAlgorithm property is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448, the length of the public key is determined by the SignerKeyCurve. Possible lengths are:

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

int32

SignerKeyRevoked Property (OpenPGP Component)

Whether or not the key is revoked.

Syntax

func (obj *OpenPGP) SignerKeyRevoked(SignerKeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not the key is revoked.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

bool

SignerKeySecretKey Property (OpenPGP Component)

The secret key of the key (if available).

Syntax

func (obj *OpenPGP) SignerKeySecretKey(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

The secret key of the key (if available). The key is provided as ASCII armored data.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeySecretKeyAvailable Property (OpenPGP Component)

Whether or not a secret key is available for the selected key.

Syntax

func (obj *OpenPGP) SignerKeySecretKeyAvailable(SignerKeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not a secret key is available for the selected key.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

bool

SignerKeyUsage Property (OpenPGP Component)

A text description of UsageFlags .

Syntax

func (obj *OpenPGP) SignerKeyUsage(SignerKeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of SignerKeyUsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

string

SignerKeyUsageFlags Property (OpenPGP Component)

Flags that show the intended use for the key.

Syntax

func (obj *OpenPGP) SignerKeyUsageFlags(SignerKeyIndex int32) (int32, error)

Default Value

47

Remarks

Flags that show the intended use for the key. The default value is 0x0F. The value of SignerKeyUsageFlags is a combination of the following flags:

Please refer to the SignerKeyUsage property for a text representation of SignerKeyUsageFlags.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

int32

SignerKeyVersion Property (OpenPGP Component)

This property can be used to query the OpenPGP version of the currently selected Key .

Syntax

func (obj *OpenPGP) SignerKeyVersion(SignerKeyIndex int32) (int32, error)

Default Value

4

Remarks

This property can be used to query the OpenPGP version of the currently selected Key. Possible values are:

• 4 - OpenPGP v4 (default)
• 5 - LibrePGP v5
• 6 - OpenPGP v6

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

int32

SignerKeyUserId Property (OpenPGP Component)

The user Id of the key.

Syntax

func (obj *OpenPGP) SignerKeyUserId(SignerKeyIndex int32) (string, error)
func (obj *OpenPGP) SetSignerKeyUserId(SignerKeyIndex int32, value string) error

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the SignerKeyKeyring. When this property is set the struct will search the SignerKeyKeyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as its identifier instead.

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The struct will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP struct's RecipientInfo event.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

string

SignerKeyId Property (OpenPGP Component)

The hex-encoded, 4-byte or 8-byte key Id.

Syntax

func (obj *OpenPGP) SignerKeyId(SignerKeyIndex int32) (string, error)
func (obj *OpenPGP) SetSignerKeyId(SignerKeyIndex int32, value string) error

Default Value

""

Remarks

The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the SignerKeyKeyring. When this property is set the struct will search the SignerKeyKeyring for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

NOTE: It is recommended to use the SignerKeyFingerprint property when loading a key from the SignerKeyKeyring, as it is possible for different keys to have the same Id.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

string

SignerKeyFingerprint Property (OpenPGP Component)

The hex-encoded, 20-byte fingerprint of the key.

Syntax

func (obj *OpenPGP) SignerKeyFingerprint(SignerKeyIndex int32) (string, error)
func (obj *OpenPGP) SetSignerKeyFingerprint(SignerKeyIndex int32, value string) error

Default Value

""

Remarks

The hex-encoded, 20-byte fingerprint of the key.

When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the SignerKeyKeyring. When this property is set the struct will search the SignerKeyKeyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

string

SignerKeyEncoded Property (OpenPGP Component)

The key.

Syntax

func (obj *OpenPGP) SignerKeyEncoded(SignerKeyIndex int32) ([]byte, error)
func (obj *OpenPGP) SetSignerKeyEncoded(SignerKeyIndex int32, value []byte) error

Default Value

""

Remarks

The key. This property can be used to assign a specific key. The SignerKeyFingerprint, SignerKeyId, and SignerKeyUserId properties may also be used to specify a key.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

[]byte

SigningAlgorithm Property (OpenPGP Component)

The signature hash algorithm used when signing.

Syntax

func (obj *OpenPGP) SigningAlgorithm() (string, error)
func (obj *OpenPGP) SetSigningAlgorithm(value string) error

Default Value

"SHA256"

Remarks

This property specifies the signature hash algorithm used when signing. Possible values are:

• SHA1
• MD5
• SHA256 (default)
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

Data Type

string

Config Method (OpenPGP Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *OpenPGP) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (OpenPGP Component)

Decrypts the message.

Syntax

func (obj *OpenPGP) Decrypt() error

Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in Keys. Before decryption begins the struct will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

DecryptAndVerifySignature Method (OpenPGP Component)

Decrypts and verifies the signature of the message.

Syntax

func (obj *OpenPGP) DecryptAndVerifySignature() error

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.

This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the struct will perform the decryption without error.

The message will be decrypted using the keys specified in Keys. Before decryption begins the struct will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

The message will be verified using the keys specified in SignerKeys. Before verification begins the struct will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the struct fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

NOTE: This method does not attempt to check the validity of the signing key itself.

Encrypt Method (OpenPGP Component)

Encrypts the message.

Syntax

func (obj *OpenPGP) Encrypt() error

Remarks

This method encrypts the specified message.

The message is encrypted with the public keys specified in RecipientKeys.

When encrypting, the following properties may be used to further configure the struct:

• ASCIIArmor
• CompressionMethod
• EncryptingAlgorithm

Additionally, CompatibilityProfile may be set to control whether the encrypted message uses RFC 9580 or GnuPG's LibrePGP format; see CompatibilityProfile for details.

GetRecipientInfo Method (OpenPGP Component)

Gets recipient information for an encrypted message.

Syntax

func (obj *OpenPGP) GetRecipientInfo() error

Remarks

This method will fire a RecipientInfo event for every recipient key for which the message has been encrypted. The event will provide the KeyId and Fingerprint, which can be used to identify the correct key to be used for decryption.

Interrupt Method (OpenPGP Component)

Interrupt the current method.

Syntax

func (obj *OpenPGP) Interrupt() error

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Reset Method (OpenPGP Component)

Resets the class properties.

Syntax

func (obj *OpenPGP) Reset() error

Remarks

This method resets all message and key properties to their default values.

Sign Method (OpenPGP Component)

Signs the message.

Syntax

func (obj *OpenPGP) Sign() error

Remarks

This method signs the specified message.

The message is signed with the private key specified in the Key* properties.

When signing, the following properties may be used to further configure the struct:

• ASCIIArmor
• ClearSignature
• DetachedSignature
• SigningAlgorithm

Additionally, CompatibilityProfile may be set to control whether the signature uses RFC 9580 or GnuPG's LibrePGP format; see CompatibilityProfile for details.

SignAndEncrypt Method (OpenPGP Component)

Signs and encrypts the current message.

Syntax

func (obj *OpenPGP) SignAndEncrypt() error

Remarks

This method signs and encrypts the specified message.

The message is encrypted with the public keys specified in RecipientKeys and signed with the private key specified in Keys.

When encrypting, the following properties may be used to further configure the struct:

• ASCIIArmor
• CompressionMethod
• EncryptingAlgorithm

Additionally, CompatibilityProfile may be set to control whether the encrypted message uses RFC 9580 or GnuPG's LibrePGP format; see CompatibilityProfile for details.

When signing, the following properties may be used to further configure the struct:

• ASCIIArmor
• ClearSignature
• DetachedSignature
• SigningAlgorithm

Additionally, CompatibilityProfile may be set to control whether the signature uses RFC 9580 or GnuPG's LibrePGP format; see CompatibilityProfile for details.

VerifySignature Method (OpenPGP Component)

Verifies the signature of the current message.

Syntax

func (obj *OpenPGP) VerifySignature() error

Remarks

This method verifies the signature of the message.

The message will be verified using the keys specified in SignerKeys. Before verification begins the struct will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the struct fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

Error Event (OpenPGP Component)

Fired when information is available about errors during data delivery.

Syntax

// OpenPGPErrorEventArgs carries the OpenPGP Error event's parameters.
type OpenPGPErrorEventArgs struct {...}

func (args *OpenPGPErrorEventArgs) ErrorCode() int32
func (args *OpenPGPErrorEventArgs) Description() string
// OpenPGPErrorEvent defines the signature of the OpenPGP Error event's handler function.
type OpenPGPErrorEvent func(sender *OpenPGP, args *OpenPGPErrorEventArgs)

func (obj *OpenPGP) GetOnErrorHandler() OpenPGPErrorEvent
func (obj *OpenPGP) SetOnErrorHandler(handlerFunc OpenPGPErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

KeyPassphrase Event (OpenPGP Component)

Fired if the passphrase of current key is incorrect or empty.

Syntax

// OpenPGPKeyPassphraseEventArgs carries the OpenPGP KeyPassphrase event's parameters.
type OpenPGPKeyPassphraseEventArgs struct {...}

func (args *OpenPGPKeyPassphraseEventArgs) UserId() string
func (args *OpenPGPKeyPassphraseEventArgs) KeyId() string
func (args *OpenPGPKeyPassphraseEventArgs) Fingerprint() string
func (args *OpenPGPKeyPassphraseEventArgs) Passphrase() string
func (args *OpenPGPKeyPassphraseEventArgs) SetPassphrase(value string)

// OpenPGPKeyPassphraseEvent defines the signature of the OpenPGP KeyPassphrase event's handler function.
type OpenPGPKeyPassphraseEvent func(sender *OpenPGP, args *OpenPGPKeyPassphraseEventArgs)

func (obj *OpenPGP) GetOnKeyPassphraseHandler() OpenPGPKeyPassphraseEvent
func (obj *OpenPGP) SetOnKeyPassphraseHandler(handlerFunc OpenPGPKeyPassphraseEvent)

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the KeyPassphrase property before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

UserId holds the user Id of the key the passphrase is required for.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as its identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Progress Event (OpenPGP Component)

Fired as progress is made.

Syntax

// OpenPGPProgressEventArgs carries the OpenPGP Progress event's parameters.
type OpenPGPProgressEventArgs struct {...}

func (args *OpenPGPProgressEventArgs) BytesProcessed() int64
func (args *OpenPGPProgressEventArgs) PercentProcessed() int32
func (args *OpenPGPProgressEventArgs) Operation() int32
func (args *OpenPGPProgressEventArgs) IsEOF() bool
func (args *OpenPGPProgressEventArgs) SetIsEOF(value bool)

// OpenPGPProgressEvent defines the signature of the OpenPGP Progress event's handler function.
type OpenPGPProgressEvent func(sender *OpenPGP, args *OpenPGPProgressEventArgs)

func (obj *OpenPGP) GetOnProgressHandler() OpenPGPProgressEvent
func (obj *OpenPGP) SetOnProgressHandler(handlerFunc OpenPGPProgressEvent)

Remarks

This event is fired automatically as data is processed by the struct.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:

The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the struct. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

RecipientInfo Event (OpenPGP Component)

Fired for each recipient key of the encrypted message.

Syntax

// OpenPGPRecipientInfoEventArgs carries the OpenPGP RecipientInfo event's parameters.
type OpenPGPRecipientInfoEventArgs struct {...}

func (args *OpenPGPRecipientInfoEventArgs) KeyId() string
func (args *OpenPGPRecipientInfoEventArgs) Fingerprint() string
func (args *OpenPGPRecipientInfoEventArgs) PublicKeyAlgorithm() string
// OpenPGPRecipientInfoEvent defines the signature of the OpenPGP RecipientInfo event's handler function.
type OpenPGPRecipientInfoEvent func(sender *OpenPGP, args *OpenPGPRecipientInfoEventArgs)

func (obj *OpenPGP) GetOnRecipientInfoHandler() OpenPGPRecipientInfoEvent
func (obj *OpenPGP) SetOnRecipientInfoHandler(handlerFunc OpenPGPRecipientInfoEvent)

Remarks

This event fires when the Decrypt or DecryptAndVerifySignature method is called.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the Key* properties. The Key* properties can be set from within this event as this event fires directly before the decryption process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

PublicKeyAlgorithm is the algorithm of the public key used to encrypt the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)
• ML-KEM (Subkeys only; LibrePGP/GnuPG)
• ML-KEM-768+X25519 (Subkeys only)
• ML-KEM-1024+X448 (Subkeys only)

SignatureInfo Event (OpenPGP Component)

Fired during verification of the signed message.

Syntax

// OpenPGPSignatureInfoEventArgs carries the OpenPGP SignatureInfo event's parameters.
type OpenPGPSignatureInfoEventArgs struct {...}

func (args *OpenPGPSignatureInfoEventArgs) KeyId() string
func (args *OpenPGPSignatureInfoEventArgs) Fingerprint() string
func (args *OpenPGPSignatureInfoEventArgs) SigningAlgorithm() string
func (args *OpenPGPSignatureInfoEventArgs) PublicKeyAlgorithm() string
// OpenPGPSignatureInfoEvent defines the signature of the OpenPGP SignatureInfo event's handler function.
type OpenPGPSignatureInfoEvent func(sender *OpenPGP, args *OpenPGPSignatureInfoEventArgs)

func (obj *OpenPGP) GetOnSignatureInfoHandler() OpenPGPSignatureInfoEvent
func (obj *OpenPGP) SetOnSignatureInfoHandler(handlerFunc OpenPGPSignatureInfoEvent)

Remarks

This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the SignerKey* properties. The SignerKey* properties can be set from within this event as this event fires directly before the verification process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:

• SHA1
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ML-DSA-65+Ed25519
• ML-DSA-87+Ed448
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

Status Event (OpenPGP Component)

Shows the progress of the operation.

Syntax

// OpenPGPStatusEventArgs carries the OpenPGP Status event's parameters.
type OpenPGPStatusEventArgs struct {...}

func (args *OpenPGPStatusEventArgs) Message() string
// OpenPGPStatusEvent defines the signature of the OpenPGP Status event's handler function.
type OpenPGPStatusEvent func(sender *OpenPGP, args *OpenPGPStatusEventArgs)

func (obj *OpenPGP) GetOnStatusHandler() OpenPGPStatusEvent
func (obj *OpenPGP) SetOnStatusHandler(handlerFunc OpenPGPStatusEvent)

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

VerificationStatus Event (OpenPGP Component)

Fired after verification of the signed message.

Syntax

// OpenPGPVerificationStatusEventArgs carries the OpenPGP VerificationStatus event's parameters.
type OpenPGPVerificationStatusEventArgs struct {...}

func (args *OpenPGPVerificationStatusEventArgs) KeyId() string
func (args *OpenPGPVerificationStatusEventArgs) Fingerprint() string
func (args *OpenPGPVerificationStatusEventArgs) Status() int32
// OpenPGPVerificationStatusEvent defines the signature of the OpenPGP VerificationStatus event's handler function.
type OpenPGPVerificationStatusEvent func(sender *OpenPGP, args *OpenPGPVerificationStatusEventArgs)

func (obj *OpenPGP) GetOnVerificationStatusHandler() OpenPGPVerificationStatusEvent
func (obj *OpenPGP) SetOnVerificationStatusHandler(handlerFunc OpenPGPVerificationStatusEvent)

Remarks

This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Status holds the result of the operation. Possible values are:

Config Settings (OpenPGP Component)

OpenPGP Config Settings

89011C04000102000605025100459B000A0910E2...

5E70662EA810E768

Base Config Settings

Trappable Errors (OpenPGP Component)

OpenPGP Errors