routeros-scripts/hotspot-to-wpa

#!rsc by RouterOS
# RouterOS script: hotspot-to-wpa
# Copyright (c) 2019-2021 Christian Hesse <mail@eworm.de>
# https://git.eworm.de/cgit/routeros-scripts/about/COPYING.md
#
# add private WPA passphrase after hotspot login
# https://git.eworm.de/cgit/routeros-scripts/about/doc/hotspot-to-wpa.md

:local 0 "hotspot-to-wpa";
:global GlobalFunctionsReady;
:while ($GlobalFunctionsReady != true) do={ :delay 500ms; }

:global LogPrintExit2;

:local MacAddress $"mac-address";
:local UserName $username;
:local Date [ / system clock get date ];
:local PassWord [ / ip hotspot user get [ find where name=$UserName ] password ];

:if ([ :len [ / caps-man access-list find where comment="--- hotspot-to-wpa above ---" disabled ] ] = 0) do={
  / caps-man access-list add comment="--- hotspot-to-wpa above ---" disabled=yes;
  $LogPrintExit2 warning $0 ("Added disabled access-list entry with comment '--- hotspot-to-wpa above ---'.") false;
}
:local PlaceBefore ([ / caps-man access-list find where comment="--- hotspot-to-wpa above ---" disabled ]->0);

$LogPrintExit2 info $0 ("Adding/updating accesslist entry for mac address " . $MacAddress . \
  " (user " . $UserName . ").") false;

/ caps-man access-list remove [ find where mac-address=$MacAddress comment~"^hotspot-to-wpa: " ];
/ caps-man access-list add comment=("hotspot-to-wpa: " . $UserName . ", " . $MacAddress . ", " . $Date) \
    mac-address=$MacAddress private-passphrase=$PassWord ssid-regexp="-wpa\$" place-before=$PlaceBefore;
extend magic pattern with "by RouterOS" This matches the string included in export. 2020-09-18 09:00:27 +00:00			`#!rsc by RouterOS`
add script 'hotspot-to-wpa' 2019-10-14 19:24:35 +00:00			`# RouterOS script: hotspot-to-wpa`
update copyright for 2021 2021-01-01 20:33:52 +00:00			`# Copyright (c) 2019-2021 Christian Hesse <mail@eworm.de>`
explicitly name the license Copyright (C) 2013-2020 Christian Hesse <mail@eworm.de> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. https://www.gnu.org/licenses/#GPL https://www.gnu.org/licenses/gpl.html https://www.gnu.org/licenses/gpl.md 2020-06-19 20:17:42 +00:00			`# https://git.eworm.de/cgit/routeros-scripts/about/COPYING.md`
add script 'hotspot-to-wpa' 2019-10-14 19:24:35 +00:00			`#`
			`# add private WPA passphrase after hotspot login`
add doc/hotspot-to-wpa.md 2020-03-27 20:46:08 +00:00			`# https://git.eworm.de/cgit/routeros-scripts/about/doc/hotspot-to-wpa.md`
add script 'hotspot-to-wpa' 2019-10-14 19:24:35 +00:00
global: give script or function name in log messages 2021-02-22 14:14:10 +00:00			`:local 0 "hotspot-to-wpa";`
global: drop script 'global-wait' All scripts wait for the global functions on their own now. 2021-02-18 13:52:47 +00:00			`:global GlobalFunctionsReady;`
			`:while ($GlobalFunctionsReady != true) do={ :delay 500ms; }`

global: give script or function name in log messages 2021-02-22 14:14:10 +00:00			`:global LogPrintExit2;`
hotspot-to-wpa: use $LogPrintExit and add more logging 2020-03-05 08:17:19 +00:00
add script 'hotspot-to-wpa' 2019-10-14 19:24:35 +00:00			`:local MacAddress $"mac-address";`
			`:local UserName $username;`
			`:local Date [ / system clock get date ];`
			`:local PassWord [ / ip hotspot user get [ find where name=$UserName ] password ];`

[ ... print count-only ...] -> [ :len [ ... find ... ] ] Using 'print count-only' always prints a number to terminal, even if the value is evaluated in a condition or assigned to a variable. This can be quite annoying. Behavior will not chance (SUP-25503), so replacing the code... 2020-08-26 07:23:56 +00:00			`:if ([ :len [ / caps-man access-list find where comment="--- hotspot-to-wpa above ---" disabled ] ] = 0) do={`
hotspot-to-wpa: unbreak options 2020-03-09 12:46:06 +00:00			`/ caps-man access-list add comment="--- hotspot-to-wpa above ---" disabled=yes;`
global: give script or function name in log messages 2021-02-22 14:14:10 +00:00			`$LogPrintExit2 warning $0 ("Added disabled access-list entry with comment '--- hotspot-to-wpa above ---'.") false;`
add script 'hotspot-to-wpa' 2019-10-14 19:24:35 +00:00			`}`
hotspot-to-wpa: always use first entry to place before 2021-01-03 19:34:19 +00:00			`:local PlaceBefore ([ / caps-man access-list find where comment="--- hotspot-to-wpa above ---" disabled ]->0);`
add script 'hotspot-to-wpa' 2019-10-14 19:24:35 +00:00
global: give script or function name in log messages 2021-02-22 14:14:10 +00:00			`$LogPrintExit2 info $0 ("Adding/updating accesslist entry for mac address " . $MacAddress . \`
hotspot-to-wpa: use $LogPrintExit and add more logging 2020-03-05 08:17:19 +00:00			`" (user " . $UserName . ").") false;`

add script 'hotspot-to-wpa' 2019-10-14 19:24:35 +00:00			`/ caps-man access-list remove [ find where mac-address=$MacAddress comment~"^hotspot-to-wpa: " ];`
hotspot-to-wpa: drop support for tx limits ... if you need to limit bandwidth use queues instead. 2021-11-03 14:21:01 +00:00			`/ caps-man access-list add comment=("hotspot-to-wpa: " . $UserName . ", " . $MacAddress . ", " . $Date) \`
			`mac-address=$MacAddress private-passphrase=$PassWord ssid-regexp="-wpa\$" place-before=$PlaceBefore;`