util.hex: Deprecate to/from in favour of encode/decode, for consistency!

8 files changed, 31 insertions, 27 deletions

diff --git a/plugins/mod_auth_internal_hashed.lua b/plugins/mod_auth_internal_hashed.lua
index 1b0e76ed..cf851eef 100644
--- a/plugins/mod_auth_internal_hashed.lua
+++ b/plugins/mod_auth_internal_hashed.lua
@@ -14,7 +14,7 @@ local usermanager = require "core.usermanager";
 local generate_uuid = require "util.uuid".generate;
 local new_sasl = require "util.sasl".new;
 local hex = require"util.hex";
-local to_hex, from_hex = hex.to, hex.from;
+local to_hex, from_hex = hex.encode, hex.decode;
 local saslprep = require "util.encodings".stringprep.saslprep;
 local secure_equals = require "util.hashes".equals;
 
diff --git a/plugins/mod_storage_xep0227.lua b/plugins/mod_storage_xep0227.lua
index 1a7baaeb..9a3ca002 100644
--- a/plugins/mod_storage_xep0227.lua
+++ b/plugins/mod_storage_xep0227.lua
@@ -68,11 +68,11 @@ local function createOuterXml(user, host)
 end
 
 local function hex_to_base64(s)
-	return base64.encode(hex.from(s));
+	return base64.encode(hex.decode(s));
 end
 
 local function base64_to_hex(s)
-	return base64.encode(hex.from(s));
+	return base64.encode(hex.decode(s));
 end
 
 local handlers = {};
diff --git a/spec/util_hashes_spec.lua b/spec/util_hashes_spec.lua
index 3639dd4e..51a4a79c 100644
--- a/spec/util_hashes_spec.lua
+++ b/spec/util_hashes_spec.lua
@@ -10,28 +10,28 @@ describe("PBKDF2-HMAC-SHA1", function ()
 		local S = "salt"
 		local c = 1
 		local DK = "0c60c80f961f0e71f3a9b524af6012062fe037a6";
-		assert.equal(DK, hex.to(hashes.pbkdf2_hmac_sha1(P, S, c)));
+		assert.equal(DK, hex.encode(hashes.pbkdf2_hmac_sha1(P, S, c)));
 	end);
 	it("test vector 2", function ()
 		local P = "password"
 		local S = "salt"
 		local c = 2
 		local DK = "ea6c014dc72d6f8ccd1ed92ace1d41f0d8de8957";
-		assert.equal(DK, hex.to(hashes.pbkdf2_hmac_sha1(P, S, c)));
+		assert.equal(DK, hex.encode(hashes.pbkdf2_hmac_sha1(P, S, c)));
 	end);
 	it("test vector 3", function ()
 		local P = "password"
 		local S = "salt"
 		local c = 4096
 		local DK = "4b007901b765489abead49d926f721d065a429c1";
-		assert.equal(DK, hex.to(hashes.pbkdf2_hmac_sha1(P, S, c)));
+		assert.equal(DK, hex.encode(hashes.pbkdf2_hmac_sha1(P, S, c)));
 	end);
 	it("test vector 4 #SLOW", function ()
 		local P = "password"
 		local S = "salt"
 		local c = 16777216
 		local DK = "eefe3d61cd4da4e4e9945b3d6ba2158c2634e984";
-		assert.equal(DK, hex.to(hashes.pbkdf2_hmac_sha1(P, S, c)));
+		assert.equal(DK, hex.encode(hashes.pbkdf2_hmac_sha1(P, S, c)));
 	end);
 end);
 
