In this article, we are going to Integrate Yahoo OAuth with MVC 5 in step by step way.
The process of each OAuth provider is different as we saw on Facebook, the Facebook provide appId and appSecret and in same way Google provide ClientId and ClientSecret, Twitter provide ConsumerKey and ConsumerSecret provide but the way you need to register you application for using this services are totally different from each other, In this fast growing world most of application requires this kind of Authentication technology.
Let's start OAuth Integration with Yahoo in step by step process.
We are going to create Database with Name "MVCDEMODB" in SQL Server 2008 R2
Create New Asp.Net MVC Application
From Visual studio 2015 IDE Start page click on "New Project" link.
After clicking on "New Project" link a new dialog will pop up.
In that we are going to select web templates from left pane after selecting web template, we find only one project template in it "ASP.NET Web Application" just select that.
After selecting this project template next we are going to name the project as "MVC5DEMO9" and clicking on the OK button a new dialog will pop up with Name "New ASP.NET Project" for selecting project Templates.
In this dialog, we are going to choose MVC project template and then we are going to choose Authentication type for doing that just click on Change Authentication button, a new dialog will pop up with name "Change Authentication" here we are going to choose Individual User Accounts .
Note: - Individual User Accounts
If you choose this option for Authentication of application then your application will be configured to use ASP.NET identity [ASP.NET Membership] where User register in the application and then sign in using credentials and also User sign in via social accounts such as Facebook, Twitter, Google, Microsoft and other providers. All user data will be stored in SQL server database.
After selecting Authentication type as Individual User Accounts click on OK Button.
It will show a progress bar while it is creating a project.
After creating a project it will show Readme HTML page with useful links on that page.
And in right part, you will see newly created project structure.
As we have chosen Individual User Accounts Authentication type we got ready made Membership Model added in Models folder as shown below.
Models Folder View
After creating project successfully now let's add connection string to project
<connectionStrings> <add name="DefaultConnection" connectionString="Data Source=sai-pc;Database=MVC5DEMODB;UID=sa;Password=Pass$123" providerName="System.Data.SqlClient" /> </connectionStrings>
After adding Connection string next step just save current project and RUN.
Homepage View in browser after running application
After Register page appear enter details required for registration.
After filling data just click on Register button meanwhile Microsoft.AspNet.Identity will generate tables in the database as shown below.
Database View after registering User
Along with this, it will also save data in these tables.
Just have a look on below snapshot it is data which we have filled while we have registered in the application.
If you look out properly you will as see other tables in the database which stored data related to Role and Role.
Tables and its Details
AspNetRoles : - which stored data related to Role
AspNetUserRoles: - which stored data related to Role assigns to User.
AspNetUsers: - which stored data related to User.
AspNetUserLogins: - which stored data related to Login Provider [Google, Facebook, Twitter] [ProviderKey, UserId].
After Completing with Database part let’s move back to Application part.
Now you are logged into application if you want you can log out and retry to log in.
It is the traditional way to doing it.
Now let move toward Implementing External Authentication provider like Yahoo.
Implementing External Authentication provider Yahoo
In this part of implementation, we do not require to do any coding part it’s all about configuration.
All configuration starts with Startup.Auth.cs
Startup.Auth file in Asp.Net MVC
This Class (Startup.Auth.cs) file is created by default when we create application and it is located inside App_Start as shown below
Now let’s take a view on Startup.Auth.cs file and see what it contains.
The Startup.Auth.cs file contains all OAuth Clients comment by default.
We are going to implement an example of OAuth with Yahoo but we are not able to see any Yahoo Login provider by default right.
We need to add this provider from NuGet Package.
Adding Owin.Security.Providers.Yahoo Package from NuGet Package
For install Yahoo provider just right click on Project then select Manage NuGet Packages a new dialog will popup as show below.
Now click on Browse tab in search box type: - "Owin.Security.Providers.Yahoo" then NuGet package will it appear in below search result. Just select that "Owin.Security.Providers.Yahoo" package in Right it will show Install button.
After clicking on Install button below is snapshot after installing.
Adding Owin.Security.Providers.Yahoo Package from Package Manager Console
Mean while if you want to install Owin.Security.Providers.Yahoo Package from Package Manager Console below are step to do.
Just copy command "Install-Package Owin.Security.Providers.Yahoo" and paste it in Package Manager Console and press enter it will start installing.
After adding Yahoo Oauth package now next we use Yahoo provider as shown below.
Register Application with Yahoo
In this part we are going to register our application with Yahoo but for doing this process we need to have account on Yahoo if it is not there then we need to create account for this demo, if you already have Yahoo than that good you are ready to take ride just login into your Yahoo account .
Then past given URL in browser: - https://developer.yahoo.com/apps/ , below view, must appear after pasting URL.
After that to create an app we need to just click on Create an App button it will redirect it to create app page.
Then it will ask you to enter "Application Name" here I am going to enter "MVC5DEMO9" then choose Application Type if we are working with Localhost then we are going to select Installed application because it will not ask for Callback Domain, if we want to host application on production server then select web application here it is mandatory to enter Callback Domain, but for demo we are going select "Installed Application" next we need to enter Description "Oauth with Yahoo" you can enter your own description here.
Next just scroll page below you will find API Permission.
In API Permission we are going to choose Profile (Social Directory) and in that just we want to read information of profile for that we are going to select Read public and finally click on Create app button.
After click on Create app button it will create app and then it will redirect to apps info page as show below.
This page contains your Client ID and Client Secret of Yahoo along with that we can update details of App on this page.
Next thing we have not provided Callback Domain while we were creating application then how will it redirect back to our application, this may question rise.
Answer to this question is just set Project Url to http://localhost:8000/
To set URL which we are going add just right click on the MVC5DEMO9 project then select properties from the list which is at the bottom.
Just paste URL http://localhost:8000/ in Project URL Textbox.
Just copy and paste Client ID and Client Secret to Startup.Auth.cs class as shown below.
Then Save your application and run.
Below Login screen will appear with Yahoo button.
After clicking on Yahoo button it will take you to Yahoo Login page and ask you to enter credentials for Sign in.
After entering credentials and clicked on Sign in button.
After Clicking on Sign in button it will authenticate your request as shown below.
Now just click on Agree button [Button in Violet color] to proceed further
After authentication, it will redirect to ExternalLoginCallback view and on that view you will see Email textbox which will tell you to enter Email ID (firstname.lastname@example.org).
After entering Email ID in textbox now just click on Register button and you are login into application. Along with that, it shows message.
"You've successfully authenticated with Yahoo. Please enter a Email for this site below and click the Register button to finish logging in."
After clicking on Register button it will register you and along with that it also login into the application as shown below.
Now let’s check out where this data is been added in (MVC5DEMODB) database tables.
First, we will look on AspNetUserLogins table.
This table store data related to LoginProvider.
As you can see it is storing data of Yahoo login.
This table store data related to all Users from Oauth login as well as from Traditional.
If it contains PasswordHash then it is registered by Traditional Login and if it is PasswordHash is empty then it is done by OAuth login.
Finally, we completed understanding what OAuth is and how to use with asp.net MVC 5 applications and also had an example of OAuth integration with Yahoo.