ueberauth_cas

Central Authentication Service strategy for Überauth

Monthly Downloads: 553

Programming language: Elixir

License: MIT License

Tags: Authentication    

Latest version: v2.2.0

README

Überauth CAS Strategy

Central Authentication Service (CAS) strategy for Überauth.

Installation

1. Add :ueberauth and :ueberauth_cas to your list of dependencies in mix.exs:

   def deps do
     [
       {:ueberauth, "~> 0.7"},
       {:ueberauth_cas, "~> 2.0"}
     ]
   end

1. Ensure :ueberauth_cas is started before your application:

   def application do
     [applications: [:ueberauth_cas]]
   end

1. Configure the CAS integration in config/config.exs:

   config :ueberauth, Ueberauth,
     providers: [cas: {Ueberauth.Strategy.CAS, [
       base_url: "http://cas.example.com",
       callback_url: "http://your-app.example.com/auth/cas/callback",
       # sanitize_attribute_names: false,
     ]}]

1. Include the Überauth plug in your controller:

   defmodule MyApp.AuthController do
     use MyApp.Web, :controller
     plug Ueberauth
     ...
   end

1. Create the request and callback routes if you haven't already:

   scope "/auth", MyApp do
     pipe_through :browser

     get "/:provider", AuthController, :request
     get "/:provider/callback", AuthController, :callback
   end

1. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

Compatibility

Überauth CAS was tested with the Casino CAS server implementation. Please let me know if Überauth CAS is incompatible with your CAS server, and why.

The docs contain more information about protocol specifics.

Copyright and License

Copyright (c) 2016 Marcel de Graaf

This library is licensed under the [MIT license](./LICENSE.md).