Skip to content

Commit

Permalink
feat(client-network-firewall): You can now log events that are relate…
Browse files Browse the repository at this point in the history 
…d to TLS inspection, in addition to the existing alert and flow logging.
  • Loading branch information
awstools committed Jul 25, 2024
1 parent 2e67698 commit ab0e00e
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 28 deletions.
3 changes: 1 addition & 2 deletions clients/client-network-firewall/src/commands/CreateTLSInspectionConfigurationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ export interface CreateTLSInspectionConfigurationCommandOutput
__MetadataBearer {}

/**
* <p>Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains Certificate Manager certificate associations between and the scope configurations that Network Firewall uses to decrypt and re-encrypt traffic traveling through your firewall.</p>
* <p>After you create a TLS inspection configuration, you can associate it with a new firewall policy.</p>
* <p>Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.</p>
* <p>To update the settings for a TLS inspection configuration, use <a>UpdateTLSInspectionConfiguration</a>.</p>
* <p>To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, <a>ListTagsForResource</a>, <a>TagResource</a>, and <a>UntagResource</a>.</p>
* <p>To retrieve information about TLS inspection configurations, use <a>ListTLSInspectionConfigurations</a> and <a>DescribeTLSInspectionConfiguration</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-network-firewall/src/commands/DescribeLoggingConfigurationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export interface DescribeLoggingConfigurationCommandOutput
* // LoggingConfiguration: { // LoggingConfiguration
* // LogDestinationConfigs: [ // LogDestinationConfigs // required
* // { // LogDestinationConfig
* // LogType: "ALERT" || "FLOW", // required
* // LogType: "ALERT" || "FLOW" || "TLS", // required
* // LogDestinationType: "S3" || "CloudWatchLogs" || "KinesisDataFirehose", // required
* // LogDestination: { // LogDestinationMap // required
* // "<keys>": "STRING_VALUE",
Expand Down
4 changes: 2 additions & 2 deletions clients/client-network-firewall/src/commands/UpdateLoggingConfigurationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingCo
* LoggingConfiguration: { // LoggingConfiguration
* LogDestinationConfigs: [ // LogDestinationConfigs // required
* { // LogDestinationConfig
* LogType: "ALERT" || "FLOW", // required
* LogType: "ALERT" || "FLOW" || "TLS", // required
* LogDestinationType: "S3" || "CloudWatchLogs" || "KinesisDataFirehose", // required
* LogDestination: { // LogDestinationMap // required
* "<keys>": "STRING_VALUE",
Expand All @@ -83,7 +83,7 @@ export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingCo
* // LoggingConfiguration: { // LoggingConfiguration
* // LogDestinationConfigs: [ // LogDestinationConfigs // required
* // { // LogDestinationConfig
* // LogType: "ALERT" || "FLOW", // required
* // LogType: "ALERT" || "FLOW" || "TLS", // required
* // LogDestinationType: "S3" || "CloudWatchLogs" || "KinesisDataFirehose", // required
* // LogDestination: { // LogDestinationMap // required
* // "<keys>": "STRING_VALUE",
Expand Down
47 changes: 32 additions & 15 deletions clients/client-network-firewall/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1618,7 +1618,8 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
/**
* <p>Stateful inspection criteria for a domain list rule group. </p>
* <p>For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.</p>
* <p>By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the <code>HOME_NET</code> rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see <a>RuleVariables</a> in this guide and <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html">Stateful domain list rule groups in Network Firewall</a> in the <i>Network Firewall Developer Guide</i>.</p>
* <p>By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the <code>HOME_NET</code> rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see <a>RuleVariables</a> in this guide and
* <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html">Stateful domain list rule groups in Network Firewall</a> in the <i>Network Firewall Developer Guide</i>.</p>
* @public
*/
export interface RulesSourceList {
Expand Down Expand Up @@ -1852,6 +1853,10 @@ export interface StatefulRule {
* can enable the rule with <code>ALERT</code> action, verify in the logs that the rule
* is filtering as you want, then change the action to <code>DROP</code>.</p>
* </li>
* <li>
* <p>
* <b>REJECT</b> - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.</p>
* </li>
* </ul>
* @public
*/
Expand Down Expand Up @@ -2343,8 +2348,7 @@ export interface CreateRuleGroupRequest {
* <p>
* <b>Capacity for a stateful rule group</b>
* </p>
* <p>For
* a stateful rule group, the minimum capacity required is the number of individual rules that
* <p>For a stateful rule group, the minimum capacity required is the number of individual rules that
* you expect to have in the rule group. </p>
* @public
*/
Expand Down Expand Up @@ -3081,6 +3085,7 @@ export type LogDestinationType = (typeof LogDestinationType)[keyof typeof LogDes
export const LogType = {
ALERT: "ALERT",
FLOW: "FLOW",
TLS: "TLS",
} as const;

/**
Expand All @@ -3090,24 +3095,37 @@ export type LogType = (typeof LogType)[keyof typeof LogType];

/**
* <p>Defines where Network Firewall sends logs for the firewall for one log type. This is used
* in <a>LoggingConfiguration</a>. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.</p>
* <p>Network Firewall generates logs for stateful rule groups. You can save alert and flow log
* types. The stateful rules engine records flow logs for all network traffic that it receives.
* It records alert logs for traffic that matches stateful rules that have the rule
* action set to <code>DROP</code> or <code>ALERT</code>. </p>
* in <a>LoggingConfiguration</a>. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.</p>
* <p>Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log
* types. </p>
* @public
*/
export interface LogDestinationConfig {
/**
* <p>The type of log to send. Alert logs report traffic that matches a <a>StatefulRule</a> with an action setting that sends an alert log message. Flow logs are
* standard network traffic flow logs. </p>
* <p>The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.</p>
* <ul>
* <li>
* <p>
* <code>ALERT</code> - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see <a>StatefulRule</a>.</p>
* </li>
* <li>
* <p>
* <code>FLOW</code> - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.</p>
* </li>
* <li>
* <p>
* <code>TLS</code> - Logs for events that are related to TLS inspection. For more information, see
* <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-configurations.html">Inspecting SSL/TLS traffic with TLS inspection configurations</a>
* in the <i>Network Firewall Developer Guide</i>.</p>
* </li>
* </ul>
* @public
*/
LogType: LogType | undefined;

/**
* <p>The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket,
* a CloudWatch log group, or a Kinesis Data Firehose delivery stream.</p>
* a CloudWatch log group, or a Firehose delivery stream.</p>
* @public
*/
LogDestinationType: LogDestinationType | undefined;
Expand All @@ -3118,9 +3136,8 @@ export interface LogDestinationConfig {
* <ul>
* <li>
* <p>For an Amazon S3 bucket, provide the name of the bucket, with key <code>bucketName</code>,
* and optionally provide a prefix, with key <code>prefix</code>. The following example
* specifies an Amazon S3 bucket named
* <code>DOC-EXAMPLE-BUCKET</code> and the prefix <code>alerts</code>: </p>
* and optionally provide a prefix, with key <code>prefix</code>. </p>
* <p>The following example specifies an Amazon S3 bucket named <code>DOC-EXAMPLE-BUCKET</code> and the prefix <code>alerts</code>: </p>
* <p>
* <code>"LogDestination": \{ "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts"
* \}</code>
Expand All @@ -3135,7 +3152,7 @@ export interface LogDestinationConfig {
* </p>
* </li>
* <li>
* <p>For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key
* <p>For a Firehose delivery stream, provide the name of the delivery stream, with key
* <code>deliveryStream</code>. The following example specifies a delivery stream
* named <code>alert-delivery-stream</code>: </p>
* <p>
Expand Down
Loading

0 comments on commit ab0e00e

Please sign in to comment.