Bug 25389 - Provide definition of 'octet string' and link throughout document
authorMark Watson <watsonm@netflix.com>
Tue, 23 Sep 2014 11:00:30 -0700
changeset 218 245fcde1bf6f
parent 217 07185a01188e
child 219 d4704a7582c8
Bug 25389 - Provide definition of 'octet string' and link throughout document
spec/Overview-WebCryptoAPI.xml
spec/Overview.html
--- a/spec/Overview-WebCryptoAPI.xml	Tue Sep 23 10:43:42 2014 -0700
+++ b/spec/Overview-WebCryptoAPI.xml	Tue Sep 23 11:00:30 2014 -0700
@@ -655,6 +655,10 @@
           are defined by the HTML specification [<a href="#HTML">HTML</a>].
         </p>
         <p>
+          An <dfn id="dfn-octet-string">octet string</dfn> is an ordered sequence of zero or more
+          integers, each in the range 0 to 255 inclusive.
+        </p>
+        <p>
           Comparing two strings in a <dfn id="case-sensitive">case-sensitive</dfn>
           manner means comparing them exactly, code point for code point.
         </p>
@@ -9008,7 +9012,8 @@
                             </li>
                             <li>
                               <p>
-                                Set the <var>subjectPublicKey</var> field to the octet string that
+                                Set the <var>subjectPublicKey</var> field to the
+                                <a href="#dfn-octet-string">octet string</a> that
                                 represents the Elliptic Curve public key represented by the [[<a
                                 href="#dfn-CryptoKey-slot-handle">handle</a>]] internal slot of
                                 <var>key</var> according to the encoding rules specified in
@@ -9314,7 +9319,7 @@
               <tr>
                 <td>deriveBits</td>
                 <td><a href="#dfn-EcdhKeyDeriveParams">EcdhKeyDeriveParams</a></td>
-                <td>Octet string</td>
+                <td><a href="#dfn-octet-string">Octet string</a></td>
               </tr>
               <tr>
                 <td>importKey</td>
@@ -9574,7 +9579,7 @@
                         <li>
                           <p>
                             Let <var>secret</var> be the result of applying the field element to
-                            octet string conversion defined in Section ? of <a href="#X9.63">X9.63</a>
+                            <a href="#dfn-octet-string">octet string</a> conversion defined in Section ? of <a href="#X9.63">X9.63</a>
                             to the output of the ECDH primitive.
                           </p>
                         </li>
@@ -10393,7 +10398,7 @@
                             </li>
                             <li>
                               <p>
-                                Set the <var>subjectPublicKey</var> field to the octet string that
+                                Set the <var>subjectPublicKey</var> field to the <a href="#dfn-octet-string">octet string</a> that
                                 represents the Elliptic Curve public key represented by the [[<a
                                 href="#dfn-CryptoKey-slot-handle">handle</a>]] internal slot of
                                 <var>key</var> according to the encoding rules specified in
@@ -10640,7 +10645,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be an octet string representing the Elliptic Curve
+                            Let <var>data</var> be an <a href="#dfn-octet-string">octet string</a> representing the Elliptic Curve
                             point <var>Q</var> represented by [[<a
                             href="#dfn-CryptoKey-slot-handle">handle</a>]] internal slot of
                             <var>key</var> according to <a href="#X9.62">X9.62</a> Annex A.
@@ -10976,7 +10981,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -11015,7 +11020,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -11532,7 +11537,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -11571,7 +11576,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -12048,7 +12053,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -12087,7 +12092,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -12693,7 +12698,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -12732,7 +12737,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -13211,7 +13216,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -13251,7 +13256,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -13697,7 +13702,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -13737,7 +13742,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -14299,7 +14304,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -14351,7 +14356,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -14855,7 +14860,7 @@
               <tr>
                 <td>deriveBits</td>
                 <td><a href="#dfn-DhKeyDeriveParams">DhKeyDeriveParams</a></td>
-                <td>Octet string</td>
+                <td><a href="#dfn-octet-string">Octet string</a></td>
               </tr>
               <tr>
                 <td>importKey</td>
@@ -15329,7 +15334,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-prime">prime</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>prime</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>prime</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -15337,7 +15342,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-generator">generator</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>base</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>base</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -15456,7 +15461,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-prime">prime</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>prime</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>prime</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -15464,7 +15469,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-generator">generator</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>base</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>base</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -15535,7 +15540,7 @@
                               of <var>key</var> is <code>"private"</code>:
                             </dt>
                             <dd>
-                              Let <var>data</var> be the octet string that represents the private
+                              Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> that represents the private
                               value <var>x</var> associated with <var>key</var> as a big integer,
                               most significant octet first.
                             </dd>
@@ -15876,7 +15881,7 @@
               <tr>
                 <td>deriveBits</td>
                 <td><a href="#dfn-ConcatParams">ConcatParams</a></td>
-                <td>Octet string</td>
+                <td><a href="#dfn-octet-string">Octet string</a></td>
               </tr>
               <tr>
                 <td>Import key</td>
--- a/spec/Overview.html	Tue Sep 23 10:43:42 2014 -0700
+++ b/spec/Overview.html	Tue Sep 23 11:00:30 2014 -0700
@@ -662,6 +662,10 @@
           are defined by the HTML specification [<a href="#HTML">HTML</a>].
         </p>
         <p>
