**** CubicPower OpenStack Study ****
# Copyright 2014 OpenStack Foundation
#
# 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 keystone.common import sql
from keystone.common.sql import migration_helpers
from keystone.contrib import federation
from keystone.contrib.federation import core
from keystone import exception
from keystone.openstack.common.db.sqlalchemy import migration
from keystone.openstack.common import jsonutils
**** CubicPower OpenStack Study ****
class FederationProtocolModel(sql.ModelBase, sql.DictBase):
__tablename__ = 'federation_protocol'
attributes = ['id', 'idp_id', 'mapping_id']
mutable_attributes = frozenset(['mapping_id'])
id = sql.Column(sql.String(64), primary_key=True)
idp_id = sql.Column(sql.String(64), sql.ForeignKey('identity_provider.id',
ondelete='CASCADE'), primary_key=True)
mapping_id = sql.Column(sql.String(64), nullable=False)
__table_args__ = (sql.UniqueConstraint('id', 'idp_id'), dict())
@classmethod
**** CubicPower OpenStack Study ****
def from_dict(cls, dictionary):
new_dictionary = dictionary.copy()
return cls(**new_dictionary)
**** CubicPower OpenStack Study ****
def to_dict(self):
"""Return a dictionary with model's attributes."""
d = dict()
for attr in self.__class__.attributes:
d[attr] = getattr(self, attr)
return d
**** CubicPower OpenStack Study ****
class IdentityProviderModel(sql.ModelBase, sql.DictBase):
__tablename__ = 'identity_provider'
attributes = ['id', 'enabled', 'description']
mutable_attributes = frozenset(['description', 'enabled'])
id = sql.Column(sql.String(64), primary_key=True)
enabled = sql.Column(sql.Boolean, nullable=False)
description = sql.Column(sql.Text(), nullable=True)
@classmethod
**** CubicPower OpenStack Study ****
def from_dict(cls, dictionary):
new_dictionary = dictionary.copy()
return cls(**new_dictionary)
**** CubicPower OpenStack Study ****
def to_dict(self, include_extra_dict=False):
"""Return the model's attributes as a dictionary."""
d = dict()
for attr in self.__class__.attributes:
d[attr] = getattr(self, attr)
return d
**** CubicPower OpenStack Study ****
class MappingModel(sql.ModelBase, sql.DictBase):
__tablename__ = 'mapping'
attributes = ['id', 'rules']
id = sql.Column(sql.String(64), primary_key=True)
rules = sql.Column(sql.JsonBlob(), nullable=False)
@classmethod
**** CubicPower OpenStack Study ****
def from_dict(cls, dictionary):
new_dictionary = dictionary.copy()
return cls(**new_dictionary)
**** CubicPower OpenStack Study ****
def to_dict(self):
"""Return a dictionary with model's attributes."""
d = dict()
for attr in self.__class__.attributes:
d[attr] = getattr(self, attr)
return d
**** CubicPower OpenStack Study ****
class Federation(core.Driver):
**** CubicPower OpenStack Study ****
def db_sync(self):
abs_path = migration_helpers.find_migrate_repo(federation)
migration.db_sync(sql.get_engine(), abs_path)
# Identity Provider CRUD
@sql.handle_conflicts(conflict_type='identity_provider')
**** CubicPower OpenStack Study ****
def create_idp(self, idp_id, idp):
session = sql.get_session()
with session.begin():
idp['id'] = idp_id
idp_ref = IdentityProviderModel.from_dict(idp)
session.add(idp_ref)
return idp_ref.to_dict()
**** CubicPower OpenStack Study ****
def delete_idp(self, idp_id):
session = sql.get_session()
with session.begin():
idp_ref = self._get_idp(session, idp_id)
q = session.query(IdentityProviderModel)
q = q.filter_by(id=idp_id)
q.delete(synchronize_session=False)
session.delete(idp_ref)
**** CubicPower OpenStack Study ****
def _get_idp(self, session, idp_id):
idp_ref = session.query(IdentityProviderModel).get(idp_id)
if not idp_ref:
raise exception.IdentityProviderNotFound(idp_id=idp_id)
return idp_ref
**** CubicPower OpenStack Study ****
def list_idps(self):
session = sql.get_session()
with session.begin():
idps = session.query(IdentityProviderModel)
idps_list = [idp.to_dict() for idp in idps]
return idps_list
**** CubicPower OpenStack Study ****
def get_idp(self, idp_id):
session = sql.get_session()
idp_ref = self._get_idp(session, idp_id)
return idp_ref.to_dict()
**** CubicPower OpenStack Study ****
def update_idp(self, idp_id, idp):
session = sql.get_session()
with session.begin():
idp_ref = self._get_idp(session, idp_id)
old_idp = idp_ref.to_dict()
old_idp.update(idp)
new_idp = IdentityProviderModel.from_dict(old_idp)
for attr in IdentityProviderModel.mutable_attributes:
setattr(idp_ref, attr, getattr(new_idp, attr))
return idp_ref.to_dict()
# Protocol CRUD
**** CubicPower OpenStack Study ****
def _get_protocol(self, session, idp_id, protocol_id):
q = session.query(FederationProtocolModel)
q = q.filter_by(id=protocol_id, idp_id=idp_id)
try:
return q.one()
except sql.NotFound:
kwargs = {'protocol_id': protocol_id,
'idp_id': idp_id}
raise exception.FederatedProtocolNotFound(**kwargs)
@sql.handle_conflicts(conflict_type='federation_protocol')
**** CubicPower OpenStack Study ****
def create_protocol(self, idp_id, protocol_id, protocol):
session = sql.get_session()
with session.begin():
self._get_idp(session, idp_id)
protocol['id'] = protocol_id
protocol['idp_id'] = idp_id
protocol_ref = FederationProtocolModel.from_dict(protocol)
session.add(protocol_ref)
return protocol_ref.to_dict()
**** CubicPower OpenStack Study ****
def update_protocol(self, idp_id, protocol_id, protocol):
session = sql.get_session()
with session.begin():
proto_ref = self._get_protocol(session, idp_id, protocol_id)
old_proto = proto_ref.to_dict()
old_proto.update(protocol)
new_proto = FederationProtocolModel.from_dict(old_proto)
for attr in FederationProtocolModel.mutable_attributes:
setattr(proto_ref, attr, getattr(new_proto, attr))
return proto_ref.to_dict()
**** CubicPower OpenStack Study ****
def get_protocol(self, idp_id, protocol_id):
session = sql.get_session()
protocol_ref = self._get_protocol(session, idp_id, protocol_id)
return protocol_ref.to_dict()
**** CubicPower OpenStack Study ****
def list_protocols(self, idp_id):
session = sql.get_session()
q = session.query(FederationProtocolModel)
q = q.filter_by(idp_id=idp_id)
protocols = [protocol.to_dict() for protocol in q]
return protocols
**** CubicPower OpenStack Study ****
def delete_protocol(self, idp_id, protocol_id):
session = sql.get_session()
with session.begin():
key_ref = self._get_protocol(session, idp_id, protocol_id)
q = session.query(FederationProtocolModel)
q = q.filter_by(id=protocol_id, idp_id=idp_id)
q.delete(synchronize_session=False)
session.delete(key_ref)
# Mapping CRUD
**** CubicPower OpenStack Study ****
def _get_mapping(self, session, mapping_id):
mapping_ref = session.query(MappingModel).get(mapping_id)
if not mapping_ref:
raise exception.MappingNotFound(mapping_id=mapping_id)
return mapping_ref
@sql.handle_conflicts(conflict_type='mapping')
**** CubicPower OpenStack Study ****
def create_mapping(self, mapping_id, mapping):
session = sql.get_session()
ref = {}
ref['id'] = mapping_id
ref['rules'] = jsonutils.dumps(mapping.get('rules'))
with session.begin():
mapping_ref = MappingModel.from_dict(ref)
session.add(mapping_ref)
return mapping_ref.to_dict()
**** CubicPower OpenStack Study ****
def delete_mapping(self, mapping_id):
session = sql.get_session()
with session.begin():
mapping_ref = self._get_mapping(session, mapping_id)
session.delete(mapping_ref)
**** CubicPower OpenStack Study ****
def list_mappings(self):
session = sql.get_session()
with session.begin():
mappings = session.query(MappingModel)
return [x.to_dict() for x in mappings]
**** CubicPower OpenStack Study ****
def get_mapping(self, mapping_id):
session = sql.get_session()
with session.begin():
mapping_ref = self._get_mapping(session, mapping_id)
return mapping_ref.to_dict()
@sql.handle_conflicts(conflict_type='mapping')
**** CubicPower OpenStack Study ****
def update_mapping(self, mapping_id, mapping):
ref = {}
ref['id'] = mapping_id
ref['rules'] = jsonutils.dumps(mapping.get('rules'))
session = sql.get_session()
with session.begin():
mapping_ref = self._get_mapping(session, mapping_id)
old_mapping = mapping_ref.to_dict()
old_mapping.update(ref)
new_mapping = MappingModel.from_dict(old_mapping)
for attr in MappingModel.attributes:
setattr(mapping_ref, attr, getattr(new_mapping, attr))
return mapping_ref.to_dict()
**** CubicPower OpenStack Study ****
def get_mapping_from_idp_and_protocol(self, idp_id, protocol_id):
session = sql.get_session()
with session.begin():
protocol_ref = self._get_protocol(session, idp_id, protocol_id)
mapping_id = protocol_ref.mapping_id
mapping_ref = self._get_mapping(session, mapping_id)
return mapping_ref.to_dict()