Archives/go-sendxmpp
2
0
Fork 0
mirror of https://salsa.debian.org/mdosch/go-sendxmpp synced 2024-11-12 13:10:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add infos about SCRAM auth mechanism pinning to man page.

Browse Source
This commit is contained in:
Martin Dosch 2023-11-11 19:10:34 +01:00
parent 80f37b1e67
commit df5f149dab
No known key found for this signature in database
GPG Key ID: 52A57CFCE13D657D
3 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/go-sendxmpp.1
View File

@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GO\-SENDXMPP" "1" "October 2023" ""
.TH "GO\-SENDXMPP" "1" "November 2023" ""
.SH "NAME"
\fBgo\-sendxmpp\fR \- A tool to send messages to an XMPP contact or MUC\.
.SH "SYNOPSIS"
@ -97,6 +97,8 @@ Username for XMPP account (JID)\.
.TP
\fB\-\-version\fR
Show version information\.
.SH "SCRAM"
Go\-sendxmpp supports \fISalted Challenge Responce Authentication Mechanism\fR (SCRAM)\. If go\-sendxmpp successfully connects using SCRAM it will create a file \fB~/\.local/share/go\-sendxmpp/[your_jid]/authmechanism\fR containing the name of the used mechanism\. It will read this file and use the same mechanism for future connections and fail if it is not available\. This is to protect against downgrades by a \fIMachine In The Middle\fR (MITM)\. If you want to upgrade to another mechanism (e\.g\. if SCRAM\-SHA\-1\-PLUS gets available for your server that previously only supported SCRAM\-SHA\-1) you have to manually edit the file\. It is not recommended to delete the file and let go\-sendxmpp recreate it as this would make it vulnerable to downgrade attacks for the next connection attempt\.
.SH "SHELL COMPLETIONS"
.SS "ZSH"
There are no shell completions yet (contributions welcome) but for zsh it is possible to automatically create completions from \fB\-\-help\fR which might work good enough\.

16
man/go-sendxmpp.1.html
View File

@ -57,6 +57,7 @@
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#SCRAM">SCRAM</a>
<a href="#SHELL-COMPLETIONS">SHELL COMPLETIONS</a>
<a href="#CHAT">CHAT</a>
<a href="#AUTHOR">AUTHOR</a>
@ -195,6 +196,19 @@ To send raw XML to a MUC you have to specify the MUC via <code>-c</code> and go-
<dd>Show version information.</dd>
</dl>
<h2 id="SCRAM">SCRAM</h2>
<p>Go-sendxmpp supports <em>Salted Challenge Responce Authentication Mechanism</em> (SCRAM).
If go-sendxmpp successfully connects using SCRAM it will create a file
<code>~/.local/share/go-sendxmpp/[your_jid]/authmechanism</code> containing the name of the
used mechanism. It will read this file and use the same mechanism for future connections
and fail if it is not available. This is to protect against downgrades by a
<em>Machine In The Middle</em> (MITM). If you want to upgrade to another mechanism (e.g.
if SCRAM-SHA-1-PLUS gets available for your server that previously only supported
SCRAM-SHA-1) you have to manually edit the file. It is not recommended to delete
the file and let go-sendxmpp recreate it as this would make it vulnerable to downgrade
attacks for the next connection attempt.</p>
<h2 id="SHELL-COMPLETIONS">SHELL COMPLETIONS</h2>
<h3 id="ZSH">ZSH</h3>
@ -232,7 +246,7 @@ License: BSD 2-clause License</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>October 2023</li>
<li class='tc'>November 2023</li>
<li class='tr'>go-sendxmpp(1)</li>
</ol>

13
man/go-sendxmpp.1.ronn
View File

@ -119,6 +119,19 @@ Username for XMPP account (JID).
* `--version`:
Show version information.
## SCRAM
Go-sendxmpp supports *Salted Challenge Responce Authentication Mechanism* (SCRAM).
If go-sendxmpp successfully connects using SCRAM it will create a file
`~/.local/share/go-sendxmpp/[your_jid]/authmechanism` containing the name of the
used mechanism. It will read this file and use the same mechanism for future connections
and fail if it is not available. This is to protect against downgrades by a
*Machine In The Middle* (MITM). If you want to upgrade to another mechanism (e.g.
if SCRAM-SHA-1-PLUS gets available for your server that previously only supported
SCRAM-SHA-1) you have to manually edit the file. It is not recommended to delete
the file and let go-sendxmpp recreate it as this would make it vulnerable to downgrade
attacks for the next connection attempt.
## SHELL COMPLETIONS
### ZSH