@@ -41,14 +41,14 @@ describe("PBKDF2-HMAC-SHA256", function ()
 		local S = "salt";
 		local c = 1
 		local DK = "120fb6cffcf8b32c43e7225256c4f837a86548c92ccc35480805987cb70be17b";
-		assert.equal(DK, hex.to(hashes.pbkdf2_hmac_sha256(P, S, c)));
+		assert.equal(DK, hex.encode(hashes.pbkdf2_hmac_sha256(P, S, c)));
 	end);
 	it("test vector 2", function ()
 		local P = "password";
 		local S = "salt";
 		local c = 2
 		local DK = "ae4d0c95af6b46d32d0adff928f06dd02a303f8ef3c251dfd6e2d85a95474c43";
-		assert.equal(DK, hex.to(hashes.pbkdf2_hmac_sha256(P, S, c)));
+		assert.equal(DK, hex.encode(hashes.pbkdf2_hmac_sha256(P, S, c)));
 	end);
 end);
 
diff --git a/spec/util_hmac_spec.lua b/spec/util_hmac_spec.lua
index a2125c3a..8d6274aa 100644
--- a/spec/util_hmac_spec.lua
+++ b/spec/util_hmac_spec.lua
@@ -7,8 +7,8 @@ local hmac = require "util.hmac";
 local hex = require "util.hex";
 
 describe("Test case 1", function ()
-	local Key  = hex.from("0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b");
-	local Data = hex.from("4869205468657265");
+	local Key  = hex.decode("0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b");
+	local Data = hex.decode("4869205468657265");
 	describe("HMAC-SHA-256", function ()
 		it("works", function()
 			assert.equal("b0344c61d8db38535ca8afceaf0bf12b881dc200c9833da726e9376c2e32cff7", hmac.sha256(Key, Data, true))
@@ -21,8 +21,8 @@ describe("Test case 1", function ()
 	end);
 end);
 describe("Test case 2", function ()
-	local Key  = hex.from("4a656665");
-	local Data = hex.from("7768617420646f2079612077616e7420666f72206e6f7468696e673f");
+	local Key  = hex.decode("4a656665");
+	local Data = hex.decode("7768617420646f2079612077616e7420666f72206e6f7468696e673f");
 	describe("HMAC-SHA-256", function ()
 		it("works", function()
 			assert.equal("5bdcc146bf60754e6a042426089575c75a003f089d2739839dec58b964ec3843", hmac.sha256(Key, Data, true))
@@ -35,8 +35,8 @@ describe("Test case 2", function ()
 	end);
 end);
 describe("Test case 3", function ()
-	local Key  = hex.from("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
-	local Data = hex.from("dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd");
+	local Key  = hex.decode("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
+	local Data = hex.decode("dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd");
 	describe("HMAC-SHA-256", function ()
 		it("works", function()
 			assert.equal("773ea91e36800e46854db8ebd09181a72959098b3ef8c122d9635514ced565fe", hmac.sha256(Key, Data, true))
@@ -49,8 +49,8 @@ describe("Test case 3", function ()
 	end);
 end);
 describe("Test case 4", function ()
-	local Key  = hex.from("0102030405060708090a0b0c0d0e0f10111213141516171819");
-	local Data = hex.from("cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd");
+	local Key  = hex.decode("0102030405060708090a0b0c0d0e0f10111213141516171819");
+	local Data = hex.decode("cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd");
 	describe("HMAC-SHA-256", function ()
 		it("works", function()
 			assert.equal("82558a389a443c0ea4cc819899f2083a85f0faa3e578f8077a2e3ff46729665b", hmac.sha256(Key, Data, true))
@@ -63,8 +63,8 @@ describe("Test case 4", function ()
 	end);
 end);
 describe("Test case 5", function ()
-	local Key  = hex.from("0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c");
-	local Data = hex.from("546573742057697468205472756e636174696f6e");
+	local Key  = hex.decode("0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c");
+	local Data = hex.decode("546573742057697468205472756e636174696f6e");
 	describe("HMAC-SHA-256", function ()
 		it("works", function()
 			assert.equal("a3b6167473100ee06e0c796c2955552b", hmac.sha256(Key, Data, true):sub(1,128/4))
@@ -77,8 +77,8 @@ describe("Test case 5", function ()
 	end);
 end);
 describe("Test case 6", function ()
-	local Key  = hex.from("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
-	local Data = hex.from("54657374205573696e67204c6172676572205468616e20426c6f636b2d53697a65204b6579202d2048617368204b6579204669727374");
+	local Key  = hex.decode("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
+	local Data = hex.decode("54657374205573696e67204c6172676572205468616e20426c6f636b2d53697a65204b6579202d2048617368204b6579204669727374");
 	describe("HMAC-SHA-256", function ()
 		it("works", function()
 			assert.equal("60e431591ee0b67f0d8a26aacbf5b77f8e0bc6213728c5140546040f0ee37f54", hmac.sha256(Key, Data, true))
@@ -91,8 +91,8 @@ describe("Test case 6", function ()
 	end);
 end);
 describe("Test case 7", function ()
-	local Key  = hex.from("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
-	local Data = hex.from("5468697320697320612074657374207573696e672061206c6172676572207468616e20626c6f636b2d73697a65206b657920616e642061206c6172676572207468616e20626c6f636b2d73697a6520646174612e20546865206b6579206e6565647320746f20626520686173686564206265666f7265206265696e6720757365642062792074686520484d414320616c676f726974686d2e");
+	local Key  = hex.decode("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
+	local Data = hex.decode("5468697320697320612074657374207573696e672061206c6172676572207468616e20626c6f636b2d73697a65206b657920616e642061206c6172676572207468616e20626c6f636b2d73697a6520646174612e20546865206b6579206e6565647320746f20626520686173686564206265666f7265206265696e6720757365642062792074686520484d414320616c676f726974686d2e");
 	describe("HMAC-SHA-256", function ()
 		it("works", function()
 			assert.equal("9b09ffa71b942fcb27635fbcd5b0e944bfdc63644f0713938a7f51535c3a35e2", hmac.sha256(Key, Data, true))
diff --git a/util/dns.lua b/util/dns.lua
index 9d80d1ec..3b58e03e 100644
--- a/util/dns.lua
+++ b/util/dns.lua
@@ -13,7 +13,7 @@ local s_format = string.format;
 local s_sub = string.sub;
 
 local iana_data = require "util.dnsregistry";
-local tohex = require "util.hex".to;
+local tohex = require "util.hex".encode;
 local inet_ntop = require "util.net".ntop;
 
 -- Simplified versions of Waqas DNS parsers
diff --git a/util/hex.lua b/util/hex.lua
index 4cc28d33..6202620f 100644
--- a/util/hex.lua
+++ b/util/hex.lua
@@ -23,4 +23,8 @@ local function from(s)
 	return (s_gsub(s_lower(s), "%X*(%x%x)%X*", hex_to_char));
 end
 
-return { to = to, from = from }
+return {
+	encode = to, decode = from;
+	-- COMPAT w/pre-0.12:
+	to = to, from = from;
+};
diff --git a/util/ip.lua b/util/ip.lua
index 20b92466..4b450934 100644
--- a/util/ip.lua
+++ b/util/ip.lua
@@ -67,7 +67,7 @@ function ip_methods:normal()
 end
 
 function ip_methods.bits(ip)
-	return hex.to(ip.packed):upper():gsub(".", hex2bits);
+	return hex.encode(ip.packed):upper():gsub(".", hex2bits);
 end
 
 function ip_methods.bits_full(ip)
diff --git a/util/uuid.lua b/util/uuid.lua
index f4fd21f6..54ea99b4 100644
--- a/util/uuid.lua
+++ b/util/uuid.lua
@@ -8,7 +8,7 @@
 
 local random = require "util.random";
 local random_bytes = random.bytes;
-local hex = require "util.hex".to;
+local hex = require "util.hex".encode;
 local m_ceil = math.ceil;
 
 local function get_nibbles(n)