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