carbynestack - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #go #rust #deep-learning #nodejs #java #windows #awesome #awesome-list #security #open-source

carbynestack

(★ 93)

Cloud native Secure Multiparty Computation Stack

File Explorer

Download Latest Version (.zip)

- - auto-labeler.yml
  - release.yaml
  - stale-issue-cleanup.yml
- - LICENSE.md
- - LICENSE
  - NOTICE
- - LICENSE
  - NOTICE
- - LICENSE
- - LICENSE
- - LICENSE
  - NOTICE.md
- - LICENSE
- - LICENSE
- sbom.json
- - carbyne-stack.ts
- - 0010.dbms.yaml
  - 0020.minio.yaml
  - 0030.istio.yaml
  - 0040.etcd.yaml
  - 0050.redis.yaml
  - 0080.thymus.yaml
  - 0100.castor.yaml
  - 0200.amphora.yaml
  - 0300.ephemeral.yaml
  - 0400.klyshko.yaml
  - 0450.klyshko-config.yaml
- - azure-cluster.ts
  - azure-jump.ts
  - azure-private-cluster.ts
  - local-kind-cluster.ts
- .gitignore
- .npmrc
- cdktf.json
- jest.config.js
- main.ts
- package-lock.json
- package.json
- README.md
- tsconfig.json
- 0049-end-user-authentication.md
- 0055-federated-learning.md
- NNNN-CSEP-template.md
- README.md
.codacy.yaml
.gitignore
.markdownlint.json
.pre-commit-config.yaml
.prettierignore
.release-please-manifest.json
CHANGELOG.md
CODE_OF_CONDUCT.md
CODEOWNERS
commitlint.config.js
CONTRIBUTING.md
DEVELOPING.md
LICENSE
NOTICE.md
package-lock.json
README.md
release-please-config.json
TRIAGING.md

# Installation Guide

1. Get the code

git clone https://github.com/carbynestack/carbynestack

Downloads the entire project code from GitHub to your computer.

cd carbynestack

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd deployments

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Carbyne Stack

