fix(*) add prefix to all error messages

Author: fffonion

lib/resty/openssl/asn1.lua

@@ -40,23 +40,23 @@ local function asn1_to_unix(asn1)
   end
   local month = tonumber(s:sub(yyoffset+1, yyoffset+2))
   if month > 12 or month < 1 then
-    return nil, "bad format " .. s
+    return nil, "asn1.asn1_to_unix: bad format " .. s
   end
   local day = tonumber(s:sub(yyoffset+3, yyoffset+4))
   if day > 31 or day < 1 then
-    return nil, "bad format " .. s
+    return nil, "asn1.asn1_to_unix: bad format " .. s
   end
   local hour = tonumber(s:sub(yyoffset+5, yyoffset+6))
   if hour > 23 or hour < 0 then
-    return nil, "bad format " .. s
+    return nil, "asn1.asn1_to_unix: bad format " .. s
   end
   local minute = tonumber(s:sub(yyoffset+7, yyoffset+8))
   if minute > 59 or hour < 0 then
-    return nil, "bad format " .. s
+    return nil, "asn1.asn1_to_unix: bad format " .. s
   end
   local second = tonumber(s:sub(yyoffset+9, yyoffset+10))
   if second > 59 or second < 0 then
-    return nil, "bad format " .. s
+    return nil, "asn1.asn1_to_unix: bad format " .. s
   end
 
   local tm
@@ -74,7 +74,7 @@ local function asn1_to_unix(asn1)
     local hh = tonumber(s:sub(yyoffset+12, yyoffset+13) or 'no')
     local mm = tonumber(s:sub(yyoffset+14, yyoffset+15) or 'no')
     if not hh or not mm then
-      return nil, "bad format " .. s
+      return nil, "asn1.asn1_to_unix: bad format " .. s
     end
     tm = tm + sgn * (hh * 3600 + mm * 60)
   end

lib/resty/openssl/aux/jwk.lua

@@ -124,7 +124,9 @@ end
 function _M.load_jwk(txt)
   local tbl, err = cjson.decode(txt)
   if err then
-    return nil, "error decoding jwk json: " .. err
+    return nil, "error decoding JSON from JWK: " .. err
+  elseif type(tbl) ~= "table" then
+    return nil, "except input to be decoded as a table, got " .. type(tbl)
   end
 
   local key, key_free, key_type, err
@@ -155,7 +157,7 @@ function _M.load_jwk(txt)
   end
 
   if err then
-    return nil, "failed to construct key from JWK: " .. err
+    return nil, "failed to construct " .. tbl["kty"] .. " key from JWK: " .. err
   end
 
   local ctx = C.EVP_PKEY_new()

lib/resty/openssl/bn.lua

@@ -25,7 +25,7 @@ function _M.new(bn)
       return nil, format_error("bn.new")
     end
   elseif bn then
-    return nil, "expect nil or a number at #1"
+    return nil, "bn.new: expect nil or a number at #1"
   end
 
   return setmetatable( { ctx = ctx }, mt), nil
@@ -37,7 +37,7 @@ end
 
 function _M.dup(ctx)
   if not ffi.istype(bn_ptr_ct, ctx) then
-    return nil, "expect a bn ctx at #1"
+    return nil, "bn.dup: expect a bn ctx at #1"
   end
   local ctx = C.BN_dup(ctx)
   ffi_gc(ctx, C.BN_free)
@@ -64,7 +64,7 @@ end
 
 function _M.from_binary(s)
   if type(s) ~= "string" then
