cli: add '--show-password' option for 'nmcli device wifi hotspot'

It is useful to show nmcli-generated hotspot password (if a user does not
provide his own password). Without the option the user would have to look into
the generated profile in order to find out the password.

diff --git a/clients/cli/devices.c b/clients/cli/devices.c
index 03eea15..0c38419 100644 (file)
--- a/clients/cli/devices.c
+++ b/clients/cli/devices.c
@@ -268,7 +268,7 @@ usage (void)
                      "  wifi connect <(B)SSID> [password <password>] [wep-key-type key|phrase] [ifname <ifname>]\n"
                      "                         [bssid <BSSID>] [name <name>] [private yes|no] [hidden yes|no]\n\n"
                      "  wifi hotspot [ifname <ifname>] [con-name <name>] [ssid <SSID>] [band a|bg] [channel <channel>]\n\n"
-                     "               [password <password>]\n\n"
+                     "               [password <password>] [--show-password]\n\n"
                      "  wifi rescan [ifname <ifname>] [[ssid <SSID to scan>] ...]\n\n"
                      ));
 }
@@ -375,6 +375,7 @@ usage_device_wifi (void)
                      "\n"
                      "ARGUMENTS := wifi hotspot [ifname <ifname>] [con-name <name>] [ssid <SSID>]\n"
                      "                          [band a|bg] [channel <channel>] [password <password>]\n"
+                     "                          [--show-password]\n"
                      "\n"
                      "Create a Wi-Fi hotspot. Use 'connection down' or 'device disconnect'\n"
                      "to stop the hotspot.\n"
@@ -385,6 +386,7 @@ usage_device_wifi (void)
                      "band - Wi-Fi band to use\n"
                      "channel - Wi-Fi channel to use\n"
                      "password - password to use for the hotspot\n"
+                     "--show-password - tell nmcli to print password to stdout\n"
                      "\n"
                      "ARGUMENTS := rescan [ifname <ifname>] [[ssid <SSID to scan>] ...]\n"
                      "\n"
@@ -2770,6 +2772,7 @@ set_wireless_security_for_hotspot (NMSettingWirelessSecurity *s_wsec,
                                    const char *wifi_mode,
                                    NMDeviceWifiCapabilities caps,
                                    const char *password,
+                                   gboolean show_password,
                                    GError **error)
 {
         char generated_key[11];
@@ -2828,6 +2831,9 @@ set_wireless_security_for_hotspot (NMSettingWirelessSecurity *s_wsec,
                              NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE, NM_WEP_KEY_TYPE_KEY,
                              NULL);
        }
+       if (show_password)
+               g_print (_("Hotspot password: %s\n"), key);
+
        return TRUE;
 }
 
@@ -2844,6 +2850,7 @@ do_device_wifi_hotspot (NmCli *nmc, int argc, char **argv)
        const char *channel = NULL;
        unsigned long channel_int;
        const char *password = NULL;
+       gboolean show_password = FALSE;
        NMDevice *device = NULL;
        int devices_idx;
        const GPtrArray *devices;
@@ -2914,6 +2921,8 @@ do_device_wifi_hotspot (NmCli *nmc, int argc, char **argv)
                                goto error;
                        }
                        password = *argv;
+               } else if (nmc_arg_is_option (*argv, "show-password")) {
+                       show_password = TRUE;
                } else {
                        g_string_printf (nmc->return_text, _("Error: Unknown parameter %s."), *argv);
                        nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
@@ -3000,7 +3009,7 @@ do_device_wifi_hotspot (NmCli *nmc, int argc, char **argv)
 
        s_wsec = (NMSettingWirelessSecurity *) nm_setting_wireless_security_new ();
        nm_connection_add_setting (connection, NM_SETTING (s_wsec));
-       if (!set_wireless_security_for_hotspot (s_wsec, wifi_mode, caps, password, &error)) {
+       if (!set_wireless_security_for_hotspot (s_wsec, wifi_mode, caps, password, show_password, &error)) {
                g_object_unref (connection);
                g_string_printf (nmc->return_text, _("Error: Invalid 'password': %s."), error->message);
                nmc->return_value = NMC_RESULT_ERROR_UNKNOWN;

diff --git a/clients/cli/nmcli-completion b/clients/cli/nmcli-completion
index 62951a1..02364c6 100644 (file)
--- a/clients/cli/nmcli-completion
+++ b/clients/cli/nmcli-completion
@@ -512,6 +512,7 @@ _nmcli_compl_ARGS()
             save| \
             hidden| \
             private)
+            show-password)
                 if [[ "${#words[@]}" -eq 2 ]]; then
                     _nmcli_list "yes no"
                     return 0
@@ -1346,7 +1347,7 @@ _nmcli()
                                     ;;
                                 h|ho|hot|hots|hotsp|hotspo|hotspot)
                                     _nmcli_array_delete_at words 0 2
-                                    OPTIONS=(ifname con-name ssid band channel password)
+                                    OPTIONS=(ifname con-name ssid band channel password show-password)
                                     _nmcli_compl_ARGS
                                     ;;
                                 r|re|res|resc|resca|rescan)

diff --git a/man/nmcli.1.in b/man/nmcli.1.in
index e195b97..61328f0 100644 (file)
--- a/man/nmcli.1.in
+++ b/man/nmcli.1.in
@@ -854,7 +854,7 @@ Otherwise the SSID would not be found and the connection attempt would fail.
 .RE
 .TP
 .B wifi hotspot [ifname <ifname>] [con-name <name>] [ssid <SSID>] [band a|bg] [channel <channel>]
-.B [password <password>]
+.B [password <password>] [--show-password]
 .br
 Create a Wi-Fi hotspot. The command creates a hotspot connection profile according to
 Wi-Fi device capabilities and activates it on the device. The hotspot is secured with WPA
@@ -864,20 +864,23 @@ Use \fIconnection down\fP or \fIdevice disconnect\fP to stop the hotspot.
 .RS
 .PP
 Parameters of the hotspot can be influenced by the optional parameters:
-.IP \fIifname\fP 10
+.IP \fIifname\fP 17
 \(en what Wi-Fi device is used
-.IP \fIcon-name\fP 10
+.IP \fIcon-name\fP 17
 \(en name of the created hotspot connection profile
-.IP \fIssid\fP 10
+.IP \fIssid\fP 17
 \(en SSID of the hotspot
-.IP \fIband\fP 10
+.IP \fIband\fP 17
 \(en Wi-Fi band to use
-.IP \fIchannel\fP 10
+.IP \fIchannel\fP 17
 \(en Wi-Fi channel to use
-.IP \fIpassword\fP 10
+.IP \fIpassword\fP 17
 \(en password to use for the created hotspot. If not provided,
 nmcli will generate a password. The password is either WPA
 pre-shared key or WEP key.
+.IP \fI--show-password\fP 17
+\(en tell nmcli to print the password to stdout. It is useful
+when the user did not provide his own password.
 .RE
 .TP
 .B wifi rescan [ifname <ifname>] [[ssid <SSID>] ...]