[![DOI](https://zenodo.org/badge/408830243.svg)](https://zenodo.org/badge/latestdoi/408830243)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/197a4f29b04a417c950285a38f787e6f)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=carbynestack/carbynestack&utm_campaign=Badge_Grade)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
[![Known Vulnerabilities](https://snyk.io/test/github/carbynestack/carbynestack/badge.svg)](https://snyk.io/test/github/carbynestack/carbynestack)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://raw.githubusercontent.com/carbynestack/carbynestack/master/CODE_OF_CONDUCT.md)

Carbyne Stack is a Cloud Native Secure Multiparty Computation (MPC) platform
released under Apache License 2.0. Use Carbyne Stack to build resilient scalable
infrastructure for sensitive data workloads. More information can be found on
the [Carbyne Stack website](https://carbynestack.io).

> **DISCLAIMER**: Carbyne Stack is _alpha_ software. The software is not ready
> for production use. It has neither been developed nor tested for a specific
> use case. The underlying Secure Multiparty Computation protocols are
> _currently_ used in a way that is not secure.

## Getting Started

Carbyne Stack can be deployed and experimented with locally. See the
[Getting Started](https://carbynestack.io/getting-started/) section on the
[Carybne Stack website](https://carbynestack.io) for instructions.

## Contributing

Please see the Carbyne Stack [Contributor's Guide](CONTRIBUTING.md).

## Governance

For more information on our project's governance model and decision-making
process, please visit our
[Governance repository](https://github.com/carbynestack/governance).

## Citation

We use [Zenodo](https://zenodo.org/) to archive our work and make it citable via
*Digital Object Identifiers* (DOIs).

In case you want to cite the Carbyne Stack software in general (and not a
specific version) you can use the following BibTex entry:

```bibtex
@software {carbynestack,
  title = {Carbyne Stack},
  author = {Becker, Sebastian and Duplys, Paul and Graf, Johannes and
   Graffi, Kalman and Grassi, Alessandro and Greven, David and Grewe, Julian and
   Jain, Shalabh and Klenk, Timo and Matyunin, Nikolay and Modica, Hanna and
   Raskin, Vadim and Scherer, Petra and Suschke, Volker and Trieflinger, Sven and
   Vlasakiev, Veselin and Weinfurtner, Jared},
  date = {2021},
  institution = {Robert Bosch GmbH},
  license = {Apache License 2.0},
  url = {https://carbynestack.io},
  abstract = {Carbyne Stack is an open-source cloud native stack for building
   scalable Secure Multiparty Computation applications.},
  repository = {https://github.com/carbynestack/carbynestack},
  doi = {10.5281/zenodo.8192460}
}
```

The given DOI will always reference the latest archived release of Carbyne Stack
on Zenodo.

### Citing a Release

It is generally preferable to use the DOI for a specific version of Carbyne
Stack to ensure that other users/researchers can access the exact (research)
artefact you used for reproducibility. To achieve this you can add a second
BibTex entry pointing to a specific archived release:

```bibtex
@softwareversion {carbynestack-v<version>,
  version = {<version>},
  date = {<release-date>},
  crossref = {carbynestack},
  doi = {<version-doi>}
}
```

You can lookup the `release-date` and `version-doi` for a given version
[here](https://zenodo.org/search?page=1&size=20&q=carbynestack).

### Enhancement Proposals

We use [_Carbyne Stack Enhancement Proposals_](enhancements/README.md) (CSEPs)
to suggest, communicate and coordinate on new significant efforts for the
Carbyne Stack project. The CSEP process is intended to provide a consistent and
controlled path for larger changes to Carbyne Stack (such as new features) so
that all stakeholders can be confident about the direction of the project.

## License

Carbyne Stack is open-sourced under the Apache License 2.0. See the
[LICENSE](LICENSE) file for details.

### 3rd Party Licenses

Carbyne Stack relies heavily on 3rd party Open Source Software. Artifacts that
comprise 3rd party OSS and that are distributed by us, e.g., Java archives and
Docker Images, are built to satisfy the license obligations of the 3rd party OSS
components. A _Software Bill of Materials_ (SBOM), copyright notices, license
texts and links to the source codes for the 3rd party OSS components are made
available at the root of the module source tree in a folder called
`3RD-PARTY-LICENSES`. The following sections describe how this information is
distributed with or alongside the generated Carbyne Stack artifacts.

#### GitHub Releases

When Carbyne Stack software artifacts are built and published, all information
about linked and redistributed 3rd-party OSS components is collected from the
`3RD-PARTY-LICENSES` folder of the respective artifact and attached to the
GitHub release page. Where applicable, license texts and notice files are packed
into a file for each component following the naming scheme
`<artifact-name>-3rd-party-copyrights.zip`. Sources files are downloaded and
bundled into a single archive called `<artifact-name>-3rd-party-sources.zip`.

#### Docker Images

All _Carbyne Stack_ Docker images are based on one of the
[Carbyne Stack Docker Base Images](https://github.com/carbynestack/base-images).
With each [release](https://github.com/carbynestack/base-images/releases) of one
of these base images, a _Disclosure Documentation_ is published, which contains
a list of all included software packages, their licenses and sources that are
distributed with the corresponding image. The download link to the _Disclosure
Documentation_ can also be obtained from the image using:

```shell
docker inspect --format '{{index .Config.Labels "3rd-party-disclosure"}}' ${IMAGE_REPOSITORY}:${IMAGE_TAG}
```

More information about additional software components distributed with an image
is also provided inside the Docker Image in the folder `/3RD-PARTY-LICENSES` or
as follows:

- Docker images built using [ko](https://github.com/google/ko) include the SBOM
  and associated files in the folder `/var/run/ko`.
- For images created using [Maven](https://maven.apache.org/) by means of the
  [Dockerfile Maven Plugin](https://github.com/spotify/dockerfile-maven) the
  artifacts are made available in the root folder of the image.

#### Java Archives

Java Archives (JARs) are built using [Maven](https://maven.apache.org/). The
SBOM is created as part of the regular build process and made available together
with the associated files at a location that depends on the type of the JAR that
is built:

- For plain JARs that just contain the component itself and for fat JARs built
  using the
  [Maven Assembly Plugin](https://maven.apache.org/plugins/maven-assembly-plugin/)
  , the artifacts are made available in the root folder of the JAR.

- For runnable fat JARs built by the
  [Spring Boot Maven Plugin](https://docs.spring.io/spring-boot/docs/current/maven-plugin/reference/htmlsingle/)
  the artifacts are made available in the folder `/BOOT-INF/classes/` of the
  JAR.

> **NOTE**: While the SBOM is derived automatically from the dependencies
> specified in the project object model (`pom.xml`), the files required to
> fulfill license obligations (e.g. license and notice files) have to be
> provided manually.

## Export Control

Carbyne Stack includes cryptographic software. The country in which you
currently reside may have restrictions on the import, possession, use, and/or
re-export to another country, of encryption software. **Before** using any
encryption software, please check your country's laws, regulations and policies
concerning the import, possession, or use, and re-export of encryption software,
to see if this is permitted. See the
[Wassenaar Arrangement](http://www.wassenaar.org) website for more information.

Robert Bosch GmbH has classified this software as Export Commodity Control
Number (ECCN) 5D002, which includes information security software using or
performing cryptographic functions with asymmetric algorithms. The form and
manner of this distribution makes it eligible for export under the "publicly
available" Section 742.15(b) and 734.3(b)(3) exemptions (see the BIS Export
Administration Regulations, Section 742.15(b) and Section 734.3(b)(3)) for both
object code and source code.

For additional information see the Carbyne Stack
[website](https://www.carbynestack.io/legal/export-control/).