RDK-59367: Sync up xdialserver changes from RDKE

[yuvaramachandran-gurusamy]

RDK-59367: Sync up xdialserver changes from RDKE

Signed-off-by: yuvaramachandran_gurusamy [yuvaramachandran_gurusamy@comcast.com]

[github-actions]

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

In general, the problem is fixed by explicitly setting the least-privilege permissions for the GITHUB_TOKEN, either at the workflow root (applies to all jobs) or per job (applies only to that job). For a simple build job that only checks out code and runs shell scripts, contents: read is usually sufficient.

The best fix here, without changing existing functionality, is to add a minimal permissions block to the build-entservices-on-pr job. This ensures the GITHUB_TOKEN (if used implicitly by any actions in the job) has only read access to repo contents. Since the job uses only actions/checkout@v3 and shell commands, contents: read is enough and will not break existing behavior. Concretely, in .github/workflows/native_full_build.yml, under jobs: build-entservices-on-pr:, add:

    permissions:
      contents: read

indented to align with runs-on and container. No additional imports or definitions are required, and no other files need to be changed.

[Copilot]

Pull request overview

This PR syncs xdialserver changes from RDKE, adding several significant features and fixes including security token support, manufacturer/model name configuration, UUID-based application routing, and comprehensive build/CI infrastructure.

Changes:

• Added security token authentication support with conditional compilation flag
• Implemented dynamic manufacturer and model name configuration via new callback mechanisms
• Introduced UUID-based application routing and per-boot persistent UUID generation
• Added mutex protection for SSDP operations to prevent race conditions
• Improved error handling, logging consistency, and memory management throughout

Reviewed changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 20 comments.

Show a summary per file

File	Description
stubs/securityagent/SecurityTokenUtil.h	New header defining security token retrieval interface
stubs/securityagent/SecurityTokenUtil.cpp	Stub implementation for security token (contains critical bugs)
stubs/iarm_stubs.cpp	IARM bus stub implementations for testing
server/plat/gdialappcache.hpp	Initialize observer pointer to nullptr
server/plat/gdialappcache.cpp	Add null pointer checks and fix logging format
server/plat/gdial_app_registry.c	Add UUID generation and persistence for app URIs
server/plat/gdial.hpp	Add manufacturer/model name callback typedefs
server/plat/gdial.cpp	Extensive changes: move semantics, new callbacks, security token integration
server/plat/gdial-plat-util.c	Fix format specifier for thread ID logging
server/plat/gdial-plat-dev.c	Remove manufacturer/model getter functions
server/plat/gdial-plat-app.c	Add manufacturer/model name callback registration
server/plat/gdial-os-app.h	Declare new manufacturer/model update functions
server/plat/CMakeLists.txt	Add DISABLE_SECURITY_TOKEN build option and uuid library
server/include/gdialserviceimpl.h	Add manufacturer/model events, remove onStopped
server/include/gdialservicecommon.h	Remove onStopped from interface (breaking change)
server/include/gdialservice.h	Add manufacturer/model setter methods
server/include/gdial_app_registry.h	Add app_uri field for UUID-based routing
server/include/gdial-plat-dev.h	Remove manufacturer/model getter declarations
server/include/gdial-plat-app.h	Add manufacturer/model callback typedefs and registration
server/include/gdial-config.h	Fix header guard naming convention
server/gdialservice.cpp	Implement manufacturer/model handlers, improve initialization
server/gdialserver_ut.cpp	Update unit tests for interface changes
server/gdial-ssdp.h	Add manufacturer/model setter function declarations
server/gdial-ssdp.c	Add mutex protection and manufacturer/model support
server/gdial-rest.h	Update additional_data_url signature for UUID support
server/gdial-rest.c	Implement UUID-based routing, fix typo, add null checks
server/CMakeLists.txt	Add libsoup-3.0 detection and fallback
cov_build.sh	New coverage build script
build_dependencies.sh	Comprehensive dependency installation script
Makefile	Add DISABLE_SECURITY_TOKEN flag support
.github/workflows/native_full_build.yml	GitHub Actions workflow for native builds
.github/CODEOWNERS	Define code ownership

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The memcpy return value check is incorrect. memcpy always returns the destination pointer (buffer), which will be non-null, making the condition always false. Additionally, the function should return the length of the token on success (as documented in the header), not 0. The correct implementation should return len on success.

