upgrade_persistency.c File Reference

#include "upgrade_persistency.h"
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <amxc/amxc_macros.h>
#include <amxc/amxc_string.h>
#include "file_utils.h"
#include "password_constants.h"
#include "persistency.h"
#include "xpon_trace.h"

Go to the source code of this file.

Macros
#define	_GNU_SOURCE
#define	UPGR_STORAGE_DIR_OVERALL   "/cfg/system/"
#define	UPGR_STORAGE_DIR_COMPONENT   UPGR_STORAGE_DIR_OVERALL "tr181-xpon/"
#define	ASCII_PASSWORD_FILE_INDEX   0
#define	HEX_PASSWORD_FILE_INDEX   1

Functions
void	upgr_persistency_init (void)
void	upgr_persistency_cleanup (void)
static void	create_password_file_path (const char *const ani_object, bool hex, amxc_string_t *const file_path)
void	upgr_persistency_set_password (const char *const ani_path, const char *const password, bool hex)
bool	upgr_persistency_get_password (const char *const ani_path, char *const password, bool *hex)

Variables
static char *	s_upgr_storage_dir = NULL

Macro Definition Documentation

_GNU_SOURCE

#define _GNU_SOURCE

Define _GNU_SOURCE to avoid following error: implicit declaration of function ‘strdup’

Definition at line 68 of file upgrade_persistency.c.

ASCII_PASSWORD_FILE_INDEX

#define ASCII_PASSWORD_FILE_INDEX   0

Definition at line 222 of file upgrade_persistency.c.

HEX_PASSWORD_FILE_INDEX

#define HEX_PASSWORD_FILE_INDEX   1

Definition at line 223 of file upgrade_persistency.c.

UPGR_STORAGE_DIR_COMPONENT

#define UPGR_STORAGE_DIR_COMPONENT   UPGR_STORAGE_DIR_OVERALL "tr181-xpon/"

Definition at line 99 of file upgrade_persistency.c.

UPGR_STORAGE_DIR_OVERALL

#define UPGR_STORAGE_DIR_OVERALL   "/cfg/system/"

Folder for upgrade persistent settings.

TODO This folder is hardcoded for now. It must be made configurable.

Definition at line 98 of file upgrade_persistency.c.

Function Documentation

create_password_file_path()

static void create_password_file_path ( const char *const  ani_object, bool  hex, amxc_string_t *const  file_path  )

static

Definition at line 159 of file upgrade_persistency.c.

                                                                      {
 
    amxc_string_set(file_path, s_upgr_storage_dir);
    amxc_string_appendf(file_path, "%s", ani_object);
    if(hex) {
        amxc_string_append(file_path, "_password_hex.txt", 17);
    } else {
        amxc_string_append(file_path, "_password_ascii.txt", 19);
    }
}

Here is the caller graph for this function:

upgr_persistency_cleanup()

void upgr_persistency_cleanup

(

void

)

Clean up the part responsible for the upgrade persistent settings.

The plugin must call this function once when stopping.

Definition at line 152 of file upgrade_persistency.c.

                                    {
    if(s_upgr_storage_dir) {
        free(s_upgr_storage_dir);
        s_upgr_storage_dir = NULL;
    }
}

Here is the caller graph for this function:

upgr_persistency_get_password()

bool upgr_persistency_get_password	(	const char *const	ani_path,
		char *const	password,
		bool *	hex
	)

Get the saved password for a certain ANI instance.

Parameters

[in]	ani_path	path to ANI instance, e.g. "XPON.ONU.1.ANI.1"
[in,out]	password	the function writes the saved password to this parameter if a saved password for the ANI exists. If no saved password exists, the function does not write to this parameter. The caller must pass a buffer of size MAX_PASSWORD_LEN_PLUS_ONE to ensure this function has enough space to write a password.
[in,out]	hex	the function sets this parameter to true if the password it writes to password is in hexadecimal format.

If no saved password exists for the ANI, the function does not update password or hex, and returns true.

Returns

true on success, else false

