<commit_before># FederatedRails - 0.1

Allows Ruby on Rails applications to easily integrate to federated authentication sources particuarly those served by Shibboleth service providers.

Utilizes Warden as an underlying mechanism so can be adjusted for non RoR rack applications with relative ease.

Concepts
--------
* Subject - Security specific view of an entity capable of being authenticated to an application. It can be a human being, a third-party process, a server etc. Also referred to as ‘user’.
* Principal - A subjects uniquely identifying attribute. This is generally mapped to the federation attribute eduPersonTargetedID. For non federated applications this is commonly referred to as a ‘username’
* Credentials - Data used to verify identity at session establishment. For integrators this is the associated SAML assertion and is represented by a unique internal sessionID. For non federated applications this is usually a ‘password’
 * Attributes - A subjects identifying attributes. Names, email, entitlements etc.For non federated applications these need to manually entered. For federated applications they are in many cases automatically supplied.

Documentation
-------------
You'll find all the documentation for FederatedRails at http://wiki.aaf.edu.au/spintegrators/federatedrails

Installation
------------
This isn't currently published to a gem repository given early release status.

Clone the repository to your local disk and in your Gemfile add:

gem 'federated_rails', '0.1.0', :path => "yourpath/federated_rails"

Alternatively use the bundler git syntax. 

Once this is done execute the supplied generator

rails g federated_rails:install Subject
Subject should be the name of your subject class you can change this to say User if this better suits your application.

Then simply continue with Bundler as normal.

Contributing
------------
All contributions welcome. Simply fork and send a pull request when you have something new or log an issue.

Credits
-------
FederatedRails was written by <NAME> on behalf of the Australian Access Federation.<commit_msg>fixed unaligned list element<commit_after># FederatedRails - 0.1

Allows Ruby on Rails applications to easily integrate to federated authentication sources particuarly those served by Shibboleth service providers.

Utilizes Warden as an underlying mechanism so can be adjusted for non RoR rack applications with relative ease.

Concepts
--------
* Subject - Security specific view of an entity capable of being authenticated to an application. It can be a human being, a third-party process, a server etc. Also referred to as ‘user’.
* Principal - A subjects uniquely identifying attribute. This is generally mapped to the federation attribute eduPersonTargetedID. For non federated applications this is commonly referred to as a ‘username’
* Credentials - Data used to verify identity at session establishment. For integrators this is the associated SAML assertion and is represented by a unique internal sessionID. For non federated applications this is usually a ‘password’
* Attributes - A subjects identifying attributes. Names, email, entitlements etc.For non federated applications these need to manually entered. For federated applications they are in many cases automatically supplied.

Documentation
-------------
You'll find all the documentation for FederatedRails at http://wiki.aaf.edu.au/spintegrators/federatedrails

Installation
------------
This isn't currently published to a gem repository given early release status.

Clone the repository to your local disk and in your Gemfile add:

gem 'federated_rails', '0.1.0', :path => "yourpath/federated_rails"

Alternatively use the bundler git syntax. 

Once this is done execute the supplied generator

rails g federated_rails:install Subject
Subject should be the name of your subject class you can change this to say User if this better suits your application.

Then simply continue with Bundler as normal.

Contributing
------------
All contributions welcome. Simply fork and send a pull request when you have something new or log an issue.

Credits
-------
FederatedRails was written by <NAME> on behalf of the Australian Access Federation.
{'fraction_non_alphanumeric': 0.05946717411988582, 'fraction_numerical': 0.002378686964795433, 'mean_word_length': 4.262828535669587, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5762815', 'n_tokens_mistral': 994, 'n_tokens_neox': 949, 'n_words': 562}