@aeriajs/security 0.0.0

package/dist/ownership.mjs

@@ -0,0 +1,180 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+import { ACErrors } from "@aeriajs/types";
+import { left, right } from "@aeriajs/common";
+export var checkOwnershipRead = function() {
+    var _ref = _async_to_generator(function(props, context) {
+        var token, description, payload;
+        return _ts_generator(this, function(_state) {
+            token = context.token, description = context.description;
+            payload = Object.assign({}, props.payload);
+            if (token.authenticated && description.owned) {
+                if (!token.roles.includes("root")) {
+                    payload.filters.owner = token.sub;
+                }
+            }
+            return [
+                2,
+                right(payload)
+            ];
+        });
+    });
+    return function checkOwnershipRead(props, context) {
+        return _ref.apply(this, arguments);
+    };
+}();
+export var checkOwnershipWrite = function() {
+    var _ref = _async_to_generator(function(props, context) {
+        var token, description, parentId, payload;
+        return _ts_generator(this, function(_state) {
+            token = context.token, description = context.description;
+            parentId = props.parentId;
+            payload = Object.assign({}, props.payload);
+            if (token.authenticated && description.owned) {
+                if (!payload.what._id || description.owned === "always") {
+                    payload.what.owner = token.sub;
+                } else {
+                    return [
+                        2,
+                        right(payload)
+                    ];
+                }
+            }
+            if (!payload.what.owner && !parentId && context.description.owned) {
+                return [
+                    2,
+                    left(ACErrors.OwnershipError)
+                ];
+            }
+            return [
+                2,
+                right(payload)
+            ];
+        });
+    });
+    return function checkOwnershipWrite(props, context) {
+        return _ref.apply(this, arguments);
+    };
+}();

package/dist/pagination.d.ts

@@ -0,0 +1,3 @@
+import type { SecurityCheckProps, SecurityCheckReadPayload } from './types.js';
+import { ACErrors } from '@aeriajs/types';
+export declare const checkPagination: (props: SecurityCheckProps<SecurityCheckReadPayload>) => Promise<import("@aeriajs/types").Right<SecurityCheckReadPayload> | import("@aeriajs/types").Left<ACErrors.InvalidLimit>>;

package/dist/pagination.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkPagination = void 0;
+const types_1 = require("@aeriajs/types");
+const common_1 = require("@aeriajs/common");
+const checkPagination = async (props) => {
+    const { payload } = props;
+    if (payload.limit) {
+        if (payload.limit <= 0 || payload.limit > 150) {
+            return (0, common_1.left)(types_1.ACErrors.InvalidLimit);
+        }
+    }
+    return (0, common_1.right)(payload);
+};
+exports.checkPagination = checkPagination;

package/dist/pagination.mjs

@@ -0,0 +1,149 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+import { ACErrors } from "@aeriajs/types";
+import { left, right } from "@aeriajs/common";
+export var checkPagination = function() {
+    var _ref = _async_to_generator(function(props) {
+        var payload;
+        return _ts_generator(this, function(_state) {
+            payload = props.payload;
+            if (payload.limit) {
+                if (payload.limit <= 0 || payload.limit > 150) {
+                    return [
+                        2,
+                        left(ACErrors.InvalidLimit)
+                    ];
+                }
+            }
+            return [
+                2,
+                right(payload)
+            ];
+        });
+    });
+    return function checkPagination(props) {
+        return _ref.apply(this, arguments);
+    };
+}();

package/dist/rateLimiting.d.ts

@@ -0,0 +1,6 @@
+import type { Context, Description, RateLimitingParams } from '@aeriajs/types';
+export declare enum RateLimitingErrors {
+    Unauthenticated = "UNAUTHENTICATED",
+    LimitReached = "LIMIT_REACHED"
+}
+export declare const limitRate: <TDescription extends Description>(context: Context<TDescription>, params: RateLimitingParams) => Promise<import("@aeriajs/types").Left<RateLimitingErrors.Unauthenticated> | import("@aeriajs/types").Right<null> | import("@aeriajs/types").Left<RateLimitingErrors.LimitReached>>;

package/dist/rateLimiting.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.limitRate = exports.RateLimitingErrors = void 0;
+const common_1 = require("@aeriajs/common");
+var RateLimitingErrors;
+(function (RateLimitingErrors) {
+    RateLimitingErrors["Unauthenticated"] = "UNAUTHENTICATED";
+    RateLimitingErrors["LimitReached"] = "LIMIT_REACHED";
+})(RateLimitingErrors || (exports.RateLimitingErrors = RateLimitingErrors = {}));
+const getUser = (context) => {
+    if (!context.token.authenticated) {
+        throw new Error();
+    }
+    return context.collections.user.model.findOne({
+        _id: context.token.sub,
+    }, {
+        resources_usage: 1,
+    });
+};
+const limitRate = async (context, params) => {
+    let user;
+    if (!context.token.authenticated || !(user = await getUser(context))) {
+        return (0, common_1.left)(RateLimitingErrors.Unauthenticated);
+    }
+    const { increment = 1, limit, scale, } = params;
+    const payload = {
+        $inc: {
+            hits: increment,
+        },
+        $set: {},
+    };
+    const usage = user.resources_usage?.get(context.functionPath);
+    if (!usage) {
+        const entry = await context.collections.resourceUsage.model.insertOne({
+            hits: increment,
+        });
+        await context.collections.user.model.updateOne({
+            _id: user._id,
+        }, {
+            $set: {
+                [`resources_usage.${context.functionPath}`]: entry.insertedId,
+            },
+        });
+        return (0, common_1.right)(null);
+    }
+    if (scale && (new Date().getTime() / 1000 - usage.updated_at.getTime() / 1000 < scale)) {
+        return (0, common_1.left)(RateLimitingErrors.LimitReached);
+    }
+    if (limit && (usage.hits % limit === 0)) {
+        payload.$set = {
+            last_maximum_reach: new Date(),
+        };
+    }
+    await context.collections.resourceUsage.model.updateOne({
+        _id: usage._id,
+    }, payload);
+    return (0, common_1.right)(null);
+};
+exports.limitRate = limitRate;

