tqt/Ghost
2
1
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2023-12-13 21:00:40 +01:00
Code Issues 1 Releases Wiki Activity

Improved error message when attempting to use disabled v0.1 Public API (#10562)

Browse source 
no issue
- trying to use the v0.1 Public API when it was disabled led to a confusing error message, see https://forum.ghost.org/t/403-forbidden-error-on-postman-api-call/6017
- adds an explicit check for the Public API being enabled in the client authentication step and throws a useful error message if client auth is attempted when it's disabled
This commit is contained in:
Kevin Ansfield 2019-03-05 10:41:07 +00:00 committed by GitHub
parent e79fc9a9be
commit 39edb7646e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
core/server/services/auth/authenticate.js
View file

@ -5,6 +5,7 @@ const common = require('../../lib/common');
const session = require('./session');
const apiKeyAuth = require('./api-key');
const members = require('./members');
const labs = require('../labs');
const authenticate = {
// ### Authenticate Client Middleware
@ -38,6 +39,14 @@ const authenticate = {
req.body.client_secret = req.query.client_secret;
}
if (labs.isSet('publicAPI') !== true) {
return next(new common.errors.NoPermissionError({
message: common.i18n.t('errors.middleware.auth.publicAPIDisabled.error'),
context: common.i18n.t('errors.middleware.auth.publicAPIDisabled.context'),
help: common.i18n.t('errors.middleware.auth.forInformationRead', {url: 'https://docs.ghost.org/api/content/'})
}));
}
if (!req.body.client_id || !req.body.client_secret) {
return next(new common.errors.UnauthorizedError({
message: common.i18n.t('errors.middleware.auth.accessDenied'),

4
core/server/translations/en.json
View file

@ -74,6 +74,10 @@
"versionMismatch": "Client request for {clientVersion} does not match server version {serverVersion}."
},
"auth": {
"publicAPIDisabled": {
"error": "Permission error! Public API is disabled.",
"context": "Please enable the deprecated v0.1 Public API or switch to using the v2 Content API."
},
"clientAuthenticationFailed": "Client Authentication Failed",
"clientCredentialsNotProvided": "Client credentials were not provided",
"clientCredentialsNotValid": "Client credentials were not valid",

24
core/test/unit/services/auth/authenticate_spec.js
View file

@ -6,6 +6,7 @@ const ClientPasswordStrategy = require('passport-oauth2-client-password').Strate
const auth = require('../../../../server/services/auth');
const common = require('../../../../server/lib/common');
const models = require('../../../../server/models');
const labs = require('../../../../server/services/labs');
const user = {id: 1};
const info = {scope: '*'};
const token = 'test_token';
@ -203,6 +204,10 @@ describe('Auth', function () {
});
describe('Client Authentication', function () {
beforeEach(function () {
sinon.stub(labs, 'isSet').withArgs('publicAPI').returns(true);
});
it('shouldn\'t require authorized client with bearer token', function (done) {
req.headers = {};
req.headers.authorization = 'Bearer ' + token;
@ -344,6 +349,25 @@ describe('Auth', function () {
done();
});
it('shouldn\'t authenticate when publicAPI is disabled', function (done) {
labs.isSet.restore();
sinon.stub(labs, 'isSet').withArgs('publicAPI').returns(false);
req.body = {};
req.body.client_id = testClient;
req.body.client_secret = testSecret;
req.headers = {};
var next = function next(err) {
err.statusCode.should.eql(403);
(err instanceof common.errors.NoPermissionError).should.eql(true);
done();
};
registerSuccessfulClientPasswordStrategy();
auth.authenticate.authenticateClient(req, res, next);
});
it('shouldn\'t authenticate when error', function (done) {
req.body = {};
req.body.client_id = testClient;