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