@crdtech/auth-utils v0.4.14

Permission Levels

Permission digunakan sebagai pembatasan dalam melakukan kegiatan. Permission menggunakan sistem whitelist, artinya apabila tidak memiliki permission maka tidak dapat melakukan kegiatan apapun. Permission terbagi tiga:

1. Global Permission paling tinggi. Muncul di root payload jwt setelah melalui middleware. Biasanya hanya dimiliki super admin.

2. Organization Ada di organization dalam field role_binding. Permission ini dibutuhkan untuk melakukan perubahan di level organization.

3. Group Ada di group dalam field role_binding. Permission ini dibutuhkan untuk melakukan perubahan di level group.

Untuk mengedit group membutuhkan permission di level group, tidak cukup hanya dengan permission di level organization

middleware.access

Middleware untuk pengecekan permission saat mengakses suatu route. Middleware akan mengembalikan error apabila permission yang diinginkan route tidak sesuai. Middleware akan membiarkan lewat selama memiliki permission level apapun.

middleware.globalAccess

Sama seperti middleware.globalAccess. Bedanya adalah middleware ini akan mengembalikan error apabila tidak ditemukan permisssion level global yang sesuai, meskipun memiliki permission level organization dan group.

libs.permission.validate

Function untuk pengecekan permission user.

Parameter pertama adalah req.permission yang didapat dari middleware.access atau middleware.globalAccess. req.permission berbentuk rangkuman dari permission yang dimiliki user. Rangkuman ini untuk memudahkan pengecekan.

Parameter kedua terdiri dari organization ID yang ingin dicek dan group list (opsional). Group list ini untuk mengecek permission level group. Apabila user hanya memiliki sebagian permission group dari semua permission group yang sedang dicek, maka pengecekan akan dianggap gagal.

Function ini mengembalikan value true atau false.

Contoh:

validate({
    global: false,
    organizations: {
        "001": {
            organization: false,
            groupList: [
                "myGroup-002",
                "myGroup-004"
            ]
        }
    }
}, {
    organizationId: "001",
    groupList: [
        "myGroup-001",
        "myGroup-003"
    ]
}).then(function(hasAccess){
    // hasAccess memiliki value true atau false
});

libs.filterFromReq

Function untuk mengkonversi filter dalam request menjadi filter dalam format MongoDB.

Parameter pertama merupakan req dari expressjs.

Parameter kedua adalah nama permission.

Parameter ketiga adalah allowKey atau nama field yang diperbolehkan menjadi key dalam filter.

Parameter keempat (opsional) adalah mapKey yaitu untuk melakukan mapping key organizationId dan groupList apabila namanya berbeda dengan yang ada di MongoDB.

Function ini mengembalikan query untuk filter MongoDB.

Contoh:

filterFromReq(
    {
        permission: {
            ["create_access"]: {
                global: false,
                organizations: {
                    "001": {
                        organization: false,
                        groupList: [
                            "001",
                            "002",
                            "003"
                        ]
                    }
                }
            }
        },
        query: {
            filter: [
                "name|=|luke"
            ]
        }
    },
    "create_access",
    {
        "name": "name",
        "organization_id": "organization_id",
        "custom_organization_id": "map_organization_id",
        "groups": "groups",
        "custom_groups": "map_groups",
        "address": "address"
    },
    {
        mapKey: {
            organizationId: "custom_organization_id",
            groupList: "custom_groups"
        }
    }
);

// function di atas akan mengembalikan:
{
    "name": {
        "$eq": "luke"
    },
    "map_organization_id": {
        "$eq": "001"
    },
    "map_groups": {
        "$in": [
            "001",
            "002",
            "003"
        ]
    }
}