Author: keith
Date: Sun Jul 20 11:22:10 2008
New Revision: 19691
URL: http://wso2.org/svn/browse/wso2?view=rev&revision=19691

Log:
Adding a page for keystore management


Added:
   trunk/mashup/java/xdocs/images/upload_private_key.png   (contents, props 
changed)
   trunk/mashup/java/xdocs/images/uploading_certificates.png   (contents, props 
changed)
   trunk/mashup/java/xdocs/keystoremanagement.html
Modified:
   trunk/mashup/java/xdocs/toc.html

Added: trunk/mashup/java/xdocs/images/upload_private_key.png
URL: 
http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/upload_private_key.png?pathrev=19691
==============================================================================
Binary file. No diff available.

Added: trunk/mashup/java/xdocs/images/uploading_certificates.png
URL: 
http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/uploading_certificates.png?pathrev=19691
==============================================================================
Binary file. No diff available.

Added: trunk/mashup/java/xdocs/keystoremanagement.html
URL: 
http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/keystoremanagement.html?pathrev=19691
==============================================================================
--- (empty file)
+++ trunk/mashup/java/xdocs/keystoremanagement.html     Sun Jul 20 11:22:10 2008
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html xmlns="http://www.w3.org/1999/xhtml";><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>Key Store Management</title>
+
+<link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all">
+</head>
+<body lang="EN-US">
+<div id="main-content">
+<h1>Key Store Management</h1>
+<p>Each user account in the Mashup Server has a keystore associated
+with it (The primary admins keystore is used for the system user). This
+keystore is prepolulated with a list if trusted certificates but it
+does not contain a private kay. Hence users must upload there private
+key to this keystore before making use of it.&nbsp;</p><h2 
id="httpMethod">Managing private keys</h2><p>Uploading a private key can be 
done by visiting <a 
href="https://localhost:7443/cert_manager.jsp";>https://localhost:7443/cert_manager.jsp</a>,
 but first you need to get yourself a private key.&nbsp;</p><ul><li>If
+the user already has a keystore (JKS or PKCS12) which contains a
+private key, he could use that keystore to upload a private key to his
+keystore.</li><li>The user can generate a private key for himself using the 
java keytool that comes with the JDK as follows,</li></ul><div 
style="margin-left: 40px;">Enter the following at the command prompt. This 
would create a keystore called keith.jks for you.</div> <p style="margin-left: 
40px;" class="code">keytool -genkey -alias keith -keystore keith.jks</p><div 
style="margin-left: 40px;">This will take you through a series of questions 
(You can skip them by pressing the enter key if you prefer)</div><p 
style="margin-left: 40px;" class="code">Enter keystore password: 
&nbsp;<br>Re-enter new password: <br>What is your first and last 
name?<br>&nbsp; [Unknown]:&nbsp; Keith Chapman<br>What is the name of your 
organizational unit?<br>&nbsp; [Unknown]:&nbsp; Mashup Server<br>What is the 
name of your organization?<br>&nbsp; [Unknown]:&nbsp; WSO2<br>What is the name 
of your City or Locality?<br>&nbsp; [Unknown]:&nbsp; Colombo<br>What is the 
name of your State or Province?<br>&nbsp; [Unknown]:&nbsp; Western<br>What is 
the two-letter country code for this unit?<br>&nbsp; [Unknown]:&nbsp; SL<br>Is 
CN=Keith Chapman, OU=Mashup Server, O=WSO2, L=Colombo, ST=Western, C=SL 
correct?<br>&nbsp; [no]:&nbsp; yes<br><br>Enter key password for 
&lt;keith&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; (RETURN if same as 
keystore password):<br>[EMAIL PROTECTED]:~$</p><br><div style="margin-left: 
40px;">Once the keystore is created users can upload their private key to the 
Mashup Server by visiting <a 
href="https://localhost:7443/cert_manager.jsp";>https://localhost:7443/cert_manager.jsp</a>.
 <br></div><br><div style="margin-left: 40px;"><img style="width: 999px; 
height: 818px;" alt="Upload private key" 
src="images/upload_private_key.png"></div>
+<h2 id="httpMethod"><br></h2><h2 id="httpMethod">Usage of user keystores</h2>
+<br>The users keystore will be used for the follwoing purposes,<br><ol><li>As 
a truststore when accessing secured endpoints/pages/feeds.&nbsp;</li><li>As
+a truststore when securing mashups (If the security policy used to
+secure a mashup requires&nbsp;users to sign the request, then for those
+requests to be valid the clients public&nbsp;certificate should be in the 
mashup authors keystore)</li><li>As a truststore when calling secured mashups 
(If
+the service that you are calling needs the request to be encrypted,
+then for those requests to be valid the&nbsp;public certificate of the
+external service needs to be in the mashup authors keystore)</li><li>To obtain 
the private key during signing&nbsp;(If
+the service that you are calling needs the request to be
+signed,&nbsp;the mashup authors private key will be used to sign these
+requests)</li></ol><h2 id="httpMethod">Managing certificates</h2><br>As
+described above a users keystore is used for many scenarios hence its
+important to be able to import certificates into your keystore. Users
+can manage their certificates by visiting <a 
href="https://localhost:7443/cert_manager.jsp";>https://localhost:7443/cert_manager.jsp</a>.
+The dialogs to upload certificates wont be displyed untill you upload
+your private key. Importing certificates can be done in two 
ways,<br><ol><li>By providing the URL of the site</li><li>By uploading the 
certificate as a file</li></ol><img style="width: 996px; height: 816px;" 
alt="Uploading Certificates" 
src="images/uploading_certificates.png"><br></div><p>� 2007-2008 WSO2 Inc.</p>
+</body></html>
\ No newline at end of file

Modified: trunk/mashup/java/xdocs/toc.html
URL: 
http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/toc.html?rev=19691&r1=19690&r2=19691&view=diff
==============================================================================
--- trunk/mashup/java/xdocs/toc.html    (original)
+++ trunk/mashup/java/xdocs/toc.html    Sun Jul 20 11:22:10 2008
@@ -1,6 +1,5 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head>
-<!--
+<html><head><!--
 ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com)
 ~
 ~ Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,11 +14,10 @@
 ~ 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>
+<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>
@@ -33,7 +31,7 @@
 <p><a href="usermanagement.html" target="mainFrame">Managing
 Users</a></p><li><a href="identity.html" target="mainFrame">Identity 
Management</a>
 </li>
-<p><a href="apidocs/index.html" target="_blank">API
+<p><a href="keystoremanagement.html" target="mainFrame">Keystore 
Management</a></p><p><a href="apidocs/index.html" target="_blank">API
 Docs</a></p>
 <h3>Writing Services</h3>
 <ul>
@@ -82,4 +80,4 @@
 Mashup Server Community Forum</a></li>
 </ul>
 </div>
-</body></html>
+</body></html>
\ No newline at end of file

_______________________________________________
Mashup-dev mailing list
[email protected]
http://wso2.org/cgi-bin/mailman/listinfo/mashup-dev

Reply via email to