package/dist/rateLimiting.mjs

@@ -0,0 +1,243 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+import { left, right } from "@aeriajs/common";
+export var RateLimitingErrors;
+(function(RateLimitingErrors) {
+    RateLimitingErrors["Unauthenticated"] = "UNAUTHENTICATED";
+    RateLimitingErrors["LimitReached"] = "LIMIT_REACHED";
+})(RateLimitingErrors || (RateLimitingErrors = {}));
+var getUser = function(context) {
+    if (!context.token.authenticated) {
+        throw new Error();
+    }
+    return context.collections.user.model.findOne({
+        _id: context.token.sub
+    }, {
+        resources_usage: 1
+    });
+};
+export var limitRate = function() {
+    var _ref = _async_to_generator(function(context, params) {
+        var _user_resources_usage, user, _tmp, _params_increment, increment, limit, scale, payload, usage, entry;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    _tmp = !context.token.authenticated;
+                    if (_tmp) return [
+                        3,
+                        2
+                    ];
+                    return [
+                        4,
+                        getUser(context)
+                    ];
+                case 1:
+                    _tmp = !(user = _state.sent());
+                    _state.label = 2;
+                case 2:
+                    if (_tmp) {
+                        return [
+                            2,
+                            left("UNAUTHENTICATED")
+                        ];
+                    }
+                    _params_increment = params.increment, increment = _params_increment === void 0 ? 1 : _params_increment, limit = params.limit, scale = params.scale;
+                    payload = {
+                        $inc: {
+                            hits: increment
+                        },
+                        $set: {}
+                    };
+                    usage = (_user_resources_usage = user.resources_usage) === null || _user_resources_usage === void 0 ? void 0 : _user_resources_usage.get(context.functionPath);
+                    if (!!usage) return [
+                        3,
+                        5
+                    ];
+                    return [
+                        4,
+                        context.collections.resourceUsage.model.insertOne({
+                            hits: increment
+                        })
+                    ];
+                case 3:
+                    entry = _state.sent();
+                    return [
+                        4,
+                        context.collections.user.model.updateOne({
+                            _id: user._id
+                        }, {
+                            $set: _define_property({}, "resources_usage.".concat(context.functionPath), entry.insertedId)
+                        })
+                    ];
+                case 4:
+                    _state.sent();
+                    return [
+                        2,
+                        right(null)
+                    ];
+                case 5:
+                    if (scale && new Date().getTime() / 1000 - usage.updated_at.getTime() / 1000 < scale) {
+                        return [
+                            2,
+                            left("LIMIT_REACHED")
+                        ];
+                    }
+                    if (limit && usage.hits % limit === 0) {
+                        payload.$set = {
+                            last_maximum_reach: new Date()
+                        };
+                    }
+                    return [
+                        4,
+                        context.collections.resourceUsage.model.updateOne({
+                            _id: usage._id
+                        }, payload)
+                    ];
+                case 6:
+                    _state.sent();
+                    return [
+                        2,
+                        right(null)
+                    ];
+            }
+        });
+    });
+    return function limitRate(context, params) {
+        return _ref.apply(this, arguments);
+    };
+}();

package/dist/types.d.ts

@@ -0,0 +1,17 @@
+import type { Context, Either, GetAllPayload, InsertPayload, ACErrors } from '@aeriajs/types';
+export type SecurityCheckReadPayload = {
+    filters: Record<string, any>;
+    sort?: Record<string, any>;
+    limit?: number;
+    offset?: number;
+};
+export type SecurityCheckWritePayload = {
+    what: Record<string, any>;
+};
+export type SecurityCheckProps<TPayload extends Record<string, any> = any> = {
+    propertyName?: string;
+    parentId?: string;
+    childId?: string;
+    payload: TPayload;
+};
+export type SecurityCheck = (props: SecurityCheckProps, context: Context) => Promise<Either<ACErrors, GetAllPayload<any> | InsertPayload<any>>>;

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.mjs

@@ -0,0 +1 @@
+export { };

package/dist/use.d.ts

@@ -0,0 +1,5 @@
+import type { Context, Description, GetAllPayload, InsertPayload } from '@aeriajs/types';
+export declare const useSecurity: <TDescription extends Description>(context: Context<TDescription>) => {
+    beforeRead: <TPayload extends Partial<GetAllPayload<any>>>(payload?: TPayload | undefined) => Promise<import("@aeriajs/types").Left<import("@aeriajs/types").ACErrors> | import("@aeriajs/types").Right<Record<string, any>>>;
+    beforeWrite: <TPayload_1 extends Partial<InsertPayload<any>>>(payload?: TPayload_1 | undefined) => Promise<import("@aeriajs/types").Left<import("@aeriajs/types").ACErrors> | import("@aeriajs/types").Right<Record<string, any>>>;
+};