IDigitalSignature
Declaration
IDigitalSignature: IDispatch
Overview
This component is meant to edit digital signature details.
Properties
Bool EnableSigning - Gets or sets the “Enable signing” checkbox.
String Description - Gets or sets the signature property description.
String DescriptionURL - Gets or sets the signature property description URL.
String TimestampServiceURL - Gets or sets the signature property timestamp service URL.
String TimestampDelayMs - Gets or sets the signature property timestamp delay in ms.
Bool EnableInstallingPatcheshWithoutElevation - Gets or sets the “Enable installing of patches for this product without elevation” checkbox.
Array<IDigitalCertificate> Certificates - Gets all certificates from the personal certificate store.
String AzureAppID - Gets or sets the ID of the Azure application that has access to Key Vault.
String AzureCertificateName - Gets or sets the name of the certificate stored in the Key Vault.
String AzureCertificateVersion - Gets or sets the version of the certificate stored in the Key Vault.
String AzureTenantID - Gets or sets the Azure active directory where Key Vault resides.
String AzureVaultName - Gets or sets the name of the Key Vault.
String CertificateFile - Gets the path on disk to the certificate when the "Use file from disk" option is selected.
CertificateSource - Gets or sets the certificate source:
0 for
the "Use from certificate store" option
1 for the "Use file from disk" option
2
for the "Use from Azure Key Vault" option
3 for the "Use Device Guard" option>
4
is set when the "Enable signing" option is unchecked
5 for the "Use Trusted Signing"
option
String Password - Gets the Private Key password when the "Use file from disk" option is selected
Array PredefinedTimestampServices - Gets the predefined timestamp services.
StoreCertificate - Gets the information of the selected certificate when the "Use from certificate store" option is enabled.
String TrustedSignerAccountName - Gets or sets the Code Signing Account name.
String TrustedSignerCertName - Gets or sets the Certificate Profile name.
String TrustedSignerCorrelationID - Gets or sets the Correlation ID.
String TrustedSignerEndPoint - Gets or sets the End Point.
Methods
SetUseFromPersonalCertificate(IDigitalCertificate certificate = Null)
This method sets the software publisher certificate to “Use from Personal certificate
store:” with the specified certificate. In case of a default value of null for the
certificate, the most suited certificate is used.
SetUseFileFromDisk(String filePath)
This method sets the software publisher certificate to “Use file from disk” with the
specified filePath. To set password policy use SetCertificatePasswordAutomatically or
SetCertificatePasswordManually methods.
CreatePersonalCertificate() returns IDigitalCertificate
This
method creates a new digital certificate and returns it.
SetCertificatePasswordAutomatically(String password)
This method
sets the password policy to store the encrypted password in the project file. This method is
available only when a certificate from disk is used and that certificate requires a
password.
SetCertificatePasswordManually()
This method sets the password
policy to enter a password each time project is built. This method is available only when a
certificate from disk is used and that certificate requires a password.
SetAzureKeyVaultSecret(String aSecret, Bool
aUseEnvironmentVariable)
This method sets the Azure Key Vault secret. The secret
can be stored in an environment variable.
SetDeviceGuardCredentials(String aUser, String aPassword, Bool
aUseEnvironmentVariable)
This method sets the Device Guard credentials. The
password can be stored in an environment variable
CreateCertificate (string PublisherId, string aPublisherDisplayName) -
returns IDigitalCertificate
This method creates a new digital certificate with the
specified publisher ID and publisher display name and returns it.