Welcome to MC² Client’s documentation!

MC² Client is a local trusted client that enables users to securely interface with the MC² ecosystem. In particular, MC² Client allows users to initialize their identities, launch MC²-loaded VMs and other resources on Azure Confidential Computing, start and stop MC² compute services (Opaque SQL and Secure XGBoost), transfer their encrypted sensitive data to the cloud for processing, and remotely run secure computation on their data.

MC² Client provides two interfaces, a Python interface and a command line interface. Both rely on a configuration file to configure MC² Client; the command line interface is simpler but less flexible, while the Python interface gives users finer grained control over what they want to do.

While MC² currently offers various compute services, the client is currently only compatible with Opaque SQL. We are currently in the midst of updating Secure XGBoost to be compatible with the client.

Contents:

• Installation
  • Building with Docker for a local deployment
  • Building from Source
  • Azure Login
• Quickstart
  • Docker Quickstart
  • Azure Quickstart
• Usage with Opaque SQL
  • Start
  • Upload
  • Run
  • Download
  • Example
• Configuration
  • Global Configuration
  • Azure Configuration
• Python Interface
  • Python Package Usage
  • API Reference
• CLI Interface
  • CLI Usage
  • CLI Reference