Fortinet black logo

Administration Guide

Creating a launcher

Creating a launcher

To create a launcher:
  1. Go to Secrets > Secret Launchers.
  2. In the secret launchers list, select Create to create a new secret launcher.
  3. The New Secret Launcher window opens.

  4. Enter the following information:

    Name

    The name of the launcher.

    Type

    From the dropdown, select a type:

    • Other client: Other client launcher type.

    • Remote desktop: RDP client launcher type.

    • SSH client: SSH client launcher type.

    • VNC: VNC client launcher type.

    Executable

    The program file name, e.g., putty.exe for an SSH client.

    Ensure that the program path is already added to the environment variable path in Windows before launching the secret.

    An absolute path is also supported. Use the escape character (\) when using an absolute path, e.g.:

    C:\\Users\\user1\\Documents\\putty.exe

    C:\\Users\\user1\\Documents\\New folder\\putty.exe

    Parameter

    The command line parameters from the Available Variables list.

    Valid field variables are:

    • $DOMAIN

    • $HOST

    • $USER

    • $PASSWORD

    • $VNCPASSWORD

      $VNCPASSWORD is filled with the obfuscated password sometimes used by VNC when saving the password to a file.

    • $PASSPHRASE

      $PASSPHRASE refers to the passphrase of SSH keys.

    • $PUB_KEY

    • $PRI_KEY

    • $URL

    • $PORT

      $PORT is filled in using the port value assigned to the launcher in the template.

    • $TMPFILE

      $TMPFILE is filled in with the path to a temporary file, generally for use with launchers that require loading config files (when launching with non-proxy mode).

    User input variables are:

    • $TARGET

      The $TARGET user input variable can replace the $HOST field variable. This allows you to specify the 'target' at the launch time rather than having it hard coded in secret itself.

    Example

    For putty.exe as the Executable, -|$USER -pw $PASSWORD $HOST are the parameters.

    For putty.exe as the Executable for SSH execution, -l $USER -pw $PASSWORD $HOST -m C:\\Users\\user1\\Desktop\\cmd.txt

    or

    -l $USER -pw $PASSWORD $HOST -m \"C:\\Program Files\\cmd.txt\" are the parameters.

    For the full path of a file, use the escape character double backslash (\\) for the -m parameter.

    Note:

    When there is no space in the path, double quotes are not necessary:

    -l $USER -pw $PASSWORD $HOST -m C:\\Users\\user1\\Desktop\\cmd.txt

    When there is space in the path, double quotes must be used with backslash:

    -l $USER -pw $PASSWORD $HOST -m \"C:\\Program Files\\cmd.txt\"

    Initial Commands

    Configure initializing the environment. See Creating a new launcher command.

    Clean Commands

    Configure cleaning the environment. See Creating a new launcher command.

  5. Click Submit.

Non-proxy environment

When using launchers with non-proxy mode, launchers may require the environment to be initialized beforehand. You may specify this with init-commands and clean-commands.

Note: Init-commands and clean-commands only run in the non-proxy mode.

Creating a new launcher command
To create a new launcher command:
  1. In step 3 when Creating a secret launcher, select Create in the Initial Commands or Clean Commands pane.

    The New Launcher Command window opens.

  2. In Command, enter the command.

    Enter $ to get the list of valid variables.

  3. Click OK.
    • Select the command from the list and then select Edit to edit it.

    • Select command(s) from the list and then select Delete to delete them.

You can create launchers to be used as file launchers for SSH clients, SMB over the Web, SFTP over the Web, and other types of launchers.

Creating launchers via the CLI Example
  1. In the CLI console, enter the following commands:

    config secret launcher

    edit "Example Windows RDP"

    set exe "mstsc.exe"

    set para "/V:$TARGET:$PORT /noConsentPrompt"

    set type rdp

    config init-commands

    edit 1

    set cmd "cmdkey /generic:$TARGET /user:$USER /pass:$PASSWORD"

    next

    end

    config clean-commands

    edit 1

    set cmd "cmdkey /del:$TARGET"

    next

    end

    next

    end

