2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 local configmanager = require "core.configmanager";
10 local log = require "util.logger".init("certmanager");
12 local ssl_newcontext = ssl and ssl.newcontext;
14 local tostring = tostring;
17 local io_open = io.open;
18 local t_concat = table.concat;
20 local prosody = prosody;
21 local resolve_path = configmanager.resolve_relative_path;
22 local config_path = prosody.paths.config;
24 local luasec_has_noticket, luasec_has_verifyext, luasec_has_no_compression;
26 local luasec_major, luasec_minor = ssl._VERSION:match("^(%d+)%.(%d+)");
27 luasec_has_noticket = tonumber(luasec_major)>0 or tonumber(luasec_minor)>=4;
28 luasec_has_verifyext = tonumber(luasec_major)>0 or tonumber(luasec_minor)>=5;
29 luasec_has_no_compression = tonumber(luasec_major)>0 or tonumber(luasec_minor)>=5;
34 -- Global SSL options if not overridden per-host
35 local global_ssl_config = configmanager.get("*", "ssl");
38 local core_defaults = {
39 capath = "/etc/ssl/certs";
41 verify = (ssl and ssl.x509 and { "peer", "client_once", }) or "none";
43 cipher_server_preference = true;
44 no_ticket = luasec_has_noticket;
45 no_compression = luasec_has_no_compression and configmanager.get("*", "ssl_compression") ~= true;
46 -- Has no_compression? Then it has these too...
47 single_dh_use = luasec_has_no_compression;
48 single_ecdh_use = luasec_has_no_compression;
50 verifyext = { "lsec_continue", "lsec_ignore_purpose" };
52 ciphers = "HIGH+kEDH:HIGH+kEECDH:HIGH:!PSK:!SRP:!3DES:!aNULL";
54 local path_options = { -- These we pass through resolve_path()
55 key = true, certificate = true, cafile = true, capath = true, dhparam = true
58 options = true, verify = true, verifyext = true
61 if ssl and not luasec_has_verifyext and ssl.x509 then
62 -- COMPAT mw/luasec-hg
63 for i=1,#core_defaults.verifyext do -- Remove lsec_ prefix
64 core_defaults.verify[#core_defaults.verify+1] = core_defaults.verifyext[i]:sub(6);
68 local function merge_set(t, o)
69 if type(t) ~= "table" then t = { t } end
70 for k,v in pairs(t) do
71 if v == true or v == false then
80 local protocols = { "sslv2", "sslv3", "tlsv1", "tlsv1_1", "tlsv1_2" };
81 for i = 1, #protocols do protocols[protocols[i] .. "+"] = i - 1; end
83 function create_context(host, mode, user_ssl_config)
84 user_ssl_config = user_ssl_config or {}
85 user_ssl_config.mode = mode;
87 if not ssl then return nil, "LuaSec (required for encryption) was not found"; end
89 if global_ssl_config then
90 for option,default_value in pairs(global_ssl_config) do
91 if user_ssl_config[option] == nil then
92 user_ssl_config[option] = default_value;
97 for option,default_value in pairs(core_defaults) do
98 if user_ssl_config[option] == nil then
99 user_ssl_config[option] = default_value;
103 local min_protocol = protocols[user_ssl_config.protocol];
105 user_ssl_config.protocol = "sslv23";
106 for i = min_protocol, 1, -1 do
107 user_ssl_config.options["no_"..protocols[i]] = true;
111 for option in pairs(set_options) do
113 merge_set(core_defaults[option], merged);
114 if global_ssl_config then
115 merge_set(global_ssl_config[option], merged);
117 merge_set(user_ssl_config[option], merged);
118 local final_array = {};
119 for opt, enable in pairs(merged) do
121 final_array[#final_array+1] = opt;
124 user_ssl_config[option] = final_array;
127 -- We can't read the password interactively when daemonized
128 user_ssl_config.password = user_ssl_config.password or
129 function() log("error", "Encrypted certificate for %s requires 'ssl' 'password' to be set in config", host); end;
131 for option in pairs(path_options) do
132 if type(user_ssl_config[option]) == "string" then
133 user_ssl_config[option] = resolve_path(config_path, user_ssl_config[option]);
137 -- Allow the cipher list to be a table
138 if type(user_ssl_config.ciphers) == "table" then
139 user_ssl_config.ciphers = t_concat(user_ssl_config.ciphers, ":")
142 if mode == "server" then
143 if not user_ssl_config.key then return nil, "No key present in SSL/TLS configuration for "..host; end
144 if not user_ssl_config.certificate then return nil, "No certificate present in SSL/TLS configuration for "..host; end
147 -- LuaSec expects dhparam to be a callback that takes two arguments.
148 -- We ignore those because it is mostly used for having a separate
149 -- set of params for EXPORT ciphers, which we don't have by default.
150 if type(user_ssl_config.dhparam) == "string" then
151 local f, err = io_open(user_ssl_config.dhparam);
152 if not f then return nil, "Could not open DH parameters: "..err end
153 local dhparam = f:read("*a");
155 user_ssl_config.dhparam = function() return dhparam; end
158 local ctx, err = ssl_newcontext(user_ssl_config);
160 -- COMPAT Older LuaSec ignores the cipher list from the config, so we have to take care
161 -- of it ourselves (W/A for #x)
162 if ctx and user_ssl_config.ciphers then
164 success, err = ssl.context.setcipher(ctx, user_ssl_config.ciphers);
165 if not success then ctx = nil; end
169 err = err or "invalid ssl config"
170 local file = err:match("^error loading (.-) %(");
172 if file == "private key" then
173 file = user_ssl_config.key or "your private key";
174 elseif file == "certificate" then
175 file = user_ssl_config.certificate or "your certificate file";
177 local reason = err:match("%((.+)%)$") or "some reason";
178 if reason == "Permission denied" then
179 reason = "Check that the permissions allow Prosody to read this file.";
180 elseif reason == "No such file or directory" then
181 reason = "Check that the path is correct, and the file exists.";
182 elseif reason == "system lib" then
183 reason = "Previous error (see logs), or other system error.";
184 elseif reason == "(null)" or not reason then
185 reason = "Check that the file exists and the permissions are correct";
187 reason = "Reason: "..tostring(reason):lower();
189 log("error", "SSL/TLS: Failed to load '%s': %s (for %s)", file, reason, host);
191 log("error", "SSL/TLS: Error initialising for %s: %s", host, err);
197 function reload_ssl_config()
198 global_ssl_config = configmanager.get("*", "ssl");
199 if luasec_has_no_compression then
200 core_defaults.options.no_compression = configmanager.get("*", "ssl_compression") ~= true;
204 prosody.events.add_handler("config-reloaded", reload_ssl_config);