jsecret, jtool secret

The jsecret executable is a platform agent tool. It creates an encrypted connection file which acts like password file, containing all the necessary information to connect to the central Redwood Server, like username, password, hostname and port of the central Redwood Server. These connection files can be used by various platform agent tools such as jevent.

It can also be used to generate a shared secret, which is used by the platform agent and the central Redwood Server to ensure the desired process server, from the desired central Redwood Server, is connected to the desired platform agent.

Generating a Connection File

jsecret -c [-proxy <url>] [-auth <method>] <filename> <url>

Argument	Description
-c	Create a connection file
<filename>	The name of the file
-proxy <url>	The proxy server to use
-auth <method>	The authentication method to use for the proxy; <method> can be either basic (default) or none when the proxy server requires no authentication
<url>	The URL of the target system, such as http[s]://<hostname>:<port>/<context>, for example https://pr1.example.com:10180/redwood

Proxy Settings

The following environment variables are used to retrieve proxy server connection details:

• HTTP_PROXY - The URL to the proxy server, https://proxy.example.com:3128
• PROXY_USER - The user for the proxy server, ignored if HTTP_PROXY is not set
• PROXY_PASSWORD - The password for the proxy user, ignored if HTTP_PROXY is not set
• NO_PROXY - Enforce a direct connection

note

These environment variables override the settings in the connection file for all tools that connect to the central Redwood server.

Generating a Shared Secret File

jsecret -n <filename>

Argument	Description	Default
-n	Create a shared secret
<filename>	path to the file	net/instance/<instance_name>/private/secret

Generating a proxy_url_password secret file

jsecret -p <filename>

Argument	Description	Default
-p	Create a file containing the password to the proxy server as defined in the proxy_url configuration file. You move the output file of this command to proxy_url_password and store it in the private directory for your platform agent instance.
<filename>	path to the file	<install_directory>/net/instance/<instance_name>/private/proxy_url_password

Generating MD5 Checksums

jsecret -md5 <filename>

Argument	Description
-md5	Create an md5 checksum of the file
<filename>	Name of the file

Generating SHA1 Checksums

jsecret -sha1 <filename>

Argument	Description
-sha1	Create a SHA1 checksum of the file
<filename>	Name of the file

Generating SHA256 Checksums

jsecret -sha256 <filename>

Argument	Description
-sha256	Create a SHA256 checksum of the file
<filename>	Name of the file

Examples

Generating a connection file for raising events

$ jsecret -c ./example.conn https://pr1.example.com:50000/redwood
Username:admin
Password:*****
$ ls -l ./example.conn
-rw------- 1 redwood users 240 nov 18 15:16 ./example.conn

Generating a connection file for jftp

$ jsecret -c ./ftp.sec ftp://ftp.example.com:21
Username:admin
Password:*****
$ ls -l ./ftp.sec
-rw------- 1 redwood users 240 nov 18 15:17 ./ftp.sec

Generating a connection file in a process

(jecho "username"&&jecho "password") | jsecret -c ./ftp.sec ftp://ftp.example.com:21

Generating a shared secret file

jsecret -n net/instance/<instance>/private/secret

Generating a proxy_url_password file

jsecret -p net/instance/<instance>/private/proxy_url_password

note

The proxy_url and proxy_url_password files can contain more than one URL/password in a comma-separated list. See Configuring Platform Agents for more information.

See Also

• Command Line System Tools