normalized JOSE algorithm references, added initial use cases section
authorDavid Dahl <ddahl@mozilla.com>
Mon, 28 Jan 2013 09:36:31 -0600
changeset 4 27bcbfdc4adf
parent 3 be02e044185a
child 5 fa3944fb18db
normalized JOSE algorithm references, added initial use cases section
Overview.html
highlevel-api-source.html
--- a/Overview.html	Fri Jan 25 10:32:29 2013 -0600
+++ b/Overview.html	Mon Jan 28 09:36:31 2013 -0600
@@ -82,11 +82,11 @@
         <h2>Use cases</h2>
         <section>
           <h3>Security of data at rest</h3>
-          <p>TODO</p>
+          <p>An E-commerce website needs to store credit card numbers and related customer information to facilitate 1-step ordering. The site can either store this data on its own servers, making it a rich target for criminals. Another option is protecting this data with the "protect" method and decrypting later with "unprotect" during a transaction. The server stores the the key ID and uses it when appropriate. A credit card transaction is processed easily, the server does not store the credentials and the data is safely stored in the browser's LocalStorage.</p>
         </section>
         <section>
           <h3>Web-based messaging</h3>
-          <p>TODO</p>
+          <p>A web-messaging company would like to provide a private messaging feature. Users can create keypairs and share them via a link, out of band or via a text message. (Users equate public keys with an "addressbook entry", without which, no communication can take place.) After a message is composed, it is encrypted and signed, then sent to the server for delivery. No plaintext is passed to the server or retained on the client.</p>
         </section>
     </section>
     
@@ -128,11 +128,6 @@
     <section class="informative">
       <h2>Privacy considerations</h2>
       <p>The Privacy considerations of [[!WEBCRYPTO]] apply to this specification.</p>
-      <section>
-          <p>
-            TODO
-          </p>
-      </section>
     </section>
     
     <section class="section" id="dependencies">
@@ -181,12 +176,12 @@
           <dd>Get public key by an ID if it exists</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onGetKeypair</dt>
           <dd>onGetKeypair event handler</dd>
-          <dt>void createKeyPair (in DOMString aJoseAlgID)</dt>
+          <dt>void createKeyPair (in DOMString aJoseAlg)</dt>
           <dd>Generate a public keypair</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onCreateKeypair</dt>
           <dd>onCreateKeypair event handler</dd>
 
-          <dt>void encryptAndSign (in DOMSring aPlainText, in DOMString aRecipientJWK, in DOMString aSenderJWKID)</dt>
+          <dt>void encryptAndSign (in DOMSring aPlainText, in DOMString aRecipientJWK, in DOMString aJWKID)</dt>
           <dd>Perform encryption, signing the encrypted data</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onEncryptComplete</dt>
           <dd>onEncryptComplete event handler</dd>
@@ -200,7 +195,7 @@
           <dt>[TreatNonCallableAsNull] attribute Function? onDecryptError</dt>
           <dd>onDecryptError event handler</dd>
 
-          <dt>void protect (in DOMString aPlainText, in DOMString aJWAlgID)</dt>
+          <dt>void protect (in DOMString aPlainText, in DOMString aJOSEAlg)</dt>
           <dd>Symmetric encryption of a string (a key is generated on each use)</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onProtectComplete</dt>
           <dd>onProtectComplete event handler, ciphertext and keyID are passed to this function</dd>
@@ -228,7 +223,7 @@
           <dt>[TreatNonCallableAsNull] attribute Function? onVerifyError</dt>
           <dd>onVerifyError event handler</dd>
 
-          <dt>void hash(in DOMString aJWAlgID, in DOMString aData)</dt>
+          <dt>void hash(in DOMString aJOSEAlg, in DOMString aData)</dt>
           <dd>Create a cryptographic hash</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onHashComplete</dt>
           <dd>onHashComplete event handler</dd>
--- a/highlevel-api-source.html	Fri Jan 25 10:32:29 2013 -0600
+++ b/highlevel-api-source.html	Mon Jan 28 09:36:31 2013 -0600
@@ -82,11 +82,11 @@
         <h2>Use cases</h2>
         <section>
           <h3>Security of data at rest</h3>
-          <p>TODO</p>
+          <p>An E-commerce website needs to store credit card numbers and related customer information to facilitate 1-step ordering. The site can either store this data on its own servers, making it a rich target for criminals. Another option is protecting this data with the "protect" method and decrypting later with "unprotect" during a transaction. The server stores the the key ID and uses it when appropriate. A credit card transaction is processed easily, the server does not store the credentials and the data is safely stored in the browser's LocalStorage.</p>
         </section>
         <section>
           <h3>Web-based messaging</h3>
-          <p>TODO</p>
+          <p>A web-messaging company would like to provide a private messaging feature. Users can create keypairs and share them via a link, out of band or via a text message. (Users equate public keys with an "addressbook entry", without which, no communication can take place.) After a message is composed, it is encrypted and signed, then sent to the server for delivery. No plaintext is passed to the server or retained on the client.</p>
         </section>
     </section>
     
@@ -128,11 +128,6 @@
     <section class="informative">
       <h2>Privacy considerations</h2>
       <p>The Privacy considerations of [[!WEBCRYPTO]] apply to this specification.</p>
-      <section>
-          <p>
-            TODO
-          </p>
-      </section>
     </section>
     
     <section class="section" id="dependencies">
@@ -181,12 +176,12 @@
           <dd>Get public key by an ID if it exists</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onGetKeypair</dt>
           <dd>onGetKeypair event handler</dd>
-          <dt>void createKeyPair (in DOMString aJoseAlgID)</dt>
+          <dt>void createKeyPair (in DOMString aJoseAlg)</dt>
           <dd>Generate a public keypair</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onCreateKeypair</dt>
           <dd>onCreateKeypair event handler</dd>
 
-          <dt>void encryptAndSign (in DOMSring aPlainText, in DOMString aRecipientJWK, in DOMString aSenderJWKID)</dt>
+          <dt>void encryptAndSign (in DOMSring aPlainText, in DOMString aRecipientJWK, in DOMString aJWKID)</dt>
           <dd>Perform encryption, signing the encrypted data</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onEncryptComplete</dt>
           <dd>onEncryptComplete event handler</dd>
@@ -200,7 +195,7 @@
           <dt>[TreatNonCallableAsNull] attribute Function? onDecryptError</dt>
           <dd>onDecryptError event handler</dd>
 
-          <dt>void protect (in DOMString aPlainText, in DOMString aJWAlgID)</dt>
+          <dt>void protect (in DOMString aPlainText, in DOMString aJOSEAlg)</dt>
           <dd>Symmetric encryption of a string (a key is generated on each use)</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onProtectComplete</dt>
           <dd>onProtectComplete event handler, ciphertext and keyID are passed to this function</dd>
@@ -228,7 +223,7 @@
           <dt>[TreatNonCallableAsNull] attribute Function? onVerifyError</dt>
           <dd>onVerifyError event handler</dd>
 
-          <dt>void hash(in DOMString aJWAlgID, in DOMString aData)</dt>
+          <dt>void hash(in DOMString aJOSEAlg, in DOMString aData)</dt>
           <dd>Create a cryptographic hash</dd>
           <dt>[TreatNonCallableAsNull] attribute Function? onHashComplete</dt>
           <dd>onHashComplete event handler</dd>