CodeSign Rust Reference Documentation

CodeSign

Current Version: 11.6.1
Requires Chilkat Bundle License

Chilkat.CodeSign

Sign, verify, inspect, and remove Authenticode signatures on Windows executables.

Chilkat.CodeSign works directly with Authenticode signatures on Windows executable files such as .exe and .dll. It provides functionality for applying a code-signing signature, validating whether a signed executable can be trusted, extracting signature information, retrieving the signer certificate, and removing an existing signature.

Sign EXE and DLL files

Apply Authenticode signatures to Windows executable files using a certificate and associated private key.

Validate trust

Check whether a signed executable has a valid signature and whether the signing certificate chain can be trusted.

Inspect signatures

Extract details about the Authenticode signature, including signer information and signature-related metadata.

Retrieve signer certificates

Get the certificate used to sign the executable and inspect it with Chilkat.Cert.

Remove signatures

Remove an existing Authenticode signature from a Windows executable when an unsigned output file is required.

Diagnostics

Use detailed diagnostic output to troubleshoot signing, certificate, trust-chain, timestamping, or validation problems.

Common pattern: Load or provide a code-signing certificate that has access to its private key, sign the target .exe or .dll, optionally add timestamping if supported by the signing workflow, then verify the resulting signature and inspect diagnostics if validation does not succeed.

For an extended overview, see CodeSign Class Overview.

Object Creation

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::CodeSign;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let code_sign = CodeSign::new();
// ... the native object is freed when `code_sign` goes out of scope.
pub fn new() -> CodeSign

Creates the underlying native Chilkat object (CodeSign also implements Default). Every method takes &self, so the object never needs to be declared mut. A CodeSign is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for CodeSign

The native object is freed when the CodeSign is dropped — when it goes out of scope, or explicitly with drop(code_sign). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<CodeSign>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match code_sign.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

DebugLogFilePath
// read/write
pub fn debug_log_file_path(&self) -> String
pub fn set_debug_log_file_path(&self, value: &str)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
HeartbeatMs
// read/write
pub fn heartbeat_ms(&self) -> i32
pub fn set_heartbeat_ms(&self, value: i32)
Introduced in version 9.5.0.98

Specifies the approximate interval, in milliseconds, between AbortCheck event callbacks during supported operations. An event handler can request that the current operation be aborted.

The default is 0, which disables AbortCheck callbacks. Setting a positive value enables periodic callbacks when an operation is sufficiently long-running; methods that finish quickly may complete without generating one.

Callback interval: The interval is a scheduling target rather than a real-time guarantee. Callback timing can vary while waiting for private-key hardware, a timestamp authority, certificate-chain processing, or other operating-system services.

More Information and Examples
Event Callback Examples
top
LastErrorHtml
// read-only
pub fn last_error_html(&self) -> String

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
// read-only
pub fn last_error_text(&self) -> String

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
// read-only
pub fn last_error_xml(&self) -> String

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
// read/write
pub fn last_method_success(&self) -> bool
pub fn set_last_method_success(&self, value: bool)

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
UncommonOptions
// read/write
pub fn uncommon_options(&self) -> String
pub fn set_uncommon_options(&self, value: &str)
Introduced in version 9.5.0.97

Provides a comma-separated list of specialized compatibility or validation options. The default is an empty string, which is appropriate for normal use.

OptionEffect
codesign-allow-expired-certPrevents Authenticode verification from failing solely because the signing certificate is expired.
Use only for an explicit trust policy: This option relaxes the certificate-expiration check; it does not disable file-integrity, signature, chain, or other validation checks. It is not a substitute for timestamping. A signature carrying a valid trusted timestamp should ordinarily remain verifiable after the signing certificate expires without this option.

top
VerboseLogging
// read/write
pub fn verbose_logging(&self) -> bool
pub fn set_verbose_logging(&self, value: bool)

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.

top
Version
// read-only
pub fn version(&self) -> String

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

AddSignature
pub fn add_signature(&self, path: &str, cert: &Cert, options: &JsonObject) -> Result<()>
Introduced in version 9.5.0.97

Adds a Microsoft Authenticode signature to the Windows executable or DLL specified by path. The file is modified in place. cert supplies the code-signing certificate and must provide access to its associated private key. options supplies the signing configuration as JSON.

Common options options include:

JSON memberPurpose
hashAlgSelects the file-digest algorithm, such as sha256.
timestampToken.enabledEnables an RFC 3161 timestamp token.
timestampToken.tsaUrlSpecifies the timestamp authority URL.
timestampToken.requestTsaCertRequests inclusion of the timestamp authority certificate.
timestampToken.hashAlgSelects the timestamp-request digest algorithm, such as sha256.
{
  "hashAlg": "sha256",
  "timestampToken": {
    "enabled": true,
    "tsaUrl": "http://timestamp.example.com",
    "requestTsaCert": true,
    "hashAlg": "sha256"
  }
}
Timestamping is strongly recommended: A trusted timestamp records that the signature existed while the code-signing certificate was valid. This normally allows the signature to continue validating after the signing certificate expires, provided the timestamp and certificate chains remain valid under the verifier's trust policy.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

More Information and Examples
Authenticode Sign an Executable (EXE) or DLL
top
GetSignerCert
pub fn get_signer_cert(&self, cert: &Cert) -> Result<()>
Introduced in version 10.0.1

