Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions doc/sphinx-guides/source/developers/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Security

These are security resources for Dataverse developers.

```{contents}
:local:
```

## User-Facing Security-Related Documentation

You should familiarize yourself with the following content we provide for our users to read:

- {ref}`ongoing-security`
- {ref}`security-advisories`
- {ref}`reporting-security-issues`
- [SECURITY.md](https://github.com/IQSS/dataverse/blob/develop/.github/SECURITY.md) (rendered for the public at <https://github.com/IQSS/dataverse/security>)

Some information is repeated across these documents and we should keep them in sync.

## Tracking Security Issues

We use a private GitHub issue tracker at <https://github.com/IQSS/dataverse-security/issues> for security issues.

## Sending Security Advisories

See our [how to send a security advisory](https://docs.google.com/document/d/1sYhi-_U1xP2ZEjWtqVqkuuMxncG_VZZYQRKDEv6N-KQ/edit?usp=sharing) doc.
34 changes: 0 additions & 34 deletions doc/sphinx-guides/source/developers/security.rst

This file was deleted.

30 changes: 25 additions & 5 deletions doc/sphinx-guides/source/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,16 +252,34 @@ For any resources to be integrated with Dataverse, find documentation how to set
Ongoing Security of Your Installation
+++++++++++++++++++++++++++++++++++++

Like any application, you should keep up-to-date with patches to both the Dataverse software and the platform (usually Linux) it runs on. Dataverse releases are announced on the dataverse-community_ mailing list, the Dataverse blog_, and in chat.dataverse.org_.
New Releases
^^^^^^^^^^^^

Like any application, you should keep up-to-date with new releases of Dataverse, which often contain security fixes.

Dataverse releases are announced on the dataverse-community_ mailing list, Zulip_, and the Dataverse blog_.

.. _dataverse-community: https://groups.google.com/g/dataverse-community
.. _Zulip: https://dataverse.zulipchat.com/
.. _blog: https://dataverse.org/blog
.. _chat.dataverse.org: https://chat.dataverse.org

In addition to these public channels, you can subscribe to receive security notices via email from the Dataverse team. These notices are sent to the ``contact_email`` in the installation spreadsheet_ and you can open an issue in the dataverse-installations_ repo to add or change the contact email. Security notices are also sent to people and organizations that prefer to remain anonymous. To be added to this private list, please email support@dataverse.org.
These announcements link to release notes, which can be found on GitHub:

- Backend: https://github.com/IQSS/dataverse/releases
- Frontend: https://github.com/IQSS/dataverse-frontend/releases

If the release contains a security-related fix, the release notes will mention generically that a fix is included. Some details are provided via private security advisories, described below.

.. _security-advisories:

.. _spreadsheet: https://docs.google.com/spreadsheets/d/1bfsw7gnHlHerLXuk7YprUT68liHfcaMxs1rFciA-mEo/edit#gid=0
.. _dataverse-installations: https://github.com/IQSS/dataverse-installations
Security Advisories
^^^^^^^^^^^^^^^^^^^

We highly recommend signing up to receive security advisories from the Dataverse team. These advisories are not archived publicly because we don't want attackers to use exploits against you. For this reason we also control who is subscribed to the security advisory mailing list.

To subscribe, email support@dataverse.org and ask to be added to the Dataverse security advisory mailing list.

Below you'll see a step called :ref:`map-of-installations` where you can provide a email address we can use to contact you. We typically automatically add this address to the security list but please feel free to reach out early.

For additional details about security practices by the Dataverse team, see the :doc:`/developers/security` section of the Developer Guide.

Expand Down Expand Up @@ -2572,6 +2590,8 @@ One way to submit your sitemap URL to Google is by using their "Search Console"

.. _Google's "submit a sitemap" instructions: https://support.google.com/webmasters/answer/183668

.. _map-of-installations:

Putting Your Dataverse Installation on the Map at dataverse.org
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Expand Down