qrme

Signed-off-by: Finbarrs Oketunji <[email protected]>

.devcontainer/devcontainer.json

@@ -0,0 +1,15 @@
+{
+  "name": "C Development",
+  "image": "mcr.microsoft.com/devcontainers/cpp:1-debian-11",
+  "features": {
+    "ghcr.io/devcontainers/features/cpp:1": {}
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": ["ms-vscode.cpptools", "ms-vscode.cmake-tools"]
+    }
+  },
+  "forwardPorts": [8000],
+  "postCreateCommand": "sudo apt-get update && sudo apt-get install -y libopenblas-dev liblapack-dev",
+  "remoteUser": "vscode"
+}

.gitattributes

@@ -0,0 +1,4 @@
+* text=auto whitespace=trailing-space
+
+*.png binary
+*.jpe?g binary

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: weekly

.gitignore

@@ -0,0 +1,18 @@
+# CMake & Testing
+/build*
+/tmp*
+
+# CLion
+/cmake-build*
+
+# MacOS
+.DS_Store
+
+# Others
+.venv
+__pycache__
+.pytest_cache
+.cache
+.CMake/a.out
+compile_commands.json
+scripts

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 - 2024-08-29 - @0xnu
+
+* Initial release

CODEOWNERS

@@ -0,0 +1 @@
+@0xnu

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+### Contributing
+
+1. Fork the repository
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Make your changes and ensure they follow the project's coding standards
+4. Compile and test your changes locally
+5. Commit your changes: `git commit -s -m 'Add some feature'`
+6. Push to the branch: `git push origin my-new-feature`
+7. Create a pull request
+
+### Building and Testing
+
+To build the project:
+```
+make all
+```
+
+To run tests:
+```
+make run-tests
+```
+
+For a full list of available make targets, run:
+```
+make help
+```
+
+### Code Style
+
+Please follow the coding style guidelines outlined in the project. Typically for C projects, this might include:
+
+- Use 4 spaces for indentation (not tabs)
+- Keep lines to a maximum of 80 characters
+- Use descriptive variable and function names
+- Comment your code where necessary
+
+### Submitting Changes
+
+- Ensure your code compiles without warnings
+- Run all tests and make sure they pass
+- Update documentation if you're changing functionality
+- Include comments in your code where necessary
+
+**After your pull request is merged**, you can safely delete your branch.
+
+### Reporting Issues
+
+If you find a bug or have a suggestion for improvement, please open an issue on the project's issue tracker. Provide as much detail as possible, including:
+
+- Steps to reproduce the issue
+- Expected behavior
+- Actual behavior
+- Your environment (compiler version, OS, etc.)
+
+Thank you for contributing to this project!

LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Finbarrs Oketunji. All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -0,0 +1,84 @@
+# qrme is a quantum-resistant encrypted machine learning system designed
+# to protect sensitive data and models against potential threats from
+# quantum computing. It utilises advanced cryptographic techniques to ensure
+# the confidentiality and integrity of the machine learning model and its
+# inputs/outputs, even in the face of future quantum attacks.
+#
+# Copyright (c) 2024 Finbarrs Oketunji
+# Written by Finbarrs Oketunji <[email protected]>
+#
+# This file is part of qrme.
+#
+# qrme is an open-source software: you are free to redistribute
+# and/or modify it under the terms specified in version 3 of the GNU
+# General Public License, as published by the Free Software Foundation.
+#
+# qrme is is made available with the hope that it will be beneficial,
+# but it comes with NO WARRANTY whatsoever. This includes, but is not limited
+# to, any implied warranties of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+# PURPOSE. For more detailed information, please refer to the
+# GNU General Public License.
+#
+# You should have received a copy of the GNU General Public License
+# along with qrme.  If not, visit <http://www.gnu.org/licenses/>.
+
+# Detect the operating system
+UNAME_S := $(shell uname -s)
+
+# Common variables
+CC = gcc
+CFLAGS = -O3 -I.
+LDFLAGS = -loqs -lcrypto -lm
+
+# Source files
+SRC = src/encryption.c src/model.c src/utils.c
+OBJ = $(SRC:.c=.o)
+
+# Test files
+TEST_SRC = tests/test_all.c
+TEST_OBJ = $(TEST_SRC:.c=.o)
+
+# OS-specific configurations
+ifeq ($(UNAME_S),Darwin)
+	# macOS configuration
+	LIBOQS_INCLUDE = -I/usr/local/include
+	LIBOQS_LIB = -L/usr/local/lib
+	# Install liboqs if not already installed
+	ifeq ($(shell brew list --formula | grep -q liboqs; echo $$?),1)
+		$(shell brew install liboqs)
+	endif
+else
+	# Linux configuration
+	LIBOQS_INCLUDE = -I/usr/include
+	LIBOQS_LIB = -L/usr/lib
+	# Linux package installation
+	PACKAGES = gcc libssl-dev liboqs-dev
+	$(shell sudo apt-get update && sudo apt-get install -y $(PACKAGES))
+endif
+
+all: create_sample_model test_all ## Build all targets
+
+create_sample_model: create_sample_model.c $(OBJ) ## Build the sample model creation tool
+	$(CC) $(CFLAGS) $(LIBOQS_INCLUDE) -o $@ $^ $(LIBOQS_LIB) $(LDFLAGS)
+
+test_all: $(TEST_SRC) $(OBJ) ## Build the test runner
+	$(CC) $(CFLAGS) $(LIBOQS_INCLUDE) -o $@ $^ $(LIBOQS_LIB) $(LDFLAGS)
+
+%.o: %.c ## Compile object files
+	$(CC) $(CFLAGS) $(LIBOQS_INCLUDE) -c $< -o $@
+
+run-sample: create_sample_model ## Run the sample model creation
+	./create_sample_model
+
+run-tests: test_all ## Run all tests
+	./test_all
+
+clean: ## Clean up build artifacts
+	rm -f $(OBJ) $(TEST_OBJ) create_sample_model test_all test_model.bin test_secret.key
+
+help: ## Display help message
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: all run-sample run-tests clean help
+
+.DEFAULT_GOAL := help

NOTICE

@@ -0,0 +1,6 @@
+@name: qrme
+@author: Finbarrs Oketunji
+@contact: [email protected]
+@time: 24/08/2024 - 21:30
+
+This product includes software developed by [Finbarrs Oketunji](https://finbarrs.eu).