luci-app-shadowsocks-libev: add common flag ipv6_first
[project/luci.git] / applications / luci-app-shadowsocks-libev / luasrc / model / shadowsocks-libev.lua
1 -- Copyright 2017 Yousong Zhou <yszhou4tech@gmail.com>
2 -- Licensed to the public under the Apache License 2.0.
3
4 local _up = getfenv(3)
5 local ut = require("luci.util")
6 local ds = require("luci.dispatcher")
7 local nw = require("luci.model.network")
8 nw.init()
9 module("luci.model.shadowsocks-libev", function(m)
10         setmetatable(m, {__index=function (self, k)
11                 local tb = _up
12                 return rawget(self, k) or _up[k]
13         end})
14 end)
15
16 function values_actions(o)
17         for _, a in ipairs(actions) do
18                 o:value(a)
19         end
20 end
21
22 function values_redir(o, xmode)
23         o.map.uci.foreach("shadowsocks-libev", "ss_redir", function(sdata)
24                 local sname = sdata[".name"]
25                 local mode = sdata["mode"]
26                 if mode and mode:find(xmode) then
27                         local desc = "%s - %s" % {sname, mode}
28                         o:value(sname, desc)
29                 end
30         end)
31 end
32
33 function values_serverlist(o)
34         o.map.uci.foreach("shadowsocks-libev", "server", function(sdata)
35                 local sname = sdata[".name"]
36                 local server = sdata["server"]
37                 local server_port = sdata["server_port"]
38                 if server and server_port then
39                         local desc = "%s - %s:%s" % {sname, sdata["server"], sdata["server_port"]}
40                         o:value(sname, desc)
41                 end
42         end)
43 end
44
45 function values_ipaddr(o)
46         local keys, vals = {}, {}
47         for _, v in ipairs(nw:get_interfaces()) do
48                 for _, a in ipairs(v:ipaddrs()) do
49                         o:value(a:host():string(), '%s (%s)' %{ a:host(), v:shortname() })
50                 end
51         end
52 end
53
54 function options_client(s, tab)
55         local o
56
57         o = s:taboption(tab, ListValue, "server", translate("Remote server"))
58         values_serverlist(o)
59         o = s:taboption(tab, Value, "local_address", translate("Local address"))
60         o.datatype = "ipaddr"
61         o.placeholder = "0.0.0.0"
62         values_ipaddr(o)
63         o = s:taboption(tab, Value, "local_port", translate("Local port"))
64         o.datatype = "port"
65 end
66
67 function options_server(s, tab)
68         local o
69         local optfunc
70
71         if tab == nil then
72                 optfunc = function(...) return s:option(...) end
73         else
74                 optfunc = function(...) return s:taboption(tab, ...) end
75         end
76
77         o = optfunc(Value, "server", translate("Server"))
78         o.datatype = "host"
79         o.size = 16
80         o = optfunc(Value, "server_port", translate("Server port"))
81         o.datatype = "port"
82         o.size = 5
83         o = optfunc(ListValue, "method", translate("Method"))
84         for _, m in ipairs(methods) do
85                 o:value(m)
86         end
87         o = optfunc(Value, "key", translate("Key (base64 encoding)"))
88         o.datatype = "base64"
89         o.password = true
90         o.size = 12
91         o = optfunc(Value, "password", translate("Password"))
92         o.password = true
93         o.size = 12
94 end
95
96 function options_common(s, tab)
97         local o
98
99         o = s:taboption(tab, ListValue, "mode", translate("Mode of operation"))
100         for _, m in ipairs(modes) do
101                 o:value(m)
102         end
103         o.default = "tcp_and_udp"
104         o = s:taboption(tab, Value, "mtu", translate("MTU"))
105         o.datatype = "uinteger"
106         o = s:taboption(tab, Value, "timeout", translate("Timeout (sec)"))
107         o.datatype = "uinteger"
108         s:taboption(tab, Value, "user", translate("Run as"))
109
110         s:taboption(tab, Flag, "verbose", translate("Verbose"))
111         s:taboption(tab, Flag, "ipv6_first", translate("IPv6 First"), translate("Prefer IPv6 addresses when resolving names"))
112         s:taboption(tab, Flag, "fast_open", translate("Enable TCP Fast Open"))
113         s:taboption(tab, Flag, "reuse_port", translate("Enable SO_REUSEPORT"))
114 end
115
116 function ucival_to_bool(val)
117         return val == "true" or val == "1" or val == "yes" or val == "on"
118 end
119
120 function cfgvalue_overview(sdata)
121         local stype = sdata[".type"]
122         local lines  = {}
123
124         if stype == "ss_server" then
125                 cfgvalue_overview_(sdata, lines, names_options_server)
126                 cfgvalue_overview_(sdata, lines, names_options_common)
127                 cfgvalue_overview_(sdata, lines, {
128                         "bind_address",
129                         "manager_address",
130                 })
131         elseif stype == "ss_local" or stype == "ss_redir" or stype == "ss_tunnel" then
132                 cfgvalue_overview_(sdata, lines, names_options_client)
133                 if stype == "ss_tunnel" then
134                         cfgvalue_overview_(sdata, lines, {"tunnel_address"})
135                 end
136                 cfgvalue_overview_(sdata, lines, names_options_common)
137         else
138                 return nil, nil
139         end
140         local sname = sdata[".name"]
141         local key = "%s.%s" % {stype, sname}
142         local value = {
143                 [".name"] = sname,
144                 name = '%s.<var>%s</var>' % {stype, sname},
145                 overview = table.concat(lines, "</br>"),
146                 disabled = ucival_to_bool(sdata["disabled"]),
147         }
148         return key, value
149 end
150
151 function cfgvalue_overview_(sdata, lines, names)
152         local line
153
154         for _, n in ipairs(names) do
155                 local v = sdata[n]
156                 if v ~= nil then
157                         local fv = "<var>%s</var>" % ut.pcdata(v)
158                         if sdata[".type"] ~= "ss_server" and n == "server" then
159                                 fv = '<a class="label" href="%s">%s</a>' % {
160                                         ds.build_url("admin/services/shadowsocks-libev/servers", v), fv}
161                         end
162                         line = n .. ": " .. fv
163                         table.insert(lines, line)
164                 end
165         end
166 end
167
168 function option_install_package(s, tab)
169         local bin = s.sectiontype:gsub("_", "-", 1)
170         local installed = nixio.fs.access("/usr/bin/" .. bin)
171         if installed then
172                 return
173         end
174         local opkg_package = "shadowsocks-libev-" .. bin
175         local p_install
176         if tab then
177                 p_install = s:taboption(tab, Button, "_install")
178         else
179                 p_install = s:option(Button, "_install")
180         end
181         p_install.title      = translate("Package is not installed")
182         p_install.inputtitle = translate("Install package %q" % opkg_package)
183         p_install.inputstyle = "apply"
184
185         function p_install.write()
186                 return luci.http.redirect(
187                         luci.dispatcher.build_url("admin/system/packages") ..
188                         "?submit=1&install=%s" % opkg_package
189                 )
190         end
191 end
192
193 names_options_server = {
194         "server",
195         "server_port",
196         "method",
197         "key",
198         "password",
199 }
200
201 names_options_client = {
202         "server",
203         "local_address",
204         "local_port",
205 }
206
207 names_options_common = {
208         "verbose",
209         "ipv6_first",
210         "fast_open",
211         "reuse_port",
212         "mode",
213         "mtu",
214         "timeout",
215         "user",
216 }
217
218 modes = {
219         "tcp_only",
220         "tcp_and_udp",
221         "udp_only",
222 }
223
224 actions = {
225         "bypass",
226         "forward",
227         "checkdst",
228 }
229
230 methods = {
231         -- aead
232         "aes-128-gcm",
233         "aes-192-gcm",
234         "aes-256-gcm",
235         -- stream
236         "table",
237         "rc4",
238         "rc4-md5",
239         "aes-128-cfb",
240         "aes-192-cfb",
241         "aes-256-cfb",
242         "aes-128-ctr",
243         "aes-192-ctr",
244         "aes-256-ctr",
245         "bf-cfb",
246         "camellia-128-cfb",
247         "camellia-192-cfb",
248         "camellia-256-cfb",
249         "salsa20",
250         "chacha20",
251         "chacha20-ietf",
252 }