storage: implement network profile encryption
James Prestwood
PATCH 1/5 storage: implement network profile encryption
Some users don't like the idea of storing network credentials in plaintext on the file system. As far as IWD goes the credential directory permissions should be set up such that nobody but the owner/root have access but nevertheless they are still plaintext.
For added security these credentials can be encrypted using a secret key. In this patch the origination of the key does not matter, but in this patch series IWD will support a systemd provided key.
The encryption itself will operate on the entire [Security] group as well as all embedded groups. Once encrypted the [Security] group will be replaced with two key/values:
EncryptedSalt - A random string of bytes used for the encryption EncryptedSecurity - A string of bytes containing the encrypted [Security]
group, as well as all embedded groups.
After the profile has been encrypted these values should not be modified. Note that any values added to [Security] after encryption has no effect. Once the profile is encrypted there is no way to modify [Security] without manually decrypting first, or just removing it entirely which effectively treated a 'new' profile.
The encryption/decryption is done using AES-SIV with a salt value and the network SSID as the IV.
Once a key is set any profiles opened will automatically be encrypted and re-written to disk. Modules using network_storage_open will be provided the decrypted profile, and will be unaware it was ever encrypted in the first place. Similarly when network_storage_sync is called the profile will by automatically encrypted and written to disk without the caller needing to do anything special.
--- Makefile.am | 3 +- src/storage.c | 224 +++++++++++++++++++++++++++++++++++++++++++++++--- src/storage.h | 2 + 3 files changed, 217 insertions(+), 12 deletions(-)
Makefile.am +2 -1
@@ -381,7 +381,8 @@ tools_hwsim_SOURCES = tools/hwsim.c src/mpdu.h \ src/nl80211util.h src/nl80211util.c \ src/storage.h src/storage.c \ src/common.h src/common.c \ - src/band.h src/band.c + src/band.h src/band.c \ + src/crypto.h src/crypto.c tools_hwsim_LDADD = $(ell_ldadd) if DBUS_POLICY
src/storage.c +213 -11
269 lines not on this page · raw message
src/storage.h +2 -0
@@ -50,3 +50,5 @@ int storage_network_remove(enum security type, const char *ssid);struct l_settings *storage_known_frequencies_load (void );void storage_known_frequencies_sync (struct l_settings *known_freqs); + +void __storage_set_encryption_key (const uint8_t *key,size_t key_len);
Signature · 1 line
2.31.1
James Prestwood
PATCH 2/5 main: add SystemdEncrypt option, and initialize key
Recently systemd added the ability to pass secret credentials to services via LoadCredentialEncrypted/SetCredentialEncrypted. Once set up the service is able to read the decrypted credentials from a file. The file path is found in the environment variable CREDENTIALS_DIRECTORY + an identifier. The value of SystemdEncrypt should be set to the systemd key ID used when the credential was created.
When SystemdEncrypt is set IWD will attempt to read the decrypted secret from systemd. If at any point this fails warnings will be printed but IWD will continue normally. Its expected that any failures will result in the inability to connect to any networks which have previously encrypted the passphrase/PSK without re-entering the passphrase manually. This could happen, for example, if the systemd secret was changed.
Once the secret is read in it is set into storage to be used for profile encryption/decryption.
--- src/main.c | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+)
src/main.c +46 -0
@@ -29,6 +29,7 @@#include <errno.h> #include <getopt.h> #include <signal.h> +#include <sys/stat.h> #include <ell/ell.h> #include <ell/useful.h>
@@ -397,6 +398,49 @@ done:return r; } +/* +* Initialize a systemd encryption key for encrypting/decrypting credentials. +*/ +static void setup_system_key (void ) +{ +const char *cred_dir; +ssize_t len; +struct stat st; + _auto_(l_free) char *path = NULL; + _auto_(l_free) uint8_t *key = NULL; + _auto_(l_free) char *key_id = NULL; + + key_id =l_settings_get_string (iwd_config,"General" ,"SystemdEncrypt" ); +if (!key_id) +return ; + + cred_dir =getenv ("CREDENTIALS_DIRECTORY" ); +if (!cred_dir) { +l_warn ("SystemdEncrypt enabled, but CREDENTIALS_DIRECTORY not " +"set, check iwd.service file" ); +return ; + } + + path =l_strdup_printf ("%s/%s" , cred_dir, key_id); + +if (stat (path, &st) <0 ) { +l_warn ("SystemdEncrypt enabled, but could not stat %s" , + path); +return ; + } + + key =l_malloc (st.st_size); + + len =read_file (key, st.st_size,"%s" , path); +if (len <0 ) { +l_warn ("SystemdEncrypt enabled, but reading %s failed (%ld)" , + path, len); +return ; + } + +__storage_set_encryption_key (key, st.st_size); +} +int main (int argc,char *argv[]) {int exit_status;
@@ -529,6 +573,8 @@ int main(int argc, char *argv[])l_dbus_set_disconnect_handler (dbus, dbus_disconnected,NULL ,NULL );dbus_init (dbus); +setup_system_key (); + exit_status =l_main_run_with_signal (signal_handler,NULL );iwd_modules_exit ();
Signature · 1 line
2.31.1
James Prestwood
PATCH 3/5 tools: add decrypt-profile tool
In reply to James PrestwoodThis tool will decrypt an IWD network profile which was previously encrypted using a systemd provided key. Either a text passphrase can be provided (--pass) or a file containing the secret (--file).
This can be useful for debugging, or recovering an encrypted profile after enabling SystemdEncrypt.
--- Makefile.am | 8 +- tools/decrypt-profile.c | 163 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 170 insertions(+), 1 deletion(-) create mode 100644 tools/decrypt-profile.c
Makefile.am +7 -1
@@ -362,7 +362,7 @@ man_MANS += wired/ead.8 endif endif -noinst_PROGRAMS += tools/probe-req +noinst_PROGRAMS += tools/probe-req tools/decrypt-profile tools_probe_req_SOURCES = tools/probe-req.c src/mpdu.h src/mpdu.c \ src/ie.h src/ie.c \
@@ -372,6 +372,12 @@ tools_probe_req_SOURCES = tools/probe-req.c src/mpdu.h src/mpdu.c \ src/band.h src/band.c tools_probe_req_LDADD = $(ell_ldadd) +tools_decrypt_profile_SOURCES = tools/decrypt-profile.c \ + src/common.h src/common.c \ + src/crypto.h src/crypto.c \ + src/storage.h src/storage.c +tools_decrypt_profile_LDADD = ${ell_ldadd} + if HWSIM bin_PROGRAMS += tools/hwsim
tools/decrypt-profile.c new file +163 -0
163 lines not on this page · raw message
Signature · 1 line
2.31.1
James Prestwood
PATCH 4/5 doc: document SystemdEncrypt
In reply to James Prestwood--- src/iwd.config.rst | 16 ++++++++++++++++ src/iwd.network.rst | 6 +++++- 2 files changed, 21 insertions(+), 1 deletion(-)
src/iwd.config.rst +16 -0
@@ -188,6 +188,22 @@ The group ``[General]`` contains general settings. by the kernel so if kernels/drivers exist which don't support OCV it can be disabled here. + * - SystemdEncrypt + - Value: Systemd key ID + + Enables network profile encryption using a systemd provided secret key. + Once enabled all PSK/8021x network profiles will be encrypted + automatically. Once the profile is encrypted there is no way of going + back using IWD alone. A tool, decrypt-profile, is provided assuming the + secret is known which will decrypt a profile. This decrypted profile + could manually be set to /var/lib/iwd to 'undo' any profile encryption, + but its going to be a manual process. + + Setting up systemd to provide the secret is left up to the user as IWD + has no way of performing this automatically. The systemd options required + are LoadCredentialEncrypted or SetCredentialEncrypted, and the secret + identifier should be named whatever SystemdEncrypt is set to. + Network -------
src/iwd.network.rst +5 -1
@@ -179,7 +179,11 @@ Network Authentication Settings ------------------------------- The group ``[Security]`` contains settings for Wi-Fi security and -authentication configuration. +authentication configuration. This group can be encrypted by enabling +``SystemdEncrypt``, see *iwd.config* for details on this option. If this section +is encrypted (only contains EncryptedSalt/EncryptedSecurity) it should not be +modified. Modifying these values will result in the inability to connect to that +network. .. list-table:: :header-rows: 0
Signature · 1 line
2.31.1
James Prestwood
PATCH 5/5 auto-t: add test for encrypted profiles
In reply to James Prestwood--- .../testEncryptedProfiles/connection_test.py | 130 ++++++++++++++++++ autotests/testEncryptedProfiles/hw.conf | 6 + autotests/testEncryptedProfiles/iwd-secret | 1 + autotests/testEncryptedProfiles/main.conf | 2 + autotests/testEncryptedProfiles/ssidCCMP.conf | 10 ++ autotests/testEncryptedProfiles/ssidCCMP.psk | 2 + 6 files changed, 151 insertions(+) create mode 100644 autotests/testEncryptedProfiles/connection_test.py create mode 100644 autotests/testEncryptedProfiles/hw.conf create mode 100644 autotests/testEncryptedProfiles/iwd-secret create mode 100644 autotests/testEncryptedProfiles/main.conf create mode 100644 autotests/testEncryptedProfiles/ssidCCMP.conf create mode 100644 autotests/testEncryptedProfiles/ssidCCMP.psk
autotests/testEncryptedProfiles/connection_test.py new file +130 -0
@@ -0,0 +1,130 @@ +#!/usr/bin/python3 + +import unittest +import sys + +sys.path.append('../util') +import iwd +import os +from iwd import IWD +from iwd import NetworkType +from iwd import PSKAgent + +class Test(unittest.TestCase): + def profile_is_encrypted(self, profile): + with open('/tmp/iwd/' + profile) as f: + contents = f.read() + + if 'Passphrase' in contents: + return False + + return True + + def validate(self, wd): + devices = wd.list_devices(1) + device = devices[0] + + ordered_network = device.get_ordered_network('ssidCCMP') + + self.assertEqual(ordered_network.type, NetworkType.psk) + + condition = 'not obj.connected' + wd.wait_for_object_condition(ordered_network.network_object, condition) + + ordered_network.network_object.connect() + + condition = 'obj.state == DeviceState.connected' + wd.wait_for_object_condition(device, condition) + + device.disconnect() + + condition = 'not obj.connected' + wd.wait_for_object_condition(ordered_network.network_object, condition) + + # Tests that an existing plaintext profile gets encrypted + def test_new_profile(self): + IWD.copy_to_storage('ssidCCMP.psk') + + mtime = os.path.getmtime('/tmp/iwd/' + 'ssidCCMP.psk') + self.assertFalse(self.profile_is_encrypted('ssidCCMP.psk')) + + wd = IWD(True) + + # Make sure profile was accepted + condition = 'len(obj.list_known_networks()) == 1' + wd.wait_for_object_condition(wd, condition) + + # Check the file was modified (should be encrypted now) + self.assertNotEqual(mtime, os.path.getmtime('/tmp/iwd/' + 'ssidCCMP.psk')) + + self.validate(wd) + + self.assertTrue(self.profile_is_encrypted('ssidCCMP.psk')) + + # Tests that a new connection with agent gets written to an encrypted profile + def test_agent_profile(self): + wd = IWD(True) + + psk_agent = PSKAgent("secret123") + wd.register_psk_agent(psk_agent) + + with self.assertRaises(FileNotFoundError): + self.profile_is_encrypted('ssidCCMP.psk') + + self.validate(wd) + + self.assertTrue(self.profile_is_encrypted('ssidCCMP.psk')) + + wd.unregister_psk_agent(psk_agent) + + # Tests that an invalid profile gets re-written after an agent request + def test_invalid_profile_rewritten(self): + bad_config = '[Security]\nPassphrase=incorrect\n' + os.system('echo "%s" > /tmp/iwd/ssidCCMP.psk' % bad_config) + + wd = IWD(True) + + condition = 'len(obj.list_known_networks()) == 1' + wd.wait_for_object_condition(wd, condition) + + # IWD should still encrypt the profile automatically + self.assertTrue(self.profile_is_encrypted('ssidCCMP.psk')) + + # This should fail + with self.assertRaises(iwd.FailedEx): + self.validate(wd) + + psk_agent = PSKAgent("secret123") + wd.register_psk_agent(psk_agent) + + self.validate(wd) + + self.assertTrue(self.profile_is_encrypted('ssidCCMP.psk')) + + # Tests that a profile that doesn't decrypt wont become a known network + def test_decryption_failure(self): + bad_config = \ +''' +[Security] +EncryptedSalt=000102030405060708090a0b0c0d0e0f +EncryptedSecurity=aabbccddeeff00112233445566778899 +''' + os.system('echo "%s" > /tmp/iwd/ssidCCMP.psk' % bad_config) + + wd = IWD(True) + + self.assertEqual(wd.list_known_networks(), []) + + def tearDown(self): + IWD.clear_storage() + + @classmethod + def setUpClass(cls): + os.environ['CREDENTIALS_DIRECTORY'] = '/tmp' + + @classmethod + def tearDownClass(cls): + IWD.clear_storage() + +if __name__ == '__main__': + unittest.main(exit=True)
autotests/testEncryptedProfiles/hw.conf new file +6 -0
@@ -0,0 +1,6 @@ +[SETUP] +num_radios=2 +start_iwd=0 + +[HOSTAPD] +rad0=ssidCCMP.conf
autotests/testEncryptedProfiles/iwd-secret new file +1 -0
@@ -0,0 +1 @@ +secret123
autotests/testEncryptedProfiles/main.conf new file +2 -0
@@ -0,0 +1,2 @@ +[General] +SystemdEncrypt=iwd-secret
autotests/testEncryptedProfiles/ssidCCMP.conf new file +10 -0
@@ -0,0 +1,10 @@ +hw_mode=g +channel=1 +ssid=ssidCCMP + +wpa=2 +wpa_pairwise=CCMP +wpa_passphrase=secret123 + +ieee80211w=2 +wpa_key_mgmt=WPA-PSK-SHA256
autotests/testEncryptedProfiles/ssidCCMP.psk new file +2 -0
@@ -0,0 +1,2 @@ +[Security] +Passphrase=secret123
Signature · 1 line
2.31.1