[MOD] Refactor code out for #6

Schema/AdminDeactivate.json

@@ -0,0 +1,14 @@
+{
+  "header": "Schema\/AdminDeactivate.h",
+  "types": {
+    "DeactivateRequest": {
+      "fields": {
+        "reason": {
+          "type": "string"
+        }
+      },
+      "type": "struct"
+    }
+  },
+  "guard": "TELODENDRIA_SCHEMA_ADMINDEACTIVATE_H"
+}

Schema/RequestToken.json

@@ -0,0 +1,21 @@
+{
+  "header": "Schema\/RequestToken.h",
+  "types": {
+    "RequestToken": {
+      "fields": {
+        "client_secret": { "type": "string" },
+        "send_attempt": { "type": "integer" },
+        "next_link": { "type": "string" },
+        "id_access_token": { "type": "string" },
+        "id_server": { "type": "string" },
+        
+        "email": { "type": "string" },
+
+        "country": { "type": "string" },
+        "phone_number": { "type": "string" }
+      },
+      "type": "struct"
+    }
+  },
+  "guard": "TELODENDRIA_SCHEMA_REQUESTTOKEN_H"
+}

docs/dev/rationale.md

@@ -39,12 +39,71 @@ Telodendria that Conduit lacks.
 
 ### Small Dependency Chain
 
-**TODO:** See #30.
+Conduit's dependency chain is quite large. What this means is that
+Conduit depends on a lot of code that it does not control, making it
+vulnerable to supply chain attacks. A problem with Rust Crates
+is that they are developer-published, so they don't go through any sort
+of auditing process like a Debian package would, for example.
+ If any one of the dependencies is
+hijacked or otherwise compromised, then Conduit itself is compromised
+and it is likely that this would go unnoticed for quite a while. While
+one could argue that this is extremely unlikely to happen, sometimes you
+just don't want to take that risk, especially not if you're deploying a
+Matrix homeserver, likely for the purpose of secure, private chat.
+
+Telodendria doesn't pull in any packages from developer repositories, so
+the risk of supply chain attacks is much lower. It
+only uses its own code and code provided by the operating system it is running
+on, which has been vetted by a large number of developers and can be trusted
+due to the sheer scope of an operating system. A supply chain attack against
+Telodendria would be a supply chain attack against the entire operating system;
+at that point, end users have much bigger problems.
+
+Minimal dependencies doesn't only mitigate supply chain attacks. It also makes
+maintenance much easier. Telodendria can spend more time writing code than
+Conduit because Conduit developers have to ensure dependencies stay up to date and
+when they inevitably break things, Conduit must pause development to fix those.
+Telodendria doesn't suffer from this problem: because most of the code is developed
+along side of Telodendria, it can remain as stable or become as volatile as the
+developers choose. Additionally, because Telodendria is so low-level, the code on
+which it depends is extremely unlikely to be changed in any significant way,
+since so many other programs depend on that code.
 
 ### Standardized
 
-**TODO:** See #30.
+Conduit is written in Rust, which has no formal standard. This makes it less than
+ideal for long-lived software projects, because it changes frequently and often
+breaks existing code. Telodendria is written in C, a stable, mature, and standardized
+language that will always compile the same code the same way, making it more
+portable and sustainable for the future because we don't ever have to worry about
+upgrading our toolchain—using standard tools built into most operating systems
+will suffice.
+
+Because the language in which Telodendria is written never changes, Telodendria can
+continually optimize and improve the code, instead of having to fix breaking changes.
+This ensures that Telodendria's code will last. Rust code becomes obsolete with in a
+few years at best—programs written in Rust last year probably won't compile or run
+properly on the latest Rust toolchain. Telodendria, on the other hand, is written in C89,
+which compiled and ran the same way in 1989 as it does today and will continue to for the
+foreseeable future.
+
+### Fast Compile Times
+
+Rust is well-known for taking an extremely long time to compile moderately-sized
+programs. Since a Matrix homeserver is such a large project, the compile times would
+be prohibitively large for rapid development. By writing Telodendria in C, we can take
+advantage of decades worth of compiler optimizations and speed improvements, resulting
+in extremely fast builds.
 
 ### Portable
 
