EzSSL 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5680630e7ae64e9a8e228615bcfef3389edd5bf74ac58cc92fb8dce85c2039d0
-  data.tar.gz: 3c797a767ac64ae1de5353c7ac2f9199d448f7e4e24fc7d27d5389aac24fdf9d
+  metadata.gz: 4f4af8b7f05ef4af024970829b47f06efab3bdb4da0444a8d57a06b7ea146af1
+  data.tar.gz: fcdb8597e1977fca10c5d04dba0e191728ac9a482bbbf6759e72370ef56e6ca8
 SHA512:
-  metadata.gz: fa8e6d140cd892a49d2f95fca9e5add92ef4a8544857f99d44c66b42ed6c089897dcb583c8176f082a6373f0cb24e7b469d0978fb85e41d2241f46b48794b4a5
-  data.tar.gz: bb7f920c5c036b9202de771bf76dbfec7691b042e8bc426e71462fae2a07195b132e6672639a8c2be3c92ab6cf12a0c3e6716531853b5af62ff5fda9af1deba0
+  metadata.gz: 96edb214b6f10451a6d2634bbae8975fd1fdf4440ccff09a6150172a8acbde5f09d4b4fd43bfde0ded174407f165cebc565da6e2b2eed13d9fd06c68bfa5eecc
+  data.tar.gz: 31486a4e8e0c4ce854ec17ddfe30dddf7aae3ae9b4c763c8b31357e3a2e88b20a938f3fed98c6f3aad5f66cbefe008c3d9202d38d7abdc5341c2d7288510f2f4

data/lib/ezssl.rb

@@ -1,7 +1,9 @@
 require 'openssl'
 require 'socket'
 module EzSSL
+
   class Server
+
     attr_reader :read
     def initialize(ip,port,length=2048)
       @socket=TCPServer.open(ip,port)
@@ -9,6 +11,10 @@ module EzSSL
       @pubkey=@pair.public_key
       @read=@pubkey.public_encrypt('hello').length
     end
+
+    # Accepts a client connection, and returns a Handle object for communication
+    # 
+    # @return [Object] The Handle object
     def accept()
       client=@socket.accept
       client.puts @pubkey.to_s
@@ -21,12 +27,20 @@ module EzSSL
       end
       return Handle.new(client,key,self)
     end
+
+    # Decrypt a message without direct access to the private key
+    # 
+    # @param msg [String] The encrypted message
+    # @return [String] The decrypted message
     def decrypt(msg)
       return @pair.private_decrypt(msg)
     end
   end
 
   class Client
+
+    attr_reader :key, :pubkey
+
     def initialize(ip,port,length=2048)
       @pair=OpenSSL::PKey::RSA.new(length)
       @pubkey=@pair.public_key
@@ -42,10 +56,28 @@ module EzSSL
       @socket.puts @pubkey.to_s
       @key=OpenSSL::PKey::RSA.new(key)
     end
+
+    # Returns the maximum length of string that can be encypted with a given key
+    # 
+    # @param [Object] The OpenSSL object to test
+    # @return [Integer] The maximum length of string that can be encrypted with the given key
+    def max_len(key)
+      return key.public_encrypt('test').length
+    end
+
+    # Sends a string (msg) to the server
+    #
+    # @param msg [String] The sting being sent to the server
+    # @raise [ArgumentError] if the message being sent is too large for the OpenSSL::PKey::RSA object
     def puts(msg)
+      raise ArgumentError, "Message is too large to encrypt with the current key. (Max Length:#{max_len(@key)})" if msg.length > max_len(@key)
       @socket.write @key.public_encrypt(msg)
       return nil
     end
+
+    # Recieves a string from the server
+    # 
+    # @return [String] The message from the server
     def gets()
       msg=@socket.read(@read)
       return @pair.private_decrypt(msg)
@@ -53,21 +85,49 @@ module EzSSL
   end
 
   private
+
+  # The object that allows communication from Server to Client.
   class Handle
+
     def initialize(client,key,server)
+      # The represented client
       @client=client
+      # The public key of the represented client
       @key=OpenSSL::PKey::RSA.new(key)
+      @read=@key.public_encrypt('test lol').length
       @server=server
     end
+
+    # Sends a string (msg) to the represented client
+    #  
+    # @param msg [String] The message being sent to the client
+    # @raise [ArgumentError] if the message being sent is too large for the OpenSSL::PKey::RSA object
     def puts(msg)
+      raise ArgumentError, "Message is too large to encrypt with the current key. (Max Length:#{max_len(@key)})" if msg.length > max_len(@key)
       @client.write @key.public_encrypt(msg)
+      return nil
     end
+
+    # Returns the maximum length of string that can be encypted with a given key
+    # 
+    # @param [Object] The OpenSSL object to test
+    # @return [Integer] The maximum length of string that can be encrypted with the given key
+    def max_len(key)
+      return key.public_encrypt('test').length
+    end
+
+    # Recieves a string from the client
+    # 
+    # @return [String] The message sent from the client
     def gets()
       msg=@client.read(@server.read)
       return @server.decrypt(msg)
     end
+
+    # Closes the client remotely
     def close
       @client.close
     end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: EzSSL
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Lucas Reinheart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-11-10 00:00:00.000000000 Z
 dependencies: []
 description: OpenSSL is confusing to people new to socket programming, so i aim to
   make the process easier
@@ -18,7 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ezssl.rb
-homepage: ''
+homepage: https://rubygems.org/gems/EzSSL
 licenses:
 - MIT
 metadata:
@@ -41,5 +41,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Easily maie secure socket connections
+summary: Easily make secure socket connections
 test_files: []