]> git.ipfire.org Git - thirdparty/openssl.git/commit
Add exporters for CMake
authorRichard Levitte <levitte@openssl.org>
Wed, 3 May 2023 10:36:09 +0000 (12:36 +0200)
committerRichard Levitte <levitte@openssl.org>
Wed, 15 Nov 2023 07:22:29 +0000 (08:22 +0100)
commitc768ccebc718ea0ed6afc5147fe4079fff632cd6
treef9ad63ab2a131144ad0740429fda4ab8a58b024c
parent2ac569a67b9d0980efa2d8061a6a61e0645f37a7
Add exporters for CMake

CMake's older package finder, FindOpenSSL.cmake, does a best guess effort
and doesn't always get it right.

By CMake's own documentation, that's what such modules are (best effort
attempts), and package producers are (strongly) encouraged to help out by
producing and installing <PackageName>Config.cmake files to get a more
deterministic configuration.

The resulting OpenSSLConfig.cmake tries to mimic the result from CMake's
FindOpenSSL.cmake, by using the same variable and imported target names.
It also adds a few extra variables of its own, such as:

    OPENSSL_MODULES_DIR     Indicates the default installation directory
                            for OpenSSL loadable modules, such as providers.
    OPENSSL_RUNTIME_DIR     Indicates the default runtime directory, where
                            for example the openssl program is located.
    OPENSSL_PROGRAM         Is the full directory-and-filename of the
                            openssl program.

The imported targets OpenSSL::Crypto and OpenSSL::SSL are as precisely
specified as possible, so for example, they are specified with the both the
import library and the DLL on Windows, which should make life easier on that
platform.

For the moment, one of the following must be done in your CMake project for
this CMake configuration to take priority over CMake's FindOpenSSL.cmake:

-   The variable CMAKE_FIND_PACKAGE_PREFER_CONFIG must be set to true prior
    to the 'find_package(OpenSSL)' call.
-   The 'find_package' call itself must use the "Full Signature".  If you
    don't know any better, simply add the 'CONFIG' option, i.e. from this
    example:

        find_package(OpenSSL 3.0 REQUIRED)

    to this:

        find_package(OpenSSL 3.0 REQUIRED CONFIG)

Just as with the 'pkg-config' exporters, two variants of the .cmake files
are produced:

- Those in 'exporters/' are installed in the location that 'pkg-config'
  itself prefers for installed packages.
- Those in the top directory are to be used when it's desirable to build
  directly against an OpenSSL build tree.

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20878)
.gitignore
Configurations/unix-Makefile.tmpl
Configurations/windows-makefile.tmpl
build.info
exporters/build.info
exporters/cmake/OpenSSLConfig.cmake.in [new file with mode: 0644]
exporters/cmake/OpenSSLConfigVersion.cmake.in [new file with mode: 0644]
util/mkinstallvars.pl