PHP Classes

Argon2 Refiner: Benchmark Argon2id hashing to recommend parameters

Recommend this page to a friend!
     
  Info   Example   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 38 All time: 10,962 This week: 35Up
Version License PHP version Categories
argon2-refiner 1.0MIT/X Consortium ...5Cryptography, Performance and optimiz..., P...
Description 

Author

Scott Arciszewski

This package can be used to benchmark Argon2id hashing to recommend parameters.

It takes as arguments some parameters that the limits of time and memory used by Argon2id password hashing.

The package runs some benchmarks with the given parameters and generates new parameter values to optimize the hashing process on the current hosting environment.

Innovation Award
PHP Programming Innovation award nominee
August 2019
Number 9		 Argon2 is a function for implementing a password hashing method. It provides means to change parameters that can tune its behavior.

This package can generate parameter values to optimize the execution of a password hashing function based on Argon2.

Manuel Lemos
Picture of Scott Arciszewski
  Performance   Level  
Name: Scott Arciszewski <contact>
Classes: 38 packages by
Country: United States United States

Level 1 Star

 Innovation award
Innovation award
Nominee: 29x

Winner: 1x

Example

#!/usr/bin/php
<?php
use ParagonIE\Argon2Refiner\ParameterRecommender;

if (file_exists(dirname(__DIR__) . '/vendor/autoload.php')) {
    // We're a standalone package
    require_once dirname(__DIR__) . '/vendor/autoload.php';
} elseif (file_exists(dirname(__DIR__, 3) . '/autoload.php')) {
    // We're installed as a library
    require_once dirname(__DIR__, 3) . '/autoload.php';
} else {
    // Trust the include path.
    require_once 'vendor/autoload.php';
}

$ms = $argc > 1 ? $argv[1] : 500;
$recommender = (new ParameterRecommender($ms));
if ($argc > 2) {
    $tolerance = (int) $argv[2];
    if ($tolerance > 0) {
        $recommender->setTolerance($tolerance);
    }
}

$results = $recommender->runBenchmarks();
if (empty($results)) {
    echo 'No parameters meet your target time window.', PHP_EOL;
    exit(255);
}

$min = [
    'diff' => PHP_INT_MAX,
    'data' => [
        'time_cost' => null,
        'mem_cost' => null,
        'bench_time' => PHP_INT_MAX
    ]
];

foreach ($results as $i => $res) {
    $weightedDiff = $res['bench_time'] - $ms;
    if ($weightedDiff > 0) {
        // Apply a penalty to overshots
        $weightedDiff *= 2;
    } else {
        $weightedDiff *= -1;
    }
    if ($weightedDiff < $min['diff']) {
        $min = [
            'diff' => $weightedDiff,
            'data' => $res
        ];
    }
    $results[$i]['diff'] = $weightedDiff;
}

$reduced = $min['data']['mem_cost'] >> 10;
echo 'Recommended Argon2id parameters:', PHP_EOL;
echo "\t Memory cost (sodium): {$min['data']['mem_cost']}\n";
echo "\tMemory cost (password_hash): {$reduced}\n";
echo "\t Time cost: {$min['data']['time_cost']}\n\n";
echo "Real time: {$min['data']['bench_time']}ms\n";

  Files folder image Files (9)  
File Role Description
Files folder imagebin (1 file)
Files folder imagesrc (1 file)
Files folder imagetests (1 file)
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file psalm.xml Data Auxiliary data
Accessible without login Plain text file README.md Doc. Read me

  Files folder image Files (9)  /  bin  
File Role Description
  Accessible without login Plain text file benchmark Example Example script

  Files folder image Files (9)  /  src  
File Role Description
  Accessible without login Plain text file ParameterRecommender.php Class Class source

  Files folder image Files (9)  /  tests  
File Role Description
  Accessible without login Plain text file ParameterRecommenderTest.php Class Class source

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
Downloadargon2-refiner-2019-08-19.zip 7KB
Downloadargon2-refiner-2019-08-19.tar.gz 5KB
Install with ComposerInstall with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:38
This week:0
All time:10,962
This week:35Up

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.