Skip to content

Commit

Permalink
Update README, ready for v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
paragonie-security committed Jan 12, 2017
1 parent bc5a551 commit 3551f37
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Generally: If you replace `\Sodium\ ` with `ParagonIE_Sodium_Compat::`, any
code already written for the libsodium PHP extension should work with our
polyfill without additional code changes.

To learn how to use Libsodium, read [*Using Libsodium in PHP Projects*](https://paragonie.com/book/pecl-libsodium).

## API Coverage

* Mainline NaCl Features
Expand All @@ -125,12 +127,13 @@ polyfill without additional code changes.
* For advanced users only:
* `crypto_stream()`
* `crypto_stream_xor()`
* Other utilities (e.g. `crypto_*_keypair()`)

### Features Excluded from this Polyfill

* `sodium_memzero()` - Although we expose this API endpoint, it's a NOP. We can't
* `\Sodium\memzero()` - Although we expose this API endpoint, it's a NOP. We can't
reliably zero buffers from PHP.
* `crypto_pwhash()` - It's not feasible to polyfill scrypt or Argon2 into PHP and get
* `\Sodium\crypto_pwhash()` - It's not feasible to polyfill scrypt or Argon2 into PHP and get
reasonable performance. Users would feel motivated to select parameters that downgrade
security to avoid denial of service (DoS) attacks.

Expand Down

0 comments on commit 3551f37

Please sign in to comment.