python-manilaclient/manilaclient/v2/security_services.py

# Copyright 2013 OpenStack Foundation
# 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.

from manilaclient import api_versions
from manilaclient import base
from manilaclient import exceptions

RESOURCES_PATH = '/security-services'
RESOURCE_PATH = "/security-services/%s"
RESOURCE_NAME = 'security_service'
RESOURCES_NAME = 'security_services'


class SecurityService(base.Resource):
    """Security service for Manila shares."""

    def __repr__(self):
        return f"<SecurityService: {self.id}>"

    def update(self, **kwargs):
        """Update this security service."""
        return self.manager.update(self, **kwargs)

    def delete(self):
        """Delete this security service."""
        self.manager.delete(self)


class SecurityServiceManager(base.ManagerWithFind):
    """Manage :class:`SecurityService` resources."""

    resource_class = SecurityService

    @api_versions.wraps("1.0", "2.75")
    def create(
        self,
        type,
        dns_ip=None,
        ou=None,
        server=None,
        domain=None,
        user=None,
        password=None,
        name=None,
        description=None,
    ):
        """Create security service for NAS.

        :param type: security service type - 'ldap', 'kerberos' or
                     'active_directory'
        :param dns_ip: dns ip address used inside tenant's network
        :param ou: security service organizational unit
        :param server: security service server ip address or hostname
        :param domain: security service domain
        :param user: security identifier used by tenant
        :param password: password used by user
        :param name: security service name
        :param description: security service description
        :rtype: :class:`SecurityService`
        """
        return self._create_security_service(
            type,
            dns_ip=dns_ip,
            ou=ou,
            server=server,
            domain=domain,
            user=user,
            password=password,
            name=name,
            description=description,
        )

    @api_versions.wraps("2.76")  # noqa
    def create(  # noqa
        self,
        type,
        dns_ip=None,
        ou=None,
        server=None,
        domain=None,
        user=None,
        password=None,
        name=None,
        description=None,
        default_ad_site=None,
    ):
        """Create security service for NAS.

        :param type: security service type - 'ldap', 'kerberos' or
                     'active_directory'
        :param dns_ip: dns ip address used inside tenant's network
        :param ou: security service organizational unit
        :param server: security service server ip address or hostname
        :param domain: security service domain
        :param user: security identifier used by tenant
        :param password: password used by user
        :param name: security service name
        :param description: security service description
        :param default_ad_site: default AD-Site
        :rtype: :class:`SecurityService`
        """
        return self._create_security_service(
            type,
            dns_ip=dns_ip,
            ou=ou,
            server=server,
            domain=domain,
            user=user,
            password=password,
            name=name,
            description=description,
            default_ad_site=default_ad_site,
        )

    def _create_security_service(
        self,
        type,
        dns_ip=None,
        ou=None,
        server=None,
        domain=None,
        user=None,
        password=None,
        name=None,
        description=None,
        default_ad_site=None,
    ):
        values = {'type': type}
        if dns_ip:
            values['dns_ip'] = dns_ip
        if ou:
            values['ou'] = ou
        if server:
            values['server'] = server
        if domain:
            values['domain'] = domain
        if user:
            values['user'] = user
        if password:
            values['password'] = password
        if name:
            values['name'] = name
        if description:
            values['description'] = description
        if default_ad_site:
            values['default_ad_site'] = default_ad_site

        body = {RESOURCE_NAME: values}

        return self._create(RESOURCES_PATH, body, RESOURCE_NAME)

    def get(self, security_service):
        """Get a security service info.

        :param security_service: security service to get.
        :rtype: :class:`SecurityService`
        """
        return self._get(
            RESOURCE_PATH % base.getid(security_service),
            RESOURCE_NAME,
        )

    @api_versions.wraps("1.0", "2.75")
    def update(
        self,
        security_service,
        dns_ip=None,
        ou=None,
        server=None,
        domain=None,
        password=None,
        user=None,
        name=None,
        description=None,
    ):
        """Updates a security service.

        :param security_service: security service to update.
        :param dns_ip: dns ip address used inside tenant's network
        :param ou: security service organizational unit
        :param server: security service server ip address or hostname
        :param domain: security service domain
        :param user: security identifier used by tenant
        :param password: password used by user
        :param name: security service name
        :param description: security service description
        :rtype: :class:`SecurityService`
        """
        return self._update_security_service(
            security_service,
            dns_ip=dns_ip,
            ou=ou,
            server=server,
            domain=domain,
            password=password,
            user=user,
            name=name,
            description=description,
        )

    @api_versions.wraps("2.76")  # noqa
    def update(  # noqa
        self,
        security_service,
        dns_ip=None,
        ou=None,
        server=None,
        domain=None,
        password=None,
        user=None,
        name=None,
        description=None,
        default_ad_site=None,
    ):
        """Updates a security service.

        :param security_service: security service to update.
        :param dns_ip: dns ip address used inside tenant's network
        :param ou: security service organizational unit
        :param server: security service server ip address or hostname
        :param domain: security service domain
        :param user: security identifier used by tenant
        :param password: password used by user
        :param name: security service name
        :param description: security service description
        :param default_ad_site: default AD-Site
        :rtype: :class:`SecurityService`
        """
        return self._update_security_service(
            security_service,
            dns_ip=dns_ip,
            ou=ou,
            server=server,
            domain=domain,
            password=password,
            user=user,
            name=name,
            description=description,
            default_ad_site=default_ad_site,
        )

    def _update_security_service(
        self,
        security_service,
        dns_ip=None,
        ou=None,
        server=None,
        domain=None,
        password=None,
        user=None,
        name=None,
        description=None,
        default_ad_site=None,
    ):
        values = {}
        if dns_ip is not None:
            values['dns_ip'] = dns_ip
        if ou is not None:
            values['ou'] = ou
        if server is not None:
            values['server'] = server
        if domain is not None:
            values['domain'] = domain
        if user is not None:
            values['user'] = user
        if password is not None:
            values['password'] = password
        if name is not None:
            values['name'] = name
        if description is not None:
            values['description'] = description
        if default_ad_site is not None:
            values['default_ad_site'] = default_ad_site

        for k, v in values.items():
            if v == '':
                values[k] = None

        if not values:
            msg = "Must specify fields to be updated"
            raise exceptions.CommandError(msg)

        body = {RESOURCE_NAME: values}

        return self._update(
            RESOURCE_PATH % base.getid(security_service),
            body,
            RESOURCE_NAME,
        )

    def delete(self, security_service):
        """Delete a security service.

        :param security_service: security service to be deleted.
        """
        self._delete(RESOURCE_PATH % base.getid(security_service))

    def list(self, detailed=True, search_opts=None):
        """Get a list of all security services.

        :rtype: list of :class:`SecurityService`
        """
        query_string = self._build_query_string(search_opts)

        if detailed:
            path = RESOURCES_PATH + "/detail" + query_string
        else:
            path = RESOURCES_PATH + query_string

        return self._list(path, RESOURCES_NAME)