CkCodeSign Ruby Reference Documentation
CkCodeSign
Current Version: 10.0.0
A class for signing Windows executables and DLLs, and for verifying signed executables and DLLs. This is a Windows-only class. The class and functions will exist on non-Windows systems, but will be no-op functions (stubs) that simply return a failed status.
Object Creation
obj = Chilkat::CkCodeSign.new()
Properties
DebugLogFilePath
# ckStr is a CkString
codeSign.get_DebugLogFilePath(ckStr);
strVal = codeSign.debugLogFilePath();
codeSign.put_DebugLogFilePath(strVal);
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
# ckStr is a CkString
codeSign.get_LastErrorHtml(ckStr);
strVal = codeSign.lastErrorHtml();
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
# ckStr is a CkString
codeSign.get_LastErrorText(ckStr);
strVal = codeSign.lastErrorText();
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
# ckStr is a CkString
codeSign.get_LastErrorXml(ckStr);
strVal = codeSign.lastErrorXml();
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
boolVal = codeSign.get_LastMethodSuccess();
codeSign.put_LastMethodSuccess(boolVal);
Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = true and failure = false.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topUncommonOptions
# ckStr is a CkString
codeSign.get_UncommonOptions(ckStr);
strVal = codeSign.uncommonOptions();
codeSign.put_UncommonOptions(strVal);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
Can be set to a list of the following comma separated keywords:
- "codesign-allow-expired-cert" - Don't fail authenticode signature validation because the signing certificate is expired.
Utf8
boolVal = codeSign.get_Utf8();
codeSign.put_Utf8(boolVal);
When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = codeSign.get_VerboseLogging();
codeSign.put_VerboseLogging(boolVal);
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
# ckStr is a CkString
codeSign.get_Version(ckStr);
strVal = codeSign.version();
Methods
AddSignature
# cert is a CkCert
# options is a CkJsonObject
status = codeSign.AddSignature(path, cert, options);
Authenticode signs a DLL or EXE.
Returns true for success, false for failure.
AddSignatureAsync (1)
# path is a string
# cert is a CkCert
# options is a CkJsonObject
ret_task = codeSign.AddSignatureAsync(path, cert, options);
Creates an asynchronous task to call the AddSignature method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns nil on failure
topRemoveSignature
status = codeSign.RemoveSignature(path);
Removes the authenticode signature of a Windows executable or DLL. The path to the executable/DLL is passed in path.
Returns true for success, false for failure.
VerifySignature
Verifies the signature of a Windows executable or DLL. The path to the executable/DLL is passed in path. Information about the signature is returned in sigInfo. Returns true if the signature is verified indicating the EXE or DLL can be trusted. Otherwise returns false.
Returns true for success, false for failure.