All files / handlers/rules CreateRuleHandler.ts

96.23% Statements 51/53
78.13% Branches 25/32
75% Functions 3/4
98% Lines 49/50

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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201                                      1x 1x 1x 1x 1x   1x 1x 1x                                                                                                                             1x         7x 7x 7x 7x 7x   7x               7x 7x 7x 1x 1x               6x 6x   6x 1x 1x                 5x 5x 5x 5x 5x 5x             4x 4x 1x     1x 1x     3x 3x 1x 1x   2x                       2x 2x 1x   1x   1x 1x 1x         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 { APIGatewayProxyEvent, Context } from 'aws-lambda';
import { AuditChangeResult, FlowAudit, FlowRule, Logger, LoggerFactory } from 'shared_types';
import { AsyncRequestHandler } from 'src/common/AsyncRequestHandler';
import RuleConfigError from 'src/common/RuleConfigError';
import { ServerlessResponse } from 'src/common/ServerlessResponse';
import { AuditsDataSourceService } from 'src/service/AuditsDataSourceService';
import { OpaPolicyService } from 'src/service/OpaPolicyService';
import { RulesDataSourceService } from 'src/service/RulesDataSourceService';
import { CreateFlowRuleInput } from 'src/types/FlowRule';
import { CreateRuleInputValidator } from 'src/validators/CreateRuletInputValidator';
import { RuleGroupAuthenticationValidator } from 'src/validators/RuleGroupAuthenticationValidator';
import { inject, injectable } from 'tsyringe';
 
 
/**
 * @api {post} /rulegroups/{id}/rules Create new rule
 * @apiGroup Rule
 * @apiDescription Create new rule in a rule group referencing a cloud resource or fixed resource
 * @apiVersion 1.0.0
 *  @apiExample {curl} CURL Example:
 curl --location --request POST 'https://<rest_api_id>.execute-api.ap-southeast-2.amazonaws.com/prod/rulegroups/demo-group-group/rules' --data-raw '{
  "action": "drop",
  "destination": "Onprem_Server",
  "protocol": "tcp",
  "ruleGroupId": "demo-group-group",
  "source": "Ec2_Arn_DEMO",
    "destinationPort": {
        "type": "SinglePort",
        "value": '123'
    },
    "sourcePort": {
        "type": "Any"
    },
}'
* @apiSuccess (Success 201) Rule created
* @apiParam {string} protocol The protocol for this rule supported tcp | udp | icmp
* @apiParam {string}  action The action specified for this rule supported drop | pass | alert
* @apiParam {string}  source The object's id as a source of this rule
* @apiParam {string}  destination The object's id as a destination of this rule
* @apiParam {string}  ruleGroupId The group ID this rule attaches to
* @apiError (Error 400) BadRequest Rule group id path parameter cannot be null or empty
* @apiError (Error 400) BadRequest Rule group id path parameter does not match request body groupId
* @apiError (Error 400) BadRequest Referenced object does not exists
* @apiError (Error 400) BadRequest RuleGroup  does not exists
* @apiError (Error 403) Forbidden Requestor's arn is not authorized to perform this action
* @apiError (Error 500) RemoteError Unable to determine user accessibility
* @apiError (Error 500) RemoteError Error while creating rule object
* 
* @apiSuccessExample Success-Response: 
*      HTTP/1.1 201 OK
*  {
    "rule": {
        "protocol": "tcp",
        "action": "drop",
        "source": "Ec2_Arn_DEMO",
        "destination": "Onprem_Server",
        "status": "PENDING",
        "ruleGroupId": "integration-CRUD-test-group-4dadbfc5-58f2-4e3d-a9bc-193753a49a23",
        "lastUpdated": "2021-09-16T23:11:56.198Z",
        "id": "88bc676a-4917-490e-92ab-610a545c5baf",
        "destinationPort": {
            "type": "SinglePort",
            "value": '123'
            },
        "sourcePort": {
            "type": "Any"
        },
        "version": 0
    }
}
* 
* @apiSampleRequest off
*/
@injectable()
export class CreateRuleHandler
    implements AsyncRequestHandler<APIGatewayProxyEvent, ServerlessResponse> {
    private readonly logger: Logger;
 
    constructor(@inject('LoggerFactory') loggerFactory: LoggerFactory,
        @inject('RulesDataSourceService') private ruleDataSourceService: RulesDataSourceService,
        @inject('AuditsDataSourceService') private auditsDataSourceService: AuditsDataSourceService,
        @inject('CreateRuleInputValidator') private validator: CreateRuleInputValidator,
        @inject('RuleGroupAuthenticationValidator') private ruleGroupAuthenticationValidator: RuleGroupAuthenticationValidator,
        @inject('OpaPolicyService') private opaPolicyService: OpaPolicyService
    ) {
        this.logger = loggerFactory.getLogger('CreateRuleHandler');
    }
 
    async handle(
        event: APIGatewayProxyEvent,
        // eslint-disable-next-line @typescript-eslint/no-unused-vars
        _context: Context
    ): Promise<ServerlessResponse> {
        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
                )
            );
        }
        this.logger.debug('Processing create rule request');
        const input = await this.validator.parseAndValidate(event);
 
        if (input.ruleGroupId != pathRuleGroupId) {
            this.logger.error('Rule group id path parameter does not match request body groupId.',);
            return ServerlessResponse.ofError(
                new RuleConfigError(
                    'Rule group id path parameter does not match request body groupId.',
                    400,
                    false
                )
            );
        }
 
        const requestorIdentity = event.requestContext.identity?.userArn ?? 'Unknown';
        const requestingAccountId = event.requestContext.accountId;
        const accountId = event.requestContext.accountId ?? '100000';
        this.logger.debug('sending request to opa');
        try {
            const response = await this.opaPolicyService.requestDecision({
                "requester": {
                    "arn": requestorIdentity,
                    "accountId": accountId
                }
            }, { rule: input }, 'CREATE')
 
            this.logger.info(' opa decision response', response)
            if (response.status === 'NON_COMPLIANT') {
                return ServerlessResponse.ofObject(400, { message: response.reasonPhrases });
            }
        } catch (e) {
            this.logger.error('opa error', e);
            return ServerlessResponse.ofObject(500, { message: `Unable to determine user accessibility, ${e}` });
        }
 
        const errorResponse = await this.ruleGroupAuthenticationValidator.checkRuleGroupAccess(requestorIdentity, pathRuleGroupId, requestingAccountId, 'CREATE');
        if (errorResponse) {
            this.logger.error(`Authorization error ${errorResponse.body}`)
            return errorResponse;
        }
        const newRule: CreateFlowRuleInput = {
            ...(input.id && { id: input.id }),
            protocol: input.protocol,
            ...(input.optionFields && { optionFields: input.optionFields.map(kp => ({ key: kp.key, ...(kp.value && { value: kp.value }) })) }),
            action: input.action,
            source: input.source,
            sourcePort: input.sourcePort,
            destination: input.destination,
            destinationPort: input.destinationPort,
            status: 'PENDING',
            ruleGroupId: pathRuleGroupId
        }
        try {
            const rule = await this.ruleDataSourceService.createRule(newRule);
            await this.auditEntryForCreation(requestorIdentity, 'SUCCESS', rule);
 
            return ServerlessResponse.ofObject(201, { rule: rule });
        } catch (e) {
            this.logger.error('Error while creating rule object', e, input);
            this.auditEntryForCreation(requestorIdentity, 'REJECTED', input, [e.message]);
            return ServerlessResponse.ofObject(500, { message: 'Error while creating rule object' });
        }
    }
 
    async auditEntryForCreation(requestorIdentity: string, status: AuditChangeResult, object: FlowRule, reasons?: string[]): Promise<FlowAudit> {
        return await this.auditsDataSourceService.createAuditEntry({
            requestedBy: requestorIdentity,
            requestedTimestamp: new Date().toISOString(),
            requestedChange: {
                type: 'CREATE', //CREATE/UPDATE/DELETE
                changeContent: {
                    requestedObject: object,
                },
                changeResult: status, // SUCCESS, REJECTED
                reasonPhrase: reasons ?? []
            }
        })
    }
}