VsixSignToolSignSettings Class

Summary

Settings for VsixSignTool Sign command.
Assembly
Cake.VsixSignTool.dll
Namespace
Cake.VsixSignTool
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.VsixSignTool/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["VsixSignToolSignSettings"] class Type type-node

Syntax

public sealed class VsixSignToolSignSettings : AutoToolSettings

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Properties

Name Value Summary
Csp string
Specify the CSP containing the Private Key Container.
DoNotEmbedCertificate bool
Do not embed the signing certificate in either the signature part XML or as a separate part in the package.
DoNotEmbedCertificateInChainSeparately bool
Do not embed the certificates in the certificate chain separately in the package.
EmbedCertificateChain bool
Retrieve and embed the certificates in the certificate chain up to the root authority separately in the package. (This functionality has not been implemented yet.)
EmbedSigningCertificate bool
Embed the signing certificate within the signature part XML. If no "/e." option is specified, "/es" is default.
EmbedSigningCertificateAsSeparate bool
Embed the signing certificate as a separate part in the package.
File string
Specify the signing cert in a file. If this file is a PFX with a password, the password may be supplied with the "/p" option. If the file is P7B file, use the "/csp" and "/k" options to specify the CSP and container name of the private key. This option is mandatory.
FileDigestAlgorithm string
File digest algorithm.
Hash string
Specify the SHA1 hash of the signing cert.
KeyContainerName string
Specify the Key Container Name of the Private Key.
Password string
Specify a password to use when opening the PFX file.
Quiet bool
No output on success and minimal output on failure. As always, VsixSignTool returns 0 on success and 1 on failure.
RFC3161TimestampServerUrl string
RFC3161_timestamp_URL
TimestampDigestAlgorithm string
Use with /tr switch only
TimestampServerUrl string
Specify the timestamp server's URL. If this option is not present, the signed file will not be timestamped. A warning is generated if timestamping fails.
Usage string
Specify the Enhanced Key Usage that must be present in the cert. The parameter may be specified by OID or by string. The default usage is "Code Signing" (1.3.6.1.5.5.7.3.3). (This functionality has not been implemented yet.)

Extension Methods

Name Value Summary
Dump<VsixSignToolSignSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<VsixSignToolSignSettings>(VsixSignToolSignSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VsixSignToolSignSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<VsixSignToolSignSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<VsixSignToolSignSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VsixSignToolSignSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin