Back to Contents


The KeyStore class

Summary:

See also: The Genero Web Services XML Library


Syntax

The KeyStore class provides static methods to handle a key store global to the entire application. It enables to register X509 and trusted certificates, and any kind of key by name for automatic XML signature validation or XML decryption.

The status is set to zero after a successful method call.

Syntax

xml.KeyStore

Methods

Class Methods
Name Description
xml.KeyStore.AddTrustedCertificate(
  cert xml.CryptoX509)
Registers the given X509 certificate as a trusted certificate for the application. It will be used for signature verification if no other certificate was set for that purpose.
Note: has the same effect as the FGLPROFILE entry xml.keystore.calist
Throws an exception in case of errors, and updates status with an error code.
xml.KeyStore.AddCertificate(
  cert xml.CryptoX509)
Registers the given X509 certificate as a certificate for the application. It will be used when an incomplete X509 certificate is detected during signature or encryption to complete the process by checking the certificate issuer name and serial number.
Note: has the same effect as the FGLPROFILE entry xml.keystore.x509list
Throws an exception in case of errors, and updates status with an error code.
xml.KeyStore.AddKey(
  key xml.CryptoKey)
Registers the given key by name to the application. It is used for XML signature verification or XML decryption when a key name was specified in the XML KeyInfo node and no other key was set in the Signature or Encryption object.
Note: the CryptoKey must have the KeyName feature set, and the name must be unique in the application
Throws an exception in case of errors, and updates status with an error code.

Back to the top