Zhegui Single Sign On Getting Started Guide

Ping Chen

Ziran Liang

Weihua Lu

2.0.3

2011-08-17


Table of Contents

1. Zhegui Single Sign On Introduction
2. Obtaining Zhegui Single Sign On
Release Bundle Downloads
Purchase software
3. Starting Zhegui Single Sign On
Starting database
Starting Single Sign On
4. Admin sign on
5. Create application to work with Zhegui Single Sign On
6. Create application user
7. Change application to get SSO user info
8. Application user sign on
9. Application synchronize application users via Zhegui Single Sign On
10. Report and Monictoring

List of Examples

7.1. Java/Servlet code sample
7.2. ASP.NET code sample
7.3. PHP code sample
9.1. the web service relative info

Chapter 1. Zhegui Single Sign On Introduction

Zhegui Single Sign On is a web-based Single Sign On software product. Support J2EE/ASP/ASP.NET/PHP based background applications. Provided by:

Shanghai Zhegui Software Co,.Ltd http://zheguisoft.com/

This book is just a short introduction of Zhegui Single Sign On. For more detail, please check our user manual. Feel free to contact support@zheguisoft.com if need.

Zhegui Single Sign On work as reverse proxy server.

Chapter 2. Obtaining Zhegui Single Sign On

Release Bundle Downloads

Zhegui Software team provides release bundles hosted on our company website http://zheguisoft.com/en-us/download_list.htm , in ZIP formats. Our product is also available for download on http://www.regnow.com/.

After download, unzip zsso-v2.0.3.zip to a local folder. you will get following folder tree:

Zhegui Single Sign On is free to download. There is a limit for application user count without purchasing. No other functions limit.

Purchase software

Zhegui Single Sign On can be purchased on http://www.regnow.com/, or from dealer on our website http://zheguisoft.com/en-us/dealer_list.htm. Before purchase, you can look at the price list at http://zheguisoft.com/en-us/price_list.htm#zsso. It's possible to get some discount from dealers.

Chapter 3. Starting Zhegui Single Sign On

Starting database

Starting database by click start_database_server.bat .

Starting Single Sign On

Click start_zsso_server_en.bat to start Zhegui Single Sign On with english GUI. Normally, by running this .bat file, it will start database at the beginning. And you will got message in DOS windows, for example "Server startup in 14815 ms".

Zhegui Single Sign On will start two software servers. One is for admin, listen on http://localhost:8180/zsso , administrator can change configurations of this system. Another is for normal application users, listen on http://lcoalhost:80/xxx, where xxx is application short name we will define later.

Chapter 4. Admin sign on

Administrator can sign on at http://localhost:8180/zsso with Microsoft IE or Firefox. The user/password is admin/zsso. You should change this password ASAP, for security reason.

Chapter 5. Create application to work with Zhegui Single Sign On

After admin sign on, enter "application system(maintain)" by click menu "master data" --> "sso background application system". Click the "plus" icon, you will see the "input form". After you fill this form , click "Submit" button.

Note: to make it simple, first time we create application, we can fill following: abbreviation=test_app, application full name=Test application, root url=http://my_test_app_server/my_root_url, Use SSO authority="unchecked", Need sign in="checked", timeout seconds=600, memo="empty". this is standard web Single Sign On configuration.

This is a screenshot.

Chapter 6. Create application user

After admin sign on, enter "application user(maintain)" by click menu "master data" --> "sso background application user". Click the "plus" icon, you will see the "input form". After you fill this form , click "Submit" button.

Note: to make it simple, first time we create application, we can fill following: user sign in name=test1, user full name=test 1, email=test1@myhome.com, phone=1234, effective time=2011-08-19, discard time="empty", memo="empty".

After create a new application user, you will got a message: create user test1 successfully! password is: xxxx. Remember this password.

And we need to tell Zhegui Single Sign On, what applications here the user can access. After admin sign on, enter "relation between sso application and sso user(maintain)" by click menu "authority" --> "sso application and user relationship". Check user test1 from right side, check one or more applications from left, click "Save" button.

Chapter 7. Change application to get SSO user info

Applications that need to integrate with Zhegui Single Sign On, should be changed a little to get SSO user info from HTTP header.

Example 7.1. Java/Servlet code sample

			//get Single Sign On user data from HTTP request headers
			String userSignInNm = request.getHeader("iv-user");
			String userMail = request.getHeader("iv-user-mail");
			String userIp = request.getHeader("iv-remote-address");
			String userSessionKeyInSSO = request.getHeader("iv-sso-client-uuid");
		
		

Example 7.2. ASP.NET code sample

			//get Single Sign On user data from HTTP request headers
			string userSignInNm = Request.Headers["iv-user"];
			string userMail = Request.Headers["iv-user-mail"];
			string userIp = Request.Headers["iv-remote-address"];
			string userSessionKeyInSSO = Request.Headers["iv-sso-client-uuid"];
		
		

Example 7.3. PHP code sample

			//get Single Sign On user data from HTTP request headers
			$userSignInNm = $_SERVER["HTTP_IV_USER"];
			$userMail = $_SERVER["HTTP_IV_USER_MAIL"];
			$userIp = $_SERVER["HTTP_IV_REMOTE_ADDRESS"];
			$userSessionKeyInSSO = $_SERVER["HTTP_IV_SSO_CLIENT_UUID"];
		
		

Chapter 8. Application user sign on

Application user can access application "test_app" via Zhegui Single Sign On by access this URL:

http://sso_server/test_app

A native user sign on page will let current user to sign with user name "test1", created at chapter "Create application user".

Application user sign on page can be customized. By change system paramter "system parameter_application user_sign_page_folder", in menu "parameters" --> "system parameter configuration", you can point to local folder where your sign on page locate.

Chapter 9. Application synchronize application users via Zhegui Single Sign On

Application behind Zhegui Single Sign On can create a timer job to synchronize application users that just created if we need to get configuration ready beforehand for new user. For example, application level user rights.

Zhegui Single Sign On provide a SOAP style web service to make application users' data to be synchronized easily: http://zsso_ip:8091/zsso/SsoWebservice?wsdl

Example 9.1. the web service relative info

			@WebService(targetNamespace = "http://www.zhegui.biz/webservice")
			@SOAPBinding(style = SOAPBinding.Style.RPC)
			@WebMethod public String getAllUsersInXmlFormat() 
		
		

Chapter 10. Report and Monictoring

Several logs have been provied by Zhegui Single Sign On: application users' sign on log, web access log, top slow URL(average operation time), top slow url report (single operation).

Two trend charts have been provied by Zhegui Single Sign On:visit quantity trend chart,online user trend chart.

For Monictoring, we provide: current online user information, current running web requests. And , the another usefull report: server load chart of CPU/Memory/network/JVM/HTTP.