Skip to content

Commit 1411a54

Browse files
authored
Add security section to README
Added a security section emphasizing the importance of input validation and data integrity in production systems.
1 parent ba1ccfa commit 1411a54

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ Myth: SIMD compression means high speed but less compression.
4040
Fact: This is wrong. Some schemes cannot easily be accelerated
4141
with SIMD instructions, but many that do compress very well.
4242

43+
## Security
44+
45+
It is a low-level library. The inputs are not validated prior to decoding. It is assumed that the provided buffers were generated
46+
by the corresponding encoding functions. It is your responsability to ensure the validity of your data. In production systems,
47+
the use a strong hashing function to check for data integrity is recommended. The library does not provide this functionality.
48+
4349
## Working with sorted lists of integers
4450

4551
If you are working primarily with sorted lists of integers, then

0 commit comments

Comments
 (0)