Skip to content

Delete .github/FUNDING.yml #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samarsamer251-glitch wants to merge 2 commits into
base: function-removal
Choose a base branch
from
Open

Delete .github/FUNDING.yml #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b35d51
Start the 4.0 migration guide
bob-beck Nov 25, 2025
376078c
Delete .github/FUNDING.yml
samarsamer251-glitch Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
264 changes: 2 additions & 262 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,263 +1,3 @@
Welcome to the OpenSSL Project
==============================

[![openssl logo]][www.openssl.org]

[![github actions ci badge]][github actions ci]
[![Nightly OS Zoo ci badge](https://github.com/openssl/openssl/actions/workflows/os-zoo.yml/badge.svg)](https://github.com/openssl/openssl/actions/workflows/os-zoo.yml)
[![Provider Compatibility](https://github.com/openssl/openssl/actions/workflows/provider-compatibility.yml/badge.svg)](https://github.com/openssl/openssl/actions/workflows/provider-compatibility.yml)
[![Quic Interop](https://github.com/openssl/openssl/actions/workflows/run_quic_interop.yml/badge.svg)](https://github.com/openssl/openssl/actions/workflows/run_quic_interop.yml)
[![Daily checks](https://github.com/openssl/openssl/actions/workflows/run-checker-daily.yml/badge.svg)](https://github.com/openssl/openssl/actions/workflows/run-checker-daily.yml)
[![LFX Health Score](https://insights.linuxfoundation.org/api/badge/health-score?project=openssl)](https://insights.linuxfoundation.org/project/openssl)

OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit
for the Transport Layer Security (TLS, formerly SSL), Datagram TLS (DTLS), and QUIC protocols.

The protocol implementations are based on a full-strength general purpose
cryptographic library, which can also be used stand-alone. Also included is a
cryptographic module validated to conform with FIPS standards.

OpenSSL is descended from the SSLeay library developed by Eric A. Young
and Tim J. Hudson.

The official Home Page of the OpenSSL Project is [www.openssl.org].

Table of Contents
=================

- [Overview](#overview)
- [Download](#download)
- [Build and Install](#build-and-install)
- [Documentation](#documentation)
- [License](#license)
- [Support](#support)
- [Contributing](#contributing)
- [Legalities](#legalities)

Overview
========

The OpenSSL toolkit includes:

- **libssl**
an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446]),
DTLS protocol versions up to DTLSv1.2 ([RFC 6347]) and
the QUIC version 1 protocol ([RFC 9000]).

- **libcrypto**
a full-strength general purpose cryptographic library. It constitutes the
basis of the TLS implementation, but can also be used independently.

- **openssl**
the OpenSSL command line tool, a swiss army knife for cryptographic tasks,
testing and analyzing. It can be used for
- creation of key parameters
- creation of X.509 certificates, CSRs and CRLs
- calculation of message digests
- encryption and decryption
- SSL/TLS/DTLS and client and server tests
- QUIC client tests
- handling of S/MIME signed or encrypted mail
- and more...

Download
========

For Production Use
------------------

Source code tarballs of the official releases can be downloaded from
[openssl-library.org/source/](https://openssl-library.org/source/).
The OpenSSL project does not distribute the toolkit in binary form.

However, for a large variety of operating systems precompiled versions
of the OpenSSL toolkit are available. In particular, on Linux and other
Unix operating systems, it is normally recommended to link against the
precompiled shared libraries provided by the distributor or vendor.

We also maintain a list of third parties that produce OpenSSL binaries for
various Operating Systems (including Windows) on the [Binaries] page on our
wiki.

For Testing and Development
---------------------------

Although testing and development could in theory also be done using
the source tarballs, having a local copy of the git repository with
the entire project history gives you much more insight into the
code base.

The main OpenSSL Git repository is private.
There is a public GitHub mirror of it at [github.com/openssl/openssl],
which is updated automatically from the former on every commit.

A local copy of the Git repository can be obtained by cloning it from
the GitHub mirror using

git clone https://github.com/openssl/openssl.git

If you intend to contribute to OpenSSL, either to fix bugs or contribute
new features, you need to fork the GitHub mirror and clone your public fork
instead.

git clone https://github.com/yourname/openssl.git

This is necessary because all development of OpenSSL nowadays is done via
GitHub pull requests. For more details, see [Contributing](#contributing).

Build and Install
=================

After obtaining the Source, have a look at the [INSTALL](INSTALL.md) file for
detailed instructions about building and installing OpenSSL. For some
platforms, the installation instructions are amended by a platform specific
document.

* [Notes for UNIX-like platforms](NOTES-UNIX.md)
* [Notes for Android platforms](NOTES-ANDROID.md)
* [Notes for Windows platforms](NOTES-WINDOWS.md)
* [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md)
* [Notes for the OpenVMS platform](NOTES-VMS.md)
* [Notes on Perl](NOTES-PERL.md)
* [Notes on Valgrind](NOTES-VALGRIND.md)

Specific notes on upgrading to OpenSSL 3.x from previous versions can be found
in the [ossl-guide-migration(7ossl)] manual page.

Documentation
=============

README Files
------------

There are some README.md files in the top level of the source distribution
containing additional information on specific topics.

* [Information about the OpenSSL QUIC protocol implementation](README-QUIC.md)
* [Information about the OpenSSL Provider architecture](README-PROVIDERS.md)
* [Information about using the OpenSSL FIPS validated module](README-FIPS.md)
* [Information about the legacy OpenSSL Engine architecture](README-ENGINES.md)

The OpenSSL Guide
-----------------

There are some tutorial and introductory pages on some important OpenSSL topics
within the [OpenSSL Guide].

Manual Pages
------------

The manual pages for the master branch and all current stable releases are
available online.

- [OpenSSL master](https://docs.openssl.org/master/)
- [OpenSSL 3.5](https://docs.openssl.org/3.5/)
- [OpenSSL 3.4](https://docs.openssl.org/3.4/)
- [OpenSSL 3.3](https://docs.openssl.org/3.3/)
- [OpenSSL 3.2](https://docs.openssl.org/3.2/)
- [OpenSSL 3.0](https://docs.openssl.org/3.0/)

Demos
-----

There are numerous source code demos for using various OpenSSL capabilities in the
[demos subfolder](./demos).

Wiki
----

There is a [GitHub Wiki] which is currently not very active.

License
=======

OpenSSL is licensed under the Apache License 2.0, which means that
you are free to get and use it for commercial and non-commercial
purposes as long as you fulfill its conditions.

See the [LICENSE.txt](LICENSE.txt) file for more details.

Support
=======

There are various ways to get in touch. The correct channel depends on
your requirement. See the [SUPPORT](SUPPORT.md) file for more details.

Contributing
============

If you are interested and willing to contribute to the OpenSSL project,
please take a look at the [CONTRIBUTING](CONTRIBUTING.md) file.

Legalities
==========

A number of nations restrict the use or export of cryptography. If you are
potentially subject to such restrictions, you should seek legal advice before
attempting to develop or distribute cryptographic code.

Copyright
=========

Copyright (c) 1998-2025 The OpenSSL Project Authors

Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson

All rights reserved.

<!-- Links -->

[www.openssl.org]:
<https://www.openssl.org>
"OpenSSL Homepage"

[github.com/openssl/openssl]:
<https://github.com/openssl/openssl>
"OpenSSL GitHub Mirror"

[GitHub Wiki]:
<https://github.com/openssl/openssl/wiki>
"OpenSSL Wiki"

[ossl-guide-migration(7ossl)]:
<https://docs.openssl.org/master/man7/ossl-guide-migration>
"OpenSSL Migration Guide"

[RFC 8446]:
<https://tools.ietf.org/html/rfc8446>

[RFC 6347]:
<https://tools.ietf.org/html/rfc6347>

[RFC 9000]:
<https://tools.ietf.org/html/rfc9000>

[Binaries]:
<https://github.com/openssl/openssl/wiki/Binaries>
"List of third party OpenSSL binaries"

[OpenSSL Guide]:
<https://docs.openssl.org/master/man7/ossl-guide-introduction>
"An introduction to OpenSSL"

<!-- Logos and Badges -->

[openssl logo]:
doc/images/openssl.svg
"OpenSSL Logo"

[github actions ci badge]:
<https://github.com/openssl/openssl/workflows/GitHub%20CI/badge.svg>
"GitHub Actions CI Status"

[github actions ci]:
<https://github.com/openssl/openssl/actions/workflows/ci.yml>
"GitHub Actions CI"

[appveyor badge]:
<https://ci.appveyor.com/api/projects/status/8e10o7xfrg73v98f/branch/master?svg=true>
"AppVeyor Build Status"

[appveyor jobs]:
<https://ci.appveyor.com/project/openssl/openssl/branch/master>
"AppVeyor Jobs"
= - creation of X.509 certificates, CSRs and CRLs
- INSTALL.md)
6 changes: 6 additions & 0 deletions doc/build.info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5033,6 +5033,10 @@ DEPEND[man/man7/openssl_user_macros.7]=man7/openssl_user_macros.pod
GENERATE[man/man7/openssl_user_macros.7]=man7/openssl_user_macros.pod
DEPEND[man7/openssl_user_macros.pod]{pod}=man7/openssl_user_macros.pod.in
GENERATE[man7/openssl_user_macros.pod]=man7/openssl_user_macros.pod.in
DEPEND[html/man7/ossl-ex-api.html]=man7/ossl-ex-api.pod
GENERATE[html/man7/ossl-ex-api.html]=man7/ossl-ex-api.pod
DEPEND[man/man7/ossl-ex-api.7]=man7/ossl-ex-api.pod
GENERATE[man/man7/ossl-ex-api.7]=man7/ossl-ex-api.pod
DEPEND[html/man7/ossl-guide-introduction.html]=man7/ossl-guide-introduction.pod
GENERATE[html/man7/ossl-guide-introduction.html]=man7/ossl-guide-introduction.pod
DEPEND[man/man7/ossl-guide-introduction.7]=man7/ossl-guide-introduction.pod
Expand Down Expand Up @@ -5312,6 +5316,7 @@ html/man7/openssl-quic-concurrency.html \
html/man7/openssl-quic.html \
html/man7/openssl-threads.html \
html/man7/openssl_user_macros.html \
html/man7/ossl-ex-api.html \
html/man7/ossl-guide-introduction.html \
html/man7/ossl-guide-libcrypto-introduction.html \
html/man7/ossl-guide-libraries-introduction.html \
Expand Down Expand Up @@ -5471,6 +5476,7 @@ man/man7/openssl-quic-concurrency.7 \
man/man7/openssl-quic.7 \
man/man7/openssl-threads.7 \
man/man7/openssl_user_macros.7 \
man/man7/ossl-ex-api.7 \
man/man7/ossl-guide-introduction.7 \
man/man7/ossl-guide-libcrypto-introduction.7 \
man/man7/ossl-guide-libraries-introduction.7 \
Expand Down
80 changes: 80 additions & 0 deletions doc/internal/man7/removal.pod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
=pod

=head1 NAME

removal - How to do Public API removal

=head1 DESCRIPTION

Removal of a public function should only be done after it has been
previously deprecated as documented in L<deprecation(7)>.

Once you are ready to remove a deprecated function, you need to
ensure one or more of the following things is true:

=over 4

=item There is a usually straightforward one-to-one replacement of the
deleted function with a new function.

=item The existing documentation for the function in the last release
describes how to replace the function. If you feel this documentation
is inadequate or incomplete, consider updating it if a maintenance
release will happen.

=item Details on how to replace the function are provided in
L<ossl-guide-migration(7)>. If the replacement is complex and was
not adequately documented in the past release, it is a good idea
to write a reasonable section here.

=back

Once that is done, you should prepare your PR that removes the
function, internal uses, and documentation.

Your PR removing functions should include adding the function to the
list in L<ossl-ex-api(7)> with an appropriate entry. Keep it short and
simple. Each entry in the list for a version can include a quick link
to the usual replacement such as:

=over 4

=item SIMPLE-removed-function (Deprecated in 3.0.0) see SIMPLE-replacement-function(3)

=back

If is more complex, mention that the documentation for a previous version should be
consulted, such as:

=over 4

=item REMOVED-morecomplex (Deprecated in 3.0.0) Consult the documentation in OpenSSL 3.6

=back

Alternatively, if a section covering this is in the migration guide:

=over 4

=item ENGINE-allthethings (Deprecated in 3.0.0) Consult L<ossl-guide-migration(7)>.

=back

The list should NOT include a long migration guide. That should have been present
in the previous version documentation, or added to ossl-guide-migration.pod

=head1 SEE ALSO

L<deprecation(7)>
L<ossl-guide-migration(7)>

=head1 COPYRIGHT

Copyright 2025 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Loading