From 227e51b9cfcd754b1dcd3bbfd1db2bb35d189be0 Mon Sep 17 00:00:00 2001 From: Alexander Sulfrian Date: Thu, 16 Feb 2023 17:06:45 +0100 Subject: [PATCH 01/23] SMTP: Support disabling encryption (#297) --- README.md | 2 +- emailer/smtp.go | 2 ++ main.go | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 598a994..a946f80 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Note: | `SMTP_USERNAME` | The SMTP username | N/A | | `SMTP_PASSWORD` | The SMTP user password | N/A | | `SMTP_AUTH_TYPE` | The SMTP authentication type. Possible values: `PLAIN`, `LOGIN`, `NONE` | `NONE` | -| `SMTP_ENCRYPTION` | the encryption method. Possible values: `SSL`, `SSLTLS`, `TLS`, `STARTTLS` | `STARTTLS` | +| `SMTP_ENCRYPTION` | the encryption method. Possible values: `NONE`, `SSL`, `SSLTLS`, `TLS`, `STARTTLS` | `STARTTLS` | ### Defaults for server configuration diff --git a/emailer/smtp.go b/emailer/smtp.go index d1fdbae..f77db7c 100644 --- a/emailer/smtp.go +++ b/emailer/smtp.go @@ -33,6 +33,8 @@ func authType(authType string) mail.AuthType { func encryptionType(encryptionType string) mail.Encryption { switch strings.ToUpper(encryptionType) { + case "NONE": + return mail.EncryptionNone case "SSL": return mail.EncryptionSSL case "SSLTLS": diff --git a/main.go b/main.go index 3f0cd13..98a0e7c 100644 --- a/main.go +++ b/main.go @@ -61,7 +61,7 @@ func init() { flag.StringVar(&flagSmtpUsername, "smtp-username", util.LookupEnvOrString("SMTP_USERNAME", flagSmtpUsername), "SMTP Username") flag.StringVar(&flagSmtpPassword, "smtp-password", util.LookupEnvOrString("SMTP_PASSWORD", flagSmtpPassword), "SMTP Password") flag.BoolVar(&flagSmtpNoTLSCheck, "smtp-no-tls-check", util.LookupEnvOrBool("SMTP_NO_TLS_CHECK", flagSmtpNoTLSCheck), "Disable TLS verification for SMTP. This is potentially dangerous.") - flag.StringVar(&flagSmtpEncryption, "smtp-encryption", util.LookupEnvOrString("SMTP_ENCRYPTION", flagSmtpEncryption), "SMTP Encryption : SSL, SSLTLS, TLS or STARTTLS (by default)") + flag.StringVar(&flagSmtpEncryption, "smtp-encryption", util.LookupEnvOrString("SMTP_ENCRYPTION", flagSmtpEncryption), "SMTP Encryption : NONE, SSL, SSLTLS, TLS or STARTTLS (by default)") flag.StringVar(&flagSmtpAuthType, "smtp-auth-type", util.LookupEnvOrString("SMTP_AUTH_TYPE", flagSmtpAuthType), "SMTP Auth Type : PLAIN, LOGIN or NONE.") flag.StringVar(&flagSendgridApiKey, "sendgrid-api-key", util.LookupEnvOrString("SENDGRID_API_KEY", flagSendgridApiKey), "Your sendgrid api key.") flag.StringVar(&flagEmailFrom, "email-from", util.LookupEnvOrString("EMAIL_FROM_ADDRESS", flagEmailFrom), "'From' email address.") From ccffe4028aa84f2c2ce9d4e97f2711f2060fe638 Mon Sep 17 00:00:00 2001 From: Arminas Date: Thu, 16 Feb 2023 18:08:26 +0200 Subject: [PATCH 02/23] Qr code filename fix (#290) --- templates/clients.html | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/templates/clients.html b/templates/clients.html index 689c261..04fb790 100644 --- a/templates/clients.html +++ b/templates/clients.html @@ -70,7 +70,9 @@ Wireguard Clients
- QR code + + QR code +
@@ -391,6 +393,7 @@ Wireguard Clients function regenerateQRCode() { const client_id = $("#qr_client_id").val(); const QRCodeImg = $("#qr_code"); + const QRCodeA = $("#qr_code_a"); let include_fwmark = false; if ($("#qr_include_fwmark").is(':checked')){ include_fwmark = true; @@ -410,6 +413,8 @@ Wireguard Clients $(".modal-title").text("Scan QR Code for " + client.name + " profile"); QRCodeImg.attr('src', resp.QRCode).show(); + QRCodeA.attr('download', resp.Client.name); + QRCodeA.attr('href', resp.QRCode).show(); }, error: function (jqXHR, exception) { const responseJson = jQuery.parseJSON(jqXHR.responseText); From a866977cb007e3dae1a438da144c6870c174a2fe Mon Sep 17 00:00:00 2001 From: ByteDream <63594396+ByteDream@users.noreply.github.com> Date: Thu, 16 Feb 2023 17:09:24 +0100 Subject: [PATCH 03/23] Add favicon (#288) --- README.md | 1 + custom/img/favicon.ico | Bin 0 -> 17014 bytes handler/routes.go | 10 ++++++++++ main.go | 1 + templates/base.html | 2 ++ templates/login.html | 2 ++ util/config.go | 1 + 7 files changed, 17 insertions(+) create mode 100644 custom/img/favicon.ico diff --git a/README.md b/README.md index a946f80..489314c 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ Note: | `WGUI_USERNAME` | The username for the login page. Used for db initialization only | `admin` | | `WGUI_PASSWORD` | The password for the user on the login page. Will be hashed automatically. Used for db initialization only | `admin` | | `WGUI_PASSWORD_HASH` | The password hash for the user on the login page. (alternative to `WGUI_PASSWORD`). Used for db initialization only | N/A | +| `WGUI_FAVICON_FILE_PATH` | The file path used as website favicon | Embedded WireGuard logo | | `WGUI_ENDPOINT_ADDRESS` | The default endpoint address used in global settings | Resolved to your public ip address | | `WGUI_DNS` | The default DNS servers (comma-separated-list) used in the global settings | `1.1.1.1` | | `WGUI_MTU` | The default MTU used in global settings | `1450` | diff --git a/custom/img/favicon.ico b/custom/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..7852f45fcd3f079ad11290ffe83b0d4bd5e65e0b GIT binary patch literal 17014 zcmeHOX^a$A5FWhatY?w;8ZR!~<_T=Dv$8;rMNMDaFWiQV}A@s8JFy0sY}YP&69FTTzrCuB->F>sNE^^z?M~G4xEg36S2Ic}Knas_NBy zRqu5oF$DkH+7kGiNnA5Fk&qIJ#G!allxW98<@tYYg^#%W)fI7^CL6OgSuE2e<1bm`rppjyzQXePpllF<_@Zrk0|=-ig|W8 z*o$(K#oA%RjQyg(5_C*W>o|($a9MvrbnVhs7H^O*3Cd3++Yby345@v-yI?Q+O-&LL z8;K|ASn%;Tdg&b)zJQGGft`$KYg@j{$dO{7v?NZ$8n{@M#5TA7=({P-^8gsWbmJfO zkF}~@dvbE6H4klmcB28=P2&1TS>B|Y$GGv0ea>7z{E=Ni&p&Xq;8#ENL#NSgpqH5} z&yrZ(($ce=U!GtC<2YKFBmXulbBFq+)u?vhYbD3CE}J(5<%9eLM^BT@bA!^WcYE07 zI*#93^aYHMa`bAE=l0+yKRrs$?&U@UHv0$1FZFlp>r|)9#@!q}T0fln)T<18@O^3C z!6sMXnWCy5wm?dFa%?(PgQWP<2U|u!rJ)U96{k5BT5eg#kF%sIqxoCNqDJH1d7e8!tp3-gZjy zA96{J#_4A~vVHPNt*u?V!Ukr0;UBEWyn!rcP~W`W%f?TGbvE6D?w_>I_~9ptHhNNw zhtFQEE7>;ix}3w|RE~cCKn~q_PSqtdOTVkyAvYWaF0V1kC+doEzh!OQT#$kIs0xEk zr%v^d!3xZ)Db6&>%?ukEN+J`e+`H~FHiJaKt9Ebk0|O3dtTA!i3@p4UCtg48@>-RS>xH> zK1a|$jxvCazu<`lF(EK7fj^sAiUHGd=P)`C!n(N_`t@}_02-Z9=$IRGxSW+7eRNrO zG=ICea|=x|C!qh7rlGS&lU-EprOI>${R+;4F5>uUbUDr`?{d|>BChq~32Xinv}VAE zJY6^^Lk!`7yHo~wZlt)#i*6(8VYe)=gvSpLlm|xJAM^OI57MRFc#5S>#(AkRE;7rVmd6u$4`=_$F*Z}Zv;dl&kK7qCU5*wY~WHQ$Z zoa~u#6uA$pJ}LGF&uolyurx=uws-rk%GvX5_({jhC|3aA;CL2<`ffLxji`hEzp?W@ z_*?B5?Ux74=Q{`cS$tnADUJosrA~Dy-#B4H&(40ws7E{KhR^jQe(^gd=K3mUjK%`D zd=mD>qx_Chk9KZ;n)H)VIx}A5Vh?n&6ZS%xcwdvVW4U@RhvGG6SoJ9-H-_UaUoMMJ znwmP3+<1k%A^aTy$naa51Kb$Mx8BOpZd5t;uWLE}isik)F_nB7&DWNed3#eFfPT-S z-Zj^QeoINm9Q`Qr|8}`z4qnOeXD|2ID_5-X)ED?C;pwu|Dg8!FdA*&VD1L*-?h;R- zePZsYs*wgg_B;vofzMOwAs^c7z@EPj3p?2f`4-4^2}=_(rPo_Yk z1I(G`DEJL~%;H^+X~6WG6(jo{wo%J{p|JT5lU^ocDzN#-S)RZxY0m@iTLu5_d~e7q544N*-R>Z=1oo-GQ+fI54|iqGjcMN;XWYaaopC{b?=jed*nz!m zZ=7-fc0JHpH|3~+oj)h2wDSsl`8b&JKn`u-6Z+`f#6D)6e&=(yEFPcOb3GmhR5i4)dZcqyEFIiGKpbWZ!lIOjTQ z!A*L^oOqFRTf*t|34iw~^nOAuW5lsf{=IMHd4Ovko{4xr^c3VrF30z0D)7^L;J6#| uf6Q}ma;JO{;h|g)VTS$}7X4x`KEHwtUd2409^`&FH`b2w9TKRQ1pWgWN|x6E literal 0 HcmV?d00001 diff --git a/handler/routes.go b/handler/routes.go index 3ddbb2d..18a7d17 100644 --- a/handler/routes.go +++ b/handler/routes.go @@ -6,6 +6,7 @@ import ( "encoding/json" "fmt" "net/http" + "os" "sort" "strings" "time" @@ -32,6 +33,15 @@ func Health() echo.HandlerFunc { } } +func Favicon() echo.HandlerFunc { + return func(c echo.Context) error { + if favicon, ok := os.LookupEnv(util.FaviconFilePathEnvVar); ok { + return c.File(favicon) + } + return c.Redirect(http.StatusFound, util.BasePath+"/static/custom/img/favicon.ico") + } +} + // LoginPage handler func LoginPage() echo.HandlerFunc { return func(c echo.Context) error { diff --git a/main.go b/main.go index 98a0e7c..683b5e8 100644 --- a/main.go +++ b/main.go @@ -148,6 +148,7 @@ func main() { } app.GET(util.BasePath+"/_health", handler.Health()) + app.GET(util.BasePath+"/favicon", handler.Favicon()) app.POST(util.BasePath+"/new-client", handler.NewClient(db), handler.ValidSession, handler.ContentTypeJson) app.POST(util.BasePath+"/update-client", handler.UpdateClient(db), handler.ValidSession, handler.ContentTypeJson) app.POST(util.BasePath+"/email-client", handler.EmailClient(db, sendmail, defaultEmailSubject, defaultEmailContent), handler.ValidSession, handler.ContentTypeJson) diff --git a/templates/base.html b/templates/base.html index fd337a7..0f5d686 100644 --- a/templates/base.html +++ b/templates/base.html @@ -8,6 +8,8 @@ {{template "title" .}} + + diff --git a/templates/login.html b/templates/login.html index c75aa39..515eb1a 100644 --- a/templates/login.html +++ b/templates/login.html @@ -7,6 +7,8 @@ WireGuard UI + + diff --git a/util/config.go b/util/config.go index 63044ca..7f5d221 100644 --- a/util/config.go +++ b/util/config.go @@ -34,6 +34,7 @@ const ( UsernameEnvVar = "WGUI_USERNAME" PasswordEnvVar = "WGUI_PASSWORD" PasswordHashEnvVar = "WGUI_PASSWORD_HASH" + FaviconFilePathEnvVar = "WGUI_FAVICON_FILE_PATH" EndpointAddressEnvVar = "WGUI_ENDPOINT_ADDRESS" DNSEnvVar = "WGUI_DNS" MTUEnvVar = "WGUI_MTU" From cc285c5c204cf3ff70f19f529d38ba8f2f315360 Mon Sep 17 00:00:00 2001 From: Arminas Date: Thu, 16 Feb 2023 18:10:11 +0200 Subject: [PATCH 04/23] Status show IP's (#291) --- handler/routes.go | 11 +++++++++++ templates/status.html | 6 +++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/handler/routes.go b/handler/routes.go index 18a7d17..cc66a66 100644 --- a/handler/routes.go +++ b/handler/routes.go @@ -617,6 +617,8 @@ func Status(db store.IStore) echo.HandlerFunc { LastHandshakeTime time.Time LastHandshakeRel time.Duration Connected bool + AllocatedIP string + Endpoint string } type DeviceVM struct { @@ -664,12 +666,21 @@ func Status(db store.IStore) echo.HandlerFunc { for i := range devices { devVm := DeviceVM{Name: devices[i].Name} for j := range devices[i].Peers { + var allocatedIPs string + for _, ip := range devices[i].Peers[j].AllowedIPs { + if len(allocatedIPs) > 0 { + allocatedIPs += "
" + } + allocatedIPs += ip.String() + } pVm := PeerVM{ PublicKey: devices[i].Peers[j].PublicKey.String(), ReceivedBytes: devices[i].Peers[j].ReceiveBytes, TransmitBytes: devices[i].Peers[j].TransmitBytes, LastHandshakeTime: devices[i].Peers[j].LastHandshakeTime, LastHandshakeRel: time.Since(devices[i].Peers[j].LastHandshakeTime), + AllocatedIP: allocatedIPs, + Endpoint: devices[i].Peers[j].Endpoint.String(), } pVm.Connected = pVm.LastHandshakeRel.Minutes() < 3. diff --git a/templates/status.html b/templates/status.html index b161646..a9b770b 100644 --- a/templates/status.html +++ b/templates/status.html @@ -41,6 +41,8 @@ Connected Peers # Name Email + Allocated IPs + Endpoint Public Key Received Transmitted @@ -54,6 +56,8 @@ Connected Peers {{ $idx }} {{ $peer.Name }} {{ $peer.Email }} + {{ $peer.AllocatedIP }} + {{ $peer.Endpoint }} {{ $peer.PublicKey }} @@ -68,4 +72,4 @@ Connected Peers {{end}} {{define "bottom_js"}} -{{end}} \ No newline at end of file +{{end}} From 40a0ba859ead51209fe32a21ffc4cbd17ccc8378 Mon Sep 17 00:00:00 2001 From: Arminas Date: Thu, 16 Feb 2023 18:17:10 +0200 Subject: [PATCH 05/23] Client search (#303) --- templates/base.html | 22 +++++++++++----------- templates/clients.html | 22 ++++++++++++++++++++++ 2 files changed, 33 insertions(+), 11 deletions(-) diff --git a/templates/base.html b/templates/base.html index 0f5d686..a2710e0 100644 --- a/templates/base.html +++ b/templates/base.html @@ -46,17 +46,17 @@ - - - - - - - - - - - +
diff --git a/templates/clients.html b/templates/clients.html index 04fb790..239e54e 100644 --- a/templates/clients.html +++ b/templates/clients.html @@ -252,6 +252,28 @@ Wireguard Clients populateClientList(); }) + // show search bar and override :contains to be case-insensitive + $(document).ready(function () { + $("#search-form").show(); + jQuery.expr[':'].contains = function(a, i, m) { + return jQuery(a).text().toUpperCase() + .indexOf(m[3].toUpperCase()) >= 0; + }; + }) + + // hide all clients and display only the ones that meet the search criteria (name, email, IP) + $('#search-input').keyup(function () { + var query = $(this).val(); + $('.col-lg-4').hide(); + $(".info-box-text").each(function() { + if($(this).children('i.fa-user').length > 0 || $(this).children('i.fa-envelope').length > 0) + { + $(this).filter(':contains("' + query + '")').parent().parent().parent().show(); + } + }) + $(".badge-secondary").filter(':contains("' + query + '")').parent().parent().parent().show(); + }) + // modal_pause_client modal event $("#modal_pause_client").on('show.bs.modal', function (event) { const button = $(event.relatedTarget); From 64b8eba0928708cbb943b366ccad42cd1681c24e Mon Sep 17 00:00:00 2001 From: Nathan Aclander <5856032+naclander@users.noreply.github.com> Date: Thu, 16 Feb 2023 08:24:23 -0800 Subject: [PATCH 06/23] Match MTU value between settings and documentation (#298) Under Global Settings, the MTU value on the left is by default set to 1450, but the documentation claims 1420. This updates the documentation to match the correct default value. --- templates/global_settings.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/global_settings.html b/templates/global_settings.html index e013349..8a41d1f 100644 --- a/templates/global_settings.html +++ b/templates/global_settings.html @@ -91,7 +91,7 @@ Global Settings
2. DNS Servers
The DNS servers will be set to client config.
3. MTU
-
The MTU will be set to server and client config. By default it is 1420. You might want +
The MTU will be set to server and client config. By default it is 1450. You might want to adjust the MTU size if your connection (e.g PPPoE, 3G, satellite network, etc) has a low MTU.
Leave blank to omit this setting in the configs.
4. Persistent Keepalive
From aadf099f5045fcff529d5063084300388b6bd444 Mon Sep 17 00:00:00 2001 From: Arminas Date: Thu, 16 Feb 2023 18:31:24 +0200 Subject: [PATCH 07/23] About page (#296) --- handler/routes.go | 10 ++++ main.go | 1 + router/router.go | 6 ++ templates/about.html | 139 +++++++++++++++++++++++++++++++++++++++++++ templates/base.html | 13 +++- 5 files changed, 167 insertions(+), 2 deletions(-) create mode 100644 templates/about.html diff --git a/handler/routes.go b/handler/routes.go index cc66a66..04f3208 100644 --- a/handler/routes.go +++ b/handler/routes.go @@ -829,3 +829,13 @@ func ApplyServerConfig(db store.IStore, tmplBox *rice.Box) echo.HandlerFunc { return c.JSON(http.StatusOK, jsonHTTPResponse{true, "Applied server config successfully"}) } } + +// AboutPage handler +func AboutPage() echo.HandlerFunc { + return func(c echo.Context) error { + return c.Render(http.StatusOK, "about.html", map[string]interface{}{ + "baseData": model.BaseData{Active: "about", CurrentUser: currentUser(c)}, + }) + } +} + diff --git a/main.go b/main.go index 683b5e8..cbfa8b7 100644 --- a/main.go +++ b/main.go @@ -147,6 +147,7 @@ func main() { sendmail = emailer.NewSmtpMail(util.SmtpHostname, util.SmtpPort, util.SmtpUsername, util.SmtpPassword, util.SmtpNoTLSCheck, util.SmtpAuthType, util.EmailFromName, util.EmailFrom, util.SmtpEncryption) } + app.GET(util.BasePath+"/about", handler.AboutPage()) app.GET(util.BasePath+"/_health", handler.Health()) app.GET(util.BasePath+"/favicon", handler.Favicon()) app.POST(util.BasePath+"/new-client", handler.NewClient(db), handler.ValidSession, handler.ContentTypeJson) diff --git a/router/router.go b/router/router.go index 0f9facc..9aeaf1b 100644 --- a/router/router.go +++ b/router/router.go @@ -93,6 +93,11 @@ func New(tmplBox *rice.Box, extraData map[string]string, secret []byte) *echo.Ec log.Fatal(err) } + aboutPageString, err := tmplBox.String("about.html") + if err != nil { + log.Fatal(err) + } + // create template list funcs := template.FuncMap{ "StringsJoin": strings.Join, @@ -105,6 +110,7 @@ func New(tmplBox *rice.Box, extraData map[string]string, secret []byte) *echo.Ec templates["global_settings.html"] = template.Must(template.New("global_settings").Funcs(funcs).Parse(tmplBaseString + tmplGlobalSettingsString)) templates["status.html"] = template.Must(template.New("status").Funcs(funcs).Parse(tmplBaseString + tmplStatusString)) templates["wake_on_lan_hosts.html"] = template.Must(template.New("wake_on_lan_hosts").Funcs(funcs).Parse(tmplBaseString + tmplWakeOnLanHostsString)) + templates["about.html"] = template.Must(template.New("about").Funcs(funcs).Parse(tmplBaseString + aboutPageString)) e.Logger.SetLevel(log.DEBUG) e.Pre(middleware.RemoveTrailingSlash()) diff --git a/templates/about.html b/templates/about.html new file mode 100644 index 0000000..4fc6b77 --- /dev/null +++ b/templates/about.html @@ -0,0 +1,139 @@ +{{ define "title"}} +About +{{ end }} + +{{ define "top_css"}} +{{ end }} + +{{ define "username"}} +{{ .username }} +{{ end }} + +{{ define "page_title"}} +About +{{ end }} + +{{ define "page_content"}} +
+
+ +
+ +
+
+
+

About Wireguard-UI

+
+ +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ +
+ + + +
+
+
+ +
+
+ Copyright © + + Wireguard UI. + All rights reserved. + +
+
+ +
+
+ +
+
+{{ end }} + +{{ define "bottom_js"}} + +{{ end }} diff --git a/templates/base.html b/templates/base.html index a2710e0..1987ab0 100644 --- a/templates/base.html +++ b/templates/base.html @@ -143,6 +143,15 @@

+
  • ABOUT
    • +
  • + + +

    + About +

    +     +
    • @@ -283,7 +292,7 @@
    - +
    {{if .baseData.CurrentUser}} - {{.baseData.CurrentUser}} + + {{if .baseData.Admin}} + Administrator: {{.baseData.CurrentUser}} + {{else}} + Manager: {{.baseData.CurrentUser}} + {{end}} + {{else}} Administrator {{end}} @@ -109,6 +115,8 @@

    + + {{if .baseData.Admin}}
  • @@ -117,6 +125,8 @@

    • + +
  • SETTINGS
  • @@ -126,6 +136,16 @@

    • +
  • + + +

    + Users Settings +

    +     +
    • + {{end}} +
  • UTILITIES
  • diff --git a/templates/login.html b/templates/login.html index 515eb1a..bc5ace4 100644 --- a/templates/login.html +++ b/templates/login.html @@ -101,7 +101,11 @@ $("#btn_login").click(function () { const username = $("#username").val(); const password = $("#password").val(); - const data = {"username": username, "password": password} + let rememberMe = false; + if ($("#remember").is(':checked')){ + rememberMe = true; + } + const data = {"username": username, "password": password, "rememberMe": rememberMe} $.ajax({ cache: false, diff --git a/templates/profile.html b/templates/profile.html index c2d3b95..fa80157 100644 --- a/templates/profile.html +++ b/templates/profile.html @@ -31,7 +31,7 @@ Profile
    + value="">
    @@ -55,56 +55,82 @@ Profile {{ define "bottom_js"}} {{ end }} diff --git a/templates/users_settings.html b/templates/users_settings.html new file mode 100644 index 0000000..05d8878 --- /dev/null +++ b/templates/users_settings.html @@ -0,0 +1,294 @@ +{{define "title"}} +Users Settings +{{end}} + +{{define "top_css"}} +{{end}} + +{{define "username"}} +{{ .username }} +{{end}} + +{{define "page_title"}} +Users Settings +{{end}} + +{{define "page_content"}} +
    +
    +
    +
    +
    +
    + + + + + + +{{end}} + +{{define "bottom_js"}} + + +{{end}} diff --git a/util/config.go b/util/config.go index 7f5d221..28887e6 100644 --- a/util/config.go +++ b/util/config.go @@ -24,6 +24,7 @@ var ( const ( DefaultUsername = "admin" DefaultPassword = "admin" + DefaultIsAdmin = true DefaultServerAddress = "10.252.1.0/24" DefaultServerPort = 51820 DefaultDNS = "1.1.1.1" diff --git a/util/util.go b/util/util.go index 40eb357..d3b7c14 100644 --- a/util/util.go +++ b/util/util.go @@ -381,7 +381,7 @@ func ValidateIPAllocation(serverAddresses []string, ipAllocatedList []string, ip } // WriteWireGuardServerConfig to write Wireguard server config. e.g. wg0.conf -func WriteWireGuardServerConfig(tmplBox *rice.Box, serverConfig model.Server, clientDataList []model.ClientData, globalSettings model.GlobalSetting) error { +func WriteWireGuardServerConfig(tmplBox *rice.Box, serverConfig model.Server, clientDataList []model.ClientData, usersList []model.User, globalSettings model.GlobalSetting) error { var tmplWireguardConf string // if set, read wg.conf template from WgConfTemplate @@ -416,6 +416,7 @@ func WriteWireGuardServerConfig(tmplBox *rice.Box, serverConfig model.Server, cl "serverConfig": serverConfig, "clientDataList": clientDataList, "globalSettings": globalSettings, + "usersList": usersList, } err = t.Execute(f, config) From 9f20fe6c0954f453958a8c4ac215ba13aa138891 Mon Sep 17 00:00:00 2001 From: Arminas Date: Wed, 15 Mar 2023 22:15:41 +0200 Subject: [PATCH 09/23] Show apply config button only when needed (#292) --- go.mod | 3 ++- go.sum | 24 ++++++++++++++++++++---- handler/routes.go | 20 ++++++++++++++++++++ main.go | 1 + model/misc.go | 6 ++++++ store/jsondb/jsondb.go | 25 ++++++++++++++++++++++++- store/store.go | 3 +++ templates/base.html | 28 +++++++++++++++++++++++++++- util/util.go | 41 +++++++++++++++++++++++++++++++++++++++++ 9 files changed, 144 insertions(+), 7 deletions(-) diff --git a/go.mod b/go.mod index dfe3c40..d7c4a16 100644 --- a/go.mod +++ b/go.mod @@ -19,7 +19,8 @@ require ( github.com/sendgrid/sendgrid-go v3.10.0+incompatible github.com/skip2/go-qrcode v0.0.0-20191027152451-9434209cb086 github.com/xhit/go-simple-mail/v2 v2.10.0 - golang.org/x/crypto v0.0.0-20210503195802-e9a32991a82e + golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 + golang.org/x/mod v0.7.0 //golang.zx2c4.com/wireguard v0.0.20200121 // indirect golang.zx2c4.com/wireguard/wgctrl v0.0.0-20210803171230-4253848d036c gopkg.in/go-playground/assert.v1 v1.2.1 // indirect diff --git a/go.sum b/go.sum index beffdb5..814f123 100644 --- a/go.sum +++ b/go.sum @@ -157,6 +157,7 @@ github.com/valyala/fasttemplate v1.1.0 h1:RZqt0yGBsps8NGvLSGW804QQqCUYYLsaOjTVHy github.com/valyala/fasttemplate v1.1.0/go.mod h1:UQGH1tvbgY+Nz5t2n7tXsz52dQxojPUpymEIMZ47gx8= github.com/xhit/go-simple-mail/v2 v2.10.0 h1:nib6RaJ4qVh5HD9UE9QJqnUZyWp3upv+Z6CFxaMj0V8= github.com/xhit/go-simple-mail/v2 v2.10.0/go.mod h1:kA1XbQfCI4JxQ9ccSN6VFyIEkkugOm7YiPkA5hKiQn4= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= @@ -164,13 +165,18 @@ golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8U golang.org/x/crypto v0.0.0-20200221231518-2aa609cf4a9d/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= -golang.org/x/crypto v0.0.0-20210503195802-e9a32991a82e h1:8foAy0aoO5GkqCvAEJ4VC4P3zksTg4X4aJCDpZzmgQI= golang.org/x/crypto v0.0.0-20210503195802-e9a32991a82e/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 h1:7I4JAnoQBe7ZtJcBaYHi5UtiO8tQHbUSXxL+pnGRANg= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.7.0 h1:LapD9S96VoQRhi/GrNTqeBJFrUjs5UHCAtTlgwA5oZA= +golang.org/x/mod v0.7.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190607181551-461777fb6f67/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20191007182048-72f939374954/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -181,11 +187,13 @@ golang.org/x/net v0.0.0-20201216054612-986b41b23924/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= -golang.org/x/net v0.0.0-20210504132125-bbd867fde50d h1:nTDGCTeAu2LhcsHTRzjyIUbZHCJ4QePArsm27Hka0UM= golang.org/x/net v0.0.0-20210504132125-bbd867fde50d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b h1:PxfKdU9lEEDYjdIzOtC4qFWgkU2rGHdKlKowJSMN9h0= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -215,19 +223,27 @@ golang.org/x/sys v0.0.0-20210216163648-f7da38b97c65/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210309040221-94ec62e08169/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210503173754-0981d6026fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20211103235746-7861aae1554b h1:1VkfZQv42XQlA/jchYumAnv1UPo6RgF9rJFkTgZIxO4= golang.org/x/sys v0.0.0-20211103235746-7861aae1554b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f h1:v4INt8xihDGvnrfjMDVXGxw9wrfxYyCjk0KbXjhR55s= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190608022120-eacb66d2a7c3/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/handler/routes.go b/handler/routes.go index 7b61dc2..4f76d22 100644 --- a/handler/routes.go +++ b/handler/routes.go @@ -983,11 +983,31 @@ func ApplyServerConfig(db store.IStore, tmplBox *rice.Box) echo.HandlerFunc { false, fmt.Sprintf("Cannot apply server config: %v", err), }) } + + err = util.UpdateHashes(db) + if err != nil { + log.Error("Cannot update hashes: ", err) + return c.JSON(http.StatusInternalServerError, jsonHTTPResponse{ + false, fmt.Sprintf("Cannot update hashes: %v", err), + }) + } return c.JSON(http.StatusOK, jsonHTTPResponse{true, "Applied server config successfully"}) } } + +// GetHashesChanges handler returns if database hashes have changed +func GetHashesChanges(db store.IStore) echo.HandlerFunc { + return func(c echo.Context) error { + if util.HashesChanged(db) { + return c.JSON(http.StatusOK, jsonHTTPResponse{true, "Hashes changed"}) + } else { + return c.JSON(http.StatusOK, jsonHTTPResponse{false, "Hashes not changed"}) + } + } +} + // AboutPage handler func AboutPage() echo.HandlerFunc { return func(c echo.Context) error { diff --git a/main.go b/main.go index 18b1134..7e79ca4 100644 --- a/main.go +++ b/main.go @@ -152,6 +152,7 @@ func main() { sendmail = emailer.NewSmtpMail(util.SmtpHostname, util.SmtpPort, util.SmtpUsername, util.SmtpPassword, util.SmtpNoTLSCheck, util.SmtpAuthType, util.EmailFromName, util.EmailFrom, util.SmtpEncryption) } + app.GET(util.BasePath+"/test-hash", handler.GetHashesChanges(db), handler.ValidSession) app.GET(util.BasePath+"/about", handler.AboutPage()) app.GET(util.BasePath+"/_health", handler.Health()) app.GET(util.BasePath+"/favicon", handler.Favicon()) diff --git a/model/misc.go b/model/misc.go index d8f2cf5..dc95f15 100644 --- a/model/misc.go +++ b/model/misc.go @@ -12,3 +12,9 @@ type BaseData struct { CurrentUser string Admin bool } + +// ClientServerHashes struct, to save hashes to detect changes +type ClientServerHashes struct { + Client string `json:"client"` + Server string `json:"server"` +} diff --git a/store/jsondb/jsondb.go b/store/jsondb/jsondb.go index e6ebfb2..0357cbe 100644 --- a/store/jsondb/jsondb.go +++ b/store/jsondb/jsondb.go @@ -42,7 +42,9 @@ func (o *JsonDB) Init() error { var serverInterfacePath string = path.Join(serverPath, "interfaces.json") var serverKeyPairPath string = path.Join(serverPath, "keypair.json") var globalSettingPath string = path.Join(serverPath, "global_settings.json") - var userPath string = path.Join(o.dbPath, "users") + var hashesPath string = path.Join(serverPath, "hashes.json") + var userPath string = path.Join(serverPath, "users.json") + // create directories if they do not exist if _, err := os.Stat(clientPath); os.IsNotExist(err) { os.MkdirAll(clientPath, os.ModePerm) @@ -104,6 +106,14 @@ func (o *JsonDB) Init() error { globalSetting.UpdatedAt = time.Now().UTC() o.conn.Write("server", "global_settings", globalSetting) } + + // hashes + if _, err := os.Stat(hashesPath); os.IsNotExist(err) { + clientServerHashes := new(model.ClientServerHashes) + clientServerHashes.Client = "none" + clientServerHashes.Server = "none" + o.conn.Write("server", "hashes", clientServerHashes) + } // user info results, err := o.conn.ReadAll("users") @@ -295,3 +305,16 @@ func (o *JsonDB) SaveServerKeyPair(serverKeyPair model.ServerKeypair) error { func (o *JsonDB) SaveGlobalSettings(globalSettings model.GlobalSetting) error { return o.conn.Write("server", "global_settings", globalSettings) } + +func (o *JsonDB) GetPath() string { + return o.dbPath +} + +func (o *JsonDB) GetHashes() (model.ClientServerHashes, error) { + hashes := model.ClientServerHashes{} + return hashes, o.conn.Read("server", "hashes", &hashes) +} + +func (o *JsonDB) SaveHashes(hashes model.ClientServerHashes) error { + return o.conn.Write("server", "hashes", hashes) +} diff --git a/store/store.go b/store/store.go index 166bc3d..ef6d723 100644 --- a/store/store.go +++ b/store/store.go @@ -24,4 +24,7 @@ type IStore interface { DeleteWakeOnHostLanHost(macAddress string) error SaveWakeOnLanHost(host model.WakeOnLanHost) error DeleteWakeOnHost(host model.WakeOnLanHost) error + GetPath() string + SaveHashes(hashes model.ClientServerHashes) error + GetHashes() (model.ClientServerHashes, error) } diff --git a/templates/base.html b/templates/base.html index 9663d7d..e1db8ca 100644 --- a/templates/base.html +++ b/templates/base.html @@ -63,7 +63,7 @@ - {{if .baseData.CurrentUser}} @@ -351,6 +351,32 @@ $('[data-toggle="tooltip"]').tooltip() }) + $(document).ready(function () { + + $.ajax({ + cache: false, + method: 'GET', + url: '{{.basePath}}/test-hash', + dataType: 'json', + contentType: "application/json", + success: function(data) { + if (data.status) { + $("#apply-config-button").show() + } + else + { + $("#apply-config-button").hide() + } + }, + error: function(jqXHR, exception) { + const responseJson = jQuery.parseJSON(jqXHR.responseText); + toastr.error(responseJson['message']); + } + }); + + }); + + // populateClient function for render new client info // on the client page. function populateClient(client_id) { diff --git a/util/util.go b/util/util.go index d3b7c14..6b61d84 100644 --- a/util/util.go +++ b/util/util.go @@ -4,9 +4,14 @@ import ( "encoding/json" "errors" "fmt" + "github.com/ngoduykhanh/wireguard-ui/store" + "golang.org/x/mod/sumdb/dirhash" + "io" "io/ioutil" "net" "os" + "path" + "path/filepath" "strconv" "strings" "text/template" @@ -463,3 +468,39 @@ func LookupEnvOrStrings(key string, defaultVal []string) []string { } return defaultVal } + +// GetCurrentHash returns current hashes +func GetCurrentHash(db store.IStore) (string, string) { + hashClients, _ := dirhash.HashDir(path.Join(db.GetPath(), "clients"), "prefix", dirhash.Hash1) + files := append([]string(nil), "prefix/global_settings.json", "prefix/interfaces.json", "prefix/keypair.json") + + osOpen := func(name string) (io.ReadCloser, error) { + return os.Open(filepath.Join(path.Join(db.GetPath(), "server"), strings.TrimPrefix(name, "prefix"))) + } + hashServer, _ := dirhash.Hash1(files, osOpen) + + return hashClients, hashServer +} + +func HashesChanged(db store.IStore) bool { + old, _ := db.GetHashes() + oldClient := old.Client + oldServer := old.Server + newClient, newServer := GetCurrentHash(db) + + if oldClient != newClient { + fmt.Println("Hash for client differs") + return true + } + if oldServer != newServer { + fmt.Println("Hash for server differs") + return true + } + return false +} + +func UpdateHashes(db store.IStore) error { + var clientServerHashes model.ClientServerHashes + clientServerHashes.Client, clientServerHashes.Server = GetCurrentHash(db) + return db.SaveHashes(clientServerHashes) +} From d1cf0ca7ebc57e111e6efa2a12a964627f0c6d21 Mon Sep 17 00:00:00 2001 From: Arminas Date: Wed, 15 Mar 2023 22:24:44 +0200 Subject: [PATCH 10/23] Client filtration (#330) --- custom/js/helper.js | 1 + templates/base.html | 7 +++++ templates/clients.html | 65 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 73 insertions(+) diff --git a/custom/js/helper.js b/custom/js/helper.js index f337e5d..39bc1fa 100644 --- a/custom/js/helper.js +++ b/custom/js/helper.js @@ -58,6 +58,7 @@ function renderClientList(data) {
    ${obj.Client.name} + ${obj.Client.email} ${prettyDateTime(obj.Client.created_at)} diff --git a/templates/base.html b/templates/base.html index e1db8ca..6c2e3f3 100644 --- a/templates/base.html +++ b/templates/base.html @@ -56,6 +56,13 @@
    • + diff --git a/templates/clients.html b/templates/clients.html index 239e54e..5a585f0 100644 --- a/templates/clients.html +++ b/templates/clients.html @@ -263,6 +263,7 @@ Wireguard Clients // hide all clients and display only the ones that meet the search criteria (name, email, IP) $('#search-input').keyup(function () { + $("#status-selector").val("All"); var query = $(this).val(); $('.col-lg-4').hide(); $(".info-box-text").each(function() { @@ -274,6 +275,70 @@ Wireguard Clients $(".badge-secondary").filter(':contains("' + query + '")').parent().parent().parent().show(); }) + $("#status-selector").on('change', function () { + $('#search-input').val(""); + switch ($("#status-selector").val()) { + case "All": + $('.col-lg-4').show(); + break; + case "Enabled": + $('.col-lg-4').hide(); + $('[id^="paused_"]').each(function () { + if ($(this).css("visibility") === "hidden") { + $(this).parent().parent().show(); + } + }); + break; + case "Disabled": + $('.col-lg-4').hide(); + $('[id^="paused_"]').each(function () { + if ($(this).css("visibility") !== "hidden") { + $(this).parent().parent().show(); + } + }); + break; + case "Connected": + $('.col-lg-4').hide(); + $.ajax({ + cache: false, + method: 'GET', + url: '{{.basePath}}/status', + success: function (data) { + const returnedHTML = $(data).find(".table-success").get(); + var returnedString = ""; + returnedHTML.forEach(entry => returnedString += entry.outerHTML); + $(".fa-key").each(function () { + if (returnedString.indexOf($(this).parent().text().trim()) != -1) { + $(this).closest('.col-lg-4').show(); + } + }) + } + }); + break; + case "Disconnected": + $('.col-lg-4').show(); + $.ajax({ + cache: false, + method: 'GET', + url: '{{.basePath}}/status', + success: function (data) { + const returnedHTML = $(data).find(".table-success").get(); + var returnedString = ""; + returnedHTML.forEach(entry => returnedString += entry.outerHTML); + $(".fa-key").each(function () { + if (returnedString.indexOf($(this).parent().text().trim()) != -1) { + $(this).closest('.col-lg-4').hide(); + } + }) + } + }); + break; + default: + $('.col-lg-4').show(); + break; + } + }); + // modal_pause_client modal event $("#modal_pause_client").on('show.bs.modal', function (event) { const button = $(event.relatedTarget); From 3d59c7d0de8e5460abdec997e22034c9269a2177 Mon Sep 17 00:00:00 2001 From: ByteDream <63594396+ByteDream@users.noreply.github.com> Date: Wed, 15 Mar 2023 21:29:08 +0100 Subject: [PATCH 11/23] Add log levels (#332) --- README.md | 1 + main.go | 33 ++++++++++++++++++--------------- router/router.go | 22 ++++++++++++++++++++-- util/config.go | 1 + util/util.go | 16 ++++++++++++++++ 5 files changed, 56 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 489314c..6153ea0 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ Note: | `WGUI_PERSISTENT_KEEPALIVE` | The default persistent keepalive for WireGuard in global settings | `15` | | `WGUI_FORWARD_MARK` | The default WireGuard forward mark | `0xca6c` | | `WGUI_CONFIG_FILE_PATH` | The default WireGuard config file path used in global settings | `/etc/wireguard/wg0.conf` | +| `WGUI_LOG_LEVEL` | The default log level. Possible values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF` | `INFO` | | | `WG_CONF_TEMPLATE` | The custom `wg.conf` config file template. Please refer to our [default template](https://github.com/ngoduykhanh/wireguard-ui/blob/master/templates/wg.conf) | N/A | | `EMAIL_FROM_ADDRESS` | The sender email address | N/A | | `EMAIL_FROM_NAME` | The sender name | `WireGuard UI` | diff --git a/main.go b/main.go index 7e79ca4..3e1b6b5 100644 --- a/main.go +++ b/main.go @@ -88,21 +88,24 @@ func init() { util.WgConfTemplate = flagWgConfTemplate util.BasePath = util.ParseBasePath(flagBasePath) - // print app information - fmt.Println("Wireguard UI") - fmt.Println("App Version\t:", appVersion) - fmt.Println("Git Commit\t:", gitCommit) - fmt.Println("Git Ref\t\t:", gitRef) - fmt.Println("Build Time\t:", buildTime) - fmt.Println("Git Repo\t:", "https://github.com/ngoduykhanh/wireguard-ui") - fmt.Println("Authentication\t:", !util.DisableLogin) - fmt.Println("Bind address\t:", util.BindAddress) - //fmt.Println("Sendgrid key\t:", util.SendgridApiKey) - fmt.Println("Email from\t:", util.EmailFrom) - fmt.Println("Email from name\t:", util.EmailFromName) - //fmt.Println("Session secret\t:", util.SessionSecret) - fmt.Println("Custom wg.conf\t:", util.WgConfTemplate) - fmt.Println("Base path\t:", util.BasePath+"/") + // print only if log level is INFO or lower + if lvl, _ := util.ParseLogLevel(util.LookupEnvOrString(util.LogLevel, "INFO")); lvl <= log.INFO { + // print app information + fmt.Println("Wireguard UI") + fmt.Println("App Version\t:", appVersion) + fmt.Println("Git Commit\t:", gitCommit) + fmt.Println("Git Ref\t\t:", gitRef) + fmt.Println("Build Time\t:", buildTime) + fmt.Println("Git Repo\t:", "https://github.com/ngoduykhanh/wireguard-ui") + fmt.Println("Authentication\t:", !util.DisableLogin) + fmt.Println("Bind address\t:", util.BindAddress) + //fmt.Println("Sendgrid key\t:", util.SendgridApiKey) + fmt.Println("Email from\t:", util.EmailFrom) + fmt.Println("Email from name\t:", util.EmailFromName) + //fmt.Println("Session secret\t:", util.SessionSecret) + fmt.Println("Custom wg.conf\t:", util.WgConfTemplate) + fmt.Println("Base path\t:", util.BasePath+"/") + } } func main() { diff --git a/router/router.go b/router/router.go index 802ba2a..cdc6424 100644 --- a/router/router.go +++ b/router/router.go @@ -118,10 +118,28 @@ func New(tmplBox *rice.Box, extraData map[string]string, secret []byte) *echo.Ec templates["wake_on_lan_hosts.html"] = template.Must(template.New("wake_on_lan_hosts").Funcs(funcs).Parse(tmplBaseString + tmplWakeOnLanHostsString)) templates["about.html"] = template.Must(template.New("about").Funcs(funcs).Parse(tmplBaseString + aboutPageString)) - e.Logger.SetLevel(log.DEBUG) + lvl, err := util.ParseLogLevel(util.LookupEnvOrString(util.LogLevel, "INFO")) + if err != nil { + log.Fatal(err) + } + logConfig := middleware.DefaultLoggerConfig + logConfig.Skipper = func(c echo.Context) bool { + resp := c.Response() + if resp.Status >= 500 && lvl > log.ERROR { // do not log if response is 5XX but log level is higher than ERROR + return true + } else if resp.Status >= 400 && lvl > log.WARN { // do not log if response is 4XX but log level is higher than WARN + return true + } else if lvl > log.DEBUG { // do not log if log level is higher than DEBUG + return true + } + return false + } + + e.Logger.SetLevel(lvl) e.Pre(middleware.RemoveTrailingSlash()) - e.Use(middleware.Logger()) + e.Use(middleware.LoggerWithConfig(logConfig)) e.HideBanner = true + e.HidePort = lvl > log.INFO // hide the port output if the log level is higher than INFO e.Validator = NewValidator() e.Renderer = &TemplateRegistry{ templates: templates, diff --git a/util/config.go b/util/config.go index 28887e6..018690f 100644 --- a/util/config.go +++ b/util/config.go @@ -42,6 +42,7 @@ const ( PersistentKeepaliveEnvVar = "WGUI_PERSISTENT_KEEPALIVE" ForwardMarkEnvVar = "WGUI_FORWARD_MARK" ConfigFilePathEnvVar = "WGUI_CONFIG_FILE_PATH" + LogLevel = "WGUI_LOG_LEVEL" ServerAddressesEnvVar = "WGUI_SERVER_INTERFACE_ADDRESSES" ServerListenPortEnvVar = "WGUI_SERVER_LISTEN_PORT" ServerPostUpScriptEnvVar = "WGUI_SERVER_POST_UP_SCRIPT" diff --git a/util/util.go b/util/util.go index 6b61d84..44f357b 100644 --- a/util/util.go +++ b/util/util.go @@ -469,6 +469,22 @@ func LookupEnvOrStrings(key string, defaultVal []string) []string { return defaultVal } +func ParseLogLevel(lvl string) (log.Lvl, error) { + switch strings.ToLower(lvl) { + case "debug": + return log.DEBUG, nil + case "info": + return log.INFO, nil + case "warn": + return log.WARN, nil + case "error": + return log.ERROR, nil + case "off": + return log.OFF, nil + default: + return log.DEBUG, fmt.Errorf("not a valid log level: %s", lvl) + } + // GetCurrentHash returns current hashes func GetCurrentHash(db store.IStore) (string, string) { hashClients, _ := dirhash.HashDir(path.Join(db.GetPath(), "clients"), "prefix", dirhash.Hash1) From 7b848c841f19468ff668d07d24fbfccf150221b6 Mon Sep 17 00:00:00 2001 From: ByteDream <63594396+ByteDream@users.noreply.github.com> Date: Wed, 15 Mar 2023 21:30:18 +0100 Subject: [PATCH 12/23] Disable cgo on release ci (#334) --- .github/workflows/release.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1e5d93a..8907d06 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -62,6 +62,7 @@ jobs: goos: ${{ matrix.goos }} goarch: ${{ matrix.goarch }} goversion: "https://dl.google.com/go/go1.16.1.linux-amd64.tar.gz" + pre_command: export CGO_ENABLED=0 binary_name: "wireguard-ui" build_flags: -v ldflags: -X "main.appVersion=${{ env.APP_VERSION }}" -X "main.buildTime=${{ env.BUILD_TIME }}" -X main.gitCommit=${{ github.sha }} -X main.gitRef=${{ github.ref }} From b8341dd36f68ca21bf4f7a8dfd6b4da0f90561c3 Mon Sep 17 00:00:00 2001 From: ByteDream <63594396+ByteDream@users.noreply.github.com> Date: Wed, 15 Mar 2023 21:35:57 +0100 Subject: [PATCH 13/23] Add docker-compose examples (#339) --- .dockerignore | 3 ++ .gitignore | 4 +++ README.md | 14 ++------ examples/docker-compose/README.md | 30 +++++++++++++++++ examples/docker-compose/boringtun.yml | 43 +++++++++++++++++++++++++ examples/docker-compose/linuxserver.yml | 42 ++++++++++++++++++++++++ examples/docker-compose/system.yml | 27 ++++++++++++++++ 7 files changed, 151 insertions(+), 12 deletions(-) create mode 100644 examples/docker-compose/README.md create mode 100644 examples/docker-compose/boringtun.yml create mode 100644 examples/docker-compose/linuxserver.yml create mode 100644 examples/docker-compose/system.yml diff --git a/.dockerignore b/.dockerignore index b9ff5d8..7624d3e 100644 --- a/.dockerignore +++ b/.dockerignore @@ -25,3 +25,6 @@ docker-compose* db assets wireguard-ui + +# Examples +examples diff --git a/.gitignore b/.gitignore index d6eba78..b8e3cf3 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,7 @@ rice-box.go # IDEs .vscode .idea + +# Examples +examples/docker-compose/config +examples/docker-compose/db diff --git a/README.md b/README.md index 6153ea0..0c7bebd 100644 --- a/README.md +++ b/README.md @@ -27,23 +27,13 @@ Download the binary file from the release page and run it directly on the host m ### Using docker compose -You can take a look at this example -of [docker-compose.yml](https://github.com/ngoduykhanh/wireguard-ui/blob/master/docker-compose.yaml). Please adjust -volume mount points to work with your setup. Then run it like below: +The [examples/docker-compose](examples/docker-compose) folder contains example docker-compose files. +Choose the example which fits you the most, adjust the configuration for your needs, then run it like below: ``` docker-compose up ``` -Note: - -- There is a Status page that needs docker to be able to access the network of the host in order to read the - wireguard interface stats. See the `cap_add` and `network_mode` options on the docker-compose.yaml -- Similarly, the `WGUI_MANAGE_START` and `WGUI_MANAGE_RESTART` settings need the same access, in order to restart the - wireguard interface. -- Because the `network_mode` is set to `host`, we don't need to specify the exposed ports. The app will listen on - port `5000` by default. - ## Environment Variables | Variable | Description | Default | diff --git a/examples/docker-compose/README.md b/examples/docker-compose/README.md new file mode 100644 index 0000000..951df08 --- /dev/null +++ b/examples/docker-compose/README.md @@ -0,0 +1,30 @@ +## Prerequisites + +### Kernel Module + +Depending on if the Wireguard kernel module is available on your system you have more or less choices which example to use. + +You can check if the kernel modules are available via the following command: +```shell +modprobe wireguard +``` + +If the command exits successfully and doesn't print an error the kernel modules are available. +If it does error, you either have to install them manually (or activate if deactivated) or use an userspace implementation. +For an example of an userspace implementation, see _borigtun_. + +### Credentials + +Username and password for all examples is `admin` by default. +For security reasons it's highly recommended to change them before the first startup. + +## Examples +- **[system](system.yml)** + + If you have Wireguard already installed on your system and only want to run the UI in docker this might fit the most. +- **[linuxserver](linuxserver.yml)** + + If you have the Wireguard kernel modules installed (included in the mainline kernel since version 5.6) but want it running inside of docker, this might fit the most. +- **[boringtun](boringtun.yml)** + + If Wireguard kernel modules are not available, you can switch to an userspace implementation like [boringtun](https://github.com/cloudflare/boringtun). diff --git a/examples/docker-compose/boringtun.yml b/examples/docker-compose/boringtun.yml new file mode 100644 index 0000000..a1bdd2f --- /dev/null +++ b/examples/docker-compose/boringtun.yml @@ -0,0 +1,43 @@ +version: "3" + +services: + boringtun: + image: ghcr.io/ntkme/boringtun:edge + command: + - wg0 + container_name: boringtun + # use the network of the 'wireguard-ui' service. this enables to show active clients in the status page + network_mode: service:wireguard-ui + cap_add: + - NET_ADMIN + volumes: + - /dev/net/tun:/dev/net/tun + - ./config:/etc/wireguard + + wireguard-ui: + image: ngoduykhanh/wireguard-ui:latest + container_name: wireguard-ui + cap_add: + - NET_ADMIN + environment: + - SENDGRID_API_KEY + - EMAIL_FROM_ADDRESS + - EMAIL_FROM_NAME + - SESSION_SECRET + - WGUI_USERNAME=admin + - WGUI_PASSWORD=admin + - WG_CONF_TEMPLATE + - WGUI_MANAGE_START=true + - WGUI_MANAGE_RESTART=true + logging: + driver: json-file + options: + max-size: 50m + volumes: + - ./db:/app/db + - ./config:/etc/wireguard + ports: + # port for wireguard-ui + - "5000:5000" + # port of the wireguard server. this must be set here as the `boringtun` container joins the network of this container and hasn't its own network over which it could publish the ports + - "51820:51820/udp" diff --git a/examples/docker-compose/linuxserver.yml b/examples/docker-compose/linuxserver.yml new file mode 100644 index 0000000..1b7a66f --- /dev/null +++ b/examples/docker-compose/linuxserver.yml @@ -0,0 +1,42 @@ +version: "3" + +services: + wireguard: + image: linuxserver/wireguard:latest + container_name: wireguard + cap_add: + - NET_ADMIN + volumes: + - ./config:/config + ports: + # port for wireguard-ui. this must be set here as the `wireguard-ui` container joins the network of this container and hasn't its own network over which it could publish the ports + - "5000:5000" + # port of the wireguard server + - "51820:51820/udp" + + wireguard-ui: + image: ngoduykhanh/wireguard-ui:latest + container_name: wireguard-ui + depends_on: + - wireguard + cap_add: + - NET_ADMIN + # use the network of the 'wireguard' service. this enables to show active clients in the status page + network_mode: service:wireguard + environment: + - SENDGRID_API_KEY + - EMAIL_FROM_ADDRESS + - EMAIL_FROM_NAME + - SESSION_SECRET + - WGUI_USERNAME=admin + - WGUI_PASSWORD=admin + - WG_CONF_TEMPLATE + - WGUI_MANAGE_START=true + - WGUI_MANAGE_RESTART=true + logging: + driver: json-file + options: + max-size: 50m + volumes: + - ./db:/app/db + - ./config:/etc/wireguard diff --git a/examples/docker-compose/system.yml b/examples/docker-compose/system.yml new file mode 100644 index 0000000..c27f31e --- /dev/null +++ b/examples/docker-compose/system.yml @@ -0,0 +1,27 @@ +version: "3" + +services: + wireguard-ui: + image: ngoduykhanh/wireguard-ui:latest + container_name: wireguard-ui + cap_add: + - NET_ADMIN + # required to show active clients. with this set, you don't need to expose the ui port (5000) anymore + network_mode: host + environment: + - SENDGRID_API_KEY + - EMAIL_FROM_ADDRESS + - EMAIL_FROM_NAME + - SESSION_SECRET + - WGUI_USERNAME=admin + - WGUI_PASSWORD=admin + - WG_CONF_TEMPLATE + - WGUI_MANAGE_START=false + - WGUI_MANAGE_RESTART=false + logging: + driver: json-file + options: + max-size: 50m + volumes: + - ./db:/app/db + - /etc/wireguard:/etc/wireguard From b80c44af43518c3dc1e48d8d5406085c667e3d9f Mon Sep 17 00:00:00 2001 From: Paul Dee Date: Wed, 15 Mar 2023 21:37:39 +0100 Subject: [PATCH 14/23] Fix for fwmark (#279) --- README.md | 2 +- model/setting.go | 2 +- store/jsondb/jsondb.go | 5 +---- templates/clients.html | 17 +++-------------- templates/global_settings.html | 18 +++++++++--------- util/config.go | 4 ++-- util/util.go | 6 ------ 7 files changed, 17 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 0c7bebd..27b4ed8 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ docker-compose up | `WGUI_DNS` | The default DNS servers (comma-separated-list) used in the global settings | `1.1.1.1` | | `WGUI_MTU` | The default MTU used in global settings | `1450` | | `WGUI_PERSISTENT_KEEPALIVE` | The default persistent keepalive for WireGuard in global settings | `15` | -| `WGUI_FORWARD_MARK` | The default WireGuard forward mark | `0xca6c` | +| `WGUI_FIREWALL_MARK` | The default WireGuard firewall mark | `0xca6c` (51820) | | `WGUI_CONFIG_FILE_PATH` | The default WireGuard config file path used in global settings | `/etc/wireguard/wg0.conf` | | `WGUI_LOG_LEVEL` | The default log level. Possible values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF` | `INFO` | | | `WG_CONF_TEMPLATE` | The custom `wg.conf` config file template. Please refer to our [default template](https://github.com/ngoduykhanh/wireguard-ui/blob/master/templates/wg.conf) | N/A | diff --git a/model/setting.go b/model/setting.go index e871591..a702293 100644 --- a/model/setting.go +++ b/model/setting.go @@ -10,7 +10,7 @@ type GlobalSetting struct { DNSServers []string `json:"dns_servers"` MTU int `json:"mtu,string"` PersistentKeepalive int `json:"persistent_keepalive,string"` - ForwardMark string `json:"forward_mark"` + FirewallMark string `json:"firewall_mark"` ConfigFilePath string `json:"config_file_path"` UpdatedAt time.Time `json:"updated_at"` } diff --git a/store/jsondb/jsondb.go b/store/jsondb/jsondb.go index 0357cbe..f95ff16 100644 --- a/store/jsondb/jsondb.go +++ b/store/jsondb/jsondb.go @@ -101,7 +101,7 @@ func (o *JsonDB) Init() error { globalSetting.DNSServers = util.LookupEnvOrStrings(util.DNSEnvVar, []string{util.DefaultDNS}) globalSetting.MTU = util.LookupEnvOrInt(util.MTUEnvVar, util.DefaultMTU) globalSetting.PersistentKeepalive = util.LookupEnvOrInt(util.PersistentKeepaliveEnvVar, util.DefaultPersistentKeepalive) - globalSetting.ForwardMark = util.LookupEnvOrString(util.ForwardMarkEnvVar, util.DefaultForwardMark) + globalSetting.FirewallMark = util.LookupEnvOrString(util.FirewallMarkEnvVar, util.DefaultFirewallMark) globalSetting.ConfigFilePath = util.LookupEnvOrString(util.ConfigFilePathEnvVar, util.DefaultConfigFilePath) globalSetting.UpdatedAt = time.Now().UTC() o.conn.Write("server", "global_settings", globalSetting) @@ -269,9 +269,6 @@ func (o *JsonDB) GetClientByID(clientID string, qrCodeSettings model.QRCodeSetti if !qrCodeSettings.IncludeMTU { globalSettings.MTU = 0 } - if !qrCodeSettings.IncludeFwMark { - globalSettings.ForwardMark = "" - } png, err := qrcode.Encode(util.BuildClientConfig(client, server, globalSettings), qrcode.Medium, 256) if err == nil { diff --git a/templates/clients.html b/templates/clients.html index 5a585f0..513797c 100644 --- a/templates/clients.html +++ b/templates/clients.html @@ -70,17 +70,8 @@ Wireguard Clients
    - - QR code - -
    -
    - - -
    -
    + QR code +
    @@ -490,9 +481,7 @@ Wireguard Clients cache: false, method: 'GET', url: '{{.basePath}}/api/client/' + client_id, - data: { - qrCodeIncludeFwMark: include_fwmark - }, + data: JSON.stringify(data), dataType: 'json', contentType: "application/json", success: function (resp) { diff --git a/templates/global_settings.html b/templates/global_settings.html index 8a41d1f..15d7b4b 100644 --- a/templates/global_settings.html +++ b/templates/global_settings.html @@ -56,10 +56,10 @@ Global Settings value="{{if .globalSettings.PersistentKeepalive }}{{ .globalSettings.PersistentKeepalive }}{{end}}">
    - - + +
    @@ -100,8 +100,8 @@ Global Settings until they reach out to other peers themselves. Adding PersistentKeepalive can ensure that the connection remains open.
    Leave blank to omit this setting in the Client config.
    -
    5. Forward Mark
    -
    Set an fwmark on all packets going out of WireGuard's UDP socket. Default value: 0xca6c
    +
    5. Firewall Mark
    +
    Add a matching fwmark on all packets going out of a WireGuard non-default-route tunnel. Default value: 0xca6c
    6. Wireguard Config File Path
    The path of your Wireguard server config file. Please make sure the parent directory exists and is writable.
    @@ -149,9 +149,9 @@ Global Settings const dns_servers = $("#dns_servers").val().split(","); const mtu = $("#mtu").val(); const persistent_keepalive = $("#persistent_keepalive").val(); - const forward_mark = $("#forward_mark").val(); + const firewall_mark = $("#firewall_mark").val(); const config_file_path = $("#config_file_path").val(); - const data = {"endpoint_address": endpoint_address, "dns_servers": dns_servers, "mtu": mtu, "persistent_keepalive": persistent_keepalive, "forward_mark": forward_mark, "config_file_path": config_file_path}; + const data = {"endpoint_address": endpoint_address, "dns_servers": dns_servers, "mtu": mtu, "persistent_keepalive": persistent_keepalive, "firewall_mark": firewall_mark, "config_file_path": config_file_path}; $.ajax({ cache: false, @@ -222,7 +222,7 @@ Global Settings config_file_path: { required: true }, - forward_mark: { + firewall_mark: { required: false } }, diff --git a/util/config.go b/util/config.go index 018690f..7a95f97 100644 --- a/util/config.go +++ b/util/config.go @@ -30,7 +30,7 @@ const ( DefaultDNS = "1.1.1.1" DefaultMTU = 1450 DefaultPersistentKeepalive = 15 - DefaultForwardMark = "0xca6c" + DefaultFirewallMark = "0xca6c" // i.e. 51820 DefaultConfigFilePath = "/etc/wireguard/wg0.conf" UsernameEnvVar = "WGUI_USERNAME" PasswordEnvVar = "WGUI_PASSWORD" @@ -40,7 +40,7 @@ const ( DNSEnvVar = "WGUI_DNS" MTUEnvVar = "WGUI_MTU" PersistentKeepaliveEnvVar = "WGUI_PERSISTENT_KEEPALIVE" - ForwardMarkEnvVar = "WGUI_FORWARD_MARK" + FirewallMarkEnvVar = "WGUI_FIREWALL_MARK" ConfigFilePathEnvVar = "WGUI_CONFIG_FILE_PATH" LogLevel = "WGUI_LOG_LEVEL" ServerAddressesEnvVar = "WGUI_SERVER_INTERFACE_ADDRESSES" diff --git a/util/util.go b/util/util.go index 44f357b..04950f9 100644 --- a/util/util.go +++ b/util/util.go @@ -65,18 +65,12 @@ func BuildClientConfig(client model.Client, server model.Server, setting model.G peerPersistentKeepalive = fmt.Sprintf("PersistentKeepalive = %d\n", setting.PersistentKeepalive) } - forwardMark := "" - if setting.ForwardMark != "" { - forwardMark = fmt.Sprintf("FwMark = %s\n", setting.ForwardMark) - } - // build the config as string strConfig := "[Interface]\n" + clientAddress + clientPrivateKey + clientDNS + clientMTU + - forwardMark + "\n[Peer]\n" + peerPublicKey + peerPresharedKey + From 814093cdd32863dc3b5becfc0ae8de6cd0eec982 Mon Sep 17 00:00:00 2001 From: Paul Dee Date: Wed, 15 Mar 2023 21:39:20 +0100 Subject: [PATCH 15/23] Stamp git commit into docker builds. (#325) --- Dockerfile | 3 ++- README.md | 8 +++++++- main.go | 1 + templates/about.html | 6 ++++++ 4 files changed, 16 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index a30cefe..e4d5525 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,6 +4,7 @@ LABEL maintainer="Khanh Ngo Current version
    +{{ if .gitCommit }} +
    + + +
    +{{ end }}
    From abef29bf172482305f940dba7e1519037e05172f Mon Sep 17 00:00:00 2001 From: Matze <37954743+Matze1224@users.noreply.github.com> Date: Wed, 15 Mar 2023 21:41:46 +0100 Subject: [PATCH 16/23] better error-handling if no public IP could be detected (#323) --- README.md | 5 +++-- util/util.go | 6 ++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index eaa18c3..7eca337 100644 --- a/README.md +++ b/README.md @@ -43,14 +43,15 @@ docker-compose up | `WGUI_USERNAME` | The username for the login page. Used for db initialization only | `admin` | | `WGUI_PASSWORD` | The password for the user on the login page. Will be hashed automatically. Used for db initialization only | `admin` | | `WGUI_PASSWORD_HASH` | The password hash for the user on the login page. (alternative to `WGUI_PASSWORD`). Used for db initialization only | N/A | +| `WGUI_ENDPOINT_ADDRESS` | The default endpoint address used in global settings where clients should connect to | Resolved to your public ip address | | `WGUI_FAVICON_FILE_PATH` | The file path used as website favicon | Embedded WireGuard logo | | `WGUI_ENDPOINT_ADDRESS` | The default endpoint address used in global settings | Resolved to your public ip address | | `WGUI_DNS` | The default DNS servers (comma-separated-list) used in the global settings | `1.1.1.1` | | `WGUI_MTU` | The default MTU used in global settings | `1450` | | `WGUI_PERSISTENT_KEEPALIVE` | The default persistent keepalive for WireGuard in global settings | `15` | -| `WGUI_FIREWALL_MARK` | The default WireGuard firewall mark | `0xca6c` (51820) | +| `WGUI_FIREWALL_MARK` | The default WireGuard firewall mark | `0xca6c` (51820) | | `WGUI_CONFIG_FILE_PATH` | The default WireGuard config file path used in global settings | `/etc/wireguard/wg0.conf` | -| `WGUI_LOG_LEVEL` | The default log level. Possible values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF` | `INFO` | | +| `WGUI_LOG_LEVEL` | The default log level. Possible values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF` | `INFO` | | `WG_CONF_TEMPLATE` | The custom `wg.conf` config file template. Please refer to our [default template](https://github.com/ngoduykhanh/wireguard-ui/blob/master/templates/wg.conf) | N/A | | `EMAIL_FROM_ADDRESS` | The sender email address | N/A | | `EMAIL_FROM_NAME` | The sender name | `WireGuard UI` | diff --git a/util/util.go b/util/util.go index 04950f9..35568da 100644 --- a/util/util.go +++ b/util/util.go @@ -220,10 +220,12 @@ func GetPublicIP() (model.Interface, error) { ip, err := consensus.ExternalIP() if err != nil { publicInterface.IPAddress = "N/A" + } else { + publicInterface.IPAddress = ip.String() } - publicInterface.IPAddress = ip.String() - return publicInterface, err + // error handling happend above, no need to pass it through + return publicInterface, nil } // GetIPFromCIDR get ip from CIDR From c8240fe15791d375f5f3441c47cc67cf1d9c856b Mon Sep 17 00:00:00 2001 From: Arminas Date: Wed, 15 Mar 2023 22:45:46 +0200 Subject: [PATCH 17/23] fixed about page not showing menu items (#343) --- handler/routes.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/handler/routes.go b/handler/routes.go index 4f76d22..96be22d 100644 --- a/handler/routes.go +++ b/handler/routes.go @@ -1012,7 +1012,7 @@ func GetHashesChanges(db store.IStore) echo.HandlerFunc { func AboutPage() echo.HandlerFunc { return func(c echo.Context) error { return c.Render(http.StatusOK, "about.html", map[string]interface{}{ - "baseData": model.BaseData{Active: "about", CurrentUser: currentUser(c)}, + "baseData": model.BaseData{Active: "about", CurrentUser: currentUser(c), Admin: isAdmin(c)}, }) } } From e3e363944344ac667f384d8e8bd50df2942eea9b Mon Sep 17 00:00:00 2001 From: Khanh Ngo Date: Wed, 15 Mar 2023 21:50:46 +0100 Subject: [PATCH 18/23] Bracket fixes --- util/util.go | 1 + 1 file changed, 1 insertion(+) diff --git a/util/util.go b/util/util.go index 35568da..b62752d 100644 --- a/util/util.go +++ b/util/util.go @@ -480,6 +480,7 @@ func ParseLogLevel(lvl string) (log.Lvl, error) { default: return log.DEBUG, fmt.Errorf("not a valid log level: %s", lvl) } +} // GetCurrentHash returns current hashes func GetCurrentHash(db store.IStore) (string, string) { From 4fc52b62d21614325d61cc1787dd95bacec9841c Mon Sep 17 00:00:00 2001 From: ByteDream <63594396+ByteDream@users.noreply.github.com> Date: Thu, 16 Mar 2023 08:40:04 +0100 Subject: [PATCH 19/23] Replace go.rice with native go embedding (#331) --- .github/workflows/release.yml | 10 +-------- .gitignore | 1 - Dockerfile | 7 +------ README.md | 11 +--------- go.mod | 3 +-- go.sum | 9 --------- handler/routes.go | 9 ++++----- main.go | 38 +++++++++++++++++++++++------------ router/router.go | 24 +++++++++++----------- util/util.go | 18 ++++++++++++++--- 10 files changed, 60 insertions(+), 70 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8907d06..feb4c93 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -40,20 +40,12 @@ jobs: node-version: '14' registry-url: 'https://registry.npmjs.org' - # prepare assets for go rice + # prepare assets - name: Prepare assets run: | chmod +x ./prepare_assets.sh ./prepare_assets.sh - # get go rice tool - - name: Get go rice tool - run: go get github.com/GeertJohan/go.rice/rice - - # run go rice embed - - name: Run go rice embed - run: ${HOME}/go/bin/rice embed-go - # build and make the releases - name: Build and make the releases uses: wangyoucao577/go-release-action@master diff --git a/.gitignore b/.gitignore index b8e3cf3..f1e3f44 100644 --- a/.gitignore +++ b/.gitignore @@ -16,7 +16,6 @@ wireguard-ui vendor/ assets/ node_modules/ -rice-box.go # IDEs .vscode diff --git a/Dockerfile b/Dockerfile index e4d5525..e42603b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -43,10 +43,6 @@ RUN mkdir -p assets/plugins && \ /build/node_modules/jquery-tags-input/ \ assets/plugins/ -# Get go modules and build tool -RUN go mod download && \ - go get github.com/GeertJohan/go.rice/rice - # Add sources COPY . /build @@ -54,8 +50,7 @@ COPY . /build RUN cp -r /build/custom/ assets/ # Build -RUN rice embed-go && \ - CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -ldflags="-X main.gitCommit=${COMMIT}" -a -o wg-ui . +RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -ldflags="-X main.gitCommit=${COMMIT}" -a -o wg-ui . # Release stage FROM alpine:3.16 diff --git a/README.md b/README.md index 7eca337..7fc3207 100644 --- a/README.md +++ b/README.md @@ -211,18 +211,9 @@ Prepare the assets directory ./prepare_assets.sh ``` -Then you can embed resources by generating Go source code - -```sh -rice embed-go -go build -o wireguard-ui -``` - -Or, append resources to executable as zip file - +Then build your executable ```sh go build -o wireguard-ui -rice append --exec wireguard-ui ``` ## License diff --git a/go.mod b/go.mod index d7c4a16..5842acb 100644 --- a/go.mod +++ b/go.mod @@ -1,9 +1,8 @@ module github.com/ngoduykhanh/wireguard-ui -go 1.14 +go 1.16 require ( - github.com/GeertJohan/go.rice v1.0.2 github.com/glendc/go-external-ip v0.0.0-20170425150139-139229dcdddd github.com/go-playground/universal-translator v0.17.0 // indirect github.com/gorilla/sessions v1.2.0 diff --git a/go.sum b/go.sum index 814f123..ee957cb 100644 --- a/go.sum +++ b/go.sum @@ -1,8 +1,4 @@ -github.com/GeertJohan/go.incremental v1.0.0/go.mod h1:6fAjUhbVuX1KcMD3c8TEgVUqmo4seqhv0i0kdATSkM0= -github.com/GeertJohan/go.rice v1.0.2 h1:PtRw+Tg3oa3HYwiDBZyvOJ8LdIyf6lAovJJtr7YOAYk= -github.com/GeertJohan/go.rice v1.0.2/go.mod h1:af5vUNlDNkCjOZeSGFgIJxDje9qdjsO6hshx0gTmZt4= github.com/Knetic/govaluate v3.0.1-0.20171022003610-9aa49832a739+incompatible/go.mod h1:r7JcOSlj0wfOMncg0iLm8Leh48TZaKVeNIfJntJ2wa0= -github.com/akavel/rsrc v0.8.0/go.mod h1:uLoCtb9J+EyAqh+26kdrTgmzRBFPGOolLWKpdxkKq+c= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= github.com/appleboy/gofight/v2 v2.1.2/go.mod h1:frW+U1QZEdDgixycTj4CygQ48yLTUhplt43+Wczp3rw= @@ -12,8 +8,6 @@ github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6r github.com/casbin/casbin/v2 v2.0.0/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ= github.com/codahale/hdrhistogram v0.0.0-20161010025455-3a0bb77429bd/go.mod h1:sE/e/2PUdi/liOCUjSTXgM1o87ZssimdTWN964YiIeI= github.com/coreos/bbolt v1.3.1-coreos.6.0.20180223184059-4f5275f4ebbf/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= -github.com/daaku/go.zipexe v1.0.0 h1:VSOgZtH418pH9L16hC/JrgSNJbbAL26pj7lmD1+CGdY= -github.com/daaku/go.zipexe v1.0.0/go.mod h1:z8IiR6TsVLEYKwXAoE/I+8ys/sDkgTzSL0CLnGVd57E= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= @@ -52,7 +46,6 @@ github.com/gorilla/sessions v1.2.0/go.mod h1:dk2InVEVJ0sfLlnXv9EAgkf6ecYs/i80K/z github.com/jcelliott/lumber v0.0.0-20160324203708-dd349441af25 h1:EFT6MH3igZK/dIVqgGbTqWVvkZ7wJ5iGN03SVtvvdd8= github.com/jcelliott/lumber v0.0.0-20160324203708-dd349441af25/go.mod h1:sWkGw/wsaHtRsT9zGQ/WyJCotGWG/Anow/9hsAcBWRw= github.com/jessevdk/go-flags v0.0.0-20150816100521-1acbbaff2f34/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= -github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= github.com/josharian/native v0.0.0-20200817173448-b6b71def0850 h1:uhL5Gw7BINiiPAo24A2sxkcDI0Jt/sqp1v5xQCniEFA= github.com/josharian/native v0.0.0-20200817173448-b6b71def0850/go.mod h1:7X/raswPFr05uY3HiLlYeyQntB6OO7E/d2Cu7qoaN2w= github.com/jsimonetti/rtnetlink v0.0.0-20190606172950-9527aa82566a/go.mod h1:Oz+70psSo5OFh8DBl0Zv2ACw7Esh6pPUphlvZG9x7uw= @@ -109,7 +102,6 @@ github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJ github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= -github.com/nkovacs/streamquote v1.0.0/go.mod h1:BN+NaZ2CmdKqUuTUXUEm9j95B2TRbpOWpxbJYzzgUsc= github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o= github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= @@ -252,7 +244,6 @@ golang.zx2c4.com/wireguard v0.0.0-20210427022245-097af6e1351b/go.mod h1:a057zjmo golang.zx2c4.com/wireguard/wgctrl v0.0.0-20210803171230-4253848d036c h1:ADNrRDI5NR23/TUCnEmlLZLt4u9DnZ2nwRkPrAcFvto= golang.zx2c4.com/wireguard/wgctrl v0.0.0-20210803171230-4253848d036c/go.mod h1:+1XihzyZUBJcSc5WO9SwNA7v26puQwOEDwanaxfNXPQ= gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= -gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/go-playground/assert.v1 v1.2.1 h1:xoYuJVE7KT85PYWrN730RguIQO0ePzVRfFMXadIrXTM= gopkg.in/go-playground/assert.v1 v1.2.1/go.mod h1:9RXL0bg/zibRAgZUYszZSwO/z8Y/a8bDuhia5mkpMnE= diff --git a/handler/routes.go b/handler/routes.go index 96be22d..d43d75f 100644 --- a/handler/routes.go +++ b/handler/routes.go @@ -5,13 +5,13 @@ import ( "encoding/base64" "encoding/json" "fmt" + "io/fs" "net/http" "os" "sort" "strings" "time" - rice "github.com/GeertJohan/go.rice" "github.com/gorilla/sessions" "github.com/labstack/echo-contrib/session" "github.com/labstack/echo/v4" @@ -948,7 +948,7 @@ func SuggestIPAllocation(db store.IStore) echo.HandlerFunc { } // ApplyServerConfig handler to write config file and restart Wireguard server -func ApplyServerConfig(db store.IStore, tmplBox *rice.Box) echo.HandlerFunc { +func ApplyServerConfig(db store.IStore, tmplDir fs.FS) echo.HandlerFunc { return func(c echo.Context) error { server, err := db.GetServer() @@ -976,14 +976,14 @@ func ApplyServerConfig(db store.IStore, tmplBox *rice.Box) echo.HandlerFunc { } // Write config file - err = util.WriteWireGuardServerConfig(tmplBox, server, clients, users, settings) + err = util.WriteWireGuardServerConfig(tmplDir, server, clients, users, settings) if err != nil { log.Error("Cannot apply server config: ", err) return c.JSON(http.StatusInternalServerError, jsonHTTPResponse{ false, fmt.Sprintf("Cannot apply server config: %v", err), }) } - + err = util.UpdateHashes(db) if err != nil { log.Error("Cannot update hashes: ", err) @@ -1016,4 +1016,3 @@ func AboutPage() echo.HandlerFunc { }) } } - diff --git a/main.go b/main.go index ccd163a..2fb2d03 100644 --- a/main.go +++ b/main.go @@ -1,16 +1,17 @@ package main import ( + "embed" "flag" "fmt" "github.com/labstack/echo/v4" "github.com/labstack/gommon/log" "github.com/ngoduykhanh/wireguard-ui/store" + "io/fs" "net/http" "os" "time" - rice "github.com/GeertJohan/go.rice" "github.com/ngoduykhanh/wireguard-ui/emailer" "github.com/ngoduykhanh/wireguard-ui/handler" "github.com/ngoduykhanh/wireguard-ui/router" @@ -51,6 +52,16 @@ const ( ` ) +// embed the "templates" directory +// +//go:embed templates/* +var embeddedTemplates embed.FS + +// embed the "assets" directory +// +//go:embed assets/* +var embeddedAssets embed.FS + func init() { // command-line flags and env variables @@ -122,17 +133,15 @@ func main() { extraData["gitCommit"] = gitCommit extraData["basePath"] = util.BasePath - // create rice box for embedded template - tmplBox := rice.MustFindBox("templates") - - // rice file server for assets. "assets" is the folder where the files come from. - assetHandler := http.FileServer(rice.MustFindBox("assets").HTTPBox()) + // strip the "templates/" prefix from the embedded directory so files can be read by their direct name (e.g. + // "base.html" instead of "templates/base.html") + tmplDir, _ := fs.Sub(fs.FS(embeddedTemplates), "templates") // create the wireguard config on start, if it doesn't exist - initServerConfig(db, tmplBox) + initServerConfig(db, tmplDir) // register routes - app := router.New(tmplBox, extraData, util.SessionSecret) + app := router.New(tmplDir, extraData, util.SessionSecret) app.GET(util.BasePath, handler.WireGuardClients(db), handler.ValidSession) @@ -170,26 +179,29 @@ func main() { app.POST(util.BasePath+"/wg-server/interfaces", handler.WireGuardServerInterfaces(db), handler.ValidSession, handler.ContentTypeJson, handler.NeedsAdmin) app.POST(util.BasePath+"/wg-server/keypair", handler.WireGuardServerKeyPair(db), handler.ValidSession, handler.ContentTypeJson, handler.NeedsAdmin) app.GET(util.BasePath+"/global-settings", handler.GlobalSettings(db), handler.ValidSession, handler.NeedsAdmin) - app.POST(util.BasePath+"/global-settings", handler.GlobalSettingSubmit(db), handler.ValidSession, handler.ContentTypeJson, handler.NeedsAdmin) app.GET(util.BasePath+"/status", handler.Status(db), handler.ValidSession) app.GET(util.BasePath+"/api/clients", handler.GetClients(db), handler.ValidSession) app.GET(util.BasePath+"/api/client/:id", handler.GetClient(db), handler.ValidSession) app.GET(util.BasePath+"/api/machine-ips", handler.MachineIPAddresses(), handler.ValidSession) app.GET(util.BasePath+"/api/suggest-client-ips", handler.SuggestIPAllocation(db), handler.ValidSession) - app.POST(util.BasePath+"/api/apply-wg-config", handler.ApplyServerConfig(db, tmplBox), handler.ValidSession, handler.ContentTypeJson) + app.POST(util.BasePath+"/api/apply-wg-config", handler.ApplyServerConfig(db, tmplDir), handler.ValidSession, handler.ContentTypeJson) app.GET(util.BasePath+"/wake_on_lan_hosts", handler.GetWakeOnLanHosts(db), handler.ValidSession) app.POST(util.BasePath+"/wake_on_lan_host", handler.SaveWakeOnLanHost(db), handler.ValidSession, handler.ContentTypeJson) app.DELETE(util.BasePath+"/wake_on_lan_host/:mac_address", handler.DeleteWakeOnHost(db), handler.ValidSession, handler.ContentTypeJson) app.PUT(util.BasePath+"/wake_on_lan_host/:mac_address", handler.WakeOnHost(db), handler.ValidSession, handler.ContentTypeJson) - // servers other static files + // strip the "assets/" prefix from the embedded directory so files can be called directly without the "assets/" + // prefix + assetsDir, _ := fs.Sub(fs.FS(embeddedAssets), "assets") + assetHandler := http.FileServer(http.FS(assetsDir)) + // serves other static files app.GET(util.BasePath+"/static/*", echo.WrapHandler(http.StripPrefix(util.BasePath+"/static/", assetHandler))) app.Logger.Fatal(app.Start(util.BindAddress)) } -func initServerConfig(db store.IStore, tmplBox *rice.Box) { +func initServerConfig(db store.IStore, tmplDir fs.FS) { settings, err := db.GetGlobalSettings() if err != nil { log.Fatalf("Cannot get global settings: ", err) @@ -216,7 +228,7 @@ func initServerConfig(db store.IStore, tmplBox *rice.Box) { } // write config file - err = util.WriteWireGuardServerConfig(tmplBox, server, clients, users, settings) + err = util.WriteWireGuardServerConfig(tmplDir, server, clients, users, settings) if err != nil { log.Fatalf("Cannot create server config: ", err) } diff --git a/router/router.go b/router/router.go index cdc6424..c2d1943 100644 --- a/router/router.go +++ b/router/router.go @@ -3,11 +3,11 @@ package router import ( "errors" "io" + "io/fs" "reflect" "strings" "text/template" - rice "github.com/GeertJohan/go.rice" "github.com/gorilla/sessions" "github.com/labstack/echo-contrib/session" "github.com/labstack/echo/v4" @@ -48,57 +48,57 @@ func (t *TemplateRegistry) Render(w io.Writer, name string, data interface{}, c } // New function -func New(tmplBox *rice.Box, extraData map[string]string, secret []byte) *echo.Echo { +func New(tmplDir fs.FS, extraData map[string]string, secret []byte) *echo.Echo { e := echo.New() e.Use(session.Middleware(sessions.NewCookieStore(secret))) // read html template file to string - tmplBaseString, err := tmplBox.String("base.html") + tmplBaseString, err := util.StringFromEmbedFile(tmplDir, "base.html") if err != nil { log.Fatal(err) } - tmplLoginString, err := tmplBox.String("login.html") + tmplLoginString, err := util.StringFromEmbedFile(tmplDir, "login.html") if err != nil { log.Fatal(err) } - tmplProfileString, err := tmplBox.String("profile.html") + tmplProfileString, err := util.StringFromEmbedFile(tmplDir, "profile.html") if err != nil { log.Fatal(err) } - tmplClientsString, err := tmplBox.String("clients.html") + tmplClientsString, err := util.StringFromEmbedFile(tmplDir, "clients.html") if err != nil { log.Fatal(err) } - tmplServerString, err := tmplBox.String("server.html") + tmplServerString, err := util.StringFromEmbedFile(tmplDir, "server.html") if err != nil { log.Fatal(err) } - tmplGlobalSettingsString, err := tmplBox.String("global_settings.html") + tmplGlobalSettingsString, err := util.StringFromEmbedFile(tmplDir, "global_settings.html") if err != nil { log.Fatal(err) } - tmplUsersSettingsString, err := tmplBox.String("users_settings.html") + tmplUsersSettingsString, err := util.StringFromEmbedFile(tmplDir, "users_settings.html") if err != nil { log.Fatal(err) } - tmplStatusString, err := tmplBox.String("status.html") + tmplStatusString, err := util.StringFromEmbedFile(tmplDir, "status.html") if err != nil { log.Fatal(err) } - tmplWakeOnLanHostsString, err := tmplBox.String("wake_on_lan_hosts.html") + tmplWakeOnLanHostsString, err := util.StringFromEmbedFile(tmplDir, "wake_on_lan_hosts.html") if err != nil { log.Fatal(err) } - aboutPageString, err := tmplBox.String("about.html") + aboutPageString, err := util.StringFromEmbedFile(tmplDir, "about.html") if err != nil { log.Fatal(err) } diff --git a/util/util.go b/util/util.go index b62752d..7b93a57 100644 --- a/util/util.go +++ b/util/util.go @@ -7,6 +7,7 @@ import ( "github.com/ngoduykhanh/wireguard-ui/store" "golang.org/x/mod/sumdb/dirhash" "io" + "io/fs" "io/ioutil" "net" "os" @@ -17,7 +18,6 @@ import ( "text/template" "time" - rice "github.com/GeertJohan/go.rice" externalip "github.com/glendc/go-external-ip" "github.com/labstack/gommon/log" "github.com/ngoduykhanh/wireguard-ui/model" @@ -382,7 +382,7 @@ func ValidateIPAllocation(serverAddresses []string, ipAllocatedList []string, ip } // WriteWireGuardServerConfig to write Wireguard server config. e.g. wg0.conf -func WriteWireGuardServerConfig(tmplBox *rice.Box, serverConfig model.Server, clientDataList []model.ClientData, usersList []model.User, globalSettings model.GlobalSetting) error { +func WriteWireGuardServerConfig(tmplDir fs.FS, serverConfig model.Server, clientDataList []model.ClientData, usersList []model.User, globalSettings model.GlobalSetting) error { var tmplWireguardConf string // if set, read wg.conf template from WgConfTemplate @@ -394,7 +394,7 @@ func WriteWireGuardServerConfig(tmplBox *rice.Box, serverConfig model.Server, cl tmplWireguardConf = string(fileContentBytes) } else { // read default wg.conf template file to string - fileContent, err := tmplBox.String("wg.conf") + fileContent, err := StringFromEmbedFile(tmplDir, "wg.conf") if err != nil { return err } @@ -465,6 +465,18 @@ func LookupEnvOrStrings(key string, defaultVal []string) []string { return defaultVal } +func StringFromEmbedFile(embed fs.FS, filename string) (string, error) { + file, err := embed.Open(filename) + if err != nil { + return "", err + } + content, err := io.ReadAll(file) + if err != nil { + return "", err + } + return string(content), nil +} + func ParseLogLevel(lvl string) (log.Lvl, error) { switch strings.ToLower(lvl) { case "debug": From 00f7f3d280b90fdaa15faf48379d509b1b37e135 Mon Sep 17 00:00:00 2001 From: Khanh Ngo Date: Thu, 16 Mar 2023 08:58:28 +0100 Subject: [PATCH 20/23] Style fixes --- templates/base.html | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/templates/base.html b/templates/base.html index 6c2e3f3..181049d 100644 --- a/templates/base.html +++ b/templates/base.html @@ -56,13 +56,15 @@
    - +
    + +
    From d3c47c53c8460b108ac1a0833f77cc0a3dcce33a Mon Sep 17 00:00:00 2001 From: Khanh Ngo Date: Thu, 16 Mar 2023 09:09:48 +0100 Subject: [PATCH 21/23] QR code fixes --- templates/clients.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/templates/clients.html b/templates/clients.html index 513797c..0fa98f7 100644 --- a/templates/clients.html +++ b/templates/clients.html @@ -481,7 +481,9 @@ Wireguard Clients cache: false, method: 'GET', url: '{{.basePath}}/api/client/' + client_id, - data: JSON.stringify(data), + data: { + qrCodeIncludeFwMark: include_fwmark + }, dataType: 'json', contentType: "application/json", success: function (resp) { From 5e0217db049ae0adc8947fa796f9614301603fd6 Mon Sep 17 00:00:00 2001 From: Khanh Ngo Date: Thu, 16 Mar 2023 16:25:38 +0100 Subject: [PATCH 22/23] Set password type field --- templates/users_settings.html | 2 +- util/util.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/templates/users_settings.html b/templates/users_settings.html index 05d8878..6fb8d69 100644 --- a/templates/users_settings.html +++ b/templates/users_settings.html @@ -42,7 +42,7 @@ Users Settings
    -
    diff --git a/util/util.go b/util/util.go index 7b93a57..4d4b9b3 100644 --- a/util/util.go +++ b/util/util.go @@ -514,11 +514,11 @@ func HashesChanged(db store.IStore) bool { newClient, newServer := GetCurrentHash(db) if oldClient != newClient { - fmt.Println("Hash for client differs") + //fmt.Println("Hash for client differs") return true } if oldServer != newServer { - fmt.Println("Hash for server differs") + //fmt.Println("Hash for server differs") return true } return false From ac99317ba3ff35eb169b6acc561ecf6f674f4062 Mon Sep 17 00:00:00 2001 From: Khanh Ngo Date: Fri, 17 Mar 2023 09:53:57 +0100 Subject: [PATCH 23/23] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7fc3207..62eef0d 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,11 @@ or docker compose build --build-arg=COMMIT=$(git rev-parse --short HEAD) ``` +:information_source: A container image is avaialble on [Docker Hub](https://hub.docker.com/r/ngoduykhanh/wireguard-ui) which you can pull and use +``` +docker pull ngoduykhanh/wireguard-ui +```` + ### Build binary file Prepare the assets directory