password.h File Reference

#include <stdbool.h>

Go to the source code of this file.

Functions
bool	passwd_check_password (const char *const ani_auth_path, const char *const password)
void	passwd_set_password (const char *const ani_auth_path, const char *const password)
void	passwd_restore_password (const char *const ani_path)

Detailed Description

Functions related to the PON password.

Definition in file password.h.

Function Documentation

passwd_check_password()

bool passwd_check_password	(	const char *const	ani_path,
		const char *const	password
	)

Return true if the password is valid, else return false.

Parameters

[in]	ani_path	path to ANI instance, e.g. "XPON.ONU.1.ANI.1"
[in]	password	possible new value for the parameter Password of the ANI instance referred to by ani_path.

The function looks at other parameters of the ANI referred to by ani_path to determine if the password is valid. E.g. if ani_path is "XPON.ONU.1.ANI.1", it looks at:

• XPON.ONU.1.ANI.1.PONMode
• XPON.ONU.1.ANI.1.TC.Authentication.HexadecimalPassword

Returns

true if password is valid, else false

Definition at line 99 of file password.c.

                                                                                   {
 
    bool rv = false;
    size_t i;
 
    SAH_TRACEZ_DEBUG(ME, "ani_path='%s' password='%s'", ani_path, password);
 
    bool is_hex = false;
    if(!dm_is_hex_password(ani_path, &is_hex)) {
        SAH_TRACEZ_ERROR(ME, "Failed to determine if password is in hex");
        goto exit;
    }
 
    const size_t len = strlen(password);
    if(is_hex) {
        if((len % 2) != 0) {
            SAH_TRACEZ_ERROR(ME, "hex password does not have even number of chars");
            goto exit;
        }
        for(i = 0; i < len; i++) {
            if(!isxdigit(password[i])) {
                SAH_TRACEZ_ERROR(ME, "hex password has non-hexadecimal digit");
                goto exit;
            }
        }
    }
 
    pon_mode_t pon_mode = pon_mode_unknown;
    if(!dm_get_ani_pon_mode(ani_path, &pon_mode)) {
        SAH_TRACEZ_ERROR(ME, "Failed to get PON mode");
        goto exit;
    }
    when_true_trace(pon_mode_unknown == pon_mode, exit, ERROR,
                    "Unknown PON mode");
 
    size_t maxlen =
        (pon_mode_gpon == pon_mode) ?
        MAX_GPON_PASSWORD_LEN : MAX_XPON_PASSWORD_LEN;
 
    if(is_hex) {
        maxlen *= 2; /* hex value is twice the size of an ASCII value */
        if(len != maxlen) {
            SAH_TRACEZ_ERROR(ME, "Length of password = %zd != %zd [mode='%s', hex=1]",
                             len, maxlen, pon_mode_to_string(pon_mode));
            goto exit;
        }
    } else if(len > maxlen) {
        SAH_TRACEZ_ERROR(ME, "Length of password = %zd > %zd [mode='%s', hex=0]",
                         len, maxlen, pon_mode_to_string(pon_mode));
        goto exit;
    }
 
    rv = true;
 
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

passwd_restore_password()

void passwd_restore_password

(

const char *const

ani_path

)

Restore the PON password for an ANI: in DM and towards vendor module.

Parameters

[in]

ani_path

path to ANI instance, e.g. "XPON.ONU.1.ANI.1"

Check if there is a saved PON password for the ANI. If there is, update its Password parameter (and its HexadecimalPassword parameter) in the DM. The update in the DM causes the Ambiorix framework to call the same functions as when another component or user updates the Password parameter: _check_password() and _password_changed(). The latter function call among others forwards the password to the vendor module.

Definition at line 237 of file password.c.

                                                         {
 
    SAH_TRACEZ_DEBUG(ME, "ani_path='%s'", ani_path);
    char password[MAX_PASSWORD_LEN_PLUS_ONE] = { 0 };
    bool hex = false;
    if(!upgr_persistency_get_password(ani_path, password, &hex)) {
        SAH_TRACEZ_ERROR(ME, "ani='%s': failed to get password", ani_path);
        goto exit;
    }
    when_true(strlen(password) == 0, exit); /* nothing to do */
 
    update_password_in_dm(ani_path, password, hex);
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

passwd_set_password()

void passwd_set_password	(	const char *const	ani_path,
		const char *const	password
	)

Set the password of an 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

The function forwards the value to:

• the vendor module
• the part of this plugin responsible for the upgrade persistent settings

Definition at line 168 of file password.c.

                                                     {
 
    SAH_TRACEZ_DEBUG(ME, "ani_path='%s' password='%s'", ani_path, password);
 
    bool is_hex = false;
    if(strlen(password) != 0) {
        if(!dm_is_hex_password(ani_path, &is_hex)) {
            SAH_TRACEZ_ERROR(ME, "%s: failed to determine if password is in "
                             "hex", ani_path);
            goto exit;
        }
    }
 
    upgr_persistency_set_password(ani_path, password, is_hex);
    pon_ctrl_set_password(ani_path, password, is_hex);
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function: