From 4ec76ab6f2b3432d2e2028dc3fb884b3b9aea471 Mon Sep 17 00:00:00 2001 From: ywcb00 Date: Tue, 1 Sep 2026 23:44:31 +0200 Subject: [PATCH] feat(SECURITY.md): add security markdown feat(docs/site/security.md): create security model site on website --- SECURITY.md | 29 ++++++++++++++++++ docs/_includes/header.html | 1 + docs/site/install.md | 1 + docs/site/security.md | 62 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 93 insertions(+) create mode 100644 SECURITY.md create mode 100644 docs/site/security.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000000..8da4f5c3b38 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,29 @@ + + +# Security Policy in Apache SystemDS + +(Adapted from [Apache Spark](https://github.com/apache/spark/blob/master/SECURITY.md) and [Apache Kafka](https://github.com/apache/kafka/blob/trunk/SECURITY.md)) + +## Reporting a Vulnerability + +To report a security vulnerability in Apache SystemDS, follow the [ASF security process](https://www.apache.org/security/). Please do **not** open public GitHub issues, create public pull requests, file public JIRA tickets, or post to mailing lists for unpatched vulnerabilities. Reports can be sent privately to [security@apache.org](mailto:security%40apache.org). + +## Security Model +The Apache SystemDS security model is documented under [site/security](https://apache.github.io/systemds/site/security). diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 669aeb2eaaa..518af3112bc 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -57,6 +57,7 @@
  • Other:
  • Contributing to SystemDS 🡕
    • +
  • Security Model
  • GitHub 🡕
    • diff --git a/docs/site/install.md b/docs/site/install.md index 240be323b2a..c0eadbf051c 100644 --- a/docs/site/install.md +++ b/docs/site/install.md @@ -70,4 +70,5 @@ SystemDS provides advanced configuration options for performance tuning and spec - BLAS / Native Acceleration — [Native Backend (BLAS) Guide](native-backend) - Federated Backend Deployment — [Federated Guide](federated-monitoring) - Contributing to SystemDS — [Contributing Guide](https://github.com/apache/systemds/blob/main/CONTRIBUTING.md) +- Security — [Security Model](security) diff --git a/docs/site/security.md b/docs/site/security.md new file mode 100644 index 00000000000..712c6d10c9d --- /dev/null +++ b/docs/site/security.md @@ -0,0 +1,62 @@ +--- +layout: site +title: Apache SystemDS Security +--- + + +(Adapted from [Apache Spark](https://github.com/apache/spark/blob/master/SECURITY.md) and [Apache Kafka](https://github.com/apache/kafka/blob/trunk/SECURITY.md)) + +## Things You Need To Know + +- **Security is off by default.** Security features like authentication are not enabled by default. When exposing an Apache SystemDS deployment to the internet or an untrusted network, it is important to secure the application against potential threats. +- **Different levels of threat in different deployments.** Apache SystemDS supports multiple backends and each one supports different levels of security in different environments. None of the backends are secure by default. Be sure to evaluate your environment and take the appropriate measure to secure your Apache SystemDS deployment. +- **Apache SystemDS assumes a trusted operator.** Anyone with shell access to the machine on which Apache SystemDS is deployed can read and modify both data and code. Apache SystemDS does not protect deployments from their own adminstrators. +- **Apache SystemDS trusts its JVM and classpaths.** JARs included in the classpath of a process inherit full privileges of this process. Extensions of the classpath or loading supplementary components is equivalent to trusting these additions; the model assumes no hostile JARs are present. + +## Local Backend + +The local backend of Apache SystemDS enables executing operations on the local machine. Even though this does not require a network connection, there are still certain security risks that should be taken into account. Therefore, it is of high importance to explicitly ensure the security of the system before deploying Apache SystemDS. + +## Apache Spark Backend + +Apache SystemDS supports distributed execution using [Apache Spark 3.5.7](https://github.com/apache/spark/releases/tag/v3.5.7). Since Apache SystemDS incorporates Apache Spark, the [security model of Apache Spark](https://spark.apache.org/docs/3.5.7/security.html) as well as the security specifications of underlying dependencies also apply to Apache SystemDS. + +## Federated Backend + +The federated backend in Apache SystemDS allows to execute operations on data that is located on remote workers. This federated mode is intended for deployment within an enterprise network only, where participants can be reached over network only by trusted parties. + +### SSL Authentication and Encryption + +Apache SystemDS supports SSL authentication and encryption for the communication between the coordinators and federated workers in a federated deployment. Note that this feature is disabled by default. It can be enabled and configured through the following configuration options: + +| Property Name | Default | Meaning | Since Version | +| ------------- | ------- | ------- | ------------- | +| sysds.federated.ssl | false | Boolean flag to disable and enable SSL encryption. | 3.5.0 | +| sysds.federated.ssl.cert | null | File path to the worker X.509 certificate chain. | 3.5.0 | +| sysds.federated.ssl.key | null | File path to the worker private PKCS key. | 3.5.0 | +| sysds.federated.ssl.trust | null | File path to the trusted certificates (CA). | 3.5.0 | + +## Parameter Server with Homomorphic Encryption + +Parameter servers in Apache SystemDS support the privacy-preserving technique of homomorphic encryption using the library [SEAL 3.7.0](https://github.com/microsoft/SEAL/releases/tag/v3.7.0). Note that this feature is disabled by default. When enabling homorphic encryption, the [security model of SEAL](https://github.com/microsoft/SEAL/blob/v3.7.0/SECURITY.md) applies also to Apache SystemDS. + +## Reporting Security Issues + +Suspected vulnerabilities should be sent privately to [security@apache.org](mailto:security%40apache.org). Please do not disclose the security issue publicly until the PMC has had time to investigate the issue, prepare a fix, and coordinate a release.