You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

302 lines
8.9 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>subtle - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package subtle</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "crypto/subtle"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. </dl>
  58. </div>
  59. <!-- The package's Name is printed as title by the top-level template -->
  60. <div id="pkg-overview" class="toggleVisible">
  61. <div class="collapsed">
  62. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  63. </div>
  64. <div class="expanded">
  65. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  66. <p>
  67. Package subtle implements functions that are often useful in cryptographic
  68. code but require careful thought to use correctly.
  69. </p>
  70. </div>
  71. </div>
  72. <div id="pkg-index" class="toggleVisible">
  73. <div class="collapsed">
  74. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  75. </div>
  76. <div class="expanded">
  77. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  78. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  79. <div id="manual-nav">
  80. <dl>
  81. <dd><a href="index.html#ConstantTimeByteEq">func ConstantTimeByteEq(x, y uint8) int</a></dd>
  82. <dd><a href="index.html#ConstantTimeCompare">func ConstantTimeCompare(x, y []byte) int</a></dd>
  83. <dd><a href="index.html#ConstantTimeCopy">func ConstantTimeCopy(v int, x, y []byte)</a></dd>
  84. <dd><a href="index.html#ConstantTimeEq">func ConstantTimeEq(x, y int32) int</a></dd>
  85. <dd><a href="index.html#ConstantTimeLessOrEq">func ConstantTimeLessOrEq(x, y int) int</a></dd>
  86. <dd><a href="index.html#ConstantTimeSelect">func ConstantTimeSelect(v, x, y int) int</a></dd>
  87. </dl>
  88. </div><!-- #manual-nav -->
  89. <h4>Package files</h4>
  90. <p>
  91. <span style="font-size:90%">
  92. <a href="http://localhost:6060/src/crypto/subtle/constant_time.go">constant_time.go</a>
  93. </span>
  94. </p>
  95. </div><!-- .expanded -->
  96. </div><!-- #pkg-index -->
  97. <div id="pkg-callgraph" class="toggle" style="display: none">
  98. <div class="collapsed">
  99. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  100. </div> <!-- .expanded -->
  101. <div class="expanded">
  102. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  103. <p>
  104. In the call graph viewer below, each node
  105. is a function belonging to this package
  106. and its children are the functions it
  107. calls&mdash;perhaps dynamically.
  108. </p>
  109. <p>
  110. The root nodes are the entry points of the
  111. package: functions that may be called from
  112. outside the package.
  113. There may be non-exported or anonymous
  114. functions among them if they are called
  115. dynamically from another package.
  116. </p>
  117. <p>
  118. Click a node to visit that function's source code.
  119. From there you can visit its callers by
  120. clicking its declaring <code>func</code>
  121. token.
  122. </p>
  123. <p>
  124. Functions may be omitted if they were
  125. determined to be unreachable in the
  126. particular programs or tests that were
  127. analyzed.
  128. </p>
  129. <!-- Zero means show all package entry points. -->
  130. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  131. </div>
  132. </div> <!-- #pkg-callgraph -->
  133. <h2 id="ConstantTimeByteEq">func <a href="http://localhost:6060/src/crypto/subtle/constant_time.go?s=922:961#L21">ConstantTimeByteEq</a></h2>
  134. <pre>func ConstantTimeByteEq(x, y <a href="../../builtin/index.html#uint8">uint8</a>) <a href="../../builtin/index.html#int">int</a></pre>
  135. <p>
  136. ConstantTimeByteEq returns 1 if x == y and 0 otherwise.
  137. </p>
  138. <h2 id="ConstantTimeCompare">func <a href="http://localhost:6060/src/crypto/subtle/constant_time.go?s=490:531#L2">ConstantTimeCompare</a></h2>
  139. <pre>func ConstantTimeCompare(x, y []<a href="../../builtin/index.html#byte">byte</a>) <a href="../../builtin/index.html#int">int</a></pre>
  140. <p>
  141. ConstantTimeCompare returns 1 iff the two slices, x
  142. and y, have equal contents. The time taken is a function of the length of
  143. the slices and is independent of the contents.
  144. </p>
  145. <h2 id="ConstantTimeCopy">func <a href="http://localhost:6060/src/crypto/subtle/constant_time.go?s=1415:1456#L45">ConstantTimeCopy</a></h2>
  146. <pre>func ConstantTimeCopy(v <a href="../../builtin/index.html#int">int</a>, x, y []<a href="../../builtin/index.html#byte">byte</a>)</pre>
  147. <p>
  148. ConstantTimeCopy copies the contents of y into x (a slice of equal length)
  149. if v == 1. If v == 0, x is left unchanged. Its behavior is undefined if v
  150. takes any other value.
  151. </p>
  152. <h2 id="ConstantTimeEq">func <a href="http://localhost:6060/src/crypto/subtle/constant_time.go?s=1092:1127#L31">ConstantTimeEq</a></h2>
  153. <pre>func ConstantTimeEq(x, y <a href="../../builtin/index.html#int32">int32</a>) <a href="../../builtin/index.html#int">int</a></pre>
  154. <p>
  155. ConstantTimeEq returns 1 if x == y and 0 otherwise.
  156. </p>
  157. <h2 id="ConstantTimeLessOrEq">func <a href="http://localhost:6060/src/crypto/subtle/constant_time.go?s=1781:1820#L59">ConstantTimeLessOrEq</a></h2>
  158. <pre>func ConstantTimeLessOrEq(x, y <a href="../../builtin/index.html#int">int</a>) <a href="../../builtin/index.html#int">int</a></pre>
  159. <p>
  160. ConstantTimeLessOrEq returns 1 if x &lt;= y and 0 otherwise.
  161. Its behavior is undefined if x or y are negative or &gt; 2**31 - 1.
  162. </p>
  163. <h2 id="ConstantTimeSelect">func <a href="http://localhost:6060/src/crypto/subtle/constant_time.go?s=791:831#L18">ConstantTimeSelect</a></h2>
  164. <pre>func ConstantTimeSelect(v, x, y <a href="../../builtin/index.html#int">int</a>) <a href="../../builtin/index.html#int">int</a></pre>
  165. <p>
  166. ConstantTimeSelect returns x if v is 1 and y if v is 0.
  167. Its behavior is undefined if v takes any other value.
  168. </p>
  169. <div id="footer">
  170. Build version go1.6.<br>
  171. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  172. the content of this page is licensed under the
  173. Creative Commons Attribution 3.0 License,
  174. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  175. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  176. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  177. </div>
  178. </div><!-- .container -->
  179. </div><!-- #page -->
  180. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  181. <script type="text/javascript" src="../../../lib/godoc/jquery.js"></script>
  182. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.js"></script>
  183. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.edit.js"></script>
  184. <script type="text/javascript" src="../../../lib/godoc/godocs.js"></script>
  185. </body>
  186. </html>