summaryrefslogtreecommitdiffstats
path: root/samples/KeyChainDemo/_index.html
diff options
context:
space:
mode:
authorTony Chan <htchan@google.com>2012-03-29 02:03:59 +0800
committerTony Chan <htchan@google.com>2012-03-30 11:10:01 +0800
commit1a2ddb4216d81f9feadfea3a94bc9923255fe49a (patch)
tree73907472e1bb4be76eb885bc1c942e154f6e2d29 /samples/KeyChainDemo/_index.html
parent64cd8f35fb9cefdeaaded4025af011d1d4c9b90a (diff)
downloadandroid_development-1a2ddb4216d81f9feadfea3a94bc9923255fe49a.tar.gz
android_development-1a2ddb4216d81f9feadfea3a94bc9923255fe49a.tar.bz2
android_development-1a2ddb4216d81f9feadfea3a94bc9923255fe49a.zip
sdk doc change: Added KeyChain API Demo
Change-Id: Ib2b751a9de485359705b243d2c70e5f8f2c8ab3c
Diffstat (limited to 'samples/KeyChainDemo/_index.html')
-rw-r--r--samples/KeyChainDemo/_index.html50
1 files changed, 50 insertions, 0 deletions
diff --git a/samples/KeyChainDemo/_index.html b/samples/KeyChainDemo/_index.html
new file mode 100644
index 000000000..57e91b30f
--- /dev/null
+++ b/samples/KeyChainDemo/_index.html
@@ -0,0 +1,50 @@
+<p>This is a demo application highlighting how to use the KeyChain APIs introduced in API Level 14.</p>
+
+<p>The source code for this demo app shows how to install a PKCS12 key chain stored in the assets folder,
+ grant permission to the app to use the installed key chain and finally display the certificate and
+ private key info. The app also has a simple implementation of a web server listening to requests
+ at an SSL socket using the same certificate in the key chain.
+</p>
+
+<p>The application includes the following key classes:</p>
+<ul>
+ <li><a href="src/com/example/android/keychain/KeyChainDemoActivity.html"><code>KeyChainDemoActivity</code></a>
+ &mdash; the main <code>Activity</code> that is used to install the key chain and start/stop
+ the web server. </li>
+ <li><a href="src/com/example/android/keychain/SecureWebServer.html"><code>SecureWebServer</code></a>
+ &mdash; a single thread web server listening at port 8080 for <code>https://localhost:8080</code> request</li>
+ <li><a href="src/com/example/android/keychain/SecureWebServerService.html"><code>SecureWebServerService</code></a>
+ &mdash; a <code>Service</code> that runs the web server in the foreground.</li>
+</ul>
+
+<p>If you are developing an application that uses the KeyChain APIs,
+ remember that the feature is supported only on Android 4.0 (API level 14) and
+ higher versions of the platform. To ensure that your application can only be
+ installed on devices that are running Android 4.0, remember to add the
+ following to the application's manifest:</p>
+<ul>
+ <li><code>&lt;uses-sdk android:minSdkVersion="14" /&gt;</code>, which
+ indicates to the Android platform that your application requires
+ Android 4.0 or higher. For more information, see <a
+ href="../../../guide/appendix/api-levels.html">API Levels</a> and the
+ documentation for the <a
+ href="../../../guide/topics/manifest/uses-sdk-element.html"><code>&lt;uses-sdk&gt;</code></a>
+ element.</li>
+</ul>
+
+<p>Note: Due to browser cache, you need to restart the browser completely before it can recognize
+ any keystore updates. The easiest way to do this is to dismiss the app in the Recent Apps list.
+</p>
+
+<p>
+ For more information about using the KeyChain API, see the
+ <a href="../../../reference/android/security/KeyChain.html">
+ <code>android.security.KeyChain</code></a>
+ documentation.
+</p>
+
+<img alt="" src="../images/KeyChainDemo1.png" />
+<img alt="" src="../images/KeyChainDemo2.png" />
+<img alt="" src="../images/KeyChainDemo3.png" />
+<img alt="" src="../images/KeyChainDemo4.png" />
+