umbot
    Preparing search index...

    Interface IIpFilterOptions

    Опции ipFilter middleware.

    interface IIpFilterOptions {
        blacklist?: string[];
        deniedText?: string;
        rejectWithoutIp?: boolean;
        whitelist?: string[];
    }
    Index

    Properties

    blacklist? deniedText? rejectWithoutIp? whitelist?

    Properties

    blacklist?: string[]

    Чёрный список IP/CIDR. Если задан — перечисленные запрещены. Поддерживаются IPv4 и IPv6. Игнорируется, если задан whitelist.

    Правила сравниваются по версии адреса: если заданы только IPv4-правила, IPv6-клиенты под blacklist не попадут — добавляйте IPv6-правила явно.

    deniedText?: string

    Текст ответа, который получит пользователь из заблокированного IP.

    '' (пустой ответ — молчим)
    rejectWithoutIp?: boolean

    Отклонять запросы, у которых IP клиента неизвестен.

    IP неизвестен, если бот вызван через bot.run() или через bot.webhookEvent() без аргумента clientIp (serverless-обработчик, не передавший IP из события). По умолчанию такие запросы пропускаются без фильтрации — чтобы не ломать локальную разработку. Включите опцию в продакшене с whitelist: иначе забытый clientIp молча отключает фильтр.

    false

    bot.use(ipFilter({ whitelist: ['10.0.0.0/8'], rejectWithoutIp: true }));
    whitelist?: string[]

    Белый список IP/CIDR. Если задан — разрешены только эти адреса. Поддерживаются IPv4 и IPv6. Примеры: '10.0.0.1', '192.168.0.0/24', '127.0.0.1', '2001:db8::/32', '::1'.

    Правила сравниваются по версии адреса: если заданы только IPv4-правила, IPv6-клиенты под whitelist не попадут и будут заблокированы.

    Settings

    Member Visibility

    On This Page

    Properties