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