Table of Contents - sso-0.1.4 Documentation
Pages
-
README
- Setting up an SSO client
- Assumptions
- How it works
- Trusted OAuth clients
- Unstrusted OAuth clients
- Also good to know
- Setup (trusted client)
- Add the gem to your Gemfile
- Make sure you activated the Warden middleware provided by the
warden
gem - Set the URL to the SSO Server
- Setup your login logic
- e.g. config/initializers/warden.rb
- The options are passed on to
::Warden::Manager.after_fetch
- Profit
- README
Classes and Modules
- OmniAuth
- OmniAuth::Strategies
- OmniAuth::Strategies::SSO
- SSO
- SSO::Benchmarking
- SSO::Client
- SSO::Client::Authentications
- SSO::Client::Authentications::Passport
- SSO::Client::Passport
- SSO::Client::PassportVerifier
- SSO::Client::Warden
- SSO::Client::Warden::Hooks
- SSO::Client::Warden::Hooks::AfterFetch
- SSO::Client::Warden::Strategies
- SSO::Client::Warden::Strategies::Passport
- SSO::Configuration
- SSO::Engine
- SSO::Logging
- SSO::Meter
- SSO::Server
- SSO::Server::Authentications
- SSO::Server::Authentications::Passport
- SSO::Server::Doorkeeper
- SSO::Server::Doorkeeper::AccessTokenMarker
- SSO::Server::Doorkeeper::GrantMarker
- SSO::Server::Doorkeeper::ResourceOwnerAuthenticator
- SSO::Server::Errors
- SSO::Server::Middleware
- SSO::Server::Middleware::PassportDestruction
- SSO::Server::Middleware::PassportExchange
- SSO::Server::Middleware::PassportVerification
- SSO::Server::Passport
- SSO::Server::Passports
- SSO::Server::Passports::Activity
- SSO::Server::Warden
- SSO::Server::Warden::Hooks
- SSO::Server::Warden::Hooks::AfterAuthentication
- SSO::Server::Warden::Hooks::BeforeLogout
- SSO::Server::Warden::Strategies
- SSO::Server::Warden::Strategies::Passport
Methods
- ::activate — SSO::Client::Warden::Hooks::AfterFetch
- ::backend — SSO::Server::Passports
- ::config — SSO
- ::configure — SSO
- ::development_environment? — OmniAuth::Strategies::SSO
- ::endpoint — OmniAuth::Strategies::SSO
- ::find — SSO::Server::Passports
- ::find_by_access_token_id — SSO::Server::Passports
- ::find_valid_access_grant — SSO::Server::Passports
- ::find_valid_access_token — SSO::Server::Passports
- ::find_valid_passport — SSO::Server::Passports
- ::find_valid_passport_by_grant_id — SSO::Server::Passports
- ::generate — SSO::Server::Passports
- ::logout — SSO::Server::Passports
- ::new — SSO::Client::Authentications::Passport
- ::new — SSO::Client::Passport
- ::new — SSO::Client::PassportVerifier
- ::new — SSO::Client::Warden::Hooks::AfterFetch
- ::new — SSO::Server::Authentications::Passport
- ::new — SSO::Server::Doorkeeper::AccessTokenMarker
- ::new — SSO::Server::Doorkeeper::GrantMarker
- ::new — SSO::Server::Doorkeeper::ResourceOwnerAuthenticator
- ::new — SSO::Server::Middleware::PassportDestruction
- ::new — SSO::Server::Middleware::PassportExchange
- ::new — SSO::Server::Middleware::PassportVerification
- ::new — SSO::Server::Passports::Activity
- ::new — SSO::Server::Warden::Hooks::AfterAuthentication
- ::new — SSO::Server::Warden::Hooks::BeforeLogout
- ::passports_path — OmniAuth::Strategies::SSO
- ::register_access_token_from_grant — SSO::Server::Passports
- ::register_access_token_from_id — SSO::Server::Passports
- ::register_authorization_grant — SSO::Server::Passports
- ::test_environment? — OmniAuth::Strategies::SSO
- ::to_proc — SSO::Server::Doorkeeper::ResourceOwnerAuthenticator
- ::to_proc — SSO::Server::Warden::Hooks::AfterAuthentication
- ::to_proc — SSO::Server::Warden::Hooks::BeforeLogout
- ::update_activity — SSO::Server::Passports
- #agent — SSO::Client::Authentications::Passport
- #agent — SSO::Client::Warden::Hooks::AfterFetch
- #applicable? — SSO::Server::Doorkeeper::AccessTokenMarker
- #auth_hash — SSO::Client::PassportVerifier
- #authenticate — SSO::Client::Authentications::Passport
- #authenticate — SSO::Server::Authentications::Passport
- #authenticate! — SSO::Client::Authentications::Passport
- #authenticate! — SSO::Client::Warden::Strategies::Passport
- #authenticate! — SSO::Server::Authentications::Passport
- #authenticate! — SSO::Server::Warden::Strategies::Passport
- #authorization_grant_flow? — SSO::Server::Doorkeeper::AccessTokenMarker
- #backend — SSO::Server::Authentications::Passport
- #base_endpoint — SSO::Client::PassportVerifier
- #benchmark — SSO::Benchmarking
- #call — SSO::Client::PassportVerifier
- #call — SSO::Client::Warden::Hooks::AfterFetch
- #call — SSO::Server::Doorkeeper::AccessTokenMarker
- #call — SSO::Server::Doorkeeper::GrantMarker
- #call — SSO::Server::Doorkeeper::ResourceOwnerAuthenticator
- #call — SSO::Server::Middleware::PassportDestruction
- #call — SSO::Server::Middleware::PassportExchange
- #call — SSO::Server::Middleware::PassportVerification
- #call — SSO::Server::Passports::Activity
- #call — SSO::Server::Warden::Hooks::AfterAuthentication
- #call — SSO::Server::Warden::Hooks::BeforeLogout
- #caller_name — SSO::Meter
- #check_arguments — SSO::Server::Authentications::Passport
- #check_request_signature — SSO::Client::Authentications::Passport
- #chip — SSO::Client::Authentications::Passport
- #chip! — SSO::Server::Passport
- #chip_belongs_to_passport? — SSO::Client::Authentications::Passport
- #chip_ciphertext — SSO::Client::Authentications::Passport
- #chip_ciphertext_and_iv — SSO::Client::Authentications::Passport
- #chip_decryption — SSO::Client::Authentications::Passport
- #chip_digest — SSO::Client::Authentications::Passport
- #chip_digest — SSO::Server::Passport
- #chip_iv — SSO::Client::Authentications::Passport
- #chip_key — SSO::Client::Authentications::Passport
- #chip_key — SSO::Server::Passport
- #chip_passport_id — SSO::Client::Authentications::Passport
- #chip_passport_secret — SSO::Client::Authentications::Passport
- #chip_plaintext — SSO::Server::Passport
- #code — SSO::Server::Doorkeeper::GrantMarker
- #create_chip! — SSO::Server::Passport
- #current_user — SSO::Server::Doorkeeper::ResourceOwnerAuthenticator
- #debug — SSO::Logging
- #decrypt_chip — SSO::Client::Authentications::Passport
- #decrypt_chip! — SSO::Client::Authentications::Passport
- #default_environment — SSO::Configuration
- #default_exception_handler — SSO::Configuration
- #default_human_readable_location_for_ip — SSO::Configuration
- #default_log_level — SSO::Configuration
- #default_logger — SSO::Configuration
- #default_metric — SSO::Configuration
- #default_passport_verification_timeout_ms — SSO::Configuration
- #default_session_backend — SSO::Configuration
- #delta — SSO::Client::Passport
- #device_id — SSO::Client::Authentications::Passport
- #device_id — SSO::Client::Warden::Hooks::AfterFetch
- #encoded_chip_ciphertext — SSO::Client::Authentications::Passport
- #encoded_chip_iv — SSO::Client::Authentications::Passport
- #endpoint — SSO::Client::PassportVerifier
- #ensure_activity_at — SSO::Server::Passport
- #ensure_secret — SSO::Server::Passport
- #environment — SSO::Configuration
- #environment= — SSO::Configuration
- #error — SSO::Logging
- #exception_handler — SSO::Configuration
- #export — SSO::Server::Passport
- #failure_rack_array — SSO::Client::Authentications::Passport
- #failure_rack_array — SSO::Server::Authentications::Passport
- #fatal — SSO::Logging
- #fetch_response — SSO::Client::PassportVerifier
- #find_user_for_passport — SSO::Configuration
- #grant_token — SSO::Server::Doorkeeper::AccessTokenMarker
- #grant_type — SSO::Server::Doorkeeper::AccessTokenMarker
- #handle_authorization_grant_flow — SSO::Server::Doorkeeper::AccessTokenMarker
- #handle_password_flow — SSO::Server::Doorkeeper::AccessTokenMarker
- #human_readable_location_for_ip — SSO::Configuration
- #human_readable_timeout_in_ms — SSO::Client::PassportVerifier
- #immediate_ip — SSO::Server::Passports::Activity
- #info — SSO::Logging
- #insider_id — SSO::Client::PassportVerifier
- #insider_id — SSO::Server::Passports::Activity
- #insider_secret — SSO::Client::PassportVerifier
- #insider_signature — SSO::Client::PassportVerifier
- #insider_signature — SSO::Server::Passports::Activity
- #interpret_response — SSO::Client::PassportVerifier
- #ip — SSO::Client::Authentications::Passport
- #ip — SSO::Client::Warden::Hooks::AfterFetch
- #json_code — SSO::Server::Middleware::PassportDestruction
- #json_error — SSO::Server::Middleware::PassportExchange
- #load_user! — SSO::Server::Passport
- #location_header — SSO::Server::Doorkeeper::GrantMarker
- #logger — SSO::Configuration
- #logger — SSO::Logging
- #meter — SSO::Client::Warden::Hooks::AfterFetch
- #metric — SSO::Configuration
- #metric — SSO::Meter
- #modified! — SSO::Client::Passport
- #modified? — SSO::Client::Passport
- #oauth_client_id — SSO::Configuration
- #oauth_client_secret — SSO::Configuration
- #outgoing_access_token — SSO::Server::Doorkeeper::AccessTokenMarker
- #outgoing_grant_token — SSO::Server::Doorkeeper::GrantMarker
- #params — SSO::Client::PassportVerifier
- #params — SSO::Server::Authentications::Passport
- #parsed_response — SSO::Client::PassportVerifier
- #parsed_response_body — SSO::Server::Doorkeeper::AccessTokenMarker
- #passport — SSO::Server::Authentications::Passport
- #passport! — SSO::Server::Authentications::Passport
- #passport_authentication — SSO::Client::Warden::Strategies::Passport
- #passport_authentication — SSO::Server::Warden::Strategies::Passport
- #passport_chip_key — SSO::Configuration
- #passport_id — SSO::Server::Authentications::Passport
- #passport_id — SSO::Server::Doorkeeper::GrantMarker
- #passport_invalid! — SSO::Client::Warden::Hooks::AfterFetch
- #passport_valid! — SSO::Client::Warden::Hooks::AfterFetch
- #passport_valid_and_modified! — SSO::Client::Warden::Hooks::AfterFetch
- #passport_verification_timeout_ms — SSO::Configuration
- #passports_path — SSO::Server::Middleware::PassportDestruction
- #passports_path — SSO::Server::Middleware::PassportExchange
- #passports_path — SSO::Server::Middleware::PassportVerification
- #password_flow? — SSO::Server::Doorkeeper::AccessTokenMarker
- #path — SSO::Client::PassportVerifier
- #path — SSO::Server::Authentications::Passport
- #progname — SSO::Logging
- #proxied_ip — SSO::Server::Passports::Activity
- #query_params — SSO::Client::PassportVerifier
- #raw_info — OmniAuth::Strategies::SSO
- #received_passport — SSO::Client::PassportVerifier
- #received_passport_attributes — SSO::Client::PassportVerifier
- #redirect_uri — SSO::Server::Doorkeeper::GrantMarker
- #redirect_uri_params — SSO::Server::Doorkeeper::GrantMarker
- #request — SSO::Server::Doorkeeper::GrantMarker
- #response — SSO::Client::PassportVerifier
- #response! — SSO::Client::PassportVerifier
- #response_body — SSO::Server::Doorkeeper::AccessTokenMarker
- #response_code — SSO::Client::PassportVerifier
- #response_code — SSO::Server::Doorkeeper::AccessTokenMarker
- #response_has_success_flag? — SSO::Client::PassportVerifier
- #retrieve_passport — SSO::Client::Authentications::Passport
- #server_response_missing_success_flag! — SSO::Client::Warden::Hooks::AfterFetch
- #server_response_not_parseable! — SSO::Client::Warden::Hooks::AfterFetch
- #server_unreachable! — SSO::Client::Warden::Hooks::AfterFetch
- #session — SSO::Server::Doorkeeper::AccessTokenMarker
- #session_backend — SSO::Configuration
- #signature_digest — SSO::Client::PassportVerifier
- #signature_digest — SSO::Server::Passports::Activity
- #signature_request — SSO::Client::Authentications::Passport
- #signature_request — SSO::Client::PassportVerifier
- #signature_request — SSO::Server::Authentications::Passport
- #state — SSO::Server::Authentications::Passport
- #state — SSO::Server::Passport
- #state! — SSO::Server::Passport
- #success_new_state_rack_array — SSO::Server::Authentications::Passport
- #success_same_state_rack_array — SSO::Server::Authentications::Passport
- #timeout_in_milliseconds — SSO::Client::PassportVerifier
- #timeout_in_seconds — SSO::Client::PassportVerifier
- #timing — SSO::Meter
- #to_s — SSO::Server::Passport
- #token — SSO::Client::PassportVerifier
- #track — SSO::Meter
- #trusted_proxy_app? — SSO::Server::Passports::Activity
- #unexpected_server_response_status! — SSO::Client::Warden::Hooks::AfterFetch
- #unmodified? — SSO::Client::Passport
- #unverified? — SSO::Client::Passport
- #update_location — SSO::Server::Passport
- #update_passport — SSO::Server::Authentications::Passport
- #user_state_base — SSO::Configuration
- #user_state_base — SSO::Server::Passport
- #user_state_digest — SSO::Client::Authentications::Passport
- #user_state_digest — SSO::Server::Passport
- #user_state_key — SSO::Configuration
- #user_state_key — SSO::Server::Passport
- #valid? — SSO::Client::Warden::Strategies::Passport
- #valid? — SSO::Server::Warden::Strategies::Passport
- #valid_signature? — SSO::Server::Authentications::Passport
- #verb — SSO::Server::Authentications::Passport
- #verification — SSO::Client::Authentications::Passport
- #verification — SSO::Client::Warden::Hooks::AfterFetch
- #verification_code — SSO::Client::Warden::Hooks::AfterFetch
- #verification_object — SSO::Client::Warden::Hooks::AfterFetch
- #verified! — SSO::Client::Passport
- #verified? — SSO::Client::Passport
- #verifier — SSO::Client::Authentications::Passport
- #verifier — SSO::Client::Warden::Hooks::AfterFetch
- #verifier_options — SSO::Client::Authentications::Passport
- #verify — SSO::Client::Warden::Hooks::AfterFetch
- #warden — SSO::Server::Doorkeeper::AccessTokenMarker
- #warden — SSO::Server::Doorkeeper::GrantMarker
- #warden — SSO::Server::Doorkeeper::ResourceOwnerAuthenticator
- #warden_scope — SSO::Client::Warden::Hooks::AfterFetch
- #warn — SSO::Logging