PGPReader Component
Properties Methods Events Config Settings Errors
The PGPReader component reads and unprotects protected PGP files
Syntax
nsoftware.SecureBlackbox.PGPReader
Remarks
PGPReader allows you to parse PGP messages and manipulate PGP-secured data. It decrypts the protected data, decompresses it, verifies signatures, and returns "clear" data.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Armored | Indicates if the processed message had been base64-armored. |
Compressed | Indicates if the processed message had been compressed. |
DataBytes | Use this property to pass the original signed data to component in the byte array form. |
DataFile | The name of the file containing the original signed data. |
DataStream | A stream containing the originally signed data. |
DecryptingKeys | A collection of keys to be used for decryption. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
InputBytes | Use this property to pass the input to component in byte array form. |
InputFile | Provides a filename of a file to process. |
InputStream | A stream containing the input to process. |
KeyPassphrase | Specifies a passphrase for the decryption key. |
OutputBytes | Use this property to read the output the component object has produced. |
OutputFile | The file where the encrypted and/or signed data will be saved. |
OutputStream | The stream where the encrypted and/or signed data will be saved. |
Passphrase | Specifies a message decryption password. |
ProcessedLength | Reports the number of bytes processed. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
Signatures | Contains signatures that were included in the protected message. |
VerifyingKeys | A collection of keys to be used for signature verification. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DecryptAndVerify | Decrypts and verifies a protected message. |
DoAction | Performs an additional action. |
Reset | Resets the component settings. |
VerifyDetached | Verifies a detached 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.
EncryptionInfo | Reports early information on encryption parameters. |
Error | Information about errors during PGP decryption/verification. |
ExternalDecrypt | Handles remote or external decryption. |
FileExtractionFinish | Reports the ending of file extraction process. |
FileExtractionStart | Reports the beginning of file extraction process. |
KeyPassphraseNeeded | Requests a key protection password from the application. |
MultipleFilesFound | Fires if the PGP message is recognized to contain multiple files. |
Notification | This event notifies the application about an underlying control flow event. |
PassphraseNeeded | Requests a data protection password from the application. |
Progress | Reports the progress of the decryption operation. |
Signed | Notifies the application about a signed message. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
IgnoreDataPacketLengths | Whether to check the length of input data packets. |
PasswordAttempts | The number of attempts allowed for entering password. |
TempPath | Path for storing temporary files. |
UndefInputLength | Set this property if you are working with non-seekable streams. |
UseGreedyMemoryConsumption | Whether to limit memory consumption for the cost of speed. |
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 component. |
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. |
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 components 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. |
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. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOwnDNSResolver | Specifies whether the client components 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. |
Armored Property (PGPReader Component)
Indicates if the processed message had been base64-armored.
Syntax
Default Value
False
Remarks
This property is set to true if the supplied message was armored by encoding it into base64 and adding BEGIN and END brackets.
This property is read-only and not available at design time.
Compressed Property (PGPReader Component)
Indicates if the processed message had been compressed.
Syntax
Default Value
False
Remarks
This property is set to true if the supplied message was compressed by its creator.
This property is read-only and not available at design time.
DataBytes Property (PGPReader Component)
Use this property to pass the original signed data to component in the byte array form.
Syntax
Remarks
When validating detached signatures, assign a byte array containing the signed data to this property.
This property is not available at design time.
DataFile Property (PGPReader Component)
The name of the file containing the original signed data.
Syntax
Default Value
""
Remarks
Use this property to provide the original data when validating detached signatures with VerifyDetached.
DataStream Property (PGPReader Component)
A stream containing the originally signed data.
Syntax
public System.IO.Stream DataStream { get; set; }
Public Property DataStream As System.IO.Stream
Default Value
null
Remarks
Use this property to provide the original data when validating detached signatures with VerifyDetached.
This property is not available at design time.
DecryptingKeys Property (PGPReader Component)
A collection of keys to be used for decryption.
Syntax
public PGPKeyList DecryptingKeys { get; }
Public Property DecryptingKeys As PGPKeyList
Remarks
Use this property to provide decryption keys. Note that only secret keys can decrypt.
In most cases you will also need to supply a passphrase for the chosen decryption key. Use this by subscribing to KeyPassphraseNeeded event, setting the control's KeyPassphrase property, or setting the Passphrase property of the relevant key object.
This property is not available at design time.
Please refer to the PGPKey type for a complete list of fields.ExternalCrypto Property (PGPReader Component)
Provides access to external signing and DC parameters.
Syntax
public ExternalCrypto ExternalCrypto { get; }
Public ReadOnly Property ExternalCrypto As ExternalCrypto
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).
This property is read-only.
Please refer to the ExternalCrypto type for a complete list of fields.FIPSMode Property (PGPReader Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
InputBytes Property (PGPReader Component)
Use this property to pass the input to component in byte array form.
Syntax
Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
InputFile Property (PGPReader Component)
Provides a filename of a file to process.
Syntax
Default Value
""
Remarks
Use this property to provide a path to the file to be encrypted and/or signed.
InputStream Property (PGPReader Component)
A stream containing the input to process.
Syntax
public System.IO.Stream InputStream { get; set; }
Public Property InputStream As System.IO.Stream
Default Value
null
Remarks
Use this property to feed the input data to the component from a stream object.
This property is not available at design time.
KeyPassphrase Property (PGPReader Component)
Specifies a passphrase for the decryption key.
Syntax
Default Value
""
Remarks
Use this property to provide a passphrase for the decryption secret key.
If this property is left empty or a wrong passphrase is provided, the KeyPassphraseNeeded event will be fired to request the correct passphrase.
OutputBytes Property (PGPReader Component)
Use this property to read the output the component object has produced.
Syntax
Remarks
Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.
This property is read-only and not available at design time.
OutputFile Property (PGPReader Component)
The file where the encrypted and/or signed data will be saved.
Syntax
Default Value
""
Remarks
Use this property to provide a path to the file where the component should store the encrypted and/or signed data.
OutputStream Property (PGPReader Component)
The stream where the encrypted and/or signed data will be saved.
Syntax
public System.IO.Stream OutputStream { get; set; }
Public Property OutputStream As System.IO.Stream
Default Value
null
Remarks
Use this property to specify the stream to take the resulting encrypted and/or signed data.
This property is not available at design time.
Passphrase Property (PGPReader Component)
Specifies a message decryption password.
Syntax
Default Value
""
Remarks
Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.
Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.
If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.
ProcessedLength Property (PGPReader Component)
Reports the number of bytes processed.
Syntax
Default Value
0
Remarks
Use this property to check the number of bytes that the component has read when processing the protected message.
This property is read-only and not available at design time.
Profile Property (PGPReader Component)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Signatures Property (PGPReader Component)
Contains signatures that were included in the protected message.
Syntax
public PGPSignatureList Signatures { get; }
Public ReadOnly Property Signatures As PGPSignatureList
Remarks
Use this property to access the details of the signatures included in the processed message.
This property is read-only and not available at design time.
Please refer to the PGPSignature type for a complete list of fields.VerifyingKeys Property (PGPReader Component)
A collection of keys to be used for signature verification.
Syntax
public PGPKeyList VerifyingKeys { get; }
Public Property VerifyingKeys As PGPKeyList
Remarks
Use this property to provide verifying keys.
You will need an appropriate key to verify every signature included in the message. Use Signed event to get informed about the keys that were used for signing.
This property is not available at design time.
Please refer to the PGPKey type for a complete list of fields.Config Method (PGPReader Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
DecryptAndVerify Method (PGPReader Component)
Decrypts and verifies a protected message.
Syntax
public void DecryptAndVerify();
Public Sub DecryptAndVerify()
Remarks
Use this method to unprotect a PGP message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream). The method writes the decrypted message to a byte array (OutputBytes), to a file (OutputFile) or to a stream (OutputStream).
DoAction Method (PGPReader Component)
Performs an additional action.
Syntax
Remarks
DoAction is a generic method available in every component. 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;....
Reset Method (PGPReader Component)
Resets the component settings.
Syntax
public void Reset();
Public Sub Reset()
Remarks
Reset is a generic method available in every component.
VerifyDetached Method (PGPReader Component)
Verifies a detached signature.
Syntax
public void VerifyDetached();
Public Sub VerifyDetached()
Remarks
Use this method to verify a detached signature contained in a byte array (DataBytes), in a file (DataFile) or in a stream (DataStream) over a message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream).
EncryptionInfo Event (PGPReader Component)
Reports early information on encryption parameters.
Syntax
public event OnEncryptionInfoHandler OnEncryptionInfo; public delegate void OnEncryptionInfoHandler(object sender, PGPReaderEncryptionInfoEventArgs e); public class PGPReaderEncryptionInfoEventArgs : EventArgs { public string KeyIDs { get; } public int EncryptedProtection { get; } public bool PassphraseUsed { get; } }
Public Event OnEncryptionInfo As OnEncryptionInfoHandler Public Delegate Sub OnEncryptionInfoHandler(sender As Object, e As PGPReaderEncryptionInfoEventArgs) Public Class PGPReaderEncryptionInfoEventArgs Inherits EventArgs Public ReadOnly Property KeyIDs As String Public ReadOnly Property EncryptedProtection As Integer Public ReadOnly Property PassphraseUsed As Boolean End Class
Remarks
The component fires this event to report early encryption information. Use this event to find out what encryption type is used, and to provide appropriate decryption material (the secret keys or the password) via DecryptingKeys or Passphrase properties.
KeyIDs contains the IDs of the keys that can be used to decrypt the data. PassphraseUsed shows if the message can also be decrypted with a passphrase. Both can be set at the same time, indicating that each of the decryption routes can be taken.
EncryptedProtection parameter specifies whether the message includes a modification detection record.
Error Event (PGPReader Component)
Information about errors during PGP decryption/verification.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, PGPReaderErrorEventArgs e); public class PGPReaderErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As PGPReaderErrorEventArgs) Public Class PGPReaderErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The event is fired in case of exceptional conditions during decryption/verification of protected data.
ErrorCode contains an error code and Description contains a textual description of the error.
ExternalDecrypt Event (PGPReader Component)
Handles remote or external decryption.
Syntax
public event OnExternalDecryptHandler OnExternalDecrypt; public delegate void OnExternalDecryptHandler(object sender, PGPReaderExternalDecryptEventArgs e); public class PGPReaderExternalDecryptEventArgs : EventArgs { public string OperationId { get; } public string Algorithm { get; } public string Pars { get; } public string EncryptedData { get; } public string Data { get; set; } }
Public Event OnExternalDecrypt As OnExternalDecryptHandler Public Delegate Sub OnExternalDecryptHandler(sender As Object, e As PGPReaderExternalDecryptEventArgs) Public Class PGPReaderExternalDecryptEventArgs Inherits EventArgs Public ReadOnly Property OperationId As String Public ReadOnly Property Algorithm As String Public ReadOnly Property Pars As String Public ReadOnly Property EncryptedData As String Public Property Data As String End Class
Remarks
Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.
The component uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.
Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
FileExtractionFinish Event (PGPReader Component)
Reports the ending of file extraction process.
Syntax
public event OnFileExtractionFinishHandler OnFileExtractionFinish; public delegate void OnFileExtractionFinishHandler(object sender, PGPReaderFileExtractionFinishEventArgs e); public class PGPReaderFileExtractionFinishEventArgs : EventArgs { public string FileName { get; } public string Timestamp { get; } }
Public Event OnFileExtractionFinish As OnFileExtractionFinishHandler Public Delegate Sub OnFileExtractionFinishHandler(sender As Object, e As PGPReaderFileExtractionFinishEventArgs) Public Class PGPReaderFileExtractionFinishEventArgs Inherits EventArgs Public ReadOnly Property FileName As String Public ReadOnly Property Timestamp As String End Class
Remarks
This event informs about the ending of extraction of the next available file. FileName parameter indicates the original file name, and the Timestamp its last modification time.
In the handler, the user can take away the output stream or store the file data from OutputBytes.
FileExtractionStart Event (PGPReader Component)
Reports the beginning of file extraction process.
Syntax
public event OnFileExtractionStartHandler OnFileExtractionStart; public delegate void OnFileExtractionStartHandler(object sender, PGPReaderFileExtractionStartEventArgs e); public class PGPReaderFileExtractionStartEventArgs : EventArgs { public string FileName { get; } public string Timestamp { get; } public bool Skip { get; set; } }
Public Event OnFileExtractionStart As OnFileExtractionStartHandler Public Delegate Sub OnFileExtractionStartHandler(sender As Object, e As PGPReaderFileExtractionStartEventArgs) Public Class PGPReaderFileExtractionStartEventArgs Inherits EventArgs Public ReadOnly Property FileName As String Public ReadOnly Property Timestamp As String Public Property Skip As Boolean End Class
Remarks
This event informs about the beginning of extraction of the next available file. A PGP message may contain more than one file. FileName parameter indicates the original file name, and the Timestamp its last modification time.
The user should provide an output filename in OutputFile or a stream in OutputStream. If none of them is provided, the extracted file will be placed to OutputBytes. After the file is extracted, FileExtractionFinish event is fired.
KeyPassphraseNeeded Event (PGPReader Component)
Requests a key protection password from the application.
Syntax
public event OnKeyPassphraseNeededHandler OnKeyPassphraseNeeded; public delegate void OnKeyPassphraseNeededHandler(object sender, PGPReaderKeyPassphraseNeededEventArgs e); public class PGPReaderKeyPassphraseNeededEventArgs : EventArgs { public string KeyID { get; } public string UserID { get; } public bool MainKey { get; } public string Passphrase { get; set; } public bool Skip { get; set; } }
Public Event OnKeyPassphraseNeeded As OnKeyPassphraseNeededHandler Public Delegate Sub OnKeyPassphraseNeededHandler(sender As Object, e As PGPReaderKeyPassphraseNeededEventArgs) Public Class PGPReaderKeyPassphraseNeededEventArgs Inherits EventArgs Public ReadOnly Property KeyID As String Public ReadOnly Property UserID As String Public ReadOnly Property MainKey As Boolean Public Property Passphrase As String Public Property Skip As Boolean End Class
Remarks
The component 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 (which is requested via PassphraseNeeded). The component fires it when it has found a suitable decryption secret key in the keyring, and attempts to use it to decrypt the data.
If the data is encrypted with multiple keys, this event is called for each key in a loop until the password for at least one key is provided correctly. 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.
MultipleFilesFound Event (PGPReader Component)
Fires if the PGP message is recognized to contain multiple files.
Syntax
public event OnMultipleFilesFoundHandler OnMultipleFilesFound; public delegate void OnMultipleFilesFoundHandler(object sender, PGPReaderMultipleFilesFoundEventArgs e); public class PGPReaderMultipleFilesFoundEventArgs : EventArgs { public string TarFileName { get; } public bool Proceed { get; set; } }
Public Event OnMultipleFilesFound As OnMultipleFilesFoundHandler Public Delegate Sub OnMultipleFilesFoundHandler(sender As Object, e As PGPReaderMultipleFilesFoundEventArgs) Public Class PGPReaderMultipleFilesFoundEventArgs Inherits EventArgs Public ReadOnly Property TarFileName As String Public Property Proceed As Boolean End Class
Remarks
The component fires this event to report that there is more than one file in the PGP message.
The TarFileName specifies the name of the TAR file containing the files. Tune up Proceed to go ahead or stop the processing.
Notification Event (PGPReader Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, PGPReaderNotificationEventArgs e); public class PGPReaderNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As PGPReaderNotificationEventArgs) Public Class PGPReaderNotificationEventArgs Inherits EventArgs Public ReadOnly Property EventID As String Public ReadOnly Property EventParam As String End Class
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.
PassphraseNeeded Event (PGPReader Component)
Requests a data protection password from the application.
Syntax
public event OnPassphraseNeededHandler OnPassphraseNeeded; public delegate void OnPassphraseNeededHandler(object sender, PGPReaderPassphraseNeededEventArgs e); public class PGPReaderPassphraseNeededEventArgs : EventArgs { public string Passphrase { get; set; } public bool Skip { get; set; } }
Public Event OnPassphraseNeeded As OnPassphraseNeededHandler Public Delegate Sub OnPassphraseNeededHandler(sender As Object, e As PGPReaderPassphraseNeededEventArgs) Public Class PGPReaderPassphraseNeededEventArgs Inherits EventArgs Public Property Passphrase As String Public Property Skip As Boolean End Class
Remarks
The component fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.
The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.
Progress Event (PGPReader Component)
Reports the progress of the decryption operation.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, PGPReaderProgressEventArgs e); public class PGPReaderProgressEventArgs : EventArgs { public long Current { get; } public long Total { get; } public bool Cancel { get; set; } }
Public Event OnProgress As OnProgressHandler Public Delegate Sub OnProgressHandler(sender As Object, e As PGPReaderProgressEventArgs) Public Class PGPReaderProgressEventArgs Inherits EventArgs Public ReadOnly Property Current As Long Public ReadOnly Property Total As Long Public Property Cancel As Boolean End Class
Remarks
The component fires this event repeatedly to report the progress of the file extraction operation.
Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the extraction process.
Signed Event (PGPReader Component)
Notifies the application about a signed message.
Syntax
public event OnSignedHandler OnSigned; public delegate void OnSignedHandler(object sender, PGPReaderSignedEventArgs e); public class PGPReaderSignedEventArgs : EventArgs { public string KeyIDs { get; } public int SignatureType { get; } }
Public Event OnSigned As OnSignedHandler Public Delegate Sub OnSignedHandler(sender As Object, e As PGPReaderSignedEventArgs) Public Class PGPReaderSignedEventArgs Inherits EventArgs Public ReadOnly Property KeyIDs As String Public ReadOnly Property SignatureType As Integer End Class
Remarks
The component fires this event when it identifies a signed message to allow the application to prepare the component for verification.
Use the KeyIDs parameter to identify keys used that were used to sign the message, and make sure they are available in the VerifyingKeys list.
SignatureType indicates the signature type:
pstNormal | 0 | A traditional signature, compatible (algorithm permitting) with PGP 2.6.x |
pstOnePass | 1 | A newer one-pass signature |
pstDetached | 2 | A detached signature, i.e., a signature contained in a separate file from the data it covers |
pstCleartext | 3 | A signature made over textual data and appended to it |
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
AsyncDocumentID
string
Default: ""
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
CustomParams
string
Default: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
string
Default: ""
Additional data to be included in the async state and mirrored back by the requestor.
ExternalHashCalculation
bool
Default: False
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.
If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
HashAlgorithm
string
Default: "SHA256"
Specifies the request's signature hash algorithm.
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_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
KeyID
string
Default: ""
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
KeySecret
string
Default: ""
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the KeyID topic.
Method
AsyncSignMethods
Default: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Mode
ExternalCryptoModes
Default: 0
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
PublicKeyAlgorithm
string
Default: ""
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Constructors
public ExternalCrypto();
Public ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
PGPKey Type
This container represents a PGP key.
Remarks
OpenPGP standard supports several types of keys. In our days, a typical OpenPGP keypair actually consists of two cryptographic keys: a primary key and a subkey. The primary key is normally used for signing, while the subkey is used for encryption.
While it is typical for PGP environments to use a primary key/subkey bundle, this is not a must. Sometimes you may come across standalone keys (mainly when dealing with older implementations), as well as whole key trees, each of those carrying a bunch of differently-purposed subkeys bound to the same primary key.
Algorithm-wise, OpenPGP keys also differ. Generally speaking, OpenPGP supports the following public key algorithms: RSA, Elgamal (often incorrectly referred to as DH), DSA, ECDH and ECDSA. When it comes to primary key/subkey bundles, DSA/Elgamal, RSA/RSA and ECDSA/ECDH pairs are typically used. Although there's no restriction on algorithm bundles, and, e.g. a ECDSA/Elgamal key bundle is perfectly possible, such combination is rarely used in practice.
A typical OpenPGP key is associated with some kind of user ID (Username). It is normally represented with a user's e-mail address, while in theory can be any piece of text. The secret part of the OpenPGP keypair is protected with a password (Passphrase).
Fields
BitsInKey
int (read-only)
Default: 2048
Indicates the key length in bits.
CanEncrypt
bool (read-only)
Default: False
Returns True if this key can be used for encryption.
CanSign
bool (read-only)
Default: False
Returns True if this key can be used for signing.
Curve
string (read-only)
Default: ""
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 |
Enabled
bool
Default: False
Enables or disables this key for use in encryption or signing operation.
EncryptionAlgorithm
string (read-only)
Default: "AES128"
Indicates the symmetric algorithm used to encrypt the secret key.
IsPublic
bool (read-only)
Default: False
Returns True if this key is a public key, and False otherwise.
IsSecret
bool (read-only)
Default: False
Returns True if this key is a secret key, and False otherwise.
IsSubkey
bool (read-only)
Default: False
Returns True if this key is a subkey of another key, and False otherwise.
KeyFP
string (read-only)
Default: ""
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
KeyID
string (read-only)
Default: ""
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.
Passphrase
string
Default: ""
The key protection password.
PassphraseValid
bool (read-only)
Default: False
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
PrimaryKeyID
string (read-only)
Default: ""
If this key is a subkey (IsSubkey returns True), this field contains the identifier of the subkey's primary key.
Protection
PGPProtectionTypes (read-only)
Default: 0
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 |
PublicKeyAlgorithm
string (read-only)
Default: ""
Specifies the asymmetric algorithm of the key.
QBits
int (read-only)
Default: 0
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.
Timestamp
string (read-only)
Default: ""
Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).
Username
string (read-only)
Default: ""
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.
ValidTo
string (read-only)
Default: "0"
Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.
Version
int (read-only)
Default: 0
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.
Constructors
Creates an empty PGP key object.
Create a PGP key object from a key file.
PGPSignature Type
A container for PGP signature properties.
Remarks
PGPSignature contains details and validation information for a PGP signature.
Fields
CertificationType
PGPCertificationTypes (read-only)
Default: 0
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. |
CreationTime
string (read-only)
Default: ""
The time when the signature was created, in Universal Coordinated Time (UTC).
ExpirationTime
int (read-only)
Default: 0
Specifies signature expiration time, in seconds since its creation time (CreationTime).
Ths property set to 0 indicates that the signature never expires.
Exportable
bool (read-only)
Default: False
Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
HashAlgorithm
string (read-only)
Default: ""
Specifies the hash algorithm used in the signature.
HashMark
int (read-only)
Default: 0
Returns the hash mark attribute of a signature.
Check this property to get a hash mark of a signature.
KeyExpirationTime
int (read-only)
Default: 0
The number of seconds after which the signed key will expire.
KeyFlags
int (read-only)
Default: 0
Returns the key flags included in the signature.
Use this property to retrieve the key flags stored in the key signature.
LegacyFormat
bool (read-only)
Default: False
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.
PolicyURL
string (read-only)
Default: ""
Contains the URL of the signature policy.
PreferredAlgorithms
string (read-only)
Default: ""
Contains a list of algorithms preferred by the signed key holder.
PrimaryUserID
bool (read-only)
Default: False
Indicates whether the UserID covered by the signature is the main user id for this key.
ReasonForRevocation
string (read-only)
Default: ""
Describes the reason why the key or the certificate was revoked.
Revocable
bool (read-only)
Default: False
Specifies whether the signature can be revoked.
Revocation
bool (read-only)
Default: False
Indicates whether or not the signature is a revocation signature.
SignatureClass
PGPSignatureClasses (read-only)
Default: 0
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 |
SignerKeyID
string (read-only)
Default: ""
Indicates the KeyID of the signing key.
SignerUserID
string (read-only)
Default: ""
Indicates the UserID associated with the signing key.
StrictlyValid
bool (read-only)
Default: False
Returns True if this signature is valid in a strict way (no compatibility relaxations).
Target
string (read-only)
Default: ""
Indicates the KeyID or Username of the target key or user.
TextSignature
bool (read-only)
Default: False
Indicates whether or not the signature is made over a text document.
TrustAmount
int (read-only)
Default: 0
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.
TrustLevel
int (read-only)
Default: 0
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.
Validated
bool (read-only)
Default: False
Whether the signature has been validated.
Validity
SignatureValidities (read-only)
Default: 0
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) |
Version
int (read-only)
Default: 0
Indicates the signature version.
RFC 4880 defines two versions for PGP signatures: 3 and 4.
Constructors
public PGPSignature();
Public PGPSignature()
Creates an empty PGPSignature object.
Config Settings (PGPReader Component)
The component 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 component, access to these internal properties is provided through the Config method.PGPReader Config Settings
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 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 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.
Trappable Errors (PGPReader Component)
PGPReader 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) |