{"id":13880419,"url":"https://github.com/dennisreimann/masq","last_synced_at":"2025-07-16T16:31:52.754Z","repository":{"id":2693208,"uuid":"3686295","full_name":"dennisreimann/masq","owner":"dennisreimann","description":"Mountable Rails engine that provides OpenID server/identity provider functionality","archived":true,"fork":false,"pushed_at":"2015-12-31T13:58:26.000Z","size":497,"stargazers_count":85,"open_issues_count":6,"forks_count":18,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-11-24T09:33:51.090Z","etag":null,"topics":["identity-provider","openid","openid-server","rails-engine"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dennisreimann.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-11T11:25:26.000Z","updated_at":"2023-12-07T14:59:33.000Z","dependencies_parsed_at":"2022-08-28T12:22:23.133Z","dependency_job_id":null,"html_url":"https://github.com/dennisreimann/masq","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/dennisreimann/masq","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dennisreimann%2Fmasq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dennisreimann%2Fmasq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dennisreimann%2Fmasq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dennisreimann%2Fmasq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dennisreimann","download_url":"https://codeload.github.com/dennisreimann/masq/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dennisreimann%2Fmasq/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265524647,"owners_count":23782016,"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":["identity-provider","openid","openid-server","rails-engine"],"created_at":"2024-08-06T08:03:01.262Z","updated_at":"2025-07-16T16:31:52.236Z","avatar_url":"https://github.com/dennisreimann.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Masq OpenID Server\n\n[![Gem Version](https://badge.fury.io/rb/masq.png)](http://badge.fury.io/rb/masq)\n[![Build Status](https://secure.travis-ci.org/dennisreimann/masq.png)](http://travis-ci.org/dennisreimann/masq)\n\nMasq is a mountable Rails engine that provides OpenID server/identity provider functionality.\nIt is the successor of the stand-alone Rails application [masquerade](http://github.com/dennisreimann/masquerade/).\n\nThe project is released under the MIT-License and its source code is available at [GitHub](http://github.com/dennisreimann/masquerade/).\nFeel free to fork and submit patches :)\n\n## Installation\n\n_If you want to upgrade from masquerade, please skip this part and see the Upgrading section below_\n\n0. In case you want to run masq as a standalone application (not integrated into an existing app), you will have to generate a barebone Rails app first:\n    * `rails new my_openid_provider`\n\n1. Add masq to your Gemfile and install it:\n    * `gem 'masq'`\n    * `bundle install`\n\n2. Copy the configuration and edit it:\n    * `bundle exec rake masq:install:config`\n    * `$EDITOR config/masq.yml`\n\n3. Copy the migrations and migrate:\n    * `bundle exec rake masq:install:migrations`\n    * `bundle exec rake db:migrate`\n\n4. Configure the routes by mounting the masq engine:\n    * For integration into an existing app, mount it in a subdirectory, like:\n        * `mount Masq::Engine =\u003e \"/masq\"` or\n        * `mount Masq::Engine =\u003e \"/openid\"`\n    * Standalone installation, mount it at the root:\n        * `mount Masq::Engine =\u003e \"/\"`\n\n## Upgrading from masquerade\n\n1. Generate a barebone Rails app:\n    * `rails new my_openid_provider`\n\n2. Add masq to your Gemfile and install it:\n    * `gem 'masq'`\n    * `bundle install`\n\n3. Copy your existing masquerade config file from `config/app_config.yml` to the new apps `config/masq.yml`\n\n4. Copy the migrations and migrate:\n    * PLEASE BACKUP YOUR DATABASE FIRST!\n    * `bundle exec rake masq:install:migrations`\n    * `bundle exec rake db:migrate`\n\n5. Configure the routes by mounting the masq engine:\n\n        Rails.application.routes.draw do\n          mount Masq::Engine =\u003e \"/\"\n        end\n\n## Testing the installation\n\nYou can test the functionality in your local environment starting two instances: One as\nyour Identity Provider/OpenID Server and another one as Relying Party.\n\n    * `rails server`\n    * `rails server -p 3001`\n\nOpen your browser with these urls (assumes you mounted the engine at */masq*):\n\n    * [http://localhost:3000/masq](http://localhost:3000/masq) (Identity Provider)\n    * [http://localhost:3001/masq/consumer](http://localhost:3001/masq/consumer) (Relying Party testsuite)\n\nFirst you have to create an account at the Identity Provider, after that you will be able\nto use the issued OpenID URL (`http://localhost:3000/masq/YOUR_LOGIN`) to send requests from the\nRelying Party to the server.\n\nUse the options provided by the OpenID verification form to test several aspects of the\nclient-server communication (like requesting simple registration data).\n\n## Development\n\n### Introduction\n\nThe main functionality is in the server controller, which is the endpoint for incoming\nOpenID requests. The server controller is supposed to only interact with relying parties\na.k.a. consumer websites. It includes the OpenidServerSystem module, which provides some\nhandy methods to access and answer OpenID requests.\n\n### Testing\n\nYou can run the tests with Rake:\n    * `DB_ADAPTER=sqlite3 bundle exec rake app:masq:test:ci`\n    * `DB_ADAPTER=mysql2 bundle exec rake app:masq:test:ci`\n    * `DB_ADAPTER=postgresql bundle exec rake app:masq:test:ci`\n\nThe Rake task configures the database.yml for the chosen adapter.\n\nIn case you prefer running the tests continuously, use Guard:\n    * `bundle exec guard`\n\n## Contact\n\nDennis Reimann: [mail@dennisreimann.de](mailto:mail@dennisreimann.de)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdennisreimann%2Fmasq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdennisreimann%2Fmasq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdennisreimann%2Fmasq/lists"}