Skip to content

Commit 7dcbbc1

Browse files
committed
Add CONTRIBUTING, SECURITY policies.
1 parent 6ce0ff0 commit 7dcbbc1

File tree

3 files changed

+130
-0
lines changed

3 files changed

+130
-0
lines changed

CONTRIBUTING

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
I welcome bug reports, patches, and suggestions. My preferred way to
2+
recieve these is via the RT system at
3+
https://rt.cpan.org/Public/Dist/Display.html?Name=Win32API-File-Time,
4+
but I happily accept them either through GitHub at
5+
https://github.com/trwyant/perl-Win32API-File-Time,
6+
by electronic mail to WYANT AT cpan DOT org, or any other way that works
7+
for you, though I can not accept owls because I have no facilities to
8+
house them. Non-RT requests may be turned into RT tickets by me unless
9+
you specifically request otherwise. The bug report, patch, or suggestion
10+
(if acted on) will also be acknowledged in the Changes file unless you
11+
specifically request othewise.
12+
13+
Requests for information probably do not need to be tickets in RT or
14+
GitHub, and my preferred route for these is by electronic mail, but
15+
again anything that works for you is probably fine with me.
16+
17+
I try hard never to reject a bug report outright, though I may edit
18+
patches, believe that a different fix is more in line with my vision for
19+
the code, or even that the report is due to a misunderstanding and
20+
address it with a documentation change. Whatever I decide I will give
21+
you time to respond (typically a week or so), and whatever I actually do
22+
I will give you time to see if it meets your needs before I do a
23+
production release.
24+
25+
GitHub pull requests should be made on a topic branch rather than the
26+
master branch. If you have something big in mind I would appreciate a
27+
heads-up in some form prior to the pull request.

MANIFEST

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Build.PL
22
Changes
3+
CONTRIBUTING
34
eg/README
45
eg/touch.pl
56
inc/mock/Win32/API.pm
@@ -15,6 +16,7 @@ MANIFEST
1516
META.json
1617
META.yml
1718
README
19+
SECURITY
1820
t/basic.t
1921
t/file.t
2022
xt/author/changes.t

SECURITY

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

0 commit comments

Comments
 (0)