[Project] Add DKIM FFI interface

3 files changed, 233 insertions, 0 deletions

diff --git a/lualib/lua_ffi/common.lua b/lualib/lua_ffi/common.lua
new file mode 100644
index 000000000..15569c4fe
--- /dev/null
+++ b/lualib/lua_ffi/common.lua
@@ -0,0 +1,32 @@
+--[[
+Copyright (c) 2019, Vsevolod Stakhov <vsevolod@highsecure.ru>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+]]--
+
+--[[[
+-- @module lua_ffi/common
+-- Common ffi definitions
+--]]
+
+local ffi = require 'ffi'
+
+ffi.cdef[[
+struct GString {
+  char  *str;
+  size_t len;
+  size_t allocated_len;
+};
+
+void g_string_free (struct GString *st, int free_data);
+]]
\ No newline at end of file
diff --git a/lualib/lua_ffi/dkim.lua b/lualib/lua_ffi/dkim.lua
new file mode 100644
index 000000000..1e8022f7e
--- /dev/null
+++ b/lualib/lua_ffi/dkim.lua
@@ -0,0 +1,150 @@
+--[[
+Copyright (c) 2019, Vsevolod Stakhov <vsevolod@highsecure.ru>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+]]--
+
+--[[[
+-- @module lua_ffi/dkim
+-- This module contains ffi interfaces to DKIM
+--]]
+
+local ffi = require 'ffi'
+
+ffi.cdef[[
+struct rspamd_dkim_sign_context_s;
+struct rspamd_dkim_key_s;
+struct rspamd_task;
+enum rspamd_dkim_key_format {
+  RSPAMD_DKIM_KEY_FILE = 0,
+  RSPAMD_DKIM_KEY_PEM,
+  RSPAMD_DKIM_KEY_BASE64,
+  RSPAMD_DKIM_KEY_RAW,
+};
+enum rspamd_sign_type {
+  DKIM_SIGN_RSASHA1 = 0,
+  DKIM_SIGN_RSASHA256,
+  DKIM_SIGN_RSASHA512,
+  DKIM_SIGN_ECDSASHA256,
+  DKIM_SIGN_ECDSASHA512,
+  DKIM_SIGN_EDDSASHA256,
+};
+enum rspamd_dkim_key_type {
+  RSPAMD_DKIM_KEY_RSA = 0,
+  RSPAMD_DKIM_KEY_ECDSA,
+  RSPAMD_DKIM_KEY_EDDSA
+};
+struct rspamd_dkim_sign_context_s*
+rspamd_create_dkim_sign_context (struct rspamd_task *task,
+    struct rspamd_dkim_key_s *priv_key,
+    int headers_canon,
+    int body_canon,
+    const char *dkim_headers,
+    enum rspamd_dkim_type type,
+    void *unused);
+struct rspamd_dkim_key_s* rspamd_dkim_sign_key_load (const char *what, size_t len,
+    enum rspamd_dkim_key_format type,
+    void *err);
+void rspamd_dkim_key_unref (struct rspamd_dkim_key_s *k);
+struct GString *rspamd_dkim_sign (struct rspamd_task *task,
+    const char *selector,
+    const char *domain,
+    unsigned long expire,
+    size_t len,
+    unsigned int idx,
+    const char *arc_cv,
+    struct rspamd_dkim_sign_context_s *ctx);
+]]
+
+local function load_sign_key(what, format)
+  if not format then
+    format = ffi.C.RSPAMD_DKIM_KEY_PEM
+  else
+    if format == 'file' then
+      format = ffi.C.RSPAMD_DKIM_KEY_FILE
+    elseif format == 'base64' then
+      format = ffi.C.RSPAMD_DKIM_KEY_BASE64
+    elseif format == 'base64' then
+      format = ffi.C.RSPAMD_DKIM_KEY_RAW
+    else
+      return nil,'unknown key format'
+    end
+  end
+
+  return ffi.C.rspamd_dkim_sign_key_load(what, #what, format, nil)
+end
+
+local default_dkim_headers =
+"(o)from:(o)sender:(o)reply-to:(o)subject:(o)date:(o)message-id:" ..
+"(o)to:(o)cc:(o)mime-version:(o)content-type:(o)content-transfer-encoding:" ..
+"resent-to:resent-cc:resent-from:resent-sender:resent-message-id:" ..
+"(o)in-reply-to:(o)references:list-id:list-owner:list-unsubscribe:" ..
+"list-subscribe:list-post"
+
+local function create_sign_context(task, privkey, dkim_headers, sign_type)
+  if not task or not privkey then
+    return nil,'invalid arguments'
+  end
+
+  if not dkim_headers then
+    dkim_headers = default_dkim_headers
+  end
+
+  if not sign_type then
+    sign_type = 'rsa-sha-256'
+  end
+
+  if sign_type == 'rsa-sha256' then
+    sign_type = ffi.C.DKIM_SIGN_RSASHA256
+  elseif sign_type == 'rsa-sha1' then
+    sign_type = ffi.C.DKIM_SIGN_RSASHA1
+  elseif sign_type == 'rsa-sha512' then
+    sign_type = ffi.C.DKIM_SIGN_RSASHA512
+  elseif sign_type == 'eddsa' or sign_type == 'eddsa-sha256' then
+    sign_type = ffi.C.DKIM_SIGN_EDDSASHA256
+  else
+    return nil,'invalid sign type'
+  end
+
+
+  return ffi.C.rspamd_create_dkim_sign_context(task, privkey,
+      1, 1, dkim_headers, sign_type, nil)
+end
+
+local function do_sign(task, sign_context, selector, domain,
+                       expire, len, arc_idx)
+  if not task or not sign_context or not selector or not domain then
+    return nil,'invalid arguments'
+  end
+
+  if not expire then expire = 0 end
+  if not len then len = 0 end
+  if not arc_idx then arc_idx = 0 end
+
+  local gstring = ffi.C.rspamd_dkim_sign(task, selector, domain, expire, len, arc_idx, nil, sign_context)
+
+  if not gstring then
+    return nil,'cannot sign'
+  end
+
+  local ret = ffi.string(gstring.str, gstring.len)
+  ffi.C.g_string_free(gstring, true)
+
+  return ret
+end
+
+return {
+  load_sign_key = load_sign_key,
+  create_sign_context = create_sign_context,
+  do_sign = do_sign
+}
\ No newline at end of file
diff --git a/lualib/lua_ffi/init.lua b/lualib/lua_ffi/init.lua
new file mode 100644
index 000000000..657bad370
--- /dev/null
+++ b/lualib/lua_ffi/init.lua
@@ -0,0 +1,51 @@
+--[[
+Copyright (c) 2019, Vsevolod Stakhov <vsevolod@highsecure.ru>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+]]--
+
+--[[[
+-- @module lua_ffi
+-- This module contains ffi interfaces (requires luajit or lua-ffi)
+--]]
+
+local ffi
+
+local exports = {}
+
+if type(jit) == 'table' then
+  ffi = require "jit"
+  local NULL = ffi.new 'void*'
+
+  exports.is_null = function(o)
+    return o ~= NULL
+  end
+else
+  local ret,result_or_err = pcall(require, 'ffi')
+
+  if not ret then
+    io.stderr:write('FFI support is required: please use LuaJIT or install lua-ffi')
+    os.exit(1)
+  end
+
+  ffi = result_or_err
+  -- Lua ffi
+  local NULL = ffi.NULL or ffi.C.NULL
+  exports.is_null = function(o)
+    return o ~= NULL
+  end
+end
+
+exports.dkim = require "lua_ffi/dkim"
+
+return exports
\ No newline at end of file