chapters/data: Add checkers for memory-security tasks

Done solving the issue 134 :
chapters/data/memory-security/drills/tasks: Add solutions and checkers #134
Added the generate_skels.py infrastructure to generate the skeletons
Added checkers for the tasks which needed one
Updated the README.md for every task with useful information on how to use:
-`make skels` command
-the checker
Added solution
Updated generate_skels.py to add support for Makefile-uncommenting lines.

Fixes #134

Signed-off-by: Vica Teodor Andrei <[email protected]>

chapters/data/memory-security/drills/tasks/aslr/.gitignore

@@ -0,0 +1 @@
+support

chapters/data/memory-security/drills/tasks/aslr/Makefile

@@ -0,0 +1,10 @@
+PYTHON = python3
+SCRIPT = generate_skels.py
+
+skels:
+	mkdir -p support/src
+	$(PYTHON) $(SCRIPT) --input ./solution/src --output ./support/src
+	$(PYTHON) $(SCRIPT) --input ./solution/tests --output ./support/tests
+
+clean:
+	rm -rf support/

chapters/data/memory-security/drills/tasks/aslr/README.md

@@ -1,5 +1,8 @@
 # ASLR
 
+Navigate to `chapters/data/memory-security/drills/tasks/aslr` and run `make skels` to generate the `support/` folder.
+Then navigate to `support/src`.
+
 Use the `Makefile.aslr` file to compile the `chapters/data/memory-security/drills/tasks/aslr/support/aslr.c` file:
 
 ```console
@@ -26,3 +29,17 @@ Disable PIC by uncommenting the `-fno-PIC` and `LDFLAGS` lines.
 We observe that for randomization to work, we need to instruct the OS to randomize the program sections and the compiler to generate code that is position independent.
 
 If you're having difficulties solving this exercise, go through [this](../../../reading/memory-security.md) reading material.
+
+## Checker
+
+To run the checker, go into the `tests` directory located in `src`, then type `make check`.
+A successful output of the checker should look like this :
+
+```console
+student@os:~/.../drills/tasks/aslr/support/src/tests make check
+test_aslr                        ........................ passed ... 100
+
+========================================================================
+
+Total:                                                           100/100
+```

chapters/data/memory-security/drills/tasks/aslr/generate_skels.py

@@ -0,0 +1,149 @@
+#!/usr/bin/python3 -u
+# SPDX-License-Identifier: BSD-3-Clause
+
+import sys
+import argparse
+import os.path
+import re
+
+
+def process_file(src, dst, pattern, replace, remove, replace_pairs, end_string=None):
+    if not pattern or not replace or not remove:
+        print(
+            f"ERROR: The script behaviour is not properly specified for {src}",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+
+    fin = open(src, "r")
+    os.makedirs(os.path.dirname(dst), exist_ok=True)
+    fout = open(dst, "w")
+
+    remove_lines = 0
+    skip_lines = 0
+    uncomment_lines = 0
+    end_found = True
+    makefile_special_handling = "Makefile" in src
+
+    for i, l in enumerate(fin.readlines()):
+        # Skip generation of file.
+        if "SKIP_GENERATE" in l:
+            fout.close()
+            os.remove(dst)
+            return
+
+        if end_string and not end_found:
+            fout.write(l)
+            if end_string in l:
+                end_found = True
+            continue
+
+        if remove_lines > 0:
+            remove_lines -= 1
+            continue
+
+        if skip_lines > 0:
+            skip_lines -= 1
+            m = re.search(pattern, l)
+            if m:
+                l = f"{m.group(1)}{m.group(3)}\n"
+                fout.write(l)
+            continue
+
+        if uncomment_lines > 0:
+            uncomment_lines -= 1
+            for fro, to in replace_pairs:
+                l = re.sub(fro, to, l)
+            fout.write(l)
+            continue
+
+        if makefile_special_handling and "TODO" in l and "Uncomment" in l:
+            fout.write(l)
+            next_line = fin.readline()
+            fout.write(next_line.lstrip("#").lstrip())
+            continue
+
+        m = re.search(pattern, l)
+        if m:
+            skip_lines = int(m.group(2)) if m.group(2) else 1
+            if end_string and end_string not in l:
+                end_found = False
+            l = f"{m.group(1)}{m.group(3)}\n"
+
+        m = re.search(replace, l)
+        if m:
+            uncomment_lines = int(m.group(2)) if m.group(2) else 1
+            continue
+
+        m = re.search(remove, l)
+        if m:
+            remove_lines = int(m.group(2)) if m.group(2) else 1
+            continue
+
+        fout.write(l)
+
+    fout.close()
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Generate skeletons sources from reference solution sources"
+    )
+    parser.add_argument(
+        "--input", help="input directory to process files", required=True
+    )
+    parser.add_argument(
+        "--output", help="output directory to copy processed files", required=True
+    )
+    args = parser.parse_args()
+
+    for root, dirs, files in os.walk(args.input):
+        new_root = os.path.join(args.output, os.path.relpath(root, args.input))
+        for d in dirs:
+            os.makedirs(os.path.join(new_root, d), exist_ok=True)
+
+        for src in files:
+            if (
+                re.match("Makefile.*$", src)
+                or re.match(r".*\.sh$", src)
+                or re.match(r".*\.[sS]$", src)
+                or re.match(r".*\.py$", src)
+            ):
+                pattern = r"(^\s*#\s*TODO)( [0-9]*)(:.*)"
+                replace = r"(^\s*#\s*REPLACE)( [0-9]*)"
+                remove = r"(^\s*#\s*REMOVE)( [0-9]*)"
+                replace_pairs = [("# ", "")]
+                end_string = None
+            elif re.match(r".*\.asm$", src):
+                pattern = r"(^\s*;\s*TODO)( [0-9]*)(:.*)"
+                replace = r"(^\s*;\s*REPLACE)( [0-9]*)"
+                remove = r"(^\s*;\s*REMOVE)( [0-9]*)"
+                replace_pairs = [("; ", "")]
+                end_string = None
+            elif (
+                re.match(r".*\.[ch]$", src)
+                or re.match(r".*\.cpp$", src)
+                or re.match(r".*\.hpp$", src)
+            ):
+                pattern = r"(.*/\*\s*TODO)([ 0-9]*)(:.*)"
+                replace = r"(.*/\*\s*REPLACE)( [0-9]*)"
+                remove = r"(.*/\*\s*REMOVE)( [0-9]*)"
+                replace_pairs = [(r"/\* ", ""), (r" \*/", "")]
+                end_string = "*/"
+            elif re.match(r".*\.d$", src):
+                pattern = r"(.*//\s*TODO)([ 0-9]*)(:.*)"
+                replace = r"(.*//\s*REPLACE)( [0-9]*)"
+                remove = r"(.*//\s*REMOVE)( [0-9]*)"
+                replace_pairs = [(r"// ", "")]
+                end_string = None
+            else:
+                continue
+
+            dst = os.path.join(new_root, src)
+            src = os.path.join(root, src)
+            print(dst)
+            process_file(src, dst, pattern, replace, remove, replace_pairs, end_string)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

chapters/data/memory-security/drills/tasks/aslr/solution/src/.gitignore

@@ -0,0 +1 @@
+/aslr

chapters/data/memory-security/drills/tasks/aslr/support/Makefile → chapters/data/memory-security/drills/tasks/aslr/solution/src/Makefile

@@ -8,7 +8,10 @@ SRCS = aslr.c
 OBJS = $(SRCS:.c=.o)
 
 # Flags for compiling and linking
+# TODO: Uncomment the -fno-PIC line
 CFLAGS += -fno-stack-protector -fno-PIC
+
+# TODO: Uncomment the LDFLAGS line
 LDFLAGS += -no-pie
 
 # Output binary

chapters/data/memory-security/drills/tasks/exec-shellcode/support/tests/Makefile → chapters/data/memory-security/drills/tasks/aslr/solution/tests/Makefile

@@ -1,6 +1,6 @@
 SRC_PATH ?= ../src
-FULL_SRC_PATH = "$(realpath $(SRC_PATH))"
-CPPFLAGS = -I. -I$(FULL_SRC_PATH) -I../utils
+FULL_SRC_PATH = $(realpath $(SRC_PATH))
+CPPFLAGS = -I. -I$(realpath $(SRC_PATH)) -I../utils
 CFLAGS = -Wall -Wextra
 # Remove the line below to disable debugging support.
 CFLAGS += -g -O0

chapters/data/memory-security/drills/tasks/exec-shellcode/support/tests/graded_test.inc.sh → chapters/data/memory-security/drills/tasks/aslr/solution/tests/graded_test.inc.sh

@@ -34,7 +34,6 @@ run_test()
 {
     func="$1"
     points="$2"
-
     # Run in subshell.
     (eval "$func")
     print_test "$func" "$?" "$points"

chapters/data/memory-security/drills/tasks/exec-shellcode/support/tests/run_all_tests.sh → chapters/data/memory-security/drills/tasks/aslr/solution/tests/run_all_tests.sh

@@ -2,18 +2,16 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 if test -z "$SRC_PATH"; then
-    SRC_PATH=../src
+    SRC_PATH=../src/
 fi
 
 export SRC_PATH
-
+echo ""
 (
-./test_helloworld.sh
-./test_getpid.sh
-./test_openfile.sh
-./test_brk.sh
+  bash test.sh
 ) | tee results.txt
-
+echo ""
+echo "========================================================================"
 total=$(grep '\( passed \| failed \)' results.txt | rev | cut -d ' ' -f 1 | rev | paste -s -d'+' | bc)
 echo ""
 echo -n "Total:                           "