hmac — Ключевое хэширование для аутентификации сообщений

Исходный код: Lib/hmac.py

Этот модуль реализует алгоритм HMAC, как описано в RFC 2104.

hmac.new(key, msg=None, digestmod=None)

Возвращает новый объект hmac. key — объект bytes или bytearray, содержащий секретный ключ. Если msg присутствует, вызывается метод update(msg). digestmod — имя дайджеста, конструктор дайджеста или модуль для использования объектом HMAC. Поддерживаются любые имена, подходящие для hashlib.new(), по умолчанию используется конструктор hashlib.md5.

Изменено в версии 3.4: Параметр key может быть объектом bytes или bytearray. Параметр msg может быть любого типа, поддерживаемого hashlib. Параметр digestmod может быть именем алгоритма хэширования.

Устарело начиная с версии 3.4: MD5 в качестве неявного значения по умолчанию для digestmod устарел.

Объект HMAC имеет следующие методы:

HMAC.update(msg)

Обновляет объект hmac с помощью msg. Повторные вызовы эквивалентны одному вызову с конкатенацией всех аргументов: m.update(a); m.update(b) эквивалентно m.update(a + b).

Изменено в версии 3.4: Параметр msg может быть любого типа, поддерживаемого hashlib.

HMAC.digest()

Возвращает дайджест байтов, переданных методу update() до сих пор. Этот объект bytes будет иметь такую же длину, как digest_size дайджеста, переданного конструктору. Он может содержать байты, отличные от ASCII, включая байты NUL.

Предупреждение

При сравнении результата digest() с внешним дайджестом во время процедуры верификации рекомендуется использовать функцию compare_digest() вместо оператора == для уменьшения уязвимости к атакам по таймингу.

HMAC.hexdigest()

Аналогично digest(), за исключением того, что дайджест возвращается в виде строки вдвое большей длины, содержащей только шестнадцатеричные цифры. Это может использоваться для безопасного обмена значениями по электронной почте или в других небинарных средах.

Предупреждение

При сравнении результата hexdigest() с внешним дайджестом во время процедуры верификации рекомендуется использовать функцию compare_digest() вместо оператора == для уменьшения уязвимости к атакам по таймингу.

HMAC.copy()

Возвращает копию (“клонирование”) объекта hmac. Это может использоваться для эффективного вычисления дайджестов строк, которые имеют общую начальную подстроку.

Объект хэша имеет следующие атрибуты:

HMAC.digest_size

Размер результирующего дайджеста HMAC в байтах.

HMAC.block_size

Внутренний размер блока алгоритма хэширования в байтах.

Добавлено в версии 3.4.

HMAC.name

Каноническое имя этого HMAC, всегда в нижнем регистре, например hmac-md5.

Добавлено в версии 3.4.

Этот модуль также предоставляет следующую вспомогательную функцию:

hmac.compare_digest(a, b)

Возвращает a == b. Эта функция использует подход, разработанный для предотвращения анализа по времени, избегая поведения короткого замыкания, основанного на содержании, что делает её подходящей для криптографии. a и b должны быть одного типа: либо str (только ASCII, например, возвращаемый HMAC.hexdigest()), либо объект-подобный байтам.

Примечание

Если a и b имеют разную длину, или если возникает ошибка, атака по таймингу теоретически могла бы раскрыть информацию о типах и длинах a и b, но не их значениях.

Добавлено в версии 3.3.