Connect to a scuttlebot/secret-stack server, and call a method on it, with
Connect to a scuttlebot/secret-stack server, and call a method on it, with
standard I/O.
standard I/O.
.ShOPTIONS
.ShOPTIONS
.Bl-tag
.Bl-tag-widthDs
.ItFlj
.ItFlj
Send stdin data as JSON.
Send stdin data as JSON.
.ItFll
.ItFll
Don't output newlines after string or JSON packets.
Don't output newlines after string or JSON packets.
.ItFlr
.ItFlr
Raw mode. Disables stdin line buffering/editing and echoing. Implies
Raw mode.
Disables stdin line buffering/editing and echoing.
Implies
.Fll.
.Fll.
.ItFle
.ItFle
Encode arguments as strings, rather than expecting them to be JSON-encoded.
Encode arguments as strings, rather than expecting them to be JSON-encoded.
.ItFlT
.ItFlT
Test using shs1-testsuite protocol. Instead of connecting to a peer and calling a RPC method, connect to stdio. On successful handshake, output concatenation of
Test using shs1-testsuite protocol.
Instead of connecting to a peer and calling a RPC method, connect to stdio.
On successful handshake, output concatenation of
the encryption key, encryption nonce, decryption key and decryption nonce.
the encryption key, encryption nonce, decryption key and decryption nonce.
.ItFla
.ItFla
Passthrough mode. Instead of making a muxrpc call, pass through the box-stream
Passthrough mode.
Instead of making a muxrpc call, pass through the box-stream
to stdio.
to stdio.
.ItFln
.ItFln
Noauth mode. Skip secret-handshake authentication and box-stream encryption.
Noauth mode.
Skip secret-handshake authentication and box-stream encryption.
This option makes the
This option makes the
.Flk,
.Flk,
.FlK,
.FlK,
@ -77,31 +83,37 @@ Connect to server over IPv6 only.
.ItFld
.ItFld
Listen for an incoming connection instead of making an outgoing connection.
Listen for an incoming connection instead of making an outgoing connection.
.ItFlcArcap
.ItFlcArcap
Capability key for secret-handshake. Default is SSB's capability key,
Capability key for secret-handshake.
Default is SSB's capability key,
.Li1KHLiKZvAvjbY1ziZEHMXawbCEIM6qwjCDm3VYRan/s=.
.Li1KHLiKZvAvjbY1ziZEHMXawbCEIM6qwjCDm3VYRan/s=.
.ItFlsArhost
.ItFlsArhost
The hostname to connect to. Default is localhost. If set to localhost and connection to localhost fails,
The hostname to connect to.
Default is localhost.
If set to localhost and connection to localhost fails,
.Nm
.Nm
may attempt to connect to other local interface addresses.
may attempt to connect to other local interface addresses.
.ItFlpArport
.ItFlpArport
The port to connect to. Default is 8008.
The port to connect to.
Default is 8008.
.ItFluArsocket_path
.ItFluArsocket_path
Unix socket path to connect to, instead of TCP socket. Conflicts with
Unix socket path to connect to, instead of TCP socket.
Conflicts with
.Flp
.Flp
and
and
.Fls.
.Fls.
.ItFlkArkey
.ItFlkArkey
The key to connect to. Default is your public key, as read from your
The key to connect to.
private key file or the
Default is your public key, as read from your private key file or the
.FlK
.FlK
option. In listen mode (
option.
In listen mode (
.Fld
.Fld
), if
), if
.Flk
.Flk
is specified, only a connection from the given key is accepted; otherwise a connection from any key is accepted.
is specified, only a connection from the given key is accepted; otherwise a connection from any key is accepted.
.ItFlKArkeypair
.ItFlKArkeypair
Private key or private key seed to use for secret-handshake. Default is to use the private key
Private key or private key seed to use for secret-handshake.
from your
Default is to use the private key from your
.Pa~/.ssb/secret
.Pa~/.ssb/secret
file or other secret file according to the environmental variables described in
file or other secret file according to the environmental variables described in
.SxENVIRONMENT.
.SxENVIRONMENT.
@ -117,22 +129,26 @@ Default is to look up the method in
.ItArmethod
.ItArmethod
Method name.
Method name.
.ItOpArargument...
.ItOpArargument...
Arguments to pass to the method call. Each argument must be JSON-encoded, unless the
Arguments to pass to the method call.
Each argument must be JSON-encoded, unless the
.Fle
.Fle
option is used, in which the arguments are treated as strings.
option is used, in which the arguments are treated as strings.
.El
.El
.ShENVIRONMENT
.ShENVIRONMENT
.Bl-tag
.Bl-tag-widthDs
.ItEvssb_appname
.ItEvssb_appname
Name of the app. Default is
Name of the app.
Default is
.Dqssb.
.Dqssb.
Used to construct the app's directory if
Used to construct the app's directory if
.Evssb_path
.Evssb_path
is not present.
is not present.
.ItEvssb_path
.ItEvssb_path
Path to the app's directory. Default is to use
Path to the app's directory.
.Evssb_appnametoconstructthepathas
Default is to use
.Dq~/.<ssb_appname>
.Evssb_appname
to construct the path as
.Dq~/.<ssb_appname>.
.El
.El
.ShFILES
.ShFILES
.Bl-tag-width-indent
.Bl-tag-width-indent
@ -164,8 +180,8 @@ or
.FlT
.FlT
are specified,
are specified,
.Nm
.Nm
will attempt to connect in noauth mode to this socket file. If the socket file
will attempt to connect in noauth mode to this socket file.
is not present or the connection fails,
If the socket file is not present or the connection fails,
.Nm
.Nm
will fall back to connecting with TCP and secret-handshake according to the
will fall back to connecting with TCP and secret-handshake according to the
config file - unless the
config file - unless the
@ -193,6 +209,5 @@ The command completed with an error.