nodemailer/wildduck
1
1
Fork 0
mirror of https://github.com/nodemailer/wildduck.git synced 2025-10-04 02:46:57 +08:00
Code Issues Projects Releases Packages Wiki Activity

update DKIM handling

Browse source
This commit is contained in:
Andris Reinman 2018-09-11 11:13:53 +03:00
parent c828893c9c
commit 1f9ae407a9
8 changed files with 263 additions and 114 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
config/roles.json
View file

@ -31,6 +31,13 @@
"read:any": ["*"],
"update:any": ["*"],
"delete:any": ["*"]
},
"dkim": {
"create:any": ["*"],
"read:any": ["*"],
"update:any": ["*"],
"delete:any": ["*"]
}
},

2
docs/api_data.js
View file

File diff suppressed because one or more lines are too long

2
docs/api_data.json
View file

File diff suppressed because one or more lines are too long

2
docs/api_project.js
View file

@ -1 +1 @@
define({ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2018-09-10T11:13:03.088Z", "url": "http://apidocjs.com", "version": "0.17.6" } });
define({ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2018-09-11T08:09:57.476Z", "url": "http://apidocjs.com", "version": "0.17.6" } });

2
docs/api_project.json
View file

@ -1 +1 @@
{ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2018-09-10T11:13:03.088Z", "url": "http://apidocjs.com", "version": "0.17.6" } }
{ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2018-09-11T08:09:57.476Z", "url": "http://apidocjs.com", "version": "0.17.6" } }

350
lib/api/dkim.js
View file

@ -6,6 +6,8 @@ const MongoPaging = require('mongo-cursor-pagination');
const ObjectID = require('mongodb').ObjectID;
const DkimHandler = require('../dkim-handler');
const tools = require('../tools');
const util = require('util');
const roles = require('../roles');
module.exports = (db, server) => {
const dkimHandler = new DkimHandler({
@ -16,6 +18,10 @@ module.exports = (db, server) => {
database: db.database
});
const setDkim = util.promisify(dkimHandler.set.bind(dkimHandler));
const getDkim = util.promisify(dkimHandler.get.bind(dkimHandler));
const delDkim = util.promisify(dkimHandler.del.bind(dkimHandler));
/**
* @api {get} /dkim List registered DKIM keys
* @apiName GetDkim
@ -120,6 +126,9 @@ module.exports = (db, server) => {
return next();
}
// permissions check
req.validate(roles.can(req.role).readAny('dkim'));
let query = result.value.query;
let limit = result.value.limit;
let page = result.value.page;
@ -187,6 +196,110 @@ module.exports = (db, server) => {
})
);
/**
* @api {get} /dkim/resolve/:domain Resolve ID for a DKIM domain
* @apiName ResolveDKIM
* @apiGroup DKIM
* @apiHeader {String} X-Access-Token Optional access token if authentication is enabled
* @apiHeaderExample {json} Header-Example:
* {
* "X-Access-Token": "59fc66a03e54454869460e45"
* }
*
* @apiParam {String} domain DKIM domain
*
* @apiSuccess {Boolean} success Indicates successful response
* @apiSuccess {String} id DKIM unique ID (24 byte hex)
*
* @apiError error Description of the error
*
* @apiExample {curl} Example usage:
* curl -i http://localhost:8080/dkim/resolve/example.com
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "success": true,
* "id": "59fc66a03e54454869460e45"
* }
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 200 OK
* {
* "error": "This domain does not exist"
* }
*/
server.get(
'/dkim/resolve/:domain',
tools.asyncifyJson(async (req, res, next) => {
res.charSet('utf-8');
const schema = Joi.object().keys({
domain: Joi.string()
.max(255)
//.hostname()
.required(),
sess: Joi.string().max(255),
ip: Joi.string().ip({
version: ['ipv4', 'ipv6'],
cidr: 'forbidden'
})
});
const result = Joi.validate(req.params, schema, {
abortEarly: false,
convert: true
});
if (result.error) {
res.json({
error: result.error.message,
code: 'InputValidationError'
});
return next();
}
// permissions check
req.validate(roles.can(req.role).readAny('dkim'));
let domain = tools.normalizeDomain(result.value.domain);
let dkimData;
try {
dkimData = await db.database.collection('dkim').findOne(
{
domain
},
{
projection: { _id: 1 }
}
);
} catch (err) {
res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
return next();
}
if (!dkimData) {
res.json({
error: 'This domain does not exist',
code: 'DkimNotFound'
});
return next();
}
res.json({
success: true,
id: dkimData._id
});
return next();
})
);
/**
* @api {post} /dkim Create or update DKIM key for domain
* @apiName PostDkim
@ -248,62 +361,72 @@ module.exports = (db, server) => {
* "error": "This user does not exist"
* }
*/
server.post('/dkim', (req, res, next) => {
res.charSet('utf-8');
server.post(
'/dkim',
tools.asyncifyJson(async (req, res, next) => {
res.charSet('utf-8');
const schema = Joi.object().keys({
domain: Joi.string()
.max(255)
//.hostname()
.required(),
selector: Joi.string()
.max(255)
//.hostname()
.trim()
.required(),
privateKey: Joi.string()
.empty('')
.trim()
.regex(/^-----BEGIN (RSA )?PRIVATE KEY-----/, 'DKIM key format'),
description: Joi.string()
.max(255)
//.hostname()
.trim(),
sess: Joi.string().max(255),
ip: Joi.string().ip({
version: ['ipv4', 'ipv6'],
cidr: 'forbidden'
})
});
const result = Joi.validate(req.params, schema, {
abortEarly: false,
convert: true
});
if (result.error) {
res.json({
error: result.error.message,
code: 'InputValidationError'
const schema = Joi.object().keys({
domain: Joi.string()
.max(255)
//.hostname()
.required(),
selector: Joi.string()
.max(255)
//.hostname()
.trim()
.required(),
privateKey: Joi.string()
.empty('')
.trim()
.regex(/^-----BEGIN (RSA )?PRIVATE KEY-----/, 'DKIM key format'),
description: Joi.string()
.max(255)
//.hostname()
.trim(),
sess: Joi.string().max(255),
ip: Joi.string().ip({
version: ['ipv4', 'ipv6'],
cidr: 'forbidden'
})
});
return next();
}
dkimHandler.set(result.value, (err, response) => {
if (err) {
const result = Joi.validate(req.params, schema, {
abortEarly: false,
convert: true
});
if (result.error) {
res.json({
error: result.error.message,
code: 'InputValidationError'
});
return next();
}
// permissions check
req.validate(roles.can(req.role).createAny('dkim'));
let response;
try {
response = await setDkim(result.value);
} catch (err) {
res.json({
error: err.message,
code: err.code
});
return next();
}
if (response) {
response.success = true;
}
res.json(response);
return next();
});
});
})
);
/**
* @api {get} /dkim/:dkim Request DKIM information
@ -357,52 +480,61 @@ module.exports = (db, server) => {
* "error": "This Alias does not exist"
* }
*/
server.get('/dkim/:dkim', (req, res, next) => {
res.charSet('utf-8');
server.get(
'/dkim/:dkim',
tools.asyncifyJson(async (req, res, next) => {
res.charSet('utf-8');
const schema = Joi.object().keys({
dkim: Joi.string()
.hex()
.lowercase()
.length(24)
.required(),
sess: Joi.string().max(255),
ip: Joi.string().ip({
version: ['ipv4', 'ipv6'],
cidr: 'forbidden'
})
});
const result = Joi.validate(req.params, schema, {
abortEarly: false,
convert: true
});
if (result.error) {
res.json({
error: result.error.message,
code: 'InputValidationError'
const schema = Joi.object().keys({
dkim: Joi.string()
.hex()
.lowercase()
.length(24)
.required(),
sess: Joi.string().max(255),
ip: Joi.string().ip({
version: ['ipv4', 'ipv6'],
cidr: 'forbidden'
})
});
return next();
}
let dkim = new ObjectID(result.value.dkim);
const result = Joi.validate(req.params, schema, {
abortEarly: false,
convert: true
});
dkimHandler.get({ _id: dkim }, false, (err, response) => {
if (err) {
if (result.error) {
res.json({
error: result.error.message,
code: 'InputValidationError'
});
return next();
}
// permissions check
req.validate(roles.can(req.role).readAny('dkim'));
let dkim = new ObjectID(result.value.dkim);
let response;
try {
response = await getDkim({ _id: dkim }, false);
} catch (err) {
res.json({
error: err.message,
code: err.code
});
return next();
}
if (response) {
response.success = true;
}
res.json(response);
return next();
});
});
})
);
/**
* @api {delete} /dkim/:dkim Delete a DKIM key
@ -435,49 +567,59 @@ module.exports = (db, server) => {
* "error": "Database error"
* }
*/
server.del('/dkim/:dkim', (req, res, next) => {
res.charSet('utf-8');
server.del(
'/dkim/:dkim',
tools.asyncifyJson(async (req, res, next) => {
res.charSet('utf-8');
const schema = Joi.object().keys({
dkim: Joi.string()
.hex()
.lowercase()
.length(24)
.required(),
sess: Joi.string().max(255),
ip: Joi.string().ip({
version: ['ipv4', 'ipv6'],
cidr: 'forbidden'
})
});
const result = Joi.validate(req.params, schema, {
abortEarly: false,
convert: true
});
if (result.error) {
res.json({
error: result.error.message,
code: 'InputValidationError'
const schema = Joi.object().keys({
dkim: Joi.string()
.hex()
.lowercase()
.length(24)
.required(),
sess: Joi.string().max(255),
ip: Joi.string().ip({
version: ['ipv4', 'ipv6'],
cidr: 'forbidden'
})
});
return next();
}
let dkim = new ObjectID(result.value.dkim);
const result = Joi.validate(req.params, schema, {
abortEarly: false,
convert: true
});
dkimHandler.del({ _id: dkim }, (err, response) => {
if (err) {
if (result.error) {
res.json({
error: result.error.message,
code: 'InputValidationError'
});
return next();
}
// permissions check
req.validate(roles.can(req.role).deleteAny('dkim'));
let dkim = new ObjectID(result.value.dkim);
let response;
try {
response = await delDkim({ _id: dkim });
} catch (err) {
res.json({
error: err.message,
code: err.code
});
return next();
}
res.json({
success: response
});
return next();
});
});
})
);
};

4
lib/api/domainaliases.js
View file

@ -329,7 +329,7 @@ module.exports = (db, server) => {
* @apiParam {String} alias Alias domain
*
* @apiSuccess {Boolean} success Indicates successful response
* @apiSuccess {String} id Users unique ID (24 byte hex)
* @apiSuccess {String} id Alias unique ID (24 byte hex)
*
* @apiError error Description of the error
*
@ -377,7 +377,7 @@ module.exports = (db, server) => {
return next();
}
let alias = tools.normalizeDomain(req.params.alias);
let alias = tools.normalizeDomain(result.value.alias);
db.users.collection('domainaliases').findOne(
{

8
lib/dkim-handler.js
View file

@ -200,7 +200,7 @@ class DkimHandler {
query._id = new ObjectID(options._id);
} else {
let err = new Error('Invalid or unknown DKIM key');
err.code = 'KeyNotFound';
err.code = 'DkimNotFound';
return setImmediate(() => callback(err));
}
@ -211,7 +211,7 @@ class DkimHandler {
}
if (!dkimData) {
let err = new Error('Invalid or unknown DKIM key');
err.code = 'KeyNotFound';
err.code = 'DkimNotFound';
return callback(err);
}
@ -263,7 +263,7 @@ class DkimHandler {
query._id = new ObjectID(options._id);
} else {
let err = new Error('Invalid or unknown DKIM key');
err.code = 'KeyNotFound';
err.code = 'DkimNotFound';
return setImmediate(() => callback(err));
}
@ -276,7 +276,7 @@ class DkimHandler {
if (!r.deletedCount) {
let err = new Error('Invalid or unknown DKIM key');
err.code = 'KeyNotFound';
err.code = 'DkimNotFound';
return callback(err);
}