The "vhost" Module (v3)

Description

This module allows the server administrator to define accounts which can grant a custom virtual host.

Configuration

To load this module use the following <module> tag:

<module name="vhost">

<vhost>

The <vhost> tag defines a virtual host account. This tag can be defined as many times as required.

Name Type Default Value Description
user Text None Required! The username used when logging into the account.
pass Text None Required! The password used when logging into the account.
hash Text None The algorithm that the password is hashed with.
host Text None The vhost for users who log into this account.

The hash field is currently optional but will be required in the next major version of InspIRCd.

The following hashing modules are included with InspIRCd:

Algorithm Module(s) Description
argon2d argon2 Hashes using the Argon2d algorithm.
argon2i argon2 Hashes using the Argon2i algorithm.
argon2id argon2 Hashes using the Argon2id algorithm.
bcrypt bcrypt Hashes using the bcrypt algorithm.
hmac-md5 password_hash, md5 Hashes using the MD5 and HMAC algorithms.
hmac-sha1 password_hash, sha1 Hashes using the SHA-1 and HMAC algorithms.
hmac-sha256 password_hash, sha256 Hashes using the SHA-256 and HMAC algorithms.
md5 md5 Hashes using the MD5 algorithm.
pbkdf2-hmac-md5 pbkdf2, md5 Hashes using the MD5 and PBKDF2 algorithms.
pbkdf2-hmac-sha1 pbkdf2, sha1 Hashes using the SHA-1 and PBKDF2 algorithms.
pbkdf2-hmac-sha256 pbkdf2, sha256 Hashes using the SHA-256 and PBKDF2 algorithms.
sha1 sha1 Hashes using the SHA-1 algorithm.
sha256 sha256 Hashes using the SHA-256 algorithm.
Example Usage

Adds a virtual host account with the username Sadie and a hashed password:

<vhost user="Sadie"
       pass="Ohf74jA8$GwQ083Z/Jl2Vi6WpYKu2ABTU5HAKO+Zk8NWw7sdt7cQ"
       hash="hmac-sha256"
       host="helper.example.com">

Commands

Name Parameter Count Syntax Description
VHOST 2 <username> <password> Log into the account with the specified username and password.

Example Usage

Logs into the account with the name Sadie and password fl00fyc4pyb4r4:

/VHOST Sadie fl00fyc4pyb4r4