-**TODO:** See #30.
+One does not typically think of C as more portable than something like Rust, but
+Telodendria is written in such a way that it is. Rust relies on LLVM, which doesn't
+support some strange or exotic architectures in the same way that a specialized C
+compiler for those architectures will. This allows users to run Telodendria on the
+hardware of their choice, even if that hardware is so strange that the modern world
+has totally left it behind.
+
+Telodendria doesn't just aim at being lightweight and portable, it aims to empower
+people to use common hardware that they already have, even if it is typically thought
+of as underpowered.

src/Routes/RouteAdminDeactivate.c

@@ -28,7 +28,8 @@
 #include <Cytoplasm/Str.h>
 
 #include <User.h>
-#include <Cytoplasm/Log.h>
+
+#include <Schema/AdminDeactivate.h>
 
 ROUTE_IMPL(RouteAdminDeactivate, path, argp)
 {
@@ -38,6 +39,7 @@ ROUTE_IMPL(RouteAdminDeactivate, path, argp)
 
     JsonValue *val;
     char *reason = "Deactivated by admin";
+    char *err;
     char *removedLocalpart = ArrayGet(path, 0);
     char *token;
 
@@ -48,6 +50,8 @@ ROUTE_IMPL(RouteAdminDeactivate, path, argp)
 
     HttpRequestMethod method = HttpRequestMethodGet(args->context);
 
+    DeactivateRequest deactReq;
+
     if ((method != HTTP_DELETE) && (method != HTTP_PUT))
     {
         char * msg = "Route only supports DELETE and PUT as for now.";
@@ -63,10 +67,10 @@ ROUTE_IMPL(RouteAdminDeactivate, path, argp)
             HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
             return MatrixErrorCreate(M_NOT_JSON, NULL);
         }
-        val = HashMapGet(request, "reason");
+        if (!DeactivateRequestFromJson(request, &deactReq, &err))
-        if (val && JsonValueType(val) == JSON_STRING)
         {
-            reason = JsonValueAsString(val);
+            HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
+            return MatrixErrorCreate(M_BAD_JSON, err);
         }
     }
 
@@ -100,7 +104,7 @@ ROUTE_IMPL(RouteAdminDeactivate, path, argp)
         response = HashMapCreate();
         
         JsonSet(response, JsonValueString(removedLocalpart), 1, "user");
-        JsonSet(response, JsonValueString(reason), 1, "reason");
+        JsonSet(response, JsonValueString(deactReq.reason), 1, "reason");
         JsonSet(response, JsonValueString(UserGetName(user)), 1, "banned_by");
     }
     else
@@ -112,6 +116,7 @@ ROUTE_IMPL(RouteAdminDeactivate, path, argp)
 finish:
     UserUnlock(user);
     UserUnlock(removed);
+    DeactivateRequestFree(&deactReq);
     JsonFree(request);
     return response;
 }

src/Routes/RouteRequestToken.c

@@ -26,14 +26,31 @@
 #include <Cytoplasm/Str.h>
 #include <Cytoplasm/Json.h>
 
