1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
# go-sendxmpp
## about
A tool to send messages to an XMPP contact or MUC inspired by [sendxmpp](https://sendxmpp.hostname.sk/).
You can find other sendxmpp alternatives in the [XSF wiki](https://wiki.xmpp.org/web/User:MDosch/Sendxmpp_incarnations).
## support
You might join the [chat](https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join) if you have problems,
want to contribute or just want to talk about the project. You might also talk about any of the other
sendxmpp incarnations. :)
[](https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join)
## installation
### repositories including go-sendxmpp
[](https://repology.org/project/go:sendxmpp/versions)
### manual installation
#### requirements
* [go](https://golang.org/)
#### instructions
Latest release:
```plain
$ go install salsa.debian.org/mdosch/go-sendxmpp@latest
```
Current development version:
```plain
$ go install salsa.debian.org/mdosch/go-sendxmpp@master
```
You will find the binary in `$GOPATH/bin` or, if set, `$GOBIN`.
### binaries
There are some (automatically built and untested) binaries linked to the
[release](https://salsa.debian.org/mdosch/go-sendxmpp/-/releases).
## usage
You can either pipe a programs output to `go-sendxmpp`, write in your terminal (put \^D in a new
line to finish) or send the input from a file (`-m` or `--message`).
The account data is expected at `~/.config/go-sendxmpp/config` if no other configuration file location
is specified with `-f` or `--file`. The configuration file is expected to be in the following format:
```plain
username: <your_jid>
password: <your_jabber_password>
```
If this is not sufficient to connect you might also specify `jserver` and `port`. It is also possible to
use a password manager. In this case the `password` setting should be replaced by the `eval_password`
setting:
```
eval_password: <command_to_unlock_your_password>
```
You can also configure the alias/nickname for MUCs via the `alias` setting:
```
alias: <my_alias>
```
If no configuration file is present or if the values should be overridden it is possible to define
the account details via command line options:
```plain
Usage: go-sendxmpp [-cdilntv] [-a value] [--allow-plain] [--anonymous] [--fast-invalidate] [--fast-off] [-f value] [--headline] [--help] [-h value] [-j value] [--legacy-pgp] [-m value] [--muc-password value] [--no-sasl-upgrade] [--oob-file value] [--ox] [--ox-delete-nodes] [--ox-genprivkey-rsa] [--ox-genprivkey-x25519] [--ox-import-privkey value] [--ox-passphrase value] [-p value] [--raw] [-r value] [--retry-connect value] [--retry-connect-max value] [--scram-mech-pinning value] [--ssdp-off] [-s value] [--suppress-root-warning] [--timeout value] [--tls-version value] [-u value] [--version] [recipients…]
-a, --alias=value Set alias/nicknamefor chatrooms.
--allow-plain Allow PLAIN authentication.
--anonymous Use anonymous authentication.
-c, --chatroom Send message to a chatroom.
-d, --debug Show XMPP stanzas.
--fast-invalidate
Invalidate XEP-0484: Fast Authentication Streamlining Tokens.
--fast-off Disable XEP-0484: Fast Authentication Streamlining Tokens.
-f, --file=value Set configuration file. (Default:
~/.config/go-sendxmpp/sendxmpprc)
--headline Send message as type headline.
--help Show help.
-h, --http-upload=value
Send a file via http-upload. Can be invoked several times to upload multiple files.
-i, --interactive Interactive mode (for use with e.g. 'tail -f').
-j, --jserver=value
XMPP server address.
--legacy-pgp Use "Legacy PGP" encryption using the Ox key infrastructure
(experimental and not encouraged).
-l, --listen Listen for messages and print them to stdout.
-m, --message=value
Set file including the message.
--muc-password=value
Password for password protected MUCs.
--no-sasl-upgrade
Disable XEP-0480: SASL Upgrade Tasks.
-n, --no-tls-verify
Skip verification of TLS certificates (not recommended).
--oob-file=value
URL to send a file as out of band data.
--ox Use "OpenPGP for XMPP" encryption (experimental).
--ox-delete-nodes
Delete existing OpenPGP nodes on the server.
--ox-genprivkey-rsa
Generate a private OpenPGP key (RSA 4096 bit) for the given
JID and publish the corresponding public key.
--ox-genprivkey-x25519
Generate a private OpenPGP key (x25519) for the given JID
and publish the corresponding public key.
--ox-import-privkey=value
Import an existing private OpenPGP key.
--ox-passphrase=value
Passphrase for locking and unlocking the private OpenPGP
key.
-p, --password=value
Password for XMPP account.
--raw Send raw XML.
-r, --recipients=value
Read recipients from file.
--retry-connect=value
Time to retry to connect after failed connection in seconds.
(0 = disabled)
--retry-connect-max=value
Number of maximum retries to perform for '--retry-connect'.
(0 = unlimited)
--scram-mech-pinning=value
Enforce the use of a certain SCRAM authentication mechanism.
--ssdp-off Disable XEP-0474: SASL SCRAM Downgrade Protection.
-s, --subject=value
Set message subject.
--suppress-root-warning
Suppress warning when run as root.
--timeout=value
Connection timeout in seconds. [10]
-t, --tls Use direct TLS.
--tls-version=value
Minimal TLS version. 10 (TLSv1.0), 11 (TLSv1.1), 12
(TLSv1.2) or 13 (TLSv1.3). [12]
-u, --username=value
Username for XMPP account.
-v, --verbose Show debug information.
--version Show version information.
```
### examples
Send a message to two recipients using a configuration file.
```bash
cat message.txt|go-sendxmpp -f ./sendxmpp recipient1@example.com recipient2@example.com
```
Send a message to two recipients directly defining account credentials.
```bash
cat message.txt|go-sendxmpp -u bob@example.com -p swordfish recipient1@example.com recipient2@example.com
```
Send a message to two groupchats (`-c`) using a configuration file.
```bash
cat message.txt|go-sendxmpp -cf ./sendxmpp chat1@conference.example.com chat2@conference.example.com
```
Send file changes to two groupchats (`-c`) using a configuration file.
```bash
tail -f example.log|go-sendxmpp -cif ./sendxmpp chat1@conference.example.com chat2@conference.example.com
```
Send a notification if a long running process finishes.
```bash
waitpid $(pidof -s rsync) && echo "Rsync finished."|go-sendxmpp recipient@example.com
```
### shell completion
There are no shell completions yet (contributions welcome) but for zsh it is possible to automatically create completions from `--help` and for fish it is possible to create completions from the man page.
Those might work *good enough*.
#### zsh
Just place the following in your `~/.zshrc` or `~/.zshrc.local`:
``` bash
compdef _gnu_generic go-sendxmpp
```
#### fish
Fish can generate them from the man page with following command:
``` bash
fish_update_completions
```
|