Retrieves the X.509 signer certificate discovered by the most recent call to VerifySignature on this CodeSign object. If the certificate is fully available, cert is loaded with it and the method returns true. Otherwise, the method returns false.

The returned object contains the public certificate only; it does not provide the signer's private key. Call this method after VerifySignature and use the same CodeSign instance.

Certificate retrieval versus trust: Successfully retrieving the signer certificate does not independently validate the signature or establish trust. Use the result of VerifySignature and the returned signature information when making a trust decision.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
RemoveSignature
pub fn remove_signature(&self, path: &str) -> Result<()>
Introduced in version 9.5.0.97

Removes the embedded Authenticode signature from the Windows executable or DLL specified by path. The file is modified in place. Returns true if the signature is successfully removed; otherwise returns false.

Effect of removal: The resulting file is no longer Authenticode-signed and no longer carries the removed publisher and timestamp information. This operation does not delete the signing certificate from a Windows certificate store or alter the private key. Keep a backup when the original signed file must be retained.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

More Information and Examples
Remove the Authenticode Signature from an EXE or DLL
top
VerifySignature
pub fn verify_signature(&self, path: &str, sig_info: &JsonObject) -> Result<()>
Introduced in version 9.5.0.97

Verifies the embedded Microsoft Authenticode signature of the Windows executable or DLL specified by path. Structured information about the signature, signer, certificate chain, digest algorithms, timestamp, and validation result is written to sig_info.

Returns true when the signature satisfies the applicable Authenticode validation checks under the current Windows trust configuration. This includes confirming that the signed portions of the file have not changed and evaluating the signing certificate and timestamp information, as applicable. An unsigned file or a signature that does not validate causes the method to return false. Inspect sig_info and LastErrorText for details.

What successful verification means: Authenticode verifies publisher identity, file integrity, and certificate trust according to the validation policy. It does not prove that the software is bug-free, safe to execute, or free of malicious behavior. Trust results can also depend on the Windows trusted-root store, certificate-chain availability, timestamp validity, revocation policy, and other system trust settings.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

More Information and Examples
Verify Authenticode Signature of EXE or DLL
top

Events

All Chilkat methods are synchronous: the call returns when the work is done. During a call, CodeSign raises three events so your application can show progress and offer a way out. Implement the chilkat::EventHandler trait (every method has a do-nothing default, so implement only the events you need) and install it with set_event_handler:

use chilkat::{CodeSign, EventHandler};

struct Progress;

impl EventHandler for Progress {
    fn percent_done(&mut self, pct: i32) -> bool {
        println!("{pct}%");
        false   // return true to abort the method in progress
    }
    fn progress_info(&mut self, name: &str, value: &str) {
        println!("{name}: {value}");
    }
}

let code_sign = CodeSign::new();
code_sign.set_event_handler(Progress);
code_sign.set_heartbeat_ms(250);   // raise abort_check 4 times per second during Chilkat calls

For a one-off handler the closure methods avoid writing a type; they may be combined, and each replaces the previously set closure for that one event (installing a closure removes a trait handler set earlier, and vice versa):

code_sign.on_percent_done(|pct| { println!("{pct}%"); false });
code_sign.on_progress_info(|name, value| println!("{name}: {value}"));
pub fn set_event_handler<H: EventHandler>(&self, handler: H)

Installs handler as the receiver of this object's events, replacing any handler or closures set earlier. The object owns the handler, which must be Send + 'static.

pub fn clear_event_handler(&self)

Removes the handler and any closures; events are no longer delivered.

AbortCheck fires at regular intervals controlled by the HeartbeatMs property (0, the default, disables it); PercentDone fires when an operation's completion percentage is known; ProgressInfo delivers named progress values. Returning true from abort_check or percent_done aborts the running method, which then returns Err.

Events fire on the thread that called the method, before that method returns. A panic inside a handler aborts the running method and is re-raised to the caller once the native library has returned, so it never unwinds through C frames. To abort a long operation from another thread, share an Arc<AtomicBool> with an abort_check handler, or set the object's AbortCurrent property to true.

AbortCheck
// EventHandler trait method; closure form: on_abort_check(FnMut() -> bool)
fn abort_check(&mut self) -> bool

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

More Information and Examples
Chilkat Event Callback Examples

Example (closure form; the EventHandler trait method is equivalent):

code_sign.set_heartbeat_ms(250);   // call abort_check 4 times per second

let stop = std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false));
let flag = stop.clone();
code_sign.on_abort_check(move || flag.load(std::sync::atomic::Ordering::Relaxed));
// ... another thread may now abort the method in progress with stop.store(true, Ordering::Relaxed)
top
PercentDone
// EventHandler trait method; closure form: on_percent_done(FnMut(i32) -> bool)
fn percent_done(&mut self, pct: i32) -> bool

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pct_done argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pct_done equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples
Chilkat Event Callback Examples

Example (closure form; the EventHandler trait method is equivalent):

code_sign.on_percent_done(|pct| {
    // pct ranges from 1 to 100.
    println!("Percent done: {pct}");
    false   // return true to abort the method in progress
});
top
ProgressInfo
// EventHandler trait method; closure form: on_progress_info(FnMut(&str, &str))
fn progress_info(&mut self, name: &str, value: &str)

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

More Information and Examples
Chilkat Event Callback Examples

Example (closure form; the EventHandler trait method is equivalent):

code_sign.on_progress_info(|name, value| println!("{name}: {value}"));
top