Botan-3 Migration

Phatcat · Phatcat · commit 2a9c7176139c · 2025-04-28T03:36:07.000+02:00
Complete Botan-3 migration target:

Removal of FindBotan and using supplied config
Migrate from marked as deprecated functions
 -1363 padding needs to be done manually now
 -No serialization directly on the hasher
 -no declaration of functions with a serialization.

target_link_libraries:
srp6 need botan and doesn't have it linked
libs/shared need to be linked to botan as well
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -99,8 +99,17 @@ set(version_file "${CMAKE_CURRENT_BINARY_DIR}/Version.cpp")
 ##############################
 #            Botan           #
 ##############################
-find_package(Botan 2.14.0 REQUIRED)
-include_directories(${BOTAN_INCLUDE_DIRS})
+find_package(Botan 3.7.0 REQUIRED)
+# Check if the static target exists; otherwise fallback to the shared target.
+if(TARGET Botan::Botan-static)
+  set(BOTAN_LIBRARY Botan::Botan-static)
+  message(STATUS "Using Botan static library")
+elseif(TARGET Botan::Botan)
+  set(BOTAN_LIBRARY Botan::Botan)
+  message(STATUS "Using Botan shared library")
+else()
+  message(FATAL_ERROR "No valid Botan target found")
+endif()
 
 ##############################
 #     MySQL Connector C++    #
diff --git a/Dockerfile b/Dockerfile
@@ -22,7 +22,7 @@ RUN apt-get -y update && apt-get -y upgrade \
  && apt-get -y install cmake \
  && apt-get -y install git \
  # Install required library packages
- && apt-get install -y libbotan-2-dev \
+ && apt-get install -y libbotan-3-dev \
  && apt-get install -y libmysqlcppconn-dev \
  && apt-get install -y zlib1g-dev \
  && apt-get install -y libpcre3-dev \
@@ -60,8 +60,6 @@ RUN --mount=type=cache,target=build \
     -DBUILD_OPT_TOOLS=${build_optional_tools} \
     -DPCRE_STATIC_LIB=${pcre_static_lib} \
     -DDISABLE_EMBER_THREADS=${disable_threads} \
-    -DBOTAN_ROOT_DIR=/usr/include/botan-2/ \
-    -DBOTAN_LIBRARY=/usr/lib/x86_64-linux-gnu/libbotan-2.so \
     && cd build && make -j$(nproc) install \
     && make test
 
@@ -70,7 +68,7 @@ ARG install_dir=/usr/local/bin
 ARG working_dir=/usr/src/ember
 WORKDIR ${install_dir}
 RUN apt-get -y update \
- && apt-get install -y libbotan-2-19 \
+ && apt-get install -y libbotan-3-7 \
  && apt-get install -y libmysqlcppconn7v5 \
  && apt-get install -y mysql-client
 COPY --from=builder ${install_dir} ${install_dir}
diff --git a/cmake/FindBotan.cmake b/cmake/FindBotan.cmake
diff --git a/src/account/AccountService.cpp b/src/account/AccountService.cpp
@@ -45,7 +45,8 @@ AccountService::handle_session_fetch(const SessionLookup& msg, const Link& link,
 		return response;
 	}
 
-	auto key = Botan::BigInt::encode(*session);
+	std::vector<uint8_t> key((*session).bytes());
+	(*session).serialize_to(std::span<uint8_t>(key.data(), key.size()));
 
 	response.status = Status::OK;
 	response.account_id = msg.account_id();
diff --git a/src/gateway/AccountClient.cpp b/src/gateway/AccountClient.cpp
@@ -86,7 +86,7 @@ void AccountClient::handle_locate_response(std::expected<const SessionResponse*,
 		return;
 	}
 
-	auto key = Botan::BigInt::decode(msg->key()->data(), msg->key()->size());
+	auto key = Botan::BigInt::from_bytes(std::span<const std::uint8_t>(msg->key()->data(), msg->key()->size()));
 	cb(msg->status(), std::move(key));
 }
 
diff --git a/src/gateway/PacketCrypto.h b/src/gateway/PacketCrypto.h
@@ -44,7 +44,7 @@ class PacketCrypto final {
 		);
 
 		key_.resize(key.bytes(), boost::container::default_init);
