Remote Manipulator System Remote Mgmt

[yes1n]

Hello. I made a file RMS.pm for inventory of Internet-ID Remote Manipulator System Host. I would really like to see it added to the new version of the GLPI agent. I checked it on my 300 computers - it works. If there are any improvements to the code on your part, I will be glad. Thank you.
Here is his code:

package GLPI::Agent::Task::Inventory::Generic::Remote_Mgmt::RMS;

use strict;
use warnings;

use parent 'GLPI::Agent::Task::Inventory::Module';

use English qw(-no_match_vars);

use GLPI::Agent::Tools;

sub isEnabled {
    my (%params) = @_;

    if (OSNAME eq 'MSWin32') {

        GLPI::Agent::Tools::Win32->use();

        my $key = getRegistryKey(
            path => 'HKEY_LOCAL_MACHINE/SOFTWARE/Usoris/Remote Utilities Host/Host/Parameters',
            # Important for remote inventory optimization
            required    => [ qw/InternetId/ ],
            maxdepth    => 1,
            logger => $params{logger}
        );
        if (!$key && is64bit()) {
            $key = getRegistryKey(
                path => 'HKEY_LOCAL_MACHINE/SOFTWARE/Usoris/Remote Utilities Host/Host/Parameters',
                # Important for remote inventory optimization
                required    => [ qw/InternetId/ ],
                maxdepth    => 1,
                logger => $params{logger}
            );
        }

        return $key && (keys %$key);
    }

    return canRun('rms');
}

sub doInventory {
    my (%params) = @_;

    my $inventory = $params{inventory};
    my $logger    = $params{logger};

    my $InternetID = _getID(
        osname  => OSNAME,
        logger  => $logger
    );
    if (defined($InternetID)) {
        $logger->debug('Found InternetID : ' . $InternetID) if ($logger);

        $inventory->addEntry(
            section => 'REMOTE_MGMT',
            entry   => {
                ID   => $InternetID,
                TYPE => 'rms'
            }
        );
    } else {
        $logger->debug('InternetID not found') if ($logger);
    }
}

sub _getID {
    my (%params) = @_;
    my $osname = delete $params{osname} // '';
    return _getID_MSWin32() if $osname eq "MSWin32";
}

sub _getID_MSWin32 {

    GLPI::Agent::Tools::Win32->use();

    my $clientid = getRegistryValue(
        path => 'HKEY_LOCAL_MACHINE/SOFTWARE/Usoris/Remote Utilities Host/Host/Parameters/InternetId',
    );

    $clientid = hex2dec($clientid);

    $clientid = substr($clientid, 0, index($clientid, '</internet_id'));
    $clientid = substr($clientid, index($clientid, '<internet_id>')+13);

    return $clientid;

}

1;

[g-bougard]

Hi @yes1n

thank you for your idea and your code.

I don't see any problem to add RMS as remote_mgmt module. The best way of doing is to create a Pull Request on github. I'll review it and merge it after eventually few code updates.

Regarding your code, I see few things that you should fixe or enhance:

1. in isEnabled(), it seems to me you're indeed retrying exactly the same registry key if the first one is not found. So the second time, it should also find nothing.
2. the _getID() call will return nothing if not on MSWin32: or rms doesn't support any other system than MSWin32, so you should check it in isEnabled() and simplify the code, or it supports other OS, so you should provide a way to find the expected id from , maybe from rms command in _getID().
3. Passing osname to _getID() is not required, you can better use such code:

...
    my $InternetID = OSNAME eq "MSWin32" ? _getID_MSWin32(%params) : _getID(%params);
...

or really use OSNAME as is each time you need it.

[g-bougard]

And if you can, can you add some tests with real datas ?
You have a good sample here: https://github.com/glpi-project/glpi-agent/blob/develop/t/tasks/inventory/generic/remote_mgmt/teamviewer.t

[yes1n]

Thanks for the answer. As I wrote, the code is not perfect. in the isEnabled function, only 1 search is actually needed, because in both the 32-bit version and the 64-bit version the registry branch is the same. It is also the same for different versions of Windows from 7 to 11

[yes1n]

I will try. Please help me how to make tests or give me a link to the wiki. Thank you!

[g-bougard]

Just take teamviewer.t as sample and create a rms.t file at the same place to test yooour _getID() API. You will probably have to also integrate z registry export under resources\win32\registry.

[yes1n]

I also made a URL link to the connection in the file src/Item_RemoteManagement.php

class Item_RemoteManagement extends CommonDBChild
{
...
    public const RMS = 'rms';
...
    public function getRemoteLink(): string
    {
        $link = '<a href="%s" target="_blank">%s</a>';
        $id = Html::entities_deep($this->fields['remoteid']);
        $href = null;
        switch ($this->fields['type']) {
            case self::TEAMVIEWER:
                $href = "https://start.teamviewer.com/$id";
                break;
            case self::ANYDESK:
                $href = "anydesk:$id";
                break;
            case self::SUPREMO:
                $href = "supremo:$id";
                break;
            case self::RMS:
                $rms = array();
                $rms[] = "-create";
                $rms[] = "-name:Test connection";
                $rms[] = "-host:$id";
                $rms[] = "-fullcontrol";
                $text = implode("\r\n", $rms);
                $href = 'rms:'.bin2hex($text);
                break;
        }

        if ($href === null) {
            return $id;
        } else {
            return sprintf(
                $link,
                $href,
                $id
            );
        }
    }
    public function showForm($ID, array $options = [])
    {
     ...
        $types = [
            self::TEAMVIEWER => 'TeamViewer',
            self::LITEMANAGER => 'LiteManager',
            self::ANYDESK => 'AnyDesk',
            self::MESHCENTRAL => 'MeshCentral',
            self::SUPREMO => 'SupRemo',
            self::RUSTDESK => 'RustDesk',
            self::RMS => 'rms',
        ];
   ...
    }
}

[g-bougard]

After we merge RMS support in glpi-agent, you'll be able to also propose a PR to glpi project.

[yes1n]

I did a pull request #499 for now because it works but needs improvement. Added rms.t for the test. Tell me how to run the test to check?