Skip to content

Commit b135fd4

Browse files
lightseytoddr
authored andcommitted
Document the security team's processes and practices
Add a new perlsecpolicy POD file with detailed descriptions of the security team's vulnerability remediation workflow and the criteria used to distinguish security issues from other types of bugs. This also switches the team's public contact address to [email protected], and updates the security contact information shown in github's issue interface.
1 parent d7cdd62 commit b135fd4

File tree

7 files changed

+549
-26
lines changed

7 files changed

+549
-26
lines changed

MANIFEST

+1
Original file line numberDiff line numberDiff line change
@@ -5277,6 +5277,7 @@ pod/perlreref.pod Perl regular expressions quick reference
52775277
pod/perlretut.pod Perl regular expressions tutorial
52785278
pod/perlrun.pod Perl execution and options
52795279
pod/perlsec.pod Perl security
5280+
pod/perlsecpolicy.pod Perl security report handling policy
52805281
pod/perlsource.pod Guide to the Perl source tree
52815282
pod/perlstyle.pod Perl style guide
52825283
pod/perlsub.pod Perl subroutines

Porting/security_template.pod

+3-3
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ The current version of perl is available from https://www.perl.org/get.html .
6464
FIXME or use the following:
6565

6666
Specifics about the vulnerability were first disclosed to
67-
C<perl5-security-report>, a closed subscriber mailing list that has a
68-
subset of the perl 5 committers subcribed to it.
67+
C<perl-security>, a closed subscriber mailing list that has a
68+
subset of the perl committers subcribed to it.
6969

7070
=head2 When was the vulnerability discovered?
7171

@@ -78,6 +78,6 @@ FIXME
7878
=head2 How was the vulnerability reported?
7979

8080
FIXME: something like "So-and-so sent email to
81-
perl5-security-report@perl.org"
81+
8282

8383
=cut

SECURITY.md

+35-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,43 @@
11
# Security Policy
22

3+
Perl's vulnerability handling policies are described fully in
4+
[perlsecpolicy]
5+
36
## Reporting a Vulnerability
47

5-
If you believe you have found a security vulnerability in Perl, please email the details to [email protected]
8+
If you believe you have found a security vulnerability in the Perl
9+
interpreter or modules maintained in the core Perl codebase, email
10+
the details to [email protected]. This address is a closed
11+
membership mailing list monitored by the Perl security team.
12+
13+
You should receive an initial response to your report within 72 hours.
14+
If you do not receive a response in that time, please contact
15+
the security team lead [John Lightsey](mailto:[email protected]) and
16+
the Perl pumpking [SawyerX](mailto:[email protected]).
17+
18+
When members of the security team reply to your messages, they will
19+
generally include the [email protected] address in the "To" or "CC"
20+
fields of the response. This allows all of the security team to follow
21+
the discussion and chime in as needed. Use the "Reply-all" functionality
22+
of your email client when you send subsequent responses so that the
23+
entire security team receives the message.
624

7-
This creates a new Request Tracker ticket in a special queue which isn't initially publicly accessible. The email will also be copied to a closed subscription unarchived mailing list which includes all the core committers, who will be able to help assess the impact of issues, figure out a resolution, and help co-ordinate the release of patches to mitigate or fix the problem across all platforms on which Perl is supported. Please only use this address for security issues in the Perl core, not for modules independently distributed on CPAN.
25+
The security team will evaluate your report and make an initial
26+
determination of whether it is likely to fit the scope of issues the
27+
team handles. General guidelines about how this is determined are
28+
detailed in the ["WHAT ARE SECURITY ISSUES"] section of [perlsecpolicy].
829

9-
When sending an initial request to the security email address, please don't Cc any other parties, because if they reply to all, the reply will generate yet another new ticket. Once you have received an initial reply with a [perl #NNNNNN] ticket number in the headline, it's okay to Cc subsequent replies to third parties: all emails to the perl5-security-report address with the ticket number in the subject line will be added to the ticket; without it, a new ticket will be created.
30+
If your report meets the team's criteria, an issue will be opened in the
31+
team's private issue tracker and you will be provided the issue's ID number.
32+
Issue identifiers have the form perl-security#NNN. Include this identifier
33+
with any subsequent messages you send.
1034

11-
## PerlSec
35+
The security team will send periodic updates about the status of your
36+
issue and guide you through any further action that is required to complete
37+
the vulnerability remediation process. The stages vulnerabilities typically
38+
go through are explained in the ["HOW WE DEAL WITH SECURITY ISSUES"]
39+
section of [perlsecpolicy].
1240

13-
Read more at https://perldoc.perl.org/perlsec.html
41+
[perlsecpolicy]: pod/perlsecpolicy.pod
42+
["WHAT ARE SECURITY ISSUES"]: pod/perlsecpolicy.pod#what-are-security-issues
43+
["HOW WE DEAL WITH SECURITY ISSUES"]: pod/perlsecpolicy.pod#how-we-deal-with-security-issues

pod/perl.pod

+1
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ aux h2ph h2xs perlbug pl2pm pod2html pod2man splain xsubpp
129129
perlebcdic Considerations for running Perl on EBCDIC platforms
130130

131131
perlsec Perl security
132+
perlsecpolicy Perl security report handling policy
132133

133134
perlmod Perl modules: how they work
134135
perlmodlib Perl modules: how to write and use

pod/perlsec.pod

+8-18
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,14 @@ untrustworthy) programs to accomplish its purposes.
1414

1515
=head1 SECURITY VULNERABILITY CONTACT INFORMATION
1616

17-
If you believe you have found a security vulnerability in Perl, please
18-
email the details to [email protected]. This creates a new
19-
Request Tracker ticket in a special queue which isn't initially publicly
20-
accessible. The email will also be copied to a closed subscription
21-
unarchived mailing list which includes all the core committers, who will
22-
be able to help assess the impact of issues, figure out a resolution, and
23-
help co-ordinate the release of patches to mitigate or fix the problem
24-
across all platforms on which Perl is supported. Please only use this
25-
address for security issues in the Perl core, not for modules
26-
independently distributed on CPAN.
27-
28-
When sending an initial request to the security email address, please
29-
don't Cc any other parties, because if they reply to all, the reply will
30-
generate yet another new ticket. Once you have received an initial reply
31-
with a C<[perl #NNNNNN]> ticket number in the headline, it's okay to Cc
32-
subsequent replies to third parties: all emails to the
33-
perl5-security-report address with the ticket number in the subject line
34-
will be added to the ticket; without it, a new ticket will be created.
17+
If you believe you have found a security vulnerability in the Perl
18+
interpreter or modules maintained in the core Perl codebase,
19+
email the details to
20+
21+
This address is a closed membership mailing list monitored by the Perl
22+
security team.
23+
24+
See L<perlsecpolicy> for additional information.
3525

3626
=head1 SECURITY MECHANISMS AND CONCERNS
3727

0 commit comments

Comments
 (0)