This is an automated email from the ASF dual-hosted git repository.
chenBright pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/brpc.git
The following commit(s) were added to refs/heads/master by this push:
new 8b17e1544 fix(ubshm): reject truncated shared memory names (#3728)
8b17e1544 is described below
commit 8b17e1544ae93062405050f2e76e1567950078f7
Author: nkysg <[email protected]>
AuthorDate: Sat Nov 21 19:15:06 2026 +0800
fix(ubshm): reject truncated shared memory names (#3728)
* fix(ubshm): reject truncated shared memory names
* test(ubshm): cover overlong peer names in server handshake
* fix(ubshm): preserve shared memory name logging
---
src/brpc/ubshm/ub_endpoint.cpp | 23 +++++++++++++++++------
src/brpc/ubshm/ub_endpoint.h | 5 +++++
src/brpc/ubshm/ub_ring.cpp | 8 +++++---
test/brpc_ubring_unittest.cpp | 40 ++++++++++++++++++++++++++++++++++++++++
4 files changed, 67 insertions(+), 9 deletions(-)
diff --git a/src/brpc/ubshm/ub_endpoint.cpp b/src/brpc/ubshm/ub_endpoint.cpp
index 5141a7151..a0286cd2e 100644
--- a/src/brpc/ubshm/ub_endpoint.cpp
+++ b/src/brpc/ubshm/ub_endpoint.cpp
@@ -166,6 +166,17 @@ std::string HelloMessage::toString() const {
return std::string(buf.data(), static_cast<size_t>(n));
}
+bool BuildServerShmName(const char* peer_name,
+ char (&shm_name)[SHM_MAX_NAME_BUFF_LEN]) {
+ const int result = snprintf(shm_name, SHM_MAX_NAME_BUFF_LEN, "%s_%s",
+ peer_name, SERVER_SHM_NAME_SUFFIX);
+ if (UNLIKELY(result < 0 || result >= SHM_MAX_NAME_BUFF_LEN)) {
+ LOG(WARNING) << "Build server shared memory name failed, ret=" <<
result;
+ return false;
+ }
+ return true;
+}
+
UBShmEndpoint::UBShmEndpoint(Socket* s)
: _socket(s)
, _socket_id(s ? s->id() : INVALID_SOCKET_ID)
@@ -620,14 +631,14 @@ void* UBShmEndpoint::ProcessHandshakeAtServer(void* arg) {
if (client_ip_port != nullptr) {
*client_ip_port = '\0';
}
- int result = snprintf(local_trx_shm.name, SHM_MAX_NAME_BUFF_LEN,
"%s_%s",
- client_name, SERVER_SHM_NAME_SUFFIX);
- if (UNLIKELY(result < 0)) {
- LOG(WARNING) << "Copy client shared memory name failed, ret=" <<
result;
+ const bool server_name_valid =
+ BuildServerShmName(client_name, local_trx_shm.name);
+ if (!server_name_valid) {
ub_transport->_ub_state = UBShmTransport::UB_OFF;
}
- if (result >= 0 && ep->AllocateServerResources(
- &remote_trx_shm, &local_trx_shm, local_format) < 0) {
+ if (server_name_valid &&
+ ep->AllocateServerResources(&remote_trx_shm, &local_trx_shm,
+ local_format) < 0) {
LOG(WARNING) << "Fail to allocate ub resources, fallback to tcp:"
<< s->description();
ub_transport->_ub_state = UBShmTransport::UB_OFF;
diff --git a/src/brpc/ubshm/ub_endpoint.h b/src/brpc/ubshm/ub_endpoint.h
index 526966c9f..841ad1642 100644
--- a/src/brpc/ubshm/ub_endpoint.h
+++ b/src/brpc/ubshm/ub_endpoint.h
@@ -60,6 +60,11 @@ UbrDataFormat PreferredDataFormatForShmType(SHM_TYPE
shm_type);
UbrDataFormat SelectDataFormat(UbrDataFormat local_format,
uint16_t remote_format_id);
+// Builds the server-side shared-memory name derived from a peer name.
+// Returns false when the result cannot fit in shm_name.
+bool BuildServerShmName(const char* peer_name,
+ char (&shm_name)[SHM_MAX_NAME_BUFF_LEN]);
+
struct HelloMessage {
void Serialize(void* data) const;
void Deserialize(void* data);
diff --git a/src/brpc/ubshm/ub_ring.cpp b/src/brpc/ubshm/ub_ring.cpp
index 595b96d03..bdc63d7ce 100644
--- a/src/brpc/ubshm/ub_ring.cpp
+++ b/src/brpc/ubshm/ub_ring.cpp
@@ -1199,8 +1199,9 @@ RETURN_CODE UBRing::UbrMapRemoteShmAddTimer(SHM
*local_trx_shm, const char *loca
SHM_NAME_PREFIX,
local_name,
SERVER_SHM_NAME_SUFFIX);
- if (UNLIKELY(result < 0)) {
- LOG(ERROR) << "Copy server shared memory name failed, local_name=%s,
ret=%d.", local_name, result;
+ if (UNLIKELY(result < 0 || result >= SHM_MAX_NAME_BUFF_LEN)) {
+ LOG(ERROR) << "Copy server shared memory name failed, local_name="
+ << local_name << ", ret=" << result;
return UBRING_ERR;
}
UbrSetSleepTask(UBR_TASK_CONNECT_MAP_FRONT);
@@ -1260,8 +1261,9 @@ RETURN_CODE UBRing::ApplyAndMapLocalShm(SHM
*local_trx_shm, const char *local_na
SHM_NAME_PREFIX,
local_name,
CLIENT_SHM_NAME_SUFFIX);
- if (UNLIKELY(result < 0)) {
+ if (UNLIKELY(result < 0 || result >= SHM_MAX_NAME_BUFF_LEN)) {
LOG(ERROR) << "Copy client localTrx shared memory name failed,
local_name=" << local_name << ", ret=" << result;
+ UBRingManager::ReleaseUbrTrxFromMgr(_trx);
return UBRING_ERR;
}
diff --git a/test/brpc_ubring_unittest.cpp b/test/brpc_ubring_unittest.cpp
index f4f5c3657..c71fa9615 100644
--- a/test/brpc_ubring_unittest.cpp
+++ b/test/brpc_ubring_unittest.cpp
@@ -46,6 +46,7 @@ DECLARE_int32(ub_connect_timeout_s);
DECLARE_int32(ub_hb_timer_interval_s);
DECLARE_int32(ub_event_queue_timer_interval_us);
DECLARE_int32(ub_flying_io_timeout_s);
+DECLARE_int32(ubr_max_managed_num);
extern bool g_skip_ub_init;
} // namespace ubring
@@ -769,6 +770,20 @@ TEST_F(HelloMessageTest, full_shm_name) {
SHM_MAX_NAME_BUFF_LEN - 1));
}
+TEST(ServerHandshakeTest, rejects_overlong_peer_shm_name) {
+ // Deserialize limits a full wire name to SHM_MAX_NAME_BUFF_LEN - 1 bytes.
+ // Appending the server suffix must make the server reject UB setup rather
+ // than allocate a shared-memory object using a truncated name.
+ const std::string peer_name(SHM_MAX_NAME_BUFF_LEN - 1, 'A');
+ char server_name[SHM_MAX_NAME_BUFF_LEN] = {};
+ EXPECT_FALSE(brpc::ubring::BuildServerShmName(peer_name.c_str(),
+ server_name));
+
+ EXPECT_TRUE(brpc::ubring::BuildServerShmName("UBRING_test",
+ server_name));
+ EXPECT_STREQ("UBRING_test_S", server_name);
+}
+
TEST_F(HelloMessageTest, toString_contains_fields) {
msg.msg_len = 64;
msg.hello_ver = 2;
@@ -857,10 +872,22 @@ protected:
UBShmEndpoint* _ep = nullptr;
bool _saved_skip = false;
};
+
+class UBShmEndpointOneTrxTest : public UBShmEndpointTest {
+protected:
+ void SetUp() override {
+ FLAGS_ubr_max_managed_num = 1;
+ UBShmEndpointTest::SetUp();
+ }
+
+private:
+ GFLAGS_NAMESPACE::FlagSaver _flag_saver;
+};
} // namespace ubring
} // namespace brpc
using brpc::ubring::UBShmEndpointTest;
+using brpc::ubring::UBShmEndpointOneTrxTest;
TEST_F(UBShmEndpointTest, construct_initial_state) {
ASSERT_NE(nullptr, _ep);
@@ -884,6 +911,19 @@ TEST_F(UBShmEndpointTest,
allocate_client_resources_real_shm) {
EXPECT_EQ(0, ret);
}
+TEST_F(UBShmEndpointOneTrxTest, reject_truncated_local_shm_name) {
+ brpc::ubring::SHM local_trx_shm =
+ {nullptr, 4 * 1024 * 1024, 0, {0}, (uint32_t)_socket->fd()};
+ brpc::ubring::UBRing ring;
+ const std::string long_name(SHM_MAX_NAME_BUFF_LEN, 'a');
+
+ ASSERT_NE(0, ring.UbrAllocateLocalShm(&local_trx_shm, long_name.c_str()));
+
+ brpc::ubring::UbrTrx* trx = nullptr;
+ ASSERT_EQ(0, brpc::ubring::UBRingManager::AcquireUbrTrxFromMgr(&trx));
+ EXPECT_EQ(0, brpc::ubring::UBRingManager::ReleaseUbrTrxFromMgr(trx));
+}
+
TEST_F(UBShmEndpointTest, repeated_ipc_unlink_keeps_mapping_for_unmap) {
static std::atomic<uint32_t> name_sequence(0);
const std::string name = "/brpc_u_" + std::to_string(getpid()) + "_" +
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]