moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Standardize on _enig prefix for internal routes; update all _internal to this prefix

This commit is contained in:
Bryan Ashby 2023-01-04 21:25:33 -07:00
parent 5055337eff
commit 8026164ae4
No known key found for this signature in database
GPG Key ID: C2C1B501E4EFD994
3 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
WHATSNEW.md
View File

@ -4,7 +4,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
## 0.0.14-beta ## 0.0.14-beta
* The [Web Server](/docs/_docs/servers/contentservers/web-server.md) has made some possibly breaking changes: * The [Web Server](/docs/_docs/servers/contentservers/web-server.md) has made some possibly breaking changes:
* `/static/` prefixes are no longer required. This was a ugly hack. * `/static/` prefixes are no longer required. This was a ugly hack.
* Some internal routes such as those used for password resets live within `/_internal/`. * Some internal routes such as those used for password resets live within `/_enig/`.
* Routes for the file base now default to `/_f/` prefixed instead of just `/f/`. If `/f/` is in your `config.hjson` you are encouraged to update it! * Routes for the file base now default to `/_f/` prefixed instead of just `/f/`. If `/f/` is in your `config.hjson` you are encouraged to update it!
* Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established. * Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established.

12
core/user_2fa_otp_web_register.js
View File

@ -5,6 +5,7 @@
const Config = require('./config.js').get; const Config = require('./config.js').get;
const getServer = require('./listening_server.js').getServer; const getServer = require('./listening_server.js').getServer;
const webServerPackageName = require('./servers/content/web.js').moduleInfo.packageName; const webServerPackageName = require('./servers/content/web.js').moduleInfo.packageName;
const { WellKnownLocations } = require('./servers/content/web');
const { const {
createToken, createToken,
deleteToken, deleteToken,
@ -76,7 +77,8 @@ module.exports = class User2FA_OTPWebRegister {
(token, textTemplate, htmlTemplate, callback) => { (token, textTemplate, htmlTemplate, callback) => {
const webServer = getWebServer(); const webServer = getWebServer();
const registerUrl = webServer.instance.buildUrl( const registerUrl = webServer.instance.buildUrl(
`/_internal/enable_2fa_otp?token=${token}&otpType=${otpType}` WellKnownLocations.Internal +
`/2fa/enable_2fa_otp?token=${token}&otpType=${otpType}`
); );
const replaceTokens = s => { const replaceTokens = s => {
@ -170,7 +172,9 @@ module.exports = class User2FA_OTPWebRegister {
return User2FA_OTPWebRegister.accessDenied(webServer, resp); return User2FA_OTPWebRegister.accessDenied(webServer, resp);
} }
const postUrl = webServer.instance.buildUrl('/_internal/enable_2fa_otp'); const postUrl = webServer.instance.buildUrl(
WellKnownLocations.Internal + '/2fa/enable_2fa_otp'
);
const config = Config(); const config = Config();
return webServer.instance.routeTemplateFilePage( return webServer.instance.routeTemplateFilePage(
_.get(config, 'users.twoFactorAuth.otp.registerPageTemplate'), _.get(config, 'users.twoFactorAuth.otp.registerPageTemplate'),
@ -296,12 +300,12 @@ ${backupCodes}
[ [
{ {
method: 'GET', method: 'GET',
path: /^\/_internal\/enable_2fa_otp\?token=[a-f0-9]+&otpType=[a-zA-Z0-9_]+$/, path: /^\/_enig\/2fa\/enable_2fa_otp\?token=[a-f0-9]+&otpType=[a-zA-Z0-9_]+$/,
handler: User2FA_OTPWebRegister.routeRegisterGet, handler: User2FA_OTPWebRegister.routeRegisterGet,
}, },
{ {
method: 'POST', method: 'POST',
path: /^\/_internal\/enable_2fa_otp$/, path: /^\/_enig\/2fa\/enable_2fa_otp$/,
handler: User2FA_OTPWebRegister.routeRegisterPost, handler: User2FA_OTPWebRegister.routeRegisterPost,
}, },
].forEach(r => { ].forEach(r => {

12
core/web_password_reset.js
View File

@ -6,6 +6,7 @@ const Config = require('./config.js').get;
const Errors = require('./enig_error.js').Errors; const Errors = require('./enig_error.js').Errors;
const getServer = require('./listening_server.js').getServer; const getServer = require('./listening_server.js').getServer;
const webServerPackageName = require('./servers/content/web.js').moduleInfo.packageName; const webServerPackageName = require('./servers/content/web.js').moduleInfo.packageName;
const { WellKnownLocations } = require('./servers/content/web');
const User = require('./user.js'); const User = require('./user.js');
const userDb = require('./database.js').dbs.user; const userDb = require('./database.js').dbs.user;
const getISOTimestampString = require('./database.js').getISOTimestampString; const getISOTimestampString = require('./database.js').getISOTimestampString;
@ -121,7 +122,8 @@ class WebPasswordReset {
const sendMail = require('./email.js').sendMail; const sendMail = require('./email.js').sendMail;
const resetUrl = webServer.instance.buildUrl( const resetUrl = webServer.instance.buildUrl(
`/_internal/reset_password?token=${ WellKnownLocations.Internal +
`/sec/reset_password?token=${
user.properties[UserProps.EmailPwResetToken] user.properties[UserProps.EmailPwResetToken]
}` }`
); );
@ -194,13 +196,13 @@ class WebPasswordReset {
{ {
// this is the page displayed to user when they GET it // this is the page displayed to user when they GET it
method: 'GET', method: 'GET',
path: /^\/_internal\/reset_password\?token=[a-f0-9]+$/, path: /^\/_enig\/sec\/reset_password\?token=[a-f0-9]+$/,
handler: WebPasswordReset.routeResetPasswordGet, handler: WebPasswordReset.routeResetPasswordGet,
}, },
// POST handler for performing the actual reset // POST handler for performing the actual reset
{ {
method: 'POST', method: 'POST',
path: /^\/_internal\/reset_password$/, path: /^\/_enig\/sec\/reset_password$/,
handler: WebPasswordReset.routeResetPasswordPost, handler: WebPasswordReset.routeResetPasswordPost,
}, },
].forEach(r => { ].forEach(r => {
@ -269,7 +271,9 @@ class WebPasswordReset {
); );
} }
const postResetUrl = webServer.instance.buildUrl('/_internal/reset_password'); const postResetUrl = webServer.instance.buildUrl(
WellKnownLocations.Internal + '/sec/reset_password'
);
const config = Config(); const config = Config();
return webServer.instance.routeTemplateFilePage( return webServer.instance.routeTemplateFilePage(