File: //snap/google-cloud-cli/396/lib/surface/compute/security_policies/rules/update.py
# -*- coding: utf-8 -*- #
# Copyright 2017 Google LLC. 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.
"""Command for updating security policies rules."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.compute import base_classes
from googlecloudsdk.api_lib.compute.security_policies import client
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.command_lib.compute import scope as compute_scope
from googlecloudsdk.command_lib.compute.security_policies import flags as security_policy_flags
from googlecloudsdk.command_lib.compute.security_policies import security_policies_utils
from googlecloudsdk.command_lib.compute.security_policies.rules import flags
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
class UpdateHelper(object):
r"""Update a Compute Engine security policy rule.
*{command}* is used to update security policy rules.
## EXAMPLES
To update the description and IP ranges of a rule at priority
1000, run:
$ {command} 1000 \
--security-policy=my-policy \
--description="block 1.2.3.4/32" \
--src-ip-ranges=1.2.3.4/32
"""
@classmethod
def Args(
cls,
parser,
support_fairshare=False,
support_rpc_status=False,
):
"""Generates the flagset for an Update command."""
cls.NAME_ARG = (flags.PriorityArgument('update'))
cls.NAME_ARG.AddArgument(
parser, operation_type='update', cust_metavar='PRIORITY')
flags.AddRegionFlag(parser, 'update')
cls.SECURITY_POLICY_ARG = (
security_policy_flags.SecurityPolicyMultiScopeArgumentForRules()
)
cls.SECURITY_POLICY_ARG.AddArgument(parser)
flags.AddMatcherAndNetworkMatcher(parser, required=False)
flags.AddAction(
parser,
required=False,
support_fairshare=support_fairshare)
flags.AddDescription(parser)
flags.AddPreview(parser, for_update=True)
flags.AddRedirectOptions(parser)
flags.AddRateLimitOptions(
parser,
support_rpc_status=support_rpc_status,
)
flags.AddRequestHeadersToAdd(parser)
flags.AddRecaptchaOptions(parser)
@classmethod
def Run(
cls,
release_track,
args,
support_rpc_status,
):
"""Validates arguments and patches a security policy rule."""
modified_fields = [
args.description,
args.src_ip_ranges,
args.action,
args.preview is not None,
args.network_user_defined_fields,
args.network_src_ip_ranges,
args.network_dest_ip_ranges,
args.network_ip_protocols,
args.network_src_ports,
args.network_dest_ports,
args.network_src_region_codes,
args.network_src_asns,
args.redirect_type,
args.redirect_target,
args.request_headers_to_add,
args.rate_limit_threshold_count,
args.rate_limit_threshold_interval_sec,
args.conform_action,
args.exceed_action,
args.enforce_on_key,
args.enforce_on_key_name,
args.ban_threshold_count,
args.ban_threshold_interval_sec,
args.ban_duration_sec,
args.recaptcha_action_site_keys,
args.recaptcha_session_site_keys,
]
min_args = [
'--description',
'--src-ip-ranges',
'--expression',
'--action',
'--preview',
'--network-user-defined-fields',
'--network-src-ip-ranges',
'--network-dest-ip-ranges',
'--network-ip-protocols',
'--network-src-ports',
'--network-dest-ports',
'--network-src-region-codes',
'--redirect-type',
'--redirect-target',
'--request-headers-to-add',
'--rate-limit-threshold-count',
'--rate-limit-threshold-interval-sec',
'--conform-action',
'--exceed-action',
'--enforce-on-key',
'--enforce-on-key-name',
'--ban-threshold-count',
'--ban-threshold-interval-sec',
'--ban-duration-sec',
'--recaptcha_action_site_keys',
'--recaptcha_session_site_keys',
]
if support_rpc_status:
modified_fields.extend([
args.exceed_action_rpc_status_code,
args.exceed_action_rpc_status_message,
])
min_args.extend([
'--exceed-action-rpc-status-code',
'--exceed-action-rpc-status-message',
])
if not any(
[args.IsSpecified(field[2:].replace('-', '_')) for field in min_args]):
raise exceptions.MinimumArgumentException(
min_args, 'At least one property must be modified.')
holder = base_classes.ComputeApiHolder(release_track)
if args.security_policy:
security_policy_ref = cls.SECURITY_POLICY_ARG.ResolveAsResource(
args,
holder.resources,
default_scope=compute_scope.ScopeEnum.GLOBAL)
if getattr(security_policy_ref, 'region', None) is not None:
ref = holder.resources.Parse(
args.name,
collection='compute.regionSecurityPolicyRules',
params={
'project': properties.VALUES.core.project.GetOrFail,
'region': security_policy_ref.region,
'securityPolicy': args.security_policy,
})
else:
ref = holder.resources.Parse(
args.name,
collection='compute.securityPolicyRules',
params={
'project': properties.VALUES.core.project.GetOrFail,
'securityPolicy': args.security_policy,
},
)
else:
try:
ref = holder.resources.Parse(
args.name,
collection='compute.regionSecurityPolicyRules',
params={
'project': properties.VALUES.core.project.GetOrFail,
'region': getattr(args, 'region', None),
},
)
except (
resources.RequiredFieldOmittedException,
resources.WrongResourceCollectionException,
):
ref = holder.resources.Parse(
args.name,
collection='compute.securityPolicyRules',
params={
'project': properties.VALUES.core.project.GetOrFail,
},
)
security_policy_rule = client.SecurityPolicyRule(
ref, compute_client=holder.client)
redirect_options = security_policies_utils.CreateRedirectOptions(
holder.client, args
)
rate_limit_options = security_policies_utils.CreateRateLimitOptions(
holder.client, args, support_rpc_status
)
request_headers_to_add = args.request_headers_to_add
expression_options = security_policies_utils.CreateExpressionOptions(
holder.client, args
)
result = security_policies_utils.CreateNetworkMatcher(
holder.client, args
)
network_matcher = result[0]
update_mask = result[1]
if args.IsSpecified('action') and args.action not in ['redirect']:
update_mask.append('redirect_options')
if args.IsSpecified('action') and args.action not in [
'throttle',
'rate-based-ban',
'fairshare',
]:
update_mask.append('rate_limit_options')
elif args.IsSpecified('exceed_action') and args.exceed_action not in [
'redirect'
]:
update_mask.append('rate_limit_options.exceed_redirect_options')
update_mask_str = ','.join(update_mask)
return security_policy_rule.Patch(
src_ip_ranges=args.src_ip_ranges,
expression=args.expression,
expression_options=expression_options,
network_matcher=network_matcher,
action=args.action,
description=args.description,
preview=args.preview,
redirect_options=redirect_options,
rate_limit_options=rate_limit_options,
request_headers_to_add=request_headers_to_add,
update_mask=update_mask_str if update_mask_str else None,
)
@base.UniverseCompatible
@base.ReleaseTracks(base.ReleaseTrack.GA)
class UpdateGA(base.UpdateCommand):
r"""Update a Compute Engine security policy rule.
*{command}* is used to update security policy rules.
## EXAMPLES
To update the description and IP ranges of a rule at priority
1000, run:
$ {command} 1000 \
--security-policy=my-policy \
--description="block 1.2.3.4/32" \
--src-ip-ranges=1.2.3.4/32
"""
SECURITY_POLICY_ARG = None
NAME_ARG = None
_support_rpc_status = False
@classmethod
def Args(cls, parser):
UpdateHelper.Args(
parser,
support_rpc_status=cls._support_rpc_status,
)
def Run(self, args):
return UpdateHelper.Run(
self.ReleaseTrack(),
args,
self._support_rpc_status,
)
@base.UniverseCompatible
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class UpdateBeta(base.UpdateCommand):
r"""Update a Compute Engine security policy rule.
*{command}* is used to update security policy rules.
## EXAMPLES
To update the description and IP ranges of a rule at priority
1000, run:
$ {command} 1000 \
--security-policy=my-policy \
--description="block 1.2.3.4/32" \
--src-ip-ranges=1.2.3.4/32
"""
SECURITY_POLICY_ARG = None
_support_rpc_status = False
@classmethod
def Args(cls, parser):
UpdateHelper.Args(
parser,
support_fairshare=True,
support_rpc_status=cls._support_rpc_status,
)
def Run(self, args):
return UpdateHelper.Run(
self.ReleaseTrack(),
args,
self._support_rpc_status,
)
@base.UniverseCompatible
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class UpdateAlpha(base.UpdateCommand):
r"""Update a Compute Engine security policy rule.
*{command}* is used to update security policy rules.
## EXAMPLES
To update the description and IP ranges of a rule at priority
1000, run:
$ {command} 1000 \
--security-policy=my-policy \
--description="block 1.2.3.4/32" \
--src-ip-ranges=1.2.3.4/32
"""
SECURITY_POLICY_ARG = None
_support_rpc_status = True
@classmethod
def Args(cls, parser):
UpdateHelper.Args(
parser,
support_fairshare=True,
support_rpc_status=cls._support_rpc_status,
)
def Run(self, args):
return UpdateHelper.Run(
self.ReleaseTrack(),
args,
self._support_rpc_status,
)