Definition at line 242 of file upgrade_persistency.c.

                                              {
 
    bool rv = false;
    int i;
    char password_saved[MAX_PASSWORD_LEN_PLUS_ONE] = { 0 };
    const char* password_file_used = NULL;
 
    amxc_string_t file_path_ascii;
    amxc_string_t file_path_hex;
    amxc_string_init(&file_path_ascii, 0);
    amxc_string_init(&file_path_hex, 0);
 
    create_password_file_path(ani_path, /*hex=*/ false, &file_path_ascii);
    create_password_file_path(ani_path, /*hex=*/ true, &file_path_hex);
    const char* files[2] = { 0 };
    files[ASCII_PASSWORD_FILE_INDEX] = amxc_string_get(&file_path_ascii, 0);
    files[HEX_PASSWORD_FILE_INDEX] = amxc_string_get(&file_path_hex, 0);
 
    for(i = 0; i < 2; ++i) {
        if(access(files[i], F_OK) == 0) {
            if(!read_first_line_from_file(files[i], password_saved,
                                          MAX_PASSWORD_LEN_PLUS_ONE)) {
                SAH_TRACEZ_ERROR(ME, "Failed get password from %s", files[i]);
                goto exit;
            }
            password_file_used = files[i];
            if(HEX_PASSWORD_FILE_INDEX == i) {
                *hex = true;
            }
            break;
        }
    }
    if(password_file_used == NULL) {
        SAH_TRACEZ_DEBUG(ME, "%s: no password", ani_path);
        rv = true;
        goto exit;
    }
 
 
    if(strlen(password_saved) == 0) {
        SAH_TRACEZ_ERROR(ME, "Password read from %s is empty",
                         password_file_used);
        goto exit;
    }
 
    if(snprintf(password, MAX_PASSWORD_LEN_PLUS_ONE, "%s",
                password_saved) < 0) {
        SAH_TRACEZ_ERROR(ME, "snprintf() to copy password failed");
        goto exit;
    }
    SAH_TRACEZ_DEBUG(ME, "ani='%s': password='%s' hex=%d", ani_path,
                     password, *hex);
    rv = true;
 
exit:
    amxc_string_clean(&file_path_ascii);
    amxc_string_clean(&file_path_hex);
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

upgr_persistency_init()

void upgr_persistency_init

(

void

)

Initialize the part responsible for the upgrade persistent settings.

The plugin must call this function once at startup after it has called persistency_init(): if this function can not use the folder for upgrade persistent files, it uses the folder for reboot persistent files created by persistency_init().

Definition at line 112 of file upgrade_persistency.c.

                                 {
 
    if(access(UPGR_STORAGE_DIR_OVERALL, R_OK | W_OK | X_OK) == 0) {
        if(access(UPGR_STORAGE_DIR_COMPONENT, R_OK | W_OK | X_OK) == 0) {
            s_upgr_storage_dir = strdup(UPGR_STORAGE_DIR_COMPONENT);
            when_null_trace(s_upgr_storage_dir, exit, ERROR,
                            "Failed to allocate mem for s_upgr_storage_dir");
            goto exit;
        }
        if(mkdir(UPGR_STORAGE_DIR_COMPONENT, 0777) == -1) {
            SAH_TRACEZ_ERROR(ME, "Failed to create %s: %s", UPGR_STORAGE_DIR_COMPONENT,
                             strerror(errno));
            goto exit;
        }
        s_upgr_storage_dir = strdup(UPGR_STORAGE_DIR_COMPONENT);
        when_null_trace(s_upgr_storage_dir, exit, ERROR,
                        "Failed to allocate mem for s_upgr_storage_dir");
    } else {
        SAH_TRACEZ_WARNING(ME, "No folder for upgrade persistent settings");
        SAH_TRACEZ_WARNING(ME, "Use folder for reboot persistent settings");
        const char* const reboot_persistent = persistency_get_folder();
        if(access(reboot_persistent, R_OK | W_OK | X_OK) != 0) {
            SAH_TRACEZ_ERROR(ME, "No folder for any persistent settings");
            goto exit;
        }
        s_upgr_storage_dir = strdup(reboot_persistent);
        when_null_trace(s_upgr_storage_dir, exit, ERROR,
                        "Failed to allocate mem for s_upgr_storage_dir");
    }
 
exit:
    SAH_TRACEZ_DEBUG(ME, "dir='%s'", s_upgr_storage_dir ? : "NULL");
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

upgr_persistency_set_password()

void upgr_persistency_set_password	(	const char *const	ani_path,
		const char *const	password,
		bool	hex
	)

Save the password of a certain ANI instance.

Parameters

[in]	ani_path	path to ANI instance, e.g. "XPON.ONU.1.ANI.1"
[in]	password	new value for the parameter Password of the ANI referred to by ani_path
[in]	hex	if true password is in hexadecimal format; if false, password is in ASCII format. The function only uses this parameter if password is not empty.

If password is empty, the function removes any files storing the password for the ANI instance.

Definition at line 185 of file upgrade_persistency.c.

                                             {
 
    when_null_trace(s_upgr_storage_dir, exit, DEBUG, "No persistency");
    when_null(ani_path, exit);
    when_null(password, exit);
 
    SAH_TRACEZ_DEBUG(ME, "ani_path='%s' password='%s' hex=%d",
                     ani_path, password, hex);
 
    amxc_string_t file_path_ascii;
    amxc_string_t file_path_hex;
    amxc_string_init(&file_path_ascii, 0);
    amxc_string_init(&file_path_hex, 0);
 
    create_password_file_path(ani_path, /*hex=*/ false, &file_path_ascii);
    create_password_file_path(ani_path, /*hex=*/ true, &file_path_hex);
 
    const char* const ascii_cstr = amxc_string_get(&file_path_ascii, 0);
    const char* const hex_cstr = amxc_string_get(&file_path_hex, 0);
 
    if(strlen(password) == 0) {
        unlink(ascii_cstr);
        unlink(hex_cstr);
    } else {
        write_file(hex ? hex_cstr : ascii_cstr, password);
        unlink(hex ? ascii_cstr : hex_cstr);
    }
 
    amxc_string_clean(&file_path_ascii);
    amxc_string_clean(&file_path_hex);
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

s_upgr_storage_dir

char* s_upgr_storage_dir = NULL

static

Definition at line 102 of file upgrade_persistency.c.