Creating a launcher

To create a launcher:
  1. Go to Secrets > Secret Launchers.
  2. In the secret launchers list, select Create to create a new secret launcher.
  3. The New Secret Launcher window opens.

  4. Enter the following information:

    Name

    The name of the launcher.

    Type

    From the dropdown, select a type:

    • Other client: Other client launcher type.

    • Remote desktop: RDP client launcher type.

    • SSH client: SSH client launcher type.

    • VNC: VNC client launcher type.

    Executable

    The program file name, e.g., putty.exe for an SSH client.

    Ensure that the program path is already added to the environment variable path in Windows before launching the secret.

    An absolute path is also supported. Use the escape character (\) when using an absolute path, e.g.:

    C:\\Users\\user1\\Documents\\putty.exe

    C:\\Users\\user1\\Documents\\New folder\\putty.exe

    Parameter

    The command line parameters from the Available Variables list.

    Valid field variables are:

    • $DOMAIN

    • $HOST

    • $USER

    • $PASSWORD

    • $VNCPASSWORD

      $VNCPASSWORD is filled with the obfuscated password sometimes used by VNC when saving the password to a file.

    • $PASSPHRASE

      $PASSPHRASE refers to the passphrase of SSH keys.

    • $PUB_KEY

    • $PRI_KEY

    • $URL

    • $PORT

      $PORT is filled in using the port value assigned to the launcher in the template.

    • $TMPFILE

      $TMPFILE is filled in with the path to a temporary file, generally for use with launchers that require loading config files (when launching with non-proxy mode).

    User input variables are:

    • $TARGET

      The $TARGET user input variable can replace the $HOST field variable. This allows you to specify the 'target' at the launch time rather than having it hard coded in secret itself.

    Example

    For putty.exe as the Executable, -|$USER -pw $PASSWORD $HOST are the parameters.

    For putty.exe as the Executable for SSH execution, -l $USER -pw $PASSWORD $HOST -m C:\\Users\\user1\\Desktop\\cmd.txt

    or

    -l $USER -pw $PASSWORD $HOST -m \"C:\\Program Files\\cmd.txt\" are the parameters.

    For the full path of a file, use the escape character double backslash (\\) for the -m parameter.

    Note:

    When there is no space in the path, double quotes are not necessary:

    -l $USER -pw $PASSWORD $HOST -m C:\\Users\\user1\\Desktop\\cmd.txt

    When there is space in the path, double quotes must be used with backslash:

    -l $USER -pw $PASSWORD $HOST -m \"C:\\Program Files\\cmd.txt\"

    Initial Commands

    Configure initializing the environment. See Creating a new launcher command.

    Clean Commands

    Configure cleaning the environment. See Creating a new launcher command.

  5. Click Submit.

Non-proxy environment

When using launchers with non-proxy mode, launchers may require the environment to be initialized beforehand. You may specify this with init-commands and clean-commands.

Note: Init-commands and clean-commands only run in the non-proxy mode.

Creating a new launcher command
To create a new launcher command:
  1. In step 3 when Creating a secret launcher, select Create in the Initial Commands or Clean Commands pane.

    The New Launcher Command window opens.

  2. In Command, enter the command.

    Enter $ to get the list of valid variables.

  3. Click OK.
    • Select the command from the list and then select Edit to edit it.

    • Select command(s) from the list and then select Delete to delete them.

You can create launchers to be used as file launchers for SSH clients, SMB over the Web, SFTP over the Web, and other types of launchers.

Creating launchers via the CLI Example
  1. In the CLI console, enter the following commands:

    config secret launcher

    edit "Example Windows RDP"

    set exe "mstsc.exe"

    set para "/V:$TARGET:$PORT /noConsentPrompt"

    set type rdp

    config init-commands

    edit 1

    set cmd "cmdkey /generic:$TARGET /user:$USER /pass:$PASSWORD"

    next

    end

    config clean-commands

    edit 1

    set cmd "cmdkey /del:$TARGET"

    next

    end

    next

    end