Skip to content

An Uberauth strategy for Yandex authentication.

License

Notifications You must be signed in to change notification settings

ysatarov/ueberauth_yandex

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Überauth Yandex

Yandex OAuth2 strategy for Überauth.

Installation

  1. Setup your application at Yandex Developer Console.

  2. Add :ueberauth_yandex to your list of dependencies in mix.exs:

    def deps do
      [{:ueberauth_yandex, "~> 0.1"}]
    end
  3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_yandex]]
    end
  4. Add Yandex to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        yandex: {Ueberauth.Strategy.Yandex, []}
      ]
  5. Update your provider configuration:

    config :ueberauth, Ueberauth.Strategy.Yandex.OAuth,
      client_id: System.get_env("YANDEX_CLIENT_ID"),
      client_secret: System.get_env("YANDEX_CLIENT_SECRET")
  6. Include the Überauth plug in your controller:

    defmodule MyApp.AuthController do
      use MyApp.Web, :controller
      plug Ueberauth
      ...
    end
  7. 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
  8. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth Example application.

Calling

Depending on the configured url you can initiate the request through:

/auth/yandex

Or with options:

/auth/yandex?scope=login%3Aemail+login%3Ainfo+login%3Aavatar

By default the requested scope is "email". Scope can be configured either explicitly as a scope query value on the request path or in your configuration:

config :ueberauth, Ueberauth,
  providers: [
    yandex: {Ueberauth.Strategy.Yandex, [default_scope: "login:email login:info"]}
  ]

To guard against client-side request modification, it's important to still check the domain in info.urls[:website] within the Ueberauth.Auth struct if you want to limit sign-in to a specific domain.

Credits

Sponsored by JetRockets.

JetRockets

License

Please see LICENSE for licensing details.

About

An Uberauth strategy for Yandex authentication.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Elixir 100.0%