Basic auth and Unraid 6.8

[acateon]

Tried your updated example in the Unraid forum but the rest sensor in HA shows status unknown and the HA logs complains about malformed json.

No events logged in the Unraid syslog.

Is it confirmed to work with the new login that 6.8 brought?

[fma965]

It's only going to work with basic auth. I presume there is an option to change from form authentication to basic auth. Almost all web applications such as a rest sensor in JSON, wget, curl etc support basic auth but not form auth the only benefit of form auth in my opinion is password manager integration and it can persist across browser sessions

[acateon]

To my knowledge there's no way of (easily via GUI) to change back to basic auth from the new login.

One way around having to change the global login and use sensitive root credentials would be to have a companion docker to the plugin with a lightweight httpd with mapped directories to the api.php file. Or possibly mapped directly with access to the HA docker if HA has the possibility of phrasing PHP.

That would be some what of a turn-key solution.

By the way, thanks for the effort and good job!

[fma965]

Yes after doing some research I have come to the same conclusion.

Really unraid in this day and age should provide a API literally everything else does. Unfortunately it doesn't. Without API tokens form based auth is a mistake but I get the reasons for form based auth especially if users are http but I think now isn't the right time.

My friend @jiminald has a possible idea involving submitting and saving the cookies etc .. maybe he can explain further ;)

If you go the docker route you may aswell just run nginx/php and map the ini file directory and do the entire process in docker rather than as a plugin. Which is an option but not great.

[fma965]

Just adding this here for quick access
https://gist.github.com/Fma965/0d79beeece0a52969ec22093b9e70990

[fma965]

Upon further inspection of the code i can see there is already work in progress code for an API in 6.8 via a plugin called unraid.net so this kinda makes my program redundant.

https://raw.githubusercontent.com/limetech/Unraid.net/next/Unraid.net.plg

in the /boot/config/plugins/dynamix/dynamix.cfg file you have this

[remote]
apikey="bbff6d7320a3cfa74964c58b5c5d3b0XXXXXXXXXXXXXXXXXXXXXXe2bc79518f2e4f0c4"
wanaccess="no"
wanport="0"

{
   "data": {
       "vars": {
           "version": "6.8.0",
           "port": 965
       },
       "disks": [
           {
               "device": "/dev/sda",
               "type": "HD",
               "name": "Extreme"
           },
           {
               "device": "/dev/sdb",
               "type": "SSD",
               "name": "MTFDDAK256MAM-1K12"
           },
           {
               "device": "/dev/sdc",
               "type": "SSD",
               "name": "Crucial_CT250MX200SSD4"
           },
           {
               "device": "/dev/sdd",
               "type": "HD",
               "name": "ST2000LM007-1R8174"
           },
           {
               "device": "/dev/sde",
               "type": "SSD",
               "name": "LITEON_LCH-256V2S-HP"
           },
           {
               "device": "/dev/sdf",
               "type": "HD",
               "name": "WDC_WD5000AAKX-60U6AA0"
           },
           {
               "device": "/dev/sdg",
               "type": "HD",
               "name": "WDC_WD20EZRZ-00Z5HB0"
           },
           {
               "device": "/dev/sdh",
               "type": "SSD",
               "name": "SAMSUNG_MZ7PD256HCGM-000H7"
           },
           {
               "device": "/dev/sdi",
               "type": "HD",
               "name": "WDC_WD20EZRZ-00Z5HB0"
           },
           {
               "device": "/dev/sdj",
               "type": "HD",
               "name": "WDC_WD20EZRZ-00Z5HB0"
           },
           {
               "device": "/dev/sdk",
               "type": "SSD",
               "name": "MTFDDAK256MAM-1K12"
           },
           {
               "device": "/dev/sdl",
               "type": "HD",
               "name": "ST2000DM008-2FR102"
           },
           {
               "device": "/dev/nvme0n1",
               "type": "NVMe",
               "name": "Samsung_SSD_960_EVO_250GB"
           }
       ]
   }
}

looks like Unraid API is definitely a thing in 6.8 and therefore completely makes this quick plugin redudant.

[fma965]

Well as it's unlikely that this is going to be added any time soon @demonspork

Here are some on the fly sed commands to patch the nginx conf file,

Create a htpasswd file in /boot/config with a valud basic authentication

cp /boot/config/htpasswd /etc/nginx/basic
sed -i 's%return 302 \$scheme:\/\/\$http_host\/login;%# return 302 \$scheme:\/\/\$http_host\/login;%' /etc/nginx/conf.d/emhttp-servers.conf
sed -i '/^auth_request\ \/auth_request.php;/a auth_basic "Unraid";\nauth_basic_user_file  /etc/nginx/basic;' /etc/nginx/conf.d/emhttp-servers.conf
nginx -s reload

Use CA User Scripts plugin and set to on first array start.

[fma965]

​
Using the CA User Scripts Plugin

Then in the /boot/config/plugins/user.scripts/scripts/Fix Basic Auth/script file

#!/bin/bash
while [ ! -f /var/run/nginx.pid ]
do
  sleep 2 # or less like 0.2
done
cp /boot/config/htpasswd /etc/nginx/basic
sed -i 's%return 302 \$scheme:\/\/\$http_host\/login;%# return 302 \$scheme:\/\/\$http_host\/login;%' /etc/nginx/conf.d/emhttp-servers.conf
sed -i '/^auth_request\ \/auth_request.php;/a auth_basic "Unraid";\nauth_basic_user_file  /etc/nginx/basic;' /etc/nginx/conf.d/emhttp-servers.conf
nginx -s reload

UPDATE: i have made it work with the /boot/config/go file

#!/bin/bash
# Start the Management Utility
/usr/local/sbin/emhttp &

# Wait for Nginx to be running before patching Basic Auth
while [ ! -f /var/run/nginx.pid ]
do
  sleep 2 # or less like 0.2
done

# Patch Basic Auth back in to Unraid 6.8+ (Make sure /boot/config/htpasswd exists and is valid)
cp /boot/config/htpasswd /etc/nginx/basic
sed -i 's%return 302 \$scheme:\/\/\$http_host\/login;%# return 302 \$scheme:\/\/\$http_host\/login;%' /etc/nginx/conf.d/emhttp-servers.conf
sed -i '/^auth_request\ \/auth_request.php;/a auth_basic "Unraid";\nauth_basic_user_file  /etc/nginx/basic;' /etc/nginx/conf.d/emhttp-servers.conf
nginx -s reload
# End Nginx Basic Auth Patch

​

[sund4nce]

@fma965 How have you managed to get the official unraid API (I assume it's the Graphql one, right?) running?

[fma965]

@fma965 How have you managed to get the official unraid API (I assume it's the Graphql one, right?) running?

It is yes, unfortunately i have forgot, i know it involves the next branch of the unraid.net plugin

usage /etc/rc.d/rc.unraid-api start|stop

https://github.com/limetech/Unraid.net/tree/next