vchain_client 1.0.1 → 1.0.6

data/lib/vchain_client/blockstack_client.rb

@@ -6,102 +6,408 @@ module VChainClient
 	Xet0UYuBrILjHB9HcxFc+WwuCflIRWtRDsNfaY6Ra7j/cRYLeiocYA=="
 
 		@config = nil
+		@log = nil
 
 	  	@@recs_cache = {}
 	  	@@keys_cache = {}
 
 	    def initialize(config)
 	    	@config = config
+
+	    	@log = Log4r::Logger["vchain_client"]
 	    end 
 
 	  	def checkFederativeServer(federative_server_id)
-	  		return self.checkBlockstackRecord(federative_server_id, 'federative_server')
+
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.checkFederativeServer] input:")
+	  			@log.debug("-> federative_server_id: #{federative_server_id}")
+	  		end
+
+	  		begin
+	  			
+	  			return self.checkBlockstackRecord(federative_server_id, 'federative_server')
+
+	  		rescue => e
+
+		  		if @log.error?
+		  			@log.error("[Blockstack.checkFederativeServer] checkBlockstackRecord raised exception:")
+		  			@log.error("#{e.class}, #{e.message}")
+		  			@log.error("-> federative_server_id: #{federative_server_id}")
+		  			@log.error("--> federative_server_id: #{federative_server_id}")
+		  			@log.error("--> type: federative_server")
+		  		end
+
+	  			raise e
+	  		end
 	  	end
 
 	  	def checkVerificator(verificator_id)
-	  		return self.checkBlockstackRecord(verificator_id, 'verificator')
+
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.checkVerificator] input:")
+	  			@log.debug("-> verificator_id: #{verificator_id}")
+	  		end
+
+	  		begin
+	  			
+	  			return self.checkBlockstackRecord(verificator_id, 'verificator')
+
+	  		rescue => e
+
+		  		if @log.error?
+		  			@log.error("[Blockstack.checkVerificator] checkBlockstackRecord raised exception:")
+		  			@log.error("#{e.class}, #{e.message}")
+		  			@log.error("-> verificator_id: #{verificator_id}")
+		  			@log.error("--> verificator_id: #{verificator_id}")
+		  			@log.error("--> type: verificator")
+		  		end
+
+	  			raise e
+	  		end
 	  	end
 
 	  	def checkValidator(validator_id)
-	  		return self.checkBlockstackRecord(validator_id, 'validator')
+
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.checkValidator] input:")
+	  			@log.debug("-> validator_id: #{validator_id}")
+	  		end
+
+	  		begin
+	  			
+	  			return self.checkBlockstackRecord(validator_id, 'validator')
+
+	  		rescue => e
+
+		  		if @log.error?
+		  			@log.error("[Blockstack.checkValidator] checkBlockstackRecord raised exception:")
+		  			@log.error("#{e.class}, #{e.message}")
+		  			@log.error("-> validator_id: #{validator_id}")
+		  			@log.error("--> validator_id: #{validator_id}")
+		  			@log.error("--> type: validator")
+		  		end
+
+	  			raise e
+	  		end
 	  	end
 
 	  	def checkBlockstackRecord(blockstack_id, type)
 
-	  		record = self.getBlockstackRecord(blockstack_id)
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.checkBlockstackRecord] input:")
+	  			@log.debug("-> blockstack_id: #{blockstack_id}")
+	  			@log.debug("-> type: #{type}")
+	  		end
+
+	  		record = nil
+
+	  		begin
+	  			
+	  			record = self.getBlockstackRecord(blockstack_id)
+
+	  		rescue => e
+
+		  		if @log.error?
+		  			@log.error("[Blockstack.checkBlockstackRecord] getBlockstackRecord raised exception:")
+		  			@log.error("#{e.class}, #{e.message}")
+		  			@log.error("-> blockstack_id: #{blockstack_id}")
+		  			@log.error("-> type: #{type}")
+		  			@log.error("--> blockstack_id: #{blockstack_id}")
+		  		end
+
+	  			raise e
+	  		end
+
+	  		if record == nil
+	  			if @log.error?
+		  			@log.error("[Blockstack.checkBlockstackRecord] failed to retrieve record")
+		  			@log.error("-> blockstack_id: #{blockstack_id}")
+		  			@log.error("-> type: #{type}")
+		  			@log.error("--> blockstack_id: #{blockstack_id}")
+	  			end
+
+	  			return false
+	  		end
 
 	  		signaturesHelper = VChainClient::Signatures.new(@config)
 
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.checkBlockstackRecord] Signatures initialized")
+	  		end
+
 	  		if record != nil
+
 	  			if record.key?("pubkey")
+
 	  				if record.key?("vchain_role")
 	  					
 	  					if record["vchain_role"] != type
