security/reporting.html · security/reporting.rst 공식 원문 ↗

Zephyr 3.7.0 · Security

Security Vulnerability Reporting

Private advisory가 triage와 fix를 거쳐 최대 90일 뒤 공개되는 전 과정을 정리합니다.

Official pathsecurity/reporting.html
Source filesecurity/reporting.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

본문 기준: Zephyr 3.7.0 LTS3 · 이후 유지보수 패치는 별도입니다.

Part 1

요약·해설

PSIRT 접근 통제, 상태 전이, 30+60일 일정과 LTS backport 책임을 설명합니다.

Acknowledge

Within 1 week

Embargo

At most 90 days

Backport

Current LTS · latest two

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 3DF9BDDC6E2C1ABEAF5324D844909B848684337A146DF39F01DCA8BA7C53849C
.. _reporting:

Security Vulnerability Reporting
################################

Introduction
============

Vulnerabilities to the Zephyr project may be reported via email to the
[email protected] mailing list.  These reports will be
acknowledged and analyzed by the security response team within 1 week.
Each vulnerability will be entered into the Zephyr Project security
advisory GitHub_.  The original submitter will be granted permission to
view the issues that they have reported.

.. _GitHub: https://github.com/zephyrproject-rtos/zephyr/security

Security Issue Management
=========================

Issues within this bug tracking system will transition through a
number of states according to this diagram:

.. graphviz::

   digraph {
      node [style = rounded];
      init [shape = point];
      New [shape = box];
      Triage [shape = box];
      {
        rank = same;
        rankdir = LR;
        Assigned [shape = box];
        Rejected [shape = box];
      }
      Review [shape = box];
      Accepted [shape = box];
      Public [shape = box];

      init -> New;
      New -> Triage;
      Triage -> Rejected [dir = both];
      Triage -> Assigned;
      Assigned -> Review [dir = both];
      Review -> Accepted;
      Review -> Rejected;
      Accepted -> Public;

   }

- New: This state represents new reports that have been entered
  directly by a reporter.  When entered by the response team in
  response to an email, the issue shall be transitioned directly to
  Triage.

- Triage: This issue is awaiting Triage by the response team.  The
  response team will analyze the issue, determine a responsible
  entity, assign it to that individual, and move the
  issue to the Assigned state.  Part of triage will be to set the
  issue's priority.

- Assigned: The issue has been assigned, and is awaiting a fix by the
  assignee.

- Review: Once there is a Zephyr pull request for the issue, the PR
  link will be added to a comment in the issue, and the issue moved to
  the Review state.

- Accepted: Indicates that this issue has been merged into the
  appropriate branch within Zephyr.

- Public: The embargo period has ended.  The issue will be made
  publicly visible, the associated CVE updated, and the
  vulnerabilities page in the docs updated to include the detailed
  information.

The security advisories created are kept private, due to the
sensitive nature of security reports.  The issues are only visible to
certain parties:

- Members of the PSIRT mailing list

- the reporter

- others, as proposed and ratified by the Zephyr Security
  Subcommittee.  In the general case, this will include:

  - The code owner responsible for the fix.

  - The Zephyr release owners for the relevant releases affected by
    this vulnerability.

The Zephyr Security Subcommittee shall review the reported
vulnerabilities during any meeting with more than three people in
attendance.  During this review, they shall determine if new issues
need to be embargoed.

The guideline for embargo will be based on: 1. Severity of the issue,
and 2. Exploitability of the issue.  Issues that the subcommittee
decides do not need an embargo will be reproduced in the regular
Zephyr project bug tracking system.

.. _vulnerability_timeline:

Security sensitive vulnerabilities shall be made public after an
embargo period of at most 90 days.  The intent is to allow 30 days
within the Zephyr project to fix the issues, and 60 days for external
parties building products using Zephyr to be able to apply and
distribute these fixes.

.. _vulnerability_fix_recommendations:

Fixes to the code shall be made through pull requests PR in the Zephyr
project github.  Developers shall make an attempt to not reveal the
sensitive nature of what is being fixed, and shall not refer to CVE
numbers that have been assigned to the issue.  The developer instead
should merely describe what has been fixed.

The security subcommittee will maintain information mapping embargoed
CVEs to these PRs (this information is within the Github security
advisories), and produce regular reports of the state of security
issues.

Each issue that is considered a security vulnerability shall be
assigned a CVE number.  As fixes are created, it may be necessary to
allocate additional CVE numbers, or to retire numbers that were
assigned.

Vulnerability Notification
==========================