-		key.binary_encode(key_.data(), key_.size());
+		key.serialize_to(std::span<uint8_t>( key_.data() + (key_.size() - key.bytes()), key.bytes() ));
 	}
 
 	inline void encrypt(auto& data) {
diff --git a/src/gateway/states/Authentication.cpp b/src/gateway/states/Authentication.cpp
@@ -164,7 +164,7 @@ void prove_session(ClientContext& ctx, const Botan::BigInt& key) {
 		key.bytes(), boost::container::default_init
 	);
 
-	key.binary_encode(k_bytes.data(), k_bytes.size());
+	key.serialize_to(std::span<uint8_t>(k_bytes.data() + (k_bytes.size() - key.bytes()), key.bytes()));
 
 	const std::uint32_t protocol_id = 0; // best guess, this is hardcoded to zero in the client
 	auto& auth_ctx = std::get<Context>(ctx.state_ctx);
diff --git a/src/libs/shared/CMakeLists.txt b/src/libs/shared/CMakeLists.txt
@@ -137,5 +137,5 @@ source_group("Metrics" FILES ${METRICS_SRC})
 include_directories(${CMAKE_SOURCE_DIR}/deps/utf8cpp ${PROJECT_BINARY_DIR}/src)
 add_library(${LIBRARY_NAME} ${LIBRARY_SRC})
 target_include_directories(${LIBRARY_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/)
-target_link_libraries(${LIBRARY_NAME} logger conpool ${PCRE_LIBRARY})
+target_link_libraries(${LIBRARY_NAME} logger conpool ${BOTAN_LIBRARY} ${PCRE_LIBRARY})
 set_target_properties(${LIBRARY_NAME} PROPERTIES FOLDER "Common Libraries")
diff --git a/src/libs/shared/shared/database/daos/mysql/PatchDAO.h b/src/libs/shared/shared/database/daos/mysql/PatchDAO.h
@@ -64,7 +64,8 @@ class MySQLPatchDAO final : public PatchDAO {
 
 			const auto md5 = res->getString("md5");
 			Botan::BigInt md5_int(md5.asStdString());
-			Botan::BigInt::encode_1363(meta.file_meta.md5.data(), meta.file_meta.md5.size(), md5_int);
+			std::fill(meta.file_meta.md5.begin(), meta.file_meta.md5.end(), 0);		// 1363 style padding
+			md5_int.serialize_to({ meta.file_meta.md5.data() + meta.file_meta.md5.size() - md5_int.bytes(), md5_int.bytes() });
 			patches.emplace_back(std::move(meta));
 		}
 
@@ -87,8 +88,8 @@ class MySQLPatchDAO final : public PatchDAO {
 		stmt->setBoolean(3, meta.mpq);
 		stmt->setString(4, meta.file_meta.name);
 		stmt->setUInt64(5, meta.file_meta.size);
-		auto md5 = Botan::BigInt::decode(reinterpret_cast<const std::uint8_t*>(meta.file_meta.md5.data()),
-		                                 meta.file_meta.md5.size());
+		auto md5 = Botan::BigInt::from_bytes(std::span<const uint8_t>(reinterpret_cast<const std::uint8_t*>(
+                                                     meta.file_meta.md5.data()), meta.file_meta.md5.size()));
 
 		stmt->setString(6, md5.to_hex_string());
 		stmt->setUInt(7, meta.locale_id);
diff --git a/src/libs/srp6/CMakeLists.txt b/src/libs/srp6/CMakeLists.txt
@@ -19,5 +19,6 @@ add_library(${LIBRARY_NAME}
 			include/srp6/detail/Primes.h
            )
 
+target_link_libraries(${LIBRARY_NAME} PRIVATE ${BOTAN_LIBRARY})
 target_include_directories(${LIBRARY_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
 set_target_properties(${LIBRARY_NAME} PROPERTIES FOLDER "Common Libraries")
diff --git a/src/libs/srp6/src/Client.cpp b/src/libs/srp6/src/Client.cpp
@@ -23,7 +23,7 @@ Client::Client(std::string identifier, std::string password, Generator gen, std:
 	: Client(std::move(identifier),
 	         std::move(password),
 	         gen,
-             BigInt::decode((AutoSeeded_RNG()).random_vec(key_size)) % gen.prime(),
+             BigInt::from_bytes(std::span<const uint8_t>{ (AutoSeeded_RNG().random_vec(key_size)).data(), key_size }) % gen.prime(),
 	         srp6a) { }
 
 Client::Client(std::string identifier, std::string password, Generator gen, BigInt a, bool srp6a)
@@ -64,7 +64,7 @@ SessionKey Client::session_key(const BigInt& B, std::span<const std::uint8_t> sa
 		return SessionKey(detail::interleaved_hash(detail::encode_flip_1363(S, N.bytes())));
 	} else {
 		KeyType key(S.bytes(), boost::container::default_init);
-		S.binary_encode(key.data(), key.size());
+		S.serialize_to(std::span<uint8_t>(key.data(), key.size()));
 		return SessionKey(key);
 	}
 }
diff --git a/src/libs/srp6/src/Server.cpp b/src/libs/srp6/src/Server.cpp
@@ -48,7 +48,7 @@ SessionKey Server::session_key(const BigInt& A, Compliance mode, bool interleave
 		return SessionKey(detail::interleaved_hash(detail::encode_flip_1363(S, N_.bytes())));
 	} else {
 		KeyType key(N_.bytes(), boost::container::default_init);
-		S.binary_encode(key.data(), key.size());
+		S.serialize_to(std::span<uint8_t>(key.data(), key.size()));
 		return SessionKey(key);
 	}
 }
diff --git a/src/libs/srp6/src/Util.cpp b/src/libs/srp6/src/Util.cpp
@@ -21,19 +21,20 @@ namespace detail {
 
 Botan::BigInt decode_flip(std::span<std::uint8_t> val) {
 	std::ranges::reverse(val);
-	return Botan::BigInt::decode(val.data(), val.size());
+	return Botan::BigInt::from_bytes(std::span<const uint8_t>(val.data(), val.size()));
 }
 
 SmallVec encode_flip(const Botan::BigInt& val) {
 	SmallVec res(val.bytes(), boost::container::default_init);
-	val.binary_encode(res.data(), res.size());
+	val.serialize_to(std::span<uint8_t>(res.data(), res.size()));
 	std::ranges::reverse(res);
 	return res;
 }
 
 SmallVec encode_flip_1363(const Botan::BigInt& val, std::size_t padding) {
 	SmallVec res(padding, boost::container::default_init);
-	Botan::BigInt::encode_1363(res.data(), res.size(), val);
+	std::fill(res.begin(), res.end(), 0); // 1363 style padding
+	val.serialize_to({ res.data() + res.size() - val.bytes(), val.bytes() });
 	std::ranges::reverse(res);
 	return res;
 }
@@ -69,15 +70,15 @@ Botan::BigInt scrambler(const Botan::BigInt& A, const Botan::BigInt& B, std::siz
 	auto hasher = Botan::HashFunction::create_or_throw("SHA-1");
 	BOOST_ASSERT_MSG(SHA1_LEN == hasher->output_length(), "Bad hash length");
 	std::array<std::uint8_t, SHA1_LEN> hash_out;
-	SmallVec vec(padding, boost::container::default_init);
+	SmallVec vec(padding, 0); // 1363 style padding
 
 	if(mode == Compliance::RFC5054) {
-		Botan::BigInt::encode_1363(vec.data(), vec.size(), A);
+		A.serialize_to(std::span<uint8_t>(vec.data(), vec.size()));
 		hasher->update(vec.data(), vec.size());
-		Botan::BigInt::encode_1363(vec.data(), vec.size(), B);
+		B.serialize_to(std::span<uint8_t>(vec.data(), vec.size()));
 		hasher->update(vec.data(), vec.size());
 		hasher->final(hash_out.data());
-		return Botan::BigInt::decode(hash_out.data(), hash_out.size());
+		return Botan::BigInt::from_bytes(std::span<const uint8_t>(hash_out.data(), hash_out.size()));
 	} else {
 		const auto& a_enc = encode_flip_1363(A, padding);
 		const auto& b_enc = encode_flip_1363(B, padding);
@@ -93,10 +94,14 @@ Botan::BigInt compute_k(const Botan::BigInt& g, const Botan::BigInt& N) {
 	std::array<std::uint8_t, SHA1_LEN> hash;
 	auto hasher = Botan::HashFunction::create_or_throw("SHA-1");
 	BOOST_ASSERT_MSG(SHA1_LEN == hasher->output_length(), "Bad hash length");
-	hasher->update(Botan::BigInt::encode(N));
-	hasher->update(Botan::BigInt::encode_1363(g, N.bytes()));
+	std::vector<uint8_t> n_buf(N.bytes(), 0);		// 1363 style padding
+	N.serialize_to({ n_buf.data() + n_buf.size() - N.bytes(), N.bytes() });
+	std::vector<uint8_t> g_buf(N.bytes(), 0);		// 1363 style padding
+	g.serialize_to({ g_buf.data() + g_buf.size() - g.bytes(), g.bytes() });
+	hasher->update(n_buf.data(), n_buf.size());
+	hasher->update(g_buf.data(), g_buf.size());
 	hasher->final(hash.data());
-	return Botan::BigInt::decode(hash.data(), hash.size());
+	return Botan::BigInt::from_bytes(std::span<const uint8_t>(hash.data(), hash.size()));
 }
 
 Botan::BigInt compute_x(std::string_view identifier, std::string_view password,
@@ -123,7 +128,7 @@ Botan::BigInt compute_x(std::string_view identifier, std::string_view password,
 	hasher->final(hash.data());
 
 	if(mode == Compliance::RFC5054) {
-		return Botan::BigInt::decode(hash.data(), hash.size());
+		return Botan::BigInt::from_bytes(std::span<const uint8_t>(hash.data(), hash.size()));
 	} else {
 		return detail::decode_flip(hash);
 	}
diff --git a/src/login/AccountClient.cpp b/src/login/AccountClient.cpp
@@ -89,7 +89,7 @@ void AccountClient::handle_locate_response(std::expected<const SessionResponse*,
 		return;
 	}
 
-	auto key = Botan::BigInt::decode(msg->key()->data(), msg->key()->size());
+	auto key = Botan::BigInt::from_bytes(std::span<const std::uint8_t>(msg->key()->data(), msg->key()->size()));
 	cb(msg->status(), std::move(key));
 }
 
diff --git a/src/login/Authenticator.cpp b/src/login/Authenticator.cpp
@@ -53,7 +53,7 @@ ReconnectAuthenticator::ReconnectAuthenticator(utf8_string username,
 	: username_(std::move(username)) {
 	std::ranges::copy(salt, salt_.data());
 	sess_key_.t.resize(session_key.bytes());
-	session_key.binary_encode(sess_key_.t.data(), sess_key_.t.size());
+	session_key.serialize_to(std::span<uint8_t>(sess_key_.t.data() + (sess_key_.t.size() - session_key.bytes()), session_key.bytes()));
 }
 
 bool ReconnectAuthenticator::proof_check(std::span<const std::uint8_t> salt,
diff --git a/src/login/LoginHandler.cpp b/src/login/LoginHandler.cpp
@@ -360,7 +360,7 @@ bool LoginHandler::validate_client_integrity(std::span<const std::uint8_t> hash,
 		salt.bytes(), boost::container::default_init
 	);
 
-	salt.binary_encode(bytes.data(), bytes.size());
+	salt.serialize_to(std::span<uint8_t>(bytes.data(), salt.bytes()));
 	std::ranges::reverse(bytes);
 	return validate_client_integrity(hash, bytes, reconnect);
 }
diff --git a/src/login/grunt/client/LoginProof.h b/src/login/grunt/client/LoginProof.h
@@ -166,11 +166,13 @@ class LoginProof final : public Packet {
 		stream << opcode;
 
 		std::array<std::uint8_t, A_LENGTH> a_bytes;
-		Botan::BigInt::encode_1363(a_bytes.data(), a_bytes.size(), A);
+		std::fill(a_bytes.begin(), a_bytes.end(), 0); // 1363 style padding
+		A.serialize_to({ a_bytes.data() + a_bytes.size() - A.bytes(), A.bytes() });
 		stream.put(a_bytes.rbegin(), a_bytes.rend());
 
 		std::array<std::uint8_t, M1_LENGTH> m1_bytes;
-		Botan::BigInt::encode_1363(m1_bytes.data(), m1_bytes.size(), M1);
+		std::fill(m1_bytes.begin(), m1_bytes.end(), 0); // 1363 style padding
+		M1.serialize_to({ m1_bytes.data() + m1_bytes.size() - M1.bytes(), M1.bytes() });
 		stream.put(m1_bytes.rbegin(), m1_bytes.rend());
 
 		stream.put(client_checksum.data(), client_checksum.size());
diff --git a/src/login/grunt/server/LoginChallenge.h b/src/login/grunt/server/LoginChallenge.h
@@ -132,19 +132,22 @@ class LoginChallenge final : public Packet {
 		}
 		
 		std::array<std::uint8_t, PUB_KEY_LENGTH> bytes{};
-		Botan::BigInt::encode_1363(bytes.data(), bytes.size(), B);
+		std::fill(bytes.begin(), bytes.end(), 0); // 1363 style padding
+		B.serialize_to({ bytes.data() + (bytes.size() - B.bytes()), B.bytes() });
 		stream.put(bytes.rbegin(), bytes.rend());
 
 		stream << g_len;
 		stream << g;
 		stream << n_len;
 
 		static_assert(bytes.size() == PRIME_LENGTH);
-		Botan::BigInt::encode_1363(bytes.data(), bytes.size(), N);
+		std::fill(bytes.begin(), bytes.end(), 0); // 1363 style padding
+		N.serialize_to({ bytes.data() + (bytes.size() - N.bytes()), N.bytes() });
 		stream.put(bytes.rbegin(), bytes.rend());
 
 		static_assert(bytes.size() == SALT_LENGTH);
-		Botan::BigInt::encode_1363(bytes.data(), bytes.size(), s);
+		std::fill(bytes.begin(), bytes.end(), 0); // 1363 style padding
+		s.serialize_to({ bytes.data() + (bytes.size() - s.bytes()), s.bytes() });
 		stream.put(bytes.rbegin(), bytes.rend());
 
 		stream.put(checksum_salt.data(), checksum_salt.size());
diff --git a/src/login/grunt/server/LoginProof.h b/src/login/grunt/server/LoginProof.h
diff --git a/src/tools/srpgen/main.cpp b/src/tools/srpgen/main.cpp
diff --git a/tests/MPQ.cpp b/tests/MPQ.cpp
diff --git a/tests/SRP6.cpp b/tests/SRP6.cpp

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,8 @@ AccountService::handle_session_fetch(const SessionLookup& msg, const Link& link,`
`45`	`45`	`return response;`
`46`	`46`	`}`
`47`	`47`
`48`		`- auto key = Botan::BigInt::encode(*session);`
	`48`	`+ std::vector<uint8_t> key((*session).bytes());`
	`49`	`+ (*session).serialize_to(std::span<uint8_t>(key.data(), key.size()));`
`49`	`50`
`50`	`51`	`response.status = Status::OK;`
`51`	`52`	`response.account_id = msg.account_id();`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ void AccountClient::handle_locate_response(std::expected<const SessionResponse*,`
`86`	`86`	`return;`
`87`	`87`	`}`
`88`	`88`
`89`		`- auto key = Botan::BigInt::decode(msg->key()->data(), msg->key()->size());`
	`89`	`+ auto key = Botan::BigInt::from_bytes(std::span<const std::uint8_t>(msg->key()->data(), msg->key()->size()));`
`90`	`90`	`cb(msg->status(), std::move(key));`
`91`	`91`	`}`
`92`	`92`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class PacketCrypto final {`
`44`	`44`	`);`
`45`	`45`
`46`	`46`	`key_.resize(key.bytes(), boost::container::default_init);`
`47`		`- key.binary_encode(key_.data(), key_.size());`
	`47`	`+ key.serialize_to(std::span<uint8_t>( key_.data() + (key_.size() - key.bytes()), key.bytes() ));`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`inline void encrypt(auto& data) {`
Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,6 @@ add_library(${LIBRARY_NAME}`
`19`	`19`	`include/srp6/detail/Primes.h`
`20`	`20`	`)`
`21`	`21`
	`22`	`+target_link_libraries(${LIBRARY_NAME} PRIVATE ${BOTAN_LIBRARY})`
`22`	`23`	`target_include_directories(${LIBRARY_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)`
`23`	`24`	`set_target_properties(${LIBRARY_NAME} PROPERTIES FOLDER "Common Libraries")`