XMLRPC API endpoint `channel.software.updateRepoSsl` resets `hasSignedMetadata` Repository property

[os-sengel]

Problem description

The Endpoint channel.software.updateRepoSsl resets the repository property hasSignedMetadata. This is likely unintended behavior, and somewhat undermines checks regarding the authenticity of the respective upstream repository - if channels, repos, etc are managed via the API.

Steps to reproduce

1. Run a current uyuni instance (2024-12)
2. Create an admin account
3. Run the following python script

import xmlrpc.client as xmlrpclib

UYUNI_URL = 'https://<instance>/rpc/api'
UYUNI_USER = '<myuser>'
UYUNI_PASSWORD =  '<myuserpassword>'

CLEANUP = True

def main():
    # Login

    client = xmlrpclib.Server(UYUNI_URL)
    sessionKey = client.auth.login(UYUNI_USER,UYUNI_PASSWORD)

    # create test ssl key
    client.kickstart.keys.create(sessionKey,
            "hasSignedMetadata_testcert",
            "SSL",
            "dummy content")

    # create test repo with signed=true
    # Parameters
    #   string sessionKey
    #   string label - repository label
    #   string type - repository type (only YUM is supported)
    #   string url - repository url
    #   string sslCaCert - SSL CA cert description, or an empty string
    #   string sslCliCert - SSL Client cert description, or an empty string
    #   string sslCliKey - SSL Client key description, or an empty string
    #   boolean hasSignedMetadata - true if the repository has signed metadata, false otherwise
    client.channel.software.createRepo(sessionKey,
            "hasSignedMetadata_test",
            "yum",
            "https://example.com",
            "",
            "",
            "",
            True)

    print("Initial Repository Properties")
    print(client.channel.software.getRepoDetails(sessionKey,"hasSignedMetadata_test"))

    # update ssl (only one cert
    client.channel.software.updateRepoSsl(sessionKey,
            "hasSignedMetadata_test",
            "hasSignedMetadata_testcert",
            "",
            "")


    print("Repository Properties after updating SSL")
    print(client.channel.software.getRepoDetails(sessionKey,"hasSignedMetadata_test"))
    print("The property hasSignedMetadata has changed unexpectedly")


    if CLEANUP:
        client.channel.software.removeRepo(sessionKey,"hasSignedMetadata_test")
        client.kickstart.keys.delete(sessionKey,"hasSignedMetadata_testcert")

    client.auth.logout(sessionKey)



if __name__ == "__main__":
    main()

output:

Initial Repository Properties
{'sourceUrl': 'https://example.com', 'id': 514, 'label': 'hasSignedMetadata_test', 'type': 'yum', 'hasSignedMetadata': True, 'sslContentSources': []}
Repository Properties after updating SSL
{'sourceUrl': 'https://example.com', 'id': 514, 'label': 'hasSignedMetadata_test', 'type': 'yum', 'hasSignedMetadata': False, 'sslContentSources': [{'sslKeyDesc': '', 'sslCaDesc': 'hasSignedMetadata_testcert', 'sslCertDesc': ''}]}

4. inspect the changed hasSignedMetadata property

Uyuni version

Information for package Uyuni-Server-release:
---------------------------------------------
Repository     : @System
Name           : Uyuni-Server-release
Version        : 2024.12-241000.225.1.uyuni5
Arch           : x86_64
Vendor         : obs://build.opensuse.org/systemsmanagement:Uyuni
Support Level  : unknown
Installed Size : 1.4 KiB
Installed      : Yes (automatically)
Status         : up-to-date
Source package : Uyuni-Server-release-2024.12-241000.225.1.uyuni5.src
Upstream URL   : https://www.uyuni-project.org/
Summary        : Uyuni Server
Description    :
    Uyuni lets you efficiently manage physical, virtual,
    and cloud-based Linux systems. It provides automated and cost-effective
    configuration and software management, asset management, and system
    provisioning.

Uyuni proxy version (if used)

uyuni-tools version used to deploy/manage the server or proxy (if relevant)

Useful logs

Additional information

No response

[os-sengel]

This the following method is likely handling the api call to channel.software.updateRepoSsl

uyuni/java/code/src/com/redhat/rhn/frontend/xmlrpc/channel/software/ChannelSoftwareHandler.java

Lines 2387 to 2388 in fd0e5d2

	public ContentSource updateRepoSsl(User loggedInUser, String label,
	String sslCaCert, String sslCliCert, String sslCliKey) {

Drilling down, where the "signed Metadata" boolean is set, i find, that repoEditor.store() method does contain a setMetadataSigned(this.metadata_signed) call

The this.metadata_signed likely, means it's expected to be already initialized in the current class instance which is an EditRepoCommand class extending a BaseRepoCommand class

So the store() method expects the EditRepoCommand having metadata_signed already be set.
That's what leading me back to where the EditRepoCommand instance is created. Between ChannelSoftwareHandler.java#L2401 and ChannelSoftwareHandler.java#L2421 there is no other metadata sign flag set. Which means, the creation of the EditRepoCommand is expected to create the metadata sign flag as well.

The EditRepoCommand init method uses the factory ChannelFactory.lookupContentSource which finally uses the DB query ContentSource.findByIdandOrg

I am not very familiar with directly interacting with the DB, that's why i couldnt check the response of the DB whether it contains the signed metadata flag.

In case it does contain that flag, the EditRepoCommand init method or store method contains an error regarding handling of said flag.

---

Another wierd observation:

The ContentSource's Copy Constructor doesn't seem to copy the metadataSigned boolean

uyuni/java/code/src/com/redhat/rhn/domain/channel/ContentSource.java

Lines 53 to 61 in fd0e5d2

	public ContentSource(ContentSource cs) {
	org = cs.getOrg();
	type = cs.getType();
	sourceUrl = cs.getSourceUrl();
	label = cs.getLabel();
	channels = new HashSet<>(cs.getChannels());
	sslSets = new HashSet<>(cs.getSslSets());
	repositoryAuth = cs.getRepositoryAuth();
	}

Although there is a class property
and a get/set

[os-sengel]

I believe, a dirty workaround for this bug would be to copy the flag into the repoEditor instance. Add this line

repoEditor.setMetadataSigned(repo.getMetadataSigned())

between the creation of repoEdtior instance, and the repoEditor.store() call. E.g. directly before this block:

uyuni/java/code/src/com/redhat/rhn/frontend/xmlrpc/channel/software/ChannelSoftwareHandler.java

Lines 2420 to 2421 in fd0e5d2

	// Store Repo
	repoEditor.store();

Though this is really just working around the issue, that the EditRepoCommand.store method is setting the flag without checking, whether it's needed to be updated.

[CDellaGiusta]

Fixed and backported
Uyuni: #10494
5.0: https://github.com/SUSE/spacewalk/pull/27592
4.3: https://github.com/SUSE/spacewalk/pull/27593