WISE-PaaS/Single Sign-On(SSO)

From ESS-WIKI
Revision as of 06:40, 16 January 2017 by Dylan.chang (talk | contribs)
Jump to: navigation, search

Single Sign-On (SSO) is part of Advantech WISE-PaaS cloud solution and  plays an important role in the interoperability of Internet identity. It provides a central login mechanism.

OpenID Connect utilizes Keycloak which is an open source identity and access management for modern applications and services.


API Protocol Flow

WISE-PaaS/Single Sign-On use the OAuth 2.0 protocol for authentication and authorization.

RTENOTITLE

RTENOTITLE


  • User/Resource owner : Who authorizes others to access Protected Resource. If the role is human, it means the end-user.
  • Application/Client/Browse : An application ,client or a browser page represents the Resource Owner to access the Protected Resource.
  • Authorize Server : The server issues the Access Token after user are authenticated. (WISE-PaaS/Single Sign-On server)
  • Resource Server : The server hosting Protected Resource accept requests according to Access Token.

Here is a more detailed explanation of the steps in the diagram:

  1. The application requests authorization to access service resources from the user
  2. If the user authorized the request, the application receives an authorization grant
  3. The application requests an access token from the authorization server (API) by presenting authentication of its own identity, and the authorization grant
  4. If the application identity is authenticated and the authorization grant is valid, the authorization server (API) issues an access token to the application. Authorization is complete.
  5. The application requests the resource from the resource server (API) and presents the access token for authentication
  6. If the access token is valid, the resource server (API) serves the resource to the application

Features Overview

WISE-PaaS/Single Sign-On(SSO) which base on keycloak has the following features.

  • Single-Sign On : Login once to multiple applications
  • Standard Protocols : OpenID Connect, OAuth 2.0 and SAML 2.0
  • Centralized Management : For admins and users
  • Adapters : Secure applications and services easily
  • High Performance : Lightweight, fast and scalable
  • Clustering : For scalability and availability
  • Themes : Customize look and feel
  • Extensible : Customize through code
  • Password Policies : Customize password policies

Components

[Please describe]

  • OpenID Connect Server
  • OpenID Connect Client
  • OAuth 2.0 Server
  • OAuth 2.0 Client

Implementation

WISE-PaaS provides a complete service for Single Sign-On. There are tree sections for developer to implement.

Settings on Authorization Server

Apply a manager account for OpenID Central Server

Please send a request to WISE-Paas/OpenID Connect service manager by E-mail. And provide the following information

  • Service name : [RMM] as your realm.
  • Client name : [RMMClient] a client definition for a app to login in.
  • User registration : [True/False] Enable/Disable user registeration.
  • Administrator account : [RMMAdmin] Use this account to manage this realm. The default password is same as account name. Change password after first login

Setting your service on Single Sign-On server

Login Single Sign-On server
Authorization Setting
  1. Authorization Enabled
  2. Create a Resource : Creating the resources that you want to protect
  3. Create a Permission : A permission associates the object being protected and the policies that must be evaluated to decide whether access should be granted.
  4. Create a Role : Use this type of policy to define conditions for your permissions where a set of one or more roles is permitted to access an object.
  5. Create a User : Craete a login account for SSO with role mapping of client.
  6. Evaluate : When designing your policies, you can simulate authorization requests to test how your policies are being evaluated with a json format result.

Get Client App setting

  1. Realm Public Key : Get the public key from Realms setting-> [Realm]->Keys-> Public key.
  2. Client Credentials Secret : Get Secret from Clients->Credentials->Secret

Application for end user

  1. Copy the json , html sample code to your local web site.
  2. Modify json setting
  3. Once the test HTML page is opened, it is automatically directed to OpenID Connect Server.
  4. While login success, it will automatically lead back to test page.

Verify Access Token on Resource Server

A Java Client Java example :

  • Maven Dependency
<code data-lang="xml"><dependencies>
    <dependency>
        <groupId>org.keycloak</groupId>
        <artifactId>keycloak-authz-client</artifactId>
        <version>${KEYCLOAK_VERSION}</version>
    </dependency>
</dependencies></code>
  • Obtaining User Entitlements
<code data-lang="java">// create a new instance based on the configuration defined in keycloak-authz.json
AuthzClient authzClient = AuthzClient.create();

// obtain an Entitlement API Token to get access to the Entitlement API.
// this token is an access token issued to a client on behalf of an user
// with a scope = kc_entitlement
String eat = getEntitlementAPIToken(authzClient);

// send the entitlement request to the server to
// obtain an RPT with all permissions granted to the user
EntitlementResponse response = authzClient.entitlement(eat)
    .getAll("hello-world-authz-service");
String rpt = response.getRpt();

System.out.println("You got a RPT: " + rpt);

// now you can use the RPT to access protected resources on the resource server</code>

Document

  • WISE-PaaS/Single Sign-On(SSO) server setting
  • Application(Client) Sample code (json)
  • Application(Client) Sample code (HTML)
  • Resource Server jwt Sample code