SecureTunnel Command Line

• The SecureTunnel executable is available in form of a command-line utility and a desktop application.

  The command-line utility is helpful when you need to automate the tunnel start and stop.

• The utility works on Windows, Linux and Mac OS systems.

• It works with both HTTP and HTTPS traffic.

• The utility is resource friendly. It doesn’t have any specific requirements and can run on almost any machine, even on a “weak” one.

• For details of the tunnel functioning, see Secure Tunnel.

1. You can download the tunnel desktop app from the product UI.

   1. Log in to BitBar and click Secure Tunnel in the toolbar.

   2. In the subsequent dialog box, click the link on the Desktop tab page to download the SecureTunnel executable (SBSecureTunnel.exe):

      

      Click the image to enlarge it.

      Note:

      BitBar automatically provides the package that matches your operating system: Windows, Linux, or MacOS.

That’s all. You can run the downloaded executable as it is. Depending on the security settings, the operating system may ask your permission to run it. Grant the permission.

In general case, you can start the tunnel from the BitBar website or on your computer (see Secure Tunnel Desktop App). Using the command-line utility implies that you start the tunnel  from your computer. Open the command line window and enter the command like this:

Here, --username is your BitBar account (email address), and --authkey is your authentication key (also called API key). --acceptAllCerts commands the tunnel to accept security certificates. For detailed information on supported command-line parameters, see below.

Tip: You can get the needed command line at any time on the BitBar website: open the Secure Tunnel dialog box and select the needed options on the Command Line tab. The dialog will update the sample command line respectively:

Click the image to enlarge it.

The tunnel connects to the geo.tunnel.smartbear.com server through port 443. It is important that proxies and firewalls running in your network allow connection to this URL and port.

After the tunnel is up and running, you can create or run your tests as you regularly do. For details, see the following links:

Regardless of the way you started the tunnel, you can close it on the BitBar website: open the Secure Tunnel dialog box and click Disconnect.

Click the image to enlarge it.

You can also close the tunnel from the command line by using the --kill parameter. See below.

The utility supports special parameters to enable you to configure every aspect of tunnel functioning. The parameters can be organized into the following logical groups:

By using the SBSecureTunnel command-line utility, you can start SecureTunnel in various configurations. In every call, you should specify these parameters:

• --username is the name of your BitBar account (for example, john.smith@mycompany.com).

• --authkey is your authentication key (also called API key).

  How to get the API key

  How to get the API keyHow to get the API key

  1. Log in to BitBar, click the user icon in the top-right corner, and select My Account.

  2. Go to [My Integrations] API Access > API tab and copy the API key value:

     

     Click the image to enlarge it.

In most cases, you will run the utility with the following parameters:

This call initiates the tunnel of the Internal Websites type with the the Accept all SSL certificates and Bypass tunnel for public URLs settings enabled (for more information on them, see Tunnel Settings).

Note that the Internal Websites mode is used by default and doesn’t require any command-line argument for activation. The same is with the Bypass … setting.

To run the tunnel in the Tunnel Settings mode, add the --proxyIp and --proxyPort parameters to the command line:

Currently, BitBar doesn’t support this mode.

By default, the Bypass tunnel for public URLs setting is on and you don’t need to add anything to the command line to activate it.

If you need to disable the setting, add --bypass false to the command line:

To enable the Accept all SSL certificates setting, add --acceptAllCerts to the command line. If this parameter is absent, the setting is off: