Anyone knows how I can add a user with ctlmgr_ctl

[fraternl]

I would like to add a user with ctlmgr_ctl
What's the syntax?

[fraternl]

I know how to list them.
I have no idea yet how to create a new entry.

ctlmgr_ctl l boxusers "settings/user/list(UID,enabled,name,box_admin_rights,vpn_access)"
        user0   boxuser10       1       admin   5       1
        user1   boxuser64       1       fritz0801       3       0

[fda77]

I cant remember how to chnage arrays. Someone wrote it somewhere, maybe Boxmatrix (abandoned) or IPPF
Also look into the avm .lua Sources could help.

[fda77]

After a quick test...

 ctlmgr_ctl l boxusers "settings/user/list(UID,name)"
 ctlmgr_ctl l boxusers "settings/user/list"
 ctlmgr_ctl l boxusers "settings/user0/name"
 ctlmgr_ctl l boxusers "settings/user0/UID"

[fraternl]

I found this page:
https://www.ip-phone-forum.de/threads/avm-firmwarevariablen-abfragen-setzen-mit-einem-einzigen-aufruf-und-ohne-ctlmgr_ctl.275773/

still reading...

[fraternl]

WIP

I created the LUA-script "queries.lua" and have it working.
Now I need to work out how "set.lua" works.

echo "BOXUSERS=boxusers:settings/user/list(UID,enabled,name,box_admin_rights,vpn_access)" | queries.lua
BOXUSERS_1_index="user0"
BOXUSERS_1_UID="boxuser10"
BOXUSERS_1_enabled="1"
BOXUSERS_1_name="admin"
BOXUSERS_1_box_admin_rights="5"
BOXUSERS_1_vpn_access="1"
BOXUSERS_2_index="user1"
BOXUSERS_2_UID="boxuser97"
BOXUSERS_2_enabled="1"
BOXUSERS_2_name="fritz0362"
BOXUSERS_2_box_admin_rights="3"
BOXUSERS_2_vpn_access="0"
BOXUSERS_count=2

I think this will give me the name for a new user if I wish to make one

echo "newId=boxusers:settings/user/newid" | queries.lua
newId="user2"

This seems to be the command to create a user:

echo -e "boxusers:settings/user2/enabled=1\nboxusers:settings/user2/name=test\nboxusers:settings/user2/
box_admin_rights=5\nboxusers:settings/user2/password=testtesttest" | set.lua
OK

And it worked:

ctlmgr_ctl u boxusers
boxusers:settings/
own_email=error
own_password=error
last_homenetwork_username=
myfritz_boxuser_uid=
temporarilyresetauth=0
twofactor_auth_enabled=0
googleauth_enabled=1
own_googleauth_devicename=error
googleauth_check_token=
user_has_default_password=1
user0/
 UID=boxuser10
 enabled=1
 name=admin
 email=
 password=****
 id=10
 box_admin_rights=5
 nas_rights=0
 phone_rights=5
 dial_rights=5
 homeauto_rights=5
 vpn_access=1
 vpn_psk=2FMc58nfiLhQEuYP
 is_myself=0
 is_tr069_remote_access_user=0
 googleauth_sharedsecret=
 googleauth_sharedsecret_url=
 googleauth_devicename=
 googleauth_setupdate=
 googleauth_reset=
 googleauth_check_token=
 logins=
user1/
 UID=boxuser97
 enabled=1
 name=fritz0362
 email=
 password=****
 id=97
 box_admin_rights=3
 nas_rights=3
 phone_rights=3
 dial_rights=3
 homeauto_rights=3
 vpn_access=0
 vpn_psk=
 is_myself=0
 is_tr069_remote_access_user=0
 googleauth_sharedsecret=
 googleauth_sharedsecret_url=
 googleauth_devicename=
 googleauth_setupdate=
 googleauth_reset=
 googleauth_check_token=
 logins=
user2/
 UID=boxuser11
 enabled=1
 name=test
 email=
 password=****
 id=11
 box_admin_rights=5
 nas_rights=0
 phone_rights=5
 dial_rights=5
 homeauto_rights=5
 vpn_access=0
 vpn_psk=
 is_myself=0
 is_tr069_remote_access_user=0
 googleauth_sharedsecret=
 googleauth_sharedsecret_url=
 googleauth_devicename=
 googleauth_setupdate=
 googleauth_reset=
 googleauth_check_token=
 logins=

echo "newId=boxusers:settings/user/newid" | queries.lua
newId="user3"

[fda77]

Well, with this knopwledge, "newid" is the keyword:

$ ctlmgr_ctl r boxusers settings/user/newid
user1

and then (untested)

ctlmgr_ctl w boxusers settings/user1/xxx yyy

[fraternl]

This works

ctlmgr_ctl r boxusers settings/user/newid
user3

this doesn't, but I'm probably doing it wrong
ctlmgr_ctl w boxusers settings/user3/enabled 1/name test2/password blablablablabla/box_admin_rights 5

I have to catch a train now ;-)

[fda77]

Whats the source of your used syntax? I can not test writing, but reading multiple values:

ctlmgr_ctl r  wlan settings/ssid  wlan settings/guest_ssid
..
..

(this could speedup your other discussion...)

and for better parsing:

ctlmgr_ctl r -v   wlan settings/ssid   wlan settings/guest_ssid
wlan:settings/ssid = ...
wlan:settings/guest_ssid = ...

[fraternl]

With this startup script I want to make sure that an AVM user exists which I initially give the password that's on the back of the box...
At least this was the plan.
After the first provisioning this should be changed of course, but I prefer to have it already.

It didn't work, so I gave these commands on the prompt to check why and it seems AVM doesn't want you to create a user with the password on the back.
very funny AVM!!

CUSTOMUSER=freetz
BACKPASS=`grep '^webgui_pass'  /proc/sys/urlader/environment | awk '{print $2}' | egrep -o '[a-z]+[0-9]+'`
echo -e "boxusers:settings/user2/enabled=1\nboxusers:settings/user2/name=${CUSTOMUSER}\nboxusers:settings/user2/box_admin_rights=5\nboxusers:settings/user2/password=${BACKPASS}" | /sbin/set.lua
Password rejected. The password for access from the internet must be different from the one printed on the base of your FRITZ!Box housing.

I solved this by adding an exclamation mark.

CUSTOMUSER=freetz
BACKPASS=`grep '^webgui_pass'  /proc/sys/urlader/environment | awk '{print $2}' | egrep -o '[a-z]+[0-9]+'`
# Make sure I have a valid 10 character password
if echo -n "${BACKPASS}" | wc -c | grep '^10$' ; then
  # I have a valid BACKPASS
  if ! echo "BOXUSERS=boxusers:settings/user/list(name)" | /sbin/queries.lua | grep -q "name=.${CUSTOMUSER}" ; then
    # CUSTOMUSER is not an existing user

    NEWID=`ctlmgr_ctl r boxusers settings/user/newid`
    echo -e "boxusers:settings/${NEWID}/enabled=1\nboxusers:settings/${NEWID}/name=${CUSTOMUSER}\nboxusers:settings/${NEWID}/box_admin_rights=5\nboxusers:settings/${NEWID}/password=${BACKPASS}!" | /sbin/set.lua

  fi
fi

[fda77]

Omg, thats avm :)

[fraternl]

The main reason for adding a user is because I do not want to lose access to the AVM-interface from the Internet.
Even if the box gets a factory reset, a user gets created and the https port gets set.

The code I have here depends on /sbin/set.lua
It also needs some other variables set, but that's beyond the scope of this topic.

Typically I provision a box by pushing the firmware, setting the Internet connection and enable a user. Someone else then installs the box and tells me the IP if Internet is working.
In the past it happened that I forgot to create a user, so there's no access from the Internet to the box even if I know its IP.

After a factory reset there's of course no Internet access, but I can easily talk a user through the setup.
I can tell him to login to the box using the password that's on the back of the box and talk him through the Internet setup.
The moment Internet is working I can have access to the box using that same password (with an exclamation mark)

If the box is decommisioned I can just flash the standard firmware on it.

# To enable access from the Internet an enabled user with box_admin_rights=5 needs to exist
#
# I only want to add/enable a custom user if there's no enabled user with access from the Internet
# If the custom user is deleted or crippled, it will stay that way unless there is no enabled superuser
#


EXISTCU=        # A custom user exists
EXISTENADMIN=   # An enabled admin exist
CUISENADMIN=    # The existing custom user is enabled and has admin rights (this boolean turned out to be superfluous)

CUSTOMUSER=freetz
BACKPASS=`grep '^webgui_pass'  /proc/sys/urlader/environment | awk '{print $2}' | egrep -o '[a-z]+[0-9]+'`

BOXUSERS="`ctlmgr_ctl u boxusers | grep -A8 '^user[0-9]'`"

echo "${BOXUSERS}" | grep -A6 "enabled=1" | grep -q "box_admin_rights=5" && EXISTENADMIN=yes
echo "${BOXUSERS}" | grep -q "name=${CUSTOMUSER}$" && EXISTCU=yes
echo "${BOXUSERS}" | grep -A5 -B1 "name=${CUSTOMUSER}$" | grep -A6 "enabled=1" | grep -q "box_admin_rights=5$" && CUISENADMIN=yes

if [ ! ${EXISTENADMIN} ] ; then
  if [ ${EXISTCU} ] ; then
    # A custom user already exist, but it has no admin rights or is not enabled (no user has)
    # do not add a user, but enable it and give it admin rights
    CUID="`echo "${BOXUSERS}" | grep -B3 name=${CUSTOMUSER} | egrep -o "^user[0-9]+"`"
    echo -e "boxusers:settings/${CUID}/enabled=1\nboxusers:settings/${CUID}/box_admin_rights=5" | /sbin/set.lua
  elif echo -n "${BACKPASS}" | wc -c | grep -q '^10$' ; then
    # A new custom user needs to be created
    NEWID=`ctlmgr_ctl r boxusers settings/user/newid`
    echo -e "boxusers:settings/${NEWID}/enabled=1\nboxusers:settings/${NEWID}/name=${CUSTOMUSER}\nboxusers:settings/${NEWID}/box_admin_rights=5\nboxusers:settings/${NEWID}/password=${BACKPASS}!" | /sbin/set.lua
  fi
fi

[fraternl]

/sbin/set.lua and /sbin/queries.lua are copied from this website

https://www.ip-phone-forum.de/threads/avm-firmwarevariablen-abfragen-setzen-mit-einem-einzigen-aufruf-und-ohne-ctlmgr_ctl.275773/

As far as I can gather they are written by PeterPawn, well-known author of Freetz related stuff.

cat /sbin/queries.lua

#!/bin/luavar

lineno = 0;
rc = 0;

while true do
    local line = io.read("*line");
    if (line == nil) then
        if (lineno == 0) then
            io.stderr:write("Missing requests\n");
            os.exit(2);
        end
        break;
    end
    lineno = lineno + 1;
    local varname, query = string.match(line, "(.*)=(.*)");
    if (varname ~= nil and query ~= nil) then
        if (string.find(query, "%(.*%)") == nil) then
            local single_res = box.query(query);
            if (single_res == nil) then
                print(varname.."=\"***no result***\"");
            else
                print(varname.."=\""..single_res.."\"");
            end
        else
            local columns = {};
            local first, last = string.find(query, "%(.*%)");
            local list = string.sub(query, first + 1, last - 1);
            for col in string.gmatch(list, "[^,]+") do
                table.insert(columns, col);
            end
            if (string.find(query, "listwindow%(.*%)") ~= nil) then
                table.remove(columns, 1);
                table.remove(columns, 1);
            end
            local result = box.multiquery(query);
            local index = 0;
            for i, entry in ipairs(result) do
                for j, value in ipairs(entry) do
                    j = j - 1;
                    if (j > 0) then
                        colname = columns[j];
                    else
                        colname = "index";
                    end
                    print(varname.."_"..i.."_"..colname.."=\""..value.."\"");
                end
                index = i;
            end
            print(varname.."_count="..index);
        end
    else
        io.stderr:write("Malformed request at line ",lineno,"\n");
        rc = 1;
