Skip to content

Commit a256fe6

Browse files
committed
Update the PerlSecPol to cover our new CVE process and provide an example.
Updates from PTS 2025 to clarify how the perl disclosure process will work. * Clarify what an embargo period is as this is surprisingly not well documented on the internet. * Provide a simple walkthrough to show a real example of the process.
1 parent 68ce332 commit a256fe6

File tree

1 file changed

+172
-36
lines changed

1 file changed

+172
-36
lines changed

pod/perlsecpolicy.pod

Lines changed: 172 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ determination of whether it is likely to fit the scope of issues the
4343
team handles. General guidelines about how this is determined are
4444
detailed in the L</WHAT ARE SECURITY ISSUES> section.
4545

46-
If your report meets the team's criteria, an issue will be opened in the
47-
team's private issue tracker and you will be provided the issue's ID number.
48-
Issue identifiers have the form perl-security#NNN. Include this identifier
46+
If your report meets the team's criteria, you will be provided the issue's
47+
CVE ID(s). Issue identifiers have the form CVE-YYYY-NNNNN, where YYYY is the
48+
year the CVE was reported, and NNNNN is a unique number. Include this identifier
4949
with any subsequent messages you send.
5050

5151
The security team will send periodic updates about the status of your
@@ -317,16 +317,20 @@ If the security report cannot be reproduced or does not meet the team's
317317
criteria for handling as a security issue, you will be notified by email
318318
and given an opportunity to respond.
319319

320-
=head3 Issue ID assignment
320+
=head3 CVE assignment
321321

322-
Security reports that pass initial triage analysis are turned into issues
323-
in the security team's private issue tracker. When a report progresses to
324-
this point you will be provided the issue ID for future reference. These
325-
identifiers have the format perl-security#NNN or Perl/perl-security#NNN.
322+
Security reports that pass initial triage analysis are turned into CVEs.
323+
When a report progresses to this point, one or more CVEs are reserved by
324+
the security team. Issue identifiers have the form CVE-YYYY-NNNNN, where
325+
YYYY is the year the CVE was reported, and NNNNN is a unique number. The
326+
CVE will be used in any subsequent communications about the issue.
326327

327-
The assignment of an issue ID does not confirm that a security report
328-
represents a vulnerability in Perl. Many reports require further analysis
329-
to reach that determination.
328+
The assignment of these IDs do not confirm that a security report represents
329+
a vulnerability in Perl. Many reports require further analysis to reach that
330+
determination. The vulnerability should not be discussed publicly at this stage.
331+
332+
An internal ticket will also be opened. These identifiers have the format
333+
perl-security#NNN or Perl/perl-security#NNN.
330334

331335
Issues in the security team's private tracker are used to collect details
332336
about the problem and track progress towards a resolution. These notes and
@@ -344,32 +348,27 @@ criteria at this stage, you will be notified by email and given an
344348
opportunity to respond before the issue is closed.
345349

346350
The team may discuss potential fixes with you or provide you with
347-
patches for testing purposes during this time frame. No information
348-
should be shared publicly at this stage.
351+
patches for testing purposes during this time frame.
349352

350-
=head3 CVE ID assignment
353+
=head3 The CVE is updated.
351354

352355
Once an issue is fully confirmed and a potential fix has been found,
353-
the security team will request a CVE identifier for the issue to use
354-
in public announcements.
356+
the security team will communicate with the
357+
L<CPAN Security Group|https://security.metacpan.org/>.
355358

356359
Details like the range of vulnerable Perl versions and identities
357-
of the people that discovered the flaw need to be collected to submit
358-
the CVE ID request.
360+
of the people that discovered the flaw need to be collected.
359361

360362
The security team may ask you to clarify the exact name we should use
361363
when crediting discovery of the issue. The
362364
L</Vulnerability credit and bounties> section of this document
363365
explains our preferred format for this credit.
364366

365-
Once a CVE ID has been assigned, you will be notified by email.
366-
The vulnerability should not be discussed publicly at this stage.
367-
368367
=head3 Pre-release notifications
369368