Each Zephyr release shall contain a report of CVEs that were fixed in
that release.  Because of the sensitive nature of these
vulnerabilities, the release shall merely include a list of CVEs that
have been fixed.  After the embargo period, the vulnerabilities page
shall be updated to include additional details of these
vulnerabilities.  The vulnerability page shall give credit to the
reporter(s) unless a reporter specifically requests anonymity.

The Zephyr project shall maintain a vulnerability-alerts mailing list.
This list will be seeded initially with a contact from each project
member.  Additional parties can request to join this list by filling
out the form at the `Vulnerability Registry`_.  These parties will be
vetted by the project director to determine that they have a
legitimate interest in knowing about security vulnerabilities during
the embargo period.

.. _Vulnerability Registry: https://www.zephyrproject.org/vulnerability-registry/ 

Periodically, the security subcommittee will send information to this
mailing list describing known embargoed issues, and their backport
status within the project.  This information is intended to allow them
to determine if they need to backport these changes to any internal
trees.

When issues have been triaged, this list will be informed of:

- The Zephyr Project security advisory link (GitHub).

- The CVE number assigned.

- The subsystem involved.

- The severity of the issue.

After acceptance of a PR fixing the issue (merged), in addition to the
above, the list will be informed of:

- The association between the CVE number and the PR fixing it.

- Backport plans within the Zephyr project.

Backporting of Security Vulnerabilities
=======================================

Each security issue fixed within zephyr shall be backported to the
following releases:

- The current Long Term Stable (LTS) release.

- The most recent two releases.

The developer of the fix shall be responsible for any necessary
backports, and apply them to any of the above listed release branches,
unless the fix does not apply (the vulnerability was introduced after
this release was made). All recommendations for
:ref:`vulnerability fixes <vulnerability_fix_recommendations>` apply
for backport pull requests (and associated issues). Additionally, it is
recommended that the developer privately informs the responsible
release manager that the backport pull request and issue are addressing
a vulnerability.

Backports will be tracked on the security advisory.

Need to Know
============

Due to the sensitive nature of security vulnerabilities, it is
important to share details and fixes only with those parties that have
a need to know.  The following parties will need to know details about
security vulnerabilities before the embargo period ends:

- Maintainers will have access to all information within their domain
  area only.

- The current release manager, and the release manager for historical
  releases affected by the vulnerability (see backporting above).

- The Project Security Incident Response (PSIRT) team will have full
  access to information.  The PSIRT is made up of representatives from
  platinum members, and volunteers who do work on triage from other
  members.

- As needed, release managers and maintainers may be invited to attend
  additional security meetings to discuss vulnerabilities.

Part 3

한국어 전문 번역

소개

Zephyr project의 vulnerability는 [email protected] mailing list로 email을 보내 report할 수 있습니다. Security response team은 1주 안에 report 접수를 확인하고 분석합니다. 각 vulnerability는 Zephyr Project security advisory GitHub에 등록되며, 최초 reporter에게 자신이 report한 issue를 볼 permission이 부여됩니다.

Security issue 관리

Bug tracking system의 issue는 다음 상태를 거칩니다.

Zephyr security advisory 상태 전이
New

Reporter가 직접 등록
→ Triage

Triage

우선순위·책임자 결정
↔ Rejected 또는 → Assigned

Assigned

담당자가 fix 작성
↔ Review

Review

PR link 검토
→ Accepted 또는 → Rejected

Accepted

적절한 branch에 merge
→ Public

Public

Embargo 종료
CVE·문서 공개

Rejected

Triage와 양방향 재검토
Review에서도 이동 가능

  • New: Reporter가 직접 입력한 새 report를 나타냅니다. Response team이 email report를 대신 입력했다면 issue를 즉시 Triage로 전환합니다.
  • Triage: Response team의 분류를 기다리는 상태입니다. Team이 issue를 분석하고 책임 entity를 정해 담당자에게 assign하고 Assigned로 옮기며, 이 과정에서 priority도 설정합니다.
  • Assigned: Issue가 담당자에게 할당되어 fix를 기다립니다.
  • Review: Issue용 Zephyr pull request가 생기면 PR link를 issue comment에 추가하고 Review로 옮깁니다.
  • Accepted: Fix가 적절한 Zephyr branch에 merge되었음을 뜻합니다.
  • Public: Embargo 기간이 끝났습니다. Issue를 공개하고 관련 CVE를 갱신하며 documentation의 vulnerability page에 상세 정보를 추가합니다.

Security report는 민감하므로 생성된 security advisory를 private으로 유지합니다. Issue는 PSIRT mailing list member, reporter, 그리고 Zephyr Security Subcommittee가 제안하고 승인한 사람에게만 보입니다. 일반적으로 fix 담당 code owner와 vulnerability의 영향을 받는 release의 Zephyr release owner가 포함됩니다.

