update DKIM handling

config/roles.json

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

docs/api_project.js

@@ -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"
  }
});

docs/api_project.json

@@ -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"
  }
}

lib/api/dkim.js

@@ -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) => {
+    server.post(
-        res.charSet('utf-8');
+        '/dkim',
+        tools.asyncifyJson(async (req, res, next) => {
+            res.charSet('utf-8');
 
-        const schema = Joi.object().keys({
+            const schema = Joi.object().keys({
-            domain: Joi.string()
+                domain: Joi.string()
-                .max(255)
+                    .max(255)
-                //.hostname()
+                    //.hostname()
-                .required(),
+                    .required(),
-            selector: Joi.string()
+                selector: Joi.string()
-                .max(255)
+                    .max(255)
-                //.hostname()
+                    //.hostname()
-                .trim()
+                    .trim()
-                .required(),
+                    .required(),
-            privateKey: Joi.string()
+                privateKey: Joi.string()
-                .empty('')
+                    .empty('')
-                .trim()
+                    .trim()
-                .regex(/^-----BEGIN (RSA )?PRIVATE KEY-----/, 'DKIM key format'),
+                    .regex(/^-----BEGIN (RSA )?PRIVATE KEY-----/, 'DKIM key format'),
-            description: Joi.string()
+                description: Joi.string()
-                .max(255)
+                    .max(255)
-                //.hostname()
+                    //.hostname()
-                .trim(),
+                    .trim(),
-            sess: Joi.string().max(255),
+                sess: Joi.string().max(255),
-            ip: Joi.string().ip({
+                ip: Joi.string().ip({
-                version: ['ipv4', 'ipv6'],
+                    version: ['ipv4', 'ipv6'],
-                cidr: 'forbidden'
+                    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();
-        }
 
-        dkimHandler.set(result.value, (err, response) => {
+            const result = Joi.validate(req.params, schema, {
-            if (err) {
+                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) => {
+    server.get(
-        res.charSet('utf-8');
+        '/dkim/:dkim',
+        tools.asyncifyJson(async (req, res, next) => {
+            res.charSet('utf-8');
 
-        const schema = Joi.object().keys({
+            const schema = Joi.object().keys({
-            dkim: Joi.string()
+                dkim: Joi.string()
-                .hex()
+                    .hex()
-                .lowercase()
+                    .lowercase()
-                .length(24)
+                    .length(24)
-                .required(),
+                    .required(),
-            sess: Joi.string().max(255),
+                sess: Joi.string().max(255),
-            ip: Joi.string().ip({
+                ip: Joi.string().ip({
-                version: ['ipv4', 'ipv6'],
+                    version: ['ipv4', 'ipv6'],
-                cidr: 'forbidden'
+                    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();
-        }
 
-        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 (result.error) {
-            if (err) {
+                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) => {
+    server.del(
-        res.charSet('utf-8');
+        '/dkim/:dkim',
+        tools.asyncifyJson(async (req, res, next) => {
+            res.charSet('utf-8');
 
-        const schema = Joi.object().keys({
+            const schema = Joi.object().keys({
-            dkim: Joi.string()
+                dkim: Joi.string()
-                .hex()
+                    .hex()
-                .lowercase()
+                    .lowercase()
-                .length(24)
+                    .length(24)
-                .required(),
+                    .required(),
-            sess: Joi.string().max(255),
+                sess: Joi.string().max(255),
-            ip: Joi.string().ip({
+                ip: Joi.string().ip({
-                version: ['ipv4', 'ipv6'],
+                    version: ['ipv4', 'ipv6'],
-                cidr: 'forbidden'
+                    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();
-        }
 
-        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 (result.error) {
-            if (err) {
+                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();
-        });
+        })
-    });
+    );
 };

lib/api/domainaliases.js

@@ -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(
             {

lib/dkim-handler.js

@@ -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);
             }