a0712d23e8
refs #10156 - Updated ApiKey model to use shorter secrets for admin keys
84 lines
2.3 KiB
JavaScript
84 lines
2.3 KiB
JavaScript
const crypto = require('crypto');
|
|
const ghostBookshelf = require('./base');
|
|
const {Role} = require('./role');
|
|
|
|
/*
|
|
* Uses birthday problem estimation to calculate chance of collision
|
|
* d = 16^26 // 26 char hex string
|
|
* n = 10,000,000 // 10 million
|
|
*
|
|
* (-n x (n-1)) / 2d
|
|
* 1 - e^
|
|
*
|
|
*
|
|
* 17
|
|
* ~= 4 x 10^
|
|
*
|
|
* ref: https://medium.freecodecamp.org/how-long-should-i-make-my-api-key-833ebf2dc26f
|
|
* ref: https://en.wikipedia.org/wiki/Birthday_problem#Approximations
|
|
*
|
|
* 26 char hex string = 13 bytes
|
|
* 64 char hex string JWT secret = 32 bytes
|
|
*/
|
|
const createSecret = (type) => {
|
|
const bytes = type === 'content' ? 13 : 32;
|
|
return crypto.randomBytes(bytes).toString('hex');
|
|
};
|
|
|
|
const ApiKey = ghostBookshelf.Model.extend({
|
|
tableName: 'api_keys',
|
|
|
|
defaults() {
|
|
const secret = createSecret(this.get('type'));
|
|
|
|
return {
|
|
secret
|
|
};
|
|
},
|
|
|
|
role() {
|
|
return this.belongsTo('Role');
|
|
},
|
|
|
|
// if an ApiKey does not have a related Integration then it's considered
|
|
// "internal" and shouldn't show up in the UI. Example internal API Keys
|
|
// would be the ones used for the scheduler and backup clients
|
|
integration() {
|
|
return this.belongsTo('Integration');
|
|
},
|
|
|
|
onSaving(model, attrs, options) {
|
|
ghostBookshelf.Model.prototype.onSaving.apply(this, arguments);
|
|
|
|
// enforce roles which are currently hardcoded
|
|
// - admin key = Adminstrator role
|
|
// - content key = no role
|
|
if (this.hasChanged('type') || this.hasChanged('role_id')) {
|
|
if (this.get('type') === 'admin') {
|
|
return Role.findOne({name: 'Admin Integration'}, Object.assign({}, options, {columns: ['id']}))
|
|
.then((role) => {
|
|
this.set('role_id', role.get('id'));
|
|
});
|
|
}
|
|
|
|
if (this.get('type') === 'content') {
|
|
this.set('role_id', null);
|
|
}
|
|
}
|
|
}
|
|
}, {
|
|
refreshSecret(data, options) {
|
|
const secret = createSecret(data.type);
|
|
return this.edit(Object.assign({}, data, {secret}), options);
|
|
}
|
|
});
|
|
|
|
const ApiKeys = ghostBookshelf.Collection.extend({
|
|
model: ApiKey
|
|
});
|
|
|
|
module.exports = {
|
|
ApiKey: ghostBookshelf.model('ApiKey', ApiKey),
|
|
ApiKeys: ghostBookshelf.collection('ApiKeys', ApiKeys)
|
|
};
|