Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Available on (crate features rustls-tls or native-tls) and (crate features rustcrypto or openssl) only.

Builds an UnregisteredClient

Implementations

impl ClientBuilder

pub fn new() -> Self

Create a new builder with no options defined.

pub fn with_rsa_key_size(self, num_bits: usize) -> Self

Sets the RSA key size that the builder will generate for the client.

pub fn with_server(self, server: String) -> Self

Sets the Interactsh server that the client will connect to.

pub fn with_auth_token(self, auth_token: String) -> Self

Sets an optional auth token that the client will use to authenticate with the Interactsh server.

If this is not set, then no auth header will be sent to the server.

pub fn with_proxy(self, proxy: Proxy) -> Self

Sets an optional proxy that the client can use.

This can be set more than once; each new proxy will be added to a list of proxies that the client will try. Proxies will be tried in the order added.

pub fn with_timeout(self, timeout: Duration) -> Self

Sets the timeout value for server requests.

pub fn verify_ssl(self, ssl_verify: bool) -> Self

Sets whether or not the client should verify the server’s SSL certificate.

pub fn parse_logs(self, parse_logs: bool) -> Self

Sets whether or not the client should parse the logs or just return the raw logs.

pub fn set_dns_override(self, server_ip_address: IpAddr) -> Self

Sets an option on the client to override normal DNS resolution for the server and instead use the provided IP address.

pub fn build(self) -> Result<UnregisteredClient, ClientBuildError>

Builds an UnregisteredClient.

The server must be set and the RSA key generated in order for this to succeed. If the build succeeds, the register function must be called on the returned UnregisteredClient to turn it into a RegisteredClient.

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Create a new builder with the default options.

This will create a builder with a 2048 bit RSA key and server randomly picked from the list of default servers provided and maintained by the Interactsh team. This will also set the timeout to 15 seconds, SSL verification to false, and parse_logs to true.