Author: channa Date: Sun Jul 20 00:19:24 2008 New Revision: 19655 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=19655
Log: Added documentation for OpenID and InfoCard. MASHUP-728. Added: trunk/mashup/java/xdocs/identity.html trunk/mashup/java/xdocs/images/infocard_92x64.png (contents, props changed) trunk/mashup/java/xdocs/images/openid-logo.jpg (contents, props changed) trunk/mashup/java/xdocs/images/openid_associate.png (contents, props changed) trunk/mashup/java/xdocs/images/openid_details_verify.png (contents, props changed) trunk/mashup/java/xdocs/images/openid_selfreg_url.png (contents, props changed) Modified: trunk/mashup/java/xdocs/toc.html trunk/mashup/java/xdocs/usermanagement.html Added: trunk/mashup/java/xdocs/identity.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/identity.html?pathrev=19655 ============================================================================== --- (empty file) +++ trunk/mashup/java/xdocs/identity.html Sun Jul 20 00:19:24 2008 @@ -0,0 +1,240 @@ +<!-- +~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) +~ +~ Licensed under the Apache License, Version 2.0 (the "License"); +~ you may not use this file except in compliance with the License. +~ You may obtain a copy of the License at +~ +~ http://www.apache.org/licenses/LICENSE-2.0 +~ +~ Unless required by applicable law or agreed to in writing, software +~ distributed under the License is distributed on an "AS IS" BASIS, +~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~ See the License for the specific language governing permissions and +~ limitations under the License. +--> +<html> +<head> + <meta http-equiv="content-type" content=""> + <title>Identity</title> + <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" + media="all"> +</head> + +<body> + +<div id="main-content"> +<h1>Identity Management<br> +</h1> + +<p>The WSO2 Mashup Server utilizes the WSO2 <a +href="http://wso2.org/project/solutions/identity/1.5/docs/";>Identity +Solution</a> to provide two more user friendly means of authentication in +addition to the usual User ID and Password based login. Both OpenID and +InfoCard are fast becoming preferred means of authentication </p> + +<p>for users frustrated by the need to remember user ID and password +combinations for an increasing number of web sites and services that require +authentication. You can enable both options for users registering on your +WSO2 Mashup Server by updating your </p> + +<p>server installation as described below.</p> + +<h1>OpenID</h1> +<img src="images/openid-logo.jpg"> + +<h2>Preparing the Server</h2> + +<p>If you have already setup the 'webapp_url' parameter in the as shown +below, your Mashup Server is ready to allow OpenID based authentication.</p> + +<p><init-param></p> + +<p><param-name>webapp_url</param-name></p> + +<p><param-value>https://<strong>mydomain</strong>/</param-value></p> + +<p></init-param></p> + +<p></p> + +<h2>Using OpenID</h2> + +<p>Simply attempting to Login with an unregistered OpenID will trigger the +self registration process, if internet guests are allowed on your server. The +initial page displayed will warn you that you are attempting to use an +unregistered OpenID to login and </p> + +<p>request confirmation to register this OpenId on the site.</p> +<img src="images/openid_selfreg_url.png"> + +<p>Once you click on 'Register', the Mashup Server will retrieve your full +name, nickname and e-mail ID from your identity provider and display this +information in a confirmation page, requesting you to complete any required +</p> + +<p>details that were not made available. Clicking on the 'Register' link here +will initiate the standard e-mail ID verification process, after which you +may Login using your newly registered OpenID.</p> +<img src="images/openid_details_verify.png"> + +<h3>Associating an OpenID with an Existing Profile</h3> + +<p>Clicking on the 'Register your OpenID' link will bring up a text field +into which you can enter the URL of the OpenID that you wish to associate +with your current profile. Clicking on the 'Add' button will complete the +association, after which you can</p> + +<p>Login using this ID.</p> + +<p><img src="images/openid_associate.png" alt="Associate OpenId"> </p> + +<h1>InfoCard</h1> + +<p><img src="images/infocard_92x64.png"> </p> + +<h2>Preparing the Server</h2> + +<p>1. To use InfoCards for authentication, the JDK on your mashup server +needs to include the 'Java Cryptography Extension (JCE) Unlimited Strength +Jurisdiction Policy Files' which can be found, along with installation +instructions, on the download page </p> + +<p>for your JDK. The policy file for JDK 1.5 can be found <a +href="https://cds.sun.com/is-bin/INTERSHOP.enfinity/WFS/CDS-CDS_Developer-Site/en_US/-/USD/[EMAIL PROTECTED]">here</a>. +Typically, just copying the local_policy.jar and US_export_policy.jar files +from the downloaded zip file to the /jre/lib/security directory of your JDK, +overwriting the two existing files, is all you need to do. </p> + +<p>2. A keystore needs to be configured on your server. The default +configuration and keystore that ships with the mashup server will be +sufficient for testing CardSpace on your local system, but the parameters +hightlighted below need to be changed to match </p> + +<p>a valid certificate that you will need to obtain for your domain before +you allow external users to authenticate via InfoCards.</p> + +<p></p> + +<h3>The [Mashup Home]/lib/tomcat/webapps/ROOT/WEB-INF/web.xml file needs to +have the keystore information updated.</h3> + +<p><init-param></p> + +<p><param-name>Keystore</param-name></p> + +<p><param-value>../../../../conf/<strong>mykeystore</strong>.jks</param-value></p> + +<p></init-param></p> + +<p><init-param></p> + +<p><param-name>StorePass</param-name></p> + +<p><param-value><strong>mykeystorepassword</strong></param-value></p> + +<p></init-param></p> + +<p><init-param></p> + +<p><param-name>KeyAlias</param-name></p> + +<p><param-value><strong>myalias</strong></param-value></p> + +<p></init-param></p> + +<p><init-param></p> + +<p><param-name>KeyPass</param-name></p> + +<p><param-value><strong>mykeypass</strong></param-value></p> + +<p></init-param></p> + +<p></p> + +<h3>This change has to also be carried out in the [Mashup +Home]/conf/axis2.xml file, by updating the values highlighted below.</h3> + +<p><parameter name="keystore"></p> + +<p><wso2wsas:KeyStore +xmlns:wso2wsas="http://www.wso2.org/products/wsas"></p> + +<p><!-- Keystore file location--></p> + +<p><wso2wsas:Location>conf/<strong>mykeystore</strong>.jks</wso2wsas:Location></p> + +<p><!-- Keystore type (JKS/PKCS12 etc.)--></p> + +<p><wso2wsas:Type>JKS</wso2wsas:Type></p> + +<p><!-- Keystore password--></p> + +<p><wso2wsas:Password><strong>mykeystorepassword</strong></wso2wsas:Password></p> + +<p></wso2wsas:KeyStore></p> + +<p></parameter></p> + +<p></p> + +<h2>Preparing the Client</h2> + +<p>1. Windows/IE users should download the Microsoft .NET Framework 3.0 +Redistributable Package from <a +href="http://www.microsoft.com/downloads/details.aspx?familyid=10cc340b-f857-4a14-83f5-25634c3bf043&displaylang=en";>here</a> +and install it to setup the CardSpace selector in your Windows based client. +Also, please make sure you're running MSIE 7.0.</p> + +<p>2. Firefox user can use an Identity selector plugin of their choice.</p> + +<p><br> +</p> + +<h2>Using InfoCard</h2> + +<p>As a user, you can either register yourself using your InfoCard directly, +or register using a username and password, and associate your InfoCard with +this profile later on. </p> + +<p>Registering </p> + +<h3>Self Registration with InfoCard </h3> + +<p>When the 'Get details from my personal or Managed InfoCard' image is +clicked, you will be shown the IdentitySelector, from whcih you need to +select the InfoCard that you plan to use to register on the Mashup Server.</p> + +<p><img style="width: 1001px; height: 558px;" alt="Self Registration" +src="images/Self_Registration.png"><br> +Once you send the card across, the server will extract the required claims +from the information supplied by the InfoCard and display them for +verification, while requesting you to enter a username, based on which the +server </p> + +<p>will create your profile and script directory. After the standard e-mail +ID verification step is complete, you may login using your InfoCard and +associate other InfoCards, OpenID's or even a password with your profile.</p> + +<h3>Associating an InfoCard with an Existing Profile</h3> + +<p>The 'Management Tasks' pane of the profile page contains a link to +'Register your InfoCard'. This can be used as many times as necessary, to +associate as many cards as you require with your profile. Simply click on the +link, </p> + +<p>select the card to be associated in your Identity Selector and send. The +next time you access your profile, you will see the list of associated cards +displayed.</p> + +<p><br> +<img style="width: 1010px; height: 564px;" alt="Profile" +src="images/User_Profile.png"><br> +<br> +</p> +</div> + +<p>© WSO2 Inc.</p> +</body> +</html> Added: trunk/mashup/java/xdocs/images/infocard_92x64.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/infocard_92x64.png?pathrev=19655 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/openid-logo.jpg URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/openid-logo.jpg?pathrev=19655 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/openid_associate.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/openid_associate.png?pathrev=19655 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/openid_details_verify.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/openid_details_verify.png?pathrev=19655 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/openid_selfreg_url.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/openid_selfreg_url.png?pathrev=19655 ============================================================================== Binary file. No diff available. Modified: trunk/mashup/java/xdocs/toc.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/toc.html?rev=19655&r1=19654&r2=19655&view=diff ============================================================================== --- trunk/mashup/java/xdocs/toc.html (original) +++ trunk/mashup/java/xdocs/toc.html Sun Jul 20 00:19:24 2008 @@ -1,84 +1,96 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head> -<!-- -~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) -~ -~ Licensed under the Apache License, Version 2.0 (the "License"); -~ you may not use this file except in compliance with the License. -~ You may obtain a copy of the License at -~ -~ http://www.apache.org/licenses/LICENSE-2.0 -~ -~ Unless required by applicable law or agreed to in writing, software -~ distributed under the License is distributed on an "AS IS" BASIS, -~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~ See the License for the specific language governing permissions and -~ limitations under the License. ---> -<meta http-equiv="content-type" content=""><title>WSO2 Mashup Server Documentation - Table of Contents</title> - -<link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> +<html> +<head> + <!-- + ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> + <meta http-equiv="content-type" content=""> + <title>WSO2 Mashup Server Documentation - Table of Contents</title> + <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" + media="all"> </head> <body style="margin: 0px; padding: 0px; direction: ltr;" lang="en-US"> -<div class="nav_header">Documentation -Index</div> + +<div class="nav_header"> +Documentation Index</div> + <div id="nav_list"> <p><a href="introduction.html" target="mainFrame">Introduction</a></p> -<p><a href="community.html" target="mainFrame">WSO2 -Mashup Server Community</a></p> + +<p><a href="community.html" target="mainFrame">WSO2 Mashup Server +Community</a></p> + <p><a target="mainFrame" href="installationguide.html">Installation</a></p> -<p><a href="adminguide.html" target="mainFrame">Managing -Services</a></p> -<p><a href="usermanagement.html" target="mainFrame">Managing -Users</a></p> -<p><a href="apidocs/index.html" target="_blank">API -Docs</a></p> + +<p><a href="adminguide.html" target="mainFrame">Managing Services</a></p> + +<p><a href="usermanagement.html" target="mainFrame">Managing Users</a></p><li><a href="identity.html" target="mainFrame">Identities</a></li> + +<p><a href="apidocs/index.html" target="_blank">API Docs</a></p> + <h3>Writing Services</h3> <ul> -<li><a href="helloworldservice.html" target="mainFrame">Writing a Hello World Service</a></li> -<li><a href="generatedresources.html" target="mainFrame">Automatically -Generated Resources</a></li> -<li><a href="annotations.html" target="mainFrame">Javascript -Web Service Annotations</a></li> -<li><a href="dataBinding.html" target="mainFrame">Javascript -Data Binding</a></li> -<li><a href="restyservices.html" target="mainFrame">Writing -RESTful services</a></li> -<li><a href="e4xquickstart.html" target="mainFrame">E4X -Quick Start Guide</a></li> -<li><a href="tooling.html" target="mainFrame">Productivity -Tools</a></li> + <li><a href="helloworldservice.html" target="mainFrame">Writing a Hello + World Service</a></li> + <li><a href="generatedresources.html" target="mainFrame">Automatically + Generated Resources</a></li> + <li><a href="annotations.html" target="mainFrame">Javascript Web Service + Annotations</a></li> + <li><a href="dataBinding.html" target="mainFrame">Javascript Data + Binding</a></li> + <li><a href="restyservices.html" target="mainFrame">Writing RESTful + services</a></li> + <li><a href="e4xquickstart.html" target="mainFrame">E4X Quick Start + Guide</a></li> + <li><a href="tooling.html" target="mainFrame">Productivity Tools</a></li> </ul> + <h3>Consuming Services</h3> <ul> -<li><a href="helloworldclient.html" target="mainFrame">Hello -World Client</a></li> -<li><a href="consumingservices.html" target="mainFrame">Using -stubs</a></li> -<li><a href="hostedobjects.html" target="mainFrame">Hosted -Objects</a> -<ul> -<li><a href="apphostobject.html" target="mainFrame">APP</a></li> -<li><a href="emailhostobject.html" target="mainFrame">Email</a> </li> -<li><a href="feedhostobject.html" target="mainFrame">Feed</a></li> -<li><a href="filehostobject.html" target="mainFrame">File</a></li> -<li><a href="imhostobject.html" target="mainFrame">IM</a></li> -<li><a href="requesthostobject.html">Request</a></li> -<li><a href="scraperhostobject.html" target="mainFrame">Scraper</a></li> -<li><a href="sessionhostobject.html" target="mainFrame">Session</a></li> -<li><a href="systemhostobject.html" target="mainFrame">System</a></li> -<li><a href="wsrequesthostobject.html" target="mainFrame">WSRequest</a></li> -</ul> -</li> + <li><a href="helloworldclient.html" target="mainFrame">Hello World + Client</a></li> + <li><a href="consumingservices.html" target="mainFrame">Using stubs</a></li> + <li><a href="hostedobjects.html" target="mainFrame">Hosted Objects</a> + <ul> + <li><a href="apphostobject.html" target="mainFrame">APP</a></li> + <li><a href="emailhostobject.html" target="mainFrame">Email</a> </li> + <li><a href="feedhostobject.html" target="mainFrame">Feed</a></li> + <li><a href="filehostobject.html" target="mainFrame">File</a></li> + <li><a href="imhostobject.html" target="mainFrame">IM</a></li> + <li><a href="requesthostobject.html">Request</a></li> + <li><a href="scraperhostobject.html" target="mainFrame">Scraper</a></li> + <li><a href="sessionhostobject.html" target="mainFrame">Session</a></li> + <li><a href="systemhostobject.html" target="mainFrame">System</a></li> + <li><a href="wsrequesthostobject.html" + target="mainFrame">WSRequest</a></li> + </ul> + </li> </ul> + <h3>Other References</h3> <ul> -<li><a href="http://mooshup.com"; target="blank">mooshup.com</a></li> -<li><a href="http://www.wso2.org/wiki/display/mashup/WSO2+Mashup+Server+Reference"; target="blank">WSO2 Mashup Server Reference</a></li> -<li><a href="http://www.wso2.org/taxonomy/term/303/all"; target="blank">The WSO2 Oxygen Tank Library</a></li> -<li><a href="http://wso2.org/forum/226"; target="blank">WSO2 -Mashup Server Community Forum</a></li> + <li><a href="http://mooshup.com"; target="blank">mooshup.com</a></li> + <li><a + href="http://www.wso2.org/wiki/display/mashup/WSO2+Mashup+Server+Reference"; + target="blank">WSO2 Mashup Server Reference</a></li> + <li><a href="http://www.wso2.org/taxonomy/term/303/all"; target="blank">The + WSO2 Oxygen Tank Library</a></li> + <li><a href="http://wso2.org/forum/226"; target="blank">WSO2 Mashup Server + Community Forum</a></li> </ul> </div> -</body></html> \ No newline at end of file +</body> +</html> Modified: trunk/mashup/java/xdocs/usermanagement.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/usermanagement.html?rev=19655&r1=19654&r2=19655&view=diff ============================================================================== --- trunk/mashup/java/xdocs/usermanagement.html (original) +++ trunk/mashup/java/xdocs/usermanagement.html Sun Jul 20 00:19:24 2008 @@ -177,12 +177,13 @@ <p></p> <h3>Assign Administrative Privileges</h3> -<img alt="Assign Admin Icon" src="images/assign_admin.png"> +<img alt="Assign Admin Icon" src="images/assign_admin.png"> + <p>The primary user is permitted to assign administrative privileges to any other registered user. Clicking the 'Assign Admin' icon will display a -confirmation page, where the 'Grant' button will grant these privileges <br/> -to the selected user and toggle icon in the 'Manage Users' page to call -the 'Revoke Admin' action.</p> +confirmation page, where the 'Grant' button will grant these privileges <br> +to the selected user and toggle icon in the 'Manage Users' page to call the +'Revoke Admin' action.</p> <p></p> @@ -199,8 +200,9 @@ header takes a guest to the page below, which allows a new user to enter a valid user ID, full name, e-mail ID and password and request registration. Alternatively, an <br> -InfoCard or OpenID, described in the Identity page, can be used to furnish -user details, simplifying the registration process.<br> +InfoCard or OpenID, described in the <a href="identity.html">Identity</a> +page, can be used to furnish user details, simplifying the registration +process.<br> <br> When this information is submitted, the user is requested to complete the registration process by clicking on a verfication link sent to the specified @@ -235,7 +237,7 @@ links.</p> <p>Further details on managing OpenID and InfoCard are provided in the -Identity page.<br> +<a href="identity.html">Identity</a> page.<br> <br> <img style="width: 1010px; height: 564px;" alt="Profile" src="images/User_Profile.png"><br> _______________________________________________ Mashup-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/mashup-dev
