Skip to content

Commit

Permalink
Various small doc updates
Browse files Browse the repository at this point in the history
* Update chanlist description
* Update blowfish modinfo
* Update PBKDF2 description
* Update included.rst
* Update modinfo
  • Loading branch information
vanosg authored Dec 30, 2023
1 parent 43358bd commit 82ca2a8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
2 changes: 1 addition & 1 deletion doc/sphinx_source/modules/included.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Modules included with Eggdrop
later retrieval.

:ref:`pbkdf2`
This modules updates Eggdrop to use PBKDF2 for hashing purposes, such as for userfile passwords. It was specifically designed to work with the blowfish module to make the transition from blowfish to pbkdf2 password hashing as easy as possible. If you are transitioning a userfile from 1.8 or earlier, you should load this AND the blowfish module. By doing so, Eggdrop will seamlessly update the old blowfish hashes to the new PBKDF2 hashes once a user logs in for the first time, and allow you to (eventually) remove the blowfish module altogether. For new bots, you should load this module by itself and not use the blowfish module. The blowfish module is still required for encrypting/decrypting strings. Eggdrop will not start without an encryption module loaded.
This modules updates Eggdrop to use PBKDF2 for hashing purposes, such as for userfile passwords. It was specifically designed to work with the blowfish module to make the transition from blowfish to pbkdf2 password hashing as easy as possible. If you are transitioning a userfile from 1.8 or earlier, you should load this AND the blowfish module. By doing so, Eggdrop will seamlessly update the old blowfish hashes to the new PBKDF2 hashes once a user logs in for the first time, and allow you to (eventually) remove the blowfish module altogether. For new bots, you should load this module by itself and not use the blowfish module. The blowfish module is still required if you use Tcl to encrypt/decrypt strings in Tcl (ie, some scripts). Eggdrop will not start without a password-hashing module loaded.

:ref:`seen`
This module provides very basic seen commands via msg, on channel
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx_source/using/tcl-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1338,7 +1338,7 @@ onchansplit <nick> [channel]
chanlist <channel> [flags][<&|>chanflags]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Description: flags are any global flags; the '&' or '\|' denotes to look for channel specific flags, where '&' will return users having ALL chanflags and '|' returns users having ANY of the chanflags (See `Flag Masks`_ for additional information).
Description: lists all users on a channel Eggdrop has joined. flags are any global flags; the '&' or '\|' denotes to look for channel specific flags, where '&' will return users having ALL chanflags and '|' returns users having ANY of the chanflags (See `Flag Masks`_ for additional information).
Returns: Searching for flags optionally preceded with a '+' will return a list of nicknames that have all the flags listed. Searching for flags preceded with a '-' will return a list of nicknames that do not have have any of the flags (differently said, '-' will hide users that have all flags listed). If no flags are given, all of the nicknames on the channel are returned.

Expand Down
12 changes: 8 additions & 4 deletions src/mod/blowfish.mod/modinfo
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
DESC:The blowfish module provides encryption support for eggdrop. You always
DESC:need to load an encryption module to run eggdrop. Currently, blowfish
DESC:is the only encryption module, so you don't have much choice.
DESC:The blowfish module provides encryption and hashing support for eggdrop.
DESC:Eggdrop requires a module that provides hashing in order to protect
DESC:passwords. While the PBKDF2 module is the current recommended module for
DESC:password hashing, you should still run this module if you want to use
DESC:functions such as the Tcl 'encrypt' command.
DESC:
DESC:ENABLE this module.
DESC:Enable this module if you are transitioning from userfiles previously
DESC:created with the blowfish module, or are using Tcl scripts that use
DESC:the encrypt function.

0 comments on commit 82ca2a8

Please sign in to comment.