validate_file() WP 1.2.0

Проверяет переданную строку, является ли она правильным путем к файлу (имени файла). Если проверка пройдена, вернет 0; если нет, вернет: 1, 2 или 3.

Используется для предотвращения Directory traversal атак.

Хуков нет.

Возвращает

Число.

• 0 - проверка пройдена;
• 1 - означает что файл содержит ../ (Перейти в родительскую директорию). Что, переданное команде, может позволить читать/изменять файлы в родительских директориях — что неприемлемо с точки зрения безопасности;
• 2 - означает что $file содержит : вторым символом (Диск для Windows; абсолютный путь). Неприемлемо по тем же причинам;
• 3 - означает что файла нет в списке допустимых, указанных в параметре $allowed_files.

Использование

validate_file( $file, $allowed_files );

$file(строка) (обязательный)

Путь до файла.

$allowed_files(массив)

Список допустимых файлов, которым должна соответствовать переменная $file.
По умолчанию: ''

Примеры

#1 Демонстрация проверок пути файлов

Путь, который пройдет проверку:

$path = 'uploads/2012/12/my_image.jpg';
echo validate_file( $path ); // выведет 0 (допустимый путь)

Путь, который не пройдет проверку:

$path = '../../wp-content/uploads/2012/12/my_image.jpg';
echo validate_file( $path ); // выведет 1 (недоступный путь)

Заметки

Будьте внимательны при проверке возвращаемого результата, т.к. если проверка пройдена, то функция вернет 0, а если не пройдена то вернет число. Поэтому проверять стоит как-то так:

if( validate_file( $file ) === 0 )
	echo 'проверка пройдена';
else
	echo 'проверка не пройдена';

Список изменений

Код validate file: wp-includes/functions.php ^{WP 5.3}

<?php
function validate_file( $file, $allowed_files = array() ) {
	// `../` on its own is not allowed:
	if ( '../' === $file ) {
		return 1;
	}

	// More than one occurence of `../` is not allowed:
	if ( preg_match_all( '#\.\./#', $file, $matches, PREG_SET_ORDER ) && ( count( $matches ) > 1 ) ) {
		return 1;
	}

	// `../` which does not occur at the end of the path is not allowed:
	if ( false !== strpos( $file, '../' ) && '../' !== mb_substr( $file, -3, 3 ) ) {
		return 1;
	}

	// Files not in the allowed file list are not allowed:
	if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files ) ) {
		return 3;
	}

	// Absolute Windows drive paths are not allowed:
	if ( ':' == substr( $file, 1, 1 ) ) {
		return 2;
	}

	return 0;
}

Cвязанные функции

Из метки: validate (проверка)

Еще из раздела: Очистка данных