Skip to content

ext/ldap: Value parsing of LDAP Attributes #16173

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

Merged
merged 5 commits into from
Oct 5, 2024
Merged

ext/ldap: Value parsing of LDAP Attributes #16173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b87ca2f
ext/ldap: Add API parsing zval to LDAP value
Girgias Oct 2, 2024
9bf85b4
ext/ldap: Parse attribute value via new API in do_modify
Girgias Oct 2, 2024
cdfcb5e
ext/ldap: Remove an unnecessary duplication
Girgias Oct 2, 2024
2fb35ed
ext/ldap: Use bool instead of int
Girgias Oct 2, 2024
0968aa4
ext/ldap: Pass a HashTable directly to parse individual control
Girgias Oct 2, 2024
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
70 changes: 49 additions & 21 deletions ext/ldap/ldap.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,31 @@ static void ldap_result_entry_free_obj(zend_object *obj)
} \
}

/* An LDAP value must be a string, however it defines a format for integer and
* booleans, thus we parse zvals to the corresponding string if possible
* See RFC 4517: https://datatracker.ietf.org/doc/html/rfc4517 */
static zend_string* php_ldap_try_get_ldap_value_from_zval(zval *zv) {
switch (Z_TYPE_P(zv)) {
case IS_STRING:
case IS_LONG:
/* Object might be stringable */
case IS_OBJECT:
return zval_try_get_string(zv);
case IS_TRUE:
return ZSTR_INIT_LITERAL("TRUE", false);
case IS_FALSE:
return ZSTR_INIT_LITERAL("FALSE", false);
default:
zend_type_error("LDAP value must be of type string|int|bool, %s given", zend_zval_value_name(zv));
return NULL;
}
}

/* The char pointer MUST refer to the char* of a zend_string struct */
static void php_ldap_zend_string_release_from_char_pointer(char *ptr) {
zend_string_release((zend_string*) (ptr - XtOffsetOf(zend_string, val)));
}

/* {{{ Parse controls from and to arrays */
static void _php_ldap_control_to_array(LDAP *ld, LDAPControl* ctrl, zval* array, int request)
{
Expand Down Expand Up @@ -381,17 +406,16 @@ static void _php_ldap_control_to_array(LDAP *ld, LDAPControl* ctrl, zval* array,
}
}