370369
When the security team is satisfied that the fix for a security issue
371-
is ready to release publicly, a pre-release notification
372-
announcement is sent to the major redistributors of Perl.
370+
is ready to release publicly, a pre-release notification announcement
371+
is sent to the major redistributors of Perl.
373372

374373
This pre-release announcement includes a list of Perl versions that
375374
are affected by the flaw, an analysis of the risks to users, patches
@@ -381,8 +380,8 @@ The pre-release announcement will include a specific target date
381380
when the issue will be announced publicly. The time frame between
382381
the pre-release announcement and the release date allows redistributors
383382
to prepare and test their own updates and announcements. During this
384-
period the vulnerability details and fixes are embargoed and should not
385-
be shared publicly. This embargo period may be extended further if
383+
period the vulnerability details and fixes are embargoed (see L</Embargo Period> )
384+
and should not be shared publicly. This L</Embargo Period> may be extended further if
386385
problems are discovered during testing.
387386

388387
You will be sent the portions of pre-release announcements that are
@@ -401,22 +400,22 @@ rather than applying patches to an older release. The security
401400
team works with Perl's release managers to make this possible.
402401

403402
New official releases of Perl are generally produced and tested
404-
on private systems during the pre-release embargo period.
403+
on private systems during the pre-release L</Embargo Period>.
405404

406405
=head3 Release of fixes and announcements
407406

408-
At the end of the embargo period the security fixes will be
409-
committed to Perl's public git repository and announcements will be
410-
sent to the L<perl5-porters|https://lists.perl.org/list/perl5-porters.html>
411-
and L<oss-security|https://oss-security.openwall.org/wiki/mailing-lists/oss-security>
407+
The L</Embargo Period> ends when the security fixes are committed to Perl's
408+
public git repository. Announcements will be sent to the
409+
L<perl5-porters|https://lists.perl.org/list/perl5-porters.html> and
410+
L<oss-security|https://oss-security.openwall.org/wiki/mailing-lists/oss-security>
412411
mailing lists.
413412

414413
If official Perl releases are ready, they will be published at this time
415414
and announced on the L<perl5-porters|https://lists.perl.org/list/perl5-porters.html>
416415
mailing list.
417416

418417
The security team will send a follow-up notification to everyone that
419-
participated in the pre-release embargo period once the release process is
418+
participated in the pre-release L</Embargo Period> once the release process is
420419
finished. Vulnerability reporters and Perl redistributors should not publish
421420
their own announcements or fixes until the Perl security team's release process
422421
is complete.
@@ -455,12 +454,11 @@ request a CVE ID and send an announcement to inform users.
455454

456455
=head2 Vulnerability credit and bounties
457456

458-
The Perl project appreciates the effort security researchers
459-
invest in making Perl safe and secure.
457+
The Perl project appreciates the effort security researchers invest in making
458+
Perl safe and secure.
460459

461-
Since much of this work is hidden from the public, crediting
462-
researchers publicly is an important part of the vulnerability
463-
remediation process.
460+
Since much of this work is hidden from the public, crediting researchers
461+
publicly is an important part of the vulnerability remediation process.
464462

465463
=head3 Credits in vulnerability announcements
466464

@@ -488,4 +486,142 @@ omitted from announcements.
488486
The Perl project is a non-profit volunteer effort. We do not provide
489487
any monetary rewards for reporting security issues in Perl.
490488

