-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <title>Class: MCollective::SSL</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::SSL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/ssl_rb.html">
- lib/mcollective/ssl.rb
- </a>
- <br />
- </td>
- </tr>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <title>Class: MCollective::SSL</title>
- <div id="bodyContent">
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+ <script src="../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</head>
+<body class="class">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../lib/mcollective/ssl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ssl.rb">lib/mcollective/ssl.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+ <div id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link"><a href="../Object.html">Object</a></p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000220">::base64_decode</a></li>
+
+ <li><a href="#M000218">::base64_encode</a></li>
+
+ <li><a href="#M000222">::md5</a></li>
+
+ <li><a href="#M000202">::new</a></li>
+
+ <li><a href="#M000223">::uuid</a></li>
+
+ <li><a href="#M000214">#aes_decrypt</a></li>
+
+ <li><a href="#M000213">#aes_encrypt</a></li>
+
+ <li><a href="#M000219">#base64_decode</a></li>
+
+ <li><a href="#M000217">#base64_encode</a></li>
+
+ <li><a href="#M000207">#decrypt_with_private</a></li>
+
+ <li><a href="#M000208">#decrypt_with_public</a></li>
+
+ <li><a href="#M000206">#encrypt_with_private</a></li>
+
+ <li><a href="#M000205">#encrypt_with_public</a></li>
+
+ <li><a href="#M000221">#md5</a></li>
+
+ <li><a href="#M000224">#read_key</a></li>
+
+ <li><a href="#M000210">#rsa_decrypt_with_private</a></li>
+
+ <li><a href="#M000212">#rsa_decrypt_with_public</a></li>
+
+ <li><a href="#M000211">#rsa_encrypt_with_private</a></li>
+
+ <li><a href="#M000209">#rsa_encrypt_with_public</a></li>
+
+ <li><a href="#M000215">#sign</a></li>
+
+ <li><a href="#M000216">#verify_signature</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../COPYING.html">COPYING</a></li>
+
+ <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
+
+ <li class="file"><a href="../README.html">README</a></li>
+
+ <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
+
+ <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
+
+ <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
+
+ <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
+
+ <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
+
+ <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
+
+ <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
+
+ <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
+
+ <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
+
+ <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
+
+ <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
+
+ <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../MCollective.html">MCollective</a></li>
+
+ <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
+
+ <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
+
+ <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+
+ <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+
+ <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
+
+ <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
+
+ <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
+
+ <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
+
+ <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
+
+ <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
+
+ <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
+
+ <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+
+ <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
+
+ <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+
+ <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+
+ <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+
+ <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+
+ <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
+
+ <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+
+ <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+
+ <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
+
+ <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
+
+ <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+
+ <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
+
+ <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+
+ <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+
+ <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+
+ <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+
+ <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
+
+ <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
+
+ <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+
+ <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+
+ <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
+
+ <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+
+ <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
+
+ <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+
+ <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+
+ <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+
+ <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+
+ <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+
+ <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+
+ <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+
+ <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
+
+ <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+
+ <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+
+ <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+
+ <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+
+ <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+
+ <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+
+ <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+
+ <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+
+ <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+
+ <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+
+ <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
+
+ <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
+
+ <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+
+ <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
+
+ <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+
+ <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
+
+ <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
+
+ <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+
+ <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+
+ <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
+
+ <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
+
+ <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+
+ <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+
+ <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+
+ <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
+
+ <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
+
+ <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+
+ <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+
+ <li><a href="../Array.html">Array</a></li>
+
+ <li><a href="../Dir.html">Dir</a></li>
+
+ <li><a href="../Object.html">Object</a></li>
+
+ <li><a href="../String.html">String</a></li>
+
+ <li><a href="../Symbol.html">Symbol</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="class">MCollective::SSL</h1>
+
+ <div id="description">
+ <p>
A class that assists in encrypting and decrypting data using a combination
of RSA and AES
</p>
<p>
The key and data will all be base 64 encoded already by default you can
pass a 2nd parameter as false to <a
-href="SSL.html#M000378">encrypt_with_private</a> and counterparts that will
+href="SSL.html#M000206">encrypt_with_private</a> and counterparts that will
prevent the base 64 encoding
</p>
<p>
decrypted using a private key
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000386">aes_decrypt</a>
- <a href="#M000385">aes_encrypt</a>
- <a href="#M000392">base64_decode</a>
- <a href="#M000391">base64_decode</a>
- <a href="#M000390">base64_encode</a>
- <a href="#M000389">base64_encode</a>
- <a href="#M000379">decrypt_with_private</a>
- <a href="#M000380">decrypt_with_public</a>
- <a href="#M000378">encrypt_with_private</a>
- <a href="#M000377">encrypt_with_public</a>
- <a href="#M000394">md5</a>
- <a href="#M000393">md5</a>
- <a href="#M000376">new</a>
- <a href="#M000396">read_key</a>
- <a href="#M000382">rsa_decrypt_with_private</a>
- <a href="#M000384">rsa_decrypt_with_public</a>
- <a href="#M000383">rsa_encrypt_with_private</a>
- <a href="#M000381">rsa_encrypt_with_public</a>
- <a href="#M000387">sign</a>
- <a href="#M000395">uuid</a>
- <a href="#M000388">verify_signature</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">private_key_file</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">public_key_file</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ssl_cipher</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000392" class="method-detail">
- <a name="M000392"></a>
-
- <div class="method-heading">
- <a href="#M000392" class="method-signature">
- <span class="method-name">base64_decode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000392-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000392-source">
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="public-key-file-attribute-method" class="method-detail">
+ <a name="public_key_file"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">public_key_file</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="private-key-file-attribute-method" class="method-detail">
+ <a name="private_key_file"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">private_key_file</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ssl-cipher-attribute-method" class="method-detail">
+ <a name="ssl_cipher"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ssl_cipher</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="base-decode-method" class="method-detail ">
+ <a name="M000220"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_decode</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="base-decode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 195</span>
195: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">string</span>)
196: <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">string</span>)
-197: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000390" class="method-detail">
- <a name="M000390"></a>
-
- <div class="method-heading">
- <a href="#M000390" class="method-signature">
- <span class="method-name">base64_encode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000390-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000390-source">
+197: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-encode-method" class="method-detail ">
+ <a name="M000218"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_encode</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="base-encode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 186</span>
186: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">string</span>)
187: <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-identifier">string</span>)
-188: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000394" class="method-detail">
- <a name="M000394"></a>
-
- <div class="method-heading">
- <a href="#M000394" class="method-signature">
- <span class="method-name">md5</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000394-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000394-source">
+188: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="md--method" class="method-detail ">
+ <a name="M000222"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">md5</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="md--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 203</span>
203: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">md5</span>(<span class="ruby-identifier">string</span>)
204: <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">string</span>)
-205: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000376" class="method-detail">
- <a name="M000376"></a>
-
- <div class="method-heading">
- <a href="#M000376" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(pubkey=nil, privkey=nil, passphrase=nil, cipher=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000376-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000376-source">
+205: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000202"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(pubkey=nil, privkey=nil, passphrase=nil, cipher=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 37</span>
37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">pubkey</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">privkey</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">passphrase</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">cipher</span>=<span class="ruby-keyword kw">nil</span>)
46: <span class="ruby-ivar">@ssl_cipher</span> = <span class="ruby-identifier">cipher</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">cipher</span>
47:
48: <span class="ruby-identifier">raise</span> <span class="ruby-node">"The supplied cipher '#{@ssl_cipher}' is not supported"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">ciphers</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@ssl_cipher</span>)
-49: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000395" class="method-detail">
- <a name="M000395"></a>
-
- <div class="method-heading">
- <a href="#M000395" class="method-signature">
- <span class="method-name">uuid</span><span class="method-args">(string=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+49: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="uuid-method" class="method-detail ">
+ <a name="M000223"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">uuid</span><span
+ class="method-args">(string=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates a RFC 4122 version 5 UUID. If string is supplied it will produce
repeatable UUIDs for that string else a random 128bit string will be used
from OpenSSL::BN
<pre>
https://github.com/kwilczynski/puppet-functions/blob/master/lib/puppet/parser/functions/uuid.rb
</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000395-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000395-source">
+
+
+
+ <div class="method-source-code"
+ id="uuid-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 213</span>
213: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">uuid</span>(<span class="ruby-identifier">string</span>=<span class="ruby-keyword kw">nil</span>)
235: <span class="ruby-keyword kw">end</span>
236:
237: <span class="ruby-identifier">bytes</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">'-'</span>)
-238: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000386" class="method-detail">
- <a name="M000386"></a>
-
- <div class="method-heading">
- <a href="#M000386" class="method-signature">
- <span class="method-name">aes_decrypt</span><span class="method-args">(key, crypt_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+238: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="aes-decrypt-method" class="method-detail ">
+ <a name="M000214"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">aes_decrypt</span><span
+ class="method-args">(key, crypt_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
decrypts a string given key, iv and data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000386-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000386-source">
+
+
+
+ <div class="method-source-code"
+ id="aes-decrypt-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 158</span>
158: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aes_decrypt</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">crypt_string</span>)
162: <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>
163: <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">pkcs5_keyivgen</span>(<span class="ruby-identifier">key</span>)
164: <span class="ruby-identifier">decrypted_data</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">crypt_string</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">final</span>
-165: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000385" class="method-detail">
- <a name="M000385"></a>
-
- <div class="method-heading">
- <a href="#M000385" class="method-signature">
- <span class="method-name">aes_encrypt</span><span class="method-args">(plain_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+165: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="aes-encrypt-method" class="method-detail ">
+ <a name="M000213"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">aes_encrypt</span><span
+ class="method-args">(plain_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
encrypts a string, returns a hash of key, iv and data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000385-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000385-source">
+
+
+
+ <div class="method-source-code"
+ id="aes-encrypt-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 144</span>
144: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aes_encrypt</span>(<span class="ruby-identifier">plain_string</span>)
152: <span class="ruby-identifier">encrypted_data</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">plain_string</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">final</span>
153:
154: {<span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">encrypted_data</span>}
-155: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000391" class="method-detail">
- <a name="M000391"></a>
-
- <div class="method-heading">
- <a href="#M000391" class="method-signature">
- <span class="method-name">base64_decode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+155: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-decode-method" class="method-detail ">
+ <a name="M000219"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_decode</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
base 64 decode a string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000391-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000391-source">
+
+
+
+ <div class="method-source-code"
+ id="base-decode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 191</span>
191: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">string</span>)
192: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">string</span>)
-193: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000389" class="method-detail">
- <a name="M000389"></a>
-
- <div class="method-heading">
- <a href="#M000389" class="method-signature">
- <span class="method-name">base64_encode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+193: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-encode-method" class="method-detail ">
+ <a name="M000217"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_encode</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
base 64 encode a string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000389-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000389-source">
+
+
+
+ <div class="method-source-code"
+ id="base-encode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 182</span>
182: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">string</span>)
183: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">string</span>)
-184: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000379" class="method-detail">
- <a name="M000379"></a>
-
- <div class="method-heading">
- <a href="#M000379" class="method-signature">
- <span class="method-name">decrypt_with_private</span><span class="method-args">(crypted, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+184: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="decrypt-with-private-method" class="method-detail ">
+ <a name="M000207"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">decrypt_with_private</span><span
+ class="method-args">(crypted, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Decrypts data, expects a hash as create with crypt_with_public
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000379-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000379-source">
+
+
+
+ <div class="method-source-code"
+ id="decrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 88</span>
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decrypt_with_private</span>(<span class="ruby-identifier">crypted</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
96: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">rsa_decrypt_with_private</span>(<span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:key</span>])
97: <span class="ruby-identifier">aes_decrypt</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:data</span>])
98: <span class="ruby-keyword kw">end</span>
-99: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000380" class="method-detail">
- <a name="M000380"></a>
-
- <div class="method-heading">
- <a href="#M000380" class="method-signature">
- <span class="method-name">decrypt_with_public</span><span class="method-args">(crypted, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+99: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="decrypt-with-public-method" class="method-detail ">
+ <a name="M000208"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">decrypt_with_public</span><span
+ class="method-args">(crypted, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Decrypts data, expects a hash as create with crypt_with_private
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000380-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000380-source">
+
+
+
+ <div class="method-source-code"
+ id="decrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 102</span>
102: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decrypt_with_public</span>(<span class="ruby-identifier">crypted</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
110: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">rsa_decrypt_with_public</span>(<span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:key</span>])
111: <span class="ruby-identifier">aes_decrypt</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:data</span>])
112: <span class="ruby-keyword kw">end</span>
-113: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000378" class="method-detail">
- <a name="M000378"></a>
-
- <div class="method-heading">
- <a href="#M000378" class="method-signature">
- <span class="method-name">encrypt_with_private</span><span class="method-args">(plain_text, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+113: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="encrypt-with-private-method" class="method-detail ">
+ <a name="M000206"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">encrypt_with_private</span><span
+ class="method-args">(plain_text, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Encrypts supplied data using AES and then encrypts using RSA the key and IV
</p>
<p>
Return a hash with everything optionally base 64 encoded
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000378-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000378-source">
+
+
+
+ <div class="method-source-code"
+ id="encrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 73</span>
73: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encrypt_with_private</span>(<span class="ruby-identifier">plain_text</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
82: <span class="ruby-keyword kw">end</span>
83:
84: {<span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">data</span>}
-85: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000377" class="method-detail">
- <a name="M000377"></a>
-
- <div class="method-heading">
- <a href="#M000377" class="method-signature">
- <span class="method-name">encrypt_with_public</span><span class="method-args">(plain_text, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+85: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="encrypt-with-public-method" class="method-detail ">
+ <a name="M000205"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">encrypt_with_public</span><span
+ class="method-args">(plain_text, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Encrypts supplied data using AES and then encrypts using RSA the key and IV
</p>
<p>
Return a hash with everything optionally base 64 encoded
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000377-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000377-source">
+
+
+
+ <div class="method-source-code"
+ id="encrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 55</span>
55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encrypt_with_public</span>(<span class="ruby-identifier">plain_text</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
64: <span class="ruby-keyword kw">end</span>
65:
66: {<span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">data</span>}
-67: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000393" class="method-detail">
- <a name="M000393"></a>
-
- <div class="method-heading">
- <a href="#M000393" class="method-signature">
- <span class="method-name">md5</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000393-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000393-source">
+67: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="md--method" class="method-detail ">
+ <a name="M000221"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">md5</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="md--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 199</span>
199: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">md5</span>(<span class="ruby-identifier">string</span>)
200: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">md5</span>(<span class="ruby-identifier">string</span>)
-201: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000396" class="method-detail">
- <a name="M000396"></a>
-
- <div class="method-heading">
- <a href="#M000396" class="method-signature">
- <span class="method-name">read_key</span><span class="method-args">(type, key=nil, passphrase=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+201: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="read-key-method" class="method-detail ">
+ <a name="M000224"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">read_key</span><span
+ class="method-args">(type, key=nil, passphrase=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Reads either a :public or :private key from disk, uses an optional
passphrase to read the private key
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000396-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000396-source">
+
+
+
+ <div class="method-source-code"
+ id="read-key-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 242</span>
242: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_key</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">key</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">passphrase</span>=<span class="ruby-keyword kw">nil</span>)
274: <span class="ruby-keyword kw">else</span>
275: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only load :public or :private keys"</span>
276: <span class="ruby-keyword kw">end</span>
-277: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000382" class="method-detail">
- <a name="M000382"></a>
-
- <div class="method-heading">
- <a href="#M000382" class="method-signature">
- <span class="method-name">rsa_decrypt_with_private</span><span class="method-args">(crypt_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+277: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-decrypt-with-private-method" class="method-detail ">
+ <a name="M000210"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_decrypt_with_private</span><span
+ class="method-args">(crypt_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the private key to RSA decrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000382-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000382-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-decrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 123</span>
123: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_decrypt_with_private</span>(<span class="ruby-identifier">crypt_string</span>)
124: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No private key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@private_key</span>
125:
126: <span class="ruby-ivar">@private_key</span>.<span class="ruby-identifier">private_decrypt</span>(<span class="ruby-identifier">crypt_string</span>)
-127: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000384" class="method-detail">
- <a name="M000384"></a>
-
- <div class="method-heading">
- <a href="#M000384" class="method-signature">
- <span class="method-name">rsa_decrypt_with_public</span><span class="method-args">(crypt_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+127: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-decrypt-with-public-method" class="method-detail ">
+ <a name="M000212"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_decrypt_with_public</span><span
+ class="method-args">(crypt_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the public key to RSA decrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000384-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000384-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-decrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 137</span>
137: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_decrypt_with_public</span>(<span class="ruby-identifier">crypt_string</span>)
138: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No public key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@public_key</span>
139:
140: <span class="ruby-ivar">@public_key</span>.<span class="ruby-identifier">public_decrypt</span>(<span class="ruby-identifier">crypt_string</span>)
-141: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000383" class="method-detail">
- <a name="M000383"></a>
-
- <div class="method-heading">
- <a href="#M000383" class="method-signature">
- <span class="method-name">rsa_encrypt_with_private</span><span class="method-args">(plain_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+141: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-encrypt-with-private-method" class="method-detail ">
+ <a name="M000211"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_encrypt_with_private</span><span
+ class="method-args">(plain_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the private key to RSA encrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000383-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000383-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-encrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 130</span>
130: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_encrypt_with_private</span>(<span class="ruby-identifier">plain_string</span>)
131: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No private key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@private_key</span>
132:
133: <span class="ruby-ivar">@private_key</span>.<span class="ruby-identifier">private_encrypt</span>(<span class="ruby-identifier">plain_string</span>)
-134: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000381" class="method-detail">
- <a name="M000381"></a>
-
- <div class="method-heading">
- <a href="#M000381" class="method-signature">
- <span class="method-name">rsa_encrypt_with_public</span><span class="method-args">(plain_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+134: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-encrypt-with-public-method" class="method-detail ">
+ <a name="M000209"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_encrypt_with_public</span><span
+ class="method-args">(plain_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the public key to RSA encrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000381-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000381-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-encrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 116</span>
116: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_encrypt_with_public</span>(<span class="ruby-identifier">plain_string</span>)
117: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No public key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@public_key</span>
118:
119: <span class="ruby-ivar">@public_key</span>.<span class="ruby-identifier">public_encrypt</span>(<span class="ruby-identifier">plain_string</span>)
-120: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000387" class="method-detail">
- <a name="M000387"></a>
-
- <div class="method-heading">
- <a href="#M000387" class="method-signature">
- <span class="method-name">sign</span><span class="method-args">(string, base64=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+120: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="sign-method" class="method-detail ">
+ <a name="M000215"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">sign</span><span
+ class="method-args">(string, base64=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Signs a string using the private key
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000387-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000387-source">
+
+
+
+ <div class="method-source-code"
+ id="sign-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 168</span>
168: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sign</span>(<span class="ruby-identifier">string</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">false</span>)
169: <span class="ruby-identifier">sig</span> = <span class="ruby-ivar">@private_key</span>.<span class="ruby-identifier">sign</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">string</span>)
170:
171: <span class="ruby-identifier">base64</span> <span class="ruby-value">? </span><span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">sig</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">sig</span>
-172: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000388" class="method-detail">
- <a name="M000388"></a>
-
- <div class="method-heading">
- <a href="#M000388" class="method-signature">
- <span class="method-name">verify_signature</span><span class="method-args">(signature, string, base64=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+172: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="verify-signature-method" class="method-detail ">
+ <a name="M000216"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">verify_signature</span><span
+ class="method-args">(signature, string, base64=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Using the public key verifies that a string was signed using the private
key
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000388-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000388-source">
+
+
+
+ <div class="method-source-code"
+ id="verify-signature-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 175</span>
175: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">verify_signature</span>(<span class="ruby-identifier">signature</span>, <span class="ruby-identifier">string</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">false</span>)
176: <span class="ruby-identifier">signature</span> = <span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">signature</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">base64</span>
177:
178: <span class="ruby-ivar">@public_key</span>.<span class="ruby-identifier">verify</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">signature</span>, <span class="ruby-identifier">string</span>)
-179: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+179: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </div>
- </div>
+
+ </div>
+
+ </div>
- </div>
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
</body>
-</html>
\ No newline at end of file
+</html>
+
Code Review / packages / precise / mcollective.git / blobdiff