mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-07-09 04:05:56 +00:00
cli: add "nmcli d wifi show"
A quick overview of the currently connected Wi-Fi network, including credentials. Comes handy if someone wants to connect more devices to their Hotspot or the same network as they are connected to.
This commit is contained in:
Lubomir Rintel
parent
976eebae73
commit
7061341a41
|
|
@ -4179,6 +4179,10 @@ clients_common_libnmc_base_la_SOURCES = \
|
|||
clients/common/nm-client-utils.h \
|
||||
$(NULL)
|
||||
|
||||
EXTRA_DIST += \
|
||||
clients/common/qrcodegen.c \
|
||||
clients/common/qrcodegen.h
|
||||
|
||||
clients_common_libnmc_base_la_CPPFLAGS = \
|
||||
$(clients_cppflags) \
|
||||
-DG_LOG_DOMAIN=\""libnmc"\" \
|
||||
|
|
|
|||
|
|
@ -696,6 +696,7 @@ usage (void)
|
|||
" [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>] [password <password>]\n\n"
|
||||
" wifi rescan [ifname <ifname>] [[ssid <SSID to scan>] ...]\n\n"
|
||||
" wifi show-password [ifname <ifname>]\n\n"
|
||||
" lldp [list [ifname <ifname>]]\n\n"
|
||||
));
|
||||
}
|
||||
|
|
@ -1829,6 +1830,9 @@ connected_state_cb (AddAndActivateInfo *info)
|
|||
g_print (_("Device '%s' successfully activated with '%s'.\n"),
|
||||
nm_device_get_iface (info->device),
|
||||
nm_active_connection_get_uuid (info->active));
|
||||
|
||||
if (info->hotspot)
|
||||
g_print (_("Hint: \"nmcli dev wifi show-password\" shows the Wi-Fi name and password.\n"));
|
||||
} else if ( state <= NM_DEVICE_STATE_DISCONNECTED
|
||||
|| state >= NM_DEVICE_STATE_DEACTIVATING) {
|
||||
reason = nm_device_get_state_reason (info->device);
|
||||
|
|
@ -4026,12 +4030,221 @@ finish:
|
|||
return nmc->return_value;
|
||||
}
|
||||
|
||||
static void
|
||||
string_append_mecard (GString *string, const char *tag, const char *text)
|
||||
{
|
||||
const char *p;
|
||||
bool is_hex = TRUE;
|
||||
int start;
|
||||
|
||||
if (!text)
|
||||
return;
|
||||
|
||||
g_string_append (string, tag);
|
||||
start = string->len;
|
||||
|
||||
for (p = text; *p; p++) {
|
||||
if (!g_ascii_isxdigit (*p))
|
||||
is_hex = FALSE;
|
||||
if (strchr ("\\\":;,", *p))
|
||||
g_string_append_c (string, '\\');
|
||||
g_string_append_c (string, *p);
|
||||
}
|
||||
|
||||
if (is_hex) {
|
||||
g_string_insert_c (string, start, '\"');
|
||||
g_string_append_c (string, '\"');
|
||||
}
|
||||
g_string_append_c (string, ';');
|
||||
}
|
||||
|
||||
static void
|
||||
print_wifi_connection (const NmcConfig *nmc_config, NMConnection *connection)
|
||||
{
|
||||
NMSettingWireless *s_wireless;
|
||||
NMSettingWirelessSecurity *s_wsec;
|
||||
const char *key_mgmt = NULL;
|
||||
const char *psk = NULL;
|
||||
const char *type = NULL;
|
||||
GBytes *ssid_bytes;
|
||||
char *ssid;
|
||||
GString *string;
|
||||
|
||||
s_wireless = nm_connection_get_setting_wireless (connection);
|
||||
g_return_if_fail (s_wireless);
|
||||
|
||||
ssid_bytes = nm_setting_wireless_get_ssid (s_wireless);
|
||||
g_return_if_fail (ssid_bytes);
|
||||
ssid = nm_utils_ssid_to_utf8 (g_bytes_get_data (ssid_bytes, NULL),
|
||||
g_bytes_get_size (ssid_bytes));
|
||||
g_return_if_fail (ssid);
|
||||
g_print ("SSID: %s\n", ssid);
|
||||
|
||||
string = g_string_sized_new (64);
|
||||
g_string_append (string, "WIFI:");
|
||||
|
||||
s_wsec = nm_connection_get_setting_wireless_security (connection);
|
||||
if (s_wsec) {
|
||||
key_mgmt = nm_setting_wireless_security_get_key_mgmt (s_wsec);
|
||||
psk = nm_setting_wireless_security_get_psk (s_wsec);
|
||||
}
|
||||
|
||||
if (key_mgmt == NULL) {
|
||||
type = "nopass";
|
||||
g_print ("%s: %s\n", _("Security"), _("None"));
|
||||
} else if ( strcmp (key_mgmt, "none") == 0
|
||||
|| strcmp (key_mgmt, "ieee8021x") == 0) {
|
||||
type = "WEP";
|
||||
g_print ("%s: WEP\n", _("Security"));
|
||||
} else if ( strcmp (key_mgmt, "wpa-none") == 0
|
||||
|| strcmp (key_mgmt, "wpa-psk") == 0
|
||||
|| strcmp (key_mgmt, "sae") == 0) {
|
||||
type = "WPA";
|
||||
g_print ("%s: WPA\n", _("Security"));
|
||||
}
|
||||
|
||||
if (psk)
|
||||
g_print ("%s: %s\n", _("Password"), psk);
|
||||
|
||||
string_append_mecard(string, "T:", type);
|
||||
string_append_mecard(string, "S:", ssid);
|
||||
string_append_mecard(string, "P:", psk);
|
||||
|
||||
if (nm_setting_wireless_get_hidden (s_wireless))
|
||||
g_string_append (string, "H:true;");
|
||||
|
||||
g_string_append_c (string, ';');
|
||||
if (nmc_config->use_colors)
|
||||
nmc_print_qrcode (string->str);
|
||||
g_string_free (string, TRUE);
|
||||
|
||||
g_print ("\n");
|
||||
}
|
||||
|
||||
static gboolean
|
||||
wifi_show_device (const NmcConfig *nmc_config, NMDevice *device, GError **error)
|
||||
{
|
||||
NMActiveConnection *active_conn;
|
||||
gs_unref_object NMConnection *connection = NULL;
|
||||
gs_unref_variant GVariant *secrets = NULL;
|
||||
|
||||
if (!NM_IS_DEVICE_WIFI (device)) {
|
||||
g_set_error (error, NMCLI_ERROR, 0,
|
||||
_("Error: Device '%s' is not a Wi-Fi device."),
|
||||
nm_device_get_iface (device));
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
connection = nm_device_get_applied_connection (device, 0, NULL, NULL, error);
|
||||
if (!connection)
|
||||
return FALSE;
|
||||
|
||||
active_conn = nm_device_get_active_connection (device);
|
||||
if (!active_conn) {
|
||||
g_set_error (error, NMCLI_ERROR, 0,
|
||||
_("no active connection on device '%s'"),
|
||||
nm_device_get_iface (device));
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
secrets = nm_remote_connection_get_secrets (nm_active_connection_get_connection (active_conn),
|
||||
NM_SETTING_WIRELESS_SECURITY_SETTING_NAME,
|
||||
NULL,
|
||||
NULL);
|
||||
if (secrets && !nm_connection_update_secrets (connection,
|
||||
NM_SETTING_WIRELESS_SECURITY_SETTING_NAME,
|
||||
secrets,
|
||||
error)) {
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
print_wifi_connection (nmc_config, connection);
|
||||
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
static NMCResultCode
|
||||
do_device_wifi_show_password (NmCli *nmc, int argc, char **argv)
|
||||
{
|
||||
const char *ifname = NULL;
|
||||
gs_free NMDevice **devices = NULL;
|
||||
gs_free_error GError *error = NULL;
|
||||
gboolean found = FALSE;
|
||||
int i;
|
||||
|
||||
devices = nmc_get_devices_sorted (nmc->client);
|
||||
|
||||
next_arg (nmc, &argc, &argv, NULL);
|
||||
while (argc > 0) {
|
||||
if (argc == 1 && nmc->complete)
|
||||
nmc_complete_strings (*argv, "ifname");
|
||||
|
||||
if (strcmp (*argv, "ifname") == 0) {
|
||||
if (ifname) {
|
||||
g_string_printf (nmc->return_text,
|
||||
_("Error: '%s' cannot repeat."),
|
||||
*(argv-1));
|
||||
return NMC_RESULT_ERROR_USER_INPUT;
|
||||
}
|
||||
argc--;
|
||||
argv++;
|
||||
if (!argc) {
|
||||
g_string_printf (nmc->return_text,
|
||||
_("Error: %s argument is missing."),
|
||||
*(argv-1));
|
||||
return NMC_RESULT_ERROR_USER_INPUT;
|
||||
}
|
||||
ifname = *argv;
|
||||
if (argc == 1 && nmc->complete)
|
||||
complete_device (devices, ifname, TRUE);
|
||||
} else if (!nmc->complete) {
|
||||
g_string_printf (nmc->return_text,
|
||||
_("Error: invalid extra argument '%s'."),
|
||||
*argv);
|
||||
return NMC_RESULT_ERROR_USER_INPUT;
|
||||
}
|
||||
|
||||
next_arg (nmc, &argc, &argv, NULL);
|
||||
}
|
||||
|
||||
if (nmc->complete)
|
||||
return nmc->return_value;
|
||||
|
||||
for (i = 0; devices[i]; i++) {
|
||||
if (ifname && g_strcmp0 (nm_device_get_iface (devices[i]), ifname) != 0)
|
||||
continue;
|
||||
|
||||
if (wifi_show_device (&nmc->nmc_config, devices[i], &error)) {
|
||||
found = TRUE;
|
||||
} else {
|
||||
if (ifname) {
|
||||
g_string_printf (nmc->return_text,
|
||||
_("%s"), error->message);
|
||||
return NMC_RESULT_ERROR_UNKNOWN;
|
||||
}
|
||||
g_clear_error (&error);
|
||||
}
|
||||
|
||||
if (ifname)
|
||||
break;
|
||||
}
|
||||
|
||||
if (!found) {
|
||||
g_string_printf (nmc->return_text,
|
||||
_("Error: No Wi-Fi device found."));
|
||||
return NMC_RESULT_ERROR_UNKNOWN;
|
||||
}
|
||||
|
||||
return nmc->return_value;
|
||||
}
|
||||
|
||||
static NMCCommand device_wifi_cmds[] = {
|
||||
{ "list", do_device_wifi_list, NULL, TRUE, TRUE },
|
||||
{ "connect", do_device_wifi_connect, NULL, TRUE, TRUE },
|
||||
{ "hotspot", do_device_wifi_hotspot, NULL, TRUE, TRUE },
|
||||
{ "rescan", do_device_wifi_rescan, NULL, TRUE, TRUE },
|
||||
{ NULL, do_device_wifi_list, NULL, TRUE, TRUE },
|
||||
{ "list", do_device_wifi_list, NULL, TRUE, TRUE },
|
||||
{ "connect", do_device_wifi_connect, NULL, TRUE, TRUE },
|
||||
{ "hotspot", do_device_wifi_hotspot, NULL, TRUE, TRUE },
|
||||
{ "rescan", do_device_wifi_rescan, NULL, TRUE, TRUE },
|
||||
{ "show-password", do_device_wifi_show_password, NULL, TRUE, TRUE },
|
||||
{ NULL, do_device_wifi_list, NULL, TRUE, TRUE },
|
||||
};
|
||||
|
||||
static NMCResultCode
|
||||
|
|
|
|||
|
|
@ -434,14 +434,14 @@ nmc_activation_get_effective_state (NMActiveConnection *active,
|
|||
}
|
||||
|
||||
static gboolean
|
||||
can_show_graphics (void)
|
||||
can_show_utf8 (void)
|
||||
{
|
||||
static gboolean can_show_graphics_set = FALSE;
|
||||
static gboolean can_show_graphics = TRUE;
|
||||
static gboolean can_show_utf8_set = FALSE;
|
||||
static gboolean can_show_utf8 = TRUE;
|
||||
char *locale_str;
|
||||
|
||||
if (G_LIKELY (can_show_graphics_set))
|
||||
return can_show_graphics;
|
||||
if (G_LIKELY (can_show_utf8_set))
|
||||
return can_show_utf8;
|
||||
|
||||
if (!g_get_charset (NULL)) {
|
||||
/* Non-UTF-8 locale */
|
||||
|
|
@ -449,9 +449,24 @@ can_show_graphics (void)
|
|||
if (locale_str)
|
||||
g_free (locale_str);
|
||||
else
|
||||
can_show_graphics = FALSE;
|
||||
can_show_utf8 = FALSE;
|
||||
}
|
||||
|
||||
return can_show_utf8;
|
||||
}
|
||||
|
||||
|
||||
static gboolean
|
||||
can_show_graphics (void)
|
||||
{
|
||||
static gboolean can_show_graphics_set = FALSE;
|
||||
static gboolean can_show_graphics = TRUE;
|
||||
|
||||
if (G_LIKELY (can_show_graphics_set))
|
||||
return can_show_graphics;
|
||||
|
||||
can_show_graphics = can_show_utf8 ();
|
||||
|
||||
/* The linux console font typically doesn't have characters we need */
|
||||
if (g_strcmp0 (g_getenv ("TERM"), "linux") == 0)
|
||||
can_show_graphics = FALSE;
|
||||
|
|
@ -501,3 +516,73 @@ nmc_password_subst_char (void)
|
|||
else
|
||||
return "*";
|
||||
}
|
||||
|
||||
/*
|
||||
* We actually use a small part of qrcodegen.c, but we'd prefer to keep it
|
||||
* intact. Include it instead of linking to it to give the compiler a
|
||||
* chance to optimize bits we don't need away.
|
||||
*/
|
||||
|
||||
#pragma GCC visibility push(hidden)
|
||||
NM_PRAGMA_WARNING_DISABLE("-Wdeclaration-after-statement")
|
||||
#define NDEBUG
|
||||
#include "qrcodegen.c"
|
||||
NM_PRAGMA_WARNING_REENABLE
|
||||
#pragma GCC visibility pop
|
||||
|
||||
void
|
||||
nmc_print_qrcode (const char *str)
|
||||
{
|
||||
uint8_t tempBuffer[qrcodegen_BUFFER_LEN_FOR_VERSION (qrcodegen_VERSION_MAX)];
|
||||
uint8_t qrcode[qrcodegen_BUFFER_LEN_FOR_VERSION (qrcodegen_VERSION_MAX)];
|
||||
gboolean term_linux;
|
||||
int size;
|
||||
int x;
|
||||
int y;
|
||||
|
||||
term_linux = g_strcmp0 (g_getenv ("TERM"), "linux") == 0;
|
||||
if (!term_linux && !can_show_graphics ())
|
||||
return;
|
||||
|
||||
if (!qrcodegen_encodeText (str,
|
||||
tempBuffer,
|
||||
qrcode,
|
||||
qrcodegen_Ecc_LOW,
|
||||
qrcodegen_VERSION_MIN,
|
||||
qrcodegen_VERSION_MAX,
|
||||
qrcodegen_Mask_AUTO,
|
||||
FALSE)) {
|
||||
return;
|
||||
}
|
||||
|
||||
size = qrcodegen_getSize (qrcode);
|
||||
|
||||
g_print ("\n");
|
||||
|
||||
if (term_linux) {
|
||||
/* G1 alternate character set on Linux console. */
|
||||
for (y = 0; y < size; y += 1) {
|
||||
g_print (" \033[37;40;1m\016");
|
||||
for (x = 0; x < size; x++) {
|
||||
g_print ( qrcodegen_getModule (qrcode, x, y)
|
||||
? " " : "\060\060");
|
||||
}
|
||||
g_print ("\017\033[0m\n");
|
||||
}
|
||||
} else {
|
||||
/* UTF-8 */
|
||||
for (y = -2; y < size + 2; y += 2) {
|
||||
g_print (" \033[37;40m");
|
||||
for (x = -2; x < size + 2; x++) {
|
||||
bool top = qrcodegen_getModule (qrcode, x, y);
|
||||
bool bottom = qrcodegen_getModule (qrcode, x, y + 1);
|
||||
if (top) {
|
||||
g_print (bottom ? " " : "\u2584");
|
||||
} else {
|
||||
g_print (bottom ? "\u2580" : "\u2588");
|
||||
}
|
||||
}
|
||||
g_print ("\033[0m\n");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -41,4 +41,6 @@ const char *nmc_wifi_strength_bars (guint8 strength);
|
|||
|
||||
const char *nmc_password_subst_char (void);
|
||||
|
||||
void nmc_print_qrcode (const char *str);
|
||||
|
||||
#endif /* __NM_CLIENT_UTILS_H__ */
|
||||
|
|
|
|||
1009
clients/common/qrcodegen.c
Normal file
1009
clients/common/qrcodegen.c
Normal file
File diff suppressed because it is too large
Load Diff
311
clients/common/qrcodegen.h
Normal file
311
clients/common/qrcodegen.h
Normal file
|
|
@ -0,0 +1,311 @@
|
|||
/*
|
||||
* QR Code generator library (C)
|
||||
*
|
||||
* Copyright (c) Project Nayuki. (MIT License)
|
||||
* https://www.nayuki.io/page/qr-code-generator-library
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to
|
||||
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
* the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
* - The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
* - The Software is provided "as is", without warranty of any kind, express or
|
||||
* implied, including but not limited to the warranties of merchantability,
|
||||
* fitness for a particular purpose and noninfringement. In no event shall the
|
||||
* authors or copyright holders be liable for any claim, damages or other
|
||||
* liability, whether in an action of contract, tort or otherwise, arising from,
|
||||
* out of or in connection with the Software or the use or other dealings in the
|
||||
* Software.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* This library creates QR Code symbols, which is a type of two-dimension barcode.
|
||||
* Invented by Denso Wave and described in the ISO/IEC 18004 standard.
|
||||
* A QR Code structure is an immutable square grid of black and white cells.
|
||||
* The library provides functions to create a QR Code from text or binary data.
|
||||
* The library covers the QR Code Model 2 specification, supporting all versions (sizes)
|
||||
* from 1 to 40, all 4 error correction levels, and 4 character encoding modes.
|
||||
*
|
||||
* Ways to create a QR Code object:
|
||||
* - High level: Take the payload data and call qrcodegen_encodeText() or qrcodegen_encodeBinary().
|
||||
* - Low level: Custom-make the list of segments and call
|
||||
* qrcodegen_encodeSegments() or qrcodegen_encodeSegmentsAdvanced().
|
||||
* (Note that all ways require supplying the desired error correction level and various byte buffers.)
|
||||
*/
|
||||
|
||||
|
||||
/*---- Enum and struct types----*/
|
||||
|
||||
/*
|
||||
* The error correction level in a QR Code symbol.
|
||||
*/
|
||||
enum qrcodegen_Ecc {
|
||||
// Must be declared in ascending order of error protection
|
||||
// so that an internal qrcodegen function works properly
|
||||
qrcodegen_Ecc_LOW = 0 , // The QR Code can tolerate about 7% erroneous codewords
|
||||
qrcodegen_Ecc_MEDIUM , // The QR Code can tolerate about 15% erroneous codewords
|
||||
qrcodegen_Ecc_QUARTILE, // The QR Code can tolerate about 25% erroneous codewords
|
||||
qrcodegen_Ecc_HIGH , // The QR Code can tolerate about 30% erroneous codewords
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* The mask pattern used in a QR Code symbol.
|
||||
*/
|
||||
enum qrcodegen_Mask {
|
||||
// A special value to tell the QR Code encoder to
|
||||
// automatically select an appropriate mask pattern
|
||||
qrcodegen_Mask_AUTO = -1,
|
||||
// The eight actual mask patterns
|
||||
qrcodegen_Mask_0 = 0,
|
||||
qrcodegen_Mask_1,
|
||||
qrcodegen_Mask_2,
|
||||
qrcodegen_Mask_3,
|
||||
qrcodegen_Mask_4,
|
||||
qrcodegen_Mask_5,
|
||||
qrcodegen_Mask_6,
|
||||
qrcodegen_Mask_7,
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* Describes how a segment's data bits are interpreted.
|
||||
*/
|
||||
enum qrcodegen_Mode {
|
||||
qrcodegen_Mode_NUMERIC = 0x1,
|
||||
qrcodegen_Mode_ALPHANUMERIC = 0x2,
|
||||
qrcodegen_Mode_BYTE = 0x4,
|
||||
qrcodegen_Mode_KANJI = 0x8,
|
||||
qrcodegen_Mode_ECI = 0x7,
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* A segment of character/binary/control data in a QR Code symbol.
|
||||
* The mid-level way to create a segment is to take the payload data
|
||||
* and call a factory function such as qrcodegen_makeNumeric().
|
||||
* The low-level way to create a segment is to custom-make the bit buffer
|
||||
* and initialize a qrcodegen_Segment struct with appropriate values.
|
||||
* Even in the most favorable conditions, a QR Code can only hold 7089 characters of data.
|
||||
* Any segment longer than this is meaningless for the purpose of generating QR Codes.
|
||||
* Moreover, the maximum allowed bit length is 32767 because
|
||||
* the largest QR Code (version 40) has 31329 modules.
|
||||
*/
|
||||
struct qrcodegen_Segment {
|
||||
// The mode indicator of this segment.
|
||||
enum qrcodegen_Mode mode;
|
||||
|
||||
// The length of this segment's unencoded data. Measured in characters for
|
||||
// numeric/alphanumeric/kanji mode, bytes for byte mode, and 0 for ECI mode.
|
||||
// Always zero or positive. Not the same as the data's bit length.
|
||||
int numChars;
|
||||
|
||||
// The data bits of this segment, packed in bitwise big endian.
|
||||
// Can be null if the bit length is zero.
|
||||
uint8_t *data;
|
||||
|
||||
// The number of valid data bits used in the buffer. Requires
|
||||
// 0 <= bitLength <= 32767, and bitLength <= (capacity of data array) * 8.
|
||||
// The character count (numChars) must agree with the mode and the bit buffer length.
|
||||
int bitLength;
|
||||
};
|
||||
|
||||
|
||||
|
||||
/*---- Macro constants and functions ----*/
|
||||
|
||||
#define qrcodegen_VERSION_MIN 1 // The minimum version number supported in the QR Code Model 2 standard
|
||||
#define qrcodegen_VERSION_MAX 40 // The maximum version number supported in the QR Code Model 2 standard
|
||||
|
||||
// Calculates the number of bytes needed to store any QR Code up to and including the given version number,
|
||||
// as a compile-time constant. For example, 'uint8_t buffer[qrcodegen_BUFFER_LEN_FOR_VERSION(25)];'
|
||||
// can store any single QR Code from version 1 to 25 (inclusive). The result fits in an int (or int16).
|
||||
// Requires qrcodegen_VERSION_MIN <= n <= qrcodegen_VERSION_MAX.
|
||||
#define qrcodegen_BUFFER_LEN_FOR_VERSION(n) ((((n) * 4 + 17) * ((n) * 4 + 17) + 7) / 8 + 1)
|
||||
|
||||
// The worst-case number of bytes needed to store one QR Code, up to and including
|
||||
// version 40. This value equals 3918, which is just under 4 kilobytes.
|
||||
// Use this more convenient value to avoid calculating tighter memory bounds for buffers.
|
||||
#define qrcodegen_BUFFER_LEN_MAX qrcodegen_BUFFER_LEN_FOR_VERSION(qrcodegen_VERSION_MAX)
|
||||
|
||||
|
||||
|
||||
/*---- Functions (high level) to generate QR Codes ----*/
|
||||
|
||||
/*
|
||||
* Encodes the given text string to a QR Code, returning true if encoding succeeded.
|
||||
* If the data is too long to fit in any version in the given range
|
||||
* at the given ECC level, then false is returned.
|
||||
* - The input text must be encoded in UTF-8 and contain no NULs.
|
||||
* - The variables ecl and mask must correspond to enum constant values.
|
||||
* - Requires 1 <= minVersion <= maxVersion <= 40.
|
||||
* - The arrays tempBuffer and qrcode must each have a length
|
||||
* of at least qrcodegen_BUFFER_LEN_FOR_VERSION(maxVersion).
|
||||
* - After the function returns, tempBuffer contains no useful data.
|
||||
* - If successful, the resulting QR Code may use numeric,
|
||||
* alphanumeric, or byte mode to encode the text.
|
||||
* - In the most optimistic case, a QR Code at version 40 with low ECC
|
||||
* can hold any UTF-8 string up to 2953 bytes, or any alphanumeric string
|
||||
* up to 4296 characters, or any digit string up to 7089 characters.
|
||||
* These numbers represent the hard upper limit of the QR Code standard.
|
||||
* - Please consult the QR Code specification for information on
|
||||
* data capacities per version, ECC level, and text encoding mode.
|
||||
*/
|
||||
bool qrcodegen_encodeText(const char *text, uint8_t tempBuffer[], uint8_t qrcode[],
|
||||
enum qrcodegen_Ecc ecl, int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl);
|
||||
|
||||
|
||||
/*
|
||||
* Encodes the given binary data to a QR Code, returning true if encoding succeeded.
|
||||
* If the data is too long to fit in any version in the given range
|
||||
* at the given ECC level, then false is returned.
|
||||
* - The input array range dataAndTemp[0 : dataLen] should normally be
|
||||
* valid UTF-8 text, but is not required by the QR Code standard.
|
||||
* - The variables ecl and mask must correspond to enum constant values.
|
||||
* - Requires 1 <= minVersion <= maxVersion <= 40.
|
||||
* - The arrays dataAndTemp and qrcode must each have a length
|
||||
* of at least qrcodegen_BUFFER_LEN_FOR_VERSION(maxVersion).
|
||||
* - After the function returns, the contents of dataAndTemp may have changed,
|
||||
* and does not represent useful data anymore.
|
||||
* - If successful, the resulting QR Code will use byte mode to encode the data.
|
||||
* - In the most optimistic case, a QR Code at version 40 with low ECC can hold any byte
|
||||
* sequence up to length 2953. This is the hard upper limit of the QR Code standard.
|
||||
* - Please consult the QR Code specification for information on
|
||||
* data capacities per version, ECC level, and text encoding mode.
|
||||
*/
|
||||
bool qrcodegen_encodeBinary(uint8_t dataAndTemp[], size_t dataLen, uint8_t qrcode[],
|
||||
enum qrcodegen_Ecc ecl, int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl);
|
||||
|
||||
|
||||
/*---- Functions (low level) to generate QR Codes ----*/
|
||||
|
||||
/*
|
||||
* Renders a QR Code representing the given segments at the given error correction level.
|
||||
* The smallest possible QR Code version is automatically chosen for the output. Returns true if
|
||||
* QR Code creation succeeded, or false if the data is too long to fit in any version. The ECC level
|
||||
* of the result may be higher than the ecl argument if it can be done without increasing the version.
|
||||
* This function allows the user to create a custom sequence of segments that switches
|
||||
* between modes (such as alphanumeric and byte) to encode text in less space.
|
||||
* This is a low-level API; the high-level API is qrcodegen_encodeText() and qrcodegen_encodeBinary().
|
||||
* To save memory, the segments' data buffers can alias/overlap tempBuffer, and will
|
||||
* result in them being clobbered, but the QR Code output will still be correct.
|
||||
* But the qrcode array must not overlap tempBuffer or any segment's data buffer.
|
||||
*/
|
||||
bool qrcodegen_encodeSegments(const struct qrcodegen_Segment segs[], size_t len,
|
||||
enum qrcodegen_Ecc ecl, uint8_t tempBuffer[], uint8_t qrcode[]);
|
||||
|
||||
|
||||
/*
|
||||
* Renders a QR Code representing the given segments with the given encoding parameters.
|
||||
* Returns true if QR Code creation succeeded, or false if the data is too long to fit in the range of versions.
|
||||
* The smallest possible QR Code version within the given range is automatically
|
||||
* chosen for the output. Iff boostEcl is true, then the ECC level of the result
|
||||
* may be higher than the ecl argument if it can be done without increasing the
|
||||
* version. The mask number is either between 0 to 7 (inclusive) to force that
|
||||
* mask, or -1 to automatically choose an appropriate mask (which may be slow).
|
||||
* This function allows the user to create a custom sequence of segments that switches
|
||||
* between modes (such as alphanumeric and byte) to encode text in less space.
|
||||
* This is a low-level API; the high-level API is qrcodegen_encodeText() and qrcodegen_encodeBinary().
|
||||
* To save memory, the segments' data buffers can alias/overlap tempBuffer, and will
|
||||
* result in them being clobbered, but the QR Code output will still be correct.
|
||||
* But the qrcode array must not overlap tempBuffer or any segment's data buffer.
|
||||
*/
|
||||
bool qrcodegen_encodeSegmentsAdvanced(const struct qrcodegen_Segment segs[], size_t len, enum qrcodegen_Ecc ecl,
|
||||
int minVersion, int maxVersion, int mask, bool boostEcl, uint8_t tempBuffer[], uint8_t qrcode[]);
|
||||
|
||||
|
||||
/*
|
||||
* Tests whether the given string can be encoded as a segment in alphanumeric mode.
|
||||
* A string is encodable iff each character is in the following set: 0 to 9, A to Z
|
||||
* (uppercase only), space, dollar, percent, asterisk, plus, hyphen, period, slash, colon.
|
||||
*/
|
||||
bool qrcodegen_isAlphanumeric(const char *text);
|
||||
|
||||
|
||||
/*
|
||||
* Tests whether the given string can be encoded as a segment in numeric mode.
|
||||
* A string is encodable iff each character is in the range 0 to 9.
|
||||
*/
|
||||
bool qrcodegen_isNumeric(const char *text);
|
||||
|
||||
|
||||
/*
|
||||
* Returns the number of bytes (uint8_t) needed for the data buffer of a segment
|
||||
* containing the given number of characters using the given mode. Notes:
|
||||
* - Returns SIZE_MAX on failure, i.e. numChars > INT16_MAX or
|
||||
* the number of needed bits exceeds INT16_MAX (i.e. 32767).
|
||||
* - Otherwise, all valid results are in the range [0, ceil(INT16_MAX / 8)], i.e. at most 4096.
|
||||
* - It is okay for the user to allocate more bytes for the buffer than needed.
|
||||
* - For byte mode, numChars measures the number of bytes, not Unicode code points.
|
||||
* - For ECI mode, numChars must be 0, and the worst-case number of bytes is returned.
|
||||
* An actual ECI segment can have shorter data. For non-ECI modes, the result is exact.
|
||||
*/
|
||||
size_t qrcodegen_calcSegmentBufferSize(enum qrcodegen_Mode mode, size_t numChars);
|
||||
|
||||
|
||||
/*
|
||||
* Returns a segment representing the given binary data encoded in
|
||||
* byte mode. All input byte arrays are acceptable. Any text string
|
||||
* can be converted to UTF-8 bytes and encoded as a byte mode segment.
|
||||
*/
|
||||
struct qrcodegen_Segment qrcodegen_makeBytes(const uint8_t data[], size_t len, uint8_t buf[]);
|
||||
|
||||
|
||||
/*
|
||||
* Returns a segment representing the given string of decimal digits encoded in numeric mode.
|
||||
*/
|
||||
struct qrcodegen_Segment qrcodegen_makeNumeric(const char *digits, uint8_t buf[]);
|
||||
|
||||
|
||||
/*
|
||||
* Returns a segment representing the given text string encoded in alphanumeric mode.
|
||||
* The characters allowed are: 0 to 9, A to Z (uppercase only), space,
|
||||
* dollar, percent, asterisk, plus, hyphen, period, slash, colon.
|
||||
*/
|
||||
struct qrcodegen_Segment qrcodegen_makeAlphanumeric(const char *text, uint8_t buf[]);
|
||||
|
||||
|
||||
/*
|
||||
* Returns a segment representing an Extended Channel Interpretation
|
||||
* (ECI) designator with the given assignment value.
|
||||
*/
|
||||
struct qrcodegen_Segment qrcodegen_makeEci(long assignVal, uint8_t buf[]);
|
||||
|
||||
|
||||
/*---- Functions to extract raw data from QR Codes ----*/
|
||||
|
||||
/*
|
||||
* Returns the side length of the given QR Code, assuming that encoding succeeded.
|
||||
* The result is in the range [21, 177]. Note that the length of the array buffer
|
||||
* is related to the side length - every 'uint8_t qrcode[]' must have length at least
|
||||
* qrcodegen_BUFFER_LEN_FOR_VERSION(version), which equals ceil(size^2 / 8 + 1).
|
||||
*/
|
||||
int qrcodegen_getSize(const uint8_t qrcode[]);
|
||||
|
||||
|
||||
/*
|
||||
* Returns the color of the module (pixel) at the given coordinates, which is false
|
||||
* for white or true for black. The top left corner has the coordinates (x=0, y=0).
|
||||
* If the given coordinates are out of bounds, then false (white) is returned.
|
||||
*/
|
||||
bool qrcodegen_getModule(const uint8_t qrcode[], int x, int y);
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
|
@ -1614,6 +1614,19 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>wifi</command>
|
||||
<command>show-password</command>
|
||||
<arg><option>ifname</option> <replaceable>ifname</replaceable></arg>
|
||||
</term>
|
||||
|
||||
<listitem>
|
||||
<para>Show the details of the active Wi-Fi networks, including the
|
||||
secrets.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>lldp</command>
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user