Clarify folly::ssl::init documentation
[folly.git] / folly / ssl / OpenSSLVersionFinder.h
1 /*
2  * Copyright 2017 Facebook, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17
18 #include <folly/Conv.h>
19 #include <folly/portability/OpenSSL.h>
20
21 // This is used to find the OpenSSL version at runtime. Just returning
22 // OPENSSL_VERSION_NUMBER is insufficient as runtime version may be different
23 // from the compile-time version
24 struct OpenSSLVersionFinder {
25   static std::string getOpenSSLLongVersion() {
26 #ifdef OPENSSL_VERSION_TEXT
27     return SSLeay_version(SSLEAY_VERSION);
28 #elif defined(OPENSSL_VERSION_NUMBER)
29     return folly::format("0x{:x}", OPENSSL_VERSION_NUMBER).str();
30 #else
31     return "";
32 #endif
33   }
34
35   uint64_t getOpenSSLNumericVersion() {
36 #ifdef OPENSSL_VERSION_NUMBER
37     return SSLeay();
38 #else
39     return 0;
40 #endif
41   }
42 };