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.

347 lines
11 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>ecdsa - 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 ecdsa</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/ecdsa"</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 ecdsa implements the Elliptic Curve Digital Signature Algorithm, as
  68. defined in FIPS 186-3.
  69. </p>
  70. <p>
  71. This implementation derives the nonce from an AES-CTR CSPRNG keyed by
  72. ChopMD(256, SHA2-512(priv.D || entropy || hash)). The CSPRNG key is IRO by
  73. a result of Coron; the AES-CTR stream is IRO under standard assumptions.
  74. </p>
  75. </div>
  76. </div>
  77. <div id="pkg-index" class="toggleVisible">
  78. <div class="collapsed">
  79. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  80. </div>
  81. <div class="expanded">
  82. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  83. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  84. <div id="manual-nav">
  85. <dl>
  86. <dd><a href="index.html#Sign">func Sign(rand io.Reader, priv *PrivateKey, hash []byte) (r, s *big.Int, err error)</a></dd>
  87. <dd><a href="index.html#Verify">func Verify(pub *PublicKey, hash []byte, r, s *big.Int) bool</a></dd>
  88. <dd><a href="index.html#PrivateKey">type PrivateKey</a></dd>
  89. <dd>&nbsp; &nbsp; <a href="index.html#GenerateKey">func GenerateKey(c elliptic.Curve, rand io.Reader) (priv *PrivateKey, err error)</a></dd>
  90. <dd>&nbsp; &nbsp; <a href="index.html#PrivateKey.Public">func (priv *PrivateKey) Public() crypto.PublicKey</a></dd>
  91. <dd>&nbsp; &nbsp; <a href="index.html#PrivateKey.Sign">func (priv *PrivateKey) Sign(rand io.Reader, msg []byte, opts crypto.SignerOpts) ([]byte, error)</a></dd>
  92. <dd><a href="index.html#PublicKey">type PublicKey</a></dd>
  93. </dl>
  94. </div><!-- #manual-nav -->
  95. <h4>Package files</h4>
  96. <p>
  97. <span style="font-size:90%">
  98. <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go">ecdsa.go</a>
  99. </span>
  100. </p>
  101. </div><!-- .expanded -->
  102. </div><!-- #pkg-index -->
  103. <div id="pkg-callgraph" class="toggle" style="display: none">
  104. <div class="collapsed">
  105. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  106. </div> <!-- .expanded -->
  107. <div class="expanded">
  108. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  109. <p>
  110. In the call graph viewer below, each node
  111. is a function belonging to this package
  112. and its children are the functions it
  113. calls&mdash;perhaps dynamically.
  114. </p>
  115. <p>
  116. The root nodes are the entry points of the
  117. package: functions that may be called from
  118. outside the package.
  119. There may be non-exported or anonymous
  120. functions among them if they are called
  121. dynamically from another package.
  122. </p>
  123. <p>
  124. Click a node to visit that function's source code.
  125. From there you can visit its callers by
  126. clicking its declaring <code>func</code>
  127. token.
  128. </p>
  129. <p>
  130. Functions may be omitted if they were
  131. determined to be unreachable in the
  132. particular programs or tests that were
  133. analyzed.
  134. </p>
  135. <!-- Zero means show all package entry points. -->
  136. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  137. </div>
  138. </div> <!-- #pkg-callgraph -->
  139. <h2 id="Sign">func <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go?s=4284:4367#L137">Sign</a></h2>
  140. <pre>func Sign(rand <a href="../../io/index.html">io</a>.<a href="../../io/index.html#Reader">Reader</a>, priv *<a href="index.html#PrivateKey">PrivateKey</a>, hash []<a href="../../builtin/index.html#byte">byte</a>) (r, s *<a href="../../math/big/index.html">big</a>.<a href="../../math/big/index.html#Int">Int</a>, err <a href="../../builtin/index.html#error">error</a>)</pre>
  141. <p>
  142. Sign signs an arbitrary length hash (which should be the result of hashing a
  143. larger message) using the private key, priv. It returns the signature as a
  144. pair of integers. The security of the private key depends on the entropy of
  145. rand.
  146. </p>
  147. <h2 id="Verify">func <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go?s=5960:6020#L211">Verify</a></h2>
  148. <pre>func Verify(pub *<a href="index.html#PublicKey">PublicKey</a>, hash []<a href="../../builtin/index.html#byte">byte</a>, r, s *<a href="../../math/big/index.html">big</a>.<a href="../../math/big/index.html#Int">Int</a>) <a href="../../builtin/index.html#bool">bool</a></pre>
  149. <p>
  150. Verify verifies the signature in r, s of hash using the public key, pub. Its
  151. return value records whether the signature is valid.
  152. </p>
  153. <h2 id="PrivateKey">type <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go?s=1378:1427#L42">PrivateKey</a></h2>
  154. <pre>type PrivateKey struct {
  155. <a href="index.html#PublicKey">PublicKey</a>
  156. D *<a href="../../math/big/index.html">big</a>.<a href="../../math/big/index.html#Int">Int</a>
  157. }</pre>
  158. <p>
  159. PrivateKey represents a ECDSA private key.
  160. </p>
  161. <h3 id="GenerateKey">func <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go?s=2606:2686#L89">GenerateKey</a></h3>
  162. <pre>func GenerateKey(c <a href="../elliptic/index.html">elliptic</a>.<a href="../elliptic/index.html#Curve">Curve</a>, rand <a href="../../io/index.html">io</a>.<a href="../../io/index.html#Reader">Reader</a>) (priv *<a href="index.html#PrivateKey">PrivateKey</a>, err <a href="../../builtin/index.html#error">error</a>)</pre>
  163. <p>
  164. GenerateKey generates a public and private key pair.
  165. </p>
  166. <h3 id="PrivateKey.Public">func (*PrivateKey) <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go?s=1532:1581#L52">Public</a></h3>
  167. <pre>func (priv *<a href="index.html#PrivateKey">PrivateKey</a>) Public() <a href="../index.html">crypto</a>.<a href="../index.html#PublicKey">PublicKey</a></pre>
  168. <p>
  169. Public returns the public key corresponding to priv.
  170. </p>
  171. <h3 id="PrivateKey.Sign">func (*PrivateKey) <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go?s=1853:1949#L60">Sign</a></h3>
  172. <pre>func (priv *<a href="index.html#PrivateKey">PrivateKey</a>) Sign(rand <a href="../../io/index.html">io</a>.<a href="../../io/index.html#Reader">Reader</a>, msg []<a href="../../builtin/index.html#byte">byte</a>, opts <a href="../index.html">crypto</a>.<a href="../index.html#SignerOpts">SignerOpts</a>) ([]<a href="../../builtin/index.html#byte">byte</a>, <a href="../../builtin/index.html#error">error</a>)</pre>
  173. <p>
  174. Sign signs msg with priv, reading randomness from rand. This method is
  175. intended to support keys where the private part is kept in, for example, a
  176. hardware module. Common uses should use the Sign function in this package
  177. directly.
  178. </p>
  179. <h2 id="PublicKey">type <a href="http://localhost:6060/src/crypto/ecdsa/ecdsa.go?s=1274:1330#L36">PublicKey</a></h2>
  180. <pre>type PublicKey struct {
  181. <a href="../elliptic/index.html">elliptic</a>.<a href="../elliptic/index.html#Curve">Curve</a>
  182. X, Y *<a href="../../math/big/index.html">big</a>.<a href="../../math/big/index.html#Int">Int</a>
  183. }</pre>
  184. <p>
  185. PublicKey represents an ECDSA public key.
  186. </p>
  187. <div id="footer">
  188. Build version go1.6.<br>
  189. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  190. the content of this page is licensed under the
  191. Creative Commons Attribution 3.0 License,
  192. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  193. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  194. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  195. </div>
  196. </div><!-- .container -->
  197. </div><!-- #page -->
  198. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  199. <script type="text/javascript" src="../../../lib/godoc/jquery.js"></script>
  200. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.js"></script>
  201. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.edit.js"></script>
  202. <script type="text/javascript" src="../../../lib/godoc/godocs.js"></script>
  203. </body>
  204. </html>