summary refs log tree commit diff stats
path: root/HACKING.md
diff options
context:
space:
mode:
authorSoniEx2 <endermoneymod@gmail.com>2020-08-04 15:46:03 -0300
committerSoniEx2 <endermoneymod@gmail.com>2020-08-04 15:46:03 -0300
commit7d43478b76a24bc25ed3bf1599dc59ccbb372656 (patch)
treea097cbfa6255b6dbd8338690784bd1eede72e94b /HACKING.md
parent6e4a073affc0ea4a6660b6f5d301e148429d3771 (diff)
Add input validation section to HACKING.md
Diffstat (limited to 'HACKING.md')
-rw-r--r--HACKING.md19
1 files changed, 16 insertions, 3 deletions
diff --git a/HACKING.md b/HACKING.md
index ef461fa..c782840 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -4,9 +4,11 @@ Hacking GAnarchy
 Project Structure
 -----------------
 
-`requirements.txt` lists known-good, frozen dependencies. if needed or desired, install dependencies listed in setup.py directly.
+`requirements.txt` lists known-good, frozen dependencies. if needed or
+desired, install dependencies listed in setup.py directly.
 
-GAnarchy uses GAnarchy-based dependencies. they are identified by `gan$COMMIT` names. e.g. in requirements.txt:
+GAnarchy uses GAnarchy-based dependencies. they are identified by `gan$COMMIT`
+names. e.g. in requirements.txt:
 
 ```
 -e git+https://soniex2.autistic.space/git-repos/abdl.git@1b26ad799217af7e187fdae78e862a6bf46e5591#egg=gan0f74bd87a23b515b45da7e6f5d9cc82380443dab
@@ -22,4 +24,15 @@ install_requires=[
 
 (the comment is just a hint for humans to read)
 
-note however that not all forks are compatible with the project. requirements.txt provides known-good versions.
+note however that not all forks are compatible with the project.
+requirements.txt provides known-good versions.
+
+Input Validation
+----------------
+
+GAnarchy accepts untrusted input: from the user, from remote servers, etc.
+
+Where relevant, input should be validated in `data.py`. For example, URIs
+should be normalized (domain and protocol should be converted to
+all-lowercase), NULs should be rejected, etc. (FIXME: As of writing this, this
+is not the case)