From 540aaf87f97eb7ff5561046f20a79d70f7a745d3 Mon Sep 17 00:00:00 2001 From: Matt Colyer Date: Thu, 14 Aug 2008 09:26:33 -0700 Subject: Refactored and documented userpref.c. --- src/userpref.c | 305 ++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 193 insertions(+), 112 deletions(-) (limited to 'src/userpref.c') diff --git a/src/userpref.c b/src/userpref.c index 0a9086b..46e97b7 100644 --- a/src/userpref.c +++ b/src/userpref.c @@ -27,35 +27,34 @@ #include #include - #define LIBIPHONE_CONF_DIR "libiphone" #define LIBIPHONE_CONF_FILE "libiphonerc" -#define LIBIPHONE_ROOT_PRIVKEY "RootPrivateKey.pem" -#define LIBIPHONE_HOST_PRIVKEY "HostPrivateKey.pem" -#define LIBIPHONE_ROOT_CERTIF "RootCertificate.pem" -#define LIBIPHONE_HOST_CERTIF "HostCertificate.pem" - +#define LIBIPHONE_ROOT_PRIVKEY "RootPrivateKey.pem" +#define LIBIPHONE_HOST_PRIVKEY "HostPrivateKey.pem" +#define LIBIPHONE_ROOT_CERTIF "RootCertificate.pem" +#define LIBIPHONE_HOST_CERTIF "HostCertificate.pem" extern int debug; -inline void create_config_dir() { - gchar* config_dir = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, NULL); - g_mkdir_with_parents (config_dir, 755); - g_free(config_dir); - return; -} - -char* get_host_id() -{ +/** Reads the HostID from a previously generated configuration file. + * + * @note It is the responsibility of the calling function to free the returned host_id + * + * @return The string containing the HostID or NULL + */ +char* get_host_id() { char* host_id = NULL; - gchar* config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); + gchar* config_file; + GKeyFile* key_file; + gchar* loc_host_id; - /* now parse file to get the HostID */ - GKeyFile* key_file = g_key_file_new (); - if( g_key_file_load_from_file (key_file, config_file, G_KEY_FILE_KEEP_COMMENTS, NULL) ) { + config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); - gchar* loc_host_id = g_key_file_get_value(key_file, "Global", "HostID", NULL); + /* now parse file to get the HostID */ + key_file = g_key_file_new(); + if(g_key_file_load_from_file(key_file, config_file, G_KEY_FILE_KEEP_COMMENTS, NULL)) { + loc_host_id = g_key_file_get_value(key_file, "Global", "HostID", NULL); if (loc_host_id) host_id = strdup((char*)loc_host_id); g_free(loc_host_id); @@ -63,32 +62,42 @@ char* get_host_id() g_key_file_free(key_file); g_free(config_file); - if (debug) printf("Using %s as HostID\n",host_id); + if (debug) printf("get_host_id(): Using %s as HostID\n",host_id); return host_id; } -int is_device_known(char* public_key) -{ +/** Determines whether this iPhone has been connected to this system before. + * + * @param public_key The public key as given by the iPhone. + * + * @return 1 if the iPhone has been connected previously to this configuration + * or 0 otherwise. + */ +int is_device_known(char* public_key) { int ret = 0; - + gchar *config_file; + GKeyFile *key_file; + gchar **devices_list, **pcur, *keyfilepath, *stored_key; + GIOChannel *keyfile; + /* first get config file */ - gchar* config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); + config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); if (g_file_test(config_file, (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR))) { /* now parse file to get knwon devices list */ - GKeyFile* key_file = g_key_file_new (); - if( g_key_file_load_from_file (key_file, config_file, G_KEY_FILE_KEEP_COMMENTS, NULL) ) { + key_file = g_key_file_new (); + if(g_key_file_load_from_file(key_file, config_file, G_KEY_FILE_KEEP_COMMENTS, NULL)) { - gchar** devices_list = g_key_file_get_string_list (key_file, "Global", "DevicesList", NULL, NULL); + devices_list = g_key_file_get_string_list (key_file, "Global", "DevicesList", NULL, NULL); if (devices_list) { - gchar** pcur = devices_list; + pcur = devices_list; while(*pcur && !ret) { /* open associated base64 encoded key */ - gchar* keyfilepath = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, *pcur, NULL); + keyfilepath = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, *pcur, NULL); if (g_file_test(keyfilepath, (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR))) { - GIOChannel* keyfile = g_io_channel_new_file (keyfilepath, "r", NULL); + keyfile = g_io_channel_new_file (keyfilepath, "r", NULL); - gchar* stored_key = NULL; + stored_key = NULL; g_io_channel_read_to_end (keyfile, &stored_key, NULL, NULL); /* now compare to input */ @@ -109,52 +118,67 @@ int is_device_known(char* public_key) return ret; } -int store_device_public_key(char* public_key) -{ +/** Mark the iPhone (as represented by the key) as having connected to this + * configuration. + * + * @param public_key The public key given by the iPhone + * + * @return 1 on success and 0 if no public key is given or if it has already + * been marked as connected previously. + */ +int store_device_public_key(char* public_key) { + gchar *config_file; + GKeyFile *key_file; + gchar **devices_list; + guint len = 0; + guint wlength = 0; + gchar dev_file[20]; + int i; + const gchar** new_devices_list; + gsize length; + gchar *buf; + GIOChannel *file; + gchar* device_file; + if (NULL == public_key || is_device_known(public_key)) return 0; /* first get config file */ - gchar* config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); + config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); if (g_file_test(config_file, (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR))) { + key_file = g_key_file_new(); + if(g_key_file_load_from_file (key_file, config_file, G_KEY_FILE_KEEP_COMMENTS, NULL)) { - - GKeyFile* key_file = g_key_file_new (); - if( g_key_file_load_from_file (key_file, config_file, G_KEY_FILE_KEEP_COMMENTS, NULL) ) { - - gchar** devices_list = g_key_file_get_string_list (key_file, "Global", "DevicesList", NULL, NULL); - - guint length = 0; - guint wlength = 0; + /* Determine device name */ + devices_list = g_key_file_get_string_list (key_file, "Global", "DevicesList", NULL, NULL); if (devices_list) - length = g_strv_length(devices_list); + len = g_strv_length(devices_list); g_strfreev(devices_list); + g_sprintf(dev_file, "Device%i", len); - gchar dev_file[20]; - g_sprintf (dev_file, "Device%i", length); - - gchar* device_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, dev_file, NULL); - GIOChannel* file = g_io_channel_new_file (device_file, "w", NULL); - g_free (device_file); + /* Write device file to disk */ + device_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, dev_file, NULL); + file = g_io_channel_new_file (device_file, "w", NULL); + g_free(device_file); wlength = strlen(public_key); // why this wasn't discovered before... ugh - g_io_channel_write_chars (file, public_key, wlength, NULL, NULL); + g_io_channel_write_chars(file, public_key, wlength, NULL, NULL); g_io_channel_shutdown(file, TRUE, NULL); - /* append device to list */ - const gchar** new_devices_list = (const gchar**)g_malloc(sizeof(gchar*)* (length + 2)); - int i; - for( i = 0; i < length; i++) + /* Append device to list */ + new_devices_list = (const gchar**)g_malloc(sizeof(gchar*)* (len + 2)); + for( i = 0; i < len; i++) new_devices_list[i] = devices_list[i]; - new_devices_list[length] = dev_file; - new_devices_list[length+1] = NULL; - g_key_file_set_string_list (key_file,"Global", "DevicesList", new_devices_list, length+1); + new_devices_list[len] = dev_file; + new_devices_list[len+1] = NULL; + g_key_file_set_string_list(key_file,"Global", "DevicesList", new_devices_list, len+1); g_free(new_devices_list); } - gsize length; - gchar* buf = g_key_file_to_data (key_file, &length,NULL); - GIOChannel* file = g_io_channel_new_file (config_file, "w", NULL); - g_io_channel_write_chars (file, buf, length, NULL, NULL); + + /* Write config file to disk */ + buf = g_key_file_to_data(key_file, &length, NULL); + file = g_io_channel_new_file(config_file, "w", NULL); + g_io_channel_write_chars(file, buf, length, NULL, NULL); g_io_channel_shutdown(file, TRUE, NULL); g_key_file_free(key_file); } @@ -162,94 +186,151 @@ int store_device_public_key(char* public_key) return 1; } -int read_file_in_confdir(char* file, gnutls_datum_t* data) -{ - if (NULL == file || NULL == data) - return 0; - - gchar* filepath = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, file, NULL); +/** Private function which reads the given file into a gnutls structure. + * + * @param file The filename of the file to read + * @param data The pointer at which to store the data. + * + * @return 1 if the file contents where read successfully and 0 otherwise. + */ +int read_file_in_confdir(char* file, gnutls_datum_t* data) { gboolean success; gsize size; char *content; - success = g_file_get_contents (filepath, &content, &size, NULL); - g_free (filepath); + gchar *filepath; + + if (NULL == file || NULL == data) + return 0; + + /* Read file */ + filepath = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, file, NULL); + success = g_file_get_contents(filepath, &content, &size, NULL); + g_free(filepath); + + /* Add it to the gnutls_datnum_t structure */ data->data = content; data->size = size; + return success; } -int get_root_private_key(gnutls_datum_t* root_privkey) -{ +/** Read the root private key + * + * @param root_privkey A pointer to the appropriate gnutls structure + * + * @return 1 if the file was successfully read and 0 otherwise. + */ +int get_root_private_key(gnutls_datum_t* root_privkey) { return read_file_in_confdir(LIBIPHONE_ROOT_PRIVKEY, root_privkey); } -int get_host_private_key(gnutls_datum_t* host_privkey) -{ +/** Read the host private key + * + * @param host_privkey A pointer to the appropriate gnutls structure + * + * @return 1 if the file was successfully read and 0 otherwise. + */ +int get_host_private_key(gnutls_datum_t* host_privkey) { return read_file_in_confdir(LIBIPHONE_HOST_PRIVKEY, host_privkey); } -int get_root_certificate(gnutls_datum_t* root_cert) -{ +/** Read the root certificate + * + * @param root_privkey A pointer to the appropriate gnutls structure + * + * @return 1 if the file was successfully read and 0 otherwise. + */ +int get_root_certificate(gnutls_datum_t* root_cert) { return read_file_in_confdir(LIBIPHONE_ROOT_CERTIF, root_cert); } -int get_host_certificate(gnutls_datum_t* host_cert) -{ +/** Read the host certificate + * + * @param root_privkey A pointer to the appropriate gnutls structure + * + * @return 1 if the file was successfully read and 0 otherwise. + */ +int get_host_certificate(gnutls_datum_t* host_cert) { return read_file_in_confdir(LIBIPHONE_HOST_CERTIF, host_cert); } -int init_config_file(char* host_id, gnutls_datum_t* root_key, gnutls_datum_t* host_key, gnutls_datum_t* root_cert, gnutls_datum_t* host_cert) -{ +/** Creates a freedesktop compatible configuration directory for libiphone. + */ +inline void create_config_dir() { + gchar* config_dir; + + config_dir = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, NULL); + g_mkdir_with_parents(config_dir, 755); + g_free(config_dir); +} + +/** Create and save a configuration file containing the given data. + * + * @note: All fields must specified and be non-null + * + * @param host_id The UUID of the host + * @param root_key The root key + * @param host_key The host key + * @param root_cert The root certificate + * @param host_cert The host certificate + * + * @return 1 on success and 0 otherwise. + */ +int init_config_file(char* host_id, gnutls_datum_t* root_key, gnutls_datum_t* host_key, gnutls_datum_t* root_cert, gnutls_datum_t* host_cert) { + FILE * pFile; + gchar* pem; + GKeyFile* key_file; + gsize length; + gchar *buf, *config_file; + GIOChannel* file; + if (!host_id || !root_key || !host_key || !root_cert || !host_cert) return 0; - /* make sure config directory exists*/ + /* Make sure config directory exists*/ create_config_dir(); - /* now parse file to get the HostID */ - GKeyFile* key_file = g_key_file_new (); + /* Now parse file to get the HostID */ + key_file = g_key_file_new(); - /* store in config file */ - if (debug) printf("init_config_file setting hostID to %s\n", host_id); - g_key_file_set_value (key_file, "Global", "HostID", host_id); + /* Store in config file */ + if (debug) printf("init_config_file(): setting hostID to %s\n", host_id); + g_key_file_set_value(key_file, "Global", "HostID", host_id); - /* write config file on disk */ - gsize length; - gchar* buf = g_key_file_to_data (key_file, &length,NULL); - gchar* config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); - GIOChannel* file = g_io_channel_new_file (config_file, "w", NULL); - g_free (config_file); - g_io_channel_write_chars (file, buf, length, NULL, NULL); + /* Write config file on disk */ + buf = g_key_file_to_data(key_file, &length,NULL); + config_file = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_CONF_FILE, NULL); + file = g_io_channel_new_file(config_file, "w", NULL); + g_free(config_file); + g_io_channel_write_chars(file, buf, length, NULL, NULL); g_io_channel_shutdown(file, TRUE, NULL); g_key_file_free(key_file); - //now write keys and certifs to disk - FILE * pFile; - gchar* pem; + /* Now write keys and certificates to disk */ pem = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_ROOT_PRIVKEY, NULL); - pFile = fopen ( pem , "wb" ); - fwrite ( root_key->data, 1 , root_key->size , pFile ); - fclose (pFile); - g_free (pem); + pFile = fopen(pem , "wb"); + fwrite(root_key->data, 1 , root_key->size , pFile ); + fclose(pFile); + g_free(pem); pem = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_HOST_PRIVKEY, NULL); - pFile = fopen ( pem , "wb" ); - fwrite ( host_key->data, 1 , host_key->size , pFile ); - fclose (pFile); - g_free (pem); + pFile = fopen(pem , "wb"); + fwrite(host_key->data, 1 , host_key->size , pFile); + fclose(pFile); + g_free(pem); pem = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_ROOT_CERTIF, NULL); - pFile = fopen ( pem , "wb" ); - fwrite ( root_cert->data, 1 , root_cert->size , pFile ); - fclose (pFile); - g_free (pem); + pFile = fopen(pem , "wb"); + fwrite(root_cert->data, 1 , root_cert->size , pFile); + fclose(pFile); + g_free(pem); pem = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), LIBIPHONE_CONF_DIR, LIBIPHONE_HOST_CERTIF, NULL); - pFile = fopen ( pem , "wb" ); - fwrite ( host_cert->data, 1 , host_cert->size , pFile ); - fclose (pFile); - g_free (pem); + pFile = fopen(pem , "wb"); + fwrite(host_cert->data, 1 , host_cert->size , pFile); + fclose(pFile); + g_free(pem); return 1; } -- cgit v1.1-32-gdbae