util.openssl: Rename variables for readability
[prosody.git] / util / openssl.lua
1 local type, tostring, pairs, ipairs = type, tostring, pairs, ipairs;
2 local t_insert, t_concat = table.insert, table.concat;
3 local s_format = string.format;
4
5 local oid_xmppaddr = "1.3.6.1.5.5.7.8.5"; -- [XMPP-CORE]
6 local oid_dnssrv   = "1.3.6.1.5.5.7.8.7"; -- [SRV-ID]
7
8 local idna_to_ascii = require "util.encodings".idna.to_ascii;
9
10 local _M = {};
11 local config = {};
12 _M.config = config;
13
14 local ssl_config = {};
15 local ssl_config_mt = {__index=ssl_config};
16
17 function config.new()
18         return setmetatable({
19                 req = {
20                         distinguished_name = "distinguished_name",
21                         req_extensions = "certrequest",
22                         x509_extensions = "selfsigned",
23                         prompt = "no",
24                 },
25                 distinguished_name = {
26                         countryName = "GB",
27                         -- stateOrProvinceName = "",
28                         localityName = "The Internet",
29                         organizationName = "Your Organisation",
30                         organizationalUnitName = "XMPP Department",
31                         commonName = "example.com",
32                         emailAddress = "xmpp@example.com",
33                 },
34                 certrequest = {
35                         basicConstraints = "CA:FALSE",
36                         keyUsage = "digitalSignature,keyEncipherment",
37                         extendedKeyUsage = "serverAuth,clientAuth",
38                         subjectAltName = "@subject_alternative_name",
39                 },
40                 selfsigned = {
41                         basicConstraints = "CA:TRUE",
42                         subjectAltName = "@subject_alternative_name",
43                 },
44                 subject_alternative_name = {
45                         DNS = {},
46                         otherName = {},
47                 },
48         }, ssl_config_mt);
49 end
50
51 local DN_order = {
52         "countryName";
53         "stateOrProvinceName";
54         "localityName";
55         "streetAddress";
56         "organizationName";
57         "organizationalUnitName";
58         "commonName";
59         "emailAddress";
60 }
61 _M._DN_order = DN_order;
62 function ssl_config:serialize()
63         local s = "";
64         for k, t in pairs(self) do
65                 s = s .. ("[%s]\n"):format(k);
66                 if k == "subject_alternative_name" then
67                         for san, n in pairs(t) do
68                                 for i = 1,#n do
69                                         s = s .. s_format("%s.%d = %s\n", san, i -1, n[i]);
70                                 end
71                         end
72                 elseif k == "distinguished_name" then
73                         for i=1,#DN_order do
74                                 local k = DN_order[i]
75                                 local v = t[k];
76                                 if v then
77                                         s = s .. ("%s = %s\n"):format(k, v);
78                                 end
79                         end
80                 else
81                         for k, v in pairs(t) do
82                                 s = s .. ("%s = %s\n"):format(k, v);
83                         end
84                 end
85                 s = s .. "\n";
86         end
87         return s;
88 end
89
90 local function utf8string(s)
91         -- This is how we tell openssl not to encode UTF-8 strings as fake Latin1
92         return s_format("FORMAT:UTF8,UTF8:%s", s);
93 end
94
95 local function ia5string(s)
96         return s_format("IA5STRING:%s", s);
97 end
98
99 _M.util = {
100         utf8string = utf8string,
101         ia5string = ia5string,
102 };
103
104 function ssl_config:add_dNSName(host)
105         t_insert(self.subject_alternative_name.DNS, idna_to_ascii(host));
106 end
107
108 function ssl_config:add_sRVName(host, service)
109         t_insert(self.subject_alternative_name.otherName,
110                 s_format("%s;%s", oid_dnssrv, ia5string("_" .. service .."." .. idna_to_ascii(host))));
111 end
112
113 function ssl_config:add_xmppAddr(host)
114         t_insert(self.subject_alternative_name.otherName,
115                 s_format("%s;%s", oid_xmppaddr, utf8string(host)));
116 end
117
118 function ssl_config:from_prosody(hosts, config, certhosts)
119         -- TODO Decide if this should go elsewhere
120         local found_matching_hosts = false;
121         for i = 1,#certhosts do
122                 local certhost = certhosts[i];
123                 for name in pairs(hosts) do
124                         if name == certhost or name:sub(-1-#certhost) == "."..certhost then
125                                 found_matching_hosts = true;
126                                 self:add_dNSName(name);
127                                 --print(name .. "#component_module: " .. (config.get(name, "component_module") or "nil"));
128                                 if config.get(name, "component_module") == nil then
129                                         self:add_sRVName(name, "xmpp-client");
130                                 end
131                                 --print(name .. "#anonymous_login: " .. tostring(config.get(name, "anonymous_login")));
132                                 if not (config.get(name, "anonymous_login") or
133                                                 config.get(name, "authentication") == "anonymous") then
134                                         self:add_sRVName(name, "xmpp-server");
135                                 end
136                                 self:add_xmppAddr(name);
137                         end
138                 end
139         end
140         if not found_matching_hosts then
141                 return nil, "no-matching-hosts";
142         end
143 end
144
145 do -- Lua to shell calls.
146         local function shell_escape(s)
147                 return "'" .. tostring(s):gsub("'",[['\'']]) .. "'";
148         end
149
150         local function serialize(command, args)
151                 local commandline = { "openssl", command };
152                 for k, v in pairs(args) do
153                         if type(k) == "string" then
154                                 t_insert(commandline, ("-%s"):format(k));
155                                 if v ~= true then
156                                         t_insert(commandline, shell_escape(v));
157                                 end
158                         end
159                 end
160                 for _, v in ipairs(args) do
161                         t_insert(commandline, shell_escape(v));
162                 end
163                 return t_concat(commandline, " ");
164         end
165
166         local os_execute = os.execute;
167         setmetatable(_M, {
168                 __index=function(_,f)
169                         return function(opts)
170                                 return 0 == os_execute(serialize(command, type(opts) == "table" and opts or {}));
171                         end;
172                 end;
173         });
174 end
175
176 return _M;