-- die folgende Zeile aktivieren (-- am Beginn entfernen), um bei falscher Eingabe die Verarbeitung abzubrechen
--        break;
    end
end

os.exit(rc);

cat /sbin/set.lua

#! /bin/luavar

lineno = 0;
rc = 0;
cmtable = {};

while true do
    local line = io.read("*line");
    if (line == nil) then
        if (lineno == 0) then
            io.stderr:write("Missing set statements\n");
            os.exit(2);
        else
            break;
        end
    end
    lineno = lineno + 1;
    local varname, value = string.match(line, "(.*)=(.*)");
    if (varname ~= nil and value ~= nil) then
        table.insert(cmtable, { ["name"] = varname, ["value"] = value } );
    else
        io.stderr:write("Malformed set statement at line ",lineno,"\n");
        os.exit(127);
    end
end

err = 0;
message = "";
err, message = box.set_config(cmtable);
if (err == 0) then
    io.stderr:write("OK\n");
    rc = 0;
else
    if (string.len(message) > 0) then
        io.stderr:write(message,"\n");
    else
        io.stderr:write("error\n");
    end
    rc = 1;
end

os.exit(rc);

[fda77]

I dont understand why you need these lua files. You could use plain ctlmgr_ctl and it does the same and you will not get compatibility problems

[fraternl]

To read the variables and write simple variables I can use ctlmgr_ctl, but for writing arrays I couldn't find the proper syntax.

The article where I got the 2 scripts they talk about speed and it is clearly faster.
I have thus far not seen anyone writing an array element with ctlmgr_ctl.

BTW I do need some of this speed as the router reboots the moment you select the region.

[fda77]

I also dont know how writing arrays, but multiple variables within 1 command should work. I have not tested it, but only reading multiple with 1 command

[fraternl]

The reading of multiple single dimensional variables is not the same as arrays.
You can do a dump, but reading an array should require a different syntax for the program to distinguish between arrays and non-indexed variables.

I have tested several ways and couldn't get any of them to work.
They don't give examples for writing arrays and I don't even know for certain it supports it.
Do you know for certain they are using it themselves for adding an array?

I'm still communicating with AVM's framework with that set.lua or I wouldnt get an error message that I can't add a user with the password on the back.
It may well be the way how AVM sets the variables all at once and the ctlmgr_ctl is only for quick and dirty simple variables.

All speculation, of course.

[fraternl]

I just tried chatgpt feeding it all the commands and syntax that do work, but it can't find any logic in their syntax either.

[fda77]

Logic does not help with AVM

[fda77]

ctlmgr_ctl r boxusers settings/user/newid
user1

ctlmgr_ctl w  boxusers settings/user1/enabled 1  boxusers settings/user1/name nubody  boxusers settings/user1/box_admin_rights 3  boxusers settings/user1/password aciouasvdtn
1
nubody
3
****

ctlmgr_ctl r boxusers settings/user/newid
user2

ctlmgr_ctl l boxusers "settings/user/list(UID,name,box_admin_rights)" | tail -n1
  user1   boxuser10       nubody  3

[fraternl]

I have changed my code so I'm not using set.lua & queries.lua.
I leave these 2 scripts on my boxes so I could start using them at will.
It retrieves data much faster which could prevent some timeouts I'm experiencing.

Thanks again.

[fda77]

Executing ctlmgr_ctl multiple times is slow, but reading all at the same time is fast, like the uimods page https://freetz-ng.github.io/freetz-ng/wiki/60_Development/uimods.html#mehrere-variablen