aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index e385979..a17b169 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
# lpass
+A simple implementation of
+[lesspass](https://github.com/lesspass/lesspass) in C.
-A simple implementation of [lesspass](https://github.com/lesspass/lesspass) in C.
+# Memory safety disclaimers
+This implementation only uses dynamic memory allocation as implemented
+within OpenSSL to handle big integers (`BIGNUM` in OpenSSL lingo). All
+allocations should be checked for success (non-`NULL`), please send a
+patch if you find that this is not the case. The same is true for the
+status of OpenSSL functions that return a status code.
+
+String manipulation is done only on statically-allocated strings,
+while also using the versions whose limits can be specified (e.g.,
+`snprintf` versus `sprintf` and `strncpy` versus `strcpy`).
+
+This code uses variable-length array declarations for simplicity.
+
+# Dependencies
+A recent version of OpenSSL.