Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IMPROVE] Add option to require authentication on user's shield endpoint #16845

Merged
merged 3 commits into from
Mar 12, 2020
Merged

[IMPROVE] Add option to require authentication on user's shield endpoint #16845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0e51ec
Add verification on shield endpoint if user request for users
MarcosSpessatto Mar 11, 2020
28667fa
Apply suggestions from review
MarcosSpessatto Mar 12, 2020
1c5c533
Update app/api/server/v1/misc.js
MarcosSpessatto Mar 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/api/server/settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ settings.addGroup('General', function() {
this.add('API_Enable_Direct_Message_History_EndPoint', false, { type: 'boolean', public: false });
this.add('API_Enable_Shields', true, { type: 'boolean', public: false });
this.add('API_Shield_Types', '*', { type: 'string', public: false, enableQuery: { _id: 'API_Enable_Shields', value: true } });
this.add('API_Shield_user_require_auth', false, { type: 'boolean', public: false, enableQuery: { _id: 'API_Enable_Shields', value: true } });
this.add('API_Enable_CORS', false, { type: 'boolean', public: false });
this.add('API_CORS_Origin', '*', { type: 'string', public: false, enableQuery: { _id: 'API_Enable_CORS', value: true } });
});
Expand Down
3 changes: 3 additions & 0 deletions app/api/server/v1/misc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ API.v1.addRoute('shield.svg', { authRequired: false, rateLimiterOptions: { numRe
text = `#${ channel }`;
break;
case 'user':
if (settings.get('API_Shield_user_require_auth') && !this.getLoggedInUser()) {
return API.v1.failure('You must be logged in to do this.');
}
const user = this.getUserFromParams();

// Respect the server's choice for using their real names or not
Expand Down
1 change: 1 addition & 0 deletions packages/rocketchat-i18n/i18n/en.i18n.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,7 @@
"API_Personal_Access_Tokens_Regenerate_It": "Regenerate token",
"API_Shield_Types": "Shield Types",
"API_Shield_Types_Description": "Types of shields to enable as a comma separated list, choose from `online`, `channel` or `*` for all",
"API_Shield_user_require_auth": "Require authentication for users shields",
"API_Token": "API Token",
"API_Tokenpass_URL": "Tokenpass Server URL",
"API_Tokenpass_URL_Description": "Example: https://domain.com (excluding trailing slash)",
Expand Down
1 change: 1 addition & 0 deletions packages/rocketchat-i18n/i18n/pt-BR.i18n.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,7 @@
"API_Personal_Access_Tokens_Regenerate_It": "Renovar código",
"API_Shield_Types": "Tipos de escudo",
"API_Shield_Types_Description": "Tipos de escudos para habilitar como uma lista separada por vírgulas, escolha entre \"on-line\", \"canal\" ou \"*\" para todos",
"API_Shield_user_require_auth": "Exigir autenticaçāo para escudos de usuários",
"API_Token": "API Token",
"API_Tokenpass_URL": "URL do Servidor Tokenpass",
"API_Tokenpass_URL_Description": "Exemplo: https://domain.com (excluindo a barra diagonal)",
Expand Down