BroadSQL Download
On this page
Documentation / Commands / SET MASTER PASSWORD

SET MASTER PASSWORD

Core command SET MAPA

Changes the master password that protects the Connections Definition File (CDF).

Syntax

SET MASTER PASSWORD

Examples

SET MASTER PASSWORD;

Details

The command takes no argument. It asks for the current master password, then for the new one twice, and encrypts the BroadSQL configuration database (CDF) again with the new master password. The change applies to the whole CDF, every connection and API included. BroadSQL then asks you to log in with the new master password. The current database connection stays open.

Accepted master passwords

2 to 256 characters: letters, digits and symbols of the ISO-8859-1 (Latin-1) character set, such as a-z A-Z 0-9 é ü ß $ # @ ! % & * - _ +. Spaces, control characters and characters outside Latin-1 (for example € or Chinese characters) are refused before anything is changed: the database engine cannot reopen a file encrypted with them.

How the CDF is protected during the change

The CDF is never encrypted again in place. BroadSQL first saves a backup in the backups folder next to the CDF (<CDF name>_masterpwd_<date>_<time>.zip, encrypted with the previous master password), encrypts a copy with the new password, checks that the copy opens with it and holds exactly the same data, and only then puts the copy in place of the CDF and checks it again. When any step fails, the CDF is left as it was and the message says so. When BroadSQL is stopped in the middle of the change, the next login completes it (log in with the new master password) or offers to undo it (log in with the previous one).

Refusals

Nothing changes when the current master password is wrong, the new password does not follow the rules above or is the same as the current one, or the two entries differ. The command is refused in CDF maintenance mode (use DISCONNECT first), while a CONFIG or CONFIG API window is open, and while a Script runs in the BroadSQL Editor. Close other BroadSQL sessions that use the same CDF first: the change is refused while another one has the CDF open.

Last modified in release 5.5.0.

← All commands

Found something wrong or unclear on this page? , with the page address.