[authen-passphrase-scrypt.git] / README

Authen-Passphrase-Scrypt version 0.002
======================================

This is experimental code, DO NOT USE in security-critical software.

Scrypt is a key derivation function that was originally developed for
use in the Tarsnap online backup system and is designed to be far more
secure against hardware brute-force attacks than alternative functions
such as PBKDF2 or bcrypt.

Authen::Passphrase::Scrypt is a module for hashing and verifying
passphrases using scrypt. It offers the same interface as
Authen::Passphrase. It is not however possible to use this module from
within Authen::Passphrase.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

DEPENDENCIES

This module requires these other modules and libraries:

* OpenSSL (-lcrypto)
* Authen::Passphrase
* Data::Entropy::Algorithms
* Object::Tiny
* Test::Exception

COPYRIGHT AND LICENCE

Copyright (C) 2017-2018 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.24.1 or,
at your option, any later version of Perl 5 you may have available.
Commit	Line	Data
	1	Authen-Passphrase-Scrypt version 0.002
	2	======================================
	3
	4	This is experimental code, DO NOT USE in security-critical software.
	5
	6	Scrypt is a key derivation function that was originally developed for
	7	use in the Tarsnap online backup system and is designed to be far more
	8	secure against hardware brute-force attacks than alternative functions
	9	such as PBKDF2 or bcrypt.
	10
	11	Authen::Passphrase::Scrypt is a module for hashing and verifying
	12	passphrases using scrypt. It offers the same interface as
	13	Authen::Passphrase. It is not however possible to use this module from
	14	within Authen::Passphrase.
	15
	16	INSTALLATION
	17
	18	To install this module type the following:
	19
	20	perl Makefile.PL
	21	make
	22	make test
	23	make install
	24
	25	DEPENDENCIES
	26
	27	This module requires these other modules and libraries:
	28
	29	* OpenSSL (-lcrypto)
	30	* Authen::Passphrase
	31	* Data::Entropy::Algorithms
	32	* Object::Tiny
	33	* Test::Exception
	34
	35	COPYRIGHT AND LICENCE
	36
	37	Copyright (C) 2017-2018 by Marius Gavrilescu
	38
	39	This library is free software; you can redistribute it and/or modify
	40	it under the same terms as Perl itself, either Perl version 5.24.1 or,
	41	at your option, any later version of Perl 5 you may have available.
	42
	43