From d8f9c77a62a7bfea82e892f8ecb309630826fed5 Mon Sep 17 00:00:00 2001 From: Ade Lee Date: Thu, 24 Sep 2015 23:36:43 -0400 Subject: Added Features REST API resource This will help us track whether or not a server has a feature either offered or enabled. Ultimately, it could be used by an admin to enable or disable features. The Java client is not included in this commit. Will add in a subsequent commit. --- base/common/python/pki/feature.py | 170 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 base/common/python/pki/feature.py (limited to 'base/common/python') diff --git a/base/common/python/pki/feature.py b/base/common/python/pki/feature.py new file mode 100644 index 000000000..fd9d40551 --- /dev/null +++ b/base/common/python/pki/feature.py @@ -0,0 +1,170 @@ +#!/usr/bin/python + +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; version 2 of the License. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with this program; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +# +# Copyright (C) 2014 Red Hat, Inc. +# All rights reserved. +# +# Author: +# Ade Lee + +from __future__ import absolute_import +from __future__ import print_function + +from six import iteritems + +import pki +import pki.client as client +import pki.encoder as encoder + + +class Feature(object): + """Class containing data about Features advertised by the CS server + """ + + json_attribute_names = { + 'id': 'feature_id', + 'description': 'description', + 'enabled': 'enabled', + 'version': 'version' + } + + def __init__(self, feature_id=None, version=None, description=None, + enabled="False"): + self.feature_id = feature_id + self.version = version + self.description = description + self.enabled = (enabled.lower() == "true") + + def __repr__(self): + attributes = { + "Feature": { + "feature_id": self.feature_id, + "description": self.description, + "version": self.version, + "enabled": self.enabled + } + } + return str(attributes) + + @classmethod + def from_json(cls, attr_list): + """ Return Feature object from JSON dict """ + feature = cls() + + for k, v in iteritems(attr_list): + if k in Feature.json_attribute_names: + setattr(feature, Feature.json_attribute_names[k], v) + else: + setattr(feature, k, v) + + return feature + + +class FeatureCollection(object): + """ + Class containing list of Feature objects. + This data is returned when listing features. + """ + + def __init__(self): + """ Constructor """ + self.feature_list = [] + self.links = [] + + def __iter__(self): + return iter(self.feature_list) + + @classmethod + def from_json(cls, json_value): + """ Populate object from JSON input """ + ret = cls() + features = json_value + if not isinstance(features, list): + ret.feature_list.append(Feature.from_json(features)) + else: + for feature in features: + ret.feature_list.append( + Feature.from_json(feature)) + + return ret + + +class FeatureClient(object): + """ + Class encapsulating and mirroring the functionality in the + AuthorityResource Java interface class defining the REST API for + subordinate CA (authority) resources. + """ + + def __init__(self, connection): + """ Constructor """ + self.connection = connection + self.headers = {'Content-type': 'application/json', + 'Accept': 'application/json'} + self.feature_url = '/rest/config/features' + + @pki.handle_exceptions() + def get_feature(self, feature_id): + """ Return a Feature object. """ + if feature_id is None: + raise ValueError("Feature ID must be specified") + + url = self.feature_url + '/' + str(feature_id) + r = self.connection.get(url, self.headers) + return Feature.from_json(r.json()) + + @pki.handle_exceptions() + def list_features(self): + """ Return a FeatureCollection object of all available features + """ + response = self.connection.get( + path=self.feature_url, + headers=self.headers) + return FeatureCollection.from_json(response.json()) + +encoder.NOTYPES['Feature'] = Feature + + +def main(): + # Create a PKIConnection object that stores the details of the CA. + connection = client.PKIConnection('https', 'localhost', '8453', 'ca') + + # Instantiate the FeatureClient + feature_client = FeatureClient(connection) + + # List all features + print("Listing all features") + print("-----------------------") + features = feature_client.list_features() + for feature in features.feature_list: + print(str(feature)) + + # Get authority feature + print("Getting authority feature") + print("-------------------------") + feature = feature_client.get_feature("authority") + print(str(feature)) + + # Get non-existent feature + print("Get non-existent feature") + print("------------------------") + try: + feature_client.get_feature("foobar") + except pki.ResourceNotFoundException as e: + print(e.message) + + +if __name__ == "__main__": + main() -- cgit