SignToolSignSettings Class

Summary

Contains settings used by SignToolSignRunner.
Namespace
Cake.Common.Tools.SignTool
Base Types
graph BT Type-->Base0["ToolSettings"] click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base0-->Base1["object"] Type["SignToolSignSettings"] class Type type-node

Syntax

public sealed class SignToolSignSettings : ToolSettings

Properties

Name Value Summary
AdditionalCertPath FilePath
Gets or sets the path to an additional certificate that is to be added to the signature block.
AppendSignature bool
Gets or sets a value indicating whether the signature should be appended
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
CertPath FilePath
Gets or sets the PFX certificate path.
CertSubjectName string
Gets or sets the name of the subject of the signing certificate. This value can be a substring of the entire subject name.
CertThumbprint string
Gets or sets the thumbprint for locating a certificate in the store.
Description string
Gets or sets the signed content's description.
DescriptionUri Uri
Gets or sets the signed content's expanded description URL.
DigestAlgorithm SignToolDigestAlgorithm
Gets or sets the file digest algorithm
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
Inherited from ToolSettings
Password string
Gets or sets the PFX certificate password.
StoreName string
Gets or sets the store to open when searching for the certificate.
TimeStampDigestAlgorithm SignToolDigestAlgorithm
Gets or sets the timestamp digest algorithm
TimeStampUri Uri
Gets or sets the timestamp server's URL. Timestamp will only be added if TimeStampUri is set.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
UseMachineStore bool
Gets or sets a value indicating whether a machine store, instead of a user store, is used.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<SignToolSignSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SignToolSignSettings>(SignToolSignSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<SignToolSignSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<SignToolSignSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<SignToolSignSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<SignToolSignSettings>(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