-    return nil, "expect a string at #1"
+    return nil, "bn.from_binary: expect a string at #1"
   end
 
   local ctx = C.BN_bin2bn(s, #s, nil)
@@ -87,7 +87,7 @@ end
 
 function _M.from_hex(s)
   if type(s) ~= "string" then
-    return nil, "expect a string at #1"
+    return nil, "bn.from_hex: expect a string at #1"
   end
 
   local p = ffi.new(bn_ptrptr_ct)
@@ -113,7 +113,7 @@ mt.__tostring = _M.to_dec
 
 function _M.from_dec(s)
   if type(s) ~= "string" then
-    return nil, "expect a string at #1"
+    return nil, "bn.from_dec: expect a string at #1"
   end
 
   local p = ffi.new(bn_ptrptr_ct)
@@ -353,10 +353,10 @@ if OPENSSL_10 then
     local ctx = C.BN_new()
     ffi_gc(ctx, C.BN_free)
     if ctx == nil then
-      return nil, "BN_new() failed"
+      return nil, "bn:is_word: BN_new() failed"
     end
     if C.BN_set_word(ctx, n) ~= 1 then
-      return nil, "BN_set_word() failed"
+      return nil, "bn:is_word: BN_set_word() failed"
     end
     return C.BN_cmp(self.ctx, ctx) == 0
   end
@@ -384,7 +384,7 @@ end
 
 function _M:is_prime(nchecks)
   if nchecks and type(nchecks) ~= "number" then
-    return nil, "expect a number at #1"
+    return nil, "bn:is_prime: expect a number at #1"
   end
   -- if nchecks is not defined, set to BN_prime_checks:
   -- select number of iterations based on the size of the number

lib/resty/openssl/cipher.lua

@@ -16,7 +16,7 @@ local cipher_ctx_ptr_ct = ffi.typeof('EVP_CIPHER_CTX*')
 
 function _M.new(typ)
   if not typ then
-    return nil, "expect type to be defined"
+    return nil, "cipher.new: expect type to be defined"
   end
 
   local ctx
@@ -29,12 +29,12 @@ function _M.new(typ)
     ffi_gc(ctx, C.EVP_CIPHER_CTX_cleanup)
   end
   if ctx == nil then
-    return nil, "failed to create EVP_CIPHER_CTX"
+    return nil, "cipher.new: failed to create EVP_CIPHER_CTX"
   end
 
   local dtyp = C.EVP_get_cipherbyname(typ)
   if dtyp == nil then
-    return nil, string.format("invalid cipher type \"%s\"", typ)
+    return nil, string.format("cipher.new: invalid cipher type \"%s\"", typ)
   end
 
   local code = C.EVP_CipherInit_ex(ctx, dtyp, nil, "", nil, -1)
@@ -58,10 +58,10 @@ end
 function _M:init(key, iv, opts)
   opts = opts or {}
   if not key or #key ~= self.key_size then
-    return false, string.format("incorrect key size, expect %d", self.key_size)
+    return false, string.format("cipher:init: incorrect key size, expect %d", self.key_size)
   end
   if not iv or #iv ~= self.iv_size then
-    return false, string.format("incorrect iv size, expect %d", self.iv_size)
+    return false, string.format("cipher:init: incorrect iv size, expect %d", self.iv_size)
   end
 
   if C.EVP_CipherInit_ex(self.ctx, nil, nil, key, iv, opts.is_encrypt and 1 or 0) == 0 then
@@ -103,7 +103,7 @@ end
 local int_ptr = ffi.typeof("int[1]")
 function _M:update(...)
   if not self.initialized then
-    return nil, "cipher not initalized, call cipher:init first"
+    return nil, "cipher:update: cipher not initalized, call cipher:init first"
   end
 
   local ret = {}
@@ -146,31 +146,31 @@ end
 
 function _M:derive(key, salt, count, md)
   if type(key) ~= "string" then
-    return nil, nil, "expect a string at #1"
+    return nil, nil, "cipher:derive: expect a string at #1"
   elseif salt and type(salt) ~= "string" then
-    return nil, nil, "expect a string at #2"
+    return nil, nil, "cipher:derive: expect a string at #2"
   elseif count then
     count = tonumber(count)
     if not count then
-      return nil, nil, "expect a number at #3"
+      return nil, nil, "cipher:derive: expect a number at #3"
     end
   elseif md and type(md) ~= "string" then
-    return nil, nil, "expect a string or nil at #4"
+    return nil, nil, "cipher:derive: expect a string or nil at #4"
   end
 
   if salt then
     if #salt > 8 then
-      ngx.log(ngx.WARN, "salt is too long, truncate salt to 8 bytes")
+      ngx.log(ngx.WARN, "cipher:derive: salt is too long, truncate salt to 8 bytes")
       salt = salt:sub(0, 8)
     elseif #salt < 8 then
-      ngx.log(ngx.WARN, "salt is too short, padding with zero bytes to length")
+      ngx.log(ngx.WARN, "cipher:derive: salt is too short, padding with zero bytes to length")
       salt = salt .. string.rep('\000', 8 - #salt)
     end
   end
 
   local mdt = C.EVP_get_digestbyname(md or 'sha1')
   if mdt == nil then
-    return nil, nil, string.format("invalid digest type \"%s\"", md)
+    return nil, nil, string.format("cipher:derive: invalid digest type \"%s\"", md)
   end
   local cipt = C.EVP_CIPHER_CTX_cipher(self.ctx)
   local keyb = ffi_new('unsigned char[?]', self.key_size)

lib/resty/openssl/digest.lua

@@ -24,12 +24,12 @@ function _M.new(typ)
     ffi_gc(ctx, C.EVP_MD_CTX_destroy)
   end
   if ctx == nil then
-    return nil, "failed to create EVP_MD_CTX"
+    return nil, "digest.new: failed to create EVP_MD_CTX"
   end
 
   local dtyp = C.EVP_get_digestbyname(typ or 'sha1')
   if dtyp == nil then
-    return nil, string.format("invalid digest type \"%s\"", typ)
+    return nil, string.format("digest.new: invalid digest type \"%s\"", typ)
   end
 
   local code = C.EVP_DigestInit_ex(ctx, dtyp, nil)

lib/resty/openssl/ec.lua

@@ -23,7 +23,7 @@ function _M.get_parameters(ec_key_st)
       if k == 'group' then
         local nid = C.EC_GROUP_get_curve_name(group)
         if nid == 0 then
-          return nil, "EC_GROUP_get_curve_name() failed"
+          return nil, "ec.get_parameters: EC_GROUP_get_curve_name() failed"
         end
         return nid
       elseif k == 'public' or k == "pub_key" then
@@ -68,25 +68,14 @@ function _M.get_parameters(ec_key_st)
           return nil, format_error("ec.get_parameters: EC_POINT_get_affine_coordinates")
         end
       else
-        return nil, "unknown parameter \"" .. k .. "\" for EC key"
+        return nil, "ec.get_parameters: unknown parameter \"" .. k .. "\" for EC key"
       end
 
       return bn_lib.dup(bn)
     end
   }), nil
 end
 
