Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

netplan key-management support wpa-psk-sha256 (LP# 2085320) #531

Merged
merged 1 commit into from
Dec 18, 2024
Merged

netplan key-management support wpa-psk-sha256 (LP# 2085320) #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/netplan-yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -910,7 +910,8 @@ interfaces, as well as individual Wi-Fi networks, by means of the `auth` block.
- **`key-management`** (scalar)

> The supported key management modes are `none` (no key management);
> `psk` (WPA with pre-shared key, common for home Wi-Fi); `eap` (WPA
> `psk` (WPA with pre-shared key, common for home Wi-Fi); `psk-sha256`
> (WPA2 with pre-shared key, common for home Wi-Fi); `eap` (WPA
> with EAP, common for enterprise Wi-Fi); `eap-sha256` (used with WPA3-Enterprise);
> `eap-suite-b-192` (used with WPA3-Enterprise); `sae` (used by WPA3);
> and `802.1x` (used primarily for wired Ethernet connections).
Expand Down
1 change: 1 addition & 0 deletions src/abi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ typedef enum {
NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAPSUITE_B_192,
NETPLAN_AUTH_KEY_MANAGEMENT_8021X,
NETPLAN_AUTH_KEY_MANAGEMENT_WPA_SAE,
NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSKSHA256,
NETPLAN_AUTH_KEY_MANAGEMENT_MAX,
} NetplanAuthKeyManagementType;

Expand Down
1 change: 1 addition & 0 deletions src/names.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ static const char* const
netplan_auth_key_management_type_to_str[NETPLAN_AUTH_KEY_MANAGEMENT_MAX] = {
[NETPLAN_AUTH_KEY_MANAGEMENT_NONE] = "none",
[NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSK] = "psk",
[NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSKSHA256] = "psk-sha256",
[NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAP] = "eap",
[NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAPSHA256] = "eap-sha256",
[NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAPSUITE_B_192] = "eap-suite-b-192",
Expand Down
4 changes: 4 additions & 0 deletions src/networkd.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1188,6 +1188,10 @@ append_wpa_auth_conf(GString* s, const NetplanAuthenticationSettings* auth, cons
g_string_append(s, " key_mgmt=WPA-PSK\n");
break;

case NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSKSHA256:
g_string_append(s, " key_mgmt=WPA-PSK WPA-PSK-SHA256\n");
break;

case NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAP:
g_string_append(s, " key_mgmt=WPA-EAP\n");
break;
Expand Down
1 change: 1 addition & 0 deletions src/nm.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,7 @@ write_wifi_auth_parameters(const NetplanAuthenticationSettings* auth, GKeyFile *
case NETPLAN_AUTH_KEY_MANAGEMENT_NONE:
break;
case NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSK:
case NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSKSHA256:
g_key_file_set_string(kf, "wifi-security", "key-mgmt", "wpa-psk");
break;
case NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAP:
Expand Down
3 changes: 3 additions & 0 deletions src/parse-nm.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,6 +1019,9 @@ netplan_parser_load_keyfile(NetplanParser* npp, const char* filename, GError** e
*/
if (ap->auth.key_management == NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAP)
ap->auth.key_management = NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAPSHA256;
/*The same logic is used for WPA-PSK*/
else if (ap->auth.key_management == NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSK)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: the comment above needs to be updated now. Maybe just append this to the comment: The same logic is used for WPA-PSK.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree!! It will be clearer for other when reading this part~

ap->auth.key_management = NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSKSHA256;
break;

case 3:
Expand Down
7 changes: 7 additions & 0 deletions src/parse.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1015,6 +1015,13 @@ handle_auth_key_management(NetplanParser* npp, yaml_node_t* node, __unused const
auth->key_management = NETPLAN_AUTH_KEY_MANAGEMENT_NONE;
else if (strcmp(scalar(node), "psk") == 0)
auth->key_management = NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSK;
else if (strcmp(scalar(node), "psk-sha256") == 0) {
/* WPA-PSK-SHA256 is commonly used with Protected Management Frames
* so let's set it as optional
*/
auth->key_management = NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSKSHA256;
auth->pmf_mode = NETPLAN_AUTH_PMF_MODE_OPTIONAL;
}
else if (strcmp(scalar(node), "eap") == 0)
auth->key_management = NETPLAN_AUTH_KEY_MANAGEMENT_WPA_EAP;
else if (strcmp(scalar(node), "eap-sha256") == 0) {
Expand Down
1 change: 1 addition & 0 deletions src/util.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1235,6 +1235,7 @@ gboolean
_is_auth_key_management_psk(const NetplanAuthenticationSettings* auth)
{
return ( auth->key_management == NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSK
|| auth->key_management == NETPLAN_AUTH_KEY_MANAGEMENT_WPA_PSKSHA256
|| auth->key_management == NETPLAN_AUTH_KEY_MANAGEMENT_WPA_SAE);
}

Expand Down
54 changes: 54 additions & 0 deletions tests/generator/test_wifis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,27 @@ def test_wifi_wowlan_default(self):
self.assertTrue(os.path.islink(os.path.join(
self.workdir.name, 'run/systemd/system/systemd-networkd.service.wants/netplan-wpa-wl0.service')))

def test_wifi_wpa_sha256(self):
self.generate('''network:
version: 2
wifis:
wl0:
access-points:
homenet:
auth:
key-management: psk-sha256
password: "********"''')

self.assert_wpa_supplicant("wl0", """ctrl_interface=/run/wpa_supplicant

network={
ssid=P"homenet"
key_mgmt=WPA-PSK WPA-PSK-SHA256
ieee80211w=1
psk="********"
}
""")

def test_wifi_wpa3_personal(self):
self.generate('''network:
version: 2
Expand Down Expand Up @@ -794,6 +815,39 @@ def test_wifi_adhoc_wpa_5ghz(self):
}
""")

def test_wifi_wpa_sha256(self):
self.generate('''network:
version: 2
renderer: NetworkManager
wifis:
wl0:
access-points:
homenet:
auth:
key-management: psk-sha256
password: "********"''')

self.assert_nm({'wl0-homenet': '''[connection]
id=netplan-wl0-homenet
type=wifi
interface-name=wl0

[ipv4]
method=link-local

[ipv6]
method=ignore

[wifi]
ssid=homenet
mode=infrastructure

[wifi-security]
key-mgmt=wpa-psk
pmf=2
psk=********
'''})

def test_wifi_wpa3_personal(self):
self.generate('''network:
version: 2
Expand Down
51 changes: 51 additions & 0 deletions tests/parser/test_keyfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1505,6 +1505,57 @@ def test_keyfile_wpa3_sae(self):
name: "test2"
'''.format(UUID, UUID)})

def test_keyfile_wpa_sha256(self):
self.generate_from_keyfile('''[connection]
id=test2
uuid={}
type=wifi
interface-name=wlan0

[wifi]
mode=infrastructure
ssid=ubuntu-wpa-sha256

[wifi-security]
key-mgmt=wpa-psk
pmf=2
psk=test1234

[ipv4]
method=auto

[ipv6]
addr-gen-mode=stable-privacy
method=auto

[proxy]
'''.format(UUID))
self.assert_netplan({UUID: '''network:
version: 2
wifis:
NM-{}:
renderer: NetworkManager
match:
name: "wlan0"
dhcp4: true
dhcp6: true
ipv6-address-generation: "stable-privacy"
access-points:
"ubuntu-wpa-sha256":
auth:
key-management: "psk-sha256"
password: "test1234"
networkmanager:
uuid: "ff9d6ebc-226d-4f82-a485-b7ff83b9607f"
name: "test2"
passthrough:
ipv6.ip6-privacy: "-1"
proxy._: ""
networkmanager:
uuid: "{}"
name: "test2"
'''.format(UUID, UUID)})

def test_keyfile_wpa3_enterprise_eap_sha256(self):
self.generate_from_keyfile('''[connection]
id=test2
Expand Down
Loading