Jws ConfigurationThe 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.
JWS Configuration Settings
Allowed signing algorithms when StrictValidation is set to True.This setting specifics a comma separated list of algorithms that are allowed when StrictValidation is set to true. This allows multiple signing algorithms to be considered acceptable during validation. This setting is only applicable when StrictValidation is set to true. Possible values:
Example value: HS512,HS256.
|CloseInputStreamAfterProcess: Whether to close the input stream after processing.This setting specifies whether the stream set by SetInputStream is closed after processing the message. The default value is True.|
|CloseOutputStreamAfterProcess: Whether to close the output stream after processing.This setting specifies whether the stream set by SetOutputStream is closed after processing the message. The default value is True.|
The certificate values to include in the signed message (if any).This setting specifies whether information about the Certificate is included in the signed message.
When specified, the value here determines the format of the included certificate information. The
certificate information is included as a standard JWS header parameter.
Multiple formats may be included in the signed message. The value specified should be the binary 'OR' of one or more of the following values:
Note: When including the certificate chain (0x01) the public certificate of Certificate will automatically be included. IssuerCerts may also be set to the public issuer certificates that will be used when building the chain to include.
For instance, to include both the certificate chain and SHA-256 thumbprint of the Certificate set this to 5.
A collection of issuer certificates used with IncludeCertificateFormat.This setting optionally specifies one or more issuer certificates that may be used by the component when IncludeCertificateFormat
is specified. Note that the issuer certificates specified here are used as a store of potential issuer certificates. At
runtime the component will inspect the Certificate value and add the relevant issuer certificates that are present
in this property.
The format of the value must be one or more PEM encoded certificates with headers and footers. For instance to include 2 issuer certificates the value may be:
The encoding of the Key value.This setting specifies the encoding that has been applied to the Key. value prior to providing it to the component.
The Key is typically represented as an array of bytes, however in some cases the key value may have been encoded.
As a matter of convenience the component will accept the key with an encoding already applied. The component
will decode the key value according the to the value specified here before processing. Possible values are:
Holds the raw JOSE header.This setting may be queried after calling Sign or Verify to obtain the raw JOSE header. This returns a JSON string like:
Determines the serialization type to use when reading and writing JWS content.This setting is used to control the serialization type the component uses when reading and writing JWS content. Possible values are:
|StrictValidation: Requires a specific algorithm when verifying signatures.If set to True the component will validate that the Algorithm in the JWS message matches the value specified in the Algorithm property. If it does not an error is thrown. By default this is False and the algorithm is read and used automatically from the message. Enabling this setting provides a way to require a specific algorithm when calling VerifySignature.|
Base Configuration Settings
|BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build.|
Tells the component whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.
In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:
|UseDaemonThreads: Whether threads created by the component are daemon threads.If set to True (default), when the component creates a thread the thread's Daemon property will be explicitly set to True. When set to False the component will not set the Daemon property on the created thread. The default value is True.|
|UseInternalSecurityAPI: Tells the component whether or not to use the system security libraries or an internal implementation. By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API.|