-function _M.ec_group_from_nid(nid)
-  local group = C.EC_GROUP_new_by_curve_name(nid)
-  if group == nil then
-    return nil, "EC_GROUP_new_by_curve_name() failed"
-  end
-  -- # define OPENSSL_EC_NAMED_CURVE     0x001
-  C.EC_GROUP_set_asn1_flag(group, 1)
-  C.EC_GROUP_set_point_conversion_form(group, C.POINT_CONVERSION_UNCOMPRESSED)
-  return group
-end
-
 function _M.set_parameters(ec_key_st, opts)
   for _, k in ipairs(_M.params) do
     if k ~= "group" then
@@ -101,12 +90,12 @@ function _M.set_parameters(ec_key_st, opts)
   if group_nid then
     local nid, err = objects_lib.txtnid2nid(group_nid)
     if err then
-      return nil, "cannot use parameter \"group\":" .. err
+      return nil, "ec.set_parameters: cannot use parameter \"group\":" .. err
     end
 
     group = C.EC_GROUP_new_by_curve_name(nid)
     if group == nil then
-      return nil, "EC_GROUP_new_by_curve_name() failed"
+      return nil, "ec.set_parameters: EC_GROUP_new_by_curve_name() failed"
     end
     ffi_gc(group, C.EC_GROUP_free)
     -- # define OPENSSL_EC_NAMED_CURVE     0x001
@@ -122,18 +111,18 @@ function _M.set_parameters(ec_key_st, opts)
   local y = opts["y"]
   local pub = opts["public"]
   if (x and not y) or (y and not x) then
