Source code for keystone.tests.protection.v3.test_endpoint_group

#    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.

import uuid

import http.client

from keystone.common import provider_api
import keystone.conf
from keystone.tests.common import auth as common_auth
from keystone.tests import unit
from keystone.tests.unit import base_classes
from keystone.tests.unit import ksfixtures

CONF = keystone.conf.CONF
PROVIDERS = provider_api.ProviderAPIs


class _SystemUserEndpointGroupsTests(object):
    """Common default functionality for all system users."""

    def test_user_can_list_endpoint_groups(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )

        with self.test_client() as c:
            r = c.get('/v3/OS-EP-FILTER/endpoint_groups', headers=self.headers)
            endpoint_groups = []
            for endpoint_group in r.json['endpoint_groups']:
                endpoint_groups.append(endpoint_group['id'])

            self.assertIn(endpoint_group['id'], endpoint_groups)

    def test_user_can_get_an_endpoint_group(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'],
                  headers=self.headers)

    def test_user_can_list_projects_associated_with_endpoint_groups(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        PROVIDERS.catalog_api.add_endpoint_group_to_project(
            endpoint_group['id'], project['id'])
        with self.test_client() as c:
            r = c.get('/v3/OS-EP-FILTER/endpoint_groups/%s/projects'
                      % endpoint_group['id'], headers=self.headers)
            projects = []
            for project in r.json['projects']:
                projects.append(project['id'])
            self.assertIn(project['id'], projects)

    def test_user_can_list_endpoints_associated_with_endpoint_groups(self):
        service = PROVIDERS.catalog_api.create_service(
            uuid.uuid4().hex, unit.new_service_ref()
        )
        endpoint = unit.new_endpoint_ref(service['id'], region_id=None)
        endpoint = PROVIDERS.catalog_api.create_endpoint(
            endpoint['id'], endpoint
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            r = c.get('/v3/OS-EP-FILTER/endpoint_groups/%s/endpoints'
                      % endpoint_group['id'],
                      headers=self.headers)
            endpoints = []
            for endpoint in r.json['endpoints']:
                endpoints.append(endpoint['id'])
            self.assertIn(endpoint['id'], endpoints)

    def test_user_can_get_endpoints_associated_with_endpoint_groups(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        PROVIDERS.catalog_api.add_endpoint_group_to_project(
            endpoint_group['id'], project['id'])
        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s'
                  % (endpoint_group['id'], project['id']),
                  headers=self.headers)

    def test_user_can_list_endpoint_groups_with_their_projects(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        PROVIDERS.catalog_api.add_endpoint_group_to_project(
            endpoint_group['id'], project['id'])
        with self.test_client() as c:
            r = c.get('/v3/OS-EP-FILTER/projects/%s/endpoint_groups'
                      % project['id'],
                      headers=self.headers)
            endpoint_groups = []
            for endpoint_group in r.json['endpoint_groups']:
                endpoint_groups.append(endpoint_group['id'])


class _SystemReaderAndMemberUserEndpointGroupsTests(object):
    """Common default functionality for system readers and system members."""

    def test_user_cannot_create_endpoint_groups(self):
        create = {
            'endpoint_group': {
                'id': uuid.uuid4().hex,
                'description': uuid.uuid4().hex,
                'filters': {'interface': 'public'},
                'name': uuid.uuid4().hex
            }
        }

        with self.test_client() as c:
            c.post(
                '/v3/OS-EP-FILTER/endpoint_groups', json=create,
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_update_endpoint_groups(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )

        update = {'endpoint_group': {'filters': {'interface': 'internal'}}}

        with self.test_client() as c:
            c.patch(
                '/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'],
                json=update,
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_delete_endpoint_groups(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )

        with self.test_client() as c:
            c.delete(
                '/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'],
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_add_endpoint_group_to_project(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            c.put('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s'
                  % (endpoint_group['id'], project['id']),
                  headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN
                  )

    def test_cannot_remove_endpoint_group_from_project(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            c.delete('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s'
                     % (endpoint_group['id'], project['id']),
                     headers=self.headers,
                     expected_status_code=http.client.FORBIDDEN
                     )


class _DomainAndProjectUserEndpointGroupTests(object):

    def test_user_cannot_list_endpoint_groups(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )

        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/endpoint_groups', headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN)

    def test_user_cannot_get_an_endpoint_group(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'],
                  headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN)

    def test_user_cannot_list_projects_associated_with_endpoint_groups(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        PROVIDERS.catalog_api.add_endpoint_group_to_project(
            endpoint_group['id'], project['id'])
        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/endpoint_groups/%s/projects'
                  % endpoint_group['id'],
                  headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN)

    def test_user_cannot_list_endpoints_associated_with_endpoint_groups(self):
        service = PROVIDERS.catalog_api.create_service(
            uuid.uuid4().hex, unit.new_service_ref()
        )
        endpoint = unit.new_endpoint_ref(service['id'], region_id=None)
        endpoint = PROVIDERS.catalog_api.create_endpoint(
            endpoint['id'], endpoint
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/endpoint_groups/%s/endpoints'
                  % endpoint_group['id'],
                  headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN)

    def test_user_cannot_get_endpoints_associated_with_endpoint_groups(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        PROVIDERS.catalog_api.add_endpoint_group_to_project(
            endpoint_group['id'], project['id'])
        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s'
                  % (endpoint_group['id'], project['id']),
                  headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN)

    def test_user_cannot_list_endpoint_groups_with_their_projects(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        PROVIDERS.catalog_api.add_endpoint_group_to_project(
            endpoint_group['id'], project['id'])
        with self.test_client() as c:
            c.get('/v3/OS-EP-FILTER/projects/%s/endpoint_groups'
                  % project['id'],
                  headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN)

    def test_user_cannot_create_endpoint_groups(self):
        create = {
            'endpoint_group': {
                'id': uuid.uuid4().hex,
                'description': uuid.uuid4().hex,
                'filters': {'interface': 'public'},
                'name': uuid.uuid4().hex
            }
        }

        with self.test_client() as c:
            c.post(
                '/v3/OS-EP-FILTER/endpoint_groups', json=create,
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_update_endpoint_groups(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )

        update = {'endpoint_group': {'filters': {'interface': 'internal'}}}

        with self.test_client() as c:
            c.patch(
                '/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'],
                json=update,
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_delete_endpoint_groups(self):
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )

        with self.test_client() as c:
            c.delete(
                '/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'],
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_add_endpoint_group_to_project(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            c.put('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s'
                  % (endpoint_group['id'], project['id']),
                  headers=self.headers,
                  expected_status_code=http.client.FORBIDDEN
                  )

    def test_cannot_remove_endpoint_group_from_project(self):
        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex, unit.new_project_ref(
                domain_id=CONF.identity.default_domain_id
            )
        )
        endpoint_group = unit.new_endpoint_group_ref(
            filters={'interface': 'public'})
        endpoint_group = PROVIDERS.catalog_api.create_endpoint_group(
            endpoint_group['id'], endpoint_group
        )
        with self.test_client() as c:
            c.delete('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s'
                     % (endpoint_group['id'], project['id']),
                     headers=self.headers,
                     expected_status_code=http.client.FORBIDDEN
                     )


[docs]class SystemReaderTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _SystemUserEndpointGroupsTests, _SystemReaderAndMemberUserEndpointGroupsTests):
[docs] def setUp(self): super(SystemReaderTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) system_reader = unit.new_user_ref( domain_id=CONF.identity.default_domain_id ) self.user_id = PROVIDERS.identity_api.create_user( system_reader )['id'] PROVIDERS.assignment_api.create_system_grant_for_user( self.user_id, self.bootstrapper.reader_role_id ) auth = self.build_authentication_request( user_id=self.user_id, password=system_reader['password'], system=True ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs]class SystemMemberTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _SystemUserEndpointGroupsTests, _SystemReaderAndMemberUserEndpointGroupsTests):
[docs] def setUp(self): super(SystemMemberTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) system_member = unit.new_user_ref( domain_id=CONF.identity.default_domain_id ) self.user_id = PROVIDERS.identity_api.create_user( system_member )['id'] PROVIDERS.assignment_api.create_system_grant_for_user( self.user_id, self.bootstrapper.member_role_id ) auth = self.build_authentication_request( user_id=self.user_id, password=system_member['password'], system=True ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs]class SystemAdminTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _SystemUserEndpointGroupsTests):
[docs] def setUp(self): super(SystemAdminTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) # Reuse the system administrator account created during # ``keystone-manage bootstrap`` self.user_id = self.bootstrapper.admin_user_id auth = self.build_authentication_request( user_id=self.user_id, password=self.bootstrapper.admin_password, system=True ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs] def test_user_can_create_endpoint_group(self): create = { 'endpoint_group': { 'id': uuid.uuid4().hex, 'description': uuid.uuid4().hex, 'filters': {'interface': 'public'}, 'name': uuid.uuid4().hex } } with self.test_client() as c: c.post( '/v3/OS-EP-FILTER/endpoint_groups', json=create, headers=self.headers)
[docs] def test_user_can_update_endpoint_group(self): endpoint_group = unit.new_endpoint_group_ref( filters={'interface': 'public'}) endpoint_group = PROVIDERS.catalog_api.create_endpoint_group( endpoint_group['id'], endpoint_group ) update = {'endpoint_group': {'filters': {'interface': 'internal'}}} with self.test_client() as c: c.patch( '/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'], json=update, headers=self.headers)
[docs] def test_user_can_delete_endpoint_group(self): endpoint_group = unit.new_endpoint_group_ref( filters={'interface': 'public'}) endpoint_group = PROVIDERS.catalog_api.create_endpoint_group( endpoint_group['id'], endpoint_group ) with self.test_client() as c: c.delete( '/v3/OS-EP-FILTER/endpoint_groups/%s' % endpoint_group['id'], headers=self.headers )
[docs] def test_user_add_endpoint_group_to_project(self): project = PROVIDERS.resource_api.create_project( uuid.uuid4().hex, unit.new_project_ref( domain_id=CONF.identity.default_domain_id ) ) endpoint_group = unit.new_endpoint_group_ref( filters={'interface': 'public'}) endpoint_group = PROVIDERS.catalog_api.create_endpoint_group( endpoint_group['id'], endpoint_group ) with self.test_client() as c: c.put('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s' % (endpoint_group['id'], project['id']), headers=self.headers )
[docs] def test_remove_endpoint_group_from_project(self): project = PROVIDERS.resource_api.create_project( uuid.uuid4().hex, unit.new_project_ref( domain_id=CONF.identity.default_domain_id ) ) endpoint_group = unit.new_endpoint_group_ref( filters={'interface': 'public'}) endpoint_group = PROVIDERS.catalog_api.create_endpoint_group( endpoint_group['id'], endpoint_group ) PROVIDERS.catalog_api.add_endpoint_group_to_project( endpoint_group['id'], project['id']) with self.test_client() as c: c.delete('/v3/OS-EP-FILTER/endpoint_groups/%s/projects/%s' % (endpoint_group['id'], project['id']), headers=self.headers )
[docs]class DomainUserTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _DomainAndProjectUserEndpointGroupTests):
[docs] def setUp(self): super(DomainUserTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) domain = PROVIDERS.resource_api.create_domain( uuid.uuid4().hex, unit.new_domain_ref() ) self.domain_id = domain['id'] domain_admin = unit.new_user_ref(domain_id=self.domain_id) self.user_id = PROVIDERS.identity_api.create_user(domain_admin)['id'] PROVIDERS.assignment_api.create_grant( self.bootstrapper.admin_role_id, user_id=self.user_id, domain_id=self.domain_id ) auth = self.build_authentication_request( user_id=self.user_id, password=domain_admin['password'], domain_id=self.domain_id ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs]class ProjectUserTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _DomainAndProjectUserEndpointGroupTests):
[docs] def setUp(self): super(ProjectUserTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) self.user_id = self.bootstrapper.admin_user_id auth = self.build_authentication_request( user_id=self.user_id, password=self.bootstrapper.admin_password, project_id=self.bootstrapper.project_id ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs]class ProjectUserTestsWithoutEnforceScope( base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _DomainAndProjectUserEndpointGroupTests):
[docs] def setUp(self): super(ProjectUserTestsWithoutEnforceScope, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) # Explicityly set enforce_scope to False to make sure we maintain # backwards compatibility with project users. self.config_fixture.config(group='oslo_policy', enforce_scope=False) domain = PROVIDERS.resource_api.create_domain( uuid.uuid4().hex, unit.new_domain_ref() ) user = unit.new_user_ref(domain_id=domain['id']) self.user_id = PROVIDERS.identity_api.create_user(user)['id'] self.project_id = PROVIDERS.resource_api.create_project( uuid.uuid4().hex, unit.new_project_ref(domain_id=domain['id']) )['id'] PROVIDERS.assignment_api.create_grant( self.bootstrapper.member_role_id, user_id=self.user_id, project_id=self.project_id ) auth = self.build_authentication_request( user_id=self.user_id, password=user['password'], project_id=self.project_id ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}