489+
=head2 Embargo Period
490+
491+
In the context of Perl's coordinated vulnerability disclosure process, an "embargo"
492+
refers to the period of time during which information about a reported vulnerability
493+
is kept confidential. This embargo begins when a security issue is reported to the
494+
Perl security team and lasts until a fix has been developed and a fix is provided
495+
in a public location.
496+
497+
The purpose of the embargo is to allow the security team to work on a fix
498+
and prepare a coordinated release without the risk of the vulnerability being
499+
exploited or disclosed prematurely. This helps ensure that users of Perl
500+
and its modules are protected from potential attacks while the security
501+
issue is being addressed.
502+
503+
Embargo lengths can vary depending on the complexity of the issue and the
504+
time required to develop a fix. The security team will communicate
505+
the expected duration of the embargo to the reporter and any other
506+
parties involved in the process.
507+
508+
As a goal, the security team aims to keep the total embargo period to less
509+
than 60 days. This may be extended due to the following factors:
510+
511+
=over 4
512+
513+
=item *
514+
515+
The complexity of the issue
516+
517+
=item *
518+
519+
The time required to develop a fix
520+
521+
=item *
522+
523+
The need for additional testing or validation
524+
525+
=item *
526+
527+
The availability of resources to address the issue
528+
529+
=item *
530+
531+
Public holidays which might affect the ability of end users to apply the fix.
532+
533+
=back
534+
535+
During this period:
536+
537+
=over 4
538+
539+
=item *
540+
541+
Details of the vulnerability are shared only with a restricted group of trusted contributors
542+
(such as core maintainers, toolchain maintainers, and packagers), solely for the purpose
543+
of preparing and testing a fix.
544+
545+
=item *
546+
547+
Reporters are asked not to disclose the issue publicly or share details with third parties
548+
until the embargo is lifted.
549+
550+
=item *
551+
552+
The duration of the embargo may vary depending on the severity and complexity of the issue,
553+
but typically lasts until the relevant security patch is released and announced.
554+
555+
=item *
556+
557+
Breaking the embargo — by prematurely disclosing details — undermines the coordinated
558+
disclosure process and may result in reduced cooperation in future cases.
559+
560+
=back
561+
562+
The Perl security team strives to resolve vulnerabilities promptly and encourages all parties
563+
to respect the embargo period to help protect users and downstream distributions.
564+
565+
=head2 Example Release Process
566+
567+
This section provides an example of how a security issue reported by a third
568+
party might be handled by the Perl security team, from the initial report to
569+
the final release.
570+
571+
=head3 Step 1: Reporting the Vulnerability
572+
573+
A security researcher discovers a vulnerability in the Perl interpreter that
574+
allows an attacker to cause a denial of service under specific conditions. The
575+
researcher emails the details of the issue to
576+
L<[email protected]|mailto:[email protected]>, including a
577+
proof-of-concept script and a description of the impact.
578+
579+
=head3 Step 2: Initial Response
580+
581+
Within 72 hours, the security team acknowledges receipt of the report and
582+
confirms that the issue is under investigation. The researcher is informed of
583+
the expected timeline for triage.
584+
585+
=head3 Step 3: Initial Triage
586+
587+
The security team reproduces the issue using the provided proof-of-concept and
588+
determines that it meets the criteria for handling as a security issue. One or
589+
more CVEs are reserved. The team notifies the researcher referencing the CVE IDs.
590+
591+
=head3 Step 4: Development of a Fix
592+
593+
The security team analyzes the affected code and develops a patch to address
594+
the vulnerability. The patch is tested against various scenarios to ensure it
595+
resolves the issue without introducing regressions. The researcher is invited
596+
to test the patch privately and provide feedback.
597+
598+
=head3 Step 5: Pre-Release Notification
599+
600+
The security team prepares a pre-release notification, including details of
601+
the vulnerability, the affected Perl versions, and the patch. This notification
602+
is sent to major redistributors of Perl under embargo, giving them time to
603+
prepare their own updates.
604+
605+
=head3 Step 6: Pre-Release Testing
606+
607+
During the remaining embargo period, pre-notified redistributors prepare packages
608+
for release and test the patch to ensure compatibility with their systems.
609+
610+
=head3 Step 7: Public Release
611+
612+
On the scheduled release date, the patch is committed to Perl's public git
613+
repository. An official announcement is sent to the
614+
L<perl5-porters|https://lists.perl.org/list/perl5-porters.html> and
615+
L<oss-security|https://oss-security.openwall.org/wiki/mailing-lists/oss-security>
616+
mailing lists. If applicable, a new Perl release containing the fix is
617+
published.
618+
619+
The security team will notify CPAN Security to publish the CVE.
620+
621+
=head3 Step 8: Vendor and Third-Party Updates
622+
623+
Vendors and third-party maintainers incorporate the patch or updated Perl
624+
release into their distributions. The security team follows up with all
625+
parties involved to ensure the issue is resolved and users are protected.
626+
491627
=cut

0 commit comments

Comments
 (0)