heat/heat/engine/resources/neutron/vpnservice.py

583 lines
21 KiB
Python

#
# 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.
from heat.engine import clients
from heat.engine import constraints
from heat.engine import properties
from heat.engine.resources.neutron import neutron
from heat.engine import support
if clients.neutronclient is not None:
from neutronclient.common.exceptions import NeutronClientException
class VPNService(neutron.NeutronResource):
"""
A resource for VPN service in Neutron.
"""
PROPERTIES = (
NAME, DESCRIPTION, ADMIN_STATE_UP,
SUBNET_ID, SUBNET, ROUTER_ID,
) = (
'name', 'description', 'admin_state_up',
'subnet_id', 'subnet', 'router_id',
)
properties_schema = {
NAME: properties.Schema(
properties.Schema.STRING,
_('Name for the vpn service.'),
update_allowed=True
),
DESCRIPTION: properties.Schema(
properties.Schema.STRING,
_('Description for the vpn service.'),
update_allowed=True
),
ADMIN_STATE_UP: properties.Schema(
properties.Schema.BOOLEAN,
_('Administrative state for the vpn service.'),
default=True,
update_allowed=True
),
SUBNET_ID: properties.Schema(
properties.Schema.STRING,
support_status=support.SupportStatus(
support.DEPRECATED,
_('Use property %s.') % SUBNET),
required=False
),
SUBNET: properties.Schema(
properties.Schema.STRING,
_('Subnet in which the vpn service will be created.'),
required=False
),
ROUTER_ID: properties.Schema(
properties.Schema.STRING,
_('Unique identifier for the router to which the vpn service '
'will be inserted.'),
required=True
),
}
attributes_schema = {
'admin_state_up': _('The administrative state of the vpn service.'),
'description': _('The description of the vpn service.'),
'name': _('The name of the vpn service.'),
'router_id': _('The unique identifier of the router to which the vpn '
'service was inserted.'),
'status': _('The status of the vpn service.'),
'subnet_id': _('The unique identifier of the subnet in which the vpn '
'service was created.'),
'tenant_id': _('The unique identifier of the tenant owning the vpn '
'service.'),
'show': _('All attributes.'),
}
def _show_resource(self):
return self.neutron().show_vpnservice(self.resource_id)['vpnservice']
def validate(self):
super(VPNService, self).validate()
self._validate_depr_property_required(
self.properties, self.SUBNET, self.SUBNET_ID)
def handle_create(self):
props = self.prepare_properties(
self.properties,
self.physical_resource_name())
self._resolve_subnet(
self.neutron(), props,
self.SUBNET, 'subnet_id')
vpnservice = self.neutron().create_vpnservice({'vpnservice': props})[
'vpnservice']
self.resource_id_set(vpnservice['id'])
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
if prop_diff:
self.neutron().update_vpnservice(self.resource_id,
{'vpnservice': prop_diff})
def handle_delete(self):
client = self.neutron()
try:
client.delete_vpnservice(self.resource_id)
except NeutronClientException as ex:
self._handle_not_found_exception(ex)
else:
return self._delete_task()
class IPsecSiteConnection(neutron.NeutronResource):
"""
A resource for IPsec site connection in Neutron.
"""
PROPERTIES = (
NAME, DESCRIPTION, PEER_ADDRESS, PEER_ID, PEER_CIDRS, MTU,
DPD, PSK, INITIATOR, ADMIN_STATE_UP, IKEPOLICY_ID,
IPSECPOLICY_ID, VPNSERVICE_ID,
) = (
'name', 'description', 'peer_address', 'peer_id', 'peer_cidrs', 'mtu',
'dpd', 'psk', 'initiator', 'admin_state_up', 'ikepolicy_id',
'ipsecpolicy_id', 'vpnservice_id',
)
_DPD_KEYS = (
DPD_ACTIONS, DPD_INTERVAL, DPD_TIMEOUT,
) = (
'actions', 'interval', 'timeout',
)
properties_schema = {
NAME: properties.Schema(
properties.Schema.STRING,
_('Name for the ipsec site connection.'),
update_allowed=True
),
DESCRIPTION: properties.Schema(
properties.Schema.STRING,
_('Description for the ipsec site connection.'),
update_allowed=True
),
PEER_ADDRESS: properties.Schema(
properties.Schema.STRING,
_('Remote branch router public IPv4 address or IPv6 address or '
'FQDN.'),
required=True
),
PEER_ID: properties.Schema(
properties.Schema.STRING,
_('Remote branch router identity.'),
required=True
),
PEER_CIDRS: properties.Schema(
properties.Schema.LIST,
_('Remote subnet(s) in CIDR format.'),
required=True
),
MTU: properties.Schema(
properties.Schema.INTEGER,
_('Maximum transmission unit size (in bytes) for the ipsec site '
'connection.'),
default=1500
),
DPD: properties.Schema(
properties.Schema.MAP,
_('Dead Peer Detection protocol configuration for the ipsec site '
'connection.'),
schema={
DPD_ACTIONS: properties.Schema(
properties.Schema.STRING,
_('Controls DPD protocol mode.'),
default='hold',
constraints=[
constraints.AllowedValues(['clear', 'disabled',
'hold', 'restart',
'restart-by-peer']),
]
),
DPD_INTERVAL: properties.Schema(
properties.Schema.INTEGER,
_('Number of seconds for the DPD delay.'),
default=30
),
DPD_TIMEOUT: properties.Schema(
properties.Schema.INTEGER,
_('Number of seconds for the DPD timeout.'),
default=120
),
}
),
PSK: properties.Schema(
properties.Schema.STRING,
_('Pre-shared key string for the ipsec site connection.'),
required=True
),
INITIATOR: properties.Schema(
properties.Schema.STRING,
_('Initiator state in lowercase for the ipsec site connection.'),
default='bi-directional',
constraints=[
constraints.AllowedValues(['bi-directional', 'response-only']),
]
),
ADMIN_STATE_UP: properties.Schema(
properties.Schema.BOOLEAN,
_('Administrative state for the ipsec site connection.'),
default=True,
update_allowed=True
),
IKEPOLICY_ID: properties.Schema(
properties.Schema.STRING,
_('Unique identifier for the ike policy associated with the '
'ipsec site connection.'),
required=True
),
IPSECPOLICY_ID: properties.Schema(
properties.Schema.STRING,
_('Unique identifier for the ipsec policy associated with the '
'ipsec site connection.'),
required=True
),
VPNSERVICE_ID: properties.Schema(
properties.Schema.STRING,
_('Unique identifier for the vpn service associated with the '
'ipsec site connection.'),
required=True
),
}
attributes_schema = {
'admin_state_up': _('The administrative state of the ipsec site '
'connection.'),
'auth_mode': _('The authentication mode of the ipsec site '
'connection.'),
'description': _('The description of the ipsec site connection.'),
'dpd': _('The dead peer detection protocol configuration of the ipsec '
'site connection.'),
'ikepolicy_id': _('The unique identifier of ike policy associated '
'with the ipsec site connection.'),
'initiator': _('The initiator of the ipsec site connection.'),
'ipsecpolicy_id': _('The unique identifier of ipsec policy '
'associated with the ipsec site connection.'),
'mtu': _('The maximum transmission unit size (in bytes) of the ipsec '
'site connection.'),
'name': _('The name of the ipsec site connection.'),
'peer_address': _('The remote branch router public IPv4 address or '
'IPv6 address or FQDN.'),
'peer_cidrs': _('The remote subnet(s) in CIDR format of the ipsec '
'site connection.'),
'peer_id': _('The remote branch router identity of the ipsec site '
'connection.'),
'psk': _('The pre-shared key string of the ipsec site connection.'),
'route_mode': _('The route mode of the ipsec site connection.'),
'status': _('The status of the ipsec site connection.'),
'tenant_id': _('The unique identifier of the tenant owning the ipsec '
'site connection.'),
'vpnservice_id': _('The unique identifier of vpn service associated '
'with the ipsec site connection.')
}
def _show_resource(self):
return self.neutron().show_ipsec_site_connection(self.resource_id)[
'ipsec_site_connection']
def handle_create(self):
props = self.prepare_properties(
self.properties,
self.physical_resource_name())
ipsec_site_connection = self.neutron().create_ipsec_site_connection(
{'ipsec_site_connection': props})['ipsec_site_connection']
self.resource_id_set(ipsec_site_connection['id'])
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
if prop_diff:
self.neutron().update_ipsec_site_connection(
self.resource_id, {'ipsec_site_connection': prop_diff})
def handle_delete(self):
client = self.neutron()
try:
client.delete_ipsec_site_connection(self.resource_id)
except NeutronClientException as ex:
self._handle_not_found_exception(ex)
else:
return self._delete_task()
class IKEPolicy(neutron.NeutronResource):
"""
A resource for IKE policy in Neutron.
"""
PROPERTIES = (
NAME, DESCRIPTION, AUTH_ALGORITHM, ENCRYPTION_ALGORITHM,
PHASE1_NEGOTIATION_MODE, LIFETIME, PFS, IKE_VERSION,
) = (
'name', 'description', 'auth_algorithm', 'encryption_algorithm',
'phase1_negotiation_mode', 'lifetime', 'pfs', 'ike_version',
)
_LIFETIME_KEYS = (
LIFETIME_UNITS, LIFETIME_VALUE,
) = (
'units', 'value',
)
properties_schema = {
NAME: properties.Schema(
properties.Schema.STRING,
_('Name for the ike policy.'),
update_allowed=True
),
DESCRIPTION: properties.Schema(
properties.Schema.STRING,
_('Description for the ike policy.'),
update_allowed=True
),
AUTH_ALGORITHM: properties.Schema(
properties.Schema.STRING,
_('Authentication hash algorithm for the ike policy.'),
default='sha1',
constraints=[
constraints.AllowedValues(['sha1']),
]
),
ENCRYPTION_ALGORITHM: properties.Schema(
properties.Schema.STRING,
_('Encryption algorithm for the ike policy.'),
default='aes-128',
constraints=[
constraints.AllowedValues(['3des', 'aes-128', 'aes-192',
'aes-256']),
]
),
PHASE1_NEGOTIATION_MODE: properties.Schema(
properties.Schema.STRING,
_('Negotiation mode for the ike policy.'),
default='main',
constraints=[
constraints.AllowedValues(['main']),
]
),
LIFETIME: properties.Schema(
properties.Schema.MAP,
_('Safety assessment lifetime configuration for the ike policy.'),
schema={
LIFETIME_UNITS: properties.Schema(
properties.Schema.STRING,
_('Safety assessment lifetime units.'),
default='seconds',
constraints=[
constraints.AllowedValues(['seconds', 'kilobytes']),
]
),
LIFETIME_VALUE: properties.Schema(
properties.Schema.INTEGER,
_('Safety assessment lifetime value in specified '
'units.'),
default=3600
),
}
),
PFS: properties.Schema(
properties.Schema.STRING,
_('Perfect forward secrecy in lowercase for the ike policy.'),
default='group5',
constraints=[
constraints.AllowedValues(['group2', 'group5', 'group14']),
]
),
IKE_VERSION: properties.Schema(
properties.Schema.STRING,
_('Version for the ike policy.'),
default='v1',
constraints=[
constraints.AllowedValues(['v1', 'v2']),
]
),
}
attributes_schema = {
'auth_algorithm': _('The authentication hash algorithm used by the ike'
' policy.'),
'description': _('The description of the ike policy.'),
'encryption_algorithm': _('The encryption algorithm used by the ike '
'policy.'),
'ike_version': _('The version of the ike policy.'),
'lifetime': _('The safety assessment lifetime configuration for the '
'ike policy.'),
'name': _('The name of the ike policy.'),
'pfs': _('The perfect forward secrecy of the ike policy.'),
'phase1_negotiation_mode': _('The negotiation mode of the ike '
'policy.'),
'tenant_id': _('The unique identifier of the tenant owning the ike '
'policy.'),
}
def _show_resource(self):
return self.neutron().show_ikepolicy(self.resource_id)['ikepolicy']
def handle_create(self):
props = self.prepare_properties(
self.properties,
self.physical_resource_name())
ikepolicy = self.neutron().create_ikepolicy({'ikepolicy': props})[
'ikepolicy']
self.resource_id_set(ikepolicy['id'])
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
if prop_diff:
self.neutron().update_ikepolicy(self.resource_id,
{'ikepolicy': prop_diff})
def handle_delete(self):
client = self.neutron()
try:
client.delete_ikepolicy(self.resource_id)
except NeutronClientException as ex:
self._handle_not_found_exception(ex)
else:
return self._delete_task()
class IPsecPolicy(neutron.NeutronResource):
"""
A resource for IPsec policy in Neutron.
"""
PROPERTIES = (
NAME, DESCRIPTION, TRANSFORM_PROTOCOL, ENCAPSULATION_MODE,
AUTH_ALGORITHM, ENCRYPTION_ALGORITHM, LIFETIME, PFS,
) = (
'name', 'description', 'transform_protocol', 'encapsulation_mode',
'auth_algorithm', 'encryption_algorithm', 'lifetime', 'pfs',
)
_LIFETIME_KEYS = (
LIFETIME_UNITS, LIFETIME_VALUE,
) = (
'units', 'value',
)
properties_schema = {
NAME: properties.Schema(
properties.Schema.STRING,
_('Name for the ipsec policy.'),
update_allowed=True
),
DESCRIPTION: properties.Schema(
properties.Schema.STRING,
_('Description for the ipsec policy.'),
update_allowed=True
),
TRANSFORM_PROTOCOL: properties.Schema(
properties.Schema.STRING,
_('Transform protocol for the ipsec policy.'),
default='esp',
constraints=[
constraints.AllowedValues(['esp', 'ah', 'ah-esp']),
]
),
ENCAPSULATION_MODE: properties.Schema(
properties.Schema.STRING,
_('Encapsulation mode for the ipsec policy.'),
default='tunnel',
constraints=[
constraints.AllowedValues(['tunnel', 'transport']),
]
),
AUTH_ALGORITHM: properties.Schema(
properties.Schema.STRING,
_('Authentication hash algorithm for the ipsec policy.'),
default='sha1',
constraints=[
constraints.AllowedValues(['sha1']),
]
),
ENCRYPTION_ALGORITHM: properties.Schema(
properties.Schema.STRING,
_('Encryption algorithm for the ipsec policy.'),
default='aes-128',
constraints=[
constraints.AllowedValues(['3des', 'aes-128', 'aes-192',
'aes-256']),
]
),
LIFETIME: properties.Schema(
properties.Schema.MAP,
_('Safety assessment lifetime configuration for the ipsec '
'policy.'),
schema={
LIFETIME_UNITS: properties.Schema(
properties.Schema.STRING,
_('Safety assessment lifetime units.'),
default='seconds',
constraints=[
constraints.AllowedValues(['seconds',
'kilobytes']),
]
),
LIFETIME_VALUE: properties.Schema(
properties.Schema.INTEGER,
_('Safety assessment lifetime value in specified '
'units.'),
default=3600
),
}
),
PFS: properties.Schema(
properties.Schema.STRING,
_('Perfect forward secrecy for the ipsec policy.'),
default='group5',
constraints=[
constraints.AllowedValues(['group2', 'group5', 'group14']),
]
),
}
attributes_schema = {
'auth_algorithm': _('The authentication hash algorithm of the ipsec '
'policy.'),
'description': _('The description of the ipsec policy.'),
'encapsulation_mode': _('The encapsulation mode of the ipsec policy.'),
'encryption_algorithm': _('The encryption algorithm of the ipsec '
'policy.'),
'lifetime': _('The safety assessment lifetime configuration of the '
'ipsec policy.'),
'name': _('The name of the ipsec policy.'),
'pfs': _('The perfect forward secrecy of the ipsec policy.'),
'tenant_id': _('The unique identifier of the tenant owning the '
'ipsec policy.'),
'transform_protocol': _('The transform protocol of the ipsec policy.')
}
def _show_resource(self):
return self.neutron().show_ipsecpolicy(self.resource_id)['ipsecpolicy']
def handle_create(self):
props = self.prepare_properties(
self.properties,
self.physical_resource_name())
ipsecpolicy = self.neutron().create_ipsecpolicy(
{'ipsecpolicy': props})['ipsecpolicy']
self.resource_id_set(ipsecpolicy['id'])
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
if prop_diff:
self.neutron().update_ipsecpolicy(self.resource_id,
{'ipsecpolicy': prop_diff})
def handle_delete(self):
client = self.neutron()
try:
client.delete_ipsecpolicy(self.resource_id)
except NeutronClientException as ex:
self._handle_not_found_exception(ex)
else:
return self._delete_task()
def resource_mapping():
if clients.neutronclient is None:
return {}
return {
'OS::Neutron::VPNService': VPNService,
'OS::Neutron::IPsecSiteConnection': IPsecSiteConnection,
'OS::Neutron::IKEPolicy': IKEPolicy,
'OS::Neutron::IPsecPolicy': IPsecPolicy,
}