All files / handlers/rules ListRulesHandler.ts

96.97% Statements 32/33
81.48% Branches 22/27
100% Functions 2/2
100% Lines 30/30

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129                                        1x 1x 1x 1x 1x   1x                                                                                       1x         1x 1x   1x               4x 4x   4x 4x 3x   4x     4x 4x 4x 1x 1x                 3x 3x 3x 3x 1x 1x     2x         2x   2x        
/* 
  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  
  Licensed under the Apache License, Version 2.0 (the "License").
  You may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
      http://www.apache.org/licenses/LICENSE-2.0
  
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/
 
// import { build, parse } from "@aws-sdk/util-arn-parser";
import { APIGatewayProxyEvent, Context } from 'aws-lambda';
import { Logger, LoggerFactory } from 'shared_types';
import { AsyncRequestHandler } from 'src/common/AsyncRequestHandler';
import RuleConfigError from 'src/common/RuleConfigError';
import { ServerlessResponse } from 'src/common/ServerlessResponse';
import { RulesDataSourceService } from 'src/service/RulesDataSourceService';
import { RuleGroupAuthenticationValidator } from 'src/validators/RuleGroupAuthenticationValidator';
import { inject, injectable } from 'tsyringe';
 
const MAX_NUM_RESULTS = 100;
/**
 * @api {get} /rulegroups/{id}/rules List rules
 * @apiGroup Rule
 * @apiDescription List rule groups belongs to requestor's arn
 * @apiVersion 1.0.0
 * @apiExample {curl} CURL Example:
 curl --location --request GET 'https://<rest_api_id>.execute-api.ap-southeast-2.amazonaws.com/prod/rulegroups/rulegroup_id/rules'
* @apiParam (Optional Query Parameters) {number{1-100}} [limit=100] The number of object per page.
* @apiParam (Optional Query Parameters) {string} [nextToken] The pagination token.
* @apiSuccess (Success 200) Object results
* @apiError (Error 502) Timeout Service timed out
* @apiError (Error 503) InternalError Internal error occurred 
* 
* @apiSuccessExample Success-Response: 
*      HTTP/1.1 200 OK
*  {
    "results": [
        {
            "id": "rule_id",
            "version": 536,
            "lastUpdated": "2021-09-15T02:53:53.754Z",
            "action": "drop",
            "protocol": "udp",
            "status": "ACTIVE",
            "ruleGroupId": "rulegroup_id",
            "destination": "Ec2_SUBNET",
            "source": "Onprem_Server",
            "failureReasons": [],
             "destinationPort": {
            "type": "SinglePort",
            "value": '123'
            },
            "sourcePort": {
                "type": "Any"
            },
        }
    ],
    "nextToken": "rule_id_2"
}
* 
* @apiSampleRequest off
*/
@injectable()
export class ListRulesHandler
    implements AsyncRequestHandler<APIGatewayProxyEvent, ServerlessResponse> {
    private readonly logger: Logger;
 
    constructor(@inject('LoggerFactory') loggerFactory: LoggerFactory,
        @inject('RulesDataSourceService') private rulesDataSourceService: RulesDataSourceService,
        @inject('RuleGroupAuthenticationValidator') private ruleGroupAuthenticationValidator: RuleGroupAuthenticationValidator
    ) {
        this.logger = loggerFactory.getLogger('ListRulesHandler');
    }
 
    async handle(
        event: APIGatewayProxyEvent,
        // eslint-disable-next-line @typescript-eslint/no-unused-vars
        _context: Context
    ): Promise<ServerlessResponse> {
        this.logger.info('lambda event', event);
        this.logger.info('lambda event context', _context);
 
        let limit = parseInt(event.queryStringParameters?.limit as string);
        if (!limit || limit <= 0 || limit > MAX_NUM_RESULTS) {
            limit = MAX_NUM_RESULTS;
        }
        this.logger.debug(
            `Listing objects, up to ${limit} objects will be returned.`
        );
        Iif (!event.pathParameters) { return ServerlessResponse.ofError(new RuleConfigError(undefined, 400, false)); }
        const pathRuleGroupId = event.pathParameters['id'];
        if (!pathRuleGroupId) {
            this.logger.error('Rule group id path parameter cannot be null or empty.');
            return ServerlessResponse.ofError(
                new RuleConfigError(
                    'Rule group id path parameter cannot be null or empty.',
                    400,
                    false
                )
            );
        }
     
        const requestorIdentity = event.requestContext.identity?.userArn ?? 'Unkonwn';
        const requestingAccountId = event.requestContext.accountId;
        const errorResposne = await this.ruleGroupAuthenticationValidator.checkRuleGroupAccess(requestorIdentity, pathRuleGroupId, requestingAccountId, 'LIST');
        if (errorResposne) {
            this.logger.error(`Authorization error ${errorResposne.body}`)
            return errorResposne;
        }
 
        const rules = await this.rulesDataSourceService.getRulesByGroupId(
            pathRuleGroupId,
            limit,
            event.queryStringParameters?.nextToken
        );
        this.logger.debug(`Found ${rules.results.length} objects.`);
 
        return ServerlessResponse.ofObject(200, rules);
    }
 
}