-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Document Security Policy #9730
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alamb
wants to merge
5
commits into
apache:main
Choose a base branch
from
alamb:alamb/security_model
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Document Security Policy #9730
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d6f3a8f
Add SECURITY model for arrow-rs
alamb 8d0f20e
prettier
alamb 6b59892
Apply suggestions from code review
alamb fff1a96
Merge remote-tracking branch 'apache/main' into alamb/security_model
alamb de727be
revert inadvertent removal
alamb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| <!--- | ||
| 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. | ||
| --> | ||
|
|
||
| # Security Policy | ||
|
|
||
| This document outlines the security model for the Rust implementation of Apache Arrow (`arrow-rs`) and how to report vulnerabilities. | ||
|
|
||
| ## Security Model | ||
|
|
||
| The `arrow-rs` project follows the [Apache Arrow Security Model]. Key aspects include: | ||
| - Reading data from untrusted sources (e.g., over a network or from a file) requires explicit validation. | ||
| - Failure to validate untrusted data before use may lead to security issues. This implementation provides APIs to validate Arrow data. For example, [`ArrayData::validate_full`] can be used to ensure that data conforms to the Arrow specification. | ||
|
|
||
| ## Rust Safety and Undefined Behavior | ||
|
|
||
| We strive to uphold the [Rust Soundness Pledge]. | ||
|
|
||
| - **Undefined Behavior (UB) is a bug:** Any instance of UB is a bug we are committed to fixing. | ||
| - **UB as a Security Issue:** Any **exploitable** UB triggered via safe APIs is a security issue. Other UB instances are bugs, and we welcome help fixing them. | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| **Do not file a public issue.** Follow the [ASF security reporting process] by emailing [security@apache.org](mailto:security@apache.org). | ||
|
|
||
| Include in your report: | ||
| - A clear description and minimal reproducer. | ||
| - Affected crates and versions. | ||
| - Potential impact. | ||
|
|
||
| [Apache Arrow Security Model]: https://arrow.apache.org/docs/dev/format/Security.html | ||
| [`ArrayData::validate_full`]: https://docs.rs/arrow/latest/arrow/array/struct.ArrayData.html#method.validate_full | ||
| [Rust Soundness Pledge]: https://raphlinus.github.io/rust/2020/01/18/soundness-pledge.html | ||
| [ASF security reporting process]: https://www.apache.org/security/#reporting-a-vulnerability | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <!--- | ||
| 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. | ||
| --> | ||
|
|
||
| # `arrow-csv` | ||
|
|
||
| Support for reading/writing CSV files to/from [Apache Arrow]. | ||
|
|
||
| See the [main repository README] and the [API documentation] for more details. | ||
|
|
||
| ## Security | ||
|
|
||
| See the [Security Policy] for information on the security model and how to report vulnerabilities. | ||
|
|
||
| [Apache Arrow]: https://arrow.apache.org/ | ||
| [main repository README]: https://github.com/apache/arrow-rs | ||
| [API documentation]: https://docs.rs/arrow-csv/latest | ||
| [Security Policy]: https://github.com/apache/arrow-rs/blob/main/SECURITY.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| <!--- | ||
| 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. | ||
| --> | ||
|
|
||
| # `arrow-ipc` | ||
|
|
||
| Support for reading/writing files and streams of the [Arrow IPC Format] to/from [Apache Arrow]. | ||
|
|
||
| See the [main repository README] and the [API documentation] for more details. | ||
|
|
||
| ## Security | ||
|
|
||
| See the [Security Policy] for information on the security model and how to report vulnerabilities. | ||
|
|
||
| [Apache Arrow]: https://arrow.apache.org/ | ||
| [Arrow IPC Format]: https://arrow.apache.org/docs/format/Columnar.html#format-ipc | ||
| [main repository README]: https://github.com/apache/arrow-rs | ||
| [API documentation]: https://docs.rs/arrow-ipc/latest | ||
| [Security Policy]: https://github.com/apache/arrow-rs/blob/main/SECURITY.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <!--- | ||
| 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. | ||
| --> | ||
|
|
||
| # `arrow-json` | ||
|
|
||
| Support for reading and writing JSON to/from [Apache Arrow]. | ||
|
|
||
| See the [main repository README] and the [API documentation] for more details. | ||
|
|
||
| ## Security | ||
|
|
||
| See the [Security Policy] for information on the security model and how to report vulnerabilities. | ||
|
|
||
| [Apache Arrow]: https://arrow.apache.org/ | ||
| [main repository README]: https://github.com/apache/arrow-rs | ||
| [API documentation]: https://docs.rs/arrow-json/latest | ||
| [Security Policy]: https://github.com/apache/arrow-rs/blob/main/SECURITY.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should define what exploitable means, as it is so important to this section.
Perhaps inline whatever gets merged from https://github.com/apache/arrow/pull/49761/changes or at least link to it