-	  						return nil
+				  			if @log.error?
+				  				@log.error("[Blockstack.checkBlockstackRecord] type mismatch")
+					  			@log.error("-> blockstack_id: #{blockstack_id}")
+					  			@log.error("-> type: #{type}")
+					  			@log.error("--> '"+ record["vchain_role"] +"'")
+				  			end	 
+
+	  						return false
+	  					end
+
+	  					if !record.key?("validator_blockstack_id")
+				  			if @log.error?
+				  				@log.error("[Blockstack.checkBlockstackRecord] record doesn't have 'validator_blockstack_id' field")
+					  			@log.error("-> blockstack_id: #{blockstack_id}")
+					  			@log.error("-> type: #{type}")
+				  			end	 
+
+	  						return false
 	  					end
 
 	  					validator_blockstack_id = record["validator_blockstack_id"]
-	  					if validator_blockstack_id != nil
 
-	  						if record["vchain_role"] != 'validator'
+				  		if @log.debug?
+				  			@log.debug("[Blockstack.checkBlockstackRecord] record's vchain_role is '"+ record["vchain_role"] +"'")
+				  		end
+
+  						if record["vchain_role"] != 'validator'
+
+					  		if @log.debug?
+					  			@log.debug("[Blockstack.checkBlockstackRecord] going to check validator for #{blockstack_id}, validator_id: #{validator_blockstack_id}")
+					  		end
+
+					  		begin
+
 	  							if !self.checkValidator(validator_blockstack_id)
-	  								return nil
+
+						  			if @log.error?
+						  				@log.error("[Blockstack.checkBlockstackRecord] failed to check validator")
+							  			@log.error("-> blockstack_id: #{blockstack_id}")
+							  			@log.error("-> type: #{type}")
+							  			@log.error("--> validator_blockstack_id: #{validator_blockstack_id}")
+						  			end	
+
+	  								return false
 	  							end
-	  						end
 
-	  						validator_pub_key = nil
-	  						if record["vchain_role"] != 'validator'
-	  							validator_pub_key = self.getPublicKey(validator_blockstack_id)
-	  						else
-	  							validator_pub_key = MASTER_PUBLIC_KEY;
-	  						end
+  							rescue => e
+						  		if @log.error?
+						  			@log.error("[Blockstack.checkBlockstackRecord] checkValidator raised exception:")
+						  			@log.error("#{e.class}, #{e.message}")
+						  			@log.error("-> blockstack_id: #{blockstack_id}")
+						  			@log.error("-> type: #{type}")
+						  			@log.error("--> validator_blockstack_id: #{validator_blockstack_id}")
+						  		end
+
+  								raise e
+  							end
+
+  						end
+
+  						validator_pub_key = nil
+  						if record["vchain_role"] != 'validator'
+
+  							begin
+  								
+  								validator_pub_key = self.getPublicKey(validator_blockstack_id)
+
+  							rescue => e
+						  		if @log.error?
+						  			@log.error("[Blockstack.checkBlockstackRecord] getPublicKey raised exception:")
+						  			@log.error("#{e.class}, #{e.message}")
+						  			@log.error("-> blockstack_id: #{blockstack_id}")
+						  			@log.error("-> type: #{type}")
+						  			@log.error("--> validator_blockstack_id: #{validator_blockstack_id}")
+						  		end
+
+  								raise e
+  							end
+
+  						else
+  							validator_pub_key = MASTER_PUBLIC_KEY;
+  						end
 
-							# check client's sig
+  						if validator_pub_key == nil
+  							if @log.error?
+					  			@log.error("[Blockstack.checkBlockstackRecord] failed to retrieve public key:")
+					  			@log.error("-> blockstack_id: #{blockstack_id}")
+					  			@log.error("-> type: #{type}")
+					  			@log.error("--> validator_blockstack_id: #{validator_blockstack_id}")
+  							end
 
-							client_sig_to_check = record["vchain_id"] + record["vchain_role"] + blockstack_id + record["pubkey"] + record["sig_version"];
+  							return false
+  						end
+
+						# check client's sig
+						client_sig_to_check = record["vchain_id"] + record["vchain_role"] + blockstack_id + record["pubkey"] + record["sig_version"];
+
+						begin
 
 							if signaturesHelper.verifySignature(client_sig_to_check, record["client_sig"], record["pubkey"])
+								
 								# check validator's sig
 								validator_sig_to_check = record["vchain_id"] + record["vchain_role"] + blockstack_id + record["pubkey"] + record["sig_version"] + record["validator_vchain_id"] + validator_blockstack_id
 								
