Cole-Greer commented on code in PR #3449: URL: https://github.com/apache/tinkerpop/pull/3449#discussion_r3364065597
########## THREAT_MODEL.md: ########## @@ -0,0 +1,348 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Apache TinkerPop — Threat Model (v0 draft) + +## §1 Header + +- **Project:** Apache TinkerPop (`apache/tinkerpop`) — a graph computing framework: the Gremlin query + language, the traversal machine, Gremlin Server (remote query execution), the GraphSON / Gryo / + GraphBinary serialization formats, and the Gremlin Language Variants (Java, Python, .NET, Go, JS). + *(documented — `README.md`, repo layout)* +- **Scope of this model:** the **`apache/tinkerpop` monorepo**, active branches `master`, `3.7-dev`, + `3.8-dev` *(maintainer — colegreer, scope confirmation)*. The model focuses on the network-facing and + deserialization surfaces (see §2); provider graph databases that embed TinkerPop are out of scope (§3). +- **Date:** 2026-06-05. **Status:** DRAFT v0 — first pass by the ASF Security team via the + threat-model-producer rubric, for the TinkerPop PMC to react to. **Author:** ASF Security team, for PMC + ratification. +- **Version binding:** versioned with the project; a report against release *N* is triaged against the + model as it stood at *N*, not against `HEAD`. +- **Reporting cross-reference:** §8-property violations → report privately per the ASF process + (`[email protected]`); §3 / §9 findings are closed citing this document. +- **Provenance legend:** *(documented)* = stated in TinkerPop's own docs / reference / source; + *(maintainer)* = confirmed by a TinkerPop PMC member through this process; *(inferred)* = reasoned from + the reference docs, architecture, and graph-server domain knowledge, **not yet confirmed** — every + *(inferred)* claim has a matching §14 open question. +- **Draft confidence:** a v0 with **no PMC confirmation folded in yet** — the deployment posture, the + default auth/TLS stance, the script-execution sandboxing story, and the serialization (Gryo) + disposition are the highest-value items for the PMC to confirm in §14. +- **What TinkerPop is:** TinkerPop is an embeddable graph-computing framework. Applications and graph + databases (providers) embed `gremlin-core` to run Gremlin traversals; **Gremlin Server** exposes that + capability over the network (WebSocket sub-protocol + HTTP), accepting both **string-based Gremlin + scripts** (evaluated by the `gremlin-groovy` Groovy script engine) and **bytecode-based traversals** + (the GLVs). *(documented — reference docs)* Review Comment: It's clear we will need to split this model into 2 very distinct versions for 3.7/3.8 and 4. As this PR is already targeting master, I suggest we focus this one on 4. I'll open a twin PR which cherry-picks the draft back to 3.7, and we can iterate on the websocket/bytecode model there. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
