wyrihaximus/react-stream-hash

On the fly hash calculator for ReactPHP streams

1.1.0 2019-01-01 17:37 UTC

Requires

• php: ^7.2
• react/stream: ^1.1.0

Requires (Dev)

• api-clients/cs-fixer-config: ^1.1
• api-clients/test-utilities: ^5.4
• react/promise-stream: ^1.0 || ^0.1.1

MIT

• Cees-Jan Kiewiet

README

Installation

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-stream-hash 

Usage

Writable stream:

$algo = 'sha512'; // Change to any desired algo from hash_algos()
$streamToHash = new ThroughStream();
// Constructor accepts a third $key argument in case you want a HMAC hash
$stream = new WritableStreamHash($streamToHash, $algo);
$stream->on('hash', function ($hash, $algo) {
    // Do with what you need the hash for
});
$stream->on('hash_raw', function ($hash, $algo) {
    // Do with what you need the raw hash for
});

// Write to the stream
$stream->write('foo');
$stream->end('bar');

Readable stream:

$algo = 'sha512'; // Change to any desired algo from hash_algos()
$streamToHash = new ThroughStream();
// Constructor accepts a third $key argument in case you want a HMAC hash
$stream = new ReadableStreamHash($streamToHash, $algo);
$stream->on('hash', function ($hash, $algo) {
    // Do with what you need the hash for
});
$stream->on('hash_raw', function ($hash, $algo) {
    // Do with what you need the raw hash for
});

// The readable emits data when written to
$streamToHash->write('foo');
$streamToHash->end('bar');

Contributing

Please see CONTRIBUTING for details.

License

Copyright 2017 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.