opaque-sql
An encrypted data analytics platform
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- support.md
- build.sh
- docs.yml
- main.yml
- install-pre-commit
- pre-commit
- sbt
- 000000_0.csv
- 000001_0.csv
- 000002_0.csv
- 000003_0.csv
- 000004_0.csv
- 000005_0.csv
- 000006_0.csv
- 000007_0.csv
- 000008_0.csv
- 000009_0.csv
- 000000_0.csv
- 000001_0.csv
- 000002_0.csv
- 000003_0.csv
- 000004_0.csv
- 000005_0.csv
- 000006_0.csv
- 000007_0.csv
- 000008_0.csv
- 000009_0.csv
- cpt_treatments.csv
- icd_codes.txt
- synth-disease-data
- synth_disease_data.py
- data.csv
- PageRank256.in
- synth-tpch-benchmark-data
- synth-tpch-test-data
- fetch-data.sh
- Dockerfile
- README.md
- benchmarking.rst
- contributing.rst
- install.rst
- tpch-results.csv
- client.rst
- functionality.rst
- untrusted.rst
- usage.rst
- conf.py
- index.rst
- make.bat
- Makefile
- requirements.txt
- run-tests.gdb
- build.properties
- BuildType.scala
- plugins.sbt
- protoc.sbt
- format.sh
- install.sh
- app.cpp
- app.h
- CMakeLists.txt
- errlist.h
- common.h
- define.h
- jni.h
- jni_md.h
- crypto_context.h
- ks_crypto.cpp
- ks_crypto.h
- random.h
- sgxaes.cpp
- sgxaes.h
- sgxaes_asm.S
- expression_evaluation.h
- flatbuffers.cpp
- flatbuffers.h
- flatbuffers_readers.cpp
- flatbuffers_readers.h
- flatbuffers_writers.cpp
- flatbuffers_writers.h
- aggregate.cpp
- aggregate.h
- broadcast_nested_loop_join.cpp
- broadcast_nested_loop_join.h
- filter.cpp
- filter.h
- limit.cpp
- limit.h
- non_oblivious_sort_merge_join.cpp
- non_oblivious_sort_merge_join.h
- project.cpp
- project.h
- sort.cpp
- sort.h
- CMakeLists.txt
- Enclave.conf
- Enclave.config.xml
- enclave.cpp
- enclave.edl
- enclave.lds
- util.cpp
- util.h
- CMakeLists.txt
- EncryptedBlock.fbs
- Expr.fbs
- operators.fbs
- Rows.fbs
- log4j.properties
- LogisticRegression.scala
- EncryptedSortExec.scala
- operators.scala
- SGXEnclave.scala
- ClosestPoint.scala
- Decrypt.scala
- DotProduct.scala
- VectorAdd.scala
- VectorMultiply.scala
- VectorSum.scala
- operators.scala
- rules.scala
- Globals.scala
- IntpHandler.scala
- Listener.scala
- RA.scala
- README.md
- implicits.scala
- OpaqueException.scala
- sources.scala
- strategies.scala
- Utils.scala
- InMemoryRelationMatcher.scala
- OpaqueDatasetFunctions.scala
- UndoCollapseProject.scala
- client.proto
- listener.proto
- __init__.py
- README.md
- intp_handler.py
- listener.py
- opaque_sql.py
- mc2_test_key.pem
- q1.sql
- q10.sql
- q11.sql
- q12.sql
- q13.sql
- q14.sql
- q15.sql
- q16.sql
- q17.sql
- q18.sql
- q19.sql
- q2.sql
- q20.sql
- q21.sql
- q22.sql
- q3.sql
- q4.sql
- q5.sql
- q6.sql
- q7.sql
- q8.sql
- q9.sql
- log4j.properties
- Benchmark.scala
- BigDataBenchmark.scala
- KMeans.scala
- LeastSquares.scala
- PageRank.scala
- TPCHBenchmark.scala
- TPCH.scala
- TPCHSuite.scala
- AggregationSuite.scala
- CreateSuite.scala
- FilterSuite.scala
- JoinSuite.scala
- LimitSuite.scala
- OpaqueFunSuite.scala
- OpaqueSpecificSuite.scala
- OpaqueSQLSuiteBase.scala
- OpaqueSuiteBase.scala
- OpaqueUDFSuite.scala
- SecurityLevel.scala
- SharedSparkSessions.scala
- SortSuite.scala
- SQLHelper.scala
- SQLTestData.scala
- SubquerySuite.scala
- UnionSuite.scala
- .clang-format
- .gitignore
- .jvmopts
- .scalafmt.conf
- build.sbt
- CODE_OF_CONDUCT.md
- LICENSE
- opaqueenv
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/mc2-project/opaque-sql
Downloads the entire project code from GitHub to your computer.
cd opaque-sql
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f docker/Dockerfile -t opaque-sql .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 opaque-sql
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. CMake
MediumPrerequisites
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/cpp
This project's files live in a subfolder, so move into it first.
mkdir build && cd build
Creates a folder to hold the build output and moves into it.
cmake ..
Analyzes the source code and generates build configuration files (must be run inside the build folder).
make
Compiles the code based on the generated build configuration to produce an executable.
Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).
4. Python
EasyPrerequisites
pip install -r opaque-sql-docs/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd opaque-sql-docs
This project's files live in a subfolder, so move into it first.
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)