Merge pull request #2061 from AkhtarAmir/H-plugin/aws-qldb-ledger-del…

…etion-protection

H-plugin QLDB Ledger Deletion Protection Enabled

exports.js

@@ -498,6 +498,7 @@ module.exports = {
         'ssmSessionDuration'            : require(__dirname + '/plugins/aws/ssm/ssmSessionDuration'),
 
         'ledgerEncrypted'               : require(__dirname + '/plugins/aws/qldb/ledgerEncrypted'),
+        'ledgerDeletionProtection'      : require(__dirname + '/plugins/aws/qldb/ledgerDeletionProtection'),
 
         'lambdaAdminPrivileges'         : require(__dirname + '/plugins/aws/lambda/lambdaAdminPrivileges.js'),
         'envVarsClientSideEncryption'   : require(__dirname + '/plugins/aws/lambda/envVarsClientSideEncryption.js'),

plugins/aws/qldb/ledgerDeletionProtection.js

@@ -0,0 +1,73 @@
+var async = require('async');
+var helpers = require('../../../helpers/aws');
+
+module.exports = {
+    title: 'Ledger Deletion Protection',
+    category: 'QLDB',
+    domain: 'Databases',
+    severity: 'Medium',
+    description: 'Ensures that AWS QLDB ledger has deletion protection feature enabled.',
+    more_info: 'Enabling deletion protection for an Amazon QLDB ledger prevents accidental or unauthorized deletions, ensuring the ledger remains secure and accessible. It requires explicit action to disable this protection before the ledger can be deleted.',
+    recommended_action: 'Modify QLDB ledger and enable deletion protection.',
+    link: 'https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html',
+    apis: ['QLDB:listLedgers','QLDB:describeLedger','STS:getCallerIdentity'],
+    realtime_triggers: ['qldb:CreateLedger', 'qldb:UpdateLedger', 'qldb:DeleteLedger'], 
+
+    run: function(cache, settings, callback) {
+        var results = [];
+        var source = {};
+        var regions = helpers.regions(settings);
+
+        var defaultRegion = helpers.defaultRegion(settings);
+        var awsOrGov = helpers.defaultPartition(settings);
+        var accountId = helpers.addSource(cache, source, ['sts', 'getCallerIdentity', defaultRegion, 'data']);
+
+        async.each(regions.qldb, function(region, rcb){        
+            var listLedgers = helpers.addSource(cache, source,
+                ['qldb', 'listLedgers', region]);
+
+            if (!listLedgers) return rcb();
+
+            if (listLedgers.err || !listLedgers.data) {
+                helpers.addResult(results, 3,
+                    'Unable to query QLDB ledgers: ' + helpers.addError(listLedgers), region);
+                return rcb();
+            }
+
+            if (!listLedgers.data.length) {
+                helpers.addResult(results, 0, 'No QLDB ledgers found', region);
+                return rcb();
+            }
+
+            for (let ledger of listLedgers.data) {
+                if (!ledger.Name) continue;
+
+                let resource = `arn:${awsOrGov}:qldb:${region}:${accountId}:ledger/${ledger.Name}`;
+
+                var describeLedger = helpers.addSource(cache, source,
+                    ['qldb', 'describeLedger', region, ledger.Name]);
+
+                if (!describeLedger || describeLedger.err || !describeLedger.data ) {
+                    helpers.addResult(results, 3,
+                        `Unable to get QLDB ledgers description: ${helpers.addError(describeLedger)}`,
+                        region, resource);
+                    continue;
+                } 
+
+                if (describeLedger.data.DeletionProtection) {
+                    helpers.addResult(results, 0,
+                        'QLDB ledger has deletion protection enabled',
+                        region, resource);
+                } else {
+                    helpers.addResult(results, 2,
+                        'QLDB ledger does not have deletion protection enabled',
+                        region, resource);
+                }
+            }
+
+            rcb();
+        }, function(){
+            callback(null, results, source);
+        });
+    }
+};

plugins/aws/qldb/ledgerDeletionProtection.spec.js

@@ -0,0 +1,100 @@
+var expect = require('chai').expect;
+var ledgerDeletionProtection = require('./ledgerDeletionProtection');
+
+const listLedgers = [   
+    {
+        "Name": "test-ledger",
+        "State": "ACTIVE",
+        "CreationDateTime": "2021-11-19T16:29:08.899000+05:00" 
+    } 
+];
+
+const describeLedger = [
+    {
+        "Name": "test-ledger",
+        "Arn": "arn:aws:qldb:us-east-1:000111222333:ledger/test-ledger",
+        "State": "ACTIVE",
+        "CreationDateTime": "2021-11-19T16:29:08.899000+05:00",
+        "PermissionsMode": "STANDARD",
+        "DeletionProtection": true,
+    },
+    {
+        "Name": "test-ledger",
+        "Arn": "arn:aws:qldb:us-east-1:000111222333:ledger/test-ledger",
+        "State": "ACTIVE",
+        "CreationDateTime": "2021-11-19T16:29:08.899000+05:00",
+        "PermissionsMode": "STANDARD",
+        "DeletionProtection": false,
+    }
+];
+
+const createCache = (ledgers, describeLedger, ledgersErr, describeLedgerErr) => {
+    var name = (ledgers && ledgers.length) ? ledgers[0].Name: null;
+    return {
+        qldb: {
+            listLedgers: {
+                'us-east-1': {
+                    err: ledgersErr,
+                    data: ledgers
+                },
+            },
+            describeLedger: {
+                'us-east-1': {
+                    [name]: {
+                        data: describeLedger,
+                        err: describeLedgerErr
+                    }
+                }
+            }
+        },
+    };
+};
+
+describe('ledgerDeletionProtection', function () {
+    describe('run', function () {
+        it('should PASS if QLDB ledger has deletion protection enabled', function (done) {
+            const cache = createCache(listLedgers, describeLedger[0]);
+            ledgerDeletionProtection.run(cache, {}, (err, results) => {
+                expect(results.length).to.equal(1);
+                expect(results[0].status).to.equal(0);
+                expect(results[0].region).to.equal('us-east-1');
+                expect(results[0].message).to.include('QLDB ledger has deletion protection enabled');
+                done();
+            });
+        });
+
+        it('should FAIL if QLDb ledger does not have deletion protection enabled', function (done) {
+            const cache = createCache(listLedgers, describeLedger[1]);
+            ledgerDeletionProtection.run(cache, {}, (err, results) => {
+                expect(results.length).to.equal(1);
+                expect(results[0].status).to.equal(2);
+                expect(results[0].region).to.equal('us-east-1');
+                expect(results[0].message).to.include('QLDB ledger does not have deletion protection enabled');
+                done();
+            });
+        });
+
+        it('should PASS if no QLDB ledgers found', function (done) {
+            const cache = createCache([]);
+            ledgerDeletionProtection.run(cache, {}, (err, results) => {
+                expect(results.length).to.equal(1);
+                expect(results[0].status).to.equal(0);
+                expect(results[0].region).to.equal('us-east-1');
+                expect(results[0].message).to.include('No QLDB ledgers found');
+                done();
+            });
+        });
+
+        it('should UNKNOWN if unable to list QLDB ledgers', function (done) {
+            const cache = createCache(null, null, null, { message: "Unable to list QLDB ledgers" });
+            ledgerDeletionProtection.run(cache, {}, (err, results) => {
+                expect(results.length).to.equal(1);
+                expect(results[0].status).to.equal(3);
+                expect(results[0].region).to.equal('us-east-1');
+                expect(results[0].message).to.include('Unable to query QLDB ledgers');
+                done();
+            });
+        });
+
+    });
+})