-    return nil, "\"x\" and \"y\" parameter must be defined at same time or both undefined"
+    return nil, "ec.set_parameters: \"x\" and \"y\" parameter must be defined at same time or both undefined"
   end
 
   if x and y then
     if pub then
-      return nil, "cannot set \"x\" and \"y\" with \"public\" at same time to set public key"
+      return nil, "ec.set_parameters: cannot set \"x\" and \"y\" with \"public\" at same time to set public key"
     end
     -- double check if we have set group already
     if group == nil then
       group = C.EC_KEY_get0_group(ec_key_st)
       if group == nil then
-        return nil, "cannot set public key without setting \"group\""
+        return nil, "ec.set_parameters: cannot set public key without setting \"group\""
       end
     end
 
@@ -146,7 +135,7 @@ function _M.set_parameters(ec_key_st, opts)
     if group == nil then
       group = C.EC_KEY_get0_group(ec_key_st)
       if group == nil then
-        return nil, "cannot set public key without setting \"group\""
+        return nil, "ec.set_parameters: cannot set public key without setting \"group\""
       end
     end
 

lib/resty/openssl/err.lua

@@ -40,7 +40,7 @@ local function format_error(ctx, code)
   end
 
   if #errors > 0 then
-    return string.format("%s: %s", ctx, table.concat(errors, " "))
+    return string.format("%s%s%s", (ctx or ""), (ctx and ": " or ""), table.concat(errors, " "))
   else
     return string.format("%s failed", ctx)
   end

lib/resty/openssl/hmac.lua

@@ -26,12 +26,12 @@ function _M.new(key, typ)
     ffi_gc(ctx, C.HMAC_CTX_cleanup)
   end
   if ctx == nil then
-    return nil, "failed to create HMAC_CTX"
+    return nil, "hmac.new: failed to create HMAC_CTX"
   end
 
   local dtyp = C.EVP_get_digestbyname(typ or 'sha1')
   if dtyp == nil then
-    return nil, string.format("invalid digest type \"%s\"", typ)
+    return nil, string.format("hmac.new: invalid digest type \"%s\"", typ)
   end
 
   local code = C.HMAC_Init_ex(ctx, key, #key, dtyp, nil)

lib/resty/openssl/kdf.lua

@@ -114,20 +114,20 @@ local void_ptr = ffi.typeof("void *")
 function _M.derive(options)
   local typ = options.type
   if not typ then
-    return nil, "\"type\" must be set"
+    return nil, "kdf.derive: \"type\" must be set"
   elseif type(typ) ~= "number" then
-    return nil, "expect a number as \"type\""
+    return nil, "kdf.derive: expect a number as \"type\""
   end
 
   if typ <= 0 then
-    return nil, "kdf type " ..  (type_literals[typ] or tostring(typ)) ..
+    return nil, "kdf.derive: kdf type " ..  (type_literals[typ] or tostring(typ)) ..
                 " not supported in " .. version_text
   end
 
   for k, v in pairs(options_schema) do
     local v, err = check_options(options, typ, k, unpack(v))
     if err then
-      return nil, err
+      return nil, "kdf.derive: " .. err
     end
     options[k] = v
   end
@@ -144,7 +144,7 @@ function _M.derive(options)
   local md
   md = C.EVP_get_digestbyname(options.md or "sha1")
   if md == nil then
-    return nil, string.format("invalid digest type \"%s\"", md)
+    return nil, string.format("kdf.derive: invalid digest type \"%s\"", md)
   end
 
   local buf = ffi_new('unsigned char[?]', options.outlen)
@@ -171,7 +171,7 @@ function _M.derive(options)
       buf, options.outlen
     )
   elseif typ ~= NID_tls1_prf and typ ~= NID_hkdf then
-    return nil, ("unknown type %d"):format(typ)
+    return nil, string.format("kdf.derive: unknown type %d", typ)
   end
   if code then
     if code ~= 1 then
@@ -243,7 +243,7 @@ function _M.derive(options)
       end
     end
   else
-    return nil, ("unknown type %d"):format(typ)
+    return nil, string.format("kdf.derive: unknown type %d", typ)
   end
   code = C.EVP_PKEY_derive(ctx, buf, outlen)
   if code == -2 then