static int _php_ldap_control_from_array(LDAP *ld, LDAPControl** ctrl, zval* array)
static int php_ldap_control_from_array(LDAP *ld, LDAPControl** ctrl, const HashTable *control_ht)
{
zval* val;
zend_string *control_oid;
int control_iscritical = 0, rc = LDAP_SUCCESS;
char** ldap_attrs = NULL;
LDAPSortKey** sort_keys = NULL;
zend_string *tmpstring = NULL, **tmpstrings1 = NULL, **tmpstrings2 = NULL;
size_t num_tmpstrings1 = 0, num_tmpstrings2 = 0;

if ((val = zend_hash_str_find(Z_ARRVAL_P(array), "oid", sizeof("oid") - 1)) == NULL) {
if ((val = zend_hash_str_find(control_ht, "oid", sizeof("oid") - 1)) == NULL) {
zend_value_error("%s(): Control must have an \"oid\" key", get_active_function_name());
return -1;
}
Expand All @@ -401,17 +425,17 @@ static int _php_ldap_control_from_array(LDAP *ld, LDAPControl** ctrl, zval* arra
return -1;
}

if ((val = zend_hash_str_find(Z_ARRVAL_P(array), "iscritical", sizeof("iscritical") - 1)) != NULL) {
bool control_iscritical = false;
if ((val = zend_hash_str_find(control_ht, "iscritical", sizeof("iscritical") - 1)) != NULL) {
control_iscritical = zend_is_true(val);
} else {
control_iscritical = 0;
}

BerElement *ber = NULL;
struct berval control_value = { 0L, NULL };
int control_value_alloc = 0;
bool control_value_alloc = false;
int rc = LDAP_SUCCESS;

if ((val = zend_hash_find(Z_ARRVAL_P(array), ZSTR_KNOWN(ZEND_STR_VALUE))) != NULL) {
if ((val = zend_hash_find(control_ht, ZSTR_KNOWN(ZEND_STR_VALUE))) != NULL) {
if (Z_TYPE_P(val) != IS_ARRAY) {
tmpstring = zval_get_string(val);
if (EG(exception)) {
Expand Down Expand Up @@ -762,7 +786,7 @@ static LDAPControl** php_ldap_controls_from_array(LDAP *ld, const HashTable *con
break;
}

if (_php_ldap_control_from_array(ld, ctrlp, ctrlarray) == LDAP_SUCCESS) {
if (php_ldap_control_from_array(ld, ctrlp, Z_ARRVAL_P(ctrlarray)) == LDAP_SUCCESS) {
++ctrlp;
} else {
error = 1;
Expand Down Expand Up @@ -2229,7 +2253,7 @@ static void php_ldap_do_modify(INTERNAL_FUNCTION_PARAMETERS, int oper, int ext)
}
/* end additional , gerrit thomson */

const zend_string *attribute = NULL;
zend_string *attribute = NULL;
zval *attribute_values = NULL;
unsigned int attribute_index = 0;
ZEND_HASH_FOREACH_STR_KEY_VAL(attributes_ht, attribute, attribute_values) {
Expand All @@ -2251,22 +2275,24 @@ static void php_ldap_do_modify(INTERNAL_FUNCTION_PARAMETERS, int oper, int ext)

ldap_mods[attribute_index] = emalloc(sizeof(LDAPMod));
ldap_mods[attribute_index]->mod_op = oper | LDAP_MOD_BVALUES;
ldap_mods[attribute_index]->mod_type = estrndup(ZSTR_VAL(attribute), ZSTR_LEN(attribute));
/* No need to duplicate the string as it is not consumed and the zend_string will not be released */
ldap_mods[attribute_index]->mod_type = ZSTR_VAL(attribute);
ldap_mods[attribute_index]->mod_bvalues = NULL;

ZVAL_DEREF(attribute_values);
/* If the attribute takes a single value it can be passed directly instead of as a list with one element */
/* allow for arrays with one element, no allowance for arrays with none but probably not required, gerrit thomson. */
if (Z_TYPE_P(attribute_values) != IS_ARRAY) {
convert_to_string(attribute_values);
if (EG(exception)) {
zend_string *value = php_ldap_try_get_ldap_value_from_zval(attribute_values);
if (UNEXPECTED(value == NULL)) {
RETVAL_FALSE;
goto cleanup;
}
ldap_mods[attribute_index]->mod_bvalues = safe_emalloc(2, sizeof(struct berval *), 0);
ldap_mods[attribute_index]->mod_bvalues[0] = (struct berval *) emalloc (sizeof(struct berval));
ldap_mods[attribute_index]->mod_bvalues[0]->bv_val = Z_STRVAL_P(attribute_values);
ldap_mods[attribute_index]->mod_bvalues[0]->bv_len = Z_STRLEN_P(attribute_values);
/* The string will be free by php_ldap_zend_string_release_from_char_pointer() during cleanup */
ldap_mods[attribute_index]->mod_bvalues[0]->bv_val = ZSTR_VAL(value);
ldap_mods[attribute_index]->mod_bvalues[0]->bv_len = ZSTR_LEN(value);
ldap_mods[attribute_index]->mod_bvalues[1] = NULL;
} else {
SEPARATE_ARRAY(attribute_values);
Expand All @@ -2289,14 +2315,15 @@ static void php_ldap_do_modify(INTERNAL_FUNCTION_PARAMETERS, int oper, int ext)
zend_ulong attribute_value_index = 0;
zval *attribute_value = NULL;
ZEND_HASH_FOREACH_NUM_KEY_VAL(Z_ARRVAL_P(attribute_values), attribute_value_index, attribute_value) {
convert_to_string(attribute_value);
if (EG(exception)) {
zend_string *value = php_ldap_try_get_ldap_value_from_zval(attribute_value);
if (UNEXPECTED(value == NULL)) {
RETVAL_FALSE;
goto cleanup;
}
ldap_mods[attribute_index]->mod_bvalues[attribute_value_index] = (struct berval *) emalloc (sizeof(struct berval));
ldap_mods[attribute_index]->mod_bvalues[attribute_value_index]->bv_val = Z_STRVAL_P(attribute_value);
ldap_mods[attribute_index]->mod_bvalues[attribute_value_index]->bv_len = Z_STRLEN_P(attribute_value);
/* The string will be free by php_ldap_zend_string_release_from_char_pointer() during cleanup */
ldap_mods[attribute_index]->mod_bvalues[attribute_value_index]->bv_val = ZSTR_VAL(value);
ldap_mods[attribute_index]->mod_bvalues[attribute_value_index]->bv_len = ZSTR_LEN(value);
} ZEND_HASH_FOREACH_END();
ldap_mods[attribute_index]->mod_bvalues[num_values] = NULL;
}
Expand Down Expand Up @@ -2365,10 +2392,11 @@ static void php_ldap_do_modify(INTERNAL_FUNCTION_PARAMETERS, int oper, int ext)
cleanup:
for (LDAPMod **ptr = ldap_mods; *ptr != NULL; ptr++) {
LDAPMod *mod = *ptr;
efree(mod->mod_type);
if (mod->mod_bvalues != NULL) {
for (struct berval **bval_ptr = mod->mod_bvalues; *bval_ptr != NULL; bval_ptr++) {
efree(*bval_ptr);
struct berval *bval = *bval_ptr;
php_ldap_zend_string_release_from_char_pointer(bval->bv_val);
efree(bval);
}
efree(mod->mod_bvalues);
}
Expand Down
8 changes: 2 additions & 6 deletions ext/ldap/tests/ldap_add_modify_delete_programming_errors.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,13 @@ try {
/* We don't check that values have nul bytes as the length of the string is passed to LDAP */

?>
--EXPECTF--
--EXPECT--
ValueError: ldap_add(): Argument #3 ($entry) must not be empty
ValueError: ldap_add(): Argument #3 ($entry) must be an associative array of attribute => values
ValueError: ldap_add(): Argument #3 ($entry) key must not be empty
ValueError: ldap_add(): Argument #3 ($entry) key must not contain any null bytes
Error: Object of class stdClass could not be converted to string
ValueError: ldap_add(): Argument #3 ($entry) list of attribute values must not be empty
ValueError: ldap_add(): Argument #3 ($entry) must be a list of attribute values

Warning: Array to string conversion in %s on line %d

Warning: ldap_add(): Add: Can't contact LDAP server in %s on line %d
bool(false)
TypeError: LDAP value must be of type string|int|bool, array given
Error: Object of class stdClass could not be converted to string
10 changes: 3 additions & 7 deletions ext/ldap/tests/ldap_add_modify_delete_references_programming_errors.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,8 @@ try {
/* We don't check that values have nul bytes as the length of the string is passed to LDAP */

?>
--EXPECTF--
--EXPECT--
Error: Object of class stdClass could not be converted to string
ValueError: ldap_add(): Argument #3 ($entry) list of attribute values must not be empty

Warning: Array to string conversion in %s on line %d

Warning: ldap_add(): Add: Can't contact LDAP server in %s on line %d
bool(false)
Error: Object of class stdClass could not be converted to string
TypeError: LDAP value must be of type string|int|bool, array given
TypeError: LDAP value must be of type string|int|bool, stdClass given