xref: /netbsd-src/crypto/external/bsd/openssl/dist/SUPPORT.md (revision b0d1725196a7921d003d2c66a14f186abda4176b)
1*b0d17251SchristosOpenSSL User Support resources
2*b0d17251Schristos==============================
3*b0d17251Schristos
4*b0d17251SchristosSee the <https://www.openssl.org/support/contracts.html> for details on how to
5*b0d17251Schristosobtain commercial technical support.
6*b0d17251Schristos
7*b0d17251SchristosIf you have general questions about using OpenSSL
8*b0d17251Schristos-------------------------------------------------
9*b0d17251Schristos
10*b0d17251SchristosIn this case the [openssl-users] mailing list is the right place for you.
11*b0d17251SchristosThe list is not only watched by the OpenSSL team members, but also by many
12*b0d17251Schristosother OpenSSL users. Here you will most likely get the answer to your questions.
13*b0d17251SchristosAn overview over the [mailing lists](#mailing-lists) can be found below.
14*b0d17251Schristos
15*b0d17251SchristosIf you think you found a Bug
16*b0d17251Schristos----------------------------
17*b0d17251Schristos
18*b0d17251Schristos*NOTE: this section assumes that you want to report it or figure it out and
19*b0d17251Schristosfix it.  What's written here is not to be taken as a recipe for how to get a
20*b0d17251Schristosworking production installation*
21*b0d17251Schristos
22*b0d17251SchristosIf you have any problems with OpenSSL then please take the following steps
23*b0d17251Schristosfirst:
24*b0d17251Schristos
25*b0d17251Schristos- Search the mailing lists and/or the GitHub issues to find out whether
26*b0d17251Schristos  the problem has already been reported.
27*b0d17251Schristos- Download the latest version from the repository to see if the problem
28*b0d17251Schristos  has already been addressed.
29*b0d17251Schristos- Configure without assembler support (`no-asm`) and check whether the
30*b0d17251Schristos  problem persists.
31*b0d17251Schristos- Remove compiler optimization flags.
32*b0d17251Schristos
33*b0d17251SchristosPlease keep in mind: Just because something doesn't work the way you expect
34*b0d17251Schristosdoes not mean it is necessarily a bug in OpenSSL. If you are not sure,
35*b0d17251Schristosconsider searching the mail archives and posting a question to the
36*b0d17251Schristos[openssl-users] mailing list first.
37*b0d17251Schristos
38*b0d17251Schristos### Open an Issue
39*b0d17251Schristos
40*b0d17251SchristosIf you wish to report a bug, please open an [issue][github-issues] on GitHub
41*b0d17251Schristosand include the following information:
42*b0d17251Schristos
43*b0d17251Schristos- OpenSSL version: output of `openssl version -a`
44*b0d17251Schristos- Configuration data: output of `perl configdata.pm --dump`
45*b0d17251Schristos- OS Name, Version, Hardware platform
46*b0d17251Schristos- Compiler Details (name, version)
47*b0d17251Schristos- Application Details (name, version)
48*b0d17251Schristos- Problem Description (steps that will reproduce the problem, if known)
49*b0d17251Schristos- Stack Traceback (if the application dumps core)
50*b0d17251Schristos
51*b0d17251SchristosNot only errors in the software, also errors in the documentation, in
52*b0d17251Schristosparticular the manual pages, can be reported as issues.
53*b0d17251Schristos
54*b0d17251Schristos### Submit a Pull Request
55*b0d17251Schristos
56*b0d17251SchristosThe fastest way to get a bug fixed is to fix it yourself ;-). If you are
57*b0d17251Schristosexperienced in programming and know how to fix the bug, you can open a
58*b0d17251Schristospull request. The details are covered in the [Contributing][contributing] section.
59*b0d17251Schristos
60*b0d17251SchristosDon't hesitate to open a pull request, even if it's only a small change
61*b0d17251Schristoslike a grammatical or typographical error in the documentation.
62*b0d17251Schristos
63*b0d17251SchristosMailing Lists
64*b0d17251Schristos=============
65*b0d17251Schristos
66*b0d17251SchristosThe OpenSSL maintains a number of [mailing lists] for various purposes.
67*b0d17251SchristosThe most important lists are:
68*b0d17251Schristos
69*b0d17251Schristos- [openssl-users]    for general questions about using the OpenSSL software
70*b0d17251Schristos                     and discussions between OpenSSL users.
71*b0d17251Schristos
72*b0d17251Schristos- [openssl-announce] for official announcements to the OpenSSL community.
73*b0d17251Schristos
74*b0d17251Schristos- [openssl-project]  for discussion about the development roadmap
75*b0d17251Schristos                     and governance.
76*b0d17251Schristos
77*b0d17251SchristosOnly subscribers can post to [openssl-users] or [openssl-project].  The
78*b0d17251Schristosarchives are made public, however.  For more information, see the [mailing
79*b0d17251Schristoslists] page.
80*b0d17251Schristos
81*b0d17251SchristosThere was an [openssl-dev] list that has been discontinued since development
82*b0d17251Schristosis now taking place in the form of GitHub pull requests. Although not active
83*b0d17251Schristosanymore, the searchable archive may still contain useful information.
84*b0d17251Schristos
85*b0d17251Schristos<!-- Links -->
86*b0d17251Schristos
87*b0d17251Schristos[mailing lists]:     https://www.openssl.org/community/mailinglists.html
88*b0d17251Schristos[openssl-users]:     https://mta.openssl.org/mailman/listinfo/openssl-users
89*b0d17251Schristos[openssl-announce]:  https://mta.openssl.org/mailman/listinfo/openssl-announce
90*b0d17251Schristos[openssl-project]:   https://mta.openssl.org/mailman/listinfo/openssl-project
91*b0d17251Schristos[openssl-dev]:       https://mta.openssl.org/mailman/listinfo/openssl-dev
92*b0d17251Schristos[github-issues]:     https://github.com/openssl/openssl/issues/new/choose
93*b0d17251Schristos[contributing]:      https://github.com/openssl/openssl/blob/master/CONTRIBUTING.md
94