Zephyr Security Subcommittee는 세 명을 초과하는 인원이 참석한 meeting마다 report된 vulnerability를 검토하고 새 issue에 embargo가 필요한지 판단합니다.

Embargo guideline은 issue severity와 exploitability 두 요소를 기준으로 합니다. Subcommittee가 embargo가 필요 없다고 판단한 issue는 일반 Zephyr project bug tracking system에 다시 등록합니다.

Security-sensitive vulnerability는 최대 90일의 embargo 뒤 공개합니다. Zephyr project 내부에서 fix하는 데 30일, Zephyr로 product를 만드는 외부 party가 fix를 적용하고 배포하는 데 60일을 제공하려는 일정입니다.

Code fix는 Zephyr project GitHub의 pull request로 제출합니다. Developer는 수정 대상이 security-sensitive하다는 사실을 드러내지 않도록 노력해야 하며 issue에 부여된 CVE number를 언급하지 않습니다. 대신 무엇을 수정했는지만 설명합니다.

Security subcommittee는 embargo된 CVE와 PR의 mapping을 GitHub security advisory 안에 유지하고 security issue 상태 report를 정기적으로 만듭니다.

Security vulnerability로 간주된 각 issue에는 CVE number를 부여합니다. Fix를 만드는 과정에서 CVE를 추가 할당하거나 이미 할당한 number를 폐기해야 할 수도 있습니다.

Vulnerability 알림

각 Zephyr release에는 그 release에서 고친 CVE report가 포함됩니다. Vulnerability가 민감하므로 release에는 수정한 CVE 목록만 넣습니다. Embargo가 끝난 뒤 vulnerability page에 상세 정보를 추가합니다. Reporter가 anonymity를 명시적으로 요청하지 않는 한 page에서 reporter에게 credit을 제공합니다.

Zephyr project는 vulnerability-alerts mailing list를 유지합니다. 처음에는 각 project member의 contact 한 명씩으로 구성합니다. 다른 party는 Vulnerability Registry form으로 가입을 요청할 수 있습니다. Project director는 embargo 기간 중 security vulnerability를 알아야 할 정당한 이해관계가 있는지 검토합니다.

Security subcommittee는 알려진 embargo issue와 project 안의 backport 상태를 이 mailing list에 주기적으로 보냅니다. 수신자는 이 정보를 바탕으로 internal tree에 change를 backport해야 하는지 판단합니다.

Issue triage가 끝나면 mailing list에 다음 내용을 알립니다.

  • Zephyr Project security advisory link(GitHub)
  • 할당된 CVE number
  • 관련 subsystem
  • Issue severity

Issue를 고치는 PR이 accept되어 merge된 뒤에는 위 정보에 더해 다음 내용도 알립니다.

  • CVE number와 이를 고친 PR의 관계
  • Zephyr project 내부 backport plan

Security vulnerability backport

Zephyr에서 수정한 각 security issue는 다음 release로 backport해야 합니다.

  • 현재 Long Term Stable(LTS) release
  • 가장 최근 두 release

Fix developer는 필요한 backport를 책임지고 위 release branch에 적용합니다. 단, 해당 release 뒤에 vulnerability가 도입되어 fix가 적용되지 않는 경우는 제외합니다. Vulnerability fix에 대한 모든 권고는 backport PR과 관련 issue에도 적용합니다. 또한 developer가 책임 release manager에게 backport PR과 issue가 vulnerability를 다룬다는 사실을 private하게 알리는 것을 권장합니다.

Backport 진행 상태는 security advisory에서 추적합니다.

Need to Know 원칙

Security vulnerability는 민감하므로 세부 정보와 fix를 알아야 할 필요가 있는 party에게만 공유하는 것이 중요합니다. Embargo 종료 전 세부 정보가 필요한 party는 다음과 같습니다.

  • Maintainer는 자신의 domain 영역에 해당하는 모든 정보에만 접근합니다.
  • 현재 release manager와 vulnerability 영향을 받는 과거 release의 release manager가 접근합니다.
  • Project Security Incident Response Team(PSIRT)은 모든 정보에 접근합니다. PSIRT는 platinum member 대표와 다른 member 중 triage를 수행하는 volunteer로 구성됩니다.
  • 필요하면 release manager와 maintainer를 추가 security meeting에 초대해 vulnerability를 논의할 수 있습니다.

Source

출처

영어 원문에는 문단, 문서 지시문, 표, 코드, 코드 심벌, 경로를 그대로 보존했습니다.