Merge branch 'master' of github:nanhantianyi/wireguard-ui into clients-patch

README.md

@@ -49,10 +49,10 @@ Note:
 | Variable                    | Description                                                                                                                                                  | Default                            |
 |-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
 | `BASE_PATH`                 | Set this variable if you run wireguard-ui under a subpath of your reverse proxy virtual host (e.g. /wireguard))                                              | N/A                                |
-| `SESSION_SECRET`            | The secret key used to encrypt the session cookies. Set this to a random value.                                                                              | N/A                                |
+| `SESSION_SECRET`            | The secret key used to encrypt the session cookies. Set this to a random value                                                                               | N/A                                |
-| `WGUI_USERNAME`             | The username for the login page                                                                                                                              | `admin`                            |
+| `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                                                                                    | `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`)                                                                           | N/A                                |
+| `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                                                                                                         | 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`                             |
@@ -98,7 +98,7 @@ These environment variables only apply to the docker container.
 
 | Variable              | Description                                                   | Default |
 |-----------------------|---------------------------------------------------------------|---------|
-| `WGUI_MANAGE_START`   | Start/stop WireGaurd when the container is started/stopped    | `false` |
+| `WGUI_MANAGE_START`   | Start/stop WireGuard when the container is started/stopped    | `false` |
 | `WGUI_MANAGE_RESTART` | Auto restart WireGuard when we Apply Config changes in the UI | `false` |
 
 ## Auto restart WireGuard daemon

handler/routes.go

@@ -100,6 +100,63 @@ func Logout() echo.HandlerFunc {
 	}
 }
 
+// LoadProfile to load user information
+func LoadProfile(db store.IStore) echo.HandlerFunc {
+	return func(c echo.Context) error {
+
+		userInfo, err := db.GetUser()
+		if err != nil {
+			log.Error("Cannot get user information: ", err)
+		}
+
+		return c.Render(http.StatusOK, "profile.html", map[string]interface{}{
+			"baseData": model.BaseData{Active: "profile", CurrentUser: currentUser(c)},
+			"userInfo": userInfo,
+		})
+	}
+}
+
+// UpdateProfile to update user information
+func UpdateProfile(db store.IStore) echo.HandlerFunc {
+	return func(c echo.Context) error {
+		data := make(map[string]interface{})
+		err := json.NewDecoder(c.Request().Body).Decode(&data)
+
+		if err != nil {
+			return c.JSON(http.StatusBadRequest, jsonHTTPResponse{false, "Bad post data"})
+		}
+
+		username := data["username"].(string)
+		password := data["password"].(string)
+
+		user, err := db.GetUser()
+		if err != nil {
+			return c.JSON(http.StatusNotFound, jsonHTTPResponse{false, err.Error()})
+		}
+
+		if username == "" {
+			return c.JSON(http.StatusBadRequest, jsonHTTPResponse{false, "Please provide a valid username"})
+		} else {
+			user.Username = username
+		}
+
+		if password != "" {
+			hash, err := util.HashPassword(password)
+			if err != nil {
+				return c.JSON(http.StatusInternalServerError, jsonHTTPResponse{false, err.Error()})
+			}
+			user.PasswordHash = hash
+		}
+
+		if err := db.SaveUser(user); err != nil {
+			return c.JSON(http.StatusInternalServerError, jsonHTTPResponse{false, err.Error()})
+		}
+		log.Infof("Updated admin user information successfully")
+
+		return c.JSON(http.StatusOK, jsonHTTPResponse{true, "Updated admin user information successfully"})
+	}
+}
+
 // WireGuardClients handler
 func WireGuardClients(db store.IStore) echo.HandlerFunc {
 	return func(c echo.Context) error {
@@ -118,7 +175,7 @@ func WireGuardClients(db store.IStore) echo.HandlerFunc {
 	}
 }
 
-// GetClients handler return a list of Wireguard client data
+// GetClients handler return a JSON list of Wireguard client data
 func GetClients(db store.IStore) echo.HandlerFunc {
 	return func(c echo.Context) error {
 
@@ -133,7 +190,7 @@ func GetClients(db store.IStore) echo.HandlerFunc {
 	}
 }
 
-// GetClient handler return a of Wireguard client data
+// GetClient handler returns a JSON object of Wireguard client data
 func GetClient(db store.IStore) echo.HandlerFunc {
 	return func(c echo.Context) error {
 

main.go

@@ -135,6 +135,9 @@ func main() {
 	if !util.DisableLogin {
 		app.GET(util.BasePath+"/login", handler.LoginPage())
 		app.POST(util.BasePath+"/login", handler.Login(db))
+		app.GET(util.BasePath+"/logout", handler.Logout(), handler.ValidSession)
+		app.GET(util.BasePath+"/profile", handler.LoadProfile(db), handler.ValidSession)
+		app.POST(util.BasePath+"/profile", handler.UpdateProfile(db), handler.ValidSession)
 	}
 
 	var sendmail emailer.Emailer
@@ -145,7 +148,6 @@ func main() {
 	}
 
 	app.GET(util.BasePath+"/_health", handler.Health())
-	app.GET(util.BasePath+"/logout", handler.Logout(), handler.ValidSession)
 	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)

router/router.go

@@ -63,6 +63,11 @@ func New(tmplBox *rice.Box, extraData map[string]string, secret []byte) *echo.Ec
 		log.Fatal(err)
 	}
 
+	tmplProfileString, err := tmplBox.String("profile.html")
+	if err != nil {
+		log.Fatal(err)
+	}
+
 	tmplClientsString, err := tmplBox.String("clients.html")
 	if err != nil {
 		log.Fatal(err)
@@ -94,6 +99,7 @@ func New(tmplBox *rice.Box, extraData map[string]string, secret []byte) *echo.Ec
 	}
 	templates := make(map[string]*template.Template)
 	templates["login.html"] = template.Must(template.New("login").Funcs(funcs).Parse(tmplLoginString))
+	templates["profile.html"] = template.Must(template.New("profile").Funcs(funcs).Parse(tmplBaseString + tmplProfileString))
 	templates["clients.html"] = template.Must(template.New("clients").Funcs(funcs).Parse(tmplBaseString + tmplClientsString))
 	templates["server.html"] = template.Must(template.New("server").Funcs(funcs).Parse(tmplBaseString + tmplServerString))
 	templates["global_settings.html"] = template.Must(template.New("global_settings").Funcs(funcs).Parse(tmplBaseString + tmplGlobalSettingsString))

store/jsondb/jsondb.go

@@ -127,13 +127,18 @@ func (o *JsonDB) GetUser() (model.User, error) {
 	return user, o.conn.Read("server", "users", &user)
 }
 
+// SaveUser func to user info to the database
+func (o *JsonDB) SaveUser(user model.User) error {
+	return o.conn.Write("server", "users", user)
+}
+
 // GetGlobalSettings func to query global settings from the database
 func (o *JsonDB) GetGlobalSettings() (model.GlobalSetting, error) {
 	settings := model.GlobalSetting{}
 	return settings, o.conn.Read("server", "global_settings", &settings)
 }
 
-// GetServer func to query Server setting from the database
+// GetServer func to query Server settings from the database
 func (o *JsonDB) GetServer() (model.Server, error) {
 	server := model.Server{}
 	// read server interface information
@@ -157,7 +162,7 @@ func (o *JsonDB) GetServer() (model.Server, error) {
 func (o *JsonDB) GetClients(hasQRCode bool) ([]model.ClientData, error) {
 	var clients []model.ClientData
 
-	// read all client json file in "clients" directory
+	// read all client json files in "clients" directory
 	records, err := o.conn.ReadAll("clients")
 	if err != nil {
 		return clients, err
@@ -208,7 +213,9 @@ func (o *JsonDB) GetClientByID(clientID string, qrCodeSettings model.QRCodeSetti
 		server, _ := o.GetServer()
 		globalSettings, _ := o.GetGlobalSettings()
 		client := client
-		client.UseServerDNS = qrCodeSettings.IncludeDNS
+		if !qrCodeSettings.IncludeDNS{
+			globalSettings.DNSServers = []string{}
+		}
 		if !qrCodeSettings.IncludeMTU {
 			globalSettings.MTU = 0
 		}

store/store.go

@@ -7,6 +7,7 @@ import (
 type IStore interface {
 	Init() error
 	GetUser() (model.User, error)
+	SaveUser(user model.User) error
 	GetGlobalSettings() (model.GlobalSetting, error)
 	GetServer() (model.Server, error)
 	GetClients(hasQRCode bool) ([]model.ClientData, error)

templates/base.html

@@ -87,7 +87,11 @@
                         <i class="nav-icon fas fa-2x fa-user"></i>
                     </div>
                     <div class="info">
-                        <a href="#" class="d-block">{{if .baseData.CurrentUser}} {{.baseData.CurrentUser}} {{else}} Administrator {{end}}</a>
+                        {{if .baseData.CurrentUser}}
+                        <a href="{{.basePath}}/profile" class="d-block">{{.baseData.CurrentUser}}</a>
+                        {{else}}
+                        <a href="#" class="d-block">Administrator</a>
+                        {{end}}
                     </div>
                 </div>
 

templates/clients.html

@@ -429,7 +429,7 @@ Wireguard Clients
             });
         }
 
-        // submitEmailClient function for sending an email to the client with the configuration
+        // submitEmailClient function for sending an email with the configuration to the client
         function submitEmailClient() {
             const client_id = $("#e_client_id").val();
             const email = $("#e_client_email").val();

templates/global_settings.html

@@ -199,6 +199,7 @@ Global Settings
 
         // Load DNS server to the form
         {{range .globalSettings.DNSServers}}
+        $("#dns_servers").removeTag('{{.}}');
         $("#dns_servers").addTag('{{.}}');
         {{end}}
 

templates/profile.html

@@ -0,0 +1,110 @@
+{{ define "title"}}
+Profile
+{{ end }}
+
+{{ define "top_css"}}
+{{ end }}
+
+{{ define "username"}}
+{{ .username }}
+{{ end }}
+
+{{ define "page_title"}}
+Profile
+{{ end }}
+
+{{ define "page_content"}}
+<section class="content">
+    <div class="container-fluid">
+        <!-- <h5 class="mt-4 mb-2">Global Settings</h5> -->
+        <div class="row">
+            <!-- left column -->
+            <div class="col-md-6">
+                <div class="card card-success">
+                    <div class="card-header">
+                        <h3 class="card-title">Update user information</h3>
+                    </div>
+                    <!-- /.card-header -->
+                    <!-- form start -->
+                    <form role="form" id="frm_profile" name="frm_profile">
+                        <div class="card-body">
+                            <div class="form-group">
+                                <label for="username" class="control-label">Username</label>
+                                <input type="text" class="form-control" name="username" id="username"
+                                       value="{{ .userInfo.Username }}">
+                            </div>
+                            <div class="form-group">
+                                <label for="password" class="control-label">Password</label>
+                                <input type="password" class="form-control" name="password" id="password"
+                                       value="" placeholder="Leave empty to keep the password unchanged">
+                            </div>
+                            <!-- /.card-body -->
+                            <div class="card-footer">
+                                <button type="submit" class="btn btn-success" id="update">Update</button>
+                            </div>
+                        </div>
+                    </form>
+                </div>
+                <!-- /.card -->
+            </div>
+        </div>
+        <!-- /.row -->
+    </div>
+</section>
+{{ end }}
+
+{{ define "bottom_js"}}
+<script>
+  function updateUserInfo() {
+    const username = $("#username").val();
+    const password = $("#password").val();
+    const data = {"username": username, "password": password};
+    $.ajax({
+      cache: false,
+      method: 'POST',
+      url: '{{.basePath}}/profile',
+      dataType: 'json',
+      contentType: "application/json",
+      data: JSON.stringify(data),
+      success: function (data) {
+        toastr.success("Updated admin user information successfully");
+      },
+      error: function (jqXHR, exception) {
+        const responseJson = jQuery.parseJSON(jqXHR.responseText);
+        toastr.error(responseJson['message']);
+      }
+    });
+  }
+
+  $(document).ready(function () {
+    $.validator.setDefaults({
+      submitHandler: function () {
+        updateUserInfo();
+      }
+    });
+    $("#frm_profile").validate({
+      rules: {
+        username: {
+          required: true
+        }
+      },
+      messages: {
+        username: {
+          required: "Please enter a username",
+        }
+      },
+      errorElement: 'span',
+      errorPlacement: function (error, element) {
+        error.addClass('invalid-feedback');
+        element.closest('.form-group').append(error);
+      },
+      highlight: function (element, errorClass, validClass) {
+        $(element).addClass('is-invalid');
+      },
+      unhighlight: function (element, errorClass, validClass) {
+        $(element).removeClass('is-invalid');
+      }
+    });
+  });
+</script>
+{{ end }}

templates/server.html

@@ -110,7 +110,7 @@ Wireguard Server Settings
             </div>
             <div class="modal-body">
                 <p>Are you sure to generate a new key pair for the Wireguard server?<br/>
-                The existing Clients's peer public key need to be updated to keep the connection working.</p>
+                The existing Client's peer public key need to be updated to keep the connection working.</p>
             </div>
             <div class="modal-footer justify-content-between">
                 <button type="button" class="btn btn-outline-dark" data-dismiss="modal">Cancel</button>
@@ -165,6 +165,7 @@ Wireguard Server Settings
 
         // Load server addresses to the form
         {{range .serverInterface.Addresses}}
+        $("#addresses").removeTag('{{.}}');
         $("#addresses").addTag('{{.}}');
         {{end}}