+          An <dfn id="dfn-octet-string">octet string</dfn> is an ordered sequence of zero or more
+          integers, each in the range 0 to 255 inclusive.
+        </p>
+        <p>
           Comparing two strings in a <dfn id="case-sensitive">case-sensitive</dfn>
           manner means comparing them exactly, code point for code point.
         </p>
@@ -8687,7 +8691,8 @@
                             </li>
                             <li>
                               <p>
-                                Set the <var>subjectPublicKey</var> field to the octet string that
+                                Set the <var>subjectPublicKey</var> field to the
+                                <a href="#dfn-octet-string">octet string</a> that
                                 represents the Elliptic Curve public key represented by the [[<a href="#dfn-CryptoKey-slot-handle">handle</a>]] internal slot of
                                 <var>key</var> according to the encoding rules specified in
                                 Section 2.2 of <a href="#RFC5480">RFC 5480</a> and using the
@@ -8977,7 +8982,7 @@
               <tr>
                 <td>deriveBits</td>
                 <td><a href="#dfn-EcdhKeyDeriveParams">EcdhKeyDeriveParams</a></td>
-                <td>Octet string</td>
+                <td><a href="#dfn-octet-string">Octet string</a></td>
               </tr>
               <tr>
                 <td>importKey</td>
@@ -9228,7 +9233,7 @@
                         <li>
                           <p>
                             Let <var>secret</var> be the result of applying the field element to
-                            octet string conversion defined in Section ? of <a href="#X9.63">X9.63</a>
+                            <a href="#dfn-octet-string">octet string</a> conversion defined in Section ? of <a href="#X9.63">X9.63</a>
                             to the output of the ECDH primitive.
                           </p>
                         </li>
@@ -10011,7 +10016,7 @@
                             </li>
                             <li>
                               <p>
-                                Set the <var>subjectPublicKey</var> field to the octet string that
+                                Set the <var>subjectPublicKey</var> field to the <a href="#dfn-octet-string">octet string</a> that
                                 represents the Elliptic Curve public key represented by the [[<a href="#dfn-CryptoKey-slot-handle">handle</a>]] internal slot of
                                 <var>key</var> according to the encoding rules specified in
                                 Section 2.2 of <a href="#RFC5480">RFC 5480</a> and using the
@@ -10241,7 +10246,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be an octet string representing the Elliptic Curve
+                            Let <var>data</var> be an <a href="#dfn-octet-string">octet string</a> representing the Elliptic Curve
                             point <var>Q</var> represented by [[<a href="#dfn-CryptoKey-slot-handle">handle</a>]] internal slot of
                             <var>key</var> according to <a href="#X9.62">X9.62</a> Annex A.
                           </p>
@@ -10568,7 +10573,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -10607,7 +10612,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -11104,7 +11109,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -11143,7 +11148,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -11615,7 +11620,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -11654,7 +11659,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -12243,7 +12248,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -12282,7 +12287,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -12741,7 +12746,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -12781,7 +12786,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -13216,7 +13221,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -13256,7 +13261,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -13807,7 +13812,7 @@
                       <ol>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string contained in <var>keyData</var>.
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> contained in <var>keyData</var>.
                           </p>
                         </li>
                         <li>
@@ -13859,7 +13864,7 @@
                         </li>
                         <li>
                           <p>
-                            Let <var>data</var> be the octet string obtained by decoding the
+                            Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> obtained by decoding the
                             <code>"k"</code> field of <var>jwk</var>.
                           </p>
                         </li>
@@ -14355,7 +14360,7 @@
               <tr>
                 <td>deriveBits</td>
                 <td><a href="#dfn-DhKeyDeriveParams">DhKeyDeriveParams</a></td>
-                <td>Octet string</td>
+                <td><a href="#dfn-octet-string">Octet string</a></td>
               </tr>
               <tr>
                 <td>importKey</td>
@@ -14799,7 +14804,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-prime">prime</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>prime</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>prime</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -14807,7 +14812,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-generator">generator</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>base</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>base</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -14917,7 +14922,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-prime">prime</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>prime</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>prime</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -14925,7 +14930,7 @@
                       <p>
                         Set the <a href="#dfn-DhKeyAlgorithm-generator">generator</a> attribute of
                         <var>algorithm</var> to a new <code>BigInteger</code> equal to the
-                        octet string encoding of the <code>base</code> field of
+                        <a href="#dfn-octet-string">octet string</a> encoding of the <code>base</code> field of
                         <var>params</var>.
                       </p>
                     </li>
@@ -14994,7 +14999,7 @@
                               of <var>key</var> is <code>"private"</code>:
                             </dt>
                             <dd>
-                              Let <var>data</var> be the octet string that represents the private
+                              Let <var>data</var> be the <a href="#dfn-octet-string">octet string</a> that represents the private
                               value <var>x</var> associated with <var>key</var> as a big integer,
                               most significant octet first.
                             </dd>
@@ -15318,7 +15323,7 @@
               <tr>
                 <td>deriveBits</td>
                 <td><a href="#dfn-ConcatParams">ConcatParams</a></td>
-                <td>Octet string</td>
+                <td><a href="#dfn-octet-string">Octet string</a></td>
               </tr>
               <tr>
                 <td>Import key</td>