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.

329 lines
8.7 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>rc4 - 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 rc4</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/rc4"</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 rc4 implements RC4 encryption, as defined in Bruce Schneier&#39;s
  68. Applied Cryptography.
  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#Cipher">type Cipher</a></dd>
  82. <dd>&nbsp; &nbsp; <a href="index.html#NewCipher">func NewCipher(key []byte) (*Cipher, error)</a></dd>
  83. <dd>&nbsp; &nbsp; <a href="index.html#Cipher.Reset">func (c *Cipher) Reset()</a></dd>
  84. <dd>&nbsp; &nbsp; <a href="index.html#Cipher.XORKeyStream">func (c *Cipher) XORKeyStream(dst, src []byte)</a></dd>
  85. <dd><a href="index.html#KeySizeError">type KeySizeError</a></dd>
  86. <dd>&nbsp; &nbsp; <a href="index.html#KeySizeError.Error">func (k KeySizeError) Error() string</a></dd>
  87. <dd><a href="index.html#pkg-note-BUG">Bugs</a></dd>
  88. </dl>
  89. </div><!-- #manual-nav -->
  90. <h4>Package files</h4>
  91. <p>
  92. <span style="font-size:90%">
  93. <a href="http://localhost:6060/src/crypto/rc4/rc4.go">rc4.go</a>
  94. <a href="http://localhost:6060/src/crypto/rc4/rc4_asm.go">rc4_asm.go</a>
  95. </span>
  96. </p>
  97. </div><!-- .expanded -->
  98. </div><!-- #pkg-index -->
  99. <div id="pkg-callgraph" class="toggle" style="display: none">
  100. <div class="collapsed">
  101. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  102. </div> <!-- .expanded -->
  103. <div class="expanded">
  104. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  105. <p>
  106. In the call graph viewer below, each node
  107. is a function belonging to this package
  108. and its children are the functions it
  109. calls&mdash;perhaps dynamically.
  110. </p>
  111. <p>
  112. The root nodes are the entry points of the
  113. package: functions that may be called from
  114. outside the package.
  115. There may be non-exported or anonymous
  116. functions among them if they are called
  117. dynamically from another package.
  118. </p>
  119. <p>
  120. Click a node to visit that function's source code.
  121. From there you can visit its callers by
  122. clicking its declaring <code>func</code>
  123. token.
  124. </p>
  125. <p>
  126. Functions may be omitted if they were
  127. determined to be unreachable in the
  128. particular programs or tests that were
  129. analyzed.
  130. </p>
  131. <!-- Zero means show all package entry points. -->
  132. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  133. </div>
  134. </div> <!-- #pkg-callgraph -->
  135. <h2 id="Cipher">type <a href="http://localhost:6060/src/crypto/rc4/rc4.go?s=457:509#L5">Cipher</a></h2>
  136. <pre>type Cipher struct {
  137. <span class="comment">// contains filtered or unexported fields</span>
  138. }</pre>
  139. <p>
  140. A Cipher is an instance of RC4 using a particular key.
  141. </p>
  142. <h3 id="NewCipher">func <a href="http://localhost:6060/src/crypto/rc4/rc4.go?s=769:812#L18">NewCipher</a></h3>
  143. <pre>func NewCipher(key []<a href="../../builtin/index.html#byte">byte</a>) (*<a href="index.html#Cipher">Cipher</a>, <a href="../../builtin/index.html#error">error</a>)</pre>
  144. <p>
  145. NewCipher creates and returns a new Cipher. The key argument should be the
  146. RC4 key, at least 1 byte and at most 256 bytes.
  147. </p>
  148. <h3 id="Cipher.Reset">func (*Cipher) <a href="http://localhost:6060/src/crypto/rc4/rc4.go?s=1174:1198#L37">Reset</a></h3>
  149. <pre>func (c *<a href="index.html#Cipher">Cipher</a>) Reset()</pre>
  150. <p>
  151. Reset zeros the key data so that it will no longer appear in the
  152. process&#39;s memory.
  153. </p>
  154. <h3 id="Cipher.XORKeyStream">func (*Cipher) <a href="http://localhost:6060/src/crypto/rc4/rc4_asm.go?s=433:479#L3">XORKeyStream</a></h3>
  155. <pre>func (c *<a href="index.html#Cipher">Cipher</a>) XORKeyStream(dst, src []<a href="../../builtin/index.html#byte">byte</a>)</pre>
  156. <p>
  157. XORKeyStream sets dst to the result of XORing src with the key stream.
  158. Dst and src may be the same slice but otherwise should not overlap.
  159. </p>
  160. <h2 id="KeySizeError">type <a href="http://localhost:6060/src/crypto/rc4/rc4.go?s=511:532#L10">KeySizeError</a></h2>
  161. <pre>type KeySizeError <a href="../../builtin/index.html#int">int</a></pre>
  162. <h3 id="KeySizeError.Error">func (KeySizeError) <a href="http://localhost:6060/src/crypto/rc4/rc4.go?s=534:570#L12">Error</a></h3>
  163. <pre>func (k <a href="index.html#KeySizeError">KeySizeError</a>) Error() <a href="../../builtin/index.html#string">string</a></pre>
  164. <h2 id="pkg-note-BUG">Bugs</h2>
  165. <ul style="list-style: none; padding: 0;">
  166. <li><a href="http://localhost:6060/src/crypto/rc4/rc4.go?s=271:379#L1">&#x261e;</a> RC4 is in common use but has design weaknesses that make
  167. it a poor choice for new protocols.
  168. </li>
  169. </ul>
  170. <div id="footer">
  171. Build version go1.6.<br>
  172. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  173. the content of this page is licensed under the
  174. Creative Commons Attribution 3.0 License,
  175. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  176. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  177. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  178. </div>
  179. </div><!-- .container -->
  180. </div><!-- #page -->
  181. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  182. <script type="text/javascript" src="../../../lib/godoc/jquery.js"></script>
  183. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.js"></script>
  184. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.edit.js"></script>
  185. <script type="text/javascript" src="../../../lib/godoc/godocs.js"></script>
  186. </body>
  187. </html>