{"id":13546709,"url":"https://github.com/ging/fiware-idm-deprecated","last_synced_at":"2025-04-02T18:31:29.034Z","repository":{"id":24812465,"uuid":"28226729","full_name":"ging/fiware-idm-deprecated","owner":"ging","description":"DEPRECATED - Identity Manager - Keyrock","archived":true,"fork":false,"pushed_at":"2019-03-14T14:19:06.000Z","size":2911,"stargazers_count":18,"open_issues_count":9,"forks_count":25,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-11-03T14:36:08.121Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"API Blueprint","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ging.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-19T11:23:36.000Z","updated_at":"2024-01-30T19:51:40.000Z","dependencies_parsed_at":"2022-08-23T06:50:54.550Z","dependency_job_id":null,"html_url":"https://github.com/ging/fiware-idm-deprecated","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ging%2Ffiware-idm-deprecated","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ging%2Ffiware-idm-deprecated/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ging%2Ffiware-idm-deprecated/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ging%2Ffiware-idm-deprecated/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ging","download_url":"https://codeload.github.com/ging/fiware-idm-deprecated/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246869869,"owners_count":20847208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:00:43.500Z","updated_at":"2025-04-02T18:31:28.263Z","avatar_url":"https://github.com/ging.png","language":"API Blueprint","funding_links":[],"categories":["API Blueprint","others"],"sub_categories":[],"readme":"***********************************\nImportant information\n***********************************\nThis is an archive of the code repository for the previous  Horizion + Keystone-based version of  the FIWARE Identity Manager project. The current code repositiory for this project can be found at: https://github.com/ging/fiware-idm\n\n***********************************\nIdentity Manager - Keyrock Overview\n***********************************\n\n.. image:: https://img.shields.io/badge/license-APACHE-blue.svg\n   :target: http://www.apache.org/licenses/LICENSE-2.0\n   \n.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat\n   :target: http://fiware-idm.readthedocs.org/en/latest/\n   \n.. image:: https://img.shields.io/docker/pulls/fiware/idm.svg\n   :target: https://hub.docker.com/r/fiware/idm/\n   \n.. image:: https://img.shields.io/badge/support-sof-yellowgreen.svg\n   :target: http://stackoverflow.com/questions/tagged/fiware\n\n.. contents::\n   :local:\n   :depth: 3\n\n.. _introduction:\n\nIntroduction\n============\n\nThis project is part of `FIWARE \u003chttp://fiware.org\u003e`__. You may find\nmore information about this FIWARE GE\n`here \u003chttp://catalogue.fiware.org/enablers/identity-management-keyrock\u003e`__.\n\n-  You may find the source code of this project in GitHub `here \u003chttps://github.com/ging/fiware-idm\u003e`__\n-  You may find the documentation of this project in Read the Docs `here \u003chttp://fiware-idm.readthedocs.org/\u003e`__\n\nWelcome to the main repository for the UPM's implementation of the\nFIWARE Identity Manager Generic Enabler. This repository acts as an\nentry point and holds the documentation and some automated tools for\ninstallation and management. The IdM is composed of two independent\ncomponents: a RESTful back-end and web front-end.\n\nIf you want to see the\ncode for each of the components of the IdM and more specific\ndocumentation please head to each component's repository:\n\n-  Horizon based front-end `ging/horizon \u003chttps://github.com/ging/horizon\u003e`__\n-  Keystone based back-end `ging/keystone \u003chttps://github.com/ging/keystone\u003e`__\n\nYou can see a working installation in the FIWARE Lab sandbox environment\nhttps://account.lab.fiware.org/\n\n.. begin-requirements\n\nRequirements\n------------\n\nIdentity Manager - KeyRock requires Ubuntu 12.04 or greater.\n\nBoth Horizon, for the front-end, and Keystone, for the back-end, must be\ninstalled in order for the generic enabler to run correctly. They can be installed\nin the same machine or in two separated ones. If you choose to separate them, the\ntwo machines must be able to communicate to each other through the network.\n\n.. end-requirements\n\n.. _build:\n\nHow to Build \u0026 Install\n======================\n\nThe IdM is made up of two components: the web-based front-end and the\nrestful back-end. You can check specific documentation in their respective repositories.\n\n\nInstalling the back-end\n-----------------------\n\n.. begin-keystone-installation\n\n1. Install the Ubuntu dependencies\n  ::\n\n      $ sudo apt-get install python python-dev python-virtualenv libxml2-dev libxslt1-dev libsasl2-dev libssl-dev libldap2-dev libffi-dev libsqlite3-dev libmysqlclient-dev python-mysqldb\n\n2. Get the code from our `GitHub repository \u003chttps://github.com/ging/keystone\u003e`__\n  :: \n\n      $ git clone https://github.com/ging/keystone \u0026\u0026 cd keystone\n\n3. Install the python dependencies\n  ::\n\n    $ sudo python tools/install_venv.py\n\n\n4. Create a configuration file\n  ::\n\n    $ cp etc/keystone.conf.sample etc/keystone.conf\n\n5. Create the tables and populate the database\n\n  .. begin-database\n\n  ::\n      \n      $ sudo tools/with_venv.sh bin/keystone-manage -v db_sync\n      $ sudo tools/with_venv.sh bin/keystone-manage -v db_sync --extension=oauth2\n      $ sudo tools/with_venv.sh bin/keystone-manage -v db_sync --extension=roles\n      $ sudo tools/with_venv.sh bin/keystone-manage -v db_sync --extension=user_registration\n      $ sudo tools/with_venv.sh bin/keystone-manage -v db_sync --extension=two_factor_auth\n      $ sudo tools/with_venv.sh bin/keystone-manage -v db_sync --extension=endpoint_filter\n      $ sudo tools/with_venv.sh bin/keystone-manage -v db_sync --populate\n\n  .. end-database\n\n6. Finally, you can run keystone from the console\n  ::\n\n    $ sudo tools/with_venv.sh bin/keystone-all -v\n\nYou may now log into the web (if you have Horizon installed) using the administrative account (by\ndefault, user is `idm` and the password is the one you entered during the populate step).\n\n.. note:: \n  If you want to run the Keystone backend in the backgroud you\n  can :ref:`install it as a service \u003ckeystone-as-service\u003e`.\n\n.. end-keystone-installation\n\nNow, head on to the :ref:`configuration instructions \u003ckeystone-configuration\u003e`.\n\n(You can read more in-depth documentation at the `Installation \u0026 Administration Guide \u003chttp://fiware-idm.readthedocs.org/en/latest/admin_guide.html\u003e`__)\n\nInstalling the front-end\n------------------------\n\n.. begin-horizon-installation\n\n1. Install the Ubuntu dependencies\n  ::\n\n      $ sudo apt-get install python python-dev python-virtualenv libssl-dev libffi-dev libjpeg8-dev\n\n2. Get the code from our `GitHub repository \u003chttps://github.com/ging/horizon\u003e`__\n  :: \n\n      $ git clone https://github.com/ging/horizon \u0026\u0026 cd horizon\n\n3. Create a configuration file\n  ::\n\n    $ cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py\n\n4. Install the python dependencies\n  ::\n\n    $ sudo python tools/install_venv.py\n\nYou can now check that everything went OK by running the development server, but you\nwon't be able to log in until you install the backend.\n::\n\n    $ sudo tools/with_venv.sh python manage.py runserver localhost:8000\n\n.. note ::\n  If you want to run the Horizon frontend in the backgroud you\n  can install it as a service or, for a production environment, run it under Apache.\n\n.. end-horizon-installation\n\nNow, head to the :ref:`configuration instructions \u003chorizon-configuration\u003e`.\n\n(You can read more in-depth documentation at the `Installation \u0026 Administration Guide \u003chttp://fiware-idm.readthedocs.org/en/latest/admin_guide.html\u003e`__)\n\n.. _extras:\n\nOther Installation options\n--------------------------\n\nDocker\n^^^^^^\n\nWe provide a Docker image to facilitate you the building of this\nGE.\n\n-  `Here \u003chttps://github.com/ging/fiware-idm/tree/master/extras/docker\u003e`__\n   you will find the Dockerfile and the documentation explaining how to\n   use it.\n-  In `Docker Hub \u003chttps://hub.docker.com/r/fiware/idm/\u003e`__ you\n   will find the public image.\n\nVM Image\n^^^^^^^^\nWe provide an installation script that can be run within a Ubuntu\nvirtual machine. This script installs the whole Identity Manager, and\nsets it up to run in background.\n\nYou can find the installation script and a verification script `here \u003chttps://github.com/ging/fiware-idm/tree/master/extras/scripts\u003e`__.\n\nThis image contains the following settings as defaults, but you can change any of them after installation, as you can see in the :ref:`horizon \u003chorizon-configuration\u003e` and the :ref:`keystone \u003ckeystone-configuration\u003e` configuration instructions:\n\n+---------------+--------------+\n| Setting       | Value        |\n+===============+==============+\n| idm user      | :code:`idm`  |\n+---------------+--------------+\n| idm password  | :code:`idm`  |\n+---------------+--------------+\n| Horizon port  | :code:`8000` |\n+---------------+--------------+\n| Keystone port | :code:`5000` |\n+---------------+--------------+\n\nChef\n^^^^\nWe also provide a Chef Cookbook, which you can find `here \u003chttps://github.com/ging/fiware-idm/tree/master/extras/chef\u003e`__.\n\n\n.. _api:\n\nAPI Overview\n=============\n\nKeyrock back-end is based on Openstack\n`Keystone \u003chttp://docs.openstack.org/developer/keystone/\u003e`__ project, so\nit exports all the Keystone API. However, Keyrock implements some custom\nextensions that have their own REST APIs. Furthermore, to facilitate the\naccess to some identity resources we have enabled an `SCIM\n2.0 \u003chttp://www.simplecloud.info/\u003e`__ API.\n\nFinally, one of the main uses of Keyrock is to allow developers to add\nidentity management (authentication and authorization) to their\napplications based on FIWARE identity. This is posible thanks to\n`OAuth2 \u003chttp://oauth.net/2/\u003e`__ protocol.\n\n-  `Keystone\n   API \u003chttp://developer.openstack.org/api-ref-identity-v3.html\u003e`__\n-  `Keyrock extensions\n   API \u003chttp://docs.keyrock.apiary.io/#reference/keystone-extensions\u003e`__\n-  `SCIM 2.0 API \u003chttp://docs.keyrock.apiary.io/#reference/scim-2.0\u003e`__\n-  `OAuth2 API \u003chttp://fiware-idm.readthedocs.org/en/latest/oauth2.html\u003e`__\n\nYou will find the full API description\n`here \u003chttp://docs.keyrock.apiary.io/\u003e`__\n\n\nChanges introduced in 5.x\n=========================\n\nThis section is for users of the 4.x versions. They biggest change introduced\nin 5.x is the removal Fabric tasks. The functionality in the tasks has been moved elsewhere, converted to a CLI or removed completely.\n\n- A new CLI tool to help with admin tasks. Documentation :ref:`here \u003ccli-tools\u003e`\n- The instalation now is always done step by step.\n- The population script for the keystone database is now part of keystone.\n\nCheck the release notes for a full list of changes and new features.\n\n.. _advanced:\n\nAdvanced Documentation\n======================\n\n-  `User \u0026 Programmers\n   Manual \u003chttp://fiware-idm.readthedocs.org/en/latest/user_guide.html\u003e`__\n-  `Installation \u0026 Administration\n   Guide \u003chttp://fiware-idm.readthedocs.org/en/latest/admin_guide.html\u003e`__\n-  `Production set-up\n   guide \u003chttp://fiware-idm.readthedocs.org/en/latest/setup.html\u003e`__\n-  `How to run\n   tests \u003chttp://fiware-idm.readthedocs.org/en/latest/admin_guide.html#end-to-end-testing\u003e`__\n-  `Using the FIWARE LAB instance\n   (OAuth2) \u003chttp://fiware-idm.readthedocs.org/en/latest/oauth2.html\u003e`__\n-  `Developers and contributors\n   Guide \u003chttp://fiware-idm.readthedocs.org/en/latest/developer_guide.html\u003e`__\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fging%2Ffiware-idm-deprecated","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fging%2Ffiware-idm-deprecated","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fging%2Ffiware-idm-deprecated/lists"}