-
-
-
-
-
-
-
-
- + +
+ +
+
+
+
+
+
+
+
+
+
+ In Files
+
+
+ -
+
+
- lib/mcollective/ssl.rb + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parent
+ + + +
+
+
+
+
+
+ Methods
+-
+
+
- ::base64_decode + +
- ::base64_encode + +
- ::md5 + +
- ::new + +
- ::uuid + +
- #aes_decrypt + +
- #aes_encrypt + +
- #base64_decode + +
- #base64_encode + +
- #decrypt_with_private + +
- #decrypt_with_public + +
- #encrypt_with_private + +
- #encrypt_with_public + +
- #md5 + +
- #read_key + +
- #rsa_decrypt_with_private + +
- #rsa_decrypt_with_public + +
- #rsa_encrypt_with_private + +
- #rsa_encrypt_with_public + +
- #sign + +
- #verify_signature + +
+
+
+
+
+
+
+
+ Files
+-
+
+
- COPYING + +
- Gemfile + +
- README + +
- Rakefile + +
- client.cfg.dist + +
- data-help.erb + +
- discovery-help.erb + +
- facts.yaml.dist + +
- metadata-help.erb + +
- msg-help.erb + +
- rpc-help.erb + +
- server.cfg.dist + +
- PLACEHOLDER + +
- PLACEHOLDER + +
- action_snippet.erb + +
- data_input_snippet.erb + +
- ddl.erb + +
- plugin.erb + +
- en.yml + +
- mcollective.init + +
+ Class Index
+
+
+
+
+
+
+ Class Index
+ ![[+]](../images/find.png "show/hide quicksearch")
+
+
+ -
+
+
- MCollective + +
- MCollective::Agent + +
- MCollective::Agents + +
- MCollective::Aggregate + +
- MCollective::Aggregate::Base + +
- MCollective::Aggregate::Result + +
- MCollective::Aggregate::Result::Base + +
- MCollective::Aggregate::Result::CollectionResult + +
- MCollective::Aggregate::Result::NumericResult + +
- MCollective::Application + +
- MCollective::Applications + +
- MCollective::Cache + +
- MCollective::Client + +
- MCollective::CodedError + +
- MCollective::Config + +
- MCollective::Connector + +
- MCollective::Connector::Base + +
- MCollective::DDL + +
- MCollective::DDL::AgentDDL + +
- MCollective::DDL::Base + +
- MCollective::DDL::DataDDL + +
- MCollective::DDL::DiscoveryDDL + +
- MCollective::DDL::ValidatorDDL + +
- MCollective::DDLValidationError + +
- MCollective::Data + +
- MCollective::Data::Base + +
- MCollective::Data::Result + +
- MCollective::Discovery + +
- MCollective::Facts + +
- MCollective::Facts::Base + +
- MCollective::Generators + +
- MCollective::Generators::AgentGenerator + +
- MCollective::Generators::Base + +
- MCollective::Generators::DataGenerator + +
- MCollective::InvalidRPCData + +
- MCollective::Log + +
- MCollective::Logger + +
- MCollective::Logger::Base + +
- MCollective::Logger::Console_logger + +
- MCollective::Logger::File_logger + +
- MCollective::Logger::Syslog_logger + +
- MCollective::Matcher + +
- MCollective::Matcher::Parser + +
- MCollective::Matcher::Scanner + +
- MCollective::Message + +
- MCollective::MissingRPCData + +
- MCollective::MsgDoesNotMatchRequestID + +
- MCollective::MsgTTLExpired + +
- MCollective::NotTargettedAtUs + +
- MCollective::Optionparser + +
- MCollective::PluginManager + +
- MCollective::PluginPackager + +
- MCollective::PluginPackager::AgentDefinition + +
- MCollective::PluginPackager::StandardDefinition + +
- MCollective::RPC + +
- MCollective::RPC::ActionRunner + +
- MCollective::RPC::Agent + +
- MCollective::RPC::Audit + +
- MCollective::RPC::Client + +
- MCollective::RPC::Helpers + +
- MCollective::RPC::Progress + +
- MCollective::RPC::Reply + +
- MCollective::RPC::Request + +
- MCollective::RPC::Result + +
- MCollective::RPC::Stats + +
- MCollective::RPCAborted + +
- MCollective::RPCError + +
- MCollective::Registration + +
- MCollective::Registration::Base + +
- MCollective::Runner + +
- MCollective::RunnerStats + +
- MCollective::SSL + +
- MCollective::Security + +
- MCollective::Security::Base + +
- MCollective::SecurityValidationFailed + +
- MCollective::Shell + +
- MCollective::Translatable + +
- MCollective::UnixDaemon + +
- MCollective::UnknownRPCAction + +
- MCollective::UnknownRPCError + +
- MCollective::Util + +
- MCollective::Validator + +
- MCollective::ValidatorError + +
- MCollective::WindowsDaemon + +
- Array + +
- Dir + +
- Object + +
- String + +
- Symbol + +
+
-
- MCollective::SSL
+ +
+
-
-
- A class that assists in encrypting and decrypting data using a combination of RSA and AES
@@ -106,7 +392,7 @@ This will result in a hash of data like:The key and data will all be base 64 encoded already by default you can pass a 2nd parameter as false to encrypt_with_private and counterparts that will +href="SSL.html#M000206">encrypt_with_private and counterparts that will prevent the base 64 encoding
@@ -118,162 +404,186 @@ There are matching methods for using a public key to encrypt data to be decrypted using a private key
-
-
-
- Methods
- -
- aes_decrypt
- aes_encrypt
- base64_decode
- base64_decode
- base64_encode
- base64_encode
- decrypt_with_private
- decrypt_with_public
- encrypt_with_private
- encrypt_with_public
- md5
- md5
- new
- read_key
- rsa_decrypt_with_private
- rsa_decrypt_with_public
- rsa_encrypt_with_private
- rsa_encrypt_with_public
- sign
- uuid
- verify_signature
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
- Attributes
- -
-
-
-
- | private_key_file | -[R] | -- |
| public_key_file | -[R] | -- |
| ssl_cipher | -[R] | -- |
-
+
+ Public Class methods
- -
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Attributes
+ + + + + + + + +
+
+
+
+ Public Class Methods
+ + +
+
+
+
-
-
+
+
+
+
+ base64_decode(string)
+ click to toggle source
+
+
+
+
+
+
-
- (Not documented)
+ + + +
# File lib/mcollective/ssl.rb, line 195
195: def self.base64_decode(string)
196: Base64.decode64(string)
-197: end
-
-
+
+
+
-
-
+
+
+
+
+ base64_encode(string)
+ click to toggle source
+
+
+
+
+
+
-
- (Not documented)
+ + + +
# File lib/mcollective/ssl.rb, line 186
186: def self.base64_encode(string)
187: Base64.encode64(string)
-188: end
-
-
+
+
+
-
-
+
+
+
+
+ md5(string)
+ click to toggle source
+
+
+
+
+
+
-
- (Not documented)
+ + + +
# File lib/mcollective/ssl.rb, line 203
203: def self.md5(string)
204: Digest::MD5.hexdigest(string)
-205: end
-
-
+
+
+
-
-
+
+
+
+
+ new(pubkey=nil, privkey=nil, passphrase=nil, cipher=nil)
+ click to toggle source
+
+
+
+
+
+
-
- (Not documented)
+ + + +
# File lib/mcollective/ssl.rb, line 37
37: def initialize(pubkey=nil, privkey=nil, passphrase=nil, cipher=nil)
@@ -288,23 +598,29 @@ decrypted using a private key
46: @ssl_cipher = cipher if cipher
47:
48: raise "The supplied cipher '#{@ssl_cipher}' is not supported" unless OpenSSL::Cipher.ciphers.include?(@ssl_cipher)
-49: end
-
-
+
+
+
+
+
+
+
+ uuid(string=nil)
+ click to toggle source
+
+
+
+
+
+
-
- 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 @@ -315,9 +631,11 @@ Code used with permission from:
https://github.com/kwilczynski/puppet-functions/blob/master/lib/puppet/parser/functions/uuid.rb
-
-
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 213
213: def self.uuid(string=nil)
@@ -345,30 +663,42 @@ Code used with permission from:
235: end
236:
237: bytes.join('-')
-238: end
-
- Public Instance methods
- - + + +
+
+
+ Public Instance Methods
+ + +
+
+
+
+
+
+
+
+ aes_decrypt(key, crypt_string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ decrypts a string given key, iv and data
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 158
158: def aes_decrypt(key, crypt_string)
@@ -378,28 +708,36 @@ decrypts a string given key, iv and data
162: cipher.key = key
163: cipher.pkcs5_keyivgen(key)
164: decrypted_data = cipher.update(crypt_string) + cipher.final
-165: end
-
-
+
+
+
+
+
+
+
+ aes_encrypt(plain_string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ encrypts a string, returns a hash of key, iv and data
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 144
144: def aes_encrypt(plain_string)
@@ -413,80 +751,104 @@ encrypts a string, returns a hash of key, iv and data
152: encrypted_data = cipher.update(plain_string) + cipher.final
153:
154: {:key => key, :data => encrypted_data}
-155: end
-
-
+
+
+
+
+
+
+
+ base64_decode(string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ base 64 decode a string
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 191
191: def base64_decode(string)
192: SSL.base64_decode(string)
-193: end
-
-
+
+
+
+
+
+
+
+ base64_encode(string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ base 64 encode a string
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 182
182: def base64_encode(string)
183: SSL.base64_encode(string)
-184: end
-
-
+
+
+
+
+
+
+
+ decrypt_with_private(crypted, base64=true)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Decrypts data, expects a hash as create with crypt_with_public
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 88
88: def decrypt_with_private(crypted, base64=true)
@@ -500,28 +862,36 @@ Decrypts data, expects a hash as create with crypt_with_public
96: key = rsa_decrypt_with_private(crypted[:key])
97: aes_decrypt(key, crypted[:data])
98: end
-99: end
-
-
+
+
+
+
+
+
+
+ decrypt_with_public(crypted, base64=true)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Decrypts data, expects a hash as create with crypt_with_private
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 102
102: def decrypt_with_public(crypted, base64=true)
@@ -535,31 +905,39 @@ Decrypts data, expects a hash as create with crypt_with_private
110: key = rsa_decrypt_with_public(crypted[:key])
111: aes_decrypt(key, crypted[:data])
112: end
-113: end
-
-
+
+
+
+
+
+
+
+ encrypt_with_private(plain_text, base64=true)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Encrypts supplied data using AES and then encrypts using RSA the key and IV
Return a hash with everything optionally base 64 encoded
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 73
73: def encrypt_with_private(plain_text, base64=true)
@@ -574,31 +952,39 @@ Return a hash with everything optionally base 64 encoded
82: end
83:
84: {:key => key, :data => data}
-85: end
-
-
+
+
+
+
+
+
+
+ encrypt_with_public(plain_text, base64=true)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+
-
-
+
+
+ Encrypts supplied data using AES and then encrypts using RSA the key and IV
Return a hash with everything optionally base 64 encoded
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 55
55: def encrypt_with_public(plain_text, base64=true)
@@ -613,52 +999,69 @@ Return a hash with everything optionally base 64 encoded
64: end
65:
66: {:key => key, :data => data}
-67: end
-
-
+
+
+
+
+
+
+
+ read_key(type, key=nil, passphrase=nil)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Reads either a :public or :private key from disk, uses an optional passphrase to read the private key
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 242
242: def read_key(type, key=nil, passphrase=nil)
@@ -696,191 +1099,250 @@ passphrase to read the private key
274: else
275: raise "Can only load :public or :private keys"
276: end
-277: end
-
-
+
+
+
+
+
+
+
+ rsa_decrypt_with_private(crypt_string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Use the private key to RSA decrypt data
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 123
123: def rsa_decrypt_with_private(crypt_string)
124: raise "No private key set" unless @private_key
125:
126: @private_key.private_decrypt(crypt_string)
-127: end
-
-
+
+
+
+
+
+
+
+ rsa_decrypt_with_public(crypt_string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Use the public key to RSA decrypt data
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 137
137: def rsa_decrypt_with_public(crypt_string)
138: raise "No public key set" unless @public_key
139:
140: @public_key.public_decrypt(crypt_string)
-141: end
-
-
+
+
+
+
+
+
+
+ rsa_encrypt_with_private(plain_string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Use the private key to RSA encrypt data
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 130
130: def rsa_encrypt_with_private(plain_string)
131: raise "No private key set" unless @private_key
132:
133: @private_key.private_encrypt(plain_string)
-134: end
-
-
+
+
+
+
+
+
+
+ rsa_encrypt_with_public(plain_string)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Use the public key to RSA encrypt data
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 116
116: def rsa_encrypt_with_public(plain_string)
117: raise "No public key set" unless @public_key
118:
119: @public_key.public_encrypt(plain_string)
-120: end
-
-
+
+
+
+
+
+
+
+ sign(string, base64=false)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Signs a string using the private key
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 168
168: def sign(string, base64=false)
169: sig = @private_key.sign(OpenSSL::Digest::SHA1.new, string)
170:
171: base64 ? base64_encode(sig) : sig
-172: end
-
-
+
+
+
+
+
+
+ verify_signature(signature, string, base64=false)
+ click to toggle source
+
+
+
+
+
+
+179: end
+ Using the public key verifies that a string was signed using the private key
- -
+
+
+
+
-
-
# File lib/mcollective/ssl.rb, line 175
175: def verify_signature(signature, string, base64=false)
176: signature = base64_decode(signature) if base64
177:
178: @public_key.verify(OpenSSL::Digest::SHA1.new, signature, string)
-179: end
-
-