PGPKeyManager Component
Properties Methods Events Config Settings Errors
The PGPKeyManager class manages individual PGP keys.
Syntax
secureblackbox.PGPKeyManager
Remarks
PGPKeyManager provides means for generating, checking, and editing individual PGP keys.
PGPKeyManager can work with RSA, Elgamal (DH), ECDSA, DSS, and EdDSA keypairs with or without subkeys. Public and private PGP keys of versions 2, 3, 4, 5, and 6 are supported.
Note: if you are looking to work with multi-key files ('keyrings'), please see the PGPKeyring component instead. PGPKeyManager works with individual PGP key structures ('key trees' - one primary key with subkeys). For that same reason, consider using PGPKeyring for loading keys that are to be used with PGPWriter and PGPReader for signing or encryption. It is often the case that even allegedly single-key files actually contain more than one key tree, which may lead to key material loss if they are loaded into PGPKeyManager.
Or, putting it in a simple way:
- Use PGPKeyManager if you need to alter a key (e.g. generate, add or remove subkeys, revoke, re-sign, change password).
- Where you need to use an existing key (e.g. for signing), use PGPKeyring, even if it is a standalone key.
- To alter a key residing in a keyring, load the keyring files into PGPKeyring first. The assign the key in question to PGPKeyManager, make the necessary changes, return it back to the keyring, and re-save the keyring.
You can load keys into a PGPKeyManager object in one of the following ways:
- By loading it from a file or memory using ImportFromFile or ImportBytes methods.
- By importing it from a PGPKeyring object using ImportPinned method.
- By generating it using GeneratePair or CreateKey methods.
Mgr.ImportFromFile("key.pub");
Once you have the key loaded in your PGPKeyManager object, you can perform a variety of operations on it:
- Iterate over elements of the key tree using Subkeys, Signatures, and Users collections.
- Add new subkeys to it using CreateSubkey method. Note that your new subkey is unlikely to be accepted elsewhere unless you sign it.
- Add new user records to the key with CreateUser method.
- Signing keys, subkeys, and user records (existing or new) with this or another private key using SignKey, SignSubkey, and SignUser methods. The new signatures are added to the key tree.
- Remove or revoke existing subkeys, user records, and signatures.
- Change the key protection level or password.
Note: Use pinning to copy keys between PGPKeyring and PGPKeyManager:
Keyring.PinnedKey = Mgr.Key;
Keyring.ImportPinned();
Mgr.PinnedKey = Keyring.SelectedKeys[i];
Mgr.ImportPinned();
Once your work with the key tree has completed, save it to a buffer or file using ExportBytes and ExportToFile methods.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| KeyBitsInKey | Indicates the key length in bits. |
| KeyCanEncrypt | Returns True if this key can be used for encryption. |
| KeyCanSign | Returns True if this key can be used for signing. |
| KeyCurve | Indicates the elliptic curve associated with a EC key. |
| KeyEnabled | Enables or disables this key for use in encryption or signing operation. |
| KeyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
| KeyIsPublic | Returns True if this key is a public key, and False otherwise. |
| KeyIsSecret | Returns True if this key is a secret key, and False otherwise. |
| KeyIsSubkey | Returns True if this key is a subkey of another key, and False otherwise. |
| KeyFP | The 20-byte fingerprint (hash value) of this key. |
| KeyID | Contains a 8-byte key identifier. |
| KeyPassphrase | The key protection password. |
| KeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
| KeyPrimaryKeyID | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
| KeyProtection | Specifies the level of protection applied to the secret key. |
| KeyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
| KeyQBits | The length of the DSA Q (legitimate range: 160-512). |
| KeyTimestamp | Use this property to check the time the key was generated. |
| KeyUsername | Specifies the name of the user bound to this key. |
| KeyValidTo | Provide accurate expiration moment indication. |
| KeyVersion | Indicates the key version. |
| PinnedKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SignatureCount | The number of records in the Signature arrays. |
| SignatureCertificationType | Specifies the type of a UserID signature. |
| SignatureCreationTime | The time when the signature was created, in Universal Coordinated Time (UTC). |
| SignatureExpirationTime | Specifies signature expiration time, in seconds since its creation time (CreationTime). |
| SignatureExportable | Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer. |
| SignatureHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SignatureHashAlgorithm | Specifies the hash algorithm used in the signature. |
| SignatureHashMark | Returns the hash mark attribute of a signature. |
| SignatureKeyExpirationTime | The number of seconds after which the signed key will expire. |
| SignatureKeyFlags | Returns the key flags included in the signature. |
| SignatureLegacyFormat | Indicates whether signature uses PGP 2. |
| SignaturePolicyURL | Contains the URL of the signature policy. |
| SignaturePreferredAlgorithms | Contains a list of algorithms preferred by the signed key holder. |
| SignaturePrimaryUserID | Indicates whether the UserID covered by the signature is the main user id for this key. |
| SignatureReasonForRevocation | Describes the reason why the key or the certificate was revoked. |
| SignatureRevocable | Specifies whether the signature can be revoked. |
| SignatureRevocation | Indicates whether or not the signature is a revocation signature. |
| SignatureClass | Indicates the signature class. |
| SignatureSignerKeyID | Indicates the KeyID of the signing key. |
| SignatureSignerUserID | Indicates the UserID associated with the signing key. |
| SignatureStrictlyValid | Returns True if this signature is valid in a strict way (no compatibility relaxations). |
| SignatureTarget | Indicates the KeyID or Username of the target key or user. |
| SignatureTextSignature | Indicates whether or not the signature is made over a text document. |
| SignatureTrustAmount | Specifies the amount of trust assigned by this signature. |
| SignatureTrustLevel | The trust level assigned by this signature. |
| SignatureValidated | Whether the signature has been validated. |
| SignatureValidity | Provides the validity status of the signature if the signature has been validated. |
| SignatureVersion | Indicates the signature version. |
| SigningKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SubkeyCount | The number of records in the Subkey arrays. |
| SubkeyBitsInKey | Indicates the key length in bits. |
| SubkeyCanEncrypt | Returns True if this key can be used for encryption. |
| SubkeyCanSign | Returns True if this key can be used for signing. |
| SubkeyCurve | Indicates the elliptic curve associated with a EC key. |
| SubkeyEnabled | Enables or disables this key for use in encryption or signing operation. |
| SubkeyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
| SubkeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SubkeyIsPublic | Returns True if this key is a public key, and False otherwise. |
| SubkeyIsSecret | Returns True if this key is a secret key, and False otherwise. |
| SubkeyIsSubkey | Returns True if this key is a subkey of another key, and False otherwise. |
| SubkeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
| SubkeyKeyID | Contains a 8-byte key identifier. |
| SubkeyPassphrase | The key protection password. |
| SubkeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
| SubkeyPrimaryKeyID | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
| SubkeyProtection | Specifies the level of protection applied to the secret key. |
| SubkeyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
| SubkeyQBits | The length of the DSA Q (legitimate range: 160-512). |
| SubkeyTimestamp | Use this property to check the time the key was generated. |
| SubkeyUsername | Specifies the name of the user bound to this key. |
| SubkeyValidTo | Provide accurate expiration moment indication. |
| SubkeyVersion | Indicates the key version. |
| UserCount | The number of records in the User arrays. |
| UserHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| Username | Specifies the user name of user. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| ChangePassphrase | Changes the password of the secret key. |
| ChangeProtection | Changes the protection level of the secret key. |
| CheckPassphrase | Checks if the password matches the secret key. |
| Config | Sets or retrieves a configuration setting. |
| CreateKey | Generates a new key. |
| CreateSubkey | Generates a new subkey. |
| CreateUser | Adds a user to an existing key. |
| DoAction | Performs an additional action. |
| ExportBytes | Serializes the key to a byte array. |
| ExportToFile | Exports the key to a file. |
| GeneratePair | Generates a new pair of PGP keys. |
| ImportBytes | Loads a key from a byte array. |
| ImportFromFile | Loads a key from a file. |
| ImportPinned | Loads a key from a pinned key object. |
| RemoveSignature | Unbinds the specified signature from the key, subkey or user. |
| RemoveSubkey | Removes the specified subkey from the key. |
| RemoveUser | Unbinds the specified user from the key. |
| Reset | Creates a new empty keyring. |
| RevokeKey | Revokes the key. |
| RevokeSubkey | Revokes the key's subkey. |
| RevokeUser | Revokes a user certification. |
| SignKey | Sign the key. |
| SignSubkey | Sign the key's subkey. |
| SignUser | Creates a user certification. |
| Verify | Verifies the integrity of a key signature. |
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.
| Error | Information about errors during PGP key management. |
| KeyPassphraseNeeded | Requests a key protection password from the application. |
| Notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| Armor | Enables or disables ASCII armouring. |
| ArmorBoundary | Specifies the armour boundary/title. |
| ArmorHeaders | Specifies armour headers. |
| HashAlgorithm | The hash algorithm to use with the operation, when not accepted via a parameter. |
| KeyFlags | Specifies key flags for user certification signatures. |
| KeyHashAlgorithm | The hash algorithm associated with the key. |
| PreferredAlgs | Specifies preferred algorithms for user certification signatures. |
| RawKeyFormat | Specifies whether low-level key format should be used as input or output of an operation. |
| RespectKeyUsage | Enables policy-based key usage checks. |
| SaveKeyTrust | Tells the class to include the trust packets with the serialized keys. |
| SaveSecretKeySignatures | Enforces saving of signature packets to the secret keyring file. |
| SignatureCreationTime | Indicates the signature creation time. |
| SignatureExpirationTime | Returns or sets the signature expiration time. |
| SignatureHashAlgorithm | The hash algorithm of the signature. |
| SubkeyIndex | Allows to select a specific subkey for certain operations. |
| UseLongKeyIDs | Use full-length KeyID format. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| EnableSSHMLKEM | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| EnableTLSMLKEM | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
KeyBitsInKey Property (PGPKeyManager Component)
Indicates the key length in bits.
Syntax
func (obj *PGPKeyManager) KeyBitsInKey() (int32, error)
Default Value
2048
Remarks
Indicates the key length in bits.
This property is read-only.
Data Type
int32
KeyCanEncrypt Property (PGPKeyManager Component)
Returns True if this key can be used for encryption.
Syntax
func (obj *PGPKeyManager) KeyCanEncrypt() (bool, error)
Default Value
false
Remarks
Returns True if this key can be used for encryption.
This property is read-only.
Data Type
bool
KeyCanSign Property (PGPKeyManager Component)
Returns True if this key can be used for signing.
Syntax
func (obj *PGPKeyManager) KeyCanSign() (bool, error)
Default Value
false
Remarks
Returns True if this key can be used for signing.
This property is read-only.
Data Type
bool
KeyCurve Property (PGPKeyManager Component)
Indicates the elliptic curve associated with a EC key.
Syntax
func (obj *PGPKeyManager) KeyCurve() (string, error)
Default Value
""
Remarks
Indicates the elliptic curve associated with a EC key.
Supported values:
| SB_PGP_CURVE_P256 | P256 | |
| SB_PGP_CURVE_P384 | P384 | |
| SB_PGP_CURVE_P521 | P521 | |
| SB_PGP_CURVE_ED25519 | ED25519 | |
| SB_PGP_CURVE_CURVE25519 | CURVE25519 | |
| SB_PGP_CURVE_BRAINPOOLP256R1 | BRAINPOOLP256 | |
| SB_PGP_CURVE_BRAINPOOLP512R1 | BRAINPOOLP512 |
This property is read-only.
Data Type
string
KeyEnabled Property (PGPKeyManager Component)
Enables or disables this key for use in encryption or signing operation.
Syntax
func (obj *PGPKeyManager) KeyEnabled() (bool, error)
func (obj *PGPKeyManager) SetKeyEnabled(value bool) error
Default Value
false
Remarks
Enables or disables this key for use in encryption or signing operation.
Data Type
bool
KeyEncryptionAlgorithm Property (PGPKeyManager Component)
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
func (obj *PGPKeyManager) KeyEncryptionAlgorithm() (string, error)
Default Value
"AES128"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
This property is read-only.
Data Type
string
KeyIsPublic Property (PGPKeyManager Component)
Returns True if this key is a public key, and False otherwise.
Syntax
func (obj *PGPKeyManager) KeyIsPublic() (bool, error)
Default Value
false
Remarks
Returns True if this key is a public key, and False otherwise.
This property is read-only.
Data Type
bool
KeyIsSecret Property (PGPKeyManager Component)
Returns True if this key is a secret key, and False otherwise.
Syntax
func (obj *PGPKeyManager) KeyIsSecret() (bool, error)
Default Value
false
Remarks
Returns True if this key is a secret key, and False otherwise.
This property is read-only.
Data Type
bool
KeyIsSubkey Property (PGPKeyManager Component)
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
func (obj *PGPKeyManager) KeyIsSubkey() (bool, error)
Default Value
false
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
This property is read-only.
Data Type
bool
KeyFP Property (PGPKeyManager Component)
The 20-byte fingerprint (hash value) of this key.
Syntax
func (obj *PGPKeyManager) KeyFP() (string, error)
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
This property is read-only.
Data Type
string
KeyID Property (PGPKeyManager Component)
Contains a 8-byte key identifier.
Syntax
func (obj *PGPKeyManager) KeyID() (string, error)
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
This property is read-only.
Data Type
string
KeyPassphrase Property (PGPKeyManager Component)
The key protection password.
Syntax
func (obj *PGPKeyManager) KeyPassphrase() (string, error)
func (obj *PGPKeyManager) SetKeyPassphrase(value string) error
Default Value
""
Remarks
The key protection password.
Data Type
string
KeyPassphraseValid Property (PGPKeyManager Component)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
func (obj *PGPKeyManager) KeyPassphraseValid() (bool, error)
Default Value
false
Remarks
Use this property to check whether the specified KeyPassphrase is valid and can be used to unlock the secret key.
This property is read-only.
Data Type
bool
KeyPrimaryKeyID Property (PGPKeyManager Component)
If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
Syntax
func (obj *PGPKeyManager) KeyPrimaryKeyID() (string, error)
Default Value
""
Remarks
If this key is a subkey (KeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.
This property is read-only.
Data Type
string
KeyProtection Property (PGPKeyManager Component)
Specifies the level of protection applied to the secret key.
Syntax
func (obj *PGPKeyManager) KeyProtection() (int32, error)
Possible Values
0 // None
1 // Low
2 // Normal
3 // High
Default Value
0
Remarks
Specifies the level of protection applied to the secret key.
Allowed values:
| pptNone | 0 | Key is not encrypted |
| pptLow | 1 | Only the password hash is used to derive the secret key |
| pptNormal | 2 | Password hash with salt is used to derive the secret key |
| pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation |
This property is read-only.
Data Type
int32
KeyPublicKeyAlgorithm Property (PGPKeyManager Component)
Specifies the asymmetric algorithm of the key.
Syntax
func (obj *PGPKeyManager) KeyPublicKeyAlgorithm() (string, error)
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
This property is read-only.
Data Type
string
KeyQBits Property (PGPKeyManager Component)
The length of the DSA Q (legitimate range: 160-512).
Syntax
func (obj *PGPKeyManager) KeyQBits() (int32, error)
Default Value
0
Remarks
The length of the DSA Q (legitimate range: 160-512).
This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.
This property is read-only.
Data Type
int32
KeyTimestamp Property (PGPKeyManager Component)
Use this property to check the time the key was generated.
Syntax
func (obj *PGPKeyManager) KeyTimestamp() (string, error)
Default Value
""
Remarks
Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).
This property is read-only.
Data Type
string
KeyUsername Property (PGPKeyManager Component)
Specifies the name of the user bound to this key.
Syntax
func (obj *PGPKeyManager) KeyUsername() (string, error)
Default Value
""
Remarks
Specifies the name of the user bound to this key.
The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.
This property is read-only.
Data Type
string
KeyValidTo Property (PGPKeyManager Component)
Provide accurate expiration moment indication.
Syntax
func (obj *PGPKeyManager) KeyValidTo() (string, error)
Default Value
"0"
Remarks
Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.
This property is read-only.
Data Type
string
KeyVersion Property (PGPKeyManager Component)
Indicates the key version.
Syntax
func (obj *PGPKeyManager) KeyVersion() (int32, error)
Default Value
0
Remarks
Indicates the key version.
The key version refers to the version of the public-key packet format as defined in RFC 4880.
Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6.
This property is read-only.
Data Type
int32
PinnedKeyHandle Property (PGPKeyManager Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *PGPKeyManager) PinnedKeyHandle() (int64, error)
func (obj *PGPKeyManager) SetPinnedKeyHandle(value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
SignatureCount Property (PGPKeyManager Component)
The number of records in the Signature arrays.
Syntax
func (obj *PGPKeyManager) SignatureCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignatureCertificationType
- SignatureClass
- SignatureCreationTime
- SignatureExpirationTime
- SignatureExportable
- SignatureHandle
- SignatureHashAlgorithm
- SignatureHashMark
- SignatureKeyExpirationTime
- SignatureKeyFlags
- SignatureLegacyFormat
- SignaturePolicyURL
- SignaturePreferredAlgorithms
- SignaturePrimaryUserID
- SignatureReasonForRevocation
- SignatureRevocable
- SignatureRevocation
- SignatureSignerKeyID
- SignatureSignerUserID
- SignatureStrictlyValid
- SignatureTarget
- SignatureTextSignature
- SignatureTrustAmount
- SignatureTrustLevel
- SignatureValidated
- SignatureValidity
- SignatureVersion
This property is read-only.
Data Type
int32
SignatureCertificationType Property (PGPKeyManager Component)
Specifies the type of a UserID signature.
Syntax
func (obj *PGPKeyManager) SignatureCertificationType(SignatureIndex int32) (int32, error)
Possible Values
0 // Generic
1 // Persona
2 // Casual
3 // Positive
Default Value
0
Remarks
Specifies the type of a UserID signature.
| pctGeneric | 0 | Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type. |
| pctPersona | 1 | Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID. |
| pctCasual | 2 | Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity. |
| pctPositive | 3 | Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity. |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureCreationTime Property (PGPKeyManager Component)
The time when the signature was created, in Universal Coordinated Time (UTC).
Syntax
func (obj *PGPKeyManager) SignatureCreationTime(SignatureIndex int32) (string, error)
Default Value
""
Remarks
The time when the signature was created, in Universal Coordinated Time (UTC).
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignatureExpirationTime Property (PGPKeyManager Component)
Specifies signature expiration time, in seconds since its creation time (CreationTime).
Syntax
func (obj *PGPKeyManager) SignatureExpirationTime(SignatureIndex int32) (int32, error)
Default Value
0
Remarks
Specifies signature expiration time, in seconds since its creation time (CreationTime).
This property set to 0 indicates that the signature never expires.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureExportable Property (PGPKeyManager Component)
Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
Syntax
func (obj *PGPKeyManager) SignatureExportable(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignatureHandle Property (PGPKeyManager Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *PGPKeyManager) SignatureHandle(SignatureIndex int32) (int64, error)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int64
SignatureHashAlgorithm Property (PGPKeyManager Component)
Specifies the hash algorithm used in the signature.
Syntax
func (obj *PGPKeyManager) SignatureHashAlgorithm(SignatureIndex int32) (string, error)
Default Value
""
Remarks
Specifies the hash algorithm used in the signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignatureHashMark Property (PGPKeyManager Component)
Returns the hash mark attribute of a signature.
Syntax
func (obj *PGPKeyManager) SignatureHashMark(SignatureIndex int32) (int32, error)
Default Value
0
Remarks
Returns the hash mark attribute of a signature.
Check this property to get a hash mark of a signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureKeyExpirationTime Property (PGPKeyManager Component)
The number of seconds after which the signed key will expire.
Syntax
func (obj *PGPKeyManager) SignatureKeyExpirationTime(SignatureIndex int32) (int32, error)
Default Value
0
Remarks
The number of seconds after which the signed key will expire.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureKeyFlags Property (PGPKeyManager Component)
Returns the key flags included in the signature.
Syntax
func (obj *PGPKeyManager) SignatureKeyFlags(SignatureIndex int32) (int32, error)
Default Value
0
Remarks
Returns the key flags included in the signature.
Use this property to retrieve the key flags stored in the key signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureLegacyFormat Property (PGPKeyManager Component)
Indicates whether signature uses PGP 2.
Syntax
func (obj *PGPKeyManager) SignatureLegacyFormat(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Indicates whether signature uses PGP 2.6.x-compatible packet format.
The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignaturePolicyURL Property (PGPKeyManager Component)
Contains the URL of the signature policy.
Syntax
func (obj *PGPKeyManager) SignaturePolicyURL(SignatureIndex int32) (string, error)
Default Value
""
Remarks
Contains the URL of the signature policy.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignaturePreferredAlgorithms Property (PGPKeyManager Component)
Contains a list of algorithms preferred by the signed key holder.
Syntax
func (obj *PGPKeyManager) SignaturePreferredAlgorithms(SignatureIndex int32) (string, error)
Default Value
""
Remarks
Contains a list of algorithms preferred by the signed key holder.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignaturePrimaryUserID Property (PGPKeyManager Component)
Indicates whether the UserID covered by the signature is the main user id for this key.
Syntax
func (obj *PGPKeyManager) SignaturePrimaryUserID(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Indicates whether the UserID covered by the signature is the main user id for this key.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignatureReasonForRevocation Property (PGPKeyManager Component)
Describes the reason why the key or the certificate was revoked.
Syntax
func (obj *PGPKeyManager) SignatureReasonForRevocation(SignatureIndex int32) (string, error)
Default Value
""
Remarks
Describes the reason why the key or the certificate was revoked.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignatureRevocable Property (PGPKeyManager Component)
Specifies whether the signature can be revoked.
Syntax
func (obj *PGPKeyManager) SignatureRevocable(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Specifies whether the signature can be revoked.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignatureRevocation Property (PGPKeyManager Component)
Indicates whether or not the signature is a revocation signature.
Syntax
func (obj *PGPKeyManager) SignatureRevocation(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Indicates whether or not the signature is a revocation signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignatureClass Property (PGPKeyManager Component)
Indicates the signature class.
Syntax
func (obj *PGPKeyManager) SignatureClass(SignatureIndex int32) (int32, error)
Possible Values
0 // Document
1 // TextDocument
2 // Standalone
3 // UIDGeneric
4 // UIDPersona
5 // UIDCasual
6 // UIDPositive
7 // SubkeyBinding
8 // PrimaryKeyBinding
9 // DirectKey
10 // KeyRevocation
11 // SubkeyRevocation
12 // CertRevocation
13 // Timestamp
14 // ThirdParty
15 // NotSpecified
Default Value
0
Remarks
Indicates the signature class.
| pscDocument | 0 | Signature over binary file |
| pscTextDocument | 1 | Signature over text |
| pscStandalone | 2 | A standalone signature |
| pscUIDGeneric | 3 | User certification signature |
| pscUIDPersona | 4 | User certification signature (persona) |
| pscUIDCasual | 5 | User certification signature (casual) |
| pscUIDPositive | 6 | User certification signature (positive) |
| pscSubkeyBinding | 7 | Subkey binding signature |
| pscPrimaryKeyBinding | 8 | Primary key binding signature |
| pscDirectKey | 9 | Direct signature over a public key |
| pscKeyRevocation | 10 | Key revocation |
| pscSubkeyRevocation | 11 | Subkey revocation |
| pscCertRevocation | 12 | User revocation |
| pscTimestamp | 13 | Timestamp signature |
| pscThirdParty | 14 | Third-party signature |
| pscNotSpecified | 15 | Signature type not provided |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureSignerKeyID Property (PGPKeyManager Component)
Indicates the KeyID of the signing key.
Syntax
func (obj *PGPKeyManager) SignatureSignerKeyID(SignatureIndex int32) (string, error)
Default Value
""
Remarks
Indicates the KeyID of the signing key.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignatureSignerUserID Property (PGPKeyManager Component)
Indicates the UserID associated with the signing key.
Syntax
func (obj *PGPKeyManager) SignatureSignerUserID(SignatureIndex int32) (string, error)
Default Value
""
Remarks
Indicates the UserID associated with the signing key.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignatureStrictlyValid Property (PGPKeyManager Component)
Returns True if this signature is valid in a strict way (no compatibility relaxations).
Syntax
func (obj *PGPKeyManager) SignatureStrictlyValid(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Returns True if this signature is valid in a strict way (no compatibility relaxations).
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignatureTarget Property (PGPKeyManager Component)
Indicates the KeyID or Username of the target key or user.
Syntax
func (obj *PGPKeyManager) SignatureTarget(SignatureIndex int32) (string, error)
Default Value
""
Remarks
Indicates the KeyID or Username of the target key or user.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
string
SignatureTextSignature Property (PGPKeyManager Component)
Indicates whether or not the signature is made over a text document.
Syntax
func (obj *PGPKeyManager) SignatureTextSignature(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Indicates whether or not the signature is made over a text document.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignatureTrustAmount Property (PGPKeyManager Component)
Specifies the amount of trust assigned by this signature.
Syntax
func (obj *PGPKeyManager) SignatureTrustAmount(SignatureIndex int32) (int32, error)
Default Value
0
Remarks
Specifies the amount of trust assigned by this signature.
Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureTrustLevel Property (PGPKeyManager Component)
The trust level assigned by this signature.
Syntax
func (obj *PGPKeyManager) SignatureTrustLevel(SignatureIndex int32) (int32, error)
Default Value
0
Remarks
The trust level assigned by this signature.
Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureValidated Property (PGPKeyManager Component)
Whether the signature has been validated.
Syntax
func (obj *PGPKeyManager) SignatureValidated(SignatureIndex int32) (bool, error)
Default Value
false
Remarks
Whether the signature has been validated.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
SignatureValidity Property (PGPKeyManager Component)
Provides the validity status of the signature if the signature has been validated.
Syntax
func (obj *PGPKeyManager) SignatureValidity(SignatureIndex int32) (int32, error)
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted
Default Value
0
Remarks
Provides the validity status of the signature if the signature has been validated.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SignatureVersion Property (PGPKeyManager Component)
Indicates the signature version.
Syntax
func (obj *PGPKeyManager) SignatureVersion(SignatureIndex int32) (int32, error)
Default Value
0
Remarks
Indicates the signature version.
RFC 4880 defines two versions for PGP signatures: 3 and 4.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
int32
SigningKeyHandle Property (PGPKeyManager Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *PGPKeyManager) SigningKeyHandle() (int64, error)
func (obj *PGPKeyManager) SetSigningKeyHandle(value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
SubkeyCount Property (PGPKeyManager Component)
The number of records in the Subkey arrays.
Syntax
func (obj *PGPKeyManager) SubkeyCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- SubkeyBitsInKey
- SubkeyCanEncrypt
- SubkeyCanSign
- SubkeyCurve
- SubkeyEnabled
- SubkeyEncryptionAlgorithm
- SubkeyHandle
- SubkeyIsPublic
- SubkeyIsSecret
- SubkeyIsSubkey
- SubkeyKeyFP
- SubkeyKeyID
- SubkeyPassphrase
- SubkeyPassphraseValid
- SubkeyPrimaryKeyID
- SubkeyProtection
- SubkeyPublicKeyAlgorithm
- SubkeyQBits
- SubkeyTimestamp
- SubkeyUsername
- SubkeyValidTo
- SubkeyVersion
This property is read-only.
Data Type
int32
SubkeyBitsInKey Property (PGPKeyManager Component)
Indicates the key length in bits.
Syntax
func (obj *PGPKeyManager) SubkeyBitsInKey(SubkeyIndex int32) (int32, error)
Default Value
2048
Remarks
Indicates the key length in bits.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
int32
SubkeyCanEncrypt Property (PGPKeyManager Component)
Returns True if this key can be used for encryption.
Syntax
func (obj *PGPKeyManager) SubkeyCanEncrypt(SubkeyIndex int32) (bool, error)
Default Value
false
Remarks
Returns True if this key can be used for encryption.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
bool
SubkeyCanSign Property (PGPKeyManager Component)
Returns True if this key can be used for signing.
Syntax
func (obj *PGPKeyManager) SubkeyCanSign(SubkeyIndex int32) (bool, error)
Default Value
false
Remarks
Returns True if this key can be used for signing.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
bool
SubkeyCurve Property (PGPKeyManager Component)
Indicates the elliptic curve associated with a EC key.
Syntax
func (obj *PGPKeyManager) SubkeyCurve(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
Indicates the elliptic curve associated with a EC key.
Supported values:
| SB_PGP_CURVE_P256 | P256 | |
| SB_PGP_CURVE_P384 | P384 | |
| SB_PGP_CURVE_P521 | P521 | |
| SB_PGP_CURVE_ED25519 | ED25519 | |
| SB_PGP_CURVE_CURVE25519 | CURVE25519 | |
| SB_PGP_CURVE_BRAINPOOLP256R1 | BRAINPOOLP256 | |
| SB_PGP_CURVE_BRAINPOOLP512R1 | BRAINPOOLP512 |
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyEnabled Property (PGPKeyManager Component)
Enables or disables this key for use in encryption or signing operation.
Syntax
func (obj *PGPKeyManager) SubkeyEnabled(SubkeyIndex int32) (bool, error)
Default Value
false
Remarks
Enables or disables this key for use in encryption or signing operation.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
bool
SubkeyEncryptionAlgorithm Property (PGPKeyManager Component)
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
func (obj *PGPKeyManager) SubkeyEncryptionAlgorithm(SubkeyIndex int32) (string, error)
Default Value
"AES128"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyHandle Property (PGPKeyManager Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *PGPKeyManager) SubkeyHandle(SubkeyIndex int32) (int64, error)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
int64
SubkeyIsPublic Property (PGPKeyManager Component)
Returns True if this key is a public key, and False otherwise.
Syntax
func (obj *PGPKeyManager) SubkeyIsPublic(SubkeyIndex int32) (bool, error)
Default Value
false
Remarks
Returns True if this key is a public key, and False otherwise.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
bool
SubkeyIsSecret Property (PGPKeyManager Component)
Returns True if this key is a secret key, and False otherwise.
Syntax
func (obj *PGPKeyManager) SubkeyIsSecret(SubkeyIndex int32) (bool, error)
Default Value
false
Remarks
Returns True if this key is a secret key, and False otherwise.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
bool
SubkeyIsSubkey Property (PGPKeyManager Component)
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
func (obj *PGPKeyManager) SubkeyIsSubkey(SubkeyIndex int32) (bool, error)
Default Value
false
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
bool
SubkeyKeyFP Property (PGPKeyManager Component)
The 20-byte fingerprint (hash value) of this key.
Syntax
func (obj *PGPKeyManager) SubkeyKeyFP(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyKeyID Property (PGPKeyManager Component)
Contains a 8-byte key identifier.
Syntax
func (obj *PGPKeyManager) SubkeyKeyID(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyPassphrase Property (PGPKeyManager Component)
The key protection password.
Syntax
func (obj *PGPKeyManager) SubkeyPassphrase(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
The key protection password.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyPassphraseValid Property (PGPKeyManager Component)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
func (obj *PGPKeyManager) SubkeyPassphraseValid(SubkeyIndex int32) (bool, error)
Default Value
false
Remarks
Use this property to check whether the specified SubkeyPassphrase is valid and can be used to unlock the secret key.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
bool
SubkeyPrimaryKeyID Property (PGPKeyManager Component)
If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
Syntax
func (obj *PGPKeyManager) SubkeyPrimaryKeyID(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
If this key is a subkey (SubkeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyProtection Property (PGPKeyManager Component)
Specifies the level of protection applied to the secret key.
Syntax
func (obj *PGPKeyManager) SubkeyProtection(SubkeyIndex int32) (int32, error)
Possible Values
0 // None
1 // Low
2 // Normal
3 // High
Default Value
0
Remarks
Specifies the level of protection applied to the secret key.
Allowed values:
| pptNone | 0 | Key is not encrypted |
| pptLow | 1 | Only the password hash is used to derive the secret key |
| pptNormal | 2 | Password hash with salt is used to derive the secret key |
| pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation |
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
int32
SubkeyPublicKeyAlgorithm Property (PGPKeyManager Component)
Specifies the asymmetric algorithm of the key.
Syntax
func (obj *PGPKeyManager) SubkeyPublicKeyAlgorithm(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyQBits Property (PGPKeyManager Component)
The length of the DSA Q (legitimate range: 160-512).
Syntax
func (obj *PGPKeyManager) SubkeyQBits(SubkeyIndex int32) (int32, error)
Default Value
0
Remarks
The length of the DSA Q (legitimate range: 160-512).
This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
int32
SubkeyTimestamp Property (PGPKeyManager Component)
Use this property to check the time the key was generated.
Syntax
func (obj *PGPKeyManager) SubkeyTimestamp(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyUsername Property (PGPKeyManager Component)
Specifies the name of the user bound to this key.
Syntax
func (obj *PGPKeyManager) SubkeyUsername(SubkeyIndex int32) (string, error)
Default Value
""
Remarks
Specifies the name of the user bound to this key.
The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyValidTo Property (PGPKeyManager Component)
Provide accurate expiration moment indication.
Syntax
func (obj *PGPKeyManager) SubkeyValidTo(SubkeyIndex int32) (string, error)
Default Value
"0"
Remarks
Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
string
SubkeyVersion Property (PGPKeyManager Component)
Indicates the key version.
Syntax
func (obj *PGPKeyManager) SubkeyVersion(SubkeyIndex int32) (int32, error)
Default Value
0
Remarks
Indicates the key version.
The key version refers to the version of the public-key packet format as defined in RFC 4880.
Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6.
The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.
This property is read-only.
Data Type
int32
UserCount Property (PGPKeyManager Component)
The number of records in the User arrays.
Syntax
func (obj *PGPKeyManager) UserCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at UserCount - 1.This property is read-only.
Data Type
int32
UserHandle Property (PGPKeyManager Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *PGPKeyManager) UserHandle(UserIndex int32) (int64, error)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is read-only.
Data Type
int64
Username Property (PGPKeyManager Component)
Specifies the user name of user.
Syntax
func (obj *PGPKeyManager) Username(UserIndex int32) (string, error)
Default Value
""
Remarks
Specifies the user name of user.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is read-only.
Data Type
string
ChangePassphrase Method (PGPKeyManager Component)
Changes the password of the secret key.
Syntax
func (obj *PGPKeyManager) ChangePassphrase(OldPassphrase string, NewPassphrase string) error
Remarks
Call this method to change the password that protects the secret key and all its subkeys.
Note: use SubkeyIndex configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys).
ChangeProtection Method (PGPKeyManager Component)
Changes the protection level of the secret key.
Syntax
func (obj *PGPKeyManager) ChangeProtection(OldPassphrase string, NewPassphrase string, ProtType int32, EncAlgorithm string, HashAlgorithm string) error
Remarks
Use this method to change the protection level of the Key.
OldPassphrase specifies the current password to decrypt the key, NewPassphrase is the new password for the key, ProtType is the new protection type (see for more details), EncAlgorithm is the key encryption algorithm, and
| SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT | Plaintext | |
| SB_PGP_SYMMETRIC_ALGORITHM_IDEA | Idea | |
| SB_PGP_SYMMETRIC_ALGORITHM_3DES | 3DES | |
| SB_PGP_SYMMETRIC_ALGORITHM_CAST5 | CAST5 | |
| SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
| SB_PGP_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_PGP_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
| SB_PGP_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
| SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
Note: use SubkeyIndex configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys).
CheckPassphrase Method (PGPKeyManager Component)
Checks if the password matches the secret key.
Syntax
func (obj *PGPKeyManager) CheckPassphrase(Passphrase string) (bool, error)
Remarks
Use this method to check if a password can decrypt the Key.
Config Method (PGPKeyManager Component)
Sets or retrieves a configuration setting.
Syntax
func (obj *PGPKeyManager) 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.
CreateKey Method (PGPKeyManager Component)
Generates a new key.
Syntax
func (obj *PGPKeyManager) CreateKey(Version int32, Algorithm string, Bits int32, ValidTo string, Password string) error
Remarks
Use this method to generate a new key with the provided parameters.
CreateSubkey Method (PGPKeyManager Component)
Generates a new subkey.
Syntax
func (obj *PGPKeyManager) CreateSubkey(Algorithm string, Bits int32, ValidTo string, Password string) error
Remarks
Use this method to generate a new subkey with the provided parameters.
CreateUser Method (PGPKeyManager Component)
Adds a user to an existing key.
Syntax
func (obj *PGPKeyManager) CreateUser(Username string) error
Remarks
Use this method to add a user to an existing key. A typical format for a PGP key usage is "Name <email>", for example "John Johnson <john@johnson.com>".
DoAction Method (PGPKeyManager Component)
Performs an additional action.
Syntax
func (obj *PGPKeyManager) DoAction(ActionID string, ActionParams string) (string, error)
Remarks
DoAction is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Common ActionIDs:
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
ExportBytes Method (PGPKeyManager Component)
Serializes the key to a byte array.
Syntax
func (obj *PGPKeyManager) ExportBytes(Secret bool) ([]byte, error)
Remarks
Use this method to save the Key (both the public and secret parts) to a byte array.
ExportToFile Method (PGPKeyManager Component)
Exports the key to a file.
Syntax
func (obj *PGPKeyManager) ExportToFile(FileName string, Secret bool) error
Remarks
Use this method to save the Key (both the public and secret parts) to the file specified in Filename.
GeneratePair Method (PGPKeyManager Component)
Generates a new pair of PGP keys.
Syntax
func (obj *PGPKeyManager) GeneratePair(Version int32, Username string, Strength int32, ValidTo string, Password string) error
Remarks
Use this method to create a standard key-subkey pair. This is the primary method for generating conformant PGP keys.
Pass the user ID of the new key via the Username property. This typically should be in the format of User Name <user@email>, for example Robert Frost <robert@frost.com>, but generally can be an arbitrary text string.
This method generates a 'standard' keypair based on the Version and Strength parameters. This can range from RSA keys for version 3 to strong Ed25519 keys for version 6.
The following PGP key versions and strengths are supported:
| pvDefault | 0 | The default version (situation-specific) |
| pv3 | 3 | Version 3 |
| pv4 | 4 | Version 4 |
| pv5 | 5 | Version 5 |
| pv6 | 6 | Version 6 |
| psNormal | 0 | Normal strength |
| psStrong | 1 | Increased strength |
| psPostQuantum | 2 | Post-quantum algorithms |
Provide the key encryption password and the validity period in days via the Password and ValidTo parameters.
ImportBytes Method (PGPKeyManager Component)
Loads a key from a byte array.
Syntax
func (obj *PGPKeyManager) ImportBytes(Key []byte) error
Remarks
Use this method to load a key, either public or secret, from a byte array.
ImportFromFile Method (PGPKeyManager Component)
Loads a key from a file.
Syntax
func (obj *PGPKeyManager) ImportFromFile(FileName string) error
Remarks
Use this method to load a key, either public or secret, from a file.
ImportPinned Method (PGPKeyManager Component)
Loads a key from a pinned key object.
Syntax
func (obj *PGPKeyManager) ImportPinned() error
Remarks
Use this method to load a PGP key from a PinnedKey object. This is an easy way to import a key object from a keyring.
RemoveSignature Method (PGPKeyManager Component)
Unbinds the specified signature from the key, subkey or user.
Syntax
func (obj *PGPKeyManager) RemoveSignature(Index int32) error
Remarks
Use this method to remove the specified signature from the list of Signatures bound to the key, subkey or user.
RemoveSubkey Method (PGPKeyManager Component)
Removes the specified subkey from the key.
Syntax
func (obj *PGPKeyManager) RemoveSubkey(Index int32) error
Remarks
Use this method to remove the subkey referred by its Index from the key.
RemoveUser Method (PGPKeyManager Component)
Unbinds the specified user from the key.
Syntax
func (obj *PGPKeyManager) RemoveUser(Index int32) error
Remarks
Use this method to remove the specified user from the list of UserIDs bound to the key.
Reset Method (PGPKeyManager Component)
Creates a new empty keyring.
Syntax
func (obj *PGPKeyManager) Reset() error
Remarks
Use this method to initialize a new empty keyring.
RevokeKey Method (PGPKeyManager Component)
Revokes the key.
Syntax
func (obj *PGPKeyManager) RevokeKey(Reason int32, Comment string) error
Remarks
Use this method to revoke the key by adding a revocation signature.
RevokeSubkey Method (PGPKeyManager Component)
Revokes the key's subkey.
Syntax
func (obj *PGPKeyManager) RevokeSubkey(Index int32, Reason int32, Comment string) error
Remarks
Use this method to revoke the subkey with a given Index by adding a revocation signature.
RevokeUser Method (PGPKeyManager Component)
Revokes a user certification.
Syntax
func (obj *PGPKeyManager) RevokeUser(Index int32, Reason int32, Comment string) error
Remarks
Use this method to revoke the user with the specified Index by adding a revocation signature to the key.
SignKey Method (PGPKeyManager Component)
Sign the key.
Syntax
func (obj *PGPKeyManager) SignKey(KeyValidTo string, HashAlgorithm string, PreferredAlgs string, KeyFlags int32) error
Remarks
Use this method to sign the main key, or 'create a key binding signature', in terms of the PGP specification. Provide the signing key in SigningKey.
Use the KeyValidTo parameter to specify the key validity period and HashAlgorithm to provide the signature hash algorithm.
The PreferredAlgs parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists:
Encryption algorithms:
- Plaintext
- IDEA
- 3DES
- Blowfish
- AES128
- AES192
- AES256
- Twofish256
- CAST5
- Camellia128
- Camellia192
- Camellia256
Compression algorithms:
- ZIP
- ZLIB
- BZIP2
Hash algorithms:
- MD5
- SHA
- RIPEMD160
- SHA224
- SHA256
- SHA384
- SHA512
- SHA3-256
- SHA3-384
- SHA3-512
Example: Camellia192,AES192,SHA256,ZIP
If you leave PreferredAlgs, no algorithm preferences information will be saved with the key.
The KeyFlags parameter is a bitmask that can contain the following bit flags:
| KeyFlagCertifyOtherKeys | 1 | The key can certify other keys |
| KeyFlagSignData | 2 | The key can be used to sign data |
| KeyFlagEncryptData | 4 | The key can be used to encrypt data (in transit) |
| KeyFlagEncryptStorage | 8 | The key can be used to encrypt data (at rest) |
| KeyFlagSplitKey | 16 | The key is part of a split key scheme |
| KeyFlagGroupKey | 32 | The key is part of a group key scheme |
SignSubkey Method (PGPKeyManager Component)
Sign the key's subkey.
Syntax
func (obj *PGPKeyManager) SignSubkey(Index int32, KeyValidTo string, HashAlgorithm string, PreferredAlgs string, KeyFlags int32) error
Remarks
Use this method to sign the subkey with a given Index (create a 'subkey binding signature'). Provide the signing key in SigningKey.
Use the KeyValidTo parameter to specify the subkey validity period and HashAlgorithm to provide the signature hash algorithm.
The PreferredAlgs parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use when using the subkey that is being signed. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists:
Encryption algorithms:
- Plaintext
- IDEA
- 3DES
- Blowfish
- AES128
- AES192
- AES256
- Twofish256
- CAST5
- Camellia128
- Camellia192
- Camellia256
Compression algorithms:
- ZIP
- ZLIB
- BZIP2
Hash algorithms:
- MD5
- SHA
- RIPEMD160
- SHA224
- SHA256
- SHA384
- SHA512
- SHA3-256
- SHA3-384
- SHA3-512
Example: Camellia256,Twofish256,AES256,ZLIB,SHA512
If you leave PreferredAlgs, no algorithm preferences information will be saved with the key.
The KeyFlags parameter is a bitmask that can contain the following bit flags:
| KeyFlagCertifyOtherKeys | 1 | The key can certify other keys |
| KeyFlagSignData | 2 | The key can be used to sign data |
| KeyFlagEncryptData | 4 | The key can be used to encrypt data (in transit) |
| KeyFlagEncryptStorage | 8 | The key can be used to encrypt data (at rest) |
| KeyFlagSplitKey | 16 | The key is part of a split key scheme |
| KeyFlagGroupKey | 32 | The key is part of a group key scheme |
SignUser Method (PGPKeyManager Component)
Creates a user certification.
Syntax
func (obj *PGPKeyManager) SignUser(Index int32, KeyValidTo string, HashAlgorithm string, Primary bool, CertType int32) error
Remarks
Use this method to sign the user ID with the specified Index using the SigningKey. This signature creates a binding between the user ID and their main key.
While it is typical to sign user IDs with their own secret keys, occasionally third-party authentication is used where the binding is signed with a third-party key.
The KeyValidTo parameter indicates the expiration date of the binding. It can be different to that of the signing and/or the main key. The Primary parameter indicates whether this should be considered the primary user ID for this key (for example, if the user has more than one email). The CertType parameters indicates the type of binding, and should be set to one of the following values (if unsure, use pctGeneric):
| pctGeneric | 0 | Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type. |
| pctPersona | 1 | Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID. |
| pctCasual | 2 | Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity. |
| pctPositive | 3 | Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity. |
Verify Method (PGPKeyManager Component)
Verifies the integrity of a key signature.
Syntax
func (obj *PGPKeyManager) Verify(Index int32) (bool, error)
Remarks
Use this method to validate a key signature. Provide the index of the signature as a parameter.
Error Event (PGPKeyManager Component)
Information about errors during PGP key management.
Syntax
// PGPKeyManagerErrorEventArgs carries the PGPKeyManager Error event's parameters.
type PGPKeyManagerErrorEventArgs struct {...}
func (args *PGPKeyManagerErrorEventArgs) ErrorCode() int32
func (args *PGPKeyManagerErrorEventArgs) Description() string
// PGPKeyManagerErrorEvent defines the signature of the PGPKeyManager Error event's handler function.
type PGPKeyManagerErrorEvent func(sender *PGPKeyManager, args *PGPKeyManagerErrorEventArgs)
func (obj *PGPKeyManager) GetOnErrorHandler() PGPKeyManagerErrorEvent
func (obj *PGPKeyManager) SetOnErrorHandler(handlerFunc PGPKeyManagerErrorEvent)
Remarks
The event is fired in case of exceptional conditions during key management.
ErrorCode contains an error code and Description contains a textual description of the error.
KeyPassphraseNeeded Event (PGPKeyManager Component)
Requests a key protection password from the application.
Syntax
// PGPKeyManagerKeyPassphraseNeededEventArgs carries the PGPKeyManager KeyPassphraseNeeded event's parameters.
type PGPKeyManagerKeyPassphraseNeededEventArgs struct {...}
func (args *PGPKeyManagerKeyPassphraseNeededEventArgs) KeyID() string
func (args *PGPKeyManagerKeyPassphraseNeededEventArgs) UserID() string
func (args *PGPKeyManagerKeyPassphraseNeededEventArgs) MainKey() bool
func (args *PGPKeyManagerKeyPassphraseNeededEventArgs) Passphrase() string
func (args *PGPKeyManagerKeyPassphraseNeededEventArgs) SetPassphrase(value string)
func (args *PGPKeyManagerKeyPassphraseNeededEventArgs) Skip() bool
func (args *PGPKeyManagerKeyPassphraseNeededEventArgs) SetSkip(value bool)
// PGPKeyManagerKeyPassphraseNeededEvent defines the signature of the PGPKeyManager KeyPassphraseNeeded event's handler function.
type PGPKeyManagerKeyPassphraseNeededEvent func(sender *PGPKeyManager, args *PGPKeyManagerKeyPassphraseNeededEventArgs)
func (obj *PGPKeyManager) GetOnKeyPassphraseNeededHandler() PGPKeyManagerKeyPassphraseNeededEvent
func (obj *PGPKeyManager) SetOnKeyPassphraseNeededHandler(handlerFunc PGPKeyManagerKeyPassphraseNeededEvent)
Remarks
The struct fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The struct fires it when it attempts to use a secret key to sign the data.
This event is fired for every protected secret key residing in SigningKeys. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.
The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.
For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.
Notification Event (PGPKeyManager Component)
This event notifies the application about an underlying control flow event.
Syntax
// PGPKeyManagerNotificationEventArgs carries the PGPKeyManager Notification event's parameters.
type PGPKeyManagerNotificationEventArgs struct {...}
func (args *PGPKeyManagerNotificationEventArgs) EventID() string
func (args *PGPKeyManagerNotificationEventArgs) EventParam() string
// PGPKeyManagerNotificationEvent defines the signature of the PGPKeyManager Notification event's handler function.
type PGPKeyManagerNotificationEvent func(sender *PGPKeyManager, args *PGPKeyManagerNotificationEventArgs)
func (obj *PGPKeyManager) GetOnNotificationHandler() PGPKeyManagerNotificationEvent
func (obj *PGPKeyManager) SetOnNotificationHandler(handlerFunc PGPKeyManagerNotificationEvent)
Remarks
The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted.
Config Settings (PGPKeyManager Component)
The struct accepts one or more of the following configuration settings. Configuration 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.PGPKeyManager Config Settings
| KeyFlagCertifyOtherKeys | 1 | The key can certify other keys |
| KeyFlagSignData | 2 | The key can be used to sign data |
| KeyFlagEncryptData | 4 | The key can be used to encrypt data (in transit) |
| KeyFlagEncryptStorage | 8 | The key can be used to encrypt data (at rest) |
| KeyFlagSplitKey | 16 | The key is part of a split key scheme |
| KeyFlagGroupKey | 32 | The key is part of a group key scheme |
Use this property before calling the SignUser method. The config setting is cleared after each signing operation.
Example: AES256,SHA256,AES128,SHA512,ZIP,ZLIB,CAST5
mgr.Config("SubkeyIndex=2");
mgr.ChangePassphrase("oldpass", "newpass");
Note: set this property to -2 to apply the setting to the main key. The default value of -1 indicates that any protection operation applies to all keys and subkeys in the tree.
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported Values:
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (PGPKeyManager Component)
PGPKeyManager Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 27262977 | The file was not found (SB_ERROR_PGP_FILE_NOT_EXISTS) |
| 27262978 | Invalid signing key (SB_ERROR_PGP_INVALID_KEY) |
| 27262980 | No secret key is available (SB_ERROR_PGP_NO_SECRET_KEY) |
| 27262982 | The operation is not supported on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY) |