Ipass® Generic Interface Specification
Total Page:16
File Type:pdf, Size:1020Kb
iPass® Generic Interface Specification BETWEEN SMART CLIENT S AND ACCESS GATEWAY , VERSION 1.6 Corporate Headquarters iPass Inc. 3800 Bridge Parkway Redwood Shores, CA 94065 USA www.ipass.com +1 650-232-4100 +1 650-232-0227 fx TABLE OF CONTENTS Scope 4 Client Integration 5 Login Request: Successful Case .......................................................................................................... 5 Login Request: Successful Case With Proxy Reply ........................................................................... 6 Login Request: Successful Case With Polling .................................................................................... 7 Login Request: Reject ............................................................................................................................ 7 Login Request: Reject With Polling ...................................................................................................... 8 Protocol Specifics .................................................................................................................................. 8 Smart Client HTTP GET to ORIGIN SERVER ................................................................................. 9 Redirect .......................................................................................................................................... 10 Proxy ............................................................................................................................................... 12 Authentication ................................................................................................................................. 13 Authentication Results Polling ........................................................................................................ 15 Abort Login ..................................................................................................................................... 17 Logoff .............................................................................................................................................. 18 Appendix A: ACCESS GATEWAY INTERFACE SPECIFICATION LICENSE AGREEMENT 20 Appendix B: Example HTTP and XML Message exchange between Smart Client and A SIMPLE ACCESS Gateway 23 Authentication Procedure Initiation [client] ....................................................................................... 23 Activation – Authentication Redirect [gateway] ................................................................................ 23 Authentication Request [client] via SSL ............................................................................................ 23 Authentication Reply [gateway] (Login Successful) ......................................................................... 24 Authentication Reply [gateway] (Login rejected) .............................................................................. 24 Client-initiated Connection Termination (logoff) of Authenticated User [client] ........................... 25 Logoff Reply [gateway] ........................................................................................................................ 25 Appendix C: Example Detailed XML Message exchange between Smart Client and a Gateway Implementing Authentication Result Polling 26 Authentication Procedure Initiation [client] ....................................................................................... 26 iPass® Generic Interface Specification 2012 iPass In c. Page 2 2 TABLE OF CONTENTS Activation - Proxy Reply [gateway] ..................................................................................................... 26 Activation - Redirect Reply [gateway] ................................................................................................ 26 Authentication Request [client] via SSL ............................................................................................ 27 (a)Authentication Reply [gateway] (Login Result Pending-begin result polling) ............................ 27 Client-initiated Authentication Result Poll [client] ............................................................................ 27 (a) Authentication Reply [gateway] (Result Still Pending-repeat polling operation again in 5 seconds) ........................................................................................................................................................ 27 (b)Authentication Reply [gateway] (Login rejected) ........................................................................ 28 (c)Authentication Reply [gateway] (Login Successful) ................................................................... 28 Client-initiated Connection Termination (logoff) of Authenticated User [client] ........................... 28 Logoff Reply [gateway] ........................................................................................................................ 28 Appendix D: XML Schema 30 Copyright 2012, iPass Inc. All rights reserved. Trademarks iPass, iPassConnect, ExpressConnect, iPassNet, RoamServer, NetServer, iPass Mobile Office, DeviceID, EPM, iSEEL, iPass Alliance, Open Mobile, and the iPass logo are trademarks of iPass Inc. All other brand or product names are trademarks or registered trademarks of their respective companies. Warranty No part of this document may be reproduced, disclosed, electronically distributed, or used without the prior consent of the copyright holder. Use of the software and documentation is governed by the terms and conditions of the iPass Corporate Remote Access Agreement, or Channel Partner Reseller Agreement. Information in this document is subject to change without notice. Every effort has been made to use fictional companies and locations in this document. Any actual company names or locations are strictly coincidental and do not constitute endorsement. iPass® Generic Interface Specification 2012 iPass In c. Page 3 3 Scope This document contains a Generic Interface Specification (GIS) between a smart client and an access gateway or other hybrid access control system. The GIS is compatible with the existing Web Browser authentication services that are presently deployed at hotspots. iPass® Generic Interface Specification 2012 iPass In c. Page 4 4 Client Integration Client Integration This interface is implemented through the use of client-initiated, HTTP message exchanges. TCP connections are established to ports 80 and 443 unless otherwise indicated. HTTP version 1.0 (http://www.ietf.org/rfc/rfc1945.txt) is specified due to its simplified header formats. The following interaction diagrams represent the access protocol from the perspective of the smart client. Login Request: Successful Case Client Gateway AAA |----------->| 1. HTTP GET operation to any “real” URL |<-----------| 2. Redirect identifies Login URL |----------->| 3. POST Credentials (user name/password) |---------->| 4. Auth Request |<----------| 5. Auth Reply - Accept |<-----------| 6. Success Notification identifies logoff URL |---------->| 7. Start Accounting |<----------| 8. Acknowledgment . Internet Access Enabled . |----------->| 9. HTTP GET to Logoff URL (from step 6) |---------->| 10. Stop Accounting |<----------| 11. Acknowledgment |<-----------| 12. Logoff Notification iPass® Generic Interface Specification 2012 iPass In c. Page 5 5 Client Integration Login Request: Successful Case With Proxy Reply Client Gateway AAA |----------->| 1. Arbitrary HTTP GET |<-----------| 2. Proxy Reply, NextURL,Delay |----------->| 1. HTTP GET to NextURL |<-----------| 2. Redirect identfies Login URL |----------->| 3. POST Credentials |---------->| 4. Auth Request |<----------| 5. Auth Reply - Accept |<-----------| 6. Success Notification |---------->| 7. Start Accounting |<----------| 8. Acknowledgment . Internet Access Enabled . |----------->| 9. HTTP GET to Logoff URL |---------->| 10. Stop Accounting |<----------| 11. Acknowledgment |<-----------| 12. Logoff Notification iPass® Generic Interface Specification 2012 iPass In c. Page 6 6 Client Integration Login Request: Successful Case With Polling Client Gateway AAA |----------->| 1. Arbitrary HTTP GET |<-----------| 2. Redirect Login URL |----------->| 3. POST Credentials |---------->| 4. Auth Request |<-----------| 5. Auth Pending |----------->| 6. GET to Polling URL |<-----------| 7. Auth Pending, Delay |<----------| 8. Auth Reply - Accept |----------->| 9. GET to Polling URL |<-----------| 10. Success Notification |---------->| 11. Start Accounting |<----------| 12. Acknowledgment . Internet Access Enabled . |----------->| 13. GET Logoff URL |---------->| 14. Stop Accounting |<----------| 15. Acknowledgment |<-----------| 16. Logoff Notification Login Request: Reject Client Gateway AAA |----------->| 1. Arbitrary HTTP GET |<-----------| 2. Redirect Login URL |----------->| 3. POST Credentials |---------->| 4. Auth Request |<----------| 5. Auth Reply - Reject |<-----------| 6. Failure Notification iPass® Generic Interface Specification 2012 iPass In c. Page 7 7 Client Integration Login Request: Reject With Polling Client Gateway AAA |----------->| 1. Arbitrary HTTP GET |<-----------| 2. Redirect Login URL |----------->| 3. POST Credentials |---------->| 4. Auth Request |<-----------| 5. Auth Pending |----------->| 6. GET to polling URL |<-----------| 7. Auth Pending, delay |<----------| 8. Auth Reply - Reject |----------->| 9. GET to Polling URL |<-----------| 10. Reject Notification Protocol Specifics The smart client to access