[Copilot]

Missing buffer size validation. The function should check if maxLength is sufficient to hold the token before calling memcpy to prevent buffer overflow. According to the function contract, if the buffer is too small, it should return a negative value indicating the required length.

[Copilot]

Inconsistent bracing style. The condition blocks starting at lines 239, 243, and 265 use braces, while others don't. For consistency and to prevent future errors when adding code, all if-statement blocks should use braces.

Suggested change

	if (nullptr!=appName){
	applicationName = appName;
	}
	if (nullptr!=argPayload){
	payLoad = argPayload;
	}
	if (nullptr!=argQueryString){
	queryString = argQueryString;
	}
	if (nullptr!=argAdditionalDataUrl){
	if (nullptr!=appName)
	{
	applicationName = appName;
	}
	if (nullptr!=argPayload)
	{
	payLoad = argPayload;
	}
	if (nullptr!=argQueryString)
	{
	queryString = argQueryString;
	}
	if (nullptr!=argAdditionalDataUrl)
	{

[Copilot]

Hardcoded GitHub token usage. The script uses $GITHUB_TOKEN for cloning a private repository at line 41, but there's no validation that this environment variable is set. The script should check if GITHUB_TOKEN is defined before attempting to use it, or provide a clear error message if it's missing.

Suggested change

	git clone https://$GITHUB_TOKEN@github.com/rdkcentral/entservices-testframework.git
	if [ -z "${GITHUB_TOKEN:-}" ]; then
	echo "Error: GITHUB_TOKEN environment variable is not set. Cannot clone entservices-testframework." >&2
	exit 1
	fi
	git clone https://${GITHUB_TOKEN}@github.com/rdkcentral/entservices-testframework.git

[Copilot]

The file handle is not closed if the second fopen fails. This creates a file descriptor leak. The error path should also close the file handle opened for reading before returning.

[Copilot]

The function comment incorrectly refers to the parameter as "Id" when the actual parameter name is "buffer". This inconsistency makes the documentation misleading.

[Copilot]

Using a hardcoded path template in /tmp with predictable filenames creates a security risk. An attacker could create symlinks or race conditions (TOCTOU) to manipulate these files. Consider using mkstemp or a more secure temporary file creation mechanism, or store these in a protected directory with appropriate permissions.

Suggested change

	#define UUID_FILE_TEMPLATE "/tmp/.dial_%s_uuid.txt"
	#define UUID_FILE_TEMPLATE "/var/lib/gdial/.dial_%s_uuid.txt"

[Copilot]

The typedef at line 55 has an inconsistent name. It's defined as "gdial_modelname_cb" but uses "gdial_manufacturername_cb" as the parameter type. While this may be intentional (same signature), it's confusing. The parameter type should be "gdial_modelname_cb" for clarity.

Suggested change

	void gdial_register_modelname_cb(gdial_manufacturername_cb cb);
	void gdial_register_modelname_cb(gdial_modelname_cb cb);

[Copilot]

The mutex initialization error handling returns EXIT_FAILURE which is typically 1, but the function signature returns int and other parts return 0 or -1. For consistency with the rest of the function's error handling pattern, this should return -1 instead of EXIT_FAILURE.

Suggested change

	return EXIT_FAILURE;
	return -1;

[Copilot]

Missing null check for app_random_uuid. The variable app_random_uuid is used in g_strdup_printf at line 130 without verifying it's not NULL. If this variable is NULL, it could lead to undefined behavior or produce an incorrect URL string.

Suggested change

	gchar *application_url_str = g_strdup_printf("http://%s:%d/%s/", iface_ipv4_address, GDIAL_REST_HTTP_PORT,app_random_uuid);
	const gchar *app_uuid = app_random_uuid;
	if (app_uuid == NULL) {
	GDIAL_LOGERROR("app_random_uuid is NULL, cannot construct Application-URL");
	soup_message_set_status(msg, SOUP_STATUS_INTERNAL_SERVER_ERROR);
	pthread_mutex_unlock(&ssdpServerEventSync);
	return;
	}
	gchar *application_url_str = g_strdup_printf("http://%s:%d/%s/", iface_ipv4_address, GDIAL_REST_HTTP_PORT, app_uuid);

[Copilot]

Pull request overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 8 comments.

Comments suppressed due to low confidence (1)

server/include/gdial_app_registry.h:45

• GDialAppRegistry is defined as a public struct in a header, and adding app_uri as a new field changes the struct layout/ABI for any external consumers that allocate or access it directly. If this header is part of the public API, consider making the struct opaque (forward-declare + accessor functions) or ensure ABI expectations are handled (e.g., bump soname / only extend at end with clear versioning).

#define APP_MAX_UUID_SIZE 64

typedef struct _GDialAppRegistry {
  gchar app_uri[APP_MAX_UUID_SIZE+1]; // for storing uri
  gchar *name;
  gboolean use_additional_data;
  gboolean is_singleton;
  GList *allowed_origins;
  GList *app_prefixes;
  GHashTable *properties;
} GDialAppRegistry;

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

GetSecurityToken violates its own contract and is unsafe: it ignores maxLength, does not NUL-terminate the buffer, and always returns 0 on success even though the header/doc says success must be > 0 (and 0 should not occur). This can cause callers to treat success as failure and can overflow buffer when maxLength < payload length (+1). Update the stub to bound-copy, NUL-terminate when possible, and return the token length on success (or -required_len on insufficient buffer).

[Copilot]

GetCurrentState() allocates controllerRemoteObject unconditionally on every call (controllerRemoteObject = new ...), even when it was already non-NULL. This leaks the previous LinkType instance and defeats the if (NULL == controllerRemoteObject) guard. Allocate only when the pointer is NULL (or delete/reset before re-allocating), and keep the token/query-building logic inside the same branch so it’s used consistently for the created object.

[Copilot]

APP_MAX_UUID_SIZE is 64 and app_uri is declared as APP_MAX_UUID_SIZE+1, but app_uri stores a leading '/' + UUID + NUL. If uuid_data can be up to APP_MAX_UUID_SIZE-1 chars, this buffer is one byte too small. Increase app_uri to APP_MAX_UUID_SIZE+2 (or size it specifically for a UUID string, e.g. 37 + 1 for '/').

Suggested change

	gchar app_uri[APP_MAX_UUID_SIZE+1]; // for storing uri
	gchar app_uri[APP_MAX_UUID_SIZE+2]; // for storing uri ('/' + UUID + '\0')

[Copilot]

uuid_data read via fgets() may include a trailing newline. That newline is then embedded into app_uri via snprintf("/%s", uuid_data), producing an invalid URI and breaking app lookup by UUID. Strip \r/\n from uuid_data after reading (and consider validating it’s a proper UUID string).

[Copilot]

The UUID cache file path is built from app_name and written under /tmp using fopen() on a predictable filename. If app_name can be influenced, this can lead to path manipulation (e.g., embedded '/'), collisions/truncation, or symlink/hardlink attacks in /tmp. Consider sanitizing app_name for filenames and using a safer open approach (e.g., open() with O_NOFOLLOW|O_CLOEXEC and explicit permissions).

[Copilot]

ssdpServerEventSync is declared with PTHREAD_MUTEX_INITIALIZER and then also initialized again with pthread_mutex_init() in gdial_ssdp_new(). Re-initializing an already-initialized mutex is undefined behavior (or can return EBUSY). Use either the static initializer (and remove pthread_mutex_init) or remove the initializer and keep explicit init/destroy.

Suggested change

	if (0 != pthread_mutex_init(&ssdpServerEventSync, NULL))
	{
	GDIAL_LOGERROR("Failed to initializing mutex");
	return EXIT_FAILURE;
	}

[Copilot]

CMake now prefers libsoup-3.0 when available, but the codebase still uses libsoup-2.x APIs/types (e.g., SoupURI, soup_uri_to_string, soup_uri_free in server/gdialservice.cpp). This will break builds on systems with libsoup3 dev packages installed. Either keep libsoup-2.4 as the required dependency, or add proper version checks (SOUP_CHECK_VERSION/SOUP_MAJOR_VERSION) and port the codepaths to libsoup3 equivalents before enabling this selection.

[Copilot]

gdial_rest_server_registered_apps_clear expects a GDialRestServer*, but gdial_rest_server_dispose() passes object (a GObject*) directly. This will compile with a warning (incompatible pointer type) and is easy to fix by passing GDIAL_REST_SERVER(object) (or self) consistently.