PageRenderTime 29ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 0ms

/source/puppet/4.5/reference/yard/Puppet/Util/Windows/RootCerts.html

https://github.com/ahpook/puppet-docs
HTML | 387 lines | 229 code | 158 blank | 0 comment | 0 complexity | de8a95d9a7870bc47ee2ab17ffd378a1 MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3.   <head>
    4. 

  4.     <meta charset="utf-8">
    5. 

  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    6. 

  6. <title>
    7. 

  7.   Class: Puppet::Util::Windows::RootCerts
    8. 

  8.   
    9. 

  9.     &mdash; Documentation by YARD 0.9.0
    10. 

  10.   
    11. 

  11. </title>
    12. 

  12. 

  13.   <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
    14. 

  14. 

  15.   <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
    16. 

  16. 

  17. <script type="text/javascript" charset="utf-8">
    18. 

  18.   pathId = "Puppet::Util::Windows::RootCerts";
    19. 

  19.   relpath = '../../../';
    20. 

  20. </script>
    21. 

  21. 

  22. 

  23.   <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
    24. 

  24. 

  25.   <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
    26. 

  26. 

  27. 

  28.   </head>
    29. 

  29.   <body>
    30. 

  30.     <div class="nav_wrap">
    31. 

  31.       <iframe id="nav" src="../../../class_list.html"></iframe>
    32. 

  32.       <div id="resizer"></div>
    33. 

  33.     </div>
    34. 

  34. 

  35.     <div id="main" tabindex="-1">
    36. 

  36.       <div id="header">
    37. 

  37.         <div id="menu">
    38. 

  38.   
    39. 

  39.     <a href="../../../_index.html">Index (R)</a> &raquo;
    40. 

  40.     <span class='title'><span class='object_link'><a href="../../../Puppet.html" title="Puppet (module)">Puppet</a></span></span> &raquo; <span class='title'><span class='object_link'>Util</span></span> &raquo; <span class='title'><span class='object_link'>Windows</span></span>
    41. 

  41.      &raquo; 
    42. 

  42.     <span class="title">RootCerts</span>
    43. 

  43.   
    44. 

  44. </div>
    45. 

  45. 

  46.         <div id="search">
    47. 

  47.   
    48. 

  48.     <a class="full_list_link" id="class_list_link"
    49. 

  49.         href="../../../class_list.html">
    50. 

  50. 

  51.         <svg width="24" height="24">
    52. 

  52.           <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
    53. 

  53.           <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
    54. 

  54.           <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
    55. 

  55.         </svg>
    56. 

  56.     </a>
    57. 

  57.   
    58. 

  58. </div>
    59. 

  59.         <div class="clear"></div>
    60. 

  60.       </div>
    61. 

  61. 

  62.       <iframe id="search_frame" src="../../../class_list.html"></iframe>
    63. 

  63. 

  64.       <div id="content"><h1>Class: Puppet::Util::Windows::RootCerts
    65. 

  65.   
    66. 

  66.   
    67. 

  67.   
    68. 

  68. </h1>
    69. 

  69. <div class="box_info">
    70. 

  70.   
    71. 

  71.   <dl>
    72. 

  72.     <dt>Inherits:</dt>
    73. 

  73.     <dd>
    74. 

  74.       <span class="inheritName"><span class='object_link'>Object</span></span>
    75. 

  75.       
    76. 

  76.         <ul class="fullTree">
    77. 

  77.           <li><span class='object_link'>Object</span></li>
    78. 

  78.           
    79. 

  79.             <li class="next">Puppet::Util::Windows::RootCerts</li>
    80. 

  80.           
    81. 

  81.         </ul>
    82. 

  82.         <a href="#" class="inheritanceTree">show all</a>
    83. 

  83.       
    84. 

  84.     </dd>
    85. 

  85.   </dl>
    86. 

  86.   
    87. 

  87. 

  88.   
    89. 

  89.   
    90. 

  90.   
    91. 

  91.   
    92. 

  92.   <dl>
    93. 

  93.       <dt>Includes:</dt>
    94. 

  94.       <dd>Enumerable</dd>
    95. 

  95.   </dl>
    96. 

  96.   
    97. 

  97.   
    98. 

  98. 

  99.   
    100. 

  100. 

  101.   
    102. 

  102.   <dl>
    103. 

  103.     <dt>Defined in:</dt>
    104. 

  104.     <dd>lib/puppet/util/windows/root_certs.rb</dd>
    105. 

  105.   </dl>
    106. 

  106.   
    107. 

  107. </div>
    108. 

  108. 

  109. <h2>Overview</h2><div class="docstring">
    110. 

  110.   <div class="discussion">
    111. 

  111.     <p>Represents a collection of trusted root certificates.</p>
    112. 

  112. 

  113. 

  114.   </div>
    115. 

  115. </div>
    116. 

  116. <div class="tags">
    117. 

  117.   
    118. 

  118. 

  119. </div>
    120. 

  120. 

  121. 

  122. 

  123. 

  124. 

  125. 

  126.   
    127. 

  127.     <h2>
    128. 

  128.       Class Method Summary
    129. 

  129.       <small><a href="#" class="summary_toggle">collapse</a></small>
    130. 

  130.     </h2>
    131. 

  131. 

  132.     <ul class="summary">
    133. 

  133.       
    134. 

  134.         
    135. 

  135. <li class="public ">
    136. 

  136.   <span class="summary_signature">
    137. 

  137.     
    138. 

  138.       <a href="#load_certs-class_method" title="load_certs (class method)">.<strong>load_certs</strong>  &#x21d2; Array&lt;[OpenSSL::X509::Certificate]&gt; </a>
    139. 

  139.     
    140. 

  140. 

  141.     
    142. 

  142.   </span>
    143. 

  143.   
    144. 

  144.   
    145. 

  145.   
    146. 

  146.   
    147. 

  147.   
    148. 

  148.   
    149. 

  149.   
    150. 

  150.   <span class="private note title">private</span>
    151. 

  151. 

  152.   
    153. 

  153.     <span class="summary_desc"><div class='inline'><p>Returns an array of root certificates.</p>
    154. 

  154. </div></span>
    155. 

  155.   
    156. 

  156. </li>
    157. 

  157. 

  158.       
    159. 

  159.     </ul>
    160. 

  160.   
    161. 

  161.     <h2>
    162. 

  162.       Instance Method Summary
    163. 

  163.       <small><a href="#" class="summary_toggle">collapse</a></small>
    164. 

  164.     </h2>
    165. 

  165. 

  166.     <ul class="summary">
    167. 

  167.       
    168. 

  168.         
    169. 

  169. <li class="public ">
    170. 

  170.   <span class="summary_signature">
    171. 

  171.     
    172. 

  172.       <a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong> {|cert| ... } &#x21d2; Object </a>
    173. 

  173.     
    174. 

  174. 

  175.     
    176. 

  176.   </span>
    177. 

  177.   
    178. 

  178.   
    179. 

  179.   
    180. 

  180.   
    181. 

  181.   
    182. 

  182.   
    183. 

  183.   
    184. 

  184.   
    185. 

  185. 

  186.   
    187. 

  187.     <span class="summary_desc"><div class='inline'><p>Enumerates each root certificate.</p>
    188. 

  188. </div></span>
    189. 

  189.   
    190. 

  190. </li>
    191. 

  191. 

  192.       
    193. 

  193.     </ul>
    194. 

  194.   
    195. 

  195. 

  196. 

  197.   
    198. 

  198.   
    199. 

  199.   
    200. 

  200.   
    201. 

  201.   
    202. 

  202.   
    203. 

  203.   
    204. 

  204. 

  205.   <div id="class_method_details" class="method_details_list">
    206. 

  206.     <h2>Class Method Details</h2>
    207. 

  207. 

  208.     
    209. 

  209.       <div class="method_details first">
    210. 

  210.   <h3 class="signature first" id="load_certs-class_method">
    211. 

  211.   
    212. 

  212.     .<strong>load_certs</strong>  &#x21d2; <tt><span class='object_link'>Array</span>&lt;[OpenSSL::X509::Certificate]&gt;</tt> &nbsp;<span class="private note title">private</span>
    213. 

  213.   
    214. 

  214. 

  215.   
    216. 

  216. 

  217.   
    218. 

  218. </h3><div class="docstring">
    219. 

  219.   <div class="discussion">
    220. 

  220.     <p class="note private">
    221. 

  221.   <strong>This method is part of a private API.</strong>
    222. 

  222.   You should avoid using this method if possible, as it may be removed or be changed in the future.
    223. 

  223. </p>
    224. 

  224. <p>Returns an array of root certificates.</p>
    225. 

  225. 

  226. 

  227.   </div>
    228. 

  228. </div>
    229. 

  229. <div class="tags">
    230. 

  230.   
    231. 

  231. <p class="tag_title">Returns:</p>
    232. 

  232. <ul class="return">
    233. 

  233.   
    234. 

  234.     <li>
    235. 

  235.       
    236. 

  236.       
    237. 

  237.         <span class='type'>(<tt><span class='object_link'>Array</span>&lt;[OpenSSL::X509::Certificate]&gt;</tt>)</span>
    238. 

  238.       
    239. 

  239.       
    240. 

  240.       
    241. 

  241.         &mdash;
    242. 

  242.         <div class='inline'><p>an array of root certificates</p>
    243. 

  243. </div>
    244. 

  244.       
    245. 

  245.     </li>
    246. 

  246.   
    247. 

  247. </ul>
    248. 

  248. 

  249. </div><table class="source_code">
    250. 

  250.   <tr>
    251. 

  251.     <td>
    252. 

  252.       <pre class="lines">
    253. 

  253. 

  254. 

  255. 33
    256. 

  256. 34
    257. 

  257. 35
    258. 

  258. 36
    259. 

  259. 37
    260. 

  260. 38
    261. 

  261. 39
    262. 

  262. 40
    263. 

  263. 41
    264. 

  264. 42
    265. 

  265. 43
    266. 

  266. 44
    267. 

  267. 45
    268. 

  268. 46
    269. 

  269. 47
    270. 

  270. 48
    271. 

  271. 49
    272. 

  272. 50
    273. 

  273. 51
    274. 

  274. 52
    275. 

  275. 53
    276. 

  276. 54
    277. 

  277. 55</pre>
    278. 

  278.     </td>
    279. 

  279.     <td>
    280. 

  280.       <pre class="code"><span class="info file"># File 'lib/puppet/util/windows/root_certs.rb', line 33</span>
    281. 

  281. 

  282. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_certs'>load_certs</span>
    283. 

  283.   <span class='id identifier rubyid_certs'>certs</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
    284. 

  284. 

  285.   <span class='comment'># This is based on a patch submitted to openssl:
    286. 

  286. </span>  <span class='comment'># https://www.mail-archive.com/openssl-dev@openssl.org/msg26958.html
    287. 

  287. </span>  <span class='id identifier rubyid_ptr'>ptr</span> <span class='op'>=</span> <span class='const'>FFI</span><span class='op'>::</span><span class='const'>Pointer</span><span class='op'>::</span><span class='const'>NULL</span>
    288. 

  288.   <span class='id identifier rubyid_store'>store</span> <span class='op'>=</span> <span class='const'>CertOpenSystemStoreA</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ROOT</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
    289. 

  289.   <span class='kw'>begin</span>
    290. 

  290.     <span class='kw'>while</span> <span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span> <span class='op'>=</span> <span class='const'>CertEnumCertificatesInStore</span><span class='lparen'>(</span><span class='id identifier rubyid_store'>store</span><span class='comma'>,</span> <span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_ptr'>ptr</span><span class='period'>.</span><span class='id identifier rubyid_null?'>null?</span>
    291. 

  291.       <span class='id identifier rubyid_context'>context</span> <span class='op'>=</span> <span class='const'>CERT_CONTEXT</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span>
    292. 

  292.       <span class='id identifier rubyid_cert_buf'>cert_buf</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span><span class='lbracket'>[</span><span class='symbol'>:pbCertEncoded</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_read_bytes'>read_bytes</span><span class='lparen'>(</span><span class='id identifier rubyid_context'>context</span><span class='lbracket'>[</span><span class='symbol'>:cbCertEncoded</span><span class='rbracket'>]</span><span class='rparen'>)</span>
    293. 

  293.       <span class='kw'>begin</span>
    294. 

  294.         <span class='id identifier rubyid_certs'>certs</span> <span class='op'>&lt;&lt;</span> <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>X509</span><span class='op'>::</span><span class='const'>Certificate</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_cert_buf'>cert_buf</span><span class='rparen'>)</span>
    295. 

  295.       <span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_detail'>detail</span>
    296. 

  296.         <span class='const'>Puppet</span><span class='period'>.</span><span class='id identifier rubyid_warning'>warning</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Failed to import root certificate: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_detail'>detail</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
    297. 

  297.       <span class='kw'>end</span>
    298. 

  298.     <span class='kw'>end</span>
    299. 

  299.   <span class='kw'>ensure</span>
    300. 

  300.     <span class='const'>CertCloseStore</span><span class='lparen'>(</span><span class='id identifier rubyid_store'>store</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span>
    301. 

  301.   <span class='kw'>end</span>
    302. 

  302. 

  303.   <span class='id identifier rubyid_certs'>certs</span>
    304. 

  304. <span class='kw'>end</span></pre>
    305. 

  305.     </td>
    306. 

  306.   </tr>
    307. 

  307. </table>
    308. 

  308. </div>
    309. 

  309.     
    310. 

  310.   </div>
    311. 

  311. 

  312.   <div id="instance_method_details" class="method_details_list">
    313. 

  313.     <h2>Instance Method Details</h2>
    314. 

  314. 

  315.     
    316. 

  316.       <div class="method_details first">
    317. 

  317.   <h3 class="signature first" id="each-instance_method">
    318. 

  318.   
    319. 

  319.     #<strong>each</strong> {|cert| ... } &#x21d2; <tt><span class='object_link'>Object</span></tt> 
    320. 

  320.   
    321. 

  321. 

  322.   
    323. 

  323. 

  324.   
    325. 

  325. </h3><div class="docstring">
    326. 

  326.   <div class="discussion">
    327. 

  327.     <p>Enumerates each root certificate.</p>
    328. 

  328. 

  329. 

  330.   </div>
    331. 

  331. </div>
    332. 

  332. <div class="tags">
    333. 

  333.   
    334. 

  334. <p class="tag_title">Yield Parameters:</p>
    335. 

  335. <ul class="yieldparam">
    336. 

  336.   
    337. 

  337.     <li>
    338. 

  338.       
    339. 

  339.         <span class='name'>cert</span>
    340. 

  340.       
    341. 

  341.       
    342. 

  342.         <span class='type'>(<tt>OpenSSL::X509::Certificate</tt>)</span>
    343. 

  343.       
    344. 

  344.       
    345. 

  345.       
    346. 

  346.         &mdash;
    347. 

  347.         <div class='inline'><p>each root certificate</p>
    348. 

  348. </div>
    349. 

  349.       
    350. 

  350.     </li>
    351. 

  351.   
    352. 

  352. </ul>
    353. 

  353. 

  354. </div><table class="source_code">
    355. 

  355.   <tr>
    356. 

  356.     <td>
    357. 

  357.       <pre class="lines">
    358. 

  358. 

  359. 

  360. 19
    361. 

  361. 20
    362. 

  362. 21</pre>
    363. 

  363.     </td>
    364. 

  364.     <td>
    365. 

  365.       <pre class="code"><span class="info file"># File 'lib/puppet/util/windows/root_certs.rb', line 19</span>
    366. 

  366. 

  367. <span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span>
    368. 

  368.   <span class='ivar'>@roots</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_cert'>cert</span><span class='op'>|</span> <span class='kw'>yield</span> <span class='id identifier rubyid_cert'>cert</span><span class='rbrace'>}</span>
    369. 

  369. <span class='kw'>end</span></pre>
    370. 

  370.     </td>
    371. 

  371.   </tr>
    372. 

  372. </table>
    373. 

  373. </div>
    374. 

  374.     
    375. 

  375.   </div>
    376. 

  376. 

  377. </div>
    378. 

  378. 

  379.       <div id="footer">
    380. 

  380.   Generated on Thu Jul  7 12:40:40 2016 by
    381. 

  381.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
    382. 

  382.   0.9.0 (ruby-2.0.0).
    383. 

  383. </div>
    384. 

  384. 

  385.     </div>
    386. 

  386.   </body>
    387. 

  387. </html>
    388.