-								if signaturesHelper.verifySignature(validator_sig_to_check, record["validator_sig"], validator_pub_key)
-									return true;
-
-								else
-									return nil
+								begin
+
+									if signaturesHelper.verifySignature(validator_sig_to_check, record["validator_sig"], validator_pub_key)
+										
+										return true;
+
+									else
+										if @log.error?
+								  			@log.error("[Blockstack.checkBlockstackRecord] failed to verify validator_sig")
+								  			@log.error("-> blockstack_id: #{blockstack_id}")
+								  			@log.error("-> type: #{type}")
+							  				@log.error("--> validator_sig_to_check: #{validator_sig_to_check}")
+							  				@log.error("--> validator_sig: "+ Base64.encode64(record["validator_sig"]))
+							  				@log.error("--> validator_pub_key: "+ record["validator_pub_key"])
+										end
+
+										return false
+									end
+
+								rescue => e
+									if @log.error?
+							  			@log.error("[Blockstack.checkBlockstackRecord] verifySignature for validator_sig raised exception:")
+							  			@log.error("#{e.class}, #{e.message}")
+							  			@log.error("-> blockstack_id: #{blockstack_id}")
+							  			@log.error("-> type: #{type}")
+							  			@log.error("--> validator_sig_to_check: #{validator_sig_to_check}")
+							  			@log.error("--> validator_sig: "+ Base64.encode64(record["validator_sig"]))
+							  			@log.error("--> validator_pub_key: "+ record["validator_pub_key"])
+									end
+
+									raise e
 								end
 
 							else
-								return nil
+								if @log.error?
+						  			@log.error("[Blockstack.checkBlockstackRecord] failed to verify client_sig")
+						  			@log.error("-> blockstack_id: #{blockstack_id}")
+						  			@log.error("-> type: #{type}")
+					  				@log.error("--> client_sig_to_check: #{client_sig_to_check}")
+					  				@log.error("--> client_sig: "+ Base64.encode64(record["client_sig"]))
+					  				@log.error("--> pubkey: "+ record["pubkey"])
+						  		end
+
+								return false
 							end
-	  					end
+
+						rescue => e
+							if @log.error?
+					  			@log.error("[Blockstack.checkBlockstackRecord] verifySignature for client_sig raised exception:")
+					  			@log.error("#{e.class}, #{e.message}")
+					  			@log.error("-> blockstack_id: #{blockstack_id}")
+					  			@log.error("-> type: #{type}")
+					  			@log.error("--> client_sig_to_check: #{client_sig_to_check}")
+					  			@log.error("--> client_sig: "+ Base64.encode64(record["client_sig"]))
+					  			@log.error("--> pubkey: "+ record["pubkey"])
+							end
+
+							raise e
+						end
+
+	  				else 
+			  			if @log.error?
+			  				@log.error("[Blockstack.checkBlockstackRecord] record doesn't have 'vchain_role' field")
+				  			@log.error("-> blockstack_id: #{blockstack_id}")
+				  			@log.error("-> type: #{type}")
+			  			end	  					
 	  				end
+
+	  			else
+		  			if @log.error?
+		  				@log.error("[Blockstack.checkBlockstackRecord] record doesn't have 'pubkey' field")
+			  			@log.error("-> blockstack_id: #{blockstack_id}")
+			  			@log.error("-> type: #{type}")
+		  			end
+	  			end
+
+	  		else
+	  			if @log.error?
+	  				@log.error("[Blockstack.checkBlockstackRecord] record is null")
+		  			@log.error("-> blockstack_id: #{blockstack_id}")
+		  			@log.error("-> type: #{type}")
 	  			end
 	  		end
 
-	  		return nil
+	  		return false
 	  	end
 
 	  	def getPublicKey(blockstack_id)
+
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.getPublicKey] input:")
+	  			@log.debug("-> blockstack_id: #{blockstack_id}")
+	  		end
+
 	  		if @@keys_cache.key?(blockstack_id)
+
+		  		if @log.debug?
+		  			@log.debug("[Blockstack.getPublicKey] '#{blockstack_id}' is in a cache")
+		  		end
+
 	  			return @@keys_cache[blockstack_id]
 	  		end
 
-	  		record = self.getBlockstackRecord(blockstack_id);
-	  		if record != nil
-	  			if record.key?("pubkey")
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.getPublicKey] '#{blockstack_id}' is not in a cache yet")
+	  		end
 
-	  				@@keys_cache[blockstack_id] = record["pubkey"]
+	  		begin
 
