onelogin 1.4.1 → 3.0.0.pre.alpha.1

data/examples/rails-custom-login-page/README.md

@@ -1,105 +0,0 @@
-# Customized Login Page
-
-This sample is a default [Ruby on Rails 5](http://rubyonrails.org/) app that makes use of the OneLogin ruby sdk for authenticating users.
-
-It is the recommended approach when building a customized login flow where you want complete control
-over the look & feel.
-
-The downside to this approach is that you have to implement MFA and password resets etc yourself. However we do have the APIs for these actions available and have demonstrated how to use them in this app.
-
-If you want a standards based, out of the box way to authenticate users then we recommend you use [our OpenId Connect implementation](https://github.com/onelogin/onelogin-oidc-ruby).
-
-## Get Started
-
-The sample tries to keep everything as simple as possible so only
-implements
-* Login - Authenticate users in a single request to OneLogin with out any redirects
-* MFA - Does MFA verification if required
-* Password Reset with user verification via MFA
-* Self sign Up / Create a new user
-* Onboard / Activate a user
-* User Apps - List apps available to a user and provides SSO links
-* User Roles - Lists a users roles
-* Logout - destroying the local session and revoking the token at OneLogin
-
-In order to run this sample you need API credentials for a OneLogin account. If you don't have a OneLogin developer account [you can sign up here](https://www.onelogin.com/developer-signup).
-
-1. Clone this repo
-
-```sh
-git clone https://github.com/onelogin/onelogin-ruby-sdk.git
-```
-
-2. Move to the rails example and install the required gems
-```sh
-cd onelogin-ruby-sdk/examples/rails-custom-login-page && bundle install
-```
-
-3. Rename `config/secrets.yml.sample` to `config/secrets.yml` and update with your OneLogin API credentials, region and subdomain.
-
-```yaml
-development:
-  secret_key_base: xxx
-  ONELOGIN_CLIENT_ID: xxx
-  ONELOGIN_CLIENT_SECRET: xxx
-  ONELOGIN_REGION: us
-  ONELOGIN_SUBDOMAIN: xxx
-```
-4. Run the sample and browse to `http://localhost:3000`
-```sh
-rails s
-```
-
-The `/dashboard` route renders a protected page to prove the authentication works and creates a session. You will need to be authenticated to view it. If you are not authenticate you will be redirected back to the login page.
-
-### Authenticate the user
-
-*helpers/sessions_helper.rb*
-```ruby
-response = api_client.create_session_login_token({
-    'username_or_email' => username,
-    'password' => password,
-    'subdomain' => ONELOGIN_SUBDOMAIN,
-  },
-  request.base_url # included for CORS session cookie request
-)
-```
-
-### Verify MFA
-
-*helpers/sessions_helper.rb*
-```ruby
-response = api_client.get_session_token_verified(
-  device_id,
-  session[:state_token],
-  otp_token,
-  request.base_url
-)
-```
-
-### Destroy the session
-
-*helpers/sessions_helper.rb*
-```ruby
-api_client.log_user_out(current_user_id)
-session.delete(:user)
-```
-
-### Make CORS request to establish SSO session
-
-Using the `session_token` returned from the `session_controller` after a new login or successful MFA verification.
-
-*views/home/index.html.erb*
-```javascript
-function makeCors(session_token) {
-  var xhr = new XMLHttpRequest();
-  xhr.withCredentials = true;
-  method = "POST";
-  var url = "https://" + ONELOGIN_SUBDOMAIN + ".onelogin.com/session_via_api_token";
-  xhr.open(method, url, true);
-  xhr.setRequestHeader("Content-Type", "application/json");
-  body = {"session_token": session_token};
-  xhr.send(JSON.stringify(body));
-};
-```
-

data/examples/rails-custom-login-page/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require_relative 'config/application'
-
-Rails.application.load_tasks

data/examples/rails-custom-login-page/app/assets/config/manifest.js

@@ -1,3 +0,0 @@
-//= link_tree ../images
-//= link_directory ../javascripts .js
-//= link_directory ../stylesheets .css

data/examples/rails-custom-login-page/app/assets/javascripts/application.js

@@ -1,18 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
-// vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require rails-ujs
-//= require turbolinks
-//= require_tree .
-//= require jquery
-//= require jquery_ujs
-

data/examples/rails-custom-login-page/app/assets/javascripts/cable.js

@@ -1,13 +0,0 @@
-// Action Cable provides the framework to deal with WebSockets in Rails.
-// You can generate new channels where WebSocket features live using the `rails generate channel` command.
-//
-//= require action_cable
-//= require_self
-//= require_tree ./channels
-
-(function() {
-  this.App || (this.App = {});
-
-  App.cable = ActionCable.createConsumer();
-
-}).call(this);

data/examples/rails-custom-login-page/app/assets/javascripts/dashboard.coffee

@@ -1,3 +0,0 @@
-# Place all the behaviors and hooks related to the matching controller here.
-# All this logic will automatically be available in application.js.
-# You can use CoffeeScript in this file: http://coffeescript.org/

data/examples/rails-custom-login-page/app/assets/javascripts/home.coffee

@@ -1,3 +0,0 @@
-# Place all the behaviors and hooks related to the matching controller here.
-# All this logic will automatically be available in application.js.
-# You can use CoffeeScript in this file: http://coffeescript.org/

data/examples/rails-custom-login-page/app/assets/javascripts/sessions.coffee

@@ -1,3 +0,0 @@
-# Place all the behaviors and hooks related to the matching controller here.
-# All this logic will automatically be available in application.js.
-# You can use CoffeeScript in this file: http://coffeescript.org/

data/examples/rails-custom-login-page/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
- * vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/examples/rails-custom-login-page/app/assets/stylesheets/dashboard.scss

@@ -1,3 +0,0 @@
-// Place all the styles related to the Dashboard controller here.
-// They will automatically be included in application.css.
-// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails-custom-login-page/app/assets/stylesheets/home.scss

@@ -1,3 +0,0 @@
-// Place all the styles related to the Home controller here.
-// They will automatically be included in application.css.
-// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails-custom-login-page/app/assets/stylesheets/sessions.scss

@@ -1,3 +0,0 @@
-// Place all the styles related to the Sessions controller here.
-// They will automatically be included in application.css.
-// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails-custom-login-page/app/channels/application_cable/channel.rb

@@ -1,4 +0,0 @@
-module ApplicationCable
-  class Channel < ActionCable::Channel::Base
-  end
-end

data/examples/rails-custom-login-page/app/channels/application_cable/connection.rb

@@ -1,4 +0,0 @@
-module ApplicationCable
-  class Connection < ActionCable::Connection::Base
-  end
-end

data/examples/rails-custom-login-page/app/controllers/application_controller.rb

@@ -1,23 +0,0 @@
-require 'onelogin'
-
-class ApplicationController < ActionController::Base
-  protect_from_forgery with: :exception
-  include SessionsHelper
-
-  def require_current_user
-    if current_user
-      return true
-    else
-      redirect_to root_url, error: "Please sign in."
-      return false
-    end
-  end
-
-  def api_client
-    @api_client ||= OneLogin::Api::Client.new(
-      client_id: ONELOGIN_CLIENT_ID,
-      client_secret: ONELOGIN_CLIENT_SECRET,
-      region: ONELOGIN_REGION
-    )
-  end
-end

data/examples/rails-custom-login-page/app/controllers/dashboard_controller.rb

@@ -1,10 +0,0 @@
-class DashboardController < ApplicationController
-  include DashboardHelper
-
-  before_action :require_current_user
-
-  def index
-    @apps = user_apps
-    @roles = user_roles
-  end
-end

data/examples/rails-custom-login-page/app/controllers/home_controller.rb

@@ -1,4 +0,0 @@
-class HomeController < ApplicationController
-  def index
-  end
-end

data/examples/rails-custom-login-page/app/controllers/sessions_controller.rb

@@ -1,46 +0,0 @@
-class SessionsController < ApplicationController
-  def new
-    response = log_in(params['username'], params['password'])
-    status = response[:error] ? :unauthorized : :ok
-
-    render json: response, status: status
-  end
-
-  def verify
-    response = verify_mfa(params['device_id'], params['otp_token'])
-    status = response ? :ok : :unauthorized
-
-    render json: response, status: status
-  end
-
-  # Checks for user and gets MFA devices
-  # available to verify token before
-  # password reset is completed
-  def forgot_password
-    user = validate_user(params['forgot_username'])
-
-    devices = get_mfa_devices(user.id)
-
-    status = user ? :ok : :not_found
-
-    render json: devices, status: status
-  end
-
-  # Verify MFA token and then update password
-  def reset_password
-    if verify_token(params['reset_device_id'], params['reset_otp_token'])
-      status = :ok
-      response = set_password(session[:user_id], params['new_password'])
-    else
-      status = :unauthorized
-      response = 'Invalid token'
-    end
-
-    render json: response, status: status
-  end
-
-  def destroy
-    log_out
-    redirect_to root_url
-  end
-end

data/examples/rails-custom-login-page/app/controllers/users_controller.rb

@@ -1,116 +0,0 @@
-class UsersController < ApplicationController
-
-  before_action :require_current_user, except: [:new, :create, :onboard, :activate]
-  before_action :set_user, only: [:show, :edit, :update, :destroy]
-
-  # GET /users
-  # GET /users.json
-  def index
-    @users = api_client.get_users.take(25) # only fetch the first 50 users
-  end
-
-  # GET /users/1
-  # GET /users/1.json
-  def show
-  end
-
-  # GET /users/new
-  def new
-  end
-
-  # GET /users/1/edit
-  def edit
-  end
-
-  # POST /users
-  # POST /users.json
-  def create
-    # Create a user
-    user = api_client.create_user(user_params)
-    # Update custom attributes
-    api_client.set_custom_attribute_to_user(user.id, custom_user_params)
-    # Set status to unactivated
-    api_client.update_user(user.id, status: 0)
-
-    if api_client.error
-      puts api_client.error_description
-    end
-
-    redirect_to onboard_path, notice: 'User has been created with status set to unactivated'
-  end
-
-  # GET /onboard
-  def onboard
-  end
-
-  # POST /activate
-  def activate
-    # Search for a user with this email address
-    @user = api_client.get_users(email: user_params[:email]).first
-
-    unless @user && verify_dob && verify_ssn
-      return redirect_to onboard_path, notice: "User #{user_params[:email]} was not verified"
-    end
-
-    # Update password
-    unless api_client.set_password_using_clear_text(@user.id, user_params[:password], user_params[:password])
-      return redirect_to onboard_path, notice: "Password update failed. #{api_client.error_description}"
-    end
-
-    # Activate user
-    api_client.update_user(@user.id, status: 1)
-
-    # Redirect to login page
-    redirect_to home_index_path
-  end
-
-  # Verify dob and ssn match
-  def verify_ssn
-    @user.custom_attributes["custom_ssn"].eql? (custom_user_params[:custom_ssn])
-  end
-
-  def verify_dob
-    @user.custom_attributes["custom_dob"].eql? (custom_user_params[:custom_dob])
-  end
-
-  # PATCH/PUT /users/1
-  # PATCH/PUT /users/1.json
-  def update
-    # update the user
-    api_client.update_user(params[:id], user_params)
-
-    # update custom attributes
-    api_client.set_custom_attribute_to_user(params[:id], custom_user_params)
-
-    respond_to do |format|
-      unless api_client.error
-        format.html { redirect_to user_path(params[:id]), notice: 'User was successfully updated.' }
-        format.json { render :show, status: :ok, location: @user }
-      else
-        format.html { render :edit }
-        format.json { render json: @user.errors, status: :unprocessable_entity }
-      end
-    end
-  end
-
-  # DELETE /users/1
-  # DELETE /users/1.json
-  def destroy
-    @user.destroy
-    respond_to do |format|
-      format.html { redirect_to users_url, notice: 'User was successfully destroyed.' }
-      format.json { head :no_content }
-    end
-  end
-
-  private
-
-    # Never trust parameters from the scary internet, only allow the white list through.
-    def user_params
-      params.permit(:firstname, :lastname, :email, :phone, :custom_field, :username, :password)
-    end
-
-    def custom_user_params
-      params.permit(:custom_field, :custom_dob, :custom_ssn)
-    end
-end

data/examples/rails-custom-login-page/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/examples/rails-custom-login-page/app/helpers/dashboard_helper.rb

@@ -1,28 +0,0 @@
-module DashboardHelper
-
-  #
-  # Get a list of app for the current user
-  #
-  def user_apps
-    api_client.get_user_apps(current_user_id)
-  end
-
-  #
-  # Get a list of roles for the current user
-  #
-  def user_roles
-    role_ids = api_client.get_user_roles(current_user_id)
-
-    roles.map do |role|
-      role if role_ids.include?(role.id)
-    end.compact
-  end
-
-  #
-  # Get a list of all roles in onelogin account
-  #
-  def roles
-    @roles ||= api_client.get_roles
-  end
-
-end

data/examples/rails-custom-login-page/app/helpers/home_helper.rb

@@ -1,2 +0,0 @@
-module HomeHelper
-end

data/examples/rails-custom-login-page/app/helpers/sessions_helper.rb

@@ -1,87 +0,0 @@
-module SessionsHelper
-
-  def log_in(username, password)
-    response = api_client.create_session_login_token({
-        'username_or_email' => username,
-        'password' => password,
-        'subdomain' => ONELOGIN_SUBDOMAIN,
-      },
-      request.base_url # included for CORS session cookie request
-    )
-    return { error: api_client.error_description } unless response
-
-    if response.is_a? OneLogin::Api::Models::SessionTokenMFAInfo
-      session[:state_token] = response.state_token
-      {
-        requires_mfa: true,
-        devices: response.devices
-      }
-    else
-      create_session(response.user)
-      {
-        requires_mfa: false,
-        session_token: response.session_token
-      }
-    end
-  end
-
-  def verify_mfa(device_id, otp_token)
-    response = api_client.get_session_token_verified(
-      device_id,
-      session[:state_token],
-      otp_token,
-      request.base_url
-    )
-    return nil unless response
-
-    create_session(response.user)
-    {
-      session_token: response.session_token
-    }
-  end
-
-  def create_session(user)
-    session[:user] = user
-  end
-
-  def log_out
-    return unless current_user
-    api_client.log_user_out(current_user_id)
-    session.delete(:user)
-  end
-
-  def current_user
-    session[:user]
-  end
-
-  def current_user_id
-    session[:user]['id'] if current_user
-  end
-
-  def validate_user(username)
-    user = api_client.get_users(username: username).first
-
-    if user
-      session[:user_id] = user.id
-    end
-
-    user
-  end
-
-  def get_mfa_devices(user_id)
-    devices = api_client.get_enrolled_factors(user_id)
-
-    # only return devices that dont need a trigger.
-    # i.e. this sample does not support push yet
-    devices.select {|d| d.needs_trigger == true }
-  end
-
-  def verify_token(device_id, mfa_token)
-    puts "VERIFY MFA TOKEN User:#{session[:user_id]}, Device:#{device_id}, Token:#{mfa_token}"
-    api_client.verify_factor(session[:user_id], device_id, mfa_token)
-  end
-
-  def set_password(user_id, password)
-    api_client.set_password_using_clear_text(user_id, password, password)
-  end
-end

data/examples/rails-custom-login-page/app/helpers/users_helper.rb

@@ -1,3 +0,0 @@
-module UsersHelper
-
-end

data/examples/rails-custom-login-page/app/jobs/application_job.rb

@@ -1,2 +0,0 @@
-class ApplicationJob < ActiveJob::Base
-end

data/examples/rails-custom-login-page/app/mailers/application_mailer.rb

@@ -1,4 +0,0 @@
-class ApplicationMailer < ActionMailer::Base
-  default from: 'from@example.com'
-  layout 'mailer'
-end

data/examples/rails-custom-login-page/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end

data/examples/rails-custom-login-page/app/views/dashboard/index.html.erb

@@ -1,50 +0,0 @@
-<div class="jumbotron">
-  <h1>Dashboard</h1>
-  <p>
-    You must be authenticated to see this page so if you're seeing it then
-    everything worked as expected 🎉
-  </p>
-  <p>
-    <a href="/users">List Users</a> | <a href="/logout">Log Out</a>
-  </p>
-</div>
-
-<div class="container">
-  <div class="row">
-    <div class="col-sm">
-      <h2>Apps</h2>
-      <ul class="list-group">
-      <%@apps.each do |app|%>
-        <li class="list-group-item"><a href="https://<%= ONELOGIN_SUBDOMAIN %>.onelogin.com/launch/<%= app.id %>"><%= app.name %></a></li>
-      <%end%>
-      </ul>
-    </div>
-    <div class="col-sm">
-      <h2>Roles</h2>
-      <ul class="list-group">
-      <%@roles.each do |role|%>
-        <li class="list-group-item"><%= role.name %></li>
-      <%end%>
-      </ul>
-
-      <br/>
-
-      <h2>Profile</h2>
-      <ul class="list-group">
-        <%current_user.each do |k, v|%>
-          <li class="list-group-item">
-            <b><%= k%>:</b> <%= v%>
-          </li>
-        <%end%>
-      </ul>
-    </div>
-  </div>
-</div>
-
-
-
-
-
-
-
-