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.

545 lines
15 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>pkix - 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 pkix</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/x509/pkix"</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 pkix contains shared, low level structures used for ASN.1 parsing
  68. and serialization of X.509 certificates, CRL and OCSP.
  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#AlgorithmIdentifier">type AlgorithmIdentifier</a></dd>
  82. <dd><a href="index.html#AttributeTypeAndValue">type AttributeTypeAndValue</a></dd>
  83. <dd><a href="index.html#AttributeTypeAndValueSET">type AttributeTypeAndValueSET</a></dd>
  84. <dd><a href="index.html#CertificateList">type CertificateList</a></dd>
  85. <dd>&nbsp; &nbsp; <a href="index.html#CertificateList.HasExpired">func (certList *CertificateList) HasExpired(now time.Time) bool</a></dd>
  86. <dd><a href="index.html#Extension">type Extension</a></dd>
  87. <dd><a href="index.html#Name">type Name</a></dd>
  88. <dd>&nbsp; &nbsp; <a href="index.html#Name.FillFromRDNSequence">func (n *Name) FillFromRDNSequence(rdns *RDNSequence)</a></dd>
  89. <dd>&nbsp; &nbsp; <a href="index.html#Name.ToRDNSequence">func (n Name) ToRDNSequence() (ret RDNSequence)</a></dd>
  90. <dd><a href="index.html#RDNSequence">type RDNSequence</a></dd>
  91. <dd><a href="index.html#RelativeDistinguishedNameSET">type RelativeDistinguishedNameSET</a></dd>
  92. <dd><a href="index.html#RevokedCertificate">type RevokedCertificate</a></dd>
  93. <dd><a href="index.html#TBSCertificateList">type TBSCertificateList</a></dd>
  94. </dl>
  95. </div><!-- #manual-nav -->
  96. <h4>Package files</h4>
  97. <p>
  98. <span style="font-size:90%">
  99. <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go">pkix.go</a>
  100. </span>
  101. </p>
  102. </div><!-- .expanded -->
  103. </div><!-- #pkg-index -->
  104. <div id="pkg-callgraph" class="toggle" style="display: none">
  105. <div class="collapsed">
  106. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  107. </div> <!-- .expanded -->
  108. <div class="expanded">
  109. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  110. <p>
  111. In the call graph viewer below, each node
  112. is a function belonging to this package
  113. and its children are the functions it
  114. calls&mdash;perhaps dynamically.
  115. </p>
  116. <p>
  117. The root nodes are the entry points of the
  118. package: functions that may be called from
  119. outside the package.
  120. There may be non-exported or anonymous
  121. functions among them if they are called
  122. dynamically from another package.
  123. </p>
  124. <p>
  125. Click a node to visit that function's source code.
  126. From there you can visit its callers by
  127. clicking its declaring <code>func</code>
  128. token.
  129. </p>
  130. <p>
  131. Functions may be omitted if they were
  132. determined to be unreachable in the
  133. particular programs or tests that were
  134. analyzed.
  135. </p>
  136. <!-- Zero means show all package entry points. -->
  137. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  138. </div>
  139. </div> <!-- #pkg-callgraph -->
  140. <h2 id="AlgorithmIdentifier">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=464:577#L7">AlgorithmIdentifier</a></h2>
  141. <pre>type AlgorithmIdentifier struct {
  142. Algorithm <a href="../../../encoding/asn1/index.html">asn1</a>.<a href="../../../encoding/asn1/index.html#ObjectIdentifier">ObjectIdentifier</a>
  143. Parameters <a href="../../../encoding/asn1/index.html">asn1</a>.<a href="../../../encoding/asn1/index.html#RawValue">RawValue</a> `asn1:&#34;optional&#34;`
  144. }</pre>
  145. <p>
  146. AlgorithmIdentifier represents the ASN.1 structure of the same name. See RFC
  147. 5280, section 4.1.1.2.
  148. </p>
  149. <h2 id="AttributeTypeAndValue">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=814:899#L18">AttributeTypeAndValue</a></h2>
  150. <pre>type AttributeTypeAndValue struct {
  151. Type <a href="../../../encoding/asn1/index.html">asn1</a>.<a href="../../../encoding/asn1/index.html#ObjectIdentifier">ObjectIdentifier</a>
  152. Value interface{}
  153. }</pre>
  154. <p>
  155. AttributeTypeAndValue mirrors the ASN.1 structure of the same name in
  156. <a href="http://tools.ietf.org/html/rfc5280#section-4.1.2.4">http://tools.ietf.org/html/rfc5280#section-4.1.2.4</a>
  157. </p>
  158. <h2 id="AttributeTypeAndValueSET">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=1029:1144#L25">AttributeTypeAndValueSET</a></h2>
  159. <pre>type AttributeTypeAndValueSET struct {
  160. Type <a href="../../../encoding/asn1/index.html">asn1</a>.<a href="../../../encoding/asn1/index.html#ObjectIdentifier">ObjectIdentifier</a>
  161. Value [][]<a href="index.html#AttributeTypeAndValue">AttributeTypeAndValue</a> `asn1:&#34;set&#34;`
  162. }</pre>
  163. <p>
  164. AttributeTypeAndValueSET represents a set of ASN.1 sequences of
  165. AttributeTypeAndValue sequences from RFC 2986 (PKCS #10).
  166. </p>
  167. <h2 id="CertificateList">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=4967:5112#L155">CertificateList</a></h2>
  168. <pre>type CertificateList struct {
  169. TBSCertList <a href="index.html#TBSCertificateList">TBSCertificateList</a>
  170. SignatureAlgorithm <a href="index.html#AlgorithmIdentifier">AlgorithmIdentifier</a>
  171. SignatureValue <a href="../../../encoding/asn1/index.html">asn1</a>.<a href="../../../encoding/asn1/index.html#BitString">BitString</a>
  172. }</pre>
  173. <p>
  174. CertificateList represents the ASN.1 structure of the same name. See RFC
  175. 5280, section 5.1. Use Certificate.CheckCRLSignature to verify the
  176. signature.
  177. </p>
  178. <h3 id="CertificateList.HasExpired">func (*CertificateList) <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=5185:5248#L162">HasExpired</a></h3>
  179. <pre>func (certList *<a href="index.html#CertificateList">CertificateList</a>) HasExpired(now <a href="../../../time/index.html">time</a>.<a href="../../../time/index.html#Time">Time</a>) <a href="../../../builtin/index.html#bool">bool</a></pre>
  180. <p>
  181. HasExpired reports whether now is past the expiry time of certList.
  182. </p>
  183. <h2 id="Extension">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=1238:1345#L32">Extension</a></h2>
  184. <pre>type Extension struct {
  185. Id <a href="../../../encoding/asn1/index.html">asn1</a>.<a href="../../../encoding/asn1/index.html#ObjectIdentifier">ObjectIdentifier</a>
  186. Critical <a href="../../../builtin/index.html#bool">bool</a> `asn1:&#34;optional&#34;`
  187. Value []<a href="../../../builtin/index.html#byte">byte</a>
  188. }</pre>
  189. <p>
  190. Extension represents the ASN.1 structure of the same name. See RFC
  191. 5280, section 4.2.
  192. </p>
  193. <h2 id="Name">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=1652:1951#L42">Name</a></h2>
  194. <pre>type Name struct {
  195. Country, Organization, OrganizationalUnit []<a href="../../../builtin/index.html#string">string</a>
  196. Locality, Province []<a href="../../../builtin/index.html#string">string</a>
  197. StreetAddress, PostalCode []<a href="../../../builtin/index.html#string">string</a>
  198. SerialNumber, CommonName <a href="../../../builtin/index.html#string">string</a>
  199. Names []<a href="index.html#AttributeTypeAndValue">AttributeTypeAndValue</a>
  200. ExtraNames []<a href="index.html#AttributeTypeAndValue">AttributeTypeAndValue</a>
  201. }</pre>
  202. <p>
  203. Name represents an X.509 distinguished name. This only includes the common
  204. elements of a DN. When parsing, all elements are stored in Names and
  205. non-standard elements can be extracted from there. When marshaling, elements
  206. in ExtraNames are appended and override other values with the same OID.
  207. </p>
  208. <h3 id="Name.FillFromRDNSequence">func (*Name) <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=1953:2006#L52">FillFromRDNSequence</a></h3>
  209. <pre>func (n *<a href="index.html#Name">Name</a>) FillFromRDNSequence(rdns *<a href="index.html#RDNSequence">RDNSequence</a>)</pre>
  210. <h3 id="Name.ToRDNSequence">func (Name) <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=3790:3837#L120">ToRDNSequence</a></h3>
  211. <pre>func (n <a href="index.html#Name">Name</a>) ToRDNSequence() (ret <a href="index.html#RDNSequence">RDNSequence</a>)</pre>
  212. <h2 id="RDNSequence">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=579:626#L12">RDNSequence</a></h2>
  213. <pre>type RDNSequence []<a href="index.html#RelativeDistinguishedNameSET">RelativeDistinguishedNameSET</a></pre>
  214. <h2 id="RelativeDistinguishedNameSET">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=628:685#L14">RelativeDistinguishedNameSET</a></h2>
  215. <pre>type RelativeDistinguishedNameSET []<a href="index.html#AttributeTypeAndValue">AttributeTypeAndValue</a></pre>
  216. <h2 id="RevokedCertificate">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=5933:6064#L181">RevokedCertificate</a></h2>
  217. <pre>type RevokedCertificate struct {
  218. SerialNumber *<a href="../../../math/big/index.html">big</a>.<a href="../../../math/big/index.html#Int">Int</a>
  219. RevocationTime <a href="../../../time/index.html">time</a>.<a href="../../../time/index.html#Time">Time</a>
  220. Extensions []<a href="index.html#Extension">Extension</a> `asn1:&#34;optional&#34;`
  221. }</pre>
  222. <p>
  223. RevokedCertificate represents the ASN.1 structure of the same name. See RFC
  224. 5280, section 5.1.
  225. </p>
  226. <h2 id="TBSCertificateList">type <a href="http://localhost:6060/src/crypto/x509/pkix/pkix.go?s=5406:5830#L168">TBSCertificateList</a></h2>
  227. <pre>type TBSCertificateList struct {
  228. Raw <a href="../../../encoding/asn1/index.html">asn1</a>.<a href="../../../encoding/asn1/index.html#RawContent">RawContent</a>
  229. Version <a href="../../../builtin/index.html#int">int</a> `asn1:&#34;optional,default:1&#34;`
  230. Signature <a href="index.html#AlgorithmIdentifier">AlgorithmIdentifier</a>
  231. Issuer <a href="index.html#RDNSequence">RDNSequence</a>
  232. ThisUpdate <a href="../../../time/index.html">time</a>.<a href="../../../time/index.html#Time">Time</a>
  233. NextUpdate <a href="../../../time/index.html">time</a>.<a href="../../../time/index.html#Time">Time</a> `asn1:&#34;optional&#34;`
  234. RevokedCertificates []<a href="index.html#RevokedCertificate">RevokedCertificate</a> `asn1:&#34;optional&#34;`
  235. Extensions []<a href="index.html#Extension">Extension</a> `asn1:&#34;tag:0,optional,explicit&#34;`
  236. }</pre>
  237. <p>
  238. TBSCertificateList represents the ASN.1 structure of the same name. See RFC
  239. 5280, section 5.1.
  240. </p>
  241. <div id="footer">
  242. Build version go1.6.<br>
  243. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  244. the content of this page is licensed under the
  245. Creative Commons Attribution 3.0 License,
  246. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  247. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  248. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  249. </div>
  250. </div><!-- .container -->
  251. </div><!-- #page -->
  252. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  253. <script type="text/javascript" src="../../../../lib/godoc/jquery.js"></script>
  254. <script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.js"></script>
  255. <script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.edit.js"></script>
  256. <script type="text/javascript" src="../../../../lib/godoc/godocs.js"></script>
  257. </body>
  258. </html>