+#include <Schema/RequestToken.h>
+
 ROUTE_IMPL(RouteRequestToken, path, argp)
 {
     RouteArgs *args = argp;
     char *type = ArrayGet(path, 0);
     HashMap *request;
     HashMap *response;
-    JsonValue *val;
+
-    char *str;
+    char *msg;
+
+    RequestToken reqTok;
+
+    Int64 minusOne = Int64Neg(Int64Create(0, 1));
+
+    reqTok.client_secret = NULL;
+    reqTok.next_link = NULL;
+    reqTok.id_access_token = NULL;
+    reqTok.id_server = NULL;
+
+    reqTok.email = NULL;
+    reqTok.country = NULL;
+    reqTok.phone_number = NULL;
+
+    reqTok.send_attempt = minusOne;
 
     if (HttpRequestMethodGet(args->context) != HTTP_POST)
     {
@@ -48,87 +65,92 @@ ROUTE_IMPL(RouteRequestToken, path, argp)
         return MatrixErrorCreate(M_NOT_JSON, NULL);
     }
 
-    val = HashMapGet(request, "client_secret");
+    if (!RequestTokenFromJson(request, &reqTok, &msg))
-    if (!val || JsonValueType(val) != JSON_STRING)
     {
         HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-        response = MatrixErrorCreate(M_BAD_JSON, NULL);
+        response = MatrixErrorCreate(M_BAD_JSON, msg);
         goto finish;
     }
 
-    str = JsonValueAsString(val);
+    if (!reqTok.client_secret)
-    if (strlen(str) > 255 || StrBlank(str))
     {
+        msg = "'client_secret' is not set";
         HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-        response = MatrixErrorCreate(M_BAD_JSON, NULL);
+        response = MatrixErrorCreate(M_BAD_JSON, msg);
         goto finish;
     }
 
-    val = HashMapGet(request, "send_attempt");
+    if (strlen(reqTok.client_secret) > 255 || StrBlank(reqTok.client_secret))
-    if (!val || JsonValueType(val) != JSON_INTEGER)
     {
+        msg = "'client_secret' is blank or too long";
         HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-        response = MatrixErrorCreate(M_BAD_JSON, NULL);
+        response = MatrixErrorCreate(M_BAD_JSON, msg);
         goto finish;
     }
 
-    val = HashMapGet(request, "next_link");
+    if (Int64Eq(reqTok.send_attempt, minusOne))
-    if (val && JsonValueType(val) != JSON_STRING)
     {
+        msg = "Invalid or inexistent 'send_attempt'";
         HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-        response = MatrixErrorCreate(M_BAD_JSON, NULL);
+        response = MatrixErrorCreate(M_BAD_JSON, msg);
         goto finish;
     }
 
-    val = HashMapGet(request, "id_access_token");
+    if (!reqTok.next_link)
-    if (val && JsonValueType(val) != JSON_STRING)
     {
+        msg = "'next_link' is not set";
         HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-        response = MatrixErrorCreate(M_BAD_JSON, NULL);
+        response = MatrixErrorCreate(M_BAD_JSON, msg);
         goto finish;
     }
-
+    if (!reqTok.id_access_token)
-    val = HashMapGet(request, "id_server");
-    if (val && JsonValueType(val) != JSON_STRING)
     {
+        msg = "'id_access_token' is not set";
         HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-        response = MatrixErrorCreate(M_BAD_JSON, NULL);
+        response = MatrixErrorCreate(M_BAD_JSON, msg);
+        goto finish;
+    }
+    if (!reqTok.id_server)
+    {
+        msg = "'id_server' is not set";
+        HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
+        response = MatrixErrorCreate(M_BAD_JSON, msg);
         goto finish;
     }
 
     if (StrEquals(type, "email"))
     {
-        val = HashMapGet(request, "email");
+        if (!reqTok.email)
-        if (val && JsonValueType(val) != JSON_STRING)
         {
+            msg = "Type is set to 'email' yet none was set";
             HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-            response = MatrixErrorCreate(M_BAD_JSON, NULL);
+            response = MatrixErrorCreate(M_BAD_JSON, msg);
             goto finish;
         }
     }
     else if (StrEquals(type, "msisdn"))
     {
-        val = HashMapGet(request, "country");
+        if (!reqTok.country)
-        if (val && JsonValueType(val) != JSON_STRING)
         {
+            msg = "Type is set to 'msisdn' yet no country is set";
             HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-            response = MatrixErrorCreate(M_BAD_JSON, NULL);
+            response = MatrixErrorCreate(M_BAD_JSON, msg);
             goto finish;
         }
 
-        str = JsonValueAsString(val);
+        if (strlen(reqTok.country) != 2)
-        if (strlen(str) != 2)
         {
+            msg = "Invalid country tag, length must be 2";
             HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-            response = MatrixErrorCreate(M_BAD_JSON, NULL);
+            response = MatrixErrorCreate(M_BAD_JSON, msg);
             goto finish;
         }
 
-        val = HashMapGet(request, "phone_number");
+        if (!reqTok.phone_number)
-        if (val && JsonValueType(val) != JSON_STRING)
         {
+            msg = "Type is set to 'msisdn' yet phone_number is unset";
             HttpResponseStatus(args->context, HTTP_BAD_REQUEST);
-            response = MatrixErrorCreate(M_BAD_JSON, NULL);
+            response = MatrixErrorCreate(M_BAD_JSON, msg);
             goto finish;
         }
     }