fix(*) always return ok, err if there's no explict return value

Author: fffonion

README.md

@@ -399,7 +399,7 @@ This function is a shorthand of `cipher:init` plus `cipher:final`.
 
 ### cipher:init
 
-**syntax**: *err = cipher:init(key, iv?, opts?)*
+**syntax**: *ok, err = cipher:init(key, iv?, opts?)*
 
 Initialize the cipher with key `key` and IV `iv`. The optional third argument is a table consists of:
 
@@ -471,7 +471,7 @@ Module to interact with message digest (EVP_MD_CTX).
 Creates a digest instance. `digest_name` is a case-insensitive string of digest algorithm name.
 To view a list of digest algorithms implemented, use `openssl list -digest-algorithms`.
 
-If `digest_name` is omitted, it's by default to `sha1`.
+If `digest_name` is omitted, it's default to `sha1`.
 
 ### digest.istype
 
@@ -481,7 +481,7 @@ Returns `true` if table is an instance of `digest`. Returns `false` otherwise.
 
 ### digest:update
 
-**syntax**: *err = digest:update(partial, ...)*
+**syntax**: *ok, err = digest:update(partial, ...)*
 
 Updates the digest with one or more strings.
 
@@ -515,7 +515,7 @@ Module to interact with hash-based message authentication code (HMAC_CTX).
 Creates a hmac instance. `digest_name` is a case-insensitive string of digest algorithm name.
 To view a list of digest algorithms implemented, use `openssl list -digest-algorithms`.
 
-If `digest_name` is omitted, it's by default to `sha1`.
+If `digest_name` is omitted, it's default to `sha1`.
 
 ### hmac.istype
 
@@ -525,7 +525,7 @@ Returns `true` if table is an instance of `hmac`. Returns `false` otherwise.
 
 ### hmac:update
 
-**syntax**: *err = hmac:update(partial, ...)*
+**syntax**: *ok, err = hmac:update(partial, ...)*
 
 Updates the HMAC with one or more strings.
 
@@ -603,7 +603,7 @@ Returns a digest of the DER representation of the X509 certificate object in raw
 `digest_name` is a case-insensitive string of digest algorithm name.
 To view a list of digest algorithms implemented, use `openssl list -digest-algorithms`.
 
-If `digest_name` is omitted, it's by default to `sha1`.
+If `digest_name` is omitted, it's default to `sha1`.
 
 ### x509:pubkey_digest
 
@@ -614,7 +614,7 @@ Returns a digest of the DER representation of the pubkey in the X509 object in r
 `digest_name` is a case-insensitive string of digest algorithm name.
 To view a list of digest algorithms implemented, use `openssl list -digest-algorithms`.
 
-If `digest_name` is omitted, it's by default to `sha1`.
+If `digest_name` is omitted, it's default to `sha1`.
 
 ### x509:get_*, x509:set_*
 

lib/resty/openssl/cipher.lua

@@ -58,14 +58,14 @@ end
 function _M:init(key, iv, opts)
   opts = opts or {}
   if not key or #key ~= self.key_size then
-    return string.format("incorrect key size, expect %d", self.key_size)
+    return false, string.format("incorrect key size, expect %d", self.key_size)
   end
   if not iv or #iv ~= self.iv_size then
-    return string.format("incorrect iv size, expect %d", self.iv_size)
+    return false, string.format("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
-    return format_error("cipher:init")
+    return false, format_error("cipher:init")
   end
 
   if opts.no_padding then
@@ -74,10 +74,12 @@ function _M:init(key, iv, opts)
   end
 
   self.initialized = true
+
+  return true
 end
 
 function _M:encrypt(key, iv, s, no_padding)
-  local err = self:init(key, iv, {
+  local _, err = self:init(key, iv, {
     is_encrypt = true,
     no_padding = no_padding,
   })
@@ -88,7 +90,7 @@ function _M:encrypt(key, iv, s, no_padding)
 end
 
 function _M:decrypt(key, iv, s, no_padding)
-  local err = self:init(key, iv, {
+  local _, err = self:init(key, iv, {
     is_encrypt = false,
     no_padding = no_padding,
   })

lib/resty/openssl/digest.lua

@@ -50,17 +50,17 @@ end
 function _M:update(...)
   for _, s in ipairs({...}) do
     if C.EVP_DigestUpdate(self.ctx, s, #s) ~= 1 then
-      return format_error("digest:update")
+      return false, format_error("digest:update")
     end
   end
-  return nil
+  return true, nil
 end
 
 local uint_ptr = ffi.typeof("unsigned int[1]")
 
 function _M:final(s)
   if s then
-    local err = self:update(s)
+    local _, err = self:update(s)
     if err then
       return nil, err
     end

lib/resty/openssl/hmac.lua

@@ -52,17 +52,17 @@ end
 function _M:update(...)
   for _, s in ipairs({...}) do
     if C.HMAC_Update(self.ctx, s, #s) ~= 1 then
-      return format_error("hmac:update")
+      return false, format_error("hmac:update")
     end
   end
-  return nil
+  return true, nil
 end
 
 local uint_ptr = ffi.typeof("unsigned int[1]")
 
 function _M:final(s)
   if s then
-    local err = self:update(s)
+    local _, err = self:update(s)
     if err then
       return nil, err
     end

t/openssl/cipher.t

@@ -23,7 +23,7 @@ __DATA__
                 ngx.log(ngx.ERR, err)
                 return
             end
-            err = cipher:init(string.rep("0", 32), string.rep("0", 16), {
+            local ok, err = cipher:init(string.rep("0", 32), string.rep("0", 16), {
                 is_encrypt = true,
             })
             if err then
@@ -206,7 +206,7 @@ VhGyRCcMvlAgUjTYrqiWpg=="
                 ngx.log(ngx.ERR, err)
                 return
             end
-            local err = cipher:init(string.rep("0", 32), string.rep("0", 16), {
+            local ok, err = cipher:init(string.rep("0", 32), string.rep("0", 16), {
                 is_encrypt = true,
             })
             if err then
@@ -258,7 +258,7 @@ yP4vKOecDyao4AzxaTAzkA==
                 ngx.log(ngx.ERR, err)
                 return
             end
-            local err = cipher:init(string.rep("0", 32), string.rep("0", 16), {
+            local ok, err = cipher:init(string.rep("0", 32), string.rep("0", 16), {
                 is_encrypt = false,
             })
             if err then

t/openssl/pkey.t

@@ -196,7 +196,7 @@ AQAB
                 ngx.log(ngx.ERR, err)
                 return
             end
-            err = digest:update("🕶️", "+1s")
+            local _, err = digest:update("🕶️", "+1s")
             if err then
                 ngx.log(ngx.ERR, err)
                 return