diff options
| -rw-r--r-- | DO_NOT_USE_THIS_LIBRARY.txt | 7 | ||||
| -rw-r--r-- | README.md | 36 |
2 files changed, 36 insertions, 7 deletions
diff --git a/DO_NOT_USE_THIS_LIBRARY.txt b/DO_NOT_USE_THIS_LIBRARY.txt deleted file mode 100644 index c814f0b..0000000 --- a/DO_NOT_USE_THIS_LIBRARY.txt +++ /dev/null @@ -1,7 +0,0 @@ -DO NOT USE THIS LIBRARY! - -This library assumes a thread-safe OpenSSL API. Currently, Ur/Web binaries -do _not_ use thread-safe OpenSSL, which means linking this library _will_ -introduce a potentially security-relevant race condition in your application. - -Upstream bug: http://www.impredicative.com/mantis/view.php?id=206 diff --git a/README.md b/README.md new file mode 100644 index 0000000..2860d67 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +urweb-crypto-random-openssl +=========================== + +urweb-crypto-random-openssl provides cryptographically secure random byte and +blob generation facilities using [OpenSSL][]. + +**This library requires Ur/Web 20150819 or later.** If you use an earlier +version, you _will_ fall afoul of [bug 206][], and you _will_ introduce a +potentially security-relevant race condition in your application. + +Installation +------------ + +The standard + + autoreconf -vis + ./configure + make + make install + +dance should work properly. + +License +------- + +urweb-crypto-random-openssl is licensed under the [Apache License, Version 2.0][]. + + +[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0 +[bug 206]: http://www.impredicative.com/mantis/view.php?id=206 "Ur/Web bug #206: Linking FFI libraries which use OpenSSL introduces race condition" +[OpenSSL]: https://openssl.org/ + + +<!-- Local Variables: --> +<!-- mode: markdown --> +<!-- End: --> |