Skip to content

Commit 5ceb574

Browse files
committed
Add a security policy
1 parent b19c023 commit 5ceb574

File tree

5 files changed

+108
-8
lines changed

5 files changed

+108
-8
lines changed

Makefile.PL

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use ExtUtils::MakeMaker;
77

88
my %WriteMakefileArgs = (
99
"ABSTRACT" => "A toolkit to help sign and verify XML Digital Signatures.",
10-
"AUTHOR" => "Byrne Reese <byrne\@cpan.org>, Timothy Legge <timlegge\@cpan.org>",
10+
"AUTHOR" => "Timothy Legge <timlegge\@gmail.com>",
1111
"CONFIGURE_REQUIRES" => {
1212
"ExtUtils::MakeMaker" => 0
1313
},

README

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -300,10 +300,8 @@ AUTHORS and CREDITS
300300

301301
Maintainer: Timothy Legge <timlegge@cpan.org>
302302

303-
AUTHORS
304-
* Byrne Reese <byrne@cpan.org>
305-
306-
* Timothy Legge <timlegge@cpan.org>
303+
AUTHOR
304+
Timothy Legge <timlegge@gmail.com>
307305

308306
COPYRIGHT AND LICENSE
309307
This software is copyright (c) 2025 by Byrne Reese, Chris Andrews and

SECURITY.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Security Policy for the XML-Sig distribution.
2+
3+
Report security issues by email to Timothy Legge <timlegge@gmail.com>.
4+
5+
This is the Security Policy for XML-Sig.
6+
7+
This text is based on the CPAN Security Group's Guidelines for Adding
8+
a Security Policy to Perl Distributions (version 1.3.0)
9+
https://security.metacpan.org/docs/guides/security-policy-for-authors.html
10+
11+
# How to Report a Security Vulnerability
12+
13+
Security vulnerabilities can be reported to the current XML-Sig
14+
maintainers by email to Timothy Legge <timlegge@gmail.com>.
15+
16+
Please include as many details as possible, including code samples
17+
or test cases, so that we can reproduce the issue. Check that your
18+
report does not expose any sensitive data, such as passwords,
19+
tokens, or personal information.
20+
21+
If you would like any help with triaging the issue, or if the issue
22+
is being actively exploited, please copy the report to the CPAN
23+
Security Group (CPANSec) at <cpan-security@security.metacpan.org>.
24+
25+
Please *do not* use the public issue reporting system on RT or
26+
GitHub issues for reporting security vulnerabilities.
27+
28+
Please do not disclose the security vulnerability in public forums
29+
until past any proposed date for public disclosure, or it has been
30+
made public by the maintainers or CPANSec. That includes patches or
31+
pull requests.
32+
33+
For more information, see
34+
[Report a Security Issue](https://security.metacpan.org/docs/report.html)
35+
on the CPANSec website.
36+
37+
## Response to Reports
38+
39+
The maintainer(s) aim to acknowledge your security report as soon as
40+
possible. However, this project is maintained by a single person in
41+
their spare time, and they cannot guarantee a rapid response. If you
42+
have not received a response from them within 2 weeks, then
43+
please send a reminder to them and copy the report to CPANSec at
44+
<cpan-security@security.metacpan.org>.
45+
46+
Please note that the initial response to your report will be an
47+
acknowledgement, with a possible query for more information. It
48+
will not necessarily include any fixes for the issue.
49+
50+
The project maintainer(s) may forward this issue to the security
51+
contacts for other projects where we believe it is relevant. This
52+
may include embedded libraries, system libraries, prerequisite
53+
modules or downstream software that uses this software.
54+
55+
They may also forward this issue to CPANSec.
56+
57+
# Which Software This Policy Applies To
58+
59+
Any security vulnerabilities in XML-Sig are covered by this policy.
60+
61+
Security vulnerabilities in versions of any libraries that are
62+
included in XML-Sig are also covered by this policy.
63+
64+
Security vulnerabilities are considered anything that allows users
65+
to execute unauthorised code, access unauthorised resources, or to
66+
have an adverse impact on accessibility or performance of a system.
67+
68+
Security vulnerabilities in upstream software (prerequisite modules
69+
or system libraries, or in Perl), are not covered by this policy
70+
unless they affect XML-Sig, or XML-Sig can
71+
be used to exploit vulnerabilities in them.
72+
73+
Security vulnerabilities in downstream software (any software that
74+
uses XML-Sig, or plugins to it that are not included with the
75+
XML-Sig distribution) are not covered by this policy.
76+
77+
## Supported Versions of XML-Sig
78+
79+
The maintainer(s) will only commit to releasing security fixes for
80+
the latest version of XML-Sig.
81+
82+
# Installation and Usage Issues
83+
84+
The distribution metadata specifies minimum versions of
85+
prerequisites that are required for XML-Sig to work. However, some
86+
of these prerequisites may have security vulnerabilities, and you
87+
should ensure that you are using up-to-date versions of these
88+
prerequisites.
89+
90+
Where security vulnerabilities are known, the metadata may indicate
91+
newer versions as recommended.
92+
93+
## Usage
94+
95+
Please see the software documentation for further information.

cpanfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ on 'configure' => sub {
3939

4040
on 'develop' => sub {
4141
requires "Pod::Coverage::TrustPod" => "0";
42+
requires "Software::Security::Policy::Individual" => "0";
4243
requires "Test::EOF" => "0";
4344
requires "Test::EOL" => "0";
4445
requires "Test::More" => "0.88";

dist.ini

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = XML-Sig
22
abstract = A toolkit to help sign and verify XML Digital Signatures.
3-
author = Byrne Reese <byrne@cpan.org>
4-
author = Timothy Legge <timlegge@cpan.org>
3+
;author = Byrne Reese <byrne@cpan.org>
4+
author = Timothy Legge <timlegge@gmail.com>
55
copyright_holder = Byrne Reese, Chris Andrews and Others, see the git log
66
; [...]
77
license = Perl_5
@@ -47,6 +47,7 @@ exclude_filename = dev-bin/cpanm
4747
exclude_filename = Dockerfile
4848
exclude_filename = MANIFEST
4949
exclude_filename = README
50+
exclude_filename = SECURITY.md
5051

5152
[Encoding]
5253
encoding = bytes
@@ -58,9 +59,10 @@ match = ico
5859
copy = cpanfile
5960
copy = Makefile.PL
6061
copy = README
62+
copy = SECURITY.md
6163

6264
[CopyFilesFromRelease]
63-
copy = cpanfile, Makefile.PL, README
65+
copy = cpanfile, Makefile.PL, README, SECURITY.md
6466

6567
[MetaJSON]
6668
[MetaProvides::Package]
@@ -88,6 +90,10 @@ version_regexp = ^(0.\d+)$ ; this is the default
8890
[OurPkgVersion]
8991
[WriteVersion]
9092

93+
[SecurityPolicy]
94+
-policy = Individual
95+
timeframe = 2 weeks
96+
9197
[Git::Tag]
9298
tag_format = %V ; this is the default
9399
tag_message = %V ; this is the default

0 commit comments

Comments
 (0)