-	  				return record["pubkey"]
-	  			end
-	  		end
+		  		record = self.getBlockstackRecord(blockstack_id);
+
+		  		if record != nil
+		  			
+		  			if record.key?("pubkey")
+
+		  				@@keys_cache[blockstack_id] = record["pubkey"]
+
+		  				return record["pubkey"]
+
+		  			else 
+				  		if @log.error?
+				  			@log.error("[Blockstack.getPublicKey] record '#{blockstack_id}' doesn't have 'pubkey' field")
+				  			@log.error("-> blockstack_id: #{blockstack_id}")
+				  			@log.error("--> blockstack_id: #{blockstack_id}")
+				  		end
+		  			end
+
+		  		else
+			  		if @log.error?
+			  			@log.error("[Blockstack.getPublicKey] failed to retrieve '#{blockstack_id}' record")
+			  			@log.error("-> blockstack_id: #{blockstack_id}")
+			  			@log.error("--> blockstack_id: #{blockstack_id}")
+			  		end
+		  		end
+
+		  	rescue => e
+		  		if @log.error?
+		  			@log.error("[Blockstack.getPublicKey] getBlockstackRecord raised exception:")
+		  			@log.error("#{e.class}, #{e.message}")
+		  			@log.error("-> blockstack_id: #{blockstack_id}")
+		  			@log.error("--> blockstack_id: #{blockstack_id}")
+		  		end
+
+		  		raise e
+		  	end
 
 	  		return nil
 	  	end
 
 	  	def getBlockstackRecord(blockstack_id)
+
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.getBlockstackRecord] input:")
+	  			@log.debug("-> blockstack_id: #{blockstack_id}")
+	  		end
+
 	  		if @@recs_cache.key?(blockstack_id)
+		  		if @log.debug?
+		  			@log.debug("[Blockstack.getBlockstackRecord] '#{blockstack_id}' is in a cache")
+		  		end
+
 	  			return @@recs_cache[blockstack_id]
 	  		end
 
@@ -109,24 +415,61 @@ module VChainClient
 
 	  		cmd = blockstack_path +" get_name_zonefile "+ blockstack_id
 
-	  		ret = `#{cmd}`
-	  		if ret == nil || ret == "Name has no user record hash defined"
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.getBlockstackRecord] using '#{blockstack_path}' as a Blockstack path")
+	  			@log.debug("[Blockstack.getBlockstackRecord] running '#{cmd}'")
+	  		end
+
+	  		ret = nil
+
+	  		begin 
+
+	  			ret = `#{cmd}`
+
+	  		rescue => e
+	  			if @log.error?
+	  				@log.error("[Blockstack.getBlockstackRecord] cmd call '#{cmd}' raised exception:")
+	  				@log.error("#{e.class}, #{e.message}")
+	  				@log.error("-> blockstack_id: #{blockstack_id}")
+	  				@log.error("--> '#{cmd}'")
+	  			end
+
+	  			raise e
+	  		end
+
+	  		if ret == nil
+	  			if @log.error?
+	  				@log.error("[Blockstack.getBlockstackRecord] failed to retrieve record from cmd call")
+	  				@log.error("-> blockstack_id: #{blockstack_id}")
+	  				@log.error("--> '#{cmd}'")
+	  			end
+
 	  			return nil
 	  		end
+
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.getBlockstackRecord] cmd call return:")
+	  			@log.debug(ret)
+	  		end
+
 	  		ret = JSON.parse ret
 
 	  		fz = {}
-	  		if ret != nil
-	  			if ret.key?("txt")
-	  				ret["txt"].each { |rec|
-	  					if rec.key?("name") && rec.key?("txt")
-	  						fz[rec["name"]] = rec["txt"]
-	  					end
-	  				}
-	  			end
+  			if ret.key?("txt")
+  				ret["txt"].each { |rec|
+  					if rec.key?("name") && rec.key?("txt")
+  						fz[rec["name"]] = rec["txt"]
+  					end
+  				}
+  			end
+
+	  		if @log.debug?
+	  			@log.debug("[Blockstack.getBlockstackRecord] fz:")
+	  			@log.debug(fz)
 	  		end
 
-	  		if fz.key?("A1")
+	  		if fz.key?("A1") && fz.key?("A2") && fz.key?("A3") && fz.key?("A4") && fz.key?("A5") && fz.key?("A6") && fz.key?("A7") && fz.key?("A8")
+
 	  			pubkey_aligned = fz["A1"]
 	  			pubkey = pubkey_aligned[0..63] +"\n"+ pubkey_aligned[64..pubkey_aligned.length]
 
@@ -141,10 +484,22 @@ module VChainClient
 					"client_sig"              => Base64.decode64(fz["A8"])
 	  			}
 
+		  		if @log.debug?
+		  			@log.debug("[Blockstack.getBlockstackRecord] output:")
+		  			@log.debug(output)
+		  		end
+
 	  			@@recs_cache[blockstack_id] = output
 	  			@@keys_cache[blockstack_id] = pubkey
 
 	  			return output
+
+	  		else
+	  			if @log.error?
+  					@log.error("[Blockstack.getBlockstackRecord] no 'A*' field")
+  					@log.error("-> blockstack_id: #{blockstack_id}")
+  					@log.error("--> blockstack_id: #{blockstack_id}")
+  				end
 	  		end
 
 	  		return nil