Password via G-code and MarlinUI (#18399)
Co-authored-by: Scott Lahteine <thinkyhead@users.noreply.github.com>2.0.x
sherwin-dc
4 years ago
committed by
GitHub
parent
0a1b865987
commit
852e5ae042
@ -0,0 +1,58 @@
|
||||
/**
|
||||
* Marlin 3D Printer Firmware
|
||||
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
||||
*
|
||||
* Based on Sprinter and grbl.
|
||||
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "../../inc/MarlinConfigPre.h"
|
||||
|
||||
#if ENABLED(PASSWORD_FEATURE)
|
||||
|
||||
#include "password.h"
|
||||
#include "../../gcode/gcode.h"
|
||||
#include "../../core/serial.h"
|
||||
|
||||
Password password;
|
||||
|
||||
// public:
|
||||
bool Password::is_set, Password::is_locked;
|
||||
uint32_t Password::value, Password::value_entry;
|
||||
|
||||
//
|
||||
// Authenticate user with password.
|
||||
// Called from Setup, after SD Prinitng Stops/Aborts, and M510
|
||||
//
|
||||
void Password::lock_machine() {
|
||||
is_locked = true;
|
||||
TERN_(HAS_LCD_MENU, authenticate_user(ui.status_screen, screen_password_entry));
|
||||
}
|
||||
|
||||
//
|
||||
// Authentication check
|
||||
//
|
||||
void Password::authentication_check() {
|
||||
if (value_entry == value)
|
||||
is_locked = false;
|
||||
else
|
||||
SERIAL_ECHOLNPGM(STR_WRONG_PASSWORD);
|
||||
|
||||
TERN_(HAS_LCD_MENU, authentication_done());
|
||||
}
|
||||
|
||||
#endif // PASSWORD_FEATURE
|
||||
@ -0,0 +1,57 @@
|
||||
/**
|
||||
* Marlin 3D Printer Firmware
|
||||
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
||||
*
|
||||
* Based on Sprinter and grbl.
|
||||
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include "../../lcd/ultralcd.h"
|
||||
|
||||
class Password {
|
||||
public:
|
||||
static bool is_set, is_locked;
|
||||
static uint32_t value, value_entry;
|
||||
|
||||
Password() { is_locked = false; }
|
||||
|
||||
static void lock_machine();
|
||||
|
||||
#if HAS_LCD_MENU
|
||||
static void access_menu_password();
|
||||
static void authentication_check();
|
||||
static void authentication_done();
|
||||
static void media_gatekeeper();
|
||||
|
||||
private:
|
||||
static void authenticate_user(const screenFunc_t, const screenFunc_t);
|
||||
static void menu_password();
|
||||
static void menu_password_entry();
|
||||
static void screen_password_entry();
|
||||
static void screen_set_password();
|
||||
static void start_over();
|
||||
|
||||
static void digit_entered();
|
||||
static void set_password_done();
|
||||
static void menu_password_report();
|
||||
|
||||
static void remove_password();
|
||||
#endif
|
||||
};
|
||||
|
||||
extern Password password;
|
||||
@ -0,0 +1,83 @@
|
||||
/**
|
||||
* Marlin 3D Printer Firmware
|
||||
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
||||
*
|
||||
* Based on Sprinter and grbl.
|
||||
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "../../../inc/MarlinConfigPre.h"
|
||||
|
||||
#if ENABLED(PASSWORD_FEATURE)
|
||||
|
||||
#include "../../../feature/password/password.h"
|
||||
#include "../../../core/serial.h"
|
||||
#include "../../gcode.h"
|
||||
|
||||
//
|
||||
// M510: Lock Printer
|
||||
//
|
||||
void GcodeSuite::M510() {
|
||||
password.lock_machine();
|
||||
}
|
||||
|
||||
//
|
||||
// M511: Unlock Printer
|
||||
//
|
||||
#if ENABLED(PASSWORD_UNLOCK_GCODE)
|
||||
|
||||
void GcodeSuite::M511() {
|
||||
if (password.is_locked) {
|
||||
password.value_entry = parser.ulongval('P');
|
||||
password.authentication_check();
|
||||
}
|
||||
}
|
||||
|
||||
#endif // PASSWORD_UNLOCK_GCODE
|
||||
|
||||
//
|
||||
// M512: Set/Change/Remove Password
|
||||
//
|
||||
#if ENABLED(PASSWORD_CHANGE_GCODE)
|
||||
|
||||
void GcodeSuite::M512() {
|
||||
if (password.is_set && parser.ulongval('P') != password.value) {
|
||||
SERIAL_ECHOLNPGM(STR_WRONG_PASSWORD);
|
||||
return;
|
||||
}
|
||||
|
||||
if (parser.seenval('N')) {
|
||||
password.value_entry = parser.ulongval('N');
|
||||
|
||||
if (password.value_entry < CAT(1e, PASSWORD_LENGTH)) {
|
||||
password.is_set = true;
|
||||
password.value = password.value_entry;
|
||||
SERIAL_ECHOLNPAIR(STR_PASSWORD_SET, password.value); // TODO: Update password.string
|
||||
}
|
||||
else
|
||||
SERIAL_ECHOLNPGM(STR_PASSWORD_TOO_LONG);
|
||||
}
|
||||
else {
|
||||
password.is_set = false;
|
||||
SERIAL_ECHOLNPGM(STR_PASSWORD_REMOVED);
|
||||
}
|
||||
SERIAL_ECHOLNPGM(STR_REMINDER_SAVE_SETTINGS);
|
||||
}
|
||||
|
||||
#endif // PASSWORD_CHANGE_GCODE
|
||||
|
||||
#endif // PASSWORD_FEATURE
|
||||
@ -0,0 +1,184 @@
|
||||
/**
|
||||
* Marlin 3D Printer Firmware
|
||||
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
||||
*
|
||||
* Based on Sprinter and grbl.
|
||||
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
//
|
||||
// Advanced Settings Menus
|
||||
//
|
||||
|
||||
#include "../../inc/MarlinConfigPre.h"
|
||||
|
||||
#if BOTH(HAS_LCD_MENU, PASSWORD_FEATURE)
|
||||
|
||||
#include "../../feature/password/password.h"
|
||||
|
||||
#include "menu.h"
|
||||
#include "menu_addon.h"
|
||||
|
||||
void menu_advanced_settings();
|
||||
|
||||
screenFunc_t success_screen, fail_screen;
|
||||
bool authenticating; // = false
|
||||
char string[(PASSWORD_LENGTH) + 1];
|
||||
static uint8_t digit_no;
|
||||
|
||||
//
|
||||
// Screen for both editing and setting the password
|
||||
//
|
||||
void Password::menu_password_entry() {
|
||||
START_MENU();
|
||||
|
||||
// "Login" or "New Code"
|
||||
STATIC_ITEM_P(authenticating ? GET_TEXT(MSG_LOGIN_REQUIRED) : GET_TEXT(MSG_EDIT_PASSWORD), SS_CENTER|SS_INVERT);
|
||||
|
||||
STATIC_ITEM_P(PSTR(""), SS_CENTER|SS_INVERT, string);
|
||||
|
||||
// Make the digit edit item look like a sub-menu
|
||||
PGM_P const label = GET_TEXT(MSG_ENTER_DIGIT);
|
||||
EDIT_ITEM_P(uint8, label, &editable.uint8, 0, 9, digit_entered);
|
||||
MENU_ITEM_ADDON_START(utf8_strlen_P(label) + 1);
|
||||
lcd_put_wchar(' ');
|
||||
lcd_put_wchar('1' + digit_no);
|
||||
SETCURSOR_X(LCD_WIDTH - 1);
|
||||
lcd_put_wchar('>');
|
||||
MENU_ITEM_ADDON_END();
|
||||
|
||||
ACTION_ITEM(MSG_START_OVER, start_over);
|
||||
|
||||
if (!authenticating) BACK_ITEM(MSG_BUTTON_CANCEL);
|
||||
|
||||
END_MENU();
|
||||
}
|
||||
|
||||
//
|
||||
// Authentication check
|
||||
//
|
||||
void Password::authentication_done() {
|
||||
ui.goto_screen(is_locked ? fail_screen : success_screen);
|
||||
ui.completion_feedback(!is_locked);
|
||||
}
|
||||
|
||||
// A single digit was completed
|
||||
void Password::digit_entered() {
|
||||
uint32_t multiplier = CAT(1e, PASSWORD_LENGTH); // 1e5 = 100000
|
||||
LOOP_LE_N(i, digit_no) multiplier /= 10;
|
||||
value_entry += editable.uint8 * multiplier;
|
||||
string[digit_no++] = '0' + editable.uint8;
|
||||
|
||||
// Exit edit screen menu and go to another screen
|
||||
ui.goto_previous_screen();
|
||||
ui.use_click();
|
||||
ui.goto_screen(menu_password_entry);
|
||||
|
||||
// After password has been keyed in
|
||||
if (digit_no == PASSWORD_LENGTH) {
|
||||
if (authenticating)
|
||||
authentication_check();
|
||||
else
|
||||
set_password_done();
|
||||
}
|
||||
}
|
||||
|
||||
//
|
||||
// Set/Change Password
|
||||
//
|
||||
void Password::screen_password_entry() {
|
||||
value_entry = 0;
|
||||
digit_no = 0;
|
||||
editable.uint8 = 0;
|
||||
memset(string, '-', PASSWORD_LENGTH);
|
||||
string[PASSWORD_LENGTH] = '\0';
|
||||
menu_password_entry();
|
||||
}
|
||||
|
||||
void Password::screen_set_password() {
|
||||
authenticating = false;
|
||||
screen_password_entry();
|
||||
}
|
||||
|
||||
void Password::authenticate_user(const screenFunc_t in_succ_scr, const screenFunc_t in_fail_scr) {
|
||||
success_screen = in_succ_scr;
|
||||
fail_screen = in_fail_scr;
|
||||
if (is_set) {
|
||||
authenticating = true;
|
||||
ui.goto_screen(screen_password_entry);
|
||||
ui.defer_status_screen();
|
||||
ui.update();
|
||||
}
|
||||
else {
|
||||
ui.goto_screen(in_succ_scr);
|
||||
is_locked = false;
|
||||
}
|
||||
}
|
||||
|
||||
void Password::access_menu_password() {
|
||||
authenticate_user(menu_password, menu_advanced_settings);
|
||||
}
|
||||
|
||||
#if ENABLED(PASSWORD_ON_SD_PRINT_MENU)
|
||||
void Password::media_gatekeeper() {
|
||||
authenticate_user(menu_media, menu_main);
|
||||
}
|
||||
#endif
|
||||
|
||||
void Password::start_over() {
|
||||
ui.goto_previous_screen(); // Goto previous screen, if any
|
||||
ui.goto_screen(screen_password_entry);
|
||||
}
|
||||
|
||||
void Password::menu_password_report() {
|
||||
START_SCREEN();
|
||||
BACK_ITEM(MSG_PASSWORD_SETTINGS);
|
||||
STATIC_ITEM(MSG_PASSWORD_SET, SS_LEFT, string);
|
||||
STATIC_ITEM(MSG_REMINDER_SAVE_SETTINGS, SS_LEFT);
|
||||
END_SCREEN();
|
||||
}
|
||||
|
||||
void Password::set_password_done() {
|
||||
is_set = true;
|
||||
value = value_entry;
|
||||
ui.completion_feedback(true);
|
||||
ui.goto_screen(menu_password_report);
|
||||
}
|
||||
|
||||
void Password::remove_password() {
|
||||
is_set = false;
|
||||
string[0] = '0';
|
||||
string[1] = '\0';
|
||||
ui.completion_feedback(true);
|
||||
ui.goto_screen(menu_password_report);
|
||||
}
|
||||
|
||||
//
|
||||
// Password Menu
|
||||
//
|
||||
void Password::menu_password() {
|
||||
START_MENU();
|
||||
BACK_ITEM(MSG_ADVANCED_SETTINGS);
|
||||
SUBMENU(MSG_CHANGE_PASSWORD, screen_set_password);
|
||||
ACTION_ITEM(MSG_REMOVE_PASSWORD, []{ ui.save_previous_screen(); remove_password(); } );
|
||||
#if ENABLED(EEPROM_SETTINGS)
|
||||
ACTION_ITEM(MSG_STORE_EEPROM, ui.store_settings);
|
||||
#endif
|
||||
END_MENU();
|
||||
}
|
||||
|
||||
#endif // HAS_LCD_MENU && PASSWORD_FEATURE
|
||||
Loading…
Reference in New Issue