README.md

Bcrypt for SA-MP

An implementation of bcrypt password hashing library for Pawn, written in C/C++.

Benefits of bcrypt

• All passwords are automatically salted
• Bcrypt is slow, which makes offline bruteforce attacks less efficient
• The work factor can be increased as the computers become more powerful

Functions

• bcrypt_hash(const key[], cost = 12, const callback_name[], const callback_format[] = "", {Float, _}:...);
• bcrypt_check(const password[], const hash[], const callback_name[], const callback_format[] = "", {Float, _}:...);
• bcrypt_get_hash(dest[]);
• bcrypt_is_equal();
• bcrypt_needs_rehash(const hash[], cost);
• bcrypt_find_cost(time_target = 250);
• bcrypt_set_thread_limit(value);
• bcrypt_debug(BCRYPT_DEBUG_LEVEL:level = BCRYPT_LOG_ERROR);

See the wiki for detailed usage.

Installation

Linux

1. Copy bcrypt-samp.so to the plugins folder
2. Add plugins bcrypt-samp.so to server.cfg
3. Copy bcrypt.inc to the compiler's include directory (pawno/include by default)
4. Add #include <bcrypt> to your gamemode or filterscript

Windows

1. Copy bcrypt-samp.dll to the plugins folder
2. Add plugins bcrypt-samp to server.cfg
3. Copy bcrypt.inc to the compiler's include directory (pawno/include by default)
4. Add #include <bcrypt> to your gamemode or filterscript

Usage

• Call function bcrypt_hash when you would like to hash user input (e.g. on registration, or when updating the work factor). Once the hash is calculated, the callback defined in the parameters will be called, and the hash can be acquired using bcrypt_get_hash function

• Call function bcrypt_check when you would like to verify whether or not user input matches a given hash (e.g. on login). Once the verification is done, the callback defined in the parameters will be called, and the result can be acquired using bcrypt_is_equal function

• You can use bcrypt_needs_rehash to check whether or not the hash needs to be updated

• If you would like to override the default number of threads used, you may use function bcrypt_set_thread_limit. In most cases, however, the default value is adequate

Example

#include <a_samp>
#include <bcrypt>

#define BCRYPT_COST 12

forward OnPasswordHashed(playerid);
forward OnPasswordChecked(playerid);

public OnDialogResponse(playerid, dialogid, response, listitem, inputtext[])
{
    switch(dialogid)
    {
        case DIALOG_REGISTRATION:
        {
			bcrypt_hash(inputtext, BCRYPT_COST, "OnPasswordHashed", "d", playerid);
        }

        case DIALOG_LOGIN:
        {
            // Variable hash is expected to contain the hash loaded from the database
            bcrypt_check(inputtext, hash,  "OnPasswordChecked", "d", playerid);
        }
    }

    return 1;
}

public OnPasswordHashed(playerid)
{
	new hash[BCRYPT_HASH_LENGTH];
	bcrypt_get_hash(hash);

	printf("Password hashed for player %d: %s", playerid, hash);
	return 1;
}

public OnPasswordChecked(playerid)
{
	new bool:match = bcrypt_is_equal();

	printf("Password checked for %d: %s", playerid, (match) ? ("Match") : ("No match"));
	return 1;
}