Skip to content

carbynestack/castor

Repository files navigation

Carbyne Stack Castor Tuple Store

codecov Codacy Badge Conventional Commits Known Vulnerabilities pre-commit Contributor Covenant

Castor is an open source storage service for cryptographic material used in Secure Multiparty Computation, so called tuples, and part of the Carbyne Stack platform.

DISCLAIMER: Carbyne Stack Castor is alpha: software. The software is not ready for production use. It has neither been developed nor tested for a specific use case.

Please have a look at the underlying modules for more information on how to run a Castor service and how to interact with it using the provided Java clients:

  • Castor Common - A shared library of commonly used functionality.
  • Castor Service - The microservice implementing the backend storage facilities for tuples.
  • Castor Java Client - A Java client library to interact with a Castor service over its REST API. The module provides client implementations to communicate
    • with the Castor service within a Virtual Cloud Provider.
    • across Castor services participating in a Virtual Cloud.
  • Castor Java Upload Client - A Java client used to upload pre-generated tuples using Castor's WebSocket interface.

💡 NOTE
Castor is only used to manage tuples in a Carbyne Stack Virtual Cloud and does not provide any functionality for generating the tuples themselves.

Namesake

Castor, a genus name of the beaver. The service name is derived from Beaver triples (proposed by Donald Rozinak Beaver), stored as one specialized type of tuples in the castor service.

License

Carbyne Stack Castor Tuple Store is open-sourced under the Apache License 2.0. See the LICENSE file for details.

3rd Party Licenses

For information on how license obligations for 3rd party OSS dependencies are fulfilled see the README file of the Carbyne Stack repository.

Contributing

Please see the Carbyne Stack Contributor's Guide .