All files / src FlowDefinitions.ts

100% Statements 1/1
100% Branches 0/0
100% Functions 0/0
100% Lines 1/1

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                              1x                                                                                                                                                                                                        
/* 
  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.
*/
export const FLOW_TARGET_TYPES_STR = [
  "SinglePort",
  "Any",
  "PortRange",
] as const;
 
export type FlowPortType = typeof FLOW_TARGET_TYPES_STR[number];
 
export type FlowObjectType = "Address" | "Cidr" | "Arn" | "Tagged" | "Lambda";
 
export type FlowRuleProtocol = "tcp" | "udp" | "icmp";
 
export type FlowRuleStatus = "ACTIVE" | "PENDING" | "FAILED";
 
export type RuleOptionPair = { key: string; value?: string | number };
 
export interface FlowRule {
  id: string;
  version: number;
  lastUpdated?: string;
  protocol: FlowRuleProtocol;
  action: string;
  source: string;
  sourcePort: FlowRulePort;
  destination: string;
  destinationPort: FlowRulePort;
  ruleBundleId: string;
  suricataString?: string;
  status: FlowRuleStatus;
  failureReasons?: string[];
  optionFields?: RuleOptionPair[];
}
 
export interface FlowRuleBundle {
  id: string;
  version: number;
  ruleGroupArn: string;
  description: string;
  ownerGroup: string[];
  aggregatorName?: string;
}
 
export interface FlowRulePort {
  type: FlowPortType;
  value?: string;
}
 
export interface TaggedTargetValue {
  key: string;
  value: string;
}
 
export interface FlowObject {
  id: string;
  type: FlowObjectType;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  value: any;
  createdBy?: string;
  lastUpdated?: string;
}
 
export interface ResolvedFlowRule {
  id: string;
  action: string;
  source: FlowObject;
  destination: FlowObject;
  suricataString?: string;
}
 
export interface ResolvedFlowObject extends FlowObject {
  addresses: string[];
  failureReasons?: string[];
}
 
export interface RuleApplicationResult {
  message: string;
  ruleBundleIds?: string[];
}
 
export type AuditChangeResult = "SUCCESS" | "REJECTED";
 
export type AuditChangeType = "CREATE" | "UPDATE" | "DELETE";
 
export interface FlowAudit {
  id: string;
  requestedBy: string;
  requestedTimestamp: string; //ISO time
  flowRuleGroupId?: string;
  flowRuleId?: string;
  flowTargetId?: string;
  requestedChange: {
    type: AuditChangeType;
    changeContent: {
      originalObject?: FlowRule | FlowObject;
      requestedObject: FlowRule | FlowObject;
    };
    changeResult: AuditChangeResult;
    reasonPhrase: string[];
  };
}