php-mhcrypto

This repository contains Metahash wallet and signature PHP API sample code. For more details about Metahash address generation, please read the article. C++ code is used from repository cpplib_open_ssl_decor.

Get the source code

Clone the repository by:

git clone https://github.com/metahashorg/php-mhcrypto

Build extension

Run following commands in php-mhcrypto project folder:

phpize
./configure --enable-mhcrypto
make
sudo make install

Load extension

Extension should be loaded before being used.

Call dl() function in PHP script by the moment you need the extension (refer to sample script mhcrypto.php).

Use PHP configuration if you need to load extension always.

Put 'extension=mhcrypto.so' into PHP.ini. You need to change php.ini for php-cli and php-fpm (for example, sudo nano php.ini).

For example so you can find the php.ini for php-cli on your computer:

php -i|grep php.ini
Configuration File (php.ini) Path => /etc/php/7.3/cli
Loaded Configuration File => /etc/php/7.3/cli/php.ini

php.ini for php-fpm will be in the same folder ~/fpm/php.ini

(Refer to PHP documentation for 'extension' keyword and your Linux documentation for PHP.ini location.)

Test application

This PHP7 test script shows the use of extension. Enable dl() function in your php.ini with enable_dl option.

php -f mhcrypto.php

API

mhcrypto_generate_wallet

mhcrypto_generate_wallet(string $private_key, string $public_key, string $mh_address[, string $password])

This procedure generates new wallet. Wallet is represented by 3 strings: private and public key and wallet address. String arguments are passed by reference. Means that procedure fills them with new generated values. $password argument is optional and not implemented in that version.

mhcrypto_sign_text

mhcrypto_sign_text(string $sign, string $private_key, string $text[, string $password])

This procedure uses private key to build a signature for given text. All 3 arguments are string variables. $sign signature variables is passed by reference. However $sign variable have a type of string the content of variable is not a string rather it's binary data can be used in conjunction with mhcrypto_check_sign_text function. $password argument is optional and not implemented in that version.

mhcrypto_check_sign_text

bool mhcrypto_check_sign_text(string $sign, string $public_key, string $text)

Takes 3 string arguments and returns boolean result of the test if given signature matches given text. Public key is required for that operation.