Mercurial > irccd

annotate plugins/auth/auth.7 @ 1201:67fa43998a91 default tip @

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: update copyright years
author David Demelier <markand@malikania.fr>
date Thu, 04 Jan 2024 10:39:43 +0100
parents 1845a0509a93
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
1201
67fa43998a91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 1183
diff changeset
2 .\" Copyright (c) 2013-2024 David Demelier <markand@malikania.fr>
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd @IRCCD_MAN_DATE@
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt IRCCD-PLUGIN-AUTH 7
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm auth
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd irccd auth plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 The plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 provides generic authentication to the most popular services.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 For the moment,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .Nm auth
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 supports the following backends:
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
32 .Bl -tag -width nickserv
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .It nickserv
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 the NickServ service, using /msg NickServ identify user pass
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .It quakenet
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 the quakenet.org service, using /msg Q@CServe.quakenet.org AUTH user pass
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
37 .El
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .\" INSTALLATION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Sh INSTALLATION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 The plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .Nm
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
42 is distributed with irccd. To enable it add it into your
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
43 .Xr irccd.conf 5
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
44 configuration file.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 .Pp
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
46 .Bd -literal -offset indent
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
47 plugin "auth"
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .\" USAGE
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .Sh USAGE
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 You must configure the file to enable authentication.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .\" CONFIGURATION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .Sh CONFIGURATION
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
54 The plugin
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
55 .Nm
1020
3dec26654d06 man: misc fixes
David Demelier <markand@malikania.fr>
parents: 1019
diff changeset
56 supports the following configuration properties:
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
57 .Bl -tag -width "server.password (string)"
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .It Va server.type No (string)
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
59 Must be
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Em nickserv
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 or
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 .Em quakenet .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 .It Va server.password No (string)
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
64 The password.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .It Va server.username No (string)
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
66 The username to use. Required for quakenet, optional for nickserv.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 .Pp
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
69 Note: you must replace server prefix with the server identifier you refer to in
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
70 the
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
71 .Xr irccd.conf 5
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
72 file.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 Example of configuration:
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
75 .Bd -literal
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
76 plugin "auth" {
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
77 config {
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
78 "freenode.type" "nickserv";
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
79 "freenode.password" "mysecretpassword";
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
80 "freenode.username" "jeanfrancois";
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
81
1019
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
82 "wanadoo.type" "nickserv";
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
83 "wanadoo.password" "wanadoo is dead";
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
84 }
90eb31112a53 man: update plugin documentation
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
85 }
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 .Ed
1020
3dec26654d06 man: misc fixes
David Demelier <markand@malikania.fr>
parents: 1019
diff changeset
87 .\" SEE ALSO
3dec26654d06 man: misc fixes
David Demelier <markand@malikania.fr>
parents: 1019
diff changeset
88 .Sh SEE ALSO
3dec26654d06 man: misc fixes
David Demelier <markand@malikania.fr>
parents: 1019
diff changeset
89 .Xr irccd 1 ,
3dec26654d06 man: misc fixes
David Demelier <markand@malikania.fr>
parents: 1019
diff changeset
90 .Xr irccd-templates 7